[PATCH v3 11/13] drm/xe/configfs: Improve documentation steps

[Riana Tauro]

On 8/8/2025 10:59 PM, Lucas De Marchi wrote:
> 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.
> 
> Signed-off-by: Lucas De Marchi <lucas.demarchi at intel.com>

Reviewed-by: Riana Tauro <riana.tauro at intel.com>

> ---
>   drivers/gpu/drm/xe/xe_configfs.c | 20 ++++++++++++++++----
>   1 file changed, 16 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/gpu/drm/xe/xe_configfs.c b/drivers/gpu/drm/xe/xe_configfs.c
> index 7c92d293ba733..58196b7571239 100644
> --- a/drivers/gpu/drm/xe/xe_configfs.c
> +++ b/drivers/gpu/drm/xe/xe_configfs.c
> @@ -29,11 +29,18 @@
>    * See Documentation/filesystems/configfs.rst for more information about how configfs works.
>    *
>    * Create devices
> - * ===============
> + * ==============
> + *
> + * To create a device, the ``xe`` module should already be loaded, but some
> + * attributes can only be set before binding the device. It can be accomplished
> + * by blocking the driver autoprobe:
>    *
> - * In order to create a device, the user has to create a directory inside ``'xe'``::
> + *	# echo 0 > /sys/bus/pci/drivers_autoprobe
> + *	# modprobe xe
>    *
> - *	mkdir /sys/kernel/config/xe/0000:03:00.0/
> + * In order to create a device, the user has to create a directory inside ``xe``::
> + *
> + *	# mkdir /sys/kernel/config/xe/0000:03:00.0/
>    *
>    * Every device created is populated by the driver with entries that can be
>    * used to configure it::
> @@ -49,6 +56,12 @@
>    *	    ├── engines_allowed
>    *	    └── enable_psmi
>    *
> + * After configuring the attributes as per next section, the device can be
> + * probed with::
> + *
> + *	# echo 0000:03:00.0 > /sys/bus/pci/drivers/xe/bind
> + *	# # or
> + *	# echo 0000:03:00.0 > /sys/bus/pci/drivers_probe
>    *
>    * Configure Attributes
>    * ====================
> @@ -60,7 +73,6 @@
>    * effect when probing the device. Example to enable it::
>    *
>    *	# echo 1 > /sys/kernel/config/xe/0000:03:00.0/survivability_mode
> - *	# echo 0000:03:00.0 > /sys/bus/pci/drivers/xe/bind  (Enters survivability mode if supported)
>    *
>    * This attribute can only be set before binding to the device.
>    *
>