SDIF

SDIF

简要说明

SDIF(SD Interface)是在SD内存卡接口的基础上发展起来的接口，接口兼容以前的SD内存卡，并且可以连接SD接口的设备。同时支持高速、低速模式。

接口描述

drv_sdif_initialize

sdif_handle_t drv_sdif_initialize(uint32_t idx, sdif_callback_t *callback, 
                                  void *user_data);

• 功能描述:

  • 通过设备号初始化对应的SDIF实例，返回SDIF实例的句柄。

• 参数:

  • idx: 设备号。

  • callback: sdif实例的事件回调函数。应用可根据回调函数做相应的行为。回调函数原型定义见sdif_callback_t。

  /* \brief sdif callback functions. */
    typedef struct {
        void (*card_inserted)(uint32_t idx, void *user_data); ///< card insert call back
        void (*card_removed)(uint32_t idx, void *user_data);  ///< card remove call back      
        void (*sdif_interrupt)(uint32_t idx, void *user_data);  ///< SDIF card interrupt occurs   
        void (*dma_des_unavailable)(uint32_t idx, void *user_data); ///< DMA descriptor unavailable
        void (*command_reload)(uint32_t idx, void *user_data); ///< command buffer full,need re-load    
        void (*transfer_complete)(uint32_t idx, void *state, int32_t status, void *user_data); ///<Transfer complete callback
    } sdif_callback_t;

• user_data:用户回调函数参数。

• 返回值:

  • NULL: 初始化失败。
  • 其它: 实例句柄。

sdif_callback_t:

drv_sdif_uninitialize

void drv_sdif_uninitialize(sdif_handle_t handle);

• 功能描述:

  • 反初始化SDIF实例。

• 参数:

  • handle: SDIF 实例句柄。

• 返回值:

  • 无。

drv_sdif_config

void drv_sdif_config(sdif_handle_t handle, sdif_config_t *config);

• 功能描述:
  • SDIF实例配置。
• 参数:
  • handle: SDIF 实例句柄。
  • config: SDIF 配置参数，见sdif_config_t定义。
• 返回值:
  • 无。

sdif_config_t：

drv_sdif_get_capabilities

void drv_sdif_get_capabilities(sdif_handle_t handle, sdif_capability_t *capability);

• 功能描述:
  • 获取SDIF实例的功能列表。
• 参数:
  • handle: SDIF 实例句柄。
  • capability: SDIF 功能列表，见sdif_capability_t定义。
• 返回值:
  • 无。

sdif_capability_t：

sdif_capability_flag_e：

drv_sdif_power_control

int32_t drv_sdif_power_control(sdif_handle_t handle, csi_power_stat_e state);

• 功能描述:
  • 获取SDIF实例功率控制。
• 参数:
  • handle: SDIF 实例句柄。
  • state: 功率状态设置，见csi_power_stat_e定义。
• 返回值:
  • 0：成功。
  • 其他：错误码。

csi_power_stat_e:

drv_sdif_send_command

int32_t drv_sdif_send_command(sdif_handle_t handle, sdif_command_t *cmd, 
                              uint32_t retries);

• 功能描述:
  • SDIF发送指令。
• 参数:
  • handle: SDIF 实例句柄。
  • cmd: 发送的命令，见sdif_command_t定义。
  • retries: 命令重试次数。
• 返回值:
  • 0：成功。
  • 其他：错误码。

sdif_command_t：

drv_sdif_transfer

int32_t drv_sdif_transfer(sdif_handle_t handle, sdif_dma_config_t *dma_config,                                       sdif_transfer_t *transfer);

• 功能描述:
  • SDIF传输函数，在轮询/非阻塞模式下传输 数据/指令。
• 参数:
  • handle: SDIF 实例句柄。
  • dma_config: dma的参数配置，此参数为NULL使用轮询发送，配置DMA参数使用dma发送，参数见sdif_dma_config_t定义。
  • transfer: sdif传输配置，见sdif_transfer_t定义。
• 返回值:
  • 0：成功。
  • 其他：错误码。

sdif_dma_config_t：

sdif_transfer_t：

sdif_data_t：

drv_sdif_transfer_abort

void drv_sdif_transfer_abort(sdif_handle_t handle);

• 功能描述:
  • SDIF中止传输。
• 参数:
  • handle: SDIF 实例句柄。
• 返回值:
  • 无。

drv_sdif_bus_width

void drv_sdif_bus_width(sdif_handle_t handle, sdif_bus_width_e bus_width);

• 功能描述:
  • SDIF设置总线宽度。
• 参数:
  • handle: SDIF 实例句柄。
  • bus_width: sdif设置总线宽度，见bus_width定义。
• 返回值:
  • 无。

drv_sdif_set_clock

uint32_t drv_sdif_set_clock(sdif_handle_t handle, uint32_t target_hz);

• 功能描述:
  • SDIF设置时钟频率。
• 参数:
  • handle: SDIF 实例句柄。
  • target_hz: 设置时钟频率。
• 返回值:
  • 0：成功。
  • 其他：错误码。

drv_sdif_get_handle

sdif_handle_t drv_sdif_get_handle(uint32_t idx);

• 功能描述:
  • SDIF通过设备号获取实例句柄。
• 参数:
  • idx: 设备号。
• 返回值:
  • NULL：失败。
  • 其他：实例句柄。

drv_sdif_get_idx

uint32_t drv_sdif_get_idx(sdif_handle_t handle);

• 功能描述:
  • SDIF通过实例句柄获取设备号。
• 参数:
  • handle: SDIF 实例句柄。
• 返回值:
  • 设备号