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 <drm/drm_client.h>
36#include <drm/drm_crtc.h>
37#include <drm/drm_device.h>
38#include <linux/kgdb.h>
39#include <linux/vgaarb.h>
40
41enum mode_set_atomic {
42 LEAVE_ATOMIC_MODE_SET,
43 ENTER_ATOMIC_MODE_SET,
44};
45
46/**
47 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
48 * @fb_width: fbdev width
49 * @fb_height: fbdev height
50 * @surface_width: scanout buffer width
51 * @surface_height: scanout buffer height
52 * @surface_bpp: scanout buffer bpp
53 * @surface_depth: scanout buffer depth
54 *
55 * Note that the scanout surface width/height may be larger than the fbdev
56 * width/height. In case of multiple displays, the scanout surface is sized
57 * according to the largest width/height (so it is large enough for all CRTCs
58 * to scanout). But the fbdev width/height is sized to the minimum width/
59 * height of all the displays. This ensures that fbcon fits on the smallest
60 * of the attached displays. fb_width/fb_height is used by
61 * drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
62 */
63struct drm_fb_helper_surface_size {
64 u32 fb_width;
65 u32 fb_height;
66 u32 surface_width;
67 u32 surface_height;
68 u32 surface_bpp;
69 u32 surface_depth;
70};
71
72/**
73 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
74 *
75 * Driver callbacks used by the fbdev emulation helper library.
76 */
77struct drm_fb_helper_funcs {
78 /**
79 * @fb_probe:
80 *
81 * Driver callback to allocate and initialize the fbdev info structure.
82 * Furthermore it also needs to allocate the DRM framebuffer used to
83 * back the fbdev.
84 *
85 * This callback is mandatory.
86 *
87 * RETURNS:
88 *
89 * The driver should return 0 on success and a negative error code on
90 * failure.
91 */
92 int (*fb_probe)(struct drm_fb_helper *helper,
93 struct drm_fb_helper_surface_size *sizes);
94};
95
96/**
97 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
98 * @fb: Scanout framebuffer object
99 * @dev: DRM device
100 * @funcs: driver callbacks for fb helper
101 * @fbdev: emulated fbdev device info struct
102 * @pseudo_palette: fake palette of 16 colors
103 * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
104 * the screen buffer
105 * @dirty_lock: spinlock protecting @dirty_clip
106 * @dirty_work: worker used to flush the framebuffer
107 * @resume_work: worker used during resume if the console lock is already taken
108 *
109 * This is the main structure used by the fbdev helpers. Drivers supporting
110 * fbdev emulation should embedded this into their overall driver structure.
111 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
112 * operations.
113 */
114struct drm_fb_helper {
115 /**
116 * @client:
117 *
118 * DRM client used by the generic fbdev emulation.
119 */
120 struct drm_client_dev client;
121
122 /**
123 * @buffer:
124 *
125 * Framebuffer used by the generic fbdev emulation.
126 */
127 struct drm_client_buffer *buffer;
128
129 struct drm_framebuffer *fb;
130 struct drm_device *dev;
131 const struct drm_fb_helper_funcs *funcs;
132 struct fb_info *fbdev;
133 u32 pseudo_palette[17];
134 struct drm_clip_rect dirty_clip;
135 spinlock_t dirty_lock;
136 struct work_struct dirty_work;
137 struct work_struct resume_work;
138
139 /**
140 * @lock:
141 *
142 * Top-level FBDEV helper lock. This protects all internal data
143 * structures and lists, such as @connector_info and @crtc_info.
144 *
145 * FIXME: fbdev emulation locking is a mess and long term we want to
146 * protect all helper internal state with this lock as well as reduce
147 * core KMS locking as much as possible.
148 */
149 struct mutex lock;
150
151 /**
152 * @kernel_fb_list:
153 *
154 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
155 */
156 struct list_head kernel_fb_list;
157
158 /**
159 * @delayed_hotplug:
160 *
161 * A hotplug was received while fbdev wasn't in control of the DRM
162 * device, i.e. another KMS master was active. The output configuration
163 * needs to be reprobe when fbdev is in control again.
164 */
165 bool delayed_hotplug;
166
167 /**
168 * @deferred_setup:
169 *
170 * If no outputs are connected (disconnected or unknown) the FB helper
171 * code will defer setup until at least one of the outputs shows up.
172 * This field keeps track of the status so that setup can be retried
173 * at every hotplug event until it succeeds eventually.
174 *
175 * Protected by @lock.
176 */
177 bool deferred_setup;
178
179 /**
180 * @preferred_bpp:
181 *
182 * Temporary storage for the driver's preferred BPP setting passed to
183 * FB helper initialization. This needs to be tracked so that deferred
184 * FB helper setup can pass this on.
185 *
186 * See also: @deferred_setup
187 */
188 int preferred_bpp;
189};
190
191static inline struct drm_fb_helper *
192drm_fb_helper_from_client(struct drm_client_dev *client)
193{
194 return container_of(client, struct drm_fb_helper, client);
195}
196
197/**
198 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
199 *
200 * Helper define to register default implementations of drm_fb_helper
201 * functions. To be used in struct fb_ops of drm drivers.
202 */
203#define DRM_FB_HELPER_DEFAULT_OPS \
204 .fb_check_var = drm_fb_helper_check_var, \
205 .fb_set_par = drm_fb_helper_set_par, \
206 .fb_setcmap = drm_fb_helper_setcmap, \
207 .fb_blank = drm_fb_helper_blank, \
208 .fb_pan_display = drm_fb_helper_pan_display, \
209 .fb_debug_enter = drm_fb_helper_debug_enter, \
210 .fb_debug_leave = drm_fb_helper_debug_leave, \
211 .fb_ioctl = drm_fb_helper_ioctl
212
213#ifdef CONFIG_DRM_FBDEV_EMULATION
214void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
215 const struct drm_fb_helper_funcs *funcs);
216int drm_fb_helper_init(struct drm_device *dev,
217 struct drm_fb_helper *helper, int max_conn);
218void drm_fb_helper_fini(struct drm_fb_helper *helper);
219int drm_fb_helper_blank(int blank, struct fb_info *info);
220int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
221 struct fb_info *info);
222int drm_fb_helper_set_par(struct fb_info *info);
223int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
224 struct fb_info *info);
225
226int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
227
228struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
229void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
230void drm_fb_helper_fill_info(struct fb_info *info,
231 struct drm_fb_helper *fb_helper,
232 struct drm_fb_helper_surface_size *sizes);
233
234void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
235
236void drm_fb_helper_deferred_io(struct fb_info *info,
237 struct list_head *pagelist);
238int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper);
239
240ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
241 size_t count, loff_t *ppos);
242ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
243 size_t count, loff_t *ppos);
244
245void drm_fb_helper_sys_fillrect(struct fb_info *info,
246 const struct fb_fillrect *rect);
247void drm_fb_helper_sys_copyarea(struct fb_info *info,
248 const struct fb_copyarea *area);
249void drm_fb_helper_sys_imageblit(struct fb_info *info,
250 const struct fb_image *image);
251
252void drm_fb_helper_cfb_fillrect(struct fb_info *info,
253 const struct fb_fillrect *rect);
254void drm_fb_helper_cfb_copyarea(struct fb_info *info,
255 const struct fb_copyarea *area);
256void drm_fb_helper_cfb_imageblit(struct fb_info *info,
257 const struct fb_image *image);
258
259void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
260void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
261 bool suspend);
262
263int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
264
265int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
266 unsigned long arg);
267
268int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
269int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
270int drm_fb_helper_debug_enter(struct fb_info *info);
271int drm_fb_helper_debug_leave(struct fb_info *info);
272
273int drm_fb_helper_fbdev_setup(struct drm_device *dev,
274 struct drm_fb_helper *fb_helper,
275 const struct drm_fb_helper_funcs *funcs,
276 unsigned int preferred_bpp,
277 unsigned int max_conn_count);
278void drm_fb_helper_fbdev_teardown(struct drm_device *dev);
279
280void drm_fb_helper_lastclose(struct drm_device *dev);
281void drm_fb_helper_output_poll_changed(struct drm_device *dev);
282
283int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
284 struct drm_fb_helper_surface_size *sizes);
285int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp);
286#else
287static inline void drm_fb_helper_prepare(struct drm_device *dev,
288 struct drm_fb_helper *helper,
289 const struct drm_fb_helper_funcs *funcs)
290{
291}
292
293static inline int drm_fb_helper_init(struct drm_device *dev,
294 struct drm_fb_helper *helper,
295 int max_conn)
296{
297 /* So drivers can use it to free the struct */
298 helper->dev = dev;
299 dev->fb_helper = helper;
300
301 return 0;
302}
303
304static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
305{
306 if (helper && helper->dev)
307 helper->dev->fb_helper = NULL;
308}
309
310static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
311{
312 return 0;
313}
314
315static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
316 struct fb_info *info)
317{
318 return 0;
319}
320
321static inline int drm_fb_helper_set_par(struct fb_info *info)
322{
323 return 0;
324}
325
326static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
327 struct fb_info *info)
328{
329 return 0;
330}
331
332static inline int
333drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
334{
335 return 0;
336}
337
338static inline struct fb_info *
339drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
340{
341 return NULL;
342}
343
344static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
345{
346}
347
348static inline void
349drm_fb_helper_fill_info(struct fb_info *info,
350 struct drm_fb_helper *fb_helper,
351 struct drm_fb_helper_surface_size *sizes)
352{
353}
354
355static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
356 struct fb_info *info)
357{
358 return 0;
359}
360
361static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
362 unsigned long arg)
363{
364 return 0;
365}
366
367static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
368{
369}
370
371static inline void drm_fb_helper_deferred_io(struct fb_info *info,
372 struct list_head *pagelist)
373{
374}
375
376static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
377{
378 return -ENODEV;
379}
380
381static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
382 char __user *buf, size_t count,
383 loff_t *ppos)
384{
385 return -ENODEV;
386}
387
388static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
389 const char __user *buf,
390 size_t count, loff_t *ppos)
391{
392 return -ENODEV;
393}
394
395static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
396 const struct fb_fillrect *rect)
397{
398}
399
400static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
401 const struct fb_copyarea *area)
402{
403}
404
405static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
406 const struct fb_image *image)
407{
408}
409
410static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
411 const struct fb_fillrect *rect)
412{
413}
414
415static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
416 const struct fb_copyarea *area)
417{
418}
419
420static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
421 const struct fb_image *image)
422{
423}
424
425static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
426 bool suspend)
427{
428}
429
430static inline void
431drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
432{
433}
434
435static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
436{
437 return 0;
438}
439
440static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
441 int bpp_sel)
442{
443 return 0;
444}
445
446static inline int drm_fb_helper_debug_enter(struct fb_info *info)
447{
448 return 0;
449}
450
451static inline int drm_fb_helper_debug_leave(struct fb_info *info)
452{
453 return 0;
454}
455
456static inline int
457drm_fb_helper_fbdev_setup(struct drm_device *dev,
458 struct drm_fb_helper *fb_helper,
459 const struct drm_fb_helper_funcs *funcs,
460 unsigned int preferred_bpp,
461 unsigned int max_conn_count)
462{
463 /* So drivers can use it to free the struct */
464 dev->fb_helper = fb_helper;
465
466 return 0;
467}
468
469static inline void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
470{
471 dev->fb_helper = NULL;
472}
473
474static inline void drm_fb_helper_lastclose(struct drm_device *dev)
475{
476}
477
478static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
479{
480}
481
482static inline int
483drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
484 struct drm_fb_helper_surface_size *sizes)
485{
486 return 0;
487}
488
489static inline int
490drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
491{
492 return 0;
493}
494
495#endif
496
497/* TODO: There's a todo entry to remove these three */
498static inline int
499drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
500{
501 return 0;
502}
503
504static inline int
505drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
506 struct drm_connector *connector)
507{
508 return 0;
509}
510
511static inline int
512drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
513 struct drm_connector *connector)
514{
515 return 0;
516}
517
518/**
519 * drm_fb_helper_remove_conflicting_framebuffers - remove firmware-configured framebuffers
520 * @a: memory range, users of which are to be removed
521 * @name: requesting driver name
522 * @primary: also kick vga16fb if present
523 *
524 * This function removes framebuffer devices (initialized by firmware/bootloader)
525 * which use memory range described by @a. If @a is NULL all such devices are
526 * removed.
527 */
528static inline int
529drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
530 const char *name, bool primary)
531{
532#if IS_REACHABLE(CONFIG_FB)
533 return remove_conflicting_framebuffers(a, name, primary);
534#else
535 return 0;
536#endif
537}
538
539/**
540 * drm_fb_helper_remove_conflicting_pci_framebuffers - remove firmware-configured framebuffers for PCI devices
541 * @pdev: PCI device
542 * @resource_id: index of PCI BAR configuring framebuffer memory
543 * @name: requesting driver name
544 *
545 * This function removes framebuffer devices (eg. initialized by firmware)
546 * using memory range configured for @pdev's BAR @resource_id.
547 *
548 * The function assumes that PCI device with shadowed ROM drives a primary
549 * display and so kicks out vga16fb.
550 */
551static inline int
552drm_fb_helper_remove_conflicting_pci_framebuffers(struct pci_dev *pdev,
553 int resource_id,
554 const char *name)
555{
556 int ret = 0;
557
558 /*
559 * WARNING: Apparently we must kick fbdev drivers before vgacon,
560 * otherwise the vga fbdev driver falls over.
561 */
562#if IS_REACHABLE(CONFIG_FB)
563 ret = remove_conflicting_pci_framebuffers(pdev, resource_id, name);
564#endif
565 if (ret == 0)
566 ret = vga_remove_vgacon(pdev);
567 return ret;
568}
569
570#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_clip_rect;
34struct drm_fb_helper;
35
36#include <linux/fb.h>
37
38#include <drm/drm_client.h>
39
40/**
41 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
42 * @fb_width: fbdev width
43 * @fb_height: fbdev height
44 * @surface_width: scanout buffer width
45 * @surface_height: scanout buffer height
46 * @surface_bpp: scanout buffer bpp
47 * @surface_depth: scanout buffer depth
48 *
49 * Note that the scanout surface width/height may be larger than the fbdev
50 * width/height. In case of multiple displays, the scanout surface is sized
51 * according to the largest width/height (so it is large enough for all CRTCs
52 * to scanout). But the fbdev width/height is sized to the minimum width/
53 * height of all the displays. This ensures that fbcon fits on the smallest
54 * of the attached displays. fb_width/fb_height is used by
55 * drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
56 */
57struct drm_fb_helper_surface_size {
58 u32 fb_width;
59 u32 fb_height;
60 u32 surface_width;
61 u32 surface_height;
62 u32 surface_bpp;
63 u32 surface_depth;
64};
65
66/**
67 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
68 *
69 * Driver callbacks used by the fbdev emulation helper library.
70 */
71struct drm_fb_helper_funcs {
72 /**
73 * @fb_probe:
74 *
75 * Driver callback to allocate and initialize the fbdev info structure.
76 * Furthermore it also needs to allocate the DRM framebuffer used to
77 * back the fbdev.
78 *
79 * This callback is mandatory.
80 *
81 * RETURNS:
82 *
83 * The driver should return 0 on success and a negative error code on
84 * failure.
85 */
86 int (*fb_probe)(struct drm_fb_helper *helper,
87 struct drm_fb_helper_surface_size *sizes);
88
89 /**
90 * @fb_dirty:
91 *
92 * Driver callback to update the framebuffer memory. If set, fbdev
93 * emulation will invoke this callback in regular intervals after
94 * the framebuffer has been written.
95 *
96 * This callback is optional.
97 *
98 * Returns:
99 * 0 on success, or an error code otherwise.
100 */
101 int (*fb_dirty)(struct drm_fb_helper *helper, struct drm_clip_rect *clip);
102};
103
104/**
105 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
106 * @fb: Scanout framebuffer object
107 * @dev: DRM device
108 * @funcs: driver callbacks for fb helper
109 * @info: emulated fbdev device info struct
110 * @pseudo_palette: fake palette of 16 colors
111 * @damage_clip: clip rectangle used with deferred_io to accumulate damage to
112 * the screen buffer
113 * @damage_lock: spinlock protecting @damage_clip
114 * @damage_work: worker used to flush the framebuffer
115 * @resume_work: worker used during resume if the console lock is already taken
116 *
117 * This is the main structure used by the fbdev helpers. Drivers supporting
118 * fbdev emulation should embedded this into their overall driver structure.
119 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
120 * operations.
121 */
122struct drm_fb_helper {
123 /**
124 * @client:
125 *
126 * DRM client used by the generic fbdev emulation.
127 */
128 struct drm_client_dev client;
129
130 /**
131 * @buffer:
132 *
133 * Framebuffer used by the generic fbdev emulation.
134 */
135 struct drm_client_buffer *buffer;
136
137 struct drm_framebuffer *fb;
138 struct drm_device *dev;
139 const struct drm_fb_helper_funcs *funcs;
140 struct fb_info *info;
141 u32 pseudo_palette[17];
142 struct drm_clip_rect damage_clip;
143 spinlock_t damage_lock;
144 struct work_struct damage_work;
145 struct work_struct resume_work;
146
147 /**
148 * @lock:
149 *
150 * Top-level FBDEV helper lock. This protects all internal data
151 * structures and lists, such as @connector_info and @crtc_info.
152 *
153 * FIXME: fbdev emulation locking is a mess and long term we want to
154 * protect all helper internal state with this lock as well as reduce
155 * core KMS locking as much as possible.
156 */
157 struct mutex lock;
158
159 /**
160 * @kernel_fb_list:
161 *
162 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
163 */
164 struct list_head kernel_fb_list;
165
166 /**
167 * @delayed_hotplug:
168 *
169 * A hotplug was received while fbdev wasn't in control of the DRM
170 * device, i.e. another KMS master was active. The output configuration
171 * needs to be reprobe when fbdev is in control again.
172 */
173 bool delayed_hotplug;
174
175 /**
176 * @deferred_setup:
177 *
178 * If no outputs are connected (disconnected or unknown) the FB helper
179 * code will defer setup until at least one of the outputs shows up.
180 * This field keeps track of the status so that setup can be retried
181 * at every hotplug event until it succeeds eventually.
182 *
183 * Protected by @lock.
184 */
185 bool deferred_setup;
186
187 /**
188 * @preferred_bpp:
189 *
190 * Temporary storage for the driver's preferred BPP setting passed to
191 * FB helper initialization. This needs to be tracked so that deferred
192 * FB helper setup can pass this on.
193 *
194 * See also: @deferred_setup
195 */
196 int preferred_bpp;
197
198#ifdef CONFIG_FB_DEFERRED_IO
199 /**
200 * @fbdefio:
201 *
202 * Temporary storage for the driver's FB deferred I/O handler. If the
203 * driver uses the DRM fbdev emulation layer, this is set by the core
204 * to a generic deferred I/O handler if a driver is preferring to use
205 * a shadow buffer.
206 */
207 struct fb_deferred_io fbdefio;
208#endif
209};
210
211static inline struct drm_fb_helper *
212drm_fb_helper_from_client(struct drm_client_dev *client)
213{
214 return container_of(client, struct drm_fb_helper, client);
215}
216
217/**
218 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
219 *
220 * Helper define to register default implementations of drm_fb_helper
221 * functions. To be used in struct fb_ops of drm drivers.
222 */
223#define DRM_FB_HELPER_DEFAULT_OPS \
224 .fb_check_var = drm_fb_helper_check_var, \
225 .fb_set_par = drm_fb_helper_set_par, \
226 .fb_setcmap = drm_fb_helper_setcmap, \
227 .fb_blank = drm_fb_helper_blank, \
228 .fb_pan_display = drm_fb_helper_pan_display, \
229 .fb_debug_enter = drm_fb_helper_debug_enter, \
230 .fb_debug_leave = drm_fb_helper_debug_leave, \
231 .fb_ioctl = drm_fb_helper_ioctl
232
233#ifdef CONFIG_DRM_FBDEV_EMULATION
234void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
235 unsigned int preferred_bpp,
236 const struct drm_fb_helper_funcs *funcs);
237void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper);
238int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
239void drm_fb_helper_fini(struct drm_fb_helper *helper);
240int drm_fb_helper_blank(int blank, struct fb_info *info);
241int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
242 struct fb_info *info);
243int drm_fb_helper_set_par(struct fb_info *info);
244int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
245 struct fb_info *info);
246
247int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
248
249struct fb_info *drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper);
250void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper);
251void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper);
252void drm_fb_helper_fill_info(struct fb_info *info,
253 struct drm_fb_helper *fb_helper,
254 struct drm_fb_helper_surface_size *sizes);
255
256void drm_fb_helper_damage_range(struct fb_info *info, off_t off, size_t len);
257void drm_fb_helper_damage_area(struct fb_info *info, u32 x, u32 y, u32 width, u32 height);
258
259#ifdef CONFIG_FB_DEFERRED_IO
260void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist);
261#endif
262
263void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
264void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
265 bool suspend);
266
267int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
268
269int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
270 unsigned long arg);
271
272int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
273int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper);
274int drm_fb_helper_debug_enter(struct fb_info *info);
275int drm_fb_helper_debug_leave(struct fb_info *info);
276void drm_fb_helper_lastclose(struct drm_device *dev);
277#else
278static inline void drm_fb_helper_prepare(struct drm_device *dev,
279 struct drm_fb_helper *helper,
280 unsigned int preferred_bpp,
281 const struct drm_fb_helper_funcs *funcs)
282{
283}
284
285static inline void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper)
286{
287}
288
289static inline int drm_fb_helper_init(struct drm_device *dev,
290 struct drm_fb_helper *helper)
291{
292 /* So drivers can use it to free the struct */
293 helper->dev = dev;
294 dev->fb_helper = helper;
295
296 return 0;
297}
298
299static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
300{
301 if (helper && helper->dev)
302 helper->dev->fb_helper = NULL;
303}
304
305static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
306{
307 return 0;
308}
309
310static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
311 struct fb_info *info)
312{
313 return 0;
314}
315
316static inline int drm_fb_helper_set_par(struct fb_info *info)
317{
318 return 0;
319}
320
321static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
322 struct fb_info *info)
323{
324 return 0;
325}
326
327static inline int
328drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
329{
330 return 0;
331}
332
333static inline struct fb_info *
334drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper)
335{
336 return NULL;
337}
338
339static inline void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper)
340{
341}
342
343static inline void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper)
344{
345}
346
347static inline void
348drm_fb_helper_fill_info(struct fb_info *info,
349 struct drm_fb_helper *fb_helper,
350 struct drm_fb_helper_surface_size *sizes)
351{
352}
353
354static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
355 struct fb_info *info)
356{
357 return 0;
358}
359
360static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
361 unsigned long arg)
362{
363 return 0;
364}
365
366#ifdef CONFIG_FB_DEFERRED_IO
367static inline void drm_fb_helper_deferred_io(struct fb_info *info,
368 struct list_head *pagelist)
369{
370}
371#endif
372
373static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
374 bool suspend)
375{
376}
377
378static inline void
379drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
380{
381}
382
383static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
384{
385 return 0;
386}
387
388static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper)
389{
390 return 0;
391}
392
393static inline int drm_fb_helper_debug_enter(struct fb_info *info)
394{
395 return 0;
396}
397
398static inline int drm_fb_helper_debug_leave(struct fb_info *info)
399{
400 return 0;
401}
402
403static inline void drm_fb_helper_lastclose(struct drm_device *dev)
404{
405}
406#endif
407
408#endif