Serial
Hardware Abstraction Layer (HAL) API Reference > Custom Bootloader HAL > Common

Common bootloader serial definitions.

Functions

void serInit (void)
Initialize serial port.
void serPutFlush (void)
Flush the transmiter.
void serPutChar (uint8_t ch)
Transmit a character.
void serPutStr (const char *str)
Transmit a string.
void serPutBuf (const uint8_t buf[], uint8_t size)
Transmit a buffer.
void serPutDecimal (uint16_t val)
Transmit a 16bit value in decimal.
void serPutHex (uint8_t byte)
Transmit a byte as hex.
void serPutHexInt (uint16_t word)
Transmit a 16bit integer as hex.
bool serCharAvailable (void)
Determine if a character is available.
uint8_t serGetChar (uint8_t *ch)
Get a character if available, otherwise return an error.
void serGetFlush (void)
Flush the receiver.

Detailed Description

Common bootloader serial definitions.

See bootloader-serial.h for source code.

Function Documentation

◆ serCharAvailable()

bool serCharAvailable ( void )

Determine if a character is available.

Returns
true if a character is available, false otherwise.

◆ serGetChar()

uint8_t serGetChar ( uint8_t * ch )

Get a character if available, otherwise return an error.

Parameters
ch Pointer to a location where the received byte will be placed.
Returns
BL_SUCCESS if a character was obtained, BL_ERR otherwise.

◆ serGetFlush()

void serGetFlush ( void )

Flush the receiver.

◆ serInit()

void serInit ( void )

Initialize serial port.

◆ serPutBuf()

void serPutBuf ( const uint8_t buf[],
uint8_t size
)

Transmit a buffer.

Parameters
buf A buffer.
size Length of buffer.

◆ serPutChar()

void serPutChar ( uint8_t ch )

Transmit a character.

Parameters
ch A character.

◆ serPutDecimal()

void serPutDecimal ( uint16_t val )

Transmit a 16bit value in decimal.

Parameters
val The data to print.

◆ serPutFlush()

void serPutFlush ( void )

Flush the transmiter.

◆ serPutHex()

void serPutHex ( uint8_t byte )

Transmit a byte as hex.

Parameters
byte A byte.

◆ serPutHexInt()

void serPutHexInt ( uint16_t word )

Transmit a 16bit integer as hex.

Parameters
word A 16bit integer.

◆ serPutStr()

void serPutStr ( const char * str )

Transmit a string.

Parameters
str A string.