sdio.h

 
#ifndef _SDIO_H_
#define _SDIO_H_
 
/*******************************************************************************
*                                     Include Files
*******************************************************************************/
 
#include <stdbool.h>
#include <stddef.h>
#include "sdio_registers.h"
#include "syna_device.h"
#include "io_expander.h"
#include "logger.h"
#include "cache.h"
#include "clk.h"
 
 
/***************************************************************************/
 
/*******************************************************************************
* Macro definitions
*******************************************************************************/
 
#define SDIO_BLOCK_SIZE               (512UL) 
 
#define SDIO_SDSC_ADDR_SHIFT          (9U)    
 
/* SD output clock. */
#define SDIO_CLK_400K                 (400UL * 1000UL)          
#define SDIO_CLK_10M                  (10UL * 1000UL * 1000UL)  
#define SDIO_CLK_20M                  (20UL * 1000UL * 1000UL)  
#define SDIO_CLK_25M                  (25UL * 1000UL * 1000UL)  
#define SDIO_CLK_50M                  (50UL * 1000UL * 1000UL)  
#define SDIO_CLK_100M                 (100UL * 1000UL * 1000UL) 
 
#define SDIO_CLK_RAMP_UP_TIME_MS      (100UL)  
 
#ifndef SDIO_CLK_RAMP_UP_TIME_US_WAKEUP     
 
#ifndef SDIO_CLK_RAMP_UP_TIME_MS_WAKEUP     
 
#define SDIO_CLK_RAMP_UP_TIME_US_WAKEUP (1U)  
#else
#define SDIO_CLK_RAMP_UP_TIME_US_WAKEUP (SDIO_CLK_RAMP_UP_TIME_MS_WAKEUP * 1000U)
#endif /* !defined SDIO_CLK_RAMP_UP_TIME_MS_WAKEUP */
#endif /* !defined SDIO_CLK_RAMP_UP_TIME_US_WAKEUP */
 
 
#define SDIO_INIT_CLK_FREQUENCY_KHZ   (400U)  
#define SDIO_3_PERIODS_US             (((1000U * 3U) / SDIO_INIT_CLK_FREQUENCY_KHZ) + 1U)
 
#define SDIO_CARD_IDLE                (0x0UL)  
#define SDIO_CARD_READY               (0x1UL)  
#define SDIO_CARD_IDENT               (0x2UL)  
#define SDIO_CARD_STBY                (0x3UL)  
#define SDIO_CARD_TRAN                (0x4UL)  
#define SDIO_CARD_DATA                (0x5UL)  
#define SDIO_CARD_RCV                 (0x6UL)  
#define SDIO_CARD_PRG                 (0x7UL)  
#define SDIO_CARD_DIS                 (0x8UL)  
 
#define SDIO_CMD13_OUT_OF_RANGE       (31U) 
#define SDIO_CMD13_ADDRESS_ERROR      (30U) 
#define SDIO_CMD13_BLOCK_LEN_ERROR    (29U) 
#define SDIO_CMD13_ERASE_SEQ_ERROR    (28U) 
#define SDIO_CMD13_ERASE_PARAM        (27U) 
#define SDIO_CMD13_WP_VIOLATION       (26U) 
#define SDIO_CMD13_CARD_IS_LOCKED     (25U) 
#define SDIO_CMD13_LOCK_ULOCK_FAILED  (24U) 
#define SDIO_CMD13_COM_CRC_ERROR      (23U) 
#define SDIO_CMD13_ILLEGAL_COMMAND    (22U) 
#define SDIO_CMD13_CARD_ECC_FAILED    (21U) 
#define SDIO_CMD13_CC_ERROR           (20U) 
#define SDIO_CMD13_ERROR              (19U) 
#define SDIO_CMD13_CSD_OVERWRITE      (16U) 
#define SDIO_CMD13_WP_ERASE_SKIP      (15U) 
 
#define SDIO_CMD13_CARD_ECC_DISABLED  (14U) 
 
#define SDIO_CMD13_CURRENT_STATE      (9U)  
#define SDIO_CMD13_READY_FOR_DATA     (8U)  
#define SDIO_CMD13_APP_CMD            (5U)  
#define SDIO_CMD13_AKE_SEQ_ERROR      (3U)  
 
#define SDIO_CMD13_CURRENT_STATE_MSK  (0x00001E00UL) 
 
 
 

#define SDIO_CMD_COMPLETE            (0x0001U)

#define SDIO_XFER_COMPLETE           (0x0002U)

#define SDIO_BGAP                    (0x0004U)

#define SDIO_DMA_INTERRUPT           (0x0008U)

#define SDIO_BUF_WR_READY            (0x0010U)

#define SDIO_BUF_RD_READY            (0x0020U)

#define SDIO_CARD_INSERTION          (0x0040U)

#define SDIO_CARD_REMOVAL            (0x0080U)

#define SDIO_CARD_INTERRUPT          (0x0100U)

#define SDIO_FX_EVENT                (0x2000U)

#define SDIO_ERR_INTERRUPT           (0x8000U)

#define SDIO_CUR_LMT_ERR             (0x0080U)

#define SDIO_ADMA_ERR                (0x0200U)

#define SDIO_TUNING_ERR              (0x0400U)

#define SDIO_DAT_7_4                 (0x000000F0UL)

#define SDIO_BUF_WR_ENABLE           (0x00000400UL)

#define SDIO_BUF_RD_ENABLE           (0x00000800UL)

#define SDIO_CARD_INSERTED           (0x00010000UL)

#define SDIO_CARD_STABLE             (0x00020000UL)

#define SDIO_CARD_DETECT_PIN_LEVEL   (0x00040000UL)

#define SDIO_WR_PROTECT_SW_LVL       (0x00080000UL)

#define SDIO_DAT_3_0                 (0x00F00000UL)

#define SDIO_DAT_0_Msk               (0x00100000UL)

#define SDIO_CMD_LINE_LVL            (0x01000000UL)

#define SDIO_HOST_REG_VOL            (0x02000000UL)

#define SDIO_CMD_ISSU_ERR            (0x08000000UL)

#define SDIO_SUB_CMD_STAT            (0x10000000UL)
 
/******************************************************************************
 * Enumerations
 *****************************************************************************/


typedef enum
{
    SDIO_CMD_NORMAL     = 0U,  
    SDIO_CMD_SUSPEND    = 1U,  
    SDIO_CMD_RESUME     = 2U,  
    SDIO_CMD_ABORT      = 3U   
}sdio_cmd_type_en;

typedef enum
{
    SDIO_AUTO_CMD_NONE  = 0U,  
    SDIO_AUTO_CMD_12    = 1U,  
    SDIO_AUTO_CMD_23    = 2U,  
    SDIO_AUTO_CMD_AUTO  = 3U   
}sdio_auto_cmd_en;

typedef enum
{
    SDIO_RESET_DATALINE = 0U,  
    SDIO_RESET_CMD_LINE = 1U,  
    SDIO_RESET_ALL      = 2U   
}sdio_reset_en;

typedef enum
{
    SDIO_ADMA_ST_STOP   = 0U,   
 
    SDIO_ADMA_ST_FDS    = 1U,   
 
    SDIO_ADMA_ST_TFR    = 3U,   
 
    SDIO_ADMA_LEN_ERR   = 4U   
}sdio_adma_error_en;

typedef enum
{
    SDIO_AUTO_CMD12_NOT_EXEC         = 0U,  
    SDIO_AUTO_CMD_TOUT_ERR           = 1U,  
    SDIO_AUTO_CMD_CRC_ERR            = 2U,  
    SDIO_AUTO_CMD_EBIT_ERR           = 3U,  
    SDIO_AUTO_CMD_IDX_ERR            = 4U,  
    SDIO_AUTO_CMD_RESP_ERR           = 5U,  
    SDIO_CMD_NOT_ISSUED_AUTO_CMD12   = 7U   
} sdio_auto_cmd_status_en;

typedef enum
{
    SDIO_OK                          = 0U,   
    SDIO_ERROR                       = 1U,   
    SDIO_ERROR_INVALID_PARAMETER     = 2U,   
    SDIO_ERROR_OPERATION_IN_PROGRESS = 3U,   
    SDIO_ERROR_UNINITIALIZED         = 4U,   
    SDIO_ERROR_TIMEOUT               = 5U,   
    SDIO_ERROR_UNUSABLE_CARD         = 6U,   
    SDIO_ERROR_DISCONNECTED          = 7U,   
    SDIO_ERROR_CRC                   = 8U,   
    SDIO_ERROR_DATA_END_BIT          = 9U,   
    SDIO_ERROR_GENERAL               = 10U,  
    SDIO_ERROR_NOT_SUPPORTED         = 11U,  
    SDIO_ERROR_DATA_INTEGRITY        = 12U   
} sdio_status_en;

typedef enum
{
    SDIO_BUS_WIDTH_1_BIT              = 0U,  
    SDIO_BUS_WIDTH_4_BIT              = 1U,  
} sdio_bus_width_en;

typedef enum
{
    SDIO_BUS_SPEED_DEFAULT      = 0U,  
    SDIO_BUS_SPEED_HIGHSPEED    = 1U,  
    SDIO_BUS_SPEED_SDR12_5      = 2U,  
    SDIO_BUS_SPEED_SDR25        = 3U,  
    SDIO_BUS_SPEED_SDR50        = 4U,  
} sdio_bus_speed_mode_en;

typedef enum
{
    SDIO_ERASE_ERASE               = 0U,  
    SDIO_ERASE_DISCARD             = 1U,  
    SDIO_ERASE_FULE                = 2U,  
    SDIO_ERASE_SECURE              = 3U,  
    SDIO_ERASE_SECURE_TRIM_STEP_2  = 4U,  
    SDIO_ERASE_SECURE_TRIM_STEP_1  = 5U,  
    SDIO_ERASE_TRIM                = 6U   
} sdio_erase_type_en;

typedef enum
{
    SDIO_SD               = 0U,  
    SDIO_SDIO             = 1U,  
    SDIO_COMBO            = 3U,  
    SDIO_UNUSABLE         = 4U,  
} sdio_card_type_en;

typedef enum
{
    SDIO_SDSC             = 0U,   
    SDIO_SDHC             = 1U,   
    SDIO_SDXC             = 2U,   
    SDIO_UNSUPPORTED      = 4U    
}sdio_card_capacity_en;

typedef enum
{
    SDIO_RESPONSE_NONE    = 0U, 
    
    SDIO_RESPONSE_LEN_136 = 1U, 
    
    SDIO_RESPONSE_LEN_48  = 2U, 
    
    SDIO_RESPONSE_LEN_48B = 3U, 
} sdio_response_type_en;
 

typedef enum
{
    SDIO_DMA_SDMA         = 0U, 
    SDIO_DMA_ADMA2        = 2U, 
}sdio_dma_type_en;

typedef enum
{
    SDIO_PERMANENT         = 0U, 
    SDIO_ENABLE_TEMPORARY  = 1U, 
    SDIO_DISABLE_TEMPORARY = 2U  
} sdio_write_protect_en;

typedef enum
{
    SDIO_AKE_SEQ_ERROR_R1_RESP         = 3U,  
    SDIO_APP_CMD_R1_RESP               = 5U,  
    SDIO_FX_EVENT_R1_RESP              = 6U,  
    SDIO_READY_FOR_DATA_R1_RESP        = 8U,  
    SDIO_CURRENT_STATE_0_R1_RESP       = 9U,  
    SDIO_CURRENT_STATE_1_R1_RESP       = 10U, 
    SDIO_CURRENT_STATE_2_R1_RESP       = 11U, 
    SDIO_CURRENT_STATE_3_R1_RESP       = 12U, 
    SDIO_ERASE_RESET_R1_RESP           = 13U, 
    SDIO_CARD_ECC_DISABLED_R1_RESP     = 14U, 
    SDIO_WP_ERASE_SKIP_R1_RESP         = 15U, 
    SDIO_CSD_OVERWRITE_R1_RESP         = 16U, 
    SDIO_ERROR_R1_RESP                 = 19U, 
    SDIO_CC_ERROR_R1_RESP              = 20U, 
    SDIO_CARD_ECC_FAILED_R1_RESP       = 21U, 
    SDIO_ILLEGAL_COMMAND_R1_RESP       = 22U, 
    SDIO_COM_CRC_ERROR_R1_RESP         = 23U, 
    SDIO_LOCK_UNLOCK_FAILED_R1_RESP    = 24U, 
    SDIO_CARD_IS_LOCKED_R1_RESP        = 25U, 
    SDIO_WP_VIOLATION_R1_RESP          = 26U, 
    SDIO_ERASE_PARAM_R1_RESP           = 27U, 
    SDIO_ERASE_SEQ_ERROR_R1_RESP       = 28U, 
    SDIO_BLOCK_LEN_ERROR_R1_RESP       = 29U, 
    SDIO_ADDRESS_ERROR_R1_RESP         = 30U, 
    SDIO_OUT_OF_RANGE_R1_RESP          = 31U, 
} sdio_r1_response_en;

 
/*******************************************************************************
* Type Definitions
*******************************************************************************/

typedef struct
{
    sdio_dma_type_en        dmaType;          
}sdio_config_t;

typedef struct
{
    bool                    lowVoltageSignaling;
    sdio_bus_width_en       busWidth;           
    sdio_card_type_en       *cardType;          
    uint32_t                *rca;               
    sdio_card_capacity_en   *cardCapacity;      
    uint32_t                clockSpeed;         
    uint32_t                busSpeed;           
}sdio_sd_card_config_t;
 

typedef struct
{
    uint32_t                  commandIndex;                 
    uint32_t                  commandArgument;              
    bool                      enableCrcCheck;               
    bool                      enableAutoResponseErrorCheck; 
    sdio_response_type_en    respType;                     
    bool                      enableIdxCheck;             
    bool                      dataPresent;                   
    sdio_cmd_type_en           cmdType;                     
} sdio_cmd_config_t;

typedef struct
{
    uint32_t                  blockSize;            
    uint32_t                  numberOfBlock;        
    bool                      enableDma;            
    sdio_auto_cmd_en          autoCommand;          
    bool                      read;                 
    uint32_t*                 data;                 
    uint32_t                  dataTimeout;          
    bool                      enableIntAtBlockGap;  
    bool                      enReliableWrite;      
}sdio_data_config_t;

typedef struct
{
    uint32_t*                 data;            
    uint32_t                  address;         
    uint32_t                  numberOfBlocks;  
    sdio_auto_cmd_en          autoCommand;     
    uint32_t                  dataTimeout;     
    bool                      enReliableWrite; 
    bool                      enableDma;       
} sdio_write_read_config_t;

 
 
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
 
/* High level section */
 
/*******************************************************************************
* Function Name: sdio_init
****************************************************************************/
 
sdio_status_en sdio_init(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_deinit
****************************************************************************/
sdio_status_en sdio_deinit(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_enable
****************************************************************************/
sdio_status_en sdio_enable(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_disable
****************************************************************************/
sdio_status_en sdio_disable(sdio_instance_en id);
 
 
/*******************************************************************************
* Function Name: sdio_config
****************************************************************************/
sdio_status_en sdio_config(sdio_instance_en id,
                                      const sdio_config_t* config);
 
 
/*******************************************************************************
* Function Name: sdio_sd_card_init
****************************************************************************/
sdio_status_en sdio_sd_card_init(sdio_instance_en id,
                                     sdio_sd_card_config_t *config);
 
/*******************************************************************************
* Function Name: sdio_sd_card_read
****************************************************************************/
sdio_status_en sdio_sd_card_read(sdio_instance_en id,
                                     sdio_write_read_config_t *config);
 
/*******************************************************************************
* Function Name: sdio_sd_card_write
****************************************************************************/
sdio_status_en sdio_sd_card_write(sdio_instance_en id,
                                      sdio_write_read_config_t *config);
 
/*******************************************************************************
* Function Name: sdio_sd_card_erase
****************************************************************************/
sdio_status_en sdio_sd_card_erase(sdio_instance_en id,
                          uint32_t startAddr,
                          uint32_t endAddr,
                          sdio_erase_type_en eraseType);
 
/*******************************************************************************
* Function Name: sdio_set_sd_clk_div
****************************************************************************/
sdio_status_en sdio_set_sd_clk_div(sdio_instance_en id, uint16_t clkDiv);
 
/*******************************************************************************
* Function Name: sdio_is_wp_set
****************************************************************************/
bool sdio_is_wp_set(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_set_host_bus_width
****************************************************************************/
sdio_status_en sdio_set_host_bus_width(sdio_instance_en id,
                                             sdio_bus_width_en width);
 
/*******************************************************************************
* Function Name: sdio_set_bus_width
****************************************************************************/
sdio_status_en sdio_set_bus_width(sdio_instance_en id,sdio_bus_width_en width);
 
/*******************************************************************************
* Function Name: sdio_set_host_speed_mode
****************************************************************************/
sdio_status_en sdio_set_host_speed_mode(sdio_instance_en id,
                                             sdio_bus_speed_mode_en speedMode);
 
/*******************************************************************************
* Function Name: sdio_set_bus_speed_mode
****************************************************************************/
sdio_status_en sdio_set_bus_speed_mode(sdio_instance_en id,
                                               sdio_bus_speed_mode_en speedMode);
 
/*******************************************************************************
* Function Name: sdio_sel_bus_voltage
****************************************************************************/
sdio_status_en sdio_sel_bus_voltage(sdio_instance_en id,
                                              bool enable18VSignal);
 
/*******************************************************************************
* Function Name: sdio_enable_card_voltage
****************************************************************************/
void sdio_enable_card_voltage(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_disable_card_voltage
****************************************************************************/
void sdio_disable_card_voltage(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_get_response
****************************************************************************/
sdio_status_en sdio_get_response(sdio_instance_en id,
                                          uint32_t *responsePtr,
                                          bool largeResponse);
 
/*******************************************************************************
* Function Name: sdio_send_command
****************************************************************************/
sdio_status_en sdio_send_command(sdio_instance_en id,
                                          sdio_cmd_config_t const *config);
 
/*******************************************************************************
* Function Name: sdio_init_data_transfer
****************************************************************************/
sdio_status_en sdio_init_data_transfer(sdio_instance_en id,
                                              sdio_data_config_t const *dataConfig);
 
/*******************************************************************************
* Function Name: sdio_abort_transfer
****************************************************************************/
sdio_status_en sdio_abort_transfer(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_write_protect
****************************************************************************/
sdio_status_en sdio_write_protect(sdio_instance_en id,sdio_write_protect_en writeProtect);
 
/*******************************************************************************
* Function Name: sdio_get_card_status
****************************************************************************/
uint32_t sdio_get_card_status(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_get_ocr
****************************************************************************/
uint32_t sdio_get_ocr(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_get_cid
****************************************************************************/
sdio_status_en sdio_get_cid(sdio_instance_en id, uint32_t *cid);
 
/*******************************************************************************
* Function Name: sdio_get_csd
****************************************************************************/
sdio_status_en sdio_get_csd(sdio_instance_en id,
                                      uint32_t *csd);
 
/*******************************************************************************
* Function Name: sdio_get_rca
****************************************************************************/
uint32_t sdio_get_rca(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_get_scr
****************************************************************************/
sdio_status_en sdio_get_scr(sdio_instance_en id,
                                      uint32_t *scr);
 
/*******************************************************************************
* Function Name: sdio_get_present_state
****************************************************************************/
uint32_t sdio_get_present_state(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_is_card_connected
****************************************************************************/
bool sdio_is_card_connected(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_software_reset
****************************************************************************/
sdio_status_en sdio_software_reset(sdio_instance_en id, sdio_reset_en reset);
 
/*******************************************************************************
* Function Name: sdio_get_block_count
****************************************************************************/
sdio_status_en sdio_get_block_count(sdio_instance_en id,uint32_t *block_count);
 
/*******************************************************************************
* Function Name: sdio_get_normal_interrupt_status
****************************************************************************/
uint32_t sdio_get_normal_interrupt_status(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_clear_normal_interrupt_status
****************************************************************************/
void sdio_clear_normal_interrupt_status(sdio_instance_en id, uint32_t status);
 
/*******************************************************************************
* Function Name: sdio_set_error_interrupt_enable
****************************************************************************/
void sdio_set_error_interrupt_enable(sdio_instance_en id, uint32_t interrupt);
 
/*******************************************************************************
* Function Name: sdio_clear_error_interrupt_status
****************************************************************************/
void sdio_clear_error_interrupt_status(sdio_instance_en id, uint32_t status);
 
/*******************************************************************************
* Function Name: sdio_set_normal_interrupt_enable
****************************************************************************/
void sdio_set_normal_interrupt_enable(sdio_instance_en id, uint32_t interrupt);
 
/*******************************************************************************
* Function Name: sdio_buffer_write
****************************************************************************/
sdio_status_en  sdio_buffer_write(sdio_instance_en id, uint32_t data);
 
/*******************************************************************************
* Function Name: sdio_buffer_read
****************************************************************************/
uint32_t  sdio_buffer_read(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_ops_go_idle
****************************************************************************/
sdio_status_en sdio_ops_go_idle(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_set_host_voltage
****************************************************************************/
sdio_status_en sdio_set_host_voltage(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_change_clock
****************************************************************************/
sdio_status_en sdio_change_clock(sdio_instance_en id, uint32_t frequency);
 
/*******************************************************************************
* Function Name: sdio_set_block_size_count
****************************************************************************/
void sdio_set_block_size_count(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_ops_send_io_rw_direct_cmd
****************************************************************************/
sdio_status_en sdio_ops_send_io_rw_direct_cmd(sdio_instance_en id,
                                              uint32_t rwFlag,
                                              uint32_t functionNumber,
                                              uint32_t rawFlag,
                                              uint32_t registerAddress,
                                              uint32_t data);
 
/*******************************************************************************
* Function Name: sdio_ops_sdio_send_op_cond
****************************************************************************/
sdio_status_en sdio_ops_sdio_send_op_cond(sdio_instance_en id,
                                          uint32_t *ocrReg,
                                          uint32_t cmdArgument);
 
/*******************************************************************************
* Function Name: sdio_ops_select_card
****************************************************************************/
sdio_status_en sdio_ops_select_card(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_fetch_rca
****************************************************************************/
sdio_status_en sdio_fetch_rca(sdio_instance_en id);
 
/*******************************************************************************
* Function Name: sdio_cmd_rx_data
****************************************************************************/
sdio_status_en sdio_cmd_rx_data(sdio_instance_en id, sdio_data_config_t *pcmd);
 
/*******************************************************************************
* Function Name: sdio_cmd_tx_data
****************************************************************************/
sdio_status_en sdio_cmd_tx_data(sdio_instance_en id, sdio_data_config_t *pcmd);
 
/*******************************************************************************
* Function Name: sdio_set_normal_interrupt_mask
****************************************************************************/
void sdio_set_normal_interrupt_mask(sdio_instance_en id, uint32_t interruptMask);
 
/*******************************************************************************
* Function Name: sdio_isr
****************************************************************************/
ISR_CODE uint32_t sdio_isr(sdio_instance_en id);

#endif  /*_SDIO_H_*/