]>
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 | ||
44adece5 | 35 | #include <drm/drm_crtc.h> |
1a7aba7f JB |
36 | #include <linux/kgdb.h> |
37 | ||
b516a9ef DV |
38 | enum mode_set_atomic { |
39 | LEAVE_ATOMIC_MODE_SET, | |
40 | ENTER_ATOMIC_MODE_SET, | |
41 | }; | |
42 | ||
b0ee9e7f DA |
43 | struct drm_fb_offset { |
44 | int x, y; | |
45 | }; | |
46 | ||
785b93ef | 47 | struct drm_fb_helper_crtc { |
785b93ef | 48 | struct drm_mode_set mode_set; |
8be48d92 | 49 | struct drm_display_mode *desired_mode; |
b0ee9e7f | 50 | int x, y; |
785b93ef DA |
51 | }; |
52 | ||
b7b5ee59 RC |
53 | /** |
54 | * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size | |
55 | * @fb_width: fbdev width | |
56 | * @fb_height: fbdev height | |
57 | * @surface_width: scanout buffer width | |
58 | * @surface_height: scanout buffer height | |
59 | * @surface_bpp: scanout buffer bpp | |
60 | * @surface_depth: scanout buffer depth | |
61 | * | |
62 | * Note that the scanout surface width/height may be larger than the fbdev | |
63 | * width/height. In case of multiple displays, the scanout surface is sized | |
64 | * according to the largest width/height (so it is large enough for all CRTCs | |
65 | * to scanout). But the fbdev width/height is sized to the minimum width/ | |
66 | * height of all the displays. This ensures that fbcon fits on the smallest | |
67 | * of the attached displays. | |
68 | * | |
69 | * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height, | |
70 | * rather than the surface size. | |
71 | */ | |
38651674 DA |
72 | struct drm_fb_helper_surface_size { |
73 | u32 fb_width; | |
74 | u32 fb_height; | |
75 | u32 surface_width; | |
76 | u32 surface_height; | |
77 | u32 surface_bpp; | |
78 | u32 surface_depth; | |
79 | }; | |
80 | ||
207fd329 DV |
81 | /** |
82 | * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library | |
207fd329 DV |
83 | * |
84 | * Driver callbacks used by the fbdev emulation helper library. | |
85 | */ | |
4abe3520 | 86 | struct drm_fb_helper_funcs { |
264d6970 DV |
87 | /** |
88 | * @gamma_set: | |
89 | * | |
90 | * Set the given gamma LUT register on the given CRTC. | |
91 | * | |
92 | * This callback is optional. | |
93 | * | |
94 | * FIXME: | |
95 | * | |
96 | * This callback is functionally redundant with the core gamma table | |
97 | * support and simply exists because the fbdev hasn't yet been | |
98 | * refactored to use the core gamma table interfaces. | |
99 | */ | |
4abe3520 DA |
100 | void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green, |
101 | u16 blue, int regno); | |
264d6970 DV |
102 | /** |
103 | * @gamma_get: | |
104 | * | |
105 | * Read the given gamma LUT register on the given CRTC, used to save the | |
106 | * current LUT when force-restoring the fbdev for e.g. kdbg. | |
107 | * | |
108 | * This callback is optional. | |
109 | * | |
110 | * FIXME: | |
111 | * | |
112 | * This callback is functionally redundant with the core gamma table | |
113 | * support and simply exists because the fbdev hasn't yet been | |
114 | * refactored to use the core gamma table interfaces. | |
115 | */ | |
4abe3520 DA |
116 | void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green, |
117 | u16 *blue, int regno); | |
118 | ||
264d6970 DV |
119 | /** |
120 | * @fb_probe: | |
121 | * | |
122 | * Driver callback to allocate and initialize the fbdev info structure. | |
123 | * Furthermore it also needs to allocate the DRM framebuffer used to | |
124 | * back the fbdev. | |
125 | * | |
126 | * This callback is mandatory. | |
127 | * | |
128 | * RETURNS: | |
129 | * | |
130 | * The driver should return 0 on success and a negative error code on | |
131 | * failure. | |
132 | */ | |
4abe3520 DA |
133 | int (*fb_probe)(struct drm_fb_helper *helper, |
134 | struct drm_fb_helper_surface_size *sizes); | |
264d6970 DV |
135 | |
136 | /** | |
137 | * @initial_config: | |
138 | * | |
139 | * Driver callback to setup an initial fbdev display configuration. | |
140 | * Drivers can use this callback to tell the fbdev emulation what the | |
141 | * preferred initial configuration is. This is useful to implement | |
142 | * smooth booting where the fbdev (and subsequently all userspace) never | |
143 | * changes the mode, but always inherits the existing configuration. | |
144 | * | |
145 | * This callback is optional. | |
146 | * | |
147 | * RETURNS: | |
148 | * | |
149 | * The driver should return true if a suitable initial configuration has | |
150 | * been filled out and false when the fbdev helper should fall back to | |
151 | * the default probing logic. | |
152 | */ | |
11e17a08 JB |
153 | bool (*initial_config)(struct drm_fb_helper *fb_helper, |
154 | struct drm_fb_helper_crtc **crtcs, | |
155 | struct drm_display_mode **modes, | |
b0ee9e7f | 156 | struct drm_fb_offset *offsets, |
11e17a08 | 157 | bool *enabled, int width, int height); |
4abe3520 DA |
158 | }; |
159 | ||
d50ba256 | 160 | struct drm_fb_helper_connector { |
0b4c0f3f | 161 | struct drm_connector *connector; |
d50ba256 DA |
162 | }; |
163 | ||
9685cd9d | 164 | /** |
264d6970 DV |
165 | * struct drm_fb_helper - main structure to emulate fbdev on top of KMS |
166 | * @fb: Scanout framebuffer object | |
167 | * @dev: DRM device | |
9685cd9d RC |
168 | * @crtc_count: number of possible CRTCs |
169 | * @crtc_info: per-CRTC helper state (mode, x/y offset, etc) | |
170 | * @connector_count: number of connected connectors | |
171 | * @connector_info_alloc_count: size of connector_info | |
264d6970 | 172 | * @connector_info: array of per-connector information |
9685cd9d RC |
173 | * @funcs: driver callbacks for fb helper |
174 | * @fbdev: emulated fbdev device info struct | |
175 | * @pseudo_palette: fake palette of 16 colors | |
eaa434de NT |
176 | * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to |
177 | * the screen buffer | |
178 | * @dirty_lock: spinlock protecting @dirty_clip | |
179 | * @dirty_work: worker used to flush the framebuffer | |
cfe63423 | 180 | * @resume_work: worker used during resume if the console lock is already taken |
264d6970 DV |
181 | * |
182 | * This is the main structure used by the fbdev helpers. Drivers supporting | |
183 | * fbdev emulation should embedded this into their overall driver structure. | |
184 | * Drivers must also fill out a struct &drm_fb_helper_funcs with a few | |
185 | * operations. | |
9685cd9d | 186 | */ |
785b93ef DA |
187 | struct drm_fb_helper { |
188 | struct drm_framebuffer *fb; | |
189 | struct drm_device *dev; | |
785b93ef DA |
190 | int crtc_count; |
191 | struct drm_fb_helper_crtc *crtc_info; | |
0b4c0f3f | 192 | int connector_count; |
65c2a89c | 193 | int connector_info_alloc_count; |
0b4c0f3f | 194 | struct drm_fb_helper_connector **connector_info; |
3a493879 | 195 | const struct drm_fb_helper_funcs *funcs; |
38651674 DA |
196 | struct fb_info *fbdev; |
197 | u32 pseudo_palette[17]; | |
eaa434de NT |
198 | struct drm_clip_rect dirty_clip; |
199 | spinlock_t dirty_lock; | |
200 | struct work_struct dirty_work; | |
cfe63423 | 201 | struct work_struct resume_work; |
264d6970 DV |
202 | |
203 | /** | |
204 | * @kernel_fb_list: | |
205 | * | |
206 | * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit. | |
207 | */ | |
785b93ef | 208 | struct list_head kernel_fb_list; |
8be48d92 | 209 | |
264d6970 DV |
210 | /** |
211 | * @delayed_hotplug: | |
212 | * | |
213 | * A hotplug was received while fbdev wasn't in control of the DRM | |
214 | * device, i.e. another KMS master was active. The output configuration | |
215 | * needs to be reprobe when fbdev is in control again. | |
216 | */ | |
4abe3520 | 217 | bool delayed_hotplug; |
785b93ef DA |
218 | }; |
219 | ||
74064893 | 220 | /** |
21bf75ec | 221 | * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers |
74064893 SC |
222 | * |
223 | * Helper define to register default implementations of drm_fb_helper | |
224 | * functions. To be used in struct fb_ops of drm drivers. | |
225 | */ | |
226 | #define DRM_FB_HELPER_DEFAULT_OPS \ | |
227 | .fb_check_var = drm_fb_helper_check_var, \ | |
228 | .fb_set_par = drm_fb_helper_set_par, \ | |
229 | .fb_setcmap = drm_fb_helper_setcmap, \ | |
230 | .fb_blank = drm_fb_helper_blank, \ | |
1e008928 SC |
231 | .fb_pan_display = drm_fb_helper_pan_display, \ |
232 | .fb_debug_enter = drm_fb_helper_debug_enter, \ | |
233 | .fb_debug_leave = drm_fb_helper_debug_leave | |
74064893 | 234 | |
a03fdcb1 | 235 | #ifdef CONFIG_DRM_FBDEV_EMULATION |
10a23102 TR |
236 | void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper, |
237 | const struct drm_fb_helper_funcs *funcs); | |
4abe3520 DA |
238 | int drm_fb_helper_init(struct drm_device *dev, |
239 | struct drm_fb_helper *helper, int crtc_count, | |
eb1f8e4f | 240 | int max_conn); |
4abe3520 | 241 | void drm_fb_helper_fini(struct drm_fb_helper *helper); |
785b93ef DA |
242 | int drm_fb_helper_blank(int blank, struct fb_info *info); |
243 | int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, | |
244 | struct fb_info *info); | |
245 | int drm_fb_helper_set_par(struct fb_info *info); | |
246 | int drm_fb_helper_check_var(struct fb_var_screeninfo *var, | |
247 | struct fb_info *info); | |
785b93ef | 248 | |
b7bdf0a8 | 249 | int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper); |
b8017d6c AT |
250 | |
251 | struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper); | |
252 | void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper); | |
253 | void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper); | |
38651674 | 254 | void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper, |
785b93ef | 255 | uint32_t fb_width, uint32_t fb_height); |
3632ef89 DA |
256 | void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, |
257 | uint32_t depth); | |
258 | ||
47074ab7 AT |
259 | void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper); |
260 | ||
eaa434de NT |
261 | void drm_fb_helper_deferred_io(struct fb_info *info, |
262 | struct list_head *pagelist); | |
263 | ||
cbb1a82e AT |
264 | ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf, |
265 | size_t count, loff_t *ppos); | |
266 | ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf, | |
267 | size_t count, loff_t *ppos); | |
268 | ||
742547b7 AT |
269 | void drm_fb_helper_sys_fillrect(struct fb_info *info, |
270 | const struct fb_fillrect *rect); | |
271 | void drm_fb_helper_sys_copyarea(struct fb_info *info, | |
272 | const struct fb_copyarea *area); | |
273 | void drm_fb_helper_sys_imageblit(struct fb_info *info, | |
274 | const struct fb_image *image); | |
275 | ||
276 | void drm_fb_helper_cfb_fillrect(struct fb_info *info, | |
277 | const struct fb_fillrect *rect); | |
278 | void drm_fb_helper_cfb_copyarea(struct fb_info *info, | |
279 | const struct fb_copyarea *area); | |
280 | void drm_fb_helper_cfb_imageblit(struct fb_info *info, | |
281 | const struct fb_image *image); | |
282 | ||
28579f37 | 283 | void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend); |
cfe63423 | 284 | void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, |
28579f37 | 285 | bool suspend); |
fdefa58a | 286 | |
068143d3 | 287 | int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info); |
d50ba256 | 288 | |
7394371d | 289 | int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper); |
01934c2a | 290 | int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel); |
0b4c0f3f | 291 | int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper); |
1a7aba7f JB |
292 | int drm_fb_helper_debug_enter(struct fb_info *info); |
293 | int drm_fb_helper_debug_leave(struct fb_info *info); | |
2f1046f3 JB |
294 | struct drm_display_mode * |
295 | drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, | |
296 | int width, int height); | |
297 | struct drm_display_mode * | |
298 | drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, | |
299 | int width, int height); | |
8be48d92 | 300 | |
65c2a89c DA |
301 | int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector); |
302 | int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, | |
303 | struct drm_connector *connector); | |
a03fdcb1 AT |
304 | #else |
305 | static inline void drm_fb_helper_prepare(struct drm_device *dev, | |
306 | struct drm_fb_helper *helper, | |
307 | const struct drm_fb_helper_funcs *funcs) | |
308 | { | |
309 | } | |
310 | ||
311 | static inline int drm_fb_helper_init(struct drm_device *dev, | |
312 | struct drm_fb_helper *helper, int crtc_count, | |
313 | int max_conn) | |
314 | { | |
315 | return 0; | |
316 | } | |
317 | ||
318 | static inline void drm_fb_helper_fini(struct drm_fb_helper *helper) | |
319 | { | |
320 | } | |
321 | ||
322 | static inline int drm_fb_helper_blank(int blank, struct fb_info *info) | |
323 | { | |
324 | return 0; | |
325 | } | |
326 | ||
327 | static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, | |
328 | struct fb_info *info) | |
329 | { | |
330 | return 0; | |
331 | } | |
332 | ||
333 | static inline int drm_fb_helper_set_par(struct fb_info *info) | |
334 | { | |
335 | return 0; | |
336 | } | |
337 | ||
338 | static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var, | |
339 | struct fb_info *info) | |
340 | { | |
341 | return 0; | |
342 | } | |
343 | ||
b7bdf0a8 | 344 | static inline int |
a03fdcb1 AT |
345 | drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper) |
346 | { | |
b7bdf0a8 | 347 | return 0; |
a03fdcb1 AT |
348 | } |
349 | ||
350 | static inline struct fb_info * | |
351 | drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper) | |
352 | { | |
353 | return NULL; | |
354 | } | |
355 | ||
356 | static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper) | |
357 | { | |
358 | } | |
359 | static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper) | |
360 | { | |
361 | } | |
362 | ||
363 | static inline void drm_fb_helper_fill_var(struct fb_info *info, | |
364 | struct drm_fb_helper *fb_helper, | |
365 | uint32_t fb_width, uint32_t fb_height) | |
366 | { | |
367 | } | |
368 | ||
369 | static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, | |
370 | uint32_t depth) | |
371 | { | |
372 | } | |
373 | ||
374 | static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap, | |
375 | struct fb_info *info) | |
376 | { | |
377 | return 0; | |
378 | } | |
379 | ||
380 | static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper) | |
381 | { | |
382 | } | |
383 | ||
eaa434de NT |
384 | static inline void drm_fb_helper_deferred_io(struct fb_info *info, |
385 | struct list_head *pagelist) | |
386 | { | |
387 | } | |
388 | ||
a03fdcb1 AT |
389 | static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info, |
390 | char __user *buf, size_t count, | |
391 | loff_t *ppos) | |
392 | { | |
393 | return -ENODEV; | |
394 | } | |
395 | ||
396 | static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info, | |
397 | const char __user *buf, | |
398 | size_t count, loff_t *ppos) | |
399 | { | |
400 | return -ENODEV; | |
401 | } | |
402 | ||
403 | static inline void drm_fb_helper_sys_fillrect(struct fb_info *info, | |
404 | const struct fb_fillrect *rect) | |
405 | { | |
406 | } | |
407 | ||
408 | static inline void drm_fb_helper_sys_copyarea(struct fb_info *info, | |
409 | const struct fb_copyarea *area) | |
410 | { | |
411 | } | |
412 | ||
413 | static inline void drm_fb_helper_sys_imageblit(struct fb_info *info, | |
414 | const struct fb_image *image) | |
415 | { | |
416 | } | |
417 | ||
418 | static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info, | |
419 | const struct fb_fillrect *rect) | |
420 | { | |
421 | } | |
422 | ||
423 | static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info, | |
424 | const struct fb_copyarea *area) | |
425 | { | |
426 | } | |
427 | ||
428 | static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info, | |
429 | const struct fb_image *image) | |
430 | { | |
431 | } | |
432 | ||
433 | static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, | |
28579f37 | 434 | bool suspend) |
a03fdcb1 AT |
435 | { |
436 | } | |
437 | ||
cfe63423 | 438 | static inline void |
28579f37 | 439 | drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend) |
cfe63423 NT |
440 | { |
441 | } | |
442 | ||
a03fdcb1 AT |
443 | static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper) |
444 | { | |
445 | return 0; | |
446 | } | |
447 | ||
448 | static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, | |
449 | int bpp_sel) | |
450 | { | |
451 | return 0; | |
452 | } | |
453 | ||
454 | static inline int | |
455 | drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper) | |
456 | { | |
457 | return 0; | |
458 | } | |
459 | ||
460 | static inline int drm_fb_helper_debug_enter(struct fb_info *info) | |
461 | { | |
462 | return 0; | |
463 | } | |
464 | ||
465 | static inline int drm_fb_helper_debug_leave(struct fb_info *info) | |
466 | { | |
467 | return 0; | |
468 | } | |
469 | ||
470 | static inline struct drm_display_mode * | |
471 | drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, | |
472 | int width, int height) | |
473 | { | |
474 | return NULL; | |
475 | } | |
476 | ||
477 | static inline struct drm_display_mode * | |
478 | drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, | |
479 | int width, int height) | |
480 | { | |
481 | return NULL; | |
482 | } | |
483 | ||
484 | static inline int | |
485 | drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, | |
486 | struct drm_connector *connector) | |
487 | { | |
488 | return 0; | |
489 | } | |
490 | ||
491 | static inline int | |
492 | drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, | |
493 | struct drm_connector *connector) | |
494 | { | |
495 | return 0; | |
496 | } | |
44adece5 | 497 | |
0a3bfe29 CW |
498 | #endif |
499 | ||
44adece5 DV |
500 | static inline int |
501 | drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a, | |
502 | const char *name, bool primary) | |
503 | { | |
749cc6f7 | 504 | #if IS_REACHABLE(CONFIG_FB) |
0a3bfe29 CW |
505 | return remove_conflicting_framebuffers(a, name, primary); |
506 | #else | |
44adece5 | 507 | return 0; |
a03fdcb1 | 508 | #endif |
0a3bfe29 CW |
509 | } |
510 | ||
785b93ef | 511 | #endif |