linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Roy Franz <roy.franz@linaro.org>
To: linux-kernel@vger.kernel.org, linux-efi@vger.kernel.org,
	matt.fleming@intel.com
Cc: leif.lindholm@linaro.org, grant.likely@linaro.org,
	msalter@redhat.com, Roy Franz <roy.franz@linaro.org>
Subject: [PATCH 01/18] EFI stub documentation updates
Date: Sun, 22 Sep 2013 15:45:25 -0700	[thread overview]
Message-ID: <1379889942-3135-2-git-send-email-roy.franz@linaro.org> (raw)
In-Reply-To: <1379889942-3135-1-git-send-email-roy.franz@linaro.org>

Move efi-stub.txt out of x86 directory and into common directory
in preparation for adding ARM EFI stub support.

Signed-off-by: Roy Franz <roy.franz@linaro.org>
---
 Documentation/efi-stub.txt     |   65 ++++++++++++++++++++++++++++++++++++++++
 Documentation/x86/efi-stub.txt |   65 ----------------------------------------
 arch/x86/Kconfig               |    2 +-
 3 files changed, 66 insertions(+), 66 deletions(-)
 create mode 100644 Documentation/efi-stub.txt
 delete mode 100644 Documentation/x86/efi-stub.txt

diff --git a/Documentation/efi-stub.txt b/Documentation/efi-stub.txt
new file mode 100644
index 0000000..44e6bb6
--- /dev/null
+++ b/Documentation/efi-stub.txt
@@ -0,0 +1,65 @@
+			  The EFI Boot Stub
+		     ---------------------------
+
+On the x86 platform, a bzImage can masquerade as a PE/COFF image,
+thereby convincing EFI firmware loaders to load it as an EFI
+executable. The code that modifies the bzImage header, along with the
+EFI-specific entry point that the firmware loader jumps to are
+collectively known as the "EFI boot stub", and live in
+arch/x86/boot/header.S and arch/x86/boot/compressed/eboot.c,
+respectively.
+
+By using the EFI boot stub it's possible to boot a Linux kernel
+without the use of a conventional EFI boot loader, such as grub or
+elilo. Since the EFI boot stub performs the jobs of a boot loader, in
+a certain sense it *IS* the boot loader.
+
+The EFI boot stub is enabled with the CONFIG_EFI_STUB kernel option.
+
+
+**** How to install bzImage.efi
+
+The bzImage located in arch/x86/boot/bzImage must be copied to the EFI
+System Partiion (ESP) and renamed with the extension ".efi". Without
+the extension the EFI firmware loader will refuse to execute it. It's
+not possible to execute bzImage.efi from the usual Linux file systems
+because EFI firmware doesn't have support for them.
+
+
+**** Passing kernel parameters from the EFI shell
+
+Arguments to the kernel can be passed after bzImage.efi, e.g.
+
+	fs0:> bzImage.efi console=ttyS0 root=/dev/sda4
+
+
+**** The "initrd=" option
+
+Like most boot loaders, the EFI stub allows the user to specify
+multiple initrd files using the "initrd=" option. This is the only EFI
+stub-specific command line parameter, everything else is passed to the
+kernel when it boots.
+
+The path to the initrd file must be an absolute path from the
+beginning of the ESP, relative path names do not work. Also, the path
+is an EFI-style path and directory elements must be separated with
+backslashes (\). For example, given the following directory layout,
+
+fs0:>
+	Kernels\
+			bzImage.efi
+			initrd-large.img
+
+	Ramdisks\
+			initrd-small.img
+			initrd-medium.img
+
+to boot with the initrd-large.img file if the current working
+directory is fs0:\Kernels, the following command must be used,
+
+	fs0:\Kernels> bzImage.efi initrd=\Kernels\initrd-large.img
+
+Notice how bzImage.efi can be specified with a relative path. That's
+because the image we're executing is interpreted by the EFI shell,
+which understands relative paths, whereas the rest of the command line
+is passed to bzImage.efi.
diff --git a/Documentation/x86/efi-stub.txt b/Documentation/x86/efi-stub.txt
deleted file mode 100644
index 44e6bb6..0000000
--- a/Documentation/x86/efi-stub.txt
+++ /dev/null
@@ -1,65 +0,0 @@
-			  The EFI Boot Stub
-		     ---------------------------
-
-On the x86 platform, a bzImage can masquerade as a PE/COFF image,
-thereby convincing EFI firmware loaders to load it as an EFI
-executable. The code that modifies the bzImage header, along with the
-EFI-specific entry point that the firmware loader jumps to are
-collectively known as the "EFI boot stub", and live in
-arch/x86/boot/header.S and arch/x86/boot/compressed/eboot.c,
-respectively.
-
-By using the EFI boot stub it's possible to boot a Linux kernel
-without the use of a conventional EFI boot loader, such as grub or
-elilo. Since the EFI boot stub performs the jobs of a boot loader, in
-a certain sense it *IS* the boot loader.
-
-The EFI boot stub is enabled with the CONFIG_EFI_STUB kernel option.
-
-
-**** How to install bzImage.efi
-
-The bzImage located in arch/x86/boot/bzImage must be copied to the EFI
-System Partiion (ESP) and renamed with the extension ".efi". Without
-the extension the EFI firmware loader will refuse to execute it. It's
-not possible to execute bzImage.efi from the usual Linux file systems
-because EFI firmware doesn't have support for them.
-
-
-**** Passing kernel parameters from the EFI shell
-
-Arguments to the kernel can be passed after bzImage.efi, e.g.
-
-	fs0:> bzImage.efi console=ttyS0 root=/dev/sda4
-
-
-**** The "initrd=" option
-
-Like most boot loaders, the EFI stub allows the user to specify
-multiple initrd files using the "initrd=" option. This is the only EFI
-stub-specific command line parameter, everything else is passed to the
-kernel when it boots.
-
-The path to the initrd file must be an absolute path from the
-beginning of the ESP, relative path names do not work. Also, the path
-is an EFI-style path and directory elements must be separated with
-backslashes (\). For example, given the following directory layout,
-
-fs0:>
-	Kernels\
-			bzImage.efi
-			initrd-large.img
-
-	Ramdisks\
-			initrd-small.img
-			initrd-medium.img
-
-to boot with the initrd-large.img file if the current working
-directory is fs0:\Kernels, the following command must be used,
-
-	fs0:\Kernels> bzImage.efi initrd=\Kernels\initrd-large.img
-
-Notice how bzImage.efi can be specified with a relative path. That's
-because the image we're executing is interpreted by the EFI shell,
-which understands relative paths, whereas the rest of the command line
-is passed to bzImage.efi.
diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
index b32ebf9..ec65b51 100644
--- a/arch/x86/Kconfig
+++ b/arch/x86/Kconfig
@@ -1579,7 +1579,7 @@ config EFI_STUB
           This kernel feature allows a bzImage to be loaded directly
 	  by EFI firmware without the use of a bootloader.
 
-	  See Documentation/x86/efi-stub.txt for more information.
+	  See Documentation/efi-stub.txt for more information.
 
 config SECCOMP
 	def_bool y
-- 
1.7.10.4


  reply	other threads:[~2013-09-22 22:45 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-22 22:45 [PATCH V5 00/18] ARM EFI stub common code Roy Franz
2013-09-22 22:45 ` Roy Franz [this message]
2013-09-22 22:45 ` [PATCH 02/18] Add proper definitions for some EFI function pointers Roy Franz
2013-09-22 22:45 ` [PATCH 03/18] Move common EFI stub code from x86 arch code to common location Roy Franz
2013-09-22 22:45 ` [PATCH 04/18] Add system table pointer argument to shared functions Roy Franz
2013-09-22 22:45 ` [PATCH 05/18] Rename memory allocation/free functions Roy Franz
2013-09-22 22:45 ` [PATCH 06/18] Enforce minimum alignment of 1 page on allocations Roy Franz
2013-09-25 12:01   ` Matt Fleming
2013-09-22 22:45 ` [PATCH 07/18] Move relocate_kernel() to shared file Roy Franz
2013-09-22 22:45 ` [PATCH 08/18] Generalize relocate_kernel() for use by other architectures Roy Franz
2013-09-25 12:01   ` Matt Fleming
2013-09-22 22:45 ` [PATCH 09/18] Move unicode to ASCII conversion to shared function Roy Franz
2013-09-25 12:01   ` Matt Fleming
2013-09-22 22:45 ` [PATCH 10/18] Do proper conversion from UTF-16 to UTF-8 Roy Franz
2013-09-22 22:54   ` H. Peter Anvin
2013-09-22 23:07     ` Roy Franz
2013-09-23  0:24       ` H. Peter Anvin
2013-09-25 12:01         ` Matt Fleming
2013-09-25 14:15           ` Roy Franz
2013-09-22 22:45 ` [PATCH 11/18] Rename __get_map() to efi_get_memory_map() Roy Franz
2013-09-22 22:45 ` [PATCH 12/18] generalize efi_get_memory_map() Roy Franz
2013-09-22 22:45 ` [PATCH 13/18] use efi_get_memory_map() to get final map for x86 Roy Franz
2013-09-22 22:45 ` [PATCH 14/18] Allow efi_free() to be called with size of 0, and do nothing in that case Roy Franz
2013-09-22 22:45 ` [PATCH 15/18] Generalize handle_ramdisks() and rename to handle_cmdline_files() Roy Franz
2013-09-22 22:45 ` [PATCH 16/18] Renames in handle_cmdline_files() to complete generalization Roy Franz
2013-09-22 22:45 ` [PATCH 17/18] Fix types in EFI calls to match EFI function definitions Roy Franz
2013-09-22 22:45 ` [PATCH 18/18] resolve warnings found on ARM compile Roy Franz
2013-09-25 12:11 ` [PATCH V5 00/18] ARM EFI stub common code Matt Fleming
2013-09-25 12:21   ` Matt Fleming

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=1379889942-3135-2-git-send-email-roy.franz@linaro.org \
    --to=roy.franz@linaro.org \
    --cc=grant.likely@linaro.org \
    --cc=leif.lindholm@linaro.org \
    --cc=linux-efi@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=matt.fleming@intel.com \
    --cc=msalter@redhat.com \
    /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;
as well as URLs for NNTP newsgroup(s).