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 #define EFI_IFR_EXTEND_OP_OPTIONKEY   0x5
  60
  61
  62 typedef struct _EFI_IFR_GUID_LABEL {
  63   EFI_IFR_OP_HEADER   Header;
  64   EFI_GUID            Guid;
  65   UINT8               ExtendOpCode;
  66   UINT16              Number;
  67 } EFI_IFR_GUID_LABEL;
  68
  69 #define EFI_IFR_BANNER_ALIGN_LEFT     0
  70 #define EFI_IFR_BANNER_ALIGN_CENTER   1
  71 #define EFI_IFR_BANNER_ALIGN_RIGHT    2
  72
  73 typedef struct _EFI_IFR_GUID_BANNER {
  74   EFI_IFR_OP_HEADER   Header;
  75   EFI_GUID            Guid;
  76   UINT8               ExtendOpCode; // Extended opcode is EFI_IFR_EXTEND_OP_BANNER
  77   EFI_STRING_ID       Title;        // The string token for the banner title
  78   UINT16              LineNumber;   // 1-based line number
  79   UINT8               Alignment;    // left, center, or right-aligned
  80 } EFI_IFR_GUID_BANNER;
  81
  82 typedef struct _EFI_IFR_GUID_TIMEOUT {
  83   EFI_IFR_OP_HEADER   Header;
  84   EFI_GUID            Guid;
  85   UINT8               ExtendOpCode;
  86   UINT16              TimeOut;
  87 } EFI_IFR_GUID_TIMEOUT;
  88
  89 #define EFI_NON_DEVICE_CLASS              0x00
  90 #define EFI_DISK_DEVICE_CLASS             0x01
  91 #define EFI_VIDEO_DEVICE_CLASS            0x02
  92 #define EFI_NETWORK_DEVICE_CLASS          0x04
  93 #define EFI_INPUT_DEVICE_CLASS            0x08
  94 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
  95 #define EFI_OTHER_DEVICE_CLASS            0x20
  96
  97 typedef struct _EFI_IFR_GUID_CLASS {
  98   EFI_IFR_OP_HEADER   Header;
  99   EFI_GUID            Guid;
 100   UINT8               ExtendOpCode;
 101   UINT16              Class;
 102 } EFI_IFR_GUID_CLASS;
 103
 104 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
 105 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
 106 #define EFI_FRONT_PAGE_SUBCLASS           0x02
 107 #define EFI_SINGLE_USE_SUBCLASS           0x03
 108
 109 typedef struct _EFI_IFR_GUID_SUBCLASS {
 110   EFI_IFR_OP_HEADER   Header;
 111   EFI_GUID            Guid;
 112   UINT8               ExtendOpCode;
 113   UINT16              SubClass;
 114 } EFI_IFR_GUID_SUBCLASS;
 115
 116 //
 117 // GUIDed opcodes defined for Tiano
 118 //
 119 #define EFI_IFR_FRAMEWORK_GUID \
 120   { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }
 121
 122 #define EFI_IFR_EXTEND_OP_OPTIONKEY   0x0
 123 #define EFI_IFR_EXTEND_OP_VAREQNAME   0x1
 124
 125 //
 126 // Store the framework vfr option key value
 127 //
 128 typedef struct _EFI_IFR_GUID_OPTIONKEY {
 129   EFI_IFR_OP_HEADER   Header;
 130   EFI_GUID            Guid;
 131   UINT8               ExtendOpCode;
 132   EFI_QUESTION_ID     QuestionId;
 133   EFI_IFR_TYPE_VALUE  OptionValue;
 134   UINT16              KeyValue;
 135 } EFI_IFR_GUID_OPTIONKEY;
 136
 137
 138 //
 139 // Store the framework vfr vareqval name number
 140 //
 141 typedef struct _EFI_IFR_GUID_VAREQNAME {
 142   EFI_IFR_OP_HEADER   Header;
 143   EFI_GUID            Guid;
 144   UINT8               ExtendOpCode;
 145   EFI_QUESTION_ID     QuestionId;
 146   EFI_STRING_ID       NameId;
 147 } EFI_IFR_GUID_VAREQNAME;
 148
 149 #pragma pack()
 150
 151 #endif
 152