uapi/drm/i915: Document memory residency and Flat-CCS capability of obj
[linux-block.git] / drivers / gpu / drm / drm_sysfs.c
CommitLineData
55716d26 1// SPDX-License-Identifier: GPL-2.0-only
0650fd58 2
1da177e4
LT
3/*
4 * drm_sysfs.c - Modifications to drm_sysfs_class.c to support
5 * extra sysfs attribute from DRM. Normal drm_sysfs_class
6 * does not allow adding attributes.
7 *
8 * Copyright (c) 2004 Jon Smirl <jonsmirl@gmail.com>
9 * Copyright (c) 2003-2004 Greg Kroah-Hartman <greg@kroah.com>
10 * Copyright (c) 2003-2004 IBM Corp.
1da177e4
LT
11 */
12
48c429c6 13#include <linux/acpi.h>
1da177e4 14#include <linux/device.h>
1da177e4 15#include <linux/err.h>
2d1a8a48 16#include <linux/export.h>
0500c04e 17#include <linux/gfp.h>
e1a29c6c 18#include <linux/i2c.h>
0500c04e
SR
19#include <linux/kdev_t.h>
20#include <linux/slab.h>
21
22#include <drm/drm_connector.h>
23#include <drm/drm_device.h>
24#include <drm/drm_file.h>
25#include <drm/drm_modes.h>
26#include <drm/drm_print.h>
27#include <drm/drm_property.h>
760285e7 28#include <drm/drm_sysfs.h>
0500c04e 29
67d0ec4e 30#include "drm_internal.h"
6fe2ce06 31#include "drm_crtc_internal.h"
1da177e4 32
5bdebb18
DA
33#define to_drm_minor(d) dev_get_drvdata(d)
34#define to_drm_connector(d) dev_get_drvdata(d)
e8b962b6 35
e2271704
DV
36/**
37 * DOC: overview
38 *
39 * DRM provides very little additional support to drivers for sysfs
40 * interactions, beyond just all the standard stuff. Drivers who want to expose
41 * additional sysfs properties and property groups can attach them at either
42 * &drm_device.dev or &drm_connector.kdev.
43 *
44 * Registration is automatically handled when calling drm_dev_register(), or
45 * drm_connector_register() in case of hot-plugged connectors. Unregistration is
46 * also automatically handled by drm_dev_unregister() and
47 * drm_connector_unregister().
48 */
49
08e4d534
TH
50static struct device_type drm_sysfs_device_minor = {
51 .name = "drm_minor"
52};
53
331de7db
HG
54static struct device_type drm_sysfs_device_connector = {
55 .name = "drm_connector",
56};
57
fcc90213
DH
58struct class *drm_class;
59
48c429c6
HG
60#ifdef CONFIG_ACPI
61static bool drm_connector_acpi_bus_match(struct device *dev)
62{
63 return dev->type == &drm_sysfs_device_connector;
64}
65
66static struct acpi_device *drm_connector_acpi_find_companion(struct device *dev)
67{
68 struct drm_connector *connector = to_drm_connector(dev);
69
70 return to_acpi_device_node(connector->fwnode);
71}
72
73static struct acpi_bus_type drm_connector_acpi_bus = {
74 .name = "drm_connector",
75 .match = drm_connector_acpi_bus_match,
76 .find_companion = drm_connector_acpi_find_companion,
77};
78
79static void drm_sysfs_acpi_register(void)
80{
81 register_acpi_bus_type(&drm_connector_acpi_bus);
82}
83
84static void drm_sysfs_acpi_unregister(void)
85{
86 unregister_acpi_bus_type(&drm_connector_acpi_bus);
87}
88#else
89static void drm_sysfs_acpi_register(void) { }
90static void drm_sysfs_acpi_unregister(void) { }
91#endif
92
2c9ede55 93static char *drm_devnode(struct device *dev, umode_t *mode)
02200d06
KS
94{
95 return kasprintf(GFP_KERNEL, "dri/%s", dev_name(dev));
96}
97
82d5e73f 98static CLASS_ATTR_STRING(version, S_IRUGO, "drm 1.1.0 20060810");
1da177e4
LT
99
100/**
fcc90213
DH
101 * drm_sysfs_init - initialize sysfs helpers
102 *
103 * This is used to create the DRM class, which is the implicit parent of any
104 * other top-level DRM sysfs objects.
1da177e4 105 *
fcc90213 106 * You must call drm_sysfs_destroy() to release the allocated resources.
1da177e4 107 *
fcc90213 108 * Return: 0 on success, negative error code on failure.
1da177e4 109 */
fcc90213 110int drm_sysfs_init(void)
1da177e4 111{
24f73c92 112 int err;
0650fd58 113
fcc90213
DH
114 drm_class = class_create(THIS_MODULE, "drm");
115 if (IS_ERR(drm_class))
116 return PTR_ERR(drm_class);
e8b962b6 117
fcc90213
DH
118 err = class_create_file(drm_class, &class_attr_version.attr);
119 if (err) {
120 class_destroy(drm_class);
121 drm_class = NULL;
122 return err;
123 }
24f73c92 124
fcc90213 125 drm_class->devnode = drm_devnode;
48c429c6
HG
126
127 drm_sysfs_acpi_register();
fcc90213 128 return 0;
1da177e4
LT
129}
130
131/**
e8b962b6 132 * drm_sysfs_destroy - destroys DRM class
1da177e4 133 *
e8b962b6 134 * Destroy the DRM device class.
1da177e4 135 */
e8b962b6 136void drm_sysfs_destroy(void)
1da177e4 137{
26b91ae4 138 if (IS_ERR_OR_NULL(drm_class))
1da177e4 139 return;
48c429c6 140 drm_sysfs_acpi_unregister();
0933e2d9 141 class_remove_file(drm_class, &class_attr_version.attr);
e8b962b6 142 class_destroy(drm_class);
49099c49 143 drm_class = NULL;
1da177e4
LT
144}
145
331de7db
HG
146static void drm_sysfs_release(struct device *dev)
147{
148 kfree(dev);
149}
150
f453ba04
DA
151/*
152 * Connector properties
153 */
c484f02d 154static ssize_t status_store(struct device *device,
f453ba04 155 struct device_attribute *attr,
c484f02d 156 const char *buf, size_t count)
f453ba04
DA
157{
158 struct drm_connector *connector = to_drm_connector(device);
c484f02d 159 struct drm_device *dev = connector->dev;
ed293f77 160 enum drm_connector_force old_force;
007c80a5
CW
161 int ret;
162
c484f02d 163 ret = mutex_lock_interruptible(&dev->mode_config.mutex);
007c80a5
CW
164 if (ret)
165 return ret;
f453ba04 166
ed293f77 167 old_force = connector->force;
c484f02d 168
ed293f77 169 if (sysfs_streq(buf, "detect"))
c484f02d 170 connector->force = 0;
ed293f77 171 else if (sysfs_streq(buf, "on"))
c484f02d 172 connector->force = DRM_FORCE_ON;
ed293f77 173 else if (sysfs_streq(buf, "on-digital"))
c484f02d 174 connector->force = DRM_FORCE_ON_DIGITAL;
ed293f77 175 else if (sysfs_streq(buf, "off"))
c484f02d 176 connector->force = DRM_FORCE_OFF;
ed293f77 177 else
c484f02d
CW
178 ret = -EINVAL;
179
ed293f77
DV
180 if (old_force != connector->force || !connector->force) {
181 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] force updated from %d to %d or reprobing\n",
c484f02d
CW
182 connector->base.id,
183 connector->name,
ed293f77 184 old_force, connector->force);
c484f02d 185
ed293f77
DV
186 connector->funcs->fill_modes(connector,
187 dev->mode_config.max_width,
188 dev->mode_config.max_height);
c484f02d
CW
189 }
190
191 mutex_unlock(&dev->mode_config.mutex);
192
38d8571d 193 return ret ? ret : count;
c484f02d
CW
194}
195
196static ssize_t status_show(struct device *device,
197 struct device_attribute *attr,
198 char *buf)
199{
200 struct drm_connector *connector = to_drm_connector(device);
4eb9b945
DV
201 enum drm_connector_status status;
202
203 status = READ_ONCE(connector->status);
007c80a5 204
835bc483
TT
205 return sysfs_emit(buf, "%s\n",
206 drm_get_connector_status_name(status));
f453ba04
DA
207}
208
209static ssize_t dpms_show(struct device *device,
210 struct device_attribute *attr,
211 char *buf)
212{
213 struct drm_connector *connector = to_drm_connector(device);
621bd0f6 214 int dpms;
f453ba04 215
621bd0f6 216 dpms = READ_ONCE(connector->dpms);
f453ba04 217
835bc483 218 return sysfs_emit(buf, "%s\n", drm_get_dpms_name(dpms));
f453ba04
DA
219}
220
221static ssize_t enabled_show(struct device *device,
222 struct device_attribute *attr,
223 char *buf)
224{
225 struct drm_connector *connector = to_drm_connector(device);
4eb9b945
DV
226 bool enabled;
227
228 enabled = READ_ONCE(connector->encoder);
f453ba04 229
835bc483 230 return sysfs_emit(buf, enabled ? "enabled\n" : "disabled\n");
f453ba04
DA
231}
232
2c3c8bea
CW
233static ssize_t edid_show(struct file *filp, struct kobject *kobj,
234 struct bin_attribute *attr, char *buf, loff_t off,
235 size_t count)
f453ba04 236{
d122cbf1 237 struct device *connector_dev = kobj_to_dev(kobj);
f453ba04
DA
238 struct drm_connector *connector = to_drm_connector(connector_dev);
239 unsigned char *edid;
240 size_t size;
a48a62bc 241 ssize_t ret = 0;
f453ba04 242
a48a62bc 243 mutex_lock(&connector->dev->mode_config.mutex);
f453ba04 244 if (!connector->edid_blob_ptr)
a48a62bc 245 goto unlock;
f453ba04
DA
246
247 edid = connector->edid_blob_ptr->data;
248 size = connector->edid_blob_ptr->length;
249 if (!edid)
a48a62bc 250 goto unlock;
f453ba04
DA
251
252 if (off >= size)
a48a62bc 253 goto unlock;
f453ba04
DA
254
255 if (off + count > size)
256 count = size - off;
257 memcpy(buf, edid + off, count);
258
a48a62bc
DV
259 ret = count;
260unlock:
261 mutex_unlock(&connector->dev->mode_config.mutex);
262
263 return ret;
f453ba04
DA
264}
265
266static ssize_t modes_show(struct device *device,
267 struct device_attribute *attr,
268 char *buf)
269{
270 struct drm_connector *connector = to_drm_connector(device);
271 struct drm_display_mode *mode;
272 int written = 0;
273
a48a62bc 274 mutex_lock(&connector->dev->mode_config.mutex);
f453ba04 275 list_for_each_entry(mode, &connector->modes, head) {
9b9f2219 276 written += scnprintf(buf + written, PAGE_SIZE - written, "%s\n",
f453ba04
DA
277 mode->name);
278 }
a48a62bc 279 mutex_unlock(&connector->dev->mode_config.mutex);
f453ba04
DA
280
281 return written;
282}
283
c484f02d 284static DEVICE_ATTR_RW(status);
335f1a62
TI
285static DEVICE_ATTR_RO(enabled);
286static DEVICE_ATTR_RO(dpms);
287static DEVICE_ATTR_RO(modes);
288
289static struct attribute *connector_dev_attrs[] = {
290 &dev_attr_status.attr,
291 &dev_attr_enabled.attr,
292 &dev_attr_dpms.attr,
293 &dev_attr_modes.attr,
294 NULL
f453ba04
DA
295};
296
f453ba04
DA
297static struct bin_attribute edid_attr = {
298 .attr.name = "edid",
e36ebaf4 299 .attr.mode = 0444,
7466f4cc 300 .size = 0,
f453ba04
DA
301 .read = edid_show,
302};
303
335f1a62
TI
304static struct bin_attribute *connector_bin_attrs[] = {
305 &edid_attr,
306 NULL
307};
308
309static const struct attribute_group connector_dev_group = {
310 .attrs = connector_dev_attrs,
311 .bin_attrs = connector_bin_attrs,
312};
313
335f1a62
TI
314static const struct attribute_group *connector_dev_groups[] = {
315 &connector_dev_group,
335f1a62
TI
316 NULL
317};
318
f453ba04
DA
319int drm_sysfs_connector_add(struct drm_connector *connector)
320{
321 struct drm_device *dev = connector->dev;
331de7db
HG
322 struct device *kdev;
323 int r;
f453ba04 324
5bdebb18
DA
325 if (connector->kdev)
326 return 0;
f453ba04 327
331de7db
HG
328 kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
329 if (!kdev)
330 return -ENOMEM;
331
332 device_initialize(kdev);
333 kdev->class = drm_class;
334 kdev->type = &drm_sysfs_device_connector;
335 kdev->parent = dev->primary->kdev;
336 kdev->groups = connector_dev_groups;
337 kdev->release = drm_sysfs_release;
338 dev_set_drvdata(kdev, connector);
339
340 r = dev_set_name(kdev, "card%d-%s", dev->primary->index, connector->name);
341 if (r)
342 goto err_free;
343
f453ba04 344 DRM_DEBUG("adding \"%s\" to sysfs\n",
25933820 345 connector->name);
f453ba04 346
331de7db
HG
347 r = device_add(kdev);
348 if (r) {
349 drm_err(dev, "failed to register connector device: %d\n", r);
350 goto err_free;
f453ba04
DA
351 }
352
331de7db
HG
353 connector->kdev = kdev;
354
e1a29c6c
AP
355 if (connector->ddc)
356 return sysfs_create_link(&connector->kdev->kobj,
357 &connector->ddc->dev.kobj, "ddc");
f453ba04 358 return 0;
331de7db
HG
359
360err_free:
361 put_device(kdev);
362 return r;
f453ba04 363}
f453ba04 364
f453ba04
DA
365void drm_sysfs_connector_remove(struct drm_connector *connector)
366{
5bdebb18 367 if (!connector->kdev)
1828fe6c 368 return;
e1a29c6c
AP
369
370 if (connector->ddc)
371 sysfs_remove_link(&connector->kdev->kobj, "ddc");
372
f453ba04 373 DRM_DEBUG("removing \"%s\" from sysfs\n",
25933820 374 connector->name);
f453ba04 375
5bdebb18
DA
376 device_unregister(connector->kdev);
377 connector->kdev = NULL;
f453ba04 378}
f453ba04 379
ce858828
DV
380void drm_sysfs_lease_event(struct drm_device *dev)
381{
382 char *event_string = "LEASE=1";
383 char *envp[] = { event_string, NULL };
384
385 DRM_DEBUG("generating lease event\n");
386
387 kobject_uevent_env(&dev->primary->kdev->kobj, KOBJ_CHANGE, envp);
388}
389
f453ba04
DA
390/**
391 * drm_sysfs_hotplug_event - generate a DRM uevent
392 * @dev: DRM device
393 *
394 * Send a uevent for the DRM device specified by @dev. Currently we only
395 * set HOTPLUG=1 in the uevent environment, but this could be expanded to
396 * deal with other types of events.
6fe2ce06
R
397 *
398 * Any new uapi should be using the drm_sysfs_connector_status_event()
399 * for uevents on connector status change.
f453ba04
DA
400 */
401void drm_sysfs_hotplug_event(struct drm_device *dev)
402{
403 char *event_string = "HOTPLUG=1";
404 char *envp[] = { event_string, NULL };
405
406 DRM_DEBUG("generating hotplug event\n");
407
5bdebb18 408 kobject_uevent_env(&dev->primary->kdev->kobj, KOBJ_CHANGE, envp);
f453ba04 409}
5ca58282 410EXPORT_SYMBOL(drm_sysfs_hotplug_event);
f453ba04 411
0d6a8c5e
SS
412/**
413 * drm_sysfs_connector_hotplug_event - generate a DRM uevent for any connector
414 * change
415 * @connector: connector which has changed
416 *
417 * Send a uevent for the DRM connector specified by @connector. This will send
418 * a uevent with the properties HOTPLUG=1 and CONNECTOR.
419 */
420void drm_sysfs_connector_hotplug_event(struct drm_connector *connector)
421{
422 struct drm_device *dev = connector->dev;
423 char hotplug_str[] = "HOTPLUG=1", conn_id[21];
424 char *envp[] = { hotplug_str, conn_id, NULL };
425
426 snprintf(conn_id, sizeof(conn_id),
427 "CONNECTOR=%u", connector->base.id);
428
429 drm_dbg_kms(connector->dev,
430 "[CONNECTOR:%d:%s] generating connector hotplug event\n",
431 connector->base.id, connector->name);
432
433 kobject_uevent_env(&dev->primary->kdev->kobj, KOBJ_CHANGE, envp);
434}
435EXPORT_SYMBOL(drm_sysfs_connector_hotplug_event);
436
6fe2ce06
R
437/**
438 * drm_sysfs_connector_status_event - generate a DRM uevent for connector
439 * property status change
440 * @connector: connector on which property status changed
441 * @property: connector property whose status changed.
442 *
443 * Send a uevent for the DRM device specified by @dev. Currently we
444 * set HOTPLUG=1 and connector id along with the attached property id
445 * related to the status change.
446 */
447void drm_sysfs_connector_status_event(struct drm_connector *connector,
448 struct drm_property *property)
449{
450 struct drm_device *dev = connector->dev;
451 char hotplug_str[] = "HOTPLUG=1", conn_id[21], prop_id[21];
452 char *envp[4] = { hotplug_str, conn_id, prop_id, NULL };
453
454 WARN_ON(!drm_mode_obj_find_prop_id(&connector->base,
455 property->base.id));
456
457 snprintf(conn_id, ARRAY_SIZE(conn_id),
458 "CONNECTOR=%u", connector->base.id);
459 snprintf(prop_id, ARRAY_SIZE(prop_id),
460 "PROPERTY=%u", property->base.id);
461
462 DRM_DEBUG("generating connector status event\n");
463
464 kobject_uevent_env(&dev->primary->kdev->kobj, KOBJ_CHANGE, envp);
465}
466EXPORT_SYMBOL(drm_sysfs_connector_status_event);
467
e1728075 468struct device *drm_sysfs_minor_alloc(struct drm_minor *minor)
1da177e4 469{
e1728075
DH
470 const char *minor_str;
471 struct device *kdev;
760c960b 472 int r;
e8b962b6 473
0d49f303 474 if (minor->type == DRM_MINOR_RENDER)
e1728075
DH
475 minor_str = "renderD%d";
476 else
477 minor_str = "card%d";
478
479 kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
480 if (!kdev)
481 return ERR_PTR(-ENOMEM);
482
483 device_initialize(kdev);
484 kdev->devt = MKDEV(DRM_MAJOR, minor->index);
485 kdev->class = drm_class;
486 kdev->type = &drm_sysfs_device_minor;
487 kdev->parent = minor->dev->dev;
488 kdev->release = drm_sysfs_release;
489 dev_set_drvdata(kdev, minor);
490
491 r = dev_set_name(kdev, minor_str, minor->index);
760c960b 492 if (r < 0)
e1728075 493 goto err_free;
760c960b 494
e1728075 495 return kdev;
1da177e4 496
e1728075
DH
497err_free:
498 put_device(kdev);
499 return ERR_PTR(r);
1da177e4 500}
327c225b 501
327c225b 502/**
e2271704
DV
503 * drm_class_device_register - register new device with the DRM sysfs class
504 * @dev: device to register
327c225b 505 *
e2271704
DV
506 * Registers a new &struct device within the DRM sysfs class. Essentially only
507 * used by ttm to have a place for its global settings. Drivers should never use
508 * this.
327c225b 509 */
327c225b
TH
510int drm_class_device_register(struct device *dev)
511{
49099c49
DA
512 if (!drm_class || IS_ERR(drm_class))
513 return -ENOENT;
514
327c225b
TH
515 dev->class = drm_class;
516 return device_register(dev);
517}
518EXPORT_SYMBOL_GPL(drm_class_device_register);
519
e2271704
DV
520/**
521 * drm_class_device_unregister - unregister device with the DRM sysfs class
522 * @dev: device to unregister
523 *
524 * Unregisters a &struct device from the DRM sysfs class. Essentially only used
525 * by ttm to have a place for its global settings. Drivers should never use
526 * this.
527 */
327c225b
TH
528void drm_class_device_unregister(struct device *dev)
529{
530 return device_unregister(dev);
531}
532EXPORT_SYMBOL_GPL(drm_class_device_unregister);