Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
sdhc_driver_api Struct Reference

Driver Operations SDHC driver operations More...

#include <zephyr/drivers/sdhc.h>

Data Fields

int(* reset )(const struct device *dev)
  OPT reset SDHC controller state
int(* request )(const struct device *dev, struct sdhc_command *cmd, struct sdhc_data *data)
  REQ Send command to SDHC.
int(* set_io )(const struct device *dev, struct sdhc_io *ios)
  REQ set I/O properties of SDHC
int(* get_card_present )(const struct device *dev)
  REQ check for SDHC card presence
int(* execute_tuning )(const struct device *dev)
  OPT run SDHC tuning
int(* card_busy )(const struct device *dev)
  REQ check if SD card is busy
int(* get_host_props )(const struct device *dev, struct sdhc_host_props *props)
  REQ Get SD host controller properties.
int(* enable_interrupt )(const struct device *dev, sdhc_interrupt_cb_t callback, int sources, void *user_data)
  OPT Enable SDHC interrupt sources.
int(* disable_interrupt )(const struct device *dev, int sources)
  OPT Disable SDHC interrupt sources.

Detailed Description

Driver Operations SDHC driver operations

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

◆ card_busy

int(* sdhc_driver_api::card_busy) (const struct device *dev)

REQ check if SD card is busy

◆ disable_interrupt

int(* sdhc_driver_api::disable_interrupt) (const struct device *dev, int sources)

OPT Disable SDHC interrupt sources.

◆ enable_interrupt

int(* sdhc_driver_api::enable_interrupt) (const struct device *dev, sdhc_interrupt_cb_t callback, int sources, void *user_data)

OPT Enable SDHC interrupt sources.

◆ execute_tuning

int(* sdhc_driver_api::execute_tuning) (const struct device *dev)

OPT run SDHC tuning

◆ get_card_present

int(* sdhc_driver_api::get_card_present) (const struct device *dev)

REQ check for SDHC card presence

◆ get_host_props

int(* sdhc_driver_api::get_host_props) (const struct device *dev, struct sdhc_host_props *props)

REQ Get SD host controller properties.

◆ request

int(* sdhc_driver_api::request) (const struct device *dev, struct sdhc_command *cmd, struct sdhc_data *data)

REQ Send command to SDHC.

◆ reset

int(* sdhc_driver_api::reset) (const struct device *dev)

OPT reset SDHC controller state

◆ set_io

int(* sdhc_driver_api::set_io) (const struct device *dev, struct sdhc_io *ios)

REQ set I/O properties of SDHC


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