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 <airlied@linux.ie>
   5  *
   6  * DRM framebuffer helper functions
   7  *
   8  * Permission to use, copy, modify, distribute, and sell this software and its
   9  * documentation for any purpose is hereby granted without fee, provided that
  10  * the above copyright notice appear in all copies and that both that copyright
  11  * notice and this permission notice appear in supporting documentation, and
  12  * that the name of the copyright holders not be used in advertising or
  13  * publicity pertaining to distribution of the software without specific,
  14  * written prior permission.  The copyright holders make no representations
  15  * about the suitability of this software for any purpose.  It is provided "as
  16  * is" without express or implied warranty.
  17  *
  18  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  19  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  20  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  22  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  23  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * Authors:
  27  *      Dave Airlie <airlied@linux.ie>
  28  *      Jesse Barnes <jesse.barnes@intel.com>
  29  */
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/kernel.h>
  33 #include <linux/sysrq.h>
  34 #include <linux/slab.h>
  35 #include <linux/fb.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
  42 static LIST_HEAD(kernel_fb_helper_list);
  43
  44 /**
  45  * DOC: fbdev helpers
  46  *
  47  * The fb helper functions are useful to provide an fbdev on top of a drm kernel
  48  * mode setting driver. They can be used mostly independently from the crtc
  49  * helper functions used by many drivers to implement the kernel mode setting
  50  * interfaces.
  51  *
  52  * Initialization is done as a four-step process with drm_fb_helper_prepare(),
  53  * drm_fb_helper_init(), drm_fb_helper_single_add_all_connectors() and
  54  * drm_fb_helper_initial_config(). Drivers with fancier requirements than the
  55  * default behaviour can override the third step with their own code.
  56  * Teardown is done with drm_fb_helper_fini().
  57  *
  58  * At runtime drivers should restore the fbdev console by calling
  59  * drm_fb_helper_restore_fbdev_mode() from their ->lastclose callback. They
  60  * should also notify the fb helper code from updates to the output
  61  * configuration by calling drm_fb_helper_hotplug_event(). For easier
  62  * integration with the output polling code in drm_crtc_helper.c the modeset
  63  * code provides a ->output_poll_changed callback.
  64  *
  65  * All other functions exported by the fb helper library can be used to
  66  * implement the fbdev driver interface by the driver.
  67  *
  68  * It is possible, though perhaps somewhat tricky, to implement race-free
  69  * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
  70  * helper must be called first to initialize the minimum required to make
  71  * hotplug detection work. Drivers also need to make sure to properly set up
  72  * the dev->mode_config.funcs member. After calling drm_kms_helper_poll_init()
  73  * it is safe to enable interrupts and start processing hotplug events. At the
  74  * same time, drivers should initialize all modeset objects such as CRTCs,
  75  * encoders and connectors. To finish up the fbdev helper initialization, the
  76  * drm_fb_helper_init() function is called. To probe for all attached displays
  77  * and set up an initial configuration using the detected hardware, drivers
  78  * should call drm_fb_helper_single_add_all_connectors() followed by
  79  * drm_fb_helper_initial_config().
  80  */
  81
  82 /**
  83  * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
  84  *                                             emulation helper
  85  * @fb_helper: fbdev initialized with drm_fb_helper_init
  86  *
  87  * This functions adds all the available connectors for use with the given
  88  * fb_helper. This is a separate step to allow drivers to freely assign
  89  * connectors to the fbdev, e.g. if some are reserved for special purposes or
  90  * not adequate to be used for the fbcon.
  91  *
  92  * This function is protected against concurrent connector hotadds/removals
  93  * using drm_fb_helper_add_one_connector() and
  94  * drm_fb_helper_remove_one_connector().
  95  */
  96 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
  97 {
  98         struct drm_device *dev = fb_helper->dev;
  99         struct drm_connector *connector;
 100         int i;
 101
 102         mutex_lock(&dev->mode_config.mutex);
 103         drm_for_each_connector(connector, dev) {
 104                 struct drm_fb_helper_connector *fb_helper_connector;
 105
 106                 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
 107                 if (!fb_helper_connector)
 108                         goto fail;
 109
 110                 fb_helper_connector->connector = connector;
 111                 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
 112         }
 113         mutex_unlock(&dev->mode_config.mutex);
 114         return 0;
 115 fail:
 116         for (i = 0; i < fb_helper->connector_count; i++) {
 117                 kfree(fb_helper->connector_info[i]);
 118                 fb_helper->connector_info[i] = NULL;
 119         }
 120         fb_helper->connector_count = 0;
 121         mutex_unlock(&dev->mode_config.mutex);
 122
 123         return -ENOMEM;
 124 }
 125 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
 126
 127 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
 128 {
 129         struct drm_fb_helper_connector **temp;
 130         struct drm_fb_helper_connector *fb_helper_connector;
 131
 132         WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
 133         if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
 134                 temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
 135                 if (!temp)
 136                         return -ENOMEM;
 137
 138                 fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
 139                 fb_helper->connector_info = temp;
 140         }
 141
 142
 143         fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
 144         if (!fb_helper_connector)
 145                 return -ENOMEM;
 146
 147         fb_helper_connector->connector = connector;
 148         fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
 149         return 0;
 150 }
 151 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
 152
 153 static void remove_from_modeset(struct drm_mode_set *set,
 154                 struct drm_connector *connector)
 155 {
 156         int i, j;
 157
 158         for (i = 0; i < set->num_connectors; i++) {
 159                 if (set->connectors[i] == connector)
 160                         break;
 161         }
 162
 163         if (i == set->num_connectors)
 164                 return;
 165
 166         for (j = i + 1; j < set->num_connectors; j++) {
 167                 set->connectors[j - 1] = set->connectors[j];
 168         }
 169         set->num_connectors--;
 170
 171         /* because i915 is pissy about this..
 172          * TODO maybe need to makes sure we set it back to !=NULL somewhere?
 173          */
 174         if (set->num_connectors == 0)
 175                 set->fb = NULL;
 176 }
 177
 178 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
 179                                        struct drm_connector *connector)
 180 {
 181         struct drm_fb_helper_connector *fb_helper_connector;
 182         int i, j;
 183
 184         WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
 185
 186         for (i = 0; i < fb_helper->connector_count; i++) {
 187                 if (fb_helper->connector_info[i]->connector == connector)
 188                         break;
 189         }
 190
 191         if (i == fb_helper->connector_count)
 192                 return -EINVAL;
 193         fb_helper_connector = fb_helper->connector_info[i];
 194
 195         for (j = i + 1; j < fb_helper->connector_count; j++) {
 196                 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
 197         }
 198         fb_helper->connector_count--;
 199         kfree(fb_helper_connector);
 200
 201         /* also cleanup dangling references to the connector: */
 202         for (i = 0; i < fb_helper->crtc_count; i++)
 203                 remove_from_modeset(&fb_helper->crtc_info[i].mode_set, connector);
 204
 205         return 0;
 206 }
 207 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
 208
 209 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
 210 {
 211         uint16_t *r_base, *g_base, *b_base;
 212         int i;
 213
 214         if (helper->funcs->gamma_get == NULL)
 215                 return;
 216
 217         r_base = crtc->gamma_store;
 218         g_base = r_base + crtc->gamma_size;
 219         b_base = g_base + crtc->gamma_size;
 220
 221         for (i = 0; i < crtc->gamma_size; i++)
 222                 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
 223 }
 224
 225 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
 226 {
 227         uint16_t *r_base, *g_base, *b_base;
 228
 229         if (crtc->funcs->gamma_set == NULL)
 230                 return;
 231
 232         r_base = crtc->gamma_store;
 233         g_base = r_base + crtc->gamma_size;
 234         b_base = g_base + crtc->gamma_size;
 235
 236         crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
 237 }
 238
 239 /**
 240  * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
 241  * @info: fbdev registered by the helper
 242  */
 243 int drm_fb_helper_debug_enter(struct fb_info *info)
 244 {
 245         struct drm_fb_helper *helper = info->par;
 246         const struct drm_crtc_helper_funcs *funcs;
 247         int i;
 248
 249         list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
 250                 for (i = 0; i < helper->crtc_count; i++) {
 251                         struct drm_mode_set *mode_set =
 252                                 &helper->crtc_info[i].mode_set;
 253
 254                         if (!mode_set->crtc->enabled)
 255                                 continue;
 256
 257                         funcs = mode_set->crtc->helper_private;
 258                         drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
 259                         funcs->mode_set_base_atomic(mode_set->crtc,
 260                                                     mode_set->fb,
 261                                                     mode_set->x,
 262                                                     mode_set->y,
 263                                                     ENTER_ATOMIC_MODE_SET);
 264                 }
 265         }
 266
 267         return 0;
 268 }
 269 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
 270
 271 /* Find the real fb for a given fb helper CRTC */
 272 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
 273 {
 274         struct drm_device *dev = crtc->dev;
 275         struct drm_crtc *c;
 276
 277         drm_for_each_crtc(c, dev) {
 278                 if (crtc->base.id == c->base.id)
 279                         return c->primary->fb;
 280         }
 281
 282         return NULL;
 283 }
 284
 285 /**
 286  * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
 287  * @info: fbdev registered by the helper
 288  */
 289 int drm_fb_helper_debug_leave(struct fb_info *info)
 290 {
 291         struct drm_fb_helper *helper = info->par;
 292         struct drm_crtc *crtc;
 293         const struct drm_crtc_helper_funcs *funcs;
 294         struct drm_framebuffer *fb;
 295         int i;
 296
 297         for (i = 0; i < helper->crtc_count; i++) {
 298                 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
 299                 crtc = mode_set->crtc;
 300                 funcs = crtc->helper_private;
 301                 fb = drm_mode_config_fb(crtc);
 302
 303                 if (!crtc->enabled)
 304                         continue;
 305
 306                 if (!fb) {
 307                         DRM_ERROR("no fb to restore??\n");
 308                         continue;
 309                 }
 310
 311                 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
 312                 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
 313                                             crtc->y, LEAVE_ATOMIC_MODE_SET);
 314         }
 315
 316         return 0;
 317 }
 318 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
 319
 320 static bool restore_fbdev_mode(struct drm_fb_helper *fb_helper)
 321 {
 322         struct drm_device *dev = fb_helper->dev;
 323         struct drm_plane *plane;
 324         bool error = false;
 325         int i;
 326
 327         drm_warn_on_modeset_not_all_locked(dev);
 328
 329         drm_for_each_plane(plane, dev) {
 330                 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
 331                         drm_plane_force_disable(plane);
 332
 333                 if (dev->mode_config.rotation_property) {
 334                         drm_mode_plane_set_obj_prop(plane,
 335                                                     dev->mode_config.rotation_property,
 336                                                     BIT(DRM_ROTATE_0));
 337                 }
 338         }
 339
 340         for (i = 0; i < fb_helper->crtc_count; i++) {
 341                 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
 342                 struct drm_crtc *crtc = mode_set->crtc;
 343                 int ret;
 344
 345                 if (crtc->funcs->cursor_set) {
 346                         ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
 347                         if (ret)
 348                                 error = true;
 349                 }
 350
 351                 ret = drm_mode_set_config_internal(mode_set);
 352                 if (ret)
 353                         error = true;
 354         }
 355         return error;
 356 }
 357 /**
 358  * drm_fb_helper_restore_fbdev_mode - restore fbdev configuration
 359  * @fb_helper: fbcon to restore
 360  *
 361  * This should be called from driver's drm ->lastclose callback
 362  * when implementing an fbcon on top of kms using this helper. This ensures that
 363  * the user isn't greeted with a black screen when e.g. X dies.
 364  *
 365  * Use this variant if you need to bypass locking (panic), or already
 366  * hold all modeset locks.  Otherwise use drm_fb_helper_restore_fbdev_mode_unlocked()
 367  */
 368 static bool drm_fb_helper_restore_fbdev_mode(struct drm_fb_helper *fb_helper)
 369 {
 370         return restore_fbdev_mode(fb_helper);
 371 }
 372
 373 /**
 374  * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
 375  * @fb_helper: fbcon to restore
 376  *
 377  * This should be called from driver's drm ->lastclose callback
 378  * when implementing an fbcon on top of kms using this helper. This ensures that
 379  * the user isn't greeted with a black screen when e.g. X dies.
 380  */
 381 bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
 382 {
 383         struct drm_device *dev = fb_helper->dev;
 384         bool ret;
 385         bool do_delayed = false;
 386
 387         drm_modeset_lock_all(dev);
 388         ret = restore_fbdev_mode(fb_helper);
 389
 390         do_delayed = fb_helper->delayed_hotplug;
 391         if (do_delayed)
 392                 fb_helper->delayed_hotplug = false;
 393         drm_modeset_unlock_all(dev);
 394
 395         if (do_delayed)
 396                 drm_fb_helper_hotplug_event(fb_helper);
 397         return ret;
 398 }
 399 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
 400
 401 /*
 402  * restore fbcon display for all kms driver's using this helper, used for sysrq
 403  * and panic handling.
 404  */
 405 static bool drm_fb_helper_force_kernel_mode(void)
 406 {
 407         bool ret, error = false;
 408         struct drm_fb_helper *helper;
 409
 410         if (list_empty(&kernel_fb_helper_list))
 411                 return false;
 412
 413         list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
 414                 struct drm_device *dev = helper->dev;
 415
 416                 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
 417                         continue;
 418
 419                 /*
 420                  * NOTE: Use trylock mode to avoid deadlocks and sleeping in
 421                  * panic context.
 422                  */
 423                 if (__drm_modeset_lock_all(dev, true) != 0) {
 424                         error = true;
 425                         continue;
 426                 }
 427
 428                 ret = drm_fb_helper_restore_fbdev_mode(helper);
 429                 if (ret)
 430                         error = true;
 431
 432                 drm_modeset_unlock_all(dev);
 433         }
 434         return error;
 435 }
 436
 437 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
 438 {
 439         struct drm_device *dev = fb_helper->dev;
 440         struct drm_crtc *crtc;
 441         int bound = 0, crtcs_bound = 0;
 442
 443         /* Sometimes user space wants everything disabled, so don't steal the
 444          * display if there's a master. */
 445         if (dev->primary->master)
 446                 return false;
 447
 448         drm_for_each_crtc(crtc, dev) {
 449                 if (crtc->primary->fb)
 450                         crtcs_bound++;
 451                 if (crtc->primary->fb == fb_helper->fb)
 452                         bound++;
 453         }
 454
 455         if (bound < crtcs_bound)
 456                 return false;
 457
 458         return true;
 459 }
 460
 461 #ifdef CONFIG_MAGIC_SYSRQ
 462 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
 463 {
 464         bool ret;
 465         ret = drm_fb_helper_force_kernel_mode();
 466         if (ret == true)
 467                 DRM_ERROR("Failed to restore crtc configuration\n");
 468 }
 469 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
 470
 471 static void drm_fb_helper_sysrq(int dummy1)
 472 {
 473         schedule_work(&drm_fb_helper_restore_work);
 474 }
 475
 476 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
 477         .handler = drm_fb_helper_sysrq,
 478         .help_msg = "force-fb(V)",
 479         .action_msg = "Restore framebuffer console",
 480 };
 481 #else
 482 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
 483 #endif
 484
 485 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
 486 {
 487         struct drm_fb_helper *fb_helper = info->par;
 488         struct drm_device *dev = fb_helper->dev;
 489         struct drm_crtc *crtc;
 490         struct drm_connector *connector;
 491         int i, j;
 492
 493         /*
 494          * fbdev->blank can be called from irq context in case of a panic.
 495          * Since we already have our own special panic handler which will
 496          * restore the fbdev console mode completely, just bail out early.
 497          */
 498         if (oops_in_progress)
 499                 return;
 500
 501         /*
 502          * For each CRTC in this fb, turn the connectors on/off.
 503          */
 504         drm_modeset_lock_all(dev);
 505         if (!drm_fb_helper_is_bound(fb_helper)) {
 506                 drm_modeset_unlock_all(dev);
 507                 return;
 508         }
 509
 510         for (i = 0; i < fb_helper->crtc_count; i++) {
 511                 crtc = fb_helper->crtc_info[i].mode_set.crtc;
 512
 513                 if (!crtc->enabled)
 514                         continue;
 515
 516                 /* Walk the connectors & encoders on this fb turning them on/off */
 517                 for (j = 0; j < fb_helper->connector_count; j++) {
 518                         connector = fb_helper->connector_info[j]->connector;
 519                         connector->funcs->dpms(connector, dpms_mode);
 520                         drm_object_property_set_value(&connector->base,
 521                                 dev->mode_config.dpms_property, dpms_mode);
 522                 }
 523         }
 524         drm_modeset_unlock_all(dev);
 525 }
 526
 527 /**
 528  * drm_fb_helper_blank - implementation for ->fb_blank
 529  * @blank: desired blanking state
 530  * @info: fbdev registered by the helper
 531  */
 532 int drm_fb_helper_blank(int blank, struct fb_info *info)
 533 {
 534         switch (blank) {
 535         /* Display: On; HSync: On, VSync: On */
 536         case FB_BLANK_UNBLANK:
 537                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
 538                 break;
 539         /* Display: Off; HSync: On, VSync: On */
 540         case FB_BLANK_NORMAL:
 541                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
 542                 break;
 543         /* Display: Off; HSync: Off, VSync: On */
 544         case FB_BLANK_HSYNC_SUSPEND:
 545                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
 546                 break;
 547         /* Display: Off; HSync: On, VSync: Off */
 548         case FB_BLANK_VSYNC_SUSPEND:
 549                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
 550                 break;
 551         /* Display: Off; HSync: Off, VSync: Off */
 552         case FB_BLANK_POWERDOWN:
 553                 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
 554                 break;
 555         }
 556         return 0;
 557 }
 558 EXPORT_SYMBOL(drm_fb_helper_blank);
 559
 560 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
 561 {
 562         int i;
 563
 564         for (i = 0; i < helper->connector_count; i++)
 565                 kfree(helper->connector_info[i]);
 566         kfree(helper->connector_info);
 567         for (i = 0; i < helper->crtc_count; i++) {
 568                 kfree(helper->crtc_info[i].mode_set.connectors);
 569                 if (helper->crtc_info[i].mode_set.mode)
 570                         drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
 571         }
 572         kfree(helper->crtc_info);
 573 }
 574
 575 /**
 576  * drm_fb_helper_prepare - setup a drm_fb_helper structure
 577  * @dev: DRM device
 578  * @helper: driver-allocated fbdev helper structure to set up
 579  * @funcs: pointer to structure of functions associate with this helper
 580  *
 581  * Sets up the bare minimum to make the framebuffer helper usable. This is
 582  * useful to implement race-free initialization of the polling helpers.
 583  */
 584 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
 585                            const struct drm_fb_helper_funcs *funcs)
 586 {
 587         INIT_LIST_HEAD(&helper->kernel_fb_list);
 588         helper->funcs = funcs;
 589         helper->dev = dev;
 590 }
 591 EXPORT_SYMBOL(drm_fb_helper_prepare);
 592
 593 /**
 594  * drm_fb_helper_init - initialize a drm_fb_helper structure
 595  * @dev: drm device
 596  * @fb_helper: driver-allocated fbdev helper structure to initialize
 597  * @crtc_count: maximum number of crtcs to support in this fbdev emulation
 598  * @max_conn_count: max connector count
 599  *
 600  * This allocates the structures for the fbdev helper with the given limits.
 601  * Note that this won't yet touch the hardware (through the driver interfaces)
 602  * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
 603  * to allow driver writes more control over the exact init sequence.
 604  *
 605  * Drivers must call drm_fb_helper_prepare() before calling this function.
 606  *
 607  * RETURNS:
 608  * Zero if everything went ok, nonzero otherwise.
 609  */
 610 int drm_fb_helper_init(struct drm_device *dev,
 611                        struct drm_fb_helper *fb_helper,
 612                        int crtc_count, int max_conn_count)
 613 {
 614         struct drm_crtc *crtc;
 615         int i;
 616
 617         if (!max_conn_count)
 618                 return -EINVAL;
 619
 620         fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
 621         if (!fb_helper->crtc_info)
 622                 return -ENOMEM;
 623
 624         fb_helper->crtc_count = crtc_count;
 625         fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
 626         if (!fb_helper->connector_info) {
 627                 kfree(fb_helper->crtc_info);
 628                 return -ENOMEM;
 629         }
 630         fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
 631         fb_helper->connector_count = 0;
 632
 633         for (i = 0; i < crtc_count; i++) {
 634                 fb_helper->crtc_info[i].mode_set.connectors =
 635                         kcalloc(max_conn_count,
 636                                 sizeof(struct drm_connector *),
 637                                 GFP_KERNEL);
 638
 639                 if (!fb_helper->crtc_info[i].mode_set.connectors)
 640                         goto out_free;
 641                 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
 642         }
 643
 644         i = 0;
 645         drm_for_each_crtc(crtc, dev) {
 646                 fb_helper->crtc_info[i].mode_set.crtc = crtc;
 647                 i++;
 648         }
 649
 650         return 0;
 651 out_free:
 652         drm_fb_helper_crtc_free(fb_helper);
 653         return -ENOMEM;
 654 }
 655 EXPORT_SYMBOL(drm_fb_helper_init);
 656
 657 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
 658 {
 659         if (!list_empty(&fb_helper->kernel_fb_list)) {
 660                 list_del(&fb_helper->kernel_fb_list);
 661                 if (list_empty(&kernel_fb_helper_list)) {
 662                         unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
 663                 }
 664         }
 665
 666         drm_fb_helper_crtc_free(fb_helper);
 667
 668 }
 669 EXPORT_SYMBOL(drm_fb_helper_fini);
 670
 671 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
 672                      u16 blue, u16 regno, struct fb_info *info)
 673 {
 674         struct drm_fb_helper *fb_helper = info->par;
 675         struct drm_framebuffer *fb = fb_helper->fb;
 676         int pindex;
 677
 678         if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
 679                 u32 *palette;
 680                 u32 value;
 681                 /* place color in psuedopalette */
 682                 if (regno > 16)
 683                         return -EINVAL;
 684                 palette = (u32 *)info->pseudo_palette;
 685                 red >>= (16 - info->var.red.length);
 686                 green >>= (16 - info->var.green.length);
 687                 blue >>= (16 - info->var.blue.length);
 688                 value = (red << info->var.red.offset) |
 689                         (green << info->var.green.offset) |
 690                         (blue << info->var.blue.offset);
 691                 if (info->var.transp.length > 0) {
 692                         u32 mask = (1 << info->var.transp.length) - 1;
 693                         mask <<= info->var.transp.offset;
 694                         value |= mask;
 695                 }
 696                 palette[regno] = value;
 697                 return 0;
 698         }
 699
 700         /*
 701          * The driver really shouldn't advertise pseudo/directcolor
 702          * visuals if it can't deal with the palette.
 703          */
 704         if (WARN_ON(!fb_helper->funcs->gamma_set ||
 705                     !fb_helper->funcs->gamma_get))
 706                 return -EINVAL;
 707
 708         pindex = regno;
 709
 710         if (fb->bits_per_pixel == 16) {
 711                 pindex = regno << 3;
 712
 713                 if (fb->depth == 16 && regno > 63)
 714                         return -EINVAL;
 715                 if (fb->depth == 15 && regno > 31)
 716                         return -EINVAL;
 717
 718                 if (fb->depth == 16) {
 719                         u16 r, g, b;
 720                         int i;
 721                         if (regno < 32) {
 722                                 for (i = 0; i < 8; i++)
 723                                         fb_helper->funcs->gamma_set(crtc, red,
 724                                                 green, blue, pindex + i);
 725                         }
 726
 727                         fb_helper->funcs->gamma_get(crtc, &r,
 728                                                     &g, &b,
 729                                                     pindex >> 1);
 730
 731                         for (i = 0; i < 4; i++)
 732                                 fb_helper->funcs->gamma_set(crtc, r,
 733                                                             green, b,
 734                                                             (pindex >> 1) + i);
 735                 }
 736         }
 737
 738         if (fb->depth != 16)
 739                 fb_helper->funcs->gamma_set(crtc, red, green, blue, pindex);
 740         return 0;
 741 }
 742
 743 /**
 744  * drm_fb_helper_setcmap - implementation for ->fb_setcmap
 745  * @cmap: cmap to set
 746  * @info: fbdev registered by the helper
 747  */
 748 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
 749 {
 750         struct drm_fb_helper *fb_helper = info->par;
 751         struct drm_device *dev = fb_helper->dev;
 752         const struct drm_crtc_helper_funcs *crtc_funcs;
 753         u16 *red, *green, *blue, *transp;
 754         struct drm_crtc *crtc;
 755         int i, j, rc = 0;
 756         int start;
 757
 758         if (__drm_modeset_lock_all(dev, !!oops_in_progress)) {
 759                 return -EBUSY;
 760         }
 761         if (!drm_fb_helper_is_bound(fb_helper)) {
 762                 drm_modeset_unlock_all(dev);
 763                 return -EBUSY;
 764         }
 765
 766         for (i = 0; i < fb_helper->crtc_count; i++) {
 767                 crtc = fb_helper->crtc_info[i].mode_set.crtc;
 768                 crtc_funcs = crtc->helper_private;
 769
 770                 red = cmap->red;
 771                 green = cmap->green;
 772                 blue = cmap->blue;
 773                 transp = cmap->transp;
 774                 start = cmap->start;
 775
 776                 for (j = 0; j < cmap->len; j++) {
 777                         u16 hred, hgreen, hblue, htransp = 0xffff;
 778
 779                         hred = *red++;
 780                         hgreen = *green++;
 781                         hblue = *blue++;
 782
 783                         if (transp)
 784                                 htransp = *transp++;
 785
 786                         rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
 787                         if (rc)
 788                                 goto out;
 789                 }
 790                 if (crtc_funcs->load_lut)
 791                         crtc_funcs->load_lut(crtc);
 792         }
 793  out:
 794         drm_modeset_unlock_all(dev);
 795         return rc;
 796 }
 797 EXPORT_SYMBOL(drm_fb_helper_setcmap);
 798
 799 /**
 800  * drm_fb_helper_check_var - implementation for ->fb_check_var
 801  * @var: screeninfo to check
 802  * @info: fbdev registered by the helper
 803  */
 804 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
 805                             struct fb_info *info)
 806 {
 807         struct drm_fb_helper *fb_helper = info->par;
 808         struct drm_framebuffer *fb = fb_helper->fb;
 809         int depth;
 810
 811         if (var->pixclock != 0 || in_dbg_master())
 812                 return -EINVAL;
 813
 814         /* Need to resize the fb object !!! */
 815         if (var->bits_per_pixel > fb->bits_per_pixel ||
 816             var->xres > fb->width || var->yres > fb->height ||
 817             var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
 818                 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
 819                           "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
 820                           var->xres, var->yres, var->bits_per_pixel,
 821                           var->xres_virtual, var->yres_virtual,
 822                           fb->width, fb->height, fb->bits_per_pixel);
 823                 return -EINVAL;
 824         }
 825
 826         switch (var->bits_per_pixel) {
 827         case 16:
 828                 depth = (var->green.length == 6) ? 16 : 15;
 829                 break;
 830         case 32:
 831                 depth = (var->transp.length > 0) ? 32 : 24;
 832                 break;
 833         default:
 834                 depth = var->bits_per_pixel;
 835                 break;
 836         }
 837
 838         switch (depth) {
 839         case 8:
 840                 var->red.offset = 0;
 841                 var->green.offset = 0;
 842                 var->blue.offset = 0;
 843                 var->red.length = 8;
 844                 var->green.length = 8;
 845                 var->blue.length = 8;
 846                 var->transp.length = 0;
 847                 var->transp.offset = 0;
 848                 break;
 849         case 15:
 850                 var->red.offset = 10;
 851                 var->green.offset = 5;
 852                 var->blue.offset = 0;
 853                 var->red.length = 5;
 854                 var->green.length = 5;
 855                 var->blue.length = 5;
 856                 var->transp.length = 1;
 857                 var->transp.offset = 15;
 858                 break;
 859         case 16:
 860                 var->red.offset = 11;
 861                 var->green.offset = 5;
 862                 var->blue.offset = 0;
 863                 var->red.length = 5;
 864                 var->green.length = 6;
 865                 var->blue.length = 5;
 866                 var->transp.length = 0;
 867                 var->transp.offset = 0;
 868                 break;
 869         case 24:
 870                 var->red.offset = 16;
 871                 var->green.offset = 8;
 872                 var->blue.offset = 0;
 873                 var->red.length = 8;
 874                 var->green.length = 8;
 875                 var->blue.length = 8;
 876                 var->transp.length = 0;
 877                 var->transp.offset = 0;
 878                 break;
 879         case 32:
 880                 var->red.offset = 16;
 881                 var->green.offset = 8;
 882                 var->blue.offset = 0;
 883                 var->red.length = 8;
 884                 var->green.length = 8;
 885                 var->blue.length = 8;
 886                 var->transp.length = 8;
 887                 var->transp.offset = 24;
 888                 break;
 889         default:
 890                 return -EINVAL;
 891         }
 892         return 0;
 893 }
 894 EXPORT_SYMBOL(drm_fb_helper_check_var);
 895
 896 /**
 897  * drm_fb_helper_set_par - implementation for ->fb_set_par
 898  * @info: fbdev registered by the helper
 899  *
 900  * This will let fbcon do the mode init and is called at initialization time by
 901  * the fbdev core when registering the driver, and later on through the hotplug
 902  * callback.
 903  */
 904 int drm_fb_helper_set_par(struct fb_info *info)
 905 {
 906         struct drm_fb_helper *fb_helper = info->par;
 907         struct fb_var_screeninfo *var = &info->var;
 908
 909         if (var->pixclock != 0) {
 910                 DRM_ERROR("PIXEL CLOCK SET\n");
 911                 return -EINVAL;
 912         }
 913
 914         drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
 915
 916         return 0;
 917 }
 918 EXPORT_SYMBOL(drm_fb_helper_set_par);
 919
 920 /**
 921  * drm_fb_helper_pan_display - implementation for ->fb_pan_display
 922  * @var: updated screen information
 923  * @info: fbdev registered by the helper
 924  */
 925 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
 926                               struct fb_info *info)
 927 {
 928         struct drm_fb_helper *fb_helper = info->par;
 929         struct drm_device *dev = fb_helper->dev;
 930         struct drm_mode_set *modeset;
 931         int ret = 0;
 932         int i;
 933
 934         if (__drm_modeset_lock_all(dev, !!oops_in_progress)) {
 935                 return -EBUSY;
 936         }
 937         if (!drm_fb_helper_is_bound(fb_helper)) {
 938                 drm_modeset_unlock_all(dev);
 939                 return -EBUSY;
 940         }
 941
 942         for (i = 0; i < fb_helper->crtc_count; i++) {
 943                 modeset = &fb_helper->crtc_info[i].mode_set;
 944
 945                 modeset->x = var->xoffset;
 946                 modeset->y = var->yoffset;
 947
 948                 if (modeset->num_connectors) {
 949                         ret = drm_mode_set_config_internal(modeset);
 950                         if (!ret) {
 951                                 info->var.xoffset = var->xoffset;
 952                                 info->var.yoffset = var->yoffset;
 953                         }
 954                 }
 955         }
 956         drm_modeset_unlock_all(dev);
 957         return ret;
 958 }
 959 EXPORT_SYMBOL(drm_fb_helper_pan_display);
 960
 961 /*
 962  * Allocates the backing storage and sets up the fbdev info structure through
 963  * the ->fb_probe callback and then registers the fbdev and sets up the panic
 964  * notifier.
 965  */
 966 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
 967                                          int preferred_bpp)
 968 {
 969         int ret = 0;
 970         int crtc_count = 0;
 971         int i;
 972         struct fb_info *info;
 973         struct drm_fb_helper_surface_size sizes;
 974         int gamma_size = 0;
 975
 976         memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
 977         sizes.surface_depth = 24;
 978         sizes.surface_bpp = 32;
 979         sizes.fb_width = (unsigned)-1;
 980         sizes.fb_height = (unsigned)-1;
 981
 982         /* if driver picks 8 or 16 by default use that
 983            for both depth/bpp */
 984         if (preferred_bpp != sizes.surface_bpp)
 985                 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
 986
 987         /* first up get a count of crtcs now in use and new min/maxes width/heights */
 988         for (i = 0; i < fb_helper->connector_count; i++) {
 989                 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
 990                 struct drm_cmdline_mode *cmdline_mode;
 991
 992                 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
 993
 994                 if (cmdline_mode->bpp_specified) {
 995                         switch (cmdline_mode->bpp) {
 996                         case 8:
 997                                 sizes.surface_depth = sizes.surface_bpp = 8;
 998                                 break;
 999                         case 15:
1000                                 sizes.surface_depth = 15;
1001                                 sizes.surface_bpp = 16;
1002                                 break;
1003                         case 16:
1004                                 sizes.surface_depth = sizes.surface_bpp = 16;
1005                                 break;
1006                         case 24:
1007                                 sizes.surface_depth = sizes.surface_bpp = 24;
1008                                 break;
1009                         case 32:
1010                                 sizes.surface_depth = 24;
1011                                 sizes.surface_bpp = 32;
1012                                 break;
1013                         }
1014                         break;
1015                 }
1016         }
1017
1018         crtc_count = 0;
1019         for (i = 0; i < fb_helper->crtc_count; i++) {
1020                 struct drm_display_mode *desired_mode;
1021                 struct drm_mode_set *mode_set;
1022                 int x, y, j;
1023                 /* in case of tile group, are we the last tile vert or horiz?
1024                  * If no tile group you are always the last one both vertically
1025                  * and horizontally
1026                  */
1027                 bool lastv = true, lasth = true;
1028
1029                 desired_mode = fb_helper->crtc_info[i].desired_mode;
1030                 mode_set = &fb_helper->crtc_info[i].mode_set;
1031
1032                 if (!desired_mode)
1033                         continue;
1034
1035                 crtc_count++;
1036
1037                 x = fb_helper->crtc_info[i].x;
1038                 y = fb_helper->crtc_info[i].y;
1039
1040                 if (gamma_size == 0)
1041                         gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1042
1043                 sizes.surface_width  = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1044                 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1045
1046                 for (j = 0; j < mode_set->num_connectors; j++) {
1047                         struct drm_connector *connector = mode_set->connectors[j];
1048                         if (connector->has_tile) {
1049                                 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1050                                 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1051                                 /* cloning to multiple tiles is just crazy-talk, so: */
1052                                 break;
1053                         }
1054                 }
1055
1056                 if (lasth)
1057                         sizes.fb_width  = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1058                 if (lastv)
1059                         sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1060         }
1061
1062         if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1063                 /* hmm everyone went away - assume VGA cable just fell out
1064                    and will come back later. */
1065                 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1066                 sizes.fb_width = sizes.surface_width = 1024;
1067                 sizes.fb_height = sizes.surface_height = 768;
1068         }
1069
1070         /* push down into drivers */
1071         ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1072         if (ret < 0)
1073                 return ret;
1074
1075         info = fb_helper->fbdev;
1076
1077         /*
1078          * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1079          * events, but at init time drm_setup_crtcs needs to be called before
1080          * the fb is allocated (since we need to figure out the desired size of
1081          * the fb before we can allocate it ...). Hence we need to fix things up
1082          * here again.
1083          */
1084         for (i = 0; i < fb_helper->crtc_count; i++)
1085                 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1086                         fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1087
1088
1089         info->var.pixclock = 0;
1090         if (register_framebuffer(info) < 0)
1091                 return -EINVAL;
1092
1093         dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1094                         info->node, info->fix.id);
1095
1096         if (list_empty(&kernel_fb_helper_list)) {
1097                 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1098         }
1099
1100         list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1101
1102         return 0;
1103 }
1104
1105 /**
1106  * drm_fb_helper_fill_fix - initializes fixed fbdev information
1107  * @info: fbdev registered by the helper
1108  * @pitch: desired pitch
1109  * @depth: desired depth
1110  *
1111  * Helper to fill in the fixed fbdev information useful for a non-accelerated
1112  * fbdev emulations. Drivers which support acceleration methods which impose
1113  * additional constraints need to set up their own limits.
1114  *
1115  * Drivers should call this (or their equivalent setup code) from their
1116  * ->fb_probe callback.
1117  */
1118 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1119                             uint32_t depth)
1120 {
1121         info->fix.type = FB_TYPE_PACKED_PIXELS;
1122         info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1123                 FB_VISUAL_TRUECOLOR;
1124         info->fix.mmio_start = 0;
1125         info->fix.mmio_len = 0;
1126         info->fix.type_aux = 0;
1127         info->fix.xpanstep = 1; /* doing it in hw */
1128         info->fix.ypanstep = 1; /* doing it in hw */
1129         info->fix.ywrapstep = 0;
1130         info->fix.accel = FB_ACCEL_NONE;
1131
1132         info->fix.line_length = pitch;
1133         return;
1134 }
1135 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1136
1137 /**
1138  * drm_fb_helper_fill_var - initalizes variable fbdev information
1139  * @info: fbdev instance to set up
1140  * @fb_helper: fb helper instance to use as template
1141  * @fb_width: desired fb width
1142  * @fb_height: desired fb height
1143  *
1144  * Sets up the variable fbdev metainformation from the given fb helper instance
1145  * and the drm framebuffer allocated in fb_helper->fb.
1146  *
1147  * Drivers should call this (or their equivalent setup code) from their
1148  * ->fb_probe callback after having allocated the fbdev backing
1149  * storage framebuffer.
1150  */
1151 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1152                             uint32_t fb_width, uint32_t fb_height)
1153 {
1154         struct drm_framebuffer *fb = fb_helper->fb;
1155         info->pseudo_palette = fb_helper->pseudo_palette;
1156         info->var.xres_virtual = fb->width;
1157         info->var.yres_virtual = fb->height;
1158         info->var.bits_per_pixel = fb->bits_per_pixel;
1159         info->var.accel_flags = FB_ACCELF_TEXT;
1160         info->var.xoffset = 0;
1161         info->var.yoffset = 0;
1162         info->var.activate = FB_ACTIVATE_NOW;
1163         info->var.height = -1;
1164         info->var.width = -1;
1165
1166         switch (fb->depth) {
1167         case 8:
1168                 info->var.red.offset = 0;
1169                 info->var.green.offset = 0;
1170                 info->var.blue.offset = 0;
1171                 info->var.red.length = 8; /* 8bit DAC */
1172                 info->var.green.length = 8;
1173                 info->var.blue.length = 8;
1174                 info->var.transp.offset = 0;
1175                 info->var.transp.length = 0;
1176                 break;
1177         case 15:
1178                 info->var.red.offset = 10;
1179                 info->var.green.offset = 5;
1180                 info->var.blue.offset = 0;
1181                 info->var.red.length = 5;
1182                 info->var.green.length = 5;
1183                 info->var.blue.length = 5;
1184                 info->var.transp.offset = 15;
1185                 info->var.transp.length = 1;
1186                 break;
1187         case 16:
1188                 info->var.red.offset = 11;
1189                 info->var.green.offset = 5;
1190                 info->var.blue.offset = 0;
1191                 info->var.red.length = 5;
1192                 info->var.green.length = 6;
1193                 info->var.blue.length = 5;
1194                 info->var.transp.offset = 0;
1195                 break;
1196         case 24:
1197                 info->var.red.offset = 16;
1198                 info->var.green.offset = 8;
1199                 info->var.blue.offset = 0;
1200                 info->var.red.length = 8;
1201                 info->var.green.length = 8;
1202                 info->var.blue.length = 8;
1203                 info->var.transp.offset = 0;
1204                 info->var.transp.length = 0;
1205                 break;
1206         case 32:
1207                 info->var.red.offset = 16;
1208                 info->var.green.offset = 8;
1209                 info->var.blue.offset = 0;
1210                 info->var.red.length = 8;
1211                 info->var.green.length = 8;
1212                 info->var.blue.length = 8;
1213                 info->var.transp.offset = 24;
1214                 info->var.transp.length = 8;
1215                 break;
1216         default:
1217                 break;
1218         }
1219
1220         info->var.xres = fb_width;
1221         info->var.yres = fb_height;
1222 }
1223 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1224
1225 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1226                                                uint32_t maxX,
1227                                                uint32_t maxY)
1228 {
1229         struct drm_connector *connector;
1230         int count = 0;
1231         int i;
1232
1233         for (i = 0; i < fb_helper->connector_count; i++) {
1234                 connector = fb_helper->connector_info[i]->connector;
1235                 count += connector->funcs->fill_modes(connector, maxX, maxY);
1236         }
1237
1238         return count;
1239 }
1240
1241 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1242 {
1243         struct drm_display_mode *mode;
1244
1245         list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1246                 if (mode->hdisplay > width ||
1247                     mode->vdisplay > height)
1248                         continue;
1249                 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1250                         return mode;
1251         }
1252         return NULL;
1253 }
1254 EXPORT_SYMBOL(drm_has_preferred_mode);
1255
1256 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1257 {
1258         return fb_connector->connector->cmdline_mode.specified;
1259 }
1260
1261 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1262                                                       int width, int height)
1263 {
1264         struct drm_cmdline_mode *cmdline_mode;
1265         struct drm_display_mode *mode;
1266         bool prefer_non_interlace;
1267
1268         cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1269         if (cmdline_mode->specified == false)
1270                 return NULL;
1271
1272         /* attempt to find a matching mode in the list of modes
1273          *  we have gotten so far, if not add a CVT mode that conforms
1274          */
1275         if (cmdline_mode->rb || cmdline_mode->margins)
1276                 goto create_mode;
1277
1278         prefer_non_interlace = !cmdline_mode->interlace;
1279 again:
1280         list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1281                 /* check width/height */
1282                 if (mode->hdisplay != cmdline_mode->xres ||
1283                     mode->vdisplay != cmdline_mode->yres)
1284                         continue;
1285
1286                 if (cmdline_mode->refresh_specified) {
1287                         if (mode->vrefresh != cmdline_mode->refresh)
1288                                 continue;
1289                 }
1290
1291                 if (cmdline_mode->interlace) {
1292                         if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1293                                 continue;
1294                 } else if (prefer_non_interlace) {
1295                         if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1296                                 continue;
1297                 }
1298                 return mode;
1299         }
1300
1301         if (prefer_non_interlace) {
1302                 prefer_non_interlace = false;
1303                 goto again;
1304         }
1305
1306 create_mode:
1307         mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1308                                                  cmdline_mode);
1309         list_add(&mode->head, &fb_helper_conn->connector->modes);
1310         return mode;
1311 }
1312 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1313
1314 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1315 {
1316         bool enable;
1317
1318         if (strict)
1319                 enable = connector->status == connector_status_connected;
1320         else
1321                 enable = connector->status != connector_status_disconnected;
1322
1323         return enable;
1324 }
1325
1326 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1327                                   bool *enabled)
1328 {
1329         bool any_enabled = false;
1330         struct drm_connector *connector;
1331         int i = 0;
1332
1333         for (i = 0; i < fb_helper->connector_count; i++) {
1334                 connector = fb_helper->connector_info[i]->connector;
1335                 enabled[i] = drm_connector_enabled(connector, true);
1336                 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1337                           enabled[i] ? "yes" : "no");
1338                 any_enabled |= enabled[i];
1339         }
1340
1341         if (any_enabled)
1342                 return;
1343
1344         for (i = 0; i < fb_helper->connector_count; i++) {
1345                 connector = fb_helper->connector_info[i]->connector;
1346                 enabled[i] = drm_connector_enabled(connector, false);
1347         }
1348 }
1349
1350 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1351                               struct drm_display_mode **modes,
1352                               struct drm_fb_offset *offsets,
1353                               bool *enabled, int width, int height)
1354 {
1355         int count, i, j;
1356         bool can_clone = false;
1357         struct drm_fb_helper_connector *fb_helper_conn;
1358         struct drm_display_mode *dmt_mode, *mode;
1359
1360         /* only contemplate cloning in the single crtc case */
1361         if (fb_helper->crtc_count > 1)
1362                 return false;
1363
1364         count = 0;
1365         for (i = 0; i < fb_helper->connector_count; i++) {
1366                 if (enabled[i])
1367                         count++;
1368         }
1369
1370         /* only contemplate cloning if more than one connector is enabled */
1371         if (count <= 1)
1372                 return false;
1373
1374         /* check the command line or if nothing common pick 1024x768 */
1375         can_clone = true;
1376         for (i = 0; i < fb_helper->connector_count; i++) {
1377                 if (!enabled[i])
1378                         continue;
1379                 fb_helper_conn = fb_helper->connector_info[i];
1380                 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1381                 if (!modes[i]) {
1382                         can_clone = false;
1383                         break;
1384                 }
1385                 for (j = 0; j < i; j++) {
1386                         if (!enabled[j])
1387                                 continue;
1388                         if (!drm_mode_equal(modes[j], modes[i]))
1389                                 can_clone = false;
1390                 }
1391         }
1392
1393         if (can_clone) {
1394                 DRM_DEBUG_KMS("can clone using command line\n");
1395                 return true;
1396         }
1397
1398         /* try and find a 1024x768 mode on each connector */
1399         can_clone = true;
1400         dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1401
1402         for (i = 0; i < fb_helper->connector_count; i++) {
1403
1404                 if (!enabled[i])
1405                         continue;
1406
1407                 fb_helper_conn = fb_helper->connector_info[i];
1408                 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1409                         if (drm_mode_equal(mode, dmt_mode))
1410                                 modes[i] = mode;
1411                 }
1412                 if (!modes[i])
1413                         can_clone = false;
1414         }
1415
1416         if (can_clone) {
1417                 DRM_DEBUG_KMS("can clone using 1024x768\n");
1418                 return true;
1419         }
1420         DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1421         return false;
1422 }
1423
1424 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1425                                 struct drm_display_mode **modes,
1426                                 struct drm_fb_offset *offsets,
1427                                 int idx,
1428                                 int h_idx, int v_idx)
1429 {
1430         struct drm_fb_helper_connector *fb_helper_conn;
1431         int i;
1432         int hoffset = 0, voffset = 0;
1433
1434         for (i = 0; i < fb_helper->connector_count; i++) {
1435                 fb_helper_conn = fb_helper->connector_info[i];
1436                 if (!fb_helper_conn->connector->has_tile)
1437                         continue;
1438
1439                 if (!modes[i] && (h_idx || v_idx)) {
1440                         DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1441                                       fb_helper_conn->connector->base.id);
1442                         continue;
1443                 }
1444                 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1445                         hoffset += modes[i]->hdisplay;
1446
1447                 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1448                         voffset += modes[i]->vdisplay;
1449         }
1450         offsets[idx].x = hoffset;
1451         offsets[idx].y = voffset;
1452         DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1453         return 0;
1454 }
1455
1456 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1457                                  struct drm_display_mode **modes,
1458                                  struct drm_fb_offset *offsets,
1459                                  bool *enabled, int width, int height)
1460 {
1461         struct drm_fb_helper_connector *fb_helper_conn;
1462         int i;
1463         uint64_t conn_configured = 0, mask;
1464         int tile_pass = 0;
1465         mask = (1 << fb_helper->connector_count) - 1;
1466 retry:
1467         for (i = 0; i < fb_helper->connector_count; i++) {
1468                 fb_helper_conn = fb_helper->connector_info[i];
1469
1470                 if (conn_configured & (1 << i))
1471                         continue;
1472
1473                 if (enabled[i] == false) {
1474                         conn_configured |= (1 << i);
1475                         continue;
1476                 }
1477
1478                 /* first pass over all the untiled connectors */
1479                 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1480                         continue;
1481
1482                 if (tile_pass == 1) {
1483                         if (fb_helper_conn->connector->tile_h_loc != 0 ||
1484                             fb_helper_conn->connector->tile_v_loc != 0)
1485                                 continue;
1486
1487                 } else {
1488                         if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1489                             fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1490                         /* if this tile_pass doesn't cover any of the tiles - keep going */
1491                                 continue;
1492
1493                         /* find the tile offsets for this pass - need
1494                            to find all tiles left and above */
1495                         drm_get_tile_offsets(fb_helper, modes, offsets,
1496                                              i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1497                 }
1498                 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1499                               fb_helper_conn->connector->base.id);
1500
1501                 /* got for command line mode first */
1502                 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1503                 if (!modes[i]) {
1504                         DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1505                                       fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1506                         modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1507                 }
1508                 /* No preferred modes, pick one off the list */
1509                 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1510                         list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1511                                 break;
1512                 }
1513                 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1514                           "none");
1515                 conn_configured |= (1 << i);
1516         }
1517
1518         if ((conn_configured & mask) != mask) {
1519                 tile_pass++;
1520                 goto retry;
1521         }
1522         return true;
1523 }
1524
1525 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1526                           struct drm_fb_helper_crtc **best_crtcs,
1527                           struct drm_display_mode **modes,
1528                           int n, int width, int height)
1529 {
1530         int c, o;
1531         struct drm_device *dev = fb_helper->dev;
1532         struct drm_connector *connector;
1533         const struct drm_connector_helper_funcs *connector_funcs;
1534         struct drm_encoder *encoder;
1535         int my_score, best_score, score;
1536         struct drm_fb_helper_crtc **crtcs, *crtc;
1537         struct drm_fb_helper_connector *fb_helper_conn;
1538
1539         if (n == fb_helper->connector_count)
1540                 return 0;
1541
1542         fb_helper_conn = fb_helper->connector_info[n];
1543         connector = fb_helper_conn->connector;
1544
1545         best_crtcs[n] = NULL;
1546         best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1547         if (modes[n] == NULL)
1548                 return best_score;
1549
1550         crtcs = kzalloc(dev->mode_config.num_connector *
1551                         sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1552         if (!crtcs)
1553                 return best_score;
1554
1555         my_score = 1;
1556         if (connector->status == connector_status_connected)
1557                 my_score++;
1558         if (drm_has_cmdline_mode(fb_helper_conn))
1559                 my_score++;
1560         if (drm_has_preferred_mode(fb_helper_conn, width, height))
1561                 my_score++;
1562
1563         connector_funcs = connector->helper_private;
1564         encoder = connector_funcs->best_encoder(connector);
1565         if (!encoder)
1566                 goto out;
1567
1568         /* select a crtc for this connector and then attempt to configure
1569            remaining connectors */
1570         for (c = 0; c < fb_helper->crtc_count; c++) {
1571                 crtc = &fb_helper->crtc_info[c];
1572
1573                 if ((encoder->possible_crtcs & (1 << c)) == 0)
1574                         continue;
1575
1576                 for (o = 0; o < n; o++)
1577                         if (best_crtcs[o] == crtc)
1578                                 break;
1579
1580                 if (o < n) {
1581                         /* ignore cloning unless only a single crtc */
1582                         if (fb_helper->crtc_count > 1)
1583                                 continue;
1584
1585                         if (!drm_mode_equal(modes[o], modes[n]))
1586                                 continue;
1587                 }
1588
1589                 crtcs[n] = crtc;
1590                 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
1591                 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
1592                                                   width, height);
1593                 if (score > best_score) {
1594                         best_score = score;
1595                         memcpy(best_crtcs, crtcs,
1596                                dev->mode_config.num_connector *
1597                                sizeof(struct drm_fb_helper_crtc *));
1598                 }
1599         }
1600 out:
1601         kfree(crtcs);
1602         return best_score;
1603 }
1604
1605 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
1606 {
1607         struct drm_device *dev = fb_helper->dev;
1608         struct drm_fb_helper_crtc **crtcs;
1609         struct drm_display_mode **modes;
1610         struct drm_fb_offset *offsets;
1611         struct drm_mode_set *modeset;
1612         bool *enabled;
1613         int width, height;
1614         int i;
1615
1616         DRM_DEBUG_KMS("\n");
1617
1618         width = dev->mode_config.max_width;
1619         height = dev->mode_config.max_height;
1620
1621         crtcs = kcalloc(dev->mode_config.num_connector,
1622                         sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1623         modes = kcalloc(dev->mode_config.num_connector,
1624                         sizeof(struct drm_display_mode *), GFP_KERNEL);
1625         offsets = kcalloc(dev->mode_config.num_connector,
1626                           sizeof(struct drm_fb_offset), GFP_KERNEL);
1627         enabled = kcalloc(dev->mode_config.num_connector,
1628                           sizeof(bool), GFP_KERNEL);
1629         if (!crtcs || !modes || !enabled || !offsets) {
1630                 DRM_ERROR("Memory allocation failed\n");
1631                 goto out;
1632         }
1633
1634
1635         drm_enable_connectors(fb_helper, enabled);
1636
1637         if (!(fb_helper->funcs->initial_config &&
1638               fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
1639                                                offsets,
1640                                                enabled, width, height))) {
1641                 memset(modes, 0, dev->mode_config.num_connector*sizeof(modes[0]));
1642                 memset(crtcs, 0, dev->mode_config.num_connector*sizeof(crtcs[0]));
1643                 memset(offsets, 0, dev->mode_config.num_connector*sizeof(offsets[0]));
1644
1645                 if (!drm_target_cloned(fb_helper, modes, offsets,
1646                                        enabled, width, height) &&
1647                     !drm_target_preferred(fb_helper, modes, offsets,
1648                                           enabled, width, height))
1649                         DRM_ERROR("Unable to find initial modes\n");
1650
1651                 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
1652                               width, height);
1653
1654                 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
1655         }
1656
1657         /* need to set the modesets up here for use later */
1658         /* fill out the connector<->crtc mappings into the modesets */
1659         for (i = 0; i < fb_helper->crtc_count; i++) {
1660                 modeset = &fb_helper->crtc_info[i].mode_set;
1661                 modeset->num_connectors = 0;
1662                 modeset->fb = NULL;
1663         }
1664
1665         for (i = 0; i < fb_helper->connector_count; i++) {
1666                 struct drm_display_mode *mode = modes[i];
1667                 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
1668                 struct drm_fb_offset *offset = &offsets[i];
1669                 modeset = &fb_crtc->mode_set;
1670
1671                 if (mode && fb_crtc) {
1672                         DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
1673                                       mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
1674                         fb_crtc->desired_mode = mode;
1675                         fb_crtc->x = offset->x;
1676                         fb_crtc->y = offset->y;
1677                         if (modeset->mode)
1678                                 drm_mode_destroy(dev, modeset->mode);
1679                         modeset->mode = drm_mode_duplicate(dev,
1680                                                            fb_crtc->desired_mode);
1681                         modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
1682                         modeset->fb = fb_helper->fb;
1683                         modeset->x = offset->x;
1684                         modeset->y = offset->y;
1685                 }
1686         }
1687
1688         /* Clear out any old modes if there are no more connected outputs. */
1689         for (i = 0; i < fb_helper->crtc_count; i++) {
1690                 modeset = &fb_helper->crtc_info[i].mode_set;
1691                 if (modeset->num_connectors == 0) {
1692                         BUG_ON(modeset->fb);
1693                         if (modeset->mode)
1694                                 drm_mode_destroy(dev, modeset->mode);
1695                         modeset->mode = NULL;
1696                 }
1697         }
1698 out:
1699         kfree(crtcs);
1700         kfree(modes);
1701         kfree(offsets);
1702         kfree(enabled);
1703 }
1704
1705 /**
1706  * drm_fb_helper_initial_config - setup a sane initial connector configuration
1707  * @fb_helper: fb_helper device struct
1708  * @bpp_sel: bpp value to use for the framebuffer configuration
1709  *
1710  * Scans the CRTCs and connectors and tries to put together an initial setup.
1711  * At the moment, this is a cloned configuration across all heads with
1712  * a new framebuffer object as the backing store.
1713  *
1714  * Note that this also registers the fbdev and so allows userspace to call into
1715  * the driver through the fbdev interfaces.
1716  *
1717  * This function will call down into the ->fb_probe callback to let
1718  * the driver allocate and initialize the fbdev info structure and the drm
1719  * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
1720  * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
1721  * values for the fbdev info structure.
1722  *
1723  * RETURNS:
1724  * Zero if everything went ok, nonzero otherwise.
1725  */
1726 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1727 {
1728         struct drm_device *dev = fb_helper->dev;
1729         int count = 0;
1730
1731         mutex_lock(&dev->mode_config.mutex);
1732         count = drm_fb_helper_probe_connector_modes(fb_helper,
1733                                                     dev->mode_config.max_width,
1734                                                     dev->mode_config.max_height);
1735         mutex_unlock(&dev->mode_config.mutex);
1736         /*
1737          * we shouldn't end up with no modes here.
1738          */
1739         if (count == 0)
1740                 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
1741
1742         drm_setup_crtcs(fb_helper);
1743
1744         return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1745 }
1746 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1747
1748 /**
1749  * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1750  *                               probing all the outputs attached to the fb
1751  * @fb_helper: the drm_fb_helper
1752  *
1753  * Scan the connectors attached to the fb_helper and try to put together a
1754  * setup after *notification of a change in output configuration.
1755  *
1756  * Called at runtime, takes the mode config locks to be able to check/change the
1757  * modeset configuration. Must be run from process context (which usually means
1758  * either the output polling work or a work item launched from the driver's
1759  * hotplug interrupt).
1760  *
1761  * Note that drivers may call this even before calling
1762  * drm_fb_helper_initial_config but only aftert drm_fb_helper_init. This allows
1763  * for a race-free fbcon setup and will make sure that the fbdev emulation will
1764  * not miss any hotplug events.
1765  *
1766  * RETURNS:
1767  * 0 on success and a non-zero error code otherwise.
1768  */
1769 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1770 {
1771         struct drm_device *dev = fb_helper->dev;
1772         u32 max_width, max_height;
1773
1774         mutex_lock(&fb_helper->dev->mode_config.mutex);
1775         if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
1776                 fb_helper->delayed_hotplug = true;
1777                 mutex_unlock(&fb_helper->dev->mode_config.mutex);
1778                 return 0;
1779         }
1780         DRM_DEBUG_KMS("\n");
1781
1782         max_width = fb_helper->fb->width;
1783         max_height = fb_helper->fb->height;
1784
1785         drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
1786         mutex_unlock(&fb_helper->dev->mode_config.mutex);
1787
1788         drm_modeset_lock_all(dev);
1789         drm_setup_crtcs(fb_helper);
1790         drm_modeset_unlock_all(dev);
1791         drm_fb_helper_set_par(fb_helper->fbdev);
1792
1793         return 0;
1794 }
1795 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1796
1797 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
1798  * but the module doesn't depend on any fb console symbols.  At least
1799  * attempt to load fbcon to avoid leaving the system without a usable console.
1800  */
1801 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
1802 static int __init drm_fb_helper_modinit(void)
1803 {
1804         const char *name = "fbcon";
1805         struct module *fbcon;
1806
1807         mutex_lock(&module_mutex);
1808         fbcon = find_module(name);
1809         mutex_unlock(&module_mutex);
1810
1811         if (!fbcon)
1812                 request_module_nowait(name);
1813         return 0;
1814 }
1815
1816 module_init(drm_fb_helper_modinit);
1817 #endif