ptxHal_Ext.h

Go to the documentation of this file.

 
#ifndef COMPS_HAL_PTXHAL_EXT_H_
#define COMPS_HAL_PTXHAL_EXT_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Platform.h"
#include "ptxHal.h"
 
#if (defined PTX_FEATURES_TESTING)
 
#include "ptxOsal_Ext.h"
 
#include "ptxHal_UART.h"
#include "ptxHal_UART_FTDI.h"
#include "ptxHal_UART_Ext.h"
 
#include "ptxHal_SPI.h"
#include "ptxHal_SPI_FTDI.h"
#include "ptxHal_SPI_AAR.h"
#include "ptxHal_SPI_Ext.h"
 
#include "ptxHal_I2C.h"
#include "ptxHal_I2C_FTDI.h"
#include "ptxHal_I2C_AAR.h"
#include "ptxHal_I2C_Ext.h"
 
#include "ptxHal_Gpio.h"
 
#endif
 
#if (defined PTX_FEATURES_HAL_SPI) || (defined PTX_FEATURES_HAL_I2C)
#include "ptxHal_Gpio.h"
# endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
#if (defined PTX_PLAT_MACOS)
#   define PTX_HAL_IO_DEV_LIB      "libPtxIo.dylib"
#elif (defined PTX_PLAT_LINUX)
#   define PTX_HAL_IO_DEV_LIB      "libPtxIo.so"
#elif (defined PTX_PLAT_WINDOWS)
#   define PTX_HAL_IO_DEV_LIB      "libPtxIo.dll"
#elif (defined PTX_PLAT_ANDROID)
#   define PTX_HAL_IO_DEV_LIB      /* Empty */
#elif (defined PTX_PLAT_EMBEDDED_GENERIC)
#   define PTX_HAL_IO_DEV_LIB      /* Empty */
#else
#   error Invalid Platform
#endif
 
typedef struct ptxHal
{
    ptxStatus_Comps_t               CompId;                 
    uint8_t                        *DevName;                
    size_t                          DevNameLen;             
    uint8_t                        *DevSerialNumber;        
    size_t                          DevSerialNumberLen;     
    uint32_t                        ComSpeedInit;           
    uint8_t                         UseHWFlowControl;       
    uint32_t                        CommParam;              
    uint32_t                        BusAddress;             
    ptxHal_InterfaceType_t          InfType;                
    uint32_t                        WriteTimeout;           
    uint32_t                        ReadTimeout;            
/* polyspace:begin<MISRA-C3:5.7:Not a defect:No action planned> Forward declaration. */
/* polyspace:begin<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
#if  (defined PTX_FEATURES_TESTING) || (defined PTX_FEATURES_HAL_I2C)
    struct ptxHal_I2C              *I2C;                    
#endif
#if  (defined PTX_FEATURES_TESTING) || (defined PTX_FEATURES_HAL_SPI)
    struct ptxHal_SPI              *SPI;                    
#endif
#if  (defined PTX_FEATURES_TESTING) || (defined PTX_FEATURES_HAL_UART)
    struct ptxHal_UART             *UART;                   
#endif
/* polyspace:end<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
/* polyspace:end<MISRA-C3:5.7:Not a defect:No action planned> Forward declaration. */
 
    /*
     * Functions
     */
    pptxHal_TRx_t                   TRx;                    
    pptxHal_Cancel_t                Cancel;                 
    pptxHal_MockGetActiveIfType_t   GetIfType;              
    /*
     * Mock Functions - Delegate to MOCK component
     */
    pptxHal_MockRx_t                MockRx;                 
    pptxHal_MockTx_t                MockTx;                 
    pptxHal_MockCancel_t            MockCancel;             
    /*
     * Other Comps
     */
    struct ptxOsal                 *OS;                     
    struct ptxLog                  *LOG;                    
    ptxMutex_t                      Mutex;                  
    struct ptxHal_Gpio             *HalGpio;                
} ptxHal_t;
 
typedef struct ptxHal_SwitchInterfaceParams
{
    ptxHal_InterfaceType_t          intfType;               
    uint8_t                        *devName;                
    uint32_t                        devNameLen;             
    uint8_t                        *devSerial;              
    uint32_t                        devSerialLen;           
    uint32_t                        intfSpeed;              
} ptxHal_SwitchIntfParams_t;
 
 
/*
 * ####################################################################################################################
 * FUNCTIONS
 * ####################################################################################################################
 */
 
#if (defined PTX_FEATURES_TESTING)
 
ptxStatus_t ptxHal_AllocOpen_Ext(ptxHal_t *halCtx, ptxHal_InitParam_t *initParam);
 
ptxStatus_t ptxHal_CloseDeAlloc_Ext(struct ptxHal *halCtx);
 
ptxHal_InterfaceType_t ptxHal_GetActiveIfType_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_Cancel_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearCancel_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_SetSpeed_Ext(struct ptxHal *halCtx, uint32_t bdSpeed);
 
ptxStatus_t ptxHal_SetBusAddress_Ext(struct ptxHal *halCtx, uint16_t busAddress);
 
ptxStatus_t ptxHal_SetTimeout_Ext(struct ptxHal *halCtx, uint32_t msTimeout);
 
ptxStatus_t ptxHal_HandshakeManual_Ext(struct ptxHal *halCtx, uint8_t enableHS);
 
ptxStatus_t ptxHal_SetFlowCtrlState_Ext(struct ptxHal *halCtx, uint8_t enableFc);
 
ptxStatus_t ptxHal_SetI2C_NoStopFlag_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearI2C_NoStopFlag_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_TRx_Ext(struct ptxHal *halCtx,
                       uint8_t *txBuf[], size_t txLen[], size_t numBuffers,
                       uint8_t *rxBuf, size_t *rxLen);
 
ptxStatus_t ptxHal_WaitForInterrupt_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_SetKeepNssActive_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_ClearKeepNssActive_Ext(struct ptxHal *halCtx);
 
ptxStatus_t ptxHal_GetIoLibRef(ptxHal_t *halCtx, ptxOsalLib_t **ioLibH, struct ptxIo **ioLibComp);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* COMPS_HAL_PTXHAL_EXT_H_ */