ptxHal_UART.h

Go to the documentation of this file.

 
#ifndef PTX_HAL_UART_H_
#define PTX_HAL_UART_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stddef.h>
#include "ptx_Status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
struct ptxHal_UART;
 
typedef struct ptxHal_UART* ptxHal_UART_t;
 
struct ptxOsal;
 
struct ptxLog;
 
 
typedef struct ptxHal_UartInitParam
{
    uint8_t                *DevName;            
    size_t                  DevNameLen;         
    uint32_t                ComSpeedInit;       
    uint8_t                 UseHWFlowControl;   
    uint32_t                WriteTimeout;       
    uint32_t                ReadTimeout;        
    struct ptxOsal         *OS;                 
    struct ptxLog          *LOG;                
} ptxHal_UartInitParam_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxHal_UartOpen(ptxHal_UART_t *halUart, ptxHal_UartInitParam_t *initPars);
 
ptxStatus_t ptxHal_UartClose(ptxHal_UART_t *halUart);
 
ptxStatus_t ptxHal_UartDiscardData(ptxHal_UART_t halUart);
 
ptxStatus_t ptxHal_UartSetTimeout(ptxHal_UART_t halUart, uint32_t msTimeout);
 
ptxStatus_t ptxHal_UartSetSpeed(ptxHal_UART_t halUart, uint32_t bdSpeed);
 
ptxStatus_t ptxHal_UartHandshakeManual(ptxHal_UART_t halUart, uint8_t enableHS);
 
ptxStatus_t ptxHal_UartAddSof(ptxHal_UART_t halUart, uint8_t addSof);
 
ptxStatus_t ptxHal_UartSetFc(ptxHal_UART_t halUart, uint8_t enableFc);
 
ptxStatus_t ptxHal_UartCancel(ptxHal_UART_t halUart);
 
ptxStatus_t ptxHal_UartClearCancel(ptxHal_UART_t halUart);
 
ptxStatus_t ptxHal_UartTRx(ptxHal_UART_t halUart,
                           uint8_t *txBuf[], size_t txLen[], size_t numBuffers,
                           uint8_t *rxBuf, size_t *rxLen);
 
ptxStatus_t ptxHal_UartDTRManual(ptxHal_UART_t halUart, uint8_t enableDTR);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */