daily pastebin goal
9%
SHARE
TWEET

xlcd.h

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