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_crtc.h>
36 #include <linux/kgdb.h>
38 enum mode_set_atomic {
39 LEAVE_ATOMIC_MODE_SET,
40 ENTER_ATOMIC_MODE_SET,
43 struct drm_fb_offset {
47 struct drm_fb_helper_crtc {
48 struct drm_mode_set mode_set;
49 struct drm_display_mode *desired_mode;
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
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.
69 * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
70 * rather than the surface size.
72 struct drm_fb_helper_surface_size {
82 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
84 * Driver callbacks used by the fbdev emulation helper library.
86 struct drm_fb_helper_funcs {
90 * Set the given gamma LUT register on the given CRTC.
92 * This callback is optional.
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.
100 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
101 u16 blue, int regno);
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.
108 * This callback is optional.
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.
116 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
117 u16 *blue, int regno);
122 * Driver callback to allocate and initialize the fbdev info structure.
123 * Furthermore it also needs to allocate the DRM framebuffer used to
126 * This callback is mandatory.
130 * The driver should return 0 on success and a negative error code on
133 int (*fb_probe)(struct drm_fb_helper *helper,
134 struct drm_fb_helper_surface_size *sizes);
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.
145 * This callback is optional.
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.
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);
160 struct drm_fb_helper_connector {
161 struct drm_connector *connector;
165 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
166 * @fb: Scanout framebuffer object
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
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
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
187 struct drm_fb_helper {
188 struct drm_framebuffer *fb;
189 struct drm_device *dev;
191 struct drm_fb_helper_crtc *crtc_info;
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;
206 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
208 struct list_head kernel_fb_list;
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.
217 bool delayed_hotplug;
220 #ifdef CONFIG_DRM_FBDEV_EMULATION
221 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
222 const struct drm_fb_helper_funcs *funcs);
223 int drm_fb_helper_init(struct drm_device *dev,
224 struct drm_fb_helper *helper, int crtc_count,
226 void drm_fb_helper_fini(struct drm_fb_helper *helper);
227 int drm_fb_helper_blank(int blank, struct fb_info *info);
228 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
229 struct fb_info *info);
230 int drm_fb_helper_set_par(struct fb_info *info);
231 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
232 struct fb_info *info);
234 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
236 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
237 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
238 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
239 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
240 uint32_t fb_width, uint32_t fb_height);
241 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
244 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
246 void drm_fb_helper_deferred_io(struct fb_info *info,
247 struct list_head *pagelist);
249 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
250 size_t count, loff_t *ppos);
251 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
252 size_t count, loff_t *ppos);
254 void drm_fb_helper_sys_fillrect(struct fb_info *info,
255 const struct fb_fillrect *rect);
256 void drm_fb_helper_sys_copyarea(struct fb_info *info,
257 const struct fb_copyarea *area);
258 void drm_fb_helper_sys_imageblit(struct fb_info *info,
259 const struct fb_image *image);
261 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
262 const struct fb_fillrect *rect);
263 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
264 const struct fb_copyarea *area);
265 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
266 const struct fb_image *image);
268 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
269 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
272 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
274 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
275 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
276 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
277 int drm_fb_helper_debug_enter(struct fb_info *info);
278 int drm_fb_helper_debug_leave(struct fb_info *info);
279 struct drm_display_mode *
280 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
281 int width, int height);
282 struct drm_display_mode *
283 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
284 int width, int height);
286 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
287 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
288 struct drm_connector *connector);
290 static inline void drm_fb_helper_prepare(struct drm_device *dev,
291 struct drm_fb_helper *helper,
292 const struct drm_fb_helper_funcs *funcs)
296 static inline int drm_fb_helper_init(struct drm_device *dev,
297 struct drm_fb_helper *helper, int crtc_count,
303 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
307 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
312 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
313 struct fb_info *info)
318 static inline int drm_fb_helper_set_par(struct fb_info *info)
323 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
324 struct fb_info *info)
330 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
335 static inline struct fb_info *
336 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
341 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
344 static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
348 static inline void drm_fb_helper_fill_var(struct fb_info *info,
349 struct drm_fb_helper *fb_helper,
350 uint32_t fb_width, uint32_t fb_height)
354 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
359 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
360 struct fb_info *info)
365 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
369 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
370 struct list_head *pagelist)
374 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
375 char __user *buf, size_t count,
381 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
382 const char __user *buf,
383 size_t count, loff_t *ppos)
388 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
389 const struct fb_fillrect *rect)
393 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
394 const struct fb_copyarea *area)
398 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
399 const struct fb_image *image)
403 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
404 const struct fb_fillrect *rect)
408 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
409 const struct fb_copyarea *area)
413 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
414 const struct fb_image *image)
418 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
424 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
428 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
433 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
440 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
445 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
450 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
455 static inline struct drm_display_mode *
456 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
457 int width, int height)
462 static inline struct drm_display_mode *
463 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
464 int width, int height)
470 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
471 struct drm_connector *connector)
477 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
478 struct drm_connector *connector)
486 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
487 const char *name, bool primary)
489 #if IS_REACHABLE(CONFIG_FB)
490 return remove_conflicting_framebuffers(a, name, primary);