XDK API  3.6.0
Documentation
Functions
BleUart.c File Reference
#include "BleTypes.h"
#include "BleTransport.h"
+ Include dependency graph for BleUart.c:

Functions

BleStatus BLEUART_Deinit (void)
 
BleStatus BLEUART_Init (void)
 
BleStatus BLEUART_Send (U8 *uartData, U8 uartDataLen)
 
void BLEUART_TXEnds (void)
 
void BLEUART_TXStarts (void)
 

Function Documentation

BleStatus BLEUART_Deinit ( void  )

De-Initialise the Uart.

BLEUART_Deinit() This function is called by the BLE stack (TRANSPORT layer) to de-initialise the UART layer. Eventual thread shall be terminated here. When this function succeed, the UART layer shall be fully de-initialised

This function is called during the BLESTCK_Deinit() process, failure here will issue a failure in BLESTCK_Deinit()

See also
BLESTCK_Deinit()
Returns
The status of the operation:
  • BLESTATUS_SUCCESS indicates to the BLE stack that the UART have been successfully initialized
  • BLESTATUS_FAILED indicates to the BLE stack that the UART could not be initialized
Author
Alexandre GIMARD
BleStatus BLEUART_Init ( void  )

Initialise the Uart.

BLEUART_Init() This function is called by the BLE stack (TRANSPORT layer) to initialise the UART layer. The user should uses this function to open and setup parameters for the UART line, eventually create Read Thread or setup RX and TX interrupts.

When this function succeeds, the UART layer shall be fully functional

This function is called during the BLESTCK_Init() process, failure here will issue a failure in BLESTCK_Init()

See also
BLESTCK_Init()
Returns
The status of the operation:
  • BLESTATUS_SUCCESS indicates to the BLE stack that the UART have been successfully initialized
  • BLESTATUS_FAILED indicates to the BLE stack that the UART could not be initialized
Author
Alexandre GIMARD
BleStatus BLEUART_Send ( U8 uartData,
U8  uartDataLen 
)

Send data through Uart.

BLEUART_Send() This function is called by the BLE stack (TRANSPORT layer) to send data through the UART layer. When the function succeed, the UART layer shall have send all the data It is to the uart layer to retry to sent the data, if the function fails it result to a transport error and stack de-initialisation. Note that BLEUART_Send is always called after BLEUART_TXStarts() and before BLEUART_TXEnds().

Parameters
data: pointer to received data
dataLen: len of the received data contained in the data pointer
Returns
The status of the operation:
  • BLESTATUS_SUCCESS indicates to the BLE stack that the data have been successfully sent
  • BLESTATUS_FAILED indicates to the BLE stack that the data have not been sent, it result to a transport error
void BLEUART_TXEnds ( void  )

Give information to the UART layer that the stack has ends a transmit process.

BLEUART_TXEnds() This function is called by the BLE stack (TRANSPORT layer) to inform the UART layer that a packet has been transmitted. As a packet can be transmitted into several BLEUART_Send() calls, the stack inform the UART layer that a transmittion ends. it is usefull for UART line that are not full duplex or with a specific flow control and requiere to know when transmition ends. Otherwise the function should be empty. Note that BLEUART_Send is always called after BLEUART_TXStarts() and before BLEUART_TXEnds().

Returns
none
void BLEUART_TXStarts ( void  )

Give information to the UART layer that the stack will starts a transmit process.

BLEUART_TXStarts() This function is called by the BLE stack (TRANSPORT layer) to inform the UART layer that a packet will be transmitted. As a packet can be transmitted into several BLEUART_Send() calls, the stack inform the UART layer that a transmittion starts. Then the stack will call one or several BLEUART_Send() and then BLEUART_TXEnds API. it is usefull for UARt line that are not full duplex or with a specific flow control and requiere to know when transmition starts. Otherwise the function should be empty. Note that BLEUART_Send is always called after BLEUART_TXStarts() and before BLEUART_TXEnds().

Returns
none

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