UART2LPF3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2025, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_uart2_UART2LPF3__include
#define ti_drivers_uart2_UART2LPF3__include

#include <stddef.h>
#include <stdint.h>

#include <stdint.h>
#include <stdbool.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(inc/hw_types.h)
#include DeviceFamily_constructPath(driverlib/udma.h)

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/UART2.h>

#ifdef __cplusplus
extern "C" {
#endif

#define UART2LPF3_FIFO_SIZE 8

typedef enum
{
    UART2LPF3_CODING_UART   = 0, 
    UART2LPF3_CODING_SIR    = 1, 
    UART2LPF3_CODING_SIR_LP = 2, 
} UART2LPF3_CodingScheme;

typedef struct
{
    UART2_BASE_HWATTRS
    volatile uDMAControlTableEntry *dmaTxTableEntryPri; 
    volatile uDMAControlTableEntry *dmaRxTableEntryPri; 
    uint32_t txChannelMask;                             
    uint32_t rxChannelMask;                             
    int32_t txPinMux;                                   
    int32_t rxPinMux;                                   
    int32_t ctsPinMux;                                  
    int32_t rtsPinMux;                                  
    PowerLPF3_Resource powerID;                         
    UART2LPF3_CodingScheme codingScheme;                
    uint8_t irLPClkDivider;                             
    uint8_t txChannelEvtMux;        
    uint8_t rxChannelEvtMux;        
    bool concatenateFIFO;           
    uint32_t txChannelSubscriberId; 
    uint32_t rxChannelSubscriberId; 
} UART2LPF3_HWAttrs;

typedef struct
{
    UART2_BASE_OBJECT
    Power_NotifyObj preNotify;  
    Power_NotifyObj postNotify; 
} UART2LPF3_Object, *UART2LPF3_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart2_UART2LPF3__include */