xref: /openbmc/linux/drivers/gpu/drm/omapdrm/dss/dss.h (revision cfbb9be8)
1 /*
2  * Copyright (C) 2009 Nokia Corporation
3  * Author: Tomi Valkeinen <tomi.valkeinen@nokia.com>
4  *
5  * Some code and ideas taken from drivers/video/omap/ driver
6  * by Imre Deak.
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License version 2 as published by
10  * the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  * more details.
16  *
17  * You should have received a copy of the GNU General Public License along with
18  * this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __OMAP2_DSS_H
22 #define __OMAP2_DSS_H
23 
24 #include <linux/interrupt.h>
25 
26 #include "omapdss.h"
27 
28 #define MAX_DSS_LCD_MANAGERS	3
29 #define MAX_NUM_DSI		2
30 
31 #ifdef pr_fmt
32 #undef pr_fmt
33 #endif
34 
35 #ifdef DSS_SUBSYS_NAME
36 #define pr_fmt(fmt) DSS_SUBSYS_NAME ": " fmt
37 #else
38 #define pr_fmt(fmt) fmt
39 #endif
40 
41 #define DSSDBG(format, ...) \
42 	pr_debug(format, ## __VA_ARGS__)
43 
44 #ifdef DSS_SUBSYS_NAME
45 #define DSSERR(format, ...) \
46 	pr_err("omapdss " DSS_SUBSYS_NAME " error: " format, ##__VA_ARGS__)
47 #else
48 #define DSSERR(format, ...) \
49 	pr_err("omapdss error: " format, ##__VA_ARGS__)
50 #endif
51 
52 #ifdef DSS_SUBSYS_NAME
53 #define DSSINFO(format, ...) \
54 	pr_info("omapdss " DSS_SUBSYS_NAME ": " format, ##__VA_ARGS__)
55 #else
56 #define DSSINFO(format, ...) \
57 	pr_info("omapdss: " format, ## __VA_ARGS__)
58 #endif
59 
60 #ifdef DSS_SUBSYS_NAME
61 #define DSSWARN(format, ...) \
62 	pr_warn("omapdss " DSS_SUBSYS_NAME ": " format, ##__VA_ARGS__)
63 #else
64 #define DSSWARN(format, ...) \
65 	pr_warn("omapdss: " format, ##__VA_ARGS__)
66 #endif
67 
68 /* OMAP TRM gives bitfields as start:end, where start is the higher bit
69    number. For example 7:0 */
70 #define FLD_MASK(start, end)	(((1 << ((start) - (end) + 1)) - 1) << (end))
71 #define FLD_VAL(val, start, end) (((val) << (end)) & FLD_MASK(start, end))
72 #define FLD_GET(val, start, end) (((val) & FLD_MASK(start, end)) >> (end))
73 #define FLD_MOD(orig, val, start, end) \
74 	(((orig) & ~FLD_MASK(start, end)) | FLD_VAL(val, start, end))
75 
76 enum dss_model {
77 	DSS_MODEL_OMAP2,
78 	DSS_MODEL_OMAP3,
79 	DSS_MODEL_OMAP4,
80 	DSS_MODEL_OMAP5,
81 	DSS_MODEL_DRA7,
82 };
83 
84 enum dss_io_pad_mode {
85 	DSS_IO_PAD_MODE_RESET,
86 	DSS_IO_PAD_MODE_RFBI,
87 	DSS_IO_PAD_MODE_BYPASS,
88 };
89 
90 enum dss_hdmi_venc_clk_source_select {
91 	DSS_VENC_TV_CLK = 0,
92 	DSS_HDMI_M_PCLK = 1,
93 };
94 
95 enum dss_dsi_content_type {
96 	DSS_DSI_CONTENT_DCS,
97 	DSS_DSI_CONTENT_GENERIC,
98 };
99 
100 enum dss_writeback_channel {
101 	DSS_WB_LCD1_MGR =	0,
102 	DSS_WB_LCD2_MGR =	1,
103 	DSS_WB_TV_MGR =		2,
104 	DSS_WB_OVL0 =		3,
105 	DSS_WB_OVL1 =		4,
106 	DSS_WB_OVL2 =		5,
107 	DSS_WB_OVL3 =		6,
108 	DSS_WB_LCD3_MGR =	7,
109 };
110 
111 enum dss_clk_source {
112 	DSS_CLK_SRC_FCK = 0,
113 
114 	DSS_CLK_SRC_PLL1_1,
115 	DSS_CLK_SRC_PLL1_2,
116 	DSS_CLK_SRC_PLL1_3,
117 
118 	DSS_CLK_SRC_PLL2_1,
119 	DSS_CLK_SRC_PLL2_2,
120 	DSS_CLK_SRC_PLL2_3,
121 
122 	DSS_CLK_SRC_HDMI_PLL,
123 };
124 
125 enum dss_pll_id {
126 	DSS_PLL_DSI1,
127 	DSS_PLL_DSI2,
128 	DSS_PLL_HDMI,
129 	DSS_PLL_VIDEO1,
130 	DSS_PLL_VIDEO2,
131 };
132 
133 struct dss_pll;
134 
135 #define DSS_PLL_MAX_HSDIVS 4
136 
137 enum dss_pll_type {
138 	DSS_PLL_TYPE_A,
139 	DSS_PLL_TYPE_B,
140 };
141 
142 /*
143  * Type-A PLLs: clkout[]/mX[] refer to hsdiv outputs m4, m5, m6, m7.
144  * Type-B PLLs: clkout[0] refers to m2.
145  */
146 struct dss_pll_clock_info {
147 	/* rates that we get with dividers below */
148 	unsigned long fint;
149 	unsigned long clkdco;
150 	unsigned long clkout[DSS_PLL_MAX_HSDIVS];
151 
152 	/* dividers */
153 	u16 n;
154 	u16 m;
155 	u32 mf;
156 	u16 mX[DSS_PLL_MAX_HSDIVS];
157 	u16 sd;
158 };
159 
160 struct dss_pll_ops {
161 	int (*enable)(struct dss_pll *pll);
162 	void (*disable)(struct dss_pll *pll);
163 	int (*set_config)(struct dss_pll *pll,
164 		const struct dss_pll_clock_info *cinfo);
165 };
166 
167 struct dss_pll_hw {
168 	enum dss_pll_type type;
169 
170 	unsigned n_max;
171 	unsigned m_min;
172 	unsigned m_max;
173 	unsigned mX_max;
174 
175 	unsigned long fint_min, fint_max;
176 	unsigned long clkdco_min, clkdco_low, clkdco_max;
177 
178 	u8 n_msb, n_lsb;
179 	u8 m_msb, m_lsb;
180 	u8 mX_msb[DSS_PLL_MAX_HSDIVS], mX_lsb[DSS_PLL_MAX_HSDIVS];
181 
182 	bool has_stopmode;
183 	bool has_freqsel;
184 	bool has_selfreqdco;
185 	bool has_refsel;
186 
187 	/* DRA7 errata i886: use high N & M to avoid jitter */
188 	bool errata_i886;
189 };
190 
191 struct dss_pll {
192 	const char *name;
193 	enum dss_pll_id id;
194 
195 	struct clk *clkin;
196 	struct regulator *regulator;
197 
198 	void __iomem *base;
199 
200 	const struct dss_pll_hw *hw;
201 
202 	const struct dss_pll_ops *ops;
203 
204 	struct dss_pll_clock_info cinfo;
205 };
206 
207 /* Defines a generic omap register field */
208 struct dss_reg_field {
209 	u8 start, end;
210 };
211 
212 struct dispc_clock_info {
213 	/* rates that we get with dividers below */
214 	unsigned long lck;
215 	unsigned long pck;
216 
217 	/* dividers */
218 	u16 lck_div;
219 	u16 pck_div;
220 };
221 
222 struct dss_lcd_mgr_config {
223 	enum dss_io_pad_mode io_pad_mode;
224 
225 	bool stallmode;
226 	bool fifohandcheck;
227 
228 	struct dispc_clock_info clock_info;
229 
230 	int video_port_width;
231 
232 	int lcden_sig_polarity;
233 };
234 
235 struct seq_file;
236 struct platform_device;
237 
238 /* core */
239 static inline int dss_set_min_bus_tput(struct device *dev, unsigned long tput)
240 {
241 	/* To be implemented when the OMAP platform will provide this feature */
242 	return 0;
243 }
244 
245 static inline bool dss_mgr_is_lcd(enum omap_channel id)
246 {
247 	if (id == OMAP_DSS_CHANNEL_LCD || id == OMAP_DSS_CHANNEL_LCD2 ||
248 			id == OMAP_DSS_CHANNEL_LCD3)
249 		return true;
250 	else
251 		return false;
252 }
253 
254 /* DSS */
255 #if defined(CONFIG_OMAP2_DSS_DEBUGFS)
256 int dss_debugfs_create_file(const char *name, void (*write)(struct seq_file *));
257 #else
258 static inline int dss_debugfs_create_file(const char *name,
259 					  void (*write)(struct seq_file *))
260 {
261 	return 0;
262 }
263 #endif /* CONFIG_OMAP2_DSS_DEBUGFS */
264 
265 int dss_runtime_get(void);
266 void dss_runtime_put(void);
267 
268 unsigned long dss_get_dispc_clk_rate(void);
269 unsigned long dss_get_max_fck_rate(void);
270 enum omap_dss_output_id dss_get_supported_outputs(enum omap_channel channel);
271 int dss_dpi_select_source(int port, enum omap_channel channel);
272 void dss_select_hdmi_venc_clk_source(enum dss_hdmi_venc_clk_source_select);
273 enum dss_hdmi_venc_clk_source_select dss_get_hdmi_venc_clk_source(void);
274 const char *dss_get_clk_source_name(enum dss_clk_source clk_src);
275 
276 /* DSS VIDEO PLL */
277 struct dss_pll *dss_video_pll_init(struct platform_device *pdev, int id,
278 	struct regulator *regulator);
279 void dss_video_pll_uninit(struct dss_pll *pll);
280 
281 void dss_ctrl_pll_enable(enum dss_pll_id pll_id, bool enable);
282 
283 void dss_sdi_init(int datapairs);
284 int dss_sdi_enable(void);
285 void dss_sdi_disable(void);
286 
287 void dss_select_dsi_clk_source(int dsi_module,
288 		enum dss_clk_source clk_src);
289 void dss_select_lcd_clk_source(enum omap_channel channel,
290 		enum dss_clk_source clk_src);
291 enum dss_clk_source dss_get_dispc_clk_source(void);
292 enum dss_clk_source dss_get_dsi_clk_source(int dsi_module);
293 enum dss_clk_source dss_get_lcd_clk_source(enum omap_channel channel);
294 
295 void dss_set_venc_output(enum omap_dss_venc_type type);
296 void dss_set_dac_pwrdn_bgz(bool enable);
297 
298 int dss_set_fck_rate(unsigned long rate);
299 
300 typedef bool (*dss_div_calc_func)(unsigned long fck, void *data);
301 bool dss_div_calc(unsigned long pck, unsigned long fck_min,
302 		dss_div_calc_func func, void *data);
303 
304 /* SDI */
305 #ifdef CONFIG_OMAP2_DSS_SDI
306 int sdi_init_port(struct platform_device *pdev, struct device_node *port);
307 void sdi_uninit_port(struct device_node *port);
308 #else
309 static inline int sdi_init_port(struct platform_device *pdev,
310 		struct device_node *port)
311 {
312 	return 0;
313 }
314 static inline void sdi_uninit_port(struct device_node *port)
315 {
316 }
317 #endif
318 
319 /* DSI */
320 
321 #ifdef CONFIG_OMAP2_DSS_DSI
322 
323 struct dentry;
324 struct file_operations;
325 
326 void dsi_dump_clocks(struct seq_file *s);
327 
328 void dsi_irq_handler(void);
329 
330 #endif
331 
332 /* DPI */
333 #ifdef CONFIG_OMAP2_DSS_DPI
334 int dpi_init_port(struct platform_device *pdev, struct device_node *port,
335 		  enum dss_model dss_model);
336 void dpi_uninit_port(struct device_node *port);
337 #else
338 static inline int dpi_init_port(struct platform_device *pdev,
339 		struct device_node *port, enum dss_model dss_model)
340 {
341 	return 0;
342 }
343 static inline void dpi_uninit_port(struct device_node *port)
344 {
345 }
346 #endif
347 
348 /* DISPC */
349 void dispc_dump_clocks(struct seq_file *s);
350 
351 int dispc_runtime_get(void);
352 void dispc_runtime_put(void);
353 
354 void dispc_enable_sidle(void);
355 void dispc_disable_sidle(void);
356 
357 void dispc_lcd_enable_signal(bool enable);
358 void dispc_pck_free_enable(bool enable);
359 void dispc_enable_fifomerge(bool enable);
360 void dispc_enable_gamma_table(bool enable);
361 
362 typedef bool (*dispc_div_calc_func)(int lckd, int pckd, unsigned long lck,
363 		unsigned long pck, void *data);
364 bool dispc_div_calc(unsigned long dispc,
365 		unsigned long pck_min, unsigned long pck_max,
366 		dispc_div_calc_func func, void *data);
367 
368 bool dispc_mgr_timings_ok(enum omap_channel channel, const struct videomode *vm);
369 int dispc_calc_clock_rates(unsigned long dispc_fclk_rate,
370 		struct dispc_clock_info *cinfo);
371 
372 
373 void dispc_ovl_set_fifo_threshold(enum omap_plane_id plane, u32 low,
374 				  u32 high);
375 void dispc_ovl_compute_fifo_thresholds(enum omap_plane_id plane,
376 		u32 *fifo_low, u32 *fifo_high, bool use_fifomerge,
377 		bool manual_update);
378 
379 void dispc_mgr_set_clock_div(enum omap_channel channel,
380 		const struct dispc_clock_info *cinfo);
381 int dispc_mgr_get_clock_div(enum omap_channel channel,
382 		struct dispc_clock_info *cinfo);
383 void dispc_set_tv_pclk(unsigned long pclk);
384 
385 u32 dispc_wb_get_framedone_irq(void);
386 bool dispc_wb_go_busy(void);
387 void dispc_wb_go(void);
388 void dispc_wb_set_channel_in(enum dss_writeback_channel channel);
389 int dispc_wb_setup(const struct omap_dss_writeback_info *wi,
390 		bool mem_to_mem, const struct videomode *vm);
391 
392 #ifdef CONFIG_OMAP2_DSS_COLLECT_IRQ_STATS
393 static inline void dss_collect_irq_stats(u32 irqstatus, unsigned *irq_arr)
394 {
395 	int b;
396 	for (b = 0; b < 32; ++b) {
397 		if (irqstatus & (1 << b))
398 			irq_arr[b]++;
399 	}
400 }
401 #endif
402 
403 /* PLL */
404 typedef bool (*dss_pll_calc_func)(int n, int m, unsigned long fint,
405 		unsigned long clkdco, void *data);
406 typedef bool (*dss_hsdiv_calc_func)(int m_dispc, unsigned long dispc,
407 		void *data);
408 
409 int dss_pll_register(struct dss_pll *pll);
410 void dss_pll_unregister(struct dss_pll *pll);
411 struct dss_pll *dss_pll_find(const char *name);
412 struct dss_pll *dss_pll_find_by_src(enum dss_clk_source src);
413 unsigned dss_pll_get_clkout_idx_for_src(enum dss_clk_source src);
414 int dss_pll_enable(struct dss_pll *pll);
415 void dss_pll_disable(struct dss_pll *pll);
416 int dss_pll_set_config(struct dss_pll *pll,
417 		const struct dss_pll_clock_info *cinfo);
418 
419 bool dss_pll_hsdiv_calc_a(const struct dss_pll *pll, unsigned long clkdco,
420 		unsigned long out_min, unsigned long out_max,
421 		dss_hsdiv_calc_func func, void *data);
422 bool dss_pll_calc_a(const struct dss_pll *pll, unsigned long clkin,
423 		unsigned long pll_min, unsigned long pll_max,
424 		dss_pll_calc_func func, void *data);
425 
426 bool dss_pll_calc_b(const struct dss_pll *pll, unsigned long clkin,
427 	unsigned long target_clkout, struct dss_pll_clock_info *cinfo);
428 
429 int dss_pll_write_config_type_a(struct dss_pll *pll,
430 		const struct dss_pll_clock_info *cinfo);
431 int dss_pll_write_config_type_b(struct dss_pll *pll,
432 		const struct dss_pll_clock_info *cinfo);
433 int dss_pll_wait_reset_done(struct dss_pll *pll);
434 
435 extern struct platform_driver omap_dsshw_driver;
436 extern struct platform_driver omap_dispchw_driver;
437 #ifdef CONFIG_OMAP2_DSS_DSI
438 extern struct platform_driver omap_dsihw_driver;
439 #endif
440 #ifdef CONFIG_OMAP2_DSS_VENC
441 extern struct platform_driver omap_venchw_driver;
442 #endif
443 #ifdef CONFIG_OMAP4_DSS_HDMI
444 extern struct platform_driver omapdss_hdmi4hw_driver;
445 #endif
446 #ifdef CONFIG_OMAP5_DSS_HDMI
447 extern struct platform_driver omapdss_hdmi5hw_driver;
448 #endif
449 
450 #endif
451