include/linux/cfag12864b.h

   1 /*
   2  *    Filename: cfag12864b.h
   3  *     Version: 0.1.0
   4  * Description: cfag12864b LCD driver header
   5  *     License: GPLv2
   6  *
   7  *      Author: Copyright (C) Miguel Ojeda Sandonis
   8  *        Date: 2006-10-12
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License version 2 as
  12  *  published by the Free Software Foundation.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #ifndef _CFAG12864B_H_
  26 #define _CFAG12864B_H_
  27
  28 #define CFAG12864B_WIDTH        (128)
  29 #define CFAG12864B_HEIGHT       (64)
  30 #define CFAG12864B_CONTROLLERS  (2)
  31 #define CFAG12864B_PAGES        (8)
  32 #define CFAG12864B_ADDRESSES    (64)
  33 #define CFAG12864B_SIZE         ((CFAG12864B_CONTROLLERS) * \
  34                                 (CFAG12864B_PAGES) * \
  35                                 (CFAG12864B_ADDRESSES))
  36
  37 /*
  38  * The driver will blit this buffer to the LCD
  39  *
  40  * Its size is CFAG12864B_SIZE.
  41  */
  42 extern unsigned char * cfag12864b_buffer;
  43
  44 /*
  45  * Get the refresh rate of the LCD
  46  *
  47  * Returns the refresh rate (hertz).
  48  */
  49 extern unsigned int cfag12864b_getrate(void);
  50
  51 /*
  52  * Enable refreshing
  53  *
  54  * Returns 0 if successful (anyone was using it),
  55  * or != 0 if failed (someone is using it).
  56  */
  57 extern unsigned char cfag12864b_enable(void);
  58
  59 /*
  60  * Disable refreshing
  61  *
  62  * You should call this only when you finish using the LCD.
  63  */
  64 extern void cfag12864b_disable(void);
  65
  66 /*
  67  * Is enabled refreshing? (is anyone using the module?)
  68  *
  69  * Returns 0 if refreshing is not enabled (anyone is using it),
  70  * or != 0 if refreshing is enabled (someone is using it).
  71  *
  72  * Useful for buffer read-only modules.
  73  */
  74 extern unsigned char cfag12864b_isenabled(void);
  75
  76 /*
  77  * Is the module inited?
  78  */
  79 extern unsigned char cfag12864b_isinited(void);
  80
  81 #endif /* _CFAG12864B_H_ */
  82