Cdd_Uart_Cfg.h

Go to the documentation of this file.

/* ======================================================================
 *   Copyright (C) 2024 Texas Instruments Incorporated
 *
 *   All rights reserved. Property of Texas Instruments Incorporated.
 *   Restricted rights to use, duplicate or disclose this code are
 *   granted through contract.
 *
 *   The program may not be used without the written permission
 *   of Texas Instruments Incorporated or against the terms and conditions
 *   stipulated in the agreement under which this program has been
 *   supplied.
 * ==================================================================== */
 
  /*********************************************************************************************************************
    Project: AM62DX
    Date   : 2024-08-20 13:07:57
 
    This file is generated by EB Tresos
    Do not modify this file, otherwise the software may behave in unexpected way.
 
 *********************************************************************************************************************/
 
#ifndef CDD_UART_CFG_H_
#define CDD_UART_CFG_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include "Std_Types.h"
#include "Os.h"
#include "Dem.h"
#include "Det.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CDD_UART_MAJOR_VERSION                     (10U)
#define CDD_UART_MINOR_VERSION                     (0U)
#define CDD_UART_CFG_PATCH_VERSION                 (0U)
/* @} */
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define CDD_UART_CFG_ID                            (0x1U)
 
#define CDD_UART_DEV_ERROR_DETECT                  STD_ON
 
#define CDD_UART_ISR_TYPE                          CDD_UART_ISR_VOID
 
#define CDD_UART_CHANNEL_ID_0                      (0)
 
/*
 * Design: MCAL-22580,MCAL-22581,MCAL-22582
 */
#define CDD_UART_MODE_POLLING                      (0U)
#define CDD_UART_MODE_INTERRUPT                    (1U)
 
/*
 * Design: MCAL-22574
 */
#define CDD_UART_WORD_LENGTH_5                     (0U)
#define CDD_UART_WORD_LENGTH_6                     (1U)
#define CDD_UART_WORD_LENGTH_7                     (2U)
#define CDD_UART_WORD_LENGTH_8                     (3U)
 
/*
 * Design: MCAL-22575,MCAL-22576,MCAL-22577
 */
#define CDD_UART_PARITY_NONE                       (0U)
#define CDD_UART_PARITY_ODD                        (1U)
#define CDD_UART_PARITY_EVEN                       (3U)
/* @} */
#define CDD_UART_TRIGGER_LEVEL_1                   (1U)
#define CDD_UART_TRIGGER_LEVEL_8                   (8U)
#define CDD_UART_TRIGGER_LEVEL_16                  (16U)
#define CDD_UART_TRIGGER_LEVEL_32                  (32U)
#define CDD_UART_TRIGGER_LEVEL_56                  (56U)
#define CDD_UART_TRIGGER_LEVEL_60                  (60U)
/* @} */
#define CDD_UART_13x_OPER                          (3U)
#define CDD_UART_16x_OPER                          (0U)
#define CDD_UART_16x_AUTO_OPER                     (2U)
/* @} */
#define CDD_UART_FULL_READ_RETURN                  (0U)
#define CDD_UART_PARTIAL_READ_RETURN               (1U)
/* @} */
/*
 * Design: MCAL-22578,MCAL-22579
 */
#define CDD_UART_STOP_BIT_1                        (0U)
#define CDD_UART_STOP_BITS_2                       (1U)
/* @} */
#define CDD_UART_VERSION_INFO_API                  STD_ON
#define CDD_UART_REGISTER_READBACK_API             STD_ON
#define CDD_UART_DEINIT_API                        STD_ON
#define CDD_UART_WRITE_API                         STD_ON
#define CDD_UART_READ_API                          STD_ON
#define CDD_UART_CANCEL_API                        STD_ON
#define CDD_UART_GETREMAININGWORDS_API             STD_ON
/* @} */
 
#define CDD_UART_NUM_CHANNELS                      1U
 
#define CDD_UART_OS_COUNTER_ID                     ((CounterType)OsCounter_0)
 
#define CddUartConf_CddUartChannelConfiguration_CddUartChannel_0 (0U)
 
#define CDD_UART_PRE_COMPILE_VARIANT               STD_ON
#define CDD_UART_INIT_CONFIG_PC                    CddUartDriver_0
 
#define CDD_UART_MAXIMUM_CHANNELS                  1U
 
/* UART maximum channels check to ensure it is within bounds */
#if ((CDD_UART_NUM_CHANNELS < 1U) || (CDD_UART_NUM_CHANNELS > CDD_UART_MAXIMUM_CHANNELS))
    #error "CDD UART: Unsupported maximum channels in use"
#endif
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum
{
    CDD_UART_UNINIT =       0U,
    CDD_UART_INIT =         1U,
} Cdd_Uart_StatusType;
 
typedef struct
{
    void (*uartNotificationReadHandler)(void);
    void (*uartNotificationWriteHandler)(void);
    void (*uartNotificationErrorHandler)(void);
} Cdd_Uart_NotifCallbacksType;
 
typedef struct
{
    uint32 uartHwUnitID;
    uint32 uartClockFrequency;
    uint32 uartBaudRate;
    uint32 uartIOMode;
    uint32 uartTXTriggerLevel;
    uint32 uartRXTriggerLevel;
    uint32 uartHwFlowControlThreshold;
    uint32 uartWordLength;
    uint32 uartParity;
    uint32 uartReadReturnMode;
    uint32 uartOperatingMode;
    uint32 uartStopBits;
    Cdd_Uart_NotifCallbacksType uartNotificationHandlers;
} Cdd_Uart_ConfigType;
 
typedef struct
{
    /* Count of channels configured */
    uint8 netChannels;
    /* Channel Configurations */
    Cdd_Uart_ConfigType channelCfg[CDD_UART_NUM_CHANNELS];
} Cdd_Uart_CfgType;
 
extern CONST(Cdd_Uart_CfgType, CDD_UART_CONFIG_DATA) CddUartDriver_0;
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef CDD_UART_CFG_H_ */
 
/* @} */