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 <linux/kgdb.h>
37 enum mode_set_atomic {
38 LEAVE_ATOMIC_MODE_SET,
39 ENTER_ATOMIC_MODE_SET,
42 struct drm_fb_offset {
46 struct drm_fb_helper_crtc {
47 struct drm_mode_set mode_set;
48 struct drm_display_mode *desired_mode;
53 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
54 * @fb_width: fbdev width
55 * @fb_height: fbdev height
56 * @surface_width: scanout buffer width
57 * @surface_height: scanout buffer height
58 * @surface_bpp: scanout buffer bpp
59 * @surface_depth: scanout buffer depth
61 * Note that the scanout surface width/height may be larger than the fbdev
62 * width/height. In case of multiple displays, the scanout surface is sized
63 * according to the largest width/height (so it is large enough for all CRTCs
64 * to scanout). But the fbdev width/height is sized to the minimum width/
65 * height of all the displays. This ensures that fbcon fits on the smallest
66 * of the attached displays.
68 * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
69 * rather than the surface size.
71 struct drm_fb_helper_surface_size {
81 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
83 * Driver callbacks used by the fbdev emulation helper library.
85 struct drm_fb_helper_funcs {
89 * Set the given gamma LUT register on the given CRTC.
91 * This callback is optional.
95 * This callback is functionally redundant with the core gamma table
96 * support and simply exists because the fbdev hasn't yet been
97 * refactored to use the core gamma table interfaces.
99 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
100 u16 blue, int regno);
104 * Read the given gamma LUT register on the given CRTC, used to save the
105 * current LUT when force-restoring the fbdev for e.g. kdbg.
107 * This callback is optional.
111 * This callback is functionally redundant with the core gamma table
112 * support and simply exists because the fbdev hasn't yet been
113 * refactored to use the core gamma table interfaces.
115 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
116 u16 *blue, int regno);
121 * Driver callback to allocate and initialize the fbdev info structure.
122 * Furthermore it also needs to allocate the DRM framebuffer used to
125 * This callback is mandatory.
129 * The driver should return 0 on success and a negative error code on
132 int (*fb_probe)(struct drm_fb_helper *helper,
133 struct drm_fb_helper_surface_size *sizes);
138 * Driver callback to setup an initial fbdev display configuration.
139 * Drivers can use this callback to tell the fbdev emulation what the
140 * preferred initial configuration is. This is useful to implement
141 * smooth booting where the fbdev (and subsequently all userspace) never
142 * changes the mode, but always inherits the existing configuration.
144 * This callback is optional.
148 * The driver should return true if a suitable initial configuration has
149 * been filled out and false when the fbdev helper should fall back to
150 * the default probing logic.
152 bool (*initial_config)(struct drm_fb_helper *fb_helper,
153 struct drm_fb_helper_crtc **crtcs,
154 struct drm_display_mode **modes,
155 struct drm_fb_offset *offsets,
156 bool *enabled, int width, int height);
159 struct drm_fb_helper_connector {
160 struct drm_connector *connector;
164 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
165 * @fb: Scanout framebuffer object
167 * @crtc_count: number of possible CRTCs
168 * @crtc_info: per-CRTC helper state (mode, x/y offset, etc)
169 * @connector_count: number of connected connectors
170 * @connector_info_alloc_count: size of connector_info
171 * @connector_info: array of per-connector information
172 * @funcs: driver callbacks for fb helper
173 * @fbdev: emulated fbdev device info struct
174 * @pseudo_palette: fake palette of 16 colors
175 * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
177 * @dirty_lock: spinlock protecting @dirty_clip
178 * @dirty_work: worker used to flush the framebuffer
180 * This is the main structure used by the fbdev helpers. Drivers supporting
181 * fbdev emulation should embedded this into their overall driver structure.
182 * Drivers must also fill out a struct &drm_fb_helper_funcs with a few
185 struct drm_fb_helper {
186 struct drm_framebuffer *fb;
187 struct drm_device *dev;
189 struct drm_fb_helper_crtc *crtc_info;
191 int connector_info_alloc_count;
192 struct drm_fb_helper_connector **connector_info;
193 const struct drm_fb_helper_funcs *funcs;
194 struct fb_info *fbdev;
195 u32 pseudo_palette[17];
196 struct drm_clip_rect dirty_clip;
197 spinlock_t dirty_lock;
198 struct work_struct dirty_work;
203 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
205 struct list_head kernel_fb_list;
210 * A hotplug was received while fbdev wasn't in control of the DRM
211 * device, i.e. another KMS master was active. The output configuration
212 * needs to be reprobe when fbdev is in control again.
214 bool delayed_hotplug;
219 * Use atomic updates for restore_fbdev_mode(), etc. This defaults to
220 * true if driver has DRIVER_ATOMIC feature flag, but drivers can
221 * override it to true after drm_fb_helper_init() if they support atomic
222 * modeset but do not yet advertise DRIVER_ATOMIC (note that fb-helper
223 * does not require ASYNC commits).
228 #ifdef CONFIG_DRM_FBDEV_EMULATION
229 int drm_fb_helper_modinit(void);
230 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
231 const struct drm_fb_helper_funcs *funcs);
232 int drm_fb_helper_init(struct drm_device *dev,
233 struct drm_fb_helper *helper, int crtc_count,
235 void drm_fb_helper_fini(struct drm_fb_helper *helper);
236 int drm_fb_helper_blank(int blank, struct fb_info *info);
237 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
238 struct fb_info *info);
239 int drm_fb_helper_set_par(struct fb_info *info);
240 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
241 struct fb_info *info);
243 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
245 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
246 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
247 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
248 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
249 uint32_t fb_width, uint32_t fb_height);
250 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
253 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
255 void drm_fb_helper_deferred_io(struct fb_info *info,
256 struct list_head *pagelist);
258 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
259 size_t count, loff_t *ppos);
260 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
261 size_t count, loff_t *ppos);
263 void drm_fb_helper_sys_fillrect(struct fb_info *info,
264 const struct fb_fillrect *rect);
265 void drm_fb_helper_sys_copyarea(struct fb_info *info,
266 const struct fb_copyarea *area);
267 void drm_fb_helper_sys_imageblit(struct fb_info *info,
268 const struct fb_image *image);
270 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
271 const struct fb_fillrect *rect);
272 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
273 const struct fb_copyarea *area);
274 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
275 const struct fb_image *image);
277 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state);
279 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
281 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
282 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
283 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
284 int drm_fb_helper_debug_enter(struct fb_info *info);
285 int drm_fb_helper_debug_leave(struct fb_info *info);
286 struct drm_display_mode *
287 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
288 int width, int height);
289 struct drm_display_mode *
290 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
291 int width, int height);
293 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
294 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
295 struct drm_connector *connector);
297 static inline int drm_fb_helper_modinit(void)
302 static inline void drm_fb_helper_prepare(struct drm_device *dev,
303 struct drm_fb_helper *helper,
304 const struct drm_fb_helper_funcs *funcs)
308 static inline int drm_fb_helper_init(struct drm_device *dev,
309 struct drm_fb_helper *helper, int crtc_count,
315 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
319 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
324 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
325 struct fb_info *info)
330 static inline int drm_fb_helper_set_par(struct fb_info *info)
335 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
336 struct fb_info *info)
342 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
347 static inline struct fb_info *
348 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
353 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
356 static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
360 static inline void drm_fb_helper_fill_var(struct fb_info *info,
361 struct drm_fb_helper *fb_helper,
362 uint32_t fb_width, uint32_t fb_height)
366 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
371 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
372 struct fb_info *info)
377 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
381 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
382 struct list_head *pagelist)
386 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
387 char __user *buf, size_t count,
393 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
394 const char __user *buf,
395 size_t count, loff_t *ppos)
400 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
401 const struct fb_fillrect *rect)
405 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
406 const struct fb_copyarea *area)
410 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
411 const struct fb_image *image)
415 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
416 const struct fb_fillrect *rect)
420 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
421 const struct fb_copyarea *area)
425 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
426 const struct fb_image *image)
430 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
435 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
440 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
447 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
452 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
457 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
462 static inline struct drm_display_mode *
463 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
464 int width, int height)
469 static inline struct drm_display_mode *
470 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
471 int width, int height)
477 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
478 struct drm_connector *connector)
484 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
485 struct drm_connector *connector)