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 "tistdtypes.h"
55#include "hw_types.h"
56#include "Std_Types.h"
57#include "Cdd_Uart_Cfg.h"
58#include <Uart.h>
59#include "Cdd_Uart_Priv.h"
60#include "SchM_Cdd_Uart.h"
61
62#ifdef __cplusplus
63extern "C"
64{
65#endif
66
67/* ========================================================================== */
68/* Macros & Typedefs */
69/* ========================================================================== */
70
72#define UART_FIFO_SIZE (64U)
73
79#define UART_TRANSMITEMPTY_TRIALCOUNT (3000U)
80
85/*
86 * Design: MCAL-22636
87 */
93#define CDD_UART_MODULE_ID 255U
95#define CDD_UART_VENDOR_ID 44U
97#define CDD_UART_INSTANCE_ID 0U
98/* @} */
99
107#define CDD_UART_SW_MAJOR_VERSION CDD_UART_MAJOR_VERSION
109#define CDD_UART_SW_MINOR_VERSION CDD_UART_MINOR_VERSION
111#define CDD_UART_SW_PATCH_VERSION CDD_UART_CFG_PATCH_VERSION
112/* @} */
120#define CDD_UART_AR_RELEASE_MAJOR_VERSION 4U
122#define CDD_UART_AR_RELEASE_MINOR_VERSION 3U
124#define CDD_UART_AR_RELEASE_REVISION_VERSION 1U
125/* @} */
126
131/*
132 * Design: MCAL-22583,MCAL-22584,MCAL-22585,MCAL-22586,MCAL-22587,MCAL-22588,MCAL-22589,MCAL-22636,MCAL-22671
133 */
135#define CDD_UART_INIT_SERVICE_ID 0x01U
137#define CDD_UART_GETVERSIONINFO_SERVICE_ID 0x02U
139#define CDD_UART_REGISTERREADBACK_SERVICE_ID 0x0DU
141#define CDD_UART_READDATA_SERVICE_ID 0x03U
143#define CDD_UART_WRITEDATA_SERVICE_ID 0x04U
145#define CDD_UART_ERROR_SERVICE_ID 0x05U
147#define CDD_UART_CANCEL_SERVICE_ID 0x06U
149#define CDD_UART_GETREMAININGWORDS_SERVICE_ID 0x07U
151#define CDD_UART_READNOTIF_SERVICE_ID 0x08U
153#define CDD_UART_WRITENOTIF_SERVICE_ID 0x09U
155#define CDD_UART_ERRORNOTIF_SERVICE_ID 0x0AU
157#define CDD_UART_DEINIT_SERVICE_ID 0x0BU
159#define CDD_UART_INTERNAL_ISR_ID 0x0CU
160/* @} */
161
166/*
167 * Design: MCAL-22572
168 */
170#define CDD_UART_E_UNINIT 0x01U
171
173#define CDD_UART_E_INVALID_EVENT 0x02U
174
176#define CDD_UART_E_READ_LOCKED 0x03U
177
179#define CDD_UART_E_WRITE_LOCKED 0x04U
180
182#define CDD_UART_E_PARAM_POINTER 0x05U
183
185#define CDD_UART_E_ALREADY_INITIALIZED 0x06U
186
188#define CDD_UART_E_PARAM_VALUE 0x07U
189
191#define CDD_UART_E_PARAM_LENGTH 0x08U
192
194#define CDD_UART_E_INVALID_CHANNEL 0x09U
195
197#define CDD_UART_E_INVALID_CONFIG 0x0AU
198/* @} */
208#define UART_TX_FIFO_NOT_FULL ( \
209 UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_0)
210#define UART_TX_FIFO_FULL ( \
211 UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_1)
222#define UART_INTID_MODEM_STAT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_0 \
223 << \
224 UART_IIR_IT_TYPE_SHIFT)
225#define UART_INTID_TX_THRES_REACH (UART_IIR_IT_TYPE_IT_TYPE_VALUE_1 \
226 << \
227 UART_IIR_IT_TYPE_SHIFT)
228#define UART_INTID_RX_THRES_REACH (UART_IIR_IT_TYPE_IT_TYPE_VALUE_2 \
229 << \
230 UART_IIR_IT_TYPE_SHIFT)
231#define UART_INTID_RX_LINE_STAT_ERROR (UART_IIR_IT_TYPE_IT_TYPE_VALUE_3 \
232 << \
233 UART_IIR_IT_TYPE_SHIFT)
234#define UART_INTID_CHAR_TIMEOUT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_6 \
235 << \
236 UART_IIR_IT_TYPE_SHIFT)
237#define UART_INTID_XOFF_SPEC_CHAR_DETECT (UART_IIR_IT_TYPE_IT_TYPE_VALUE_8 \
238 << \
239 UART_IIR_IT_TYPE_SHIFT)
240#define UART_INTID_MODEM_SIG_STATE_CHANGE (UART_IIR_IT_TYPE_IT_TYPE_VALUE_10 \
241 << \
242 UART_IIR_IT_TYPE_SHIFT)
243
245#define UART_INTR_PENDING (0U)
246#define UART_NO_INTR_PENDING (1U)
256#define UART_INTR_CTS (UART_IER_CTS_IT_MASK)
257#define UART_INTR_RTS (UART_IER_RTS_IT_MASK)
258#define UART_INTR_XOFF (UART_IER_XOFF_IT_MASK)
259#define UART_INTR_SLEEPMODE (UART_IER_SLEEP_MODE_MASK)
260#define UART_INTR_MODEM_STAT (UART_IER_MODEM_STS_IT_MASK)
261#define UART_INTR_LINE_STAT (UART_IER_LINE_STS_IT_MASK)
262#define UART_INTR_THR (UART_IER_THR_IT_MASK)
263#define UART_INTR_RHR_CTI (UART_IER_RHR_IT_MASK)
264
265#define UART_INTR2_RX_EMPTY (UART_IER2_EN_RXFIFO_EMPTY_MASK)
266#define UART_INTR2_TX_EMPTY (UART_IER2_EN_TXFIFO_EMPTY_MASK)
276#define UART_FIFO_PE_FE_BI_DETECTED (UART_LSR_RX_FIFO_STS_MASK)
277#define UART_BREAK_DETECTED_ERROR (UART_LSR_RX_BI_MASK)
278#define UART_FRAMING_ERROR (UART_LSR_RX_FE_MASK)
279#define UART_PARITY_ERROR (UART_LSR_RX_PE_MASK)
280#define UART_OVERRUN_ERROR (UART_LSR_RX_OE_MASK)
283#define UART_STATE_RX_DISABLED (0x0U)
284#define UART_STATE_RX_ENABLED (0x1U)
285
287#define IS_DATA_LENGTH_VALID(dataLength) ((dataLength == CDD_UART_WORD_LENGTH_5) || \
288 (dataLength == CDD_UART_WORD_LENGTH_6) || \
289 (dataLength == CDD_UART_WORD_LENGTH_7) || \
290 (dataLength == CDD_UART_WORD_LENGTH_8))
291
293#define IS_STOP_BITS_VALID(stopBits) ((stopBits == CDD_UART_STOP_BIT_1) || \
294 (stopBits == CDD_UART_STOP_BITS_2))
295
297#define IS_PARITY_TYPE_VALID(parityType) ((parityType == CDD_UART_PARITY_NONE) || \
298 (parityType == CDD_UART_PARITY_ODD) || \
299 (parityType == CDD_UART_PARITY_EVEN))
300
302#define IS_OPER_MODE_VALID(operMode) ((operMode == CDD_UART_16x_OPER) || \
303 (operMode == CDD_UART_16x_AUTO_OPER) || \
304 (operMode == CDD_UART_13x_OPER))
305
307#define IS_RXTRIG_LVL_VALID(rxTrigLvl) ((rxTrigLvl == CDD_UART_TRIGGER_LEVEL_1) || \
308 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_8) || \
309 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_16) || \
310 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_56) || \
311 (rxTrigLvl == CDD_UART_TRIGGER_LEVEL_60))
312
314#define IS_TXTRIG_LVL_VALID(txTrigLvl) ((txTrigLvl == CDD_UART_TRIGGER_LEVEL_1) || \
315 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_8) || \
316 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_16) || \
317 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_32) || \
318 (txTrigLvl == CDD_UART_TRIGGER_LEVEL_56))
319
323#define MCAL_STATE_RESET (0U)
324#define MCAL_STATE_READY (1U)
325#define MCAL_STATE_BUSY (2U)
326#define MCAL_STATE_ERROR (3U)
327/* @} */
329typedef uint8 CddUartDataBufferType;
330
332typedef uint8_least CddUartDataDirectionType;
333
334/* ================================================================ */
335/* Structures and Enums */
336/* ================================================================ */
337
340/* ========================================================================== */
341/* Function Declarations */
342/* ========================================================================== */
343
344/*
345 * Design: MCAL-22636
346 */
363#if (STD_ON == CDD_UART_VERSION_INFO_API)
364FUNC(void, CDD_UART_APPL_DATA) Cdd_Uart_GetVersionInfo(
365 P2VAR(Std_VersionInfoType, AUTOMATIC, CDD_UART_APPL_DATA) VersionInfoPtr);
366#endif
367
368/*
369 * Design: MCAL-22671
370 */
387#if (STD_ON == CDD_UART_REGISTER_READBACK_API)
388FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_RegisterReadback(uint8 ChannelID, P2VAR(CddUart_RegisterReadbackType, AUTOMATIC, CDD_UART_CFG) RegisterSetPtr);
389#endif
390
391/*
392 * Design: MCAL-22584
393 */
410FUNC(void, CDD_UART_CODE) Cdd_Uart_Init(P2CONST(Cdd_Uart_CfgType, AUTOMATIC, CDD_UART_CFG) ConfigurationPtr);
411
412/*
413 * Design: MCAL-22585
414 */
431#if (STD_ON == CDD_UART_DEINIT_API)
432FUNC(void, CDD_UART_CODE) Cdd_Uart_DeInit(void);
433#endif
434
435/*
436 * Design: MCAL-22587
437 */
461#if (STD_ON == CDD_UART_WRITE_API)
462FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_Write(uint8 ChannelID,
463 P2VAR(CddUartDataBufferType, AUTOMATIC, CDD_UART_APPL_DATA) SrcBufferPtr, uint32 Count, uint32 Timeout);
464#endif
465
466/*
467 * Design: MCAL-22586
468 */
491#if (STD_ON == CDD_UART_READ_API)
492FUNC(Std_ReturnType, CDD_UART_CODE) Cdd_Uart_Read(uint8 ChannelID,
493 P2VAR(CddUartDataBufferType, AUTOMATIC, CDD_UART_APPL_DATA) DestBufferPtr, uint32 Count, uint32 Timeout);
494#endif
495
496/*
497 * Design: MCAL-22589
498 */
518#if (STD_ON == CDD_UART_CANCEL_API)
519FUNC(boolean, CDD_UART_CODE) Cdd_Uart_Cancel(uint8 ChannelID, CddUartDataDirectionType TransferType);
520#endif
521
522/*
523 * Design: MCAL-22588
524 */
544#if (STD_ON == CDD_UART_GETREMAININGWORDS_API)
545FUNC(uint32, CDD_UART_CODE) Cdd_Uart_GetRemainingWords(uint8 ChannelID, CddUartDataDirectionType TransferType);
546#endif
547
548
549#ifdef __cplusplus
550}
551#endif
552
553#endif /* #ifndef CDD_UART_H_ */
554
555
556/* @} */
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:329
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:332
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:288