eSPI SAF Driver Backend API

Data Structures
struct	espi_saf_driver_api
	Driver Operations eSPI SAF driver operations More...

Typedefs
typedef int(*	espi_saf_api_config) (const struct device *dev, const struct espi_saf_cfg *cfg)
	Callback API to configure the eSPI SAF controller.
typedef int(*	espi_saf_api_set_protection_regions) (const struct device *dev, const struct espi_saf_protection *pr)
	Callback API to set one or more SAF protection regions.
typedef int(*	espi_saf_api_activate) (const struct device *dev)
	Callback API to activate the SAF block.
typedef bool(*	espi_saf_api_get_channel_status) (const struct device *dev)
	Callback API to query if SAF is ready.
typedef int(*	espi_saf_api_flash_read) (const struct device *dev, struct espi_saf_packet *pckt)
	Callback API to send a read request for slave attached flash.
typedef int(*	espi_saf_api_flash_write) (const struct device *dev, struct espi_saf_packet *pckt)
	Callback API to send a write request for slave attached flash.
typedef int(*	espi_saf_api_flash_erase) (const struct device *dev, struct espi_saf_packet *pckt)
	Callback API to send an erase request for slave attached flash.
typedef int(*	espi_saf_api_flash_unsuccess) (const struct device *dev, struct espi_saf_packet *pckt)
	Callback API to respond unsuccessful completion for slave attached flash.
typedef int(*	espi_saf_api_manage_callback) (const struct device *dev, struct espi_callback *callback, bool set)
	Callback API to manage (add or remove) application callbacks.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a eSPI SAF driver.

Typedef Documentation

espi_saf_api_activate

typedef int(* espi_saf_api_activate) (const struct device *dev)

#include <zephyr/drivers/espi_saf.h>

Callback API to activate the SAF block.

See espi_saf_activate() for argument description.

espi_saf_api_config

typedef int(* espi_saf_api_config) (const struct device *dev, const struct espi_saf_cfg *cfg)

#include <zephyr/drivers/espi_saf.h>

Callback API to configure the eSPI SAF controller.

See espi_saf_config() for argument description.

espi_saf_api_flash_erase

typedef int(* espi_saf_api_flash_erase) (const struct device *dev, struct espi_saf_packet *pckt)

#include <zephyr/drivers/espi_saf.h>

Callback API to send an erase request for slave attached flash.

See espi_saf_flash_erase() for argument description.

espi_saf_api_flash_read

typedef int(* espi_saf_api_flash_read) (const struct device *dev, struct espi_saf_packet *pckt)

#include <zephyr/drivers/espi_saf.h>

Callback API to send a read request for slave attached flash.

See espi_saf_flash_read() for argument description.

espi_saf_api_flash_unsuccess

typedef int(* espi_saf_api_flash_unsuccess) (const struct device *dev, struct espi_saf_packet *pckt)

#include <zephyr/drivers/espi_saf.h>

Callback API to respond unsuccessful completion for slave attached flash.

See espi_saf_flash_unsuccess() for argument description.

espi_saf_api_flash_write

typedef int(* espi_saf_api_flash_write) (const struct device *dev, struct espi_saf_packet *pckt)

#include <zephyr/drivers/espi_saf.h>

Callback API to send a write request for slave attached flash.

See espi_saf_flash_write() for argument description.

espi_saf_api_get_channel_status

typedef bool(* espi_saf_api_get_channel_status) (const struct device *dev)

#include <zephyr/drivers/espi_saf.h>

Callback API to query if SAF is ready.

See espi_saf_get_channel_status() for argument description.

espi_saf_api_manage_callback

typedef int(* espi_saf_api_manage_callback) (const struct device *dev, struct espi_callback *callback, bool set)

#include <zephyr/drivers/espi_saf.h>

Callback API to manage (add or remove) application callbacks.

See espi_saf_add_callback() and espi_saf_remove_callback() for argument description.

espi_saf_api_set_protection_regions

typedef int(* espi_saf_api_set_protection_regions) (const struct device *dev, const struct espi_saf_protection *pr)

#include <zephyr/drivers/espi_saf.h>

Callback API to set one or more SAF protection regions.

See espi_saf_set_protection_regions() for argument description.