xref: /linux-6.15/include/linux/sm501.h (revision cdc83ae2)
1 /* include/linux/sm501.h
2  *
3  * Copyright (c) 2006 Simtec Electronics
4  *	Ben Dooks <[email protected]>
5  *	Vincent Sanders <[email protected]>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20 
21 extern int sm501_unit_power(struct device *dev,
22 			    unsigned int unit, unsigned int to);
23 
24 extern unsigned long sm501_set_clock(struct device *dev,
25 				     int clksrc, unsigned long freq);
26 
27 extern unsigned long sm501_find_clock(struct device *dev,
28 				      int clksrc, unsigned long req_freq);
29 
30 /* sm501_misc_control
31  *
32  * Modify the SM501's MISC_CONTROL register
33 */
34 
35 extern int sm501_misc_control(struct device *dev,
36 			      unsigned long set, unsigned long clear);
37 
38 /* sm501_modify_reg
39  *
40  * Modify a register in the SM501 which may be shared with other
41  * drivers.
42 */
43 
44 extern unsigned long sm501_modify_reg(struct device *dev,
45 				      unsigned long reg,
46 				      unsigned long set,
47 				      unsigned long clear);
48 
49 /* sm501_gpio_set
50  *
51  * set the state of the given GPIO line
52 */
53 
54 extern void sm501_gpio_set(struct device *dev,
55 			   unsigned long gpio,
56 			   unsigned int to,
57 			   unsigned int dir);
58 
59 /* sm501_gpio_get
60  *
61  * get the state of the given GPIO line
62 */
63 
64 extern unsigned long sm501_gpio_get(struct device *dev,
65 				    unsigned long gpio);
66 
67 
68 /* Platform data definitions */
69 
70 #define SM501FB_FLAG_USE_INIT_MODE	(1<<0)
71 #define SM501FB_FLAG_DISABLE_AT_EXIT	(1<<1)
72 #define SM501FB_FLAG_USE_HWCURSOR	(1<<2)
73 #define SM501FB_FLAG_USE_HWACCEL	(1<<3)
74 #define SM501FB_FLAG_PANEL_NO_FPEN	(1<<4)
75 #define SM501FB_FLAG_PANEL_NO_VBIASEN	(1<<5)
76 
77 struct sm501_platdata_fbsub {
78 	struct fb_videomode	*def_mode;
79 	unsigned int		 def_bpp;
80 	unsigned long		 max_mem;
81 	unsigned int		 flags;
82 };
83 
84 enum sm501_fb_routing {
85 	SM501_FB_OWN		= 0,	/* CRT=>CRT, Panel=>Panel */
86 	SM501_FB_CRT_PANEL	= 1,	/* Panel=>CRT, Panel=>Panel */
87 };
88 
89 /* sm501_platdata_fb flag field bit definitions */
90 
91 #define SM501_FBPD_SWAP_FB_ENDIAN	(1<<0)	/* need to endian swap */
92 
93 /* sm501_platdata_fb
94  *
95  * configuration data for the framebuffer driver
96 */
97 
98 struct sm501_platdata_fb {
99 	enum sm501_fb_routing		 fb_route;
100 	unsigned int			 flags;
101 	struct sm501_platdata_fbsub	*fb_crt;
102 	struct sm501_platdata_fbsub	*fb_pnl;
103 };
104 
105 /* gpio i2c */
106 
107 struct sm501_platdata_gpio_i2c {
108 	unsigned int		pin_sda;
109 	unsigned int		pin_scl;
110 };
111 
112 /* sm501_initdata
113  *
114  * use for initialising values that may not have been setup
115  * before the driver is loaded.
116 */
117 
118 struct sm501_reg_init {
119 	unsigned long		set;
120 	unsigned long		mask;
121 };
122 
123 #define SM501_USE_USB_HOST	(1<<0)
124 #define SM501_USE_USB_SLAVE	(1<<1)
125 #define SM501_USE_SSP0		(1<<2)
126 #define SM501_USE_SSP1		(1<<3)
127 #define SM501_USE_UART0		(1<<4)
128 #define SM501_USE_UART1		(1<<5)
129 #define SM501_USE_FBACCEL	(1<<6)
130 #define SM501_USE_AC97		(1<<7)
131 #define SM501_USE_I2S		(1<<8)
132 
133 #define SM501_USE_ALL		(0xffffffff)
134 
135 struct sm501_initdata {
136 	struct sm501_reg_init	gpio_low;
137 	struct sm501_reg_init	gpio_high;
138 	struct sm501_reg_init	misc_timing;
139 	struct sm501_reg_init	misc_control;
140 
141 	unsigned long		devices;
142 	unsigned long		mclk;		/* non-zero to modify */
143 	unsigned long		m1xclk;		/* non-zero to modify */
144 };
145 
146 /* sm501_init_gpio
147  *
148  * default gpio settings
149 */
150 
151 struct sm501_init_gpio {
152 	struct sm501_reg_init	gpio_data_low;
153 	struct sm501_reg_init	gpio_data_high;
154 	struct sm501_reg_init	gpio_ddr_low;
155 	struct sm501_reg_init	gpio_ddr_high;
156 };
157 
158 /* sm501_platdata
159  *
160  * This is passed with the platform device to allow the board
161  * to control the behaviour of the SM501 driver(s) which attach
162  * to the device.
163  *
164 */
165 
166 struct sm501_platdata {
167 	struct sm501_initdata		*init;
168 	struct sm501_init_gpio		*init_gpiop;
169 	struct sm501_platdata_fb	*fb;
170 
171 	struct sm501_platdata_gpio_i2c	*gpio_i2c;
172 	unsigned int			 gpio_i2c_nr;
173 };
174