ptxPLAT.h

Go to the documentation of this file.

 
#ifndef COMPS_PLAT_PTXPLAT_H_
#define COMPS_PLAT_PTXPLAT_H_
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
#include "ptxStatus.h"
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
#define PTX_PLAT_TRX_FLAGS_I2C_RESTART_CONDITION       0x01     
struct ptxPlat;
 
struct ptxPlatTimer;
 
typedef void (*pptxPlat_RxCallBack_t) (void *ctx);
 
typedef void (*pptxPlat_TimerCallBack_t) (void *ctx);
 
typedef struct ptxPLAT_ConfigPars
{
    uint32_t    Speed;                      
    uint8_t     DeviceAddress;              
}ptxPLAT_ConfigPars_t;
 
#define PTX_PLAT_HOST_SPEED_I2C_100000      (100000UL)                          
#define PTX_PLAT_HOST_SPEED_I2C_400000      (400000UL)                          
#define PTX_PLAT_HOST_SPEED_I2C_1000000     (1000000UL)                         
#define PTX_PLAT_HOST_SPEED_I2C_3400000     (3400000UL)                         
#define PTX_PLAT_HOST_SPEED_I2C_MAX         PTX_PLAT_HOST_SPEED_I2C_3400000     
#define PTX_PLAT_HOST_SPEED_UART_9600       (9600UL)                            
#define PTX_PLAT_HOST_SPEED_UART_14400      (14400UL)                           
#define PTX_PLAT_HOST_SPEED_UART_19200      (19200UL)                           
#define PTX_PLAT_HOST_SPEED_UART_28800      (28800UL)                           
#define PTX_PLAT_HOST_SPEED_UART_38400      (38400UL)                           
#define PTX_PLAT_HOST_SPEED_UART_57600      (57600UL)                           
#define PTX_PLAT_HOST_SPEED_UART_115200     (115200UL)                          
#define PTX_PLAT_HOST_SPEED_UART_230400     (230400UL)                          
#define PTX_PLAT_HOST_SPEED_UART_460800     (460800UL)                          
#define PTX_PLAT_HOST_SPEED_UART_921600     (921600UL)                          
#define PTX_PLAT_HOST_SPEED_UART_1843200    (1843200UL)                         
#define PTX_PLAT_HOST_SPEED_UART_3000000    (3000000UL)                         
#define PTX_PLAT_HOST_SPEED_UART_MAX        PTX_PLAT_HOST_SPEED_UART_3000000    
#define PTX_PLAT_HOST_DEFAULT_UART_SPEED    PTX_PLAT_HOST_SPEED_UART_115200     
#define PTX_PLAT_HOST_SPEED_SPI_1M          (1000000UL)                         
#define PTX_PLAT_HOST_SPEED_SPI_5M          (5000000UL)                         
#define PTX_PLAT_HOST_SPEED_SPI_10M         (10000000UL)                        
#define PTX_PLAT_HOST_SPEED_SPI_MAX         PTX_PLAT_HOST_SPEED_SPI_10M         
#if defined (PTX_INTF_UART)
#define PTX_PLAT_RXBUF_SIZE                 (256U)                              
#endif
 
/*
 * ####################################################################################################################
 * API FUNCTIONS (Mandatory Implementation)
 * ####################################################################################################################
 */
 
ptxStatus_t ptxPLAT_AllocAndInit(struct ptxPlat **plat, struct ptxPLAT_ConfigPars *initParams);
 
 
ptxStatus_t ptxPLAT_Deinit(struct ptxPlat *plat);
 
 
ptxStatus_t ptxPLAT_TRx(struct ptxPlat *plat, uint8_t *txBuf[], size_t txLen[], size_t numTxBuffers, uint8_t *rxBuf[], size_t *rxLen[], size_t numRxBuffers, uint8_t flags);
 
 
ptxStatus_t ptxPLAT_WaitForInterrupt(struct ptxPlat *plat);
 
 
ptxStatus_t ptxPLAT_StartWaitForRx(struct ptxPlat *plat, pptxPlat_RxCallBack_t irqCb, void *ctxIrqCb);
 
 
ptxStatus_t ptxPLAT_StopWaitForRx(struct ptxPlat *plat);
 
 
ptxStatus_t ptxPLAT_Sleep(struct ptxPlat *plat, uint32_t sleep_ms);
 
 
void ptxPLAT_DisableInterrupts (struct ptxPlat *plat);
 
 
void ptxPLAT_EnableInterrupts (struct ptxPlat *plat);
 
ptxStatus_t ptxPLAT_ResetChip (struct ptxPlat *plat);
 
/*
 * ####################################################################################################################
 * API FUNCTIONS (Timer)
 * ####################################################################################################################
 */
 
 
ptxStatus_t ptxPLAT_GetInitializedTimer(struct ptxPlat *plat, struct ptxPlatTimer **timer);
 
 
ptxStatus_t ptxPLAT_TimerStart(struct ptxPlat *plat, struct ptxPlatTimer *timer, uint32_t ms, uint8_t isBlock, pptxPlat_TimerCallBack_t fnISRCb, void *ISRCxt);
 
 
ptxStatus_t ptxPLAT_TimerIsElapsed(struct ptxPlat *plat, struct ptxPlatTimer *timer, uint8_t *isElapsed);
 
 
ptxStatus_t ptxPLAT_TimerDeinit(struct ptxPlat *plat, struct ptxPlatTimer *timer);
 
 
ptxStatus_t ptxPLAT_IsRxPending (struct ptxPlat *plat , uint8_t *isRxPending);
 
 
ptxStatus_t ptxPLAT_TriggerRx(struct ptxPlat *plat);
 
/*
 * ####################################################################################################################
 * API FUNCTIONS (Communication interface)
 * ####################################################################################################################
 */
 
uint8_t ptxPLAT_CheckRxActive(struct ptxPlat *plat);
 
#if defined (PTX_INTF_UART)
ptxStatus_t ptxPLAT_SetIntfSpeed(struct ptxPlat *plat, uint32_t speed);
 
uint32_t ptxPLAT_GetIntfSpeed(struct ptxPlat *plat);
 
ptxStatus_t ptxPLAT_SetCleanStateRx (struct ptxPlat *plat);
 
ptxStatus_t ptxPLAT_GetReceivedMessage (struct ptxPlat *plat, uint8_t *rxMessageBuffer, size_t *rxMessageBufferLen);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */