1 /*
2  * BRIEF MODULE DESCRIPTION
3  *	Hardware definitions for the Au1100 LCD controller
4  *
5  * Copyright 2002 MontaVista Software
6  * Copyright 2002 Alchemy Semiconductor
7  * Author:	Alchemy Semiconductor, MontaVista Software
8  *
9  *  This program is free software; you can redistribute	 it and/or modify it
10  *  under  the terms of	 the GNU General  Public License as published by the
11  *  Free Software Foundation;  either version 2 of the	License, or (at your
12  *  option) any later version.
13  *
14  *  THIS  SOFTWARE  IS PROVIDED	  ``AS	IS'' AND   ANY	EXPRESS OR IMPLIED
15  *  WARRANTIES,	  INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
16  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
17  *  NO	EVENT  SHALL   THE AUTHOR  BE	 LIABLE FOR ANY	  DIRECT, INDIRECT,
18  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  *  NOT LIMITED	  TO, PROCUREMENT OF  SUBSTITUTE GOODS	OR SERVICES; LOSS OF
20  *  USE, DATA,	OR PROFITS; OR	BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  *  ANY THEORY OF LIABILITY, WHETHER IN	 CONTRACT, STRICT LIABILITY, OR TORT
22  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  *  You should have received a copy of the  GNU General Public License along
26  *  with this program; if not, write  to the Free Software Foundation, Inc.,
27  *  675 Mass Ave, Cambridge, MA 02139, USA.
28  */
29 
30 #ifndef _AU1100LCD_H
31 #define _AU1100LCD_H
32 
33 #include <asm/mach-au1x00/au1000.h>
34 
35 #define print_err(f, arg...) printk(KERN_ERR DRIVER_NAME ": " f "\n", ## arg)
36 #define print_warn(f, arg...) printk(KERN_WARNING DRIVER_NAME ": " f "\n", ## arg)
37 #define print_info(f, arg...) printk(KERN_INFO DRIVER_NAME ": " f "\n", ## arg)
38 
39 #if DEBUG
40 #define print_dbg(f, arg...) printk(__FILE__ ": " f "\n", ## arg)
41 #else
42 #define print_dbg(f, arg...) do {} while (0)
43 #endif
44 
45 #if defined(__BIG_ENDIAN)
46 #define LCD_CONTROL_DEFAULT_PO LCD_CONTROL_PO_11
47 #else
48 #define LCD_CONTROL_DEFAULT_PO LCD_CONTROL_PO_00
49 #endif
50 #define LCD_CONTROL_DEFAULT_SBPPF LCD_CONTROL_SBPPF_565
51 
52 /********************************************************************/
53 
54 /* LCD controller restrictions */
55 #define AU1100_LCD_MAX_XRES	800
56 #define AU1100_LCD_MAX_YRES	600
57 #define AU1100_LCD_MAX_BPP	16
58 #define AU1100_LCD_MAX_CLK	48000000
59 #define AU1100_LCD_NBR_PALETTE_ENTRIES 256
60 
61 /* Default number of visible screen buffer to allocate */
62 #define AU1100FB_NBR_VIDEO_BUFFERS 4
63 
64 /********************************************************************/
65 
66 struct au1100fb_panel
67 {
68 	const char name[25];		/* Full name <vendor>_<model> */
69 
70 	u32   	control_base;		/* Mode-independent control values */
71 	u32	clkcontrol_base;	/* Panel pixclock preferences */
72 
73 	u32	horztiming;
74 	u32	verttiming;
75 
76 	u32	xres;		/* Maximum horizontal resolution */
77 	u32 	yres;		/* Maximum vertical resolution */
78 	u32 	bpp;		/* Maximum depth supported */
79 };
80 
81 struct au1100fb_regs
82 {
83 	u32  lcd_control;
84 	u32  lcd_intstatus;
85 	u32  lcd_intenable;
86 	u32  lcd_horztiming;
87 	u32  lcd_verttiming;
88 	u32  lcd_clkcontrol;
89 	u32  lcd_dmaaddr0;
90 	u32  lcd_dmaaddr1;
91 	u32  lcd_words;
92 	u32  lcd_pwmdiv;
93 	u32  lcd_pwmhi;
94 	u32  reserved[(0x0400-0x002C)/4];
95 	u32  lcd_palettebase[256];
96 };
97 
98 struct au1100fb_device {
99 
100 	struct fb_info info;			/* FB driver info record */
101 
102 	struct au1100fb_panel 	*panel;		/* Panel connected to this device */
103 
104 	struct au1100fb_regs* 	regs;		/* Registers memory map */
105 	size_t       		regs_len;
106 	unsigned int 		regs_phys;
107 
108 	unsigned char* 		fb_mem;		/* FrameBuffer memory map */
109 	size_t	      		fb_len;
110 	dma_addr_t    		fb_phys;
111 	int			panel_idx;
112 	struct clk		*lcdclk;
113 	struct device		*dev;
114 };
115 
116 /********************************************************************/
117 
118 #define LCD_CONTROL                (AU1100_LCD_BASE + 0x0)
119   #define LCD_CONTROL_SBB_BIT      21
120   #define LCD_CONTROL_SBB_MASK     (0x3 << LCD_CONTROL_SBB_BIT)
121     #define LCD_CONTROL_SBB_1        (0 << LCD_CONTROL_SBB_BIT)
122     #define LCD_CONTROL_SBB_2        (1 << LCD_CONTROL_SBB_BIT)
123     #define LCD_CONTROL_SBB_3        (2 << LCD_CONTROL_SBB_BIT)
124     #define LCD_CONTROL_SBB_4        (3 << LCD_CONTROL_SBB_BIT)
125   #define LCD_CONTROL_SBPPF_BIT    18
126   #define LCD_CONTROL_SBPPF_MASK   (0x7 << LCD_CONTROL_SBPPF_BIT)
127     #define LCD_CONTROL_SBPPF_655    (0 << LCD_CONTROL_SBPPF_BIT)
128     #define LCD_CONTROL_SBPPF_565    (1 << LCD_CONTROL_SBPPF_BIT)
129     #define LCD_CONTROL_SBPPF_556    (2 << LCD_CONTROL_SBPPF_BIT)
130     #define LCD_CONTROL_SBPPF_1555   (3 << LCD_CONTROL_SBPPF_BIT)
131     #define LCD_CONTROL_SBPPF_5551   (4 << LCD_CONTROL_SBPPF_BIT)
132   #define LCD_CONTROL_WP           (1<<17)
133   #define LCD_CONTROL_WD           (1<<16)
134   #define LCD_CONTROL_C            (1<<15)
135   #define LCD_CONTROL_SM_BIT       13
136   #define LCD_CONTROL_SM_MASK      (0x3 << LCD_CONTROL_SM_BIT)
137     #define LCD_CONTROL_SM_0         (0 << LCD_CONTROL_SM_BIT)
138     #define LCD_CONTROL_SM_90        (1 << LCD_CONTROL_SM_BIT)
139     #define LCD_CONTROL_SM_180       (2 << LCD_CONTROL_SM_BIT)
140     #define LCD_CONTROL_SM_270       (3 << LCD_CONTROL_SM_BIT)
141   #define LCD_CONTROL_DB           (1<<12)
142   #define LCD_CONTROL_CCO          (1<<11)
143   #define LCD_CONTROL_DP           (1<<10)
144   #define LCD_CONTROL_PO_BIT       8
145   #define LCD_CONTROL_PO_MASK      (0x3 << LCD_CONTROL_PO_BIT)
146     #define LCD_CONTROL_PO_00        (0 << LCD_CONTROL_PO_BIT)
147     #define LCD_CONTROL_PO_01        (1 << LCD_CONTROL_PO_BIT)
148     #define LCD_CONTROL_PO_10        (2 << LCD_CONTROL_PO_BIT)
149     #define LCD_CONTROL_PO_11        (3 << LCD_CONTROL_PO_BIT)
150   #define LCD_CONTROL_MPI          (1<<7)
151   #define LCD_CONTROL_PT           (1<<6)
152   #define LCD_CONTROL_PC           (1<<5)
153   #define LCD_CONTROL_BPP_BIT      1
154   #define LCD_CONTROL_BPP_MASK     (0x7 << LCD_CONTROL_BPP_BIT)
155     #define LCD_CONTROL_BPP_1        (0 << LCD_CONTROL_BPP_BIT)
156     #define LCD_CONTROL_BPP_2        (1 << LCD_CONTROL_BPP_BIT)
157     #define LCD_CONTROL_BPP_4        (2 << LCD_CONTROL_BPP_BIT)
158     #define LCD_CONTROL_BPP_8        (3 << LCD_CONTROL_BPP_BIT)
159     #define LCD_CONTROL_BPP_12       (4 << LCD_CONTROL_BPP_BIT)
160     #define LCD_CONTROL_BPP_16       (5 << LCD_CONTROL_BPP_BIT)
161   #define LCD_CONTROL_GO           (1<<0)
162 
163 #define LCD_INTSTATUS              (AU1100_LCD_BASE + 0x4)
164 #define LCD_INTENABLE              (AU1100_LCD_BASE + 0x8)
165   #define LCD_INT_SD               (1<<7)
166   #define LCD_INT_OF               (1<<6)
167   #define LCD_INT_UF               (1<<5)
168   #define LCD_INT_SA               (1<<3)
169   #define LCD_INT_SS               (1<<2)
170   #define LCD_INT_S1               (1<<1)
171   #define LCD_INT_S0               (1<<0)
172 
173 #define LCD_HORZTIMING             (AU1100_LCD_BASE + 0xC)
174   #define LCD_HORZTIMING_HN2_BIT   24
175   #define LCD_HORZTIMING_HN2_MASK  (0xFF << LCD_HORZTIMING_HN2_BIT)
176   #define LCD_HORZTIMING_HN2_N(N)  ((((N)-1) << LCD_HORZTIMING_HN2_BIT) & LCD_HORZTIMING_HN2_MASK)
177   #define LCD_HORZTIMING_HN1_BIT   16
178   #define LCD_HORZTIMING_HN1_MASK  (0xFF << LCD_HORZTIMING_HN1_BIT)
179   #define LCD_HORZTIMING_HN1_N(N)  ((((N)-1) << LCD_HORZTIMING_HN1_BIT) & LCD_HORZTIMING_HN1_MASK)
180   #define LCD_HORZTIMING_HPW_BIT   10
181   #define LCD_HORZTIMING_HPW_MASK  (0x3F << LCD_HORZTIMING_HPW_BIT)
182   #define LCD_HORZTIMING_HPW_N(N)  ((((N)-1) << LCD_HORZTIMING_HPW_BIT) & LCD_HORZTIMING_HPW_MASK)
183   #define LCD_HORZTIMING_PPL_BIT   0
184   #define LCD_HORZTIMING_PPL_MASK  (0x3FF << LCD_HORZTIMING_PPL_BIT)
185   #define LCD_HORZTIMING_PPL_N(N)  ((((N)-1) << LCD_HORZTIMING_PPL_BIT) & LCD_HORZTIMING_PPL_MASK)
186 
187 #define LCD_VERTTIMING             (AU1100_LCD_BASE + 0x10)
188   #define LCD_VERTTIMING_VN2_BIT   24
189   #define LCD_VERTTIMING_VN2_MASK  (0xFF << LCD_VERTTIMING_VN2_BIT)
190   #define LCD_VERTTIMING_VN2_N(N)  ((((N)-1) << LCD_VERTTIMING_VN2_BIT) & LCD_VERTTIMING_VN2_MASK)
191   #define LCD_VERTTIMING_VN1_BIT   16
192   #define LCD_VERTTIMING_VN1_MASK  (0xFF << LCD_VERTTIMING_VN1_BIT)
193   #define LCD_VERTTIMING_VN1_N(N)  ((((N)-1) << LCD_VERTTIMING_VN1_BIT) & LCD_VERTTIMING_VN1_MASK)
194   #define LCD_VERTTIMING_VPW_BIT   10
195   #define LCD_VERTTIMING_VPW_MASK  (0x3F << LCD_VERTTIMING_VPW_BIT)
196   #define LCD_VERTTIMING_VPW_N(N)  ((((N)-1) << LCD_VERTTIMING_VPW_BIT) & LCD_VERTTIMING_VPW_MASK)
197   #define LCD_VERTTIMING_LPP_BIT   0
198   #define LCD_VERTTIMING_LPP_MASK  (0x3FF << LCD_VERTTIMING_LPP_BIT)
199   #define LCD_VERTTIMING_LPP_N(N)  ((((N)-1) << LCD_VERTTIMING_LPP_BIT) & LCD_VERTTIMING_LPP_MASK)
200 
201 #define LCD_CLKCONTROL             (AU1100_LCD_BASE + 0x14)
202   #define LCD_CLKCONTROL_IB        (1<<18)
203   #define LCD_CLKCONTROL_IC        (1<<17)
204   #define LCD_CLKCONTROL_IH        (1<<16)
205   #define LCD_CLKCONTROL_IV        (1<<15)
206   #define LCD_CLKCONTROL_BF_BIT    10
207   #define LCD_CLKCONTROL_BF_MASK   (0x1F << LCD_CLKCONTROL_BF_BIT)
208   #define LCD_CLKCONTROL_BF_N(N)   ((((N)-1) << LCD_CLKCONTROL_BF_BIT) & LCD_CLKCONTROL_BF_MASK)
209   #define LCD_CLKCONTROL_PCD_BIT   0
210   #define LCD_CLKCONTROL_PCD_MASK  (0x3FF << LCD_CLKCONTROL_PCD_BIT)
211   #define LCD_CLKCONTROL_PCD_N(N)  (((N) << LCD_CLKCONTROL_PCD_BIT) & LCD_CLKCONTROL_PCD_MASK)
212 
213 #define LCD_DMAADDR0               (AU1100_LCD_BASE + 0x18)
214 #define LCD_DMAADDR1               (AU1100_LCD_BASE + 0x1C)
215   #define LCD_DMA_SA_BIT           5
216   #define LCD_DMA_SA_MASK          (0x7FFFFFF << LCD_DMA_SA_BIT)
217   #define LCD_DMA_SA_N(N)          ((N) & LCD_DMA_SA_MASK)
218 
219 #define LCD_WORDS                  (AU1100_LCD_BASE + 0x20)
220   #define LCD_WRD_WRDS_BIT         0
221   #define LCD_WRD_WRDS_MASK        (0xFFFFFFFF << LCD_WRD_WRDS_BIT)
222   #define LCD_WRD_WRDS_N(N)        ((((N)-1) << LCD_WRD_WRDS_BIT) & LCD_WRD_WRDS_MASK)
223 
224 #define LCD_PWMDIV                 (AU1100_LCD_BASE + 0x24)
225   #define LCD_PWMDIV_EN            (1<<12)
226   #define LCD_PWMDIV_PWMDIV_BIT    0
227   #define LCD_PWMDIV_PWMDIV_MASK   (0xFFF << LCD_PWMDIV_PWMDIV_BIT)
228   #define LCD_PWMDIV_PWMDIV_N(N)   ((((N)-1) << LCD_PWMDIV_PWMDIV_BIT) & LCD_PWMDIV_PWMDIV_MASK)
229 
230 #define LCD_PWMHI                  (AU1100_LCD_BASE + 0x28)
231   #define LCD_PWMHI_PWMHI1_BIT     12
232   #define LCD_PWMHI_PWMHI1_MASK    (0xFFF << LCD_PWMHI_PWMHI1_BIT)
233   #define LCD_PWMHI_PWMHI1_N(N)    (((N) << LCD_PWMHI_PWMHI1_BIT) & LCD_PWMHI_PWMHI1_MASK)
234   #define LCD_PWMHI_PWMHI0_BIT     0
235   #define LCD_PWMHI_PWMHI0_MASK    (0xFFF << LCD_PWMHI_PWMHI0_BIT)
236   #define LCD_PWMHI_PWMHI0_N(N)    (((N) << LCD_PWMHI_PWMHI0_BIT) & LCD_PWMHI_PWMHI0_MASK)
237 
238 #define LCD_PALLETTEBASE                (AU1100_LCD_BASE + 0x400)
239   #define LCD_PALLETTE_MONO_MI_BIT      0
240   #define LCD_PALLETTE_MONO_MI_MASK     (0xF << LCD_PALLETTE_MONO_MI_BIT)
241   #define LCD_PALLETTE_MONO_MI_N(N)     (((N)<< LCD_PALLETTE_MONO_MI_BIT) & LCD_PALLETTE_MONO_MI_MASK)
242 
243   #define LCD_PALLETTE_COLOR_RI_BIT     8
244   #define LCD_PALLETTE_COLOR_RI_MASK    (0xF << LCD_PALLETTE_COLOR_RI_BIT)
245   #define LCD_PALLETTE_COLOR_RI_N(N)    (((N)<< LCD_PALLETTE_COLOR_RI_BIT) & LCD_PALLETTE_COLOR_RI_MASK)
246   #define LCD_PALLETTE_COLOR_GI_BIT     4
247   #define LCD_PALLETTE_COLOR_GI_MASK    (0xF << LCD_PALLETTE_COLOR_GI_BIT)
248   #define LCD_PALLETTE_COLOR_GI_N(N)    (((N)<< LCD_PALLETTE_COLOR_GI_BIT) & LCD_PALLETTE_COLOR_GI_MASK)
249   #define LCD_PALLETTE_COLOR_BI_BIT     0
250   #define LCD_PALLETTE_COLOR_BI_MASK    (0xF << LCD_PALLETTE_COLOR_BI_BIT)
251   #define LCD_PALLETTE_COLOR_BI_N(N)    (((N)<< LCD_PALLETTE_COLOR_BI_BIT) & LCD_PALLETTE_COLOR_BI_MASK)
252 
253   #define LCD_PALLETTE_TFT_DC_BIT       0
254   #define LCD_PALLETTE_TFT_DC_MASK      (0xFFFF << LCD_PALLETTE_TFT_DC_BIT)
255   #define LCD_PALLETTE_TFT_DC_N(N)      (((N)<< LCD_PALLETTE_TFT_DC_BIT) & LCD_PALLETTE_TFT_DC_MASK)
256 
257 /********************************************************************/
258 
259 /* List of panels known to work with the AU1100 LCD controller.
260  * To add a new panel, enter the same specifications as the
261  * Generic_TFT one, and MAKE SURE that it doesn't conflicts
262  * with the controller restrictions. Restrictions are:
263  *
264  * STN color panels: max_bpp <= 12
265  * STN mono panels: max_bpp <= 4
266  * TFT panels: max_bpp <= 16
267  * max_xres <= 800
268  * max_yres <= 600
269  */
270 static struct au1100fb_panel known_lcd_panels[] =
271 {
272 	/* 800x600x16bpp CRT */
273 	[0] = {
274 		.name = "CRT_800x600_16",
275 		.xres = 800,
276 		.yres = 600,
277 		.bpp = 16,
278 		.control_base =	0x0004886A |
279 			LCD_CONTROL_DEFAULT_PO | LCD_CONTROL_DEFAULT_SBPPF |
280 			LCD_CONTROL_BPP_16 | LCD_CONTROL_SBB_4,
281 		.clkcontrol_base = 0x00020000,
282 		.horztiming = 0x005aff1f,
283 		.verttiming = 0x16000e57,
284 	},
285 	/* just the standard LCD */
286 	[1] = {
287 		.name = "WWPC LCD",
288 		.xres = 240,
289 		.yres = 320,
290 		.bpp = 16,
291 		.control_base = 0x0006806A,
292 		.horztiming = 0x0A1010EF,
293 		.verttiming = 0x0301013F,
294 		.clkcontrol_base = 0x00018001,
295 	},
296 	/* Sharp 320x240 TFT panel */
297 	[2] = {
298 		.name = "Sharp_LQ038Q5DR01",
299 		.xres = 320,
300 		.yres = 240,
301 		.bpp = 16,
302 		.control_base =
303 		( LCD_CONTROL_SBPPF_565
304 		| LCD_CONTROL_C
305 		| LCD_CONTROL_SM_0
306 			| LCD_CONTROL_DEFAULT_PO
307 		| LCD_CONTROL_PT
308 		| LCD_CONTROL_PC
309 		| LCD_CONTROL_BPP_16 ),
310 		.horztiming =
311 		( LCD_HORZTIMING_HN2_N(8)
312 		| LCD_HORZTIMING_HN1_N(60)
313 		| LCD_HORZTIMING_HPW_N(12)
314 		| LCD_HORZTIMING_PPL_N(320) ),
315 		.verttiming =
316 		( LCD_VERTTIMING_VN2_N(5)
317 		| LCD_VERTTIMING_VN1_N(17)
318 		| LCD_VERTTIMING_VPW_N(1)
319 		| LCD_VERTTIMING_LPP_N(240) ),
320 		.clkcontrol_base = LCD_CLKCONTROL_PCD_N(1),
321 	},
322 
323 	/* Hitachi SP14Q005 and possibly others */
324 	[3] = {
325 		.name = "Hitachi_SP14Qxxx",
326 		.xres = 320,
327 		.yres = 240,
328 		.bpp = 4,
329 		.control_base =
330 			( LCD_CONTROL_C
331 			| LCD_CONTROL_BPP_4 ),
332 		.horztiming =
333 			( LCD_HORZTIMING_HN2_N(1)
334 			| LCD_HORZTIMING_HN1_N(1)
335 			| LCD_HORZTIMING_HPW_N(1)
336 			| LCD_HORZTIMING_PPL_N(320) ),
337 		.verttiming =
338 			( LCD_VERTTIMING_VN2_N(1)
339 			| LCD_VERTTIMING_VN1_N(1)
340 			| LCD_VERTTIMING_VPW_N(1)
341 			| LCD_VERTTIMING_LPP_N(240) ),
342 		.clkcontrol_base = LCD_CLKCONTROL_PCD_N(4),
343 	},
344 
345 	/* Generic 640x480 TFT panel */
346 	[4] = {
347 		.name = "TFT_640x480_16",
348 		.xres = 640,
349 		.yres = 480,
350 		.bpp = 16,
351 		.control_base = 0x004806a | LCD_CONTROL_DEFAULT_PO,
352 		.horztiming = 0x3434d67f,
353 		.verttiming = 0x0e0e39df,
354 		.clkcontrol_base = LCD_CLKCONTROL_PCD_N(1),
355 	},
356 
357 	 /* Pb1100 LCDB 640x480 PrimeView TFT panel */
358 	[5] = {
359 		.name = "PrimeView_640x480_16",
360 		.xres = 640,
361 		.yres = 480,
362 		.bpp = 16,
363 		.control_base = 0x0004886a | LCD_CONTROL_DEFAULT_PO,
364 		.horztiming = 0x0e4bfe7f,
365 		.verttiming = 0x210805df,
366 		.clkcontrol_base = 0x00038001,
367 	},
368 };
369 
370 /********************************************************************/
371 
372 /* Inline helpers */
373 
374 #define panel_is_dual(panel)  (panel->control_base & LCD_CONTROL_DP)
375 #define panel_is_active(panel)(panel->control_base & LCD_CONTROL_PT)
376 #define panel_is_color(panel) (panel->control_base & LCD_CONTROL_PC)
377 #define panel_swap_rgb(panel) (panel->control_base & LCD_CONTROL_CCO)
378 
379 #endif /* _AU1100LCD_H */
380