Skip to content

Commit e2b33fc

Browse files
committed
drm/xe/configfs: Improve documentation steps
The steps are roughly: 1. Load the module without binding to the device 2. Configure the desired device 3. Bind the device Move the binding part to the "Create devices" since it's not exclusive to the survivability_mode attribute and better document the steps. Reviewed-by: Riana Tauro <riana.tauro@intel.com> Link: https://lore.kernel.org/r/20250821-psmi-v5-10-34ab7550d3d8@intel.com Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
1 parent 3eb2280 commit e2b33fc

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

drivers/gpu/drm/xe/xe_configfs.c

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,18 @@
2929
* See Documentation/filesystems/configfs.rst for more information about how configfs works.
3030
*
3131
* Create devices
32-
* ===============
32+
* ==============
33+
*
34+
* To create a device, the ``xe`` module should already be loaded, but some
35+
* attributes can only be set before binding the device. It can be accomplished
36+
* by blocking the driver autoprobe:
3337
*
34-
* In order to create a device, the user has to create a directory inside ``'xe'``::
38+
* # echo 0 > /sys/bus/pci/drivers_autoprobe
39+
* # modprobe xe
3540
*
36-
* mkdir /sys/kernel/config/xe/0000:03:00.0/
41+
* In order to create a device, the user has to create a directory inside ``xe``::
42+
*
43+
* # mkdir /sys/kernel/config/xe/0000:03:00.0/
3744
*
3845
* Every device created is populated by the driver with entries that can be
3946
* used to configure it::
@@ -49,6 +56,12 @@
4956
* ├── engines_allowed
5057
* └── enable_psmi
5158
*
59+
* After configuring the attributes as per next section, the device can be
60+
* probed with::
61+
*
62+
* # echo 0000:03:00.0 > /sys/bus/pci/drivers/xe/bind
63+
* # # or
64+
* # echo 0000:03:00.0 > /sys/bus/pci/drivers_probe
5265
*
5366
* Configure Attributes
5467
* ====================
@@ -60,7 +73,6 @@
6073
* effect when probing the device. Example to enable it::
6174
*
6275
* # echo 1 > /sys/kernel/config/xe/0000:03:00.0/survivability_mode
63-
* # echo 0000:03:00.0 > /sys/bus/pci/drivers/xe/bind (Enters survivability mode if supported)
6476
*
6577
* Allowed engines:
6678
* ----------------

0 commit comments

Comments
 (0)