692d6501b4e8377130829efa6f457c3ff2746423
[linux-3.10.git] / drivers / video / omap2 / dss / dss.h
1 /*
2  * linux/drivers/video/omap2/dss/dss.h
3  *
4  * Copyright (C) 2009 Nokia Corporation
5  * Author: Tomi Valkeinen <tomi.valkeinen@nokia.com>
6  *
7  * Some code and ideas taken from drivers/video/omap/ driver
8  * by Imre Deak.
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU General Public License version 2 as published by
12  * the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but WITHOUT
15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
17  * more details.
18  *
19  * You should have received a copy of the GNU General Public License along with
20  * this program.  If not, see <http://www.gnu.org/licenses/>.
21  */
22
23 #ifndef __OMAP2_DSS_H
24 #define __OMAP2_DSS_H
25
26 #ifdef CONFIG_OMAP2_DSS_DEBUG_SUPPORT
27 #define DEBUG
28 #endif
29
30 #ifdef DEBUG
31 extern bool dss_debug;
32 #ifdef DSS_SUBSYS_NAME
33 #define DSSDBG(format, ...) \
34         if (dss_debug) \
35                 printk(KERN_DEBUG "omapdss " DSS_SUBSYS_NAME ": " format, \
36                 ## __VA_ARGS__)
37 #else
38 #define DSSDBG(format, ...) \
39         if (dss_debug) \
40                 printk(KERN_DEBUG "omapdss: " format, ## __VA_ARGS__)
41 #endif
42
43 #ifdef DSS_SUBSYS_NAME
44 #define DSSDBGF(format, ...) \
45         if (dss_debug) \
46                 printk(KERN_DEBUG "omapdss " DSS_SUBSYS_NAME \
47                                 ": %s(" format ")\n", \
48                                 __func__, \
49                                 ## __VA_ARGS__)
50 #else
51 #define DSSDBGF(format, ...) \
52         if (dss_debug) \
53                 printk(KERN_DEBUG "omapdss: " \
54                                 ": %s(" format ")\n", \
55                                 __func__, \
56                                 ## __VA_ARGS__)
57 #endif
58
59 #else /* DEBUG */
60 #define DSSDBG(format, ...)
61 #define DSSDBGF(format, ...)
62 #endif
63
64
65 #ifdef DSS_SUBSYS_NAME
66 #define DSSERR(format, ...) \
67         printk(KERN_ERR "omapdss " DSS_SUBSYS_NAME " error: " format, \
68         ## __VA_ARGS__)
69 #else
70 #define DSSERR(format, ...) \
71         printk(KERN_ERR "omapdss error: " format, ## __VA_ARGS__)
72 #endif
73
74 #ifdef DSS_SUBSYS_NAME
75 #define DSSINFO(format, ...) \
76         printk(KERN_INFO "omapdss " DSS_SUBSYS_NAME ": " format, \
77         ## __VA_ARGS__)
78 #else
79 #define DSSINFO(format, ...) \
80         printk(KERN_INFO "omapdss: " format, ## __VA_ARGS__)
81 #endif
82
83 #ifdef DSS_SUBSYS_NAME
84 #define DSSWARN(format, ...) \
85         printk(KERN_WARNING "omapdss " DSS_SUBSYS_NAME ": " format, \
86         ## __VA_ARGS__)
87 #else
88 #define DSSWARN(format, ...) \
89         printk(KERN_WARNING "omapdss: " format, ## __VA_ARGS__)
90 #endif
91
92 /* OMAP TRM gives bitfields as start:end, where start is the higher bit
93    number. For example 7:0 */
94 #define FLD_MASK(start, end)    (((1 << ((start) - (end) + 1)) - 1) << (end))
95 #define FLD_VAL(val, start, end) (((val) << (end)) & FLD_MASK(start, end))
96 #define FLD_GET(val, start, end) (((val) & FLD_MASK(start, end)) >> (end))
97 #define FLD_MOD(orig, val, start, end) \
98         (((orig) & ~FLD_MASK(start, end)) | FLD_VAL(val, start, end))
99
100 enum dss_io_pad_mode {
101         DSS_IO_PAD_MODE_RESET,
102         DSS_IO_PAD_MODE_RFBI,
103         DSS_IO_PAD_MODE_BYPASS,
104 };
105
106 enum dss_hdmi_venc_clk_source_select {
107         DSS_VENC_TV_CLK = 0,
108         DSS_HDMI_M_PCLK = 1,
109 };
110
111 enum dss_dsi_content_type {
112         DSS_DSI_CONTENT_DCS,
113         DSS_DSI_CONTENT_GENERIC,
114 };
115
116 struct dss_clock_info {
117         /* rates that we get with dividers below */
118         unsigned long fck;
119
120         /* dividers */
121         u16 fck_div;
122 };
123
124 struct dispc_clock_info {
125         /* rates that we get with dividers below */
126         unsigned long lck;
127         unsigned long pck;
128
129         /* dividers */
130         u16 lck_div;
131         u16 pck_div;
132 };
133
134 struct dsi_clock_info {
135         /* rates that we get with dividers below */
136         unsigned long fint;
137         unsigned long clkin4ddr;
138         unsigned long clkin;
139         unsigned long dsi_pll_hsdiv_dispc_clk;  /* OMAP3: DSI1_PLL_CLK
140                                                  * OMAP4: PLLx_CLK1 */
141         unsigned long dsi_pll_hsdiv_dsi_clk;    /* OMAP3: DSI2_PLL_CLK
142                                                  * OMAP4: PLLx_CLK2 */
143         unsigned long lp_clk;
144
145         /* dividers */
146         u16 regn;
147         u16 regm;
148         u16 regm_dispc; /* OMAP3: REGM3
149                          * OMAP4: REGM4 */
150         u16 regm_dsi;   /* OMAP3: REGM4
151                          * OMAP4: REGM5 */
152         u16 lp_clk_div;
153 };
154
155 struct reg_field {
156         u16 reg;
157         u8 high;
158         u8 low;
159 };
160
161 struct seq_file;
162 struct platform_device;
163
164 /* core */
165 struct bus_type *dss_get_bus(void);
166 struct regulator *dss_get_vdds_dsi(void);
167 struct regulator *dss_get_vdds_sdi(void);
168 int dss_get_ctx_loss_count(struct device *dev);
169 int dss_dsi_enable_pads(int dsi_id, unsigned lane_mask);
170 void dss_dsi_disable_pads(int dsi_id, unsigned lane_mask);
171 int dss_set_min_bus_tput(struct device *dev, unsigned long tput);
172 int dss_debugfs_create_file(const char *name, void (*write)(struct seq_file *));
173
174 int omap_dss_register_device(struct omap_dss_device *dssdev,
175                 struct device *parent, int disp_num);
176 void omap_dss_unregister_device(struct omap_dss_device *dssdev);
177 void omap_dss_unregister_child_devices(struct device *parent);
178
179 /* apply */
180 void dss_apply_init(void);
181 int dss_mgr_wait_for_go(struct omap_overlay_manager *mgr);
182 int dss_mgr_wait_for_go_ovl(struct omap_overlay *ovl);
183 void dss_mgr_start_update(struct omap_overlay_manager *mgr);
184 int omap_dss_mgr_apply(struct omap_overlay_manager *mgr);
185
186 int dss_mgr_enable(struct omap_overlay_manager *mgr);
187 void dss_mgr_disable(struct omap_overlay_manager *mgr);
188 int dss_mgr_set_info(struct omap_overlay_manager *mgr,
189                 struct omap_overlay_manager_info *info);
190 void dss_mgr_get_info(struct omap_overlay_manager *mgr,
191                 struct omap_overlay_manager_info *info);
192 int dss_mgr_set_device(struct omap_overlay_manager *mgr,
193                 struct omap_dss_device *dssdev);
194 int dss_mgr_unset_device(struct omap_overlay_manager *mgr);
195 void dss_mgr_set_timings(struct omap_overlay_manager *mgr,
196                 struct omap_video_timings *timings);
197 const struct omap_video_timings *dss_mgr_get_timings(struct omap_overlay_manager *mgr);
198
199 bool dss_ovl_is_enabled(struct omap_overlay *ovl);
200 int dss_ovl_enable(struct omap_overlay *ovl);
201 int dss_ovl_disable(struct omap_overlay *ovl);
202 int dss_ovl_set_info(struct omap_overlay *ovl,
203                 struct omap_overlay_info *info);
204 void dss_ovl_get_info(struct omap_overlay *ovl,
205                 struct omap_overlay_info *info);
206 int dss_ovl_set_manager(struct omap_overlay *ovl,
207                 struct omap_overlay_manager *mgr);
208 int dss_ovl_unset_manager(struct omap_overlay *ovl);
209
210 /* display */
211 int dss_suspend_all_devices(void);
212 int dss_resume_all_devices(void);
213 void dss_disable_all_devices(void);
214
215 void dss_init_device(struct platform_device *pdev,
216                 struct omap_dss_device *dssdev);
217 void dss_uninit_device(struct platform_device *pdev,
218                 struct omap_dss_device *dssdev);
219 bool dss_use_replication(struct omap_dss_device *dssdev,
220                 enum omap_color_mode mode);
221
222 /* manager */
223 int dss_init_overlay_managers(struct platform_device *pdev);
224 void dss_uninit_overlay_managers(struct platform_device *pdev);
225 int dss_mgr_simple_check(struct omap_overlay_manager *mgr,
226                 const struct omap_overlay_manager_info *info);
227 int dss_mgr_check_timings(struct omap_overlay_manager *mgr,
228                 const struct omap_video_timings *timings);
229 int dss_mgr_check(struct omap_overlay_manager *mgr,
230                 struct omap_overlay_manager_info *info,
231                 const struct omap_video_timings *mgr_timings,
232                 struct omap_overlay_info **overlay_infos);
233
234 /* overlay */
235 void dss_init_overlays(struct platform_device *pdev);
236 void dss_uninit_overlays(struct platform_device *pdev);
237 void dss_overlay_setup_dispc_manager(struct omap_overlay_manager *mgr);
238 void dss_recheck_connections(struct omap_dss_device *dssdev, bool force);
239 int dss_ovl_simple_check(struct omap_overlay *ovl,
240                 const struct omap_overlay_info *info);
241 int dss_ovl_check(struct omap_overlay *ovl, struct omap_overlay_info *info,
242                 const struct omap_video_timings *mgr_timings);
243
244 /* DSS */
245 int dss_init_platform_driver(void) __init;
246 void dss_uninit_platform_driver(void);
247
248 void dss_select_hdmi_venc_clk_source(enum dss_hdmi_venc_clk_source_select);
249 enum dss_hdmi_venc_clk_source_select dss_get_hdmi_venc_clk_source(void);
250 const char *dss_get_generic_clk_source_name(enum omap_dss_clk_source clk_src);
251 void dss_dump_clocks(struct seq_file *s);
252
253 #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_OMAP2_DSS_DEBUG_SUPPORT)
254 void dss_debug_dump_clocks(struct seq_file *s);
255 #endif
256
257 void dss_sdi_init(u8 datapairs);
258 int dss_sdi_enable(void);
259 void dss_sdi_disable(void);
260
261 void dss_select_dispc_clk_source(enum omap_dss_clk_source clk_src);
262 void dss_select_dsi_clk_source(int dsi_module,
263                 enum omap_dss_clk_source clk_src);
264 void dss_select_lcd_clk_source(enum omap_channel channel,
265                 enum omap_dss_clk_source clk_src);
266 enum omap_dss_clk_source dss_get_dispc_clk_source(void);
267 enum omap_dss_clk_source dss_get_dsi_clk_source(int dsi_module);
268 enum omap_dss_clk_source dss_get_lcd_clk_source(enum omap_channel channel);
269
270 void dss_set_venc_output(enum omap_dss_venc_type type);
271 void dss_set_dac_pwrdn_bgz(bool enable);
272
273 unsigned long dss_get_dpll4_rate(void);
274 int dss_calc_clock_rates(struct dss_clock_info *cinfo);
275 int dss_set_clock_div(struct dss_clock_info *cinfo);
276 int dss_get_clock_div(struct dss_clock_info *cinfo);
277 int dss_calc_clock_div(unsigned long req_pck, struct dss_clock_info *dss_cinfo,
278                 struct dispc_clock_info *dispc_cinfo);
279
280 /* SDI */
281 int sdi_init_platform_driver(void) __init;
282 void sdi_uninit_platform_driver(void) __exit;
283
284 /* DSI */
285 #ifdef CONFIG_OMAP2_DSS_DSI
286
287 struct dentry;
288 struct file_operations;
289
290 int dsi_init_platform_driver(void) __init;
291 void dsi_uninit_platform_driver(void) __exit;
292
293 int dsi_runtime_get(struct platform_device *dsidev);
294 void dsi_runtime_put(struct platform_device *dsidev);
295
296 void dsi_dump_clocks(struct seq_file *s);
297
298 void dsi_irq_handler(void);
299 u8 dsi_get_pixel_size(enum omap_dss_dsi_pixel_format fmt);
300
301 unsigned long dsi_get_pll_hsdiv_dispc_rate(struct platform_device *dsidev);
302 int dsi_pll_set_clock_div(struct platform_device *dsidev,
303                 struct dsi_clock_info *cinfo);
304 int dsi_pll_calc_clock_div_pck(struct platform_device *dsidev,
305                 unsigned long req_pck, struct dsi_clock_info *cinfo,
306                 struct dispc_clock_info *dispc_cinfo);
307 int dsi_pll_init(struct platform_device *dsidev, bool enable_hsclk,
308                 bool enable_hsdiv);
309 void dsi_pll_uninit(struct platform_device *dsidev, bool disconnect_lanes);
310 void dsi_wait_pll_hsdiv_dispc_active(struct platform_device *dsidev);
311 void dsi_wait_pll_hsdiv_dsi_active(struct platform_device *dsidev);
312 struct platform_device *dsi_get_dsidev_from_id(int module);
313 #else
314 static inline int dsi_runtime_get(struct platform_device *dsidev)
315 {
316         return 0;
317 }
318 static inline void dsi_runtime_put(struct platform_device *dsidev)
319 {
320 }
321 static inline u8 dsi_get_pixel_size(enum omap_dss_dsi_pixel_format fmt)
322 {
323         WARN("%s: DSI not compiled in, returning pixel_size as 0\n", __func__);
324         return 0;
325 }
326 static inline unsigned long dsi_get_pll_hsdiv_dispc_rate(struct platform_device *dsidev)
327 {
328         WARN("%s: DSI not compiled in, returning rate as 0\n", __func__);
329         return 0;
330 }
331 static inline int dsi_pll_set_clock_div(struct platform_device *dsidev,
332                 struct dsi_clock_info *cinfo)
333 {
334         WARN("%s: DSI not compiled in\n", __func__);
335         return -ENODEV;
336 }
337 static inline int dsi_pll_calc_clock_div_pck(struct platform_device *dsidev,
338                 unsigned long req_pck,
339                 struct dsi_clock_info *dsi_cinfo,
340                 struct dispc_clock_info *dispc_cinfo)
341 {
342         WARN("%s: DSI not compiled in\n", __func__);
343         return -ENODEV;
344 }
345 static inline int dsi_pll_init(struct platform_device *dsidev,
346                 bool enable_hsclk, bool enable_hsdiv)
347 {
348         WARN("%s: DSI not compiled in\n", __func__);
349         return -ENODEV;
350 }
351 static inline void dsi_pll_uninit(struct platform_device *dsidev,
352                 bool disconnect_lanes)
353 {
354 }
355 static inline void dsi_wait_pll_hsdiv_dispc_active(struct platform_device *dsidev)
356 {
357 }
358 static inline void dsi_wait_pll_hsdiv_dsi_active(struct platform_device *dsidev)
359 {
360 }
361 static inline struct platform_device *dsi_get_dsidev_from_id(int module)
362 {
363         WARN("%s: DSI not compiled in, returning platform device as NULL\n",
364                         __func__);
365         return NULL;
366 }
367 #endif
368
369 /* DPI */
370 int dpi_init_platform_driver(void) __init;
371 void dpi_uninit_platform_driver(void) __exit;
372
373 /* DISPC */
374 int dispc_init_platform_driver(void) __init;
375 void dispc_uninit_platform_driver(void) __exit;
376 void dispc_dump_clocks(struct seq_file *s);
377 void dispc_irq_handler(void);
378
379 int dispc_runtime_get(void);
380 void dispc_runtime_put(void);
381
382 void dispc_enable_sidle(void);
383 void dispc_disable_sidle(void);
384
385 void dispc_lcd_enable_signal_polarity(bool act_high);
386 void dispc_lcd_enable_signal(bool enable);
387 void dispc_pck_free_enable(bool enable);
388 void dispc_enable_fifomerge(bool enable);
389 void dispc_enable_gamma_table(bool enable);
390 void dispc_set_loadmode(enum omap_dss_load_mode mode);
391
392 bool dispc_mgr_timings_ok(enum omap_channel channel,
393                 const struct omap_video_timings *timings);
394 unsigned long dispc_fclk_rate(void);
395 void dispc_find_clk_divs(unsigned long req_pck, unsigned long fck,
396                 struct dispc_clock_info *cinfo);
397 int dispc_calc_clock_rates(unsigned long dispc_fclk_rate,
398                 struct dispc_clock_info *cinfo);
399
400
401 void dispc_ovl_set_fifo_threshold(enum omap_plane plane, u32 low, u32 high);
402 void dispc_ovl_compute_fifo_thresholds(enum omap_plane plane,
403                 u32 *fifo_low, u32 *fifo_high, bool use_fifomerge,
404                 bool manual_update);
405 int dispc_ovl_setup(enum omap_plane plane, struct omap_overlay_info *oi,
406                 bool ilace, bool replication,
407                 const struct omap_video_timings *mgr_timings);
408 int dispc_ovl_enable(enum omap_plane plane, bool enable);
409 void dispc_ovl_set_channel_out(enum omap_plane plane,
410                 enum omap_channel channel);
411
412 void dispc_mgr_enable_fifohandcheck(enum omap_channel channel, bool enable);
413 u32 dispc_mgr_get_vsync_irq(enum omap_channel channel);
414 u32 dispc_mgr_get_framedone_irq(enum omap_channel channel);
415 bool dispc_mgr_go_busy(enum omap_channel channel);
416 void dispc_mgr_go(enum omap_channel channel);
417 bool dispc_mgr_is_enabled(enum omap_channel channel);
418 void dispc_mgr_enable(enum omap_channel channel, bool enable);
419 bool dispc_mgr_is_channel_enabled(enum omap_channel channel);
420 void dispc_mgr_set_io_pad_mode(enum dss_io_pad_mode mode);
421 void dispc_mgr_enable_stallmode(enum omap_channel channel, bool enable);
422 void dispc_mgr_set_tft_data_lines(enum omap_channel channel, u8 data_lines);
423 void dispc_mgr_set_lcd_type_tft(enum omap_channel channel);
424 void dispc_mgr_set_timings(enum omap_channel channel,
425                 struct omap_video_timings *timings);
426 void dispc_mgr_set_pol_freq(enum omap_channel channel,
427                 enum omap_panel_config config, u8 acbi, u8 acb);
428 unsigned long dispc_mgr_lclk_rate(enum omap_channel channel);
429 unsigned long dispc_mgr_pclk_rate(enum omap_channel channel);
430 unsigned long dispc_core_clk_rate(void);
431 int dispc_mgr_set_clock_div(enum omap_channel channel,
432                 struct dispc_clock_info *cinfo);
433 int dispc_mgr_get_clock_div(enum omap_channel channel,
434                 struct dispc_clock_info *cinfo);
435 void dispc_mgr_setup(enum omap_channel channel,
436                 struct omap_overlay_manager_info *info);
437
438 /* VENC */
439 #ifdef CONFIG_OMAP2_DSS_VENC
440 int venc_init_platform_driver(void) __init;
441 void venc_uninit_platform_driver(void) __exit;
442 unsigned long venc_get_pixel_clock(void);
443 #else
444 static inline unsigned long venc_get_pixel_clock(void)
445 {
446         WARN("%s: VENC not compiled in, returning pclk as 0\n", __func__);
447         return 0;
448 }
449 #endif
450
451 /* HDMI */
452 #ifdef CONFIG_OMAP4_DSS_HDMI
453 int hdmi_init_platform_driver(void) __init;
454 void hdmi_uninit_platform_driver(void) __exit;
455 unsigned long hdmi_get_pixel_clock(void);
456 #else
457 static inline unsigned long hdmi_get_pixel_clock(void)
458 {
459         WARN("%s: HDMI not compiled in, returning pclk as 0\n", __func__);
460         return 0;
461 }
462 #endif
463 int omapdss_hdmi_display_enable(struct omap_dss_device *dssdev);
464 void omapdss_hdmi_display_disable(struct omap_dss_device *dssdev);
465 void omapdss_hdmi_display_set_timing(struct omap_dss_device *dssdev);
466 int omapdss_hdmi_display_check_timing(struct omap_dss_device *dssdev,
467                                         struct omap_video_timings *timings);
468 int omapdss_hdmi_read_edid(u8 *buf, int len);
469 bool omapdss_hdmi_detect(void);
470 int hdmi_panel_init(void);
471 void hdmi_panel_exit(void);
472 #ifdef CONFIG_OMAP4_DSS_HDMI_AUDIO
473 int hdmi_audio_enable(void);
474 void hdmi_audio_disable(void);
475 int hdmi_audio_start(void);
476 void hdmi_audio_stop(void);
477 bool hdmi_mode_has_audio(void);
478 int hdmi_audio_config(struct omap_dss_audio *audio);
479 #endif
480
481 /* RFBI */
482 int rfbi_init_platform_driver(void) __init;
483 void rfbi_uninit_platform_driver(void) __exit;
484
485
486 #ifdef CONFIG_OMAP2_DSS_COLLECT_IRQ_STATS
487 static inline void dss_collect_irq_stats(u32 irqstatus, unsigned *irq_arr)
488 {
489         int b;
490         for (b = 0; b < 32; ++b) {
491                 if (irqstatus & (1 << b))
492                         irq_arr[b]++;
493         }
494 }
495 #endif
496
497 #endif