UARTUSCIA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 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_uart_UARTUSCIA__include
#define ti_drivers_uart_UARTUSCIA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/UART.h>

#include <ti/sysbios/knl/Semaphore.h>

/* Add UARTUSCIA_STATUS_* macros here */

/* Add UARTUSCIA_CMD_* macros here */

/* UARTUSCIA function table pointer */
extern const UART_FxnTable UARTUSCIA_fxnTable;

typedef struct UARTUSCIA_BaudrateConfig {
    uint32_t  outputBaudrate; 
    uint32_t  inputClockFreq; 
    uint8_t   prescalar;      
    uint8_t   hwRegUCBRFx;    
    uint8_t   hwRegUCBRSx;    
    uint8_t   oversampling;   
} UARTUSCIA_BaudrateConfig;

typedef struct UARTUSCIA_HWAttrs {
    unsigned int baseAddr;
    uint8_t    clockSource;
    uint32_t   bitOrder;
    unsigned int numBaudrateEntries;
    UARTUSCIA_BaudrateConfig const *baudrateLUT;
} UARTUSCIA_HWAttrs;

typedef struct UARTUSCIA_Object {
    /* UARTUSCIA control variables */
    bool                 isOpen;           /* Status for open */
    UART_Mode            readMode;         /* Mode for all read calls */
    UART_Mode            writeMode;        /* Mode for all write calls */
    unsigned int         readTimeout;      /* Timeout for read semaphore */
    unsigned int         writeTimeout;     /* Timeout for write semaphore */
    UART_Callback        readCallback;     /* Pointer to read callback */
    UART_Callback        writeCallback;    /* Pointer to write callback */
    UART_ReturnMode      readReturnMode;   /* Receive return mode */
    UART_DataMode        readDataMode;     /* Type of data being read */
    UART_DataMode        writeDataMode;    /* Type of data being written */
    UART_Echo            readEcho;         /* Echo received data back */

    /* UARTUSCIA write variables */
    const void          *writeBuf;         /* Buffer data pointer */
    size_t               writeCount;       /* Number of Chars sent */
    size_t               writeSize;        /* Chars remaining in buffer */
    bool                 writeCR;          /* Write a return character */

    /* UARTUSCIA receive variables */
    void                *readBuf;          /* Buffer data pointer */
    size_t               readCount;        /* Number of Chars read */
    size_t               readSize;         /* Chars remaining in buffer */

    /* UARTUSCIA SYS/BIOS objects */
    Semaphore_Struct     writeSem;         /* UARTUSCIA write semaphore*/
    Semaphore_Struct     readSem;          /* UARTUSCIA read semaphore */
} UARTUSCIA_Object, *UARTUSCIA_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart_UARTUSCIA__include */