XDK API  3.6.0
Documentation
Macros | Functions | Variables
XdkExtensionPortUart

This Module contains necessary implementation in order to enable user to develop his application using the Extension port UART communication interface. This module can be used a reference design for interfacing user device via UART of extension port. More...

+ Collaboration diagram for XdkExtensionPortUart:

Macros

#define BCDS_MODULE_ID   XDK_APP_MODULE_ID_EXTENSION_PORT_UART
 
#define END_OF_FRAME   UINT8_C(0xAA)
 
#define MAX_UART_RX_BUFFERSIZE   UINT32_C(16)
 
#define UART_BAURDRATE   UINT32_C(9600)
 
#define UART_RX_ERROR   UINT32_C(0xFFFF)
 
#define UART_RX_SUCCESS   UINT32_C(0)
 
#define UART_SPI_DATA_TRANSFER_TIMEOUT_MILLISEC   UINT32_MAX
 

Functions

Retcode_T ExtensionUartExample_DeInitialize (void)
 This API is used to deinit the UART interface. Once this called, from there-on user needs to call ExtensionUartExample_Initialize for using the UART communication again. More...
 
Retcode_T ExtensionUartExample_Initialize (CmdProcessor_T *handle)
 This API is used to prepare the UART with the user configuration data. Once after this call the user can write over UART interface at any time. Read callback will happen for each byte and user can able to read received data using UartRead() More...
 
Retcode_T ExtensionUartExample_Read (uint8_t *readBuffer, uint8_t readlength, uint32_t *actualLength)
 This API is used to read the data received over the UART interface. More...
 
Retcode_T ExtensionUartExample_Write (uint8_t *writeBuffer, uint8_t writeLength)
 This API is used to write data over the UART interface. Once the UartInit() was success, user can transmit data over UART interface. More...
 
static bool FrameEndCheckFunc (uint8_t lastByte)
 
static void ProcessUartRxData (void *param1, uint32_t param2)
 
static void ProcessUartTxData (uint8_t *txBuff, uint32_t txLength)
 
static void SendUartResponseData (void *param1, uint32_t param2)
 
static void UartAppCallback (struct MCU_UART_Event_S event)
 
void UartCallBack (UART_T uart, struct MCU_UART_Event_S event)
 

Variables

static uint8_t TxBuffer [MAX_UART_RX_BUFFERSIZE]
 
static CmdProcessor_TuartCmdProcessorPtr = NULL
 
static uint8_t UartRxBuffInstance [MAX_UART_RX_BUFFERSIZE]
 
static UARTTransceiver_T UartTranscieverInstance
 

Detailed Description

Macro Definition Documentation

#define BCDS_MODULE_ID   XDK_APP_MODULE_ID_EXTENSION_PORT_UART
#define END_OF_FRAME   UINT8_C(0xAA)
#define MAX_UART_RX_BUFFERSIZE   UINT32_C(16)
#define UART_BAURDRATE   UINT32_C(9600)
#define UART_RX_ERROR   UINT32_C(0xFFFF)
#define UART_RX_SUCCESS   UINT32_C(0)
#define UART_SPI_DATA_TRANSFER_TIMEOUT_MILLISEC   UINT32_MAX

Function Documentation

Retcode_T ExtensionUartExample_DeInitialize ( void  )

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T ExtensionUartExample_Initialize ( CmdProcessor_T handle)

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T ExtensionUartExample_Read ( uint8_t *  readBuffer,
uint8_t  readlength,
uint32_t *  actualLength 
)

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T ExtensionUartExample_Write ( uint8_t *  writeBuffer,
uint8_t  writeLength 
)

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static bool FrameEndCheckFunc ( uint8_t  lastByte)
static

+ Here is the caller graph for this function:

static void ProcessUartRxData ( void *  param1,
uint32_t  param2 
)
static

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void ProcessUartTxData ( uint8_t *  txBuff,
uint32_t  txLength 
)
static

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void SendUartResponseData ( void *  param1,
uint32_t  param2 
)
static

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void UartAppCallback ( struct MCU_UART_Event_S  event)
static

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void UartCallBack ( UART_T  uart,
struct MCU_UART_Event_S  event 
)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

uint8_t TxBuffer[MAX_UART_RX_BUFFERSIZE]
static
CmdProcessor_T* uartCmdProcessorPtr = NULL
static
uint8_t UartRxBuffInstance[MAX_UART_RX_BUFFERSIZE]
static
UARTTransceiver_T UartTranscieverInstance
static

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:55 by doxygen 1.8.8