LCDDogm1286.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-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_drivers_lcd_LCDDogm1286__include
#define ti_drivers_lcd_LCDDogm1286__include

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

#ifdef __cplusplus
extern "C" {
#endif

#define LCD_PIXELS     8192

#define LCD_BYTES      1024

#define LCD_COLS       128

#define LCD_X_MIN      0

#define LCD_X_MAX      (LCD_COLS - 1)

#define LCD_ROWS       64

#define LCD_Y_MIN      0

#define LCD_Y_MAX      (LCD_ROWS - 1)

#define LCD_PAGES      8

#define LCD_PAGE_ROWS  8

#define LCD_CHAR_WIDTH 6

#define LCD_FONT_WIDTH 5

typedef struct LCD_Config *LCD_Handle;

typedef enum LCD_Align
{
    LCD_ALIGN_LEFT,   
    LCD_ALIGN_CENTER, 
    LCD_ALIGN_RIGHT   
} LCD_Align;

typedef enum LCD_Page
{
    LCD_PAGE0 = 0,
    LCD_PAGE1,
    LCD_PAGE2,
    LCD_PAGE3,
    LCD_PAGE4,
    LCD_PAGE5,
    LCD_PAGE6,
    LCD_PAGE7,
    LCD_PAGE_COUNT
} LCD_Page;

typedef enum LCD_X_Limit
{
    LCD_X_FIRST = 0,
    LCD_X_LAST  = (LCD_COLS - 1)
} LCD_X_Limit;

typedef enum LCD_Y_Limit
{
    LCD_Y_FIRST = 0,
    LCD_Y_LAST  = (LCD_ROWS - 1)
} LCD_Y_Limit;

typedef struct LCD_Params
{
    unsigned int lcdWriteTimeout; 
    /* SPI parameters */
    unsigned int spiBitRate;        
    SPI_FrameFormat spiFrameFormat; 
} LCD_Params;

typedef struct LCD_Command
{
    char displayStartLine;
    char adcSet;
    char outputMode;
    char displayType;
    char lcdBias;
    char powerControl;
    char boosterRadio0;
    char boosterRadio1;
    char contrastSet0;
    char contrastSet1;
    char contrastSet2;
    char staticIndicator0;
    char staticIndicator1;
    char displayEn;
    char setPage;
    char columnHi;
    char columnLo;
} LCD_Command;

typedef struct LCD_Buffer
{
    char *pcBuffer;             
    unsigned int bufSize;       
    SemaphoreP_Struct bufMutex; 
} LCD_Buffer;

typedef struct LCD_Object
{
    /* LCD control variables */
    bool isOpen;                  /* Has the obj been opened? */
    SPI_Handle spiHandle;         /* SPI handle used by the LCD */
    unsigned int lcdWriteTimeout; /* Timeout for write semaphore */
    SemaphoreP_Struct lcdMutex;   /* Semaphore associated with the lcd */
    LCD_Buffer *lcdBuffers;       /* Pointer to the array
                                     with lcd buffers */
    uint8_t nBuffers;             /* number of buffers availible */
} LCD_Object;

typedef struct LCD_HWAttrs
{
    LCD_Command const *LCD_initCmd;
    /* LCD mode pin */
    uint8_t lcdModePin;
    /* LCD reset pin */
    uint8_t lcdResetPin;
    /* LCD CSn pin */
    uint8_t lcdCsnPin;
    /* Logical peripheral number indexed
       into the SPI_config table */
    uint8_t spiIndex;

} LCD_HWAttrs;

typedef struct LCD_Config
{
    LCD_Object *object;
    LCD_HWAttrs const *hwAttrs;
} LCD_Config;

static const LCD_Command LCD_initCmd = {
    0x40, /*Display start line 0                    */
    0xA1, /*ADC reverse, 6 oclock viewing direction */
    0xC0, /*Normal COM0...COM63                     */
    0xA6, /*Display normal, not mirrored            */
    0xA2, /*Set Bias 1/9 (Duty 1/65)                */
    0x2F, /*Booster, Regulator and Follower On      */
    0xF8, /*Set internal Booster to 4x              */
    0x00, /*                                        */
    0x27, /*Contrast set                            */
    0x81, /*                                        */
    0x16, /* <- use value from LCD-MODULE .doc guide*/
          /*    for better contrast (not 0x10)      */
    0xAC, /*No indicator                            */
    0x00, /*                                        */
    0xAF, /*Display on                              */
    0xB0, /*Set Page 0                              */
    0x10, /*High-Nibble of column address           */
    0x00  /*Low-Nibble of column address            */
};

extern void LCD_close(LCD_Handle handle);

extern void LCD_init(void);

extern LCD_Handle LCD_open(LCD_Buffer *buffers, uint8_t nBuffers, LCD_Params *params);

extern void LCD_Params_init(LCD_Params *params);

extern void LCD_writeLine(LCD_Handle handle,
                          unsigned int bufIndex,
                          char *str,
                          unsigned int uiValue,
                          unsigned char ucFormat,
                          unsigned char ucLine);

extern void LCD_update(LCD_Handle handle, unsigned int bufIndex);

extern void LCD_updatePart(LCD_Handle handle,
                           unsigned int bufIndex,
                           unsigned char ucXFrom,
                           unsigned char ucXTo,
                           LCD_Page iPageFrom,
                           LCD_Page iPageTo);

extern void LCD_bufferClear(LCD_Handle handle, unsigned int bufIndex);

extern void LCD_bufferClearPage(LCD_Handle handle, unsigned int bufIndex, LCD_Page iPage);

extern void LCD_bufferClearPart(LCD_Handle handle,
                                unsigned int bufIndex,
                                unsigned char ucXFrom,
                                unsigned char ucXTo,
                                LCD_Page iPageFrom,
                                LCD_Page iPageTo);

extern void LCD_bufferInvert(LCD_Handle handle,
                             unsigned int bufIndex,
                             unsigned char ucXFrom,
                             unsigned char ucYFrom,
                             unsigned char ucXTo,
                             unsigned char ucYTo);

extern void LCD_bufferInvertPage(LCD_Handle handle,
                                 unsigned int bufIndex,
                                 unsigned char ucXFrom,
                                 unsigned char ucXTo,
                                 LCD_Page iPage);

extern void LCD_bufferPrintString(LCD_Handle handle,
                                  unsigned int bufIndex,
                                  const char *pcStr,
                                  unsigned char ucX,
                                  LCD_Page iPage);

extern void LCD_bufferPrintStringAligned(LCD_Handle handle,
                                         unsigned int bufIndex,
                                         const char *pcStr,
                                         LCD_Align iAlignment,
                                         LCD_Page iPage);

extern void LCD_bufferPrintInt(LCD_Handle handle,
                               unsigned int bufIndex,
                               int i32Number,
                               unsigned char ucX,
                               LCD_Page iPage);

extern void LCD_bufferPrintIntAligned(LCD_Handle handle,
                                      unsigned int bufIndex,
                                      int i32Number,
                                      LCD_Align iAlignment,
                                      LCD_Page iPage);

extern void LCD_bufferPrintFloat(LCD_Handle handle,
                                 unsigned int bufIndex,
                                 float fNumber,
                                 unsigned char ucDecimals,
                                 unsigned char ucX,
                                 LCD_Page iPage);

extern void LCD_bufferPrintFloatAligned(LCD_Handle handle,
                                        unsigned int bufIndex,
                                        float fNumber,
                                        unsigned char ucDecimals,
                                        LCD_Align iAlignment,
                                        LCD_Page iPage);

extern void LCD_bufferSetLine(LCD_Handle handle,
                              unsigned int bufIndex,
                              unsigned char ucXFrom,
                              unsigned char ucYFrom,
                              unsigned char ucXTo,
                              unsigned char ucYTo);

extern void LCD_bufferClearLine(LCD_Handle handle,
                                unsigned int bufIndex,
                                unsigned char ucXFrom,
                                unsigned char ucYFrom,
                                unsigned char ucXTo,
                                unsigned char ucYTo);

extern void LCD_bufferSetHLine(LCD_Handle handle,
                               unsigned int bufIndex,
                               unsigned char ucXFrom,
                               unsigned char ucXTo,
                               unsigned char ucY);

extern void LCD_bufferClearHLine(LCD_Handle handle,
                                 unsigned int bufIndex,
                                 unsigned char ucXFrom,
                                 unsigned char ucXTo,
                                 unsigned char ucY);

extern void LCD_bufferSetVLine(LCD_Handle handle,
                               unsigned int bufIndex,
                               unsigned char ucX,
                               unsigned char ucYFrom,
                               unsigned char ucYTo);

extern void LCD_bufferClearVLine(LCD_Handle handle,
                                 unsigned int bufIndex,
                                 unsigned char ucX,
                                 unsigned char ucYFrom,
                                 unsigned char ucYTo);

extern void LCD_bufferHArrow(LCD_Handle handle,
                             unsigned int bufIndex,
                             unsigned char ucXFrom,
                             unsigned char ucXTo,
                             unsigned char ucY);

extern void LCD_bufferVArrow(LCD_Handle handle,
                             unsigned int bufIndex,
                             unsigned char ucX,
                             unsigned char ucYFrom,
                             unsigned char ucYTo);

extern void LCD_bufferSetPx(LCD_Handle handle, unsigned int bufIndex, unsigned char ucX, unsigned char ucY);

extern void LCD_bufferClearPx(LCD_Handle handle, unsigned int bufIndex, unsigned char ucX, unsigned char ucY);

extern void LCD_bufferCopy(LCD_Handle handle, unsigned int fromBufIndex, unsigned int toBufIndex);

extern void LCD_setContrast(LCD_Handle handle, unsigned char ucContrast);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_lcd_LCDDogm1286__include */