Loading...
1/*
2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 *
6 * DRM framebuffer helper functions
7 *
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.
17 *
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
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
29 */
30#ifndef DRM_FB_HELPER_H
31#define DRM_FB_HELPER_H
32
33struct drm_fb_helper;
34
35#include <linux/kgdb.h>
36
37struct drm_fb_helper_crtc {
38 uint32_t crtc_id;
39 struct drm_mode_set mode_set;
40 struct drm_display_mode *desired_mode;
41};
42
43struct drm_fb_helper_surface_size {
44 u32 fb_width;
45 u32 fb_height;
46 u32 surface_width;
47 u32 surface_height;
48 u32 surface_bpp;
49 u32 surface_depth;
50};
51
52struct drm_fb_helper_funcs {
53 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
54 u16 blue, int regno);
55 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
56 u16 *blue, int regno);
57
58 int (*fb_probe)(struct drm_fb_helper *helper,
59 struct drm_fb_helper_surface_size *sizes);
60};
61
62struct drm_fb_helper_connector {
63 struct drm_connector *connector;
64 struct drm_cmdline_mode cmdline_mode;
65};
66
67struct drm_fb_helper {
68 struct drm_framebuffer *fb;
69 struct drm_framebuffer *saved_fb;
70 struct drm_device *dev;
71 struct drm_display_mode *mode;
72 int crtc_count;
73 struct drm_fb_helper_crtc *crtc_info;
74 int connector_count;
75 struct drm_fb_helper_connector **connector_info;
76 struct drm_fb_helper_funcs *funcs;
77 int conn_limit;
78 struct fb_info *fbdev;
79 u32 pseudo_palette[17];
80 struct list_head kernel_fb_list;
81
82 /* we got a hotplug but fbdev wasn't running the console
83 delay until next set_par */
84 bool delayed_hotplug;
85};
86
87int drm_fb_helper_single_fb_probe(struct drm_fb_helper *helper,
88 int preferred_bpp);
89
90int drm_fb_helper_init(struct drm_device *dev,
91 struct drm_fb_helper *helper, int crtc_count,
92 int max_conn);
93void drm_fb_helper_fini(struct drm_fb_helper *helper);
94int drm_fb_helper_blank(int blank, struct fb_info *info);
95int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
96 struct fb_info *info);
97int drm_fb_helper_set_par(struct fb_info *info);
98int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
99 struct fb_info *info);
100int drm_fb_helper_setcolreg(unsigned regno,
101 unsigned red,
102 unsigned green,
103 unsigned blue,
104 unsigned transp,
105 struct fb_info *info);
106
107bool drm_fb_helper_restore_fbdev_mode(struct drm_fb_helper *fb_helper);
108void drm_fb_helper_restore(void);
109void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
110 uint32_t fb_width, uint32_t fb_height);
111void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
112 uint32_t depth);
113
114int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
115
116int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
117bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
118int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
119int drm_fb_helper_debug_enter(struct fb_info *info);
120int drm_fb_helper_debug_leave(struct fb_info *info);
121
122#endif
1/*
2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 *
6 * DRM framebuffer helper functions
7 *
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.
17 *
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
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
29 */
30#ifndef DRM_FB_HELPER_H
31#define DRM_FB_HELPER_H
32
33struct drm_fb_helper;
34
35#include <drm/drm_client.h>
36#include <drm/drm_crtc.h>
37#include <drm/drm_device.h>
38#include <linux/kgdb.h>
39
40enum mode_set_atomic {
41 LEAVE_ATOMIC_MODE_SET,
42 ENTER_ATOMIC_MODE_SET,
43};
44
45/**
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
53 *
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.
61 */
62struct drm_fb_helper_surface_size {
63 u32 fb_width;
64 u32 fb_height;
65 u32 surface_width;
66 u32 surface_height;
67 u32 surface_bpp;
68 u32 surface_depth;
69};
70
71/**
72 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
73 *
74 * Driver callbacks used by the fbdev emulation helper library.
75 */
76struct drm_fb_helper_funcs {
77 /**
78 * @fb_probe:
79 *
80 * Driver callback to allocate and initialize the fbdev info structure.
81 * Furthermore it also needs to allocate the DRM framebuffer used to
82 * back the fbdev.
83 *
84 * This callback is mandatory.
85 *
86 * RETURNS:
87 *
88 * The driver should return 0 on success and a negative error code on
89 * failure.
90 */
91 int (*fb_probe)(struct drm_fb_helper *helper,
92 struct drm_fb_helper_surface_size *sizes);
93};
94
95/**
96 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
97 * @fb: Scanout framebuffer object
98 * @dev: DRM device
99 * @funcs: driver callbacks for fb helper
100 * @fbdev: emulated fbdev device info struct
101 * @pseudo_palette: fake palette of 16 colors
102 * @damage_clip: clip rectangle used with deferred_io to accumulate damage to
103 * the screen buffer
104 * @damage_lock: spinlock protecting @damage_clip
105 * @damage_work: worker used to flush the framebuffer
106 * @resume_work: worker used during resume if the console lock is already taken
107 *
108 * This is the main structure used by the fbdev helpers. Drivers supporting
109 * fbdev emulation should embedded this into their overall driver structure.
110 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
111 * operations.
112 */
113struct drm_fb_helper {
114 /**
115 * @client:
116 *
117 * DRM client used by the generic fbdev emulation.
118 */
119 struct drm_client_dev client;
120
121 /**
122 * @buffer:
123 *
124 * Framebuffer used by the generic fbdev emulation.
125 */
126 struct drm_client_buffer *buffer;
127
128 struct drm_framebuffer *fb;
129 struct drm_device *dev;
130 const struct drm_fb_helper_funcs *funcs;
131 struct fb_info *fbdev;
132 u32 pseudo_palette[17];
133 struct drm_clip_rect damage_clip;
134 spinlock_t damage_lock;
135 struct work_struct damage_work;
136 struct work_struct resume_work;
137
138 /**
139 * @lock:
140 *
141 * Top-level FBDEV helper lock. This protects all internal data
142 * structures and lists, such as @connector_info and @crtc_info.
143 *
144 * FIXME: fbdev emulation locking is a mess and long term we want to
145 * protect all helper internal state with this lock as well as reduce
146 * core KMS locking as much as possible.
147 */
148 struct mutex lock;
149
150 /**
151 * @kernel_fb_list:
152 *
153 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
154 */
155 struct list_head kernel_fb_list;
156
157 /**
158 * @delayed_hotplug:
159 *
160 * A hotplug was received while fbdev wasn't in control of the DRM
161 * device, i.e. another KMS master was active. The output configuration
162 * needs to be reprobe when fbdev is in control again.
163 */
164 bool delayed_hotplug;
165
166 /**
167 * @deferred_setup:
168 *
169 * If no outputs are connected (disconnected or unknown) the FB helper
170 * code will defer setup until at least one of the outputs shows up.
171 * This field keeps track of the status so that setup can be retried
172 * at every hotplug event until it succeeds eventually.
173 *
174 * Protected by @lock.
175 */
176 bool deferred_setup;
177
178 /**
179 * @preferred_bpp:
180 *
181 * Temporary storage for the driver's preferred BPP setting passed to
182 * FB helper initialization. This needs to be tracked so that deferred
183 * FB helper setup can pass this on.
184 *
185 * See also: @deferred_setup
186 */
187 int preferred_bpp;
188};
189
190static inline struct drm_fb_helper *
191drm_fb_helper_from_client(struct drm_client_dev *client)
192{
193 return container_of(client, struct drm_fb_helper, client);
194}
195
196/**
197 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
198 *
199 * Helper define to register default implementations of drm_fb_helper
200 * functions. To be used in struct fb_ops of drm drivers.
201 */
202#define DRM_FB_HELPER_DEFAULT_OPS \
203 .fb_check_var = drm_fb_helper_check_var, \
204 .fb_set_par = drm_fb_helper_set_par, \
205 .fb_setcmap = drm_fb_helper_setcmap, \
206 .fb_blank = drm_fb_helper_blank, \
207 .fb_pan_display = drm_fb_helper_pan_display, \
208 .fb_debug_enter = drm_fb_helper_debug_enter, \
209 .fb_debug_leave = drm_fb_helper_debug_leave, \
210 .fb_ioctl = drm_fb_helper_ioctl
211
212#ifdef CONFIG_DRM_FBDEV_EMULATION
213void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
214 const struct drm_fb_helper_funcs *funcs);
215int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
216void drm_fb_helper_fini(struct drm_fb_helper *helper);
217int drm_fb_helper_blank(int blank, struct fb_info *info);
218int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
219 struct fb_info *info);
220int drm_fb_helper_set_par(struct fb_info *info);
221int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
222 struct fb_info *info);
223
224int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
225
226struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
227void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
228void drm_fb_helper_fill_info(struct fb_info *info,
229 struct drm_fb_helper *fb_helper,
230 struct drm_fb_helper_surface_size *sizes);
231
232void drm_fb_helper_deferred_io(struct fb_info *info,
233 struct list_head *pagelist);
234
235ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
236 size_t count, loff_t *ppos);
237ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
238 size_t count, loff_t *ppos);
239
240void drm_fb_helper_sys_fillrect(struct fb_info *info,
241 const struct fb_fillrect *rect);
242void drm_fb_helper_sys_copyarea(struct fb_info *info,
243 const struct fb_copyarea *area);
244void drm_fb_helper_sys_imageblit(struct fb_info *info,
245 const struct fb_image *image);
246
247void drm_fb_helper_cfb_fillrect(struct fb_info *info,
248 const struct fb_fillrect *rect);
249void drm_fb_helper_cfb_copyarea(struct fb_info *info,
250 const struct fb_copyarea *area);
251void drm_fb_helper_cfb_imageblit(struct fb_info *info,
252 const struct fb_image *image);
253
254void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
255void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
256 bool suspend);
257
258int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
259
260int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
261 unsigned long arg);
262
263int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
264int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
265int drm_fb_helper_debug_enter(struct fb_info *info);
266int drm_fb_helper_debug_leave(struct fb_info *info);
267
268void drm_fb_helper_lastclose(struct drm_device *dev);
269void drm_fb_helper_output_poll_changed(struct drm_device *dev);
270
271void drm_fbdev_generic_setup(struct drm_device *dev,
272 unsigned int preferred_bpp);
273#else
274static inline void drm_fb_helper_prepare(struct drm_device *dev,
275 struct drm_fb_helper *helper,
276 const struct drm_fb_helper_funcs *funcs)
277{
278}
279
280static inline int drm_fb_helper_init(struct drm_device *dev,
281 struct drm_fb_helper *helper)
282{
283 /* So drivers can use it to free the struct */
284 helper->dev = dev;
285 dev->fb_helper = helper;
286
287 return 0;
288}
289
290static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
291{
292 if (helper && helper->dev)
293 helper->dev->fb_helper = NULL;
294}
295
296static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
297{
298 return 0;
299}
300
301static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
302 struct fb_info *info)
303{
304 return 0;
305}
306
307static inline int drm_fb_helper_set_par(struct fb_info *info)
308{
309 return 0;
310}
311
312static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
313 struct fb_info *info)
314{
315 return 0;
316}
317
318static inline int
319drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
320{
321 return 0;
322}
323
324static inline struct fb_info *
325drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
326{
327 return NULL;
328}
329
330static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
331{
332}
333
334static inline void
335drm_fb_helper_fill_info(struct fb_info *info,
336 struct drm_fb_helper *fb_helper,
337 struct drm_fb_helper_surface_size *sizes)
338{
339}
340
341static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
342 struct fb_info *info)
343{
344 return 0;
345}
346
347static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
348 unsigned long arg)
349{
350 return 0;
351}
352
353static inline void drm_fb_helper_deferred_io(struct fb_info *info,
354 struct list_head *pagelist)
355{
356}
357
358static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
359{
360 return -ENODEV;
361}
362
363static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
364 char __user *buf, size_t count,
365 loff_t *ppos)
366{
367 return -ENODEV;
368}
369
370static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
371 const char __user *buf,
372 size_t count, loff_t *ppos)
373{
374 return -ENODEV;
375}
376
377static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
378 const struct fb_fillrect *rect)
379{
380}
381
382static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
383 const struct fb_copyarea *area)
384{
385}
386
387static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
388 const struct fb_image *image)
389{
390}
391
392static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
393 const struct fb_fillrect *rect)
394{
395}
396
397static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
398 const struct fb_copyarea *area)
399{
400}
401
402static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
403 const struct fb_image *image)
404{
405}
406
407static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
408 bool suspend)
409{
410}
411
412static inline void
413drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
414{
415}
416
417static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
418{
419 return 0;
420}
421
422static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
423 int bpp_sel)
424{
425 return 0;
426}
427
428static inline int drm_fb_helper_debug_enter(struct fb_info *info)
429{
430 return 0;
431}
432
433static inline int drm_fb_helper_debug_leave(struct fb_info *info)
434{
435 return 0;
436}
437
438static inline void drm_fb_helper_lastclose(struct drm_device *dev)
439{
440}
441
442static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
443{
444}
445
446static inline void
447drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
448{
449}
450
451#endif
452
453#endif