diff options
| author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-06-28 15:20:20 +0300 |
|---|---|---|
| committer | Jacek Anaszewski <jacek.anaszewski@gmail.com> | 2019-06-28 21:57:31 +0300 |
| commit | 8dab91970a8c01ffc7816bf8a4c4cd587b481f34 (patch) | |
| tree | badc731b9da46037457092b360ed83baaa4351b9 /Documentation/leds/ledtrig-usbport.txt | |
| parent | 25529edef561ca51dadcbb6e97b1c40d2dbc5bae (diff) | |
| download | linux-8dab91970a8c01ffc7816bf8a4c4cd587b481f34.tar.xz | |
docs: leds: convert to ReST
Rename the leds documentation files to ReST, add an
index for them and adjust in order to produce a nice html
output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com>
Diffstat (limited to 'Documentation/leds/ledtrig-usbport.txt')
| -rw-r--r-- | Documentation/leds/ledtrig-usbport.txt | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/Documentation/leds/ledtrig-usbport.txt b/Documentation/leds/ledtrig-usbport.txt deleted file mode 100644 index 69f54bfb4789..000000000000 --- a/Documentation/leds/ledtrig-usbport.txt +++ /dev/null @@ -1,41 +0,0 @@ -USB port LED trigger -==================== - -This LED trigger can be used for signalling to the user a presence of USB device -in a given port. It simply turns on LED when device appears and turns it off -when it disappears. - -It requires selecting USB ports that should be observed. All available ones are -listed as separated entries in a "ports" subdirectory. Selecting is handled by -echoing "1" to a chosen port. - -Please note that this trigger allows selecting multiple USB ports for a single -LED. This can be useful in two cases: - -1) Device with single USB LED and few physical ports - -In such a case LED will be turned on as long as there is at least one connected -USB device. - -2) Device with a physical port handled by few controllers - -Some devices may have one controller per PHY standard. E.g. USB 3.0 physical -port may be handled by ohci-platform, ehci-platform and xhci-hcd. If there is -only one LED user will most likely want to assign ports from all 3 hubs. - - -This trigger can be activated from user space on led class devices as shown -below: - - echo usbport > trigger - -This adds sysfs attributes to the LED that are documented in: -Documentation/ABI/testing/sysfs-class-led-trigger-usbport - -Example use-case: - - echo usbport > trigger - echo 1 > ports/usb1-port1 - echo 1 > ports/usb2-port1 - cat ports/usb1-port1 - echo 0 > ports/usb1-port1 |