XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs | Enumerations | Functions
BCDS_UARTTransceiver.h File Reference
#include "BCDS_Utils.h"
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
#include "BCDS_HAL.h"
#include "BCDS_HALConfig.h"
#include "BCDS_RingBuffer.h"
#include "FreeRTOS.h"
#include "semphr.h"
#include "BCDS_MCU_UART.h"
+ Include dependency graph for BCDS_UARTTransceiver.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  _UARTTransceiver_S
 

Macros

#define UART_TRANSCEIVER_DECLARE_LOOP_CALLBACK(transceiver)
 Generates a UART loop callback. More...
 

Typedefs

typedef void(* UARTransceiver_Callback_T )(struct MCU_UART_Event_S event)
 
typedef bool(* UARTTransceiver_EndofFrameCheckFunc_T )(uint8_t lastByte)
 
typedef struct _UARTTransceiver_S UARTTransceiver_T
 

Enumerations

enum  UARTTransceiver_Mode_E
 
enum  UARTTransceiver_State_E
 
enum  UARTTransceiver_UartType_E
 

Functions

Retcode_T UARTTransceiver_Deinitialize (UARTTransceiver_T *transceiver)
 De-initializes the transceiver. More...
 
Retcode_T UARTTransceiver_Initialize (UARTTransceiver_T *transceiver, HWHandle_T handle, uint8_t *rawRxBuffer, uint32_t rawRxBufferSize, enum UARTTransceiver_UartType_E type)
 Initializes the transceiver for the use with the passed UART or LEUART handle. More...
 
void UARTTransceiver_LoopCallback (UARTTransceiver_T *transceiver, struct MCU_UART_Event_S event)
 Function to loop the UART/LEUART callback. More...
 
Retcode_T UARTTransceiver_ReadData (UARTTransceiver_T *transceiver, uint8_t *buffer, uint32_t size, uint32_t *length, uint32_t timeout_ms)
 It reads the data received by the transceiver. More...
 
Retcode_T UARTTransceiver_Resume (UARTTransceiver_T *transceiver)
 It resumes the transceiver after it has been suspended. More...
 
Retcode_T UARTTransceiver_Start (UARTTransceiver_T *transceiver, UARTTransceiver_EndofFrameCheckFunc_T frameEndCheckFunc)
 It activates the transceiver to start receiving and sending in the synchronous operation mode. More...
 
Retcode_T UARTTransceiver_StartInAsyncMode (UARTTransceiver_T *transceiver, UARTTransceiver_EndofFrameCheckFunc_T frameEndCheckFunc, UARTransceiver_Callback_T callback)
 It activates the transceiver to start receiving and sending in the asynchronous operation mode. More...
 
Retcode_T UARTTransceiver_Stop (UARTTransceiver_T *transceiver)
 It stops the transceiver. More...
 
Retcode_T UARTTransceiver_Suspend (UARTTransceiver_T *transceiver)
 It suspends the transceiver. More...
 
Retcode_T UARTTransceiver_WriteData (UARTTransceiver_T *transceiver, uint8_t *data, uint32_t length, uint32_t timeout_ms)
 It writes the data for sending. More...
 

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:49 by doxygen 1.8.8