MCUSW
Loading...
Searching...
No Matches
Cdd_Uart.h
Go to the documentation of this file.
1/* ======================================================================
2 * Copyright (C) 2024 Texas Instruments Incorporated
3 *
4 * All rights reserved. Property of Texas Instruments Incorporated.
5 * Restricted rights to use, duplicate or disclose this code are
6 * granted through contract.
7 *
8 * The program may not be used without the written permission
9 * of Texas Instruments Incorporated or against the terms and conditions
10 * stipulated in the agreement under which this program has been
11 * supplied.
12 * ==================================================================== */
13
32/* ------------------------------------------------------------------------------------------------------------------
33 * FILE DESCRIPTION
34 * ------------------------------------------------------------------------------------------------------------------
35 * File: Cdd_Uart.h
36 * Project: Complex Device Driver
37 * Module: CddUartDriver
38 *
39 * Description: This module implements a driver in ANSI C programming language to centralize the
40 * configuration of ports and pins which are used by more than one driver module.
41 * With this driver you can:
42 * - Configure the UART config registers
43 * - Initialize the UART configuration
44 * - Read and write data over the UART
45 **************************************************************************************************/
46
47#ifndef CDD_UART_H_
48#define CDD_UART_H_
49
50/* ========================================================================== */
51/* Include Files */
52/* ========================================================================== */
53
54#include "Std_Types.h"
55#include "lldr.h"
56#include "hw_types.h"
57#include "Std_Types.h"
58#include "Cdd_Uart_Cfg.h"
59#include <Uart.h>
60#include "Cdd_Uart_Priv.h"
61#include "SchM_Cdd_Uart.h"
62
63#ifdef __cplusplus
64extern "C"
65{
66#endif
67
68/* ========================================================================== */
69/* Macros & Typedefs */
70/* ========================================================================== */
71
73#define UART_FIFO_SIZE (64U)
74
80#define UART_TRANSMITEMPTY_TRIALCOUNT (3000U)
81
86/*
87 * Design: MCAL-22636
88 */
94#define CDD_UART_MODULE_ID 255U
96#define CDD_UART_VENDOR_ID 44U
98#define CDD_UART_INSTANCE_ID 0U
99/* @} */
100
108#define CDD_UART_SW_MAJOR_VERSION CDD_UART_MAJOR_VERSION
110#define CDD_UART_SW_MINOR_VERSION CDD_UART_MINOR_VERSION
112#define CDD_UART_SW_PATCH_VERSION CDD_UART_CFG_PATCH_VERSION
113/* @} */
121#define CDD_UART_AR_RELEASE_MAJOR_VERSION 4U
123#define CDD_UART_AR_RELEASE_MINOR_VERSION 3U
125#define CDD_UART_AR_RELEASE_REVISION_VERSION 1U
126/* @} */
127
132/*
133 * Design: MCAL-22583,MCAL-22584,MCAL-22585,MCAL-22586,MCAL-22587,MCAL-22588,MCAL-22589,MCAL-22636,MCAL-22671
134 */
136#define CDD_UART_INIT_SERVICE_ID 0x01U
138#define CDD_UART_GETVERSIONINFO_SERVICE_ID 0x02U
140#define CDD_UART_REGISTERREADBACK_SERVICE_ID 0x0DU
142#define CDD_UART_READDATA_SERVICE_ID 0x03U
144#define CDD_UART_WRITEDATA_SERVICE_ID 0x04U
146#define CDD_UART_ERROR_SERVICE_ID 0x05U
148#define CDD_UART_CANCEL_SERVICE_ID 0x06U
150#define CDD_UART_GETREMAININGWORDS_SERVICE_ID 0x07U
152#define CDD_UART_READNOTIF_SERVICE_ID 0x08U
154#define CDD_UART_WRITENOTIF_SERVICE_ID 0x09U
156#define CDD_UART_ERRORNOTIF_SERVICE_ID 0x0AU
158#define CDD_UART_DEINIT_SERVICE_ID 0x0BU
160#define CDD_UART_INTERNAL_ISR_ID 0x0CU
161/* @} */
162
167/*
168 * Design: MCAL-22572
169 */
171#define CDD_UART_E_UNINIT 0x01U
172
174#define CDD_UART_E_INVALID_EVENT 0x02U
175
177#define CDD_UART_E_READ_LOCKED 0x03U
178
180#define CDD_UART_E_WRITE_LOCKED 0x04U
181
183#define CDD_UART_E_PARAM_POINTER 0x05U
184
186#define CDD_UART_E_ALREADY_INITIALIZED 0x06U
187
189#define CDD_UART_E_PARAM_VALUE 0x07U
190
192#define CDD_UART_E_PARAM_LENGTH 0x08U
193
195#define CDD_UART_E_INVALID_CHANNEL 0x09U
196
198#define CDD_UART_E_INVALID_CONFIG 0x0AU
199/* @} */
209#define UART_TX_FIFO_NOT_FULL ( \
210 UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_0)
211#define UART_TX_FIFO_FULL ( \
212 UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_1)
223#define UART_INTID_MODEM_STAT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_0 \
224 << \
225 UART_IIR_IT_TYPE_SHIFT)
226#define UART_INTID_TX_THRES_REACH (UART_IIR_IT_TYPE_IT_TYPE_VALUE_1 \
227 << \
228 UART_IIR_IT_TYPE_SHIFT)
229#define UART_INTID_RX_THRES_REACH (UART_IIR_IT_TYPE_IT_TYPE_VALUE_2 \
230 << \
231 UART_IIR_IT_TYPE_SHIFT)
232#define UART_INTID_RX_LINE_STAT_ERROR (UART_IIR_IT_TYPE_IT_TYPE_VALUE_3 \
233 << \
234 UART_IIR_IT_TYPE_SHIFT)
235#define UART_INTID_CHAR_TIMEOUT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_6 \
236 << \
237 UART_IIR_IT_TYPE_SHIFT)
238#define UART_INTID_XOFF_SPEC_CHAR_DETECT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_8 \
239 << \
240 UART_IIR_IT_TYPE_SHIFT)
241#define UART_INTID_MODEM_SIG_STATE_CHANGE (UART_IIR_IT_TYPE_IT_TYPE_VALUE_10 \
242 << \
243 UART_IIR_IT_TYPE_SHIFT)
244
246#define UART_INTR_PENDING (0U)
247#define UART_NO_INTR_PENDING (1U)
257#define UART_INTR_CTS (UART_IER_CTS_IT_MASK)
258#define UART_INTR_RTS (UART_IER_RTS_IT_MASK)
259#define UART_INTR_XOFF (UART_IER_XOFF_IT_MASK)
260#define UART_INTR_SLEEPMODE (UART_IER_SLEEP_MODE_MASK)
261#define UART_INTR_MODEM_STAT (UART_IER_MODEM_STS_IT_MASK)
262#define UART_INTR_LINE_STAT (UART_IER_LINE_STS_IT_MASK)
263#define UART_INTR_THR (UART_IER_THR_IT_MASK)
264#define UART_INTR_RHR_CTI (UART_IER_RHR_IT_MASK)
265
266#define UART_INTR2_RX_EMPTY (UART_IER2_EN_RXFIFO_EMPTY_MASK)
267#define UART_INTR2_TX_EMPTY (UART_IER2_EN_TXFIFO_EMPTY_MASK)
277#define UART_FIFO_PE_FE_BI_DETECTED (UART_LSR_RX_FIFO_STS_MASK)
278#define UART_BREAK_DETECTED_ERROR (UART_LSR_RX_BI_MASK)
279#define UART_FRAMING_ERROR (UART_LSR_RX_FE_MASK)
280#define UART_PARITY_ERROR (UART_LSR_RX_PE_MASK)
281#define UART_OVERRUN_ERROR (UART_LSR_RX_OE_MASK)
284#define UART_STATE_RX_DISABLED (0x0U)
285#define UART_STATE_RX_ENABLED (0x1U)
286
288#define IS_DATA_LENGTH_VALID(dataLength) ((dataLength == CDD_UART_WORD_LENGTH_5) || \
289 (dataLength == CDD_UART_WORD_LENGTH_6) || \
290 (dataLength == CDD_UART_WORD_LENGTH_7) || \
291 (dataLength == CDD_UART_WORD_LENGTH_8))
292
294#define IS_STOP_BITS_VALID(stopBits) ((stopBits == CDD_UART_STOP_BIT_1) || \
295 (stopBits == CDD_UART_STOP_BITS_2))
296
298#define IS_PARITY_TYPE_VALID(parityType) ((parityType == CDD_UART_PARITY_NONE) || \
299 (parityType == CDD_UART_PARITY_ODD) || \
300 (parityType == CDD_UART_PARITY_EVEN))
301
303#define IS_OPER_MODE_VALID(operMode) ((operMode == CDD_UART_16x_OPER) || \
304 (operMode == CDD_UART_16x_AUTO_OPER) || \
305 (operMode == CDD_UART_13x_OPER))
306
308#define IS_RXTRIG_LVL_VALID(rxTrigLvl) ((rxTrigLvl == CDD_UART_TRIGGER_LEVEL_1) || \
309 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_8) || \
310 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_16) || \
311 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_56) || \
312 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_60))
313
315#define IS_TXTRIG_LVL_VALID(txTrigLvl) ((txTrigLvl == CDD_UART_TRIGGER_LEVEL_1) || \
316 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_8) || \
317 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_16) || \
318 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_32) || \
319 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_56))
320
324#define MCAL_STATE_RESET (0U)
325#define MCAL_STATE_READY (1U)
326#define MCAL_STATE_BUSY (2U)
327#define MCAL_STATE_ERROR (3U)
328/* @} */
330typedef uint8 CddUartDataBufferType;
331
333typedef uint8_least CddUartDataDirectionType;
334
335/* ================================================================ */
336/* Structures and Enums */
337/* ================================================================ */
338
341/* ========================================================================== */
342/* Function Declarations */
343/* ========================================================================== */
344
345/*
346 * Design: MCAL-22636
347 */
364#if (STD_ON == CDD_UART_VERSION_INFO_API)
365FUNC(void, CDD_UART_APPL_DATA) Cdd_Uart_GetVersionInfo(
366 P2VAR(Std_VersionInfoType, AUTOMATIC, CDD_UART_APPL_DATA) VersionInfoPtr);
367#endif
368
369/*
370 * Design: MCAL-22671
371 */
388#if (STD_ON == CDD_UART_REGISTER_READBACK_API)
389FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_RegisterReadback(uint8 ChannelID, P2VAR(CddUart_RegisterReadbackType, AUTOMATIC, CDD_UART_CFG) RegisterSetPtr);
390#endif
391
392/*
393 * Design: MCAL-22584
394 */
411FUNC(void, CDD_UART_CODE) Cdd_Uart_Init(P2CONST(Cdd_Uart_CfgType, AUTOMATIC, CDD_UART_CFG) ConfigurationPtr);
412
413/*
414 * Design: MCAL-22585
415 */
432#if (STD_ON == CDD_UART_DEINIT_API)
433FUNC(void, CDD_UART_CODE) Cdd_Uart_DeInit(void);
434#endif
435
436/*
437 * Design: MCAL-22587
438 */
462#if (STD_ON == CDD_UART_WRITE_API)
463FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_Write(uint8 ChannelID,
464 P2VAR(CddUartDataBufferType, AUTOMATIC, CDD_UART_APPL_DATA) SrcBufferPtr, uint32 Count, uint32 Timeout);
465#endif
466
467/*
468 * Design: MCAL-22586
469 */
492#if (STD_ON == CDD_UART_READ_API)
493FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_Read(uint8 ChannelID,
494 P2VAR(CddUartDataBufferType, AUTOMATIC, CDD_UART_APPL_DATA) DestBufferPtr, uint32 Count, uint32 Timeout);
495#endif
496
497/*
498 * Design: MCAL-22589
499 */
519#if (STD_ON == CDD_UART_CANCEL_API)
520FUNC(boolean, CDD_UART_CODE) Cdd_Uart_Cancel(uint8 ChannelID, CddUartDataDirectionType TransferType);
521#endif
522
523/*
524 * Design: MCAL-22588
525 */
545#if (STD_ON == CDD_UART_GETREMAININGWORDS_API)
546FUNC(uint32, CDD_UART_CODE) Cdd_Uart_GetRemainingWords(uint8 ChannelID, CddUartDataDirectionType TransferType);
547#endif
548
549
550#ifdef __cplusplus
551}
552#endif
553
554#endif /* #ifndef CDD_UART_H_ */
555
556
557/* @} */
Cdd_Uart_Cfg.h
This file contains generated configuration file for UART Complex Device Driver.
Cdd_Uart_Cancel
boolean Cdd_Uart_Cancel(uint8 ChannelID, CddUartDataDirectionType TransferType)
Service to cancel an ongoing transaction with UART.
Cdd_Uart_Init
void Cdd_Uart_Init(const Cdd_Uart_CfgType *ConfigurationPtr)
Service for CDD UART Initialization.
CddUartDataBufferType
uint8 CddUartDataBufferType
Typedef for the data buffer elements.
Definition Cdd_Uart.h:330
Cdd_Uart_Read
Std_ReturnType Cdd_Uart_Read(uint8 ChannelID, CddUartDataBufferType *DestBufferPtr, uint32 Count, uint32 Timeout)
Service to read message or command from the UART.
CddUartDataDirectionType
uint8_least CddUartDataDirectionType
Type for defining the direction of data transfer, i.e., sending or receival.
Definition Cdd_Uart.h:333
Cdd_Uart_GetRemainingWords
uint32 Cdd_Uart_GetRemainingWords(uint8 ChannelID, CddUartDataDirectionType TransferType)
Service to get remaining words to be transmitted from the UART for any ongoing transaction.
Cdd_Uart_GetVersionInfo
void Cdd_Uart_GetVersionInfo(Std_VersionInfoType *VersionInfoPtr)
Service for getting CDD UART version.
Cdd_Uart_RegisterReadback
Std_ReturnType Cdd_Uart_RegisterReadback(uint8 ChannelID, CddUart_RegisterReadbackType *RegisterSetPtr)
Service for reading HW IP registers of a CDD UART instance.
Cdd_Uart_DeInit
void Cdd_Uart_DeInit(void)
Service for deinitializing CDD UART.
Cdd_Uart_Write
Std_ReturnType Cdd_Uart_Write(uint8 ChannelID, CddUartDataBufferType *SrcBufferPtr, uint32 Count, uint32 Timeout)
Service to transmit message using UART.
Cdd_Uart_CfgType
Definition Cdd_Uart_Cfg.h:302