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
38 #include <drm/drm_client.h>
40 enum mode_set_atomic {
41 LEAVE_ATOMIC_MODE_SET,
42 ENTER_ATOMIC_MODE_SET,
46 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
47 * @fb_width: fbdev width
48 * @fb_height: fbdev height
49 * @surface_width: scanout buffer width
50 * @surface_height: scanout buffer height
51 * @surface_bpp: scanout buffer bpp
52 * @surface_depth: scanout buffer depth
54 * Note that the scanout surface width/height may be larger than the fbdev
55 * width/height. In case of multiple displays, the scanout surface is sized
56 * according to the largest width/height (so it is large enough for all CRTCs
57 * to scanout). But the fbdev width/height is sized to the minimum width/
58 * height of all the displays. This ensures that fbcon fits on the smallest
59 * of the attached displays. fb_width/fb_height is used by
60 * drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
62 struct drm_fb_helper_surface_size {
72 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
74 * Driver callbacks used by the fbdev emulation helper library.
76 struct drm_fb_helper_funcs {
80 * Driver callback to allocate and initialize the fbdev info structure.
81 * Furthermore it also needs to allocate the DRM framebuffer used to
84 * This callback is mandatory.
88 * The driver should return 0 on success and a negative error code on
91 int (*fb_probe)(struct drm_fb_helper *helper,
92 struct drm_fb_helper_surface_size *sizes);
97 * Driver callback to update the framebuffer memory. If set, fbdev
98 * emulation will invoke this callback in regular intervals after
99 * the framebuffer has been written.
101 * This callback is optional.
104 * 0 on success, or an error code otherwise.
106 int (*fb_dirty)(struct drm_fb_helper *helper, struct drm_clip_rect *clip);
110 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
111 * @fb: Scanout framebuffer object
113 * @funcs: driver callbacks for fb helper
114 * @info: emulated fbdev device info struct
115 * @pseudo_palette: fake palette of 16 colors
116 * @damage_clip: clip rectangle used with deferred_io to accumulate damage to
118 * @damage_lock: spinlock protecting @damage_clip
119 * @damage_work: worker used to flush the framebuffer
120 * @resume_work: worker used during resume if the console lock is already taken
122 * This is the main structure used by the fbdev helpers. Drivers supporting
123 * fbdev emulation should embedded this into their overall driver structure.
124 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
127 struct drm_fb_helper {
131 * DRM client used by the generic fbdev emulation.
133 struct drm_client_dev client;
138 * Framebuffer used by the generic fbdev emulation.
140 struct drm_client_buffer *buffer;
142 struct drm_framebuffer *fb;
143 struct drm_device *dev;
144 const struct drm_fb_helper_funcs *funcs;
145 struct fb_info *info;
146 u32 pseudo_palette[17];
147 struct drm_clip_rect damage_clip;
148 spinlock_t damage_lock;
149 struct work_struct damage_work;
150 struct work_struct resume_work;
155 * Top-level FBDEV helper lock. This protects all internal data
156 * structures and lists, such as @connector_info and @crtc_info.
158 * FIXME: fbdev emulation locking is a mess and long term we want to
159 * protect all helper internal state with this lock as well as reduce
160 * core KMS locking as much as possible.
167 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
169 struct list_head kernel_fb_list;
174 * A hotplug was received while fbdev wasn't in control of the DRM
175 * device, i.e. another KMS master was active. The output configuration
176 * needs to be reprobe when fbdev is in control again.
178 bool delayed_hotplug;
183 * If no outputs are connected (disconnected or unknown) the FB helper
184 * code will defer setup until at least one of the outputs shows up.
185 * This field keeps track of the status so that setup can be retried
186 * at every hotplug event until it succeeds eventually.
188 * Protected by @lock.
195 * Temporary storage for the driver's preferred BPP setting passed to
196 * FB helper initialization. This needs to be tracked so that deferred
197 * FB helper setup can pass this on.
199 * See also: @deferred_setup
204 * @hint_leak_smem_start:
206 * Hint to the fbdev emulation to store the framebuffer's physical
207 * address in struct &fb_info.fix.smem_start. If the hint is unset,
208 * the smem_start field should always be cleared to zero.
210 bool hint_leak_smem_start;
213 static inline struct drm_fb_helper *
214 drm_fb_helper_from_client(struct drm_client_dev *client)
216 return container_of(client, struct drm_fb_helper, client);
220 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
222 * Helper define to register default implementations of drm_fb_helper
223 * functions. To be used in struct fb_ops of drm drivers.
225 #define DRM_FB_HELPER_DEFAULT_OPS \
226 .fb_check_var = drm_fb_helper_check_var, \
227 .fb_set_par = drm_fb_helper_set_par, \
228 .fb_setcmap = drm_fb_helper_setcmap, \
229 .fb_blank = drm_fb_helper_blank, \
230 .fb_pan_display = drm_fb_helper_pan_display, \
231 .fb_debug_enter = drm_fb_helper_debug_enter, \
232 .fb_debug_leave = drm_fb_helper_debug_leave, \
233 .fb_ioctl = drm_fb_helper_ioctl
235 #ifdef CONFIG_DRM_FBDEV_EMULATION
236 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
237 const struct drm_fb_helper_funcs *funcs);
238 int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
239 void drm_fb_helper_fini(struct drm_fb_helper *helper);
240 int drm_fb_helper_blank(int blank, struct fb_info *info);
241 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
242 struct fb_info *info);
243 int drm_fb_helper_set_par(struct fb_info *info);
244 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
245 struct fb_info *info);
247 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
249 struct fb_info *drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper);
250 void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper);
251 void drm_fb_helper_fill_info(struct fb_info *info,
252 struct drm_fb_helper *fb_helper,
253 struct drm_fb_helper_surface_size *sizes);
255 void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist);
257 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
258 size_t count, loff_t *ppos);
259 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
260 size_t count, loff_t *ppos);
262 void drm_fb_helper_sys_fillrect(struct fb_info *info,
263 const struct fb_fillrect *rect);
264 void drm_fb_helper_sys_copyarea(struct fb_info *info,
265 const struct fb_copyarea *area);
266 void drm_fb_helper_sys_imageblit(struct fb_info *info,
267 const struct fb_image *image);
269 ssize_t drm_fb_helper_cfb_read(struct fb_info *info, char __user *buf,
270 size_t count, loff_t *ppos);
271 ssize_t drm_fb_helper_cfb_write(struct fb_info *info, const char __user *buf,
272 size_t count, loff_t *ppos);
274 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
275 const struct fb_fillrect *rect);
276 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
277 const struct fb_copyarea *area);
278 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
279 const struct fb_image *image);
281 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
282 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
285 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
287 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
290 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
291 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
292 int drm_fb_helper_debug_enter(struct fb_info *info);
293 int drm_fb_helper_debug_leave(struct fb_info *info);
295 void drm_fb_helper_lastclose(struct drm_device *dev);
296 void drm_fb_helper_output_poll_changed(struct drm_device *dev);
298 static inline void drm_fb_helper_prepare(struct drm_device *dev,
299 struct drm_fb_helper *helper,
300 const struct drm_fb_helper_funcs *funcs)
304 static inline int drm_fb_helper_init(struct drm_device *dev,
305 struct drm_fb_helper *helper)
307 /* So drivers can use it to free the struct */
309 dev->fb_helper = helper;
314 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
316 if (helper && helper->dev)
317 helper->dev->fb_helper = NULL;
320 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
325 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
326 struct fb_info *info)
331 static inline int drm_fb_helper_set_par(struct fb_info *info)
336 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
337 struct fb_info *info)
343 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
348 static inline struct fb_info *
349 drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper)
354 static inline void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper)
359 drm_fb_helper_fill_info(struct fb_info *info,
360 struct drm_fb_helper *fb_helper,
361 struct drm_fb_helper_surface_size *sizes)
365 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
366 struct fb_info *info)
371 static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
377 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
378 struct list_head *pagelist)
382 static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
387 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
388 char __user *buf, size_t count,
394 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
395 const char __user *buf,
396 size_t count, loff_t *ppos)
401 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
402 const struct fb_fillrect *rect)
406 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
407 const struct fb_copyarea *area)
411 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
412 const struct fb_image *image)
416 static inline ssize_t drm_fb_helper_cfb_read(struct fb_info *info, char __user *buf,
417 size_t count, loff_t *ppos)
422 static inline ssize_t drm_fb_helper_cfb_write(struct fb_info *info, const char __user *buf,
423 size_t count, loff_t *ppos)
428 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
429 const struct fb_fillrect *rect)
433 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
434 const struct fb_copyarea *area)
438 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
439 const struct fb_image *image)
443 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
449 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
453 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
458 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
464 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
469 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
474 static inline void drm_fb_helper_lastclose(struct drm_device *dev)
478 static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)