From patchwork Thu Nov 24 20:40:04 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Kiper X-Patchwork-Id: 9446269 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 6722D606DB for ; Thu, 24 Nov 2016 20:43:02 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 56ED227F8F for ; Thu, 24 Nov 2016 20:43:02 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4B17C27FB6; Thu, 24 Nov 2016 20:43:02 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 388A727FAE for ; Thu, 24 Nov 2016 20:43:01 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cA0pB-0001Nh-N4; Thu, 24 Nov 2016 20:40:53 +0000 Received: from mail6.bemta5.messagelabs.com ([195.245.231.135]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cA0p9-0001Mw-NF for xen-devel@lists.xenproject.org; Thu, 24 Nov 2016 20:40:51 +0000 Received: from [85.158.139.211] by server-15.bemta-5.messagelabs.com id B7/D0-13537-35057385; Thu, 24 Nov 2016 20:40:51 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrLLMWRWlGSWpSXmKPExsUyZ7p8oG5ggHm EwbxpbBbft0xmcmD0OPzhCksAYxRrZl5SfkUCa0ZbxwfWgnN6FUfe/2JtYNyq1sXIxSEkMJlJ 4sDGHnYI5zejxOydk6CcjYwSB17vY4JwJjJKzJo4laWLkZODTUBH4uKXh+wgtoiAmcSzmQ2MI EXMApsYJWZum8cKkhAWSJWYc/kNI4jNIqAqcW/jKrBmXgF3ibtL1zKD2BICihLdzyawdTFycH AKeEi8+ygJEhYCKrk06SgjRImxRPvbi2wTGPkWMDKsYtQoTi0qSy3SNTLWSyrKTM8oyU3MzNE 1NDDVy00tLk5MT81JTCrWS87P3cQIDJZ6BgbGHYw72v0OMUpyMCmJ8m4WMo8Q4kvKT6nMSCzO iC8qzUktPsQow8GhJMHb4QeUEyxKTU+tSMvMAYYtTFqCg0dJhPeSL1Cat7ggMbc4Mx0idYpRU UqctxekTwAkkVGaB9cGi5VLjLJSwryMDAwMQjwFqUW5mSWo8q8YxTkYlYR5T4BM4cnMK4Gb/g poMRPQYslvxiCLSxIRUlINjPMFRV46nv7W9fzHIheWNSFJ2brbb6VYZVzaW7T8Ts5ldu+JU5b Nqk7IuTdHTfB88OELUnIvdFpXny6cdeKl14WDxUUXzc7PkO6fvdnqaaOYaqrfniqOCVGueSzP WirmJMwSXeay7eSOd/G+wSVa+Z365xpUbxdv6XnNV3/1gskctTqDgDXtP5RYijMSDbWYi4oTA TYGsYGQAgAA X-Env-Sender: daniel.kiper@oracle.com X-Msg-Ref: server-2.tower-206.messagelabs.com!1480020043!51466223!1 X-Originating-IP: [156.151.31.81] X-SpamReason: No, hits=0.0 required=7.0 tests=sa_preprocessor: VHJ1c3RlZCBJUDogMTU2LjE1MS4zMS44MSA9PiAyODgzMzk=\n X-StarScan-Received: X-StarScan-Version: 9.0.16; banners=-,-,- X-VirusChecked: Checked Received: (qmail 22896 invoked from network); 24 Nov 2016 20:40:44 -0000 Received: from userp1040.oracle.com (HELO userp1040.oracle.com) (156.151.31.81) by server-2.tower-206.messagelabs.com with DHE-RSA-AES256-GCM-SHA384 encrypted SMTP; 24 Nov 2016 20:40:44 -0000 Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id uAOKegZv012978 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 24 Nov 2016 20:40:42 GMT Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id uAOKefVX008267 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 24 Nov 2016 20:40:42 GMT Received: from abhmp0019.oracle.com (abhmp0019.oracle.com [141.146.116.25]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id uAOKefDH020533; Thu, 24 Nov 2016 20:40:41 GMT Received: from olila.local.net-space.pl (/10.175.249.101) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Thu, 24 Nov 2016 12:40:40 -0800 From: Daniel Kiper To: grub-devel@gnu.org, xen-devel@lists.xenproject.org Date: Thu, 24 Nov 2016 21:40:04 +0100 Message-Id: <1480020010-18421-6-git-send-email-daniel.kiper@oracle.com> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1480020010-18421-1-git-send-email-daniel.kiper@oracle.com> References: <1480020010-18421-1-git-send-email-daniel.kiper@oracle.com> X-Source-IP: aserv0022.oracle.com [141.146.126.234] Cc: jgross@suse.com, eric.snowberg@oracle.com, arvidjaar@gmail.com, andrew.cooper3@citrix.com, seth.goldberg@oracle.com, phcoder@gmail.com Subject: [Xen-devel] [MULTIBOOT2 DOC PATCH v2 05/11] multiboot2: Add description of support for EFI boot services X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Daniel Kiper --- v2 - suggestions/fixes: - clarify physical address meaning for EFI amd64 mode with boot services enabled (suggested by Andrew Cooper). --- doc/multiboot.texi | 115 +++++++++++++++++++++++++++++++++++++++++++++++++++- doc/multiboot2.h | 2 + 2 files changed, 115 insertions(+), 2 deletions(-) diff --git a/doc/multiboot.texi b/doc/multiboot.texi index f0f167e..cc1edab 100644 --- a/doc/multiboot.texi +++ b/doc/multiboot.texi @@ -534,6 +534,66 @@ The physical address to which the boot loader should jump in order to start running the operating system. @end table +@subsection EFI i386 entry address tag of Multiboot2 header + +@example +@group + +-------------------+ +u16 | type = 8 | +u16 | flags | +u32 | size | +u_virt | entry_addr | + +-------------------+ +@end group +@end example + +All of the address fields in this tag are physical addresses. +The meaning of each is as follows: + +@table @code + +@item entry_addr +The physical address to which the boot loader should jump in order to +start running EFI i386 compatible operating system code. +@end table + +This tag is taken into account only on EFI i386 platforms +when Multiboot2 image header contains EFI boot services tag. +Then entry point specified in ELF header and the entry address +tag of Multiboot2 header are ignored. + +@subsection EFI amd64 entry address tag of Multiboot2 header + +@example +@group + +-------------------+ +u16 | type = 9 | +u16 | flags | +u32 | size | +u_virt | entry_addr | + +-------------------+ +@end group +@end example + +All of the address fields in this tag are physical addresses (paging +mode is enabled and any memory space defined by the UEFI memory map +is identity mapped, hence, virtual address equals physical address; +Unified Extensible Firmware Interface Specification, Version 2.6, +section 2.3.4, x64 Platforms, boot services). The meaning of each +is as follows: + +@table @code + +@item entry_addr +The physical address to which the boot loader should jump in order to +start running EFI amd64 compatible operating system code. +@end table + +This tag is taken into account only on EFI amd64 platforms +when Multiboot2 image header contains EFI boot services tag. +Then entry point specified in ELF header and the entry address +tag of Multiboot2 header are ignored. + @node Console header tags @subsection Flags tag @@ -714,12 +774,63 @@ The OS image must leave interrupts disabled until it sets up its own On EFI system boot services must be terminated. +@section EFI i386 machine state with boot services enabled + +When the boot loader invokes the 32-bit operating system on EFI i386 +platform and EFI boot services tag together with EFI i386 entry address +tag are present in the image Multiboot2 header, the machine must have the +following state: + +@table @samp +@item EAX +Must contain the magic value @samp{0x36d76289}; the presence of this +value indicates to the operating system that it was loaded by a +Multiboot-compliant boot loader (e.g. as opposed to another type of +boot loader that the operating system can also be loaded from). + +@item EBX +Must contain the 32-bit physical address of the Multiboot2 +information structure provided by the boot loader (@pxref{Boot +information format}). +@end table + +All other processor registers, flag bits and state are set accordingly +to Unified Extensible Firmware Interface Specification, Version 2.6, +section 2.3.2, IA-32 Platforms, boot services. + +@section EFI amd64 machine state with boot services enabled + +When the boot loader invokes the 64-bit operating system on EFI amd64 +platform and EFI boot services tag together with EFI amd64 entry address +tag are present in the image Multiboot2 header, the machine must have the +following state: + +@table @samp +@item RAX +Must contain the magic value @samp{0x36d76289}; the presence of this +value indicates to the operating system that it was loaded by a +Multiboot-compliant boot loader (e.g. as opposed to another type of +boot loader that the operating system can also be loaded from). + +@item RBX +Must contain the 64-bit physical address (paging mode is enabled and any +memory space defined by the UEFI memory map is identity mapped, hence, +virtual address equals physical address; Unified Extensible Firmware +Interface Specification, Version 2.6, section 2.3.4, x64 Platforms, boot +services) of the Multiboot2 information structure provided by the boot +loader (@pxref{Boot information format}). +@end table + +All other processor registers, flag bits and state are set accordingly +to Unified Extensible Firmware Interface Specification, Version 2.6, +section 2.3.4, x64 Platforms, boot services. + @node Boot information format @section Boot information @subsection Boot information format -Upon entry to the operating system, the @code{EBX} register contains the -physical address of a @dfn{Multiboot2 information} data structure, +Upon entry to the operating system, the @code{R5/EBX/RBX} register contains +the physical address of a @dfn{Multiboot2 information} data structure, through which the boot loader communicates vital information to the operating system. The operating system can use or ignore any parts of the structure as it chooses; all information passed by the boot loader diff --git a/doc/multiboot2.h b/doc/multiboot2.h index 78337f5..240400d 100644 --- a/doc/multiboot2.h +++ b/doc/multiboot2.h @@ -69,6 +69,8 @@ #define MULTIBOOT_HEADER_TAG_FRAMEBUFFER 5 #define MULTIBOOT_HEADER_TAG_MODULE_ALIGN 6 #define MULTIBOOT_HEADER_TAG_EFI_BS 7 +#define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS_EFI32 8 +#define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS_EFI64 9 #define MULTIBOOT_ARCHITECTURE_I386 0 #define MULTIBOOT_ARCHITECTURE_MIPS32 4