mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-27 12:57:53 +00:00
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>
This commit is contained in:
parent
cc2a2d19f8
commit
d223884089
2 changed files with 21 additions and 4 deletions
|
@ -1,6 +1,6 @@
|
||||||
---------------------------------------------------------------------
|
====================================
|
||||||
Xilinx Zynq MPSoC EEMI Documentation
|
Xilinx Zynq MPSoC EEMI Documentation
|
||||||
---------------------------------------------------------------------
|
====================================
|
||||||
|
|
||||||
Xilinx Zynq MPSoC Firmware Interface
|
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
|
structure. Any driver who want to communicate with PMC using EEMI APIs
|
||||||
can call zynqmp_pm_get_eemi_ops().
|
can call zynqmp_pm_get_eemi_ops().
|
||||||
|
|
||||||
Example of EEMI ops:
|
Example of EEMI ops::
|
||||||
|
|
||||||
/* zynqmp-firmware driver maintain all EEMI APIs */
|
/* zynqmp-firmware driver maintain all EEMI APIs */
|
||||||
struct zynqmp_eemi_ops {
|
struct zynqmp_eemi_ops {
|
||||||
|
@ -34,7 +34,7 @@ Example of EEMI ops:
|
||||||
.query_data = zynqmp_pm_query_data,
|
.query_data = zynqmp_pm_query_data,
|
||||||
};
|
};
|
||||||
|
|
||||||
Example of EEMI ops usage:
|
Example of EEMI ops usage::
|
||||||
|
|
||||||
static const struct zynqmp_eemi_ops *eemi_ops;
|
static const struct zynqmp_eemi_ops *eemi_ops;
|
||||||
u32 ret_payload[PAYLOAD_ARG_CNT];
|
u32 ret_payload[PAYLOAD_ARG_CNT];
|
17
Documentation/xilinx/index.rst
Normal file
17
Documentation/xilinx/index.rst
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
:orphan:
|
||||||
|
|
||||||
|
===========
|
||||||
|
Xilinx FPGA
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
eemi
|
||||||
|
|
||||||
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
Indices
|
||||||
|
=======
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
Loading…
Reference in a new issue