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>
39 #include <linux/kgdb.h>
41 enum mode_set_atomic {
42 LEAVE_ATOMIC_MODE_SET,
43 ENTER_ATOMIC_MODE_SET,
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
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.
63 struct drm_fb_helper_surface_size {
73 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
75 * Driver callbacks used by the fbdev emulation helper library.
77 struct drm_fb_helper_funcs {
81 * Driver callback to allocate and initialize the fbdev info structure.
82 * Furthermore it also needs to allocate the DRM framebuffer used to
85 * This callback is mandatory.
89 * The driver should return 0 on success and a negative error code on
92 int (*fb_probe)(struct drm_fb_helper *helper,
93 struct drm_fb_helper_surface_size *sizes);
97 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
98 * @fb: Scanout framebuffer object
100 * @funcs: driver callbacks for fb helper
101 * @fbdev: emulated fbdev device info struct
102 * @pseudo_palette: fake palette of 16 colors
103 * @damage_clip: clip rectangle used with deferred_io to accumulate damage to
105 * @damage_lock: spinlock protecting @damage_clip
106 * @damage_work: worker used to flush the framebuffer
107 * @resume_work: worker used during resume if the console lock is already taken
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
114 struct drm_fb_helper {
118 * DRM client used by the generic fbdev emulation.
120 struct drm_client_dev client;
125 * Framebuffer used by the generic fbdev emulation.
127 struct drm_client_buffer *buffer;
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 damage_clip;
135 spinlock_t damage_lock;
136 struct work_struct damage_work;
137 struct work_struct resume_work;
142 * Top-level FBDEV helper lock. This protects all internal data
143 * structures and lists, such as @connector_info and @crtc_info.
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.
154 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
156 struct list_head kernel_fb_list;
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.
165 bool delayed_hotplug;
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.
175 * Protected by @lock.
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.
186 * See also: @deferred_setup
191 static inline struct drm_fb_helper *
192 drm_fb_helper_from_client(struct drm_client_dev *client)
194 return container_of(client, struct drm_fb_helper, client);
198 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
200 * Helper define to register default implementations of drm_fb_helper
201 * functions. To be used in struct fb_ops of drm drivers.
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
213 #ifdef CONFIG_DRM_FBDEV_EMULATION
214 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
215 const struct drm_fb_helper_funcs *funcs);
216 int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
217 void drm_fb_helper_fini(struct drm_fb_helper *helper);
218 int drm_fb_helper_blank(int blank, struct fb_info *info);
219 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
220 struct fb_info *info);
221 int drm_fb_helper_set_par(struct fb_info *info);
222 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
223 struct fb_info *info);
225 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
227 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
228 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
229 void drm_fb_helper_fill_info(struct fb_info *info,
230 struct drm_fb_helper *fb_helper,
231 struct drm_fb_helper_surface_size *sizes);
233 void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist);
235 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
236 size_t count, loff_t *ppos);
237 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
238 size_t count, loff_t *ppos);
240 void drm_fb_helper_sys_fillrect(struct fb_info *info,
241 const struct fb_fillrect *rect);
242 void drm_fb_helper_sys_copyarea(struct fb_info *info,
243 const struct fb_copyarea *area);
244 void drm_fb_helper_sys_imageblit(struct fb_info *info,
245 const struct fb_image *image);
247 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
248 const struct fb_fillrect *rect);
249 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
250 const struct fb_copyarea *area);
251 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
252 const struct fb_image *image);
254 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
255 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
258 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
260 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
263 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
264 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
265 int drm_fb_helper_debug_enter(struct fb_info *info);
266 int drm_fb_helper_debug_leave(struct fb_info *info);
268 void drm_fb_helper_lastclose(struct drm_device *dev);
269 void drm_fb_helper_output_poll_changed(struct drm_device *dev);
271 void drm_fbdev_generic_setup(struct drm_device *dev,
272 unsigned int preferred_bpp);
274 static inline void drm_fb_helper_prepare(struct drm_device *dev,
275 struct drm_fb_helper *helper,
276 const struct drm_fb_helper_funcs *funcs)
280 static inline int drm_fb_helper_init(struct drm_device *dev,
281 struct drm_fb_helper *helper)
283 /* So drivers can use it to free the struct */
285 dev->fb_helper = helper;
290 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
292 if (helper && helper->dev)
293 helper->dev->fb_helper = NULL;
296 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
301 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
302 struct fb_info *info)
307 static inline int drm_fb_helper_set_par(struct fb_info *info)
312 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
313 struct fb_info *info)
319 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
324 static inline struct fb_info *
325 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
330 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
335 drm_fb_helper_fill_info(struct fb_info *info,
336 struct drm_fb_helper *fb_helper,
337 struct drm_fb_helper_surface_size *sizes)
341 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
342 struct fb_info *info)
347 static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
353 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
354 struct list_head *pagelist)
358 static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
363 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
364 char __user *buf, size_t count,
370 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
371 const char __user *buf,
372 size_t count, loff_t *ppos)
377 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
378 const struct fb_fillrect *rect)
382 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
383 const struct fb_copyarea *area)
387 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
388 const struct fb_image *image)
392 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
393 const struct fb_fillrect *rect)
397 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
398 const struct fb_copyarea *area)
402 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
403 const struct fb_image *image)
407 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
413 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
417 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
422 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
428 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
433 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
438 static inline void drm_fb_helper_lastclose(struct drm_device *dev)
442 static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
447 drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)