drivers/gpu/drm/drm_fb_helper.c

   1 /*
   2  * Copyright (c) 2006-2009 Red Hat Inc.
   3  * Copyright (c) 2006-2008 Intel Corporation
   4  * Copyright (c) 2007 Dave Airlie <[email protected]>
   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 <[email protected]>
  28  *      Jesse Barnes <[email protected]>
  29  */
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/console.h>
  33 #include <linux/kernel.h>
  34 #include <linux/sysrq.h>
  35 #include <linux/slab.h>
  36 #include <linux/module.h>
  37 #include <drm/drmP.h>
  38 #include <drm/drm_crtc.h>
  39 #include <drm/drm_fb_helper.h>
  40 #include <drm/drm_crtc_helper.h>
  41 #include <drm/drm_atomic.h>
  42 #include <drm/drm_atomic_helper.h>
  43
  44 #include "drm_crtc_helper_internal.h"
  45
  46 static bool drm_fbdev_emulation = true;
  47 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
  48 MODULE_PARM_DESC(fbdev_emulation,
  49                  "Enable legacy fbdev emulation [default=true]");
  50
  51 static LIST_HEAD(kernel_fb_helper_list);
  52 static DEFINE_MUTEX(kernel_fb_helper_lock);
  53
  54 /**
  55  * DOC: fbdev helpers
  56  *
  57  * The fb helper functions are useful to provide an fbdev on top of a drm kernel
  58  * mode setting driver. They can be used mostly independently from the crtc
  59  * helper functions used by many drivers to implement the kernel mode setting
  60  * interfaces.
  61  *
  62  * Initialization is done as a four-step process with drm_fb_helper_prepare(),
  63  * drm_fb_helper_init(), drm_fb_helper_single_add_all_connectors() and
  64  * drm_fb_helper_initial_config(). Drivers with fancier requirements than the
  65  * default behaviour can override the third step with their own code.
  66  * Teardown is done with drm_fb_helper_fini().
  67  *
  68  * At runtime drivers should restore the fbdev console by calling
  69  * drm_fb_helper_restore_fbdev_mode_unlocked() from their &drm_driver.lastclose
  70  * callback.  They should also notify the fb helper code from updates to the
  71  * output configuration by calling drm_fb_helper_hotplug_event(). For easier
  72  * integration with the output polling code in drm_crtc_helper.c the modeset
  73  * code provides a &drm_mode_config_funcs.output_poll_changed callback.
  74  *
  75  * All other functions exported by the fb helper library can be used to
  76  * implement the fbdev driver interface by the driver.
  77  *
  78  * It is possible, though perhaps somewhat tricky, to implement race-free
  79  * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
  80  * helper must be called first to initialize the minimum required to make
  81  * hotplug detection work. Drivers also need to make sure to properly set up
  82  * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
  83  * it is safe to enable interrupts and start processing hotplug events. At the
  84  * same time, drivers should initialize all modeset objects such as CRTCs,
  85  * encoders and connectors. To finish up the fbdev helper initialization, the
  86  * drm_fb_helper_init() function is called. To probe for all attached displays
  87  * and set up an initial configuration using the detected hardware, drivers
  88  * should call drm_fb_helper_single_add_all_connectors() followed by
  89  * drm_fb_helper_initial_config().
  90  *
  91  * If &drm_framebuffer_funcs.dirty is set, the
  92  * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
  93  * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
  94  * away. This worker then calls the dirty() function ensuring that it will
  95  * always run in process context since the fb_*() function could be running in
  96  * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
  97  * callback it will also schedule dirty_work with the damage collected from the
  98  * mmap page writes.
  99  */
 100
 101 #define drm_fb_helper_for_each_connector(fbh, i__) \
 102         for (({ lockdep_assert_held(&(fbh)->dev->mode_config.mutex); }), \
 103              i__ = 0; i__ < (fbh)->connector_count; i__++)
 104
 105 /**
 106  * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
 107  *                                             emulation helper
 108  * @fb_helper: fbdev initialized with drm_fb_helper_init
 109  *
 110  * This functions adds all the available connectors for use with the given
 111  * fb_helper. This is a separate step to allow drivers to freely assign
 112  * connectors to the fbdev, e.g. if some are reserved for special purposes or
 113  * not adequate to be used for the fbcon.
 114  *
 115  * This function is protected against concurrent connector hotadds/removals
 116  * using drm_fb_helper_add_one_connector() and
 117  * drm_fb_helper_remove_one_connector().
 118  */
 119 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
 120 {
 121         struct drm_device *dev = fb_helper->dev;
 122         struct drm_connector *connector;
 123         struct drm_connector_list_iter conn_iter;
 124         int i, ret = 0;
 125
 126         if (!drm_fbdev_emulation)
 127                 return 0;
 128
 129         mutex_lock(&dev->mode_config.mutex);
 130         drm_connector_list_iter_get(dev, &conn_iter);
 131         drm_for_each_connector_iter(connector, &conn_iter) {
 132                 ret = drm_fb_helper_add_one_connector(fb_helper, connector);
 133
 134                 if (ret)
 135                         goto fail;
 136         }
 137         goto out;
 138
 139 fail:
 140         drm_fb_helper_for_each_connector(fb_helper, i) {
 141                 struct drm_fb_helper_connector *fb_helper_connector =
 142                         fb_helper->connector_info[i];
 143
 144                 drm_connector_unreference(fb_helper_connector->connector);
 145
 146                 kfree(fb_helper_connector);
 147                 fb_helper->connector_info[i] = NULL;
 148         }
 149         fb_helper->connector_count = 0;
 150 out:
 151         drm_connector_list_iter_put(&conn_iter);
 152         mutex_unlock(&dev->mode_config.mutex);
 153
 154         return ret;
 155 }
 156 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
 157
 158 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
 159 {
 160         struct drm_fb_helper_connector **temp;
 161         struct drm_fb_helper_connector *fb_helper_connector;
 162
 163         if (!drm_fbdev_emulation)
 164                 return 0;
 165
 166         WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
 167         if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
 168                 temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
 169                 if (!temp)
 170                         return -ENOMEM;
 171
 172                 fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
 173                 fb_helper->connector_info = temp;
 174         }
 175
 176
 177         fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
 178         if (!fb_helper_connector)
 179                 return -ENOMEM;
 180
 181         drm_connector_reference(connector);
 182         fb_helper_connector->connector = connector;
 183         fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
 184         return 0;
 185 }
 186 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
 187
 188 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
 189                                        struct drm_connector *connector)
 190 {
 191         struct drm_fb_helper_connector *fb_helper_connector;
 192         int i, j;
 193
 194         if (!drm_fbdev_emulation)
 195                 return 0;
 196
 197         WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
 198
 199         for (i = 0; i < fb_helper->connector_count; i++) {
 200                 if (fb_helper->connector_info[i]->connector == connector)
 201                         break;
 202         }
 203
 204         if (i == fb_helper->connector_count)
 205                 return -EINVAL;
 206         fb_helper_connector = fb_helper->connector_info[i];
 207         drm_connector_unreference(fb_helper_connector->connector);
 208
 209         for (j = i + 1; j < fb_helper->connector_count; j++) {
 210                 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
 211         }
 212         fb_helper->connector_count--;
 213         kfree(fb_helper_connector);
 214
 215         return 0;
 216 }
 217 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
 218
 219 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
 220 {
 221         uint16_t *r_base, *g_base, *b_base;
 222         int i;
 223
 224         if (helper->funcs->gamma_get == NULL)
 225                 return;
 226
 227         r_base = crtc->gamma_store;
 228         g_base = r_base + crtc->gamma_size;
 229         b_base = g_base + crtc->gamma_size;
 230
 231         for (i = 0; i < crtc->gamma_size; i++)
 232                 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
 233 }
 234
 235 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
 236 {
 237         uint16_t *r_base, *g_base, *b_base;
 238
 239         if (crtc->funcs->gamma_set == NULL)
 240                 return;
 241
 242         r_base = crtc->gamma_store;
 243         g_base = r_base + crtc->gamma_size;
 244         b_base = g_base + crtc->gamma_size;
 245
 246         crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, crtc->gamma_size);
 247 }
 248
 249 /**
 250  * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
 251  * @info: fbdev registered by the helper
 252  */
 253 int drm_fb_helper_debug_enter(struct fb_info *info)
 254 {
 255         struct drm_fb_helper *helper = info->par;
 256         const struct drm_crtc_helper_funcs *funcs;
 257         int i;
 258
 259         list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
 260                 for (i = 0; i < helper->crtc_count; i++) {
 261                         struct drm_mode_set *mode_set =
 262                                 &helper->crtc_info[i].mode_set;
 263
 264                         if (!mode_set->crtc->enabled)
 265                                 continue;
 266
 267                         funcs = mode_set->crtc->helper_private;
 268                         if (funcs->mode_set_base_atomic == NULL)
 269                                 continue;
 270
 271                         drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
 272                         funcs->mode_set_base_atomic(mode_set->crtc,
 273                                                     mode_set->fb,
 274                                                     mode_set->x,
 275                                                     mode_set->y,
 276                                                     ENTER_ATOMIC_MODE_SET);
 277                 }
 278         }
 279
 280         return 0;
 281 }
 282 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
 283
 284 /* Find the real fb for a given fb helper CRTC */
 285 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
 286 {
 287         struct drm_device *dev = crtc->dev;
 288         struct drm_crtc *c;
 289
 290         drm_for_each_crtc(c, dev) {
 291                 if (crtc->base.id == c->base.id)
 292                         return c->primary->fb;
 293         }
 294
 295         return NULL;
 296 }
 297
 298 /**
 299  * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
 300  * @info: fbdev registered by the helper
 301  */
 302 int drm_fb_helper_debug_leave(struct fb_info *info)
 303 {
 304         struct drm_fb_helper *helper = info->par;
 305         struct drm_crtc *crtc;
 306         const struct drm_crtc_helper_funcs *funcs;
 307         struct drm_framebuffer *fb;
 308         int i;
 309
 310         for (i = 0; i < helper->crtc_count; i++) {
 311                 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
 312                 crtc = mode_set->crtc;
 313                 funcs = crtc->helper_private;
 314                 fb = drm_mode_config_fb(crtc);
 315
 316                 if (!crtc->enabled)
 317                         continue;
 318
 319                 if (!fb) {
 320                         DRM_ERROR("no fb to restore??\n");
 321                         continue;
 322                 }
 323
 324                 if (funcs->mode_set_base_atomic == NULL)
 325                         continue;
 326
 327                 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
 328                 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
 329                                             crtc->y, LEAVE_ATOMIC_MODE_SET);
 330         }
 331
 332         return 0;
 333 }
 334 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
 335
 336 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper)
 337 {
 338         struct drm_device *dev = fb_helper->dev;
 339         struct drm_plane *plane;
 340         struct drm_atomic_state *state;
 341         int i, ret;
 342         unsigned plane_mask;
 343
 344         state = drm_atomic_state_alloc(dev);
 345         if (!state)
 346                 return -ENOMEM;
 347
 348         state->acquire_ctx = dev->mode_config.acquire_ctx;
 349 retry:
 350         plane_mask = 0;
 351         drm_for_each_plane(plane, dev) {
 352                 struct drm_plane_state *plane_state;
 353
 354                 plane_state = drm_atomic_get_plane_state(state, plane);
 355                 if (IS_ERR(plane_state)) {
 356                         ret = PTR_ERR(plane_state);
 357                         goto fail;
 358                 }
 359
 360                 plane_state->rotation = DRM_ROTATE_0;
 361
 362                 plane->old_fb = plane->fb;
 363                 plane_mask |= 1 << drm_plane_index(plane);
 364
 365                 /* disable non-primary: */
 366                 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
 367                         continue;
 368
 369                 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
 370                 if (ret != 0)
 371                         goto fail;
 372         }
 373
 374         for(i = 0; i < fb_helper->crtc_count; i++) {
 375                 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
 376
 377                 ret = __drm_atomic_helper_set_config(mode_set, state);
 378                 if (ret != 0)
 379                         goto fail;
 380         }
 381
 382         ret = drm_atomic_commit(state);
 383
 384 fail:
 385         drm_atomic_clean_old_fb(dev, plane_mask, ret);
 386
 387         if (ret == -EDEADLK)
 388                 goto backoff;
 389
 390         drm_atomic_state_put(state);
 391         return ret;
 392
 393 backoff:
 394         drm_atomic_state_clear(state);
 395         drm_atomic_legacy_backoff(state);
 396
 397         goto retry;
 398 }
 399
 400 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
 401 {
 402         struct drm_device *dev = fb_helper->dev;
 403         struct drm_plane *plane;
 404         int i;
 405
 406         drm_warn_on_modeset_not_all_locked(dev);
 407
 408         if (drm_drv_uses_atomic_modeset(dev))
 409                 return restore_fbdev_mode_atomic(fb_helper);
 410
 411         drm_for_each_plane(plane, dev) {
 412                 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
 413                         drm_plane_force_disable(plane);
 414
 415                 if (plane->rotation_property)
 416                         drm_mode_plane_set_obj_prop(plane,
 417                                                     plane->rotation_property,
 418                                                     DRM_ROTATE_0);
 419         }
 420
 421         for (i = 0; i < fb_helper->crtc_count; i++) {
 422                 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
 423                 struct drm_crtc *crtc = mode_set->crtc;
 424                 int ret;
 425
 426                 if (crtc->funcs->cursor_set2) {
 427                         ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
 428                         if (ret)
 429                                 return ret;
 430                 } else if (crtc->funcs->cursor_set) {
 431                         ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
 432                         if (ret)
 433                                 return ret;
 434                 }
 435
 436                 ret = drm_mode_set_config_internal(mode_set);
 437                 if (ret)
 438                         return ret;
 439         }
 440
 441         return 0;
 442 }
 443
 444 /**
 445  * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
 446  * @fb_helper: fbcon to restore
 447  *
 448  * This should be called from driver's drm &drm_driver.lastclose callback
 449  * when implementing an fbcon on top of kms using this helper. This ensures that
 450  * the user isn't greeted with a black screen when e.g. X dies.
 451  *
 452  * RETURNS:
 453  * Zero if everything went ok, negative error code otherwise.
 454  */
 455 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
 456 {
 457         struct drm_device *dev = fb_helper->dev;
 458         bool do_delayed;
 459         int ret;
 460
 461         if (!drm_fbdev_emulation)
 462                 return -ENODEV;
 463
 464         drm_modeset_lock_all(dev);
 465         ret = restore_fbdev_mode(fb_helper);
 466
 467         do_delayed = fb_helper->delayed_hotplug;
 468         if (do_delayed)
 469                 fb_helper->delayed_hotplug = false;
 470         drm_modeset_unlock_all(dev);
 471
 472         if (do_delayed)
 473                 drm_fb_helper_hotplug_event(fb_helper);
 474         return ret;
 475 }
 476 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
 477
 478 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
 479 {
 480         struct drm_device *dev = fb_helper->dev;
 481         struct drm_crtc *crtc;
 482         int bound = 0, crtcs_bound = 0;
 483
 484         /* Sometimes user space wants everything disabled, so don't steal the
 485          * display if there's a master. */
 486         if (READ_ONCE(dev->master))
 487                 return false;
 488
 489         drm_for_each_crtc(crtc, dev) {
 490                 if (crtc->primary->fb)
 491                         crtcs_bound++;
 492                 if (crtc->primary->fb == fb_helper->fb)
 493                         bound++;
 494         }
 495
 496         if (bound < crtcs_bound)
 497                 return false;
 498
 499         return true;
 500 }
 501
 502 #ifdef CONFIG_MAGIC_SYSRQ
 503 /*
 504  * restore fbcon display for all kms driver's using this helper, used for sysrq
 505  * and panic handling.
 506  */
 507 static bool drm_fb_helper_force_kernel_mode(void)
 508 {
 509         bool ret, error = false;
 510         struct drm_fb_helper *helper;
 511
 512         if (list_empty(&kernel_fb_helper_list))
 513                 return false;
 514
 515         list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
 516                 struct drm_device *dev = helper->dev;
 517
 518                 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
 519                         continue;
 520
 521                 drm_modeset_lock_all(dev);
 522                 ret = restore_fbdev_mode(helper);
 523                 if (ret)
 524                         error = true;
 525                 drm_modeset_unlock_all(dev);
 526         }
 527         return error;
 528 }
 529
 530 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
 531 {
 532         bool ret;
 533         ret = drm_fb_helper_force_kernel_mode();
 534         if (ret == true)
 535                 DRM_ERROR("Failed to restore crtc configuration\n");
 536 }
 537 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
 538
 539 static void drm_fb_helper_sysrq(int dummy1)
 540 {
 541         schedule_work(&drm_fb_helper_restore_work);
 542 }
 543
 544 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
 545         .handler = drm_fb_helper_sysrq,
 546         .help_msg = "force-fb(V)",
 547         .action_msg = "Restore framebuffer console",
 548 };
 549 #else
 550 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
 551 #endif
 552
 553 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
 554 {
 555         struct drm_fb_helper *fb_helper = info->par;
 556         struct drm_device *dev = fb_helper->dev;
 557         struct drm_crtc *crtc;
 558         struct drm_connector *connector;
 559         int i, j;
 560
 561         /*
 562          * For each CRTC in this fb, turn the connectors on/off.
 563          */
 564         drm_modeset_lock_all(dev);
 565         if (!drm_fb_helper_is_bound(fb_helper)) {
 566                 drm_modeset_unlock_all(dev);
 567                 return;
 568         }
 569
 570         for (i = 0; i < fb_helper->crtc_count; i++) {
 571                 crtc = fb_helper->crtc_info[i].mode_set.crtc;
 572
 573                 if (!crtc->enabled)
 574                         continue;
 575
 576                 /* Walk the connectors & encoders on this fb turning them on/off */
 577                 drm_fb_helper_for_each_connector(fb_helper, j) {
 578                         connector = fb_helper->connector_info[j]->connector;
 579                         connector->funcs->dpms(connector, dpms_mode);
 580                         drm_object_property_set_value(&connector->base,
 581                                 dev->mode_config.dpms_property, dpms_mode);
 582                 }
 583         }
 584         drm_modeset_unlock_all(dev);
 585 }
 586
 587 /**
 588  * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
 589  * @blank: desired blanking state
 590  * @info: fbdev registered by the helper
 591  */
 592 int drm_fb_helper_blank(int blank, struct fb_info *info)
 593 {
 594         if (oops_in_progress)
 595                 return -EBUSY;
 596
 597         switch (blank) {
 598         /* Display: On; HSync: On, VSync: On */
 599         case FB_BLANK_UNBLANK:
 600                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
 601                 break;
 602         /* Display: Off; HSync: On, VSync: On */
 603         case FB_BLANK_NORMAL:
 604                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
 605                 break;
 606         /* Display: Off; HSync: Off, VSync: On */
 607         case FB_BLANK_HSYNC_SUSPEND:
 608                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
 609                 break;
 610         /* Display: Off; HSync: On, VSync: Off */
 611         case FB_BLANK_VSYNC_SUSPEND:
 612                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
 613                 break;
 614         /* Display: Off; HSync: Off, VSync: Off */
 615         case FB_BLANK_POWERDOWN:
 616                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
 617                 break;
 618         }
 619         return 0;
 620 }
 621 EXPORT_SYMBOL(drm_fb_helper_blank);
 622
 623 static void drm_fb_helper_modeset_release(struct drm_fb_helper *helper,
 624                                           struct drm_mode_set *modeset)
 625 {
 626         int i;
 627
 628         for (i = 0; i < modeset->num_connectors; i++) {
 629                 drm_connector_unreference(modeset->connectors[i]);
 630                 modeset->connectors[i] = NULL;
 631         }
 632         modeset->num_connectors = 0;
 633
 634         drm_mode_destroy(helper->dev, modeset->mode);
 635         modeset->mode = NULL;
 636
 637         /* FIXME should hold a ref? */
 638         modeset->fb = NULL;
 639 }
 640
 641 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
 642 {
 643         int i;
 644
 645         for (i = 0; i < helper->connector_count; i++) {
 646                 drm_connector_unreference(helper->connector_info[i]->connector);
 647                 kfree(helper->connector_info[i]);
 648         }
 649         kfree(helper->connector_info);
 650
 651         for (i = 0; i < helper->crtc_count; i++) {
 652                 struct drm_mode_set *modeset = &helper->crtc_info[i].mode_set;
 653
 654                 drm_fb_helper_modeset_release(helper, modeset);
 655                 kfree(modeset->connectors);
 656         }
 657         kfree(helper->crtc_info);
 658 }
 659
 660 static void drm_fb_helper_resume_worker(struct work_struct *work)
 661 {
 662         struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
 663                                                     resume_work);
 664
 665         console_lock();
 666         fb_set_suspend(helper->fbdev, 0);
 667         console_unlock();
 668 }
 669
 670 static void drm_fb_helper_dirty_work(struct work_struct *work)
 671 {
 672         struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
 673                                                     dirty_work);
 674         struct drm_clip_rect *clip = &helper->dirty_clip;
 675         struct drm_clip_rect clip_copy;
 676         unsigned long flags;
 677
 678         spin_lock_irqsave(&helper->dirty_lock, flags);
 679         clip_copy = *clip;
 680         clip->x1 = clip->y1 = ~0;
 681         clip->x2 = clip->y2 = 0;
 682         spin_unlock_irqrestore(&helper->dirty_lock, flags);
 683
 684         /* call dirty callback only when it has been really touched */
 685         if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2)
 686                 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
 687 }
 688
 689 /**
 690  * drm_fb_helper_prepare - setup a drm_fb_helper structure
 691  * @dev: DRM device
 692  * @helper: driver-allocated fbdev helper structure to set up
 693  * @funcs: pointer to structure of functions associate with this helper
 694  *
 695  * Sets up the bare minimum to make the framebuffer helper usable. This is
 696  * useful to implement race-free initialization of the polling helpers.
 697  */
 698 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
 699                            const struct drm_fb_helper_funcs *funcs)
 700 {
 701         INIT_LIST_HEAD(&helper->kernel_fb_list);
 702         spin_lock_init(&helper->dirty_lock);
 703         INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
 704         INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
 705         helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
 706         helper->funcs = funcs;
 707         helper->dev = dev;
 708 }
 709 EXPORT_SYMBOL(drm_fb_helper_prepare);
 710
 711 /**
 712  * drm_fb_helper_init - initialize a drm_fb_helper structure
 713  * @dev: drm device
 714  * @fb_helper: driver-allocated fbdev helper structure to initialize
 715  * @crtc_count: maximum number of crtcs to support in this fbdev emulation
 716  * @max_conn_count: max connector count
 717  *
 718  * This allocates the structures for the fbdev helper with the given limits.
 719  * Note that this won't yet touch the hardware (through the driver interfaces)
 720  * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
 721  * to allow driver writes more control over the exact init sequence.
 722  *
 723  * Drivers must call drm_fb_helper_prepare() before calling this function.
 724  *
 725  * RETURNS:
 726  * Zero if everything went ok, nonzero otherwise.
 727  */
 728 int drm_fb_helper_init(struct drm_device *dev,
 729                        struct drm_fb_helper *fb_helper,
 730                        int crtc_count, int max_conn_count)
 731 {
 732         struct drm_crtc *crtc;
 733         int i;
 734
 735         if (!drm_fbdev_emulation)
 736                 return 0;
 737
 738         if (!max_conn_count)
 739                 return -EINVAL;
 740
 741         fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
 742         if (!fb_helper->crtc_info)
 743                 return -ENOMEM;
 744
 745         fb_helper->crtc_count = crtc_count;
 746         fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
 747         if (!fb_helper->connector_info) {
 748                 kfree(fb_helper->crtc_info);
 749                 return -ENOMEM;
 750         }
 751         fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
 752         fb_helper->connector_count = 0;
 753
 754         for (i = 0; i < crtc_count; i++) {
 755                 fb_helper->crtc_info[i].mode_set.connectors =
 756                         kcalloc(max_conn_count,
 757                                 sizeof(struct drm_connector *),
 758                                 GFP_KERNEL);
 759
 760                 if (!fb_helper->crtc_info[i].mode_set.connectors)
 761                         goto out_free;
 762                 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
 763         }
 764
 765         i = 0;
 766         drm_for_each_crtc(crtc, dev) {
 767                 fb_helper->crtc_info[i].mode_set.crtc = crtc;
 768                 i++;
 769         }
 770
 771         return 0;
 772 out_free:
 773         drm_fb_helper_crtc_free(fb_helper);
 774         return -ENOMEM;
 775 }
 776 EXPORT_SYMBOL(drm_fb_helper_init);
 777
 778 /**
 779  * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
 780  * @fb_helper: driver-allocated fbdev helper
 781  *
 782  * A helper to alloc fb_info and the members cmap and apertures. Called
 783  * by the driver within the fb_probe fb_helper callback function.
 784  *
 785  * RETURNS:
 786  * fb_info pointer if things went okay, pointer containing error code
 787  * otherwise
 788  */
 789 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
 790 {
 791         struct device *dev = fb_helper->dev->dev;
 792         struct fb_info *info;
 793         int ret;
 794
 795         info = framebuffer_alloc(0, dev);
 796         if (!info)
 797                 return ERR_PTR(-ENOMEM);
 798
 799         ret = fb_alloc_cmap(&info->cmap, 256, 0);
 800         if (ret)
 801                 goto err_release;
 802
 803         info->apertures = alloc_apertures(1);
 804         if (!info->apertures) {
 805                 ret = -ENOMEM;
 806                 goto err_free_cmap;
 807         }
 808
 809         fb_helper->fbdev = info;
 810
 811         return info;
 812
 813 err_free_cmap:
 814         fb_dealloc_cmap(&info->cmap);
 815 err_release:
 816         framebuffer_release(info);
 817         return ERR_PTR(ret);
 818 }
 819 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
 820
 821 /**
 822  * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
 823  * @fb_helper: driver-allocated fbdev helper
 824  *
 825  * A wrapper around unregister_framebuffer, to release the fb_info
 826  * framebuffer device
 827  */
 828 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
 829 {
 830         if (fb_helper && fb_helper->fbdev)
 831                 unregister_framebuffer(fb_helper->fbdev);
 832 }
 833 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
 834
 835 /**
 836  * drm_fb_helper_release_fbi - dealloc fb_info and its members
 837  * @fb_helper: driver-allocated fbdev helper
 838  *
 839  * A helper to free memory taken by fb_info and the members cmap and
 840  * apertures
 841  */
 842 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
 843 {
 844         if (fb_helper) {
 845                 struct fb_info *info = fb_helper->fbdev;
 846
 847                 if (info) {
 848                         if (info->cmap.len)
 849                                 fb_dealloc_cmap(&info->cmap);
 850                         framebuffer_release(info);
 851                 }
 852
 853                 fb_helper->fbdev = NULL;
 854         }
 855 }
 856 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
 857
 858 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
 859 {
 860         if (!drm_fbdev_emulation)
 861                 return;
 862
 863         mutex_lock(&kernel_fb_helper_lock);
 864         if (!list_empty(&fb_helper->kernel_fb_list)) {
 865                 list_del(&fb_helper->kernel_fb_list);
 866                 if (list_empty(&kernel_fb_helper_list)) {
 867                         unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
 868                 }
 869         }
 870         mutex_unlock(&kernel_fb_helper_lock);
 871
 872         drm_fb_helper_crtc_free(fb_helper);
 873
 874 }
 875 EXPORT_SYMBOL(drm_fb_helper_fini);
 876
 877 /**
 878  * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
 879  * @fb_helper: driver-allocated fbdev helper
 880  *
 881  * A wrapper around unlink_framebuffer implemented by fbdev core
 882  */
 883 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
 884 {
 885         if (fb_helper && fb_helper->fbdev)
 886                 unlink_framebuffer(fb_helper->fbdev);
 887 }
 888 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
 889
 890 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
 891                                 u32 width, u32 height)
 892 {
 893         struct drm_fb_helper *helper = info->par;
 894         struct drm_clip_rect *clip = &helper->dirty_clip;
 895         unsigned long flags;
 896
 897         if (!helper->fb->funcs->dirty)
 898                 return;
 899
 900         spin_lock_irqsave(&helper->dirty_lock, flags);
 901         clip->x1 = min_t(u32, clip->x1, x);
 902         clip->y1 = min_t(u32, clip->y1, y);
 903         clip->x2 = max_t(u32, clip->x2, x + width);
 904         clip->y2 = max_t(u32, clip->y2, y + height);
 905         spin_unlock_irqrestore(&helper->dirty_lock, flags);
 906
 907         schedule_work(&helper->dirty_work);
 908 }
 909
 910 /**
 911  * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
 912  * @info: fb_info struct pointer
 913  * @pagelist: list of dirty mmap framebuffer pages
 914  *
 915  * This function is used as the &fb_deferred_io.deferred_io
 916  * callback function for flushing the fbdev mmap writes.
 917  */
 918 void drm_fb_helper_deferred_io(struct fb_info *info,
 919                                struct list_head *pagelist)
 920 {
 921         unsigned long start, end, min, max;
 922         struct page *page;
 923         u32 y1, y2;
 924
 925         min = ULONG_MAX;
 926         max = 0;
 927         list_for_each_entry(page, pagelist, lru) {
 928                 start = page->index << PAGE_SHIFT;
 929                 end = start + PAGE_SIZE - 1;
 930                 min = min(min, start);
 931                 max = max(max, end);
 932         }
 933
 934         if (min < max) {
 935                 y1 = min / info->fix.line_length;
 936                 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
 937                            info->var.yres);
 938                 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
 939         }
 940 }
 941 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
 942
 943 /**
 944  * drm_fb_helper_sys_read - wrapper around fb_sys_read
 945  * @info: fb_info struct pointer
 946  * @buf: userspace buffer to read from framebuffer memory
 947  * @count: number of bytes to read from framebuffer memory
 948  * @ppos: read offset within framebuffer memory
 949  *
 950  * A wrapper around fb_sys_read implemented by fbdev core
 951  */
 952 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
 953                                size_t count, loff_t *ppos)
 954 {
 955         return fb_sys_read(info, buf, count, ppos);
 956 }
 957 EXPORT_SYMBOL(drm_fb_helper_sys_read);
 958
 959 /**
 960  * drm_fb_helper_sys_write - wrapper around fb_sys_write
 961  * @info: fb_info struct pointer
 962  * @buf: userspace buffer to write to framebuffer memory
 963  * @count: number of bytes to write to framebuffer memory
 964  * @ppos: write offset within framebuffer memory
 965  *
 966  * A wrapper around fb_sys_write implemented by fbdev core
 967  */
 968 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
 969                                 size_t count, loff_t *ppos)
 970 {
 971         ssize_t ret;
 972
 973         ret = fb_sys_write(info, buf, count, ppos);
 974         if (ret > 0)
 975                 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
 976                                     info->var.yres);
 977
 978         return ret;
 979 }
 980 EXPORT_SYMBOL(drm_fb_helper_sys_write);
 981
 982 /**
 983  * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
 984  * @info: fbdev registered by the helper
 985  * @rect: info about rectangle to fill
 986  *
 987  * A wrapper around sys_fillrect implemented by fbdev core
 988  */
 989 void drm_fb_helper_sys_fillrect(struct fb_info *info,
 990                                 const struct fb_fillrect *rect)
 991 {
 992         sys_fillrect(info, rect);
 993         drm_fb_helper_dirty(info, rect->dx, rect->dy,
 994                             rect->width, rect->height);
 995 }
 996 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
 997
 998 /**
 999  * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1000  * @info: fbdev registered by the helper
1001  * @area: info about area to copy
1002  *
1003  * A wrapper around sys_copyarea implemented by fbdev core
1004  */
1005 void drm_fb_helper_sys_copyarea(struct fb_info *info,
1006                                 const struct fb_copyarea *area)
1007 {
1008         sys_copyarea(info, area);
1009         drm_fb_helper_dirty(info, area->dx, area->dy,
1010                             area->width, area->height);
1011 }
1012 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
1013
1014 /**
1015  * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1016  * @info: fbdev registered by the helper
1017  * @image: info about image to blit
1018  *
1019  * A wrapper around sys_imageblit implemented by fbdev core
1020  */
1021 void drm_fb_helper_sys_imageblit(struct fb_info *info,
1022                                  const struct fb_image *image)
1023 {
1024         sys_imageblit(info, image);
1025         drm_fb_helper_dirty(info, image->dx, image->dy,
1026                             image->width, image->height);
1027 }
1028 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
1029
1030 /**
1031  * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1032  * @info: fbdev registered by the helper
1033  * @rect: info about rectangle to fill
1034  *
1035  * A wrapper around cfb_imageblit implemented by fbdev core
1036  */
1037 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1038                                 const struct fb_fillrect *rect)
1039 {
1040         cfb_fillrect(info, rect);
1041         drm_fb_helper_dirty(info, rect->dx, rect->dy,
1042                             rect->width, rect->height);
1043 }
1044 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1045
1046 /**
1047  * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1048  * @info: fbdev registered by the helper
1049  * @area: info about area to copy
1050  *
1051  * A wrapper around cfb_copyarea implemented by fbdev core
1052  */
1053 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1054                                 const struct fb_copyarea *area)
1055 {
1056         cfb_copyarea(info, area);
1057         drm_fb_helper_dirty(info, area->dx, area->dy,
1058                             area->width, area->height);
1059 }
1060 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1061
1062 /**
1063  * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1064  * @info: fbdev registered by the helper
1065  * @image: info about image to blit
1066  *
1067  * A wrapper around cfb_imageblit implemented by fbdev core
1068  */
1069 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1070                                  const struct fb_image *image)
1071 {
1072         cfb_imageblit(info, image);
1073         drm_fb_helper_dirty(info, image->dx, image->dy,
1074                             image->width, image->height);
1075 }
1076 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1077
1078 /**
1079  * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1080  * @fb_helper: driver-allocated fbdev helper
1081  * @suspend: whether to suspend or resume
1082  *
1083  * A wrapper around fb_set_suspend implemented by fbdev core.
1084  * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1085  * the lock yourself
1086  */
1087 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1088 {
1089         if (fb_helper && fb_helper->fbdev)
1090                 fb_set_suspend(fb_helper->fbdev, suspend);
1091 }
1092 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1093
1094 /**
1095  * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1096  *                                      takes the console lock
1097  * @fb_helper: driver-allocated fbdev helper
1098  * @suspend: whether to suspend or resume
1099  *
1100  * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1101  * isn't available on resume, a worker is tasked with waiting for the lock
1102  * to become available. The console lock can be pretty contented on resume
1103  * due to all the printk activity.
1104  *
1105  * This function can be called multiple times with the same state since
1106  * &fb_info.state is checked to see if fbdev is running or not before locking.
1107  *
1108  * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1109  */
1110 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1111                                         bool suspend)
1112 {
1113         if (!fb_helper || !fb_helper->fbdev)
1114                 return;
1115
1116         /* make sure there's no pending/ongoing resume */
1117         flush_work(&fb_helper->resume_work);
1118
1119         if (suspend) {
1120                 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1121                         return;
1122
1123                 console_lock();
1124
1125         } else {
1126                 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1127                         return;
1128
1129                 if (!console_trylock()) {
1130                         schedule_work(&fb_helper->resume_work);
1131                         return;
1132                 }
1133         }
1134
1135         fb_set_suspend(fb_helper->fbdev, suspend);
1136         console_unlock();
1137 }
1138 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1139
1140 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1141                      u16 blue, u16 regno, struct fb_info *info)
1142 {
1143         struct drm_fb_helper *fb_helper = info->par;
1144         struct drm_framebuffer *fb = fb_helper->fb;
1145
1146         if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1147                 u32 *palette;
1148                 u32 value;
1149                 /* place color in psuedopalette */
1150                 if (regno > 16)
1151                         return -EINVAL;
1152                 palette = (u32 *)info->pseudo_palette;
1153                 red >>= (16 - info->var.red.length);
1154                 green >>= (16 - info->var.green.length);
1155                 blue >>= (16 - info->var.blue.length);
1156                 value = (red << info->var.red.offset) |
1157                         (green << info->var.green.offset) |
1158                         (blue << info->var.blue.offset);
1159                 if (info->var.transp.length > 0) {
1160                         u32 mask = (1 << info->var.transp.length) - 1;
1161                         mask <<= info->var.transp.offset;
1162                         value |= mask;
1163                 }
1164                 palette[regno] = value;
1165                 return 0;
1166         }
1167
1168         /*
1169          * The driver really shouldn't advertise pseudo/directcolor
1170          * visuals if it can't deal with the palette.
1171          */
1172         if (WARN_ON(!fb_helper->funcs->gamma_set ||
1173                     !fb_helper->funcs->gamma_get))
1174                 return -EINVAL;
1175
1176         WARN_ON(fb->format->cpp[0] != 1);
1177
1178         fb_helper->funcs->gamma_set(crtc, red, green, blue, regno);
1179
1180         return 0;
1181 }
1182
1183 /**
1184  * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1185  * @cmap: cmap to set
1186  * @info: fbdev registered by the helper
1187  */
1188 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1189 {
1190         struct drm_fb_helper *fb_helper = info->par;
1191         struct drm_device *dev = fb_helper->dev;
1192         const struct drm_crtc_helper_funcs *crtc_funcs;
1193         u16 *red, *green, *blue, *transp;
1194         struct drm_crtc *crtc;
1195         int i, j, rc = 0;
1196         int start;
1197
1198         if (oops_in_progress)
1199                 return -EBUSY;
1200
1201         drm_modeset_lock_all(dev);
1202         if (!drm_fb_helper_is_bound(fb_helper)) {
1203                 drm_modeset_unlock_all(dev);
1204                 return -EBUSY;
1205         }
1206
1207         for (i = 0; i < fb_helper->crtc_count; i++) {
1208                 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1209                 crtc_funcs = crtc->helper_private;
1210
1211                 red = cmap->red;
1212                 green = cmap->green;
1213                 blue = cmap->blue;
1214                 transp = cmap->transp;
1215                 start = cmap->start;
1216
1217                 for (j = 0; j < cmap->len; j++) {
1218                         u16 hred, hgreen, hblue, htransp = 0xffff;
1219
1220                         hred = *red++;
1221                         hgreen = *green++;
1222                         hblue = *blue++;
1223
1224                         if (transp)
1225                                 htransp = *transp++;
1226
1227                         rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1228                         if (rc)
1229                                 goto out;
1230                 }
1231                 if (crtc_funcs->load_lut)
1232                         crtc_funcs->load_lut(crtc);
1233         }
1234  out:
1235         drm_modeset_unlock_all(dev);
1236         return rc;
1237 }
1238 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1239
1240 /**
1241  * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1242  * @var: screeninfo to check
1243  * @info: fbdev registered by the helper
1244  */
1245 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1246                             struct fb_info *info)
1247 {
1248         struct drm_fb_helper *fb_helper = info->par;
1249         struct drm_framebuffer *fb = fb_helper->fb;
1250         int depth;
1251
1252         if (var->pixclock != 0 || in_dbg_master())
1253                 return -EINVAL;
1254
1255         /*
1256          * Changes struct fb_var_screeninfo are currently not pushed back
1257          * to KMS, hence fail if different settings are requested.
1258          */
1259         if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1260             var->xres != fb->width || var->yres != fb->height ||
1261             var->xres_virtual != fb->width || var->yres_virtual != fb->height) {
1262                 DRM_DEBUG("fb userspace requested width/height/bpp different than current fb "
1263                           "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1264                           var->xres, var->yres, var->bits_per_pixel,
1265                           var->xres_virtual, var->yres_virtual,
1266                           fb->width, fb->height, fb->format->cpp[0] * 8);
1267                 return -EINVAL;
1268         }
1269
1270         switch (var->bits_per_pixel) {
1271         case 16:
1272                 depth = (var->green.length == 6) ? 16 : 15;
1273                 break;
1274         case 32:
1275                 depth = (var->transp.length > 0) ? 32 : 24;
1276                 break;
1277         default:
1278                 depth = var->bits_per_pixel;
1279                 break;
1280         }
1281
1282         switch (depth) {
1283         case 8:
1284                 var->red.offset = 0;
1285                 var->green.offset = 0;
1286                 var->blue.offset = 0;
1287                 var->red.length = 8;
1288                 var->green.length = 8;
1289                 var->blue.length = 8;
1290                 var->transp.length = 0;
1291                 var->transp.offset = 0;
1292                 break;
1293         case 15:
1294                 var->red.offset = 10;
1295                 var->green.offset = 5;
1296                 var->blue.offset = 0;
1297                 var->red.length = 5;
1298                 var->green.length = 5;
1299                 var->blue.length = 5;
1300                 var->transp.length = 1;
1301                 var->transp.offset = 15;
1302                 break;
1303         case 16:
1304                 var->red.offset = 11;
1305                 var->green.offset = 5;
1306                 var->blue.offset = 0;
1307                 var->red.length = 5;
1308                 var->green.length = 6;
1309                 var->blue.length = 5;
1310                 var->transp.length = 0;
1311                 var->transp.offset = 0;
1312                 break;
1313         case 24:
1314                 var->red.offset = 16;
1315                 var->green.offset = 8;
1316                 var->blue.offset = 0;
1317                 var->red.length = 8;
1318                 var->green.length = 8;
1319                 var->blue.length = 8;
1320                 var->transp.length = 0;
1321                 var->transp.offset = 0;
1322                 break;
1323         case 32:
1324                 var->red.offset = 16;
1325                 var->green.offset = 8;
1326                 var->blue.offset = 0;
1327                 var->red.length = 8;
1328                 var->green.length = 8;
1329                 var->blue.length = 8;
1330                 var->transp.length = 8;
1331                 var->transp.offset = 24;
1332                 break;
1333         default:
1334                 return -EINVAL;
1335         }
1336         return 0;
1337 }
1338 EXPORT_SYMBOL(drm_fb_helper_check_var);
1339
1340 /**
1341  * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1342  * @info: fbdev registered by the helper
1343  *
1344  * This will let fbcon do the mode init and is called at initialization time by
1345  * the fbdev core when registering the driver, and later on through the hotplug
1346  * callback.
1347  */
1348 int drm_fb_helper_set_par(struct fb_info *info)
1349 {
1350         struct drm_fb_helper *fb_helper = info->par;
1351         struct fb_var_screeninfo *var = &info->var;
1352
1353         if (oops_in_progress)
1354                 return -EBUSY;
1355
1356         if (var->pixclock != 0) {
1357                 DRM_ERROR("PIXEL CLOCK SET\n");
1358                 return -EINVAL;
1359         }
1360
1361         drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1362
1363         return 0;
1364 }
1365 EXPORT_SYMBOL(drm_fb_helper_set_par);
1366
1367 static int pan_display_atomic(struct fb_var_screeninfo *var,
1368                               struct fb_info *info)
1369 {
1370         struct drm_fb_helper *fb_helper = info->par;
1371         struct drm_device *dev = fb_helper->dev;
1372         struct drm_atomic_state *state;
1373         struct drm_plane *plane;
1374         int i, ret;
1375         unsigned plane_mask;
1376
1377         state = drm_atomic_state_alloc(dev);
1378         if (!state)
1379                 return -ENOMEM;
1380
1381         state->acquire_ctx = dev->mode_config.acquire_ctx;
1382 retry:
1383         plane_mask = 0;
1384         for(i = 0; i < fb_helper->crtc_count; i++) {
1385                 struct drm_mode_set *mode_set;
1386
1387                 mode_set = &fb_helper->crtc_info[i].mode_set;
1388
1389                 mode_set->x = var->xoffset;
1390                 mode_set->y = var->yoffset;
1391
1392                 ret = __drm_atomic_helper_set_config(mode_set, state);
1393                 if (ret != 0)
1394                         goto fail;
1395
1396                 plane = mode_set->crtc->primary;
1397                 plane_mask |= (1 << drm_plane_index(plane));
1398                 plane->old_fb = plane->fb;
1399         }
1400
1401         ret = drm_atomic_commit(state);
1402         if (ret != 0)
1403                 goto fail;
1404
1405         info->var.xoffset = var->xoffset;
1406         info->var.yoffset = var->yoffset;
1407
1408 fail:
1409         drm_atomic_clean_old_fb(dev, plane_mask, ret);
1410
1411         if (ret == -EDEADLK)
1412                 goto backoff;
1413
1414         drm_atomic_state_put(state);
1415         return ret;
1416
1417 backoff:
1418         drm_atomic_state_clear(state);
1419         drm_atomic_legacy_backoff(state);
1420
1421         goto retry;
1422 }
1423
1424 /**
1425  * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1426  * @var: updated screen information
1427  * @info: fbdev registered by the helper
1428  */
1429 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1430                               struct fb_info *info)
1431 {
1432         struct drm_fb_helper *fb_helper = info->par;
1433         struct drm_device *dev = fb_helper->dev;
1434         struct drm_mode_set *modeset;
1435         int ret = 0;
1436         int i;
1437
1438         if (oops_in_progress)
1439                 return -EBUSY;
1440
1441         drm_modeset_lock_all(dev);
1442         if (!drm_fb_helper_is_bound(fb_helper)) {
1443                 drm_modeset_unlock_all(dev);
1444                 return -EBUSY;
1445         }
1446
1447         if (drm_drv_uses_atomic_modeset(dev)) {
1448                 ret = pan_display_atomic(var, info);
1449                 goto unlock;
1450         }
1451
1452         for (i = 0; i < fb_helper->crtc_count; i++) {
1453                 modeset = &fb_helper->crtc_info[i].mode_set;
1454
1455                 modeset->x = var->xoffset;
1456                 modeset->y = var->yoffset;
1457
1458                 if (modeset->num_connectors) {
1459                         ret = drm_mode_set_config_internal(modeset);
1460                         if (!ret) {
1461                                 info->var.xoffset = var->xoffset;
1462                                 info->var.yoffset = var->yoffset;
1463                         }
1464                 }
1465         }
1466 unlock:
1467         drm_modeset_unlock_all(dev);
1468         return ret;
1469 }
1470 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1471
1472 /*
1473  * Allocates the backing storage and sets up the fbdev info structure through
1474  * the ->fb_probe callback and then registers the fbdev and sets up the panic
1475  * notifier.
1476  */
1477 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1478                                          int preferred_bpp)
1479 {
1480         int ret = 0;
1481         int crtc_count = 0;
1482         int i;
1483         struct drm_fb_helper_surface_size sizes;
1484         int gamma_size = 0;
1485
1486         memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1487         sizes.surface_depth = 24;
1488         sizes.surface_bpp = 32;
1489         sizes.fb_width = (unsigned)-1;
1490         sizes.fb_height = (unsigned)-1;
1491
1492         /* if driver picks 8 or 16 by default use that
1493            for both depth/bpp */
1494         if (preferred_bpp != sizes.surface_bpp)
1495                 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1496
1497         /* first up get a count of crtcs now in use and new min/maxes width/heights */
1498         drm_fb_helper_for_each_connector(fb_helper, i) {
1499                 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1500                 struct drm_cmdline_mode *cmdline_mode;
1501
1502                 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1503
1504                 if (cmdline_mode->bpp_specified) {
1505                         switch (cmdline_mode->bpp) {
1506                         case 8:
1507                                 sizes.surface_depth = sizes.surface_bpp = 8;
1508                                 break;
1509                         case 15:
1510                                 sizes.surface_depth = 15;
1511                                 sizes.surface_bpp = 16;
1512                                 break;
1513                         case 16:
1514                                 sizes.surface_depth = sizes.surface_bpp = 16;
1515                                 break;
1516                         case 24:
1517                                 sizes.surface_depth = sizes.surface_bpp = 24;
1518                                 break;
1519                         case 32:
1520                                 sizes.surface_depth = 24;
1521                                 sizes.surface_bpp = 32;
1522                                 break;
1523                         }
1524                         break;
1525                 }
1526         }
1527
1528         crtc_count = 0;
1529         for (i = 0; i < fb_helper->crtc_count; i++) {
1530                 struct drm_display_mode *desired_mode;
1531                 struct drm_mode_set *mode_set;
1532                 int x, y, j;
1533                 /* in case of tile group, are we the last tile vert or horiz?
1534                  * If no tile group you are always the last one both vertically
1535                  * and horizontally
1536                  */
1537                 bool lastv = true, lasth = true;
1538
1539                 desired_mode = fb_helper->crtc_info[i].desired_mode;
1540                 mode_set = &fb_helper->crtc_info[i].mode_set;
1541
1542                 if (!desired_mode)
1543                         continue;
1544
1545                 crtc_count++;
1546
1547                 x = fb_helper->crtc_info[i].x;
1548                 y = fb_helper->crtc_info[i].y;
1549
1550                 if (gamma_size == 0)
1551                         gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1552
1553                 sizes.surface_width  = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1554                 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1555
1556                 for (j = 0; j < mode_set->num_connectors; j++) {
1557                         struct drm_connector *connector = mode_set->connectors[j];
1558                         if (connector->has_tile) {
1559                                 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1560                                 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1561                                 /* cloning to multiple tiles is just crazy-talk, so: */
1562                                 break;
1563                         }
1564                 }
1565
1566                 if (lasth)
1567                         sizes.fb_width  = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1568                 if (lastv)
1569                         sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1570         }
1571
1572         if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1573                 /* hmm everyone went away - assume VGA cable just fell out
1574                    and will come back later. */
1575                 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1576                 sizes.fb_width = sizes.surface_width = 1024;
1577                 sizes.fb_height = sizes.surface_height = 768;
1578         }
1579
1580         /* push down into drivers */
1581         ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1582         if (ret < 0)
1583                 return ret;
1584
1585         /*
1586          * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1587          * events, but at init time drm_setup_crtcs needs to be called before
1588          * the fb is allocated (since we need to figure out the desired size of
1589          * the fb before we can allocate it ...). Hence we need to fix things up
1590          * here again.
1591          */
1592         for (i = 0; i < fb_helper->crtc_count; i++)
1593                 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1594                         fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1595
1596         return 0;
1597 }
1598
1599 /**
1600  * drm_fb_helper_fill_fix - initializes fixed fbdev information
1601  * @info: fbdev registered by the helper
1602  * @pitch: desired pitch
1603  * @depth: desired depth
1604  *
1605  * Helper to fill in the fixed fbdev information useful for a non-accelerated
1606  * fbdev emulations. Drivers which support acceleration methods which impose
1607  * additional constraints need to set up their own limits.
1608  *
1609  * Drivers should call this (or their equivalent setup code) from their
1610  * &drm_fb_helper_funcs.fb_probe callback.
1611  */
1612 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1613                             uint32_t depth)
1614 {
1615         info->fix.type = FB_TYPE_PACKED_PIXELS;
1616         info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1617                 FB_VISUAL_TRUECOLOR;
1618         info->fix.mmio_start = 0;
1619         info->fix.mmio_len = 0;
1620         info->fix.type_aux = 0;
1621         info->fix.xpanstep = 1; /* doing it in hw */
1622         info->fix.ypanstep = 1; /* doing it in hw */
1623         info->fix.ywrapstep = 0;
1624         info->fix.accel = FB_ACCEL_NONE;
1625
1626         info->fix.line_length = pitch;
1627         return;
1628 }
1629 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1630
1631 /**
1632  * drm_fb_helper_fill_var - initalizes variable fbdev information
1633  * @info: fbdev instance to set up
1634  * @fb_helper: fb helper instance to use as template
1635  * @fb_width: desired fb width
1636  * @fb_height: desired fb height
1637  *
1638  * Sets up the variable fbdev metainformation from the given fb helper instance
1639  * and the drm framebuffer allocated in &drm_fb_helper.fb.
1640  *
1641  * Drivers should call this (or their equivalent setup code) from their
1642  * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1643  * backing storage framebuffer.
1644  */
1645 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1646                             uint32_t fb_width, uint32_t fb_height)
1647 {
1648         struct drm_framebuffer *fb = fb_helper->fb;
1649         info->pseudo_palette = fb_helper->pseudo_palette;
1650         info->var.xres_virtual = fb->width;
1651         info->var.yres_virtual = fb->height;
1652         info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1653         info->var.accel_flags = FB_ACCELF_TEXT;
1654         info->var.xoffset = 0;
1655         info->var.yoffset = 0;
1656         info->var.activate = FB_ACTIVATE_NOW;
1657         info->var.height = -1;
1658         info->var.width = -1;
1659
1660         switch (fb->format->depth) {
1661         case 8:
1662                 info->var.red.offset = 0;
1663                 info->var.green.offset = 0;
1664                 info->var.blue.offset = 0;
1665                 info->var.red.length = 8; /* 8bit DAC */
1666                 info->var.green.length = 8;
1667                 info->var.blue.length = 8;
1668                 info->var.transp.offset = 0;
1669                 info->var.transp.length = 0;
1670                 break;
1671         case 15:
1672                 info->var.red.offset = 10;
1673                 info->var.green.offset = 5;
1674                 info->var.blue.offset = 0;
1675                 info->var.red.length = 5;
1676                 info->var.green.length = 5;
1677                 info->var.blue.length = 5;
1678                 info->var.transp.offset = 15;
1679                 info->var.transp.length = 1;
1680                 break;
1681         case 16:
1682                 info->var.red.offset = 11;
1683                 info->var.green.offset = 5;
1684                 info->var.blue.offset = 0;
1685                 info->var.red.length = 5;
1686                 info->var.green.length = 6;
1687                 info->var.blue.length = 5;
1688                 info->var.transp.offset = 0;
1689                 break;
1690         case 24:
1691                 info->var.red.offset = 16;
1692                 info->var.green.offset = 8;
1693                 info->var.blue.offset = 0;
1694                 info->var.red.length = 8;
1695                 info->var.green.length = 8;
1696                 info->var.blue.length = 8;
1697                 info->var.transp.offset = 0;
1698                 info->var.transp.length = 0;
1699                 break;
1700         case 32:
1701                 info->var.red.offset = 16;
1702                 info->var.green.offset = 8;
1703                 info->var.blue.offset = 0;
1704                 info->var.red.length = 8;
1705                 info->var.green.length = 8;
1706                 info->var.blue.length = 8;
1707                 info->var.transp.offset = 24;
1708                 info->var.transp.length = 8;
1709                 break;
1710         default:
1711                 break;
1712         }
1713
1714         info->var.xres = fb_width;
1715         info->var.yres = fb_height;
1716 }
1717 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1718
1719 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1720                                                uint32_t maxX,
1721                                                uint32_t maxY)
1722 {
1723         struct drm_connector *connector;
1724         int count = 0;
1725         int i;
1726
1727         drm_fb_helper_for_each_connector(fb_helper, i) {
1728                 connector = fb_helper->connector_info[i]->connector;
1729                 count += connector->funcs->fill_modes(connector, maxX, maxY);
1730         }
1731
1732         return count;
1733 }
1734
1735 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1736 {
1737         struct drm_display_mode *mode;
1738
1739         list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1740                 if (mode->hdisplay > width ||
1741                     mode->vdisplay > height)
1742                         continue;
1743                 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1744                         return mode;
1745         }
1746         return NULL;
1747 }
1748 EXPORT_SYMBOL(drm_has_preferred_mode);
1749
1750 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1751 {
1752         return fb_connector->connector->cmdline_mode.specified;
1753 }
1754
1755 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn)
1756 {
1757         struct drm_cmdline_mode *cmdline_mode;
1758         struct drm_display_mode *mode;
1759         bool prefer_non_interlace;
1760
1761         cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1762         if (cmdline_mode->specified == false)
1763                 return NULL;
1764
1765         /* attempt to find a matching mode in the list of modes
1766          *  we have gotten so far, if not add a CVT mode that conforms
1767          */
1768         if (cmdline_mode->rb || cmdline_mode->margins)
1769                 goto create_mode;
1770
1771         prefer_non_interlace = !cmdline_mode->interlace;
1772 again:
1773         list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1774                 /* check width/height */
1775                 if (mode->hdisplay != cmdline_mode->xres ||
1776                     mode->vdisplay != cmdline_mode->yres)
1777                         continue;
1778
1779                 if (cmdline_mode->refresh_specified) {
1780                         if (mode->vrefresh != cmdline_mode->refresh)
1781                                 continue;
1782                 }
1783
1784                 if (cmdline_mode->interlace) {
1785                         if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1786                                 continue;
1787                 } else if (prefer_non_interlace) {
1788                         if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1789                                 continue;
1790                 }
1791                 return mode;
1792         }
1793
1794         if (prefer_non_interlace) {
1795                 prefer_non_interlace = false;
1796                 goto again;
1797         }
1798
1799 create_mode:
1800         mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1801                                                  cmdline_mode);
1802         list_add(&mode->head, &fb_helper_conn->connector->modes);
1803         return mode;
1804 }
1805 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1806
1807 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1808 {
1809         bool enable;
1810
1811         if (strict)
1812                 enable = connector->status == connector_status_connected;
1813         else
1814                 enable = connector->status != connector_status_disconnected;
1815
1816         return enable;
1817 }
1818
1819 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1820                                   bool *enabled)
1821 {
1822         bool any_enabled = false;
1823         struct drm_connector *connector;
1824         int i = 0;
1825
1826         drm_fb_helper_for_each_connector(fb_helper, i) {
1827                 connector = fb_helper->connector_info[i]->connector;
1828                 enabled[i] = drm_connector_enabled(connector, true);
1829                 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1830                           enabled[i] ? "yes" : "no");
1831                 any_enabled |= enabled[i];
1832         }
1833
1834         if (any_enabled)
1835                 return;
1836
1837         drm_fb_helper_for_each_connector(fb_helper, i) {
1838                 connector = fb_helper->connector_info[i]->connector;
1839                 enabled[i] = drm_connector_enabled(connector, false);
1840         }
1841 }
1842
1843 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1844                               struct drm_display_mode **modes,
1845                               struct drm_fb_offset *offsets,
1846                               bool *enabled, int width, int height)
1847 {
1848         int count, i, j;
1849         bool can_clone = false;
1850         struct drm_fb_helper_connector *fb_helper_conn;
1851         struct drm_display_mode *dmt_mode, *mode;
1852
1853         /* only contemplate cloning in the single crtc case */
1854         if (fb_helper->crtc_count > 1)
1855                 return false;
1856
1857         count = 0;
1858         drm_fb_helper_for_each_connector(fb_helper, i) {
1859                 if (enabled[i])
1860                         count++;
1861         }
1862
1863         /* only contemplate cloning if more than one connector is enabled */
1864         if (count <= 1)
1865                 return false;
1866
1867         /* check the command line or if nothing common pick 1024x768 */
1868         can_clone = true;
1869         drm_fb_helper_for_each_connector(fb_helper, i) {
1870                 if (!enabled[i])
1871                         continue;
1872                 fb_helper_conn = fb_helper->connector_info[i];
1873                 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
1874                 if (!modes[i]) {
1875                         can_clone = false;
1876                         break;
1877                 }
1878                 for (j = 0; j < i; j++) {
1879                         if (!enabled[j])
1880                                 continue;
1881                         if (!drm_mode_equal(modes[j], modes[i]))
1882                                 can_clone = false;
1883                 }
1884         }
1885
1886         if (can_clone) {
1887                 DRM_DEBUG_KMS("can clone using command line\n");
1888                 return true;
1889         }
1890
1891         /* try and find a 1024x768 mode on each connector */
1892         can_clone = true;
1893         dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1894
1895         drm_fb_helper_for_each_connector(fb_helper, i) {
1896                 if (!enabled[i])
1897                         continue;
1898
1899                 fb_helper_conn = fb_helper->connector_info[i];
1900                 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1901                         if (drm_mode_equal(mode, dmt_mode))
1902                                 modes[i] = mode;
1903                 }
1904                 if (!modes[i])
1905                         can_clone = false;
1906         }
1907
1908         if (can_clone) {
1909                 DRM_DEBUG_KMS("can clone using 1024x768\n");
1910                 return true;
1911         }
1912         DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1913         return false;
1914 }
1915
1916 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1917                                 struct drm_display_mode **modes,
1918                                 struct drm_fb_offset *offsets,
1919                                 int idx,
1920                                 int h_idx, int v_idx)
1921 {
1922         struct drm_fb_helper_connector *fb_helper_conn;
1923         int i;
1924         int hoffset = 0, voffset = 0;
1925
1926         drm_fb_helper_for_each_connector(fb_helper, i) {
1927                 fb_helper_conn = fb_helper->connector_info[i];
1928                 if (!fb_helper_conn->connector->has_tile)
1929                         continue;
1930
1931                 if (!modes[i] && (h_idx || v_idx)) {
1932                         DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1933                                       fb_helper_conn->connector->base.id);
1934                         continue;
1935                 }
1936                 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1937                         hoffset += modes[i]->hdisplay;
1938
1939                 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1940                         voffset += modes[i]->vdisplay;
1941         }
1942         offsets[idx].x = hoffset;
1943         offsets[idx].y = voffset;
1944         DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1945         return 0;
1946 }
1947
1948 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1949                                  struct drm_display_mode **modes,
1950                                  struct drm_fb_offset *offsets,
1951                                  bool *enabled, int width, int height)
1952 {
1953         struct drm_fb_helper_connector *fb_helper_conn;
1954         const u64 mask = BIT_ULL(fb_helper->connector_count) - 1;
1955         u64 conn_configured = 0;
1956         int tile_pass = 0;
1957         int i;
1958
1959 retry:
1960         drm_fb_helper_for_each_connector(fb_helper, i) {
1961                 fb_helper_conn = fb_helper->connector_info[i];
1962
1963                 if (conn_configured & BIT_ULL(i))
1964                         continue;
1965
1966                 if (enabled[i] == false) {
1967                         conn_configured |= BIT_ULL(i);
1968                         continue;
1969                 }
1970
1971                 /* first pass over all the untiled connectors */
1972                 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1973                         continue;
1974
1975                 if (tile_pass == 1) {
1976                         if (fb_helper_conn->connector->tile_h_loc != 0 ||
1977                             fb_helper_conn->connector->tile_v_loc != 0)
1978                                 continue;
1979
1980                 } else {
1981                         if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1982                             fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1983                         /* if this tile_pass doesn't cover any of the tiles - keep going */
1984                                 continue;
1985
1986                         /* find the tile offsets for this pass - need
1987                            to find all tiles left and above */
1988                         drm_get_tile_offsets(fb_helper, modes, offsets,
1989                                              i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1990                 }
1991                 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1992                               fb_helper_conn->connector->base.id);
1993
1994                 /* got for command line mode first */
1995                 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
1996                 if (!modes[i]) {
1997                         DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1998                                       fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1999                         modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
2000                 }
2001                 /* No preferred modes, pick one off the list */
2002                 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
2003                         list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
2004                                 break;
2005                 }
2006                 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
2007                           "none");
2008                 conn_configured |= BIT_ULL(i);
2009         }
2010
2011         if ((conn_configured & mask) != mask) {
2012                 tile_pass++;
2013                 goto retry;
2014         }
2015         return true;
2016 }
2017
2018 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
2019                           struct drm_fb_helper_crtc **best_crtcs,
2020                           struct drm_display_mode **modes,
2021                           int n, int width, int height)
2022 {
2023         int c, o;
2024         struct drm_connector *connector;
2025         const struct drm_connector_helper_funcs *connector_funcs;
2026         struct drm_encoder *encoder;
2027         int my_score, best_score, score;
2028         struct drm_fb_helper_crtc **crtcs, *crtc;
2029         struct drm_fb_helper_connector *fb_helper_conn;
2030
2031         if (n == fb_helper->connector_count)
2032                 return 0;
2033
2034         fb_helper_conn = fb_helper->connector_info[n];
2035         connector = fb_helper_conn->connector;
2036
2037         best_crtcs[n] = NULL;
2038         best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2039         if (modes[n] == NULL)
2040                 return best_score;
2041
2042         crtcs = kzalloc(fb_helper->connector_count *
2043                         sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2044         if (!crtcs)
2045                 return best_score;
2046
2047         my_score = 1;
2048         if (connector->status == connector_status_connected)
2049                 my_score++;
2050         if (drm_has_cmdline_mode(fb_helper_conn))
2051                 my_score++;
2052         if (drm_has_preferred_mode(fb_helper_conn, width, height))
2053                 my_score++;
2054
2055         connector_funcs = connector->helper_private;
2056
2057         /*
2058          * If the DRM device implements atomic hooks and ->best_encoder() is
2059          * NULL we fallback to the default drm_atomic_helper_best_encoder()
2060          * helper.
2061          */
2062         if (drm_drv_uses_atomic_modeset(fb_helper->dev) &&
2063             !connector_funcs->best_encoder)
2064                 encoder = drm_atomic_helper_best_encoder(connector);
2065         else
2066                 encoder = connector_funcs->best_encoder(connector);
2067
2068         if (!encoder)
2069                 goto out;
2070
2071         /* select a crtc for this connector and then attempt to configure
2072            remaining connectors */
2073         for (c = 0; c < fb_helper->crtc_count; c++) {
2074                 crtc = &fb_helper->crtc_info[c];
2075
2076                 if ((encoder->possible_crtcs & (1 << c)) == 0)
2077                         continue;
2078
2079                 for (o = 0; o < n; o++)
2080                         if (best_crtcs[o] == crtc)
2081                                 break;
2082
2083                 if (o < n) {
2084                         /* ignore cloning unless only a single crtc */
2085                         if (fb_helper->crtc_count > 1)
2086                                 continue;
2087
2088                         if (!drm_mode_equal(modes[o], modes[n]))
2089                                 continue;
2090                 }
2091
2092                 crtcs[n] = crtc;
2093                 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2094                 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2095                                                   width, height);
2096                 if (score > best_score) {
2097                         best_score = score;
2098                         memcpy(best_crtcs, crtcs,
2099                                fb_helper->connector_count *
2100                                sizeof(struct drm_fb_helper_crtc *));
2101                 }
2102         }
2103 out:
2104         kfree(crtcs);
2105         return best_score;
2106 }
2107
2108 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper,
2109                             u32 width, u32 height)
2110 {
2111         struct drm_device *dev = fb_helper->dev;
2112         struct drm_fb_helper_crtc **crtcs;
2113         struct drm_display_mode **modes;
2114         struct drm_fb_offset *offsets;
2115         bool *enabled;
2116         int i;
2117
2118         DRM_DEBUG_KMS("\n");
2119         if (drm_fb_helper_probe_connector_modes(fb_helper, width, height) == 0)
2120                 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2121
2122         /* prevent concurrent modification of connector_count by hotplug */
2123         lockdep_assert_held(&fb_helper->dev->mode_config.mutex);
2124
2125         crtcs = kcalloc(fb_helper->connector_count,
2126                         sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2127         modes = kcalloc(fb_helper->connector_count,
2128                         sizeof(struct drm_display_mode *), GFP_KERNEL);
2129         offsets = kcalloc(fb_helper->connector_count,
2130                           sizeof(struct drm_fb_offset), GFP_KERNEL);
2131         enabled = kcalloc(fb_helper->connector_count,
2132                           sizeof(bool), GFP_KERNEL);
2133         if (!crtcs || !modes || !enabled || !offsets) {
2134                 DRM_ERROR("Memory allocation failed\n");
2135                 goto out;
2136         }
2137
2138         drm_enable_connectors(fb_helper, enabled);
2139
2140         if (!(fb_helper->funcs->initial_config &&
2141               fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2142                                                offsets,
2143                                                enabled, width, height))) {
2144                 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2145                 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2146                 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2147
2148                 if (!drm_target_cloned(fb_helper, modes, offsets,
2149                                        enabled, width, height) &&
2150                     !drm_target_preferred(fb_helper, modes, offsets,
2151                                           enabled, width, height))
2152                         DRM_ERROR("Unable to find initial modes\n");
2153
2154                 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2155                               width, height);
2156
2157                 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2158         }
2159
2160         /* need to set the modesets up here for use later */
2161         /* fill out the connector<->crtc mappings into the modesets */
2162         for (i = 0; i < fb_helper->crtc_count; i++)
2163                 drm_fb_helper_modeset_release(fb_helper,
2164                                               &fb_helper->crtc_info[i].mode_set);
2165
2166         drm_fb_helper_for_each_connector(fb_helper, i) {
2167                 struct drm_display_mode *mode = modes[i];
2168                 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2169                 struct drm_fb_offset *offset = &offsets[i];
2170                 struct drm_mode_set *modeset = &fb_crtc->mode_set;
2171
2172                 if (mode && fb_crtc) {
2173                         struct drm_connector *connector =
2174                                 fb_helper->connector_info[i]->connector;
2175
2176                         DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2177                                       mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2178
2179                         fb_crtc->desired_mode = mode;
2180                         fb_crtc->x = offset->x;
2181                         fb_crtc->y = offset->y;
2182                         modeset->mode = drm_mode_duplicate(dev,
2183                                                            fb_crtc->desired_mode);
2184                         drm_connector_reference(connector);
2185                         modeset->connectors[modeset->num_connectors++] = connector;
2186                         modeset->fb = fb_helper->fb;
2187                         modeset->x = offset->x;
2188                         modeset->y = offset->y;
2189                 }
2190         }
2191 out:
2192         kfree(crtcs);
2193         kfree(modes);
2194         kfree(offsets);
2195         kfree(enabled);
2196 }
2197
2198 /**
2199  * drm_fb_helper_initial_config - setup a sane initial connector configuration
2200  * @fb_helper: fb_helper device struct
2201  * @bpp_sel: bpp value to use for the framebuffer configuration
2202  *
2203  * Scans the CRTCs and connectors and tries to put together an initial setup.
2204  * At the moment, this is a cloned configuration across all heads with
2205  * a new framebuffer object as the backing store.
2206  *
2207  * Note that this also registers the fbdev and so allows userspace to call into
2208  * the driver through the fbdev interfaces.
2209  *
2210  * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2211  * to let the driver allocate and initialize the fbdev info structure and the
2212  * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2213  * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2214  * 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, int bpp_sel)
2241 {
2242         struct drm_device *dev = fb_helper->dev;
2243         struct fb_info *info;
2244         int ret;
2245
2246         if (!drm_fbdev_emulation)
2247                 return 0;
2248
2249         mutex_lock(&dev->mode_config.mutex);
2250         drm_setup_crtcs(fb_helper,
2251                         dev->mode_config.max_width,
2252                         dev->mode_config.max_height);
2253         ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2254         mutex_unlock(&dev->mode_config.mutex);
2255         if (ret)
2256                 return ret;
2257
2258         info = fb_helper->fbdev;
2259         info->var.pixclock = 0;
2260         ret = register_framebuffer(info);
2261         if (ret < 0)
2262                 return ret;
2263
2264         dev_info(dev->dev, "fb%d: %s frame buffer device\n",
2265                  info->node, info->fix.id);
2266
2267         mutex_lock(&kernel_fb_helper_lock);
2268         if (list_empty(&kernel_fb_helper_list))
2269                 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2270
2271         list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2272         mutex_unlock(&kernel_fb_helper_lock);
2273
2274         return 0;
2275 }
2276 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2277
2278 /**
2279  * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2280  *                               probing all the outputs attached to the fb
2281  * @fb_helper: the drm_fb_helper
2282  *
2283  * Scan the connectors attached to the fb_helper and try to put together a
2284  * setup after notification of a change in output configuration.
2285  *
2286  * Called at runtime, takes the mode config locks to be able to check/change the
2287  * modeset configuration. Must be run from process context (which usually means
2288  * either the output polling work or a work item launched from the driver's
2289  * hotplug interrupt).
2290  *
2291  * Note that drivers may call this even before calling
2292  * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2293  * for a race-free fbcon setup and will make sure that the fbdev emulation will
2294  * not miss any hotplug events.
2295  *
2296  * RETURNS:
2297  * 0 on success and a non-zero error code otherwise.
2298  */
2299 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2300 {
2301         struct drm_device *dev = fb_helper->dev;
2302
2303         if (!drm_fbdev_emulation)
2304                 return 0;
2305
2306         mutex_lock(&dev->mode_config.mutex);
2307         if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2308                 fb_helper->delayed_hotplug = true;
2309                 mutex_unlock(&dev->mode_config.mutex);
2310                 return 0;
2311         }
2312         DRM_DEBUG_KMS("\n");
2313
2314         drm_setup_crtcs(fb_helper, fb_helper->fb->width, fb_helper->fb->height);
2315
2316         mutex_unlock(&dev->mode_config.mutex);
2317
2318         drm_fb_helper_set_par(fb_helper->fbdev);
2319
2320         return 0;
2321 }
2322 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2323
2324 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2325  * but the module doesn't depend on any fb console symbols.  At least
2326  * attempt to load fbcon to avoid leaving the system without a usable console.
2327  */
2328 int __init drm_fb_helper_modinit(void)
2329 {
2330 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2331         const char *name = "fbcon";
2332         struct module *fbcon;
2333
2334         mutex_lock(&module_mutex);
2335         fbcon = find_module(name);
2336         mutex_unlock(&module_mutex);
2337
2338         if (!fbcon)
2339                 request_module_nowait(name);
2340 #endif
2341         return 0;
2342 }
2343 EXPORT_SYMBOL(drm_fb_helper_modinit);