git.gag.com Git - fw/altos/blob - avr/tmp/lcd.h

   1 #ifndef LCD_H\r
   2 #define LCD_H\r
   3 /*************************************************************************\r
   4  Title  :   C include file for the HD44780U LCD library (lcd.c)\r
   5  Author:    Peter Fleury <pfleury@gmx.ch>  http://jump.to/fleury\r
   6  File:      $Id: lcd.h,v 1.13.2.2 2006/01/30 19:51:33 peter Exp $\r
   7  Software:  AVR-GCC 3.3\r
   8  Hardware:  any AVR device, memory mapped mode only for AT90S4414/8515/Mega\r
   9 ***************************************************************************/\r
  10 \r
  11 /**\r
  12  @defgroup pfleury_lcd LCD library\r
  13  @code #include <lcd.h> @endcode\r
  14  \r
  15  @brief Basic routines for interfacing a HD44780U-based text LCD display\r
  16 \r
  17  Originally based on Volker Oth's LCD library,\r
  18  changed lcd_init(), added additional constants for lcd_command(), \r
  19  added 4-bit I/O mode, improved and optimized code.\r
  20        \r
  21  Library can be operated in memory mapped mode (LCD_IO_MODE=0) or in \r
  22  4-bit IO port mode (LCD_IO_MODE=1). 8-bit IO port mode not supported.\r
  23 \r
  24  Memory mapped mode compatible with Kanda STK200, but supports also \r
  25  generation of R/W signal through A8 address line.\r
  26        \r
  27  @author Peter Fleury pfleury@gmx.ch http://jump.to/fleury\r
  28  \r
  29  @see The chapter <a href="http://homepage.sunrise.ch/mysunrise/peterfleury/avr-lcd44780.html" target="_blank">Interfacing a HD44780 Based LCD to an AVR</a>\r
  30       on my home page.\r
  31 \r
  32 */\r
  33 \r
  34 /*@{*/\r
  35 \r
  36 #if (__GNUC__ * 100 + __GNUC_MINOR__) < 303\r
  37 #error "This library requires AVR-GCC 3.3 or later, update to newer AVR-GCC compiler !"\r
  38 #endif\r
  39 \r
  40 #include <inttypes.h>\r
  41 #include <avr/pgmspace.h>\r
  42 \r
  43 /** \r
  44  *  @name  Definitions for MCU Clock Frequency\r
  45  *  Adapt the MCU clock frequency in Hz to your target. \r
  46  */\r
  47 #define XTAL 4000000              /**< clock frequency in Hz, used to calculate delay timer */\r
  48 \r
  49 \r
  50 /**\r
  51  * @name  Definition for LCD controller type\r
  52  * Use 0 for HD44780 controller, change to 1 for displays with KS0073 controller.\r
  53  */\r
  54 #define LCD_CONTROLLER_KS0073 0  /**< Use 0 for HD44780 controller, 1 for KS0073 controller */\r
  55 \r
  56 /** \r
  57  *  @name  Definitions for Display Size \r
  58  *  Change these definitions to adapt setting to your display\r
  59  */\r
  60 #define LCD_LINES           4     /**< number of visible lines of the display */\r
  61 #define LCD_DISP_LENGTH    20     /**< visibles characters per line of the display */\r
  62 #define LCD_LINE_LENGTH  0x40     /**< internal line length of the display    */\r
  63 #define LCD_START_LINE1  0x00     /**< DDRAM address of first char of line 1 */\r
  64 #define LCD_START_LINE2  0x40     /**< DDRAM address of first char of line 2 */\r
  65 #define LCD_START_LINE3  0x14     /**< DDRAM address of first char of line 3 */\r
  66 #define LCD_START_LINE4  0x54     /**< DDRAM address of first char of line 4 */\r
  67 #define LCD_WRAP_LINES      0     /**< 0: no wrap, 1: wrap at end of visibile line */\r
  68 \r
  69 \r
  70 #define LCD_IO_MODE      1         /**< 0: memory mapped mode, 1: IO port mode */\r
  71 #if LCD_IO_MODE\r
  72 /**\r
  73  *  @name Definitions for 4-bit IO mode\r
  74  *  Change LCD_PORT if you want to use a different port for the LCD pins.\r
  75  *\r
  76  *  The four LCD data lines and the three control lines RS, RW, E can be on the \r
  77  *  same port or on different ports. \r
  78  *  Change LCD_RS_PORT, LCD_RW_PORT, LCD_E_PORT if you want the control lines on\r
  79  *  different ports. \r
  80  *\r
  81  *  Normally the four data lines should be mapped to bit 0..3 on one port, but it\r
  82  *  is possible to connect these data lines in different order or even on different\r
  83  *  ports by adapting the LCD_DATAx_PORT and LCD_DATAx_PIN definitions.\r
  84  *  \r
  85  */\r
  86 #define LCD_PORT         PORTD        /**< port for the LCD lines   */\r
  87 #define LCD_DATA0_PORT   LCD_PORT     /**< port for 4bit data bit 0 */\r
  88 #define LCD_DATA1_PORT   LCD_PORT     /**< port for 4bit data bit 1 */\r
  89 #define LCD_DATA2_PORT   LCD_PORT     /**< port for 4bit data bit 2 */\r
  90 #define LCD_DATA3_PORT   LCD_PORT     /**< port for 4bit data bit 3 */\r
  91 #define LCD_DATA0_PIN    0            /**< pin for 4bit data bit 0  */\r
  92 #define LCD_DATA1_PIN    1            /**< pin for 4bit data bit 1  */\r
  93 #define LCD_DATA2_PIN    2            /**< pin for 4bit data bit 2  */\r
  94 #define LCD_DATA3_PIN    3            /**< pin for 4bit data bit 3  */\r
  95 #define LCD_RS_PORT      LCD_PORT     /**< port for RS line         */\r
  96 #define LCD_RS_PIN       5            /**< pin  for RS line         */\r
  97 #define LCD_RW_PORT      LCD_PORT     /**< port for RW line         */\r
  98 #define LCD_RW_PIN       7            /**< pin  for RW line         */\r
  99 #define LCD_E_PORT       LCD_PORT     /**< port for Enable line     */\r
 100 #define LCD_E_PIN        4            /**< pin  for Enable line     */\r
 101 \r
 102 #elif defined(__AVR_AT90S4414__) || defined(__AVR_AT90S8515__) || defined(__AVR_ATmega64__) || \\r
 103       defined(__AVR_ATmega8515__)|| defined(__AVR_ATmega103__) || defined(__AVR_ATmega128__) || \\r
 104       defined(__AVR_ATmega161__) || defined(__AVR_ATmega162__)\r
 105 /*\r
 106  *  memory mapped mode is only supported when the device has an external data memory interface\r
 107  */\r
 108 #define LCD_IO_DATA      0xC000    /* A15=E=1, A14=RS=1                 */\r
 109 #define LCD_IO_FUNCTION  0x8000    /* A15=E=1, A14=RS=0                 */\r
 110 #define LCD_IO_READ      0x0100    /* A8 =R/W=1 (R/W: 1=Read, 0=Write   */\r
 111 #else\r
 112 #error "external data memory interface not available for this device, use 4-bit IO port mode"\r
 113 \r
 114 #endif\r
 115 \r
 116 \r
 117 /**\r
 118  *  @name Definitions for LCD command instructions\r
 119  *  The constants define the various LCD controller instructions which can be passed to the \r
 120  *  function lcd_command(), see HD44780 data sheet for a complete description.\r
 121  */\r
 122 \r
 123 /* instruction register bit positions, see HD44780U data sheet */\r
 124 #define LCD_CLR               0      /* DB0: clear display                  */\r
 125 #define LCD_HOME              1      /* DB1: return to home position        */\r
 126 #define LCD_ENTRY_MODE        2      /* DB2: set entry mode                 */\r
 127 #define LCD_ENTRY_INC         1      /*   DB1: 1=increment, 0=decrement     */\r
 128 #define LCD_ENTRY_SHIFT       0      /*   DB2: 1=display shift on           */\r
 129 #define LCD_ON                3      /* DB3: turn lcd/cursor on             */\r
 130 #define LCD_ON_DISPLAY        2      /*   DB2: turn display on              */\r
 131 #define LCD_ON_CURSOR         1      /*   DB1: turn cursor on               */\r
 132 #define LCD_ON_BLINK          0      /*     DB0: blinking cursor ?          */\r
 133 #define LCD_MOVE              4      /* DB4: move cursor/display            */\r
 134 #define LCD_MOVE_DISP         3      /*   DB3: move display (0-> cursor) ?  */\r
 135 #define LCD_MOVE_RIGHT        2      /*   DB2: move right (0-> left) ?      */\r
 136 #define LCD_FUNCTION          5      /* DB5: function set                   */\r
 137 #define LCD_FUNCTION_8BIT     4      /*   DB4: set 8BIT mode (0->4BIT mode) */\r
 138 #define LCD_FUNCTION_2LINES   3      /*   DB3: two lines (0->one line)      */\r
 139 #define LCD_FUNCTION_10DOTS   2      /*   DB2: 5x10 font (0->5x7 font)      */\r
 140 #define LCD_CGRAM             6      /* DB6: set CG RAM address             */\r
 141 #define LCD_DDRAM             7      /* DB7: set DD RAM address             */\r
 142 #define LCD_BUSY              7      /* DB7: LCD is busy                    */\r
 143 \r
 144 /* set entry mode: display shift on/off, dec/inc cursor move direction */\r
 145 #define LCD_ENTRY_DEC            0x04   /* display shift off, dec cursor move dir */\r
 146 #define LCD_ENTRY_DEC_SHIFT      0x05   /* display shift on,  dec cursor move dir */\r
 147 #define LCD_ENTRY_INC_           0x06   /* display shift off, inc cursor move dir */\r
 148 #define LCD_ENTRY_INC_SHIFT      0x07   /* display shift on,  inc cursor move dir */\r
 149 \r
 150 /* display on/off, cursor on/off, blinking char at cursor position */\r
 151 #define LCD_DISP_OFF             0x08   /* display off                            */\r
 152 #define LCD_DISP_ON              0x0C   /* display on, cursor off                 */\r
 153 #define LCD_DISP_ON_BLINK        0x0D   /* display on, cursor off, blink char     */\r
 154 #define LCD_DISP_ON_CURSOR       0x0E   /* display on, cursor on                  */\r
 155 #define LCD_DISP_ON_CURSOR_BLINK 0x0F   /* display on, cursor on, blink char      */\r
 156 \r
 157 /* move cursor/shift display */\r
 158 #define LCD_MOVE_CURSOR_LEFT     0x10   /* move cursor left  (decrement)          */\r
 159 #define LCD_MOVE_CURSOR_RIGHT    0x14   /* move cursor right (increment)          */\r
 160 #define LCD_MOVE_DISP_LEFT       0x18   /* shift display left                     */\r
 161 #define LCD_MOVE_DISP_RIGHT      0x1C   /* shift display right                    */\r
 162 \r
 163 /* function set: set interface data length and number of display lines */\r
 164 #define LCD_FUNCTION_4BIT_1LINE  0x20   /* 4-bit interface, single line, 5x7 dots */\r
 165 #define LCD_FUNCTION_4BIT_2LINES 0x28   /* 4-bit interface, dual line,   5x7 dots */\r
 166 #define LCD_FUNCTION_8BIT_1LINE  0x30   /* 8-bit interface, single line, 5x7 dots */\r
 167 #define LCD_FUNCTION_8BIT_2LINES 0x38   /* 8-bit interface, dual line,   5x7 dots */\r
 168 \r
 169 \r
 170 #define LCD_MODE_DEFAULT     ((1<<LCD_ENTRY_MODE) | (1<<LCD_ENTRY_INC) )\r
 171 \r
 172 \r
 173 \r
 174 /** \r
 175  *  @name Functions\r
 176  */\r
 177 \r
 178 \r
 179 /**\r
 180  @brief    Initialize display and select type of cursor\r
 181  @param    dispAttr \b LCD_DISP_OFF display off\n\r
 182                     \b LCD_DISP_ON display on, cursor off\n\r
 183                     \b LCD_DISP_ON_CURSOR display on, cursor on\n\r
 184                     \b LCD_DISP_ON_CURSOR_BLINK display on, cursor on flashing             \r
 185  @return  none\r
 186 */\r
 187 extern void lcd_init(uint8_t dispAttr);\r
 188 \r
 189 \r
 190 /**\r
 191  @brief    Clear display and set cursor to home position\r
 192  @param    void                                        \r
 193  @return   none\r
 194 */\r
 195 extern void lcd_clrscr(void);\r
 196 \r
 197 \r
 198 /**\r
 199  @brief    Set cursor to home position\r
 200  @param    void                                        \r
 201  @return   none\r
 202 */\r
 203 extern void lcd_home(void);\r
 204 \r
 205 \r
 206 /**\r
 207  @brief    Set cursor to specified position\r
 208  \r
 209  @param    x horizontal position\n (0: left most position)\r
 210  @param    y vertical position\n   (0: first line)\r
 211  @return   none\r
 212 */\r
 213 extern void lcd_gotoxy(uint8_t x, uint8_t y);\r
 214 \r
 215 \r
 216 /**\r
 217  @brief    Display character at current cursor position\r
 218  @param    c character to be displayed                                       \r
 219  @return   none\r
 220 */\r
 221 extern void lcd_putc(char c);\r
 222 \r
 223 \r
 224 /**\r
 225  @brief    Display string without auto linefeed\r
 226  @param    s string to be displayed                                        \r
 227  @return   none\r
 228 */\r
 229 extern void lcd_puts(const char *s);\r
 230 \r
 231 \r
 232 /**\r
 233  @brief    Display string from program memory without auto linefeed\r
 234  @param    s string from program memory be be displayed                                        \r
 235  @return   none\r
 236  @see      lcd_puts_P\r
 237 */\r
 238 extern void lcd_puts_p(const char *progmem_s);\r
 239 \r
 240 \r
 241 /**\r
 242  @brief    Send LCD controller instruction command\r
 243  @param    cmd instruction to send to LCD controller, see HD44780 data sheet\r
 244  @return   none\r
 245 */\r
 246 extern void lcd_command(uint8_t cmd);\r
 247 \r
 248 \r
 249 /**\r
 250  @brief    Send data byte to LCD controller \r
 251  \r
 252  Similar to lcd_putc(), but without interpreting LF\r
 253  @param    data byte to send to LCD controller, see HD44780 data sheet\r
 254  @return   none\r
 255 */\r
 256 extern void lcd_data(uint8_t data);\r
 257 \r
 258 \r
 259 /**\r
 260  @brief macros for automatically storing string constant in program memory\r
 261 */\r
 262 #define lcd_puts_P(__s)         lcd_puts_p(PSTR(__s))\r
 263 \r
 264 /*@}*/\r
 265 #endif //LCD_H\r