Driver Operations eSPI SAF driver operations More...

#include <zephyr/drivers/espi_saf.h>

Data Fields
espi_saf_api_config	config
	REQ Configure operation of an eSPI controller.
espi_saf_api_set_protection_regions	set_protection_regions
	REQ Set one or more SAF protection regions.
espi_saf_api_activate	activate
	REQ Activate SAF block.
espi_saf_api_get_channel_status	get_channel_status
	REQ Query to see if SAF is ready.
espi_saf_api_flash_read	flash_read
	OPT Sends a read request packet for slave attached flash.
espi_saf_api_flash_write	flash_write
	OPT Sends a write request packet for slave attached flash.
espi_saf_api_flash_erase	flash_erase
	OPT Sends an erase request packet for slave attached flash.
espi_saf_api_flash_unsuccess	flash_unsuccess
	OPT Response unsuccessful completion for slave attached flash.
espi_saf_api_manage_callback	manage_callback
	OPT Manage (add or remove) application callbacks.

Detailed Description

Driver Operations eSPI SAF driver operations

This is the driver API structure any eSPI SAF driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ activate

espi_saf_api_activate espi_saf_driver_api::activate

REQ Activate SAF block.

◆ config

espi_saf_api_config espi_saf_driver_api::config

REQ Configure operation of an eSPI controller.

◆ flash_erase

espi_saf_api_flash_erase espi_saf_driver_api::flash_erase

OPT Sends an erase request packet for slave attached flash.

◆ flash_read

espi_saf_api_flash_read espi_saf_driver_api::flash_read

OPT Sends a read request packet for slave attached flash.

◆ flash_unsuccess

espi_saf_api_flash_unsuccess espi_saf_driver_api::flash_unsuccess

OPT Response unsuccessful completion for slave attached flash.

◆ flash_write

espi_saf_api_flash_write espi_saf_driver_api::flash_write

OPT Sends a write request packet for slave attached flash.

◆ get_channel_status

espi_saf_api_get_channel_status espi_saf_driver_api::get_channel_status

REQ Query to see if SAF is ready.

◆ manage_callback

espi_saf_api_manage_callback espi_saf_driver_api::manage_callback

OPT Manage (add or remove) application callbacks.

◆ set_protection_regions

espi_saf_api_set_protection_regions espi_saf_driver_api::set_protection_regions

REQ Set one or more SAF protection regions.

The documentation for this struct was generated from the following file:

zephyr/drivers/espi_saf.h

Data Fields