SetupDesignGuide.pdf - Firmware Encoding Index

More documents

Recommendations

Info

Setup Design Guide DRAFT 6 Setup Driver Considerations 6.1 Pre-boot Operation versus Runtime Operation Due to the static nature of the data contained in the HII Database and the capacity to update NVRAM variables, the pre-boot configuration data can be effectively used during O/S runtime. This allows the same configuration mechanisms to be used in pre-boot as well as in runtime. Some thought needs to be given when designing the overall requirements associated with a setup application with regards to the type of data that is needed and it’s hardware interaction requirements. For additional information about hardware interaction see section 2.6. If some of the questions associated with a setup environment require a high level of hardware interaction, it might make sense to design the user interface flow in the VFR such that these types of questions are isolated. The reason for this is that when this data is exported to a runtime presence, it may not make any sense in that environment. For instance if there were a page which contained some diagnostic type of interactions which are not reasonable in a runtime environment the user experience of that page may not be desirable. 6.2 How to allocate and steer data to NV storage The file which contains the global data primarily consists of a series of #define values and the definition of the NV mapping descriptors. This file is intended to be used as an include file both for VFR purposes as well as a ‘C’ syntax include file for drivers that are built to support the EFI setup infrastructure. There NV mapping descriptors take the form of structure declarations in this definition file. Each piece of data that can be changed in the configuration needs to be saved. For each of these data items, there will be a structure member. To support the ability to store data in multiple physical locations, one needs to be able to specify which data items will reside in which NV storage location. A common scenario would be that a developer might have the results of many questions reside in the systemboard NVRAM, yet some of the questions might reside in another NV storage location. To differentiate between which is the system store and which is the alternate store the VFR_NV_KEY macro is used in the structure definition. The VFR compiler will read the structure that has the macro with a 0 input as the system store descriptor. All structures with non-zero macro inputs are going to be considered to be non-system storage descriptors. A sample VFR entry which declares a system NV store descriptor might look like the following entry: nvstorage handle = NULL, devicepath = NULL, key = NvRamMapKey; A sample VFR entry which declares a non-system NV store descriptor might look like the following entry: nvstorage handle = 1, 44
Setup Design Guide DRAFT devicepath = 1, key = RaidControllerNvDataKey; For additional information on the nvstorage command see section 4.2.7. The following snapshot is from the definition file containing the #define values as well as the NV structure definitions. This example shows a structure NvRamMap with the VFR_NV_KEY macro. The macro uses an NvRamMapKey which has a definition of 0. This then defines a system NV store structure. Followed immediately after it is a RaidControllerNvData structure definition with the same macro and the RaidControllerNvDataKey. Since the macro input evaluates to a non-zero value, it by definition is defining a non-system NV store structure. #define NvRamMapKey 0 #define RaidControllerNvDataKey 1 struct { UINT16 SystemPassword[20]; UINT16 ModemInitializationString[60]; UINT8 SerialPortEnable; UINT16 SamplePieceOfData; UINT32 MyFavoriteNumber; } NvRamMap VFR_NV_KEY(NvRamMapKey); struct { UINT16 SamplePieceOfData; UINT32 MyFavoriteNumber; } RaidControllerNvData VFR_NV_KEY(RaidControllerNvDataKey); 45
Page 1 and 2: Tiano Setup Design Guide Draft for
Page 3 and 4: Setup Design Guide DRAFT Revision H
Page 5 and 6: DRAFT 4.3 5 User Interface Design..
Page 7 and 8: DRAFT 1 Introduction 1.1 Scope This
Page 9 and 10: DRAFT RTC: Real Time Clock. The pie
Page 11: DRAFT Description: Status Codes Ret
Page 14 and 15: Setup Design Guide DRAFT VFR source
Page 16 and 17: Setup Design Guide DRAFT 2.1.5 HII
Page 18 and 19: Setup Design Guide DRAFT Human Inte
Page 20 and 21: Setup Design Guide DRAFT Human Inte
Page 22 and 23: Setup Design Guide DRAFT The driver
Page 24 and 25: Setup Design Guide DRAFT 3 Setup Bu
Page 26 and 27: Setup Design Guide DRAFT #define IF
Page 28 and 29: Setup Design Guide DRAFT ::= oneof
Page 30 and 31: Setup Design Guide DRAFT #strdef SP
Page 32 and 33: Setup Design Guide DRAFT should onl
Page 34 and 35: Setup Design Guide DRAFT 4.2.15 tim
Page 36 and 37: Setup Design Guide DRAFT 4.2.18 got
Page 38 and 39: Setup Design Guide DRAFT This keywo
Page 40 and 41: Setup Design Guide DRAFT 5 User Int
Page 42 and 43: Setup Design Guide DRAFT The area b
Page 46 and 47: Setup Design Guide DRAFT 7 HII Data
Page 48 and 49: Setup Design Guide DRAFT Related De
Page 50 and 51: Setup Design Guide DRAFT // // A fo
Page 52 and 53: Setup Design Guide DRAFT 7.1.1 EFI_
Page 62 and 63: Setup Design Guide DRAFT 7.1.10 EFI
Page 72 and 73: Setup Design Guide DRAFT 7.3 EFI Fo
Page 74 and 75: Setup Design Guide DRAFT EFI_SUCCES
Page 78 and 79: Setup Design Guide DRAFT 8 Simple I
Page 80 and 81: Setup Design Guide DRAFT 9 HII Keyb
Page 82 and 83: Setup Design Guide DRAFT // #define
Page 84 and 85: Setup Design Guide DRAFT accent key
Page 86: Setup Design Guide DRAFT proceeded

SetupDesignGuide.pdf - Firmware Encoding Index

Create successful ePaper yourself

Delete template?

Save as template?