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/err.h>
  18
  19 #include "drm_core.h"
  20 #include "drmP.h"
  21
  22 #define to_drm_minor(d) container_of(d, struct drm_minor, kdev)
  23 #define to_drm_connector(d) container_of(d, struct drm_connector, kdev)
  24
  25 /**
  26  * drm_sysfs_suspend - DRM class suspend hook
  27  * @dev: Linux device to suspend
  28  * @state: power state to enter
  29  *
  30  * Just figures out what the actual struct drm_device associated with
  31  * @dev is and calls its suspend hook, if present.
  32  */
  33 static int drm_sysfs_suspend(struct device *dev, pm_message_t state)
  34 {
  35         struct drm_minor *drm_minor = to_drm_minor(dev);
  36         struct drm_device *drm_dev = drm_minor->dev;
  37
  38         if (drm_minor->type == DRM_MINOR_LEGACY &&
  39             !drm_core_check_feature(drm_dev, DRIVER_MODESET) &&
  40             drm_dev->driver->suspend)
  41                 return drm_dev->driver->suspend(drm_dev, state);
  42
  43         return 0;
  44 }
  45
  46 /**
  47  * drm_sysfs_resume - DRM class resume hook
  48  * @dev: Linux device to resume
  49  *
  50  * Just figures out what the actual struct drm_device associated with
  51  * @dev is and calls its resume hook, if present.
  52  */
  53 static int drm_sysfs_resume(struct device *dev)
  54 {
  55         struct drm_minor *drm_minor = to_drm_minor(dev);
  56         struct drm_device *drm_dev = drm_minor->dev;
  57
  58         if (drm_minor->type == DRM_MINOR_LEGACY &&
  59             !drm_core_check_feature(drm_dev, DRIVER_MODESET) &&
  60             drm_dev->driver->resume)
  61                 return drm_dev->driver->resume(drm_dev);
  62
  63         return 0;
  64 }
  65
  66 /* Display the version of drm_core. This doesn't work right in current design */
  67 static ssize_t version_show(struct class *dev, char *buf)
  68 {
  69         return sprintf(buf, "%s %d.%d.%d %s\n", CORE_NAME, CORE_MAJOR,
  70                        CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
  71 }
  72
  73 static CLASS_ATTR(version, S_IRUGO, version_show, NULL);
  74
  75 /**
  76  * drm_sysfs_create - create a struct drm_sysfs_class structure
  77  * @owner: pointer to the module that is to "own" this struct drm_sysfs_class
  78  * @name: pointer to a string for the name of this class.
  79  *
  80  * This is used to create DRM class pointer that can then be used
  81  * in calls to drm_sysfs_device_add().
  82  *
  83  * Note, the pointer created here is to be destroyed when finished by making a
  84  * call to drm_sysfs_destroy().
  85  */
  86 struct class *drm_sysfs_create(struct module *owner, char *name)
  87 {
  88         struct class *class;
  89         int err;
  90
  91         class = class_create(owner, name);
  92         if (IS_ERR(class)) {
  93                 err = PTR_ERR(class);
  94                 goto err_out;
  95         }
  96
  97         class->suspend = drm_sysfs_suspend;
  98         class->resume = drm_sysfs_resume;
  99
 100         err = class_create_file(class, &class_attr_version);
 101         if (err)
 102                 goto err_out_class;
 103
 104         return class;
 105
 106 err_out_class:
 107         class_destroy(class);
 108 err_out:
 109         return ERR_PTR(err);
 110 }
 111
 112 /**
 113  * drm_sysfs_destroy - destroys DRM class
 114  *
 115  * Destroy the DRM device class.
 116  */
 117 void drm_sysfs_destroy(void)
 118 {
 119         if ((drm_class == NULL) || (IS_ERR(drm_class)))
 120                 return;
 121         class_remove_file(drm_class, &class_attr_version);
 122         class_destroy(drm_class);
 123 }
 124
 125 /**
 126  * drm_sysfs_device_release - do nothing
 127  * @dev: Linux device
 128  *
 129  * Normally, this would free the DRM device associated with @dev, along
 130  * with cleaning up any other stuff.  But we do that in the DRM core, so
 131  * this function can just return and hope that the core does its job.
 132  */
 133 static void drm_sysfs_device_release(struct device *dev)
 134 {
 135         return;
 136 }
 137
 138 /*
 139  * Connector properties
 140  */
 141 static ssize_t status_show(struct device *device,
 142                            struct device_attribute *attr,
 143                            char *buf)
 144 {
 145         struct drm_connector *connector = to_drm_connector(device);
 146         enum drm_connector_status status;
 147
 148         status = connector->funcs->detect(connector);
 149         return snprintf(buf, PAGE_SIZE, "%s",
 150                         drm_get_connector_status_name(status));
 151 }
 152
 153 static ssize_t dpms_show(struct device *device,
 154                            struct device_attribute *attr,
 155                            char *buf)
 156 {
 157         struct drm_connector *connector = to_drm_connector(device);
 158         struct drm_device *dev = connector->dev;
 159         uint64_t dpms_status;
 160         int ret;
 161
 162         ret = drm_connector_property_get_value(connector,
 163                                             dev->mode_config.dpms_property,
 164                                             &dpms_status);
 165         if (ret)
 166                 return 0;
 167
 168         return snprintf(buf, PAGE_SIZE, "%s",
 169                         drm_get_dpms_name((int)dpms_status));
 170 }
 171
 172 static ssize_t enabled_show(struct device *device,
 173                             struct device_attribute *attr,
 174                            char *buf)
 175 {
 176         struct drm_connector *connector = to_drm_connector(device);
 177
 178         return snprintf(buf, PAGE_SIZE, connector->encoder ? "enabled" :
 179                         "disabled");
 180 }
 181
 182 static ssize_t edid_show(struct kobject *kobj, struct bin_attribute *attr,
 183                          char *buf, loff_t off, size_t count)
 184 {
 185         struct device *connector_dev = container_of(kobj, struct device, kobj);
 186         struct drm_connector *connector = to_drm_connector(connector_dev);
 187         unsigned char *edid;
 188         size_t size;
 189
 190         if (!connector->edid_blob_ptr)
 191                 return 0;
 192
 193         edid = connector->edid_blob_ptr->data;
 194         size = connector->edid_blob_ptr->length;
 195         if (!edid)
 196                 return 0;
 197
 198         if (off >= size)
 199                 return 0;
 200
 201         if (off + count > size)
 202                 count = size - off;
 203         memcpy(buf, edid + off, count);
 204
 205         return count;
 206 }
 207
 208 static ssize_t modes_show(struct device *device,
 209                            struct device_attribute *attr,
 210                            char *buf)
 211 {
 212         struct drm_connector *connector = to_drm_connector(device);
 213         struct drm_display_mode *mode;
 214         int written = 0;
 215
 216         list_for_each_entry(mode, &connector->modes, head) {
 217                 written += snprintf(buf + written, PAGE_SIZE - written, "%s\n",
 218                                     mode->name);
 219         }
 220
 221         return written;
 222 }
 223
 224 static ssize_t subconnector_show(struct device *device,
 225                            struct device_attribute *attr,
 226                            char *buf)
 227 {
 228         struct drm_connector *connector = to_drm_connector(device);
 229         struct drm_device *dev = connector->dev;
 230         struct drm_property *prop = NULL;
 231         uint64_t subconnector;
 232         int is_tv = 0;
 233         int ret;
 234
 235         switch (connector->connector_type) {
 236                 case DRM_MODE_CONNECTOR_DVII:
 237                         prop = dev->mode_config.dvi_i_subconnector_property;
 238                         break;
 239                 case DRM_MODE_CONNECTOR_Composite:
 240                 case DRM_MODE_CONNECTOR_SVIDEO:
 241                 case DRM_MODE_CONNECTOR_Component:
 242                         prop = dev->mode_config.tv_subconnector_property;
 243                         is_tv = 1;
 244                         break;
 245                 default:
 246                         DRM_ERROR("Wrong connector type for this property\n");
 247                         return 0;
 248         }
 249
 250         if (!prop) {
 251                 DRM_ERROR("Unable to find subconnector property\n");
 252                 return 0;
 253         }
 254
 255         ret = drm_connector_property_get_value(connector, prop, &subconnector);
 256         if (ret)
 257                 return 0;
 258
 259         return snprintf(buf, PAGE_SIZE, "%s", is_tv ?
 260                         drm_get_tv_subconnector_name((int)subconnector) :
 261                         drm_get_dvi_i_subconnector_name((int)subconnector));
 262 }
 263
 264 static ssize_t select_subconnector_show(struct device *device,
 265                            struct device_attribute *attr,
 266                            char *buf)
 267 {
 268         struct drm_connector *connector = to_drm_connector(device);
 269         struct drm_device *dev = connector->dev;
 270         struct drm_property *prop = NULL;
 271         uint64_t subconnector;
 272         int is_tv = 0;
 273         int ret;
 274
 275         switch (connector->connector_type) {
 276                 case DRM_MODE_CONNECTOR_DVII:
 277                         prop = dev->mode_config.dvi_i_select_subconnector_property;
 278                         break;
 279                 case DRM_MODE_CONNECTOR_Composite:
 280                 case DRM_MODE_CONNECTOR_SVIDEO:
 281                 case DRM_MODE_CONNECTOR_Component:
 282                         prop = dev->mode_config.tv_select_subconnector_property;
 283                         is_tv = 1;
 284                         break;
 285                 default:
 286                         DRM_ERROR("Wrong connector type for this property\n");
 287                         return 0;
 288         }
 289
 290         if (!prop) {
 291                 DRM_ERROR("Unable to find select subconnector property\n");
 292                 return 0;
 293         }
 294
 295         ret = drm_connector_property_get_value(connector, prop, &subconnector);
 296         if (ret)
 297                 return 0;
 298
 299         return snprintf(buf, PAGE_SIZE, "%s", is_tv ?
 300                         drm_get_tv_select_name((int)subconnector) :
 301                         drm_get_dvi_i_select_name((int)subconnector));
 302 }
 303
 304 static struct device_attribute connector_attrs[] = {
 305         __ATTR_RO(status),
 306         __ATTR_RO(enabled),
 307         __ATTR_RO(dpms),
 308         __ATTR_RO(modes),
 309 };
 310
 311 /* These attributes are for both DVI-I connectors and all types of tv-out. */
 312 static struct device_attribute connector_attrs_opt1[] = {
 313         __ATTR_RO(subconnector),
 314         __ATTR_RO(select_subconnector),
 315 };
 316
 317 static struct bin_attribute edid_attr = {
 318         .attr.name = "edid",
 319         .size = 128,
 320         .read = edid_show,
 321 };
 322
 323 /**
 324  * drm_sysfs_connector_add - add an connector to sysfs
 325  * @connector: connector to add
 326  *
 327  * Create an connector device in sysfs, along with its associated connector
 328  * properties (so far, connection status, dpms, mode list & edid) and
 329  * generate a hotplug event so userspace knows there's a new connector
 330  * available.
 331  *
 332  * Note:
 333  * This routine should only be called *once* for each DRM minor registered.
 334  * A second call for an already registered device will trigger the BUG_ON
 335  * below.
 336  */
 337 int drm_sysfs_connector_add(struct drm_connector *connector)
 338 {
 339         struct drm_device *dev = connector->dev;
 340         int ret = 0, i, j;
 341
 342         /* We shouldn't get called more than once for the same connector */
 343         BUG_ON(device_is_registered(&connector->kdev));
 344
 345         connector->kdev.parent = &dev->primary->kdev;
 346         connector->kdev.class = drm_class;
 347         connector->kdev.release = drm_sysfs_device_release;
 348
 349         DRM_DEBUG("adding \"%s\" to sysfs\n",
 350                   drm_get_connector_name(connector));
 351
 352         dev_set_name(&connector->kdev, "card%d-%s",
 353                      dev->primary->index, drm_get_connector_name(connector));
 354         ret = device_register(&connector->kdev);
 355
 356         if (ret) {
 357                 DRM_ERROR("failed to register connector device: %d\n", ret);
 358                 goto out;
 359         }
 360
 361         /* Standard attributes */
 362
 363         for (i = 0; i < ARRAY_SIZE(connector_attrs); i++) {
 364                 ret = device_create_file(&connector->kdev, &connector_attrs[i]);
 365                 if (ret)
 366                         goto err_out_files;
 367         }
 368
 369         /* Optional attributes */
 370         /*
 371          * In the long run it maybe a good idea to make one set of
 372          * optionals per connector type.
 373          */
 374         switch (connector->connector_type) {
 375                 case DRM_MODE_CONNECTOR_DVII:
 376                 case DRM_MODE_CONNECTOR_Composite:
 377                 case DRM_MODE_CONNECTOR_SVIDEO:
 378                 case DRM_MODE_CONNECTOR_Component:
 379                         for (i = 0; i < ARRAY_SIZE(connector_attrs_opt1); i++) {
 380                                 ret = device_create_file(&connector->kdev, &connector_attrs_opt1[i]);
 381                                 if (ret)
 382                                         goto err_out_files;
 383                         }
 384                         break;
 385                 default:
 386                         break;
 387         }
 388
 389         ret = sysfs_create_bin_file(&connector->kdev.kobj, &edid_attr);
 390         if (ret)
 391                 goto err_out_files;
 392
 393         /* Let userspace know we have a new connector */
 394         drm_sysfs_hotplug_event(dev);
 395
 396         return 0;
 397
 398 err_out_files:
 399         if (i > 0)
 400                 for (j = 0; j < i; j++)
 401                         device_remove_file(&connector->kdev,
 402                                            &connector_attrs[i]);
 403         device_unregister(&connector->kdev);
 404
 405 out:
 406         return ret;
 407 }
 408 EXPORT_SYMBOL(drm_sysfs_connector_add);
 409
 410 /**
 411  * drm_sysfs_connector_remove - remove an connector device from sysfs
 412  * @connector: connector to remove
 413  *
 414  * Remove @connector and its associated attributes from sysfs.  Note that
 415  * the device model core will take care of sending the "remove" uevent
 416  * at this time, so we don't need to do it.
 417  *
 418  * Note:
 419  * This routine should only be called if the connector was previously
 420  * successfully registered.  If @connector hasn't been registered yet,
 421  * you'll likely see a panic somewhere deep in sysfs code when called.
 422  */
 423 void drm_sysfs_connector_remove(struct drm_connector *connector)
 424 {
 425         int i;
 426
 427         DRM_DEBUG("removing \"%s\" from sysfs\n",
 428                   drm_get_connector_name(connector));
 429
 430         for (i = 0; i < ARRAY_SIZE(connector_attrs); i++)
 431                 device_remove_file(&connector->kdev, &connector_attrs[i]);
 432         sysfs_remove_bin_file(&connector->kdev.kobj, &edid_attr);
 433         device_unregister(&connector->kdev);
 434 }
 435 EXPORT_SYMBOL(drm_sysfs_connector_remove);
 436
 437 /**
 438  * drm_sysfs_hotplug_event - generate a DRM uevent
 439  * @dev: DRM device
 440  *
 441  * Send a uevent for the DRM device specified by @dev.  Currently we only
 442  * set HOTPLUG=1 in the uevent environment, but this could be expanded to
 443  * deal with other types of events.
 444  */
 445 void drm_sysfs_hotplug_event(struct drm_device *dev)
 446 {
 447         char *event_string = "HOTPLUG=1";
 448         char *envp[] = { event_string, NULL };
 449
 450         DRM_DEBUG("generating hotplug event\n");
 451
 452         kobject_uevent_env(&dev->primary->kdev.kobj, KOBJ_CHANGE, envp);
 453 }
 454
 455 /**
 456  * drm_sysfs_device_add - adds a class device to sysfs for a character driver
 457  * @dev: DRM device to be added
 458  * @head: DRM head in question
 459  *
 460  * Add a DRM device to the DRM's device model class.  We use @dev's PCI device
 461  * as the parent for the Linux device, and make sure it has a file containing
 462  * the driver we're using (for userspace compatibility).
 463  */
 464 int drm_sysfs_device_add(struct drm_minor *minor)
 465 {
 466         int err;
 467         char *minor_str;
 468
 469         minor->kdev.parent = &minor->dev->pdev->dev;
 470         minor->kdev.class = drm_class;
 471         minor->kdev.release = drm_sysfs_device_release;
 472         minor->kdev.devt = minor->device;
 473         if (minor->type == DRM_MINOR_CONTROL)
 474                 minor_str = "controlD%d";
 475         else if (minor->type == DRM_MINOR_RENDER)
 476                 minor_str = "renderD%d";
 477         else
 478                 minor_str = "card%d";
 479
 480         dev_set_name(&minor->kdev, minor_str, minor->index);
 481
 482         err = device_register(&minor->kdev);
 483         if (err) {
 484                 DRM_ERROR("device add failed: %d\n", err);
 485                 goto err_out;
 486         }
 487
 488         return 0;
 489
 490         device_unregister(&minor->kdev);
 491 err_out:
 492
 493         return err;
 494 }
 495
 496 /**
 497  * drm_sysfs_device_remove - remove DRM device
 498  * @dev: DRM device to remove
 499  *
 500  * This call unregisters and cleans up a class device that was created with a
 501  * call to drm_sysfs_device_add()
 502  */
 503 void drm_sysfs_device_remove(struct drm_minor *minor)
 504 {
 505         device_unregister(&minor->kdev);
 506 }