drivers/gpu/drm/drm_crtc.c

   1 /*
   2  * Copyright (c) 2006-2008 Intel Corporation
   3  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
   4  * Copyright (c) 2008 Red Hat Inc.
   5  *
   6  * DRM core CRTC related 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  *      Keith Packard
  28  *      Eric Anholt <eric@anholt.net>
  29  *      Dave Airlie <airlied@linux.ie>
  30  *      Jesse Barnes <jesse.barnes@intel.com>
  31  */
  32 #include <linux/ctype.h>
  33 #include <linux/list.h>
  34 #include <linux/slab.h>
  35 #include <linux/export.h>
  36 #include <drm/drmP.h>
  37 #include <drm/drm_crtc.h>
  38 #include <drm/drm_edid.h>
  39 #include <drm/drm_fourcc.h>
  40 #include <drm/drm_modeset_lock.h>
  41
  42 #include "drm_crtc_internal.h"
  43 #include "drm_internal.h"
  44
  45 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
  46                                                         struct drm_mode_fb_cmd2 *r,
  47                                                         struct drm_file *file_priv);
  48
  49 /* Avoid boilerplate.  I'm tired of typing. */
  50 #define DRM_ENUM_NAME_FN(fnname, list)                          \
  51         const char *fnname(int val)                             \
  52         {                                                       \
  53                 int i;                                          \
  54                 for (i = 0; i < ARRAY_SIZE(list); i++) {        \
  55                         if (list[i].type == val)                \
  56                                 return list[i].name;            \
  57                 }                                               \
  58                 return "(unknown)";                             \
  59         }
  60
  61 /*
  62  * Global properties
  63  */
  64 static const struct drm_prop_enum_list drm_dpms_enum_list[] =
  65 {       { DRM_MODE_DPMS_ON, "On" },
  66         { DRM_MODE_DPMS_STANDBY, "Standby" },
  67         { DRM_MODE_DPMS_SUSPEND, "Suspend" },
  68         { DRM_MODE_DPMS_OFF, "Off" }
  69 };
  70
  71 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
  72
  73 static const struct drm_prop_enum_list drm_plane_type_enum_list[] =
  74 {
  75         { DRM_PLANE_TYPE_OVERLAY, "Overlay" },
  76         { DRM_PLANE_TYPE_PRIMARY, "Primary" },
  77         { DRM_PLANE_TYPE_CURSOR, "Cursor" },
  78 };
  79
  80 /*
  81  * Optional properties
  82  */
  83 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] =
  84 {
  85         { DRM_MODE_SCALE_NONE, "None" },
  86         { DRM_MODE_SCALE_FULLSCREEN, "Full" },
  87         { DRM_MODE_SCALE_CENTER, "Center" },
  88         { DRM_MODE_SCALE_ASPECT, "Full aspect" },
  89 };
  90
  91 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
  92         { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
  93         { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
  94         { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
  95 };
  96
  97 /*
  98  * Non-global properties, but "required" for certain connectors.
  99  */
 100 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] =
 101 {
 102         { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
 103         { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
 104         { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
 105 };
 106
 107 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
 108
 109 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] =
 110 {
 111         { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
 112         { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
 113         { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
 114 };
 115
 116 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
 117                  drm_dvi_i_subconnector_enum_list)
 118
 119 static const struct drm_prop_enum_list drm_tv_select_enum_list[] =
 120 {
 121         { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
 122         { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
 123         { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
 124         { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
 125         { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
 126 };
 127
 128 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
 129
 130 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] =
 131 {
 132         { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
 133         { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
 134         { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
 135         { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
 136         { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
 137 };
 138
 139 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
 140                  drm_tv_subconnector_enum_list)
 141
 142 static const struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
 143         { DRM_MODE_DIRTY_OFF,      "Off"      },
 144         { DRM_MODE_DIRTY_ON,       "On"       },
 145         { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
 146 };
 147
 148 struct drm_conn_prop_enum_list {
 149         int type;
 150         const char *name;
 151         struct ida ida;
 152 };
 153
 154 /*
 155  * Connector and encoder types.
 156  */
 157 static struct drm_conn_prop_enum_list drm_connector_enum_list[] =
 158 {       { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
 159         { DRM_MODE_CONNECTOR_VGA, "VGA" },
 160         { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
 161         { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
 162         { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
 163         { DRM_MODE_CONNECTOR_Composite, "Composite" },
 164         { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
 165         { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
 166         { DRM_MODE_CONNECTOR_Component, "Component" },
 167         { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
 168         { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
 169         { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
 170         { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
 171         { DRM_MODE_CONNECTOR_TV, "TV" },
 172         { DRM_MODE_CONNECTOR_eDP, "eDP" },
 173         { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
 174         { DRM_MODE_CONNECTOR_DSI, "DSI" },
 175 };
 176
 177 static const struct drm_prop_enum_list drm_encoder_enum_list[] =
 178 {       { DRM_MODE_ENCODER_NONE, "None" },
 179         { DRM_MODE_ENCODER_DAC, "DAC" },
 180         { DRM_MODE_ENCODER_TMDS, "TMDS" },
 181         { DRM_MODE_ENCODER_LVDS, "LVDS" },
 182         { DRM_MODE_ENCODER_TVDAC, "TV" },
 183         { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
 184         { DRM_MODE_ENCODER_DSI, "DSI" },
 185         { DRM_MODE_ENCODER_DPMST, "DP MST" },
 186 };
 187
 188 static const struct drm_prop_enum_list drm_subpixel_enum_list[] =
 189 {
 190         { SubPixelUnknown, "Unknown" },
 191         { SubPixelHorizontalRGB, "Horizontal RGB" },
 192         { SubPixelHorizontalBGR, "Horizontal BGR" },
 193         { SubPixelVerticalRGB, "Vertical RGB" },
 194         { SubPixelVerticalBGR, "Vertical BGR" },
 195         { SubPixelNone, "None" },
 196 };
 197
 198 void drm_connector_ida_init(void)
 199 {
 200         int i;
 201
 202         for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
 203                 ida_init(&drm_connector_enum_list[i].ida);
 204 }
 205
 206 void drm_connector_ida_destroy(void)
 207 {
 208         int i;
 209
 210         for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
 211                 ida_destroy(&drm_connector_enum_list[i].ida);
 212 }
 213
 214 /**
 215  * drm_get_connector_status_name - return a string for connector status
 216  * @status: connector status to compute name of
 217  *
 218  * In contrast to the other drm_get_*_name functions this one here returns a
 219  * const pointer and hence is threadsafe.
 220  */
 221 const char *drm_get_connector_status_name(enum drm_connector_status status)
 222 {
 223         if (status == connector_status_connected)
 224                 return "connected";
 225         else if (status == connector_status_disconnected)
 226                 return "disconnected";
 227         else
 228                 return "unknown";
 229 }
 230 EXPORT_SYMBOL(drm_get_connector_status_name);
 231
 232 /**
 233  * drm_get_subpixel_order_name - return a string for a given subpixel enum
 234  * @order: enum of subpixel_order
 235  *
 236  * Note you could abuse this and return something out of bounds, but that
 237  * would be a caller error.  No unscrubbed user data should make it here.
 238  */
 239 const char *drm_get_subpixel_order_name(enum subpixel_order order)
 240 {
 241         return drm_subpixel_enum_list[order].name;
 242 }
 243 EXPORT_SYMBOL(drm_get_subpixel_order_name);
 244
 245 static char printable_char(int c)
 246 {
 247         return isascii(c) && isprint(c) ? c : '?';
 248 }
 249
 250 /**
 251  * drm_get_format_name - return a string for drm fourcc format
 252  * @format: format to compute name of
 253  *
 254  * Note that the buffer used by this function is globally shared and owned by
 255  * the function itself.
 256  *
 257  * FIXME: This isn't really multithreading safe.
 258  */
 259 const char *drm_get_format_name(uint32_t format)
 260 {
 261         static char buf[32];
 262
 263         snprintf(buf, sizeof(buf),
 264                  "%c%c%c%c %s-endian (0x%08x)",
 265                  printable_char(format & 0xff),
 266                  printable_char((format >> 8) & 0xff),
 267                  printable_char((format >> 16) & 0xff),
 268                  printable_char((format >> 24) & 0x7f),
 269                  format & DRM_FORMAT_BIG_ENDIAN ? "big" : "little",
 270                  format);
 271
 272         return buf;
 273 }
 274 EXPORT_SYMBOL(drm_get_format_name);
 275
 276 /*
 277  * Internal function to assign a slot in the object idr and optionally
 278  * register the object into the idr.
 279  */
 280 static int drm_mode_object_get_reg(struct drm_device *dev,
 281                                    struct drm_mode_object *obj,
 282                                    uint32_t obj_type,
 283                                    bool register_obj)
 284 {
 285         int ret;
 286
 287         mutex_lock(&dev->mode_config.idr_mutex);
 288         ret = idr_alloc(&dev->mode_config.crtc_idr, register_obj ? obj : NULL, 1, 0, GFP_KERNEL);
 289         if (ret >= 0) {
 290                 /*
 291                  * Set up the object linking under the protection of the idr
 292                  * lock so that other users can't see inconsistent state.
 293                  */
 294                 obj->id = ret;
 295                 obj->type = obj_type;
 296         }
 297         mutex_unlock(&dev->mode_config.idr_mutex);
 298
 299         return ret < 0 ? ret : 0;
 300 }
 301
 302 /**
 303  * drm_mode_object_get - allocate a new modeset identifier
 304  * @dev: DRM device
 305  * @obj: object pointer, used to generate unique ID
 306  * @obj_type: object type
 307  *
 308  * Create a unique identifier based on @ptr in @dev's identifier space.  Used
 309  * for tracking modes, CRTCs and connectors. Note that despite the _get postfix
 310  * modeset identifiers are _not_ reference counted. Hence don't use this for
 311  * reference counted modeset objects like framebuffers.
 312  *
 313  * Returns:
 314  * New unique (relative to other objects in @dev) integer identifier for the
 315  * object.
 316  */
 317 int drm_mode_object_get(struct drm_device *dev,
 318                         struct drm_mode_object *obj, uint32_t obj_type)
 319 {
 320         return drm_mode_object_get_reg(dev, obj, obj_type, true);
 321 }
 322
 323 static void drm_mode_object_register(struct drm_device *dev,
 324                                      struct drm_mode_object *obj)
 325 {
 326         mutex_lock(&dev->mode_config.idr_mutex);
 327         idr_replace(&dev->mode_config.crtc_idr, obj, obj->id);
 328         mutex_unlock(&dev->mode_config.idr_mutex);
 329 }
 330
 331 /**
 332  * drm_mode_object_put - free a modeset identifer
 333  * @dev: DRM device
 334  * @object: object to free
 335  *
 336  * Free @id from @dev's unique identifier pool. Note that despite the _get
 337  * postfix modeset identifiers are _not_ reference counted. Hence don't use this
 338  * for reference counted modeset objects like framebuffers.
 339  */
 340 void drm_mode_object_put(struct drm_device *dev,
 341                          struct drm_mode_object *object)
 342 {
 343         mutex_lock(&dev->mode_config.idr_mutex);
 344         idr_remove(&dev->mode_config.crtc_idr, object->id);
 345         mutex_unlock(&dev->mode_config.idr_mutex);
 346 }
 347
 348 static struct drm_mode_object *_object_find(struct drm_device *dev,
 349                 uint32_t id, uint32_t type)
 350 {
 351         struct drm_mode_object *obj = NULL;
 352
 353         mutex_lock(&dev->mode_config.idr_mutex);
 354         obj = idr_find(&dev->mode_config.crtc_idr, id);
 355         if (obj && type != DRM_MODE_OBJECT_ANY && obj->type != type)
 356                 obj = NULL;
 357         if (obj && obj->id != id)
 358                 obj = NULL;
 359         /* don't leak out unref'd fb's */
 360         if (obj && (obj->type == DRM_MODE_OBJECT_FB))
 361                 obj = NULL;
 362         mutex_unlock(&dev->mode_config.idr_mutex);
 363
 364         return obj;
 365 }
 366
 367 /**
 368  * drm_mode_object_find - look up a drm object with static lifetime
 369  * @dev: drm device
 370  * @id: id of the mode object
 371  * @type: type of the mode object
 372  *
 373  * Note that framebuffers cannot be looked up with this functions - since those
 374  * are reference counted, they need special treatment.  Even with
 375  * DRM_MODE_OBJECT_ANY (although that will simply return NULL
 376  * rather than WARN_ON()).
 377  */
 378 struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
 379                 uint32_t id, uint32_t type)
 380 {
 381         struct drm_mode_object *obj = NULL;
 382
 383         /* Framebuffers are reference counted and need their own lookup
 384          * function.*/
 385         WARN_ON(type == DRM_MODE_OBJECT_FB);
 386         obj = _object_find(dev, id, type);
 387         return obj;
 388 }
 389 EXPORT_SYMBOL(drm_mode_object_find);
 390
 391 /**
 392  * drm_framebuffer_init - initialize a framebuffer
 393  * @dev: DRM device
 394  * @fb: framebuffer to be initialized
 395  * @funcs: ... with these functions
 396  *
 397  * Allocates an ID for the framebuffer's parent mode object, sets its mode
 398  * functions & device file and adds it to the master fd list.
 399  *
 400  * IMPORTANT:
 401  * This functions publishes the fb and makes it available for concurrent access
 402  * by other users. Which means by this point the fb _must_ be fully set up -
 403  * since all the fb attributes are invariant over its lifetime, no further
 404  * locking but only correct reference counting is required.
 405  *
 406  * Returns:
 407  * Zero on success, error code on failure.
 408  */
 409 int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
 410                          const struct drm_framebuffer_funcs *funcs)
 411 {
 412         int ret;
 413
 414         mutex_lock(&dev->mode_config.fb_lock);
 415         kref_init(&fb->refcount);
 416         INIT_LIST_HEAD(&fb->filp_head);
 417         fb->dev = dev;
 418         fb->funcs = funcs;
 419
 420         ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
 421         if (ret)
 422                 goto out;
 423
 424         dev->mode_config.num_fb++;
 425         list_add(&fb->head, &dev->mode_config.fb_list);
 426 out:
 427         mutex_unlock(&dev->mode_config.fb_lock);
 428
 429         return 0;
 430 }
 431 EXPORT_SYMBOL(drm_framebuffer_init);
 432
 433 /* dev->mode_config.fb_lock must be held! */
 434 static void __drm_framebuffer_unregister(struct drm_device *dev,
 435                                          struct drm_framebuffer *fb)
 436 {
 437         mutex_lock(&dev->mode_config.idr_mutex);
 438         idr_remove(&dev->mode_config.crtc_idr, fb->base.id);
 439         mutex_unlock(&dev->mode_config.idr_mutex);
 440
 441         fb->base.id = 0;
 442 }
 443
 444 static void drm_framebuffer_free(struct kref *kref)
 445 {
 446         struct drm_framebuffer *fb =
 447                         container_of(kref, struct drm_framebuffer, refcount);
 448         struct drm_device *dev = fb->dev;
 449
 450         /*
 451          * The lookup idr holds a weak reference, which has not necessarily been
 452          * removed at this point. Check for that.
 453          */
 454         mutex_lock(&dev->mode_config.fb_lock);
 455         if (fb->base.id) {
 456                 /* Mark fb as reaped and drop idr ref. */
 457                 __drm_framebuffer_unregister(dev, fb);
 458         }
 459         mutex_unlock(&dev->mode_config.fb_lock);
 460
 461         fb->funcs->destroy(fb);
 462 }
 463
 464 static struct drm_framebuffer *__drm_framebuffer_lookup(struct drm_device *dev,
 465                                                         uint32_t id)
 466 {
 467         struct drm_mode_object *obj = NULL;
 468         struct drm_framebuffer *fb;
 469
 470         mutex_lock(&dev->mode_config.idr_mutex);
 471         obj = idr_find(&dev->mode_config.crtc_idr, id);
 472         if (!obj || (obj->type != DRM_MODE_OBJECT_FB) || (obj->id != id))
 473                 fb = NULL;
 474         else
 475                 fb = obj_to_fb(obj);
 476         mutex_unlock(&dev->mode_config.idr_mutex);
 477
 478         return fb;
 479 }
 480
 481 /**
 482  * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference
 483  * @dev: drm device
 484  * @id: id of the fb object
 485  *
 486  * If successful, this grabs an additional reference to the framebuffer -
 487  * callers need to make sure to eventually unreference the returned framebuffer
 488  * again, using @drm_framebuffer_unreference.
 489  */
 490 struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
 491                                                uint32_t id)
 492 {
 493         struct drm_framebuffer *fb;
 494
 495         mutex_lock(&dev->mode_config.fb_lock);
 496         fb = __drm_framebuffer_lookup(dev, id);
 497         if (fb) {
 498                 if (!kref_get_unless_zero(&fb->refcount))
 499                         fb = NULL;
 500         }
 501         mutex_unlock(&dev->mode_config.fb_lock);
 502
 503         return fb;
 504 }
 505 EXPORT_SYMBOL(drm_framebuffer_lookup);
 506
 507 /**
 508  * drm_framebuffer_unreference - unref a framebuffer
 509  * @fb: framebuffer to unref
 510  *
 511  * This functions decrements the fb's refcount and frees it if it drops to zero.
 512  */
 513 void drm_framebuffer_unreference(struct drm_framebuffer *fb)
 514 {
 515         DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
 516         kref_put(&fb->refcount, drm_framebuffer_free);
 517 }
 518 EXPORT_SYMBOL(drm_framebuffer_unreference);
 519
 520 /**
 521  * drm_framebuffer_reference - incr the fb refcnt
 522  * @fb: framebuffer
 523  *
 524  * This functions increments the fb's refcount.
 525  */
 526 void drm_framebuffer_reference(struct drm_framebuffer *fb)
 527 {
 528         DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
 529         kref_get(&fb->refcount);
 530 }
 531 EXPORT_SYMBOL(drm_framebuffer_reference);
 532
 533 static void drm_framebuffer_free_bug(struct kref *kref)
 534 {
 535         BUG();
 536 }
 537
 538 static void __drm_framebuffer_unreference(struct drm_framebuffer *fb)
 539 {
 540         DRM_DEBUG("%p: FB ID: %d (%d)\n", fb, fb->base.id, atomic_read(&fb->refcount.refcount));
 541         kref_put(&fb->refcount, drm_framebuffer_free_bug);
 542 }
 543
 544 /**
 545  * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr
 546  * @fb: fb to unregister
 547  *
 548  * Drivers need to call this when cleaning up driver-private framebuffers, e.g.
 549  * those used for fbdev. Note that the caller must hold a reference of it's own,
 550  * i.e. the object may not be destroyed through this call (since it'll lead to a
 551  * locking inversion).
 552  */
 553 void drm_framebuffer_unregister_private(struct drm_framebuffer *fb)
 554 {
 555         struct drm_device *dev = fb->dev;
 556
 557         mutex_lock(&dev->mode_config.fb_lock);
 558         /* Mark fb as reaped and drop idr ref. */
 559         __drm_framebuffer_unregister(dev, fb);
 560         mutex_unlock(&dev->mode_config.fb_lock);
 561 }
 562 EXPORT_SYMBOL(drm_framebuffer_unregister_private);
 563
 564 /**
 565  * drm_framebuffer_cleanup - remove a framebuffer object
 566  * @fb: framebuffer to remove
 567  *
 568  * Cleanup framebuffer. This function is intended to be used from the drivers
 569  * ->destroy callback. It can also be used to clean up driver private
 570  *  framebuffers embedded into a larger structure.
 571  *
 572  * Note that this function does not remove the fb from active usuage - if it is
 573  * still used anywhere, hilarity can ensue since userspace could call getfb on
 574  * the id and get back -EINVAL. Obviously no concern at driver unload time.
 575  *
 576  * Also, the framebuffer will not be removed from the lookup idr - for
 577  * user-created framebuffers this will happen in in the rmfb ioctl. For
 578  * driver-private objects (e.g. for fbdev) drivers need to explicitly call
 579  * drm_framebuffer_unregister_private.
 580  */
 581 void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
 582 {
 583         struct drm_device *dev = fb->dev;
 584
 585         mutex_lock(&dev->mode_config.fb_lock);
 586         list_del(&fb->head);
 587         dev->mode_config.num_fb--;
 588         mutex_unlock(&dev->mode_config.fb_lock);
 589 }
 590 EXPORT_SYMBOL(drm_framebuffer_cleanup);
 591
 592 /**
 593  * drm_framebuffer_remove - remove and unreference a framebuffer object
 594  * @fb: framebuffer to remove
 595  *
 596  * Scans all the CRTCs and planes in @dev's mode_config.  If they're
 597  * using @fb, removes it, setting it to NULL. Then drops the reference to the
 598  * passed-in framebuffer. Might take the modeset locks.
 599  *
 600  * Note that this function optimizes the cleanup away if the caller holds the
 601  * last reference to the framebuffer. It is also guaranteed to not take the
 602  * modeset locks in this case.
 603  */
 604 void drm_framebuffer_remove(struct drm_framebuffer *fb)
 605 {
 606         struct drm_device *dev = fb->dev;
 607         struct drm_crtc *crtc;
 608         struct drm_plane *plane;
 609         struct drm_mode_set set;
 610         int ret;
 611
 612         WARN_ON(!list_empty(&fb->filp_head));
 613
 614         /*
 615          * drm ABI mandates that we remove any deleted framebuffers from active
 616          * useage. But since most sane clients only remove framebuffers they no
 617          * longer need, try to optimize this away.
 618          *
 619          * Since we're holding a reference ourselves, observing a refcount of 1
 620          * means that we're the last holder and can skip it. Also, the refcount
 621          * can never increase from 1 again, so we don't need any barriers or
 622          * locks.
 623          *
 624          * Note that userspace could try to race with use and instate a new
 625          * usage _after_ we've cleared all current ones. End result will be an
 626          * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot
 627          * in this manner.
 628          */
 629         if (atomic_read(&fb->refcount.refcount) > 1) {
 630                 drm_modeset_lock_all(dev);
 631                 /* remove from any CRTC */
 632                 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
 633                         if (crtc->primary->fb == fb) {
 634                                 /* should turn off the crtc */
 635                                 memset(&set, 0, sizeof(struct drm_mode_set));
 636                                 set.crtc = crtc;
 637                                 set.fb = NULL;
 638                                 ret = drm_mode_set_config_internal(&set);
 639                                 if (ret)
 640                                         DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
 641                         }
 642                 }
 643
 644                 list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
 645                         if (plane->fb == fb)
 646                                 drm_plane_force_disable(plane);
 647                 }
 648                 drm_modeset_unlock_all(dev);
 649         }
 650
 651         drm_framebuffer_unreference(fb);
 652 }
 653 EXPORT_SYMBOL(drm_framebuffer_remove);
 654
 655 DEFINE_WW_CLASS(crtc_ww_class);
 656
 657 /**
 658  * drm_crtc_init_with_planes - Initialise a new CRTC object with
 659  *    specified primary and cursor planes.
 660  * @dev: DRM device
 661  * @crtc: CRTC object to init
 662  * @primary: Primary plane for CRTC
 663  * @cursor: Cursor plane for CRTC
 664  * @funcs: callbacks for the new CRTC
 665  *
 666  * Inits a new object created as base part of a driver crtc object.
 667  *
 668  * Returns:
 669  * Zero on success, error code on failure.
 670  */
 671 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
 672                               struct drm_plane *primary,
 673                               struct drm_plane *cursor,
 674                               const struct drm_crtc_funcs *funcs)
 675 {
 676         struct drm_mode_config *config = &dev->mode_config;
 677         int ret;
 678
 679         crtc->dev = dev;
 680         crtc->funcs = funcs;
 681         crtc->invert_dimensions = false;
 682
 683         drm_modeset_lock_init(&crtc->mutex);
 684         ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
 685         if (ret)
 686                 return ret;
 687
 688         crtc->base.properties = &crtc->properties;
 689
 690         list_add_tail(&crtc->head, &config->crtc_list);
 691         config->num_crtc++;
 692
 693         crtc->primary = primary;
 694         crtc->cursor = cursor;
 695         if (primary)
 696                 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
 697         if (cursor)
 698                 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
 699
 700         return 0;
 701 }
 702 EXPORT_SYMBOL(drm_crtc_init_with_planes);
 703
 704 /**
 705  * drm_crtc_cleanup - Clean up the core crtc usage
 706  * @crtc: CRTC to cleanup
 707  *
 708  * This function cleans up @crtc and removes it from the DRM mode setting
 709  * core. Note that the function does *not* free the crtc structure itself,
 710  * this is the responsibility of the caller.
 711  */
 712 void drm_crtc_cleanup(struct drm_crtc *crtc)
 713 {
 714         struct drm_device *dev = crtc->dev;
 715
 716         kfree(crtc->gamma_store);
 717         crtc->gamma_store = NULL;
 718
 719         drm_modeset_lock_fini(&crtc->mutex);
 720
 721         drm_mode_object_put(dev, &crtc->base);
 722         list_del(&crtc->head);
 723         dev->mode_config.num_crtc--;
 724
 725         WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
 726         if (crtc->state && crtc->funcs->atomic_destroy_state)
 727                 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
 728
 729         memset(crtc, 0, sizeof(*crtc));
 730 }
 731 EXPORT_SYMBOL(drm_crtc_cleanup);
 732
 733 /**
 734  * drm_crtc_index - find the index of a registered CRTC
 735  * @crtc: CRTC to find index for
 736  *
 737  * Given a registered CRTC, return the index of that CRTC within a DRM
 738  * device's list of CRTCs.
 739  */
 740 unsigned int drm_crtc_index(struct drm_crtc *crtc)
 741 {
 742         unsigned int index = 0;
 743         struct drm_crtc *tmp;
 744
 745         list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
 746                 if (tmp == crtc)
 747                         return index;
 748
 749                 index++;
 750         }
 751
 752         BUG();
 753 }
 754 EXPORT_SYMBOL(drm_crtc_index);
 755
 756 /*
 757  * drm_mode_remove - remove and free a mode
 758  * @connector: connector list to modify
 759  * @mode: mode to remove
 760  *
 761  * Remove @mode from @connector's mode list, then free it.
 762  */
 763 static void drm_mode_remove(struct drm_connector *connector,
 764                             struct drm_display_mode *mode)
 765 {
 766         list_del(&mode->head);
 767         drm_mode_destroy(connector->dev, mode);
 768 }
 769
 770 /**
 771  * drm_connector_get_cmdline_mode - reads the user's cmdline mode
 772  * @connector: connector to quwery
 773  *
 774  * The kernel supports per-connector configration of its consoles through
 775  * use of the video= parameter. This function parses that option and
 776  * extracts the user's specified mode (or enable/disable status) for a
 777  * particular connector. This is typically only used during the early fbdev
 778  * setup.
 779  */
 780 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
 781 {
 782         struct drm_cmdline_mode *mode = &connector->cmdline_mode;
 783         char *option = NULL;
 784
 785         if (fb_get_options(connector->name, &option))
 786                 return;
 787
 788         if (!drm_mode_parse_command_line_for_connector(option,
 789                                                        connector,
 790                                                        mode))
 791                 return;
 792
 793         if (mode->force) {
 794                 const char *s;
 795
 796                 switch (mode->force) {
 797                 case DRM_FORCE_OFF:
 798                         s = "OFF";
 799                         break;
 800                 case DRM_FORCE_ON_DIGITAL:
 801                         s = "ON - dig";
 802                         break;
 803                 default:
 804                 case DRM_FORCE_ON:
 805                         s = "ON";
 806                         break;
 807                 }
 808
 809                 DRM_INFO("forcing %s connector %s\n", connector->name, s);
 810                 connector->force = mode->force;
 811         }
 812
 813         DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
 814                       connector->name,
 815                       mode->xres, mode->yres,
 816                       mode->refresh_specified ? mode->refresh : 60,
 817                       mode->rb ? " reduced blanking" : "",
 818                       mode->margins ? " with margins" : "",
 819                       mode->interlace ?  " interlaced" : "");
 820 }
 821
 822 /**
 823  * drm_connector_init - Init a preallocated connector
 824  * @dev: DRM device
 825  * @connector: the connector to init
 826  * @funcs: callbacks for this connector
 827  * @connector_type: user visible type of the connector
 828  *
 829  * Initialises a preallocated connector. Connectors should be
 830  * subclassed as part of driver connector objects.
 831  *
 832  * Returns:
 833  * Zero on success, error code on failure.
 834  */
 835 int drm_connector_init(struct drm_device *dev,
 836                        struct drm_connector *connector,
 837                        const struct drm_connector_funcs *funcs,
 838                        int connector_type)
 839 {
 840         int ret;
 841         struct ida *connector_ida =
 842                 &drm_connector_enum_list[connector_type].ida;
 843
 844         drm_modeset_lock_all(dev);
 845
 846         ret = drm_mode_object_get_reg(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR, false);
 847         if (ret)
 848                 goto out_unlock;
 849
 850         connector->base.properties = &connector->properties;
 851         connector->dev = dev;
 852         connector->funcs = funcs;
 853         connector->connector_type = connector_type;
 854         connector->connector_type_id =
 855                 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
 856         if (connector->connector_type_id < 0) {
 857                 ret = connector->connector_type_id;
 858                 goto out_put;
 859         }
 860         connector->name =
 861                 kasprintf(GFP_KERNEL, "%s-%d",
 862                           drm_connector_enum_list[connector_type].name,
 863                           connector->connector_type_id);
 864         if (!connector->name) {
 865                 ret = -ENOMEM;
 866                 goto out_put;
 867         }
 868
 869         INIT_LIST_HEAD(&connector->probed_modes);
 870         INIT_LIST_HEAD(&connector->modes);
 871         connector->edid_blob_ptr = NULL;
 872         connector->status = connector_status_unknown;
 873
 874         drm_connector_get_cmdline_mode(connector);
 875
 876         /* We should add connectors at the end to avoid upsetting the connector
 877          * index too much. */
 878         list_add_tail(&connector->head, &dev->mode_config.connector_list);
 879         dev->mode_config.num_connector++;
 880
 881         if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
 882                 drm_object_attach_property(&connector->base,
 883                                               dev->mode_config.edid_property,
 884                                               0);
 885
 886         drm_object_attach_property(&connector->base,
 887                                       dev->mode_config.dpms_property, 0);
 888
 889         connector->debugfs_entry = NULL;
 890
 891 out_put:
 892         if (ret)
 893                 drm_mode_object_put(dev, &connector->base);
 894
 895 out_unlock:
 896         drm_modeset_unlock_all(dev);
 897
 898         return ret;
 899 }
 900 EXPORT_SYMBOL(drm_connector_init);
 901
 902 /**
 903  * drm_connector_cleanup - cleans up an initialised connector
 904  * @connector: connector to cleanup
 905  *
 906  * Cleans up the connector but doesn't free the object.
 907  */
 908 void drm_connector_cleanup(struct drm_connector *connector)
 909 {
 910         struct drm_device *dev = connector->dev;
 911         struct drm_display_mode *mode, *t;
 912
 913         if (connector->tile_group) {
 914                 drm_mode_put_tile_group(dev, connector->tile_group);
 915                 connector->tile_group = NULL;
 916         }
 917
 918         list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
 919                 drm_mode_remove(connector, mode);
 920
 921         list_for_each_entry_safe(mode, t, &connector->modes, head)
 922                 drm_mode_remove(connector, mode);
 923
 924         ida_remove(&drm_connector_enum_list[connector->connector_type].ida,
 925                    connector->connector_type_id);
 926
 927         drm_mode_object_put(dev, &connector->base);
 928         kfree(connector->name);
 929         connector->name = NULL;
 930         list_del(&connector->head);
 931         dev->mode_config.num_connector--;
 932
 933         WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
 934         if (connector->state && connector->funcs->atomic_destroy_state)
 935                 connector->funcs->atomic_destroy_state(connector,
 936                                                        connector->state);
 937
 938         memset(connector, 0, sizeof(*connector));
 939 }
 940 EXPORT_SYMBOL(drm_connector_cleanup);
 941
 942 /**
 943  * drm_connector_index - find the index of a registered connector
 944  * @connector: connector to find index for
 945  *
 946  * Given a registered connector, return the index of that connector within a DRM
 947  * device's list of connectors.
 948  */
 949 unsigned int drm_connector_index(struct drm_connector *connector)
 950 {
 951         unsigned int index = 0;
 952         struct drm_connector *tmp;
 953         struct drm_mode_config *config = &connector->dev->mode_config;
 954
 955         WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
 956
 957         list_for_each_entry(tmp, &connector->dev->mode_config.connector_list, head) {
 958                 if (tmp == connector)
 959                         return index;
 960
 961                 index++;
 962         }
 963
 964         BUG();
 965 }
 966 EXPORT_SYMBOL(drm_connector_index);
 967
 968 /**
 969  * drm_connector_register - register a connector
 970  * @connector: the connector to register
 971  *
 972  * Register userspace interfaces for a connector
 973  *
 974  * Returns:
 975  * Zero on success, error code on failure.
 976  */
 977 int drm_connector_register(struct drm_connector *connector)
 978 {
 979         int ret;
 980
 981         drm_mode_object_register(connector->dev, &connector->base);
 982
 983         ret = drm_sysfs_connector_add(connector);
 984         if (ret)
 985                 return ret;
 986
 987         ret = drm_debugfs_connector_add(connector);
 988         if (ret) {
 989                 drm_sysfs_connector_remove(connector);
 990                 return ret;
 991         }
 992
 993         return 0;
 994 }
 995 EXPORT_SYMBOL(drm_connector_register);
 996
 997 /**
 998  * drm_connector_unregister - unregister a connector
 999  * @connector: the connector to unregister
1000  *
1001  * Unregister userspace interfaces for a connector
1002  */
1003 void drm_connector_unregister(struct drm_connector *connector)
1004 {
1005         drm_sysfs_connector_remove(connector);
1006         drm_debugfs_connector_remove(connector);
1007 }
1008 EXPORT_SYMBOL(drm_connector_unregister);
1009
1010
1011 /**
1012  * drm_connector_unplug_all - unregister connector userspace interfaces
1013  * @dev: drm device
1014  *
1015  * This function unregisters all connector userspace interfaces in sysfs. Should
1016  * be call when the device is disconnected, e.g. from an usb driver's
1017  * ->disconnect callback.
1018  */
1019 void drm_connector_unplug_all(struct drm_device *dev)
1020 {
1021         struct drm_connector *connector;
1022
1023         /* taking the mode config mutex ends up in a clash with sysfs */
1024         list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1025                 drm_connector_unregister(connector);
1026
1027 }
1028 EXPORT_SYMBOL(drm_connector_unplug_all);
1029
1030 /**
1031  * drm_bridge_init - initialize a drm transcoder/bridge
1032  * @dev: drm device
1033  * @bridge: transcoder/bridge to set up
1034  * @funcs: bridge function table
1035  *
1036  * Initialises a preallocated bridge. Bridges should be
1037  * subclassed as part of driver connector objects.
1038  *
1039  * Returns:
1040  * Zero on success, error code on failure.
1041  */
1042 int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
1043                 const struct drm_bridge_funcs *funcs)
1044 {
1045         int ret;
1046
1047         drm_modeset_lock_all(dev);
1048
1049         ret = drm_mode_object_get(dev, &bridge->base, DRM_MODE_OBJECT_BRIDGE);
1050         if (ret)
1051                 goto out;
1052
1053         bridge->dev = dev;
1054         bridge->funcs = funcs;
1055
1056         list_add_tail(&bridge->head, &dev->mode_config.bridge_list);
1057         dev->mode_config.num_bridge++;
1058
1059  out:
1060         drm_modeset_unlock_all(dev);
1061         return ret;
1062 }
1063 EXPORT_SYMBOL(drm_bridge_init);
1064
1065 /**
1066  * drm_bridge_cleanup - cleans up an initialised bridge
1067  * @bridge: bridge to cleanup
1068  *
1069  * Cleans up the bridge but doesn't free the object.
1070  */
1071 void drm_bridge_cleanup(struct drm_bridge *bridge)
1072 {
1073         struct drm_device *dev = bridge->dev;
1074
1075         drm_modeset_lock_all(dev);
1076         drm_mode_object_put(dev, &bridge->base);
1077         list_del(&bridge->head);
1078         dev->mode_config.num_bridge--;
1079         drm_modeset_unlock_all(dev);
1080
1081         memset(bridge, 0, sizeof(*bridge));
1082 }
1083 EXPORT_SYMBOL(drm_bridge_cleanup);
1084
1085 /**
1086  * drm_encoder_init - Init a preallocated encoder
1087  * @dev: drm device
1088  * @encoder: the encoder to init
1089  * @funcs: callbacks for this encoder
1090  * @encoder_type: user visible type of the encoder
1091  *
1092  * Initialises a preallocated encoder. Encoder should be
1093  * subclassed as part of driver encoder objects.
1094  *
1095  * Returns:
1096  * Zero on success, error code on failure.
1097  */
1098 int drm_encoder_init(struct drm_device *dev,
1099                       struct drm_encoder *encoder,
1100                       const struct drm_encoder_funcs *funcs,
1101                       int encoder_type)
1102 {
1103         int ret;
1104
1105         drm_modeset_lock_all(dev);
1106
1107         ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
1108         if (ret)
1109                 goto out_unlock;
1110
1111         encoder->dev = dev;
1112         encoder->encoder_type = encoder_type;
1113         encoder->funcs = funcs;
1114         encoder->name = kasprintf(GFP_KERNEL, "%s-%d",
1115                                   drm_encoder_enum_list[encoder_type].name,
1116                                   encoder->base.id);
1117         if (!encoder->name) {
1118                 ret = -ENOMEM;
1119                 goto out_put;
1120         }
1121
1122         list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
1123         dev->mode_config.num_encoder++;
1124
1125 out_put:
1126         if (ret)
1127                 drm_mode_object_put(dev, &encoder->base);
1128
1129 out_unlock:
1130         drm_modeset_unlock_all(dev);
1131
1132         return ret;
1133 }
1134 EXPORT_SYMBOL(drm_encoder_init);
1135
1136 /**
1137  * drm_encoder_cleanup - cleans up an initialised encoder
1138  * @encoder: encoder to cleanup
1139  *
1140  * Cleans up the encoder but doesn't free the object.
1141  */
1142 void drm_encoder_cleanup(struct drm_encoder *encoder)
1143 {
1144         struct drm_device *dev = encoder->dev;
1145         drm_modeset_lock_all(dev);
1146         drm_mode_object_put(dev, &encoder->base);
1147         kfree(encoder->name);
1148         list_del(&encoder->head);
1149         dev->mode_config.num_encoder--;
1150         drm_modeset_unlock_all(dev);
1151
1152         memset(encoder, 0, sizeof(*encoder));
1153 }
1154 EXPORT_SYMBOL(drm_encoder_cleanup);
1155
1156 /**
1157  * drm_universal_plane_init - Initialize a new universal plane object
1158  * @dev: DRM device
1159  * @plane: plane object to init
1160  * @possible_crtcs: bitmask of possible CRTCs
1161  * @funcs: callbacks for the new plane
1162  * @formats: array of supported formats (%DRM_FORMAT_*)
1163  * @format_count: number of elements in @formats
1164  * @type: type of plane (overlay, primary, cursor)
1165  *
1166  * Initializes a plane object of type @type.
1167  *
1168  * Returns:
1169  * Zero on success, error code on failure.
1170  */
1171 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
1172                              unsigned long possible_crtcs,
1173                              const struct drm_plane_funcs *funcs,
1174                              const uint32_t *formats, uint32_t format_count,
1175                              enum drm_plane_type type)
1176 {
1177         int ret;
1178
1179         ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
1180         if (ret)
1181                 return ret;
1182
1183         drm_modeset_lock_init(&plane->mutex);
1184
1185         plane->base.properties = &plane->properties;
1186         plane->dev = dev;
1187         plane->funcs = funcs;
1188         plane->format_types = kmalloc(sizeof(uint32_t) * format_count,
1189                                       GFP_KERNEL);
1190         if (!plane->format_types) {
1191                 DRM_DEBUG_KMS("out of memory when allocating plane\n");
1192                 drm_mode_object_put(dev, &plane->base);
1193                 return -ENOMEM;
1194         }
1195
1196         memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
1197         plane->format_count = format_count;
1198         plane->possible_crtcs = possible_crtcs;
1199         plane->type = type;
1200
1201         list_add_tail(&plane->head, &dev->mode_config.plane_list);
1202         dev->mode_config.num_total_plane++;
1203         if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1204                 dev->mode_config.num_overlay_plane++;
1205
1206         drm_object_attach_property(&plane->base,
1207                                    dev->mode_config.plane_type_property,
1208                                    plane->type);
1209
1210         return 0;
1211 }
1212 EXPORT_SYMBOL(drm_universal_plane_init);
1213
1214 /**
1215  * drm_plane_init - Initialize a legacy plane
1216  * @dev: DRM device
1217  * @plane: plane object to init
1218  * @possible_crtcs: bitmask of possible CRTCs
1219  * @funcs: callbacks for the new plane
1220  * @formats: array of supported formats (%DRM_FORMAT_*)
1221  * @format_count: number of elements in @formats
1222  * @is_primary: plane type (primary vs overlay)
1223  *
1224  * Legacy API to initialize a DRM plane.
1225  *
1226  * New drivers should call drm_universal_plane_init() instead.
1227  *
1228  * Returns:
1229  * Zero on success, error code on failure.
1230  */
1231 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
1232                    unsigned long possible_crtcs,
1233                    const struct drm_plane_funcs *funcs,
1234                    const uint32_t *formats, uint32_t format_count,
1235                    bool is_primary)
1236 {
1237         enum drm_plane_type type;
1238
1239         type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
1240         return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
1241                                         formats, format_count, type);
1242 }
1243 EXPORT_SYMBOL(drm_plane_init);
1244
1245 /**
1246  * drm_plane_cleanup - Clean up the core plane usage
1247  * @plane: plane to cleanup
1248  *
1249  * This function cleans up @plane and removes it from the DRM mode setting
1250  * core. Note that the function does *not* free the plane structure itself,
1251  * this is the responsibility of the caller.
1252  */
1253 void drm_plane_cleanup(struct drm_plane *plane)
1254 {
1255         struct drm_device *dev = plane->dev;
1256
1257         drm_modeset_lock_all(dev);
1258         kfree(plane->format_types);
1259         drm_mode_object_put(dev, &plane->base);
1260
1261         BUG_ON(list_empty(&plane->head));
1262
1263         list_del(&plane->head);
1264         dev->mode_config.num_total_plane--;
1265         if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1266                 dev->mode_config.num_overlay_plane--;
1267         drm_modeset_unlock_all(dev);
1268
1269         WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
1270         if (plane->state && plane->funcs->atomic_destroy_state)
1271                 plane->funcs->atomic_destroy_state(plane, plane->state);
1272
1273         memset(plane, 0, sizeof(*plane));
1274 }
1275 EXPORT_SYMBOL(drm_plane_cleanup);
1276
1277 /**
1278  * drm_plane_index - find the index of a registered plane
1279  * @plane: plane to find index for
1280  *
1281  * Given a registered plane, return the index of that CRTC within a DRM
1282  * device's list of planes.
1283  */
1284 unsigned int drm_plane_index(struct drm_plane *plane)
1285 {
1286         unsigned int index = 0;
1287         struct drm_plane *tmp;
1288
1289         list_for_each_entry(tmp, &plane->dev->mode_config.plane_list, head) {
1290                 if (tmp == plane)
1291                         return index;
1292
1293                 index++;
1294         }
1295
1296         BUG();
1297 }
1298 EXPORT_SYMBOL(drm_plane_index);
1299
1300 /**
1301  * drm_plane_force_disable - Forcibly disable a plane
1302  * @plane: plane to disable
1303  *
1304  * Forces the plane to be disabled.
1305  *
1306  * Used when the plane's current framebuffer is destroyed,
1307  * and when restoring fbdev mode.
1308  */
1309 void drm_plane_force_disable(struct drm_plane *plane)
1310 {
1311         int ret;
1312
1313         if (!plane->fb)
1314                 return;
1315
1316         plane->old_fb = plane->fb;
1317         ret = plane->funcs->disable_plane(plane);
1318         if (ret) {
1319                 DRM_ERROR("failed to disable plane with busy fb\n");
1320                 plane->old_fb = NULL;
1321                 return;
1322         }
1323         /* disconnect the plane from the fb and crtc: */
1324         __drm_framebuffer_unreference(plane->old_fb);
1325         plane->old_fb = NULL;
1326         plane->fb = NULL;
1327         plane->crtc = NULL;
1328 }
1329 EXPORT_SYMBOL(drm_plane_force_disable);
1330
1331 static int drm_mode_create_standard_connector_properties(struct drm_device *dev)
1332 {
1333         struct drm_property *edid;
1334         struct drm_property *dpms;
1335         struct drm_property *dev_path;
1336
1337         /*
1338          * Standard properties (apply to all connectors)
1339          */
1340         edid = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1341                                    DRM_MODE_PROP_IMMUTABLE,
1342                                    "EDID", 0);
1343         dev->mode_config.edid_property = edid;
1344
1345         dpms = drm_property_create_enum(dev, 0,
1346                                    "DPMS", drm_dpms_enum_list,
1347                                    ARRAY_SIZE(drm_dpms_enum_list));
1348         dev->mode_config.dpms_property = dpms;
1349
1350         dev_path = drm_property_create(dev,
1351                                        DRM_MODE_PROP_BLOB |
1352                                        DRM_MODE_PROP_IMMUTABLE,
1353                                        "PATH", 0);
1354         dev->mode_config.path_property = dev_path;
1355
1356         dev->mode_config.tile_property = drm_property_create(dev,
1357                                                              DRM_MODE_PROP_BLOB |
1358                                                              DRM_MODE_PROP_IMMUTABLE,
1359                                                              "TILE", 0);
1360
1361         return 0;
1362 }
1363
1364 static int drm_mode_create_standard_plane_properties(struct drm_device *dev)
1365 {
1366         struct drm_property *type;
1367
1368         /*
1369          * Standard properties (apply to all planes)
1370          */
1371         type = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1372                                         "type", drm_plane_type_enum_list,
1373                                         ARRAY_SIZE(drm_plane_type_enum_list));
1374         dev->mode_config.plane_type_property = type;
1375
1376         return 0;
1377 }
1378
1379 /**
1380  * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1381  * @dev: DRM device
1382  *
1383  * Called by a driver the first time a DVI-I connector is made.
1384  */
1385 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1386 {
1387         struct drm_property *dvi_i_selector;
1388         struct drm_property *dvi_i_subconnector;
1389
1390         if (dev->mode_config.dvi_i_select_subconnector_property)
1391                 return 0;
1392
1393         dvi_i_selector =
1394                 drm_property_create_enum(dev, 0,
1395                                     "select subconnector",
1396                                     drm_dvi_i_select_enum_list,
1397                                     ARRAY_SIZE(drm_dvi_i_select_enum_list));
1398         dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1399
1400         dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1401                                     "subconnector",
1402                                     drm_dvi_i_subconnector_enum_list,
1403                                     ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1404         dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1405
1406         return 0;
1407 }
1408 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1409
1410 /**
1411  * drm_create_tv_properties - create TV specific connector properties
1412  * @dev: DRM device
1413  * @num_modes: number of different TV formats (modes) supported
1414  * @modes: array of pointers to strings containing name of each format
1415  *
1416  * Called by a driver's TV initialization routine, this function creates
1417  * the TV specific connector properties for a given device.  Caller is
1418  * responsible for allocating a list of format names and passing them to
1419  * this routine.
1420  */
1421 int drm_mode_create_tv_properties(struct drm_device *dev,
1422                                   unsigned int num_modes,
1423                                   char *modes[])
1424 {
1425         struct drm_property *tv_selector;
1426         struct drm_property *tv_subconnector;
1427         unsigned int i;
1428
1429         if (dev->mode_config.tv_select_subconnector_property)
1430                 return 0;
1431
1432         /*
1433          * Basic connector properties
1434          */
1435         tv_selector = drm_property_create_enum(dev, 0,
1436                                           "select subconnector",
1437                                           drm_tv_select_enum_list,
1438                                           ARRAY_SIZE(drm_tv_select_enum_list));
1439         dev->mode_config.tv_select_subconnector_property = tv_selector;
1440
1441         tv_subconnector =
1442                 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1443                                     "subconnector",
1444                                     drm_tv_subconnector_enum_list,
1445                                     ARRAY_SIZE(drm_tv_subconnector_enum_list));
1446         dev->mode_config.tv_subconnector_property = tv_subconnector;
1447
1448         /*
1449          * Other, TV specific properties: margins & TV modes.
1450          */
1451         dev->mode_config.tv_left_margin_property =
1452                 drm_property_create_range(dev, 0, "left margin", 0, 100);
1453
1454         dev->mode_config.tv_right_margin_property =
1455                 drm_property_create_range(dev, 0, "right margin", 0, 100);
1456
1457         dev->mode_config.tv_top_margin_property =
1458                 drm_property_create_range(dev, 0, "top margin", 0, 100);
1459
1460         dev->mode_config.tv_bottom_margin_property =
1461                 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1462
1463         dev->mode_config.tv_mode_property =
1464                 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1465                                     "mode", num_modes);
1466         for (i = 0; i < num_modes; i++)
1467                 drm_property_add_enum(dev->mode_config.tv_mode_property, i,
1468                                       i, modes[i]);
1469
1470         dev->mode_config.tv_brightness_property =
1471                 drm_property_create_range(dev, 0, "brightness", 0, 100);
1472
1473         dev->mode_config.tv_contrast_property =
1474                 drm_property_create_range(dev, 0, "contrast", 0, 100);
1475
1476         dev->mode_config.tv_flicker_reduction_property =
1477                 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1478
1479         dev->mode_config.tv_overscan_property =
1480                 drm_property_create_range(dev, 0, "overscan", 0, 100);
1481
1482         dev->mode_config.tv_saturation_property =
1483                 drm_property_create_range(dev, 0, "saturation", 0, 100);
1484
1485         dev->mode_config.tv_hue_property =
1486                 drm_property_create_range(dev, 0, "hue", 0, 100);
1487
1488         return 0;
1489 }
1490 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1491
1492 /**
1493  * drm_mode_create_scaling_mode_property - create scaling mode property
1494  * @dev: DRM device
1495  *
1496  * Called by a driver the first time it's needed, must be attached to desired
1497  * connectors.
1498  */
1499 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1500 {
1501         struct drm_property *scaling_mode;
1502
1503         if (dev->mode_config.scaling_mode_property)
1504                 return 0;
1505
1506         scaling_mode =
1507                 drm_property_create_enum(dev, 0, "scaling mode",
1508                                 drm_scaling_mode_enum_list,
1509                                     ARRAY_SIZE(drm_scaling_mode_enum_list));
1510
1511         dev->mode_config.scaling_mode_property = scaling_mode;
1512
1513         return 0;
1514 }
1515 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1516
1517 /**
1518  * drm_mode_create_aspect_ratio_property - create aspect ratio property
1519  * @dev: DRM device
1520  *
1521  * Called by a driver the first time it's needed, must be attached to desired
1522  * connectors.
1523  *
1524  * Returns:
1525  * Zero on success, negative errno on failure.
1526  */
1527 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1528 {
1529         if (dev->mode_config.aspect_ratio_property)
1530                 return 0;
1531
1532         dev->mode_config.aspect_ratio_property =
1533                 drm_property_create_enum(dev, 0, "aspect ratio",
1534                                 drm_aspect_ratio_enum_list,
1535                                 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1536
1537         if (dev->mode_config.aspect_ratio_property == NULL)
1538                 return -ENOMEM;
1539
1540         return 0;
1541 }
1542 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1543
1544 /**
1545  * drm_mode_create_dirty_property - create dirty property
1546  * @dev: DRM device
1547  *
1548  * Called by a driver the first time it's needed, must be attached to desired
1549  * connectors.
1550  */
1551 int drm_mode_create_dirty_info_property(struct drm_device *dev)
1552 {
1553         struct drm_property *dirty_info;
1554
1555         if (dev->mode_config.dirty_info_property)
1556                 return 0;
1557
1558         dirty_info =
1559                 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1560                                     "dirty",
1561                                     drm_dirty_info_enum_list,
1562                                     ARRAY_SIZE(drm_dirty_info_enum_list));
1563         dev->mode_config.dirty_info_property = dirty_info;
1564
1565         return 0;
1566 }
1567 EXPORT_SYMBOL(drm_mode_create_dirty_info_property);
1568
1569 /**
1570  * drm_mode_create_suggested_offset_properties - create suggests offset properties
1571  * @dev: DRM device
1572  *
1573  * Create the the suggested x/y offset property for connectors.
1574  */
1575 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1576 {
1577         if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1578                 return 0;
1579
1580         dev->mode_config.suggested_x_property =
1581                 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1582
1583         dev->mode_config.suggested_y_property =
1584                 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1585
1586         if (dev->mode_config.suggested_x_property == NULL ||
1587             dev->mode_config.suggested_y_property == NULL)
1588                 return -ENOMEM;
1589         return 0;
1590 }
1591 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1592
1593 static int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
1594 {
1595         uint32_t total_objects = 0;
1596
1597         total_objects += dev->mode_config.num_crtc;
1598         total_objects += dev->mode_config.num_connector;
1599         total_objects += dev->mode_config.num_encoder;
1600         total_objects += dev->mode_config.num_bridge;
1601
1602         group->id_list = kzalloc(total_objects * sizeof(uint32_t), GFP_KERNEL);
1603         if (!group->id_list)
1604                 return -ENOMEM;
1605
1606         group->num_crtcs = 0;
1607         group->num_connectors = 0;
1608         group->num_encoders = 0;
1609         group->num_bridges = 0;
1610         return 0;
1611 }
1612
1613 void drm_mode_group_destroy(struct drm_mode_group *group)
1614 {
1615         kfree(group->id_list);
1616         group->id_list = NULL;
1617 }
1618
1619 /*
1620  * NOTE: Driver's shouldn't ever call drm_mode_group_init_legacy_group - it is
1621  * the drm core's responsibility to set up mode control groups.
1622  */
1623 int drm_mode_group_init_legacy_group(struct drm_device *dev,
1624                                      struct drm_mode_group *group)
1625 {
1626         struct drm_crtc *crtc;
1627         struct drm_encoder *encoder;
1628         struct drm_connector *connector;
1629         struct drm_bridge *bridge;
1630         int ret;
1631
1632         if ((ret = drm_mode_group_init(dev, group)))
1633                 return ret;
1634
1635         list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
1636                 group->id_list[group->num_crtcs++] = crtc->base.id;
1637
1638         list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
1639                 group->id_list[group->num_crtcs + group->num_encoders++] =
1640                 encoder->base.id;
1641
1642         list_for_each_entry(connector, &dev->mode_config.connector_list, head)
1643                 group->id_list[group->num_crtcs + group->num_encoders +
1644                                group->num_connectors++] = connector->base.id;
1645
1646         list_for_each_entry(bridge, &dev->mode_config.bridge_list, head)
1647                 group->id_list[group->num_crtcs + group->num_encoders +
1648                                group->num_connectors + group->num_bridges++] =
1649                                         bridge->base.id;
1650
1651         return 0;
1652 }
1653 EXPORT_SYMBOL(drm_mode_group_init_legacy_group);
1654
1655 void drm_reinit_primary_mode_group(struct drm_device *dev)
1656 {
1657         drm_modeset_lock_all(dev);
1658         drm_mode_group_destroy(&dev->primary->mode_group);
1659         drm_mode_group_init_legacy_group(dev, &dev->primary->mode_group);
1660         drm_modeset_unlock_all(dev);
1661 }
1662 EXPORT_SYMBOL(drm_reinit_primary_mode_group);
1663
1664 /**
1665  * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
1666  * @out: drm_mode_modeinfo struct to return to the user
1667  * @in: drm_display_mode to use
1668  *
1669  * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
1670  * the user.
1671  */
1672 static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
1673                                       const struct drm_display_mode *in)
1674 {
1675         WARN(in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
1676              in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
1677              in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
1678              in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
1679              in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX,
1680              "timing values too large for mode info\n");
1681
1682         out->clock = in->clock;
1683         out->hdisplay = in->hdisplay;
1684         out->hsync_start = in->hsync_start;
1685         out->hsync_end = in->hsync_end;
1686         out->htotal = in->htotal;
1687         out->hskew = in->hskew;
1688         out->vdisplay = in->vdisplay;
1689         out->vsync_start = in->vsync_start;
1690         out->vsync_end = in->vsync_end;
1691         out->vtotal = in->vtotal;
1692         out->vscan = in->vscan;
1693         out->vrefresh = in->vrefresh;
1694         out->flags = in->flags;
1695         out->type = in->type;
1696         strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1697         out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1698 }
1699
1700 /**
1701  * drm_crtc_convert_umode - convert a modeinfo into a drm_display_mode
1702  * @out: drm_display_mode to return to the user
1703  * @in: drm_mode_modeinfo to use
1704  *
1705  * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
1706  * the caller.
1707  *
1708  * Returns:
1709  * Zero on success, negative errno on failure.
1710  */
1711 static int drm_crtc_convert_umode(struct drm_display_mode *out,
1712                                   const struct drm_mode_modeinfo *in)
1713 {
1714         if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
1715                 return -ERANGE;
1716
1717         if ((in->flags & DRM_MODE_FLAG_3D_MASK) > DRM_MODE_FLAG_3D_MAX)
1718                 return -EINVAL;
1719
1720         out->clock = in->clock;
1721         out->hdisplay = in->hdisplay;
1722         out->hsync_start = in->hsync_start;
1723         out->hsync_end = in->hsync_end;
1724         out->htotal = in->htotal;
1725         out->hskew = in->hskew;
1726         out->vdisplay = in->vdisplay;
1727         out->vsync_start = in->vsync_start;
1728         out->vsync_end = in->vsync_end;
1729         out->vtotal = in->vtotal;
1730         out->vscan = in->vscan;
1731         out->vrefresh = in->vrefresh;
1732         out->flags = in->flags;
1733         out->type = in->type;
1734         strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
1735         out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
1736
1737         return 0;
1738 }
1739
1740 /**
1741  * drm_mode_getresources - get graphics configuration
1742  * @dev: drm device for the ioctl
1743  * @data: data pointer for the ioctl
1744  * @file_priv: drm file for the ioctl call
1745  *
1746  * Construct a set of configuration description structures and return
1747  * them to the user, including CRTC, connector and framebuffer configuration.
1748  *
1749  * Called by the user via ioctl.
1750  *
1751  * Returns:
1752  * Zero on success, negative errno on failure.
1753  */
1754 int drm_mode_getresources(struct drm_device *dev, void *data,
1755                           struct drm_file *file_priv)
1756 {
1757         struct drm_mode_card_res *card_res = data;
1758         struct list_head *lh;
1759         struct drm_framebuffer *fb;
1760         struct drm_connector *connector;
1761         struct drm_crtc *crtc;
1762         struct drm_encoder *encoder;
1763         int ret = 0;
1764         int connector_count = 0;
1765         int crtc_count = 0;
1766         int fb_count = 0;
1767         int encoder_count = 0;
1768         int copied = 0, i;
1769         uint32_t __user *fb_id;
1770         uint32_t __user *crtc_id;
1771         uint32_t __user *connector_id;
1772         uint32_t __user *encoder_id;
1773         struct drm_mode_group *mode_group;
1774
1775         if (!drm_core_check_feature(dev, DRIVER_MODESET))
1776                 return -EINVAL;
1777
1778
1779         mutex_lock(&file_priv->fbs_lock);
1780         /*
1781          * For the non-control nodes we need to limit the list of resources
1782          * by IDs in the group list for this node
1783          */
1784         list_for_each(lh, &file_priv->fbs)
1785                 fb_count++;
1786
1787         /* handle this in 4 parts */
1788         /* FBs */
1789         if (card_res->count_fbs >= fb_count) {
1790                 copied = 0;
1791                 fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
1792                 list_for_each_entry(fb, &file_priv->fbs, filp_head) {
1793                         if (put_user(fb->base.id, fb_id + copied)) {
1794                                 mutex_unlock(&file_priv->fbs_lock);
1795                                 return -EFAULT;
1796                         }
1797                         copied++;
1798                 }
1799         }
1800         card_res->count_fbs = fb_count;
1801         mutex_unlock(&file_priv->fbs_lock);
1802
1803         /* mode_config.mutex protects the connector list against e.g. DP MST
1804          * connector hot-adding. CRTC/Plane lists are invariant. */
1805         mutex_lock(&dev->mode_config.mutex);
1806         if (!drm_is_primary_client(file_priv)) {
1807
1808                 mode_group = NULL;
1809                 list_for_each(lh, &dev->mode_config.crtc_list)
1810                         crtc_count++;
1811
1812                 list_for_each(lh, &dev->mode_config.connector_list)
1813                         connector_count++;
1814
1815                 list_for_each(lh, &dev->mode_config.encoder_list)
1816                         encoder_count++;
1817         } else {
1818
1819                 mode_group = &file_priv->master->minor->mode_group;
1820                 crtc_count = mode_group->num_crtcs;
1821                 connector_count = mode_group->num_connectors;
1822                 encoder_count = mode_group->num_encoders;
1823         }
1824
1825         card_res->max_height = dev->mode_config.max_height;
1826         card_res->min_height = dev->mode_config.min_height;
1827         card_res->max_width = dev->mode_config.max_width;
1828         card_res->min_width = dev->mode_config.min_width;
1829
1830         /* CRTCs */
1831         if (card_res->count_crtcs >= crtc_count) {
1832                 copied = 0;
1833                 crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
1834                 if (!mode_group) {
1835                         list_for_each_entry(crtc, &dev->mode_config.crtc_list,
1836                                             head) {
1837                                 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
1838                                 if (put_user(crtc->base.id, crtc_id + copied)) {
1839                                         ret = -EFAULT;
1840                                         goto out;
1841                                 }
1842                                 copied++;
1843                         }
1844                 } else {
1845                         for (i = 0; i < mode_group->num_crtcs; i++) {
1846                                 if (put_user(mode_group->id_list[i],
1847                                              crtc_id + copied)) {
1848                                         ret = -EFAULT;
1849                                         goto out;
1850                                 }
1851                                 copied++;
1852                         }
1853                 }
1854         }
1855         card_res->count_crtcs = crtc_count;
1856
1857         /* Encoders */
1858         if (card_res->count_encoders >= encoder_count) {
1859                 copied = 0;
1860                 encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
1861                 if (!mode_group) {
1862                         list_for_each_entry(encoder,
1863                                             &dev->mode_config.encoder_list,
1864                                             head) {
1865                                 DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
1866                                                 encoder->name);
1867                                 if (put_user(encoder->base.id, encoder_id +
1868                                              copied)) {
1869                                         ret = -EFAULT;
1870                                         goto out;
1871                                 }
1872                                 copied++;
1873                         }
1874                 } else {
1875                         for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
1876                                 if (put_user(mode_group->id_list[i],
1877                                              encoder_id + copied)) {
1878                                         ret = -EFAULT;
1879                                         goto out;
1880                                 }
1881                                 copied++;
1882                         }
1883
1884                 }
1885         }
1886         card_res->count_encoders = encoder_count;
1887
1888         /* Connectors */
1889         if (card_res->count_connectors >= connector_count) {
1890                 copied = 0;
1891                 connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
1892                 if (!mode_group) {
1893                         list_for_each_entry(connector,
1894                                             &dev->mode_config.connector_list,
1895                                             head) {
1896                                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
1897                                         connector->base.id,
1898                                         connector->name);
1899                                 if (put_user(connector->base.id,
1900                                              connector_id + copied)) {
1901                                         ret = -EFAULT;
1902                                         goto out;
1903                                 }
1904                                 copied++;
1905                         }
1906                 } else {
1907                         int start = mode_group->num_crtcs +
1908                                 mode_group->num_encoders;
1909                         for (i = start; i < start + mode_group->num_connectors; i++) {
1910                                 if (put_user(mode_group->id_list[i],
1911                                              connector_id + copied)) {
1912                                         ret = -EFAULT;
1913                                         goto out;
1914                                 }
1915                                 copied++;
1916                         }
1917                 }
1918         }
1919         card_res->count_connectors = connector_count;
1920
1921         DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
1922                   card_res->count_connectors, card_res->count_encoders);
1923
1924 out:
1925         mutex_unlock(&dev->mode_config.mutex);
1926         return ret;
1927 }
1928
1929 /**
1930  * drm_mode_getcrtc - get CRTC configuration
1931  * @dev: drm device for the ioctl
1932  * @data: data pointer for the ioctl
1933  * @file_priv: drm file for the ioctl call
1934  *
1935  * Construct a CRTC configuration structure to return to the user.
1936  *
1937  * Called by the user via ioctl.
1938  *
1939  * Returns:
1940  * Zero on success, negative errno on failure.
1941  */
1942 int drm_mode_getcrtc(struct drm_device *dev,
1943                      void *data, struct drm_file *file_priv)
1944 {
1945         struct drm_mode_crtc *crtc_resp = data;
1946         struct drm_crtc *crtc;
1947
1948         if (!drm_core_check_feature(dev, DRIVER_MODESET))
1949                 return -EINVAL;
1950
1951         crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
1952         if (!crtc)
1953                 return -ENOENT;
1954
1955         drm_modeset_lock_crtc(crtc, crtc->primary);
1956         crtc_resp->x = crtc->x;
1957         crtc_resp->y = crtc->y;
1958         crtc_resp->gamma_size = crtc->gamma_size;
1959         if (crtc->primary->fb)
1960                 crtc_resp->fb_id = crtc->primary->fb->base.id;
1961         else
1962                 crtc_resp->fb_id = 0;
1963
1964         if (crtc->enabled) {
1965
1966                 drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
1967                 crtc_resp->mode_valid = 1;
1968
1969         } else {
1970                 crtc_resp->mode_valid = 0;
1971         }
1972         drm_modeset_unlock_crtc(crtc);
1973
1974         return 0;
1975 }
1976
1977 static bool drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1978                                          const struct drm_file *file_priv)
1979 {
1980         /*
1981          * If user-space hasn't configured the driver to expose the stereo 3D
1982          * modes, don't expose them.
1983          */
1984         if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1985                 return false;
1986
1987         return true;
1988 }
1989
1990 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
1991 {
1992         /* For atomic drivers only state objects are synchronously updated and
1993          * protected by modeset locks, so check those first. */
1994         if (connector->state)
1995                 return connector->state->best_encoder;
1996         return connector->encoder;
1997 }
1998
1999 /**
2000  * drm_mode_getconnector - get connector configuration
2001  * @dev: drm device for the ioctl
2002  * @data: data pointer for the ioctl
2003  * @file_priv: drm file for the ioctl call
2004  *
2005  * Construct a connector configuration structure to return to the user.
2006  *
2007  * Called by the user via ioctl.
2008  *
2009  * Returns:
2010  * Zero on success, negative errno on failure.
2011  */
2012 int drm_mode_getconnector(struct drm_device *dev, void *data,
2013                           struct drm_file *file_priv)
2014 {
2015         struct drm_mode_get_connector *out_resp = data;
2016         struct drm_connector *connector;
2017         struct drm_encoder *encoder;
2018         struct drm_display_mode *mode;
2019         int mode_count = 0;
2020         int props_count = 0;
2021         int encoders_count = 0;
2022         int ret = 0;
2023         int copied = 0;
2024         int i;
2025         struct drm_mode_modeinfo u_mode;
2026         struct drm_mode_modeinfo __user *mode_ptr;
2027         uint32_t __user *prop_ptr;
2028         uint64_t __user *prop_values;
2029         uint32_t __user *encoder_ptr;
2030
2031         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2032                 return -EINVAL;
2033
2034         memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2035
2036         DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);
2037
2038         mutex_lock(&dev->mode_config.mutex);
2039
2040         connector = drm_connector_find(dev, out_resp->connector_id);
2041         if (!connector) {
2042                 ret = -ENOENT;
2043                 goto out;
2044         }
2045
2046         props_count = connector->properties.count;
2047
2048         for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2049                 if (connector->encoder_ids[i] != 0) {
2050                         encoders_count++;
2051                 }
2052         }
2053
2054         if (out_resp->count_modes == 0) {
2055                 connector->funcs->fill_modes(connector,
2056                                              dev->mode_config.max_width,
2057                                              dev->mode_config.max_height);
2058         }
2059
2060         /* delayed so we get modes regardless of pre-fill_modes state */
2061         list_for_each_entry(mode, &connector->modes, head)
2062                 if (drm_mode_expose_to_userspace(mode, file_priv))
2063                         mode_count++;
2064
2065         out_resp->connector_id = connector->base.id;
2066         out_resp->connector_type = connector->connector_type;
2067         out_resp->connector_type_id = connector->connector_type_id;
2068         out_resp->mm_width = connector->display_info.width_mm;
2069         out_resp->mm_height = connector->display_info.height_mm;
2070         out_resp->subpixel = connector->display_info.subpixel_order;
2071         out_resp->connection = connector->status;
2072         drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2073
2074         encoder = drm_connector_get_encoder(connector);
2075         if (encoder)
2076                 out_resp->encoder_id = encoder->base.id;
2077         else
2078                 out_resp->encoder_id = 0;
2079         drm_modeset_unlock(&dev->mode_config.connection_mutex);
2080
2081         /*
2082          * This ioctl is called twice, once to determine how much space is
2083          * needed, and the 2nd time to fill it.
2084          */
2085         if ((out_resp->count_modes >= mode_count) && mode_count) {
2086                 copied = 0;
2087                 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2088                 list_for_each_entry(mode, &connector->modes, head) {
2089                         if (!drm_mode_expose_to_userspace(mode, file_priv))
2090                                 continue;
2091
2092                         drm_crtc_convert_to_umode(&u_mode, mode);
2093                         if (copy_to_user(mode_ptr + copied,
2094                                          &u_mode, sizeof(u_mode))) {
2095                                 ret = -EFAULT;
2096                                 goto out;
2097                         }
2098                         copied++;
2099                 }
2100         }
2101         out_resp->count_modes = mode_count;
2102
2103         if ((out_resp->count_props >= props_count) && props_count) {
2104                 copied = 0;
2105                 prop_ptr = (uint32_t __user *)(unsigned long)(out_resp->props_ptr);
2106                 prop_values = (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr);
2107                 for (i = 0; i < connector->properties.count; i++) {
2108                         struct drm_property *prop = connector->properties.properties[i];
2109                         uint64_t val;
2110
2111                         ret = drm_object_property_get_value(&connector->base, prop, &val);
2112                         if (ret)
2113                                 goto out;
2114
2115                         if (put_user(prop->base.id, prop_ptr + copied)) {
2116                                 ret = -EFAULT;
2117                                 goto out;
2118                         }
2119                         if (put_user(val, prop_values + copied)) {
2120                                 ret = -EFAULT;
2121                                 goto out;
2122                         }
2123                         copied++;
2124                 }
2125         }
2126         out_resp->count_props = props_count;
2127
2128         if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2129                 copied = 0;
2130                 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2131                 for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
2132                         if (connector->encoder_ids[i] != 0) {
2133                                 if (put_user(connector->encoder_ids[i],
2134                                              encoder_ptr + copied)) {
2135                                         ret = -EFAULT;
2136                                         goto out;
2137                                 }
2138                                 copied++;
2139                         }
2140                 }
2141         }
2142         out_resp->count_encoders = encoders_count;
2143
2144 out:
2145         mutex_unlock(&dev->mode_config.mutex);
2146
2147         return ret;
2148 }
2149
2150 static struct drm_crtc *drm_encoder_get_crtc(struct drm_encoder *encoder)
2151 {
2152         struct drm_connector *connector;
2153         struct drm_device *dev = encoder->dev;
2154         bool uses_atomic = false;
2155
2156         /* For atomic drivers only state objects are synchronously updated and
2157          * protected by modeset locks, so check those first. */
2158         list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
2159                 if (!connector->state)
2160                         continue;
2161
2162                 uses_atomic = true;
2163
2164                 if (connector->state->best_encoder != encoder)
2165                         continue;
2166
2167                 return connector->state->crtc;
2168         }
2169
2170         /* Don't return stale data (e.g. pending async disable). */
2171         if (uses_atomic)
2172                 return NULL;
2173
2174         return encoder->crtc;
2175 }
2176
2177 /**
2178  * drm_mode_getencoder - get encoder configuration
2179  * @dev: drm device for the ioctl
2180  * @data: data pointer for the ioctl
2181  * @file_priv: drm file for the ioctl call
2182  *
2183  * Construct a encoder configuration structure to return to the user.
2184  *
2185  * Called by the user via ioctl.
2186  *
2187  * Returns:
2188  * Zero on success, negative errno on failure.
2189  */
2190 int drm_mode_getencoder(struct drm_device *dev, void *data,
2191                         struct drm_file *file_priv)
2192 {
2193         struct drm_mode_get_encoder *enc_resp = data;
2194         struct drm_encoder *encoder;
2195         struct drm_crtc *crtc;
2196
2197         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2198                 return -EINVAL;
2199
2200         encoder = drm_encoder_find(dev, enc_resp->encoder_id);
2201         if (!encoder)
2202                 return -ENOENT;
2203
2204         drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2205         crtc = drm_encoder_get_crtc(encoder);
2206         if (crtc)
2207                 enc_resp->crtc_id = crtc->base.id;
2208         else if (encoder->crtc)
2209                 enc_resp->crtc_id = encoder->crtc->base.id;
2210         else
2211                 enc_resp->crtc_id = 0;
2212         drm_modeset_unlock(&dev->mode_config.connection_mutex);
2213
2214         enc_resp->encoder_type = encoder->encoder_type;
2215         enc_resp->encoder_id = encoder->base.id;
2216         enc_resp->possible_crtcs = encoder->possible_crtcs;
2217         enc_resp->possible_clones = encoder->possible_clones;
2218
2219         return 0;
2220 }
2221
2222 /**
2223  * drm_mode_getplane_res - enumerate all plane resources
2224  * @dev: DRM device
2225  * @data: ioctl data
2226  * @file_priv: DRM file info
2227  *
2228  * Construct a list of plane ids to return to the user.
2229  *
2230  * Called by the user via ioctl.
2231  *
2232  * Returns:
2233  * Zero on success, negative errno on failure.
2234  */
2235 int drm_mode_getplane_res(struct drm_device *dev, void *data,
2236                           struct drm_file *file_priv)
2237 {
2238         struct drm_mode_get_plane_res *plane_resp = data;
2239         struct drm_mode_config *config;
2240         struct drm_plane *plane;
2241         uint32_t __user *plane_ptr;
2242         int copied = 0;
2243         unsigned num_planes;
2244
2245         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2246                 return -EINVAL;
2247
2248         config = &dev->mode_config;
2249
2250         if (file_priv->universal_planes)
2251                 num_planes = config->num_total_plane;
2252         else
2253                 num_planes = config->num_overlay_plane;
2254
2255         /*
2256          * This ioctl is called twice, once to determine how much space is
2257          * needed, and the 2nd time to fill it.
2258          */
2259         if (num_planes &&
2260             (plane_resp->count_planes >= num_planes)) {
2261                 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
2262
2263                 /* Plane lists are invariant, no locking needed. */
2264                 list_for_each_entry(plane, &config->plane_list, head) {
2265                         /*
2266                          * Unless userspace set the 'universal planes'
2267                          * capability bit, only advertise overlays.
2268                          */
2269                         if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
2270                             !file_priv->universal_planes)
2271                                 continue;
2272
2273                         if (put_user(plane->base.id, plane_ptr + copied))
2274                                 return -EFAULT;
2275                         copied++;
2276                 }
2277         }
2278         plane_resp->count_planes = num_planes;
2279
2280         return 0;
2281 }
2282
2283 /**
2284  * drm_mode_getplane - get plane configuration
2285  * @dev: DRM device
2286  * @data: ioctl data
2287  * @file_priv: DRM file info
2288  *
2289  * Construct a plane configuration structure to return to the user.
2290  *
2291  * Called by the user via ioctl.
2292  *
2293  * Returns:
2294  * Zero on success, negative errno on failure.
2295  */
2296 int drm_mode_getplane(struct drm_device *dev, void *data,
2297                       struct drm_file *file_priv)
2298 {
2299         struct drm_mode_get_plane *plane_resp = data;
2300         struct drm_plane *plane;
2301         uint32_t __user *format_ptr;
2302
2303         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2304                 return -EINVAL;
2305
2306         plane = drm_plane_find(dev, plane_resp->plane_id);
2307         if (!plane)
2308                 return -ENOENT;
2309
2310         drm_modeset_lock(&plane->mutex, NULL);
2311         if (plane->crtc)
2312                 plane_resp->crtc_id = plane->crtc->base.id;
2313         else
2314                 plane_resp->crtc_id = 0;
2315
2316         if (plane->fb)
2317                 plane_resp->fb_id = plane->fb->base.id;
2318         else
2319                 plane_resp->fb_id = 0;
2320         drm_modeset_unlock(&plane->mutex);
2321
2322         plane_resp->plane_id = plane->base.id;
2323         plane_resp->possible_crtcs = plane->possible_crtcs;
2324         plane_resp->gamma_size = 0;
2325
2326         /*
2327          * This ioctl is called twice, once to determine how much space is
2328          * needed, and the 2nd time to fill it.
2329          */
2330         if (plane->format_count &&
2331             (plane_resp->count_format_types >= plane->format_count)) {
2332                 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
2333                 if (copy_to_user(format_ptr,
2334                                  plane->format_types,
2335                                  sizeof(uint32_t) * plane->format_count)) {
2336                         return -EFAULT;
2337                 }
2338         }
2339         plane_resp->count_format_types = plane->format_count;
2340
2341         return 0;
2342 }
2343
2344 /*
2345  * setplane_internal - setplane handler for internal callers
2346  *
2347  * Note that we assume an extra reference has already been taken on fb.  If the
2348  * update fails, this reference will be dropped before return; if it succeeds,
2349  * the previous framebuffer (if any) will be unreferenced instead.
2350  *
2351  * src_{x,y,w,h} are provided in 16.16 fixed point format
2352  */
2353 static int __setplane_internal(struct drm_plane *plane,
2354                                struct drm_crtc *crtc,
2355                                struct drm_framebuffer *fb,
2356                                int32_t crtc_x, int32_t crtc_y,
2357                                uint32_t crtc_w, uint32_t crtc_h,
2358                                /* src_{x,y,w,h} values are 16.16 fixed point */
2359                                uint32_t src_x, uint32_t src_y,
2360                                uint32_t src_w, uint32_t src_h)
2361 {
2362         int ret = 0;
2363         unsigned int fb_width, fb_height;
2364         unsigned int i;
2365
2366         /* No fb means shut it down */
2367         if (!fb) {
2368                 plane->old_fb = plane->fb;
2369                 ret = plane->funcs->disable_plane(plane);
2370                 if (!ret) {
2371                         plane->crtc = NULL;
2372                         plane->fb = NULL;
2373                 } else {
2374                         plane->old_fb = NULL;
2375                 }
2376                 goto out;
2377         }
2378
2379         /* Check whether this plane is usable on this CRTC */
2380         if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
2381                 DRM_DEBUG_KMS("Invalid crtc for plane\n");
2382                 ret = -EINVAL;
2383                 goto out;
2384         }
2385
2386         /* Check whether this plane supports the fb pixel format. */
2387         for (i = 0; i < plane->format_count; i++)
2388                 if (fb->pixel_format == plane->format_types[i])
2389                         break;
2390         if (i == plane->format_count) {
2391                 DRM_DEBUG_KMS("Invalid pixel format %s\n",
2392                               drm_get_format_name(fb->pixel_format));
2393                 ret = -EINVAL;
2394                 goto out;
2395         }
2396
2397         fb_width = fb->width << 16;
2398         fb_height = fb->height << 16;
2399
2400         /* Make sure source coordinates are inside the fb. */
2401         if (src_w > fb_width ||
2402             src_x > fb_width - src_w ||
2403             src_h > fb_height ||
2404             src_y > fb_height - src_h) {
2405                 DRM_DEBUG_KMS("Invalid source coordinates "
2406                               "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
2407                               src_w >> 16, ((src_w & 0xffff) * 15625) >> 10,
2408                               src_h >> 16, ((src_h & 0xffff) * 15625) >> 10,
2409                               src_x >> 16, ((src_x & 0xffff) * 15625) >> 10,
2410                               src_y >> 16, ((src_y & 0xffff) * 15625) >> 10);
2411                 ret = -ENOSPC;
2412                 goto out;
2413         }
2414
2415         plane->old_fb = plane->fb;
2416         ret = plane->funcs->update_plane(plane, crtc, fb,
2417                                          crtc_x, crtc_y, crtc_w, crtc_h,
2418                                          src_x, src_y, src_w, src_h);
2419         if (!ret) {
2420                 plane->crtc = crtc;
2421                 plane->fb = fb;
2422                 fb = NULL;
2423         } else {
2424                 plane->old_fb = NULL;
2425         }
2426
2427 out:
2428         if (fb)
2429                 drm_framebuffer_unreference(fb);
2430         if (plane->old_fb)
2431                 drm_framebuffer_unreference(plane->old_fb);
2432         plane->old_fb = NULL;
2433
2434         return ret;
2435 }
2436
2437 static int setplane_internal(struct drm_plane *plane,
2438                              struct drm_crtc *crtc,
2439                              struct drm_framebuffer *fb,
2440                              int32_t crtc_x, int32_t crtc_y,
2441                              uint32_t crtc_w, uint32_t crtc_h,
2442                              /* src_{x,y,w,h} values are 16.16 fixed point */
2443                              uint32_t src_x, uint32_t src_y,
2444                              uint32_t src_w, uint32_t src_h)
2445 {
2446         int ret;
2447
2448         drm_modeset_lock_all(plane->dev);
2449         ret = __setplane_internal(plane, crtc, fb,
2450                                   crtc_x, crtc_y, crtc_w, crtc_h,
2451                                   src_x, src_y, src_w, src_h);
2452         drm_modeset_unlock_all(plane->dev);
2453
2454         return ret;
2455 }
2456
2457 /**
2458  * drm_mode_setplane - configure a plane's configuration
2459  * @dev: DRM device
2460  * @data: ioctl data*
2461  * @file_priv: DRM file info
2462  *
2463  * Set plane configuration, including placement, fb, scaling, and other factors.
2464  * Or pass a NULL fb to disable (planes may be disabled without providing a
2465  * valid crtc).
2466  *
2467  * Returns:
2468  * Zero on success, negative errno on failure.
2469  */
2470 int drm_mode_setplane(struct drm_device *dev, void *data,
2471                       struct drm_file *file_priv)
2472 {
2473         struct drm_mode_set_plane *plane_req = data;
2474         struct drm_plane *plane;
2475         struct drm_crtc *crtc = NULL;
2476         struct drm_framebuffer *fb = NULL;
2477
2478         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2479                 return -EINVAL;
2480
2481         /* Give drivers some help against integer overflows */
2482         if (plane_req->crtc_w > INT_MAX ||
2483             plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
2484             plane_req->crtc_h > INT_MAX ||
2485             plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
2486                 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
2487                               plane_req->crtc_w, plane_req->crtc_h,
2488                               plane_req->crtc_x, plane_req->crtc_y);
2489                 return -ERANGE;
2490         }
2491
2492         /*
2493          * First, find the plane, crtc, and fb objects.  If not available,
2494          * we don't bother to call the driver.
2495          */
2496         plane = drm_plane_find(dev, plane_req->plane_id);
2497         if (!plane) {
2498                 DRM_DEBUG_KMS("Unknown plane ID %d\n",
2499                               plane_req->plane_id);
2500                 return -ENOENT;
2501         }
2502
2503         if (plane_req->fb_id) {
2504                 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
2505                 if (!fb) {
2506                         DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
2507                                       plane_req->fb_id);
2508                         return -ENOENT;
2509                 }
2510
2511                 crtc = drm_crtc_find(dev, plane_req->crtc_id);
2512                 if (!crtc) {
2513                         DRM_DEBUG_KMS("Unknown crtc ID %d\n",
2514                                       plane_req->crtc_id);
2515                         return -ENOENT;
2516                 }
2517         }
2518
2519         /*
2520          * setplane_internal will take care of deref'ing either the old or new
2521          * framebuffer depending on success.
2522          */
2523         return setplane_internal(plane, crtc, fb,
2524                                  plane_req->crtc_x, plane_req->crtc_y,
2525                                  plane_req->crtc_w, plane_req->crtc_h,
2526                                  plane_req->src_x, plane_req->src_y,
2527                                  plane_req->src_w, plane_req->src_h);
2528 }
2529
2530 /**
2531  * drm_mode_set_config_internal - helper to call ->set_config
2532  * @set: modeset config to set
2533  *
2534  * This is a little helper to wrap internal calls to the ->set_config driver
2535  * interface. The only thing it adds is correct refcounting dance.
2536  *
2537  * Returns:
2538  * Zero on success, negative errno on failure.
2539  */
2540 int drm_mode_set_config_internal(struct drm_mode_set *set)
2541 {
2542         struct drm_crtc *crtc = set->crtc;
2543         struct drm_framebuffer *fb;
2544         struct drm_crtc *tmp;
2545         int ret;
2546
2547         /*
2548          * NOTE: ->set_config can also disable other crtcs (if we steal all
2549          * connectors from it), hence we need to refcount the fbs across all
2550          * crtcs. Atomic modeset will have saner semantics ...
2551          */
2552         list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head)
2553                 tmp->primary->old_fb = tmp->primary->fb;
2554
2555         fb = set->fb;
2556
2557         ret = crtc->funcs->set_config(set);
2558         if (ret == 0) {
2559                 crtc->primary->crtc = crtc;
2560                 crtc->primary->fb = fb;
2561         }
2562
2563         list_for_each_entry(tmp, &crtc->dev->mode_config.crtc_list, head) {
2564                 if (tmp->primary->fb)
2565                         drm_framebuffer_reference(tmp->primary->fb);
2566                 if (tmp->primary->old_fb)
2567                         drm_framebuffer_unreference(tmp->primary->old_fb);
2568                 tmp->primary->old_fb = NULL;
2569         }
2570
2571         return ret;
2572 }
2573 EXPORT_SYMBOL(drm_mode_set_config_internal);
2574
2575 /**
2576  * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
2577  *     CRTC viewport
2578  * @crtc: CRTC that framebuffer will be displayed on
2579  * @x: x panning
2580  * @y: y panning
2581  * @mode: mode that framebuffer will be displayed under
2582  * @fb: framebuffer to check size of
2583  */
2584 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
2585                             int x, int y,
2586                             const struct drm_display_mode *mode,
2587                             const struct drm_framebuffer *fb)
2588
2589 {
2590         int hdisplay, vdisplay;
2591
2592         hdisplay = mode->hdisplay;
2593         vdisplay = mode->vdisplay;
2594
2595         if (drm_mode_is_stereo(mode)) {
2596                 struct drm_display_mode adjusted = *mode;
2597
2598                 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE);
2599                 hdisplay = adjusted.crtc_hdisplay;
2600                 vdisplay = adjusted.crtc_vdisplay;
2601         }
2602
2603         if (crtc->invert_dimensions)
2604                 swap(hdisplay, vdisplay);
2605
2606         if (hdisplay > fb->width ||
2607             vdisplay > fb->height ||
2608             x > fb->width - hdisplay ||
2609             y > fb->height - vdisplay) {
2610                 DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
2611                               fb->width, fb->height, hdisplay, vdisplay, x, y,
2612                               crtc->invert_dimensions ? " (inverted)" : "");
2613                 return -ENOSPC;
2614         }
2615
2616         return 0;
2617 }
2618 EXPORT_SYMBOL(drm_crtc_check_viewport);
2619
2620 /**
2621  * drm_mode_setcrtc - set CRTC configuration
2622  * @dev: drm device for the ioctl
2623  * @data: data pointer for the ioctl
2624  * @file_priv: drm file for the ioctl call
2625  *
2626  * Build a new CRTC configuration based on user request.
2627  *
2628  * Called by the user via ioctl.
2629  *
2630  * Returns:
2631  * Zero on success, negative errno on failure.
2632  */
2633 int drm_mode_setcrtc(struct drm_device *dev, void *data,
2634                      struct drm_file *file_priv)
2635 {
2636         struct drm_mode_config *config = &dev->mode_config;
2637         struct drm_mode_crtc *crtc_req = data;
2638         struct drm_crtc *crtc;
2639         struct drm_connector **connector_set = NULL, *connector;
2640         struct drm_framebuffer *fb = NULL;
2641         struct drm_display_mode *mode = NULL;
2642         struct drm_mode_set set;
2643         uint32_t __user *set_connectors_ptr;
2644         int ret;
2645         int i;
2646
2647         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2648                 return -EINVAL;
2649
2650         /* For some reason crtc x/y offsets are signed internally. */
2651         if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
2652                 return -ERANGE;
2653
2654         drm_modeset_lock_all(dev);
2655         crtc = drm_crtc_find(dev, crtc_req->crtc_id);
2656         if (!crtc) {
2657                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
2658                 ret = -ENOENT;
2659                 goto out;
2660         }
2661         DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
2662
2663         if (crtc_req->mode_valid) {
2664                 /* If we have a mode we need a framebuffer. */
2665                 /* If we pass -1, set the mode with the currently bound fb */
2666                 if (crtc_req->fb_id == -1) {
2667                         if (!crtc->primary->fb) {
2668                                 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
2669                                 ret = -EINVAL;
2670                                 goto out;
2671                         }
2672                         fb = crtc->primary->fb;
2673                         /* Make refcounting symmetric with the lookup path. */
2674                         drm_framebuffer_reference(fb);
2675                 } else {
2676                         fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
2677                         if (!fb) {
2678                                 DRM_DEBUG_KMS("Unknown FB ID%d\n",
2679                                                 crtc_req->fb_id);
2680                                 ret = -ENOENT;
2681                                 goto out;
2682                         }
2683                 }
2684
2685                 mode = drm_mode_create(dev);
2686                 if (!mode) {
2687                         ret = -ENOMEM;
2688                         goto out;
2689                 }
2690
2691                 ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
2692                 if (ret) {
2693                         DRM_DEBUG_KMS("Invalid mode\n");
2694                         goto out;
2695                 }
2696
2697                 drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);
2698
2699                 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
2700                                               mode, fb);
2701                 if (ret)
2702                         goto out;
2703
2704         }
2705
2706         if (crtc_req->count_connectors == 0 && mode) {
2707                 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
2708                 ret = -EINVAL;
2709                 goto out;
2710         }
2711
2712         if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
2713                 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
2714                           crtc_req->count_connectors);
2715                 ret = -EINVAL;
2716                 goto out;
2717         }
2718
2719         if (crtc_req->count_connectors > 0) {
2720                 u32 out_id;
2721
2722                 /* Avoid unbounded kernel memory allocation */
2723                 if (crtc_req->count_connectors > config->num_connector) {
2724                         ret = -EINVAL;
2725                         goto out;
2726                 }
2727
2728                 connector_set = kmalloc(crtc_req->count_connectors *
2729                                         sizeof(struct drm_connector *),
2730                                         GFP_KERNEL);
2731                 if (!connector_set) {
2732                         ret = -ENOMEM;
2733                         goto out;
2734                 }
2735
2736                 for (i = 0; i < crtc_req->count_connectors; i++) {
2737                         set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
2738                         if (get_user(out_id, &set_connectors_ptr[i])) {
2739                                 ret = -EFAULT;
2740                                 goto out;
2741                         }
2742
2743                         connector = drm_connector_find(dev, out_id);
2744                         if (!connector) {
2745                                 DRM_DEBUG_KMS("Connector id %d unknown\n",
2746                                                 out_id);
2747                                 ret = -ENOENT;
2748                                 goto out;
2749                         }
2750                         DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
2751                                         connector->base.id,
2752                                         connector->name);
2753
2754                         connector_set[i] = connector;
2755                 }
2756         }
2757
2758         set.crtc = crtc;
2759         set.x = crtc_req->x;
2760         set.y = crtc_req->y;
2761         set.mode = mode;
2762         set.connectors = connector_set;
2763         set.num_connectors = crtc_req->count_connectors;
2764         set.fb = fb;
2765         ret = drm_mode_set_config_internal(&set);
2766
2767 out:
2768         if (fb)
2769                 drm_framebuffer_unreference(fb);
2770
2771         kfree(connector_set);
2772         drm_mode_destroy(dev, mode);
2773         drm_modeset_unlock_all(dev);
2774         return ret;
2775 }
2776
2777 /**
2778  * drm_mode_cursor_universal - translate legacy cursor ioctl call into a
2779  *     universal plane handler call
2780  * @crtc: crtc to update cursor for
2781  * @req: data pointer for the ioctl
2782  * @file_priv: drm file for the ioctl call
2783  *
2784  * Legacy cursor ioctl's work directly with driver buffer handles.  To
2785  * translate legacy ioctl calls into universal plane handler calls, we need to
2786  * wrap the native buffer handle in a drm_framebuffer.
2787  *
2788  * Note that we assume any handle passed to the legacy ioctls was a 32-bit ARGB
2789  * buffer with a pitch of 4*width; the universal plane interface should be used
2790  * directly in cases where the hardware can support other buffer settings and
2791  * userspace wants to make use of these capabilities.
2792  *
2793  * Returns:
2794  * Zero on success, negative errno on failure.
2795  */
2796 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
2797                                      struct drm_mode_cursor2 *req,
2798                                      struct drm_file *file_priv)
2799 {
2800         struct drm_device *dev = crtc->dev;
2801         struct drm_framebuffer *fb = NULL;
2802         struct drm_mode_fb_cmd2 fbreq = {
2803                 .width = req->width,
2804                 .height = req->height,
2805                 .pixel_format = DRM_FORMAT_ARGB8888,
2806                 .pitches = { req->width * 4 },
2807                 .handles = { req->handle },
2808         };
2809         int32_t crtc_x, crtc_y;
2810         uint32_t crtc_w = 0, crtc_h = 0;
2811         uint32_t src_w = 0, src_h = 0;
2812         int ret = 0;
2813
2814         BUG_ON(!crtc->cursor);
2815         WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
2816
2817         /*
2818          * Obtain fb we'll be using (either new or existing) and take an extra
2819          * reference to it if fb != null.  setplane will take care of dropping
2820          * the reference if the plane update fails.
2821          */
2822         if (req->flags & DRM_MODE_CURSOR_BO) {
2823                 if (req->handle) {
2824                         fb = add_framebuffer_internal(dev, &fbreq, file_priv);
2825                         if (IS_ERR(fb)) {
2826                                 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
2827                                 return PTR_ERR(fb);
2828                         }
2829
2830                         drm_framebuffer_reference(fb);
2831                 } else {
2832                         fb = NULL;
2833                 }
2834         } else {
2835                 fb = crtc->cursor->fb;
2836                 if (fb)
2837                         drm_framebuffer_reference(fb);
2838         }
2839
2840         if (req->flags & DRM_MODE_CURSOR_MOVE) {
2841                 crtc_x = req->x;
2842                 crtc_y = req->y;
2843         } else {
2844                 crtc_x = crtc->cursor_x;
2845                 crtc_y = crtc->cursor_y;
2846         }
2847
2848         if (fb) {
2849                 crtc_w = fb->width;
2850                 crtc_h = fb->height;
2851                 src_w = fb->width << 16;
2852                 src_h = fb->height << 16;
2853         }
2854
2855         /*
2856          * setplane_internal will take care of deref'ing either the old or new
2857          * framebuffer depending on success.
2858          */
2859         ret = __setplane_internal(crtc->cursor, crtc, fb,
2860                                 crtc_x, crtc_y, crtc_w, crtc_h,
2861                                 0, 0, src_w, src_h);
2862
2863         /* Update successful; save new cursor position, if necessary */
2864         if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
2865                 crtc->cursor_x = req->x;
2866                 crtc->cursor_y = req->y;
2867         }
2868
2869         return ret;
2870 }
2871
2872 static int drm_mode_cursor_common(struct drm_device *dev,
2873                                   struct drm_mode_cursor2 *req,
2874                                   struct drm_file *file_priv)
2875 {
2876         struct drm_crtc *crtc;
2877         int ret = 0;
2878
2879         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2880                 return -EINVAL;
2881
2882         if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
2883                 return -EINVAL;
2884
2885         crtc = drm_crtc_find(dev, req->crtc_id);
2886         if (!crtc) {
2887                 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
2888                 return -ENOENT;
2889         }
2890
2891         /*
2892          * If this crtc has a universal cursor plane, call that plane's update
2893          * handler rather than using legacy cursor handlers.
2894          */
2895         drm_modeset_lock_crtc(crtc, crtc->cursor);
2896         if (crtc->cursor) {
2897                 ret = drm_mode_cursor_universal(crtc, req, file_priv);
2898                 goto out;
2899         }
2900
2901         if (req->flags & DRM_MODE_CURSOR_BO) {
2902                 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
2903                         ret = -ENXIO;
2904                         goto out;
2905                 }
2906                 /* Turns off the cursor if handle is 0 */
2907                 if (crtc->funcs->cursor_set2)
2908                         ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
2909                                                       req->width, req->height, req->hot_x, req->hot_y);
2910                 else
2911                         ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
2912                                                       req->width, req->height);
2913         }
2914
2915         if (req->flags & DRM_MODE_CURSOR_MOVE) {
2916                 if (crtc->funcs->cursor_move) {
2917                         ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
2918                 } else {
2919                         ret = -EFAULT;
2920                         goto out;
2921                 }
2922         }
2923 out:
2924         drm_modeset_unlock_crtc(crtc);
2925
2926         return ret;
2927
2928 }
2929
2930
2931 /**
2932  * drm_mode_cursor_ioctl - set CRTC's cursor configuration
2933  * @dev: drm device for the ioctl
2934  * @data: data pointer for the ioctl
2935  * @file_priv: drm file for the ioctl call
2936  *
2937  * Set the cursor configuration based on user request.
2938  *
2939  * Called by the user via ioctl.
2940  *
2941  * Returns:
2942  * Zero on success, negative errno on failure.
2943  */
2944 int drm_mode_cursor_ioctl(struct drm_device *dev,
2945                           void *data, struct drm_file *file_priv)
2946 {
2947         struct drm_mode_cursor *req = data;
2948         struct drm_mode_cursor2 new_req;
2949
2950         memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
2951         new_req.hot_x = new_req.hot_y = 0;
2952
2953         return drm_mode_cursor_common(dev, &new_req, file_priv);
2954 }
2955
2956 /**
2957  * drm_mode_cursor2_ioctl - set CRTC's cursor configuration
2958  * @dev: drm device for the ioctl
2959  * @data: data pointer for the ioctl
2960  * @file_priv: drm file for the ioctl call
2961  *
2962  * Set the cursor configuration based on user request. This implements the 2nd
2963  * version of the cursor ioctl, which allows userspace to additionally specify
2964  * the hotspot of the pointer.
2965  *
2966  * Called by the user via ioctl.
2967  *
2968  * Returns:
2969  * Zero on success, negative errno on failure.
2970  */
2971 int drm_mode_cursor2_ioctl(struct drm_device *dev,
2972                            void *data, struct drm_file *file_priv)
2973 {
2974         struct drm_mode_cursor2 *req = data;
2975         return drm_mode_cursor_common(dev, req, file_priv);
2976 }
2977
2978 /**
2979  * drm_mode_legacy_fb_format - compute drm fourcc code from legacy description
2980  * @bpp: bits per pixels
2981  * @depth: bit depth per pixel
2982  *
2983  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
2984  * Useful in fbdev emulation code, since that deals in those values.
2985  */
2986 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
2987 {
2988         uint32_t fmt;
2989
2990         switch (bpp) {
2991         case 8:
2992                 fmt = DRM_FORMAT_C8;
2993                 break;
2994         case 16:
2995                 if (depth == 15)
2996                         fmt = DRM_FORMAT_XRGB1555;
2997                 else
2998                         fmt = DRM_FORMAT_RGB565;
2999                 break;
3000         case 24:
3001                 fmt = DRM_FORMAT_RGB888;
3002                 break;
3003         case 32:
3004                 if (depth == 24)
3005                         fmt = DRM_FORMAT_XRGB8888;
3006                 else if (depth == 30)
3007                         fmt = DRM_FORMAT_XRGB2101010;
3008                 else
3009                         fmt = DRM_FORMAT_ARGB8888;
3010                 break;
3011         default:
3012                 DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
3013                 fmt = DRM_FORMAT_XRGB8888;
3014                 break;
3015         }
3016
3017         return fmt;
3018 }
3019 EXPORT_SYMBOL(drm_mode_legacy_fb_format);
3020
3021 /**
3022  * drm_mode_addfb - add an FB to the graphics configuration
3023  * @dev: drm device for the ioctl
3024  * @data: data pointer for the ioctl
3025  * @file_priv: drm file for the ioctl call
3026  *
3027  * Add a new FB to the specified CRTC, given a user request. This is the
3028  * original addfb ioctl which only supported RGB formats.
3029  *
3030  * Called by the user via ioctl.
3031  *
3032  * Returns:
3033  * Zero on success, negative errno on failure.
3034  */
3035 int drm_mode_addfb(struct drm_device *dev,
3036                    void *data, struct drm_file *file_priv)
3037 {
3038         struct drm_mode_fb_cmd *or = data;
3039         struct drm_mode_fb_cmd2 r = {};
3040         int ret;
3041
3042         /* convert to new format and call new ioctl */
3043         r.fb_id = or->fb_id;
3044         r.width = or->width;
3045         r.height = or->height;
3046         r.pitches[0] = or->pitch;
3047         r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
3048         r.handles[0] = or->handle;
3049
3050         ret = drm_mode_addfb2(dev, &r, file_priv);
3051         if (ret)
3052                 return ret;
3053
3054         or->fb_id = r.fb_id;
3055
3056         return 0;
3057 }
3058
3059 static int format_check(const struct drm_mode_fb_cmd2 *r)
3060 {
3061         uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;
3062
3063         switch (format) {
3064         case DRM_FORMAT_C8:
3065         case DRM_FORMAT_RGB332:
3066         case DRM_FORMAT_BGR233:
3067         case DRM_FORMAT_XRGB4444:
3068         case DRM_FORMAT_XBGR4444:
3069         case DRM_FORMAT_RGBX4444:
3070         case DRM_FORMAT_BGRX4444:
3071         case DRM_FORMAT_ARGB4444:
3072         case DRM_FORMAT_ABGR4444:
3073         case DRM_FORMAT_RGBA4444:
3074         case DRM_FORMAT_BGRA4444:
3075         case DRM_FORMAT_XRGB1555:
3076         case DRM_FORMAT_XBGR1555:
3077         case DRM_FORMAT_RGBX5551:
3078         case DRM_FORMAT_BGRX5551:
3079         case DRM_FORMAT_ARGB1555:
3080         case DRM_FORMAT_ABGR1555:
3081         case DRM_FORMAT_RGBA5551:
3082         case DRM_FORMAT_BGRA5551:
3083         case DRM_FORMAT_RGB565:
3084         case DRM_FORMAT_BGR565:
3085         case DRM_FORMAT_RGB888:
3086         case DRM_FORMAT_BGR888:
3087         case DRM_FORMAT_XRGB8888:
3088         case DRM_FORMAT_XBGR8888:
3089         case DRM_FORMAT_RGBX8888:
3090         case DRM_FORMAT_BGRX8888:
3091         case DRM_FORMAT_ARGB8888:
3092         case DRM_FORMAT_ABGR8888:
3093         case DRM_FORMAT_RGBA8888:
3094         case DRM_FORMAT_BGRA8888:
3095         case DRM_FORMAT_XRGB2101010:
3096         case DRM_FORMAT_XBGR2101010:
3097         case DRM_FORMAT_RGBX1010102:
3098         case DRM_FORMAT_BGRX1010102:
3099         case DRM_FORMAT_ARGB2101010:
3100         case DRM_FORMAT_ABGR2101010:
3101         case DRM_FORMAT_RGBA1010102:
3102         case DRM_FORMAT_BGRA1010102:
3103         case DRM_FORMAT_YUYV:
3104         case DRM_FORMAT_YVYU:
3105         case DRM_FORMAT_UYVY:
3106         case DRM_FORMAT_VYUY:
3107         case DRM_FORMAT_AYUV:
3108         case DRM_FORMAT_NV12:
3109         case DRM_FORMAT_NV21:
3110         case DRM_FORMAT_NV16:
3111         case DRM_FORMAT_NV61:
3112         case DRM_FORMAT_NV24:
3113         case DRM_FORMAT_NV42:
3114         case DRM_FORMAT_YUV410:
3115         case DRM_FORMAT_YVU410:
3116         case DRM_FORMAT_YUV411:
3117         case DRM_FORMAT_YVU411:
3118         case DRM_FORMAT_YUV420:
3119         case DRM_FORMAT_YVU420:
3120         case DRM_FORMAT_YUV422:
3121         case DRM_FORMAT_YVU422:
3122         case DRM_FORMAT_YUV444:
3123         case DRM_FORMAT_YVU444:
3124                 return 0;
3125         default:
3126                 DRM_DEBUG_KMS("invalid pixel format %s\n",
3127                               drm_get_format_name(r->pixel_format));
3128                 return -EINVAL;
3129         }
3130 }
3131
3132 static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
3133 {
3134         int ret, hsub, vsub, num_planes, i;
3135
3136         ret = format_check(r);
3137         if (ret) {
3138                 DRM_DEBUG_KMS("bad framebuffer format %s\n",
3139                               drm_get_format_name(r->pixel_format));
3140                 return ret;
3141         }
3142
3143         hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
3144         vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
3145         num_planes = drm_format_num_planes(r->pixel_format);
3146
3147         if (r->width == 0 || r->width % hsub) {
3148                 DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width);
3149                 return -EINVAL;
3150         }
3151
3152         if (r->height == 0 || r->height % vsub) {
3153                 DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
3154                 return -EINVAL;
3155         }
3156
3157         for (i = 0; i < num_planes; i++) {
3158                 unsigned int width = r->width / (i != 0 ? hsub : 1);
3159                 unsigned int height = r->height / (i != 0 ? vsub : 1);
3160                 unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);
3161
3162                 if (!r->handles[i]) {
3163                         DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
3164                         return -EINVAL;
3165                 }
3166
3167                 if ((uint64_t) width * cpp > UINT_MAX)
3168                         return -ERANGE;
3169
3170                 if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
3171                         return -ERANGE;
3172
3173                 if (r->pitches[i] < width * cpp) {
3174                         DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
3175                         return -EINVAL;
3176                 }
3177         }
3178
3179         return 0;
3180 }
3181
3182 static struct drm_framebuffer *add_framebuffer_internal(struct drm_device *dev,
3183                                                         struct drm_mode_fb_cmd2 *r,
3184                                                         struct drm_file *file_priv)
3185 {
3186         struct drm_mode_config *config = &dev->mode_config;
3187         struct drm_framebuffer *fb;
3188         int ret;
3189
3190         if (r->flags & ~DRM_MODE_FB_INTERLACED) {
3191                 DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
3192                 return ERR_PTR(-EINVAL);
3193         }
3194
3195         if ((config->min_width > r->width) || (r->width > config->max_width)) {
3196                 DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
3197                           r->width, config->min_width, config->max_width);
3198                 return ERR_PTR(-EINVAL);
3199         }
3200         if ((config->min_height > r->height) || (r->height > config->max_height)) {
3201                 DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
3202                           r->height, config->min_height, config->max_height);
3203                 return ERR_PTR(-EINVAL);
3204         }
3205
3206         ret = framebuffer_check(r);
3207         if (ret)
3208                 return ERR_PTR(ret);
3209
3210         fb = dev->mode_config.funcs->fb_create(dev, file_priv, r);
3211         if (IS_ERR(fb)) {
3212                 DRM_DEBUG_KMS("could not create framebuffer\n");
3213                 return fb;
3214         }
3215
3216         mutex_lock(&file_priv->fbs_lock);
3217         r->fb_id = fb->base.id;
3218         list_add(&fb->filp_head, &file_priv->fbs);
3219         DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);
3220         mutex_unlock(&file_priv->fbs_lock);
3221
3222         return fb;
3223 }
3224
3225 /**
3226  * drm_mode_addfb2 - add an FB to the graphics configuration
3227  * @dev: drm device for the ioctl
3228  * @data: data pointer for the ioctl
3229  * @file_priv: drm file for the ioctl call
3230  *
3231  * Add a new FB to the specified CRTC, given a user request with format. This is
3232  * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers
3233  * and uses fourcc codes as pixel format specifiers.
3234  *
3235  * Called by the user via ioctl.
3236  *
3237  * Returns:
3238  * Zero on success, negative errno on failure.
3239  */
3240 int drm_mode_addfb2(struct drm_device *dev,
3241                     void *data, struct drm_file *file_priv)
3242 {
3243         struct drm_framebuffer *fb;
3244
3245         if (!drm_core_check_feature(dev, DRIVER_MODESET))
3246                 return -EINVAL;
3247
3248         fb = add_framebuffer_internal(dev, data, file_priv);
3249         if (IS_ERR(fb))
3250                 return PTR_ERR(fb);
3251
3252         return 0;
3253 }
3254
3255 /**
3256  * drm_mode_rmfb - remove an FB from the configuration
3257  * @dev: drm device for the ioctl
3258  * @data: data pointer for the ioctl
3259  * @file_priv: drm file for the ioctl call
3260  *
3261  * Remove the FB specified by the user.
3262  *
3263  * Called by the user via ioctl.
3264  *
3265  * Returns:
3266  * Zero on success, negative errno on failure.
3267  */
3268 int drm_mode_rmfb(struct drm_device *dev,
3269                    void *data, struct drm_file *file_priv)
3270 {
3271         struct drm_framebuffer *fb = NULL;
3272         struct drm_framebuffer *fbl = NULL;
3273         uint32_t *id = data;
3274         int found = 0;
3275
3276         if (!drm_core_check_feature(dev, DRIVER_MODESET))
3277                 return -EINVAL;
3278
3279         mutex_lock(&file_priv->fbs_lock);
3280         mutex_lock(&dev->mode_config.fb_lock);
3281         fb = __drm_framebuffer_lookup(dev, *id);
3282         if (!fb)
3283                 goto fail_lookup;
3284
3285         list_for_each_entry(fbl, &file_priv->fbs, filp_head)
3286                 if (fb == fbl)
3287                         found = 1;
3288         if (!found)
3289                 goto fail_lookup;
3290
3291         /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3292         __drm_framebuffer_unregister(dev, fb);
3293
3294         list_del_init(&fb->filp_head);
3295         mutex_unlock(&dev->mode_config.fb_lock);
3296         mutex_unlock(&file_priv->fbs_lock);
3297
3298         drm_framebuffer_remove(fb);
3299
3300         return 0;
3301
3302 fail_lookup:
3303         mutex_unlock(&dev->mode_config.fb_lock);
3304         mutex_unlock(&file_priv->fbs_lock);
3305
3306         return -ENOENT;
3307 }
3308
3309 /**
3310  * drm_mode_getfb - get FB info
3311  * @dev: drm device for the ioctl
3312  * @data: data pointer for the ioctl
3313  * @file_priv: drm file for the ioctl call
3314  *
3315  * Lookup the FB given its ID and return info about it.
3316  *
3317  * Called by the user via ioctl.
3318  *
3319  * Returns:
3320  * Zero on success, negative errno on failure.
3321  */
3322 int drm_mode_getfb(struct drm_device *dev,
3323                    void *data, struct drm_file *file_priv)
3324 {
3325         struct drm_mode_fb_cmd *r = data;
3326         struct drm_framebuffer *fb;
3327         int ret;
3328
3329         if (!drm_core_check_feature(dev, DRIVER_MODESET))
3330                 return -EINVAL;
3331
3332         fb = drm_framebuffer_lookup(dev, r->fb_id);
3333         if (!fb)
3334                 return -ENOENT;
3335
3336         r->height = fb->height;
3337         r->width = fb->width;
3338         r->depth = fb->depth;
3339         r->bpp = fb->bits_per_pixel;
3340         r->pitch = fb->pitches[0];
3341         if (fb->funcs->create_handle) {
3342                 if (file_priv->is_master || capable(CAP_SYS_ADMIN) ||
3343                     drm_is_control_client(file_priv)) {
3344                         ret = fb->funcs->create_handle(fb, file_priv,
3345                                                        &r->handle);
3346                 } else {
3347                         /* GET_FB() is an unprivileged ioctl so we must not
3348                          * return a buffer-handle to non-master processes! For
3349                          * backwards-compatibility reasons, we cannot make
3350                          * GET_FB() privileged, so just return an invalid handle
3351                          * for non-masters. */
3352                         r->handle = 0;
3353                         ret = 0;
3354                 }
3355         } else {
3356                 ret = -ENODEV;
3357         }
3358
3359         drm_framebuffer_unreference(fb);
3360
3361         return ret;
3362 }
3363
3364 /**
3365  * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB
3366  * @dev: drm device for the ioctl
3367  * @data: data pointer for the ioctl
3368  * @file_priv: drm file for the ioctl call
3369  *
3370  * Lookup the FB and flush out the damaged area supplied by userspace as a clip
3371  * rectangle list. Generic userspace which does frontbuffer rendering must call
3372  * this ioctl to flush out the changes on manual-update display outputs, e.g.
3373  * usb display-link, mipi manual update panels or edp panel self refresh modes.
3374  *
3375  * Modesetting drivers which always update the frontbuffer do not need to
3376  * implement the corresponding ->dirty framebuffer callback.
3377  *
3378  * Called by the user via ioctl.
3379  *
3380  * Returns:
3381  * Zero on success, negative errno on failure.
3382  */
3383 int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
3384                            void *data, struct drm_file *file_priv)
3385 {
3386         struct drm_clip_rect __user *clips_ptr;
3387         struct drm_clip_rect *clips = NULL;
3388         struct drm_mode_fb_dirty_cmd *r = data;
3389         struct drm_framebuffer *fb;
3390         unsigned flags;
3391         int num_clips;
3392         int ret;
3393
3394         if (!drm_core_check_feature(dev, DRIVER_MODESET))
3395                 return -EINVAL;
3396
3397         fb = drm_framebuffer_lookup(dev, r->fb_id);
3398         if (!fb)
3399                 return -ENOENT;
3400
3401         num_clips = r->num_clips;
3402         clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;
3403
3404         if (!num_clips != !clips_ptr) {
3405                 ret = -EINVAL;
3406                 goto out_err1;
3407         }
3408
3409         flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;
3410
3411         /* If userspace annotates copy, clips must come in pairs */
3412         if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
3413                 ret = -EINVAL;
3414                 goto out_err1;
3415         }
3416
3417         if (num_clips && clips_ptr) {
3418                 if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
3419                         ret = -EINVAL;
3420                         goto out_err1;
3421                 }
3422                 clips = kzalloc(num_clips * sizeof(*clips), GFP_KERNEL);
3423                 if (!clips) {
3424                         ret = -ENOMEM;
3425                         goto out_err1;
3426                 }
3427
3428                 ret = copy_from_user(clips, clips_ptr,
3429                                      num_clips * sizeof(*clips));
3430                 if (ret) {
3431                         ret = -EFAULT;
3432                         goto out_err2;
3433                 }
3434         }
3435
3436         if (fb->funcs->dirty) {
3437                 ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
3438                                        clips, num_clips);
3439         } else {
3440                 ret = -ENOSYS;
3441         }
3442
3443 out_err2:
3444         kfree(clips);
3445 out_err1:
3446         drm_framebuffer_unreference(fb);
3447
3448         return ret;
3449 }
3450
3451
3452 /**
3453  * drm_fb_release - remove and free the FBs on this file
3454  * @priv: drm file for the ioctl
3455  *
3456  * Destroy all the FBs associated with @filp.
3457  *
3458  * Called by the user via ioctl.
3459  *
3460  * Returns:
3461  * Zero on success, negative errno on failure.
3462  */
3463 void drm_fb_release(struct drm_file *priv)
3464 {
3465         struct drm_device *dev = priv->minor->dev;
3466         struct drm_framebuffer *fb, *tfb;
3467
3468         /*
3469          * When the file gets released that means no one else can access the fb
3470          * list any more, so no need to grab fpriv->fbs_lock. And we need to
3471          * avoid upsetting lockdep since the universal cursor code adds a
3472          * framebuffer while holding mutex locks.
3473          *
3474          * Note that a real deadlock between fpriv->fbs_lock and the modeset
3475          * locks is impossible here since no one else but this function can get
3476          * at it any more.
3477          */
3478         list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
3479
3480                 mutex_lock(&dev->mode_config.fb_lock);
3481                 /* Mark fb as reaped, we still have a ref from fpriv->fbs. */
3482                 __drm_framebuffer_unregister(dev, fb);
3483                 mutex_unlock(&dev->mode_config.fb_lock);
3484
3485                 list_del_init(&fb->filp_head);
3486
3487                 /* This will also drop the fpriv->fbs reference. */
3488                 drm_framebuffer_remove(fb);
3489         }
3490 }
3491
3492 /**
3493  * drm_property_create - create a new property type
3494  * @dev: drm device
3495  * @flags: flags specifying the property type
3496  * @name: name of the property
3497  * @num_values: number of pre-defined values
3498  *
3499  * This creates a new generic drm property which can then be attached to a drm
3500  * object with drm_object_attach_property. The returned property object must be
3501  * freed with drm_property_destroy.
3502  *
3503  * Note that the DRM core keeps a per-device list of properties and that, if
3504  * drm_mode_config_cleanup() is called, it will destroy all properties created
3505  * by the driver.
3506  *
3507  * Returns:
3508  * A pointer to the newly created property on success, NULL on failure.
3509  */
3510 struct drm_property *drm_property_create(struct drm_device *dev, int flags,
3511                                          const char *name, int num_values)
3512 {
3513         struct drm_property *property = NULL;
3514         int ret;
3515
3516         property = kzalloc(sizeof(struct drm_property), GFP_KERNEL);
3517         if (!property)
3518                 return NULL;
3519
3520         property->dev = dev;
3521
3522         if (num_values) {
3523                 property->values = kzalloc(sizeof(uint64_t)*num_values, GFP_KERNEL);
3524                 if (!property->values)
3525                         goto fail;
3526         }
3527
3528         ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
3529         if (ret)
3530                 goto fail;
3531
3532         property->flags = flags;
3533         property->num_values = num_values;
3534         INIT_LIST_HEAD(&property->enum_list);
3535
3536         if (name) {
3537                 strncpy(property->name, name, DRM_PROP_NAME_LEN);
3538                 property->name[DRM_PROP_NAME_LEN-1] = '\0';
3539         }
3540
3541         list_add_tail(&property->head, &dev->mode_config.property_list);
3542
3543         WARN_ON(!drm_property_type_valid(property));
3544
3545         return property;
3546 fail:
3547         kfree(property->values);
3548         kfree(property);
3549         return NULL;
3550 }
3551 EXPORT_SYMBOL(drm_property_create);
3552
3553 /**
3554  * drm_property_create_enum - create a new enumeration property type
3555  * @dev: drm device
3556  * @flags: flags specifying the property type
3557  * @name: name of the property
3558  * @props: enumeration lists with property values
3559  * @num_values: number of pre-defined values
3560  *
3561  * This creates a new generic drm property which can then be attached to a drm
3562  * object with drm_object_attach_property. The returned property object must be
3563  * freed with drm_property_destroy.
3564  *
3565  * Userspace is only allowed to set one of the predefined values for enumeration
3566  * properties.
3567  *
3568  * Returns:
3569  * A pointer to the newly created property on success, NULL on failure.
3570  */
3571 struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
3572                                          const char *name,
3573                                          const struct drm_prop_enum_list *props,
3574                                          int num_values)
3575 {
3576         struct drm_property *property;
3577         int i, ret;
3578
3579         flags |= DRM_MODE_PROP_ENUM;
3580
3581         property = drm_property_create(dev, flags, name, num_values);
3582         if (!property)
3583                 return NULL;
3584
3585         for (i = 0; i < num_values; i++) {
3586                 ret = drm_property_add_enum(property, i,
3587                                       props[i].type,
3588                                       props[i].name);
3589                 if (ret) {
3590                         drm_property_destroy(dev, property);
3591                         return NULL;
3592                 }
3593         }
3594
3595         return property;
3596 }
3597 EXPORT_SYMBOL(drm_property_create_enum);
3598
3599 /**
3600  * drm_property_create_bitmask - create a new bitmask property type
3601  * @dev: drm device
3602  * @flags: flags specifying the property type
3603  * @name: name of the property
3604  * @props: enumeration lists with property bitflags
3605  * @num_props: size of the @props array
3606  * @supported_bits: bitmask of all supported enumeration values
3607  *
3608  * This creates a new bitmask drm property which can then be attached to a drm
3609  * object with drm_object_attach_property. The returned property object must be
3610  * freed with drm_property_destroy.
3611  *
3612  * Compared to plain enumeration properties userspace is allowed to set any
3613  * or'ed together combination of the predefined property bitflag values
3614  *
3615  * Returns:
3616  * A pointer to the newly created property on success, NULL on failure.
3617  */
3618 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
3619                                          int flags, const char *name,
3620                                          const struct drm_prop_enum_list *props,
3621                                          int num_props,
3622                                          uint64_t supported_bits)
3623 {
3624         struct drm_property *property;
3625         int i, ret, index = 0;
3626         int num_values = hweight64(supported_bits);
3627
3628         flags |= DRM_MODE_PROP_BITMASK;
3629
3630         property = drm_property_create(dev, flags, name, num_values);
3631         if (!property)
3632                 return NULL;
3633         for (i = 0; i < num_props; i++) {
3634                 if (!(supported_bits & (1ULL << props[i].type)))
3635                         continue;
3636
3637                 if (WARN_ON(index >= num_values)) {
3638                         drm_property_destroy(dev, property);
3639                         return NULL;
3640                 }
3641
3642                 ret = drm_property_add_enum(property, index++,
3643                                       props[i].type,
3644                                       props[i].name);
3645                 if (ret) {
3646                         drm_property_destroy(dev, property);
3647                         return NULL;
3648                 }
3649         }
3650
3651         return property;
3652 }
3653 EXPORT_SYMBOL(drm_property_create_bitmask);
3654
3655 static struct drm_property *property_create_range(struct drm_device *dev,
3656                                          int flags, const char *name,
3657                                          uint64_t min, uint64_t max)
3658 {
3659         struct drm_property *property;
3660
3661         property = drm_property_create(dev, flags, name, 2);
3662         if (!property)
3663                 return NULL;
3664
3665         property->values[0] = min;
3666         property->values[1] = max;
3667
3668         return property;
3669 }
3670
3671 /**
3672  * drm_property_create_range - create a new ranged property type
3673  * @dev: drm device
3674  * @flags: flags specifying the property type
3675  * @name: name of the property
3676  * @min: minimum value of the property
3677  * @max: maximum value of the property
3678  *
3679  * This creates a new generic drm property which can then be attached to a drm
3680  * object with drm_object_attach_property. The returned property object must be
3681  * freed with drm_property_destroy.
3682  *
3683  * Userspace is allowed to set any integer value in the (min, max) range
3684  * inclusive.
3685  *
3686  * Returns:
3687  * A pointer to the newly created property on success, NULL on failure.
3688  */
3689 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
3690                                          const char *name,
3691                                          uint64_t min, uint64_t max)
3692 {
3693         return property_create_range(dev, DRM_MODE_PROP_RANGE | flags,
3694                         name, min, max);
3695 }
3696 EXPORT_SYMBOL(drm_property_create_range);
3697
3698 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
3699                                          int flags, const char *name,
3700                                          int64_t min, int64_t max)
3701 {
3702         return property_create_range(dev, DRM_MODE_PROP_SIGNED_RANGE | flags,
3703                         name, I642U64(min), I642U64(max));
3704 }
3705 EXPORT_SYMBOL(drm_property_create_signed_range);
3706
3707 struct drm_property *drm_property_create_object(struct drm_device *dev,
3708                                          int flags, const char *name, uint32_t type)
3709 {
3710         struct drm_property *property;
3711
3712         flags |= DRM_MODE_PROP_OBJECT;
3713
3714         property = drm_property_create(dev, flags, name, 1);
3715         if (!property)
3716                 return NULL;
3717
3718         property->values[0] = type;
3719
3720         return property;
3721 }
3722 EXPORT_SYMBOL(drm_property_create_object);
3723
3724 /**
3725  * drm_property_add_enum - add a possible value to an enumeration property
3726  * @property: enumeration property to change
3727  * @index: index of the new enumeration
3728  * @value: value of the new enumeration
3729  * @name: symbolic name of the new enumeration
3730  *
3731  * This functions adds enumerations to a property.
3732  *
3733  * It's use is deprecated, drivers should use one of the more specific helpers
3734  * to directly create the property with all enumerations already attached.
3735  *
3736  * Returns:
3737  * Zero on success, error code on failure.
3738  */
3739 int drm_property_add_enum(struct drm_property *property, int index,
3740                           uint64_t value, const char *name)
3741 {
3742         struct drm_property_enum *prop_enum;
3743
3744         if (!(drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3745                         drm_property_type_is(property, DRM_MODE_PROP_BITMASK)))
3746                 return -EINVAL;
3747
3748         /*
3749          * Bitmask enum properties have the additional constraint of values
3750          * from 0 to 63
3751          */
3752         if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK) &&
3753                         (value > 63))
3754                 return -EINVAL;
3755
3756         if (!list_empty(&property->enum_list)) {
3757                 list_for_each_entry(prop_enum, &property->enum_list, head) {
3758                         if (prop_enum->value == value) {
3759                                 strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3760                                 prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3761                                 return 0;
3762                         }
3763                 }
3764         }
3765
3766         prop_enum = kzalloc(sizeof(struct drm_property_enum), GFP_KERNEL);
3767         if (!prop_enum)
3768                 return -ENOMEM;
3769
3770         strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
3771         prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
3772         prop_enum->value = value;
3773
3774         property->values[index] = value;
3775         list_add_tail(&prop_enum->head, &property->enum_list);
3776         return 0;
3777 }
3778 EXPORT_SYMBOL(drm_property_add_enum);
3779
3780 /**
3781  * drm_property_destroy - destroy a drm property
3782  * @dev: drm device
3783  * @property: property to destry
3784  *
3785  * This function frees a property including any attached resources like
3786  * enumeration values.
3787  */
3788 void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
3789 {
3790         struct drm_property_enum *prop_enum, *pt;
3791
3792         list_for_each_entry_safe(prop_enum, pt, &property->enum_list, head) {
3793                 list_del(&prop_enum->head);
3794                 kfree(prop_enum);
3795         }
3796
3797         if (property->num_values)
3798                 kfree(property->values);
3799         drm_mode_object_put(dev, &property->base);
3800         list_del(&property->head);
3801         kfree(property);
3802 }
3803 EXPORT_SYMBOL(drm_property_destroy);
3804
3805 /**
3806  * drm_object_attach_property - attach a property to a modeset object
3807  * @obj: drm modeset object
3808  * @property: property to attach
3809  * @init_val: initial value of the property
3810  *
3811  * This attaches the given property to the modeset object with the given initial
3812  * value. Currently this function cannot fail since the properties are stored in
3813  * a statically sized array.
3814  */
3815 void drm_object_attach_property(struct drm_mode_object *obj,
3816                                 struct drm_property *property,
3817                                 uint64_t init_val)
3818 {
3819         int count = obj->properties->count;
3820
3821         if (count == DRM_OBJECT_MAX_PROPERTY) {
3822                 WARN(1, "Failed to attach object property (type: 0x%x). Please "
3823                         "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
3824                         "you see this message on the same object type.\n",
3825                         obj->type);
3826                 return;
3827         }
3828
3829         obj->properties->properties[count] = property;
3830         obj->properties->values[count] = init_val;
3831         obj->properties->count++;
3832 }
3833 EXPORT_SYMBOL(drm_object_attach_property);
3834
3835 /**
3836  * drm_object_property_set_value - set the value of a property
3837  * @obj: drm mode object to set property value for
3838  * @property: property to set
3839  * @val: value the property should be set to
3840  *
3841  * This functions sets a given property on a given object. This function only
3842  * changes the software state of the property, it does not call into the
3843  * driver's ->set_property callback.
3844  *
3845  * Returns:
3846  * Zero on success, error code on failure.
3847  */
3848 int drm_object_property_set_value(struct drm_mode_object *obj,
3849                                   struct drm_property *property, uint64_t val)
3850 {
3851         int i;
3852
3853         for (i = 0; i < obj->properties->count; i++) {
3854                 if (obj->properties->properties[i] == property) {
3855                         obj->properties->values[i] = val;
3856                         return 0;
3857                 }
3858         }
3859
3860         return -EINVAL;
3861 }
3862 EXPORT_SYMBOL(drm_object_property_set_value);
3863
3864 /**
3865  * drm_object_property_get_value - retrieve the value of a property
3866  * @obj: drm mode object to get property value from
3867  * @property: property to retrieve
3868  * @val: storage for the property value
3869  *
3870  * This function retrieves the softare state of the given property for the given
3871  * property. Since there is no driver callback to retrieve the current property
3872  * value this might be out of sync with the hardware, depending upon the driver
3873  * and property.
3874  *
3875  * Returns:
3876  * Zero on success, error code on failure.
3877  */
3878 int drm_object_property_get_value(struct drm_mode_object *obj,
3879                                   struct drm_property *property, uint64_t *val)
3880 {
3881         int i;
3882
3883         for (i = 0; i < obj->properties->count; i++) {
3884                 if (obj->properties->properties[i] == property) {
3885                         *val = obj->properties->values[i];
3886                         return 0;
3887                 }
3888         }
3889
3890         return -EINVAL;
3891 }
3892 EXPORT_SYMBOL(drm_object_property_get_value);
3893
3894 /**
3895  * drm_mode_getproperty_ioctl - get the property metadata
3896  * @dev: DRM device
3897  * @data: ioctl data
3898  * @file_priv: DRM file info
3899  *
3900  * This function retrieves the metadata for a given property, like the different
3901  * possible values for an enum property or the limits for a range property.
3902  *
3903  * Blob properties are special
3904  *
3905  * Called by the user via ioctl.
3906  *
3907  * Returns:
3908  * Zero on success, negative errno on failure.
3909  */
3910 int drm_mode_getproperty_ioctl(struct drm_device *dev,
3911                                void *data, struct drm_file *file_priv)
3912 {
3913         struct drm_mode_get_property *out_resp = data;
3914         struct drm_property *property;
3915         int enum_count = 0;
3916         int value_count = 0;
3917         int ret = 0, i;
3918         int copied;
3919         struct drm_property_enum *prop_enum;
3920         struct drm_mode_property_enum __user *enum_ptr;
3921         uint64_t __user *values_ptr;
3922
3923         if (!drm_core_check_feature(dev, DRIVER_MODESET))
3924                 return -EINVAL;
3925
3926         drm_modeset_lock_all(dev);
3927         property = drm_property_find(dev, out_resp->prop_id);
3928         if (!property) {
3929                 ret = -ENOENT;
3930                 goto done;
3931         }
3932
3933         if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3934                         drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3935                 list_for_each_entry(prop_enum, &property->enum_list, head)
3936                         enum_count++;
3937         }
3938
3939         value_count = property->num_values;
3940
3941         strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
3942         out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
3943         out_resp->flags = property->flags;
3944
3945         if ((out_resp->count_values >= value_count) && value_count) {
3946                 values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
3947                 for (i = 0; i < value_count; i++) {
3948                         if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
3949                                 ret = -EFAULT;
3950                                 goto done;
3951                         }
3952                 }
3953         }
3954         out_resp->count_values = value_count;
3955
3956         if (drm_property_type_is(property, DRM_MODE_PROP_ENUM) ||
3957                         drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
3958                 if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
3959                         copied = 0;
3960                         enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
3961                         list_for_each_entry(prop_enum, &property->enum_list, head) {
3962
3963                                 if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
3964                                         ret = -EFAULT;
3965                                         goto done;
3966                                 }
3967
3968                                 if (copy_to_user(&enum_ptr[copied].name,
3969                                                  &prop_enum->name, DRM_PROP_NAME_LEN)) {
3970                                         ret = -EFAULT;
3971                                         goto done;
3972                                 }
3973                                 copied++;
3974                         }
3975                 }
3976                 out_resp->count_enum_blobs = enum_count;
3977         }
3978
3979         /*
3980          * NOTE: The idea seems to have been to use this to read all the blob
3981          * property values. But nothing ever added them to the corresponding
3982          * list, userspace always used the special-purpose get_blob ioctl to
3983          * read the value for a blob property. It also doesn't make a lot of
3984          * sense to return values here when everything else is just metadata for
3985          * the property itself.
3986          */
3987         if (drm_property_type_is(property, DRM_MODE_PROP_BLOB))
3988                 out_resp->count_enum_blobs = 0;
3989 done:
3990         drm_modeset_unlock_all(dev);
3991         return ret;
3992 }
3993
3994 static struct drm_property_blob *
3995 drm_property_create_blob(struct drm_device *dev, size_t length,
3996                          const void *data)
3997 {
3998         struct drm_property_blob *blob;
3999         int ret;
4000
4001         if (!length || !data)
4002                 return NULL;
4003
4004         blob = kzalloc(sizeof(struct drm_property_blob)+length, GFP_KERNEL);
4005         if (!blob)
4006                 return NULL;
4007
4008         ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
4009         if (ret) {
4010                 kfree(blob);
4011                 return NULL;
4012         }
4013
4014         blob->length = length;
4015
4016         memcpy(blob->data, data, length);
4017
4018         list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
4019         return blob;
4020 }
4021
4022 static void drm_property_destroy_blob(struct drm_device *dev,
4023                                struct drm_property_blob *blob)
4024 {
4025         drm_mode_object_put(dev, &blob->base);
4026         list_del(&blob->head);
4027         kfree(blob);
4028 }
4029
4030 /**
4031  * drm_mode_getblob_ioctl - get the contents of a blob property value
4032  * @dev: DRM device
4033  * @data: ioctl data
4034  * @file_priv: DRM file info
4035  *
4036  * This function retrieves the contents of a blob property. The value stored in
4037  * an object's blob property is just a normal modeset object id.
4038  *
4039  * Called by the user via ioctl.
4040  *
4041  * Returns:
4042  * Zero on success, negative errno on failure.
4043  */
4044 int drm_mode_getblob_ioctl(struct drm_device *dev,
4045                            void *data, struct drm_file *file_priv)
4046 {
4047         struct drm_mode_get_blob *out_resp = data;
4048         struct drm_property_blob *blob;
4049         int ret = 0;
4050         void __user *blob_ptr;
4051
4052         if (!drm_core_check_feature(dev, DRIVER_MODESET))
4053                 return -EINVAL;
4054
4055         drm_modeset_lock_all(dev);
4056         blob = drm_property_blob_find(dev, out_resp->blob_id);
4057         if (!blob) {
4058                 ret = -ENOENT;
4059                 goto done;
4060         }
4061
4062         if (out_resp->length == blob->length) {
4063                 blob_ptr = (void __user *)(unsigned long)out_resp->data;
4064                 if (copy_to_user(blob_ptr, blob->data, blob->length)){
4065                         ret = -EFAULT;
4066                         goto done;
4067                 }
4068         }
4069         out_resp->length = blob->length;
4070
4071 done:
4072         drm_modeset_unlock_all(dev);
4073         return ret;
4074 }
4075
4076 /**
4077  * drm_mode_connector_set_path_property - set tile property on connector
4078  * @connector: connector to set property on.
4079  * @path: path to use for property.
4080  *
4081  * This creates a property to expose to userspace to specify a
4082  * connector path. This is mainly used for DisplayPort MST where
4083  * connectors have a topology and we want to allow userspace to give
4084  * them more meaningful names.
4085  *
4086  * Returns:
4087  * Zero on success, negative errno on failure.
4088  */
4089 int drm_mode_connector_set_path_property(struct drm_connector *connector,
4090                                          const char *path)
4091 {
4092         struct drm_device *dev = connector->dev;
4093         size_t size = strlen(path) + 1;
4094         int ret;
4095
4096         connector->path_blob_ptr = drm_property_create_blob(connector->dev,
4097                                                             size, path);
4098         if (!connector->path_blob_ptr)
4099                 return -EINVAL;
4100
4101         ret = drm_object_property_set_value(&connector->base,
4102                                             dev->mode_config.path_property,
4103                                             connector->path_blob_ptr->base.id);
4104         return ret;
4105 }
4106 EXPORT_SYMBOL(drm_mode_connector_set_path_property);
4107
4108 /**
4109  * drm_mode_connector_set_tile_property - set tile property on connector
4110  * @connector: connector to set property on.
4111  *
4112  * This looks up the tile information for a connector, and creates a
4113  * property for userspace to parse if it exists. The property is of
4114  * the form of 8 integers using ':' as a separator.
4115  *
4116  * Returns:
4117  * Zero on success, errno on failure.
4118  */
4119 int drm_mode_connector_set_tile_property(struct drm_connector *connector)
4120 {
4121         struct drm_device *dev = connector->dev;
4122         int ret, size;
4123         char tile[256];
4124
4125         if (connector->tile_blob_ptr)
4126                 drm_property_destroy_blob(dev, connector->tile_blob_ptr);
4127
4128         if (!connector->has_tile) {
4129                 connector->tile_blob_ptr = NULL;
4130                 ret = drm_object_property_set_value(&connector->base,
4131                                                     dev->mode_config.tile_property, 0);
4132                 return ret;
4133         }
4134
4135         snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
4136                  connector->tile_group->id, connector->tile_is_single_monitor,
4137                  connector->num_h_tile, connector->num_v_tile,
4138                  connector->tile_h_loc, connector->tile_v_loc,
4139                  connector->tile_h_size, connector->tile_v_size);
4140         size = strlen(tile) + 1;
4141
4142         connector->tile_blob_ptr = drm_property_create_blob(connector->dev,
4143                                                             size, tile);
4144         if (!connector->tile_blob_ptr)
4145                 return -EINVAL;
4146
4147         ret = drm_object_property_set_value(&connector->base,
4148                                             dev->mode_config.tile_property,
4149                                             connector->tile_blob_ptr->base.id);
4150         return ret;
4151 }
4152 EXPORT_SYMBOL(drm_mode_connector_set_tile_property);
4153
4154 /**
4155  * drm_mode_connector_update_edid_property - update the edid property of a connector
4156  * @connector: drm connector
4157  * @edid: new value of the edid property
4158  *
4159  * This function creates a new blob modeset object and assigns its id to the
4160  * connector's edid property.
4161  *
4162  * Returns:
4163  * Zero on success, negative errno on failure.
4164  */
4165 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
4166                                             const struct edid *edid)
4167 {
4168         struct drm_device *dev = connector->dev;
4169         size_t size;
4170         int ret;
4171
4172         /* ignore requests to set edid when overridden */
4173         if (connector->override_edid)
4174                 return 0;
4175
4176         if (connector->edid_blob_ptr)
4177                 drm_property_destroy_blob(dev, connector->edid_blob_ptr);
4178
4179         /* Delete edid, when there is none. */
4180         if (!edid) {
4181                 connector->edid_blob_ptr = NULL;
4182                 ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
4183                 return ret;
4184         }
4185
4186         size = EDID_LENGTH * (1 + edid->extensions);
4187         connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
4188                                                             size, edid);
4189         if (!connector->edid_blob_ptr)
4190                 return -EINVAL;
4191
4192         ret = drm_object_property_set_value(&connector->base,
4193                                                dev->mode_config.edid_property,
4194                                                connector->edid_blob_ptr->base.id);
4195
4196         return ret;
4197 }
4198 EXPORT_SYMBOL(drm_mode_connector_update_edid_property);
4199
4200 /* Some properties could refer to dynamic refcnt'd objects, or things that
4201  * need special locking to handle lifetime issues (ie. to ensure the prop
4202  * value doesn't become invalid part way through the property update due to
4203  * race).  The value returned by reference via 'obj' should be passed back
4204  * to drm_property_change_valid_put() after the property is set (and the
4205  * object to which the property is attached has a chance to take it's own
4206  * reference).
4207  */
4208 static bool drm_property_change_valid_get(struct drm_property *property,
4209                                          uint64_t value, struct drm_mode_object **ref)
4210 {
4211         if (property->flags & DRM_MODE_PROP_IMMUTABLE)
4212                 return false;
4213
4214         *ref = NULL;
4215
4216         if (drm_property_type_is(property, DRM_MODE_PROP_RANGE)) {
4217                 if (value < property->values[0] || value > property->values[1])
4218                         return false;
4219                 return true;
4220         } else if (drm_property_type_is(property, DRM_MODE_PROP_SIGNED_RANGE)) {
4221                 int64_t svalue = U642I64(value);
4222                 if (svalue < U642I64(property->values[0]) ||
4223                                 svalue > U642I64(property->values[1]))
4224                         return false;
4225                 return true;
4226         } else if (drm_property_type_is(property, DRM_MODE_PROP_BITMASK)) {
4227                 int i;
4228                 uint64_t valid_mask = 0;
4229                 for (i = 0; i < property->num_values; i++)
4230                         valid_mask |= (1ULL << property->values[i]);
4231                 return !(value & ~valid_mask);
4232         } else if (drm_property_type_is(property, DRM_MODE_PROP_BLOB)) {
4233                 /* Only the driver knows */
4234                 return true;
4235         } else if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4236                 /* a zero value for an object property translates to null: */
4237                 if (value == 0)
4238                         return true;
4239
4240                 /* handle refcnt'd objects specially: */
4241                 if (property->values[0] == DRM_MODE_OBJECT_FB) {
4242                         struct drm_framebuffer *fb;
4243                         fb = drm_framebuffer_lookup(property->dev, value);
4244                         if (fb) {
4245                                 *ref = &fb->base;
4246                                 return true;
4247                         } else {
4248                                 return false;
4249                         }
4250                 } else {
4251                         return _object_find(property->dev, value, property->values[0]) != NULL;
4252                 }
4253         } else {
4254                 int i;
4255                 for (i = 0; i < property->num_values; i++)
4256                         if (property->values[i] == value)
4257                                 return true;
4258                 return false;
4259         }
4260 }
4261
4262 static void drm_property_change_valid_put(struct drm_property *property,
4263                 struct drm_mode_object *ref)
4264 {
4265         if (!ref)
4266                 return;
4267
4268         if (drm_property_type_is(property, DRM_MODE_PROP_OBJECT)) {
4269                 if (property->values[0] == DRM_MODE_OBJECT_FB)
4270                         drm_framebuffer_unreference(obj_to_fb(ref));
4271         }
4272 }
4273
4274 /**
4275  * drm_mode_connector_property_set_ioctl - set the current value of a connector property
4276  * @dev: DRM device
4277  * @data: ioctl data
4278  * @file_priv: DRM file info
4279  *
4280  * This function sets the current value for a connectors's property. It also
4281  * calls into a driver's ->set_property callback to update the hardware state
4282  *
4283  * Called by the user via ioctl.
4284  *
4285  * Returns:
4286  * Zero on success, negative errno on failure.
4287  */
4288 int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
4289                                        void *data, struct drm_file *file_priv)
4290 {
4291         struct drm_mode_connector_set_property *conn_set_prop = data;
4292         struct drm_mode_obj_set_property obj_set_prop = {
4293                 .value = conn_set_prop->value,
4294                 .prop_id = conn_set_prop->prop_id,
4295                 .obj_id = conn_set_prop->connector_id,
4296                 .obj_type = DRM_MODE_OBJECT_CONNECTOR
4297         };
4298
4299         /* It does all the locking and checking we need */
4300         return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
4301 }
4302
4303 static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
4304                                            struct drm_property *property,
4305                                            uint64_t value)
4306 {
4307         int ret = -EINVAL;
4308         struct drm_connector *connector = obj_to_connector(obj);
4309
4310         /* Do DPMS ourselves */
4311         if (property == connector->dev->mode_config.dpms_property) {
4312                 if (connector->funcs->dpms)
4313                         (*connector->funcs->dpms)(connector, (int)value);
4314                 ret = 0;
4315         } else if (connector->funcs->set_property)
4316                 ret = connector->funcs->set_property(connector, property, value);
4317
4318         /* store the property value if successful */
4319         if (!ret)
4320                 drm_object_property_set_value(&connector->base, property, value);
4321         return ret;
4322 }
4323
4324 static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
4325                                       struct drm_property *property,
4326                                       uint64_t value)
4327 {
4328         int ret = -EINVAL;
4329         struct drm_crtc *crtc = obj_to_crtc(obj);
4330
4331         if (crtc->funcs->set_property)
4332                 ret = crtc->funcs->set_property(crtc, property, value);
4333         if (!ret)
4334                 drm_object_property_set_value(obj, property, value);
4335
4336         return ret;
4337 }
4338
4339 /**
4340  * drm_mode_plane_set_obj_prop - set the value of a property
4341  * @plane: drm plane object to set property value for
4342  * @property: property to set
4343  * @value: value the property should be set to
4344  *
4345  * This functions sets a given property on a given plane object. This function
4346  * calls the driver's ->set_property callback and changes the software state of
4347  * the property if the callback succeeds.
4348  *
4349  * Returns:
4350  * Zero on success, error code on failure.
4351  */
4352 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
4353                                 struct drm_property *property,
4354                                 uint64_t value)
4355 {
4356         int ret = -EINVAL;
4357         struct drm_mode_object *obj = &plane->base;
4358
4359         if (plane->funcs->set_property)
4360                 ret = plane->funcs->set_property(plane, property, value);
4361         if (!ret)
4362                 drm_object_property_set_value(obj, property, value);
4363
4364         return ret;
4365 }
4366 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
4367
4368 /**
4369  * drm_mode_obj_get_properties_ioctl - get the current value of a object's property
4370  * @dev: DRM device
4371  * @data: ioctl data
4372  * @file_priv: DRM file info
4373  *
4374  * This function retrieves the current value for an object's property. Compared
4375  * to the connector specific ioctl this one is extended to also work on crtc and
4376  * plane objects.
4377  *
4378  * Called by the user via ioctl.
4379  *
4380  * Returns:
4381  * Zero on success, negative errno on failure.
4382  */
4383 int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
4384                                       struct drm_file *file_priv)
4385 {
4386         struct drm_mode_obj_get_properties *arg = data;
4387         struct drm_mode_object *obj;
4388         int ret = 0;
4389         int i;
4390         int copied = 0;
4391         int props_count = 0;
4392         uint32_t __user *props_ptr;
4393         uint64_t __user *prop_values_ptr;
4394
4395         if (!drm_core_check_feature(dev, DRIVER_MODESET))
4396                 return -EINVAL;
4397
4398         drm_modeset_lock_all(dev);
4399
4400         obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4401         if (!obj) {
4402                 ret = -ENOENT;
4403                 goto out;
4404         }
4405         if (!obj->properties) {
4406                 ret = -EINVAL;
4407                 goto out;
4408         }
4409
4410         props_count = obj->properties->count;
4411
4412         /* This ioctl is called twice, once to determine how much space is
4413          * needed, and the 2nd time to fill it. */
4414         if ((arg->count_props >= props_count) && props_count) {
4415                 copied = 0;
4416                 props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
4417                 prop_values_ptr = (uint64_t __user *)(unsigned long)
4418                                   (arg->prop_values_ptr);
4419                 for (i = 0; i < props_count; i++) {
4420                         struct drm_property *prop = obj->properties->properties[i];
4421                         uint64_t val;
4422
4423                         ret = drm_object_property_get_value(obj, prop, &val);
4424                         if (ret)
4425                                 goto out;
4426
4427                         if (put_user(prop->base.id, props_ptr + copied)) {
4428                                 ret = -EFAULT;
4429                                 goto out;
4430                         }
4431
4432                         if (put_user(val, prop_values_ptr + copied)) {
4433                                 ret = -EFAULT;
4434                                 goto out;
4435                         }
4436                         copied++;
4437                 }
4438         }
4439         arg->count_props = props_count;
4440 out:
4441         drm_modeset_unlock_all(dev);
4442         return ret;
4443 }
4444
4445 /**
4446  * drm_mode_obj_set_property_ioctl - set the current value of an object's property
4447  * @dev: DRM device
4448  * @data: ioctl data
4449  * @file_priv: DRM file info
4450  *
4451  * This function sets the current value for an object's property. It also calls
4452  * into a driver's ->set_property callback to update the hardware state.
4453  * Compared to the connector specific ioctl this one is extended to also work on
4454  * crtc and plane objects.
4455  *
4456  * Called by the user via ioctl.
4457  *
4458  * Returns:
4459  * Zero on success, negative errno on failure.
4460  */
4461 int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
4462                                     struct drm_file *file_priv)
4463 {
4464         struct drm_mode_obj_set_property *arg = data;
4465         struct drm_mode_object *arg_obj;
4466         struct drm_mode_object *prop_obj;
4467         struct drm_property *property;
4468         int i, ret = -EINVAL;
4469         struct drm_mode_object *ref;
4470
4471         if (!drm_core_check_feature(dev, DRIVER_MODESET))
4472                 return -EINVAL;
4473
4474         drm_modeset_lock_all(dev);
4475
4476         arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
4477         if (!arg_obj) {
4478                 ret = -ENOENT;
4479                 goto out;
4480         }
4481         if (!arg_obj->properties)
4482                 goto out;
4483
4484         for (i = 0; i < arg_obj->properties->count; i++)
4485                 if (arg_obj->properties->properties[i]->base.id == arg->prop_id)
4486                         break;
4487
4488         if (i == arg_obj->properties->count)
4489                 goto out;
4490
4491         prop_obj = drm_mode_object_find(dev, arg->prop_id,
4492                                         DRM_MODE_OBJECT_PROPERTY);
4493         if (!prop_obj) {
4494                 ret = -ENOENT;
4495                 goto out;
4496         }
4497         property = obj_to_property(prop_obj);
4498
4499         if (!drm_property_change_valid_get(property, arg->value, &ref))
4500                 goto out;
4501
4502         switch (arg_obj->type) {
4503         case DRM_MODE_OBJECT_CONNECTOR:
4504                 ret = drm_mode_connector_set_obj_prop(arg_obj, property,
4505                                                       arg->value);
4506                 break;
4507         case DRM_MODE_OBJECT_CRTC:
4508                 ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
4509                 break;
4510         case DRM_MODE_OBJECT_PLANE:
4511                 ret = drm_mode_plane_set_obj_prop(obj_to_plane(arg_obj),
4512                                                   property, arg->value);
4513                 break;
4514         }
4515
4516         drm_property_change_valid_put(property, ref);
4517
4518 out:
4519         drm_modeset_unlock_all(dev);
4520         return ret;
4521 }
4522
4523 /**
4524  * drm_mode_connector_attach_encoder - attach a connector to an encoder
4525  * @connector: connector to attach
4526  * @encoder: encoder to attach @connector to
4527  *
4528  * This function links up a connector to an encoder. Note that the routing
4529  * restrictions between encoders and crtcs are exposed to userspace through the
4530  * possible_clones and possible_crtcs bitmasks.
4531  *
4532  * Returns:
4533  * Zero on success, negative errno on failure.
4534  */
4535 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
4536                                       struct drm_encoder *encoder)
4537 {
4538         int i;
4539
4540         for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
4541                 if (connector->encoder_ids[i] == 0) {
4542                         connector->encoder_ids[i] = encoder->base.id;
4543                         return 0;
4544                 }
4545         }
4546         return -ENOMEM;
4547 }
4548 EXPORT_SYMBOL(drm_mode_connector_attach_encoder);
4549
4550 /**
4551  * drm_mode_crtc_set_gamma_size - set the gamma table size
4552  * @crtc: CRTC to set the gamma table size for
4553  * @gamma_size: size of the gamma table
4554  *
4555  * Drivers which support gamma tables should set this to the supported gamma
4556  * table size when initializing the CRTC. Currently the drm core only supports a
4557  * fixed gamma table size.
4558  *
4559  * Returns:
4560  * Zero on success, negative errno on failure.
4561  */
4562 int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
4563                                  int gamma_size)
4564 {
4565         crtc->gamma_size = gamma_size;
4566
4567         crtc->gamma_store = kzalloc(gamma_size * sizeof(uint16_t) * 3, GFP_KERNEL);
4568         if (!crtc->gamma_store) {
4569                 crtc->gamma_size = 0;
4570                 return -ENOMEM;
4571         }
4572
4573         return 0;
4574 }
4575 EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);
4576
4577 /**
4578  * drm_mode_gamma_set_ioctl - set the gamma table
4579  * @dev: DRM device
4580  * @data: ioctl data
4581  * @file_priv: DRM file info
4582  *
4583  * Set the gamma table of a CRTC to the one passed in by the user. Userspace can
4584  * inquire the required gamma table size through drm_mode_gamma_get_ioctl.
4585  *
4586  * Called by the user via ioctl.
4587  *
4588  * Returns:
4589  * Zero on success, negative errno on failure.
4590  */
4591 int drm_mode_gamma_set_ioctl(struct drm_device *dev,
4592                              void *data, struct drm_file *file_priv)
4593 {
4594         struct drm_mode_crtc_lut *crtc_lut = data;
4595         struct drm_crtc *crtc;
4596         void *r_base, *g_base, *b_base;
4597         int size;
4598         int ret = 0;
4599
4600         if (!drm_core_check_feature(dev, DRIVER_MODESET))
4601                 return -EINVAL;
4602
4603         drm_modeset_lock_all(dev);
4604         crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4605         if (!crtc) {
4606                 ret = -ENOENT;
4607                 goto out;
4608         }
4609
4610         if (crtc->funcs->gamma_set == NULL) {
4611                 ret = -ENOSYS;
4612                 goto out;
4613         }
4614
4615         /* memcpy into gamma store */
4616         if (crtc_lut->gamma_size != crtc->gamma_size) {
4617                 ret = -EINVAL;
4618                 goto out;
4619         }
4620
4621         size = crtc_lut->gamma_size * (sizeof(uint16_t));
4622         r_base = crtc->gamma_store;
4623         if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
4624                 ret = -EFAULT;
4625                 goto out;
4626         }
4627
4628         g_base = r_base + size;
4629         if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
4630                 ret = -EFAULT;
4631                 goto out;
4632         }
4633
4634         b_base = g_base + size;
4635         if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
4636                 ret = -EFAULT;
4637                 goto out;
4638         }
4639
4640         crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
4641
4642 out:
4643         drm_modeset_unlock_all(dev);
4644         return ret;
4645
4646 }
4647
4648 /**
4649  * drm_mode_gamma_get_ioctl - get the gamma table
4650  * @dev: DRM device
4651  * @data: ioctl data
4652  * @file_priv: DRM file info
4653  *
4654  * Copy the current gamma table into the storage provided. This also provides
4655  * the gamma table size the driver expects, which can be used to size the
4656  * allocated storage.
4657  *
4658  * Called by the user via ioctl.
4659  *
4660  * Returns:
4661  * Zero on success, negative errno on failure.
4662  */
4663 int drm_mode_gamma_get_ioctl(struct drm_device *dev,
4664                              void *data, struct drm_file *file_priv)
4665 {
4666         struct drm_mode_crtc_lut *crtc_lut = data;
4667         struct drm_crtc *crtc;
4668         void *r_base, *g_base, *b_base;
4669         int size;
4670         int ret = 0;
4671
4672         if (!drm_core_check_feature(dev, DRIVER_MODESET))
4673                 return -EINVAL;
4674
4675         drm_modeset_lock_all(dev);
4676         crtc = drm_crtc_find(dev, crtc_lut->crtc_id);
4677         if (!crtc) {
4678                 ret = -ENOENT;
4679                 goto out;
4680         }
4681
4682         /* memcpy into gamma store */
4683         if (crtc_lut->gamma_size != crtc->gamma_size) {
4684                 ret = -EINVAL;
4685                 goto out;
4686         }
4687
4688         size = crtc_lut->gamma_size * (sizeof(uint16_t));
4689         r_base = crtc->gamma_store;
4690         if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
4691                 ret = -EFAULT;
4692                 goto out;
4693         }
4694
4695         g_base = r_base + size;
4696         if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
4697                 ret = -EFAULT;
4698                 goto out;
4699         }
4700
4701         b_base = g_base + size;
4702         if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
4703                 ret = -EFAULT;
4704                 goto out;
4705         }
4706 out:
4707         drm_modeset_unlock_all(dev);
4708         return ret;
4709 }
4710
4711 /**
4712  * drm_mode_page_flip_ioctl - schedule an asynchronous fb update
4713  * @dev: DRM device
4714  * @data: ioctl data
4715  * @file_priv: DRM file info
4716  *
4717  * This schedules an asynchronous update on a given CRTC, called page flip.
4718  * Optionally a drm event is generated to signal the completion of the event.
4719  * Generic drivers cannot assume that a pageflip with changed framebuffer
4720  * properties (including driver specific metadata like tiling layout) will work,
4721  * but some drivers support e.g. pixel format changes through the pageflip
4722  * ioctl.
4723  *
4724  * Called by the user via ioctl.
4725  *
4726  * Returns:
4727  * Zero on success, negative errno on failure.
4728  */
4729 int drm_mode_page_flip_ioctl(struct drm_device *dev,
4730                              void *data, struct drm_file *file_priv)
4731 {
4732         struct drm_mode_crtc_page_flip *page_flip = data;
4733         struct drm_crtc *crtc;
4734         struct drm_framebuffer *fb = NULL;
4735         struct drm_pending_vblank_event *e = NULL;
4736         unsigned long flags;
4737         int ret = -EINVAL;
4738
4739         if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
4740             page_flip->reserved != 0)
4741                 return -EINVAL;
4742
4743         if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
4744                 return -EINVAL;
4745
4746         crtc = drm_crtc_find(dev, page_flip->crtc_id);
4747         if (!crtc)
4748                 return -ENOENT;
4749
4750         drm_modeset_lock_crtc(crtc, crtc->primary);
4751         if (crtc->primary->fb == NULL) {
4752                 /* The framebuffer is currently unbound, presumably
4753                  * due to a hotplug event, that userspace has not
4754                  * yet discovered.
4755                  */
4756                 ret = -EBUSY;
4757                 goto out;
4758         }
4759
4760         if (crtc->funcs->page_flip == NULL)
4761                 goto out;
4762
4763         fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
4764         if (!fb) {
4765                 ret = -ENOENT;
4766                 goto out;
4767         }
4768
4769         ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
4770         if (ret)
4771                 goto out;
4772
4773         if (crtc->primary->fb->pixel_format != fb->pixel_format) {
4774                 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
4775                 ret = -EINVAL;
4776                 goto out;
4777         }
4778
4779         if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4780                 ret = -ENOMEM;
4781                 spin_lock_irqsave(&dev->event_lock, flags);
4782                 if (file_priv->event_space < sizeof e->event) {
4783                         spin_unlock_irqrestore(&dev->event_lock, flags);
4784                         goto out;
4785                 }
4786                 file_priv->event_space -= sizeof e->event;
4787                 spin_unlock_irqrestore(&dev->event_lock, flags);
4788
4789                 e = kzalloc(sizeof *e, GFP_KERNEL);
4790                 if (e == NULL) {
4791                         spin_lock_irqsave(&dev->event_lock, flags);
4792                         file_priv->event_space += sizeof e->event;
4793                         spin_unlock_irqrestore(&dev->event_lock, flags);
4794                         goto out;
4795                 }
4796
4797                 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
4798                 e->event.base.length = sizeof e->event;
4799                 e->event.user_data = page_flip->user_data;
4800                 e->base.event = &e->event.base;
4801                 e->base.file_priv = file_priv;
4802                 e->base.destroy =
4803                         (void (*) (struct drm_pending_event *)) kfree;
4804         }
4805
4806         crtc->primary->old_fb = crtc->primary->fb;
4807         ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
4808         if (ret) {
4809                 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
4810                         spin_lock_irqsave(&dev->event_lock, flags);
4811                         file_priv->event_space += sizeof e->event;
4812                         spin_unlock_irqrestore(&dev->event_lock, flags);
4813                         kfree(e);
4814                 }
4815                 /* Keep the old fb, don't unref it. */
4816                 crtc->primary->old_fb = NULL;
4817         } else {
4818                 /*
4819                  * Warn if the driver hasn't properly updated the crtc->fb
4820                  * field to reflect that the new framebuffer is now used.
4821                  * Failing to do so will screw with the reference counting
4822                  * on framebuffers.
4823                  */
4824                 WARN_ON(crtc->primary->fb != fb);
4825                 /* Unref only the old framebuffer. */
4826                 fb = NULL;
4827         }
4828
4829 out:
4830         if (fb)
4831                 drm_framebuffer_unreference(fb);
4832         if (crtc->primary->old_fb)
4833                 drm_framebuffer_unreference(crtc->primary->old_fb);
4834         crtc->primary->old_fb = NULL;
4835         drm_modeset_unlock_crtc(crtc);
4836
4837         return ret;
4838 }
4839
4840 /**
4841  * drm_mode_config_reset - call ->reset callbacks
4842  * @dev: drm device
4843  *
4844  * This functions calls all the crtc's, encoder's and connector's ->reset
4845  * callback. Drivers can use this in e.g. their driver load or resume code to
4846  * reset hardware and software state.
4847  */
4848 void drm_mode_config_reset(struct drm_device *dev)
4849 {
4850         struct drm_crtc *crtc;
4851         struct drm_plane *plane;
4852         struct drm_encoder *encoder;
4853         struct drm_connector *connector;
4854
4855         list_for_each_entry(plane, &dev->mode_config.plane_list, head)
4856                 if (plane->funcs->reset)
4857                         plane->funcs->reset(plane);
4858
4859         list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
4860                 if (crtc->funcs->reset)
4861                         crtc->funcs->reset(crtc);
4862
4863         list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
4864                 if (encoder->funcs->reset)
4865                         encoder->funcs->reset(encoder);
4866
4867         list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
4868                 connector->status = connector_status_unknown;
4869
4870                 if (connector->funcs->reset)
4871                         connector->funcs->reset(connector);
4872         }
4873 }
4874 EXPORT_SYMBOL(drm_mode_config_reset);
4875
4876 /**
4877  * drm_mode_create_dumb_ioctl - create a dumb backing storage buffer
4878  * @dev: DRM device
4879  * @data: ioctl data
4880  * @file_priv: DRM file info
4881  *
4882  * This creates a new dumb buffer in the driver's backing storage manager (GEM,
4883  * TTM or something else entirely) and returns the resulting buffer handle. This
4884  * handle can then be wrapped up into a framebuffer modeset object.
4885  *
4886  * Note that userspace is not allowed to use such objects for render
4887  * acceleration - drivers must create their own private ioctls for such a use
4888  * case.
4889  *
4890  * Called by the user via ioctl.
4891  *
4892  * Returns:
4893  * Zero on success, negative errno on failure.
4894  */
4895 int drm_mode_create_dumb_ioctl(struct drm_device *dev,
4896                                void *data, struct drm_file *file_priv)
4897 {
4898         struct drm_mode_create_dumb *args = data;
4899         u32 cpp, stride, size;
4900
4901         if (!dev->driver->dumb_create)
4902                 return -ENOSYS;
4903         if (!args->width || !args->height || !args->bpp)
4904                 return -EINVAL;
4905
4906         /* overflow checks for 32bit size calculations */
4907         /* NOTE: DIV_ROUND_UP() can overflow */
4908         cpp = DIV_ROUND_UP(args->bpp, 8);
4909         if (!cpp || cpp > 0xffffffffU / args->width)
4910                 return -EINVAL;
4911         stride = cpp * args->width;
4912         if (args->height > 0xffffffffU / stride)
4913                 return -EINVAL;
4914
4915         /* test for wrap-around */
4916         size = args->height * stride;
4917         if (PAGE_ALIGN(size) == 0)
4918                 return -EINVAL;
4919
4920         /*
4921          * handle, pitch and size are output parameters. Zero them out to
4922          * prevent drivers from accidentally using uninitialized data. Since
4923          * not all existing userspace is clearing these fields properly we
4924          * cannot reject IOCTL with garbage in them.
4925          */
4926         args->handle = 0;
4927         args->pitch = 0;
4928         args->size = 0;
4929
4930         return dev->driver->dumb_create(file_priv, dev, args);
4931 }
4932
4933 /**
4934  * drm_mode_mmap_dumb_ioctl - create an mmap offset for a dumb backing storage buffer
4935  * @dev: DRM device
4936  * @data: ioctl data
4937  * @file_priv: DRM file info
4938  *
4939  * Allocate an offset in the drm device node's address space to be able to
4940  * memory map a dumb buffer.
4941  *
4942  * Called by the user via ioctl.
4943  *
4944  * Returns:
4945  * Zero on success, negative errno on failure.
4946  */
4947 int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
4948                              void *data, struct drm_file *file_priv)
4949 {
4950         struct drm_mode_map_dumb *args = data;
4951
4952         /* call driver ioctl to get mmap offset */
4953         if (!dev->driver->dumb_map_offset)
4954                 return -ENOSYS;
4955
4956         return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
4957 }
4958
4959 /**
4960  * drm_mode_destroy_dumb_ioctl - destroy a dumb backing strage buffer
4961  * @dev: DRM device
4962  * @data: ioctl data
4963  * @file_priv: DRM file info
4964  *
4965  * This destroys the userspace handle for the given dumb backing storage buffer.
4966  * Since buffer objects must be reference counted in the kernel a buffer object
4967  * won't be immediately freed if a framebuffer modeset object still uses it.
4968  *
4969  * Called by the user via ioctl.
4970  *
4971  * Returns:
4972  * Zero on success, negative errno on failure.
4973  */
4974 int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
4975                                 void *data, struct drm_file *file_priv)
4976 {
4977         struct drm_mode_destroy_dumb *args = data;
4978
4979         if (!dev->driver->dumb_destroy)
4980                 return -ENOSYS;
4981
4982         return dev->driver->dumb_destroy(file_priv, dev, args->handle);
4983 }
4984
4985 /**
4986  * drm_fb_get_bpp_depth - get the bpp/depth values for format
4987  * @format: pixel format (DRM_FORMAT_*)
4988  * @depth: storage for the depth value
4989  * @bpp: storage for the bpp value
4990  *
4991  * This only supports RGB formats here for compat with code that doesn't use
4992  * pixel formats directly yet.
4993  */
4994 void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
4995                           int *bpp)
4996 {
4997         switch (format) {
4998         case DRM_FORMAT_C8:
4999         case DRM_FORMAT_RGB332:
5000         case DRM_FORMAT_BGR233:
5001                 *depth = 8;
5002                 *bpp = 8;
5003                 break;
5004         case DRM_FORMAT_XRGB1555:
5005         case DRM_FORMAT_XBGR1555:
5006         case DRM_FORMAT_RGBX5551:
5007         case DRM_FORMAT_BGRX5551:
5008         case DRM_FORMAT_ARGB1555:
5009         case DRM_FORMAT_ABGR1555:
5010         case DRM_FORMAT_RGBA5551:
5011         case DRM_FORMAT_BGRA5551:
5012                 *depth = 15;
5013                 *bpp = 16;
5014                 break;
5015         case DRM_FORMAT_RGB565:
5016         case DRM_FORMAT_BGR565:
5017                 *depth = 16;
5018                 *bpp = 16;
5019                 break;
5020         case DRM_FORMAT_RGB888:
5021         case DRM_FORMAT_BGR888:
5022                 *depth = 24;
5023                 *bpp = 24;
5024                 break;
5025         case DRM_FORMAT_XRGB8888:
5026         case DRM_FORMAT_XBGR8888:
5027         case DRM_FORMAT_RGBX8888:
5028         case DRM_FORMAT_BGRX8888:
5029                 *depth = 24;
5030                 *bpp = 32;
5031                 break;
5032         case DRM_FORMAT_XRGB2101010:
5033         case DRM_FORMAT_XBGR2101010:
5034         case DRM_FORMAT_RGBX1010102:
5035         case DRM_FORMAT_BGRX1010102:
5036         case DRM_FORMAT_ARGB2101010:
5037         case DRM_FORMAT_ABGR2101010:
5038         case DRM_FORMAT_RGBA1010102:
5039         case DRM_FORMAT_BGRA1010102:
5040                 *depth = 30;
5041                 *bpp = 32;
5042                 break;
5043         case DRM_FORMAT_ARGB8888:
5044         case DRM_FORMAT_ABGR8888:
5045         case DRM_FORMAT_RGBA8888:
5046         case DRM_FORMAT_BGRA8888:
5047                 *depth = 32;
5048                 *bpp = 32;
5049                 break;
5050         default:
5051                 DRM_DEBUG_KMS("unsupported pixel format %s\n",
5052                               drm_get_format_name(format));
5053                 *depth = 0;
5054                 *bpp = 0;
5055                 break;
5056         }
5057 }
5058 EXPORT_SYMBOL(drm_fb_get_bpp_depth);
5059
5060 /**
5061  * drm_format_num_planes - get the number of planes for format
5062  * @format: pixel format (DRM_FORMAT_*)
5063  *
5064  * Returns:
5065  * The number of planes used by the specified pixel format.
5066  */
5067 int drm_format_num_planes(uint32_t format)
5068 {
5069         switch (format) {
5070         case DRM_FORMAT_YUV410:
5071         case DRM_FORMAT_YVU410:
5072         case DRM_FORMAT_YUV411:
5073         case DRM_FORMAT_YVU411:
5074         case DRM_FORMAT_YUV420:
5075         case DRM_FORMAT_YVU420:
5076         case DRM_FORMAT_YUV422:
5077         case DRM_FORMAT_YVU422:
5078         case DRM_FORMAT_YUV444:
5079         case DRM_FORMAT_YVU444:
5080                 return 3;
5081         case DRM_FORMAT_NV12:
5082         case DRM_FORMAT_NV21:
5083         case DRM_FORMAT_NV16:
5084         case DRM_FORMAT_NV61:
5085         case DRM_FORMAT_NV24:
5086         case DRM_FORMAT_NV42:
5087                 return 2;
5088         default:
5089                 return 1;
5090         }
5091 }
5092 EXPORT_SYMBOL(drm_format_num_planes);
5093
5094 /**
5095  * drm_format_plane_cpp - determine the bytes per pixel value
5096  * @format: pixel format (DRM_FORMAT_*)
5097  * @plane: plane index
5098  *
5099  * Returns:
5100  * The bytes per pixel value for the specified plane.
5101  */
5102 int drm_format_plane_cpp(uint32_t format, int plane)
5103 {
5104         unsigned int depth;
5105         int bpp;
5106
5107         if (plane >= drm_format_num_planes(format))
5108                 return 0;
5109
5110         switch (format) {
5111         case DRM_FORMAT_YUYV:
5112         case DRM_FORMAT_YVYU:
5113         case DRM_FORMAT_UYVY:
5114         case DRM_FORMAT_VYUY:
5115                 return 2;
5116         case DRM_FORMAT_NV12:
5117         case DRM_FORMAT_NV21:
5118         case DRM_FORMAT_NV16:
5119         case DRM_FORMAT_NV61:
5120         case DRM_FORMAT_NV24:
5121         case DRM_FORMAT_NV42:
5122                 return plane ? 2 : 1;
5123         case DRM_FORMAT_YUV410:
5124         case DRM_FORMAT_YVU410:
5125         case DRM_FORMAT_YUV411:
5126         case DRM_FORMAT_YVU411:
5127         case DRM_FORMAT_YUV420:
5128         case DRM_FORMAT_YVU420:
5129         case DRM_FORMAT_YUV422:
5130         case DRM_FORMAT_YVU422:
5131         case DRM_FORMAT_YUV444:
5132         case DRM_FORMAT_YVU444:
5133                 return 1;
5134         default:
5135                 drm_fb_get_bpp_depth(format, &depth, &bpp);
5136                 return bpp >> 3;
5137         }
5138 }
5139 EXPORT_SYMBOL(drm_format_plane_cpp);
5140
5141 /**
5142  * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
5143  * @format: pixel format (DRM_FORMAT_*)
5144  *
5145  * Returns:
5146  * The horizontal chroma subsampling factor for the
5147  * specified pixel format.
5148  */
5149 int drm_format_horz_chroma_subsampling(uint32_t format)
5150 {
5151         switch (format) {
5152         case DRM_FORMAT_YUV411:
5153         case DRM_FORMAT_YVU411:
5154         case DRM_FORMAT_YUV410:
5155         case DRM_FORMAT_YVU410:
5156                 return 4;
5157         case DRM_FORMAT_YUYV:
5158         case DRM_FORMAT_YVYU:
5159         case DRM_FORMAT_UYVY:
5160         case DRM_FORMAT_VYUY:
5161         case DRM_FORMAT_NV12:
5162         case DRM_FORMAT_NV21:
5163         case DRM_FORMAT_NV16:
5164         case DRM_FORMAT_NV61:
5165         case DRM_FORMAT_YUV422:
5166         case DRM_FORMAT_YVU422:
5167         case DRM_FORMAT_YUV420:
5168         case DRM_FORMAT_YVU420:
5169                 return 2;
5170         default:
5171                 return 1;
5172         }
5173 }
5174 EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);
5175
5176 /**
5177  * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
5178  * @format: pixel format (DRM_FORMAT_*)
5179  *
5180  * Returns:
5181  * The vertical chroma subsampling factor for the
5182  * specified pixel format.
5183  */
5184 int drm_format_vert_chroma_subsampling(uint32_t format)
5185 {
5186         switch (format) {
5187         case DRM_FORMAT_YUV410:
5188         case DRM_FORMAT_YVU410:
5189                 return 4;
5190         case DRM_FORMAT_YUV420:
5191         case DRM_FORMAT_YVU420:
5192         case DRM_FORMAT_NV12:
5193         case DRM_FORMAT_NV21:
5194                 return 2;
5195         default:
5196                 return 1;
5197         }
5198 }
5199 EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);
5200
5201 /**
5202  * drm_rotation_simplify() - Try to simplify the rotation
5203  * @rotation: Rotation to be simplified
5204  * @supported_rotations: Supported rotations
5205  *
5206  * Attempt to simplify the rotation to a form that is supported.
5207  * Eg. if the hardware supports everything except DRM_REFLECT_X
5208  * one could call this function like this:
5209  *
5210  * drm_rotation_simplify(rotation, BIT(DRM_ROTATE_0) |
5211  *                       BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_180) |
5212  *                       BIT(DRM_ROTATE_270) | BIT(DRM_REFLECT_Y));
5213  *
5214  * to eliminate the DRM_ROTATE_X flag. Depending on what kind of
5215  * transforms the hardware supports, this function may not
5216  * be able to produce a supported transform, so the caller should
5217  * check the result afterwards.
5218  */
5219 unsigned int drm_rotation_simplify(unsigned int rotation,
5220                                    unsigned int supported_rotations)
5221 {
5222         if (rotation & ~supported_rotations) {
5223                 rotation ^= BIT(DRM_REFLECT_X) | BIT(DRM_REFLECT_Y);
5224                 rotation = (rotation & ~0xf) | BIT((ffs(rotation & 0xf) + 1) % 4);
5225         }
5226
5227         return rotation;
5228 }
5229 EXPORT_SYMBOL(drm_rotation_simplify);
5230
5231 /**
5232  * drm_mode_config_init - initialize DRM mode_configuration structure
5233  * @dev: DRM device
5234  *
5235  * Initialize @dev's mode_config structure, used for tracking the graphics
5236  * configuration of @dev.
5237  *
5238  * Since this initializes the modeset locks, no locking is possible. Which is no
5239  * problem, since this should happen single threaded at init time. It is the
5240  * driver's problem to ensure this guarantee.
5241  *
5242  */
5243 void drm_mode_config_init(struct drm_device *dev)
5244 {
5245         mutex_init(&dev->mode_config.mutex);
5246         drm_modeset_lock_init(&dev->mode_config.connection_mutex);
5247         mutex_init(&dev->mode_config.idr_mutex);
5248         mutex_init(&dev->mode_config.fb_lock);
5249         INIT_LIST_HEAD(&dev->mode_config.fb_list);
5250         INIT_LIST_HEAD(&dev->mode_config.crtc_list);
5251         INIT_LIST_HEAD(&dev->mode_config.connector_list);
5252         INIT_LIST_HEAD(&dev->mode_config.bridge_list);
5253         INIT_LIST_HEAD(&dev->mode_config.encoder_list);
5254         INIT_LIST_HEAD(&dev->mode_config.property_list);
5255         INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
5256         INIT_LIST_HEAD(&dev->mode_config.plane_list);
5257         idr_init(&dev->mode_config.crtc_idr);
5258         idr_init(&dev->mode_config.tile_idr);
5259
5260         drm_modeset_lock_all(dev);
5261         drm_mode_create_standard_connector_properties(dev);
5262         drm_mode_create_standard_plane_properties(dev);
5263         drm_modeset_unlock_all(dev);
5264
5265         /* Just to be sure */
5266         dev->mode_config.num_fb = 0;
5267         dev->mode_config.num_connector = 0;
5268         dev->mode_config.num_crtc = 0;
5269         dev->mode_config.num_encoder = 0;
5270         dev->mode_config.num_overlay_plane = 0;
5271         dev->mode_config.num_total_plane = 0;
5272 }
5273 EXPORT_SYMBOL(drm_mode_config_init);
5274
5275 /**
5276  * drm_mode_config_cleanup - free up DRM mode_config info
5277  * @dev: DRM device
5278  *
5279  * Free up all the connectors and CRTCs associated with this DRM device, then
5280  * free up the framebuffers and associated buffer objects.
5281  *
5282  * Note that since this /should/ happen single-threaded at driver/device
5283  * teardown time, no locking is required. It's the driver's job to ensure that
5284  * this guarantee actually holds true.
5285  *
5286  * FIXME: cleanup any dangling user buffer objects too
5287  */
5288 void drm_mode_config_cleanup(struct drm_device *dev)
5289 {
5290         struct drm_connector *connector, *ot;
5291         struct drm_crtc *crtc, *ct;
5292         struct drm_encoder *encoder, *enct;
5293         struct drm_bridge *bridge, *brt;
5294         struct drm_framebuffer *fb, *fbt;
5295         struct drm_property *property, *pt;
5296         struct drm_property_blob *blob, *bt;
5297         struct drm_plane *plane, *plt;
5298
5299         list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
5300                                  head) {
5301                 encoder->funcs->destroy(encoder);
5302         }
5303
5304         list_for_each_entry_safe(bridge, brt,
5305                                  &dev->mode_config.bridge_list, head) {
5306                 bridge->funcs->destroy(bridge);
5307         }
5308
5309         list_for_each_entry_safe(connector, ot,
5310                                  &dev->mode_config.connector_list, head) {
5311                 connector->funcs->destroy(connector);
5312         }
5313
5314         list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
5315                                  head) {
5316                 drm_property_destroy(dev, property);
5317         }
5318
5319         list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
5320                                  head) {
5321                 drm_property_destroy_blob(dev, blob);
5322         }
5323
5324         /*
5325          * Single-threaded teardown context, so it's not required to grab the
5326          * fb_lock to protect against concurrent fb_list access. Contrary, it
5327          * would actually deadlock with the drm_framebuffer_cleanup function.
5328          *
5329          * Also, if there are any framebuffers left, that's a driver leak now,
5330          * so politely WARN about this.
5331          */
5332         WARN_ON(!list_empty(&dev->mode_config.fb_list));
5333         list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
5334                 drm_framebuffer_remove(fb);
5335         }
5336
5337         list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
5338                                  head) {
5339                 plane->funcs->destroy(plane);
5340         }
5341
5342         list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
5343                 crtc->funcs->destroy(crtc);
5344         }
5345
5346         idr_destroy(&dev->mode_config.tile_idr);
5347         idr_destroy(&dev->mode_config.crtc_idr);
5348         drm_modeset_lock_fini(&dev->mode_config.connection_mutex);
5349 }
5350 EXPORT_SYMBOL(drm_mode_config_cleanup);
5351
5352 struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
5353                                                        unsigned int supported_rotations)
5354 {
5355         static const struct drm_prop_enum_list props[] = {
5356                 { DRM_ROTATE_0,   "rotate-0" },
5357                 { DRM_ROTATE_90,  "rotate-90" },
5358                 { DRM_ROTATE_180, "rotate-180" },
5359                 { DRM_ROTATE_270, "rotate-270" },
5360                 { DRM_REFLECT_X,  "reflect-x" },
5361                 { DRM_REFLECT_Y,  "reflect-y" },
5362         };
5363
5364         return drm_property_create_bitmask(dev, 0, "rotation",
5365                                            props, ARRAY_SIZE(props),
5366                                            supported_rotations);
5367 }
5368 EXPORT_SYMBOL(drm_mode_create_rotation_property);
5369
5370 /**
5371  * DOC: Tile group
5372  *
5373  * Tile groups are used to represent tiled monitors with a unique
5374  * integer identifier. Tiled monitors using DisplayID v1.3 have
5375  * a unique 8-byte handle, we store this in a tile group, so we
5376  * have a common identifier for all tiles in a monitor group.
5377  */
5378 static void drm_tile_group_free(struct kref *kref)
5379 {
5380         struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
5381         struct drm_device *dev = tg->dev;
5382         mutex_lock(&dev->mode_config.idr_mutex);
5383         idr_remove(&dev->mode_config.tile_idr, tg->id);
5384         mutex_unlock(&dev->mode_config.idr_mutex);
5385         kfree(tg);
5386 }
5387
5388 /**
5389  * drm_mode_put_tile_group - drop a reference to a tile group.
5390  * @dev: DRM device
5391  * @tg: tile group to drop reference to.
5392  *
5393  * drop reference to tile group and free if 0.
5394  */
5395 void drm_mode_put_tile_group(struct drm_device *dev,
5396                              struct drm_tile_group *tg)
5397 {
5398         kref_put(&tg->refcount, drm_tile_group_free);
5399 }
5400
5401 /**
5402  * drm_mode_get_tile_group - get a reference to an existing tile group
5403  * @dev: DRM device
5404  * @topology: 8-bytes unique per monitor.
5405  *
5406  * Use the unique bytes to get a reference to an existing tile group.
5407  *
5408  * RETURNS:
5409  * tile group or NULL if not found.
5410  */
5411 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
5412                                                char topology[8])
5413 {
5414         struct drm_tile_group *tg;
5415         int id;
5416         mutex_lock(&dev->mode_config.idr_mutex);
5417         idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
5418                 if (!memcmp(tg->group_data, topology, 8)) {
5419                         if (!kref_get_unless_zero(&tg->refcount))
5420                                 tg = NULL;
5421                         mutex_unlock(&dev->mode_config.idr_mutex);
5422                         return tg;
5423                 }
5424         }
5425         mutex_unlock(&dev->mode_config.idr_mutex);
5426         return NULL;
5427 }
5428
5429 /**
5430  * drm_mode_create_tile_group - create a tile group from a displayid description
5431  * @dev: DRM device
5432  * @topology: 8-bytes unique per monitor.
5433  *
5434  * Create a tile group for the unique monitor, and get a unique
5435  * identifier for the tile group.
5436  *
5437  * RETURNS:
5438  * new tile group or error.
5439  */
5440 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
5441                                                   char topology[8])
5442 {
5443         struct drm_tile_group *tg;
5444         int ret;
5445
5446         tg = kzalloc(sizeof(*tg), GFP_KERNEL);
5447         if (!tg)
5448                 return ERR_PTR(-ENOMEM);
5449
5450         kref_init(&tg->refcount);
5451         memcpy(tg->group_data, topology, 8);
5452         tg->dev = dev;
5453
5454         mutex_lock(&dev->mode_config.idr_mutex);
5455         ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
5456         if (ret >= 0) {
5457                 tg->id = ret;
5458         } else {
5459                 kfree(tg);
5460                 tg = ERR_PTR(ret);
5461         }
5462
5463         mutex_unlock(&dev->mode_config.idr_mutex);
5464         return tg;
5465 }