Commit ad9b48c5 authored by Adam Zerella's avatar Adam Zerella Committed by Michael Ellerman

docs: powerpc: Add missing documentation reference

The documentation pages for 'elfnote' and 'ultravisor'
are not included in the powerpc documentation index, this
generates Sphinx warnings:

WARNING: document isn't included in any toctree

Additionally, when one includes these missing doc pages,
more Sphinx warnings appear. Unused footnote references,
syntax highlighting and table of content ordering has
been adjusted.
Signed-off-by: default avatarAdam Zerella <adam.zerella@gmail.com>
Signed-off-by: default avatarMichael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20190915052905.13431-1-adam.zerella@gmail.com
parent 855d9140
...@@ -8,8 +8,7 @@ capabilities and information which can be used by a bootloader or userland. ...@@ -8,8 +8,7 @@ capabilities and information which can be used by a bootloader or userland.
Types and Descriptors Types and Descriptors
--------------------- ---------------------
The types to be used with the "PowerPC" namesapce are defined in the The types to be used with the "PowerPC" namesapce are defined in [#f1]_.
include/uapi/asm/elfnote.h
1) PPC_ELFNOTE_CAPABILITIES 1) PPC_ELFNOTE_CAPABILITIES
...@@ -18,25 +17,25 @@ bitmap as "descriptor" field. Each bit is described below: ...@@ -18,25 +17,25 @@ bitmap as "descriptor" field. Each bit is described below:
- Ultravisor-capable bit (PowerNV only). - Ultravisor-capable bit (PowerNV only).
.. code-block:: c
#define PPCCAP_ULTRAVISOR_BIT (1 << 0) #define PPCCAP_ULTRAVISOR_BIT (1 << 0)
Indicate that the powerpc kernel binary knows how to run in an Indicate that the powerpc kernel binary knows how to run in an
ultravisor-enabled system. ultravisor-enabled system.
In an ultravisor-enabled system, some machine resources are now controlled In an ultravisor-enabled system, some machine resources are now controlled
by the ultravisor. If the kernel is not ultravisor-capable, but it ends up by the ultravisor. If the kernel is not ultravisor-capable, but it ends up
being run on a machine with ultravisor, the kernel will probably crash being run on a machine with ultravisor, the kernel will probably crash
trying to access ultravisor resources. For instance, it may crash in early trying to access ultravisor resources. For instance, it may crash in early
boot trying to set the partition table entry 0. boot trying to set the partition table entry 0.
In an ultravisor-enabled system, a bootloader could warn the user or prevent In an ultravisor-enabled system, a bootloader could warn the user or prevent
the kernel from being run if the PowerPC ultravisor capability doesn't exist the kernel from being run if the PowerPC ultravisor capability doesn't exist
or the Ultravisor-capable bit is not set. or the Ultravisor-capable bit is not set.
References References
---------- ----------
arch/powerpc/include/asm/elfnote.h .. [#f1] arch/powerpc/include/asm/elfnote.h
arch/powerpc/kernel/note.S
...@@ -15,6 +15,7 @@ powerpc ...@@ -15,6 +15,7 @@ powerpc
dawr-power9 dawr-power9
dscr dscr
eeh-pci-error-recovery eeh-pci-error-recovery
elfnote
firmware-assisted-dump firmware-assisted-dump
hvcs hvcs
isa-versions isa-versions
...@@ -25,6 +26,7 @@ powerpc ...@@ -25,6 +26,7 @@ powerpc
qe_firmware qe_firmware
syscall64-abi syscall64-abi
transactional_memory transactional_memory
ultravisor
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0 .. SPDX-License-Identifier: GPL-2.0
.. _ultravisor: .. _ultravisor:
============================ ============================
Protected Execution Facility Protected Execution Facility
...@@ -8,9 +8,6 @@ Protected Execution Facility ...@@ -8,9 +8,6 @@ Protected Execution Facility
.. contents:: .. contents::
:depth: 3 :depth: 3
.. sectnum::
:depth: 3
Protected Execution Facility Protected Execution Facility
############################ ############################
...@@ -255,7 +252,7 @@ Ultravisor calls API ...@@ -255,7 +252,7 @@ Ultravisor calls API
be made available in the public/OpenPower version of the PAPR be made available in the public/OpenPower version of the PAPR
specification. specification.
**Note** .. note::
If PEF is not enabled, the ultracalls will be redirected to the If PEF is not enabled, the ultracalls will be redirected to the
Hypervisor which must handle/fail the calls. Hypervisor which must handle/fail the calls.
...@@ -1054,4 +1051,4 @@ Use cases ...@@ -1054,4 +1051,4 @@ Use cases
References References
########## ##########
.. [1] `Supporting Protected Computing on IBM Power Architecture <https://developer.ibm.com/articles/l-support-protected-computing/>`_ - `Supporting Protected Computing on IBM Power Architecture <https://developer.ibm.com/articles/l-support-protected-computing/>`_
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment