adi_hal.h

Go to the documentation of this file.

 
#ifndef _ADI_HAL_H_
#define _ADI_HAL_H_
 
/* include standard types and definitions */
#include <stdint.h>
#include <stddef.h>
#include "no_os_util.h"
 
#define u16             uint16_t
#define DIV_U64(x, y) no_os_div_u64(x, y)
#define DIV_S64(x, y) no_os_div_s64(x, y)
#define DIV_ROUND_CLOSEST   NO_OS_DIV_ROUND_CLOSEST
#define DIV_ROUND_CLOSEST_ULL   NO_OS_DIV_ROUND_CLOSEST_ULL
 
/*========================================
 * Enums and structures
 *=======================================*/
 
struct adi_hal {
    struct no_os_gpio_desc  *gpio_adrv_resetb;
    struct no_os_gpio_desc  *gpio_adrv_sysref_req;
    struct no_os_spi_desc       *spi_adrv_desc;
    uint32_t        log_level;
    void            *extra_spi;
    uint8_t         spi_adrv_csn;
    void            *extra_gpio;
    uint8_t         gpio_adrv_resetb_num;
};
 
typedef enum {
    ADIHAL_OK = 0,        
    ADIHAL_SPI_FAIL,      
    ADIHAL_GPIO_FAIL,     
    ADIHAL_TIMER_FAIL,    
    ADIHAL_WAIT_TIMEOUT,  
    ADIHAL_GEN_SW,        
    ADIHAL_WARNING,       
    ADIHAL_ERR
} adiHalErr_t;
 
typedef enum {
    ADIHAL_LOG_NONE = 0x0,  
    ADIHAL_LOG_MSG  = 0x1,  
    ADIHAL_LOG_WARN = 0x2,  
    ADIHAL_LOG_ERR  = 0x4,  
    ADIHAL_LOG_SPI  = 0x8,  
    ADIHAL_LOG_ALL  = 0xF   
} adiLogLevel_t;
 
typedef enum {
    SYSREF_CONT_ON,     
    SYSREF_CONT_OFF,    
    SYSREF_PULSE,       
} sysrefReqMode_t;
 
/*========================================
 * Prototypes
 *=======================================*/
#ifdef __cplusplus
extern "C" {
#endif
 
/* 3 Bytes per SPI transaction * 341 transactions = ~1024 byte buffer size */
/* Minimum HAL_SPIWRITEARRAY_BUFFERSIZE = 18 */
#define HAL_SPIWRITEARRAY_BUFFERSIZE 341
 
/*============================================================================
 * ADI Device Hardware Control Functions
 *===========================================================================*/
 
adiHalErr_t ADIHAL_openHw(void *devHalInfo, uint32_t halTimeout_ms);
 
adiHalErr_t ADIHAL_closeHw(void *devHalInfo);
 
 
adiHalErr_t ADIHAL_setTimeout(void *devHalInfo, uint32_t halTimeout_ms);
 
adiHalErr_t ADIHAL_resetHw(void *devHalInfo);
 
adiHalErr_t ADIHAL_sysrefReq(void *devHalInfo, sysrefReqMode_t mode);
 
adiHalErr_t ADIHAL_spiWriteByte(void *devHalInfo, uint16_t addr, uint8_t data);
 
adiHalErr_t  ADIHAL_spiWriteBytes(void *devHalInfo, uint16_t *addr,
                  uint8_t *data, uint32_t count);
 
adiHalErr_t ADIHAL_spiReadByte(void *devHalInfo, uint16_t addr,
                   uint8_t *readdata);
 
adiHalErr_t ADIHAL_spiReadBytes(void *devHalInfo, uint16_t *addr,
                uint8_t *readdata, uint32_t count);
 
adiHalErr_t ADIHAL_spiWriteField(void *devHalInfo, uint16_t addr,
                 uint8_t  fieldVal, uint8_t mask, uint8_t startBit);
 
adiHalErr_t ADIHAL_spiReadField(void *devHalInfo, uint16_t addr,
                uint8_t *fieldVal, uint8_t mask, uint8_t startBit);
 
adiHalErr_t ADIHAL_wait_us(void *devHalInfo, uint32_t time_us);
 
/*========================================
 * Optional Logging Functions
 *
 *=======================================*/
adiHalErr_t ADIHAL_setLogLevel(void *devHalInfo, uint16_t halLogLevel);
 
adiHalErr_t ADIHAL_writeToLog(void *devHalInfo, adiLogLevel_t logLevel,
                  uint32_t errorCode, const char *comment);
 
 
#ifdef __cplusplus
}
#endif
#endif