From patchwork Tue Dec 6 22:52:53 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Kiper X-Patchwork-Id: 9463353 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 AFED46074E for ; Tue, 6 Dec 2016 22:57:02 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A1A9427CF5 for ; Tue, 6 Dec 2016 22:57:02 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 946F227D5D; Tue, 6 Dec 2016 22:57: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 4064627D5D for ; Tue, 6 Dec 2016 22:57:02 +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 1cEOcS-0007Od-KA; Tue, 06 Dec 2016 22:53:52 +0000 Received: from mail6.bemta6.messagelabs.com ([193.109.254.103]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cEOcQ-0007Mp-NZ for xen-devel@lists.xenproject.org; Tue, 06 Dec 2016 22:53:50 +0000 Received: from [193.109.254.147] by server-3.bemta-6.messagelabs.com id B4/ED-08948-E7147485; Tue, 06 Dec 2016 22:53:50 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrDLMWRWlGSWpSXmKPExsXSO6nOVbfW0T3 CYM1/fovvWyYzOTB6HP5whSWAMYo1My8pvyKBNaN5SRdLwV7+is8PrrM0ML7j6WLk4hASmMAk 8XnlBUYI5xejxMt/B5ggnA2MEvs33oZyJjBKPN71jq2LkZODTUBH4uKXh+wgtoiAmcSzmQ1g7 cwCBxklmrZtAerg4BAWSJPo+pUGYrIIqEpMPc0LUs4r4C7RvusNWKuEgKJE97MJYCM5BTwk/v z6wwxiCwHVnGi4wApRYyhx+uE2xgmMfAsYGVYxahSnFpWlFukamuolFWWmZ5TkJmbm6BoamOn lphYXJ6an5iQmFesl5+duYgSGCgMQ7GD8tizgEKMkB5OSKK+4gnuEEF9SfkplRmJxRnxRaU5q 8SFGGQ4OJQnenfZAOcGi1PTUirTMHGDQwqQlOHiURHg32QGleYsLEnOLM9MhUqcYFaXEeWtA+ gRAEhmleXBtsEi5xCgrJczLCHSIEE9BalFuZgmq/CtGcQ5GJWHeUyBTeDLzSuCmvwJazAS0+M RxZ5DFJYkIKakGxtaSPWJL60RvW6f7m+m/cgvwTzhRoc5+8Bdr8pyDUzhnhvX9vdH9oGfTcu3 KRkvHhjk1rMlfGGMiv6ZPX9oj/SB+X8O6UnaH/avyUtSXHIo5KbEykqOr7aXJxRs2gSprZqzh fZHGuMKhWvHru+qXgmYBby4bO17d672s79aD/8fTV7x79bP0nRJLcUaioRZzUXEiABx9qQmPA gAA X-Env-Sender: daniel.kiper@oracle.com X-Msg-Ref: server-5.tower-27.messagelabs.com!1481064827!76100493!1 X-Originating-IP: [141.146.126.69] X-SpamReason: No, hits=0.0 required=7.0 tests=sa_preprocessor: VHJ1c3RlZCBJUDogMTQxLjE0Ni4xMjYuNjkgPT4gMjc3MjE4\n X-StarScan-Received: X-StarScan-Version: 9.0.16; banners=-,-,- X-VirusChecked: Checked Received: (qmail 26267 invoked from network); 6 Dec 2016 22:53:48 -0000 Received: from aserp1040.oracle.com (HELO aserp1040.oracle.com) (141.146.126.69) by server-5.tower-27.messagelabs.com with DHE-RSA-AES256-GCM-SHA384 encrypted SMTP; 6 Dec 2016 22:53:48 -0000 Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id uB6Mrhbs003132 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 6 Dec 2016 22:53:43 GMT Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by userv0021.oracle.com (8.14.4/8.14.4) with ESMTP id uB6Mrh3d009726 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 6 Dec 2016 22:53:43 GMT Received: from abhmp0009.oracle.com (abhmp0009.oracle.com [141.146.116.15]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id uB6Mrg7d026039; Tue, 6 Dec 2016 22:53:42 GMT Received: from olila.local.net-space.pl (/10.175.227.19) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Tue, 06 Dec 2016 14:53:41 -0800 From: Daniel Kiper To: grub-devel@gnu.org, xen-devel@lists.xenproject.org Date: Tue, 6 Dec 2016 23:52:53 +0100 Message-Id: <1481064781-16949-6-git-send-email-daniel.kiper@oracle.com> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1481064781-16949-1-git-send-email-daniel.kiper@oracle.com> References: <1481064781-16949-1-git-send-email-daniel.kiper@oracle.com> X-Source-IP: userv0021.oracle.com [156.151.31.71] Cc: jgross@suse.com, eric.snowberg@oracle.com, arvidjaar@gmail.com, andrew.cooper3@citrix.com, tsoome@me.com, seth.goldberg@oracle.com, phcoder@gmail.com Subject: [Xen-devel] [MULTIBOOT2 DOC PATCH v3 05/13] multiboot2: Clarify meaning of information request header tag 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: - rephrase some sentences (suggested by Andrew Cooper), - add missing the articles (suggested by Andrew Cooper). --- doc/multiboot.texi | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/multiboot.texi b/doc/multiboot.texi index a9cba9b..4f838f0 100644 --- a/doc/multiboot.texi +++ b/doc/multiboot.texi @@ -437,15 +437,19 @@ u32[n] | mbi_tag_types | @end group @end example -@samp{mbi_tag_types} is an array of u32 each one representing an information -request -If this tag is present and @samp{optional} is set to @samp{0} information -conveyed by requested tag types must be present. If bootloader is unable -to supply this information it must fail with an error +@samp{mbi_tag_types} is an array of u32's, each one representing an information request. -Note: it doesn't garantee that any tags of type @samp{mbi_tag_types} will -actually be present. E.g. on a videoless system even if you requested tag -@samp{8} no tags of type @samp{8} will be present in mbi. +If this tag is present and @samp{optional} is set to @samp{0}, the bootloader must +support the requested tag and be able to provide relevant information to the image +if it is available. If the bootloader does not understand the meaning of the requested +tag it must fail with an error. However, if it supports a given tag but the information +conveyed by it is not available the bootloader does not provide the requested tag in +the Multiboot2 information structure and passes control to the loaded image as usual. + +Note: The above means that there is no guarantee that any tags of type @samp{mbi_tag_types} +will actually be present. E.g. on a videoless system even if you requested tag @samp{8} +and the bootloader supports it, no tags of type @samp{8} will be present in the Multiboot2 +information structure. @node Address header tag