diff options
| author | Mauro Carvalho Chehab | 2019-06-12 19:53:02 +0200 |
|---|---|---|
| committer | Jonathan Corbet | 2019-06-14 22:32:10 +0200 |
| commit | d223884089734cc637c4e5458870d69f6ded9f89 (patch) | |
| tree | 91c24108a62a0762839e0091f6e88cc49596f9fa /Documentation/xilinx | |
| parent | docs: watchdog: convert docs to ReST and rename to *.rst (diff) | |
| download | kernel-qcow2-linux-d223884089734cc637c4e5458870d69f6ded9f89.tar.gz kernel-qcow2-linux-d223884089734cc637c4e5458870d69f6ded9f89.tar.xz kernel-qcow2-linux-d223884089734cc637c4e5458870d69f6ded9f89.zip | |
docs: xilinx: convert eemi.txt to eemi.rst
This is a very trivial conversion: adjust the title markup
and add a few literal block markups to produce a better
visual when parsed and avoid warnings.
As newer documents related to xilinx could be added in the future,
create a new index file for it.
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/xilinx')
| -rw-r--r-- | Documentation/xilinx/eemi.rst (renamed from Documentation/xilinx/eemi.txt) | 8 | ||||
| -rw-r--r-- | Documentation/xilinx/index.rst | 17 |
2 files changed, 21 insertions, 4 deletions
diff --git a/Documentation/xilinx/eemi.txt b/Documentation/xilinx/eemi.rst index 5f39b4ffdcd4..9dcbc6f18d75 100644 --- a/Documentation/xilinx/eemi.txt +++ b/Documentation/xilinx/eemi.rst @@ -1,6 +1,6 @@ ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC EEMI Documentation ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC Firmware Interface ------------------------------------- @@ -21,7 +21,7 @@ The zynqmp-firmware driver maintain all EEMI APIs in zynqmp_eemi_ops structure. Any driver who want to communicate with PMC using EEMI APIs can call zynqmp_pm_get_eemi_ops(). -Example of EEMI ops: +Example of EEMI ops:: /* zynqmp-firmware driver maintain all EEMI APIs */ struct zynqmp_eemi_ops { @@ -34,7 +34,7 @@ Example of EEMI ops: .query_data = zynqmp_pm_query_data, }; -Example of EEMI ops usage: +Example of EEMI ops usage:: static const struct zynqmp_eemi_ops *eemi_ops; u32 ret_payload[PAYLOAD_ARG_CNT]; diff --git a/Documentation/xilinx/index.rst b/Documentation/xilinx/index.rst new file mode 100644 index 000000000000..01cc1a0714df --- /dev/null +++ b/Documentation/xilinx/index.rst @@ -0,0 +1,17 @@ +:orphan: + +=========== +Xilinx FPGA +=========== + +.. toctree:: + :maxdepth: 1 + + eemi + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` |