xref: /OK3568_Linux_fs/kernel/include/linux/cfag12864b.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *    Filename: cfag12864b.h
4*4882a593Smuzhiyun  *     Version: 0.1.0
5*4882a593Smuzhiyun  * Description: cfag12864b LCD driver header
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  *      Author: Copyright (C) Miguel Ojeda Sandonis
8*4882a593Smuzhiyun  *        Date: 2006-10-12
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef _CFAG12864B_H_
12*4882a593Smuzhiyun #define _CFAG12864B_H_
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define CFAG12864B_WIDTH	(128)
15*4882a593Smuzhiyun #define CFAG12864B_HEIGHT	(64)
16*4882a593Smuzhiyun #define CFAG12864B_CONTROLLERS	(2)
17*4882a593Smuzhiyun #define CFAG12864B_PAGES	(8)
18*4882a593Smuzhiyun #define CFAG12864B_ADDRESSES	(64)
19*4882a593Smuzhiyun #define CFAG12864B_SIZE		((CFAG12864B_CONTROLLERS) * \
20*4882a593Smuzhiyun 				(CFAG12864B_PAGES) * \
21*4882a593Smuzhiyun 				(CFAG12864B_ADDRESSES))
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun /*
24*4882a593Smuzhiyun  * The driver will blit this buffer to the LCD
25*4882a593Smuzhiyun  *
26*4882a593Smuzhiyun  * Its size is CFAG12864B_SIZE.
27*4882a593Smuzhiyun  */
28*4882a593Smuzhiyun extern unsigned char * cfag12864b_buffer;
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun /*
31*4882a593Smuzhiyun  * Get the refresh rate of the LCD
32*4882a593Smuzhiyun  *
33*4882a593Smuzhiyun  * Returns the refresh rate (hertz).
34*4882a593Smuzhiyun  */
35*4882a593Smuzhiyun extern unsigned int cfag12864b_getrate(void);
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /*
38*4882a593Smuzhiyun  * Enable refreshing
39*4882a593Smuzhiyun  *
40*4882a593Smuzhiyun  * Returns 0 if successful (anyone was using it),
41*4882a593Smuzhiyun  * or != 0 if failed (someone is using it).
42*4882a593Smuzhiyun  */
43*4882a593Smuzhiyun extern unsigned char cfag12864b_enable(void);
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /*
46*4882a593Smuzhiyun  * Disable refreshing
47*4882a593Smuzhiyun  *
48*4882a593Smuzhiyun  * You should call this only when you finish using the LCD.
49*4882a593Smuzhiyun  */
50*4882a593Smuzhiyun extern void cfag12864b_disable(void);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun /*
53*4882a593Smuzhiyun  * Is enabled refreshing? (is anyone using the module?)
54*4882a593Smuzhiyun  *
55*4882a593Smuzhiyun  * Returns 0 if refreshing is not enabled (anyone is using it),
56*4882a593Smuzhiyun  * or != 0 if refreshing is enabled (someone is using it).
57*4882a593Smuzhiyun  *
58*4882a593Smuzhiyun  * Useful for buffer read-only modules.
59*4882a593Smuzhiyun  */
60*4882a593Smuzhiyun extern unsigned char cfag12864b_isenabled(void);
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /*
63*4882a593Smuzhiyun  * Is the module inited?
64*4882a593Smuzhiyun  */
65*4882a593Smuzhiyun extern unsigned char cfag12864b_isinited(void);
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun #endif /* _CFAG12864B_H_ */
68*4882a593Smuzhiyun 
69