Loading...
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
33struct drm_fb_helper;
34
35#include <linux/kgdb.h>
36
37struct drm_fb_helper_crtc {
38 uint32_t crtc_id;
39 struct drm_mode_set mode_set;
40 struct drm_display_mode *desired_mode;
41};
42
43struct drm_fb_helper_surface_size {
44 u32 fb_width;
45 u32 fb_height;
46 u32 surface_width;
47 u32 surface_height;
48 u32 surface_bpp;
49 u32 surface_depth;
50};
51
52struct drm_fb_helper_funcs {
53 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
54 u16 blue, int regno);
55 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
56 u16 *blue, int regno);
57
58 int (*fb_probe)(struct drm_fb_helper *helper,
59 struct drm_fb_helper_surface_size *sizes);
60};
61
62struct drm_fb_helper_connector {
63 struct drm_connector *connector;
64 struct drm_cmdline_mode cmdline_mode;
65};
66
67struct drm_fb_helper {
68 struct drm_framebuffer *fb;
69 struct drm_framebuffer *saved_fb;
70 struct drm_device *dev;
71 struct drm_display_mode *mode;
72 int crtc_count;
73 struct drm_fb_helper_crtc *crtc_info;
74 int connector_count;
75 struct drm_fb_helper_connector **connector_info;
76 struct drm_fb_helper_funcs *funcs;
77 int conn_limit;
78 struct fb_info *fbdev;
79 u32 pseudo_palette[17];
80 struct list_head kernel_fb_list;
81
82 /* we got a hotplug but fbdev wasn't running the console
83 delay until next set_par */
84 bool delayed_hotplug;
85};
86
87int drm_fb_helper_single_fb_probe(struct drm_fb_helper *helper,
88 int preferred_bpp);
89
90int drm_fb_helper_init(struct drm_device *dev,
91 struct drm_fb_helper *helper, int crtc_count,
92 int max_conn);
93void drm_fb_helper_fini(struct drm_fb_helper *helper);
94int drm_fb_helper_blank(int blank, struct fb_info *info);
95int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
96 struct fb_info *info);
97int drm_fb_helper_set_par(struct fb_info *info);
98int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
99 struct fb_info *info);
100int drm_fb_helper_setcolreg(unsigned regno,
101 unsigned red,
102 unsigned green,
103 unsigned blue,
104 unsigned transp,
105 struct fb_info *info);
106
107bool drm_fb_helper_restore_fbdev_mode(struct drm_fb_helper *fb_helper);
108void drm_fb_helper_restore(void);
109void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
110 uint32_t fb_width, uint32_t fb_height);
111void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
112 uint32_t depth);
113
114int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
115
116int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
117bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
118int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
119int drm_fb_helper_debug_enter(struct fb_info *info);
120int drm_fb_helper_debug_leave(struct fb_info *info);
121
122#endif
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
33struct drm_fb_helper;
34
35#include <drm/drm_crtc.h>
36#include <linux/kgdb.h>
37
38enum mode_set_atomic {
39 LEAVE_ATOMIC_MODE_SET,
40 ENTER_ATOMIC_MODE_SET,
41};
42
43struct drm_fb_offset {
44 int x, y;
45};
46
47struct drm_fb_helper_crtc {
48 struct drm_mode_set mode_set;
49 struct drm_display_mode *desired_mode;
50 int x, y;
51};
52
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 */
72struct 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
81/**
82 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
83 *
84 * Driver callbacks used by the fbdev emulation helper library.
85 */
86struct drm_fb_helper_funcs {
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 */
100 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
101 u16 blue, int regno);
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 */
116 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
117 u16 *blue, int regno);
118
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 */
133 int (*fb_probe)(struct drm_fb_helper *helper,
134 struct drm_fb_helper_surface_size *sizes);
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 */
153 bool (*initial_config)(struct drm_fb_helper *fb_helper,
154 struct drm_fb_helper_crtc **crtcs,
155 struct drm_display_mode **modes,
156 struct drm_fb_offset *offsets,
157 bool *enabled, int width, int height);
158};
159
160struct drm_fb_helper_connector {
161 struct drm_connector *connector;
162};
163
164/**
165 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
166 * @fb: Scanout framebuffer object
167 * @dev: DRM device
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
172 * @connector_info: array of per-connector information
173 * @funcs: driver callbacks for fb helper
174 * @fbdev: emulated fbdev device info struct
175 * @pseudo_palette: fake palette of 16 colors
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
180 * @resume_work: worker used during resume if the console lock is already taken
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.
186 */
187struct drm_fb_helper {
188 struct drm_framebuffer *fb;
189 struct drm_device *dev;
190 int crtc_count;
191 struct drm_fb_helper_crtc *crtc_info;
192 int connector_count;
193 int connector_info_alloc_count;
194 struct drm_fb_helper_connector **connector_info;
195 const struct drm_fb_helper_funcs *funcs;
196 struct fb_info *fbdev;
197 u32 pseudo_palette[17];
198 struct drm_clip_rect dirty_clip;
199 spinlock_t dirty_lock;
200 struct work_struct dirty_work;
201 struct work_struct resume_work;
202
203 /**
204 * @kernel_fb_list:
205 *
206 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
207 */
208 struct list_head kernel_fb_list;
209
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 */
217 bool delayed_hotplug;
218};
219
220/**
221 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
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, \
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
234
235#ifdef CONFIG_DRM_FBDEV_EMULATION
236void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
237 const struct drm_fb_helper_funcs *funcs);
238int drm_fb_helper_init(struct drm_device *dev,
239 struct drm_fb_helper *helper, int crtc_count,
240 int max_conn);
241void drm_fb_helper_fini(struct drm_fb_helper *helper);
242int drm_fb_helper_blank(int blank, struct fb_info *info);
243int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
244 struct fb_info *info);
245int drm_fb_helper_set_par(struct fb_info *info);
246int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
247 struct fb_info *info);
248
249int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
250
251struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
252void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
253void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
254void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
255 uint32_t fb_width, uint32_t fb_height);
256void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
257 uint32_t depth);
258
259void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
260
261void drm_fb_helper_deferred_io(struct fb_info *info,
262 struct list_head *pagelist);
263
264ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
265 size_t count, loff_t *ppos);
266ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
267 size_t count, loff_t *ppos);
268
269void drm_fb_helper_sys_fillrect(struct fb_info *info,
270 const struct fb_fillrect *rect);
271void drm_fb_helper_sys_copyarea(struct fb_info *info,
272 const struct fb_copyarea *area);
273void drm_fb_helper_sys_imageblit(struct fb_info *info,
274 const struct fb_image *image);
275
276void drm_fb_helper_cfb_fillrect(struct fb_info *info,
277 const struct fb_fillrect *rect);
278void drm_fb_helper_cfb_copyarea(struct fb_info *info,
279 const struct fb_copyarea *area);
280void drm_fb_helper_cfb_imageblit(struct fb_info *info,
281 const struct fb_image *image);
282
283void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
284void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
285 bool suspend);
286
287int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
288
289int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
290int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
291int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
292int drm_fb_helper_debug_enter(struct fb_info *info);
293int drm_fb_helper_debug_leave(struct fb_info *info);
294struct drm_display_mode *
295drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
296 int width, int height);
297struct drm_display_mode *
298drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
299 int width, int height);
300
301int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
302int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
303 struct drm_connector *connector);
304#else
305static 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
311static 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
318static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
319{
320}
321
322static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
323{
324 return 0;
325}
326
327static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
328 struct fb_info *info)
329{
330 return 0;
331}
332
333static inline int drm_fb_helper_set_par(struct fb_info *info)
334{
335 return 0;
336}
337
338static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
339 struct fb_info *info)
340{
341 return 0;
342}
343
344static inline int
345drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
346{
347 return 0;
348}
349
350static inline struct fb_info *
351drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
352{
353 return NULL;
354}
355
356static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
357{
358}
359static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
360{
361}
362
363static 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
369static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
370 uint32_t depth)
371{
372}
373
374static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
375 struct fb_info *info)
376{
377 return 0;
378}
379
380static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
381{
382}
383
384static inline void drm_fb_helper_deferred_io(struct fb_info *info,
385 struct list_head *pagelist)
386{
387}
388
389static 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
396static 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
403static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
404 const struct fb_fillrect *rect)
405{
406}
407
408static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
409 const struct fb_copyarea *area)
410{
411}
412
413static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
414 const struct fb_image *image)
415{
416}
417
418static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
419 const struct fb_fillrect *rect)
420{
421}
422
423static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
424 const struct fb_copyarea *area)
425{
426}
427
428static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
429 const struct fb_image *image)
430{
431}
432
433static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
434 bool suspend)
435{
436}
437
438static inline void
439drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
440{
441}
442
443static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
444{
445 return 0;
446}
447
448static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
449 int bpp_sel)
450{
451 return 0;
452}
453
454static inline int
455drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
456{
457 return 0;
458}
459
460static inline int drm_fb_helper_debug_enter(struct fb_info *info)
461{
462 return 0;
463}
464
465static inline int drm_fb_helper_debug_leave(struct fb_info *info)
466{
467 return 0;
468}
469
470static inline struct drm_display_mode *
471drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
472 int width, int height)
473{
474 return NULL;
475}
476
477static inline struct drm_display_mode *
478drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
479 int width, int height)
480{
481 return NULL;
482}
483
484static inline int
485drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
486 struct drm_connector *connector)
487{
488 return 0;
489}
490
491static inline int
492drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
493 struct drm_connector *connector)
494{
495 return 0;
496}
497
498#endif
499
500static inline int
501drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
502 const char *name, bool primary)
503{
504#if IS_REACHABLE(CONFIG_FB)
505 return remove_conflicting_framebuffers(a, name, primary);
506#else
507 return 0;
508#endif
509}
510
511#endif