bertos/drv/lcd_hd44.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Hitachi HD44780 and clones LCD module.
  34  *
  35  * \author Bernie Innocenti <bernie@codewiz.org>
  36  * \author Stefano Fedrigo <aleph@develer.com>
  37  *
  38  * $WIZ$ module_name = "lcd_hd44"
  39  * $WIZ$ module_depends = "timer"
  40  * $WIZ$ module_configuration = "bertos/cfg/cfg_lcd_hd44.h"
  41  * $WIZ$ module_hw = "bertos/hw/hw_lcd_hd44.h"
  42  */
  43
  44 #ifndef DRV_LCD_HD44_H
  45 #define DRV_LCD_HD44_H
  46
  47 #include "cfg/cfg_lcd_hd44.h"
  48 #include <cfg/compiler.h> /* For stdint types */
  49
  50 /**
  51  * \name Display dimensions (in chars)
  52  * \{
  53  */
  54 #define LCD_ROWS  2
  55 #define LCD_COLS  16
  56 /* \} */
  57
  58 /**
  59  * \name Hitachi HD44 commands.
  60  * \{
  61  */
  62 #define LCD_CMD_DISPLAY_INI      0x30
  63
  64 #if CONFIG_LCD_4BIT
  65         #define LCD_CMD_SETFUNC  0x28   /**< 4 bits, 2 lines, 5x7 dots */
  66 #else
  67         #define LCD_CMD_SETFUNC  0x38   /**< 8 bits, 2 lines, 5x7 dots */
  68 #endif
  69
  70 #define LCD_CMD_DISPLAY_ON       0x0F   /**< Switch on display */
  71 #define LCD_CMD_DISPLAY_OFF      0x08   /**< Switch off display */
  72 #define LCD_CMD_CLEAR            0x01   /**< Clear display */
  73 #define LCD_CMD_CURSOR_BLOCK     0x0D   /**< Show cursor (block) */
  74 #define LCD_CMD_CURSOR_LINE      0x0F   /**< Show cursor (line) */
  75 #define LCD_CMD_CURSOR_OFF       0x0C   /**< Hide cursor */
  76 #define LCD_CMD_DISPLAYMODE      0x06
  77 #define LCD_CMD_SET_CGRAMADDR    0x40
  78 #define LCD_CMD_RESET_DDRAM      0x80
  79 #define LCD_CMD_SET_DDRAMADDR    0x80
  80 #define LCD_CMD_DISPLAY_SHIFT    0x18
  81 #define LCD_CMD_MOVESHIFT_LEFT   0x00
  82 #define LCD_CMD_MOVESHIFT_RIGHT  0x04
  83 /*\}*/
  84
  85 /** Type for combined LCD cursor position (x,y). */
  86 typedef uint8_t lcdpos_t;
  87
  88 void lcd_waitBusy(void);
  89 void lcd_moveTo(uint8_t addr);
  90 void lcd_setReg(uint8_t val);
  91 void lcd_putc(uint8_t a, uint8_t c);
  92 void lcd_remapChar(const char *glyph, char code);
  93 void lcd_hw_init(void);
  94 void lcd_hw_test(void);
  95
  96 #endif /* DRV_LCD_HD44_H */