mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-25 05:34:00 +08:00
ad9b48c522
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: Adam Zerella <adam.zerella@gmail.com> Signed-off-by: Michael Ellerman <mpe@ellerman.id.au> Link: https://lore.kernel.org/r/20190915052905.13431-1-adam.zerella@gmail.com
42 lines
1.3 KiB
ReStructuredText
42 lines
1.3 KiB
ReStructuredText
==========================
|
|
ELF Note PowerPC Namespace
|
|
==========================
|
|
|
|
The PowerPC namespace in an ELF Note of the kernel binary is used to store
|
|
capabilities and information which can be used by a bootloader or userland.
|
|
|
|
Types and Descriptors
|
|
---------------------
|
|
|
|
The types to be used with the "PowerPC" namesapce are defined in [#f1]_.
|
|
|
|
1) PPC_ELFNOTE_CAPABILITIES
|
|
|
|
Define the capabilities supported/required by the kernel. This type uses a
|
|
bitmap as "descriptor" field. Each bit is described below:
|
|
|
|
- Ultravisor-capable bit (PowerNV only).
|
|
|
|
.. code-block:: c
|
|
|
|
#define PPCCAP_ULTRAVISOR_BIT (1 << 0)
|
|
|
|
Indicate that the powerpc kernel binary knows how to run in an
|
|
ultravisor-enabled system.
|
|
|
|
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
|
|
being run on a machine with ultravisor, the kernel will probably crash
|
|
trying to access ultravisor resources. For instance, it may crash in early
|
|
boot trying to set the partition table entry 0.
|
|
|
|
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
|
|
or the Ultravisor-capable bit is not set.
|
|
|
|
References
|
|
----------
|
|
|
|
.. [#f1] arch/powerpc/include/asm/elfnote.h
|
|
|