drivers/avr/hd44780.h

   1 #ifndef LCD_H
   2 #define LCD_H
   3 /*************************************************************************
   4  Title  :   C include file for the HD44780U LCD library (lcd.c)
   5  Author:    Peter Fleury <pfleury@gmx.ch>  http://tinyurl.com/peterfleury
   6  License:   GNU General Public License Version 3
   7  File:      $Id: lcd.h,v 1.14.2.4 2015/01/20 17:16:07 peter Exp $
   8  Software:  AVR-GCC 4.x
   9  Hardware:  any AVR device, memory mapped mode only for AVR with
  10             memory mapped interface (AT90S8515/ATmega8515/ATmega128)
  11 ***************************************************************************/
  12
  13 /**
  14  @mainpage
  15  Collection of libraries for AVR-GCC
  16  @author Peter Fleury pfleury@gmx.ch http://tinyurl.com/peterfleury
  17  @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3
  18
  19  @file
  20  @defgroup pfleury_lcd LCD library <lcd.h>
  21  @code #include <lcd.h> @endcode
  22
  23  @brief Basic routines for interfacing a HD44780U-based character LCD display
  24
  25  LCD character displays can be found in many devices, like espresso machines, laser printers.
  26  The Hitachi HD44780 controller and its compatible controllers like Samsung KS0066U have become an industry standard for these types of displays.
  27
  28  This library allows easy interfacing with a HD44780 compatible display and can be
  29  operated in memory mapped mode (LCD_IO_MODE defined as 0 in the include file lcd.h.) or in
  30  4-bit IO port mode (LCD_IO_MODE defined as 1). 8-bit IO port mode is not supported.
  31
  32  Memory mapped mode is compatible with old Kanda STK200 starter kit, but also supports
  33  generation of R/W signal through A8 address line.
  34
  35  @see The chapter <a href=" http://homepage.hispeed.ch/peterfleury/avr-lcd44780.html" target="_blank">Interfacing a HD44780 Based LCD to an AVR</a>
  36       on my home page, which shows example circuits how to connect an LCD to an AVR controller.
  37
  38  @author Peter Fleury pfleury@gmx.ch http://tinyurl.com/peterfleury
  39
  40  @version   2.0
  41
  42  @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3
  43
  44 */
  45
  46 #include <inttypes.h>
  47 #include <avr/pgmspace.h>
  48
  49 #if (__GNUC__ * 100 + __GNUC_MINOR__) < 405
  50 #error "This library requires AVR-GCC 4.5 or later, update to newer AVR-GCC compiler !"
  51 #endif
  52
  53
  54 /**@{*/
  55
  56 /*
  57  * LCD and target specific definitions below can be defined in a separate include file with name lcd_definitions.h instead modifying this file
  58  * by adding -D_LCD_DEFINITIONS_FILE to the CDEFS section in the Makefile
  59  * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
  60  */
  61 #ifdef _LCD_DEFINITIONS_FILE
  62 #include "lcd_definitions.h"
  63 #endif
  64
  65
  66 /**
  67  * @name  Definition for LCD controller type
  68  * Use 0 for HD44780 controller, change to 1 for displays with KS0073 controller.
  69  */
  70 #ifndef LCD_CONTROLLER_KS0073
  71 #define LCD_CONTROLLER_KS0073 0  /**< Use 0 for HD44780 controller, 1 for KS0073 controller */
  72 #endif
  73
  74 /**
  75  * @name  Definitions for Display Size
  76  * Change these definitions to adapt setting to your display
  77  *
  78  * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by
  79  * adding -D_LCD_DEFINITIONS_FILE to the CDEFS section in the Makefile.
  80  * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
  81  *
  82  */
  83 #ifndef LCD_LINES
  84 #define LCD_LINES           2     /**< number of visible lines of the display */
  85 #endif
  86 #ifndef LCD_DISP_LENGTH
  87 #define LCD_DISP_LENGTH    16     /**< visibles characters per line of the display */
  88 #endif
  89 #ifndef LCD_LINE_LENGTH
  90 #define LCD_LINE_LENGTH  0x40     /**< internal line length of the display    */
  91 #endif
  92 #ifndef LCD_START_LINE1
  93 #define LCD_START_LINE1  0x00     /**< DDRAM address of first char of line 1 */
  94 #endif
  95 #ifndef LCD_START_LINE2
  96 #define LCD_START_LINE2  0x40     /**< DDRAM address of first char of line 2 */
  97 #endif
  98 #ifndef LCD_START_LINE3
  99 #define LCD_START_LINE3  0x14     /**< DDRAM address of first char of line 3 */
 100 #endif
 101 #ifndef LCD_START_LINE4
 102 #define LCD_START_LINE4  0x54     /**< DDRAM address of first char of line 4 */
 103 #endif
 104 #ifndef LCD_WRAP_LINES
 105 #define LCD_WRAP_LINES      0     /**< 0: no wrap, 1: wrap at end of visibile line */
 106 #endif
 107
 108
 109 /**
 110  * @name Definitions for 4-bit IO mode
 111  *
 112  * The four LCD data lines and the three control lines RS, RW, E can be on the
 113  * same port or on different ports.
 114  * Change LCD_RS_PORT, LCD_RW_PORT, LCD_E_PORT if you want the control lines on
 115  * different ports.
 116  *
 117  * Normally the four data lines should be mapped to bit 0..3 on one port, but it
 118  * is possible to connect these data lines in different order or even on different
 119  * ports by adapting the LCD_DATAx_PORT and LCD_DATAx_PIN definitions.
 120  *
 121  * Adjust these definitions to your target.\n
 122  * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by
 123  * adding \b -D_LCD_DEFINITIONS_FILE to the \b CDEFS section in the Makefile.
 124  * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
 125  *
 126  */
 127 #define LCD_IO_MODE      1            /**< 0: memory mapped mode, 1: IO port mode */
 128
 129 #if LCD_IO_MODE
 130
 131 #ifndef LCD_PORT
 132 #define LCD_PORT         PORTA        /**< port for the LCD lines   */
 133 #endif
 134 #ifndef LCD_DATA0_PORT
 135 #define LCD_DATA0_PORT   LCD_PORT     /**< port for 4bit data bit 0 */
 136 #endif
 137 #ifndef LCD_DATA1_PORT
 138 #define LCD_DATA1_PORT   LCD_PORT     /**< port for 4bit data bit 1 */
 139 #endif
 140 #ifndef LCD_DATA2_PORT
 141 #define LCD_DATA2_PORT   LCD_PORT     /**< port for 4bit data bit 2 */
 142 #endif
 143 #ifndef LCD_DATA3_PORT
 144 #define LCD_DATA3_PORT   LCD_PORT     /**< port for 4bit data bit 3 */
 145 #endif
 146 #ifndef LCD_DATA0_PIN
 147 #define LCD_DATA0_PIN    4            /**< pin for 4bit data bit 0  */
 148 #endif
 149 #ifndef LCD_DATA1_PIN
 150 #define LCD_DATA1_PIN    5            /**< pin for 4bit data bit 1  */
 151 #endif
 152 #ifndef LCD_DATA2_PIN
 153 #define LCD_DATA2_PIN    6            /**< pin for 4bit data bit 2  */
 154 #endif
 155 #ifndef LCD_DATA3_PIN
 156 #define LCD_DATA3_PIN    7            /**< pin for 4bit data bit 3  */
 157 #endif
 158 #ifndef LCD_RS_PORT
 159 #define LCD_RS_PORT      LCD_PORT     /**< port for RS line         */
 160 #endif
 161 #ifndef LCD_RS_PIN
 162 #define LCD_RS_PIN       3            /**< pin  for RS line         */
 163 #endif
 164 #ifndef LCD_RW_PORT
 165 #define LCD_RW_PORT      LCD_PORT     /**< port for RW line         */
 166 #endif
 167 #ifndef LCD_RW_PIN
 168 #define LCD_RW_PIN       2            /**< pin  for RW line         */
 169 #endif
 170 #ifndef LCD_E_PORT
 171 #define LCD_E_PORT       LCD_PORT     /**< port for Enable line     */
 172 #endif
 173 #ifndef LCD_E_PIN
 174 #define LCD_E_PIN        1            /**< pin  for Enable line     */
 175 #endif
 176
 177 #elif defined(__AVR_AT90S4414__) || defined(__AVR_AT90S8515__) || defined(__AVR_ATmega64__) || \
 178       defined(__AVR_ATmega8515__)|| defined(__AVR_ATmega103__) || defined(__AVR_ATmega128__) || \
 179       defined(__AVR_ATmega161__) || defined(__AVR_ATmega162__)
 180 /*
 181  * memory mapped mode is only supported when the device has an external data memory interface
 182  */
 183 #define LCD_IO_DATA      0xC000    /* A15=E=1, A14=RS=1                 */
 184 #define LCD_IO_FUNCTION  0x8000    /* A15=E=1, A14=RS=0                 */
 185 #define LCD_IO_READ      0x0100    /* A8 =R/W=1 (R/W: 1=Read, 0=Write   */
 186
 187 #else
 188 #error "external data memory interface not available for this device, use 4-bit IO port mode"
 189
 190 #endif
 191
 192
 193 /**
 194  * @name Definitions of delays
 195  * Used to calculate delay timers.
 196  * Adapt the F_CPU define in the Makefile to the clock frequency in Hz of your target
 197  *
 198  * These delay times can be adjusted, if some displays require different delays.\n
 199  * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by
 200  * adding \b -D_LCD_DEFINITIONS_FILE to the \b CDEFS section in the Makefile.
 201  * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
 202  */
 203 #ifndef LCD_DELAY_BOOTUP
 204 #define LCD_DELAY_BOOTUP   16000      /**< delay in micro seconds after power-on  */
 205 #endif
 206 #ifndef LCD_DELAY_INIT
 207 #define LCD_DELAY_INIT      5000      /**< delay in micro seconds after initialization command sent  */
 208 #endif
 209 #ifndef LCD_DELAY_INIT_REP
 210 #define LCD_DELAY_INIT_REP    64      /**< delay in micro seconds after initialization command repeated */
 211 #endif
 212 #ifndef LCD_DELAY_INIT_4BIT
 213 #define LCD_DELAY_INIT_4BIT   64      /**< delay in micro seconds after setting 4-bit mode */
 214 #endif
 215 #ifndef LCD_DELAY_BUSY_FLAG
 216 #define LCD_DELAY_BUSY_FLAG    4      /**< time in micro seconds the address counter is updated after busy flag is cleared */
 217 #endif
 218 #ifndef LCD_DELAY_ENABLE_PULSE
 219 #define LCD_DELAY_ENABLE_PULSE 1      /**< enable signal pulse width in micro seconds */
 220 #endif
 221
 222
 223 /**
 224  * @name Definitions for LCD command instructions
 225  * The constants define the various LCD controller instructions which can be passed to the
 226  * function lcd_command(), see HD44780 data sheet for a complete description.
 227  */
 228
 229 /* instruction register bit positions, see HD44780U data sheet */
 230 #define LCD_CLR               0      /* DB0: clear display                  */
 231 #define LCD_HOME              1      /* DB1: return to home position        */
 232 #define LCD_ENTRY_MODE        2      /* DB2: set entry mode                 */
 233 #define LCD_ENTRY_INC         1      /*   DB1: 1=increment, 0=decrement     */
 234 #define LCD_ENTRY_SHIFT       0      /*   DB2: 1=display shift on           */
 235 #define LCD_ON                3      /* DB3: turn lcd/cursor on             */
 236 #define LCD_ON_DISPLAY        2      /*   DB2: turn display on              */
 237 #define LCD_ON_CURSOR         1      /*   DB1: turn cursor on               */
 238 #define LCD_ON_BLINK          0      /*     DB0: blinking cursor ?          */
 239 #define LCD_MOVE              4      /* DB4: move cursor/display            */
 240 #define LCD_MOVE_DISP         3      /*   DB3: move display (0-> cursor) ?  */
 241 #define LCD_MOVE_RIGHT        2      /*   DB2: move right (0-> left) ?      */
 242 #define LCD_FUNCTION          5      /* DB5: function set                   */
 243 #define LCD_FUNCTION_8BIT     4      /*   DB4: set 8BIT mode (0->4BIT mode) */
 244 #define LCD_FUNCTION_2LINES   3      /*   DB3: two lines (0->one line)      */
 245 #define LCD_FUNCTION_10DOTS   2      /*   DB2: 5x10 font (0->5x7 font)      */
 246 #define LCD_CGRAM             6      /* DB6: set CG RAM address             */
 247 #define LCD_DDRAM             7      /* DB7: set DD RAM address             */
 248 #define LCD_BUSY              7      /* DB7: LCD is busy                    */
 249
 250 /* set entry mode: display shift on/off, dec/inc cursor move direction */
 251 #define LCD_ENTRY_DEC            0x04   /* display shift off, dec cursor move dir */
 252 #define LCD_ENTRY_DEC_SHIFT      0x05   /* display shift on,  dec cursor move dir */
 253 #define LCD_ENTRY_INC_           0x06   /* display shift off, inc cursor move dir */
 254 #define LCD_ENTRY_INC_SHIFT      0x07   /* display shift on,  inc cursor move dir */
 255
 256 /* display on/off, cursor on/off, blinking char at cursor position */
 257 #define LCD_DISP_OFF             0x08   /* display off                            */
 258 #define LCD_DISP_ON              0x0C   /* display on, cursor off                 */
 259 #define LCD_DISP_ON_BLINK        0x0D   /* display on, cursor off, blink char     */
 260 #define LCD_DISP_ON_CURSOR       0x0E   /* display on, cursor on                  */
 261 #define LCD_DISP_ON_CURSOR_BLINK 0x0F   /* display on, cursor on, blink char      */
 262
 263 /* move cursor/shift display */
 264 #define LCD_MOVE_CURSOR_LEFT     0x10   /* move cursor left  (decrement)          */
 265 #define LCD_MOVE_CURSOR_RIGHT    0x14   /* move cursor right (increment)          */
 266 #define LCD_MOVE_DISP_LEFT       0x18   /* shift display left                     */
 267 #define LCD_MOVE_DISP_RIGHT      0x1C   /* shift display right                    */
 268
 269 /* function set: set interface data length and number of display lines */
 270 #define LCD_FUNCTION_4BIT_1LINE  0x20   /* 4-bit interface, single line, 5x7 dots */
 271 #define LCD_FUNCTION_4BIT_2LINES 0x28   /* 4-bit interface, dual line,   5x7 dots */
 272 #define LCD_FUNCTION_8BIT_1LINE  0x30   /* 8-bit interface, single line, 5x7 dots */
 273 #define LCD_FUNCTION_8BIT_2LINES 0x38   /* 8-bit interface, dual line,   5x7 dots */
 274
 275
 276 #define LCD_MODE_DEFAULT     ((1<<LCD_ENTRY_MODE) | (1<<LCD_ENTRY_INC) )
 277
 278
 279
 280 /**
 281  *  @name Functions
 282  */
 283
 284
 285 /**
 286  @brief    Initialize display and select type of cursor
 287  @param    dispAttr \b LCD_DISP_OFF display off\n
 288                     \b LCD_DISP_ON display on, cursor off\n
 289                     \b LCD_DISP_ON_CURSOR display on, cursor on\n
 290                     \b LCD_DISP_ON_CURSOR_BLINK display on, cursor on flashing
 291  @return  none
 292 */
 293 extern void lcd_init(uint8_t dispAttr);
 294
 295
 296 /**
 297  @brief    Clear display and set cursor to home position
 298  @return   none
 299 */
 300 extern void lcd_clrscr(void);
 301
 302
 303 /**
 304  @brief    Set cursor to home position
 305  @return   none
 306 */
 307 extern void lcd_home(void);
 308
 309
 310 /**
 311  @brief    Set cursor to specified position
 312
 313  @param    x horizontal position\n (0: left most position)
 314  @param    y vertical position\n   (0: first line)
 315  @return   none
 316 */
 317 extern void lcd_gotoxy(uint8_t x, uint8_t y);
 318
 319
 320 /**
 321  @brief    Display character at current cursor position
 322  @param    c character to be displayed
 323  @return   none
 324 */
 325 extern void lcd_putc(char c);
 326
 327
 328 /**
 329  @brief    Display string without auto linefeed
 330  @param    s string to be displayed
 331  @return   none
 332 */
 333 extern void lcd_puts(const char *s);
 334
 335
 336 /**
 337  @brief    Display string from program memory without auto linefeed
 338  @param    progmem_s string from program memory be be displayed
 339  @return   none
 340  @see      lcd_puts_P
 341 */
 342 extern void lcd_puts_p(const char *progmem_s);
 343
 344
 345 /**
 346  @brief    Send LCD controller instruction command
 347  @param    cmd instruction to send to LCD controller, see HD44780 data sheet
 348  @return   none
 349 */
 350 extern void lcd_command(uint8_t cmd);
 351
 352
 353 /**
 354  @brief    Send data byte to LCD controller
 355
 356  Similar to lcd_putc(), but without interpreting LF
 357  @param    data byte to send to LCD controller, see HD44780 data sheet
 358  @return   none
 359 */
 360 extern void lcd_data(uint8_t data);
 361
 362
 363 /**
 364  @brief macros for automatically storing string constant in program memory
 365 */
 366 #define lcd_puts_P(__s)         lcd_puts_p(PSTR(__s))
 367
 368 /**@}*/
 369
 370 #endif //LCD_H
 371