xref: /OK3568_Linux_fs/kernel/drivers/auxdisplay/charlcd.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Character LCD driver for Linux
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2000-2008, Willy Tarreau <w@1wt.eu>
6*4882a593Smuzhiyun  * Copyright (C) 2016-2017 Glider bvba
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef _CHARLCD_H
10*4882a593Smuzhiyun #define _CHARLCD_H
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun struct charlcd {
13*4882a593Smuzhiyun 	const struct charlcd_ops *ops;
14*4882a593Smuzhiyun 	const unsigned char *char_conv;	/* Optional */
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun 	int ifwidth;			/* 4-bit or 8-bit (default) */
17*4882a593Smuzhiyun 	int height;
18*4882a593Smuzhiyun 	int width;
19*4882a593Smuzhiyun 	int bwidth;			/* Default set by charlcd_alloc() */
20*4882a593Smuzhiyun 	int hwidth;			/* Default set by charlcd_alloc() */
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun 	void *drvdata;			/* Set by charlcd_alloc() */
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun struct charlcd_ops {
26*4882a593Smuzhiyun 	/* Required */
27*4882a593Smuzhiyun 	void (*write_cmd)(struct charlcd *lcd, int cmd);
28*4882a593Smuzhiyun 	void (*write_data)(struct charlcd *lcd, int data);
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun 	/* Optional */
31*4882a593Smuzhiyun 	void (*write_cmd_raw4)(struct charlcd *lcd, int cmd);	/* 4-bit only */
32*4882a593Smuzhiyun 	void (*clear_fast)(struct charlcd *lcd);
33*4882a593Smuzhiyun 	void (*backlight)(struct charlcd *lcd, int on);
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun struct charlcd *charlcd_alloc(unsigned int drvdata_size);
37*4882a593Smuzhiyun void charlcd_free(struct charlcd *lcd);
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun int charlcd_register(struct charlcd *lcd);
40*4882a593Smuzhiyun int charlcd_unregister(struct charlcd *lcd);
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun void charlcd_poke(struct charlcd *lcd);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #endif /* CHARLCD_H */
45