sdrv_xspi_slv.h

Go to the documentation of this file.

 
#ifndef _SDRV_XSPI_SLV_H_
#define _SDRV_XSPI_SLV_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <debug.h>
#include <stdlib.h>
#include <types.h>
 
#include <sdrv_ckgen.h>
#include <sdrv_common.h>
enum sdrv_xspi_master_error {
    SSDRV_STATUS_GROUP_XSPI_SLAVER_SET_FLAG_ATTR_ERR = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_XSPI_MST_SLV, 1), 
    SSDRV_STATUS_GROUP_XSPI_SLAVER_GET_FLAG_ATTR_ERR = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_XSPI_MST_SLV, 2), 
    SSDRV_STATUS_GROUP_XSPI_SLAVER_GET_STATUS_ERR = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_XSPI_MST_SLV, 3), 
};
 
enum sdrv_xspi_slv_bit_endian {
    XSPI_SLV_BIG_ENDIAN,    
    XSPI_SLV_LITTLE_ENDIAN  
};
 
enum sdrv_xspi_slv_tx_mode {
    XSPI_SLV_DQS_DIV2_ACLK, 
    XSPI_SLV_DQS_SCLK       
};
 
enum sdrv_xspi_slv_line {
    XSPI_SLV_1_LINE, 
    XSPI_SLV_4_LINE, 
    XSPI_SLV_8_LINE, 
    XSPI_SLV_16_LINE 
};
 
enum sdrv_xspi_slv_mode {
    XSPI_SLV_INDIRECT_MODE, 
    XSPI_SLV_DIRECT_MODE    
};
 
struct sdrv_xspi_slv_sclk_idle_time_conf {
    bool enable;
    uint8_t idle_time; 
};
 
struct sdrv_xspi_slv_debounce_ctrl_conf {
    bool enable;
    uint8_t time; 
};
 
struct sdrv_xspi_slv_dummy_cycle_conf {
    uint8_t dummy_val; 
};
 
struct sdrv_xspi_slv_timeout_mon_ctrl_conf {
    bool enable;
    uint16_t time; 
};
 
struct sdrv_xspi_slv_aid_conf {
    bool enable;
    uint8_t aid; 
};
 
struct sdrv_xspi_slv_acache_conf {
    bool enable;
    uint8_t acache; 
};
 
struct sdrv_xspi_slv_aprot_conf {
    bool enable;
    uint8_t aprot; 
};
 
struct sdrv_xspi_slv_region_map_conf {
    bool enable;
    uint32_t offset_addr; 
    uint32_t begin_addr;  
    uint32_t end_addr;    
    uint32_t id;          
};
 
struct sdrv_xspi_slv_mon_conf {
    bool addr_en;
    bool addr_lock; 
    uint32_t begin_addr; 
    uint32_t end_addr; 
    uint32_t id;          
};
 
enum sdrv_xspi_slv_ioctl_flag {
    XSPI_SLV_FLAG_EN,             
    XSPI_SLV_FLAG_CRC_EN,         
    XSPI_SLV_FLAG_BIT_ENDIAN,     
    XSPI_SLV_FLAG_PAD_RESET_MASK, 
    XSPI_SLV_FLAG_WR_CHK_EN,      
    XSPI_SLV_FLAG_TX_MODE,        
    XSPI_SLV_FLAG_AXI_WR_EN,      
    XSPI_SLV_FLAG_AXI_RD_EN,      
    XSPI_SLV_FLAG_MODE,           
    XSPI_SLV_FLAG_SCLK_IDLE_TIME, 
    XSPI_SLV_FLAG_RATE,           
    XSPI_SLV_FLAG_LINE,           
    XSPI_SLV_FLAG_DEBOUNCE_CTRL,  
    XSPI_SLV_FLAG_TIMEOUT_CTRL,   
    XSPI_SLV_FLAG_ST_ACCESS,      
    XSPI_SLV_FLAG_ID0,            
    XSPI_SLV_FLAG_ID1,            
    XSPI_SLV_FLAG_PAD_INTB_MASK,  
    XSPI_SLV_FLAG_PAD_CRCB_MASK,  
    XSPI_SLV_FLAG_INT_ST,         
    XSPI_SLV_FLAG_INT_MASK,       
    XSPI_SLV_FLAG_ST,             
    XSPI_SLV_FLAG_ST_UPDATE,      
    XSPI_SLV_FLAG_CMD_WR_TRG,     
    XSPI_SLV_FLAG_CMD_RD_TRG,     
    XSPI_SLV_FLAG_CMD_WR_PACKET0, 
    XSPI_SLV_FLAG_CMD_WR_PACKET1, 
    XSPI_SLV_FLAG_CMD_WR_PAYLOAD, 
    XSPI_SLV_FLAG_CMD_WR_WDATA,   
    XSPI_SLV_FLAG_CMD_WR_ST,      
    XSPI_SLV_FLAG_CMD_RD_ID,      
    XSPI_SLV_FLAG_CMD_RD_ST,      
    XSPI_SLV_FLAG_CMD_RD_RDATA,   
    XSPI_SLV_FLAG_CMD_RD_RDATA_CRC, 
    XSPI_SLV_FLAG_ARID_OVERRIDE,    
    XSPI_SLV_FLAG_ARCACHE_OVERRIDE, 
    XSPI_SLV_FLAG_ARPROT_OVERRIDE,  
    XSPI_SLV_FLAG_AWID_OVERRIDE,    
    XSPI_SLV_FLAG_AWCACHE_OVERRIDE, 
    XSPI_SLV_FLAG_AWPROT_OVERRIDE,  
    XSPI_SLV_FLAG_REGION_MAP,       
    XSPI_SLV_FLAG_RD_MON,           
    XSPI_SLV_FLAG_WR_MON,           
    XSPI_SLV_FLAG_WR_DUMMY_CYCLE,   
    XSPI_SLV_FLAG_MAX               
};
 
struct sdrv_xspi_slv_conf {
    paddr_t base; 
    uint16_t irq; 
    bool crc_dis; 
    enum sdrv_xspi_slv_bit_endian bit_endian; 
    enum sdrv_xspi_slv_tx_mode tx_mode;       
    enum sdrv_xspi_slv_mode mode;             
    bool is_ddr;                              
    enum sdrv_xspi_slv_line line;             
    uint8_t cmd_wr_trg;     
    uint8_t cmd_rd_trg;     
    uint8_t cmd_wr_packet0; 
    uint8_t cmd_wr_packet1; 
    uint8_t cmd_wr_payload; 
    uint8_t cmd_wr_wdata;   
    uint8_t cmd_wr_st;      
    uint8_t cmd_rd_id;      
    uint8_t cmd_rd_st;      
    uint8_t cmd_rd_rdata;   
    uint8_t cmd_rd_rdata_crc; 
};
 
struct sdrv_xspi_slv {
    paddr_t base; 
    uint16_t irq; 
};
 
status_t sdrv_xspi_slv_init(struct sdrv_xspi_slv *slave,
                  const struct sdrv_xspi_slv_conf *conf);
 
status_t sdrv_xspi_slv_set_attr(struct sdrv_xspi_slv *slave,
                      enum sdrv_xspi_slv_ioctl_flag flag, const void *buf);
 
status_t sdrv_xspi_slv_get_attr(struct sdrv_xspi_slv *slave,
                      enum sdrv_xspi_slv_ioctl_flag flag, void *buf);
 
status_t sdrv_xspi_slv_enable(struct sdrv_xspi_slv *slave);
 
status_t sdrv_xspi_slv_disable(struct sdrv_xspi_slv *slave);
 
status_t sdrv_xspi_slv_deinit(struct sdrv_xspi_slv *slave);
 
status_t sdrv_xspi_slv_clr_status(struct sdrv_xspi_slv *slave);
#ifdef __cplusplus
}
#endif
 
#endif