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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 31 32 #include <linux/console.h> 33 #include <linux/pci.h> 34 #include <linux/sysrq.h> 35 #include <linux/vga_switcheroo.h> 36 37 #include <drm/drm_atomic.h> 38 #include <drm/drm_drv.h> 39 #include <drm/drm_fb_helper.h> 40 #include <drm/drm_fourcc.h> 41 #include <drm/drm_framebuffer.h> 42 #include <drm/drm_modeset_helper_vtables.h> 43 #include <drm/drm_print.h> 44 #include <drm/drm_vblank.h> 45 46 #include "drm_internal.h" 47 48 static bool drm_fbdev_emulation = true; 49 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600); 50 MODULE_PARM_DESC(fbdev_emulation, 51 "Enable legacy fbdev emulation [default=true]"); 52 53 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC; 54 module_param(drm_fbdev_overalloc, int, 0444); 55 MODULE_PARM_DESC(drm_fbdev_overalloc, 56 "Overallocation of the fbdev buffer (%) [default=" 57 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]"); 58 59 /* 60 * In order to keep user-space compatibility, we want in certain use-cases 61 * to keep leaking the fbdev physical address to the user-space program 62 * handling the fbdev buffer. 63 * This is a bad habit essentially kept into closed source opengl driver 64 * that should really be moved into open-source upstream projects instead 65 * of using legacy physical addresses in user space to communicate with 66 * other out-of-tree kernel modules. 67 * 68 * This module_param *should* be removed as soon as possible and be 69 * considered as a broken and legacy behaviour from a modern fbdev device. 70 */ 71 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM) 72 static bool drm_leak_fbdev_smem; 73 module_param_unsafe(drm_leak_fbdev_smem, bool, 0600); 74 MODULE_PARM_DESC(drm_leak_fbdev_smem, 75 "Allow unsafe leaking fbdev physical smem address [default=false]"); 76 #endif 77 78 static LIST_HEAD(kernel_fb_helper_list); 79 static DEFINE_MUTEX(kernel_fb_helper_lock); 80 81 /** 82 * DOC: fbdev helpers 83 * 84 * The fb helper functions are useful to provide an fbdev on top of a drm kernel 85 * mode setting driver. They can be used mostly independently from the crtc 86 * helper functions used by many drivers to implement the kernel mode setting 87 * interfaces. 88 * 89 * Drivers that support a dumb buffer with a virtual address and mmap support, 90 * should try out the generic fbdev emulation using drm_fbdev_generic_setup(). 91 * It will automatically set up deferred I/O if the driver requires a shadow 92 * buffer. 93 * 94 * Existing fbdev implementations should restore the fbdev console by using 95 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback. 96 * They should also notify the fb helper code from updates to the output 97 * configuration by using drm_fb_helper_output_poll_changed() as their 98 * &drm_mode_config_funcs.output_poll_changed callback. New implementations 99 * of fbdev should be build on top of struct &drm_client_funcs, which handles 100 * this automatically. Setting the old callbacks should be avoided. 101 * 102 * For suspend/resume consider using drm_mode_config_helper_suspend() and 103 * drm_mode_config_helper_resume() which takes care of fbdev as well. 104 * 105 * All other functions exported by the fb helper library can be used to 106 * implement the fbdev driver interface by the driver. 107 * 108 * It is possible, though perhaps somewhat tricky, to implement race-free 109 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare() 110 * helper must be called first to initialize the minimum required to make 111 * hotplug detection work. Drivers also need to make sure to properly set up 112 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init() 113 * it is safe to enable interrupts and start processing hotplug events. At the 114 * same time, drivers should initialize all modeset objects such as CRTCs, 115 * encoders and connectors. To finish up the fbdev helper initialization, the 116 * drm_fb_helper_init() function is called. To probe for all attached displays 117 * and set up an initial configuration using the detected hardware, drivers 118 * should call drm_fb_helper_initial_config(). 119 * 120 * If &drm_framebuffer_funcs.dirty is set, the 121 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will 122 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right 123 * away. This worker then calls the dirty() function ensuring that it will 124 * always run in process context since the fb_*() function could be running in 125 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io 126 * callback it will also schedule dirty_work with the damage collected from the 127 * mmap page writes. 128 * 129 * Deferred I/O is not compatible with SHMEM. Such drivers should request an 130 * fbdev shadow buffer and call drm_fbdev_generic_setup() instead. 131 */ 132 133 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc) 134 { 135 uint16_t *r_base, *g_base, *b_base; 136 137 if (crtc->funcs->gamma_set == NULL) 138 return; 139 140 r_base = crtc->gamma_store; 141 g_base = r_base + crtc->gamma_size; 142 b_base = g_base + crtc->gamma_size; 143 144 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 145 crtc->gamma_size, NULL); 146 } 147 148 /** 149 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter 150 * @info: fbdev registered by the helper 151 */ 152 int drm_fb_helper_debug_enter(struct fb_info *info) 153 { 154 struct drm_fb_helper *helper = info->par; 155 const struct drm_crtc_helper_funcs *funcs; 156 struct drm_mode_set *mode_set; 157 158 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) { 159 mutex_lock(&helper->client.modeset_mutex); 160 drm_client_for_each_modeset(mode_set, &helper->client) { 161 if (!mode_set->crtc->enabled) 162 continue; 163 164 funcs = mode_set->crtc->helper_private; 165 if (funcs->mode_set_base_atomic == NULL) 166 continue; 167 168 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev)) 169 continue; 170 171 funcs->mode_set_base_atomic(mode_set->crtc, 172 mode_set->fb, 173 mode_set->x, 174 mode_set->y, 175 ENTER_ATOMIC_MODE_SET); 176 } 177 mutex_unlock(&helper->client.modeset_mutex); 178 } 179 180 return 0; 181 } 182 EXPORT_SYMBOL(drm_fb_helper_debug_enter); 183 184 /** 185 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave 186 * @info: fbdev registered by the helper 187 */ 188 int drm_fb_helper_debug_leave(struct fb_info *info) 189 { 190 struct drm_fb_helper *helper = info->par; 191 struct drm_client_dev *client = &helper->client; 192 struct drm_device *dev = helper->dev; 193 struct drm_crtc *crtc; 194 const struct drm_crtc_helper_funcs *funcs; 195 struct drm_mode_set *mode_set; 196 struct drm_framebuffer *fb; 197 198 mutex_lock(&client->modeset_mutex); 199 drm_client_for_each_modeset(mode_set, client) { 200 crtc = mode_set->crtc; 201 if (drm_drv_uses_atomic_modeset(crtc->dev)) 202 continue; 203 204 funcs = crtc->helper_private; 205 fb = crtc->primary->fb; 206 207 if (!crtc->enabled) 208 continue; 209 210 if (!fb) { 211 drm_err(dev, "no fb to restore?\n"); 212 continue; 213 } 214 215 if (funcs->mode_set_base_atomic == NULL) 216 continue; 217 218 drm_fb_helper_restore_lut_atomic(mode_set->crtc); 219 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x, 220 crtc->y, LEAVE_ATOMIC_MODE_SET); 221 } 222 mutex_unlock(&client->modeset_mutex); 223 224 return 0; 225 } 226 EXPORT_SYMBOL(drm_fb_helper_debug_leave); 227 228 static int 229 __drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper, 230 bool force) 231 { 232 bool do_delayed; 233 int ret; 234 235 if (!drm_fbdev_emulation || !fb_helper) 236 return -ENODEV; 237 238 if (READ_ONCE(fb_helper->deferred_setup)) 239 return 0; 240 241 mutex_lock(&fb_helper->lock); 242 if (force) { 243 /* 244 * Yes this is the _locked version which expects the master lock 245 * to be held. But for forced restores we're intentionally 246 * racing here, see drm_fb_helper_set_par(). 247 */ 248 ret = drm_client_modeset_commit_locked(&fb_helper->client); 249 } else { 250 ret = drm_client_modeset_commit(&fb_helper->client); 251 } 252 253 do_delayed = fb_helper->delayed_hotplug; 254 if (do_delayed) 255 fb_helper->delayed_hotplug = false; 256 mutex_unlock(&fb_helper->lock); 257 258 if (do_delayed) 259 drm_fb_helper_hotplug_event(fb_helper); 260 261 return ret; 262 } 263 264 /** 265 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration 266 * @fb_helper: driver-allocated fbdev helper, can be NULL 267 * 268 * This should be called from driver's drm &drm_driver.lastclose callback 269 * when implementing an fbcon on top of kms using this helper. This ensures that 270 * the user isn't greeted with a black screen when e.g. X dies. 271 * 272 * RETURNS: 273 * Zero if everything went ok, negative error code otherwise. 274 */ 275 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper) 276 { 277 return __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, false); 278 } 279 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked); 280 281 #ifdef CONFIG_MAGIC_SYSRQ 282 /* emergency restore, don't bother with error reporting */ 283 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored) 284 { 285 struct drm_fb_helper *helper; 286 287 mutex_lock(&kernel_fb_helper_lock); 288 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) { 289 struct drm_device *dev = helper->dev; 290 291 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF) 292 continue; 293 294 mutex_lock(&helper->lock); 295 drm_client_modeset_commit_locked(&helper->client); 296 mutex_unlock(&helper->lock); 297 } 298 mutex_unlock(&kernel_fb_helper_lock); 299 } 300 301 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn); 302 303 static void drm_fb_helper_sysrq(int dummy1) 304 { 305 schedule_work(&drm_fb_helper_restore_work); 306 } 307 308 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { 309 .handler = drm_fb_helper_sysrq, 310 .help_msg = "force-fb(v)", 311 .action_msg = "Restore framebuffer console", 312 }; 313 #else 314 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { }; 315 #endif 316 317 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode) 318 { 319 struct drm_fb_helper *fb_helper = info->par; 320 321 mutex_lock(&fb_helper->lock); 322 drm_client_modeset_dpms(&fb_helper->client, dpms_mode); 323 mutex_unlock(&fb_helper->lock); 324 } 325 326 /** 327 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank 328 * @blank: desired blanking state 329 * @info: fbdev registered by the helper 330 */ 331 int drm_fb_helper_blank(int blank, struct fb_info *info) 332 { 333 if (oops_in_progress) 334 return -EBUSY; 335 336 switch (blank) { 337 /* Display: On; HSync: On, VSync: On */ 338 case FB_BLANK_UNBLANK: 339 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON); 340 break; 341 /* Display: Off; HSync: On, VSync: On */ 342 case FB_BLANK_NORMAL: 343 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY); 344 break; 345 /* Display: Off; HSync: Off, VSync: On */ 346 case FB_BLANK_HSYNC_SUSPEND: 347 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY); 348 break; 349 /* Display: Off; HSync: On, VSync: Off */ 350 case FB_BLANK_VSYNC_SUSPEND: 351 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND); 352 break; 353 /* Display: Off; HSync: Off, VSync: Off */ 354 case FB_BLANK_POWERDOWN: 355 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF); 356 break; 357 } 358 return 0; 359 } 360 EXPORT_SYMBOL(drm_fb_helper_blank); 361 362 static void drm_fb_helper_resume_worker(struct work_struct *work) 363 { 364 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper, 365 resume_work); 366 367 console_lock(); 368 fb_set_suspend(helper->info, 0); 369 console_unlock(); 370 } 371 372 static void drm_fb_helper_fb_dirty(struct drm_fb_helper *helper) 373 { 374 struct drm_device *dev = helper->dev; 375 struct drm_clip_rect *clip = &helper->damage_clip; 376 struct drm_clip_rect clip_copy; 377 unsigned long flags; 378 int ret; 379 380 if (drm_WARN_ON_ONCE(dev, !helper->funcs->fb_dirty)) 381 return; 382 383 spin_lock_irqsave(&helper->damage_lock, flags); 384 clip_copy = *clip; 385 clip->x1 = clip->y1 = ~0; 386 clip->x2 = clip->y2 = 0; 387 spin_unlock_irqrestore(&helper->damage_lock, flags); 388 389 ret = helper->funcs->fb_dirty(helper, &clip_copy); 390 if (ret) 391 goto err; 392 393 return; 394 395 err: 396 /* 397 * Restore damage clip rectangle on errors. The next run 398 * of the damage worker will perform the update. 399 */ 400 spin_lock_irqsave(&helper->damage_lock, flags); 401 clip->x1 = min_t(u32, clip->x1, clip_copy.x1); 402 clip->y1 = min_t(u32, clip->y1, clip_copy.y1); 403 clip->x2 = max_t(u32, clip->x2, clip_copy.x2); 404 clip->y2 = max_t(u32, clip->y2, clip_copy.y2); 405 spin_unlock_irqrestore(&helper->damage_lock, flags); 406 } 407 408 static void drm_fb_helper_damage_work(struct work_struct *work) 409 { 410 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper, damage_work); 411 412 drm_fb_helper_fb_dirty(helper); 413 } 414 415 /** 416 * drm_fb_helper_prepare - setup a drm_fb_helper structure 417 * @dev: DRM device 418 * @helper: driver-allocated fbdev helper structure to set up 419 * @preferred_bpp: Preferred bits per pixel for the device. 420 * @funcs: pointer to structure of functions associate with this helper 421 * 422 * Sets up the bare minimum to make the framebuffer helper usable. This is 423 * useful to implement race-free initialization of the polling helpers. 424 */ 425 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper, 426 unsigned int preferred_bpp, 427 const struct drm_fb_helper_funcs *funcs) 428 { 429 /* 430 * Pick a preferred bpp of 32 if no value has been given. This 431 * will select XRGB8888 for the framebuffer formats. All drivers 432 * have to support XRGB8888 for backwards compatibility with legacy 433 * userspace, so it's the safe choice here. 434 * 435 * TODO: Replace struct drm_mode_config.preferred_depth and this 436 * bpp value with a preferred format that is given as struct 437 * drm_format_info. Then derive all other values from the 438 * format. 439 */ 440 if (!preferred_bpp) 441 preferred_bpp = 32; 442 443 INIT_LIST_HEAD(&helper->kernel_fb_list); 444 spin_lock_init(&helper->damage_lock); 445 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker); 446 INIT_WORK(&helper->damage_work, drm_fb_helper_damage_work); 447 helper->damage_clip.x1 = helper->damage_clip.y1 = ~0; 448 mutex_init(&helper->lock); 449 helper->funcs = funcs; 450 helper->dev = dev; 451 helper->preferred_bpp = preferred_bpp; 452 } 453 EXPORT_SYMBOL(drm_fb_helper_prepare); 454 455 /** 456 * drm_fb_helper_unprepare - clean up a drm_fb_helper structure 457 * @fb_helper: driver-allocated fbdev helper structure to set up 458 * 459 * Cleans up the framebuffer helper. Inverse of drm_fb_helper_prepare(). 460 */ 461 void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper) 462 { 463 mutex_destroy(&fb_helper->lock); 464 } 465 EXPORT_SYMBOL(drm_fb_helper_unprepare); 466 467 /** 468 * drm_fb_helper_init - initialize a &struct drm_fb_helper 469 * @dev: drm device 470 * @fb_helper: driver-allocated fbdev helper structure to initialize 471 * 472 * This allocates the structures for the fbdev helper with the given limits. 473 * Note that this won't yet touch the hardware (through the driver interfaces) 474 * nor register the fbdev. This is only done in drm_fb_helper_initial_config() 475 * to allow driver writes more control over the exact init sequence. 476 * 477 * Drivers must call drm_fb_helper_prepare() before calling this function. 478 * 479 * RETURNS: 480 * Zero if everything went ok, nonzero otherwise. 481 */ 482 int drm_fb_helper_init(struct drm_device *dev, 483 struct drm_fb_helper *fb_helper) 484 { 485 int ret; 486 487 /* 488 * If this is not the generic fbdev client, initialize a drm_client 489 * without callbacks so we can use the modesets. 490 */ 491 if (!fb_helper->client.funcs) { 492 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL); 493 if (ret) 494 return ret; 495 } 496 497 dev->fb_helper = fb_helper; 498 499 return 0; 500 } 501 EXPORT_SYMBOL(drm_fb_helper_init); 502 503 /** 504 * drm_fb_helper_alloc_info - allocate fb_info and some of its members 505 * @fb_helper: driver-allocated fbdev helper 506 * 507 * A helper to alloc fb_info and the member cmap. Called by the driver 508 * within the fb_probe fb_helper callback function. Drivers do not 509 * need to release the allocated fb_info structure themselves, this is 510 * automatically done when calling drm_fb_helper_fini(). 511 * 512 * RETURNS: 513 * fb_info pointer if things went okay, pointer containing error code 514 * otherwise 515 */ 516 struct fb_info *drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper) 517 { 518 struct device *dev = fb_helper->dev->dev; 519 struct fb_info *info; 520 int ret; 521 522 info = framebuffer_alloc(0, dev); 523 if (!info) 524 return ERR_PTR(-ENOMEM); 525 526 ret = fb_alloc_cmap(&info->cmap, 256, 0); 527 if (ret) 528 goto err_release; 529 530 fb_helper->info = info; 531 info->skip_vt_switch = true; 532 533 return info; 534 535 err_release: 536 framebuffer_release(info); 537 return ERR_PTR(ret); 538 } 539 EXPORT_SYMBOL(drm_fb_helper_alloc_info); 540 541 /** 542 * drm_fb_helper_unregister_info - unregister fb_info framebuffer device 543 * @fb_helper: driver-allocated fbdev helper, can be NULL 544 * 545 * A wrapper around unregister_framebuffer, to release the fb_info 546 * framebuffer device. This must be called before releasing all resources for 547 * @fb_helper by calling drm_fb_helper_fini(). 548 */ 549 void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper) 550 { 551 if (fb_helper && fb_helper->info) 552 unregister_framebuffer(fb_helper->info); 553 } 554 EXPORT_SYMBOL(drm_fb_helper_unregister_info); 555 556 /** 557 * drm_fb_helper_fini - finialize a &struct drm_fb_helper 558 * @fb_helper: driver-allocated fbdev helper, can be NULL 559 * 560 * This cleans up all remaining resources associated with @fb_helper. 561 */ 562 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper) 563 { 564 struct fb_info *info; 565 566 if (!fb_helper) 567 return; 568 569 fb_helper->dev->fb_helper = NULL; 570 571 if (!drm_fbdev_emulation) 572 return; 573 574 cancel_work_sync(&fb_helper->resume_work); 575 cancel_work_sync(&fb_helper->damage_work); 576 577 info = fb_helper->info; 578 if (info) { 579 if (info->cmap.len) 580 fb_dealloc_cmap(&info->cmap); 581 framebuffer_release(info); 582 } 583 fb_helper->info = NULL; 584 585 mutex_lock(&kernel_fb_helper_lock); 586 if (!list_empty(&fb_helper->kernel_fb_list)) { 587 list_del(&fb_helper->kernel_fb_list); 588 if (list_empty(&kernel_fb_helper_list)) 589 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op); 590 } 591 mutex_unlock(&kernel_fb_helper_lock); 592 593 drm_fb_helper_unprepare(fb_helper); 594 595 if (!fb_helper->client.funcs) 596 drm_client_release(&fb_helper->client); 597 } 598 EXPORT_SYMBOL(drm_fb_helper_fini); 599 600 static void drm_fb_helper_add_damage_clip(struct drm_fb_helper *helper, u32 x, u32 y, 601 u32 width, u32 height) 602 { 603 struct drm_clip_rect *clip = &helper->damage_clip; 604 unsigned long flags; 605 606 spin_lock_irqsave(&helper->damage_lock, flags); 607 clip->x1 = min_t(u32, clip->x1, x); 608 clip->y1 = min_t(u32, clip->y1, y); 609 clip->x2 = max_t(u32, clip->x2, x + width); 610 clip->y2 = max_t(u32, clip->y2, y + height); 611 spin_unlock_irqrestore(&helper->damage_lock, flags); 612 } 613 614 static void drm_fb_helper_damage(struct drm_fb_helper *helper, u32 x, u32 y, 615 u32 width, u32 height) 616 { 617 drm_fb_helper_add_damage_clip(helper, x, y, width, height); 618 619 schedule_work(&helper->damage_work); 620 } 621 622 /* 623 * Convert memory region into area of scanlines and pixels per 624 * scanline. The parameters off and len must not reach beyond 625 * the end of the framebuffer. 626 */ 627 static void drm_fb_helper_memory_range_to_clip(struct fb_info *info, off_t off, size_t len, 628 struct drm_rect *clip) 629 { 630 off_t end = off + len; 631 u32 x1 = 0; 632 u32 y1 = off / info->fix.line_length; 633 u32 x2 = info->var.xres; 634 u32 y2 = DIV_ROUND_UP(end, info->fix.line_length); 635 636 if ((y2 - y1) == 1) { 637 /* 638 * We've only written to a single scanline. Try to reduce 639 * the number of horizontal pixels that need an update. 640 */ 641 off_t bit_off = (off % info->fix.line_length) * 8; 642 off_t bit_end = (end % info->fix.line_length) * 8; 643 644 x1 = bit_off / info->var.bits_per_pixel; 645 x2 = DIV_ROUND_UP(bit_end, info->var.bits_per_pixel); 646 } 647 648 drm_rect_init(clip, x1, y1, x2 - x1, y2 - y1); 649 } 650 651 /** 652 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function 653 * @info: fb_info struct pointer 654 * @pagereflist: list of mmap framebuffer pages that have to be flushed 655 * 656 * This function is used as the &fb_deferred_io.deferred_io 657 * callback function for flushing the fbdev mmap writes. 658 */ 659 void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist) 660 { 661 struct drm_fb_helper *helper = info->par; 662 unsigned long start, end, min_off, max_off; 663 struct fb_deferred_io_pageref *pageref; 664 struct drm_rect damage_area; 665 666 min_off = ULONG_MAX; 667 max_off = 0; 668 list_for_each_entry(pageref, pagereflist, list) { 669 start = pageref->offset; 670 end = start + PAGE_SIZE; 671 min_off = min(min_off, start); 672 max_off = max(max_off, end); 673 } 674 675 /* 676 * As we can only track pages, we might reach beyond the end 677 * of the screen and account for non-existing scanlines. Hence, 678 * keep the covered memory area within the screen buffer. 679 */ 680 max_off = min(max_off, info->screen_size); 681 682 if (min_off < max_off) { 683 drm_fb_helper_memory_range_to_clip(info, min_off, max_off - min_off, &damage_area); 684 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1, 685 drm_rect_width(&damage_area), 686 drm_rect_height(&damage_area)); 687 } 688 } 689 EXPORT_SYMBOL(drm_fb_helper_deferred_io); 690 691 typedef ssize_t (*drm_fb_helper_read_screen)(struct fb_info *info, char __user *buf, 692 size_t count, loff_t pos); 693 694 static ssize_t __drm_fb_helper_read(struct fb_info *info, char __user *buf, size_t count, 695 loff_t *ppos, drm_fb_helper_read_screen read_screen) 696 { 697 loff_t pos = *ppos; 698 size_t total_size; 699 ssize_t ret; 700 701 if (info->screen_size) 702 total_size = info->screen_size; 703 else 704 total_size = info->fix.smem_len; 705 706 if (pos >= total_size) 707 return 0; 708 if (count >= total_size) 709 count = total_size; 710 if (total_size - count < pos) 711 count = total_size - pos; 712 713 if (info->fbops->fb_sync) 714 info->fbops->fb_sync(info); 715 716 ret = read_screen(info, buf, count, pos); 717 if (ret > 0) 718 *ppos += ret; 719 720 return ret; 721 } 722 723 typedef ssize_t (*drm_fb_helper_write_screen)(struct fb_info *info, const char __user *buf, 724 size_t count, loff_t pos); 725 726 static ssize_t __drm_fb_helper_write(struct fb_info *info, const char __user *buf, size_t count, 727 loff_t *ppos, drm_fb_helper_write_screen write_screen) 728 { 729 loff_t pos = *ppos; 730 size_t total_size; 731 ssize_t ret; 732 int err = 0; 733 734 if (info->screen_size) 735 total_size = info->screen_size; 736 else 737 total_size = info->fix.smem_len; 738 739 if (pos > total_size) 740 return -EFBIG; 741 if (count > total_size) { 742 err = -EFBIG; 743 count = total_size; 744 } 745 if (total_size - count < pos) { 746 if (!err) 747 err = -ENOSPC; 748 count = total_size - pos; 749 } 750 751 if (info->fbops->fb_sync) 752 info->fbops->fb_sync(info); 753 754 /* 755 * Copy to framebuffer even if we already logged an error. Emulates 756 * the behavior of the original fbdev implementation. 757 */ 758 ret = write_screen(info, buf, count, pos); 759 if (ret < 0) 760 return ret; /* return last error, if any */ 761 else if (!ret) 762 return err; /* return previous error, if any */ 763 764 *ppos += ret; 765 766 return ret; 767 } 768 769 static ssize_t drm_fb_helper_read_screen_buffer(struct fb_info *info, char __user *buf, 770 size_t count, loff_t pos) 771 { 772 const char *src = info->screen_buffer + pos; 773 774 if (copy_to_user(buf, src, count)) 775 return -EFAULT; 776 777 return count; 778 } 779 780 /** 781 * drm_fb_helper_sys_read - Implements struct &fb_ops.fb_read for system memory 782 * @info: fb_info struct pointer 783 * @buf: userspace buffer to read from framebuffer memory 784 * @count: number of bytes to read from framebuffer memory 785 * @ppos: read offset within framebuffer memory 786 * 787 * Returns: 788 * The number of bytes read on success, or an error code otherwise. 789 */ 790 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf, 791 size_t count, loff_t *ppos) 792 { 793 return __drm_fb_helper_read(info, buf, count, ppos, drm_fb_helper_read_screen_buffer); 794 } 795 EXPORT_SYMBOL(drm_fb_helper_sys_read); 796 797 static ssize_t drm_fb_helper_write_screen_buffer(struct fb_info *info, const char __user *buf, 798 size_t count, loff_t pos) 799 { 800 char *dst = info->screen_buffer + pos; 801 802 if (copy_from_user(dst, buf, count)) 803 return -EFAULT; 804 805 return count; 806 } 807 808 /** 809 * drm_fb_helper_sys_write - Implements struct &fb_ops.fb_write for system memory 810 * @info: fb_info struct pointer 811 * @buf: userspace buffer to write to framebuffer memory 812 * @count: number of bytes to write to framebuffer memory 813 * @ppos: write offset within framebuffer memory 814 * 815 * Returns: 816 * The number of bytes written on success, or an error code otherwise. 817 */ 818 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf, 819 size_t count, loff_t *ppos) 820 { 821 struct drm_fb_helper *helper = info->par; 822 loff_t pos = *ppos; 823 ssize_t ret; 824 struct drm_rect damage_area; 825 826 ret = __drm_fb_helper_write(info, buf, count, ppos, drm_fb_helper_write_screen_buffer); 827 if (ret <= 0) 828 return ret; 829 830 if (helper->funcs->fb_dirty) { 831 drm_fb_helper_memory_range_to_clip(info, pos, ret, &damage_area); 832 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1, 833 drm_rect_width(&damage_area), 834 drm_rect_height(&damage_area)); 835 } 836 837 return ret; 838 } 839 EXPORT_SYMBOL(drm_fb_helper_sys_write); 840 841 /** 842 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect 843 * @info: fbdev registered by the helper 844 * @rect: info about rectangle to fill 845 * 846 * A wrapper around sys_fillrect implemented by fbdev core 847 */ 848 void drm_fb_helper_sys_fillrect(struct fb_info *info, 849 const struct fb_fillrect *rect) 850 { 851 struct drm_fb_helper *helper = info->par; 852 853 sys_fillrect(info, rect); 854 855 if (helper->funcs->fb_dirty) 856 drm_fb_helper_damage(helper, rect->dx, rect->dy, rect->width, rect->height); 857 } 858 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect); 859 860 /** 861 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea 862 * @info: fbdev registered by the helper 863 * @area: info about area to copy 864 * 865 * A wrapper around sys_copyarea implemented by fbdev core 866 */ 867 void drm_fb_helper_sys_copyarea(struct fb_info *info, 868 const struct fb_copyarea *area) 869 { 870 struct drm_fb_helper *helper = info->par; 871 872 sys_copyarea(info, area); 873 874 if (helper->funcs->fb_dirty) 875 drm_fb_helper_damage(helper, area->dx, area->dy, area->width, area->height); 876 } 877 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea); 878 879 /** 880 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit 881 * @info: fbdev registered by the helper 882 * @image: info about image to blit 883 * 884 * A wrapper around sys_imageblit implemented by fbdev core 885 */ 886 void drm_fb_helper_sys_imageblit(struct fb_info *info, 887 const struct fb_image *image) 888 { 889 struct drm_fb_helper *helper = info->par; 890 891 sys_imageblit(info, image); 892 893 if (helper->funcs->fb_dirty) 894 drm_fb_helper_damage(helper, image->dx, image->dy, image->width, image->height); 895 } 896 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit); 897 898 static ssize_t fb_read_screen_base(struct fb_info *info, char __user *buf, size_t count, 899 loff_t pos) 900 { 901 const char __iomem *src = info->screen_base + pos; 902 size_t alloc_size = min_t(size_t, count, PAGE_SIZE); 903 ssize_t ret = 0; 904 int err = 0; 905 char *tmp; 906 907 tmp = kmalloc(alloc_size, GFP_KERNEL); 908 if (!tmp) 909 return -ENOMEM; 910 911 while (count) { 912 size_t c = min_t(size_t, count, alloc_size); 913 914 memcpy_fromio(tmp, src, c); 915 if (copy_to_user(buf, tmp, c)) { 916 err = -EFAULT; 917 break; 918 } 919 920 src += c; 921 buf += c; 922 ret += c; 923 count -= c; 924 } 925 926 kfree(tmp); 927 928 return ret ? ret : err; 929 } 930 931 /** 932 * drm_fb_helper_cfb_read - Implements struct &fb_ops.fb_read for I/O memory 933 * @info: fb_info struct pointer 934 * @buf: userspace buffer to read from framebuffer memory 935 * @count: number of bytes to read from framebuffer memory 936 * @ppos: read offset within framebuffer memory 937 * 938 * Returns: 939 * The number of bytes read on success, or an error code otherwise. 940 */ 941 ssize_t drm_fb_helper_cfb_read(struct fb_info *info, char __user *buf, 942 size_t count, loff_t *ppos) 943 { 944 return __drm_fb_helper_read(info, buf, count, ppos, fb_read_screen_base); 945 } 946 EXPORT_SYMBOL(drm_fb_helper_cfb_read); 947 948 static ssize_t fb_write_screen_base(struct fb_info *info, const char __user *buf, size_t count, 949 loff_t pos) 950 { 951 char __iomem *dst = info->screen_base + pos; 952 size_t alloc_size = min_t(size_t, count, PAGE_SIZE); 953 ssize_t ret = 0; 954 int err = 0; 955 u8 *tmp; 956 957 tmp = kmalloc(alloc_size, GFP_KERNEL); 958 if (!tmp) 959 return -ENOMEM; 960 961 while (count) { 962 size_t c = min_t(size_t, count, alloc_size); 963 964 if (copy_from_user(tmp, buf, c)) { 965 err = -EFAULT; 966 break; 967 } 968 memcpy_toio(dst, tmp, c); 969 970 dst += c; 971 buf += c; 972 ret += c; 973 count -= c; 974 } 975 976 kfree(tmp); 977 978 return ret ? ret : err; 979 } 980 981 /** 982 * drm_fb_helper_cfb_write - Implements struct &fb_ops.fb_write for I/O memory 983 * @info: fb_info struct pointer 984 * @buf: userspace buffer to write to framebuffer memory 985 * @count: number of bytes to write to framebuffer memory 986 * @ppos: write offset within framebuffer memory 987 * 988 * Returns: 989 * The number of bytes written on success, or an error code otherwise. 990 */ 991 ssize_t drm_fb_helper_cfb_write(struct fb_info *info, const char __user *buf, 992 size_t count, loff_t *ppos) 993 { 994 struct drm_fb_helper *helper = info->par; 995 loff_t pos = *ppos; 996 ssize_t ret; 997 struct drm_rect damage_area; 998 999 ret = __drm_fb_helper_write(info, buf, count, ppos, fb_write_screen_base); 1000 if (ret <= 0) 1001 return ret; 1002 1003 if (helper->funcs->fb_dirty) { 1004 drm_fb_helper_memory_range_to_clip(info, pos, ret, &damage_area); 1005 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1, 1006 drm_rect_width(&damage_area), 1007 drm_rect_height(&damage_area)); 1008 } 1009 1010 return ret; 1011 } 1012 EXPORT_SYMBOL(drm_fb_helper_cfb_write); 1013 1014 /** 1015 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect 1016 * @info: fbdev registered by the helper 1017 * @rect: info about rectangle to fill 1018 * 1019 * A wrapper around cfb_fillrect implemented by fbdev core 1020 */ 1021 void drm_fb_helper_cfb_fillrect(struct fb_info *info, 1022 const struct fb_fillrect *rect) 1023 { 1024 struct drm_fb_helper *helper = info->par; 1025 1026 cfb_fillrect(info, rect); 1027 1028 if (helper->funcs->fb_dirty) 1029 drm_fb_helper_damage(helper, rect->dx, rect->dy, rect->width, rect->height); 1030 } 1031 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect); 1032 1033 /** 1034 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea 1035 * @info: fbdev registered by the helper 1036 * @area: info about area to copy 1037 * 1038 * A wrapper around cfb_copyarea implemented by fbdev core 1039 */ 1040 void drm_fb_helper_cfb_copyarea(struct fb_info *info, 1041 const struct fb_copyarea *area) 1042 { 1043 struct drm_fb_helper *helper = info->par; 1044 1045 cfb_copyarea(info, area); 1046 1047 if (helper->funcs->fb_dirty) 1048 drm_fb_helper_damage(helper, area->dx, area->dy, area->width, area->height); 1049 } 1050 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea); 1051 1052 /** 1053 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit 1054 * @info: fbdev registered by the helper 1055 * @image: info about image to blit 1056 * 1057 * A wrapper around cfb_imageblit implemented by fbdev core 1058 */ 1059 void drm_fb_helper_cfb_imageblit(struct fb_info *info, 1060 const struct fb_image *image) 1061 { 1062 struct drm_fb_helper *helper = info->par; 1063 1064 cfb_imageblit(info, image); 1065 1066 if (helper->funcs->fb_dirty) 1067 drm_fb_helper_damage(helper, image->dx, image->dy, image->width, image->height); 1068 } 1069 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit); 1070 1071 /** 1072 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend 1073 * @fb_helper: driver-allocated fbdev helper, can be NULL 1074 * @suspend: whether to suspend or resume 1075 * 1076 * A wrapper around fb_set_suspend implemented by fbdev core. 1077 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take 1078 * the lock yourself 1079 */ 1080 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend) 1081 { 1082 if (fb_helper && fb_helper->info) 1083 fb_set_suspend(fb_helper->info, suspend); 1084 } 1085 EXPORT_SYMBOL(drm_fb_helper_set_suspend); 1086 1087 /** 1088 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also 1089 * takes the console lock 1090 * @fb_helper: driver-allocated fbdev helper, can be NULL 1091 * @suspend: whether to suspend or resume 1092 * 1093 * A wrapper around fb_set_suspend() that takes the console lock. If the lock 1094 * isn't available on resume, a worker is tasked with waiting for the lock 1095 * to become available. The console lock can be pretty contented on resume 1096 * due to all the printk activity. 1097 * 1098 * This function can be called multiple times with the same state since 1099 * &fb_info.state is checked to see if fbdev is running or not before locking. 1100 * 1101 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself. 1102 */ 1103 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, 1104 bool suspend) 1105 { 1106 if (!fb_helper || !fb_helper->info) 1107 return; 1108 1109 /* make sure there's no pending/ongoing resume */ 1110 flush_work(&fb_helper->resume_work); 1111 1112 if (suspend) { 1113 if (fb_helper->info->state != FBINFO_STATE_RUNNING) 1114 return; 1115 1116 console_lock(); 1117 1118 } else { 1119 if (fb_helper->info->state == FBINFO_STATE_RUNNING) 1120 return; 1121 1122 if (!console_trylock()) { 1123 schedule_work(&fb_helper->resume_work); 1124 return; 1125 } 1126 } 1127 1128 fb_set_suspend(fb_helper->info, suspend); 1129 console_unlock(); 1130 } 1131 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked); 1132 1133 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info) 1134 { 1135 u32 *palette = (u32 *)info->pseudo_palette; 1136 int i; 1137 1138 if (cmap->start + cmap->len > 16) 1139 return -EINVAL; 1140 1141 for (i = 0; i < cmap->len; ++i) { 1142 u16 red = cmap->red[i]; 1143 u16 green = cmap->green[i]; 1144 u16 blue = cmap->blue[i]; 1145 u32 value; 1146 1147 red >>= 16 - info->var.red.length; 1148 green >>= 16 - info->var.green.length; 1149 blue >>= 16 - info->var.blue.length; 1150 value = (red << info->var.red.offset) | 1151 (green << info->var.green.offset) | 1152 (blue << info->var.blue.offset); 1153 if (info->var.transp.length > 0) { 1154 u32 mask = (1 << info->var.transp.length) - 1; 1155 1156 mask <<= info->var.transp.offset; 1157 value |= mask; 1158 } 1159 palette[cmap->start + i] = value; 1160 } 1161 1162 return 0; 1163 } 1164 1165 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info) 1166 { 1167 struct drm_fb_helper *fb_helper = info->par; 1168 struct drm_mode_set *modeset; 1169 struct drm_crtc *crtc; 1170 u16 *r, *g, *b; 1171 int ret = 0; 1172 1173 drm_modeset_lock_all(fb_helper->dev); 1174 drm_client_for_each_modeset(modeset, &fb_helper->client) { 1175 crtc = modeset->crtc; 1176 if (!crtc->funcs->gamma_set || !crtc->gamma_size) { 1177 ret = -EINVAL; 1178 goto out; 1179 } 1180 1181 if (cmap->start + cmap->len > crtc->gamma_size) { 1182 ret = -EINVAL; 1183 goto out; 1184 } 1185 1186 r = crtc->gamma_store; 1187 g = r + crtc->gamma_size; 1188 b = g + crtc->gamma_size; 1189 1190 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r)); 1191 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g)); 1192 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b)); 1193 1194 ret = crtc->funcs->gamma_set(crtc, r, g, b, 1195 crtc->gamma_size, NULL); 1196 if (ret) 1197 goto out; 1198 } 1199 out: 1200 drm_modeset_unlock_all(fb_helper->dev); 1201 1202 return ret; 1203 } 1204 1205 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc, 1206 struct fb_cmap *cmap) 1207 { 1208 struct drm_device *dev = crtc->dev; 1209 struct drm_property_blob *gamma_lut; 1210 struct drm_color_lut *lut; 1211 int size = crtc->gamma_size; 1212 int i; 1213 1214 if (!size || cmap->start + cmap->len > size) 1215 return ERR_PTR(-EINVAL); 1216 1217 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL); 1218 if (IS_ERR(gamma_lut)) 1219 return gamma_lut; 1220 1221 lut = gamma_lut->data; 1222 if (cmap->start || cmap->len != size) { 1223 u16 *r = crtc->gamma_store; 1224 u16 *g = r + crtc->gamma_size; 1225 u16 *b = g + crtc->gamma_size; 1226 1227 for (i = 0; i < cmap->start; i++) { 1228 lut[i].red = r[i]; 1229 lut[i].green = g[i]; 1230 lut[i].blue = b[i]; 1231 } 1232 for (i = cmap->start + cmap->len; i < size; i++) { 1233 lut[i].red = r[i]; 1234 lut[i].green = g[i]; 1235 lut[i].blue = b[i]; 1236 } 1237 } 1238 1239 for (i = 0; i < cmap->len; i++) { 1240 lut[cmap->start + i].red = cmap->red[i]; 1241 lut[cmap->start + i].green = cmap->green[i]; 1242 lut[cmap->start + i].blue = cmap->blue[i]; 1243 } 1244 1245 return gamma_lut; 1246 } 1247 1248 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info) 1249 { 1250 struct drm_fb_helper *fb_helper = info->par; 1251 struct drm_device *dev = fb_helper->dev; 1252 struct drm_property_blob *gamma_lut = NULL; 1253 struct drm_modeset_acquire_ctx ctx; 1254 struct drm_crtc_state *crtc_state; 1255 struct drm_atomic_state *state; 1256 struct drm_mode_set *modeset; 1257 struct drm_crtc *crtc; 1258 u16 *r, *g, *b; 1259 bool replaced; 1260 int ret = 0; 1261 1262 drm_modeset_acquire_init(&ctx, 0); 1263 1264 state = drm_atomic_state_alloc(dev); 1265 if (!state) { 1266 ret = -ENOMEM; 1267 goto out_ctx; 1268 } 1269 1270 state->acquire_ctx = &ctx; 1271 retry: 1272 drm_client_for_each_modeset(modeset, &fb_helper->client) { 1273 crtc = modeset->crtc; 1274 1275 if (!gamma_lut) 1276 gamma_lut = setcmap_new_gamma_lut(crtc, cmap); 1277 if (IS_ERR(gamma_lut)) { 1278 ret = PTR_ERR(gamma_lut); 1279 gamma_lut = NULL; 1280 goto out_state; 1281 } 1282 1283 crtc_state = drm_atomic_get_crtc_state(state, crtc); 1284 if (IS_ERR(crtc_state)) { 1285 ret = PTR_ERR(crtc_state); 1286 goto out_state; 1287 } 1288 1289 /* 1290 * FIXME: This always uses gamma_lut. Some HW have only 1291 * degamma_lut, in which case we should reset gamma_lut and set 1292 * degamma_lut. See drm_crtc_legacy_gamma_set(). 1293 */ 1294 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, 1295 NULL); 1296 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL); 1297 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, 1298 gamma_lut); 1299 crtc_state->color_mgmt_changed |= replaced; 1300 } 1301 1302 ret = drm_atomic_commit(state); 1303 if (ret) 1304 goto out_state; 1305 1306 drm_client_for_each_modeset(modeset, &fb_helper->client) { 1307 crtc = modeset->crtc; 1308 1309 r = crtc->gamma_store; 1310 g = r + crtc->gamma_size; 1311 b = g + crtc->gamma_size; 1312 1313 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r)); 1314 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g)); 1315 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b)); 1316 } 1317 1318 out_state: 1319 if (ret == -EDEADLK) 1320 goto backoff; 1321 1322 drm_property_blob_put(gamma_lut); 1323 drm_atomic_state_put(state); 1324 out_ctx: 1325 drm_modeset_drop_locks(&ctx); 1326 drm_modeset_acquire_fini(&ctx); 1327 1328 return ret; 1329 1330 backoff: 1331 drm_atomic_state_clear(state); 1332 drm_modeset_backoff(&ctx); 1333 goto retry; 1334 } 1335 1336 /** 1337 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap 1338 * @cmap: cmap to set 1339 * @info: fbdev registered by the helper 1340 */ 1341 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info) 1342 { 1343 struct drm_fb_helper *fb_helper = info->par; 1344 struct drm_device *dev = fb_helper->dev; 1345 int ret; 1346 1347 if (oops_in_progress) 1348 return -EBUSY; 1349 1350 mutex_lock(&fb_helper->lock); 1351 1352 if (!drm_master_internal_acquire(dev)) { 1353 ret = -EBUSY; 1354 goto unlock; 1355 } 1356 1357 mutex_lock(&fb_helper->client.modeset_mutex); 1358 if (info->fix.visual == FB_VISUAL_TRUECOLOR) 1359 ret = setcmap_pseudo_palette(cmap, info); 1360 else if (drm_drv_uses_atomic_modeset(fb_helper->dev)) 1361 ret = setcmap_atomic(cmap, info); 1362 else 1363 ret = setcmap_legacy(cmap, info); 1364 mutex_unlock(&fb_helper->client.modeset_mutex); 1365 1366 drm_master_internal_release(dev); 1367 unlock: 1368 mutex_unlock(&fb_helper->lock); 1369 1370 return ret; 1371 } 1372 EXPORT_SYMBOL(drm_fb_helper_setcmap); 1373 1374 /** 1375 * drm_fb_helper_ioctl - legacy ioctl implementation 1376 * @info: fbdev registered by the helper 1377 * @cmd: ioctl command 1378 * @arg: ioctl argument 1379 * 1380 * A helper to implement the standard fbdev ioctl. Only 1381 * FBIO_WAITFORVSYNC is implemented for now. 1382 */ 1383 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd, 1384 unsigned long arg) 1385 { 1386 struct drm_fb_helper *fb_helper = info->par; 1387 struct drm_device *dev = fb_helper->dev; 1388 struct drm_crtc *crtc; 1389 int ret = 0; 1390 1391 mutex_lock(&fb_helper->lock); 1392 if (!drm_master_internal_acquire(dev)) { 1393 ret = -EBUSY; 1394 goto unlock; 1395 } 1396 1397 switch (cmd) { 1398 case FBIO_WAITFORVSYNC: 1399 /* 1400 * Only consider the first CRTC. 1401 * 1402 * This ioctl is supposed to take the CRTC number as 1403 * an argument, but in fbdev times, what that number 1404 * was supposed to be was quite unclear, different 1405 * drivers were passing that argument differently 1406 * (some by reference, some by value), and most of the 1407 * userspace applications were just hardcoding 0 as an 1408 * argument. 1409 * 1410 * The first CRTC should be the integrated panel on 1411 * most drivers, so this is the best choice we can 1412 * make. If we're not smart enough here, one should 1413 * just consider switch the userspace to KMS. 1414 */ 1415 crtc = fb_helper->client.modesets[0].crtc; 1416 1417 /* 1418 * Only wait for a vblank event if the CRTC is 1419 * enabled, otherwise just don't do anythintg, 1420 * not even report an error. 1421 */ 1422 ret = drm_crtc_vblank_get(crtc); 1423 if (!ret) { 1424 drm_crtc_wait_one_vblank(crtc); 1425 drm_crtc_vblank_put(crtc); 1426 } 1427 1428 ret = 0; 1429 break; 1430 default: 1431 ret = -ENOTTY; 1432 } 1433 1434 drm_master_internal_release(dev); 1435 unlock: 1436 mutex_unlock(&fb_helper->lock); 1437 return ret; 1438 } 1439 EXPORT_SYMBOL(drm_fb_helper_ioctl); 1440 1441 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1, 1442 const struct fb_var_screeninfo *var_2) 1443 { 1444 return var_1->bits_per_pixel == var_2->bits_per_pixel && 1445 var_1->grayscale == var_2->grayscale && 1446 var_1->red.offset == var_2->red.offset && 1447 var_1->red.length == var_2->red.length && 1448 var_1->red.msb_right == var_2->red.msb_right && 1449 var_1->green.offset == var_2->green.offset && 1450 var_1->green.length == var_2->green.length && 1451 var_1->green.msb_right == var_2->green.msb_right && 1452 var_1->blue.offset == var_2->blue.offset && 1453 var_1->blue.length == var_2->blue.length && 1454 var_1->blue.msb_right == var_2->blue.msb_right && 1455 var_1->transp.offset == var_2->transp.offset && 1456 var_1->transp.length == var_2->transp.length && 1457 var_1->transp.msb_right == var_2->transp.msb_right; 1458 } 1459 1460 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var, 1461 const struct drm_format_info *format) 1462 { 1463 u8 depth = format->depth; 1464 1465 if (format->is_color_indexed) { 1466 var->red.offset = 0; 1467 var->green.offset = 0; 1468 var->blue.offset = 0; 1469 var->red.length = depth; 1470 var->green.length = depth; 1471 var->blue.length = depth; 1472 var->transp.offset = 0; 1473 var->transp.length = 0; 1474 return; 1475 } 1476 1477 switch (depth) { 1478 case 15: 1479 var->red.offset = 10; 1480 var->green.offset = 5; 1481 var->blue.offset = 0; 1482 var->red.length = 5; 1483 var->green.length = 5; 1484 var->blue.length = 5; 1485 var->transp.offset = 15; 1486 var->transp.length = 1; 1487 break; 1488 case 16: 1489 var->red.offset = 11; 1490 var->green.offset = 5; 1491 var->blue.offset = 0; 1492 var->red.length = 5; 1493 var->green.length = 6; 1494 var->blue.length = 5; 1495 var->transp.offset = 0; 1496 break; 1497 case 24: 1498 var->red.offset = 16; 1499 var->green.offset = 8; 1500 var->blue.offset = 0; 1501 var->red.length = 8; 1502 var->green.length = 8; 1503 var->blue.length = 8; 1504 var->transp.offset = 0; 1505 var->transp.length = 0; 1506 break; 1507 case 32: 1508 var->red.offset = 16; 1509 var->green.offset = 8; 1510 var->blue.offset = 0; 1511 var->red.length = 8; 1512 var->green.length = 8; 1513 var->blue.length = 8; 1514 var->transp.offset = 24; 1515 var->transp.length = 8; 1516 break; 1517 default: 1518 break; 1519 } 1520 } 1521 1522 /** 1523 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var 1524 * @var: screeninfo to check 1525 * @info: fbdev registered by the helper 1526 */ 1527 int drm_fb_helper_check_var(struct fb_var_screeninfo *var, 1528 struct fb_info *info) 1529 { 1530 struct drm_fb_helper *fb_helper = info->par; 1531 struct drm_framebuffer *fb = fb_helper->fb; 1532 const struct drm_format_info *format = fb->format; 1533 struct drm_device *dev = fb_helper->dev; 1534 unsigned int bpp; 1535 1536 if (in_dbg_master()) 1537 return -EINVAL; 1538 1539 if (var->pixclock != 0) { 1540 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n"); 1541 var->pixclock = 0; 1542 } 1543 1544 switch (format->format) { 1545 case DRM_FORMAT_C1: 1546 case DRM_FORMAT_C2: 1547 case DRM_FORMAT_C4: 1548 /* supported format with sub-byte pixels */ 1549 break; 1550 1551 default: 1552 if ((drm_format_info_block_width(format, 0) > 1) || 1553 (drm_format_info_block_height(format, 0) > 1)) 1554 return -EINVAL; 1555 break; 1556 } 1557 1558 /* 1559 * Changes struct fb_var_screeninfo are currently not pushed back 1560 * to KMS, hence fail if different settings are requested. 1561 */ 1562 bpp = drm_format_info_bpp(format, 0); 1563 if (var->bits_per_pixel > bpp || 1564 var->xres > fb->width || var->yres > fb->height || 1565 var->xres_virtual > fb->width || var->yres_virtual > fb->height) { 1566 drm_dbg_kms(dev, "fb requested width/height/bpp can't fit in current fb " 1567 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n", 1568 var->xres, var->yres, var->bits_per_pixel, 1569 var->xres_virtual, var->yres_virtual, 1570 fb->width, fb->height, bpp); 1571 return -EINVAL; 1572 } 1573 1574 /* 1575 * Workaround for SDL 1.2, which is known to be setting all pixel format 1576 * fields values to zero in some cases. We treat this situation as a 1577 * kind of "use some reasonable autodetected values". 1578 */ 1579 if (!var->red.offset && !var->green.offset && 1580 !var->blue.offset && !var->transp.offset && 1581 !var->red.length && !var->green.length && 1582 !var->blue.length && !var->transp.length && 1583 !var->red.msb_right && !var->green.msb_right && 1584 !var->blue.msb_right && !var->transp.msb_right) { 1585 drm_fb_helper_fill_pixel_fmt(var, format); 1586 } 1587 1588 /* 1589 * Likewise, bits_per_pixel should be rounded up to a supported value. 1590 */ 1591 var->bits_per_pixel = bpp; 1592 1593 /* 1594 * drm fbdev emulation doesn't support changing the pixel format at all, 1595 * so reject all pixel format changing requests. 1596 */ 1597 if (!drm_fb_pixel_format_equal(var, &info->var)) { 1598 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel format\n"); 1599 return -EINVAL; 1600 } 1601 1602 return 0; 1603 } 1604 EXPORT_SYMBOL(drm_fb_helper_check_var); 1605 1606 /** 1607 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par 1608 * @info: fbdev registered by the helper 1609 * 1610 * This will let fbcon do the mode init and is called at initialization time by 1611 * the fbdev core when registering the driver, and later on through the hotplug 1612 * callback. 1613 */ 1614 int drm_fb_helper_set_par(struct fb_info *info) 1615 { 1616 struct drm_fb_helper *fb_helper = info->par; 1617 struct fb_var_screeninfo *var = &info->var; 1618 bool force; 1619 1620 if (oops_in_progress) 1621 return -EBUSY; 1622 1623 if (var->pixclock != 0) { 1624 drm_err(fb_helper->dev, "PIXEL CLOCK SET\n"); 1625 return -EINVAL; 1626 } 1627 1628 /* 1629 * Normally we want to make sure that a kms master takes precedence over 1630 * fbdev, to avoid fbdev flickering and occasionally stealing the 1631 * display status. But Xorg first sets the vt back to text mode using 1632 * the KDSET IOCTL with KD_TEXT, and only after that drops the master 1633 * status when exiting. 1634 * 1635 * In the past this was caught by drm_fb_helper_lastclose(), but on 1636 * modern systems where logind always keeps a drm fd open to orchestrate 1637 * the vt switching, this doesn't work. 1638 * 1639 * To not break the userspace ABI we have this special case here, which 1640 * is only used for the above case. Everything else uses the normal 1641 * commit function, which ensures that we never steal the display from 1642 * an active drm master. 1643 */ 1644 force = var->activate & FB_ACTIVATE_KD_TEXT; 1645 1646 __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, force); 1647 1648 return 0; 1649 } 1650 EXPORT_SYMBOL(drm_fb_helper_set_par); 1651 1652 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y) 1653 { 1654 struct drm_mode_set *mode_set; 1655 1656 mutex_lock(&fb_helper->client.modeset_mutex); 1657 drm_client_for_each_modeset(mode_set, &fb_helper->client) { 1658 mode_set->x = x; 1659 mode_set->y = y; 1660 } 1661 mutex_unlock(&fb_helper->client.modeset_mutex); 1662 } 1663 1664 static int pan_display_atomic(struct fb_var_screeninfo *var, 1665 struct fb_info *info) 1666 { 1667 struct drm_fb_helper *fb_helper = info->par; 1668 int ret; 1669 1670 pan_set(fb_helper, var->xoffset, var->yoffset); 1671 1672 ret = drm_client_modeset_commit_locked(&fb_helper->client); 1673 if (!ret) { 1674 info->var.xoffset = var->xoffset; 1675 info->var.yoffset = var->yoffset; 1676 } else 1677 pan_set(fb_helper, info->var.xoffset, info->var.yoffset); 1678 1679 return ret; 1680 } 1681 1682 static int pan_display_legacy(struct fb_var_screeninfo *var, 1683 struct fb_info *info) 1684 { 1685 struct drm_fb_helper *fb_helper = info->par; 1686 struct drm_client_dev *client = &fb_helper->client; 1687 struct drm_mode_set *modeset; 1688 int ret = 0; 1689 1690 mutex_lock(&client->modeset_mutex); 1691 drm_modeset_lock_all(fb_helper->dev); 1692 drm_client_for_each_modeset(modeset, client) { 1693 modeset->x = var->xoffset; 1694 modeset->y = var->yoffset; 1695 1696 if (modeset->num_connectors) { 1697 ret = drm_mode_set_config_internal(modeset); 1698 if (!ret) { 1699 info->var.xoffset = var->xoffset; 1700 info->var.yoffset = var->yoffset; 1701 } 1702 } 1703 } 1704 drm_modeset_unlock_all(fb_helper->dev); 1705 mutex_unlock(&client->modeset_mutex); 1706 1707 return ret; 1708 } 1709 1710 /** 1711 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display 1712 * @var: updated screen information 1713 * @info: fbdev registered by the helper 1714 */ 1715 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, 1716 struct fb_info *info) 1717 { 1718 struct drm_fb_helper *fb_helper = info->par; 1719 struct drm_device *dev = fb_helper->dev; 1720 int ret; 1721 1722 if (oops_in_progress) 1723 return -EBUSY; 1724 1725 mutex_lock(&fb_helper->lock); 1726 if (!drm_master_internal_acquire(dev)) { 1727 ret = -EBUSY; 1728 goto unlock; 1729 } 1730 1731 if (drm_drv_uses_atomic_modeset(dev)) 1732 ret = pan_display_atomic(var, info); 1733 else 1734 ret = pan_display_legacy(var, info); 1735 1736 drm_master_internal_release(dev); 1737 unlock: 1738 mutex_unlock(&fb_helper->lock); 1739 1740 return ret; 1741 } 1742 EXPORT_SYMBOL(drm_fb_helper_pan_display); 1743 1744 static uint32_t drm_fb_helper_find_format(struct drm_fb_helper *fb_helper, const uint32_t *formats, 1745 size_t format_count, uint32_t bpp, uint32_t depth) 1746 { 1747 struct drm_device *dev = fb_helper->dev; 1748 uint32_t format; 1749 size_t i; 1750 1751 /* 1752 * Do not consider YUV or other complicated formats 1753 * for framebuffers. This means only legacy formats 1754 * are supported (fmt->depth is a legacy field), but 1755 * the framebuffer emulation can only deal with such 1756 * formats, specifically RGB/BGA formats. 1757 */ 1758 format = drm_mode_legacy_fb_format(bpp, depth); 1759 if (!format) 1760 goto err; 1761 1762 for (i = 0; i < format_count; ++i) { 1763 if (formats[i] == format) 1764 return format; 1765 } 1766 1767 err: 1768 /* We found nothing. */ 1769 drm_warn(dev, "bpp/depth value of %u/%u not supported\n", bpp, depth); 1770 1771 return DRM_FORMAT_INVALID; 1772 } 1773 1774 static uint32_t drm_fb_helper_find_color_mode_format(struct drm_fb_helper *fb_helper, 1775 const uint32_t *formats, size_t format_count, 1776 unsigned int color_mode) 1777 { 1778 struct drm_device *dev = fb_helper->dev; 1779 uint32_t bpp, depth; 1780 1781 switch (color_mode) { 1782 case 1: 1783 case 2: 1784 case 4: 1785 case 8: 1786 case 16: 1787 case 24: 1788 bpp = depth = color_mode; 1789 break; 1790 case 15: 1791 bpp = 16; 1792 depth = 15; 1793 break; 1794 case 32: 1795 bpp = 32; 1796 depth = 24; 1797 break; 1798 default: 1799 drm_info(dev, "unsupported color mode of %d\n", color_mode); 1800 return DRM_FORMAT_INVALID; 1801 } 1802 1803 return drm_fb_helper_find_format(fb_helper, formats, format_count, bpp, depth); 1804 } 1805 1806 static int __drm_fb_helper_find_sizes(struct drm_fb_helper *fb_helper, 1807 struct drm_fb_helper_surface_size *sizes) 1808 { 1809 struct drm_client_dev *client = &fb_helper->client; 1810 struct drm_device *dev = fb_helper->dev; 1811 int crtc_count = 0; 1812 struct drm_connector_list_iter conn_iter; 1813 struct drm_connector *connector; 1814 struct drm_mode_set *mode_set; 1815 uint32_t surface_format = DRM_FORMAT_INVALID; 1816 const struct drm_format_info *info; 1817 1818 memset(sizes, 0, sizeof(*sizes)); 1819 sizes->fb_width = (u32)-1; 1820 sizes->fb_height = (u32)-1; 1821 1822 drm_client_for_each_modeset(mode_set, client) { 1823 struct drm_crtc *crtc = mode_set->crtc; 1824 struct drm_plane *plane = crtc->primary; 1825 1826 drm_dbg_kms(dev, "test CRTC %u primary plane\n", drm_crtc_index(crtc)); 1827 1828 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter); 1829 drm_client_for_each_connector_iter(connector, &conn_iter) { 1830 struct drm_cmdline_mode *cmdline_mode = &connector->cmdline_mode; 1831 1832 if (!cmdline_mode->bpp_specified) 1833 continue; 1834 1835 surface_format = drm_fb_helper_find_color_mode_format(fb_helper, 1836 plane->format_types, 1837 plane->format_count, 1838 cmdline_mode->bpp); 1839 if (surface_format != DRM_FORMAT_INVALID) 1840 break; /* found supported format */ 1841 } 1842 drm_connector_list_iter_end(&conn_iter); 1843 1844 if (surface_format != DRM_FORMAT_INVALID) 1845 break; /* found supported format */ 1846 1847 /* try preferred color mode */ 1848 surface_format = drm_fb_helper_find_color_mode_format(fb_helper, 1849 plane->format_types, 1850 plane->format_count, 1851 fb_helper->preferred_bpp); 1852 if (surface_format != DRM_FORMAT_INVALID) 1853 break; /* found supported format */ 1854 } 1855 1856 if (surface_format == DRM_FORMAT_INVALID) { 1857 /* 1858 * If none of the given color modes works, fall back 1859 * to XRGB8888. Drivers are expected to provide this 1860 * format for compatibility with legacy applications. 1861 */ 1862 drm_warn(dev, "No compatible format found\n"); 1863 surface_format = drm_driver_legacy_fb_format(dev, 32, 24); 1864 } 1865 1866 info = drm_format_info(surface_format); 1867 sizes->surface_bpp = drm_format_info_bpp(info, 0); 1868 sizes->surface_depth = info->depth; 1869 1870 /* first up get a count of crtcs now in use and new min/maxes width/heights */ 1871 crtc_count = 0; 1872 drm_client_for_each_modeset(mode_set, client) { 1873 struct drm_display_mode *desired_mode; 1874 int x, y, j; 1875 /* in case of tile group, are we the last tile vert or horiz? 1876 * If no tile group you are always the last one both vertically 1877 * and horizontally 1878 */ 1879 bool lastv = true, lasth = true; 1880 1881 desired_mode = mode_set->mode; 1882 1883 if (!desired_mode) 1884 continue; 1885 1886 crtc_count++; 1887 1888 x = mode_set->x; 1889 y = mode_set->y; 1890 1891 sizes->surface_width = 1892 max_t(u32, desired_mode->hdisplay + x, sizes->surface_width); 1893 sizes->surface_height = 1894 max_t(u32, desired_mode->vdisplay + y, sizes->surface_height); 1895 1896 for (j = 0; j < mode_set->num_connectors; j++) { 1897 struct drm_connector *connector = mode_set->connectors[j]; 1898 1899 if (connector->has_tile && 1900 desired_mode->hdisplay == connector->tile_h_size && 1901 desired_mode->vdisplay == connector->tile_v_size) { 1902 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1)); 1903 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1)); 1904 /* cloning to multiple tiles is just crazy-talk, so: */ 1905 break; 1906 } 1907 } 1908 1909 if (lasth) 1910 sizes->fb_width = min_t(u32, desired_mode->hdisplay + x, sizes->fb_width); 1911 if (lastv) 1912 sizes->fb_height = min_t(u32, desired_mode->vdisplay + y, sizes->fb_height); 1913 } 1914 1915 if (crtc_count == 0 || sizes->fb_width == -1 || sizes->fb_height == -1) { 1916 drm_info(dev, "Cannot find any crtc or sizes\n"); 1917 return -EAGAIN; 1918 } 1919 1920 return 0; 1921 } 1922 1923 static int drm_fb_helper_find_sizes(struct drm_fb_helper *fb_helper, 1924 struct drm_fb_helper_surface_size *sizes) 1925 { 1926 struct drm_client_dev *client = &fb_helper->client; 1927 struct drm_device *dev = fb_helper->dev; 1928 struct drm_mode_config *config = &dev->mode_config; 1929 int ret; 1930 1931 mutex_lock(&client->modeset_mutex); 1932 ret = __drm_fb_helper_find_sizes(fb_helper, sizes); 1933 mutex_unlock(&client->modeset_mutex); 1934 1935 if (ret) 1936 return ret; 1937 1938 /* Handle our overallocation */ 1939 sizes->surface_height *= drm_fbdev_overalloc; 1940 sizes->surface_height /= 100; 1941 if (sizes->surface_height > config->max_height) { 1942 drm_dbg_kms(dev, "Fbdev over-allocation too large; clamping height to %d\n", 1943 config->max_height); 1944 sizes->surface_height = config->max_height; 1945 } 1946 1947 return 0; 1948 } 1949 1950 /* 1951 * Allocates the backing storage and sets up the fbdev info structure through 1952 * the ->fb_probe callback. 1953 */ 1954 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper) 1955 { 1956 struct drm_client_dev *client = &fb_helper->client; 1957 struct drm_device *dev = fb_helper->dev; 1958 struct drm_fb_helper_surface_size sizes; 1959 int ret; 1960 1961 ret = drm_fb_helper_find_sizes(fb_helper, &sizes); 1962 if (ret) { 1963 /* First time: disable all crtc's.. */ 1964 if (!fb_helper->deferred_setup) 1965 drm_client_modeset_commit(client); 1966 return ret; 1967 } 1968 1969 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM) 1970 fb_helper->hint_leak_smem_start = drm_leak_fbdev_smem; 1971 #endif 1972 1973 /* push down into drivers */ 1974 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes); 1975 if (ret < 0) 1976 return ret; 1977 1978 strcpy(fb_helper->fb->comm, "[fbcon]"); 1979 1980 /* Set the fb info for vgaswitcheroo clients. Does nothing otherwise. */ 1981 if (dev_is_pci(dev->dev)) 1982 vga_switcheroo_client_fb_set(to_pci_dev(dev->dev), fb_helper->info); 1983 1984 return 0; 1985 } 1986 1987 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, 1988 bool is_color_indexed) 1989 { 1990 info->fix.type = FB_TYPE_PACKED_PIXELS; 1991 info->fix.visual = is_color_indexed ? FB_VISUAL_PSEUDOCOLOR 1992 : FB_VISUAL_TRUECOLOR; 1993 info->fix.mmio_start = 0; 1994 info->fix.mmio_len = 0; 1995 info->fix.type_aux = 0; 1996 info->fix.xpanstep = 1; /* doing it in hw */ 1997 info->fix.ypanstep = 1; /* doing it in hw */ 1998 info->fix.ywrapstep = 0; 1999 info->fix.accel = FB_ACCEL_NONE; 2000 2001 info->fix.line_length = pitch; 2002 } 2003 2004 static void drm_fb_helper_fill_var(struct fb_info *info, 2005 struct drm_fb_helper *fb_helper, 2006 uint32_t fb_width, uint32_t fb_height) 2007 { 2008 struct drm_framebuffer *fb = fb_helper->fb; 2009 const struct drm_format_info *format = fb->format; 2010 2011 switch (format->format) { 2012 case DRM_FORMAT_C1: 2013 case DRM_FORMAT_C2: 2014 case DRM_FORMAT_C4: 2015 /* supported format with sub-byte pixels */ 2016 break; 2017 2018 default: 2019 WARN_ON((drm_format_info_block_width(format, 0) > 1) || 2020 (drm_format_info_block_height(format, 0) > 1)); 2021 break; 2022 } 2023 2024 info->pseudo_palette = fb_helper->pseudo_palette; 2025 info->var.xres_virtual = fb->width; 2026 info->var.yres_virtual = fb->height; 2027 info->var.bits_per_pixel = drm_format_info_bpp(format, 0); 2028 info->var.accel_flags = FB_ACCELF_TEXT; 2029 info->var.xoffset = 0; 2030 info->var.yoffset = 0; 2031 info->var.activate = FB_ACTIVATE_NOW; 2032 2033 drm_fb_helper_fill_pixel_fmt(&info->var, format); 2034 2035 info->var.xres = fb_width; 2036 info->var.yres = fb_height; 2037 } 2038 2039 /** 2040 * drm_fb_helper_fill_info - initializes fbdev information 2041 * @info: fbdev instance to set up 2042 * @fb_helper: fb helper instance to use as template 2043 * @sizes: describes fbdev size and scanout surface size 2044 * 2045 * Sets up the variable and fixed fbdev metainformation from the given fb helper 2046 * instance and the drm framebuffer allocated in &drm_fb_helper.fb. 2047 * 2048 * Drivers should call this (or their equivalent setup code) from their 2049 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev 2050 * backing storage framebuffer. 2051 */ 2052 void drm_fb_helper_fill_info(struct fb_info *info, 2053 struct drm_fb_helper *fb_helper, 2054 struct drm_fb_helper_surface_size *sizes) 2055 { 2056 struct drm_framebuffer *fb = fb_helper->fb; 2057 2058 drm_fb_helper_fill_fix(info, fb->pitches[0], 2059 fb->format->is_color_indexed); 2060 drm_fb_helper_fill_var(info, fb_helper, 2061 sizes->fb_width, sizes->fb_height); 2062 2063 info->par = fb_helper; 2064 /* 2065 * The DRM drivers fbdev emulation device name can be confusing if the 2066 * driver name also has a "drm" suffix on it. Leading to names such as 2067 * "simpledrmdrmfb" in /proc/fb. Unfortunately, it's an uAPI and can't 2068 * be changed due user-space tools (e.g: pm-utils) matching against it. 2069 */ 2070 snprintf(info->fix.id, sizeof(info->fix.id), "%sdrmfb", 2071 fb_helper->dev->driver->name); 2072 2073 } 2074 EXPORT_SYMBOL(drm_fb_helper_fill_info); 2075 2076 /* 2077 * This is a continuation of drm_setup_crtcs() that sets up anything related 2078 * to the framebuffer. During initialization, drm_setup_crtcs() is called before 2079 * the framebuffer has been allocated (fb_helper->fb and fb_helper->info). 2080 * So, any setup that touches those fields needs to be done here instead of in 2081 * drm_setup_crtcs(). 2082 */ 2083 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper) 2084 { 2085 struct drm_client_dev *client = &fb_helper->client; 2086 struct drm_connector_list_iter conn_iter; 2087 struct fb_info *info = fb_helper->info; 2088 unsigned int rotation, sw_rotations = 0; 2089 struct drm_connector *connector; 2090 struct drm_mode_set *modeset; 2091 2092 mutex_lock(&client->modeset_mutex); 2093 drm_client_for_each_modeset(modeset, client) { 2094 if (!modeset->num_connectors) 2095 continue; 2096 2097 modeset->fb = fb_helper->fb; 2098 2099 if (drm_client_rotation(modeset, &rotation)) 2100 /* Rotating in hardware, fbcon should not rotate */ 2101 sw_rotations |= DRM_MODE_ROTATE_0; 2102 else 2103 sw_rotations |= rotation; 2104 } 2105 mutex_unlock(&client->modeset_mutex); 2106 2107 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter); 2108 drm_client_for_each_connector_iter(connector, &conn_iter) { 2109 2110 /* use first connected connector for the physical dimensions */ 2111 if (connector->status == connector_status_connected) { 2112 info->var.width = connector->display_info.width_mm; 2113 info->var.height = connector->display_info.height_mm; 2114 break; 2115 } 2116 } 2117 drm_connector_list_iter_end(&conn_iter); 2118 2119 switch (sw_rotations) { 2120 case DRM_MODE_ROTATE_0: 2121 info->fbcon_rotate_hint = FB_ROTATE_UR; 2122 break; 2123 case DRM_MODE_ROTATE_90: 2124 info->fbcon_rotate_hint = FB_ROTATE_CCW; 2125 break; 2126 case DRM_MODE_ROTATE_180: 2127 info->fbcon_rotate_hint = FB_ROTATE_UD; 2128 break; 2129 case DRM_MODE_ROTATE_270: 2130 info->fbcon_rotate_hint = FB_ROTATE_CW; 2131 break; 2132 default: 2133 /* 2134 * Multiple bits are set / multiple rotations requested 2135 * fbcon cannot handle separate rotation settings per 2136 * output, so fallback to unrotated. 2137 */ 2138 info->fbcon_rotate_hint = FB_ROTATE_UR; 2139 } 2140 } 2141 2142 /* Note: Drops fb_helper->lock before returning. */ 2143 static int 2144 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper) 2145 { 2146 struct drm_device *dev = fb_helper->dev; 2147 struct fb_info *info; 2148 unsigned int width, height; 2149 int ret; 2150 2151 width = dev->mode_config.max_width; 2152 height = dev->mode_config.max_height; 2153 2154 drm_client_modeset_probe(&fb_helper->client, width, height); 2155 ret = drm_fb_helper_single_fb_probe(fb_helper); 2156 if (ret < 0) { 2157 if (ret == -EAGAIN) { 2158 fb_helper->deferred_setup = true; 2159 ret = 0; 2160 } 2161 mutex_unlock(&fb_helper->lock); 2162 2163 return ret; 2164 } 2165 drm_setup_crtcs_fb(fb_helper); 2166 2167 fb_helper->deferred_setup = false; 2168 2169 info = fb_helper->info; 2170 info->var.pixclock = 0; 2171 /* Shamelessly allow physical address leaking to userspace */ 2172 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM) 2173 if (!fb_helper->hint_leak_smem_start) 2174 #endif 2175 /* don't leak any physical addresses to userspace */ 2176 info->flags |= FBINFO_HIDE_SMEM_START; 2177 2178 /* Need to drop locks to avoid recursive deadlock in 2179 * register_framebuffer. This is ok because the only thing left to do is 2180 * register the fbdev emulation instance in kernel_fb_helper_list. */ 2181 mutex_unlock(&fb_helper->lock); 2182 2183 ret = register_framebuffer(info); 2184 if (ret < 0) 2185 return ret; 2186 2187 drm_info(dev, "fb%d: %s frame buffer device\n", 2188 info->node, info->fix.id); 2189 2190 mutex_lock(&kernel_fb_helper_lock); 2191 if (list_empty(&kernel_fb_helper_list)) 2192 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op); 2193 2194 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list); 2195 mutex_unlock(&kernel_fb_helper_lock); 2196 2197 return 0; 2198 } 2199 2200 /** 2201 * drm_fb_helper_initial_config - setup a sane initial connector configuration 2202 * @fb_helper: fb_helper device struct 2203 * 2204 * Scans the CRTCs and connectors and tries to put together an initial setup. 2205 * At the moment, this is a cloned configuration across all heads with 2206 * a new framebuffer object as the backing store. 2207 * 2208 * Note that this also registers the fbdev and so allows userspace to call into 2209 * the driver through the fbdev interfaces. 2210 * 2211 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback 2212 * to let the driver allocate and initialize the fbdev info structure and the 2213 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided 2214 * as a helper to setup simple default values for the fbdev info structure. 2215 * 2216 * HANG DEBUGGING: 2217 * 2218 * When you have fbcon support built-in or already loaded, this function will do 2219 * a full modeset to setup the fbdev console. Due to locking misdesign in the 2220 * VT/fbdev subsystem that entire modeset sequence has to be done while holding 2221 * console_lock. Until console_unlock is called no dmesg lines will be sent out 2222 * to consoles, not even serial console. This means when your driver crashes, 2223 * you will see absolutely nothing else but a system stuck in this function, 2224 * with no further output. Any kind of printk() you place within your own driver 2225 * or in the drm core modeset code will also never show up. 2226 * 2227 * Standard debug practice is to run the fbcon setup without taking the 2228 * console_lock as a hack, to be able to see backtraces and crashes on the 2229 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel 2230 * cmdline option. 2231 * 2232 * The other option is to just disable fbdev emulation since very likely the 2233 * first modeset from userspace will crash in the same way, and is even easier 2234 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0 2235 * kernel cmdline option. 2236 * 2237 * RETURNS: 2238 * Zero if everything went ok, nonzero otherwise. 2239 */ 2240 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper) 2241 { 2242 int ret; 2243 2244 if (!drm_fbdev_emulation) 2245 return 0; 2246 2247 mutex_lock(&fb_helper->lock); 2248 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper); 2249 2250 return ret; 2251 } 2252 EXPORT_SYMBOL(drm_fb_helper_initial_config); 2253 2254 /** 2255 * drm_fb_helper_hotplug_event - respond to a hotplug notification by 2256 * probing all the outputs attached to the fb 2257 * @fb_helper: driver-allocated fbdev helper, can be NULL 2258 * 2259 * Scan the connectors attached to the fb_helper and try to put together a 2260 * setup after notification of a change in output configuration. 2261 * 2262 * Called at runtime, takes the mode config locks to be able to check/change the 2263 * modeset configuration. Must be run from process context (which usually means 2264 * either the output polling work or a work item launched from the driver's 2265 * hotplug interrupt). 2266 * 2267 * Note that drivers may call this even before calling 2268 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows 2269 * for a race-free fbcon setup and will make sure that the fbdev emulation will 2270 * not miss any hotplug events. 2271 * 2272 * RETURNS: 2273 * 0 on success and a non-zero error code otherwise. 2274 */ 2275 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper) 2276 { 2277 int err = 0; 2278 2279 if (!drm_fbdev_emulation || !fb_helper) 2280 return 0; 2281 2282 mutex_lock(&fb_helper->lock); 2283 if (fb_helper->deferred_setup) { 2284 err = __drm_fb_helper_initial_config_and_unlock(fb_helper); 2285 return err; 2286 } 2287 2288 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) { 2289 fb_helper->delayed_hotplug = true; 2290 mutex_unlock(&fb_helper->lock); 2291 return err; 2292 } 2293 2294 drm_master_internal_release(fb_helper->dev); 2295 2296 drm_dbg_kms(fb_helper->dev, "\n"); 2297 2298 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height); 2299 drm_setup_crtcs_fb(fb_helper); 2300 mutex_unlock(&fb_helper->lock); 2301 2302 drm_fb_helper_set_par(fb_helper->info); 2303 2304 return 0; 2305 } 2306 EXPORT_SYMBOL(drm_fb_helper_hotplug_event); 2307 2308 /** 2309 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation 2310 * @dev: DRM device 2311 * 2312 * This function can be used as the &drm_driver->lastclose callback for drivers 2313 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked(). 2314 */ 2315 void drm_fb_helper_lastclose(struct drm_device *dev) 2316 { 2317 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper); 2318 } 2319 EXPORT_SYMBOL(drm_fb_helper_lastclose); 2320 2321 /** 2322 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed 2323 * helper for fbdev emulation 2324 * @dev: DRM device 2325 * 2326 * This function can be used as the 2327 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only 2328 * need to call drm_fbdev.hotplug_event(). 2329 */ 2330 void drm_fb_helper_output_poll_changed(struct drm_device *dev) 2331 { 2332 drm_fb_helper_hotplug_event(dev->fb_helper); 2333 } 2334 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed); 2335