]> asedeno.scripts.mit.edu Git - linux.git/blob - include/drm/drm_fb_helper.h
drm/fb-helper: Unexport fill_{var,info}
[linux.git] / include / drm / drm_fb_helper.h
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
33 struct 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
40 enum mode_set_atomic {
41         LEAVE_ATOMIC_MODE_SET,
42         ENTER_ATOMIC_MODE_SET,
43 };
44
45 struct drm_fb_offset {
46         int x, y;
47 };
48
49 struct drm_fb_helper_crtc {
50         struct drm_mode_set mode_set;
51         struct drm_display_mode *desired_mode;
52         int x, y;
53         int rotation;
54 };
55
56 /**
57  * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
58  * @fb_width: fbdev width
59  * @fb_height: fbdev height
60  * @surface_width: scanout buffer width
61  * @surface_height: scanout buffer height
62  * @surface_bpp: scanout buffer bpp
63  * @surface_depth: scanout buffer depth
64  *
65  * Note that the scanout surface width/height may be larger than the fbdev
66  * width/height.  In case of multiple displays, the scanout surface is sized
67  * according to the largest width/height (so it is large enough for all CRTCs
68  * to scanout).  But the fbdev width/height is sized to the minimum width/
69  * height of all the displays.  This ensures that fbcon fits on the smallest
70  * of the attached displays.
71  *
72  * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
73  * rather than the surface size.
74  */
75 struct drm_fb_helper_surface_size {
76         u32 fb_width;
77         u32 fb_height;
78         u32 surface_width;
79         u32 surface_height;
80         u32 surface_bpp;
81         u32 surface_depth;
82 };
83
84 /**
85  * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
86  *
87  * Driver callbacks used by the fbdev emulation helper library.
88  */
89 struct drm_fb_helper_funcs {
90         /**
91          * @fb_probe:
92          *
93          * Driver callback to allocate and initialize the fbdev info structure.
94          * Furthermore it also needs to allocate the DRM framebuffer used to
95          * back the fbdev.
96          *
97          * This callback is mandatory.
98          *
99          * RETURNS:
100          *
101          * The driver should return 0 on success and a negative error code on
102          * failure.
103          */
104         int (*fb_probe)(struct drm_fb_helper *helper,
105                         struct drm_fb_helper_surface_size *sizes);
106
107         /**
108          * @initial_config:
109          *
110          * Driver callback to setup an initial fbdev display configuration.
111          * Drivers can use this callback to tell the fbdev emulation what the
112          * preferred initial configuration is. This is useful to implement
113          * smooth booting where the fbdev (and subsequently all userspace) never
114          * changes the mode, but always inherits the existing configuration.
115          *
116          * This callback is optional.
117          *
118          * RETURNS:
119          *
120          * The driver should return true if a suitable initial configuration has
121          * been filled out and false when the fbdev helper should fall back to
122          * the default probing logic.
123          */
124         bool (*initial_config)(struct drm_fb_helper *fb_helper,
125                                struct drm_fb_helper_crtc **crtcs,
126                                struct drm_display_mode **modes,
127                                struct drm_fb_offset *offsets,
128                                bool *enabled, int width, int height);
129 };
130
131 struct drm_fb_helper_connector {
132         struct drm_connector *connector;
133 };
134
135 /**
136  * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
137  * @fb: Scanout framebuffer object
138  * @dev: DRM device
139  * @crtc_count: number of possible CRTCs
140  * @crtc_info: per-CRTC helper state (mode, x/y offset, etc)
141  * @connector_count: number of connected connectors
142  * @connector_info_alloc_count: size of connector_info
143  * @funcs: driver callbacks for fb helper
144  * @fbdev: emulated fbdev device info struct
145  * @pseudo_palette: fake palette of 16 colors
146  * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
147  *              the screen buffer
148  * @dirty_lock: spinlock protecting @dirty_clip
149  * @dirty_work: worker used to flush the framebuffer
150  * @resume_work: worker used during resume if the console lock is already taken
151  *
152  * This is the main structure used by the fbdev helpers. Drivers supporting
153  * fbdev emulation should embedded this into their overall driver structure.
154  * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
155  * operations.
156  */
157 struct drm_fb_helper {
158         /**
159          * @client:
160          *
161          * DRM client used by the generic fbdev emulation.
162          */
163         struct drm_client_dev client;
164
165         /**
166          * @buffer:
167          *
168          * Framebuffer used by the generic fbdev emulation.
169          */
170         struct drm_client_buffer *buffer;
171
172         struct drm_framebuffer *fb;
173         struct drm_device *dev;
174         int crtc_count;
175         struct drm_fb_helper_crtc *crtc_info;
176         int connector_count;
177         int connector_info_alloc_count;
178         /**
179          * @sw_rotations:
180          * Bitmask of all rotations requested for panel-orientation which
181          * could not be handled in hardware. If only one bit is set
182          * fbdev->fbcon_rotate_hint gets set to the requested rotation.
183          */
184         int sw_rotations;
185         /**
186          * @connector_info:
187          *
188          * Array of per-connector information. Do not iterate directly, but use
189          * drm_fb_helper_for_each_connector.
190          */
191         struct drm_fb_helper_connector **connector_info;
192         const struct drm_fb_helper_funcs *funcs;
193         struct fb_info *fbdev;
194         u32 pseudo_palette[17];
195         struct drm_clip_rect dirty_clip;
196         spinlock_t dirty_lock;
197         struct work_struct dirty_work;
198         struct work_struct resume_work;
199
200         /**
201          * @lock:
202          *
203          * Top-level FBDEV helper lock. This protects all internal data
204          * structures and lists, such as @connector_info and @crtc_info.
205          *
206          * FIXME: fbdev emulation locking is a mess and long term we want to
207          * protect all helper internal state with this lock as well as reduce
208          * core KMS locking as much as possible.
209          */
210         struct mutex lock;
211
212         /**
213          * @kernel_fb_list:
214          *
215          * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
216          */
217         struct list_head kernel_fb_list;
218
219         /**
220          * @delayed_hotplug:
221          *
222          * A hotplug was received while fbdev wasn't in control of the DRM
223          * device, i.e. another KMS master was active. The output configuration
224          * needs to be reprobe when fbdev is in control again.
225          */
226         bool delayed_hotplug;
227
228         /**
229          * @deferred_setup:
230          *
231          * If no outputs are connected (disconnected or unknown) the FB helper
232          * code will defer setup until at least one of the outputs shows up.
233          * This field keeps track of the status so that setup can be retried
234          * at every hotplug event until it succeeds eventually.
235          *
236          * Protected by @lock.
237          */
238         bool deferred_setup;
239
240         /**
241          * @preferred_bpp:
242          *
243          * Temporary storage for the driver's preferred BPP setting passed to
244          * FB helper initialization. This needs to be tracked so that deferred
245          * FB helper setup can pass this on.
246          *
247          * See also: @deferred_setup
248          */
249         int preferred_bpp;
250 };
251
252 static inline struct drm_fb_helper *
253 drm_fb_helper_from_client(struct drm_client_dev *client)
254 {
255         return container_of(client, struct drm_fb_helper, client);
256 }
257
258 /**
259  * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
260  *
261  * Helper define to register default implementations of drm_fb_helper
262  * functions. To be used in struct fb_ops of drm drivers.
263  */
264 #define DRM_FB_HELPER_DEFAULT_OPS \
265         .fb_check_var   = drm_fb_helper_check_var, \
266         .fb_set_par     = drm_fb_helper_set_par, \
267         .fb_setcmap     = drm_fb_helper_setcmap, \
268         .fb_blank       = drm_fb_helper_blank, \
269         .fb_pan_display = drm_fb_helper_pan_display, \
270         .fb_debug_enter = drm_fb_helper_debug_enter, \
271         .fb_debug_leave = drm_fb_helper_debug_leave, \
272         .fb_ioctl       = drm_fb_helper_ioctl
273
274 #ifdef CONFIG_DRM_FBDEV_EMULATION
275 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
276                            const struct drm_fb_helper_funcs *funcs);
277 int drm_fb_helper_init(struct drm_device *dev,
278                        struct drm_fb_helper *helper, int max_conn);
279 void drm_fb_helper_fini(struct drm_fb_helper *helper);
280 int drm_fb_helper_blank(int blank, struct fb_info *info);
281 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
282                               struct fb_info *info);
283 int drm_fb_helper_set_par(struct fb_info *info);
284 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
285                             struct fb_info *info);
286
287 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
288
289 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
290 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
291 void drm_fb_helper_fill_info(struct fb_info *info,
292                              struct drm_fb_helper *fb_helper,
293                              struct drm_fb_helper_surface_size *sizes);
294
295 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
296
297 void drm_fb_helper_deferred_io(struct fb_info *info,
298                                struct list_head *pagelist);
299 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper);
300
301 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
302                                size_t count, loff_t *ppos);
303 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
304                                 size_t count, loff_t *ppos);
305
306 void drm_fb_helper_sys_fillrect(struct fb_info *info,
307                                 const struct fb_fillrect *rect);
308 void drm_fb_helper_sys_copyarea(struct fb_info *info,
309                                 const struct fb_copyarea *area);
310 void drm_fb_helper_sys_imageblit(struct fb_info *info,
311                                  const struct fb_image *image);
312
313 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
314                                 const struct fb_fillrect *rect);
315 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
316                                 const struct fb_copyarea *area);
317 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
318                                  const struct fb_image *image);
319
320 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
321 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
322                                         bool suspend);
323
324 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
325
326 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
327                         unsigned long arg);
328
329 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
330 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
331 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
332 int drm_fb_helper_debug_enter(struct fb_info *info);
333 int drm_fb_helper_debug_leave(struct fb_info *info);
334 struct drm_display_mode *
335 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
336                         int width, int height);
337 struct drm_display_mode *
338 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn);
339
340 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
341 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
342                                        struct drm_connector *connector);
343
344 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
345                               struct drm_fb_helper *fb_helper,
346                               const struct drm_fb_helper_funcs *funcs,
347                               unsigned int preferred_bpp,
348                               unsigned int max_conn_count);
349 void drm_fb_helper_fbdev_teardown(struct drm_device *dev);
350
351 void drm_fb_helper_lastclose(struct drm_device *dev);
352 void drm_fb_helper_output_poll_changed(struct drm_device *dev);
353
354 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
355                                 struct drm_fb_helper_surface_size *sizes);
356 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp);
357 #else
358 static inline void drm_fb_helper_prepare(struct drm_device *dev,
359                                         struct drm_fb_helper *helper,
360                                         const struct drm_fb_helper_funcs *funcs)
361 {
362 }
363
364 static inline int drm_fb_helper_init(struct drm_device *dev,
365                        struct drm_fb_helper *helper,
366                        int max_conn)
367 {
368         /* So drivers can use it to free the struct */
369         helper->dev = dev;
370         dev->fb_helper = helper;
371
372         return 0;
373 }
374
375 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
376 {
377         if (helper && helper->dev)
378                 helper->dev->fb_helper = NULL;
379 }
380
381 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
382 {
383         return 0;
384 }
385
386 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
387                                             struct fb_info *info)
388 {
389         return 0;
390 }
391
392 static inline int drm_fb_helper_set_par(struct fb_info *info)
393 {
394         return 0;
395 }
396
397 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
398                                           struct fb_info *info)
399 {
400         return 0;
401 }
402
403 static inline int
404 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
405 {
406         return 0;
407 }
408
409 static inline struct fb_info *
410 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
411 {
412         return NULL;
413 }
414
415 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
416 {
417 }
418
419 static inline void drm_fb_helper_fill_var(struct fb_info *info,
420                                           struct drm_fb_helper *fb_helper,
421                                           uint32_t fb_width, uint32_t fb_height)
422 {
423 }
424
425 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
426                                           uint32_t depth)
427 {
428 }
429
430 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
431                                         struct fb_info *info)
432 {
433         return 0;
434 }
435
436 static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
437                                       unsigned long arg)
438 {
439         return 0;
440 }
441
442 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
443 {
444 }
445
446 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
447                                              struct list_head *pagelist)
448 {
449 }
450
451 static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
452 {
453         return -ENODEV;
454 }
455
456 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
457                                              char __user *buf, size_t count,
458                                              loff_t *ppos)
459 {
460         return -ENODEV;
461 }
462
463 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
464                                               const char __user *buf,
465                                               size_t count, loff_t *ppos)
466 {
467         return -ENODEV;
468 }
469
470 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
471                                               const struct fb_fillrect *rect)
472 {
473 }
474
475 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
476                                               const struct fb_copyarea *area)
477 {
478 }
479
480 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
481                                                const struct fb_image *image)
482 {
483 }
484
485 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
486                                               const struct fb_fillrect *rect)
487 {
488 }
489
490 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
491                                               const struct fb_copyarea *area)
492 {
493 }
494
495 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
496                                                const struct fb_image *image)
497 {
498 }
499
500 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
501                                              bool suspend)
502 {
503 }
504
505 static inline void
506 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
507 {
508 }
509
510 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
511 {
512         return 0;
513 }
514
515 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
516                                                int bpp_sel)
517 {
518         return 0;
519 }
520
521 static inline int
522 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
523 {
524         return 0;
525 }
526
527 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
528 {
529         return 0;
530 }
531
532 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
533 {
534         return 0;
535 }
536
537 static inline struct drm_display_mode *
538 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
539                        int width, int height)
540 {
541         return NULL;
542 }
543
544 static inline struct drm_display_mode *
545 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
546                       int width, int height)
547 {
548         return NULL;
549 }
550
551 static inline int
552 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
553                                 struct drm_connector *connector)
554 {
555         return 0;
556 }
557
558 static inline int
559 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
560                                    struct drm_connector *connector)
561 {
562         return 0;
563 }
564
565 static inline int
566 drm_fb_helper_fbdev_setup(struct drm_device *dev,
567                           struct drm_fb_helper *fb_helper,
568                           const struct drm_fb_helper_funcs *funcs,
569                           unsigned int preferred_bpp,
570                           unsigned int max_conn_count)
571 {
572         /* So drivers can use it to free the struct */
573         dev->fb_helper = fb_helper;
574
575         return 0;
576 }
577
578 static inline void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
579 {
580         dev->fb_helper = NULL;
581 }
582
583 static inline void drm_fb_helper_lastclose(struct drm_device *dev)
584 {
585 }
586
587 static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
588 {
589 }
590
591 static inline int
592 drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
593                             struct drm_fb_helper_surface_size *sizes)
594 {
595         return 0;
596 }
597
598 static inline int
599 drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
600 {
601         return 0;
602 }
603
604 #endif
605
606 /**
607  * drm_fb_helper_remove_conflicting_framebuffers - remove firmware-configured framebuffers
608  * @a: memory range, users of which are to be removed
609  * @name: requesting driver name
610  * @primary: also kick vga16fb if present
611  *
612  * This function removes framebuffer devices (initialized by firmware/bootloader)
613  * which use memory range described by @a. If @a is NULL all such devices are
614  * removed.
615  */
616 static inline int
617 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
618                                               const char *name, bool primary)
619 {
620 #if IS_REACHABLE(CONFIG_FB)
621         return remove_conflicting_framebuffers(a, name, primary);
622 #else
623         return 0;
624 #endif
625 }
626
627 /**
628  * drm_fb_helper_remove_conflicting_pci_framebuffers - remove firmware-configured framebuffers for PCI devices
629  * @pdev: PCI device
630  * @resource_id: index of PCI BAR configuring framebuffer memory
631  * @name: requesting driver name
632  *
633  * This function removes framebuffer devices (eg. initialized by firmware)
634  * using memory range configured for @pdev's BAR @resource_id.
635  *
636  * The function assumes that PCI device with shadowed ROM drives a primary
637  * display and so kicks out vga16fb.
638  */
639 static inline int
640 drm_fb_helper_remove_conflicting_pci_framebuffers(struct pci_dev *pdev,
641                                                   int resource_id,
642                                                   const char *name)
643 {
644 #if IS_REACHABLE(CONFIG_FB)
645         return remove_conflicting_pci_framebuffers(pdev, resource_id, name);
646 #else
647         return 0;
648 #endif
649 }
650
651 #endif