UART

This module includes the platform abstraction for UART communication.

Summary

Functions
`otPlatUartDisable(void)`	`otError` Disable the UART.
`otPlatUartEnable(void)`	`otError` Enable the UART.
`otPlatUartFlush(void)`	`otError` Flush the outgoing transmit buffer and wait for the data to be sent.
`otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength)`	`void` The UART driver calls this method to notify OpenThread that bytes have been received.
`otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength)`	`otError` Send bytes over the UART.
`otPlatUartSendDone(void)`	`void` The UART driver calls this method to notify OpenThread that the requested bytes have been sent.

otError otPlatUartDisable(
  void
)

Disable the UART.

Details

Return Values

`OT_ERROR_NONE`	Successfully disabled the UART.
`OT_ERROR_FAILED`	Failed to disable the UART.

otError otPlatUartEnable(
  void
)

Enable the UART.

Details

Return Values

`OT_ERROR_NONE`	Successfully enabled the UART.
`OT_ERROR_FAILED`	Failed to enabled the UART.

otError otPlatUartFlush(
  void
)

Flush the outgoing transmit buffer and wait for the data to be sent.

This is called when the CLI UART interface has a full buffer but still wishes to send more data.

Details

Return Values

`OT_ERROR_NONE`	Flush succeeded, we can proceed to write more data to the buffer.
`OT_ERROR_NOT_IMPLEMENTED`	Driver does not support synchronous flush.
`OT_ERROR_INVALID_STATE`	Driver has no data to flush.

void otPlatUartReceived(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

The UART driver calls this method to notify OpenThread that bytes have been received.

Details

Parameters

`[in] aBuf`	A pointer to the received bytes.
`[in] aBufLength`	The number of bytes received.

otError otPlatUartSend(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Send bytes over the UART.

Details

Parameters

`[in] aBuf`	A pointer to the data buffer.
`[in] aBufLength`	Number of bytes to transmit.

Return Values

`OT_ERROR_NONE`	Successfully started transmission.
`OT_ERROR_FAILED`	Failed to start the transmission.

void otPlatUartSendDone(
  void
)

The UART driver calls this method to notify OpenThread that the requested bytes have been sent.