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