| /* | |
| * Copyright 2017, Data61 | |
| * Commonwealth Scientific and Industrial Research Organisation (CSIRO) | |
| * ABN 41 687 119 230. | |
| * | |
| * This software may be distributed and modified according to the terms of | |
| * the BSD 2-Clause license. Note that NO WARRANTY is provided. | |
| * See "LICENSE_BSD2.txt" for details. | |
| * | |
| * @TAG(DATA61_BSD) | |
| */ | |
| #ifndef SDIO_H | |
| #define SDIO_H | |
| /* NOT to be confused with SDHC. This API is universal */ | |
| #include <sdhc/plat/sdio.h> | |
| /* TODO turn this into sdio_cmd */ | |
| struct mmc_cmd; | |
| struct sdio_host_dev; | |
| typedef void (*sdio_cb)(struct sdio_host_dev* sdio, int status, struct mmc_cmd* cmd, void* token); | |
| struct sdio_host_dev { | |
| int (*reset)(struct sdio_host_dev* sdio); | |
| int (*send_command)(struct sdio_host_dev* sdio, struct mmc_cmd *cmd, sdio_cb cb, void* token); | |
| int (*handle_irq)(struct sdio_host_dev* sdio, int irq); | |
| int (*is_voltage_compatible)(struct sdio_host_dev* sdio, int mv); | |
| int (*nth_irq)(struct sdio_host_dev* sdio, int n); | |
| void* priv; | |
| }; | |
| typedef struct sdio_host_dev sdio_host_dev_t; | |
| /** | |
| * Send a command to an attached device | |
| * @param[in] sdio A handle to an initialised SDIO driver | |
| * @param[in] cmd A structure that has been filled to represent the command | |
| * that should be sent. | |
| * @param[in] cb A function to be called onces the command has been accepted | |
| * by the connected device. NULL will cause the call to block | |
| * untill the command has been accepted. | |
| * @param[in] token A token to pass, unmodified, to the provided callback function. | |
| * @return 1 if the provided voltage level is supported | |
| */ | |
| static inline int | |
| sdio_send_command(sdio_host_dev_t* sdio, struct mmc_cmd *cmd, sdio_cb cb, void* token) | |
| { | |
| return sdio->send_command(sdio, cmd, cb, token); | |
| } | |
| /** | |
| * Confirm if an SDIO device supports a specific voltage | |
| * @param[in] sdio A handle to an initialised SDIO driver | |
| * @param[in] mv The voltage to be queried, in millivolts | |
| * @return 1 if the provided voltage level is supported | |
| */ | |
| static inline int | |
| sdio_is_voltage_compatible(sdio_host_dev_t* sdio, int mv) | |
| { | |
| return sdio->is_voltage_compatible(sdio, mv); | |
| } | |
| /** | |
| * Resets the provided SDIO device | |
| * @param[in] sdio A handle to an initialised SDIO driver | |
| * @return 0 on success | |
| */ | |
| static inline int | |
| sdio_reset(sdio_host_dev_t* sdio) | |
| { | |
| return sdio->reset(sdio); | |
| } | |
| /** | |
| * Returns the nth IRQ that this device generates | |
| * @param[in] sdio A handle to an initialised SDIO driver | |
| * @param[in] n Index of the desired IRQ. | |
| * @return The IRQ number, or -1 if n is invalid | |
| */ | |
| static inline int | |
| sdio_nth_irq(sdio_host_dev_t* sdio, int n) | |
| { | |
| return sdio->nth_irq(sdio, n); | |
| } | |
| /** | |
| * Passes control to the IRQ handler of the provided SDIO device | |
| * @param[in] sdio A handle to an initialised SDIO driver | |
| * @param[in] irq The IRQ number that was triggered. | |
| * @return 0 if an IRQ was handled | |
| */ | |
| static inline int | |
| sdio_handle_irq(sdio_host_dev_t* sdio, int irq) | |
| { | |
| return sdio->handle_irq(sdio, irq); | |
| } | |
| /** | |
| * Returns the ID of the default SDIO device for the current platform | |
| * @return The default SDIO device for the platform | |
| */ | |
| enum sdio_id sdio_default_id(void); | |
| /** | |
| * Initialises a platform sdio device | |
| * @param[in] id The ID of the sdio device to initialise | |
| * @param[in] io_ops OS services to use during initialisation | |
| * @param[out] dev An sdio structure to populate. | |
| * @return 0 on success | |
| */ | |
| int sdio_init(enum sdio_id id, ps_io_ops_t *io_ops, sdio_host_dev_t* dev); | |
| #endif /* SDIO_H */ |