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