api_def.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0
#ifndef __API_DEF_H__
#define __API_DEF_H__
#include <stdint.h>
#include "no_os_util.h"
 
#define ADI_POW2_48 ((uint64_t)1u << 48)
#define ADI_MAXUINT48 (ADI_POW2_48 - 1)
 
#define ADI_POW2_32 ((uint64_t)1u << 32)
#define ADI_MAXUINT32 (ADI_POW2_32 - 1)
#define ADI_MAXUINT24 (0xFFFFFF)
#define ADI_GET_BYTE(w, p) (uint8_t)(((w) >> (p)) & 0xFF)
#define ALL -1
 
#define DIV_U64_REM(x, y, r) no_os_div64_u64_rem(x, y, r)
#ifndef NO_OS_DIV_U64
#define NO_OS_DIV_U64(x, y) no_os_div_u64(x, y)
#endif
#define DIV_S64(x, y) no_os_div_s64(x, y)
 
typedef int (*spi_xfer_t) (void *user_data, uint8_t *indata, uint8_t *outdata,
               int size_bytes);
 
typedef int (*delay_us_t) (void *user_data, unsigned int us);
 
typedef int (*hw_open_t) (void *user_data);
 
typedef int (*hw_close_t) (void *user_data);
typedef int (*event_handler_t) (uint16_t event, uint8_t ref, void *data);
 
typedef int (*tx_en_pin_ctrl_t) (void *user_data, uint8_t enable);
 
typedef int (*reset_pin_ctrl_t) (void *user_data, uint8_t enable);
 
struct adi_reg_data {
    uint16_t reg;
    uint8_t val;
};
 
typedef struct {
    uint8_t chip_type;
    uint16_t prod_id;
    uint8_t prod_grade;
    uint8_t dev_revision;
} adi_chip_id_t;
 
typedef enum {
    /* Keep this invalid value as 0, so the API can test for wrong setting. */
    SPI_NONE = 0,
    /*
     * Set SPI SDO (Serial Data Output) pin as active.
     * This is in case the 4-wire SPI is needed.
     */
    SPI_SDO = 1,
    /*
     * Set SPI SDIO (Serial Data Input-Output) pin as active.
     * This is in case the 3-wire SPI is needed.
     */
    SPI_SDIO = 2,
    /* Keep it last. */
    SPI_CONFIG_MAX = 3
} spi_sdo_config_t;
 
typedef enum {
    SIGNAL_CMOS = 0, 
    SIGNAL_LVDS,     
    SIGNAL_UNKNOWN   
} signal_type_t;
 
typedef enum {
    COUPLING_AC = 0,     
    COUPLING_DC,         
    COUPLING_UNKNOWN     
} signal_coupling_t;
 
typedef enum {
    JESD_LINK_0 = 0x0,     
    JESD_LINK_1 = 0x1,     
    JESD_LINK_ALL = 0xFF   
} jesd_link_t;
 
typedef enum {
    SYNCOUTB_0 = 0x0,     
    SYNCOUTB_1 = 0x1,     
    SYNCOUTB_ALL = 0xFF   
} jesd_syncoutb_t;
 
typedef enum {
    SYSREF_NONE = 0x0,     
    SYSREF_ONESHOT,  
    SYSREF_CONT,     
    SYSREF_MON,  
    SYSREF_MODE_INVLD
} jesd_sysref_mode_t;
 
typedef struct {
    uint8_t jesd_L;     
    uint8_t jesd_F;     
    uint8_t jesd_M;     
    uint8_t jesd_S;     
    uint8_t jesd_HD;    
    uint8_t jesd_K;     
    uint8_t jesd_N;     
    uint8_t jesd_NP;    
    uint8_t jesd_CF;    
    uint8_t jesd_CS;    
    uint8_t jesd_DID;   
    uint8_t jesd_BID;   
    uint8_t jesd_LID0;  
    uint8_t jesd_JESDV; 
} jesd_param_t;
 
typedef enum {
    JESD_SUBCLASS_0,     
    JESD_SUBCLASS_1,     
    JESD_SUBCLASS_INVALID
} jesd_subclass_t;
 
typedef enum {
    PRBS_NONE, 
    PRBS7,     
    PRBS15,    
    PRBS31,    
    PRBS_MAX   
} jesd_prbs_pattern_t;
 
#endif /* !__API_DEF_H__ */