---

lcd.h

Go to the documentation of this file.

//*****************************************************************************
//
// File Name    : 'lcd.c'
// Title                        : Character LCD driver for HD44780/SED1278 displays
//                                              (usable in mem-mapped, or I/O mode)
// Author               : Pascal Stang
// Created              : 11/22/2000
// Revised              : 4/30/2002
// Version              : 1.1
// Target MCU   : Atmel AVR series
// Editor Tabs  : 3
//
// This code is distributed under the GNU Public License
//              which can be found at http://www.gnu.org/licenses/gpl.txt
//
//*****************************************************************************

// ********Changes by MG
// 
// lines 90-91 changed lines to 2, line length to 24


#ifndef LCD_H
#define LCD_H

#include "global.h"

// Define type of interface used to access the LCD
//      LCD_MEMORY_INTERFACE:
//              To use this mode you must supply the necessary hardware to connect the
//              LCD to the CPU's memory bus.  The CONTROL and DATA registers of the LCD
//              (HD44780 chip) must appear in the CPU's memory map.  This mode is faster
//              than the port interface but requires a little extra hardware to make it
//              work.  It is especially useful when your CPU is already configured to
//              use an external memory bus for other purposes (like accessing memory).
//
// LCD_PORT_INTERFACE:
//              This mode allows you to connect the control and data lines of the LCD
//              directly to the I/O port pins (no interfacing hardware is needed),
//              but it generally runs slower than the LCD_MEMORY_INTERFACE.
//              Depending on your needs, when using the LCD_PORT_INTERFACE, the LCD may
//              be accessed in 8-bit or 4-bit mode.  In 8-bit mode, one whole I/O port
//              (pins 0-7) is required for the LCD data lines, but transfers are faster.
//              In 4-bit mode, only I/O port pins 4-7 are needed for data lines, but LCD
//              access is slower.  In either mode, three additional port pins are
//              required for the LCD interface control lines (RS, R/W, and E).

// Enable one of the following interfaces to your LCD
//#define LCD_MEMORY_INTERFACE
#define LCD_PORT_INTERFACE

// Enter the parameters for your chosen interface'
// if you chose the LCD_PORT_INTERFACE:
#ifdef LCD_PORT_INTERFACE
        #ifndef LCD_CTRL_PORT
                // port and pins you will use for control lines
                #define LCD_CTRL_PORT   PORTC
                #define LCD_CTRL_DDR            DDRC

                #define LCD_CTRL_RS             PC2
                #define LCD_CTRL_RW             PC3
                #define LCD_CTRL_E              PC4
        #endif
        #ifndef LCD_DATA_POUT
                // port you will use for data lines
                #define LCD_DATA_POUT   PORTA
                #define LCD_DATA_PIN            PINA
                #define LCD_DATA_DDR            DDRA
                // access mode you will use (defaults to 8bit unless 4bit is selected)
                #define LCD_DATA_4BIT
        #endif
#endif

// if you chose the LCD_MEMORY_INTERFACE:
#ifdef LCD_MEMORY_INTERFACE
        #ifndef LCD_CTRL_ADDR
                // CPU memory address of the LCD control register
                #define LCD_CTRL_ADDR   0x1000
        #endif
        #ifndef LCD_DATA_ADDR
                // CPU memory address of the LCD data register
                #define LCD_DATA_ADDR   0x1001
        #endif
#endif


// LCD display geometry
// change these definitions to adapt setting
#define LCD_LINES           2     // visible lines
#define LCD_LINE_LENGTH    24     // line length (in characters)

// HD44780 LCD controller command set (do not modify these)
// writing:
#define LCD_CLR             0      // DB0: clear display
#define LCD_HOME            1      // DB1: return to home position
#define LCD_ENTRY_MODE      2      // DB2: set entry mode
#define LCD_ENTRY_INC       1      //   DB1: increment
#define LCD_ENTRY_SHIFT     0      //   DB2: shift
#define LCD_ON_CTRL         3      // DB3: turn lcd/cursor on
#define LCD_ON_DISPLAY      2      //   DB2: turn display on
#define LCD_ON_CURSOR       1      //   DB1: turn cursor on
#define LCD_ON_BLINK        0      //   DB0: blinking cursor
#define LCD_MOVE            4      // DB4: move cursor/display
#define LCD_MOVE_DISP       3      //   DB3: move display (0-> move cursor)
#define LCD_MOVE_RIGHT      2      //   DB2: move right (0-> left)
#define LCD_FUNCTION        5      // DB5: function set
#define LCD_FUNCTION_8BIT   4      //   DB4: set 8BIT mode (0->4BIT mode)
#define LCD_FUNCTION_2LINES 3      //   DB3: two lines (0->one line)
#define LCD_FUNCTION_10DOTS 2      //   DB2: 5x10 font (0->5x7 font)
#define LCD_CGRAM           6      // DB6: set CG RAM address
#define LCD_DDRAM           7      // DB7: set DD RAM address
// reading:
#define LCD_BUSY            7      // DB7: LCD is busy

// Default LCD setup
// this default setup is loaded on LCD initialization
#ifdef LCD_DATA_4BIT
        #define LCD_FDEF_1                      (0<<LCD_FUNCTION_8BIT)
#else
        #define LCD_FDEF_1                      (1<<LCD_FUNCTION_8BIT)
#endif
#define LCD_FDEF_2                              (1<<LCD_FUNCTION_2LINES)
#define LCD_FUNCTION_DEFAULT    ((1<<LCD_FUNCTION) | LCD_FDEF_1 | LCD_FDEF_2)
#define LCD_MODE_DEFAULT                ((1<<LCD_ENTRY_MODE) | (1<<LCD_ENTRY_INC))

// custom LCD characters
#define LCDCHAR_PROGRESS05              0       // 0/5 full progress block
#define LCDCHAR_PROGRESS15              1       // 1/5 full progress block
#define LCDCHAR_PROGRESS25              2       // 2/5 full progress block
#define LCDCHAR_PROGRESS35              3       // 3/5 full progress block
#define LCDCHAR_PROGRESS45              4       // 4/5 full progress block
#define LCDCHAR_PROGRESS55              5       // 5/5 full progress block
#define LCDCHAR_REWINDARROW     6       // rewind arrow
#define LCDCHAR_STOPBLOCK               7       // stop block
#define LCDCHAR_PAUSEBARS               8       // pause bars
#define LCDCHAR_FORWARDARROW    9       // fast-forward arrow
#define LCDCHAR_SCROLLUPARROW   10      // scroll up arrow
#define LCDCHAR_SCROLLDNARROW   11      // scroll down arrow
#define LCDCHAR_BLANK                   12      // scroll down arrow
#define LCDCHAR_ANIPLAYICON0    13      // animated play icon frame 0
#define LCDCHAR_ANIPLAYICON1    14      // animated play icon frame 1
#define LCDCHAR_ANIPLAYICON2    15      // animated play icon frame 2
#define LCDCHAR_ANIPLAYICON3    16      // animated play icon frame 3

// progress bar defines
#define PROGRESSPIXELS_PER_CHAR 6


// ****** Low-level functions ******
// the following functions are the only ones which deal with the CPU
// memory or port pins directly.  If you decide to use a fundamentally
// different hardware interface to your LCD, only these functions need
// to be changed, after which all the high-level functions will
// work again.

// initializes I/O pins connected to LCD
void lcdInitHW(void);
// waits until LCD is not busy
void lcdBusyWait(void);
// writes a control command to the LCD
void lcdControlWrite(u08 data);
// read the control status from the LCD
u08 lcdControlRead(void);
// writes a data byte to the LCD screen at the current position
void lcdDataWrite(u08 data);
// reads the data byte on the LCD screen at the current position
u08 lcdDataRead(void);


// ****** High-levlel functions ******
// these functions provide the high-level control of the LCD
// such as clearing the display, setting cursor positions,
// displaying text and special characters

// initializes the LCD display (gets it ready for use)
void lcdInit(void);

// moves the cursor/position to Home (upper left corner)
void lcdHome(void);

// clears the LCD display
void lcdClear(void);

// moves the cursor/position to the row,col requested
// ** this may not be accurate for all displays
void lcdGotoXY(u08 row, u08 col);

// loads a special user-defined character into the LCD
// <lcdCharNum> is the RAM location in the LCD (legal value: 0-7)
// <romCharNum> is the ROM character number of the 
void lcdLoadCustomChar(u08 lcdCharNum, u08 romCharNum);

// prints a series of bytes/characters to the display
void lcdPrintData(char* data, u08 nBytes);

// displays a horizontal progress bar at the current cursor location
// <progress> is the value the bargraph should indicate
// <maxprogress> is the value at the end of the bargraph
// <length> is the number of LCD characters that the bargraph should cover
void lcdProgressBar(u16 progress, u16 maxprogress, u08 length);

#endif

---