UARTSupportMSPM0.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, 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.
 */
/*!****************************************************************************
 *  @file       UARTSupportMSPM0.h
 *
 *  @brief      UART driver support APIs for the MSPM0 devices.
 *
 *  @defgroup   UARTSupportMSPM0 UART driver supporting APIs
 *
 *  # Overview
 *  Refer to @ref ti_drivers_UART_Overview for a complete description of APIs and examples
 *  of use.
 *
 ******************************************************************************
 */
/* clang-format off */
#ifndef ti_drivers_uart_UARTSupportMSPM0__include
#define ti_drivers_uart_UARTSupportMSPM0__include

#include <ti/drivers/dpl/ClockP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

#include <ti/drivers/dma/DMAMSPM0.h>
#include <ti/drivers/utils/RingBuf.h>
#include <ti/drivers/UART.h>

typedef struct {
    bool (*enable)(UART_Handle handle, UART_Params *params);

    void (*disable)(UART_Handle handle);

    void (*txChar)(UART_Handle handle);

    int_fast16_t (*read)(
        UART_Handle, void *buf, size_t size, size_t *bytesRead);

    int_fast16_t (*write)(
        UART_Handle, const void *buf, size_t size, size_t *bytesWritten);
} UARTSupport_Fxns;

typedef struct {
    const UARTSupport_Fxns *supportFxns; 
    void *userArg;                  
    uint8_t buffersSupported : 1;   
    uint8_t eventsSupported : 1;    
    uint8_t callbacksSupported : 1; 
    uint8_t dmaSupported : 1;       
    uint8_t returnMode : 1;         
    uint8_t inUse : 1;              
    uint8_t readCancel : 1;         
    uint8_t writeCancel : 1;        
    uint8_t overrunActive : 1;      
    uint8_t readTimedOut : 1;       
    uint8_t writeTimedOut : 1;      
    uint8_t readMode : 2;           
    uint8_t writeMode : 2;          
    uint8_t rxDmaChannel;           
    uint8_t txDmaChannel;           
    uint8_t readInUse : 1;          
    uint8_t writeInUse : 1;         
    uint32_t overrunCount;          
#ifndef UART_NO_DMA
    uint8_t noOfDMAChannels;        
    DMAMSPM0_Handle DMA_Handle;     
#endif
} UART_Object;


typedef struct {
    uint8_t *rxBufPtr;          
    uint8_t *txBufPtr;          
    uint16_t rxBufSize;         
    uint16_t txBufSize;         
    RingBuf_Object rxBuf;       
    RingBuf_Object txBuf;       
    SemaphoreP_Handle rxSem;    
    SemaphoreP_Handle txSem;    
} UART_Buffers_Object;

typedef struct {
    UART_EventCallback eventCallback; 
    uint32_t eventMask; 
} UART_EventCallback_Object;

typedef struct {
    UART_Callback readCallback;  
    UART_Callback writeCallback; 
    uint8_t *readBuf;            
    const uint8_t *writeBuf;     
    uint16_t readSize;           
    uint16_t writeSize;          
    uint16_t writeCount;         
    uint16_t readCount;          
    uint16_t bytesRead;          
    uint16_t bytesWritten;       
    int32_t rxStatus;            
    int32_t txStatus;            
    size_t rxSize;               
    size_t txSize;               
    void *userArg;               
} UART_Callback_Object;

/* Warning! The sequence in the below structure must NOT be modified. */
typedef struct
{
    UART_Object object;                
    UART_Buffers_Object buffersObject; 
    UART_EventCallback_Object eventCallbackObject; 
    UART_Callback_Object callbackObject; 
}UART_Data_Object;

typedef struct UART_Config_
{
    void *object;

    void const *hwAttrs;
} UART_Config;

extern  const UART_Config UART_config[];
extern const uint_least8_t UART_count;



int_fast16_t UART_readBuffered(UART_Handle handle, void *buf, size_t size, size_t *bytesRead);

int_fast16_t UART_writeBuffered(UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten);

int_fast16_t UART_readCallback(UART_Handle handle, void *buf, size_t size, size_t *bytesRead);

int_fast16_t UART_writeCallback(UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten);

int_fast16_t UART_readFullFeatured(UART_Handle handle, void *buf, size_t size, size_t *bytesRead);

int_fast16_t UART_writeFullFeatured(UART_Handle handle, const void *buf, size_t size, size_t *bytesWritten);


#endif /* ti_drivers_uart_UARTSupportMSPM0__include */
/* clang-format on */