UART2CC26X2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2020, 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_UART2CC26X2__include
#define ti_drivers_uart2_UART2CC26X2__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>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/dma/UDMACC26XX.h>

#ifdef __cplusplus
extern "C" {
#endif

#define UART2CC26X2_FIFO_SIZE 32

typedef enum {
    UART2CC26X2_FIFO_THRESHOLD_1_8 = 0,     
    UART2CC26X2_FIFO_THRESHOLD_2_8 = 1,     
    UART2CC26X2_FIFO_THRESHOLD_4_8 = 2,     
    UART2CC26X2_FIFO_THRESHOLD_6_8 = 3,     
    UART2CC26X2_FIFO_THRESHOLD_7_8 = 4      
} UART2CC26X2_FifoThreshold;

typedef struct {
    UART2_BASE_HWATTRS
    
    uint32_t        rxChannelMask;
    uint32_t        txChannelMask;
    UART2CC26X2_FifoThreshold txIntFifoThr;
    UART2CC26X2_FifoThreshold rxIntFifoThr;
} UART2CC26X2_HWAttrs;

typedef struct {
    UART2_BASE_OBJECT

    UDMACC26XX_Handle    udmaHandle; /* For setting power dependency */

    volatile tDMAControlTable    *rxDmaEntry;
    volatile tDMAControlTable    *txDmaEntry;
    
    /* PIN driver state object and handle */
    PIN_State            pinState;
    PIN_Handle           hPin;

    /* For Power management */
    Power_NotifyObj      postNotify;
} UART2CC26X2_Object, *UART2CC26X2_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart2_UART2CC26X2__include */