Xen project Mailing List

[RFC PATCH 11/11] docs: document hypercalls on sphinx generated html

From: Luca Fancellu <luca.fancellu@xxxxxxx>

Date: Thu, 3 Dec 2020 16:49:59 +0000

Delivery-date: Thu, 03 Dec 2020 16:50:38 +0000

List-id: This is a discussion list for members of the Xen Project FuSa SIG <fusa-sig.lists.xenproject.org>

Document the hypercalls using sphinx and doxygen. Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx> --- docs/hypercall-interfaces/ARM.rst | 43 +++++++++++++++++++ .../hypercall-interfaces/ARM/dom0_console.rst | 10 +++++ docs/hypercall-interfaces/ARM/elf_notes.rst | 10 +++++ .../ARM/event_channels.rst | 8 ++++ .../hypercall-interfaces/ARM/grant_tables.rst | 8 ++++ .../ARM/guest_scheduler_operations.rst | 7 +++ .../ARM/hypercall_calling_convention.rst | 7 +++ .../ARM/list_of_hypercalls.rst | 7 +++ .../ARM/start_of_day_memory_layout.rst | 9 ++++ .../start_of_day_shared_data_structure.rst | 12 ++++++ .../ARM/supported_hypercalls.rst | 7 +++ .../ARM/xen_elfnote_features.rst | 9 ++++ .../ARM/xenstore_wire_protocol.rst | 9 ++++ docs/hypercall-interfaces/index.rst | 9 ++++ docs/hypercall-interfaces/x86_32.rst | 4 ++ docs/hypercall-interfaces/x86_64.rst | 4 ++ docs/index.rst | 8 ++++ 17 files changed, 171 insertions(+) create mode 100644 docs/hypercall-interfaces/ARM.rst create mode 100644 docs/hypercall-interfaces/ARM/dom0_console.rst create mode 100644 docs/hypercall-interfaces/ARM/elf_notes.rst create mode 100644 docs/hypercall-interfaces/ARM/event_channels.rst create mode 100644 docs/hypercall-interfaces/ARM/grant_tables.rst create mode 100644 docs/hypercall-interfaces/ARM/guest_scheduler_operations.rst create mode 100644 docs/hypercall-interfaces/ARM/hypercall_calling_convention.rst create mode 100644 docs/hypercall-interfaces/ARM/list_of_hypercalls.rst create mode 100644 docs/hypercall-interfaces/ARM/start_of_day_memory_layout.rst create mode 100644 docs/hypercall-interfaces/ARM/start_of_day_shared_data_structure.rst create mode 100644 docs/hypercall-interfaces/ARM/supported_hypercalls.rst create mode 100644 docs/hypercall-interfaces/ARM/xen_elfnote_features.rst create mode 100644 docs/hypercall-interfaces/ARM/xenstore_wire_protocol.rst create mode 100644 docs/hypercall-interfaces/index.rst create mode 100644 docs/hypercall-interfaces/x86_32.rst create mode 100644 docs/hypercall-interfaces/x86_64.rst diff --git a/docs/hypercall-interfaces/ARM.rst b/docs/hypercall-interfaces/ARM.rst new file mode 100644 index 0000000000..35d7a107ed --- /dev/null +++ b/docs/hypercall-interfaces/ARM.rst @@ -0,0 +1,43 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - ARM +========================== + +Starting points +--------------- +.. toctree:: + :maxdepth: 2 + + ARM/hypercall_calling_convention + ARM/supported_hypercalls + ARM/list_of_hypercalls + ARM/guest_scheduler_operations + ARM/grant_tables + ARM/event_channels + ARM/xenstore_wire_protocol + ARM/start_of_day_shared_data_structure + ARM/start_of_day_memory_layout + ARM/dom0_console + ARM/xen_elfnote_features + ARM/elf_notes + +Functions +--------- + + +Structs +------- + + +Enums and sets of #defines +-------------------------- + + +Typedefs +-------- + + +Enum values and individual #defines +----------------------------------- + + diff --git a/docs/hypercall-interfaces/ARM/dom0_console.rst b/docs/hypercall-interfaces/ARM/dom0_console.rst new file mode 100644 index 0000000000..e102fac3d8 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/dom0_console.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Dom0 console +============ + +.. doxygengroup:: dom0_console + :project: Xen + :members: + :undoc-members: + diff --git a/docs/hypercall-interfaces/ARM/elf_notes.rst b/docs/hypercall-interfaces/ARM/elf_notes.rst new file mode 100644 index 0000000000..2203f09395 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/elf_notes.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +ELF notes +========= + +.. doxygengroup:: elf_notes + :project: Xen + :members: + :undoc-members: + diff --git a/docs/hypercall-interfaces/ARM/event_channels.rst b/docs/hypercall-interfaces/ARM/event_channels.rst new file mode 100644 index 0000000000..a1e441aa3f --- /dev/null +++ b/docs/hypercall-interfaces/ARM/event_channels.rst @@ -0,0 +1,8 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Event Channels +============== + +.. doxygengroup:: event_channels + :project: Xen + :members: diff --git a/docs/hypercall-interfaces/ARM/grant_tables.rst b/docs/hypercall-interfaces/ARM/grant_tables.rst new file mode 100644 index 0000000000..8955ec5812 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/grant_tables.rst @@ -0,0 +1,8 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Grant Tables +============ + +.. doxygengroup:: grant_table + :project: Xen + :members: diff --git a/docs/hypercall-interfaces/ARM/guest_scheduler_operations.rst b/docs/hypercall-interfaces/ARM/guest_scheduler_operations.rst new file mode 100644 index 0000000000..084bb62d67 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/guest_scheduler_operations.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Guest Scheduler Operations +========================== + +.. doxygengroup:: guest_scheduler_operations + :project: Xen diff --git a/docs/hypercall-interfaces/ARM/hypercall_calling_convention.rst b/docs/hypercall-interfaces/ARM/hypercall_calling_convention.rst new file mode 100644 index 0000000000..91fa16c088 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/hypercall_calling_convention.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Calling Convention +============================ + +.. doxygengroup:: hypercall_calling_convention + :project: Xen diff --git a/docs/hypercall-interfaces/ARM/list_of_hypercalls.rst b/docs/hypercall-interfaces/ARM/list_of_hypercalls.rst new file mode 100644 index 0000000000..9a7d599dfd --- /dev/null +++ b/docs/hypercall-interfaces/ARM/list_of_hypercalls.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +List of hypercalls +================== + +.. doxygengroup:: list_of_hypercalls + :project: Xen diff --git a/docs/hypercall-interfaces/ARM/start_of_day_memory_layout.rst b/docs/hypercall-interfaces/ARM/start_of_day_memory_layout.rst new file mode 100644 index 0000000000..f6ec24808f --- /dev/null +++ b/docs/hypercall-interfaces/ARM/start_of_day_memory_layout.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Start-of-day memory layout +========================== + +.. doxygengroup:: start_of_day_memory_layout + :project: Xen + :members: + :undoc-members: diff --git a/docs/hypercall-interfaces/ARM/start_of_day_shared_data_structure.rst b/docs/hypercall-interfaces/ARM/start_of_day_shared_data_structure.rst new file mode 100644 index 0000000000..7bf1c4946b --- /dev/null +++ b/docs/hypercall-interfaces/ARM/start_of_day_shared_data_structure.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Start-of-day shared data structure +================================== + +.. doxygengroup:: start_of_day_shared_data_structure + :project: Xen + +.. doxygenstruct:: shared_info + :project: Xen + :members: + :undoc-members: diff --git a/docs/hypercall-interfaces/ARM/supported_hypercalls.rst b/docs/hypercall-interfaces/ARM/supported_hypercalls.rst new file mode 100644 index 0000000000..070ce945e8 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/supported_hypercalls.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Supported hypercalls +==================== + +.. doxygengroup:: supported_hypercalls + :project: Xen diff --git a/docs/hypercall-interfaces/ARM/xen_elfnote_features.rst b/docs/hypercall-interfaces/ARM/xen_elfnote_features.rst new file mode 100644 index 0000000000..f99a83d5fa --- /dev/null +++ b/docs/hypercall-interfaces/ARM/xen_elfnote_features.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +XEN ELFNOTE FEATURES +==================== + +.. doxygengroup:: xen_elfnote_features + :project: Xen + :members: + :undoc-members: diff --git a/docs/hypercall-interfaces/ARM/xenstore_wire_protocol.rst b/docs/hypercall-interfaces/ARM/xenstore_wire_protocol.rst new file mode 100644 index 0000000000..753ed6b8c9 --- /dev/null +++ b/docs/hypercall-interfaces/ARM/xenstore_wire_protocol.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +XenStore wire protocol +====================== + +.. doxygengroup:: xenstore_wire_protocol + :project: Xen + :members: + diff --git a/docs/hypercall-interfaces/index.rst b/docs/hypercall-interfaces/index.rst new file mode 100644 index 0000000000..c46a88597d --- /dev/null +++ b/docs/hypercall-interfaces/index.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces +==================== + +.. toctree:: + ARM + x86_32 + x86_64 diff --git a/docs/hypercall-interfaces/x86_32.rst b/docs/hypercall-interfaces/x86_32.rst new file mode 100644 index 0000000000..9dcc29b22d --- /dev/null +++ b/docs/hypercall-interfaces/x86_32.rst @@ -0,0 +1,4 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - x86_32 +============================= diff --git a/docs/hypercall-interfaces/x86_64.rst b/docs/hypercall-interfaces/x86_64.rst new file mode 100644 index 0000000000..3ed70dff95 --- /dev/null +++ b/docs/hypercall-interfaces/x86_64.rst @@ -0,0 +1,4 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - x86_64 +============================= diff --git a/docs/index.rst b/docs/index.rst index b75487a05d..52226a42d8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,6 +53,14 @@ kind of development environment. hypervisor-guide/index +Hypercall Interfaces documentation +---------------------------------- + +.. toctree:: + :maxdepth: 2 + + hypercall-interfaces/index + Miscellanea ----------- -- 2.17.1

©2013 Xen Project, A Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation.
Xen Project is a trademark of The Linux Foundation.