hw/hw_lcd.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 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2001 Bernardo Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \version $Id$
  35  *
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  *
  39  * \brief LCD low-level hardware macros
  40  */
  41
  42 #ifndef HW_LCD_H
  43 #define HW_LCD_H
  44
  45 #include <appconfig.h>
  46 //#include <hw.h>
  47
  48 #include <cpu/attr.h>
  49 #include <cpu/irq.h>
  50 #include <cpu/types.h>
  51
  52 #include <cfg/macros.h> /* BV() */
  53 #include <cfg/debug.h>
  54
  55 #include <avr/io.h>
  56 #include <stdbool.h>
  57 #include <inttypes.h>
  58
  59 /**
  60  * \name LCD I/O pins/ports
  61  * @{
  62  */
  63 #define LCD_RS    BV(PG3)
  64 #define LCD_RW    BV(PG0)
  65 #define LCD_E     BV(PG2)
  66 #define LCD_DB0   BV(PA0)
  67 #define LCD_DB1   BV(PA1)
  68 #define LCD_DB2   BV(PA2)
  69 #define LCD_DB3   BV(PA3)
  70 #define LCD_DB4   BV(PA4)
  71 #define LCD_DB5   BV(PA5)
  72 #define LCD_DB6   BV(PA6)
  73 #define LCD_DB7   BV(PA7)
  74 /*@}*/
  75
  76 /**
  77  * \name DB high nibble (DB[4-7])
  78  * @{
  79  */
  80 #define LCD_PORT     PORTG
  81 #define LCD_DB_PORT  PORTA
  82 #define LCD_PIN      PING
  83 #define LCD_DB_PIN   PINA
  84 #define LCD_DDR      DDRG
  85 #define LCD_DB_DDR   DDRA
  86
  87 #if CONFIG_LCD_4BIT
  88         #define LCD_MASK    (LCD_DB7 | LCD_DB6 | LCD_DB5 | LCD_DB4)
  89         #define LCD_SHIFT   4
  90 #else
  91         #define LCD_MASK (uint8_t)0xff
  92         #define LCD_SHIFT 0
  93 #endif
  94 /*@}*/
  95
  96 /**
  97  * \name LCD bus control macros
  98  * @{
  99  */
 100 #define LCD_CLR_RS      (LCD_PORT &= ~LCD_RS)
 101 #define LCD_SET_RS      (LCD_PORT |=  LCD_RS)
 102 #define LCD_CLR_RD      (LCD_PORT &= ~LCD_RW)
 103 #define LCD_SET_RD      (LCD_PORT |=  LCD_RW)
 104 #define LCD_CLR_E       (LCD_PORT &= ~LCD_E)
 105 #define LCD_SET_E       (LCD_PORT |=  LCD_E)
 106
 107 #if CONFIG_LCD_4BIT
 108         #define LCD_WRITE_H(x)  (LCD_DB_PORT = (LCD_DB_PORT & ~LCD_MASK) | (((x) >> (4 - LCD_SHIFT)) & LCD_MASK))
 109         #define LCD_WRITE_L(x)  (LCD_DB_PORT = (LCD_DB_PORT & ~LCD_MASK) | (((x) << LCD_SHIFT) & LCD_MASK))
 110         #define LCD_READ_H      ((LCD_DB_PIN & LCD_MASK) >> (4 - LCD_SHIFT))
 111         #define LCD_READ_L      ((LCD_DB_PIN & LCD_MASK) >> LCD_SHIFT)
 112 #else
 113         #define LCD_WRITE(x) (LCD_DB_PORT = (x))
 114         #define LCD_READ (LCD_DB_PIN)
 115 #endif
 116 /*@}*/
 117
 118 /** Set data bus direction to output (write to display) */
 119 #define LCD_DB_OUT  (LCD_DB_DDR |= LCD_MASK)
 120
 121 /** Set data bus direction to input (read from display) */
 122 #define LCD_DB_IN   (LCD_DB_DDR &= ~LCD_MASK)
 123
 124 /** Delay for write (Enable pulse width, 220ns) */
 125 #define LCD_DELAY_WRITE \
 126         do { \
 127                 NOP; \
 128                 NOP; \
 129                 NOP; \
 130                 NOP; \
 131                 NOP; \
 132         } while (0)
 133
 134 /** Delay for read (Data ouput delay time, 120ns) */
 135 #define LCD_DELAY_READ \
 136         do { \
 137                 NOP; \
 138                 NOP; \
 139                 NOP; \
 140                 NOP; \
 141         } while (0)
 142
 143
 144 INLINE void lcd_bus_init(void)
 145 {
 146         cpuflags_t flags;
 147         IRQ_SAVE_DISABLE(flags);
 148
 149         LCD_PORT = (LCD_PORT & ~(LCD_E | LCD_RW)) | LCD_RS;
 150         LCD_DDR  |= LCD_RS | LCD_RW | LCD_E;
 151
 152         /*
 153          * Data bus is in output state most of the time:
 154          * LCD r/w functions assume it is left in output state
 155          */
 156         LCD_DB_OUT;
 157
 158
 159         IRQ_RESTORE(flags);
 160 }
 161
 162 #endif /* HW_LCD_H */