--- /dev/null
+#ifndef LCD_H\r
+#define LCD_H\r
+/*************************************************************************\r
+ Title : C include file for the HD44780U LCD library (lcd.c)\r
+ Author: Peter Fleury <pfleury@gmx.ch> http://jump.to/fleury\r
+ File: $Id: lcd.h,v 1.13.2.2 2006/01/30 19:51:33 peter Exp $\r
+ Software: AVR-GCC 3.3\r
+ Hardware: any AVR device, memory mapped mode only for AT90S4414/8515/Mega\r
+***************************************************************************/\r
+\r
+/**\r
+ @defgroup pfleury_lcd LCD library\r
+ @code #include <lcd.h> @endcode\r
+ \r
+ @brief Basic routines for interfacing a HD44780U-based text LCD display\r
+\r
+ Originally based on Volker Oth's LCD library,\r
+ changed lcd_init(), added additional constants for lcd_command(), \r
+ added 4-bit I/O mode, improved and optimized code.\r
+ \r
+ Library can be operated in memory mapped mode (LCD_IO_MODE=0) or in \r
+ 4-bit IO port mode (LCD_IO_MODE=1). 8-bit IO port mode not supported.\r
+\r
+ Memory mapped mode compatible with Kanda STK200, but supports also \r
+ generation of R/W signal through A8 address line.\r
+ \r
+ @author Peter Fleury pfleury@gmx.ch http://jump.to/fleury\r
+ \r
+ @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
+ on my home page.\r
+\r
+*/\r
+\r
+/*@{*/\r
+\r
+#if (__GNUC__ * 100 + __GNUC_MINOR__) < 303\r
+#error "This library requires AVR-GCC 3.3 or later, update to newer AVR-GCC compiler !"\r
+#endif\r
+\r
+#include <inttypes.h>\r
+#include <avr/pgmspace.h>\r
+\r
+/** \r
+ * @name Definitions for MCU Clock Frequency\r
+ * Adapt the MCU clock frequency in Hz to your target. \r
+ */\r
+#define XTAL 4000000 /**< clock frequency in Hz, used to calculate delay timer */\r
+\r
+\r
+/**\r
+ * @name Definition for LCD controller type\r
+ * Use 0 for HD44780 controller, change to 1 for displays with KS0073 controller.\r
+ */\r
+#define LCD_CONTROLLER_KS0073 0 /**< Use 0 for HD44780 controller, 1 for KS0073 controller */\r
+\r
+/** \r
+ * @name Definitions for Display Size \r
+ * Change these definitions to adapt setting to your display\r
+ */\r
+#define LCD_LINES 4 /**< number of visible lines of the display */\r
+#define LCD_DISP_LENGTH 20 /**< visibles characters per line of the display */\r
+#define LCD_LINE_LENGTH 0x40 /**< internal line length of the display */\r
+#define LCD_START_LINE1 0x00 /**< DDRAM address of first char of line 1 */\r
+#define LCD_START_LINE2 0x40 /**< DDRAM address of first char of line 2 */\r
+#define LCD_START_LINE3 0x14 /**< DDRAM address of first char of line 3 */\r
+#define LCD_START_LINE4 0x54 /**< DDRAM address of first char of line 4 */\r
+#define LCD_WRAP_LINES 0 /**< 0: no wrap, 1: wrap at end of visibile line */\r
+\r
+\r
+#define LCD_IO_MODE 1 /**< 0: memory mapped mode, 1: IO port mode */\r
+#if LCD_IO_MODE\r
+/**\r
+ * @name Definitions for 4-bit IO mode\r
+ * Change LCD_PORT if you want to use a different port for the LCD pins.\r
+ *\r
+ * The four LCD data lines and the three control lines RS, RW, E can be on the \r
+ * same port or on different ports. \r
+ * Change LCD_RS_PORT, LCD_RW_PORT, LCD_E_PORT if you want the control lines on\r
+ * different ports. \r
+ *\r
+ * Normally the four data lines should be mapped to bit 0..3 on one port, but it\r
+ * is possible to connect these data lines in different order or even on different\r
+ * ports by adapting the LCD_DATAx_PORT and LCD_DATAx_PIN definitions.\r
+ * \r
+ */\r
+#define LCD_PORT PORTD /**< port for the LCD lines */\r
+#define LCD_DATA0_PORT LCD_PORT /**< port for 4bit data bit 0 */\r
+#define LCD_DATA1_PORT LCD_PORT /**< port for 4bit data bit 1 */\r
+#define LCD_DATA2_PORT LCD_PORT /**< port for 4bit data bit 2 */\r
+#define LCD_DATA3_PORT LCD_PORT /**< port for 4bit data bit 3 */\r
+#define LCD_DATA0_PIN 0 /**< pin for 4bit data bit 0 */\r
+#define LCD_DATA1_PIN 1 /**< pin for 4bit data bit 1 */\r
+#define LCD_DATA2_PIN 2 /**< pin for 4bit data bit 2 */\r
+#define LCD_DATA3_PIN 3 /**< pin for 4bit data bit 3 */\r
+#define LCD_RS_PORT LCD_PORT /**< port for RS line */\r
+#define LCD_RS_PIN 5 /**< pin for RS line */\r
+#define LCD_RW_PORT LCD_PORT /**< port for RW line */\r
+#define LCD_RW_PIN 7 /**< pin for RW line */\r
+#define LCD_E_PORT LCD_PORT /**< port for Enable line */\r
+#define LCD_E_PIN 4 /**< pin for Enable line */\r
+\r
+#elif defined(__AVR_AT90S4414__) || defined(__AVR_AT90S8515__) || defined(__AVR_ATmega64__) || \\r
+ defined(__AVR_ATmega8515__)|| defined(__AVR_ATmega103__) || defined(__AVR_ATmega128__) || \\r
+ defined(__AVR_ATmega161__) || defined(__AVR_ATmega162__)\r
+/*\r
+ * memory mapped mode is only supported when the device has an external data memory interface\r
+ */\r
+#define LCD_IO_DATA 0xC000 /* A15=E=1, A14=RS=1 */\r
+#define LCD_IO_FUNCTION 0x8000 /* A15=E=1, A14=RS=0 */\r
+#define LCD_IO_READ 0x0100 /* A8 =R/W=1 (R/W: 1=Read, 0=Write */\r
+#else\r
+#error "external data memory interface not available for this device, use 4-bit IO port mode"\r
+\r
+#endif\r
+\r
+\r
+/**\r
+ * @name Definitions for LCD command instructions\r
+ * The constants define the various LCD controller instructions which can be passed to the \r
+ * function lcd_command(), see HD44780 data sheet for a complete description.\r
+ */\r
+\r
+/* instruction register bit positions, see HD44780U data sheet */\r
+#define LCD_CLR 0 /* DB0: clear display */\r
+#define LCD_HOME 1 /* DB1: return to home position */\r
+#define LCD_ENTRY_MODE 2 /* DB2: set entry mode */\r
+#define LCD_ENTRY_INC 1 /* DB1: 1=increment, 0=decrement */\r
+#define LCD_ENTRY_SHIFT 0 /* DB2: 1=display shift on */\r
+#define LCD_ON 3 /* DB3: turn lcd/cursor on */\r
+#define LCD_ON_DISPLAY 2 /* DB2: turn display on */\r
+#define LCD_ON_CURSOR 1 /* DB1: turn cursor on */\r
+#define LCD_ON_BLINK 0 /* DB0: blinking cursor ? */\r
+#define LCD_MOVE 4 /* DB4: move cursor/display */\r
+#define LCD_MOVE_DISP 3 /* DB3: move display (0-> cursor) ? */\r
+#define LCD_MOVE_RIGHT 2 /* DB2: move right (0-> left) ? */\r
+#define LCD_FUNCTION 5 /* DB5: function set */\r
+#define LCD_FUNCTION_8BIT 4 /* DB4: set 8BIT mode (0->4BIT mode) */\r
+#define LCD_FUNCTION_2LINES 3 /* DB3: two lines (0->one line) */\r
+#define LCD_FUNCTION_10DOTS 2 /* DB2: 5x10 font (0->5x7 font) */\r
+#define LCD_CGRAM 6 /* DB6: set CG RAM address */\r
+#define LCD_DDRAM 7 /* DB7: set DD RAM address */\r
+#define LCD_BUSY 7 /* DB7: LCD is busy */\r
+\r
+/* set entry mode: display shift on/off, dec/inc cursor move direction */\r
+#define LCD_ENTRY_DEC 0x04 /* display shift off, dec cursor move dir */\r
+#define LCD_ENTRY_DEC_SHIFT 0x05 /* display shift on, dec cursor move dir */\r
+#define LCD_ENTRY_INC_ 0x06 /* display shift off, inc cursor move dir */\r
+#define LCD_ENTRY_INC_SHIFT 0x07 /* display shift on, inc cursor move dir */\r
+\r
+/* display on/off, cursor on/off, blinking char at cursor position */\r
+#define LCD_DISP_OFF 0x08 /* display off */\r
+#define LCD_DISP_ON 0x0C /* display on, cursor off */\r
+#define LCD_DISP_ON_BLINK 0x0D /* display on, cursor off, blink char */\r
+#define LCD_DISP_ON_CURSOR 0x0E /* display on, cursor on */\r
+#define LCD_DISP_ON_CURSOR_BLINK 0x0F /* display on, cursor on, blink char */\r
+\r
+/* move cursor/shift display */\r
+#define LCD_MOVE_CURSOR_LEFT 0x10 /* move cursor left (decrement) */\r
+#define LCD_MOVE_CURSOR_RIGHT 0x14 /* move cursor right (increment) */\r
+#define LCD_MOVE_DISP_LEFT 0x18 /* shift display left */\r
+#define LCD_MOVE_DISP_RIGHT 0x1C /* shift display right */\r
+\r
+/* function set: set interface data length and number of display lines */\r
+#define LCD_FUNCTION_4BIT_1LINE 0x20 /* 4-bit interface, single line, 5x7 dots */\r
+#define LCD_FUNCTION_4BIT_2LINES 0x28 /* 4-bit interface, dual line, 5x7 dots */\r
+#define LCD_FUNCTION_8BIT_1LINE 0x30 /* 8-bit interface, single line, 5x7 dots */\r
+#define LCD_FUNCTION_8BIT_2LINES 0x38 /* 8-bit interface, dual line, 5x7 dots */\r
+\r
+\r
+#define LCD_MODE_DEFAULT ((1<<LCD_ENTRY_MODE) | (1<<LCD_ENTRY_INC) )\r
+\r
+\r
+\r
+/** \r
+ * @name Functions\r
+ */\r
+\r
+\r
+/**\r
+ @brief Initialize display and select type of cursor\r
+ @param dispAttr \b LCD_DISP_OFF display off\n\r
+ \b LCD_DISP_ON display on, cursor off\n\r
+ \b LCD_DISP_ON_CURSOR display on, cursor on\n\r
+ \b LCD_DISP_ON_CURSOR_BLINK display on, cursor on flashing \r
+ @return none\r
+*/\r
+extern void lcd_init(uint8_t dispAttr);\r
+\r
+\r
+/**\r
+ @brief Clear display and set cursor to home position\r
+ @param void \r
+ @return none\r
+*/\r
+extern void lcd_clrscr(void);\r
+\r
+\r
+/**\r
+ @brief Set cursor to home position\r
+ @param void \r
+ @return none\r
+*/\r
+extern void lcd_home(void);\r
+\r
+\r
+/**\r
+ @brief Set cursor to specified position\r
+ \r
+ @param x horizontal position\n (0: left most position)\r
+ @param y vertical position\n (0: first line)\r
+ @return none\r
+*/\r
+extern void lcd_gotoxy(uint8_t x, uint8_t y);\r
+\r
+\r
+/**\r
+ @brief Display character at current cursor position\r
+ @param c character to be displayed \r
+ @return none\r
+*/\r
+extern void lcd_putc(char c);\r
+\r
+\r
+/**\r
+ @brief Display string without auto linefeed\r
+ @param s string to be displayed \r
+ @return none\r
+*/\r
+extern void lcd_puts(const char *s);\r
+\r
+\r
+/**\r
+ @brief Display string from program memory without auto linefeed\r
+ @param s string from program memory be be displayed \r
+ @return none\r
+ @see lcd_puts_P\r
+*/\r
+extern void lcd_puts_p(const char *progmem_s);\r
+\r
+\r
+/**\r
+ @brief Send LCD controller instruction command\r
+ @param cmd instruction to send to LCD controller, see HD44780 data sheet\r
+ @return none\r
+*/\r
+extern void lcd_command(uint8_t cmd);\r
+\r
+\r
+/**\r
+ @brief Send data byte to LCD controller \r
+ \r
+ Similar to lcd_putc(), but without interpreting LF\r
+ @param data byte to send to LCD controller, see HD44780 data sheet\r
+ @return none\r
+*/\r
+extern void lcd_data(uint8_t data);\r
+\r
+\r
+/**\r
+ @brief macros for automatically storing string constant in program memory\r
+*/\r
+#define lcd_puts_P(__s) lcd_puts_p(PSTR(__s))\r
+\r
+/*@}*/\r
+#endif //LCD_H\r
projects / fw / altos / blobdiff