u_dll.h

Go to the documentation of this file.

 
#ifndef _U_DLL_H_
#define _U_DLL_H_
 
/*************************************************************************/
/* INCLUDE FILES                                                         */
/*************************************************************************/
#include <stdint.h>
#include "dbg_dll.h"
#include "ic_specifics.h"
 
#ifndef __bool_true_false_are_defined
    #define __bool_true_false_are_defined 1
    #ifndef __cplusplus /* In C++, 'bool', 'true' and 'false' and keywords */
        #define bool char
        #define true 1
        #define false 0
    else
        #ifdef __GNUC__
            /* GNU C++ supports direct inclusion of stdbool.h to provide C99
                compatibility by defining _Bool */
            #define BOOL bool
        #endif
    #endif
#endif /* __bool_true_false_are_defined */
 
#define U_DLL_EXPORTS
#ifdef U_DLL_EXPORTS
    #define U_DLL_API __declspec(dllexport)
#else
    #define U_DLL_API __declspec(dllimport)
#endif
 
#define MAX_UDLL_DEVICES                16                                          
#define BD_ADDR_SIZE                    6                                           
#define LOG_PARAM_STR_SIZE              32                                          
#define FILE_PATH_SIZE                  256                                         
#define TEST_NAME_STR_SIZE              13                                          
#define UDLL_CLBK_DATA_SIZE             256                                         
#define UDLL_MEM_RD_FILE_SIZE           0x4000000                                   
#define UDLL_MEM_RD_FILE_NAME           "MEM_READ"                                  
#define UDLL_MEM_RD_FOLDER_NAME         "mem_read_test"                             
// CSV custom memory data
#define CSV_LINE_LEN                    32768                                       
#define MAX_CSV_MEM_DATA                20                                          
// Custom memory data write size.
#define MAX_MEM_DATA_SIZE               512                                         
// Flash memory specifics
#define MAX_FLASH_CHUNK_SIZE            0x1000                                      
#define FLASH_JEDEC_ID_SIZE             3                                           
// Booter and RAM sizes.
#define MAX_LEGACY_BOOTER_FW_SIZE       0xFFFF                                      
#define MAX_EXTENDED_BOOTER_FW_SIZE     0x1FFFF                                     
#define MAX_RAM_DOWNLOAD_FW_SIZE        0x180000                                    
#define MAX_RAM_CHUNK_SIZE              0x4000                                      
// OTP
#define OTP_TOTAL_SIZE                  4096                                        
#define OTP_MAX_ADDR                    4092                                        
#define OTP_WORD_SIZE                   4                                           
#define OTP_MAX_APP_BIN_SIZE            3072                                        
#define OTP_MAX_APP_BIN_MAX_ADDR        3068                                        
#define OTP_MAX_CUST_APP_SIZE           2208                                        
#define OTP_MAX_CUST_APP_MAX_ADDR       2204                                        
// Configuration script
#define OTP_CS_BASE_ADDR                0x0C00                                      
#define CS_WORD_SIZE                    OTP_WORD_SIZE
#define MAX_CS_WORDS                    256                                         
#define MAX_CS_SIZE_BYTES               MAX_CS_WORDS * CS_WORD_SIZE                 
#define MAX_CS_SDK_ENTRIES              20                                          
#define MAX_CS_WORDS_PER_SDK_GROUP      20                                          
#define MAX_CS_REG_ENTRIES              20                                          
#define MAX_CS_STRING_SIZE              (9+(9*MAX_CS_WORDS)-1)+1                    
typedef enum __UDLL_RETURN_CODES
{
    UDLL_SUCCESS = 0,
    UDLL_ACTION_RESPONSE_ERROR,
    UDLL_UART_RX_TIMEOUT_ERROR,
    UDLL_NO_CRC_MATCH_ERROR,
    UDLL_PROG_PARAMS_ERROR,
    UDLL_DEVICE_PARAMS_ERROR,
    UDLL_UART_WRITE_ERROR,
    UDLL_UART_READ_ERROR,
    UDLL_INTERNAL_ERROR,
    UDLL_COM_PORT_INIT_ERROR,
    UDLL_COM_PORT_ERROR,
    UDLL_CANNOT_ALLOCATE_MEMORY,
    UDLL_READ_FILE_SIZE_ERROR,
    UDLL_CANNOT_OPEN_FW_FILE,
    UDLL_CANNOT_OPEN_IMAGE_FILE,
 
    UDLL_INVALID_DBG_PARAMS,
    UDLL_DBG_DLL_ERROR,
 
    UDLL_FW_DOWNLOAD_START,
    UDLL_FW_DOWNLOAD_SUCCESS,
    UDLL_FW_VERSION_GET_START,
    UDLL_FW_VERSION_GET_SUCCESS,
 
    UDLL_RAM_FW_DOWNLOAD_START,
    UDLL_RAM_FW_DOWNLOAD_SUCCESS,
    UDLL_RAM_FW_DOWNLOAD_ERROR,
 
    UDLL_GPIO_WD_START,
    UDLL_GPIO_WD_SUCCESS,
    UDLL_GPIO_WD_ERROR,
 
    UDLL_FLASH_INIT_START,
    UDLL_FLASH_INIT_SUCCESS,
    UDLL_FLASH_INIT_ERROR,
 
    UDLL_FLASH_ERASE_START,
    UDLL_FLASH_ERASE_SUCCESS,
 
    UDLL_FLASH_WRITE_START,
    UDLL_FLASH_WRITE_SUCCESS,
    UDLL_FLASH_WRITE_ERROR,
 
    UDLL_OTP_CHECK_EMPTY_START,
    UDLL_OTP_CHECK_EMPTY_STATUS,
    UDLL_OTP_CHECK_EMPTY_SUCCESS,
    UDLL_OTP_CHECK_INPUT_DATA_EMPTY_SUCCESS,
    UDLL_OTP_CHECK_SAME_DATA_SUCCESS,
    UDLL_OTP_CHECK_SKIP_IF_WRITTEN_SUCCESS,
    UDLL_OTP_CHECK_DIFFERENT_DATA_ERROR,
    UDLL_OTP_CHECK_EMPTY_ERROR,
 
    UDLL_OTP_WRITE_START,
    UDLL_OTP_WRITE_SUCCESS,
    UDLL_OTP_WRITE_ERROR,
 
    UDLL_OTP_CS_WRITE_START,
    UDLL_OTP_CS_WRITE_NUM_OF_ENTRIES,
    UDLL_OTP_CS_WRITE_STATUS,
    UDLL_OTP_CS_WRITE_RDBK_STARTED,
    UDLL_OTP_CS_WRITE_RDBK_STATUS,
    UDLL_OTP_CS_WRITE_SUCCESS,
    UDLL_OTP_CS_WRITE_ERROR,
 
    UDLL_MEM_DATA_WRITE_START,
    UDLL_MEM_DATA_WRITE_STATUS,
    UDLL_MEM_DATA_WRITE_SUCCESS,
    UDLL_MEM_DATA_WRITE_ERROR,
 
    UDLL_MEM_READ_START,
    UDLL_MEM_READ_SUCCESS,
}UDLL_RET;
typedef enum __UDLL_ACTIONS
{
    FW_LOAD = 0,
    FW_VERSION_GET,
    OTP_WRITE,
    OTP_CS_WRITE,
    FLASH_INIT,
    FLASH_WRITE,
    FLASH_ERASE,
    MEM_WRITE,
    MEM_READ,
    RAM_FW_DOWNLOAD,
    GPIO_WD,
    INVALID_UDLL_ACTION
}_UDLL_ACTIONS;
typedef enum __U_DUT_NUM
{
    U_DUT_1                             = 1,
    U_DUT_2                             = 2,
    U_DUT_3                             = 3,
    U_DUT_4                             = 4,
    U_DUT_5                             = 5,
    U_DUT_6                             = 6,
    U_DUT_7                             = 7,
    U_DUT_8                             = 8,
    U_DUT_9                             = 9,
    U_DUT_10                            = 10,
    U_DUT_11                            = 11,
    U_DUT_12                            = 12,
    U_DUT_13                            = 13,
    U_DUT_14                            = 14,
    U_DUT_15                            = 15,
    U_DUT_16                            = 16
}_U_DUT_NUM;
 
typedef enum __udll_mem_type
{
    QSPI_MEM                            = 0,                                    
    OQSPI_MEM,                                                                  
    OTP_MEM,                                                                    
    OTP_CS_MEM,                                                                 
    ANY_MEM,                                                                    
    INVALID_MEM,                                                                
}_udll_mem_type;
 
typedef enum __udll_mem_data_input
{
    CSV_FILE                            = 0,                                    
    MANUAL_IN,                                                                  
    INVALID_MEM_DATA_IN                                                         
}_udll_mem_data_input;
 
typedef enum __udll_chk_empty
{
    NO_CHECK                            = 0,                                    
    CHECK_EMPTY,                                                                
    SAME_DATA_CHECK,                                                            
    SKIP_IF_WRITTEN,                                                            
    INVALID_CHECK
}_udll_chk_empty;
 
typedef enum __udll_cs_baud_rate
{
    BAUD_4K8                            = 0x1,
    BAUD_9K6                            = 0x2,
    BAUD_14K4                           = 0x3,
    BAUD_19K2                           = 0x4,
    BAUD_28K8                           = 0x5,
    BAUD_38K4                           = 0x6,
    BAUD_57K6                           = 0x7,
    BAUD_115K2                          = 0x8,
    BAUD_230K4                          = 0x9,
    BAUD_500K                           = 0xA,
    BAUD_1M                             = 0xB,
    UNKNOWN_CS_BAUD_RATE                = 0xC
}_udll_cs_baud_rate;
 
typedef enum __udll_cs_xtal_settle_ignore
{
    DISABLE_XTAL_SETTLE_IGNORE          = 0x0,
    ENABLE_XTAL_SETTLE_IGNORE           = 0x1,                                  
    ENABLE_XTAL_SETTLE_IGNORE_RC32M     = 0x2,                                  
    UNKNOWN_XTAL_SETTLE_INGORE          = 0x3
}_udll_cs_xtal_settle_ignore;
 
typedef enum __udll_gpio_pwr_lvl
{
    V3_3                                = 0,                                    
    V1_8,                                                                       
    INVALID_LVL,                                                                
}_udll_gpio_pwr_lvl;
 
#pragma region fw_load
 
typedef struct __udll_fw_load
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    char                        fw_path[FILE_PATH_SIZE];                        
}_udll_fw_load;
 
typedef struct __udll_fw_versions
{
    char                        flash_progr_fw_ver[LOG_PARAM_STR_SIZE];         
    char                        udll_ver[LOG_PARAM_STR_SIZE];                   
}_udll_fw_versions;
 
typedef struct __udll_fw_ver
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
}_udll_fw_ver;
 
typedef struct __udll_ram_fw
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    uint32_t                    addr;                                           
    char                        fw_path[FILE_PATH_SIZE];                        
}_udll_ram_fw;
#pragma endregion
 
 
#pragma region otp
 
typedef struct __udll_otp_wr
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    _udll_chk_empty             chk_empty;                                      
    bool                        rdbck_en;                                       
    uint32_t                    addr;                                           
    char                        bin_path[FILE_PATH_SIZE];                       
}_udll_otp_wr;
#pragma endregion
 
 
#pragma region cs_section
 
typedef struct __udll_cs_booter
{
    bool                        en;                                             
    uint32_t                    address;                                        
}_udll_cs_booter;
 
typedef struct __udll_cs_uart_stx
{
    bool                        en;                                             
    _udll_cs_baud_rate          baud_rate;                                      
    uint32_t                    timeout;                                        
}_udll_cs_uart_stx;
 
typedef struct __udll_cs_sdk_entry
{
    bool                        en;                                             
    uint8_t                     set_id;                                         
    uint8_t                     group_id;                                       
    uint8_t                     length;                                         
    uint32_t                    values[MAX_CS_WORDS_PER_SDK_GROUP];             
}_udll_cs_sdk_entry;
 
typedef struct __udll_cs_sw_gen_sdk
{
    bool                        en;                                             
    uint8_t                     set_id;                                         
    uint8_t                     group_id;                                       
}_udll_cs_sw_gen_sdk;
 
typedef struct __udll_cs_xtal_settle
{
    bool                        en;                                             
    uint32_t                    timeout;                                        
    _udll_cs_xtal_settle_ignore ignore;                                         
}_udll_cs_xtal_settle;
 
typedef struct __udll_cs_min_fw_ver
{
    bool                        en;                                             
    uint32_t                    version;                                        
}_udll_cs_min_fw_ver;
 
typedef struct __udll_cs_dev_booter
{
    bool                        en;                                             
    uint32_t                    value;                                          
}_udll_cs_dev_booter;
 
typedef struct __udll_cs_reg_entry
{
    bool                        en;                                             
    uint32_t                    reg;                                            
    uint32_t                    value;                                          
}_udll_cs_reg_entry;
 
typedef struct __udll_otp_cs_wr
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    bool                        rdbck_en;                                       
    _udll_chk_empty             chk_empty;                                      
    _udll_cs_booter             booter;                                         
    bool                        dev_mode;                                       
    _udll_cs_uart_stx           uart_stx;                                       
    _udll_cs_sdk_entry          sdk_entry[MAX_CS_SDK_ENTRIES];                   
    _udll_cs_sw_gen_sdk         sw_gen_sdk;                                     
    _udll_cs_xtal_settle        xtal_settle;                                    
    _udll_cs_min_fw_ver         min_fw_ver;                                     
    _udll_cs_dev_booter         dev_booter;                                     
    _udll_cs_reg_entry          reg_entry[MAX_CS_REG_ENTRIES];                  
    bool                        xtal_trim_wr;                                   
    bool                        bda_wr;                                         
    bool                        stop_cmd_wr;                                    
}_udll_otp_cs_wr;
#pragma endregion
 
 
#pragma region flash
 
typedef struct __udll_flash_init
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    _udll_mem_type              mem_type;                                       
}_udll_flash_init;
 
typedef struct __udll_flash_wr
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    _udll_mem_type              mem_type;                                       
    bool                        rdbck_en;                                       
    uint32_t                    addr;                                           
    char                        bin_path[FILE_PATH_SIZE];                       
}_udll_flash_wr;
 
typedef struct __udll_flash_er
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    _udll_mem_type              mem_type;                                       
    bool                        er_all;                                         
    uint32_t                    addr;                                           
    uint32_t                    size;                                           
}_udll_flash_er;
#pragma endregion
 
 
#pragma region mem_wr
typedef struct __udll_mem_wr
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    bool                        rdbck_en;                                       
    _udll_chk_empty             chk_empty;                                      
    _udll_mem_type              mem_type;                                       
    uint32_t                    addr;                                           
    uint32_t                    size;                                           
    _udll_mem_data_input        input;                                          
    char                        csv_file_path[FILE_PATH_SIZE];                  
}_udll_mem_wr;
 
typedef struct __udll_mem_rd
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    char                        name[TEST_NAME_STR_SIZE];                       
    _udll_mem_type              mem_type;                                       
    uint32_t                    addr;                                           
    uint32_t                    size;                                           
}_udll_mem_rd;
#pragma endregion
 
 
typedef struct __udll_gpio_watchdog
{
    _UDLL_ACTIONS               action;                                         
    bool                        en;                                             
    _ic_gpio                    gpio;                                           
    _udll_gpio_pwr_lvl          pwr_lvl;                                        
}_udll_gpio_watchdog;
 
 
typedef union __udll_mem_params
{
    _UDLL_ACTIONS               action;                                         
    _udll_fw_load               fw_load;                                        
    _udll_fw_ver                fw_ver_get;                                     
    _udll_ram_fw                ram_fw;                                         
    _udll_otp_wr                otp_wr;                                         
    _udll_otp_cs_wr             otp_cs_wr;                                      
    _udll_flash_init            flash_init;                                     
    _udll_flash_wr              flash_wr;                                       
    _udll_flash_er              flash_er;                                       
    _udll_mem_wr                mem_wr;                                         
    _udll_mem_rd                mem_rd;                                         
    _udll_gpio_watchdog         gpio_wd;                                        
}_udll_mem_params;
 
typedef struct __udll_ic_params
{
    _dut_ic                     dut_ic;                                         
    bool                        is_GU;                                          
    uint32_t                    baud_rate;                                      
    _udll_mem_params            mem;                                            
}_udll_ic_params;
 
#pragma endregion
 
 
 
typedef union __udll_params
{
    _dut_ic                     dut_ic;                                         
    bool                        is_GU;                                          
    _udll_ic_params             ic;                                             
}_udll_params;
 
typedef void (*_user_callback_udll) (uint32_t com_port_number, int status, void *data, uint32_t data_len);
 
typedef struct __udll_dev_params
{
    bool                        is_active;                                      
    _U_DUT_NUM                  dut_num;                                        
    uint32_t                    com_port;                                       
    uint8_t                     bd_addr[BD_ADDR_SIZE];                          
    uint32_t                    xtal_trim_val;                                  
    uint8_t                     mem_data[MAX_MEM_DATA_SIZE];                    
    _user_callback_udll         clbck;                                          
}_udll_dev_params;
#ifdef __cplusplus    // If used by C++ code,
extern "C" {          // we need to export the C interface
#endif
 
 
 
U_DLL_API UDLL_RET udll_dbg_init(const _dbg_params *dbg_params_t);
 
U_DLL_API UDLL_RET udll_dbg_close(void);
 
U_DLL_API UDLL_RET udll_init(void);
 
U_DLL_API UDLL_RET udll_set_prog_params(const _udll_params *udll_params_t);
 
U_DLL_API UDLL_RET udll_set_device_params(const _udll_dev_params *params);
 
U_DLL_API UDLL_RET udll_start_prog(void);
 
U_DLL_API UDLL_RET udll_close(void);
#ifdef __cplusplus
}
#endif // @defgroup udll_api
 
#endif //_U_DLL_H_