public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Michael Kinney <michael.d.kinney@intel.com>
To: edk2-devel@lists.01.org
Cc: Liming Gao <liming.gao@intel.com>,
	Yonghong Zhu <yonghong.zhu@intel.com>,
	Kevin W Shaw <kevin.w.shaw@intel.com>
Subject: [edk2-BuildSpecification PATCH] Clarify alignment requirements for VPD VOID* PCDs
Date: Mon, 17 Apr 2017 21:41:08 -0700	[thread overview]
Message-ID: <1492490468-23216-2-git-send-email-michael.d.kinney@intel.com> (raw)
In-Reply-To: <1492490468-23216-1-git-send-email-michael.d.kinney@intel.com>

https://bugzilla.tianocore.org/show_bug.cgi?id=490

Clarify when error or warning messages are generated
for VOID* PCDs when VPD offset is not aligned.
Unicode string VPD PCDs must be 2-byte aligned.
Byte array {} VPD PCDs should be 8-byte aligned,
but is only a warning message if they are not 8-byte
aligned. All other data types only require
byte-alignment.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 7_build_environment/73_guided_tools.md | 16 ++++++++++++++--
 README.md                              |  1 +
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/7_build_environment/73_guided_tools.md b/7_build_environment/73_guided_tools.md
index 878ae33..a8881d3 100644
--- a/7_build_environment/73_guided_tools.md
+++ b/7_build_environment/73_guided_tools.md
@@ -123,8 +123,20 @@ file required by the build system is provided in the appendix, VPD Tool.
 
   * ASCII strings, "string", will be byte aligned.
   * Unicode strings, L"string" will be two-byte aligned.
-  * Byte arrays, {0x00, 0x01} will be 8-byte aligned. If the developer assigns
-    offset values in the DSC file, the developer must follow the same rules.
+  * Byte arrays, {0x00, 0x01} will be 8-byte aligned.
+
+  If the developer manually assigns offset values in the DSC file, the developer
+  must follow the same rules.
+
+  **********
+  **Note:** If a developer manually sets the offset of a `VOID*` PCD with
+  Unicode string, L"string", style to a value that is not 2-byte aligned, then
+  an error is generated and the build halts.
+  **********
+  **Note:** If a developer manually sets the offset of a `VOID*` PCD with byte
+  array {} style to a value that is not 8-byte aligned, then a warning is
+  generated, but the build will continue.
+  **********
 
 2. Modify the FDF file:
 
diff --git a/README.md b/README.md
index 71c4511..8542434 100644
--- a/README.md
+++ b/README.md
@@ -203,3 +203,4 @@ Copyright (c) 2008-2017, Intel Corporation. All rights reserved.
 | 1.27       | Convert to Gitbook                                                                                                                                                                                                                                                                                                                                                  | April 2017    |
 |            | [#471](https://bugzilla.tianocore.org/show_bug.cgi?id=471) Build spec: only copy the "TianoCore" Userextension section into "As Built" INF                                                                                                                                                                                                                          |               |
 |            | [#472](https://bugzilla.tianocore.org/show_bug.cgi?id=472) [Build Spec] Extend macro usage in the !include statements for DSC/FDF files                                                                                                                                                                                                                             |               |
+|            | [#490](https://bugzilla.tianocore.org/show_bug.cgi?id=490) Build Spec: specify the alignment requirements for VOID* PCDs stored in a PCD section                                                                                                                                                                                                                    |               |
-- 
2.6.3.windows.1



  reply	other threads:[~2017-04-18  4:41 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-18  4:41 [edk2-BuildSpecification PATCH] Clarify alignment requirements for VPD VOID* PCDs Michael Kinney
2017-04-18  4:41 ` Michael Kinney [this message]
2017-04-18  5:24   ` Zhu, Yonghong

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-list 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=1492490468-23216-2-git-send-email-michael.d.kinney@intel.com \
    --to=devel@edk2.groups.io \
    /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