cfn_hal_sdio.h File Reference

SDIO / SDMMC HAL API. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures
struct	cfn_hal_sdio_cmd_t
	SDIO command configuration. More...
struct	cfn_hal_sdio_card_info_t
	SDIO card information. More...
struct	cfn_hal_sdio_config_t
	SDIO configuration structure. More...
struct	cfn_hal_sdio_phy_t
	SDIO hardware physical mapping. More...
struct	cfn_hal_sdio_api_s
	SDIO Virtual Method Table (VMT). More...

Typedefs
typedef struct cfn_hal_sdio_s	cfn_hal_sdio_t
typedef struct cfn_hal_sdio_api_s	cfn_hal_sdio_api_t
typedef void(*	cfn_hal_sdio_callback_t) (cfn_hal_sdio_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
	SDIO callback signature.

Enumerations
enum	cfn_hal_sdio_event_t { CFN_HAL_SDIO_EVENT_NONE = 0 , CFN_HAL_SDIO_EVENT_TX_COMPLETE = CFN_HAL_BIT(0) , CFN_HAL_SDIO_EVENT_RX_READY = CFN_HAL_BIT(1) , CFN_HAL_SDIO_EVENT_CMD_SENT = CFN_HAL_BIT(2) }
	SDIO nominal event flags. More...
enum	cfn_hal_sdio_error_t { CFN_HAL_SDIO_ERROR_NONE = 0 , CFN_HAL_SDIO_ERROR_CRC = CFN_HAL_BIT(0) , CFN_HAL_SDIO_ERROR_TIMEOUT = CFN_HAL_BIT(1) , CFN_HAL_SDIO_ERROR_GENERAL = CFN_HAL_BIT(2) }
	SDIO exception error flags. More...

Functions
	CFN_HAL_VMT_CHECK (struct cfn_hal_sdio_api_s)
	CFN_HAL_CREATE_DRIVER_TYPE (sdio, cfn_hal_sdio_config_t, cfn_hal_sdio_api_t, cfn_hal_sdio_phy_t, cfn_hal_sdio_callback_t)
CFN_HAL_INLINE void	cfn_hal_sdio_populate (cfn_hal_sdio_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_sdio_api_t *api, const cfn_hal_sdio_phy_t *phy, const cfn_hal_sdio_config_t *config, cfn_hal_sdio_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_config_validate (const cfn_hal_sdio_t *driver, const cfn_hal_sdio_config_t *config)
	Validates the SDIO configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_init (cfn_hal_sdio_t *driver)
	Initializes the SDIO driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_deinit (cfn_hal_sdio_t *driver)
	Deinitializes the SDIO driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_config_set (cfn_hal_sdio_t *driver, const cfn_hal_sdio_config_t *config)
	Sets the SDIO configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_config_get (cfn_hal_sdio_t *driver, cfn_hal_sdio_config_t *config)
	Gets the current SDIO configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_callback_register (cfn_hal_sdio_t *driver, const cfn_hal_sdio_callback_t callback, void *user_arg)
	Registers a callback for SDIO events and errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_power_state_set (cfn_hal_sdio_t *driver, cfn_hal_power_state_t state)
	Sets the SDIO power state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_event_enable (cfn_hal_sdio_t *driver, uint32_t event_mask)
	Enables one or more SDIO nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_event_disable (cfn_hal_sdio_t *driver, uint32_t event_mask)
	Disables one or more SDIO nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_event_get (cfn_hal_sdio_t *driver, uint32_t *event_mask)
	Retrieves the current SDIO nominal event status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_error_enable (cfn_hal_sdio_t *driver, uint32_t error_mask)
	Enables one or more SDIO exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_error_disable (cfn_hal_sdio_t *driver, uint32_t error_mask)
	Disables one or more SDIO exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_error_get (cfn_hal_sdio_t *driver, uint32_t *error_mask)
	Retrieves the current SDIO exception error status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_send_command (cfn_hal_sdio_t *driver, const cfn_hal_sdio_cmd_t *cmd, uint32_t *response)
	Sends an SD/MMC command and waits for a response.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_read_blocks (cfn_hal_sdio_t *driver, uint8_t *buffer, uint32_t block_addr, uint32_t nbr_of_blocks, uint32_t timeout)
	Reads data blocks from the SD card.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_write_blocks (cfn_hal_sdio_t *driver, const uint8_t *data, uint32_t block_addr, uint32_t nbr_of_blocks, uint32_t timeout)
	Writes data blocks to the SD card.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_get_card_info (cfn_hal_sdio_t *driver, cfn_hal_sdio_card_info_t *info)
	Retrieves card-specific registers and capacity.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_sdio_wait_card_ready (cfn_hal_sdio_t *driver, uint32_t timeout)
	Waits until the SD card is no longer busy.
cfn_hal_error_code_t	cfn_hal_sdio_construct (cfn_hal_sdio_t *driver, const cfn_hal_sdio_config_t *config, const cfn_hal_sdio_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_sdio_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_hal_sdio_destruct (cfn_hal_sdio_t *driver)

Detailed Description

SDIO / SDMMC HAL API.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

cfn_hal_sdio_api_t

typedef struct cfn_hal_sdio_api_s cfn_hal_sdio_api_t

cfn_hal_sdio_callback_t

typedef void(* cfn_hal_sdio_callback_t) (cfn_hal_sdio_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

SDIO callback signature.

Parameters

driver	Pointer to the SDIO driver instance.
event_mask	Mask of triggered nominal events.
error_mask	Mask of triggered exception errors.
user_arg	User-defined argument passed during registration.

cfn_hal_sdio_t

typedef struct cfn_hal_sdio_s cfn_hal_sdio_t

Enumeration Type Documentation

cfn_hal_sdio_error_t

enum cfn_hal_sdio_error_t

SDIO exception error flags.

Enumerator
CFN_HAL_SDIO_ERROR_NONE
CFN_HAL_SDIO_ERROR_CRC	CRC mismatch in command or data
CFN_HAL_SDIO_ERROR_TIMEOUT	Command or data timeout
CFN_HAL_SDIO_ERROR_GENERAL	General hardware error

cfn_hal_sdio_event_t

enum cfn_hal_sdio_event_t

SDIO nominal event flags.

Enumerator
CFN_HAL_SDIO_EVENT_NONE
CFN_HAL_SDIO_EVENT_TX_COMPLETE	Block transmission finished
CFN_HAL_SDIO_EVENT_RX_READY	Block reception finished
CFN_HAL_SDIO_EVENT_CMD_SENT	Command sent and response received

Function Documentation

CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE	(	sdio	,
		cfn_hal_sdio_config_t	,
		cfn_hal_sdio_api_t	,
		cfn_hal_sdio_phy_t	,
		cfn_hal_sdio_callback_t
	)

cfn_hal_sdio_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_callback_register	(	cfn_hal_sdio_t *	driver,
		const cfn_hal_sdio_callback_t	callback,
		void *	user_arg
	)

Registers a callback for SDIO events and errors.

Parameters

driver	Pointer to the SDIO driver instance.
callback	The callback function to register.
user_arg	User-defined argument passed to the callback.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_config_get	(	cfn_hal_sdio_t *	driver,
		cfn_hal_sdio_config_t *	config
	)

Gets the current SDIO configuration.

Parameters

driver	Pointer to the SDIO driver instance.
config	[out] Pointer to store the configuration.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_config_set	(	cfn_hal_sdio_t *	driver,
		const cfn_hal_sdio_config_t *	config
	)

Sets the SDIO configuration.

Parameters

driver	Pointer to the SDIO driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_config_validate	(	const cfn_hal_sdio_t *	driver,
		const cfn_hal_sdio_config_t *	config
	)

Validates the SDIO configuration.

Parameters

driver	Pointer to the SDIO driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_construct()

cfn_hal_error_code_t cfn_hal_sdio_construct	(	cfn_hal_sdio_t *	driver,
		const cfn_hal_sdio_config_t *	config,
		const cfn_hal_sdio_phy_t *	phy,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		cfn_hal_sdio_callback_t	callback,
		void *	user_arg
	)

cfn_hal_sdio_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_deinit

(

cfn_hal_sdio_t *

driver

)

Deinitializes the SDIO driver.

Parameters

driver

Pointer to the SDIO driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_destruct()

cfn_hal_error_code_t cfn_hal_sdio_destruct

(

cfn_hal_sdio_t *

driver

)

cfn_hal_sdio_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_error_disable	(	cfn_hal_sdio_t *	driver,
		uint32_t	error_mask
	)

Disables one or more SDIO exception errors.

Parameters

driver	Pointer to the SDIO driver instance.
error_mask	Mask of errors to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_error_enable	(	cfn_hal_sdio_t *	driver,
		uint32_t	error_mask
	)

Enables one or more SDIO exception errors.

Parameters

driver	Pointer to the SDIO driver instance.
error_mask	Mask of errors to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_error_get	(	cfn_hal_sdio_t *	driver,
		uint32_t *	error_mask
	)

Retrieves the current SDIO exception error status.

Parameters

driver	Pointer to the SDIO driver instance.
error_mask	[out] Pointer to store the error mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_event_disable	(	cfn_hal_sdio_t *	driver,
		uint32_t	event_mask
	)

Disables one or more SDIO nominal events.

Parameters

driver	Pointer to the SDIO driver instance.
event_mask	Mask of events to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_event_enable	(	cfn_hal_sdio_t *	driver,
		uint32_t	event_mask
	)

Enables one or more SDIO nominal events.

Parameters

driver	Pointer to the SDIO driver instance.
event_mask	Mask of events to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_event_get	(	cfn_hal_sdio_t *	driver,
		uint32_t *	event_mask
	)

Retrieves the current SDIO nominal event status.

Parameters

driver	Pointer to the SDIO driver instance.
event_mask	[out] Pointer to store the event mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_get_card_info()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_get_card_info	(	cfn_hal_sdio_t *	driver,
		cfn_hal_sdio_card_info_t *	info
	)

Retrieves card-specific registers and capacity.

Parameters

driver	Pointer to the SDIO driver instance.
info	[out] Pointer to the card info structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_init

(

cfn_hal_sdio_t *

driver

)

Initializes the SDIO driver.

Parameters

driver

Pointer to the SDIO driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_populate()

CFN_HAL_INLINE void cfn_hal_sdio_populate	(	cfn_hal_sdio_t *	driver,
		uint32_t	peripheral_id,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		const cfn_hal_sdio_api_t *	api,
		const cfn_hal_sdio_phy_t *	phy,
		const cfn_hal_sdio_config_t *	config,
		cfn_hal_sdio_callback_t	callback,
		void *	user_arg
	)

cfn_hal_sdio_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_power_state_set	(	cfn_hal_sdio_t *	driver,
		cfn_hal_power_state_t	state
	)

Sets the SDIO power state.

Parameters

driver	Pointer to the SDIO driver instance.
state	Target power state.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_read_blocks()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_read_blocks	(	cfn_hal_sdio_t *	driver,
		uint8_t *	buffer,
		uint32_t	block_addr,
		uint32_t	nbr_of_blocks,
		uint32_t	timeout
	)

Reads data blocks from the SD card.

Parameters

driver	Pointer to the SDIO driver instance.
buffer	Pointer to the destination memory.
block_addr	Address of the first block to read.
nbr_of_blocks	Number of blocks to transfer.
timeout	Timeout duration in milliseconds.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_send_command()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_send_command	(	cfn_hal_sdio_t *	driver,
		const cfn_hal_sdio_cmd_t *	cmd,
		uint32_t *	response
	)

Sends an SD/MMC command and waits for a response.

Parameters

driver	Pointer to the SDIO driver instance.
cmd	Pointer to the command configuration structure.
response	[out] Pointer to store the card response.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_wait_card_ready()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_wait_card_ready	(	cfn_hal_sdio_t *	driver,
		uint32_t	timeout
	)

Waits until the SD card is no longer busy.

Parameters

driver	Pointer to the SDIO driver instance.
timeout	Timeout duration in milliseconds.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_sdio_write_blocks()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_sdio_write_blocks	(	cfn_hal_sdio_t *	driver,
		const uint8_t *	data,
		uint32_t	block_addr,
		uint32_t	nbr_of_blocks,
		uint32_t	timeout
	)

Writes data blocks to the SD card.

Parameters

driver	Pointer to the SDIO driver instance.
data	Pointer to the source data.
block_addr	Address of the first block to write.
nbr_of_blocks	Number of blocks to transfer.
timeout	Timeout duration in milliseconds.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_hal_sdio_api_s

)