Skip to content

Commit

Permalink
Documentation: ACPI: DSD: Convert LED documentation to ReST
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Sakari Ailus authored and Rafael J. Wysocki committed Aug 20, 2019
1 parent d1abaeb commit 2b2d424
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)
{
Expand Down Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions Documentation/firmware-guide/acpi/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ ACPI Support
namespace
dsd/graph
dsd/data-node-references
dsd/leds
enumeration
osi
method-customizing
Expand Down

0 comments on commit 2b2d424

Please sign in to comment.