summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorChristian Marangi <[email protected]>2024-10-01 14:24:42 +0200
committerTom Rini <[email protected]>2024-10-10 16:02:20 -0600
commit051c448c8b2a0b0ae9a682b4b1fde35f7a127c77 (patch)
treed77ec3c9b90cd0b95aacb90a6c9ea4687b16027f /doc/api
parent990f726ce797c040adda6d1e1bc6a21bd2b28657 (diff)
doc: introduce led.rst documentation
Introduce simple led.rst documentation to document all the additional Kconfig and the current limitation of LED_BLINK and GPIO software blink. Also add missing definition for sw_blink in led_uc_plat struct. Signed-off-by: Christian Marangi <[email protected]> Reviewed-by: Simon Glass <[email protected]>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/index.rst1
-rw-r--r--doc/api/led.rst10
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst
index ec0b8adb2cf..9f7f23f868f 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -14,6 +14,7 @@ U-Boot API documentation
event
getopt
interrupt
+ led
linker_lists
lmb
logging
diff --git a/doc/api/led.rst b/doc/api/led.rst
new file mode 100644
index 00000000000..e52e350d1bb
--- /dev/null
+++ b/doc/api/led.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+LED
+===
+
+.. kernel-doc:: include/led.h
+ :doc: Overview
+
+.. kernel-doc:: include/led.h
+ :internal: \ No newline at end of file