public inbox for linux-arch@vger.kernel.org
 help / color / mirror / Atom feed
From: "Maxiwell S. Garcia" <maxiwell@linux.ibm.com>
To: linuxppc-dev@ozlabs.org
Cc: kvm-ppc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-arch@vger.kernel.org, paulus@ozlabs.org,
	mpe@ellerman.id.au, andmike@linux.ibm.com, linuxram@us.ibm.com,
	bauerman@linux.ibm.com, cclaudio@linux.ibm.com,
	"Maxiwell S. Garcia" <maxiwell@linux.ibm.com>
Subject: [PATCH v2 2/2] docs: powerpc: Add ELF note documentation
Date: Thu, 29 Aug 2019 12:50:21 -0300	[thread overview]
Message-ID: <20190829155021.2915-3-maxiwell@linux.ibm.com> (raw)
In-Reply-To: <20190829155021.2915-1-maxiwell@linux.ibm.com>

The ELF note documentation describes the types and descriptors to be
used with the PowerPC namespace.

Signed-off-by: Maxiwell S. Garcia <maxiwell@linux.ibm.com>
Signed-off-by: Claudio Carvalho <cclaudio@linux.ibm.com>
---
 Documentation/powerpc/elfnote.rst | 42 +++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 Documentation/powerpc/elfnote.rst

diff --git a/Documentation/powerpc/elfnote.rst b/Documentation/powerpc/elfnote.rst
new file mode 100644
index 000000000000..2a5c4beeb809
--- /dev/null
+++ b/Documentation/powerpc/elfnote.rst
@@ -0,0 +1,42 @@
+==========================
+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 the
+include/uapi/asm/elfnote.h
+
+	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).
+
+	#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
+----------
+
+arch/powerpc/include/asm/elfnote.h
+arch/powerpc/kernel/note.S
+
+
-- 
2.20.1

  parent reply	other threads:[~2019-08-29 15:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-29 15:50 [PATCH v2 0/2] powerpc: Add PowerPC Capabilities ELF note Maxiwell S. Garcia
2019-08-29 15:50 ` Maxiwell S. Garcia
2019-08-29 15:50 ` [PATCH v2 1/2] " Maxiwell S. Garcia
2019-08-29 15:50   ` Maxiwell S. Garcia
2019-09-02  3:06   ` Michael Ellerman
2019-09-02  3:06     ` Michael Ellerman
2019-08-29 15:50 ` Maxiwell S. Garcia [this message]
2019-08-29 15:50   ` [PATCH v2 2/2] docs: powerpc: Add ELF note documentation Maxiwell S. Garcia

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190829155021.2915-3-maxiwell@linux.ibm.com \
    --to=maxiwell@linux.ibm.com \
    --cc=andmike@linux.ibm.com \
    --cc=bauerman@linux.ibm.com \
    --cc=cclaudio@linux.ibm.com \
    --cc=kvm-ppc@vger.kernel.org \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@ozlabs.org \
    --cc=linuxram@us.ibm.com \
    --cc=mpe@ellerman.id.au \
    --cc=paulus@ozlabs.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox