MdeModulePkg/Include/MdeModuleHii.h

   1 /** @file
   2   EDK II implementation specific HII relative definition.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __MDEMODULE_HII_H__
  16 #define __MDEMODULE_HII_H__
  17
  18 #define NARROW_CHAR         0xFFF0
  19 #define WIDE_CHAR           0xFFF1
  20 #define NON_BREAKING_CHAR   0xFFF2
  21
  22 //
  23 // State defined for password statemachine
  24 //
  25 #define BROWSER_STATE_VALIDATE_PASSWORD  0
  26 #define BROWSER_STATE_SET_PASSWORD       1
  27
  28
  29 //
  30 // Tiano Implementation specific Device Path definition.
  31 //
  32 #pragma pack(1)
  33 typedef struct {
  34   VENDOR_DEVICE_PATH             VendorDevicePath;
  35   UINT32                         Reserved;
  36   UINT64                         UniqueId;
  37 } HII_VENDOR_DEVICE_PATH_NODE;
  38 #pragma pack()
  39
  40 typedef struct {
  41   HII_VENDOR_DEVICE_PATH_NODE    Node;
  42   EFI_DEVICE_PATH_PROTOCOL       End;
  43 } HII_VENDOR_DEVICE_PATH;
  44
  45
  46 //
  47 // GUIDed opcodes defined for Tiano
  48 //
  49 #define EFI_IFR_TIANO_GUID \
  50   { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
  51
  52 #pragma pack(1)
  53
  54 #define EFI_IFR_EXTEND_OP_LABEL       0x0
  55 #define EFI_IFR_EXTEND_OP_BANNER      0x1
  56 #define EFI_IFR_EXTEND_OP_TIMEOUT     0x2
  57 #define EFI_IFR_EXTEND_OP_CLASS       0x3
  58 #define EFI_IFR_EXTEND_OP_SUBCLASS    0x4
  59
  60
  61 typedef struct _EFI_IFR_GUID_LABEL {
  62   EFI_IFR_OP_HEADER   Header;
  63   EFI_GUID            Guid;
  64   UINT8               ExtendOpCode;
  65   UINT16              Number;
  66 } EFI_IFR_GUID_LABEL;
  67
  68 #define EFI_IFR_BANNER_ALIGN_LEFT     0
  69 #define EFI_IFR_BANNER_ALIGN_CENTER   1
  70 #define EFI_IFR_BANNER_ALIGN_RIGHT    2
  71
  72 typedef struct _EFI_IFR_GUID_BANNER {
  73   EFI_IFR_OP_HEADER   Header;
  74   EFI_GUID            Guid;
  75   UINT8               ExtendOpCode; // Extended opcode is EFI_IFR_EXTEND_OP_BANNER
  76   EFI_STRING_ID       Title;        // The string token for the banner title
  77   UINT16              LineNumber;   // 1-based line number
  78   UINT8               Alignment;    // left, center, or right-aligned
  79 } EFI_IFR_GUID_BANNER;
  80
  81 typedef struct _EFI_IFR_GUID_TIMEOUT {
  82   EFI_IFR_OP_HEADER   Header;
  83   EFI_GUID            Guid;
  84   UINT8               ExtendOpCode;
  85   UINT16              TimeOut;
  86 } EFI_IFR_GUID_TIMEOUT;
  87
  88 #define EFI_NON_DEVICE_CLASS              0x00
  89 #define EFI_DISK_DEVICE_CLASS             0x01
  90 #define EFI_VIDEO_DEVICE_CLASS            0x02
  91 #define EFI_NETWORK_DEVICE_CLASS          0x04
  92 #define EFI_INPUT_DEVICE_CLASS            0x08
  93 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
  94 #define EFI_OTHER_DEVICE_CLASS            0x20
  95
  96 typedef struct _EFI_IFR_GUID_CLASS {
  97   EFI_IFR_OP_HEADER   Header;
  98   EFI_GUID            Guid;
  99   UINT8               ExtendOpCode;
 100   UINT16              Class;
 101 } EFI_IFR_GUID_CLASS;
 102
 103 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
 104 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
 105 #define EFI_FRONT_PAGE_SUBCLASS           0x02
 106 #define EFI_SINGLE_USE_SUBCLASS           0x03
 107
 108 typedef struct _EFI_IFR_GUID_SUBCLASS {
 109   EFI_IFR_OP_HEADER   Header;
 110   EFI_GUID            Guid;
 111   UINT8               ExtendOpCode;
 112   UINT16              SubClass;
 113 } EFI_IFR_GUID_SUBCLASS;
 114
 115 //
 116 // GUIDed opcodes defined for framework vfr.
 117 //
 118 #define EFI_IFR_FRAMEWORK_GUID \
 119   { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }
 120
 121 #define EFI_IFR_EXTEND_OP_OPTIONKEY   0x0
 122 #define EFI_IFR_EXTEND_OP_VAREQNAME   0x1
 123
 124 //
 125 // Store the framework vfr option key value
 126 //
 127 typedef struct _EFI_IFR_GUID_OPTIONKEY {
 128   EFI_IFR_OP_HEADER   Header;
 129   EFI_GUID            Guid;
 130   UINT8               ExtendOpCode;
 131   EFI_QUESTION_ID     QuestionId;
 132   EFI_IFR_TYPE_VALUE  OptionValue;
 133   UINT16              KeyValue;
 134 } EFI_IFR_GUID_OPTIONKEY;
 135
 136
 137 //
 138 // Store the framework vfr vareqval name number
 139 //
 140 typedef struct _EFI_IFR_GUID_VAREQNAME {
 141   EFI_IFR_OP_HEADER   Header;
 142   EFI_GUID            Guid;
 143   UINT8               ExtendOpCode;
 144   EFI_QUESTION_ID     QuestionId;
 145   EFI_STRING_ID       NameId;
 146 } EFI_IFR_GUID_VAREQNAME;
 147
 148 #pragma pack()
 149
 150 #endif
 151