tests: add armv7 debug test and a register dumper
[pandora-misc.git] / omapfb.h
1 /*
2  * File: arch/arm/plat-omap/include/mach/omapfb.h
3  *
4  * Framebuffer driver for TI OMAP boards
5  *
6  * Copyright (C) 2004 Nokia Corporation
7  * Author: Imre Deak <imre.deak@nokia.com>
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 program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  */
23
24 #ifndef __OMAPFB_H
25 #define __OMAPFB_H
26
27 #include <asm/ioctl.h>
28 #include <asm/types.h>
29
30 /* IOCTL commands. */
31
32 #define OMAP_IOW(num, dtype)    _IOW('O', num, dtype)
33 #define OMAP_IOR(num, dtype)    _IOR('O', num, dtype)
34 #define OMAP_IOWR(num, dtype)   _IOWR('O', num, dtype)
35 #define OMAP_IO(num)            _IO('O', num)
36
37 #define OMAPFB_MIRROR           OMAP_IOW(31, int)
38 #define OMAPFB_SYNC_GFX         OMAP_IO(37)
39 #define OMAPFB_VSYNC            OMAP_IO(38)
40 #define OMAPFB_SET_UPDATE_MODE  OMAP_IOW(40, int)
41 #define OMAPFB_GET_CAPS         OMAP_IOR(42, struct omapfb_caps)
42 #define OMAPFB_GET_UPDATE_MODE  OMAP_IOW(43, int)
43 #define OMAPFB_LCD_TEST         OMAP_IOW(45, int)
44 #define OMAPFB_CTRL_TEST        OMAP_IOW(46, int)
45 #define OMAPFB_UPDATE_WINDOW_OLD OMAP_IOW(47, struct omapfb_update_window_old)
46 #define OMAPFB_SET_COLOR_KEY    OMAP_IOW(50, struct omapfb_color_key)
47 #define OMAPFB_GET_COLOR_KEY    OMAP_IOW(51, struct omapfb_color_key)
48 #define OMAPFB_SETUP_PLANE      OMAP_IOW(52, struct omapfb_plane_info)
49 #define OMAPFB_QUERY_PLANE      OMAP_IOW(53, struct omapfb_plane_info)
50 #define OMAPFB_UPDATE_WINDOW    OMAP_IOW(54, struct omapfb_update_window)
51 #define OMAPFB_SETUP_MEM        OMAP_IOW(55, struct omapfb_mem_info)
52 #define OMAPFB_QUERY_MEM        OMAP_IOW(56, struct omapfb_mem_info)
53 #define OMAPFB_WAITFORVSYNC     OMAP_IO(57)
54 #define OMAPFB_MEMORY_READ      OMAP_IOR(58, struct omapfb_memory_read)
55
56 #ifndef FBIO_WAITFORVSYNC
57 #define FBIO_WAITFORVSYNC       _IOW('F', 0x20, u_int32_t)
58 #endif
59
60 #define OMAPFB_CAPS_GENERIC_MASK        0x00000fff
61 #define OMAPFB_CAPS_LCDC_MASK           0x00fff000
62 #define OMAPFB_CAPS_PANEL_MASK          0xff000000
63
64 #define OMAPFB_CAPS_MANUAL_UPDATE       0x00001000
65 #define OMAPFB_CAPS_TEARSYNC            0x00002000
66 #define OMAPFB_CAPS_PLANE_RELOCATE_MEM  0x00004000
67 #define OMAPFB_CAPS_PLANE_SCALE         0x00008000
68 #define OMAPFB_CAPS_WINDOW_PIXEL_DOUBLE 0x00010000
69 #define OMAPFB_CAPS_WINDOW_SCALE        0x00020000
70 #define OMAPFB_CAPS_WINDOW_OVERLAY      0x00040000
71 #define OMAPFB_CAPS_WINDOW_ROTATE       0x00080000
72 #define OMAPFB_CAPS_SET_BACKLIGHT       0x01000000
73
74 /* Values from DSP must map to lower 16-bits */
75 #define OMAPFB_FORMAT_MASK              0x00ff
76 #define OMAPFB_FORMAT_FLAG_DOUBLE       0x0100
77 #define OMAPFB_FORMAT_FLAG_TEARSYNC     0x0200
78 #define OMAPFB_FORMAT_FLAG_FORCE_VSYNC  0x0400
79 #define OMAPFB_FORMAT_FLAG_ENABLE_OVERLAY       0x0800
80 #define OMAPFB_FORMAT_FLAG_DISABLE_OVERLAY      0x1000
81
82 #define OMAPFB_EVENT_READY      1
83 #define OMAPFB_EVENT_DISABLED   2
84
85 #define OMAPFB_MEMTYPE_SDRAM            0
86 #define OMAPFB_MEMTYPE_SRAM             1
87 #define OMAPFB_MEMTYPE_MAX              1
88
89 enum omapfb_color_format {
90         OMAPFB_COLOR_RGB565 = 0,
91         OMAPFB_COLOR_YUV422,
92         OMAPFB_COLOR_YUV420,
93         OMAPFB_COLOR_CLUT_8BPP,
94         OMAPFB_COLOR_CLUT_4BPP,
95         OMAPFB_COLOR_CLUT_2BPP,
96         OMAPFB_COLOR_CLUT_1BPP,
97         OMAPFB_COLOR_RGB444,
98         OMAPFB_COLOR_YUY422,
99
100         OMAPFB_COLOR_ARGB16,
101         OMAPFB_COLOR_RGB24U,    /* RGB24, 32-bit container */
102         OMAPFB_COLOR_RGB24P,    /* RGB24, 24-bit container */
103         OMAPFB_COLOR_ARGB32,
104         OMAPFB_COLOR_RGBA32,
105         OMAPFB_COLOR_RGBX32,
106 };
107
108 struct omapfb_update_window {
109         __u32 x, y;
110         __u32 width, height;
111         __u32 format;
112         __u32 out_x, out_y;
113         __u32 out_width, out_height;
114         __u32 reserved[8];
115 };
116
117 struct omapfb_update_window_old {
118         __u32 x, y;
119         __u32 width, height;
120         __u32 format;
121 };
122
123 enum omapfb_plane {
124         OMAPFB_PLANE_GFX = 0,
125         OMAPFB_PLANE_VID1,
126         OMAPFB_PLANE_VID2,
127 };
128
129 enum omapfb_channel_out {
130         OMAPFB_CHANNEL_OUT_LCD = 0,
131         OMAPFB_CHANNEL_OUT_DIGIT,
132 };
133
134 struct omapfb_plane_info {
135         __u32 pos_x;
136         __u32 pos_y;
137         __u8  enabled;
138         __u8  channel_out;
139         __u8  mirror;
140         __u8  reserved1;
141         __u32 out_width;
142         __u32 out_height;
143         __u32 reserved2[12];
144 };
145
146 struct omapfb_mem_info {
147         __u32 size;
148         __u8  type;
149         __u8  reserved[3];
150 };
151
152 struct omapfb_caps {
153         __u32 ctrl;
154         __u32 plane_color;
155         __u32 wnd_color;
156 };
157
158 enum omapfb_color_key_type {
159         OMAPFB_COLOR_KEY_DISABLED = 0,
160         OMAPFB_COLOR_KEY_GFX_DST,
161         OMAPFB_COLOR_KEY_VID_SRC,
162 };
163
164 struct omapfb_color_key {
165         __u8  channel_out;
166         __u32 background;
167         __u32 trans_key;
168         __u8  key_type;
169 };
170
171 enum omapfb_update_mode {
172         OMAPFB_UPDATE_DISABLED = 0,
173         OMAPFB_AUTO_UPDATE,
174         OMAPFB_MANUAL_UPDATE
175 };
176
177 struct omapfb_memory_read {
178         __u16 x;
179         __u16 y;
180         __u16 w;
181         __u16 h;
182         size_t buffer_size;
183         void __user *buffer;
184 };
185
186 #ifdef __KERNEL__
187
188 #include <linux/completion.h>
189 #include <linux/interrupt.h>
190 #include <linux/fb.h>
191 #include <linux/mutex.h>
192
193 #include <mach/board.h>
194
195 #define OMAP_LCDC_INV_VSYNC             0x0001
196 #define OMAP_LCDC_INV_HSYNC             0x0002
197 #define OMAP_LCDC_INV_PIX_CLOCK         0x0004
198 #define OMAP_LCDC_INV_OUTPUT_EN         0x0008
199 #define OMAP_LCDC_HSVS_RISING_EDGE      0x0010
200 #define OMAP_LCDC_HSVS_OPPOSITE         0x0020
201
202 #define OMAP_LCDC_SIGNAL_MASK           0x003f
203
204 #define OMAP_LCDC_PANEL_TFT             0x0100
205
206 #define OMAPFB_PLANE_XRES_MIN           8
207 #define OMAPFB_PLANE_YRES_MIN           8
208
209 #ifdef CONFIG_ARCH_OMAP1
210 #define OMAPFB_PLANE_NUM                1
211 #else
212 #define OMAPFB_PLANE_NUM                3
213 #endif
214
215 struct omapfb_device;
216
217 struct lcd_panel {
218         const char      *name;
219         int             config;         /* TFT/STN, signal inversion */
220         int             bpp;            /* Pixel format in fb mem */
221         int             data_lines;     /* Lines on LCD HW interface */
222
223         int             x_res, y_res;
224         int             pixel_clock;    /* In kHz */
225         int             hsw;            /* Horizontal synchronization
226                                            pulse width */
227         int             hfp;            /* Horizontal front porch */
228         int             hbp;            /* Horizontal back porch */
229         int             vsw;            /* Vertical synchronization
230                                            pulse width */
231         int             vfp;            /* Vertical front porch */
232         int             vbp;            /* Vertical back porch */
233         int             acb;            /* ac-bias pin frequency */
234         int             pcd;            /* pixel clock divider.
235                                            Obsolete use pixel_clock instead */
236
237         int             (*init)         (struct lcd_panel *panel,
238                                          struct omapfb_device *fbdev);
239         void            (*cleanup)      (struct lcd_panel *panel);
240         int             (*enable)       (struct lcd_panel *panel);
241         void            (*disable)      (struct lcd_panel *panel);
242         unsigned long   (*get_caps)     (struct lcd_panel *panel);
243         int             (*set_bklight_level)(struct lcd_panel *panel,
244                                              unsigned int level);
245         unsigned int    (*get_bklight_level)(struct lcd_panel *panel);
246         unsigned int    (*get_bklight_max)  (struct lcd_panel *panel);
247         int             (*run_test)     (struct lcd_panel *panel, int test_num);
248 };
249
250 struct extif_timings {
251         int cs_on_time;
252         int cs_off_time;
253         int we_on_time;
254         int we_off_time;
255         int re_on_time;
256         int re_off_time;
257         int we_cycle_time;
258         int re_cycle_time;
259         int cs_pulse_width;
260         int access_time;
261
262         int clk_div;
263
264         u32 tim[5];             /* set by extif->convert_timings */
265
266         int converted;
267 };
268
269 struct lcd_ctrl_extif {
270         int  (*init)            (struct omapfb_device *fbdev);
271         void (*cleanup)         (void);
272         void (*get_clk_info)    (u32 *clk_period, u32 *max_clk_div);
273         unsigned long (*get_max_tx_rate)(void);
274         int  (*convert_timings) (struct extif_timings *timings);
275         void (*set_timings)     (const struct extif_timings *timings);
276         void (*set_bits_per_cycle)(int bpc);
277         void (*write_command)   (const void *buf, unsigned int len);
278         void (*read_data)       (void *buf, unsigned int len);
279         void (*write_data)      (const void *buf, unsigned int len);
280         void (*transfer_area)   (int width, int height,
281                                  void (callback)(void * data), void *data);
282         int  (*setup_tearsync)  (unsigned pin_cnt,
283                                  unsigned hs_pulse_time, unsigned vs_pulse_time,
284                                  int hs_pol_inv, int vs_pol_inv, int div);
285         int  (*enable_tearsync) (int enable, unsigned line);
286
287         unsigned long           max_transmit_size;
288 };
289
290 struct omapfb_notifier_block {
291         struct notifier_block   nb;
292         void                    *data;
293         int                     plane_idx;
294 };
295
296 typedef int (*omapfb_notifier_callback_t)(struct notifier_block *,
297                                           unsigned long event,
298                                           void *fbi);
299
300 struct omapfb_mem_region {
301         u32             paddr;
302         void __iomem    *vaddr;
303         unsigned long   size;
304         u8              type;           /* OMAPFB_PLANE_MEM_* */
305         enum omapfb_color_format format;/* OMAPFB_COLOR_* */
306         unsigned        format_used:1;  /* Must be set when format is set.
307                                          * Needed b/c of the badly chosen 0
308                                          * base for OMAPFB_COLOR_* values
309                                          */
310         unsigned        alloc:1;        /* allocated by the driver */
311         unsigned        map:1;          /* kernel mapped by the driver */
312 };
313
314 struct omapfb_mem_desc {
315         int                             region_cnt;
316         struct omapfb_mem_region        region[OMAPFB_PLANE_NUM];
317 };
318
319 struct lcd_ctrl {
320         const char      *name;
321         void            *data;
322
323         int             (*init)           (struct omapfb_device *fbdev,
324                                            int ext_mode,
325                                            struct omapfb_mem_desc *req_md);
326         void            (*cleanup)        (void);
327         void            (*bind_client)    (struct omapfb_notifier_block *nb);
328         void            (*get_caps)       (int plane, struct omapfb_caps *caps);
329         int             (*set_update_mode)(enum omapfb_update_mode mode);
330         enum omapfb_update_mode (*get_update_mode)(void);
331         int             (*setup_plane)    (int plane, int channel_out,
332                                            unsigned long offset,
333                                            int screen_width,
334                                            int pos_x, int pos_y, int width,
335                                            int height, int color_mode);
336         int             (*set_rotate)     (int angle);
337         int             (*setup_mem)      (int plane, size_t size,
338                                            int mem_type, unsigned long *paddr);
339         int             (*mmap)           (struct fb_info *info,
340                                            struct vm_area_struct *vma);
341         int             (*set_scale)      (int plane,
342                                            int orig_width, int orig_height,
343                                            int out_width, int out_height);
344         int             (*enable_plane)   (int plane, int enable);
345         int             (*update_window)  (struct fb_info *fbi,
346                                            struct omapfb_update_window *win,
347                                            void (*callback)(void *),
348                                            void *callback_data);
349         void            (*sync)           (void);
350         void            (*suspend)        (void);
351         void            (*resume)         (void);
352         int             (*run_test)       (int test_num);
353         int             (*setcolreg)      (u_int regno, u16 red, u16 green,
354                                            u16 blue, u16 transp,
355                                            int update_hw_mem);
356         int             (*set_color_key)  (struct omapfb_color_key *ck);
357         int             (*get_color_key)  (struct omapfb_color_key *ck);
358 };
359
360 enum omapfb_state {
361         OMAPFB_DISABLED = 0,
362         OMAPFB_SUSPENDED= 99,
363         OMAPFB_ACTIVE   = 100
364 };
365
366 struct omapfb_plane_struct {
367         int                             idx;
368         struct omapfb_plane_info        info;
369         enum omapfb_color_format        color_mode;
370         struct omapfb_device            *fbdev;
371 };
372
373 struct omapfb_device {
374         int                     state;
375         int                     ext_lcdc;               /* Using external
376                                                            LCD controller */
377         struct mutex            rqueue_mutex;
378
379         int                     palette_size;
380         u32                     pseudo_palette[17];
381
382         struct lcd_panel        *panel;                 /* LCD panel */
383         const struct lcd_ctrl   *ctrl;                  /* LCD controller */
384         const struct lcd_ctrl   *int_ctrl;              /* internal LCD ctrl */
385         struct lcd_ctrl_extif   *ext_if;                /* LCD ctrl external
386                                                            interface */
387         struct device           *dev;
388         struct fb_var_screeninfo        new_var;        /* for mode changes */
389
390         struct omapfb_mem_desc          mem_desc;
391         struct fb_info                  *fb_info[OMAPFB_PLANE_NUM];
392 };
393
394 struct omapfb_platform_data {
395         struct omap_lcd_config          lcd;
396         struct omapfb_mem_desc          mem_desc;
397         void                            *ctrl_platform_data;
398 };
399
400 #ifdef CONFIG_ARCH_OMAP1
401 extern struct lcd_ctrl omap1_lcd_ctrl;
402 #else
403 extern struct lcd_ctrl omap2_disp_ctrl;
404 #endif
405
406 extern void omapfb_set_platform_data(struct omapfb_platform_data *data);
407
408 extern void omapfb_reserve_sdram(void);
409 extern void omapfb_register_panel(struct lcd_panel *panel);
410 extern void omapfb_write_first_pixel(struct omapfb_device *fbdev, u16 pixval);
411 extern void omapfb_notify_clients(struct omapfb_device *fbdev,
412                                   unsigned long event);
413 extern int  omapfb_register_client(struct omapfb_notifier_block *nb,
414                                    omapfb_notifier_callback_t callback,
415                                    void *callback_data);
416 extern int  omapfb_unregister_client(struct omapfb_notifier_block *nb);
417 extern int  omapfb_update_window_async(struct fb_info *fbi,
418                                        struct omapfb_update_window *win,
419                                        void (*callback)(void *),
420                                        void *callback_data);
421
422 /* in arch/arm/plat-omap/fb.c */
423 extern void omapfb_set_ctrl_platform_data(void *pdata);
424
425 #endif /* __KERNEL__ */
426
427 #endif /* __OMAPFB_H */