diff options
| author | Rob Herring <robh@kernel.org> | 2021-03-25 19:47:13 +0300 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2021-03-27 21:59:03 +0300 |
| commit | aa89ee98b8b4d36cff793814efbc7ae31b2ea085 (patch) | |
| tree | fe72b7bbf2ec2327d7994ad829654b643d696a17 | |
| parent | 8c8239c2c1fb82f171cb22a707f3bb88a2f22109 (diff) | |
| download | linux-aa89ee98b8b4d36cff793814efbc7ae31b2ea085.tar.xz | |
docs: dt: Add DT API documentation
The kernel-doc for the DT APIs are not included in the documentation
build. Add them.
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/20210325164713.1296407-9-robh@kernel.org
| -rw-r--r-- | Documentation/devicetree/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/devicetree/kernel-api.rst | 57 |
2 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst index 70b5dcdbcf07..1a2fc8014996 100644 --- a/Documentation/devicetree/index.rst +++ b/Documentation/devicetree/index.rst @@ -11,6 +11,7 @@ Kernel Devicetree Usage usage-model of_unittest + kernel-api Devicetree Overlays =================== diff --git a/Documentation/devicetree/kernel-api.rst b/Documentation/devicetree/kernel-api.rst new file mode 100644 index 000000000000..b7429e6ed6d5 --- /dev/null +++ b/Documentation/devicetree/kernel-api.rst @@ -0,0 +1,57 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. _devicetree: + +====================================== +DeviceTree Kernel API +====================================== + +Core functions +-------------- + +.. kernel-doc:: drivers/of/base.c + :export: + +.. kernel-doc:: include/linux/of.h + :internal: + +.. kernel-doc:: drivers/of/property.c + :export: + +.. kernel-doc:: include/linux/of_graph.h + :internal: + +.. kernel-doc:: drivers/of/address.c + :export: + +.. kernel-doc:: drivers/of/irq.c + :export: + +.. kernel-doc:: drivers/of/fdt.c + :export: + +Driver model functions +---------------------- + +.. kernel-doc:: include/linux/of_device.h + :internal: + +.. kernel-doc:: drivers/of/device.c + :export: + +.. kernel-doc:: include/linux/of_platform.h + :internal: + +.. kernel-doc:: drivers/of/platform.c + :export: + +Overlay and Dynamic DT functions +-------------------------------- + +.. kernel-doc:: drivers/of/resolver.c + :export: + +.. kernel-doc:: drivers/of/dynamic.c + :export: + +.. kernel-doc:: drivers/of/overlay.c + :export: |