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>
24 #include <linux/platform_device.h>
25 #include <asm/atomic.h>
27 #define DISPC_IRQ_FRAMEDONE (1 << 0)
28 #define DISPC_IRQ_VSYNC (1 << 1)
29 #define DISPC_IRQ_EVSYNC_EVEN (1 << 2)
30 #define DISPC_IRQ_EVSYNC_ODD (1 << 3)
31 #define DISPC_IRQ_ACBIAS_COUNT_STAT (1 << 4)
32 #define DISPC_IRQ_PROG_LINE_NUM (1 << 5)
33 #define DISPC_IRQ_GFX_FIFO_UNDERFLOW (1 << 6)
34 #define DISPC_IRQ_GFX_END_WIN (1 << 7)
35 #define DISPC_IRQ_PAL_GAMMA_MASK (1 << 8)
36 #define DISPC_IRQ_OCP_ERR (1 << 9)
37 #define DISPC_IRQ_VID1_FIFO_UNDERFLOW (1 << 10)
38 #define DISPC_IRQ_VID1_END_WIN (1 << 11)
39 #define DISPC_IRQ_VID2_FIFO_UNDERFLOW (1 << 12)
40 #define DISPC_IRQ_VID2_END_WIN (1 << 13)
41 #define DISPC_IRQ_SYNC_LOST (1 << 14)
42 #define DISPC_IRQ_SYNC_LOST_DIGIT (1 << 15)
43 #define DISPC_IRQ_WAKEUP (1 << 16)
44 #define DISPC_IRQ_SYNC_LOST2 (1 << 17)
45 #define DISPC_IRQ_VSYNC2 (1 << 18)
46 #define DISPC_IRQ_ACBIAS_COUNT_STAT2 (1 << 21)
47 #define DISPC_IRQ_FRAMEDONE2 (1 << 22)
49 struct omap_dss_device
;
50 struct omap_overlay_manager
;
52 enum omap_display_type
{
53 OMAP_DISPLAY_TYPE_NONE
= 0,
54 OMAP_DISPLAY_TYPE_DPI
= 1 << 0,
55 OMAP_DISPLAY_TYPE_DBI
= 1 << 1,
56 OMAP_DISPLAY_TYPE_SDI
= 1 << 2,
57 OMAP_DISPLAY_TYPE_DSI
= 1 << 3,
58 OMAP_DISPLAY_TYPE_VENC
= 1 << 4,
59 OMAP_DISPLAY_TYPE_HDMI
= 1 << 5,
69 OMAP_DSS_CHANNEL_LCD
= 0,
70 OMAP_DSS_CHANNEL_DIGIT
= 1,
71 OMAP_DSS_CHANNEL_LCD2
= 2,
74 enum omap_color_mode
{
75 OMAP_DSS_COLOR_CLUT1
= 1 << 0, /* BITMAP 1 */
76 OMAP_DSS_COLOR_CLUT2
= 1 << 1, /* BITMAP 2 */
77 OMAP_DSS_COLOR_CLUT4
= 1 << 2, /* BITMAP 4 */
78 OMAP_DSS_COLOR_CLUT8
= 1 << 3, /* BITMAP 8 */
79 OMAP_DSS_COLOR_RGB12U
= 1 << 4, /* RGB12, 16-bit container */
80 OMAP_DSS_COLOR_ARGB16
= 1 << 5, /* ARGB16 */
81 OMAP_DSS_COLOR_RGB16
= 1 << 6, /* RGB16 */
82 OMAP_DSS_COLOR_RGB24U
= 1 << 7, /* RGB24, 32-bit container */
83 OMAP_DSS_COLOR_RGB24P
= 1 << 8, /* RGB24, 24-bit container */
84 OMAP_DSS_COLOR_YUV2
= 1 << 9, /* YUV2 4:2:2 co-sited */
85 OMAP_DSS_COLOR_UYVY
= 1 << 10, /* UYVY 4:2:2 co-sited */
86 OMAP_DSS_COLOR_ARGB32
= 1 << 11, /* ARGB32 */
87 OMAP_DSS_COLOR_RGBA32
= 1 << 12, /* RGBA32 */
88 OMAP_DSS_COLOR_RGBX32
= 1 << 13, /* RGBx32 */
89 OMAP_DSS_COLOR_NV12
= 1 << 14, /* NV12 format: YUV 4:2:0 */
90 OMAP_DSS_COLOR_RGBA16
= 1 << 15, /* RGBA16 - 4444 */
91 OMAP_DSS_COLOR_RGBX16
= 1 << 16, /* RGBx16 - 4444 */
92 OMAP_DSS_COLOR_ARGB16_1555
= 1 << 17, /* ARGB16 - 1555 */
93 OMAP_DSS_COLOR_XRGB16_1555
= 1 << 18, /* xRGB16 - 1555 */
96 enum omap_lcd_display_type
{
97 OMAP_DSS_LCD_DISPLAY_STN
,
98 OMAP_DSS_LCD_DISPLAY_TFT
,
101 enum omap_dss_load_mode
{
102 OMAP_DSS_LOAD_CLUT_AND_FRAME
= 0,
103 OMAP_DSS_LOAD_CLUT_ONLY
= 1,
104 OMAP_DSS_LOAD_FRAME_ONLY
= 2,
105 OMAP_DSS_LOAD_CLUT_ONCE_FRAME
= 3,
108 enum omap_dss_trans_key_type
{
109 OMAP_DSS_COLOR_KEY_GFX_DST
= 0,
110 OMAP_DSS_COLOR_KEY_VID_SRC
= 1,
113 enum omap_rfbi_te_mode
{
114 OMAP_DSS_RFBI_TE_MODE_1
= 1,
115 OMAP_DSS_RFBI_TE_MODE_2
= 2,
118 enum omap_panel_config
{
119 OMAP_DSS_LCD_IVS
= 1<<0,
120 OMAP_DSS_LCD_IHS
= 1<<1,
121 OMAP_DSS_LCD_IPC
= 1<<2,
122 OMAP_DSS_LCD_IEO
= 1<<3,
123 OMAP_DSS_LCD_RF
= 1<<4,
124 OMAP_DSS_LCD_ONOFF
= 1<<5,
126 OMAP_DSS_LCD_TFT
= 1<<20,
129 enum omap_dss_venc_type
{
130 OMAP_DSS_VENC_TYPE_COMPOSITE
,
131 OMAP_DSS_VENC_TYPE_SVIDEO
,
134 enum omap_display_caps
{
135 OMAP_DSS_DISPLAY_CAP_MANUAL_UPDATE
= 1 << 0,
136 OMAP_DSS_DISPLAY_CAP_TEAR_ELIM
= 1 << 1,
139 enum omap_dss_update_mode
{
140 OMAP_DSS_UPDATE_DISABLED
= 0,
141 OMAP_DSS_UPDATE_AUTO
,
142 OMAP_DSS_UPDATE_MANUAL
,
145 enum omap_dss_display_state
{
146 OMAP_DSS_DISPLAY_DISABLED
= 0,
147 OMAP_DSS_DISPLAY_ACTIVE
,
148 OMAP_DSS_DISPLAY_SUSPENDED
,
151 /* XXX perhaps this should be removed */
152 enum omap_dss_overlay_managers
{
153 OMAP_DSS_OVL_MGR_LCD
,
155 OMAP_DSS_OVL_MGR_LCD2
,
158 enum omap_dss_rotation_type
{
159 OMAP_DSS_ROT_DMA
= 0,
160 OMAP_DSS_ROT_VRFB
= 1,
163 /* clockwise rotation angle */
164 enum omap_dss_rotation_angle
{
167 OMAP_DSS_ROT_180
= 2,
168 OMAP_DSS_ROT_270
= 3,
171 enum omap_overlay_caps
{
172 OMAP_DSS_OVL_CAP_SCALE
= 1 << 0,
173 OMAP_DSS_OVL_CAP_DISPC
= 1 << 1,
176 enum omap_overlay_manager_caps
{
177 OMAP_DSS_OVL_MGR_CAP_DISPC
= 1 << 0,
180 enum omap_dss_clk_source
{
181 OMAP_DSS_CLK_SRC_FCK
= 0, /* OMAP2/3: DSS1_ALWON_FCLK
183 OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DISPC
, /* OMAP3: DSI1_PLL_FCLK
184 * OMAP4: PLL1_CLK1 */
185 OMAP_DSS_CLK_SRC_DSI_PLL_HSDIV_DSI
, /* OMAP3: DSI2_PLL_FCLK
186 * OMAP4: PLL1_CLK2 */
187 OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DISPC
, /* OMAP4: PLL2_CLK1 */
188 OMAP_DSS_CLK_SRC_DSI2_PLL_HSDIV_DSI
, /* OMAP4: PLL2_CLK2 */
193 struct rfbi_timings
{
207 u32 tim
[5]; /* set by rfbi_convert_timings() */
212 void omap_rfbi_write_command(const void *buf
, u32 len
);
213 void omap_rfbi_read_data(void *buf
, u32 len
);
214 void omap_rfbi_write_data(const void *buf
, u32 len
);
215 void omap_rfbi_write_pixels(const void __iomem
*buf
, int scr_width
,
218 int omap_rfbi_enable_te(bool enable
, unsigned line
);
219 int omap_rfbi_setup_te(enum omap_rfbi_te_mode mode
,
220 unsigned hs_pulse_time
, unsigned vs_pulse_time
,
221 int hs_pol_inv
, int vs_pol_inv
, int extif_div
);
222 void rfbi_bus_lock(void);
223 void rfbi_bus_unlock(void);
226 void dsi_bus_lock(struct omap_dss_device
*dssdev
);
227 void dsi_bus_unlock(struct omap_dss_device
*dssdev
);
228 int dsi_vc_dcs_write(struct omap_dss_device
*dssdev
, int channel
, u8
*data
,
230 int dsi_vc_dcs_write_0(struct omap_dss_device
*dssdev
, int channel
,
232 int dsi_vc_dcs_write_1(struct omap_dss_device
*dssdev
, int channel
, u8 dcs_cmd
,
234 int dsi_vc_dcs_write_nosync(struct omap_dss_device
*dssdev
, int channel
,
236 int dsi_vc_dcs_read(struct omap_dss_device
*dssdev
, int channel
, u8 dcs_cmd
,
237 u8
*buf
, int buflen
);
238 int dsi_vc_dcs_read_1(struct omap_dss_device
*dssdev
, int channel
, u8 dcs_cmd
,
240 int dsi_vc_dcs_read_2(struct omap_dss_device
*dssdev
, int channel
, u8 dcs_cmd
,
241 u8
*data1
, u8
*data2
);
242 int dsi_vc_set_max_rx_packet_size(struct omap_dss_device
*dssdev
, int channel
,
244 int dsi_vc_send_null(struct omap_dss_device
*dssdev
, int channel
);
245 int dsi_vc_send_bta_sync(struct omap_dss_device
*dssdev
, int channel
);
247 /* Board specific data */
248 struct omap_dss_board_info
{
249 int (*get_last_off_on_transaction_id
)(struct device
*dev
);
251 struct omap_dss_device
**devices
;
252 struct omap_dss_device
*default_device
;
253 void (*dsi_mux_pads
)(bool enable
);
256 #if defined(CONFIG_OMAP2_DSS_MODULE) || defined(CONFIG_OMAP2_DSS)
257 /* Init with the board info */
258 extern int omap_display_init(struct omap_dss_board_info
*board_data
);
260 static inline int omap_display_init(struct omap_dss_board_info
*board_data
)
266 struct omap_display_platform_data
{
267 struct omap_dss_board_info
*board_data
;
268 /* TODO: Additional members to be added when PM is considered */
270 bool (*opt_clock_available
)(const char *clk_role
);
273 struct omap_video_timings
{
280 /* Unit: pixel clocks */
281 u16 hsw
; /* Horizontal synchronization pulse width */
282 /* Unit: pixel clocks */
283 u16 hfp
; /* Horizontal front porch */
284 /* Unit: pixel clocks */
285 u16 hbp
; /* Horizontal back porch */
286 /* Unit: line clocks */
287 u16 vsw
; /* Vertical synchronization pulse width */
288 /* Unit: line clocks */
289 u16 vfp
; /* Vertical front porch */
290 /* Unit: line clocks */
291 u16 vbp
; /* Vertical back porch */
294 #ifdef CONFIG_OMAP2_DSS_VENC
295 /* Hardcoded timings for tv modes. Venc only uses these to
296 * identify the mode, and does not actually use the configs
297 * itself. However, the configs should be something that
298 * a normal monitor can also show */
299 extern const struct omap_video_timings omap_dss_pal_timings
;
300 extern const struct omap_video_timings omap_dss_ntsc_timings
;
303 struct omap_overlay_info
{
308 u32 p_uv_addr
; /* for NV12 format */
312 enum omap_color_mode color_mode
;
314 enum omap_dss_rotation_type rotation_type
;
319 u16 out_width
; /* if 0, out_width == width */
320 u16 out_height
; /* if 0, out_height == height */
325 struct omap_overlay
{
327 struct list_head list
;
332 enum omap_color_mode supported_modes
;
333 enum omap_overlay_caps caps
;
336 struct omap_overlay_manager
*manager
;
337 struct omap_overlay_info info
;
339 /* if true, info has been changed, but not applied() yet */
342 int (*set_manager
)(struct omap_overlay
*ovl
,
343 struct omap_overlay_manager
*mgr
);
344 int (*unset_manager
)(struct omap_overlay
*ovl
);
346 int (*set_overlay_info
)(struct omap_overlay
*ovl
,
347 struct omap_overlay_info
*info
);
348 void (*get_overlay_info
)(struct omap_overlay
*ovl
,
349 struct omap_overlay_info
*info
);
351 int (*wait_for_go
)(struct omap_overlay
*ovl
);
354 struct omap_overlay_manager_info
{
357 enum omap_dss_trans_key_type trans_key_type
;
364 struct omap_overlay_manager
{
366 struct list_head list
;
371 enum omap_overlay_manager_caps caps
;
373 struct omap_overlay
**overlays
;
374 enum omap_display_type supported_displays
;
377 struct omap_dss_device
*device
;
378 struct omap_overlay_manager_info info
;
381 /* if true, info has been changed but not applied() yet */
384 int (*set_device
)(struct omap_overlay_manager
*mgr
,
385 struct omap_dss_device
*dssdev
);
386 int (*unset_device
)(struct omap_overlay_manager
*mgr
);
388 int (*set_manager_info
)(struct omap_overlay_manager
*mgr
,
389 struct omap_overlay_manager_info
*info
);
390 void (*get_manager_info
)(struct omap_overlay_manager
*mgr
,
391 struct omap_overlay_manager_info
*info
);
393 int (*apply
)(struct omap_overlay_manager
*mgr
);
394 int (*wait_for_go
)(struct omap_overlay_manager
*mgr
);
395 int (*wait_for_vsync
)(struct omap_overlay_manager
*mgr
);
397 int (*enable
)(struct omap_overlay_manager
*mgr
);
398 int (*disable
)(struct omap_overlay_manager
*mgr
);
401 struct omap_dss_device
{
404 enum omap_display_type type
;
406 enum omap_channel channel
;
441 enum omap_dss_venc_type type
;
442 bool invert_polarity
;
451 enum omap_dss_clk_source lcd_clk_src
;
454 enum omap_dss_clk_source dispc_fclk_src
;
464 enum omap_dss_clk_source dsi_fclk_src
;
474 struct omap_video_timings timings
;
476 int acbi
; /* ac-bias pin transitions per interrupt */
477 /* Unit: line clocks */
478 int acb
; /* ac-bias pin frequency */
480 enum omap_panel_config config
;
485 struct rfbi_timings rfbi_timings
;
490 int max_backlight_level
;
494 /* used to match device to driver */
495 const char *driver_name
;
499 struct omap_dss_driver
*driver
;
501 /* helper variable for driver suspend/resume */
502 bool activate_after_resume
;
504 enum omap_display_caps caps
;
506 struct omap_overlay_manager
*manager
;
508 enum omap_dss_display_state state
;
510 /* platform specific */
511 int (*platform_enable
)(struct omap_dss_device
*dssdev
);
512 void (*platform_disable
)(struct omap_dss_device
*dssdev
);
513 int (*set_backlight
)(struct omap_dss_device
*dssdev
, int level
);
514 int (*get_backlight
)(struct omap_dss_device
*dssdev
);
517 struct omap_dss_driver
{
518 struct device_driver driver
;
520 int (*probe
)(struct omap_dss_device
*);
521 void (*remove
)(struct omap_dss_device
*);
523 int (*enable
)(struct omap_dss_device
*display
);
524 void (*disable
)(struct omap_dss_device
*display
);
525 int (*suspend
)(struct omap_dss_device
*display
);
526 int (*resume
)(struct omap_dss_device
*display
);
527 int (*run_test
)(struct omap_dss_device
*display
, int test
);
529 int (*set_update_mode
)(struct omap_dss_device
*dssdev
,
530 enum omap_dss_update_mode
);
531 enum omap_dss_update_mode (*get_update_mode
)(
532 struct omap_dss_device
*dssdev
);
534 int (*update
)(struct omap_dss_device
*dssdev
,
535 u16 x
, u16 y
, u16 w
, u16 h
);
536 int (*sync
)(struct omap_dss_device
*dssdev
);
538 int (*enable_te
)(struct omap_dss_device
*dssdev
, bool enable
);
539 int (*get_te
)(struct omap_dss_device
*dssdev
);
541 u8 (*get_rotate
)(struct omap_dss_device
*dssdev
);
542 int (*set_rotate
)(struct omap_dss_device
*dssdev
, u8 rotate
);
544 bool (*get_mirror
)(struct omap_dss_device
*dssdev
);
545 int (*set_mirror
)(struct omap_dss_device
*dssdev
, bool enable
);
547 int (*memory_read
)(struct omap_dss_device
*dssdev
,
548 void *buf
, size_t size
,
549 u16 x
, u16 y
, u16 w
, u16 h
);
551 void (*get_resolution
)(struct omap_dss_device
*dssdev
,
552 u16
*xres
, u16
*yres
);
553 void (*get_dimensions
)(struct omap_dss_device
*dssdev
,
554 u32
*width
, u32
*height
);
555 int (*get_recommended_bpp
)(struct omap_dss_device
*dssdev
);
557 int (*check_timings
)(struct omap_dss_device
*dssdev
,
558 struct omap_video_timings
*timings
);
559 void (*set_timings
)(struct omap_dss_device
*dssdev
,
560 struct omap_video_timings
*timings
);
561 void (*get_timings
)(struct omap_dss_device
*dssdev
,
562 struct omap_video_timings
*timings
);
564 int (*set_wss
)(struct omap_dss_device
*dssdev
, u32 wss
);
565 u32 (*get_wss
)(struct omap_dss_device
*dssdev
);
568 int omap_dss_register_driver(struct omap_dss_driver
*);
569 void omap_dss_unregister_driver(struct omap_dss_driver
*);
571 void omap_dss_get_device(struct omap_dss_device
*dssdev
);
572 void omap_dss_put_device(struct omap_dss_device
*dssdev
);
573 #define for_each_dss_dev(d) while ((d = omap_dss_get_next_device(d)) != NULL)
574 struct omap_dss_device
*omap_dss_get_next_device(struct omap_dss_device
*from
);
575 struct omap_dss_device
*omap_dss_find_device(void *data
,
576 int (*match
)(struct omap_dss_device
*dssdev
, void *data
));
578 int omap_dss_start_device(struct omap_dss_device
*dssdev
);
579 void omap_dss_stop_device(struct omap_dss_device
*dssdev
);
581 int omap_dss_get_num_overlay_managers(void);
582 struct omap_overlay_manager
*omap_dss_get_overlay_manager(int num
);
584 int omap_dss_get_num_overlays(void);
585 struct omap_overlay
*omap_dss_get_overlay(int num
);
587 void omapdss_default_get_resolution(struct omap_dss_device
*dssdev
,
588 u16
*xres
, u16
*yres
);
589 int omapdss_default_get_recommended_bpp(struct omap_dss_device
*dssdev
);
591 typedef void (*omap_dispc_isr_t
) (void *arg
, u32 mask
);
592 int omap_dispc_register_isr(omap_dispc_isr_t isr
, void *arg
, u32 mask
);
593 int omap_dispc_unregister_isr(omap_dispc_isr_t isr
, void *arg
, u32 mask
);
595 int omap_dispc_wait_for_irq_timeout(u32 irqmask
, unsigned long timeout
);
596 int omap_dispc_wait_for_irq_interruptible_timeout(u32 irqmask
,
597 unsigned long timeout
);
599 #define to_dss_driver(x) container_of((x), struct omap_dss_driver, driver)
600 #define to_dss_device(x) container_of((x), struct omap_dss_device, dev)
602 void omapdss_dsi_vc_enable_hs(struct omap_dss_device
*dssdev
, int channel
,
604 int omapdss_dsi_enable_te(struct omap_dss_device
*dssdev
, bool enable
);
606 int omap_dsi_prepare_update(struct omap_dss_device
*dssdev
,
607 u16
*x
, u16
*y
, u16
*w
, u16
*h
,
608 bool enlarge_update_area
);
609 int omap_dsi_update(struct omap_dss_device
*dssdev
,
611 u16 x
, u16 y
, u16 w
, u16 h
,
612 void (*callback
)(int, void *), void *data
);
613 int omap_dsi_request_vc(struct omap_dss_device
*dssdev
, int *channel
);
614 int omap_dsi_set_vc_id(struct omap_dss_device
*dssdev
, int channel
, int vc_id
);
615 void omap_dsi_release_vc(struct omap_dss_device
*dssdev
, int channel
);
617 int omapdss_dsi_display_enable(struct omap_dss_device
*dssdev
);
618 void omapdss_dsi_display_disable(struct omap_dss_device
*dssdev
,
619 bool disconnect_lanes
, bool enter_ulps
);
621 int omapdss_dpi_display_enable(struct omap_dss_device
*dssdev
);
622 void omapdss_dpi_display_disable(struct omap_dss_device
*dssdev
);
623 void dpi_set_timings(struct omap_dss_device
*dssdev
,
624 struct omap_video_timings
*timings
);
625 int dpi_check_timings(struct omap_dss_device
*dssdev
,
626 struct omap_video_timings
*timings
);
628 int omapdss_sdi_display_enable(struct omap_dss_device
*dssdev
);
629 void omapdss_sdi_display_disable(struct omap_dss_device
*dssdev
);
631 int omapdss_rfbi_display_enable(struct omap_dss_device
*dssdev
);
632 void omapdss_rfbi_display_disable(struct omap_dss_device
*dssdev
);
633 int omap_rfbi_prepare_update(struct omap_dss_device
*dssdev
,
634 u16
*x
, u16
*y
, u16
*w
, u16
*h
);
635 int omap_rfbi_update(struct omap_dss_device
*dssdev
,
636 u16 x
, u16 y
, u16 w
, u16 h
,
637 void (*callback
)(void *), void *data
);
638 int omap_rfbi_configure(struct omap_dss_device
*dssdev
, int pixel_size
,