Debug output

Debug serial interface for logging and diagnostics. More...

Functions
void *	BoardDebugInit (void)
	Initialise the debug output interface.
void	BoardDebugDeinit (void)
	Deinitialise the debug output interface.
int	BoardDebugWrite (const uint8_t *Tx, size_t Length)
	Write data to the debug output interface.
int	BoardDebugRead (uint8_t *Rx, size_t Length)
	Read data from the debug output interface.

Detailed Description

Debug serial interface for logging and diagnostics.

Function Documentation

BoardDebugInit()

void * BoardDebugInit

(

void

)

Initialise the debug output interface.

Configures the debug serial interface for logging and diagnostics.

Returns

Void pointer to debug handle, or NULL if initialisation fails.

BoardDebugDeinit()

void BoardDebugDeinit

(

void

)

Deinitialise the debug output interface.

Closes the debug port and releases associated resources.

BoardDebugWrite()

int BoardDebugWrite	(	const uint8_t *	Tx,
		size_t	Length
	)

Write data to the debug output interface.

Parameters

Tx[in]	Pointer to the data buffer to be transmitted.
Length	Number of bytes to transmit.

Returns

0 if all bytes are sent successfully, -1 if transmission fails.

BoardDebugRead()

int BoardDebugRead	(	uint8_t *	Rx,
		size_t	Length
	)

Read data from the debug output interface.

Parameters

Rx[out]	Pointer to the buffer to store received data.
Length	Number of bytes to read.

Returns

Number of bytes read, or -1 if read fails.