Commit | Line | Data |
---|---|---|
785b93ef DA |
1 | /* |
2 | * Copyright (c) 2006-2009 Red Hat Inc. | |
3 | * Copyright (c) 2006-2008 Intel Corporation | |
4 | * Copyright (c) 2007 Dave Airlie <airlied@linux.ie> | |
5 | * | |
6 | * DRM framebuffer helper functions | |
7 | * | |
8 | * Permission to use, copy, modify, distribute, and sell this software and its | |
9 | * documentation for any purpose is hereby granted without fee, provided that | |
10 | * the above copyright notice appear in all copies and that both that copyright | |
11 | * notice and this permission notice appear in supporting documentation, and | |
12 | * that the name of the copyright holders not be used in advertising or | |
13 | * publicity pertaining to distribution of the software without specific, | |
14 | * written prior permission. The copyright holders make no representations | |
15 | * about the suitability of this software for any purpose. It is provided "as | |
16 | * is" without express or implied warranty. | |
17 | * | |
18 | * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, | |
19 | * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO | |
20 | * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR | |
21 | * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, | |
22 | * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | |
23 | * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE | |
24 | * OF THIS SOFTWARE. | |
25 | * | |
26 | * Authors: | |
27 | * Dave Airlie <airlied@linux.ie> | |
28 | * Jesse Barnes <jesse.barnes@intel.com> | |
29 | */ | |
30 | #ifndef DRM_FB_HELPER_H | |
31 | #define DRM_FB_HELPER_H | |
32 | ||
4abe3520 DA |
33 | struct drm_fb_helper; |
34 | ||
1a7aba7f JB |
35 | #include <linux/kgdb.h> |
36 | ||
b516a9ef DV |
37 | enum mode_set_atomic { |
38 | LEAVE_ATOMIC_MODE_SET, | |
39 | ENTER_ATOMIC_MODE_SET, | |
40 | }; | |
41 | ||
b0ee9e7f DA |
42 | struct drm_fb_offset { |
43 | int x, y; | |
44 | }; | |
45 | ||
785b93ef | 46 | struct drm_fb_helper_crtc { |
785b93ef | 47 | struct drm_mode_set mode_set; |
8be48d92 | 48 | struct drm_display_mode *desired_mode; |
b0ee9e7f | 49 | int x, y; |
785b93ef DA |
50 | }; |
51 | ||
b7b5ee59 RC |
52 | /** |
53 | * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size | |
54 | * @fb_width: fbdev width | |
55 | * @fb_height: fbdev height | |
56 | * @surface_width: scanout buffer width | |
57 | * @surface_height: scanout buffer height | |
58 | * @surface_bpp: scanout buffer bpp | |
59 | * @surface_depth: scanout buffer depth | |
60 | * | |
61 | * Note that the scanout surface width/height may be larger than the fbdev | |
62 | * width/height. In case of multiple displays, the scanout surface is sized | |
63 | * according to the largest width/height (so it is large enough for all CRTCs | |
64 | * to scanout). But the fbdev width/height is sized to the minimum width/ | |
65 | * height of all the displays. This ensures that fbcon fits on the smallest | |
66 | * of the attached displays. | |
67 | * | |
68 | * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height, | |
69 | * rather than the surface size. | |
70 | */ | |
38651674 DA |
71 | struct drm_fb_helper_surface_size { |
72 | u32 fb_width; | |
73 | u32 fb_height; | |
74 | u32 surface_width; | |
75 | u32 surface_height; | |
76 | u32 surface_bpp; | |
77 | u32 surface_depth; | |
78 | }; | |
79 | ||
207fd329 DV |
80 | /** |
81 | * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library | |
207fd329 DV |
82 | * |
83 | * Driver callbacks used by the fbdev emulation helper library. | |
84 | */ | |
4abe3520 | 85 | struct drm_fb_helper_funcs { |
264d6970 DV |
86 | /** |
87 | * @gamma_set: | |
88 | * | |
89 | * Set the given gamma LUT register on the given CRTC. | |
90 | * | |
91 | * This callback is optional. | |
92 | * | |
93 | * FIXME: | |
94 | * | |
95 | * This callback is functionally redundant with the core gamma table | |
96 | * support and simply exists because the fbdev hasn't yet been | |
97 | * refactored to use the core gamma table interfaces. | |
98 | */ | |
4abe3520 DA |
99 | void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green, |
100 | u16 blue, int regno); | |
264d6970 DV |
101 | /** |
102 | * @gamma_get: | |
103 | * | |
104 | * Read the given gamma LUT register on the given CRTC, used to save the | |
105 | * current LUT when force-restoring the fbdev for e.g. kdbg. | |
106 | * | |
107 | * This callback is optional. | |
108 | * | |
109 | * FIXME: | |
110 | * | |
111 | * This callback is functionally redundant with the core gamma table | |
112 | * support and simply exists because the fbdev hasn't yet been | |
113 | * refactored to use the core gamma table interfaces. | |
114 | */ | |
4abe3520 DA |
115 | void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green, |
116 | u16 *blue, int regno); | |
117 | ||
264d6970 DV |
118 | /** |
119 | * @fb_probe: | |
120 | * | |
121 | * Driver callback to allocate and initialize the fbdev info structure. | |
122 | * Furthermore it also needs to allocate the DRM framebuffer used to | |
123 | * back the fbdev. | |
124 | * | |
125 | * This callback is mandatory. | |
126 | * | |
127 | * RETURNS: | |
128 | * | |
129 | * The driver should return 0 on success and a negative error code on | |
130 | * failure. | |
131 | */ | |
4abe3520 DA |
132 | int (*fb_probe)(struct drm_fb_helper *helper, |
133 | struct drm_fb_helper_surface_size *sizes); | |
264d6970 DV |
134 | |
135 | /** | |
136 | * @initial_config: | |
137 | * | |
138 | * Driver callback to setup an initial fbdev display configuration. | |
139 | * Drivers can use this callback to tell the fbdev emulation what the | |
140 | * preferred initial configuration is. This is useful to implement | |
141 | * smooth booting where the fbdev (and subsequently all userspace) never | |
142 | * changes the mode, but always inherits the existing configuration. | |
143 | * | |
144 | * This callback is optional. | |
145 | * | |
146 | * RETURNS: | |
147 | * | |
148 | * The driver should return true if a suitable initial configuration has | |
149 | * been filled out and false when the fbdev helper should fall back to | |
150 | * the default probing logic. | |
151 | */ | |
11e17a08 JB |
152 | bool (*initial_config)(struct drm_fb_helper *fb_helper, |
153 | struct drm_fb_helper_crtc **crtcs, | |
154 | struct drm_display_mode **modes, | |
b0ee9e7f | 155 | struct drm_fb_offset *offsets, |
11e17a08 | 156 | bool *enabled, int width, int height); |
4abe3520 DA |
157 | }; |
158 | ||
d50ba256 | 159 | struct drm_fb_helper_connector { |
0b4c0f3f | 160 | struct drm_connector *connector; |
d50ba256 DA |
161 | }; |
162 | ||
9685cd9d | 163 | /** |
264d6970 DV |
164 | * struct drm_fb_helper - main structure to emulate fbdev on top of KMS |
165 | * @fb: Scanout framebuffer object | |
166 | * @dev: DRM device | |
9685cd9d RC |
167 | * @crtc_count: number of possible CRTCs |
168 | * @crtc_info: per-CRTC helper state (mode, x/y offset, etc) | |
169 | * @connector_count: number of connected connectors | |
170 | * @connector_info_alloc_count: size of connector_info | |
264d6970 | 171 | * @connector_info: array of per-connector information |
9685cd9d RC |
172 | * @funcs: driver callbacks for fb helper |
173 | * @fbdev: emulated fbdev device info struct | |
174 | * @pseudo_palette: fake palette of 16 colors | |
eaa434de NT |
175 | * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to |
176 | * the screen buffer | |
177 | * @dirty_lock: spinlock protecting @dirty_clip | |
178 | * @dirty_work: worker used to flush the framebuffer | |
264d6970 DV |
179 | * |
180 | * This is the main structure used by the fbdev helpers. Drivers supporting | |
181 | * fbdev emulation should embedded this into their overall driver structure. | |
182 | * Drivers must also fill out a struct &drm_fb_helper_funcs with a few | |
183 | * operations. | |
9685cd9d | 184 | */ |
785b93ef DA |
185 | struct drm_fb_helper { |
186 | struct drm_framebuffer *fb; | |
187 | struct drm_device *dev; | |
785b93ef DA |
188 | int crtc_count; |
189 | struct drm_fb_helper_crtc *crtc_info; | |
0b4c0f3f | 190 | int connector_count; |
65c2a89c | 191 | int connector_info_alloc_count; |
0b4c0f3f | 192 | struct drm_fb_helper_connector **connector_info; |
3a493879 | 193 | const struct drm_fb_helper_funcs *funcs; |
38651674 DA |
194 | struct fb_info *fbdev; |
195 | u32 pseudo_palette[17]; | |
eaa434de NT |
196 | struct drm_clip_rect dirty_clip; |
197 | spinlock_t dirty_lock; | |
198 | struct work_struct dirty_work; | |
264d6970 DV |
199 | |
200 | /** | |
201 | * @kernel_fb_list: | |
202 | * | |
203 | * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit. | |
204 | */ | |
785b93ef | 205 | struct list_head kernel_fb_list; |
8be48d92 | 206 | |
264d6970 DV |
207 | /** |
208 | * @delayed_hotplug: | |
209 | * | |
210 | * A hotplug was received while fbdev wasn't in control of the DRM | |
211 | * device, i.e. another KMS master was active. The output configuration | |
212 | * needs to be reprobe when fbdev is in control again. | |
213 | */ | |
4abe3520 | 214 | bool delayed_hotplug; |
785b93ef DA |
215 | }; |
216 | ||
a03fdcb1 | 217 | #ifdef CONFIG_DRM_FBDEV_EMULATION |
70412cfa | 218 | int drm_fb_helper_modinit(void); |
10a23102 TR |
219 | void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper, |
220 | const struct drm_fb_helper_funcs *funcs); | |
4abe3520 DA |
221 | int drm_fb_helper_init(struct drm_device *dev, |
222 | struct drm_fb_helper *helper, int crtc_count, | |
eb1f8e4f | 223 | int max_conn); |
4abe3520 | 224 | void drm_fb_helper_fini(struct drm_fb_helper *helper); |
785b93ef DA |
225 | int drm_fb_helper_blank(int blank, struct fb_info *info); |
226 | int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, | |
227 | struct fb_info *info); | |
228 | int drm_fb_helper_set_par(struct fb_info *info); | |
229 | int drm_fb_helper_check_var(struct fb_var_screeninfo *var, | |
230 | struct fb_info *info); | |
785b93ef | 231 | |
b7bdf0a8 | 232 | int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper); |
b8017d6c AT |
233 | |
234 | struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper); | |
235 | void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper); | |
236 | void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper); | |
38651674 | 237 | void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper, |
785b93ef | 238 | uint32_t fb_width, uint32_t fb_height); |
3632ef89 DA |
239 | void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, |
240 | uint32_t depth); | |
241 | ||
47074ab7 AT |
242 | void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper); |
243 | ||
eaa434de NT |
244 | void drm_fb_helper_deferred_io(struct fb_info *info, |
245 | struct list_head *pagelist); | |
246 | ||
cbb1a82e AT |
247 | ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf, |
248 | size_t count, loff_t *ppos); | |
249 | ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf, | |
250 | size_t count, loff_t *ppos); | |
251 | ||
742547b7 AT |
252 | void drm_fb_helper_sys_fillrect(struct fb_info *info, |
253 | const struct fb_fillrect *rect); | |
254 | void drm_fb_helper_sys_copyarea(struct fb_info *info, | |
255 | const struct fb_copyarea *area); | |
256 | void drm_fb_helper_sys_imageblit(struct fb_info *info, | |
257 | const struct fb_image *image); | |
258 | ||
259 | void drm_fb_helper_cfb_fillrect(struct fb_info *info, | |
260 | const struct fb_fillrect *rect); | |
261 | void drm_fb_helper_cfb_copyarea(struct fb_info *info, | |
262 | const struct fb_copyarea *area); | |
263 | void drm_fb_helper_cfb_imageblit(struct fb_info *info, | |
264 | const struct fb_image *image); | |
265 | ||
fdefa58a AT |
266 | void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state); |
267 | ||
068143d3 | 268 | int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info); |
d50ba256 | 269 | |
7394371d | 270 | int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper); |
01934c2a | 271 | int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel); |
0b4c0f3f | 272 | int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper); |
1a7aba7f JB |
273 | int drm_fb_helper_debug_enter(struct fb_info *info); |
274 | int drm_fb_helper_debug_leave(struct fb_info *info); | |
2f1046f3 JB |
275 | struct drm_display_mode * |
276 | drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, | |
277 | int width, int height); | |
278 | struct drm_display_mode * | |
279 | drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, | |
280 | int width, int height); | |
8be48d92 | 281 | |
65c2a89c DA |
282 | int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector); |
283 | int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, | |
284 | struct drm_connector *connector); | |
a03fdcb1 | 285 | #else |
70412cfa RA |
286 | static inline int drm_fb_helper_modinit(void) |
287 | { | |
288 | return 0; | |
289 | } | |
290 | ||
a03fdcb1 AT |
291 | static inline void drm_fb_helper_prepare(struct drm_device *dev, |
292 | struct drm_fb_helper *helper, | |
293 | const struct drm_fb_helper_funcs *funcs) | |
294 | { | |
295 | } | |
296 | ||
297 | static inline int drm_fb_helper_init(struct drm_device *dev, | |
298 | struct drm_fb_helper *helper, int crtc_count, | |
299 | int max_conn) | |
300 | { | |
301 | return 0; | |
302 | } | |
303 | ||
304 | static inline void drm_fb_helper_fini(struct drm_fb_helper *helper) | |
305 | { | |
306 | } | |
307 | ||
308 | static inline int drm_fb_helper_blank(int blank, struct fb_info *info) | |
309 | { | |
310 | return 0; | |
311 | } | |
312 | ||
313 | static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, | |
314 | struct fb_info *info) | |
315 | { | |
316 | return 0; | |
317 | } | |
318 | ||
319 | static inline int drm_fb_helper_set_par(struct fb_info *info) | |
320 | { | |
321 | return 0; | |
322 | } | |
323 | ||
324 | static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var, | |
325 | struct fb_info *info) | |
326 | { | |
327 | return 0; | |
328 | } | |
329 | ||
b7bdf0a8 | 330 | static inline int |
a03fdcb1 AT |
331 | drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper) |
332 | { | |
b7bdf0a8 | 333 | return 0; |
a03fdcb1 AT |
334 | } |
335 | ||
336 | static inline struct fb_info * | |
337 | drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper) | |
338 | { | |
339 | return NULL; | |
340 | } | |
341 | ||
342 | static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper) | |
343 | { | |
344 | } | |
345 | static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper) | |
346 | { | |
347 | } | |
348 | ||
349 | static inline void drm_fb_helper_fill_var(struct fb_info *info, | |
350 | struct drm_fb_helper *fb_helper, | |
351 | uint32_t fb_width, uint32_t fb_height) | |
352 | { | |
353 | } | |
354 | ||
355 | static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, | |
356 | uint32_t depth) | |
357 | { | |
358 | } | |
359 | ||
360 | static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap, | |
361 | struct fb_info *info) | |
362 | { | |
363 | return 0; | |
364 | } | |
365 | ||
366 | static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper) | |
367 | { | |
368 | } | |
369 | ||
eaa434de NT |
370 | static inline void drm_fb_helper_deferred_io(struct fb_info *info, |
371 | struct list_head *pagelist) | |
372 | { | |
373 | } | |
374 | ||
a03fdcb1 AT |
375 | static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info, |
376 | char __user *buf, size_t count, | |
377 | loff_t *ppos) | |
378 | { | |
379 | return -ENODEV; | |
380 | } | |
381 | ||
382 | static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info, | |
383 | const char __user *buf, | |
384 | size_t count, loff_t *ppos) | |
385 | { | |
386 | return -ENODEV; | |
387 | } | |
388 | ||
389 | static inline void drm_fb_helper_sys_fillrect(struct fb_info *info, | |
390 | const struct fb_fillrect *rect) | |
391 | { | |
392 | } | |
393 | ||
394 | static inline void drm_fb_helper_sys_copyarea(struct fb_info *info, | |
395 | const struct fb_copyarea *area) | |
396 | { | |
397 | } | |
398 | ||
399 | static inline void drm_fb_helper_sys_imageblit(struct fb_info *info, | |
400 | const struct fb_image *image) | |
401 | { | |
402 | } | |
403 | ||
404 | static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info, | |
405 | const struct fb_fillrect *rect) | |
406 | { | |
407 | } | |
408 | ||
409 | static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info, | |
410 | const struct fb_copyarea *area) | |
411 | { | |
412 | } | |
413 | ||
414 | static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info, | |
415 | const struct fb_image *image) | |
416 | { | |
417 | } | |
418 | ||
419 | static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, | |
420 | int state) | |
421 | { | |
422 | } | |
423 | ||
424 | static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper) | |
425 | { | |
426 | return 0; | |
427 | } | |
428 | ||
429 | static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, | |
430 | int bpp_sel) | |
431 | { | |
432 | return 0; | |
433 | } | |
434 | ||
435 | static inline int | |
436 | drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper) | |
437 | { | |
438 | return 0; | |
439 | } | |
440 | ||
441 | static inline int drm_fb_helper_debug_enter(struct fb_info *info) | |
442 | { | |
443 | return 0; | |
444 | } | |
445 | ||
446 | static inline int drm_fb_helper_debug_leave(struct fb_info *info) | |
447 | { | |
448 | return 0; | |
449 | } | |
450 | ||
451 | static inline struct drm_display_mode * | |
452 | drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, | |
453 | int width, int height) | |
454 | { | |
455 | return NULL; | |
456 | } | |
457 | ||
458 | static inline struct drm_display_mode * | |
459 | drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, | |
460 | int width, int height) | |
461 | { | |
462 | return NULL; | |
463 | } | |
464 | ||
465 | static inline int | |
466 | drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, | |
467 | struct drm_connector *connector) | |
468 | { | |
469 | return 0; | |
470 | } | |
471 | ||
472 | static inline int | |
473 | drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, | |
474 | struct drm_connector *connector) | |
475 | { | |
476 | return 0; | |
477 | } | |
478 | #endif | |
785b93ef | 479 | #endif |