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 struct lock 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 /** 221 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers 222 * 223 * Helper define to register default implementations of drm_fb_helper 224 * functions. To be used in struct fb_ops of drm drivers. 225 */ 226 #define DRM_FB_HELPER_DEFAULT_OPS \ 227 .fb_check_var = drm_fb_helper_check_var, \ 228 .fb_set_par = drm_fb_helper_set_par, \ 229 .fb_setcmap = drm_fb_helper_setcmap, \ 230 .fb_blank = drm_fb_helper_blank, \ 231 .fb_pan_display = drm_fb_helper_pan_display 232 233 /** 234 * @DRM_FB_HELPER_DEFAULT_OPS: 235 * 236 * Helper define to register default implementations of drm_fb_helper 237 * functions. To be used in struct fb_ops of drm drivers. 238 */ 239 #define DRM_FB_HELPER_DEFAULT_OPS \ 240 .fb_check_var = drm_fb_helper_check_var, \ 241 .fb_set_par = drm_fb_helper_set_par, \ 242 .fb_setcmap = drm_fb_helper_setcmap, \ 243 .fb_blank = drm_fb_helper_blank, \ 244 .fb_pan_display = drm_fb_helper_pan_display 245 246 #ifdef CONFIG_DRM_FBDEV_EMULATION 247 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper, 248 const struct drm_fb_helper_funcs *funcs); 249 int drm_fb_helper_init(struct drm_device *dev, 250 struct drm_fb_helper *helper, int crtc_count, 251 int max_conn); 252 void drm_fb_helper_fini(struct drm_fb_helper *helper); 253 int drm_fb_helper_blank(int blank, struct fb_info *info); 254 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, 255 struct fb_info *info); 256 int drm_fb_helper_set_par(struct fb_info *info); 257 int drm_fb_helper_check_var(struct fb_var_screeninfo *var, 258 struct fb_info *info); 259 260 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper); 261 262 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper); 263 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper); 264 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper); 265 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper, 266 uint32_t fb_width, uint32_t fb_height); 267 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, 268 uint32_t depth); 269 270 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper); 271 272 void drm_fb_helper_deferred_io(struct fb_info *info, 273 struct list_head *pagelist); 274 275 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf, 276 size_t count, loff_t *ppos); 277 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf, 278 size_t count, loff_t *ppos); 279 280 void drm_fb_helper_sys_fillrect(struct fb_info *info, 281 const struct fb_fillrect *rect); 282 void drm_fb_helper_sys_copyarea(struct fb_info *info, 283 const struct fb_copyarea *area); 284 void drm_fb_helper_sys_imageblit(struct fb_info *info, 285 const struct fb_image *image); 286 287 void drm_fb_helper_cfb_fillrect(struct fb_info *info, 288 const struct fb_fillrect *rect); 289 void drm_fb_helper_cfb_copyarea(struct fb_info *info, 290 const struct fb_copyarea *area); 291 void drm_fb_helper_cfb_imageblit(struct fb_info *info, 292 const struct fb_image *image); 293 294 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend); 295 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, 296 bool suspend); 297 298 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info); 299 300 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper); 301 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel); 302 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper); 303 int drm_fb_helper_debug_enter(struct fb_info *info); 304 int drm_fb_helper_debug_leave(struct fb_info *info); 305 struct drm_display_mode * 306 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, 307 int width, int height); 308 struct drm_display_mode * 309 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, 310 int width, int height); 311 312 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector); 313 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, 314 struct drm_connector *connector); 315 #else 316 static inline void drm_fb_helper_prepare(struct drm_device *dev, 317 struct drm_fb_helper *helper, 318 const struct drm_fb_helper_funcs *funcs) 319 { 320 } 321 322 static inline int drm_fb_helper_init(struct drm_device *dev, 323 struct drm_fb_helper *helper, int crtc_count, 324 int max_conn) 325 { 326 return 0; 327 } 328 329 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper) 330 { 331 } 332 333 static inline int drm_fb_helper_blank(int blank, struct fb_info *info) 334 { 335 return 0; 336 } 337 338 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, 339 struct fb_info *info) 340 { 341 return 0; 342 } 343 344 static inline int drm_fb_helper_set_par(struct fb_info *info) 345 { 346 return 0; 347 } 348 349 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var, 350 struct fb_info *info) 351 { 352 return 0; 353 } 354 355 static inline int 356 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper) 357 { 358 return 0; 359 } 360 361 static inline struct fb_info * 362 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper) 363 { 364 return NULL; 365 } 366 367 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper) 368 { 369 } 370 static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper) 371 { 372 } 373 374 static inline void drm_fb_helper_fill_var(struct fb_info *info, 375 struct drm_fb_helper *fb_helper, 376 uint32_t fb_width, uint32_t fb_height) 377 { 378 } 379 380 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, 381 uint32_t depth) 382 { 383 } 384 385 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap, 386 struct fb_info *info) 387 { 388 return 0; 389 } 390 391 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper) 392 { 393 } 394 395 static inline void drm_fb_helper_deferred_io(struct fb_info *info, 396 struct list_head *pagelist) 397 { 398 } 399 400 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info, 401 char __user *buf, size_t count, 402 loff_t *ppos) 403 { 404 return -ENODEV; 405 } 406 407 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info, 408 const char __user *buf, 409 size_t count, loff_t *ppos) 410 { 411 return -ENODEV; 412 } 413 414 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info, 415 const struct fb_fillrect *rect) 416 { 417 } 418 419 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info, 420 const struct fb_copyarea *area) 421 { 422 } 423 424 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info, 425 const struct fb_image *image) 426 { 427 } 428 429 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info, 430 const struct fb_fillrect *rect) 431 { 432 } 433 434 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info, 435 const struct fb_copyarea *area) 436 { 437 } 438 439 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info, 440 const struct fb_image *image) 441 { 442 } 443 444 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, 445 bool suspend) 446 { 447 } 448 449 static inline void 450 drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend) 451 { 452 } 453 454 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper) 455 { 456 return 0; 457 } 458 459 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, 460 int bpp_sel) 461 { 462 return 0; 463 } 464 465 static inline int 466 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper) 467 { 468 return 0; 469 } 470 471 static inline int drm_fb_helper_debug_enter(struct fb_info *info) 472 { 473 return 0; 474 } 475 476 static inline int drm_fb_helper_debug_leave(struct fb_info *info) 477 { 478 return 0; 479 } 480 481 static inline struct drm_display_mode * 482 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, 483 int width, int height) 484 { 485 return NULL; 486 } 487 488 static inline struct drm_display_mode * 489 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, 490 int width, int height) 491 { 492 return NULL; 493 } 494 495 static inline int 496 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, 497 struct drm_connector *connector) 498 { 499 return 0; 500 } 501 502 static inline int 503 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, 504 struct drm_connector *connector) 505 { 506 return 0; 507 } 508 509 #endif 510 511 static inline int 512 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a, 513 const char *name, bool primary) 514 { 515 #if IS_ENABLED(CONFIG_FB) 516 return remove_conflicting_framebuffers(a, name, primary); 517 #else 518 return 0; 519 #endif 520 } 521 522 #endif 523