2 * Copyright (C) 2008 Nokia Corporation
3 * Author: Tomi Valkeinen <tomi.valkeinen@nokia.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef __OMAP_OMAPDSS_H
19 #define __OMAP_OMAPDSS_H
21 #include <linux/list.h>
22 #include <linux/kobject.h>
23 #include <linux/device.h>
25 #define DISPC_IRQ_FRAMEDONE (1 << 0)
26 #define DISPC_IRQ_VSYNC (1 << 1)
27 #define DISPC_IRQ_EVSYNC_EVEN (1 << 2)
28 #define DISPC_IRQ_EVSYNC_ODD (1 << 3)
29 #define DISPC_IRQ_ACBIAS_COUNT_STAT (1 << 4)
30 #define DISPC_IRQ_PROG_LINE_NUM (1 << 5)
31 #define DISPC_IRQ_GFX_FIFO_UNDERFLOW (1 << 6)
32 #define DISPC_IRQ_GFX_END_WIN (1 << 7)
33 #define DISPC_IRQ_PAL_GAMMA_MASK (1 << 8)
34 #define DISPC_IRQ_OCP_ERR (1 << 9)
35 #define DISPC_IRQ_VID1_FIFO_UNDERFLOW (1 << 10)
36 #define DISPC_IRQ_VID1_END_WIN (1 << 11)
37 #define DISPC_IRQ_VID2_FIFO_UNDERFLOW (1 << 12)
38 #define DISPC_IRQ_VID2_END_WIN (1 << 13)
39 #define DISPC_IRQ_SYNC_LOST (1 << 14)
40 #define DISPC_IRQ_SYNC_LOST_DIGIT (1 << 15)
41 #define DISPC_IRQ_WAKEUP (1 << 16)
42 #define DISPC_IRQ_SYNC_LOST2 (1 << 17)
43 #define DISPC_IRQ_VSYNC2 (1 << 18)
44 #define DISPC_IRQ_ACBIAS_COUNT_STAT2 (1 << 21)
45 #define DISPC_IRQ_FRAMEDONE2 (1 << 22)
47 struct omap_dss_device;
48 struct omap_overlay_manager;
50 enum omap_display_type {
51 OMAP_DISPLAY_TYPE_NONE = 0,
52 OMAP_DISPLAY_TYPE_DPI = 1 << 0,
53 OMAP_DISPLAY_TYPE_DBI = 1 << 1,
54 OMAP_DISPLAY_TYPE_SDI = 1 << 2,
55 OMAP_DISPLAY_TYPE_DSI = 1 << 3,
56 OMAP_DISPLAY_TYPE_VENC = 1 << 4,
57 OMAP_DISPLAY_TYPE_HDMI = 1 << 5,
67 OMAP_DSS_CHANNEL_LCD = 0,
68 OMAP_DSS_CHANNEL_DIGIT = 1,
69 OMAP_DSS_CHANNEL_LCD2 = 2,
72 enum omap_color_mode {
73 OMAP_DSS_COLOR_CLUT1 = 1 << 0, /* BITMAP 1 */
74 OMAP_DSS_COLOR_CLUT2 = 1 << 1, /* BITMAP 2 */
75 OMAP_DSS_COLOR_CLUT4 = 1 << 2, /* BITMAP 4 */
76 OMAP_DSS_COLOR_CLUT8 = 1 << 3, /* BITMAP 8 */
77 OMAP_DSS_COLOR_RGB12U = 1 << 4, /* RGB12, 16-bit container */
78 OMAP_DSS_COLOR_ARGB16 = 1 << 5, /* ARGB16 */
79 OMAP_DSS_COLOR_RGB16 = 1 << 6, /* RGB16 */
80 OMAP_DSS_COLOR_RGB24U = 1 << 7, /* RGB24, 32-bit container */
81 OMAP_DSS_COLOR_RGB24P = 1 << 8, /* RGB24, 24-bit container */
82 OMAP_DSS_COLOR_YUV2 = 1 << 9, /* YUV2 4:2:2 co-sited */
83 OMAP_DSS_COLOR_UYVY = 1 << 10, /* UYVY 4:2:2 co-sited */
84 OMAP_DSS_COLOR_ARGB32 = 1 << 11, /* ARGB32 */
85 OMAP_DSS_COLOR_RGBA32 = 1 << 12, /* RGBA32 */
86 OMAP_DSS_COLOR_RGBX32 = 1 << 13, /* RGBx32 */
87 OMAP_DSS_COLOR_NV12 = 1 << 14, /* NV12 format: YUV 4:2:0 */
88 OMAP_DSS_COLOR_RGBA16 = 1 << 15, /* RGBA16 - 4444 */
89 OMAP_DSS_COLOR_RGBX16 = 1 << 16, /* RGBx16 - 4444 */
90 OMAP_DSS_COLOR_ARGB16_1555 = 1 << 17, /* ARGB16 - 1555 */
91 OMAP_DSS_COLOR_XRGB16_1555 = 1 << 18, /* xRGB16 - 1555 */
94 enum omap_lcd_display_type {
95 OMAP_DSS_LCD_DISPLAY_STN,
96 OMAP_DSS_LCD_DISPLAY_TFT,
99 enum omap_dss_load_mode {
100 OMAP_DSS_LOAD_CLUT_AND_FRAME = 0,
101 OMAP_DSS_LOAD_CLUT_ONLY = 1,
102 OMAP_DSS_LOAD_FRAME_ONLY = 2,
103 OMAP_DSS_LOAD_CLUT_ONCE_FRAME = 3,
106 enum omap_dss_trans_key_type {
107 OMAP_DSS_COLOR_KEY_GFX_DST = 0,
108 OMAP_DSS_COLOR_KEY_VID_SRC = 1,
111 enum omap_rfbi_te_mode {
112 OMAP_DSS_RFBI_TE_MODE_1 = 1,
113 OMAP_DSS_RFBI_TE_MODE_2 = 2,
116 enum omap_panel_config {
117 OMAP_DSS_LCD_IVS = 1<<0,
118 OMAP_DSS_LCD_IHS = 1<<1,
119 OMAP_DSS_LCD_IPC = 1<<2,
120 OMAP_DSS_LCD_IEO = 1<<3,
121 OMAP_DSS_LCD_RF = 1<<4,
122 OMAP_DSS_LCD_ONOFF = 1<<5,
124 OMAP_DSS_LCD_TFT = 1<<20,
127 enum omap_dss_venc_type {
128 OMAP_DSS_VENC_TYPE_COMPOSITE,
129 OMAP_DSS_VENC_TYPE_SVIDEO,
132 enum omap_display_caps {
133 OMAP_DSS_DISPLAY_CAP_MANUAL_UPDATE = 1 << 0,
134 OMAP_DSS_DISPLAY_CAP_TEAR_ELIM = 1 << 1,
137 enum omap_dss_update_mode {
138 OMAP_DSS_UPDATE_DISABLED = 0,
139 OMAP_DSS_UPDATE_AUTO,
140 OMAP_DSS_UPDATE_MANUAL,
143 enum omap_dss_display_state {
144 OMAP_DSS_DISPLAY_DISABLED = 0,
145 OMAP_DSS_DISPLAY_ACTIVE,
146 OMAP_DSS_DISPLAY_SUSPENDED,
149 /* XXX perhaps this should be removed */
150 enum omap_dss_overlay_managers {
151 OMAP_DSS_OVL_MGR_LCD,
153 OMAP_DSS_OVL_MGR_LCD2,
156 enum omap_dss_rotation_type {
157 OMAP_DSS_ROT_DMA = 0,
158 OMAP_DSS_ROT_VRFB = 1,
161 /* clockwise rotation angle */
162 enum omap_dss_rotation_angle {
165 OMAP_DSS_ROT_180 = 2,
166 OMAP_DSS_ROT_270 = 3,
169 enum omap_overlay_caps {
170 OMAP_DSS_OVL_CAP_SCALE = 1 << 0,
171 OMAP_DSS_OVL_CAP_DISPC = 1 << 1,
174 enum omap_overlay_manager_caps {
175 OMAP_DSS_OVL_MGR_CAP_DISPC = 1 << 0,
178 enum omap_dss_clk_source {
179 OMAP_DSS_CLK_SRC_FCK = 0, /* OMAP2/3: DSS1_ALWON_FCLK
181 OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DISPC, /* OMAP3: DSI1_PLL_FCLK
182 * OMAP4: PLL1_CLK1 */
183 OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DSI, /* OMAP3: DSI2_PLL_FCLK
184 * OMAP4: PLL1_CLK2 */
185 OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DISPC, /* OMAP4: PLL2_CLK1 */
186 OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DSI, /* OMAP4: PLL2_CLK2 */
191 struct rfbi_timings {
205 u32 tim[5]; /* set by rfbi_convert_timings() */
210 void omap_rfbi_write_command(const void *buf, u32 len);
211 void omap_rfbi_read_data(void *buf, u32 len);
212 void omap_rfbi_write_data(const void *buf, u32 len);
213 void omap_rfbi_write_pixels(const void __iomem *buf, int scr_width,
216 int omap_rfbi_enable_te(bool enable, unsigned line);
217 int omap_rfbi_setup_te(enum omap_rfbi_te_mode mode,
218 unsigned hs_pulse_time, unsigned vs_pulse_time,
219 int hs_pol_inv, int vs_pol_inv, int extif_div);
220 void rfbi_bus_lock(void);
221 void rfbi_bus_unlock(void);
224 void dsi_bus_lock(struct omap_dss_device *dssdev);
225 void dsi_bus_unlock(struct omap_dss_device *dssdev);
226 int dsi_vc_dcs_write(struct omap_dss_device *dssdev, int channel, u8 *data,
228 int dsi_vc_dcs_write_0(struct omap_dss_device *dssdev, int channel,
230 int dsi_vc_dcs_write_1(struct omap_dss_device *dssdev, int channel, u8 dcs_cmd,
232 int dsi_vc_dcs_write_nosync(struct omap_dss_device *dssdev, int channel,
234 int dsi_vc_dcs_read(struct omap_dss_device *dssdev, int channel, u8 dcs_cmd,
235 u8 *buf, int buflen);
236 int dsi_vc_dcs_read_1(struct omap_dss_device *dssdev, int channel, u8 dcs_cmd,
238 int dsi_vc_dcs_read_2(struct omap_dss_device *dssdev, int channel, u8 dcs_cmd,
239 u8 *data1, u8 *data2);
240 int dsi_vc_set_max_rx_packet_size(struct omap_dss_device *dssdev, int channel,
242 int dsi_vc_send_null(struct omap_dss_device *dssdev, int channel);
243 int dsi_vc_send_bta_sync(struct omap_dss_device *dssdev, int channel);
245 /* Board specific data */
246 struct omap_dss_board_info {
247 int (*get_last_off_on_transaction_id)(struct device *dev);
249 struct omap_dss_device **devices;
250 struct omap_dss_device *default_device;
251 void (*dsi_mux_pads)(bool enable);
254 #if defined(CONFIG_OMAP2_DSS_MODULE) || defined(CONFIG_OMAP2_DSS)
255 /* Init with the board info */
256 extern int omap_display_init(struct omap_dss_board_info *board_data);
258 static inline int omap_display_init(struct omap_dss_board_info *board_data)
264 struct omap_display_platform_data {
265 struct omap_dss_board_info *board_data;
266 /* TODO: Additional members to be added when PM is considered */
268 bool (*opt_clock_available)(const char *clk_role);
271 struct omap_video_timings {
278 /* Unit: pixel clocks */
279 u16 hsw; /* Horizontal synchronization pulse width */
280 /* Unit: pixel clocks */
281 u16 hfp; /* Horizontal front porch */
282 /* Unit: pixel clocks */
283 u16 hbp; /* Horizontal back porch */
284 /* Unit: line clocks */
285 u16 vsw; /* Vertical synchronization pulse width */
286 /* Unit: line clocks */
287 u16 vfp; /* Vertical front porch */
288 /* Unit: line clocks */
289 u16 vbp; /* Vertical back porch */
292 #ifdef CONFIG_OMAP2_DSS_VENC
293 /* Hardcoded timings for tv modes. Venc only uses these to
294 * identify the mode, and does not actually use the configs
295 * itself. However, the configs should be something that
296 * a normal monitor can also show */
297 extern const struct omap_video_timings omap_dss_pal_timings;
298 extern const struct omap_video_timings omap_dss_ntsc_timings;
301 struct omap_overlay_info {
306 u32 p_uv_addr; /* for NV12 format */
310 enum omap_color_mode color_mode;
312 enum omap_dss_rotation_type rotation_type;
317 u16 out_width; /* if 0, out_width == width */
318 u16 out_height; /* if 0, out_height == height */
323 struct omap_overlay {
325 struct list_head list;
330 enum omap_color_mode supported_modes;
331 enum omap_overlay_caps caps;
334 struct omap_overlay_manager *manager;
335 struct omap_overlay_info info;
337 /* if true, info has been changed, but not applied() yet */
340 int (*set_manager)(struct omap_overlay *ovl,
341 struct omap_overlay_manager *mgr);
342 int (*unset_manager)(struct omap_overlay *ovl);
344 int (*set_overlay_info)(struct omap_overlay *ovl,
345 struct omap_overlay_info *info);
346 void (*get_overlay_info)(struct omap_overlay *ovl,
347 struct omap_overlay_info *info);
349 int (*wait_for_go)(struct omap_overlay *ovl);
352 struct omap_overlay_manager_info {
355 enum omap_dss_trans_key_type trans_key_type;
362 struct omap_overlay_manager {
364 struct list_head list;
369 enum omap_overlay_manager_caps caps;
371 struct omap_overlay **overlays;
372 enum omap_display_type supported_displays;
375 struct omap_dss_device *device;
376 struct omap_overlay_manager_info info;
379 /* if true, info has been changed but not applied() yet */
382 int (*set_device)(struct omap_overlay_manager *mgr,
383 struct omap_dss_device *dssdev);
384 int (*unset_device)(struct omap_overlay_manager *mgr);
386 int (*set_manager_info)(struct omap_overlay_manager *mgr,
387 struct omap_overlay_manager_info *info);
388 void (*get_manager_info)(struct omap_overlay_manager *mgr,
389 struct omap_overlay_manager_info *info);
391 int (*apply)(struct omap_overlay_manager *mgr);
392 int (*wait_for_go)(struct omap_overlay_manager *mgr);
393 int (*wait_for_vsync)(struct omap_overlay_manager *mgr);
395 int (*enable)(struct omap_overlay_manager *mgr);
396 int (*disable)(struct omap_overlay_manager *mgr);
399 struct omap_dss_device {
402 enum omap_display_type type;
404 enum omap_channel channel;
439 enum omap_dss_venc_type type;
440 bool invert_polarity;
449 enum omap_dss_clk_source lcd_clk_src;
452 enum omap_dss_clk_source dispc_fclk_src;
462 enum omap_dss_clk_source dsi_fclk_src;
472 struct omap_video_timings timings;
474 int acbi; /* ac-bias pin transitions per interrupt */
475 /* Unit: line clocks */
476 int acb; /* ac-bias pin frequency */
478 enum omap_panel_config config;
483 struct rfbi_timings rfbi_timings;
488 int max_backlight_level;
492 /* used to match device to driver */
493 const char *driver_name;
497 struct omap_dss_driver *driver;
499 /* helper variable for driver suspend/resume */
500 bool activate_after_resume;
502 enum omap_display_caps caps;
504 struct omap_overlay_manager *manager;
506 enum omap_dss_display_state state;
508 /* platform specific */
509 int (*platform_enable)(struct omap_dss_device *dssdev);
510 void (*platform_disable)(struct omap_dss_device *dssdev);
511 int (*set_backlight)(struct omap_dss_device *dssdev, int level);
512 int (*get_backlight)(struct omap_dss_device *dssdev);
515 struct omap_dss_driver {
516 struct device_driver driver;
518 int (*probe)(struct omap_dss_device *);
519 void (*remove)(struct omap_dss_device *);
521 int (*enable)(struct omap_dss_device *display);
522 void (*disable)(struct omap_dss_device *display);
523 int (*suspend)(struct omap_dss_device *display);
524 int (*resume)(struct omap_dss_device *display);
525 int (*run_test)(struct omap_dss_device *display, int test);
527 int (*set_update_mode)(struct omap_dss_device *dssdev,
528 enum omap_dss_update_mode);
529 enum omap_dss_update_mode (*get_update_mode)(
530 struct omap_dss_device *dssdev);
532 int (*update)(struct omap_dss_device *dssdev,
533 u16 x, u16 y, u16 w, u16 h);
534 int (*sync)(struct omap_dss_device *dssdev);
536 int (*enable_te)(struct omap_dss_device *dssdev, bool enable);
537 int (*get_te)(struct omap_dss_device *dssdev);
539 u8 (*get_rotate)(struct omap_dss_device *dssdev);
540 int (*set_rotate)(struct omap_dss_device *dssdev, u8 rotate);
542 bool (*get_mirror)(struct omap_dss_device *dssdev);
543 int (*set_mirror)(struct omap_dss_device *dssdev, bool enable);
545 int (*memory_read)(struct omap_dss_device *dssdev,
546 void *buf, size_t size,
547 u16 x, u16 y, u16 w, u16 h);
549 void (*get_resolution)(struct omap_dss_device *dssdev,
550 u16 *xres, u16 *yres);
551 void (*get_dimensions)(struct omap_dss_device *dssdev,
552 u32 *width, u32 *height);
553 int (*get_recommended_bpp)(struct omap_dss_device *dssdev);
555 int (*check_timings)(struct omap_dss_device *dssdev,
556 struct omap_video_timings *timings);
557 void (*set_timings)(struct omap_dss_device *dssdev,
558 struct omap_video_timings *timings);
559 void (*get_timings)(struct omap_dss_device *dssdev,
560 struct omap_video_timings *timings);
562 int (*set_wss)(struct omap_dss_device *dssdev, u32 wss);
563 u32 (*get_wss)(struct omap_dss_device *dssdev);
566 int omap_dss_register_driver(struct omap_dss_driver *);
567 void omap_dss_unregister_driver(struct omap_dss_driver *);
569 void omap_dss_get_device(struct omap_dss_device *dssdev);
570 void omap_dss_put_device(struct omap_dss_device *dssdev);
571 #define for_each_dss_dev(d) while ((d = omap_dss_get_next_device(d)) != NULL)
572 struct omap_dss_device *omap_dss_get_next_device(struct omap_dss_device *from);
573 struct omap_dss_device *omap_dss_find_device(void *data,
574 int (*match)(struct omap_dss_device *dssdev, void *data));
576 int omap_dss_start_device(struct omap_dss_device *dssdev);
577 void omap_dss_stop_device(struct omap_dss_device *dssdev);
579 int omap_dss_get_num_overlay_managers(void);
580 struct omap_overlay_manager *omap_dss_get_overlay_manager(int num);
582 int omap_dss_get_num_overlays(void);
583 struct omap_overlay *omap_dss_get_overlay(int num);
585 void omapdss_default_get_resolution(struct omap_dss_device *dssdev,
586 u16 *xres, u16 *yres);
587 int omapdss_default_get_recommended_bpp(struct omap_dss_device *dssdev);
589 typedef void (*omap_dispc_isr_t) (void *arg, u32 mask);
590 int omap_dispc_register_isr(omap_dispc_isr_t isr, void *arg, u32 mask);
591 int omap_dispc_unregister_isr(omap_dispc_isr_t isr, void *arg, u32 mask);
593 int omap_dispc_wait_for_irq_timeout(u32 irqmask, unsigned long timeout);
594 int omap_dispc_wait_for_irq_interruptible_timeout(u32 irqmask,
595 unsigned long timeout);
597 #define to_dss_driver(x) container_of((x), struct omap_dss_driver, driver)
598 #define to_dss_device(x) container_of((x), struct omap_dss_device, dev)
600 void omapdss_dsi_vc_enable_hs(struct omap_dss_device *dssdev, int channel,
602 int omapdss_dsi_enable_te(struct omap_dss_device *dssdev, bool enable);
604 int omap_dsi_prepare_update(struct omap_dss_device *dssdev,
605 u16 *x, u16 *y, u16 *w, u16 *h,
606 bool enlarge_update_area);
607 int omap_dsi_update(struct omap_dss_device *dssdev,
609 u16 x, u16 y, u16 w, u16 h,
610 void (*callback)(int, void *), void *data);
611 int omap_dsi_request_vc(struct omap_dss_device *dssdev, int *channel);
612 int omap_dsi_set_vc_id(struct omap_dss_device *dssdev, int channel, int vc_id);
613 void omap_dsi_release_vc(struct omap_dss_device *dssdev, int channel);
615 int omapdss_dsi_display_enable(struct omap_dss_device *dssdev);
616 void omapdss_dsi_display_disable(struct omap_dss_device *dssdev,
617 bool disconnect_lanes, bool enter_ulps);
619 int omapdss_dpi_display_enable(struct omap_dss_device *dssdev);
620 void omapdss_dpi_display_disable(struct omap_dss_device *dssdev);
621 void dpi_set_timings(struct omap_dss_device *dssdev,
622 struct omap_video_timings *timings);
623 int dpi_check_timings(struct omap_dss_device *dssdev,
624 struct omap_video_timings *timings);
626 int omapdss_sdi_display_enable(struct omap_dss_device *dssdev);
627 void omapdss_sdi_display_disable(struct omap_dss_device *dssdev);
629 int omapdss_rfbi_display_enable(struct omap_dss_device *dssdev);
630 void omapdss_rfbi_display_disable(struct omap_dss_device *dssdev);
631 int omap_rfbi_prepare_update(struct omap_dss_device *dssdev,
632 u16 *x, u16 *y, u16 *w, u16 *h);
633 int omap_rfbi_update(struct omap_dss_device *dssdev,
634 u16 x, u16 y, u16 w, u16 h,
635 void (*callback)(void *), void *data);
636 int omap_rfbi_configure(struct omap_dss_device *dssdev, int pixel_size,