Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
espi_driver_api Struct Reference

@driver_ops{eSPI} More...

#include <espi.h>

Data Fields

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

Detailed Description

@driver_ops{eSPI}

Field Documentation

◆ config

espi_api_config espi_driver_api::config

@driver_ops_mandatory Configure operation of an eSPI device.

◆ flash_erase

espi_api_flash_erase espi_driver_api::flash_erase

@driver_ops_optional Sends an erase request packet for shared flash.

◆ flash_read

espi_api_flash_read espi_driver_api::flash_read

@driver_ops_optional Sends a read request packet for shared flash.

◆ flash_write

espi_api_flash_write espi_driver_api::flash_write

@driver_ops_optional Sends a write request packet for shared flash.

◆ get_channel_status

espi_api_get_channel_status espi_driver_api::get_channel_status

@driver_ops_mandatory Query whether a logical channel is ready.

◆ interrupt_config

espi_api_interrupt_configure espi_driver_api::interrupt_config

@driver_ops_optional Control eSPI interrupts.

◆ manage_callback

espi_api_manage_callback espi_driver_api::manage_callback

@driver_ops_optional Add or remove an application callback.

◆ read_lpc_request

espi_api_lpc_read_request espi_driver_api::read_lpc_request

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

◆ read_request

espi_api_read_request espi_driver_api::read_request

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

◆ receive_oob

espi_api_receive_oob espi_driver_api::receive_oob

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

◆ receive_vwire

espi_api_receive_vwire espi_driver_api::receive_vwire

@driver_ops_mandatory Retrieves level status for a signal encapsulated in a virtual wire.

◆ send_oob

espi_api_send_oob espi_driver_api::send_oob

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

◆ send_vwire

espi_api_send_vwire espi_driver_api::send_vwire

@driver_ops_mandatory Sends system/platform signal as a virtual wire packet.

◆ write_lpc_request

espi_api_lpc_write_request espi_driver_api::write_lpc_request

@driver_ops_optional Writes data to an LPC peripheral which generates an eSPI transaction.

◆ write_request

espi_api_write_request espi_driver_api::write_request

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


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/espi.h