hpm_romapi_xpi_ram_def.h

Go to the documentation of this file.

#ifndef HPM_ROMAPI_XPI_RAM_DEF_H
#define HPM_ROMAPI_XPI_RAM_DEF_H
 
#include "hpm_common.h"
#include "hpm_romapi_xpi_def.h"
 
/**********************************************************************************************************************
 * Definitions
 *********************************************************************************************************************/
 
#define XPI_RAM_CFG_OPTION_TAG (0xfcf91U)
 
#define XPI_RAM_CFG_TAG (0x4D415258U)
 
enum {
    xpi_ram_safe_clk_freq = 1,
};
 
typedef struct {
    union {
        struct {
            uint32_t words: 4;       
            uint32_t instance: 4;    
            uint32_t reserved: 4;    
            uint32_t tag: 20;        
        };
        uint32_t U;
    } header;
    union {
        struct {
            uint32_t freq_opt: 4;                
            uint32_t misc: 4;                    
            uint32_t ram_size : 8;               
            uint32_t pin_group: 4;               
            uint32_t read_dummy_cycles: 4;       
            uint32_t write_dummy_cycles:4;       
            uint32_t probe_type: 4;              
        };
        uint32_t U;
    } option0;
    union {
        struct {
            uint32_t drive_strength: 4;         
            uint32_t max_cs_low_time: 4;        
            uint32_t pin_group_sel: 4;          
            uint32_t channel: 4;                
            uint32_t skip_ahb_buf_cfg:4;        
            uint32_t reserved: 12;
        };
        uint32_t U;
    } option1;
} xpi_ram_config_option_t;
 
 
enum {
    xpi_ram_type_apmemory_x8 = 0,       
    xpi_ram_type_hyperram = 1,          
    xpi_ram_type_apmemory_x4 = 2,       
};
 
enum {
    xpi_ram_option_misc_hyperram_3v0,
    xpi_ram_option_misc_hyperram_1v8,
};
 
 
enum {
   xpi_ram_default_max_cs_low_time_us = 4, 
};
 
enum {
    xpi_ram_opi = XPI_8PADS,        
    xpi_ram_qpi = XPI_4PADS,        
};
 
enum {
    xpi_ram_cfg_cmd_type_generic = 1,   
    xpi_ram_cfg_cmd_type_spi2xpi = 2,   
};
 
typedef struct {
    uint8_t cmd_type;       
    uint8_t param_size;     
} device_config_t;
 
typedef struct {
    uint32_t size_in_kbytes;                
    uint8_t data_pads;                      
    uint8_t en_ddr_mode;                    
    uint8_t clk_freq_for_device_cfg;        
    uint8_t working_mode_por;               
    uint8_t working_mode;                   
    uint8_t en_diff_clk;                    
    uint8_t data_valid_time;                
    uint8_t cs_hold_time;                   
    uint8_t cs_setup_time;                  
    uint8_t cs_interval;                    
    uint8_t io_voltage;                     
    uint8_t reserved0;                   
    device_config_t device_cfg_list[2];     
    uint32_t reserved1;                     
    uint32_t device_config_params[2];       
    xpi_instr_seq_t device_cfg_instr_seq[2];
    uint32_t device_cfg_addr[2];            
    uint32_t reserved2[2];                  
} xpi_ram_info_t;
 
typedef struct {
    uint32_t tag;                         
    uint32_t reserved0;                   
    uint8_t rxclk_src;                    
    uint8_t clk_freq;                     
    uint8_t drive_strength;               
    uint8_t column_addr_size;             
    uint8_t rxclk_src_for_init;           
    uint8_t enable_word_addr;             
    uint8_t max_cs_low_time;              
    uint8_t skip_ahb_buf_cfg;             
    struct {
        uint8_t enable;                   
        uint8_t group;                    
        uint8_t reserved[2];
    } port_info[4];                        
    xpi_ram_info_t device_info;       
    xpi_instr_seq_t instr_set[2];           
} xpi_ram_config_t;
 
#endif /* HPM_ROMAPI_XPI_RAM_DEF_H */