DisplayUart.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2019, 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_display_DisplayUart__include
#define ti_display_DisplayUart__include

#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/UART.h>
#include <ti/display/Display.h>
#include <stdint.h>

/* Ensure backwards compatibility. Old examples will use Minimal. */
#ifndef DisplayUart_fxnTable
#  define DisplayUart_fxnTable     DisplayUartMin_fxnTable
#endif

/* Line number that means 'put in scrolling section', if exists */
#define DisplayUart_SCROLLING       0xFF

extern const Display_FxnTable DisplayUartMin_fxnTable;
extern const Display_FxnTable DisplayUartAnsi_fxnTable;

typedef struct DisplayUart_HWAttrs
{
    unsigned int uartIdx;
    unsigned int baudRate;
    unsigned int mutexTimeout;
    char        *strBuf;
    uint16_t     strBufLen;
} DisplayUart_HWAttrs;


typedef struct DisplayUart_Object
{
    UART_Handle       hUart;
    SemaphoreP_Handle mutex;
    char              *lineClearSeq;
} DisplayUart_Object, *DisplayUart_Handle;


void DisplayUartMin_init(Display_Handle handle);
void DisplayUartAnsi_init(Display_Handle handle);

Display_Handle DisplayUartMin_open(Display_Handle, Display_Params * params);
Display_Handle DisplayUartAnsi_open(Display_Handle, Display_Params * params);

void DisplayUartMin_clear(Display_Handle handle);
void DisplayUartAnsi_clear(Display_Handle handle);

void DisplayUartMin_clearLines(Display_Handle handle,
                               uint8_t fromLine,
                               uint8_t toLine);
void DisplayUartAnsi_clearLines(Display_Handle handle,
                                uint8_t fromLine,
                                uint8_t toLine);

void DisplayUartMin_vprintf(Display_Handle handle, uint8_t line,
                            uint8_t column, char *fmt, va_list va);
void DisplayUartAnsi_vprintf(Display_Handle handle, uint8_t line,
                             uint8_t column, char *fmt, va_list va);

void DisplayUartMin_close(Display_Handle);
void DisplayUartAnsi_close(Display_Handle);

int DisplayUartMin_control(Display_Handle handle, unsigned int cmd, void *arg);
int DisplayUartAnsi_control(Display_Handle handle, unsigned int cmd, void *arg);

unsigned int   DisplayUartMin_getType(void);
unsigned int   DisplayUartAnsi_getType(void);

#endif /* ti_display_DisplayUart__include */