ptxHal.h

Go to the documentation of this file.

 
#ifndef PTXHAL_H_
#define PTXHAL_H_
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptxOsal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
typedef enum ptxHal_InterfaceType
{
    ptxHal_InterfaceType_None,          
    ptxHal_InterfaceType_I2C,           
    ptxHal_InterfaceType_SPI,           
    ptxHal_InterfaceType_UART,          
    ptxHal_InterfaceType_AAR_I2C,       
    ptxHal_InterfaceType_AAR_SPI,       
    ptxHal_InterfaceType_LPC,           
    ptxHal_InterfaceType_USB,           
    ptxHal_InterfaceType_FTDI_SPI,      
    ptxHal_InterfaceType_FTDI_I2C,      
    ptxHal_InterfaceType_FTDI_UART,     
    /* */
    ptxHal_InterfaceType_MAX
} ptxHal_InterfaceType_t;
 
typedef struct ptxHal_InitParam
{
    uint8_t                    *DevName;                
    size_t                      DevNameLen;             
    uint8_t                    *DevSerialNumber;        
    size_t                      DevSerialNumberLen;     
    uint32_t                    ComSpeedInit;           
    uint8_t                     UseHWFlowControl;       
    ptxHal_InterfaceType_t      InfType;                
    uint16_t                    BusAddress;             
    uint32_t                    CommParam;              
    /*
     * Other Comps
     */
    struct ptxOsal             *OS;                     
    struct ptxLog              *LOG;                    
    uint8_t                     AddSof;                 
    uint32_t                    GpioNum;                
} ptxHal_InitParam_t;
 
#define PTX_HAL_MAX_TX_LEN                     256
 
#define PTX_HAL_READ_TIMEOUT                   500
 
#define PTX_HAL_WRITE_TIMEOUT                  500
 
#define PTX_HAL_COMMPARAM_SERIAL_STOPBIT_MASK   3 /* */
 
#define PTX_HAL_COMMPARAM_SERIAL_ONESTOPBIT     0 /* */
 
#define PTX_HAL_COMMPARAM_SERIAL_ONE5STOPBITS   1 /* */
 
#define PTX_HAL_COMMPARAM_SERIAL_TWOSTOPBITS    2 /* */
 
#define PTX_HAL_COMMPARAM_SERIAL_INIT_SPEED     (115200UL) /* */
 
struct ptxHal;
 
struct ptxHal_InitParam;
 
typedef struct ptxHal* pptxHal_t;
 
/* polyspace<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
struct ptxIo;
 
/* polyspace<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
struct ptxHal_HifSubComps;
 
typedef ptxStatus_t (*pptxHal_MockRx_t)(pptxHal_t halCtx, uint8_t *rxBuf, size_t *rxLen);
 
typedef ptxStatus_t (*pptxHal_MockTx_t)(pptxHal_t halCtx, uint8_t *txBuf, size_t txLen);
 
typedef ptxStatus_t (*pptxHal_MockCancel_t)(pptxHal_t halCtx);
 
typedef ptxStatus_t (*pptxHal_Cancel_t)(pptxHal_t halCtx);
 
typedef ptxHal_InterfaceType_t (*pptxHal_MockGetActiveIfType_t)(pptxHal_t halCtx);
 
typedef ptxStatus_t (*pptxHal_TRx_t)(pptxHal_t halCtx,
                                     uint8_t *txBuf[], size_t txLen[], size_t numBuffers,
                                     uint8_t *rxBuf, size_t *rxLen);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxHal_AllocOpen(struct ptxHal *halCtx, struct ptxHal_InitParam *initParam);
 
ptxStatus_t ptxHal_CloseDeAlloc(struct ptxHal *halCtx);
 
ptxHal_InterfaceType_t ptxHal_GetActiveIfType(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_Cancel(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearCancel(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_SetTimeout(struct ptxHal *halCtx, uint32_t msTimeout);
 
ptxStatus_t ptxHal_SetSpeed(struct ptxHal *halCtx, uint32_t bdSpeed);
 
ptxStatus_t ptxHal_SetBusAddress(struct ptxHal *halCtx, uint16_t busAddress);
 
ptxStatus_t ptxHal_HandshakeManual(struct ptxHal *halCtx, uint8_t enableHS);
 
ptxStatus_t ptxHal_SetFlowCtrlState(struct ptxHal *halCtx, uint8_t enableFc);
 
ptxStatus_t ptxHal_SetI2C_NoStopFlag(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearI2C_NoStopFlag(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_TRx(struct ptxHal *halCtx,
                       uint8_t *txBuf[], size_t txLen[], size_t numBuffers,
                       uint8_t *rxBuf, size_t *rxLen);
 
ptxStatus_t ptxHal_WaitForInterrupt(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_SetKeepNssActive (struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearKeepNssActive (struct ptxHal *halCtx);
 
#ifdef __cplusplus
}
#endif
 
 /* Group */
 
#endif /* Guard */