GNU Linux-libre 4.19.211-gnu1
[releases.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_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
292                             uint32_t fb_width, uint32_t fb_height);
293 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
294                             uint32_t depth);
295
296 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
297
298 void drm_fb_helper_deferred_io(struct fb_info *info,
299                                struct list_head *pagelist);
300 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper);
301
302 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
303                                size_t count, loff_t *ppos);
304 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
305                                 size_t count, loff_t *ppos);
306
307 void drm_fb_helper_sys_fillrect(struct fb_info *info,
308                                 const struct fb_fillrect *rect);
309 void drm_fb_helper_sys_copyarea(struct fb_info *info,
310                                 const struct fb_copyarea *area);
311 void drm_fb_helper_sys_imageblit(struct fb_info *info,
312                                  const struct fb_image *image);
313
314 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
315                                 const struct fb_fillrect *rect);
316 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
317                                 const struct fb_copyarea *area);
318 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
319                                  const struct fb_image *image);
320
321 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
322 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
323                                         bool suspend);
324
325 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
326
327 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
328                         unsigned long arg);
329
330 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
331 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
332 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
333 int drm_fb_helper_debug_enter(struct fb_info *info);
334 int drm_fb_helper_debug_leave(struct fb_info *info);
335 struct drm_display_mode *
336 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
337                         int width, int height);
338 struct drm_display_mode *
339 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn);
340
341 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
342 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
343                                        struct drm_connector *connector);
344
345 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
346                               struct drm_fb_helper *fb_helper,
347                               const struct drm_fb_helper_funcs *funcs,
348                               unsigned int preferred_bpp,
349                               unsigned int max_conn_count);
350 void drm_fb_helper_fbdev_teardown(struct drm_device *dev);
351
352 void drm_fb_helper_lastclose(struct drm_device *dev);
353 void drm_fb_helper_output_poll_changed(struct drm_device *dev);
354
355 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
356                                 struct drm_fb_helper_surface_size *sizes);
357 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp);
358 #else
359 static inline void drm_fb_helper_prepare(struct drm_device *dev,
360                                         struct drm_fb_helper *helper,
361                                         const struct drm_fb_helper_funcs *funcs)
362 {
363 }
364
365 static inline int drm_fb_helper_init(struct drm_device *dev,
366                        struct drm_fb_helper *helper,
367                        int max_conn)
368 {
369         /* So drivers can use it to free the struct */
370         helper->dev = dev;
371         dev->fb_helper = helper;
372
373         return 0;
374 }
375
376 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
377 {
378         if (helper && helper->dev)
379                 helper->dev->fb_helper = NULL;
380 }
381
382 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
383 {
384         return 0;
385 }
386
387 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
388                                             struct fb_info *info)
389 {
390         return 0;
391 }
392
393 static inline int drm_fb_helper_set_par(struct fb_info *info)
394 {
395         return 0;
396 }
397
398 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
399                                           struct fb_info *info)
400 {
401         return 0;
402 }
403
404 static inline int
405 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
406 {
407         return 0;
408 }
409
410 static inline struct fb_info *
411 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
412 {
413         return NULL;
414 }
415
416 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
417 {
418 }
419
420 static inline void drm_fb_helper_fill_var(struct fb_info *info,
421                                           struct drm_fb_helper *fb_helper,
422                                           uint32_t fb_width, uint32_t fb_height)
423 {
424 }
425
426 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
427                                           uint32_t depth)
428 {
429 }
430
431 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
432                                         struct fb_info *info)
433 {
434         return 0;
435 }
436
437 static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
438                                       unsigned long arg)
439 {
440         return 0;
441 }
442
443 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
444 {
445 }
446
447 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
448                                              struct list_head *pagelist)
449 {
450 }
451
452 static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
453 {
454         return -ENODEV;
455 }
456
457 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
458                                              char __user *buf, size_t count,
459                                              loff_t *ppos)
460 {
461         return -ENODEV;
462 }
463
464 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
465                                               const char __user *buf,
466                                               size_t count, loff_t *ppos)
467 {
468         return -ENODEV;
469 }
470
471 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
472                                               const struct fb_fillrect *rect)
473 {
474 }
475
476 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
477                                               const struct fb_copyarea *area)
478 {
479 }
480
481 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
482                                                const struct fb_image *image)
483 {
484 }
485
486 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
487                                               const struct fb_fillrect *rect)
488 {
489 }
490
491 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
492                                               const struct fb_copyarea *area)
493 {
494 }
495
496 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
497                                                const struct fb_image *image)
498 {
499 }
500
501 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
502                                              bool suspend)
503 {
504 }
505
506 static inline void
507 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
508 {
509 }
510
511 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
512 {
513         return 0;
514 }
515
516 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
517                                                int bpp_sel)
518 {
519         return 0;
520 }
521
522 static inline int
523 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
524 {
525         return 0;
526 }
527
528 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
529 {
530         return 0;
531 }
532
533 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
534 {
535         return 0;
536 }
537
538 static inline struct drm_display_mode *
539 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
540                        int width, int height)
541 {
542         return NULL;
543 }
544
545 static inline struct drm_display_mode *
546 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
547                       int width, int height)
548 {
549         return NULL;
550 }
551
552 static inline int
553 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
554                                 struct drm_connector *connector)
555 {
556         return 0;
557 }
558
559 static inline int
560 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
561                                    struct drm_connector *connector)
562 {
563         return 0;
564 }
565
566 static inline int
567 drm_fb_helper_fbdev_setup(struct drm_device *dev,
568                           struct drm_fb_helper *fb_helper,
569                           const struct drm_fb_helper_funcs *funcs,
570                           unsigned int preferred_bpp,
571                           unsigned int max_conn_count)
572 {
573         /* So drivers can use it to free the struct */
574         dev->fb_helper = fb_helper;
575
576         return 0;
577 }
578
579 static inline void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
580 {
581         dev->fb_helper = NULL;
582 }
583
584 static inline void drm_fb_helper_lastclose(struct drm_device *dev)
585 {
586 }
587
588 static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
589 {
590 }
591
592 static inline int
593 drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
594                             struct drm_fb_helper_surface_size *sizes)
595 {
596         return 0;
597 }
598
599 static inline int
600 drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
601 {
602         return 0;
603 }
604
605 #endif
606
607 static inline int
608 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
609                                               const char *name, bool primary)
610 {
611 #if IS_REACHABLE(CONFIG_FB)
612         return remove_conflicting_framebuffers(a, name, primary);
613 #else
614         return 0;
615 #endif
616 }
617
618 #endif