Serial#

Common bootloader serial definitions.

See bootloader-serial.h for source code.

Functions#

void
serInit(void)

Initialize serial port.

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

Determine if a character is available.

uint8_t
serGetChar(uint8_t *ch)

Get a character if available, otherwise return an error.

void

Flush the receiver.

Function Documentation#

serInit#

void serInit (void )

Initialize serial port.

Parameters
TypeDirectionArgument NameDescription
voidN/A

serPutFlush#

void serPutFlush (void )

Flush the transmiter.

Parameters
TypeDirectionArgument NameDescription
voidN/A

serPutChar#

void serPutChar (uint8_t ch)

Transmit a character.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Ach

A character.


serPutStr#

void serPutStr (const char * str)

Transmit a string.

Parameters
TypeDirectionArgument NameDescription
const char *N/Astr

A string.


serPutBuf#

void serPutBuf (const uint8_t buf, uint8_t size)

Transmit a buffer.

Parameters
TypeDirectionArgument NameDescription
const uint8_tN/Abuf

A buffer.

uint8_tN/Asize

Length of buffer.


serPutDecimal#

void serPutDecimal (uint16_t val)

Transmit a 16bit value in decimal.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aval

The data to print.


serPutHex#

void serPutHex (uint8_t byte)

Transmit a byte as hex.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Abyte

A byte.


serPutHexInt#

void serPutHexInt (uint16_t word)

Transmit a 16bit integer as hex.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aword

A 16bit integer.


serCharAvailable#

bool serCharAvailable (void )

Determine if a character is available.

Parameters
TypeDirectionArgument NameDescription
voidN/A

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
TypeDirectionArgument NameDescription
uint8_t *N/Ach

Pointer to a location where the received byte will be placed.

Returns


serGetFlush#

void serGetFlush (void )

Flush the receiver.

Parameters
TypeDirectionArgument NameDescription
voidN/A