Display.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, 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_Display__include
#define ti_display_Display__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdarg.h>

/* -----------------------------------------------------------------------------
 *                                          Constants
 * ------------------------------------------------------------------------------
 */
#define Display_Type_ANY      0xFFFFFFFF   
#define Display_Type_INVALID  0x00000000   
#define Display_Type_LCD      0x80000000   
#define Display_Type_UART     0x40000000   
#define Display_Type_LOG      0x20000000   
#define Display_Type_ITM      0x10000000   
#define Display_Type_HOST     0x08000000   
#define Display_Type_ANSI     0x04000000   
#define Display_Type_GRLIB    0x00100000   
#define Display_MAXINDEX    15

#define DISPLAY_CMD_RESERVED            32

#define DISPLAY_STATUS_RESERVED        -32

#define DISPLAY_STATUS_SUCCESS         0

#define DISPLAY_STATUS_ERROR          -1

#define DISPLAY_STATUS_UNDEFINEDCMD   -2

#define DISPLAY_CMD_TRANSPORT_CLOSE  0

#define DISPLAY_CMD_TRANSPORT_OPEN   1

/* -----------------------------------------------------------------------------
 *                                          Macros
 * ------------------------------------------------------------------------------
 */
#define Display_clearLine(handle, n)    Display_clearLines(handle, n, 0)
#define Display_isIndex(i)              (i <= Display_MAXINDEX)
#define Display_isMetaType(i)           (i > Display_MAXINDEX)

#if !defined(Display_DISABLE_ALL) || (!Display_DISABLE_ALL)

#  define Display_init() \
    Display_doInit()

#  define Display_open(id, params) \
    Display_doOpen(id, params)

#  define Display_Params_init(params) \
    Display_doParamsInit(params)

#  define Display_clear(handle) \
    Display_doClear(handle)

#  define Display_clearLines(handle, fromLine, toLine) \
    Display_doClearLines(handle, fromLine, toLine)

#  define Display_printf Display_doPrintf

#  define Display_print0(handle, line, col, fmt) \
    Display_printf(handle, line, col, fmt)

#  define Display_print1(handle, line, col, fmt, a0) \
    Display_printf(handle, line, col, fmt, a0)

#  define Display_print2(handle, line, col, fmt, a0, a1) \
    Display_printf(handle, line, col, fmt, a0, a1)

#  define Display_print3(handle, line, col, fmt, a0, a1, a2) \
    Display_printf(handle, line, col, fmt, a0, a1, a2)

#  define Display_print4(handle, line, col, fmt, a0, a1, a2, a3) \
    Display_printf(handle, line, col, fmt, a0, a1, a2, a3)

#  define Display_print5(handle, line, col, fmt, a0, a1, a2, a3, a4) \
    Display_printf(handle, line, col, fmt, a0, a1, a2, a3, a4)

#  define Display_getType(handle) \
    Display_doGetType(handle)

#  define Display_control(handle, cmd, arg) \
    Display_doControl(handle, cmd, arg)

#  define Display_close(handle) \
    Display_doClose(handle)
#else
#  define Display_init()
#  define Display_open(id, params)    NULL
#  define Display_Params_init(params)
#  define Display_clear(handle)
#  define Display_clearLines(handle, fromLine, toLine)
#  define Display_printf(handle, line, col, fmt, ...)
#  define Display_print0(handle, line, col, fmt)
#  define Display_print1(handle, line, col, fmt, a0)
#  define Display_print2(handle, line, col, fmt, a0, a1)
#  define Display_print3(handle, line, col, fmt, a0, a1, a2)
#  define Display_print4(handle, line, col, fmt, a0, a1, a2, a3)
#  define Display_print5(handle, line, col, fmt, a0, a1, a2, a3, a4)
#  define Display_getType(handle) Display_Type_INVALID
#  define Display_control(handle, cmd, arg)  NULL
#  define Display_close(handle)
#endif

/* -----------------------------------------------------------------------------
 *                                          Typedefs
 * ------------------------------------------------------------------------------
 */
typedef struct Display_Config * Display_Handle;

typedef void (*Display_initFxn)(Display_Handle handle);

typedef enum Display_LineClearMode
{
    DISPLAY_CLEAR_NONE = 0,   
    DISPLAY_CLEAR_LEFT,       
    DISPLAY_CLEAR_RIGHT,      
    DISPLAY_CLEAR_BOTH        
} Display_LineClearMode;

typedef struct Display_Params
{
    Display_LineClearMode lineClearMode;  /* Default clear entire line */
} Display_Params;

typedef Display_Handle (*Display_openFxn)(Display_Handle handle,
                                          Display_Params *params);
typedef void (*Display_clearFxn)(Display_Handle handle);

typedef void (*Display_clearLinesFxn)(Display_Handle handle,
                                      uint8_t fromLine,
                                      uint8_t toLine);

typedef void (*Display_vprintfFxn)(Display_Handle handle,
                                   uint8_t line,
                                   uint8_t column,
                                   char *fmt,
                                   va_list va);

typedef void (*Display_closeFxn)(Display_Handle);

typedef int (*Display_controlFxn)(Display_Handle handle,
                                  unsigned int cmd,
                                  void *arg);
typedef unsigned int (*Display_getTypeFxn)(void);

typedef struct Display_FxnTable
{
    Display_initFxn       initFxn;
    Display_openFxn       openFxn;
    Display_clearFxn      clearFxn;
    Display_clearLinesFxn clearLinesFxn;
    Display_vprintfFxn    vprintfFxn;
    Display_closeFxn      closeFxn;
    Display_controlFxn    controlFxn;
    Display_getTypeFxn    getTypeFxn;
} Display_FxnTable;

typedef struct Display_Config
{
    Display_FxnTable const *fxnTablePtr;

    void                   *object;

    void const             *hwAttrs;
} Display_Config;


/* -----------------------------------------------------------------------------
 *                                          Functions
 * ------------------------------------------------------------------------------
 */
Display_Handle  Display_doOpen(uint32_t id, Display_Params *params);

void Display_doParamsInit(Display_Params *params);

void  Display_doClear(Display_Handle handle);

void  Display_doClearLines(Display_Handle handle, uint8_t fromLine, uint8_t toLine);

void  Display_doPrintf(Display_Handle handle, uint8_t line, uint8_t column,
                       char *fmt, ...);

void  Display_doClose(Display_Handle handle);

uint32_t  Display_doGetType(Display_Handle handle);

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

void Display_doInit(void);

#ifdef __cplusplus
}
#endif

#endif //ti_display_Display__include