2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
6 * DRM framebuffer helper functions
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.
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
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
30 #ifndef DRM_FB_HELPER_H
31 #define DRM_FB_HELPER_H
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>
41 enum mode_set_atomic {
42 LEAVE_ATOMIC_MODE_SET,
43 ENTER_ATOMIC_MODE_SET,
46 struct drm_fb_offset {
50 struct drm_fb_helper_crtc {
51 struct drm_mode_set mode_set;
52 struct drm_display_mode *desired_mode;
58 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
59 * @fb_width: fbdev width
60 * @fb_height: fbdev height
61 * @surface_width: scanout buffer width
62 * @surface_height: scanout buffer height
63 * @surface_bpp: scanout buffer bpp
64 * @surface_depth: scanout buffer depth
66 * Note that the scanout surface width/height may be larger than the fbdev
67 * width/height. In case of multiple displays, the scanout surface is sized
68 * according to the largest width/height (so it is large enough for all CRTCs
69 * to scanout). But the fbdev width/height is sized to the minimum width/
70 * height of all the displays. This ensures that fbcon fits on the smallest
71 * of the attached displays. fb_width/fb_height is used by
72 * drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
74 struct drm_fb_helper_surface_size {
84 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
86 * Driver callbacks used by the fbdev emulation helper library.
88 struct drm_fb_helper_funcs {
92 * Driver callback to allocate and initialize the fbdev info structure.
93 * Furthermore it also needs to allocate the DRM framebuffer used to
96 * This callback is mandatory.
100 * The driver should return 0 on success and a negative error code on
103 int (*fb_probe)(struct drm_fb_helper *helper,
104 struct drm_fb_helper_surface_size *sizes);
107 struct drm_fb_helper_connector {
108 struct drm_connector *connector;
112 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
113 * @fb: Scanout framebuffer object
115 * @crtc_count: number of possible CRTCs
116 * @crtc_info: per-CRTC helper state (mode, x/y offset, etc)
117 * @connector_count: number of connected connectors
118 * @connector_info_alloc_count: size of connector_info
119 * @funcs: driver callbacks for fb helper
120 * @fbdev: emulated fbdev device info struct
121 * @pseudo_palette: fake palette of 16 colors
122 * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
124 * @dirty_lock: spinlock protecting @dirty_clip
125 * @dirty_work: worker used to flush the framebuffer
126 * @resume_work: worker used during resume if the console lock is already taken
128 * This is the main structure used by the fbdev helpers. Drivers supporting
129 * fbdev emulation should embedded this into their overall driver structure.
130 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
133 struct drm_fb_helper {
137 * DRM client used by the generic fbdev emulation.
139 struct drm_client_dev client;
144 * Framebuffer used by the generic fbdev emulation.
146 struct drm_client_buffer *buffer;
148 struct drm_framebuffer *fb;
149 struct drm_device *dev;
151 struct drm_fb_helper_crtc *crtc_info;
153 int connector_info_alloc_count;
156 * Bitmask of all rotations requested for panel-orientation which
157 * could not be handled in hardware. If only one bit is set
158 * fbdev->fbcon_rotate_hint gets set to the requested rotation.
164 * Array of per-connector information. Do not iterate directly, but use
165 * drm_fb_helper_for_each_connector.
167 struct drm_fb_helper_connector **connector_info;
168 const struct drm_fb_helper_funcs *funcs;
169 struct fb_info *fbdev;
170 u32 pseudo_palette[17];
171 struct drm_clip_rect dirty_clip;
172 spinlock_t dirty_lock;
173 struct work_struct dirty_work;
174 struct work_struct resume_work;
179 * Top-level FBDEV helper lock. This protects all internal data
180 * structures and lists, such as @connector_info and @crtc_info.
182 * FIXME: fbdev emulation locking is a mess and long term we want to
183 * protect all helper internal state with this lock as well as reduce
184 * core KMS locking as much as possible.
191 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
193 struct list_head kernel_fb_list;
198 * A hotplug was received while fbdev wasn't in control of the DRM
199 * device, i.e. another KMS master was active. The output configuration
200 * needs to be reprobe when fbdev is in control again.
202 bool delayed_hotplug;
207 * If no outputs are connected (disconnected or unknown) the FB helper
208 * code will defer setup until at least one of the outputs shows up.
209 * This field keeps track of the status so that setup can be retried
210 * at every hotplug event until it succeeds eventually.
212 * Protected by @lock.
219 * Temporary storage for the driver's preferred BPP setting passed to
220 * FB helper initialization. This needs to be tracked so that deferred
221 * FB helper setup can pass this on.
223 * See also: @deferred_setup
228 static inline struct drm_fb_helper *
229 drm_fb_helper_from_client(struct drm_client_dev *client)
231 return container_of(client, struct drm_fb_helper, client);
235 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
237 * Helper define to register default implementations of drm_fb_helper
238 * functions. To be used in struct fb_ops of drm drivers.
240 #define DRM_FB_HELPER_DEFAULT_OPS \
241 .fb_check_var = drm_fb_helper_check_var, \
242 .fb_set_par = drm_fb_helper_set_par, \
243 .fb_setcmap = drm_fb_helper_setcmap, \
244 .fb_blank = drm_fb_helper_blank, \
245 .fb_pan_display = drm_fb_helper_pan_display, \
246 .fb_debug_enter = drm_fb_helper_debug_enter, \
247 .fb_debug_leave = drm_fb_helper_debug_leave, \
248 .fb_ioctl = drm_fb_helper_ioctl
250 #ifdef CONFIG_DRM_FBDEV_EMULATION
251 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
252 const struct drm_fb_helper_funcs *funcs);
253 int drm_fb_helper_init(struct drm_device *dev,
254 struct drm_fb_helper *helper, int max_conn);
255 void drm_fb_helper_fini(struct drm_fb_helper *helper);
256 int drm_fb_helper_blank(int blank, struct fb_info *info);
257 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
258 struct fb_info *info);
259 int drm_fb_helper_set_par(struct fb_info *info);
260 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
261 struct fb_info *info);
263 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
265 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
266 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
267 void drm_fb_helper_fill_info(struct fb_info *info,
268 struct drm_fb_helper *fb_helper,
269 struct drm_fb_helper_surface_size *sizes);
271 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
273 void drm_fb_helper_deferred_io(struct fb_info *info,
274 struct list_head *pagelist);
275 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper);
277 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
278 size_t count, loff_t *ppos);
279 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
280 size_t count, loff_t *ppos);
282 void drm_fb_helper_sys_fillrect(struct fb_info *info,
283 const struct fb_fillrect *rect);
284 void drm_fb_helper_sys_copyarea(struct fb_info *info,
285 const struct fb_copyarea *area);
286 void drm_fb_helper_sys_imageblit(struct fb_info *info,
287 const struct fb_image *image);
289 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
290 const struct fb_fillrect *rect);
291 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
292 const struct fb_copyarea *area);
293 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
294 const struct fb_image *image);
296 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
297 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
300 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
302 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
305 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
306 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
307 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
308 int drm_fb_helper_debug_enter(struct fb_info *info);
309 int drm_fb_helper_debug_leave(struct fb_info *info);
310 struct drm_display_mode *
311 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
312 int width, int height);
313 struct drm_display_mode *
314 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn);
316 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
317 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
318 struct drm_connector *connector);
320 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
321 struct drm_fb_helper *fb_helper,
322 const struct drm_fb_helper_funcs *funcs,
323 unsigned int preferred_bpp,
324 unsigned int max_conn_count);
325 void drm_fb_helper_fbdev_teardown(struct drm_device *dev);
327 void drm_fb_helper_lastclose(struct drm_device *dev);
328 void drm_fb_helper_output_poll_changed(struct drm_device *dev);
330 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
331 struct drm_fb_helper_surface_size *sizes);
332 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp);
334 static inline void drm_fb_helper_prepare(struct drm_device *dev,
335 struct drm_fb_helper *helper,
336 const struct drm_fb_helper_funcs *funcs)
340 static inline int drm_fb_helper_init(struct drm_device *dev,
341 struct drm_fb_helper *helper,
344 /* So drivers can use it to free the struct */
346 dev->fb_helper = helper;
351 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
353 if (helper && helper->dev)
354 helper->dev->fb_helper = NULL;
357 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
362 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
363 struct fb_info *info)
368 static inline int drm_fb_helper_set_par(struct fb_info *info)
373 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
374 struct fb_info *info)
380 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
385 static inline struct fb_info *
386 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
391 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
396 drm_fb_helper_fill_info(struct fb_info *info,
397 struct drm_fb_helper *fb_helper,
398 struct drm_fb_helper_surface_size *sizes)
402 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
403 struct fb_info *info)
408 static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
414 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
418 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
419 struct list_head *pagelist)
423 static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
428 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
429 char __user *buf, size_t count,
435 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
436 const char __user *buf,
437 size_t count, loff_t *ppos)
442 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
443 const struct fb_fillrect *rect)
447 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
448 const struct fb_copyarea *area)
452 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
453 const struct fb_image *image)
457 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
458 const struct fb_fillrect *rect)
462 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
463 const struct fb_copyarea *area)
467 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
468 const struct fb_image *image)
472 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
478 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
482 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
487 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
494 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
499 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
504 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
509 static inline struct drm_display_mode *
510 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
511 int width, int height)
516 static inline struct drm_display_mode *
517 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
518 int width, int height)
524 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
525 struct drm_connector *connector)
531 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
532 struct drm_connector *connector)
538 drm_fb_helper_fbdev_setup(struct drm_device *dev,
539 struct drm_fb_helper *fb_helper,
540 const struct drm_fb_helper_funcs *funcs,
541 unsigned int preferred_bpp,
542 unsigned int max_conn_count)
544 /* So drivers can use it to free the struct */
545 dev->fb_helper = fb_helper;
550 static inline void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
552 dev->fb_helper = NULL;
555 static inline void drm_fb_helper_lastclose(struct drm_device *dev)
559 static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
564 drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
565 struct drm_fb_helper_surface_size *sizes)
571 drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
579 * drm_fb_helper_remove_conflicting_framebuffers - remove firmware-configured framebuffers
580 * @a: memory range, users of which are to be removed
581 * @name: requesting driver name
582 * @primary: also kick vga16fb if present
584 * This function removes framebuffer devices (initialized by firmware/bootloader)
585 * which use memory range described by @a. If @a is NULL all such devices are
589 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
590 const char *name, bool primary)
592 #if IS_REACHABLE(CONFIG_FB)
593 return remove_conflicting_framebuffers(a, name, primary);
600 * drm_fb_helper_remove_conflicting_pci_framebuffers - remove firmware-configured framebuffers for PCI devices
602 * @resource_id: index of PCI BAR configuring framebuffer memory
603 * @name: requesting driver name
605 * This function removes framebuffer devices (eg. initialized by firmware)
606 * using memory range configured for @pdev's BAR @resource_id.
608 * The function assumes that PCI device with shadowed ROM drives a primary
609 * display and so kicks out vga16fb.
612 drm_fb_helper_remove_conflicting_pci_framebuffers(struct pci_dev *pdev,
619 * WARNING: Apparently we must kick fbdev drivers before vgacon,
620 * otherwise the vga fbdev driver falls over.
622 #if IS_REACHABLE(CONFIG_FB)
623 ret = remove_conflicting_pci_framebuffers(pdev, resource_id, name);
626 ret = vga_remove_vgacon(pdev);