Classes
struct	_serial_manager_callback_message
	Callback message structure. More...

struct	_serial_manager_config
	serial manager config structure More...

Macros
#define	SERIAL_MANAGER_HANDLE_DEFINE(name) uint32_t name[((SERIAL_MANAGER_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]
	Defines the serial manager handle. More...

#define	SERIAL_MANAGER_HANDLE_SIZE (SERIAL_MANAGER_HANDLE_SIZE_TEMP + 12U)
	SERIAL_PORT_UART_HANDLE_SIZE/SERIAL_PORT_USB_CDC_HANDLE_SIZE + serial manager dedicated size. More...

#define	SERIAL_MANAGER_HANDLE_SIZE_TEMP 0U

#define	SERIAL_MANAGER_NON_BLOCKING_MODE (0U)
	Enable or disable serial manager non-blocking mode (1 - enable, 0 - disable) More...

#define	SERIAL_MANAGER_READ_HANDLE_DEFINE(name) uint32_t name[((SERIAL_MANAGER_READ_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]
	Defines the serial manager read handle. More...

#define	SERIAL_MANAGER_READ_HANDLE_SIZE (4U)

#define	SERIAL_MANAGER_TASK_PRIORITY (2U)
	Macro to set serial manager task priority. More...

#define	SERIAL_MANAGER_TASK_STACK_SIZE (1000U)
	Macro to set serial manager task stack size. More...

#define	SERIAL_MANAGER_USE_COMMON_TASK (1U)
	Macro to determine whether use common task. More...

#define	SERIAL_MANAGER_WRITE_HANDLE_DEFINE(name) uint32_t name[((SERIAL_MANAGER_WRITE_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]
	Defines the serial manager write handle. More...

#define	SERIAL_MANAGER_WRITE_HANDLE_SIZE (4U)
	Set serial manager write handle size. More...

#define	SERIAL_PORT_TYPE_SWO (0U)
	Enable or disable SWO port (1 - enable, 0 - disable) More...

#define	SERIAL_PORT_TYPE_UART (0U)
	Enable or disable uart port (1 - enable, 0 - disable) More...

#define	SERIAL_PORT_TYPE_USBCDC (0U)
	Enable or disable USB CDC port (1 - enable, 0 - disable) More...

#define	SERIAL_PORT_TYPE_USBCDC_VIRTUAL (0U)
	Enable or disable USB CDC virtual port (1 - enable, 0 - disable) More...

Typedefs
typedef void *	serial_handle_t
	The handle of the serial manager module. More...

typedef struct _serial_manager_callback_message	serial_manager_callback_message_t
	Callback message structure. More...

typedef void(*	serial_manager_callback_t) (void callbackParam, serial_manager_callback_message_t message, serial_manager_status_t status)
	callback function More...

typedef struct _serial_manager_config	serial_manager_config_t
	serial manager config structure More...

typedef enum _serial_manager_status	serial_manager_status_t
	serial manager error code More...

typedef enum _serial_port_type	serial_port_type_t
	serial port type More...

typedef void *	serial_read_handle_t
	The read handle of the serial manager module. More...

typedef void *	serial_write_handle_t
	The write handle of the serial manager module. More...

Enumerations
enum	_serial_manager_status { kStatus_SerialManager_Success = kStatus_Success, kStatus_SerialManager_Error = MAKE_STATUS(kStatusGroup_SERIALMANAGER, 1), kStatus_SerialManager_Busy = MAKE_STATUS(kStatusGroup_SERIALMANAGER, 2), kStatus_SerialManager_Notify = MAKE_STATUS(kStatusGroup_SERIALMANAGER, 3), kStatus_SerialManager_Canceled, kStatus_SerialManager_HandleConflict = MAKE_STATUS(kStatusGroup_SERIALMANAGER, 5), kStatus_SerialManager_RingBufferOverflow, kStatus_SerialManager_NotConnected = MAKE_STATUS(kStatusGroup_SERIALMANAGER, 7) }
	serial manager error code More...

enum	_serial_port_type { kSerialPort_Uart = 1U, kSerialPort_UsbCdc, kSerialPort_Swo, kSerialPort_UsbCdcVirtual }
	serial port type More...

Functions
serial_manager_status_t	SerialManager_CloseReadHandle (serial_read_handle_t readHandle)
	Closes a reading for the serial manager module. More...

serial_manager_status_t	SerialManager_CloseWriteHandle (serial_write_handle_t writeHandle)
	Closes a writing handle for the serial manager module. More...

serial_manager_status_t	SerialManager_Deinit (serial_handle_t serialHandle)
	De-initializes the serial manager module instance. More...

serial_manager_status_t	SerialManager_EnterLowpower (serial_handle_t serialHandle)
	Prepares to enter low power consumption. More...

serial_manager_status_t	SerialManager_ExitLowpower (serial_handle_t serialHandle)
	Restores from low power consumption. More...

serial_manager_status_t	SerialManager_Init (serial_handle_t serialHandle, serial_manager_config_t *config)
	Initializes a serial manager module with the serial manager handle and the user configuration structure. More...

serial_manager_status_t	SerialManager_OpenReadHandle (serial_handle_t serialHandle, serial_read_handle_t readHandle)
	Opens a reading handle for the serial manager module. More...

serial_manager_status_t	SerialManager_OpenWriteHandle (serial_handle_t serialHandle, serial_write_handle_t writeHandle)
	Opens a writing handle for the serial manager module. More...

serial_manager_status_t	SerialManager_ReadBlocking (serial_read_handle_t readHandle, uint8_t *buffer, uint32_t length)
	Reads data with the blocking mode. More...

serial_manager_status_t	SerialManager_WriteBlocking (serial_write_handle_t writeHandle, uint8_t *buffer, uint32_t length)
	Transmits data with the blocking mode. More...

Detailed Description

Macro Definition Documentation

◆ SERIAL_MANAGER_HANDLE_DEFINE

#define SERIAL_MANAGER_HANDLE_DEFINE ( name ) uint32_t name[((SERIAL_MANAGER_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]

Defines the serial manager handle.

This macro is used to define a 4 byte aligned serial manager handle. Then use "(serial_handle_t)name" to get the serial manager handle.

The macro should be global and could be optional. You could also define serial manager handle by yourself.

This is an example,

SERIAL_MANAGER_HANDLE_DEFINE(serialManagerHandle);

Parameters

name	The name string of the serial manager handle.

Definition at line 151 of file serial_manager.h.

◆ SERIAL_MANAGER_HANDLE_SIZE

#define SERIAL_MANAGER_HANDLE_SIZE (SERIAL_MANAGER_HANDLE_SIZE_TEMP + 12U)

SERIAL_PORT_UART_HANDLE_SIZE/SERIAL_PORT_USB_CDC_HANDLE_SIZE + serial manager dedicated size.

Definition of serial manager handle size.

Definition at line 133 of file serial_manager.h.

◆ SERIAL_MANAGER_HANDLE_SIZE_TEMP

#define SERIAL_MANAGER_HANDLE_SIZE_TEMP 0U

Definition at line 86 of file serial_manager.h.

◆ SERIAL_MANAGER_NON_BLOCKING_MODE

#define SERIAL_MANAGER_NON_BLOCKING_MODE (0U)

Enable or disable serial manager non-blocking mode (1 - enable, 0 - disable)

Definition at line 27 of file serial_manager.h.

◆ SERIAL_MANAGER_READ_HANDLE_DEFINE

#define SERIAL_MANAGER_READ_HANDLE_DEFINE ( name ) uint32_t name[((SERIAL_MANAGER_READ_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]

Defines the serial manager read handle.

This macro is used to define a 4 byte aligned serial manager read handle. Then use "(serial_read_handle_t)name" to get the serial manager read handle.

The macro should be global and could be optional. You could also define serial manager read handle by yourself.

This is an example,

SERIAL_MANAGER_READ_HANDLE_DEFINE(serialManagerReadHandle);

Parameters

name	The name string of the serial manager read handle.

Definition at line 187 of file serial_manager.h.

◆ SERIAL_MANAGER_READ_HANDLE_SIZE

#define SERIAL_MANAGER_READ_HANDLE_SIZE (4U)

Definition at line 57 of file serial_manager.h.

◆ SERIAL_MANAGER_TASK_PRIORITY

#define SERIAL_MANAGER_TASK_PRIORITY (2U)

Macro to set serial manager task priority.

Definition at line 197 of file serial_manager.h.

◆ SERIAL_MANAGER_TASK_STACK_SIZE

#define SERIAL_MANAGER_TASK_STACK_SIZE (1000U)

Macro to set serial manager task stack size.

Definition at line 202 of file serial_manager.h.

◆ SERIAL_MANAGER_USE_COMMON_TASK

#define SERIAL_MANAGER_USE_COMMON_TASK (1U)

Macro to determine whether use common task.

Definition at line 192 of file serial_manager.h.

◆ SERIAL_MANAGER_WRITE_HANDLE_DEFINE

#define SERIAL_MANAGER_WRITE_HANDLE_DEFINE ( name ) uint32_t name[((SERIAL_MANAGER_WRITE_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]

Defines the serial manager write handle.

This macro is used to define a 4 byte aligned serial manager write handle. Then use "(serial_write_handle_t)name" to get the serial manager write handle.

The macro should be global and could be optional. You could also define serial manager write handle by yourself.

This is an example,

SERIAL_MANAGER_WRITE_HANDLE_DEFINE(serialManagerwriteHandle);

Parameters

name	The name string of the serial manager write handle.

Definition at line 169 of file serial_manager.h.

◆ SERIAL_MANAGER_WRITE_HANDLE_SIZE

#define SERIAL_MANAGER_WRITE_HANDLE_SIZE (4U)

Set serial manager write handle size.

Definition at line 56 of file serial_manager.h.

◆ SERIAL_PORT_TYPE_SWO

#define SERIAL_PORT_TYPE_SWO (0U)

Enable or disable SWO port (1 - enable, 0 - disable)

Definition at line 43 of file serial_manager.h.

◆ SERIAL_PORT_TYPE_UART

#define SERIAL_PORT_TYPE_UART (0U)

Enable or disable uart port (1 - enable, 0 - disable)

Definition at line 33 of file serial_manager.h.

◆ SERIAL_PORT_TYPE_USBCDC

#define SERIAL_PORT_TYPE_USBCDC (0U)

Enable or disable USB CDC port (1 - enable, 0 - disable)

Definition at line 38 of file serial_manager.h.

◆ SERIAL_PORT_TYPE_USBCDC_VIRTUAL

#define SERIAL_PORT_TYPE_USBCDC_VIRTUAL (0U)

Enable or disable USB CDC virtual port (1 - enable, 0 - disable)

Definition at line 48 of file serial_manager.h.

Typedef Documentation

◆ serial_handle_t

typedef void* serial_handle_t

The handle of the serial manager module.

Definition at line 206 of file serial_manager.h.

◆ serial_manager_callback_message_t

typedef struct _serial_manager_callback_message serial_manager_callback_message_t

Callback message structure.

◆ serial_manager_callback_t

typedef void(* serial_manager_callback_t) (void *callbackParam, serial_manager_callback_message_t *message, serial_manager_status_t status)

callback function

Definition at line 259 of file serial_manager.h.

◆ serial_manager_config_t

typedef struct _serial_manager_config serial_manager_config_t

serial manager config structure

◆ serial_manager_status_t

typedef enum _serial_manager_status serial_manager_status_t

serial manager error code

◆ serial_port_type_t

typedef enum _serial_port_type serial_port_type_t

serial port type

◆ serial_read_handle_t

typedef void* serial_read_handle_t

The read handle of the serial manager module.

Definition at line 212 of file serial_manager.h.

◆ serial_write_handle_t

typedef void* serial_write_handle_t

The write handle of the serial manager module.

Definition at line 209 of file serial_manager.h.

Enumeration Type Documentation

◆ _serial_manager_status

enum _serial_manager_status

serial manager error code

Enumerator
kStatus_SerialManager_Success	Success
kStatus_SerialManager_Error	Failed
kStatus_SerialManager_Busy	Busy
kStatus_SerialManager_Notify	Ring buffer is not empty
kStatus_SerialManager_Canceled	the non-blocking request is canceled
kStatus_SerialManager_HandleConflict	The handle is opened
kStatus_SerialManager_RingBufferOverflow	The ring buffer is overflowed
kStatus_SerialManager_NotConnected	The host is not connected

Definition at line 237 of file serial_manager.h.

◆ _serial_port_type

enum _serial_port_type

serial port type

Enumerator
kSerialPort_Uart	Serial port UART
kSerialPort_UsbCdc	Serial port USB CDC
kSerialPort_Swo	Serial port SWO
kSerialPort_UsbCdcVirtual	Serial port USB CDC Virtual

Definition at line 215 of file serial_manager.h.

Function Documentation

◆ SerialManager_CloseReadHandle()

serial_manager_status_t SerialManager_CloseReadHandle ( serial_read_handle_t readHandle )

Closes a reading for the serial manager module.

This function Closes a reading for the serial manager module.

Parameters

readHandle The serial manager module reading handle pointer.

Return values

kStatus_SerialManager_Success The reading handle is closed.

Definition at line 1094 of file serial_manager.c.

◆ SerialManager_CloseWriteHandle()

serial_manager_status_t SerialManager_CloseWriteHandle ( serial_write_handle_t writeHandle )

Closes a writing handle for the serial manager module.

This function Closes a writing handle for the serial manager module.

Parameters

writeHandle The serial manager module writing handle pointer.

Return values

kStatus_SerialManager_Success The writing handle is closed.

Definition at line 1031 of file serial_manager.c.

◆ SerialManager_Deinit()

serial_manager_status_t SerialManager_Deinit ( serial_handle_t serialHandle )

De-initializes the serial manager module instance.

This function de-initializes the serial manager module instance. If the opened writing or reading handle is not closed, the function will return kStatus_SerialManager_Busy.

Parameters

serialHandle The serial manager module handle pointer.

Return values

kStatus_SerialManager_Success	The serial manager de-initialization succeed.
kStatus_SerialManager_Busy	Opened reading or writing handle is not closed.

Definition at line 944 of file serial_manager.c.

◆ SerialManager_EnterLowpower()

serial_manager_status_t SerialManager_EnterLowpower ( serial_handle_t serialHandle )

Prepares to enter low power consumption.

This function is used to prepare to enter low power consumption.

Parameters

serialHandle The serial manager module handle pointer.

Return values

kStatus_SerialManager_Success Successful operation.

Definition at line 1325 of file serial_manager.c.

◆ SerialManager_ExitLowpower()

serial_manager_status_t SerialManager_ExitLowpower ( serial_handle_t serialHandle )

Restores from low power consumption.

This function is used to restore from low power consumption.

Parameters

serialHandle The serial manager module handle pointer.

Return values

kStatus_SerialManager_Success Successful operation.

Definition at line 1360 of file serial_manager.c.

◆ SerialManager_Init()

serial_manager_status_t SerialManager_Init	(	serial_handle_t	serialHandle,
		serial_manager_config_t *	config
	)

Initializes a serial manager module with the serial manager handle and the user configuration structure.

This function configures the Serial Manager module with user-defined settings. The user can configure the configuration structure. The parameter serialHandle is a pointer to point to a memory space of size SERIAL_MANAGER_HANDLE_SIZE allocated by the caller. The Serial Manager module supports three types of serial port, UART (includes UART, USART, LPSCI, LPUART, etc), USB CDC and swo. Please refer to serial_port_type_t for serial port setting. These three types can be set by using serial_manager_config_t.

Example below shows how to use this API to configure the Serial Manager. For UART,

#define SERIAL_MANAGER_RING_BUFFER_SIZE (256U)
static SERIAL_MANAGER_HANDLE_DEFINE(s_serialHandle);
static uint8_t s_ringBuffer[SERIAL_MANAGER_RING_BUFFER_SIZE];
 
serial_manager_config_t config;
serial_port_uart_config_t uartConfig;
config.type = kSerialPort_Uart;
config.ringBuffer = &s_ringBuffer[0];
config.ringBufferSize = SERIAL_MANAGER_RING_BUFFER_SIZE;
uartConfig.instance = 0;
uartConfig.clockRate = 24000000;
uartConfig.baudRate = 115200;
uartConfig.parityMode = kSerialManager_UartParityDisabled;
uartConfig.stopBitCount = kSerialManager_UartOneStopBit;
uartConfig.enableRx = 1;
uartConfig.enableTx = 1;
config.portConfig = &uartConfig;
SerialManager_Init((serial_handle_t)s_serialHandle, &config);

For USB CDC,

#define SERIAL_MANAGER_RING_BUFFER_SIZE (256U)
static SERIAL_MANAGER_HANDLE_DEFINE(s_serialHandle);
static uint8_t s_ringBuffer[SERIAL_MANAGER_RING_BUFFER_SIZE];
 
serial_manager_config_t config;
serial_port_usb_cdc_config_t usbCdcConfig;
config.type = kSerialPort_UsbCdc;
config.ringBuffer = &s_ringBuffer[0];
config.ringBufferSize = SERIAL_MANAGER_RING_BUFFER_SIZE;
usbCdcConfig.controllerIndex = kSerialManager_UsbControllerKhci0;
config.portConfig = &usbCdcConfig;
SerialManager_Init((serial_handle_t)s_serialHandle, &config);

Parameters

serialHandle	Pointer to point to a memory space of size SERIAL_MANAGER_HANDLE_SIZE allocated by the caller. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices. You can define the handle in the following two ways: SERIAL_MANAGER_HANDLE_DEFINE(serialHandle); or uint32_t serialHandle[((SERIAL_MANAGER_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))];
config	Pointer to user-defined configuration structure.

Return values

kStatus_SerialManager_Error	An error occurred.
kStatus_SerialManager_Success	The Serial Manager module initialization succeed.

Definition at line 823 of file serial_manager.c.

◆ SerialManager_OpenReadHandle()

serial_manager_status_t SerialManager_OpenReadHandle	(	serial_handle_t	serialHandle,
		serial_read_handle_t	readHandle
	)

Opens a reading handle for the serial manager module.

This function Opens a reading handle for the serial manager module. The reading handle can not be opened multiple at the same time. The error code kStatus_SerialManager_Busy would be returned when the previous reading handle is not closed. And there can only be one buffer for receiving for the reading handle at the same time.

Parameters

serialHandle	The serial manager module handle pointer. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices.
readHandle	The serial manager module reading handle pointer. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices. You can define the handle in the following two ways: SERIAL_MANAGER_READ_HANDLE_DEFINE(readHandle); or uint32_t readHandle[((SERIAL_MANAGER_READ_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))];

Return values

kStatus_SerialManager_Error	An error occurred.
kStatus_SerialManager_Success	The reading handle is opened.
kStatus_SerialManager_Busy	Previous reading handle is not closed.

Example below shows how to use this API to read data.

static SERIAL_MANAGER_READ_HANDLE_DEFINE(s_serialReadHandle);
SerialManager_OpenReadHandle((serial_handle_t)serialHandle, (serial_read_handle_t)s_serialReadHandle);
static uint8_t s_nonBlockingBuffer[64];
SerialManager_InstallRxCallback((serial_read_handle_t)s_serialReadHandle,
                                 APP_SerialManagerRxCallback,
                                 s_serialReadHandle);
SerialManager_ReadNonBlocking((serial_read_handle_t)s_serialReadHandle,
                               s_nonBlockingBuffer,
                               sizeof(s_nonBlockingBuffer));

Definition at line 1062 of file serial_manager.c.

◆ SerialManager_OpenWriteHandle()

serial_manager_status_t SerialManager_OpenWriteHandle	(	serial_handle_t	serialHandle,
		serial_write_handle_t	writeHandle
	)

Opens a writing handle for the serial manager module.

This function Opens a writing handle for the serial manager module. If the serial manager needs to be used in different tasks, the task should open a dedicated write handle for itself by calling SerialManager_OpenWriteHandle. Since there can only one buffer for transmission for the writing handle at the same time, multiple writing handles need to be opened when the multiple transmission is needed for a task.

Parameters

serialHandle	The serial manager module handle pointer. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices.
writeHandle	The serial manager module writing handle pointer. The handle should be 4 byte aligned, because unaligned access doesn't be supported on some devices. You can define the handle in the following two ways: SERIAL_MANAGER_WRITE_HANDLE_DEFINE(writeHandle); or uint32_t writeHandle[((SERIAL_MANAGER_WRITE_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))];

Return values

kStatus_SerialManager_Error	An error occurred.
kStatus_SerialManager_HandleConflict	The writing handle was opened.
kStatus_SerialManager_Success	The writing handle is opened.

Example below shows how to use this API to write data. For task 1,

static SERIAL_MANAGER_WRITE_HANDLE_DEFINE(s_serialWriteHandle1);
static uint8_t s_nonBlockingWelcome1[] = "This is non-blocking writing log for task1!\r\n";
SerialManager_OpenWriteHandle((serial_handle_t)serialHandle, (serial_write_handle_t)s_serialWriteHandle1);
SerialManager_InstallTxCallback((serial_write_handle_t)s_serialWriteHandle1,
                                 Task1_SerialManagerTxCallback,
                                 s_serialWriteHandle1);
SerialManager_WriteNonBlocking((serial_write_handle_t)s_serialWriteHandle1,
                                s_nonBlockingWelcome1,
                                sizeof(s_nonBlockingWelcome1) - 1U);

For task 2,

static SERIAL_MANAGER_WRITE_HANDLE_DEFINE(s_serialWriteHandle2);
static uint8_t s_nonBlockingWelcome2[] = "This is non-blocking writing log for task2!\r\n";
SerialManager_OpenWriteHandle((serial_handle_t)serialHandle, (serial_write_handle_t)s_serialWriteHandle2);
SerialManager_InstallTxCallback((serial_write_handle_t)s_serialWriteHandle2,
                                 Task2_SerialManagerTxCallback,
                                 s_serialWriteHandle2);
SerialManager_WriteNonBlocking((serial_write_handle_t)s_serialWriteHandle2,
                                s_nonBlockingWelcome2,
                                sizeof(s_nonBlockingWelcome2) - 1U);

Definition at line 1004 of file serial_manager.c.

◆ SerialManager_ReadBlocking()

serial_manager_status_t SerialManager_ReadBlocking	(	serial_read_handle_t	readHandle,
		uint8_t *	buffer,
		uint32_t	length
	)

Reads data with the blocking mode.

This is a blocking function, which polls the receiving buffer, waits for the receiving buffer to be full. This function receives data using an interrupt method. The interrupt of the hardware could not be disabled. And There can only one buffer for receiving for the reading handle at the same time.

Note: The function SerialManager_ReadBlocking and the function SerialManager_ReadNonBlocking cannot be used at the same time. And, the function SerialManager_CancelReading cannot be used to abort the transmission of this function.

Parameters

readHandle	The serial manager module handle pointer.
buffer	Start address of the data to store the received data.
length	The length of the data to be received.

Return values

kStatus_SerialManager_Success	Successfully received all data.
kStatus_SerialManager_Busy	Previous transmission still not finished; data not all received yet.
kStatus_SerialManager_Error	An error occurred.

Definition at line 1132 of file serial_manager.c.

◆ SerialManager_WriteBlocking()

serial_manager_status_t SerialManager_WriteBlocking	(	serial_write_handle_t	writeHandle,
		uint8_t *	buffer,
		uint32_t	length
	)

Transmits data with the blocking mode.

This is a blocking function, which polls the sending queue, waits for the sending queue to be empty. This function sends data using an interrupt method. The interrupt of the hardware could not be disabled. And There can only one buffer for transmission for the writing handle at the same time.

Note: The function SerialManager_WriteBlocking and the function SerialManager_WriteNonBlocking cannot be used at the same time. And, the function SerialManager_CancelWriting cannot be used to abort the transmission of this function.

Parameters

writeHandle	The serial manager module handle pointer.
buffer	Start address of the data to write.
length	Length of the data to write.

Return values

kStatus_SerialManager_Success	Successfully sent all data.
kStatus_SerialManager_Busy	Previous transmission still not finished; data not all sent yet.
kStatus_SerialManager_Error	An error occurred.

Definition at line 1123 of file serial_manager.c.

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ SERIAL_MANAGER_HANDLE_DEFINE

◆ SERIAL_MANAGER_HANDLE_SIZE

◆ SERIAL_MANAGER_HANDLE_SIZE_TEMP

◆ SERIAL_MANAGER_NON_BLOCKING_MODE

◆ SERIAL_MANAGER_READ_HANDLE_DEFINE

◆ SERIAL_MANAGER_READ_HANDLE_SIZE

◆ SERIAL_MANAGER_TASK_PRIORITY

◆ SERIAL_MANAGER_TASK_STACK_SIZE

◆ SERIAL_MANAGER_USE_COMMON_TASK

◆ SERIAL_MANAGER_WRITE_HANDLE_DEFINE

◆ SERIAL_MANAGER_WRITE_HANDLE_SIZE

◆ SERIAL_PORT_TYPE_SWO

◆ SERIAL_PORT_TYPE_UART

◆ SERIAL_PORT_TYPE_USBCDC

◆ SERIAL_PORT_TYPE_USBCDC_VIRTUAL

Typedef Documentation

◆ serial_handle_t

◆ serial_manager_callback_message_t

◆ serial_manager_callback_t

◆ serial_manager_config_t

◆ serial_manager_status_t

◆ serial_port_type_t

◆ serial_read_handle_t

◆ serial_write_handle_t

Enumeration Type Documentation

◆ _serial_manager_status

◆ _serial_port_type

Function Documentation

◆ SerialManager_CloseReadHandle()

◆ SerialManager_CloseWriteHandle()

◆ SerialManager_Deinit()

◆ SerialManager_EnterLowpower()

◆ SerialManager_ExitLowpower()

◆ SerialManager_Init()

◆ SerialManager_OpenReadHandle()

◆ SerialManager_OpenWriteHandle()

◆ SerialManager_ReadBlocking()

◆ SerialManager_WriteBlocking()