SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
4.2.9 subtitle
Subtitle strings are intended to be used by authors to separate sections of questions into semantic
groups.
Example: subtitle text = STR_SUBTITLE_TEXT;
4.2.10 text
Unlike HTML, text is simply another tag. This enables IFR to be more easily localized. The first
example shows a simple usage case where a static string is being printed. The second example shows a
use case which is more complex and allows for a one-time callback to acquire the secondary text data.
The second case is described in more detail in section 4.3.3.
Example: text text = STR_MISCELLANEOUS_TEXT;
Example: text text = STR_MISCELLANEOUS_TEXT;
4.2.11 oneof / endoneof
text = STR_CPU_DERIVED_TEXT,
flags = DYNAMIC,
key = CPU_FREQUENCY_KEY;
This command provides the ability to choose from multiple choices. Each of the choices is defined by
an option statement. To support the ability to reset the user choices to a specific set of defaults, the
flags settings contains a bit-mask which defines which option is defined as a system default and/or a
manufacturing setting.
Note that the flags setting is used to determine which choice is a system default. In the case of
option 3 the flags setting is set for a manufacturing default setting. It is an error condition if more
than one option has the DEFAULT or MANUFACTURING flag turned on.
Also notice that this is the first keyword example that the results of the user’s choice can be reflected
into a NVRAM storage location. See 6.2 to learn more about NVRAM configuration and to better
understand how this works programmatically.
It is also reasonable that a particular option can have both the default and manufacturing bits set. In this
case it would be specified with a flags = DEFAULT | MANUFACTURING.
Example: oneof
varid = NvRamMap.SerialPortQuestion1,
prompt = STR_ONE_OF_PROMPT,
help = STR_ONE_OF_HELP,
option text = STR_SERIAL_PORT1, value=0, flags=NULL;
option text = STR_SERIAL_PORT2, value=1, flags=DEFAULT;
option text = STR_SERIAL_PORT3, value=2, flags=MANUFACTURING;
endoneof;
A second example shows how one would create a oneof command which required dynamic
interaction with a hardware driver. Note from the first example that the key and flags settings are
optional for this command. This example is not compatible with exporting data to runtime, and thus
31