DisplayUart2.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_display_DisplayUart2__include
#define ti_display_DisplayUart2__include

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

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

extern const Display_FxnTable DisplayUart2Min_fxnTable;
extern const Display_FxnTable DisplayUart2Ansi_fxnTable;

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


typedef struct {
    UART2_Handle       hUart;
    SemaphoreP_Handle  mutex;
    char              *lineClearSeq;
} DisplayUart2_Object, *DisplayUart2_Handle;


void DisplayUart2Min_init(Display_Handle handle);
void DisplayUart2Ansi_init(Display_Handle handle);

Display_Handle DisplayUart2Min_open(Display_Handle, Display_Params * params);
Display_Handle DisplayUart2Ansi_open(Display_Handle, Display_Params * params);

void DisplayUart2Min_clear(Display_Handle handle);
void DisplayUart2Ansi_clear(Display_Handle handle);

void DisplayUart2Min_clearLines(Display_Handle handle,
                                uint8_t fromLine,
                                uint8_t toLine);
void DisplayUart2Ansi_clearLines(Display_Handle handle,
                                 uint8_t fromLine,
                                 uint8_t toLine);

void DisplayUart2Min_vprintf(Display_Handle handle, uint8_t line,
                             uint8_t column, const char *fmt, va_list va);
void DisplayUart2Ansi_vprintf(Display_Handle handle, uint8_t line,
                              uint8_t column, const char *fmt, va_list va);

void DisplayUart2Min_close(Display_Handle);
void DisplayUart2Ansi_close(Display_Handle);

int DisplayUart2Min_control(Display_Handle handle, unsigned int cmd, void *arg);
int DisplayUart2Ansi_control(Display_Handle handle, unsigned int cmd, void *arg);

unsigned int   DisplayUart2Min_getType(void);
unsigned int   DisplayUart2Ansi_getType(void);

#endif /* ti_display_DisplayUart2__include */