From patchwork Thu Nov 24 20:40:02 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Kiper X-Patchwork-Id: 9446273 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 C4F39606DB for ; Thu, 24 Nov 2016 20:43:04 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id B275327FAE for ; Thu, 24 Nov 2016 20:43:04 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id A47C227FB6; Thu, 24 Nov 2016 20:43:04 +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 A085227FAE for ; Thu, 24 Nov 2016 20:43:03 +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 1cA0p7-0001MO-Vv; Thu, 24 Nov 2016 20:40:49 +0000 Received: from mail6.bemta5.messagelabs.com ([195.245.231.135]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cA0p6-0001M1-Kb for xen-devel@lists.xenproject.org; Thu, 24 Nov 2016 20:40:48 +0000 Received: from [85.158.139.211] by server-4.bemta-5.messagelabs.com id B2/C3-22514-F4057385; Thu, 24 Nov 2016 20:40:47 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrDLMWRWlGSWpSXmKPExsUyZ7p8oK5fgHm EwfU7Jhbft0xmcmD0OPzhCksAYxRrZl5SfkUCa8aHrQIFe/kr9j+dz9rA+I6ni5GLQ0igg0ni 5t4HTBDOF0aJ/x87WCCcjYwSbycuY4NwJjJKLJ72mbWLkZODTUBH4uKXh+wgtoiAmcSzmQ2MI EXMApsYJWZumwdWJCyQJtG1toENxGYRUJU48/ExmM0r4C7RNucKE4gtIaAo0f1sAlCcg4NTwE Pi3UdJkLAQUMmlSUcZIUqMJfpm9bFMYORbwMiwilGjOLWoLLVI18hML6koMz2jJDcxM0fX0MB ULze1uDgxPTUnMalYLzk/dxMjMFTqGRgYdzDenux3iFGSg0lJlHezkHmEEF9SfkplRmJxRnxR aU5q8SFGGQ4OJQleMX+gnGBRanpqRVpmDjBoYdISHDxKIryXfIHSvMUFibnFmekQqVOMilLiv M4gfQIgiYzSPLg2WKRcYpSVEuZlZGBgEOIpSC3KzSxBlX/FKM7BqCTMe8IPaApPZl4J3PRXQI uZgBZLfjMGWVySiJCSamCUaMo0OfpZ/cysZca391XcOb3Or89x4y1x+fPMR/zOXuude1PugEV l6Zdoz8KgVW5LpyxgN1jTZm/HfLSsRKvt/Du+zkDuc6e+eNtxsH2KNzH4NWvKsRlx3gqut1P+ /3zBnfq17cPJwkePGz6WStmLTsy13JafNW9FY1q6czjnir7FGhpvV55VYinOSDTUYi4qTgQAd qc0oo8CAAA= X-Env-Sender: daniel.kiper@oracle.com X-Msg-Ref: server-4.tower-206.messagelabs.com!1480020043!72213740!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 50964 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-4.tower-206.messagelabs.com with DHE-RSA-AES256-GCM-SHA384 encrypted SMTP; 24 Nov 2016 20:40:44 -0000 Received: from aserv0021.oracle.com (aserv0021.oracle.com [141.146.126.233]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id uAOKebpG012919 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 24 Nov 2016 20:40:37 GMT Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by aserv0021.oracle.com (8.13.8/8.14.4) with ESMTP id uAOKeaVY000490 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 24 Nov 2016 20:40:37 GMT Received: from abhmp0019.oracle.com (abhmp0019.oracle.com [141.146.116.25]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id uAOKeaeL025465; Thu, 24 Nov 2016 20:40:36 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:36 -0800 From: Daniel Kiper To: grub-devel@gnu.org, xen-devel@lists.xenproject.org Date: Thu, 24 Nov 2016 21:40:02 +0100 Message-Id: <1480020010-18421-4-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: aserv0021.oracle.com [141.146.126.233] 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 03/11] 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 c438b38..771aeab 100644 --- a/doc/multiboot.texi +++ b/doc/multiboot.texi @@ -443,15 +443,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