Serial UART Communication#

halInternalUartInit#

EmberStatus halInternalUartInit (uint8_t port, SerialBaudRate rate, SerialParity parity, uint8_t stopBits)

Initializes the UART to the given settings (same parameters as ::emberSerialInit() ).

Returns

• An error code if initialization failed (such as invalid baud rate), otherise EMBER_SUCCESS.

halInternalPowerDownUart#

void halInternalPowerDownUart (void )

This function is typically called by halPowerDown() and it is responsible for performing all the work internal to the UART needed to stop the UART before a sleep cycle.

halInternalPowerUpUart#

void halInternalPowerUpUart (void )

This function is typically called by halPowerUp() and it is responsible for performing all the work internal to the UART needed to restart the UART after a sleep cycle.

halInternalStartUartTx#

void halInternalStartUartTx (uint8_t port)

Called by serial code whenever anything is queued for transmission to start any interrupt-driven transmission. May be called when transmission is already in progess.

halInternalStopUartTx#

void halInternalStopUartTx (uint8_t port)

Called by serial code to stop any interrupt-driven serial transmission currently in progress.

halInternalForceWriteUartData#

EmberStatus halInternalForceWriteUartData (uint8_t port, uint8_t * data, uint8_t length)

Directly writes a byte to the UART for transmission, regardless of anything currently queued for transmission. Should wait for anything currently in the UART hardware registers to finish transmission first, and block until data is finished being sent.

halInternalForceReadUartByte#

EmberStatus halInternalForceReadUartByte (uint8_t port, uint8_t * dataByte)

Directly reads a byte from the UART for reception, regardless of anything currently queued for reception. Does not block if a data byte has not been received.

halInternalWaitUartTxComplete#

void halInternalWaitUartTxComplete (uint8_t port)

Blocks until the UART has finished transmitting any data in its hardware registers.

halInternalRestartUart#

void halInternalRestartUart (void )

This function is typically called by ::halInternalPowerUpBoard() and it is responsible for performing all the work internal to the UART needed to restart the UART after a sleep cycle. (For example, resyncing the DMA hardware and the serial FIFO.)

halInternalUartFlowControlRxIsEnabled#

bool halInternalUartFlowControlRxIsEnabled (uint8_t port)

Checks to see if the host is allowed to send serial data to the ncp - i.e., it is not being held off by nCTS or an XOFF. Returns true is the host is able to send.

halInternalUartXonRefreshDone#

bool halInternalUartXonRefreshDone (uint8_t port)

When Xon/Xoff flow control is used, returns true if the host is not being held off and XON refreshing is complete.

halInternalUartTxIsIdle#

bool halInternalUartTxIsIdle (uint8_t port)

Returns true if the uart transmitter is idle, including the transmit shift register.

serialDropPacket#

bool serialDropPacket (void )

Testing function implemented by the upper layer. Determines whether the next packet should be dropped. Returns true if the next packet should be dropped, false otherwise.

halInternalUartFlowControl#

#define halInternalUartFlowControl

(port)

This function is used in FIFO mode when flow control is enabled. It is called from emberSerialReadByte(), and based on the number of bytes used in the uart receive queue, decides when to tell the host it may resume transmission.

halInternalUartRxPump#

#define halInternalUartRxPump

(port)

This function exists only in software UART (SOFTUART) mode on the EM3xx. This function is called by ::emberSerialReadByte(). It is responsible for maintaining synchronization between the emSerialRxQueue and the UART DMA.

halInternalUart1FlowControlRxIsEnabled#

#define halInternalUart1FlowControlRxIsEnabled

()

This function is used in FIFO mode when flow control is enabled. It is called from emberSerialReadByte(), and based on the number of bytes used in the uart receive queue, decides when to tell the host it may resume transmission.

halInternalUart1XonRefreshDone#

#define halInternalUart1XonRefreshDone

()

This function is used in FIFO mode when flow control is enabled. It is called from emberSerialReadByte(), and based on the number of bytes used in the uart receive queue, decides when to tell the host it may resume transmission.

halInternalUart1TxIsIdle#

#define halInternalUart1TxIsIdle

()

This function is used in FIFO mode when flow control is enabled. It is called from emberSerialReadByte(), and based on the number of bytes used in the uart receive queue, decides when to tell the host it may resume transmission.

halStackReceiveVuartMessage#

void halStackReceiveVuartMessage (uint8_t * data, uint8_t length)

When using a debug build with virtual UART support, this API is called by the stack when virtual UART data has been received over the debug channel.

EMBER_SERIAL_UNUSED#

#define EMBER_SERIAL_UNUSED

0

A numerical definition for a possible serial mode the code can test for.

EMBER_SERIAL_FIFO#

#define EMBER_SERIAL_FIFO

1

A numerical definition for a possible serial mode the code can test for.

EMBER_SERIAL_LOWLEVEL#

#define EMBER_SERIAL_LOWLEVEL

2

A numerical definition for a possible serial mode the code can test for.

FIFO_ENQUEUE#

#define FIFO_ENQUEUE

Macro that enqueues a byte of data in a FIFO queue.

FIFO_DEQUEUE#

#define FIFO_DEQUEUE

Macro that de-queues a byte of data from a FIFO queue.

SerialBaudRate#

SerialBaudRate

Assign numerical values for variables that hold Baud Rate parameters.

SerialParity#

SerialParity

CORTEXM3_EFM32_MICRO.

Assign numerical values for the types of parity. Use for variables that hold Parity parameters.

halHostFlushBuffers#

void halHostFlushBuffers (void )

halHostEnqueueTx#

uint16_t halHostEnqueueTx (const uint8_t * data, uint16_t length)

halHostFlushTx#

void halHostFlushTx (void )

serialCopyFromRx#

uint16_t serialCopyFromRx (const uint8_t * data, uint16_t length)

emLoadSerialTx#

void emLoadSerialTx (void )