Driver Operations eSPI driver operations More...

#include <zephyr/drivers/espi.h>

Data Fields
espi_api_config	config
	REQ Configure operation of an eSPI device.
espi_api_get_channel_status	get_channel_status
	REQ Query whether a logical channel is ready.
espi_api_read_request	read_request
	OPT Sends memory, I/O or message read request over eSPI.
espi_api_write_request	write_request
	OPT Sends memory, I/O or message write request over eSPI.
espi_api_lpc_read_request	read_lpc_request
	OPT Reads SOC data from an LPC peripheral with information updated over eSPI.
espi_api_lpc_write_request	write_lpc_request
	OPT Writes data to an LPC peripheral which generates an eSPI transaction.
espi_api_send_vwire	send_vwire
	REQ Sends system/platform signal as a virtual wire packet.
espi_api_receive_vwire	receive_vwire
	REQ Retrieves level status for a signal encapsulated in a virtual wire.
espi_api_send_oob	send_oob
	OPT Sends SMBus transaction (out-of-band) packet over eSPI bus.
espi_api_receive_oob	receive_oob
	OPT Receives SMBus transaction (out-of-band) packet from eSPI bus.
espi_api_flash_read	flash_read
	OPT Sends a read request packet for shared flash.
espi_api_flash_write	flash_write
	OPT Sends a write request packet for shared flash.
espi_api_flash_erase	flash_erase
	OPT Sends an erase request packet for shared flash.
espi_api_manage_callback	manage_callback
	OPT Add or remove an application callback.
espi_api_interrupt_configure	interrupt_config
	OPT Control eSPI interrupts.

Detailed Description

Driver Operations eSPI driver operations

This is the driver API structure any eSPI 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

◆ config

espi_api_config espi_driver_api::config

REQ Configure operation of an eSPI device.

◆ flash_erase

espi_api_flash_erase espi_driver_api::flash_erase

OPT Sends an erase request packet for shared flash.

◆ flash_read

espi_api_flash_read espi_driver_api::flash_read

OPT Sends a read request packet for shared flash.

◆ flash_write

espi_api_flash_write espi_driver_api::flash_write

OPT Sends a write request packet for shared flash.

◆ get_channel_status

espi_api_get_channel_status espi_driver_api::get_channel_status

REQ Query whether a logical channel is ready.

◆ interrupt_config

espi_api_interrupt_configure espi_driver_api::interrupt_config

OPT Control eSPI interrupts.

◆ manage_callback

espi_api_manage_callback espi_driver_api::manage_callback

OPT Add or remove an application callback.

◆ read_lpc_request

espi_api_lpc_read_request espi_driver_api::read_lpc_request

OPT Reads SOC data from an LPC peripheral with information updated over eSPI.

◆ read_request

espi_api_read_request espi_driver_api::read_request

OPT Sends memory, I/O or message read request over eSPI.

◆ receive_oob

espi_api_receive_oob espi_driver_api::receive_oob

OPT Receives SMBus transaction (out-of-band) packet from eSPI bus.

◆ receive_vwire

espi_api_receive_vwire espi_driver_api::receive_vwire

REQ Retrieves level status for a signal encapsulated in a virtual wire.

◆ send_oob

espi_api_send_oob espi_driver_api::send_oob

OPT Sends SMBus transaction (out-of-band) packet over eSPI bus.

◆ send_vwire

espi_api_send_vwire espi_driver_api::send_vwire

REQ Sends system/platform signal as a virtual wire packet.

◆ write_lpc_request

espi_api_lpc_write_request espi_driver_api::write_lpc_request

OPT Writes data to an LPC peripheral which generates an eSPI transaction.

◆ write_request

espi_api_write_request espi_driver_api::write_request

OPT Sends memory, I/O or message write request over eSPI.

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

zephyr/drivers/espi.h

Data Fields