Serial API#

Serial_ConfigureHandleQty()#

Description#

Configure maximum number of serial handles.

Files#

serial.h/serial.c

Prototype#

void  Serial_ConfigureHandleQty (CPU_SIZE_T  handle_qty)

Arguments#

handle_qty

Maximum number of serial handles.

Returned Value#

None.

Notes / Warnings#

None.

Serial_ConfigureMemSeg()#

Description#

Configures memory segment to use for internal data allocations.

Files#

serial.h/serial.c

Prototype#

void  Serial_ConfigureMemSeg (MEM_SEG  *p_seg)

Arguments#

p_seg

Pointer to memory segment.

Returned Value#

None.

Notes / Warnings#

None.

IO_SERIAL_CTRLR_REG()#

Description#

Registers a IO serial controller to the platform manager.

Files#

serial.h

Prototype#

IO_SERIAL_CTRLR_REG(name, p_drv_info)

Arguments#

name

Unique name for the IO serial controller. It is recommended to follow the standard "serX" or "spiX" where X is a digit.

p_drv_info

Pointer to the serial device hardware information structure of type SERIAL_CTRLR_DRV_INFO.

Returned Value#

None.

Notes / Warnings#

  1. This macro should normally be called from the BSP.