drivers/gpu/drm/drm_sysfs.c

   1
   2 /*
   3  * drm_sysfs.c - Modifications to drm_sysfs_class.c to support
   4  *               extra sysfs attribute from DRM. Normal drm_sysfs_class
   5  *               does not allow adding attributes.
   6  *
   7  * Copyright (c) 2004 Jon Smirl <jonsmirl@gmail.com>
   8  * Copyright (c) 2003-2004 Greg Kroah-Hartman <greg@kroah.com>
   9  * Copyright (c) 2003-2004 IBM Corp.
  10  *
  11  * This file is released under the GPLv2
  12  *
  13  */
  14
  15 #include <linux/device.h>
  16 #include <linux/kdev_t.h>
  17 #include <linux/gfp.h>
  18 #include <linux/err.h>
  19 #include <linux/export.h>
  20
  21 #include <drm/drm_sysfs.h>
  22 #include <drm/drm_core.h>
  23 #include <drm/drmP.h>
  24 #include "drm_internal.h"
  25
  26 #define to_drm_minor(d) dev_get_drvdata(d)
  27 #define to_drm_connector(d) dev_get_drvdata(d)
  28
  29 static struct device_type drm_sysfs_device_minor = {
  30         .name = "drm_minor"
  31 };
  32
  33 struct class *drm_class;
  34
  35 /**
  36  * __drm_class_suspend - internal DRM class suspend routine
  37  * @dev: Linux device to suspend
  38  * @state: power state to enter
  39  *
  40  * Just figures out what the actual struct drm_device associated with
  41  * @dev is and calls its suspend hook, if present.
  42  */
  43 static int __drm_class_suspend(struct device *dev, pm_message_t state)
  44 {
  45         if (dev->type == &drm_sysfs_device_minor) {
  46                 struct drm_minor *drm_minor = to_drm_minor(dev);
  47                 struct drm_device *drm_dev = drm_minor->dev;
  48
  49                 if (drm_minor->type == DRM_MINOR_LEGACY &&
  50                     !drm_core_check_feature(drm_dev, DRIVER_MODESET) &&
  51                     drm_dev->driver->suspend)
  52                         return drm_dev->driver->suspend(drm_dev, state);
  53         }
  54         return 0;
  55 }
  56
  57 /**
  58  * drm_class_suspend - internal DRM class suspend hook. Simply calls
  59  * __drm_class_suspend() with the correct pm state.
  60  * @dev: Linux device to suspend
  61  */
  62 static int drm_class_suspend(struct device *dev)
  63 {
  64         return __drm_class_suspend(dev, PMSG_SUSPEND);
  65 }
  66
  67 /**
  68  * drm_class_freeze - internal DRM class freeze hook. Simply calls
  69  * __drm_class_suspend() with the correct pm state.
  70  * @dev: Linux device to freeze
  71  */
  72 static int drm_class_freeze(struct device *dev)
  73 {
  74         return __drm_class_suspend(dev, PMSG_FREEZE);
  75 }
  76
  77 /**
  78  * drm_class_resume - DRM class resume hook
  79  * @dev: Linux device to resume
  80  *
  81  * Just figures out what the actual struct drm_device associated with
  82  * @dev is and calls its resume hook, if present.
  83  */
  84 static int drm_class_resume(struct device *dev)
  85 {
  86         if (dev->type == &drm_sysfs_device_minor) {
  87                 struct drm_minor *drm_minor = to_drm_minor(dev);
  88                 struct drm_device *drm_dev = drm_minor->dev;
  89
  90                 if (drm_minor->type == DRM_MINOR_LEGACY &&
  91                     !drm_core_check_feature(drm_dev, DRIVER_MODESET) &&
  92                     drm_dev->driver->resume)
  93                         return drm_dev->driver->resume(drm_dev);
  94         }
  95         return 0;
  96 }
  97
  98 static const struct dev_pm_ops drm_class_dev_pm_ops = {
  99         .suspend        = drm_class_suspend,
 100         .resume         = drm_class_resume,
 101         .freeze         = drm_class_freeze,
 102 };
 103
 104 static char *drm_devnode(struct device *dev, umode_t *mode)
 105 {
 106         return kasprintf(GFP_KERNEL, "dri/%s", dev_name(dev));
 107 }
 108
 109 static CLASS_ATTR_STRING(version, S_IRUGO,
 110                 CORE_NAME " "
 111                 __stringify(CORE_MAJOR) "."
 112                 __stringify(CORE_MINOR) "."
 113                 __stringify(CORE_PATCHLEVEL) " "
 114                 CORE_DATE);
 115
 116 /**
 117  * drm_sysfs_init - initialize sysfs helpers
 118  *
 119  * This is used to create the DRM class, which is the implicit parent of any
 120  * other top-level DRM sysfs objects.
 121  *
 122  * You must call drm_sysfs_destroy() to release the allocated resources.
 123  *
 124  * Return: 0 on success, negative error code on failure.
 125  */
 126 int drm_sysfs_init(void)
 127 {
 128         int err;
 129
 130         drm_class = class_create(THIS_MODULE, "drm");
 131         if (IS_ERR(drm_class))
 132                 return PTR_ERR(drm_class);
 133
 134         drm_class->pm = &drm_class_dev_pm_ops;
 135
 136         err = class_create_file(drm_class, &class_attr_version.attr);
 137         if (err) {
 138                 class_destroy(drm_class);
 139                 drm_class = NULL;
 140                 return err;
 141         }
 142
 143         drm_class->devnode = drm_devnode;
 144         return 0;
 145 }
 146
 147 /**
 148  * drm_sysfs_destroy - destroys DRM class
 149  *
 150  * Destroy the DRM device class.
 151  */
 152 void drm_sysfs_destroy(void)
 153 {
 154         if (IS_ERR_OR_NULL(drm_class))
 155                 return;
 156         class_remove_file(drm_class, &class_attr_version.attr);
 157         class_destroy(drm_class);
 158         drm_class = NULL;
 159 }
 160
 161 /*
 162  * Connector properties
 163  */
 164 static ssize_t status_store(struct device *device,
 165                            struct device_attribute *attr,
 166                            const char *buf, size_t count)
 167 {
 168         struct drm_connector *connector = to_drm_connector(device);
 169         struct drm_device *dev = connector->dev;
 170         enum drm_connector_status old_status;
 171         int ret;
 172
 173         ret = mutex_lock_interruptible(&dev->mode_config.mutex);
 174         if (ret)
 175                 return ret;
 176
 177         old_status = connector->status;
 178
 179         if (sysfs_streq(buf, "detect")) {
 180                 connector->force = 0;
 181                 connector->status = connector->funcs->detect(connector, true);
 182         } else if (sysfs_streq(buf, "on")) {
 183                 connector->force = DRM_FORCE_ON;
 184         } else if (sysfs_streq(buf, "on-digital")) {
 185                 connector->force = DRM_FORCE_ON_DIGITAL;
 186         } else if (sysfs_streq(buf, "off")) {
 187                 connector->force = DRM_FORCE_OFF;
 188         } else
 189                 ret = -EINVAL;
 190
 191         if (ret == 0 && connector->force) {
 192                 if (connector->force == DRM_FORCE_ON ||
 193                     connector->force == DRM_FORCE_ON_DIGITAL)
 194                         connector->status = connector_status_connected;
 195                 else
 196                         connector->status = connector_status_disconnected;
 197                 if (connector->funcs->force)
 198                         connector->funcs->force(connector);
 199         }
 200
 201         if (old_status != connector->status) {
 202                 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] status updated from %d to %d\n",
 203                               connector->base.id,
 204                               connector->name,
 205                               old_status, connector->status);
 206
 207                 dev->mode_config.delayed_event = true;
 208                 if (dev->mode_config.poll_enabled)
 209                         schedule_delayed_work(&dev->mode_config.output_poll_work,
 210                                               0);
 211         }
 212
 213         mutex_unlock(&dev->mode_config.mutex);
 214
 215         return ret ? ret : count;
 216 }
 217
 218 static ssize_t status_show(struct device *device,
 219                            struct device_attribute *attr,
 220                            char *buf)
 221 {
 222         struct drm_connector *connector = to_drm_connector(device);
 223
 224         return snprintf(buf, PAGE_SIZE, "%s\n",
 225                         drm_get_connector_status_name(connector->status));
 226 }
 227
 228 static ssize_t dpms_show(struct device *device,
 229                            struct device_attribute *attr,
 230                            char *buf)
 231 {
 232         struct drm_connector *connector = to_drm_connector(device);
 233         int dpms;
 234
 235         dpms = READ_ONCE(connector->dpms);
 236
 237         return snprintf(buf, PAGE_SIZE, "%s\n",
 238                         drm_get_dpms_name(dpms));
 239 }
 240
 241 static ssize_t enabled_show(struct device *device,
 242                             struct device_attribute *attr,
 243                            char *buf)
 244 {
 245         struct drm_connector *connector = to_drm_connector(device);
 246
 247         return snprintf(buf, PAGE_SIZE, "%s\n", connector->encoder ? "enabled" :
 248                         "disabled");
 249 }
 250
 251 static ssize_t edid_show(struct file *filp, struct kobject *kobj,
 252                          struct bin_attribute *attr, char *buf, loff_t off,
 253                          size_t count)
 254 {
 255         struct device *connector_dev = container_of(kobj, struct device, kobj);
 256         struct drm_connector *connector = to_drm_connector(connector_dev);
 257         unsigned char *edid;
 258         size_t size;
 259         ssize_t ret = 0;
 260
 261         mutex_lock(&connector->dev->mode_config.mutex);
 262         if (!connector->edid_blob_ptr)
 263                 goto unlock;
 264
 265         edid = connector->edid_blob_ptr->data;
 266         size = connector->edid_blob_ptr->length;
 267         if (!edid)
 268                 goto unlock;
 269
 270         if (off >= size)
 271                 goto unlock;
 272
 273         if (off + count > size)
 274                 count = size - off;
 275         memcpy(buf, edid + off, count);
 276
 277         ret = count;
 278 unlock:
 279         mutex_unlock(&connector->dev->mode_config.mutex);
 280
 281         return ret;
 282 }
 283
 284 static ssize_t modes_show(struct device *device,
 285                            struct device_attribute *attr,
 286                            char *buf)
 287 {
 288         struct drm_connector *connector = to_drm_connector(device);
 289         struct drm_display_mode *mode;
 290         int written = 0;
 291
 292         mutex_lock(&connector->dev->mode_config.mutex);
 293         list_for_each_entry(mode, &connector->modes, head) {
 294                 written += snprintf(buf + written, PAGE_SIZE - written, "%s\n",
 295                                     mode->name);
 296         }
 297         mutex_unlock(&connector->dev->mode_config.mutex);
 298
 299         return written;
 300 }
 301
 302 static ssize_t tv_subconnector_show(struct device *device,
 303                                     struct device_attribute *attr,
 304                                     char *buf)
 305 {
 306         struct drm_connector *connector = to_drm_connector(device);
 307         struct drm_device *dev = connector->dev;
 308         struct drm_property *prop;
 309         uint64_t subconnector;
 310         int ret;
 311
 312         prop = dev->mode_config.tv_subconnector_property;
 313         if (!prop) {
 314                 DRM_ERROR("Unable to find subconnector property\n");
 315                 return 0;
 316         }
 317
 318         ret = drm_object_property_get_value(&connector->base, prop, &subconnector);
 319         if (ret)
 320                 return 0;
 321
 322         return snprintf(buf, PAGE_SIZE, "%s",
 323                         drm_get_tv_subconnector_name((int)subconnector));
 324 }
 325
 326 static ssize_t tv_select_subconnector_show(struct device *device,
 327                                            struct device_attribute *attr,
 328                                            char *buf)
 329 {
 330         struct drm_connector *connector = to_drm_connector(device);
 331         struct drm_device *dev = connector->dev;
 332         struct drm_property *prop;
 333         uint64_t subconnector;
 334         int ret;
 335
 336         prop = dev->mode_config.tv_select_subconnector_property;
 337         if (!prop) {
 338                 DRM_ERROR("Unable to find select subconnector property\n");
 339                 return 0;
 340         }
 341
 342         ret = drm_object_property_get_value(&connector->base, prop, &subconnector);
 343         if (ret)
 344                 return 0;
 345
 346         return snprintf(buf, PAGE_SIZE, "%s",
 347                         drm_get_tv_select_name((int)subconnector));
 348 }
 349
 350 static ssize_t dvii_subconnector_show(struct device *device,
 351                                       struct device_attribute *attr,
 352                                       char *buf)
 353 {
 354         struct drm_connector *connector = to_drm_connector(device);
 355         struct drm_device *dev = connector->dev;
 356         struct drm_property *prop;
 357         uint64_t subconnector;
 358         int ret;
 359
 360         prop = dev->mode_config.dvi_i_subconnector_property;
 361         if (!prop) {
 362                 DRM_ERROR("Unable to find subconnector property\n");
 363                 return 0;
 364         }
 365
 366         ret = drm_object_property_get_value(&connector->base, prop, &subconnector);
 367         if (ret)
 368                 return 0;
 369
 370         return snprintf(buf, PAGE_SIZE, "%s",
 371                         drm_get_dvi_i_subconnector_name((int)subconnector));
 372 }
 373
 374 static ssize_t dvii_select_subconnector_show(struct device *device,
 375                                              struct device_attribute *attr,
 376                                              char *buf)
 377 {
 378         struct drm_connector *connector = to_drm_connector(device);
 379         struct drm_device *dev = connector->dev;
 380         struct drm_property *prop;
 381         uint64_t subconnector;
 382         int ret;
 383
 384         prop = dev->mode_config.dvi_i_select_subconnector_property;
 385         if (!prop) {
 386                 DRM_ERROR("Unable to find select subconnector property\n");
 387                 return 0;
 388         }
 389
 390         ret = drm_object_property_get_value(&connector->base, prop, &subconnector);
 391         if (ret)
 392                 return 0;
 393
 394         return snprintf(buf, PAGE_SIZE, "%s",
 395                         drm_get_dvi_i_select_name((int)subconnector));
 396 }
 397
 398 static DEVICE_ATTR_RW(status);
 399 static DEVICE_ATTR_RO(enabled);
 400 static DEVICE_ATTR_RO(dpms);
 401 static DEVICE_ATTR_RO(modes);
 402
 403 static struct attribute *connector_dev_attrs[] = {
 404         &dev_attr_status.attr,
 405         &dev_attr_enabled.attr,
 406         &dev_attr_dpms.attr,
 407         &dev_attr_modes.attr,
 408         NULL
 409 };
 410
 411 static DEVICE_ATTR_RO(tv_subconnector);
 412 static DEVICE_ATTR_RO(tv_select_subconnector);
 413
 414 static struct attribute *connector_tv_dev_attrs[] = {
 415         &dev_attr_tv_subconnector.attr,
 416         &dev_attr_tv_select_subconnector.attr,
 417         NULL
 418 };
 419
 420 static DEVICE_ATTR_RO(dvii_subconnector);
 421 static DEVICE_ATTR_RO(dvii_select_subconnector);
 422
 423 static struct attribute *connector_dvii_dev_attrs[] = {
 424         &dev_attr_dvii_subconnector.attr,
 425         &dev_attr_dvii_select_subconnector.attr,
 426         NULL
 427 };
 428
 429 /* Connector type related helpers */
 430 static int kobj_connector_type(struct kobject *kobj)
 431 {
 432         struct device *dev = kobj_to_dev(kobj);
 433         struct drm_connector *connector = to_drm_connector(dev);
 434
 435         return connector->connector_type;
 436 }
 437
 438 static umode_t connector_is_dvii(struct kobject *kobj,
 439                                  struct attribute *attr, int idx)
 440 {
 441         return kobj_connector_type(kobj) == DRM_MODE_CONNECTOR_DVII ?
 442                 attr->mode : 0;
 443 }
 444
 445 static umode_t connector_is_tv(struct kobject *kobj,
 446                                struct attribute *attr, int idx)
 447 {
 448         switch (kobj_connector_type(kobj)) {
 449         case DRM_MODE_CONNECTOR_Composite:
 450         case DRM_MODE_CONNECTOR_SVIDEO:
 451         case DRM_MODE_CONNECTOR_Component:
 452         case DRM_MODE_CONNECTOR_TV:
 453                 return attr->mode;
 454         }
 455
 456         return 0;
 457 }
 458
 459 static struct bin_attribute edid_attr = {
 460         .attr.name = "edid",
 461         .attr.mode = 0444,
 462         .size = 0,
 463         .read = edid_show,
 464 };
 465
 466 static struct bin_attribute *connector_bin_attrs[] = {
 467         &edid_attr,
 468         NULL
 469 };
 470
 471 static const struct attribute_group connector_dev_group = {
 472         .attrs = connector_dev_attrs,
 473         .bin_attrs = connector_bin_attrs,
 474 };
 475
 476 static const struct attribute_group connector_tv_dev_group = {
 477         .attrs = connector_tv_dev_attrs,
 478         .is_visible = connector_is_tv,
 479 };
 480
 481 static const struct attribute_group connector_dvii_dev_group = {
 482         .attrs = connector_dvii_dev_attrs,
 483         .is_visible = connector_is_dvii,
 484 };
 485
 486 static const struct attribute_group *connector_dev_groups[] = {
 487         &connector_dev_group,
 488         &connector_tv_dev_group,
 489         &connector_dvii_dev_group,
 490         NULL
 491 };
 492
 493 /**
 494  * drm_sysfs_connector_add - add a connector to sysfs
 495  * @connector: connector to add
 496  *
 497  * Create a connector device in sysfs, along with its associated connector
 498  * properties (so far, connection status, dpms, mode list & edid) and
 499  * generate a hotplug event so userspace knows there's a new connector
 500  * available.
 501  */
 502 int drm_sysfs_connector_add(struct drm_connector *connector)
 503 {
 504         struct drm_device *dev = connector->dev;
 505
 506         if (connector->kdev)
 507                 return 0;
 508
 509         connector->kdev =
 510                 device_create_with_groups(drm_class, dev->primary->kdev, 0,
 511                                           connector, connector_dev_groups,
 512                                           "card%d-%s", dev->primary->index,
 513                                           connector->name);
 514         DRM_DEBUG("adding \"%s\" to sysfs\n",
 515                   connector->name);
 516
 517         if (IS_ERR(connector->kdev)) {
 518                 DRM_ERROR("failed to register connector device: %ld\n", PTR_ERR(connector->kdev));
 519                 return PTR_ERR(connector->kdev);
 520         }
 521
 522         /* Let userspace know we have a new connector */
 523         drm_sysfs_hotplug_event(dev);
 524
 525         return 0;
 526 }
 527
 528 /**
 529  * drm_sysfs_connector_remove - remove an connector device from sysfs
 530  * @connector: connector to remove
 531  *
 532  * Remove @connector and its associated attributes from sysfs.  Note that
 533  * the device model core will take care of sending the "remove" uevent
 534  * at this time, so we don't need to do it.
 535  *
 536  * Note:
 537  * This routine should only be called if the connector was previously
 538  * successfully registered.  If @connector hasn't been registered yet,
 539  * you'll likely see a panic somewhere deep in sysfs code when called.
 540  */
 541 void drm_sysfs_connector_remove(struct drm_connector *connector)
 542 {
 543         if (!connector->kdev)
 544                 return;
 545         DRM_DEBUG("removing \"%s\" from sysfs\n",
 546                   connector->name);
 547
 548         device_unregister(connector->kdev);
 549         connector->kdev = NULL;
 550 }
 551
 552 /**
 553  * drm_sysfs_hotplug_event - generate a DRM uevent
 554  * @dev: DRM device
 555  *
 556  * Send a uevent for the DRM device specified by @dev.  Currently we only
 557  * set HOTPLUG=1 in the uevent environment, but this could be expanded to
 558  * deal with other types of events.
 559  */
 560 void drm_sysfs_hotplug_event(struct drm_device *dev)
 561 {
 562         char *event_string = "HOTPLUG=1";
 563         char *envp[] = { event_string, NULL };
 564
 565         DRM_DEBUG("generating hotplug event\n");
 566
 567         kobject_uevent_env(&dev->primary->kdev->kobj, KOBJ_CHANGE, envp);
 568 }
 569 EXPORT_SYMBOL(drm_sysfs_hotplug_event);
 570
 571 static void drm_sysfs_release(struct device *dev)
 572 {
 573         kfree(dev);
 574 }
 575
 576 /**
 577  * drm_sysfs_minor_alloc() - Allocate sysfs device for given minor
 578  * @minor: minor to allocate sysfs device for
 579  *
 580  * This allocates a new sysfs device for @minor and returns it. The device is
 581  * not registered nor linked. The caller has to use device_add() and
 582  * device_del() to register and unregister it.
 583  *
 584  * Note that dev_get_drvdata() on the new device will return the minor.
 585  * However, the device does not hold a ref-count to the minor nor to the
 586  * underlying drm_device. This is unproblematic as long as you access the
 587  * private data only in sysfs callbacks. device_del() disables those
 588  * synchronously, so they cannot be called after you cleanup a minor.
 589  */
 590 struct device *drm_sysfs_minor_alloc(struct drm_minor *minor)
 591 {
 592         const char *minor_str;
 593         struct device *kdev;
 594         int r;
 595
 596         if (minor->type == DRM_MINOR_CONTROL)
 597                 minor_str = "controlD%d";
 598         else if (minor->type == DRM_MINOR_RENDER)
 599                 minor_str = "renderD%d";
 600         else
 601                 minor_str = "card%d";
 602
 603         kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
 604         if (!kdev)
 605                 return ERR_PTR(-ENOMEM);
 606
 607         device_initialize(kdev);
 608         kdev->devt = MKDEV(DRM_MAJOR, minor->index);
 609         kdev->class = drm_class;
 610         kdev->type = &drm_sysfs_device_minor;
 611         kdev->parent = minor->dev->dev;
 612         kdev->release = drm_sysfs_release;
 613         dev_set_drvdata(kdev, minor);
 614
 615         r = dev_set_name(kdev, minor_str, minor->index);
 616         if (r < 0)
 617                 goto err_free;
 618
 619         return kdev;
 620
 621 err_free:
 622         put_device(kdev);
 623         return ERR_PTR(r);
 624 }
 625
 626 /**
 627  * drm_class_device_register - Register a struct device in the drm class.
 628  *
 629  * @dev: pointer to struct device to register.
 630  *
 631  * @dev should have all relevant members pre-filled with the exception
 632  * of the class member. In particular, the device_type member must
 633  * be set.
 634  */
 635
 636 int drm_class_device_register(struct device *dev)
 637 {
 638         if (!drm_class || IS_ERR(drm_class))
 639                 return -ENOENT;
 640
 641         dev->class = drm_class;
 642         return device_register(dev);
 643 }
 644 EXPORT_SYMBOL_GPL(drm_class_device_register);
 645
 646 void drm_class_device_unregister(struct device *dev)
 647 {
 648         return device_unregister(dev);
 649 }
 650 EXPORT_SYMBOL_GPL(drm_class_device_unregister);