[PATCH v2] spi: docs: improve the SPI userspace API documentation
From: Javier Martinez Canillas
Date: Fri Nov 19 2021 - 07:11:48 EST
This doc is fairly outdated and only uses legacy device instantiation
terminology. Let us update it and also mention the OF and ACPI device
tables, to make easier for users to figure out how should be defined.
Also, mention that devices bind could be done in user-space now using
the "driver_override" sysfs entry.
Suggested-by: Ralph Siemsen <ralph.siemsen@xxxxxxxxxx>
Signed-off-by: Javier Martinez Canillas <javierm@xxxxxxxxxx>
Changes in v2:
- Reword paragraph that explains the user-space spidev bind support
using sysfs (Uwe Kleine-König).
- Also improve the paragraph that explains that the SPI device sysfs
node will contain a "dev" attribute (Uwe Kleine-König).
- Explain that the matching tables can be extended and developers are
encouraged to do so (Geert Uytterhoeven).
Documentation/spi/spidev.rst | 58 ++++++++++++++++++++++++++----------
1 file changed, 43 insertions(+), 15 deletions(-)
diff --git a/Documentation/spi/spidev.rst b/Documentation/spi/spidev.rst
index f05dbc5ccdbc..369c657ba435 100644
@@ -29,21 +29,49 @@ of the driver stack) that are not accessible to userspace.
DEVICE CREATION, DRIVER BINDING
-The simplest way to arrange to use this driver is to just list it in the
-spi_board_info for a device as the driver it should use: the "modalias"
-entry is "spidev", matching the name of the driver exposing this API.
-Set up the other device characteristics (bits per word, SPI clocking,
-chipselect polarity, etc) as usual, so you won't always need to override
-(Sysfs also supports userspace driven binding/unbinding of drivers to
-devices. That mechanism might be supported here in the future.)
-When you do that, the sysfs node for the SPI device will include a child
-device node with a "dev" attribute that will be understood by udev or mdev.
-(Larger systems will have "udev". Smaller ones may configure "mdev" into
-busybox; it's less featureful, but often enough.) For a SPI device with
-chipselect C on bus B, you should see:
+The spidev driver contains lists of SPI devices that are supported for
+the different hardware topology representations.
+The following are the SPI device tables supported by the spidev driver:
+ - struct spi_device_id spidev_spi_ids: list of devices that can be
+ bound when these are defined using a struct spi_board_info with a
+ .modalias field matching one of the entries in the table.
+ - struct of_device_id spidev_dt_ids: list of devices that can be
+ bound when these are defined using a Device Tree node that has a
+ compatible string matching one of the entries in the table.
+ - struct acpi_device_id spidev_acpi_ids: list of devices that can
+ be bound when these are defined using a ACPI device object with a
+ _HID matching one of the entries in the table.
+You are encouraged to add an entry for your SPI device name to relevant
+tables, if these don't already have an entry for the device. To do that,
+post a patch for spidev to the linux-spi@xxxxxxxxxxxxxxx mailing list.
+It used to be supported to define an SPI device using the "spidev" name.
+For example, as .modalias = "spidev" or compatible = "spidev". But this
+is no longer supported by the Linux kernel and instead a real SPI device
+name as listed in one of the tables must be used.
+Not having a real SPI device name will lead to an error being printed and
+the spidev driver failing to probe.
+Sysfs also supports userspace driven binding/unbinding of drivers to
+devices that do not bind automatically using one of the tables above.
+To make the spidev driver bind to such a device, use the following:
+ echo spidev > /sys/bus/spi/devices/spiB.C/driver_override
+ echo spiB.C > /sys/bus/spi/drivers/spidev/bind
+When the spidev driver is bound to a SPI device, the sysfs node for the
+device will include a child device node with a "dev" attribute that will
+be understood by udev or mdev (udev replacement from BusyBox; it's less
+featureful, but often enough).
+For a SPI device with chipselect C on bus B, you should see:
character special device, major number 153 with