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_crtc.h>
  36 #include <linux/kgdb.h>
  37
  38 enum mode_set_atomic {
  39         LEAVE_ATOMIC_MODE_SET,
  40         ENTER_ATOMIC_MODE_SET,
  41 };
  42
  43 struct drm_fb_offset {
  44         int x, y;
  45 };
  46
  47 struct drm_fb_helper_crtc {
  48         struct drm_mode_set mode_set;
  49         struct drm_display_mode *desired_mode;
  50         int x, y;
  51 };
  52
  53 /**
  54  * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
  55  * @fb_width: fbdev width
  56  * @fb_height: fbdev height
  57  * @surface_width: scanout buffer width
  58  * @surface_height: scanout buffer height
  59  * @surface_bpp: scanout buffer bpp
  60  * @surface_depth: scanout buffer depth
  61  *
  62  * Note that the scanout surface width/height may be larger than the fbdev
  63  * width/height.  In case of multiple displays, the scanout surface is sized
  64  * according to the largest width/height (so it is large enough for all CRTCs
  65  * to scanout).  But the fbdev width/height is sized to the minimum width/
  66  * height of all the displays.  This ensures that fbcon fits on the smallest
  67  * of the attached displays.
  68  *
  69  * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
  70  * rather than the surface size.
  71  */
  72 struct drm_fb_helper_surface_size {
  73         u32 fb_width;
  74         u32 fb_height;
  75         u32 surface_width;
  76         u32 surface_height;
  77         u32 surface_bpp;
  78         u32 surface_depth;
  79 };
  80
  81 /**
  82  * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
  83  *
  84  * Driver callbacks used by the fbdev emulation helper library.
  85  */
  86 struct drm_fb_helper_funcs {
  87         /**
  88          * @gamma_set:
  89          *
  90          * Set the given gamma LUT register on the given CRTC.
  91          *
  92          * This callback is optional.
  93          *
  94          * FIXME:
  95          *
  96          * This callback is functionally redundant with the core gamma table
  97          * support and simply exists because the fbdev hasn't yet been
  98          * refactored to use the core gamma table interfaces.
  99          */
 100         void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
 101                           u16 blue, int regno);
 102         /**
 103          * @gamma_get:
 104          *
 105          * Read the given gamma LUT register on the given CRTC, used to save the
 106          * current LUT when force-restoring the fbdev for e.g. kdbg.
 107          *
 108          * This callback is optional.
 109          *
 110          * FIXME:
 111          *
 112          * This callback is functionally redundant with the core gamma table
 113          * support and simply exists because the fbdev hasn't yet been
 114          * refactored to use the core gamma table interfaces.
 115          */
 116         void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
 117                           u16 *blue, int regno);
 118
 119         /**
 120          * @fb_probe:
 121          *
 122          * Driver callback to allocate and initialize the fbdev info structure.
 123          * Furthermore it also needs to allocate the DRM framebuffer used to
 124          * back the fbdev.
 125          *
 126          * This callback is mandatory.
 127          *
 128          * RETURNS:
 129          *
 130          * The driver should return 0 on success and a negative error code on
 131          * failure.
 132          */
 133         int (*fb_probe)(struct drm_fb_helper *helper,
 134                         struct drm_fb_helper_surface_size *sizes);
 135
 136         /**
 137          * @initial_config:
 138          *
 139          * Driver callback to setup an initial fbdev display configuration.
 140          * Drivers can use this callback to tell the fbdev emulation what the
 141          * preferred initial configuration is. This is useful to implement
 142          * smooth booting where the fbdev (and subsequently all userspace) never
 143          * changes the mode, but always inherits the existing configuration.
 144          *
 145          * This callback is optional.
 146          *
 147          * RETURNS:
 148          *
 149          * The driver should return true if a suitable initial configuration has
 150          * been filled out and false when the fbdev helper should fall back to
 151          * the default probing logic.
 152          */
 153         bool (*initial_config)(struct drm_fb_helper *fb_helper,
 154                                struct drm_fb_helper_crtc **crtcs,
 155                                struct drm_display_mode **modes,
 156                                struct drm_fb_offset *offsets,
 157                                bool *enabled, int width, int height);
 158 };
 159
 160 struct drm_fb_helper_connector {
 161         struct drm_connector *connector;
 162 };
 163
 164 /**
 165  * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
 166  * @fb: Scanout framebuffer object
 167  * @dev: DRM device
 168  * @crtc_count: number of possible CRTCs
 169  * @crtc_info: per-CRTC helper state (mode, x/y offset, etc)
 170  * @connector_count: number of connected connectors
 171  * @connector_info_alloc_count: size of connector_info
 172  * @connector_info: array of per-connector information
 173  * @funcs: driver callbacks for fb helper
 174  * @fbdev: emulated fbdev device info struct
 175  * @pseudo_palette: fake palette of 16 colors
 176  * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
 177  *              the screen buffer
 178  * @dirty_lock: spinlock protecting @dirty_clip
 179  * @dirty_work: worker used to flush the framebuffer
 180  * @resume_work: worker used during resume if the console lock is already taken
 181  *
 182  * This is the main structure used by the fbdev helpers. Drivers supporting
 183  * fbdev emulation should embedded this into their overall driver structure.
 184  * Drivers must also fill out a struct &drm_fb_helper_funcs with a few
 185  * operations.
 186  */
 187 struct drm_fb_helper {
 188         struct drm_framebuffer *fb;
 189         struct drm_device *dev;
 190         int crtc_count;
 191         struct drm_fb_helper_crtc *crtc_info;
 192         int connector_count;
 193         int connector_info_alloc_count;
 194         struct drm_fb_helper_connector **connector_info;
 195         const struct drm_fb_helper_funcs *funcs;
 196         struct fb_info *fbdev;
 197         u32 pseudo_palette[17];
 198         struct drm_clip_rect dirty_clip;
 199         spinlock_t dirty_lock;
 200         struct work_struct dirty_work;
 201         struct work_struct resume_work;
 202
 203         /**
 204          * @kernel_fb_list:
 205          *
 206          * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
 207          */
 208         struct list_head kernel_fb_list;
 209
 210         /**
 211          * @delayed_hotplug:
 212          *
 213          * A hotplug was received while fbdev wasn't in control of the DRM
 214          * device, i.e. another KMS master was active. The output configuration
 215          * needs to be reprobe when fbdev is in control again.
 216          */
 217         bool delayed_hotplug;
 218 };
 219
 220 #ifdef CONFIG_DRM_FBDEV_EMULATION
 221 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
 222                            const struct drm_fb_helper_funcs *funcs);
 223 int drm_fb_helper_init(struct drm_device *dev,
 224                        struct drm_fb_helper *helper, int crtc_count,
 225                        int max_conn);
 226 void drm_fb_helper_fini(struct drm_fb_helper *helper);
 227 int drm_fb_helper_blank(int blank, struct fb_info *info);
 228 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
 229                               struct fb_info *info);
 230 int drm_fb_helper_set_par(struct fb_info *info);
 231 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
 232                             struct fb_info *info);
 233
 234 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
 235
 236 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
 237 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
 238 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
 239 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
 240                             uint32_t fb_width, uint32_t fb_height);
 241 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
 242                             uint32_t depth);
 243
 244 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
 245
 246 void drm_fb_helper_deferred_io(struct fb_info *info,
 247                                struct list_head *pagelist);
 248
 249 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
 250                                size_t count, loff_t *ppos);
 251 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
 252                                 size_t count, loff_t *ppos);
 253
 254 void drm_fb_helper_sys_fillrect(struct fb_info *info,
 255                                 const struct fb_fillrect *rect);
 256 void drm_fb_helper_sys_copyarea(struct fb_info *info,
 257                                 const struct fb_copyarea *area);
 258 void drm_fb_helper_sys_imageblit(struct fb_info *info,
 259                                  const struct fb_image *image);
 260
 261 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
 262                                 const struct fb_fillrect *rect);
 263 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
 264                                 const struct fb_copyarea *area);
 265 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
 266                                  const struct fb_image *image);
 267
 268 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
 269 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
 270                                         bool suspend);
 271
 272 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
 273
 274 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
 275 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
 276 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
 277 int drm_fb_helper_debug_enter(struct fb_info *info);
 278 int drm_fb_helper_debug_leave(struct fb_info *info);
 279 struct drm_display_mode *
 280 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
 281                         int width, int height);
 282 struct drm_display_mode *
 283 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
 284                       int width, int height);
 285
 286 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
 287 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
 288                                        struct drm_connector *connector);
 289 #else
 290 static inline int drm_fb_helper_modinit(void)
 291 {
 292         return 0;
 293 }
 294
 295 static inline void drm_fb_helper_prepare(struct drm_device *dev,
 296                                         struct drm_fb_helper *helper,
 297                                         const struct drm_fb_helper_funcs *funcs)
 298 {
 299 }
 300
 301 static inline int drm_fb_helper_init(struct drm_device *dev,
 302                        struct drm_fb_helper *helper, int crtc_count,
 303                        int max_conn)
 304 {
 305         return 0;
 306 }
 307
 308 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
 309 {
 310 }
 311
 312 static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
 318                                             struct fb_info *info)
 319 {
 320         return 0;
 321 }
 322
 323 static inline int drm_fb_helper_set_par(struct fb_info *info)
 324 {
 325         return 0;
 326 }
 327
 328 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
 329                                           struct fb_info *info)
 330 {
 331         return 0;
 332 }
 333
 334 static inline int
 335 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
 336 {
 337         return 0;
 338 }
 339
 340 static inline struct fb_info *
 341 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
 342 {
 343         return NULL;
 344 }
 345
 346 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
 347 {
 348 }
 349 static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
 350 {
 351 }
 352
 353 static inline void drm_fb_helper_fill_var(struct fb_info *info,
 354                                           struct drm_fb_helper *fb_helper,
 355                                           uint32_t fb_width, uint32_t fb_height)
 356 {
 357 }
 358
 359 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
 360                                           uint32_t depth)
 361 {
 362 }
 363
 364 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
 365                                         struct fb_info *info)
 366 {
 367         return 0;
 368 }
 369
 370 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
 371 {
 372 }
 373
 374 static inline void drm_fb_helper_deferred_io(struct fb_info *info,
 375                                              struct list_head *pagelist)
 376 {
 377 }
 378
 379 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
 380                                              char __user *buf, size_t count,
 381                                              loff_t *ppos)
 382 {
 383         return -ENODEV;
 384 }
 385
 386 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
 387                                               const char __user *buf,
 388                                               size_t count, loff_t *ppos)
 389 {
 390         return -ENODEV;
 391 }
 392
 393 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
 394                                               const struct fb_fillrect *rect)
 395 {
 396 }
 397
 398 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
 399                                               const struct fb_copyarea *area)
 400 {
 401 }
 402
 403 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
 404                                                const struct fb_image *image)
 405 {
 406 }
 407
 408 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
 409                                               const struct fb_fillrect *rect)
 410 {
 411 }
 412
 413 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
 414                                               const struct fb_copyarea *area)
 415 {
 416 }
 417
 418 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
 419                                                const struct fb_image *image)
 420 {
 421 }
 422
 423 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
 424                                              bool suspend)
 425 {
 426 }
 427
 428 static inline void
 429 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
 430 {
 431 }
 432
 433 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
 434 {
 435         return 0;
 436 }
 437
 438 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
 439                                                int bpp_sel)
 440 {
 441         return 0;
 442 }
 443
 444 static inline int
 445 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
 446 {
 447         return 0;
 448 }
 449
 450 static inline int drm_fb_helper_debug_enter(struct fb_info *info)
 451 {
 452         return 0;
 453 }
 454
 455 static inline int drm_fb_helper_debug_leave(struct fb_info *info)
 456 {
 457         return 0;
 458 }
 459
 460 static inline struct drm_display_mode *
 461 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
 462                        int width, int height)
 463 {
 464         return NULL;
 465 }
 466
 467 static inline struct drm_display_mode *
 468 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
 469                       int width, int height)
 470 {
 471         return NULL;
 472 }
 473
 474 static inline int
 475 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
 476                                 struct drm_connector *connector)
 477 {
 478         return 0;
 479 }
 480
 481 static inline int
 482 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
 483                                    struct drm_connector *connector)
 484 {
 485         return 0;
 486 }
 487
 488 #endif
 489
 490 static inline int
 491 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
 492                                               const char *name, bool primary)
 493 {
 494 #if IS_REACHABLE(CONFIG_FB)
 495         return remove_conflicting_framebuffers(a, name, primary);
 496 #else
 497         return 0;
 498 #endif
 499 }
 500
 501 #endif