Introduction

This files defines CDD UART configuration structures

Data Structures
struct	Cdd_Uart_NotifCallbacksType

struct	Cdd_Uart_ConfigType

struct	Cdd_Uart_CfgType

Variables
void(*	Cdd_Uart_NotifCallbacksType::uartNotificationReadHandler )(void)

void(*	Cdd_Uart_NotifCallbacksType::uartNotificationWriteHandler )(void)

void(*	Cdd_Uart_NotifCallbacksType::uartNotificationErrorHandler )(void)

uint32	Cdd_Uart_ConfigType::uartHwUnitID

uint32	Cdd_Uart_ConfigType::uartClockFrequency

uint32	Cdd_Uart_ConfigType::uartBaudRate

uint32	Cdd_Uart_ConfigType::uartIOMode

uint32	Cdd_Uart_ConfigType::uartTXTriggerLevel

uint32	Cdd_Uart_ConfigType::uartRXTriggerLevel

uint32	Cdd_Uart_ConfigType::uartHwFlowControlThreshold

uint32	Cdd_Uart_ConfigType::uartWordLength

uint32	Cdd_Uart_ConfigType::uartParity

uint32	Cdd_Uart_ConfigType::uartReadReturnMode

uint32	Cdd_Uart_ConfigType::uartOperatingMode

uint32	Cdd_Uart_ConfigType::uartStopBits

uint32	Cdd_Uart_ConfigType::uartTransferType

Cdd_Uart_NotifCallbacksType	Cdd_Uart_ConfigType::uartNotificationHandlers

uint8	Cdd_Uart_CfgType::netChannels

Cdd_Uart_ConfigType	Cdd_Uart_CfgType::channelCfg [CDD_UART_NUM_CHANNELS]

Pre-Compile Switches for API Services
enum	Cdd_Uart_StatusType { CDD_UART_UNINIT = 0U , CDD_UART_INIT = 1U }
	This type defines a range of specific status for UART Complex Driver. More...

#define	CDD_UART_VERSION_INFO_API STD_ON
	Enable/disable CDD UART Get version info API.

#define	CDD_UART_REGISTER_READBACK_API STD_ON
	Enable/disable CDD UART Register Readback API.

#define	CDD_UART_DEINIT_API STD_ON
	Enable/disable CDD UART DeInit API.

#define	CDD_UART_WRITE_API STD_ON
	Enable/disable CDD UART Write API.

#define	CDD_UART_READ_API STD_ON
	Enable/disable CDD UART Read API.

#define	CDD_UART_CANCEL_API STD_ON
	Enable/disable CDD UART Cancel API.

#define	CDD_UART_GETREMAININGWORDS_API STD_ON
	Enable/disable CDD UART GetRemainingWords API.

#define	CDD_UART_NUM_CHANNELS 1U
	total number of UART channels allocated

#define	CDD_UART_OS_COUNTER_ID ((CounterType)OsCounter_0)
	Counter ID for counter used to count wait ticks.

#define	CddUartConf_CddUartChannelConfiguration_CddUartChannel_0 (0U)
	Symbolic Names for UART channels.

#define	CDD_UART_PRE_COMPILE_VARIANT STD_ON

#define	CDD_UART_INIT_CONFIG_PC CddUartDriver_0

#define	CDD_UART_MAXIMUM_CHANNELS 9U
	Enable/disable UART per-channel ISR.

CDD UART Configurations type
UART configuration type structure for all channels in use
const Cdd_Uart_CfgType	CddUartDriver_0
	CDD Uart Configuration struct declaration.

CDD UART Driver Configuration SW Version Info
Defines for CDD UART Driver configuration version
#define	CDD_UART_MAJOR_VERSION (10U)
	CDD UART configuration Major Version.

#define	CDD_UART_MINOR_VERSION (3U)
	CDD UART configuration Minor Version.

#define	CDD_UART_CFG_PATCH_VERSION (1U)
	CDD UART configuration Patch Version.

CDD Driver ISR category level
Defines for CDD UART Driver ISR category level
#define	CDD_UART_ISR_VOID (0x00U)
	void ISR type

#define	CDD_UART_ISR_CAT1 (0x01U)
	Category 1 ISR type.

#define	CDD_UART_ISR_CAT2 (0x02U)
	Category 2 ISR type.

#define	CDD_UART_CFG_ID (0x1U)
	CDD UART Config ID.

#define	CDD_UART_DEV_ERROR_DETECT STD_ON
	Enable/disable CDD UART dev detect error.

#define	CDD_UART_ISR_TYPE CDD_UART_ISR_CAT2

#define	CDD_UART_CHANNEL_ID_0 (0U)
	CDD UART Channel Hardware IDs.

#define	CDD_UART_CHANNEL_ID_1 (1U)

#define	CDD_UART_CHANNEL_ID_2 (2U)

#define	CDD_UART_CHANNEL_ID_3 (3U)

#define	CDD_UART_CHANNEL_ID_4 (4U)

#define	CDD_UART_CHANNEL_ID_5 (5U)

#define	CDD_UART_CHANNEL_ID_6 (6U)

#define	CDD_UART_CHANNEL_ID_7 (7U)

#define	CDD_UART_CHANNEL_ID_8 (8U)

CDD UART transaction modes
#define	CDD_UART_MODE_POLLING (0U)
	Polling mode.

#define	CDD_UART_MODE_INTERRUPT (1U)
	Interrupt mode.

#define	CDD_UART_MODE_DMA (2U)
	DMA mode.

CDD UART DMA Resource Count
#define	CDD_UART_DMA_CFG_NUM_INSTANCES 1U
	Number of UART DMA instances configured. This parameter indicates DMA instances used by UART. When UART DMA mode is configured, PKTDMA instance is supported for peripheral DMA mode (PERIPH_TX/PERIPH_RX)

CDD UART word length
#define	CDD_UART_WORD_LENGTH_5 (0U)
	Word Length 5.

#define	CDD_UART_WORD_LENGTH_6 (1U)
	Word Length 6.

#define	CDD_UART_WORD_LENGTH_7 (2U)
	Word Length 7.

#define	CDD_UART_WORD_LENGTH_8 (3U)
	Word Length 8.

CDD UART parity types
#define	CDD_UART_PARITY_NONE (0U)
	None Parity.

#define	CDD_UART_PARITY_ODD (1U)
	Odd Parity.

#define	CDD_UART_PARITY_EVEN (3U)
	Even Parity.

CDD UART Transmit/Receive trigger levels
#define	CDD_UART_TRIGGER_LEVEL_1 (1U)
	Trigger Level 1.

#define	CDD_UART_TRIGGER_LEVEL_8 (8U)
	Trigger Level 8.

#define	CDD_UART_TRIGGER_LEVEL_16 (16U)
	Trigger Level 16.

#define	CDD_UART_TRIGGER_LEVEL_32 (32U)
	Trigger Level 32.

#define	CDD_UART_TRIGGER_LEVEL_56 (56U)
	Trigger Level 56.

#define	CDD_UART_TRIGGER_LEVEL_60 (60U)
	Trigger Level 60.

CDD UART operational modes
#define	CDD_UART_13x_OPER (3U)
	UART13X mode.

#define	CDD_UART_16x_OPER (0U)
	UART16X mode.

#define	CDD_UART_16x_AUTO_OPER (2U)
	UART16X AUTO mode.

CDD UART read return modes
#define	CDD_UART_FULL_READ_RETURN (0U)
	Full read return mode.

#define	CDD_UART_PARTIAL_READ_RETURN (1U)
	Partial read return mode.

CDD UART stop bits
#define	CDD_UART_STOP_BIT_1 (0U)
	Stop Bit 1.

#define	CDD_UART_STOP_BITS_2 (1U)
	Stop Bit 2.

CDD UART transfer types
#define	UART_TRANS_TX_RX_MODE (0U)
	TX and RX mode.

#define	UART_TRANS_TX_MODE (1U)
	TX mode only.

#define	UART_TRANS_RX_MODE (2U)
	RX mode only.

Macro Definition Documentation

◆ CDD_UART_MAJOR_VERSION

#define CDD_UART_MAJOR_VERSION (10U)

CDD UART configuration Major Version.

◆ CDD_UART_MINOR_VERSION

#define CDD_UART_MINOR_VERSION (3U)

CDD UART configuration Minor Version.

◆ CDD_UART_CFG_PATCH_VERSION

#define CDD_UART_CFG_PATCH_VERSION (1U)

CDD UART configuration Patch Version.

◆ CDD_UART_ISR_VOID

#define CDD_UART_ISR_VOID (0x00U)

void ISR type

◆ CDD_UART_ISR_CAT1

#define CDD_UART_ISR_CAT1 (0x01U)

Category 1 ISR type.

◆ CDD_UART_ISR_CAT2

#define CDD_UART_ISR_CAT2 (0x02U)

Category 2 ISR type.

◆ CDD_UART_CFG_ID

#define CDD_UART_CFG_ID (0x1U)

CDD UART Config ID.

◆ CDD_UART_DEV_ERROR_DETECT

#define CDD_UART_DEV_ERROR_DETECT STD_ON

Enable/disable CDD UART dev detect error.

◆ CDD_UART_ISR_TYPE

#define CDD_UART_ISR_TYPE CDD_UART_ISR_CAT2

◆ CDD_UART_CHANNEL_ID_0

#define CDD_UART_CHANNEL_ID_0 (0U)

CDD UART Channel Hardware IDs.

◆ CDD_UART_CHANNEL_ID_1

#define CDD_UART_CHANNEL_ID_1 (1U)

◆ CDD_UART_CHANNEL_ID_2

#define CDD_UART_CHANNEL_ID_2 (2U)

◆ CDD_UART_CHANNEL_ID_3

#define CDD_UART_CHANNEL_ID_3 (3U)

◆ CDD_UART_CHANNEL_ID_4

#define CDD_UART_CHANNEL_ID_4 (4U)

◆ CDD_UART_CHANNEL_ID_5

#define CDD_UART_CHANNEL_ID_5 (5U)

◆ CDD_UART_CHANNEL_ID_6

#define CDD_UART_CHANNEL_ID_6 (6U)

◆ CDD_UART_CHANNEL_ID_7

#define CDD_UART_CHANNEL_ID_7 (7U)

◆ CDD_UART_CHANNEL_ID_8

#define CDD_UART_CHANNEL_ID_8 (8U)

◆ CDD_UART_MODE_POLLING

#define CDD_UART_MODE_POLLING (0U)

Polling mode.

◆ CDD_UART_MODE_INTERRUPT

#define CDD_UART_MODE_INTERRUPT (1U)

Interrupt mode.

◆ CDD_UART_MODE_DMA

#define CDD_UART_MODE_DMA (2U)

DMA mode.

◆ CDD_UART_DMA_CFG_NUM_INSTANCES

#define CDD_UART_DMA_CFG_NUM_INSTANCES 1U

Number of UART DMA instances configured. This parameter indicates DMA instances used by UART. When UART DMA mode is configured, PKTDMA instance is supported for peripheral DMA mode (PERIPH_TX/PERIPH_RX)

◆ CDD_UART_WORD_LENGTH_5

#define CDD_UART_WORD_LENGTH_5 (0U)

Word Length 5.

◆ CDD_UART_WORD_LENGTH_6

#define CDD_UART_WORD_LENGTH_6 (1U)

Word Length 6.

◆ CDD_UART_WORD_LENGTH_7

#define CDD_UART_WORD_LENGTH_7 (2U)

Word Length 7.

◆ CDD_UART_WORD_LENGTH_8

#define CDD_UART_WORD_LENGTH_8 (3U)

Word Length 8.

◆ CDD_UART_PARITY_NONE

#define CDD_UART_PARITY_NONE (0U)

None Parity.

◆ CDD_UART_PARITY_ODD

#define CDD_UART_PARITY_ODD (1U)

Odd Parity.

◆ CDD_UART_PARITY_EVEN

#define CDD_UART_PARITY_EVEN (3U)

Even Parity.

◆ CDD_UART_TRIGGER_LEVEL_1

#define CDD_UART_TRIGGER_LEVEL_1 (1U)

Trigger Level 1.

◆ CDD_UART_TRIGGER_LEVEL_8

#define CDD_UART_TRIGGER_LEVEL_8 (8U)

Trigger Level 8.

◆ CDD_UART_TRIGGER_LEVEL_16

#define CDD_UART_TRIGGER_LEVEL_16 (16U)

Trigger Level 16.

◆ CDD_UART_TRIGGER_LEVEL_32

#define CDD_UART_TRIGGER_LEVEL_32 (32U)

Trigger Level 32.

◆ CDD_UART_TRIGGER_LEVEL_56

#define CDD_UART_TRIGGER_LEVEL_56 (56U)

Trigger Level 56.

◆ CDD_UART_TRIGGER_LEVEL_60

#define CDD_UART_TRIGGER_LEVEL_60 (60U)

Trigger Level 60.

◆ CDD_UART_13x_OPER

#define CDD_UART_13x_OPER (3U)

UART13X mode.

◆ CDD_UART_16x_OPER

#define CDD_UART_16x_OPER (0U)

UART16X mode.

◆ CDD_UART_16x_AUTO_OPER

#define CDD_UART_16x_AUTO_OPER (2U)

UART16X AUTO mode.

◆ CDD_UART_FULL_READ_RETURN

#define CDD_UART_FULL_READ_RETURN (0U)

Full read return mode.

◆ CDD_UART_PARTIAL_READ_RETURN

#define CDD_UART_PARTIAL_READ_RETURN (1U)

Partial read return mode.

◆ CDD_UART_STOP_BIT_1

#define CDD_UART_STOP_BIT_1 (0U)

Stop Bit 1.

◆ CDD_UART_STOP_BITS_2

#define CDD_UART_STOP_BITS_2 (1U)

Stop Bit 2.

◆ UART_TRANS_TX_RX_MODE

#define UART_TRANS_TX_RX_MODE (0U)

TX and RX mode.

◆ UART_TRANS_TX_MODE

#define UART_TRANS_TX_MODE (1U)

TX mode only.

◆ UART_TRANS_RX_MODE

#define UART_TRANS_RX_MODE (2U)

RX mode only.

◆ CDD_UART_VERSION_INFO_API

#define CDD_UART_VERSION_INFO_API STD_ON

Enable/disable CDD UART Get version info API.

◆ CDD_UART_REGISTER_READBACK_API

#define CDD_UART_REGISTER_READBACK_API STD_ON

Enable/disable CDD UART Register Readback API.

◆ CDD_UART_DEINIT_API

#define CDD_UART_DEINIT_API STD_ON

Enable/disable CDD UART DeInit API.

◆ CDD_UART_WRITE_API

#define CDD_UART_WRITE_API STD_ON

Enable/disable CDD UART Write API.

◆ CDD_UART_READ_API

#define CDD_UART_READ_API STD_ON

Enable/disable CDD UART Read API.

◆ CDD_UART_CANCEL_API

#define CDD_UART_CANCEL_API STD_ON

Enable/disable CDD UART Cancel API.

◆ CDD_UART_GETREMAININGWORDS_API

#define CDD_UART_GETREMAININGWORDS_API STD_ON

Enable/disable CDD UART GetRemainingWords API.

◆ CDD_UART_NUM_CHANNELS

#define CDD_UART_NUM_CHANNELS 1U

total number of UART channels allocated

◆ CDD_UART_OS_COUNTER_ID

#define CDD_UART_OS_COUNTER_ID ((CounterType)OsCounter_0)

Counter ID for counter used to count wait ticks.

◆ CddUartConf_CddUartChannelConfiguration_CddUartChannel_0

#define CddUartConf_CddUartChannelConfiguration_CddUartChannel_0 (0U)

Symbolic Names for UART channels.

◆ CDD_UART_PRE_COMPILE_VARIANT

#define CDD_UART_PRE_COMPILE_VARIANT STD_ON

◆ CDD_UART_INIT_CONFIG_PC

#define CDD_UART_INIT_CONFIG_PC CddUartDriver_0

◆ CDD_UART_MAXIMUM_CHANNELS

#define CDD_UART_MAXIMUM_CHANNELS 9U

Enable/disable UART per-channel ISR.

Maximum Channels or UART Instances on Board

Enumeration Type Documentation

◆ Cdd_Uart_StatusType

enum Cdd_Uart_StatusType

This type defines a range of specific status for UART Complex Driver.

Enumerator
CDD_UART_UNINIT	The UART Complex Driver is not initialized or not usable The UART Complex Driver is not currently transferring
CDD_UART_INIT

Variable Documentation

◆ uartNotificationReadHandler

void(* Cdd_Uart_NotifCallbacksType::uartNotificationReadHandler) (void)

< UART Read Notification Handler UART Write Notification Handler

◆ uartNotificationWriteHandler

void(* Cdd_Uart_NotifCallbacksType::uartNotificationWriteHandler) (void)

UART Error Notification Handler

◆ uartNotificationErrorHandler

void(* Cdd_Uart_NotifCallbacksType::uartNotificationErrorHandler) (void)

◆ uartHwUnitID

uint32 Cdd_Uart_ConfigType::uartHwUnitID

< CoreID on which the UART is instantiated Clock Frequency

◆ uartClockFrequency

uint32 Cdd_Uart_ConfigType::uartClockFrequency

Baud Rate for signal transfer

◆ uartBaudRate

uint32 Cdd_Uart_ConfigType::uartBaudRate

IO Mode for signal transfer

◆ uartIOMode

uint32 Cdd_Uart_ConfigType::uartIOMode

Trigger level for Transmission of signal

◆ uartTXTriggerLevel

uint32 Cdd_Uart_ConfigType::uartTXTriggerLevel

Trigger level for Receival of signal

◆ uartRXTriggerLevel

uint32 Cdd_Uart_ConfigType::uartRXTriggerLevel

Trigger threshold for signal flow control

◆ uartHwFlowControlThreshold

uint32 Cdd_Uart_ConfigType::uartHwFlowControlThreshold

Word Length for packets

◆ uartWordLength

uint32 Cdd_Uart_ConfigType::uartWordLength

Parity for data

◆ uartParity

uint32 Cdd_Uart_ConfigType::uartParity

Read return mode

◆ uartReadReturnMode

uint32 Cdd_Uart_ConfigType::uartReadReturnMode

Mode of Operation

◆ uartOperatingMode

uint32 Cdd_Uart_ConfigType::uartOperatingMode

Amount of stop bits per packet

◆ uartStopBits

uint32 Cdd_Uart_ConfigType::uartStopBits

UART transfer type mode

◆ uartTransferType

uint32 Cdd_Uart_ConfigType::uartTransferType

Callback Handles

◆ uartNotificationHandlers

Cdd_Uart_NotifCallbacksType Cdd_Uart_ConfigType::uartNotificationHandlers

◆ netChannels

uint8 Cdd_Uart_CfgType::netChannels

◆ channelCfg

Cdd_Uart_ConfigType Cdd_Uart_CfgType::channelCfg[CDD_UART_NUM_CHANNELS]

◆ CddUartDriver_0

const Cdd_Uart_CfgType CddUartDriver_0

extern

CDD Uart Configuration struct declaration.