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 typedef struct {
  33   VENDOR_DEVICE_PATH             VendorDevicePath;
  34   UINT32                         MonotonicCount;
  35 } HII_VENDOR_DEVICE_PATH_NODE;
  36
  37 typedef struct {
  38   HII_VENDOR_DEVICE_PATH_NODE    Node;
  39   EFI_DEVICE_PATH_PROTOCOL       End;
  40 } HII_VENDOR_DEVICE_PATH;
  41
  42
  43 //
  44 // GUIDed opcodes defined for Tiano
  45 //
  46 #define EFI_IFR_TIANO_GUID \
  47   { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
  48
  49
  50 #pragma pack(1)
  51
  52 #define EFI_IFR_EXTEND_OP_LABEL       0x0
  53 #define EFI_IFR_EXTEND_OP_BANNER      0x1
  54 #define EFI_IFR_EXTEND_OP_TIMEOUT     0x2
  55 #define EFI_IFR_EXTEND_OP_CLASS       0x3
  56 #define EFI_IFR_EXTEND_OP_SUBCLASS    0x4
  57
  58 typedef struct _EFI_IFR_GUID_LABEL {
  59   EFI_IFR_OP_HEADER   Header;
  60   EFI_GUID            Guid;
  61   UINT8               ExtendOpCode;
  62   UINT16              Number;
  63 } EFI_IFR_GUID_LABEL;
  64
  65 #define EFI_IFR_BANNER_ALIGN_LEFT     0
  66 #define EFI_IFR_BANNER_ALIGN_CENTER   1
  67 #define EFI_IFR_BANNER_ALIGN_RIGHT    2
  68
  69 typedef struct _EFI_IFR_GUID_BANNER {
  70   EFI_IFR_OP_HEADER   Header;
  71   EFI_GUID            Guid;
  72   UINT8               ExtendOpCode; // Extended opcode is EFI_IFR_EXTEND_OP_BANNER
  73   EFI_STRING_ID       Title;        // The string token for the banner title
  74   UINT16              LineNumber;   // 1-based line number
  75   UINT8               Alignment;    // left, center, or right-aligned
  76 } EFI_IFR_GUID_BANNER;
  77
  78 typedef struct _EFI_IFR_GUID_TIMEOUT {
  79   EFI_IFR_OP_HEADER   Header;
  80   EFI_GUID            Guid;
  81   UINT8               ExtendOpCode;
  82   UINT16              TimeOut;
  83 } EFI_IFR_GUID_TIMEOUT;
  84
  85 #define EFI_NON_DEVICE_CLASS              0x00
  86 #define EFI_DISK_DEVICE_CLASS             0x01
  87 #define EFI_VIDEO_DEVICE_CLASS            0x02
  88 #define EFI_NETWORK_DEVICE_CLASS          0x04
  89 #define EFI_INPUT_DEVICE_CLASS            0x08
  90 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
  91 #define EFI_OTHER_DEVICE_CLASS            0x20
  92
  93 typedef struct _EFI_IFR_GUID_CLASS {
  94   EFI_IFR_OP_HEADER   Header;
  95   EFI_GUID            Guid;
  96   UINT8               ExtendOpCode;
  97   UINT16              Class;
  98 } EFI_IFR_GUID_CLASS;
  99
 100 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
 101 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
 102 #define EFI_FRONT_PAGE_SUBCLASS           0x02
 103 #define EFI_SINGLE_USE_SUBCLASS           0x03
 104
 105 typedef struct _EFI_IFR_GUID_SUBCLASS {
 106   EFI_IFR_OP_HEADER   Header;
 107   EFI_GUID            Guid;
 108   UINT8               ExtendOpCode;
 109   UINT16              SubClass;
 110 } EFI_IFR_GUID_SUBCLASS;
 111
 112 #pragma pack()
 113
 114 #endif
 115