bertos/drv/lcd_text.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 Generic text LCD driver (interface).
  34  *
  35  * \version $Id$
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  *
  39  * $WIZ$ module_name = "lcd_text"
  40  * $WIZ$ module_depends = "lcd_hd44", "timer", "formatwr"
  41  */
  42
  43 #ifndef DRV_LCD_H
  44 #define DRV_LCD_H
  45
  46 #include "lcd_hd44.h"
  47
  48 #include <cfg/macros.h>
  49 #include <cfg/compiler.h>
  50 #include <struct/list.h>
  51
  52 #include <stdarg.h> // vprintf()
  53
  54
  55 /* flags for lcd_printf() */
  56 #define LCD_NORMAL     0       /* Scrittura normale */
  57 #define LCD_FILL       BV(0)   /* Fill rest of line with spaces */
  58 #define LCD_CENTER     BV(1)   /* Center string in line */
  59 #define LCD_NOCURSOR   BV(2)   /* Scrittura senza spostamento cursore */
  60
  61 /** Special priority value for lcd_setLayerDepth(). */
  62 #define LAYER_HIDDEN   -127
  63
  64 /* Compute LCD address from x/y coordinates */
  65 #define LCD_POS(x,y)  ((lcdpos_t)((uint8_t)(x) + (uint8_t)(y) * (uint8_t)LCD_COLS))
  66 #define LCD_ROW0  (LCD_COLS * 0)
  67 #define LCD_ROW1  (LCD_COLS * 1)
  68 #define LCD_ROW2  (LCD_COLS * 2)
  69 #define LCD_ROW3  (LCD_COLS * 3)
  70
  71 /**
  72  * Overwrapping layer context.
  73  */
  74 typedef struct _Layer
  75 {
  76         /**
  77          * Active layers are linked together in a list
  78          * sorted in top to bottom order.
  79          */
  80         DECLARE_NODE_ANON(struct _Layer)
  81
  82         /** Current XY address into this layer, for write operations. */
  83         lcdpos_t addr;
  84
  85         /** Priority of this layer (greater in front of lesser). */
  86         char pri;
  87
  88         /**
  89          * Layer backing store buffer.
  90          *
  91          * All writes through the layer are copied into this buffer.
  92          * Characters cells with value 0 are transparent with respect
  93          * to other layers in the background.
  94          */
  95         char buf[LCD_COLS * LCD_ROWS];
  96 } Layer;
  97
  98
  99 /* Global variables */
 100 extern Layer *lcd_DefLayer;
 101
 102 /* Function prototypes */
 103 extern void lcd_init(void);
 104 extern void lcd_test(void);
 105
 106 extern void lcd_moveCursor(lcdpos_t addr);
 107 extern char lcd_setCursor(char state);
 108
 109 extern void lcd_setAddr(Layer *layer, lcdpos_t addr);
 110 extern void lcd_putChar(char c, Layer *layer);
 111 extern int  lcd_vprintf(Layer *layer, lcdpos_t addr, uint8_t mode, const char *format, va_list ap) FORMAT(printf, 4, 0);
 112 extern int  lcd_printf(Layer *layer, lcdpos_t addr, uint8_t mode, const char *format, ...) FORMAT(printf, 4, 5);
 113 extern void lcd_clear(Layer *layer);
 114 extern void lcd_layerSet(Layer *layer, char c);
 115 extern void lcd_clearLine(Layer *layer, int y);
 116
 117 extern void lcd_setLayerDepth(Layer *layer, char pri);
 118 extern Layer *lcd_newLayer(char pri);
 119 extern void lcd_deleteLayer(Layer *layer);
 120 extern void lcd_lock(void);
 121 extern void lcd_unlock(void);
 122
 123 #endif /* DRV_LCD_H */