Lines Matching refs:the
3 the compiler, header files for the UPD regions, and generates a Boot Settings
17 1. It produces a **.txt** file that is used by the compiler that summarizes
18 the UPD section in the DSC file.
19 2. It generates header files for the UPD regions.
20 3. It generates a **Boot Settings File (BSF)** that can be used by the
22 interface for manipulating settings in the UPD regions.
26 the **'build'** command; the **GENBSF** use case may be done at any time.
28 The following sections explain the three use cases.
31 The **UPDTXT** option creates a text file with all the UPD entries, offsets,
32 size in bytes, and values. **GenCfgOpt** reads this information from the
33 **[PcdsDynamicVpd.Upd]** section of the project's DSC file. The DSC file allows
34 you to specify offsets and sizes for each entry, opening up the possibility of
36 entries that have the generic names **UnusedUpdSpaceN** where N begins with 0
43 **PlatformDscFile** must be the location of the DSC file for the platform you're
44 building. **BuildFvDir** is the location where the binary will be stored. The
45 optional **TxtOutFile** is a name and location for the output of **GenCfgOpt**.
46 The default name and location is the ```<UPD_TOOL_GUID>.txt``` in the directory
48 the DSC file or in the optional Macros arguments. Each optional macro argument
49 must follow the form ```?D <MACRO_NAME>=<VALUE>```.
51 **GenCfgOpt** checks to see if the UPD txt file has already been created and
52 will only re-create it if the DSC was modified after it was created.
55 The **HEADER** option creates header files in the build folder. Both header
56 files define the ```_UPD_DATA_REGION``` data structures in FspUpd.h, FsptUpd.h,
63 **PlatformDscFile** and **BuildFvDir** are described in the previous section.
65 that are used by variables in the UPD regions. This header file must contain
66 the special keywords ```!EXPORT EXTERNAL_BOOTLOADER_STRUCT_BEGIN``` and
68 these two keywords will be included in the generated header file.
70 the FspUpd.h header file is in special commands that appear in the comments of
71 the DSC file. The special commands begin with ```!HDR```, for header. The
72 following table summarizes the two command options.
75 Use the **HEADER** command to hide specific variables in the public header file.
76 In your project DSC file, use ```!HDR HEADER:{OFF}``` at the beginning of the
77 section you wish to hide and ```!HDR HEADER:{ON}``` at the end.
82 the data structure in the **InputHFile** between
94 start and an end for the specify data structure.
129 The **GENBSF** option generates a BSF from the UPD entries in a package's DSC
130 file. It does this by parsing special commands found in the comments of the DSC
131 file. They roughly match the keywords that define the different sections of the
138 In this case, the **BsfOutFile** parameter is required; it should be the
139 relative path to where the BSF should be stored.
141 Every BSF command in the DSC file begins with **!BSF** or **@Bsf**. The
142 following table summarizes the options that come after **!BSF** or **@Bsf**:
146 **PAGES** maps abbreviations to friendly-text descriptions of the pages in a BSF.
154 This marks the beginning of a page. Use the abbreviation specified in **PAGES**
162 All the entries that come after this command are assumed to be on that page,
163 until the next **PAGE** command
166 FIND maps to the BSF **Find** command. It will be placed in the **StructDef**
167 region of the BSF and should come at the beginning of the UPD sections of the
168 DSC, immediately before the signatures that mark the beginning of these
169 sections. The content should be the plain-text equivalent of the signature. The
178 The BLOCK command maps to the **BeginInfoBlock** section of the BSF. There are
187 **NAME** gives a plain-text for a variable. This is the text label that will
188 appear next to the control in **BCT**.
195 If the **!BSF NAME** or **@Bsf NAME** command does not appear before an entry
196 in the UPD region of the DSC file, then that entry will not appear in the BSF.
199 The **TYPE** command is used either by itself or with the **NAME** command. It
200 is usually used by itself when defining an **EditNum** field for the BSF. You
201 specify the type of data in the second parameter and the range of valid values
202 in the third.
209 **TYPE** appears on the same line as the **NAME** command when using a combo-box.
215 There is a special **None** type that puts the variable in the **StructDef**
216 region of the BSF, but doesn?t put it in any **Page** section. This makes the
217 variable visible to BCT, but not to the end user.
220 The **HELP** command defines what will appear in the help text for each control
245 such that the PCD will be displayed in several fields via BCT interface instead
254 The **ORDER** command can be used to adjust the display order for the BSF items.
255 By default the order value for a BSF item is assigned to be the UPD item
257 format ORDER: ```{HexMajor.HexMinor}```. In this case the order value will be
258 ```(HexMajor*256+HexMinor)```. The item order value will be used as the sort key
259 during the BSF item display.
266 For **OPTION** and **HELP** commands, it allows to split the contents into
268 lines except for the very first line need to start with **+** in the content to
269 tell the tool to append this string to the previous one.
271 For example, the statement
291 The **NAME**, **OPTION**, **TYPE**, and **HELP** commands can all appear on the
292 same line following the **!BSF** or **@Bsf** keyword or they may appear on
298 variable. This is the text label that will appear next to the control in BCT.
303 The above example can replace the two methods as below.
309 If the ```# @Prompt``` command does not appear before an entry in the UPD region
310 of the DSC file, then that entry will not appear in the BSF.
313 An alternative way replacing **HELP** command defines what will appear in the
319 The above example can replace the two methods as below.
334 The above example can replace the two methods as below.
341 An alternative way replace **EditNum** field for the BSF.
348 The above example can replace the two methods as below.