]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: ACPI: DSD: Convert LED documentation to ReST
authorSakari Ailus <sakari.ailus@linux.intel.com>
Wed, 14 Aug 2019 12:58:58 +0000 (15:58 +0300)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tue, 20 Aug 2019 21:53:46 +0000 (23:53 +0200)
Convert the LED documentation in text format into ReST.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/firmware-guide/acpi/dsd/leds.rst [moved from Documentation/acpi/dsd/leds.txt with 90% similarity]
Documentation/firmware-guide/acpi/index.rst

similarity index 90%
rename from Documentation/acpi/dsd/leds.txt
rename to Documentation/firmware-guide/acpi/dsd/leds.rst
index cc58b1a574c55a5d751c58aafae4edff1fe07809..946efe2b2936a5a4121627fb37a09e07c5ce1fd4 100644 (file)
@@ -1,4 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+
+========================================
 Describing and referring to LEDs in ACPI
+========================================
 
 Individual LEDs are described by hierarchical data extension [6] nodes under the
 device node, the LED driver chip. The "reg" property in the LED specific nodes
@@ -25,8 +30,12 @@ entry shall contain the string "led@" followed by the number of the LED,
 followed by the referred object name. That object shall be named "LED" followed
 by the number of the LED.
 
-An ASL example of a camera sensor device and a LED driver device for two LEDs.
-Objects not relevant for LEDs or the references to them have been omitted.
+Example
+=======
+
+An ASL example of a camera sensor device and a LED driver device for two LEDs is
+show below. Objects not relevant for LEDs or the references to them have been
+omitted. ::
 
        Device (LED)
        {
@@ -71,12 +80,15 @@ Objects not relevant for LEDs or the references to them have been omitted.
        }
 
 where
+::
 
        LED     LED driver device
        LED0    First LED
        LED1    Second LED
-       SEN     Camera sensor device (or another device the LED is
-               related to)
+       SEN     Camera sensor device (or another device the LED is related to)
+
+References
+==========
 
 [1] Device tree. <URL:http://www.devicetree.org>, referenced 2019-02-21.
 
index 90c90d42d9ad6284dbf0a2126d5025cc31d1c491..ad3b5afdae77e869ca8d685c4de1ed2f80ee67b0 100644 (file)
@@ -10,6 +10,7 @@ ACPI Support
    namespace
    dsd/graph
    dsd/data-node-references
+   dsd/leds
    enumeration
    osi
    method-customizing