MdeModulePkg/Include/MdeModuleHii.h

   1 /* @file
   2
   3   EDK II specific HII relative definition.
   4
   5 Copyright (c) 2006 - 2007, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _MDEMODULE_HII_H
  17 #define _MDEMODULE_HII_H
  18
  19 #define NARROW_CHAR         0xFFF0
  20 #define WIDE_CHAR           0xFFF1
  21 #define NON_BREAKING_CHAR   0xFFF2
  22
  23 #define GLYPH_WIDTH         EFI_GLYPH_WIDTH
  24 #define GLYPH_HEIGHT        EFI_GLYPH_HEIGHT
  25
  26 //
  27 // State defined for password statemachine
  28 //
  29 #define BROWSER_STATE_VALIDATE_PASSWORD  0
  30 #define BROWSER_STATE_SET_PASSWORD       1
  31
  32
  33 //
  34 // Tiano Implementation specific Device Path definition.
  35 //
  36 typedef struct {
  37   VENDOR_DEVICE_PATH             VendorDevicePath;
  38   UINT32                         MonotonicCount;
  39 } HII_VENDOR_DEVICE_PATH_NODE;
  40
  41 typedef struct {
  42   HII_VENDOR_DEVICE_PATH_NODE    Node;
  43   EFI_DEVICE_PATH_PROTOCOL       End;
  44 } HII_VENDOR_DEVICE_PATH;
  45
  46
  47 //
  48 // References to string tokens must use this macro to enable scanning for
  49 // token usages.
  50 //
  51 #define STRING_TOKEN(t) t
  52
  53 //
  54 // GUIDed opcodes defined for Tiano
  55 //
  56 #define EFI_IFR_TIANO_GUID \
  57   { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
  58
  59
  60 #pragma pack(1)
  61
  62 #define EFI_IFR_EXTEND_OP_LABEL       0x0
  63 #define EFI_IFR_EXTEND_OP_BANNER      0x1
  64 #define EFI_IFR_EXTEND_OP_TIMEOUT     0x2
  65 #define EFI_IFR_EXTEND_OP_CLASS       0x3
  66 #define EFI_IFR_EXTEND_OP_SUBCLASS    0x4
  67
  68 typedef struct _EFI_IFR_GUID_LABEL {
  69   EFI_IFR_OP_HEADER   Header;
  70   EFI_GUID            Guid;
  71   UINT8               ExtendOpCode;
  72   UINT16              Number;
  73 } EFI_IFR_GUID_LABEL;
  74
  75 #define EFI_IFR_BANNER_ALIGN_LEFT     0
  76 #define EFI_IFR_BANNER_ALIGN_CENTER   1
  77 #define EFI_IFR_BANNER_ALIGN_RIGHT    2
  78
  79 typedef struct _EFI_IFR_GUID_BANNER {
  80   EFI_IFR_OP_HEADER   Header;
  81   EFI_GUID            Guid;
  82   UINT8               ExtendOpCode; // Extended opcode is EFI_IFR_EXTEND_OP_BANNER
  83   EFI_STRING_ID       Title;        // The string token for the banner title
  84   UINT16              LineNumber;   // 1-based line number
  85   UINT8               Alignment;    // left, center, or right-aligned
  86 } EFI_IFR_GUID_BANNER;
  87
  88 typedef struct _EFI_IFR_GUID_TIMEOUT {
  89   EFI_IFR_OP_HEADER   Header;
  90   EFI_GUID            Guid;
  91   UINT8               ExtendOpCode;
  92   UINT16              TimeOut;
  93 } EFI_IFR_GUID_TIMEOUT;
  94
  95 #define EFI_NON_DEVICE_CLASS              0x00
  96 #define EFI_DISK_DEVICE_CLASS             0x01
  97 #define EFI_VIDEO_DEVICE_CLASS            0x02
  98 #define EFI_NETWORK_DEVICE_CLASS          0x04
  99 #define EFI_INPUT_DEVICE_CLASS            0x08
 100 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
 101 #define EFI_OTHER_DEVICE_CLASS            0x20
 102
 103 typedef struct _EFI_IFR_GUID_CLASS {
 104   EFI_IFR_OP_HEADER   Header;
 105   EFI_GUID            Guid;
 106   UINT8               ExtendOpCode;
 107   UINT16              Class;
 108 } EFI_IFR_GUID_CLASS;
 109
 110 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
 111 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
 112 #define EFI_FRONT_PAGE_SUBCLASS           0x02
 113 #define EFI_SINGLE_USE_SUBCLASS           0x03
 114
 115 typedef struct _EFI_IFR_GUID_SUBCLASS {
 116   EFI_IFR_OP_HEADER   Header;
 117   EFI_GUID            Guid;
 118   UINT8               ExtendOpCode;
 119   UINT16              SubClass;
 120 } EFI_IFR_GUID_SUBCLASS;
 121
 122 #pragma pack()
 123
 124 #endif
 125