MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h

   1 /** @file
   2
   3 Copyright (c) 2007 - 2009, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   DriverSample.h
  15
  16 Abstract:
  17
  18
  19 Revision History
  20
  21
  22 **/
  23
  24 #ifndef _DRIVER_SAMPLE_H_
  25 #define _DRIVER_SAMPLE_H_
  26
  27 #include <Uefi.h>
  28
  29 #include <Protocol/HiiConfigRouting.h>
  30 #include <Protocol/FormBrowser2.h>
  31 #include <Protocol/HiiConfigAccess.h>
  32 #include <Protocol/HiiDatabase.h>
  33 #include <Protocol/HiiString.h>
  34
  35 #include <Guid/MdeModuleHii.h>
  36 #include <Library/DebugLib.h>
  37 #include <Library/BaseLib.h>
  38 #include <Library/BaseMemoryLib.h>
  39 #include <Library/UefiRuntimeServicesTableLib.h>
  40 #include <Library/UefiDriverEntryPoint.h>
  41 #include <Library/UefiBootServicesTableLib.h>
  42 #include <Library/MemoryAllocationLib.h>
  43 #include <Library/HiiLib.h>
  44 #include <Library/DevicePathLib.h>
  45 #include <Library/PrintLib.h>
  46 #include <Library/UefiLib.h>
  47
  48 #include "NVDataStruc.h"
  49
  50 //
  51 // This is the generated IFR binary data for each formset defined in VFR.
  52 // This data array is ready to be used as input of HiiAddPackages() to
  53 // create a packagelist (which contains Form packages, String packages, etc).
  54 //
  55 extern UINT8  VfrBin[];
  56 extern UINT8  InventoryBin[];
  57
  58 //
  59 // This is the generated String package data for all .UNI files.
  60 // This data array is ready to be used as input of HiiAddPackages() to
  61 // create a packagelist (which contains Form packages, String packages, etc).
  62 //
  63 extern UINT8  DriverSampleStrings[];
  64
  65 #define DYNAMIC_ONE_OF_VAR_OFFSET        OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION, DynamicOneof)
  66 #define DYNAMIC_ORDERED_LIST_VAR_OFFSET  OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION, DynamicOrderedList)
  67
  68 //
  69 // Number of name in Name/Value storage
  70 //
  71 #define NAME_VALUE_NAME_NUMBER       3
  72
  73 #define DRIVER_SAMPLE_PRIVATE_SIGNATURE SIGNATURE_32 ('D', 'S', 'p', 's')
  74
  75 typedef struct {
  76   UINTN                            Signature;
  77
  78   EFI_HANDLE                       DriverHandle[2];
  79   EFI_HII_HANDLE                   HiiHandle[2];
  80   DRIVER_SAMPLE_CONFIGURATION      Configuration;
  81   UINT8                            PasswordState;
  82
  83   //
  84   // Name/Value storage Name list
  85   //
  86   EFI_STRING_ID                    NameStringId[NAME_VALUE_NAME_NUMBER];
  87   EFI_STRING                       NameValueName[NAME_VALUE_NAME_NUMBER];
  88
  89   //
  90   // Consumed protocol
  91   //
  92   EFI_HII_DATABASE_PROTOCOL        *HiiDatabase;
  93   EFI_HII_STRING_PROTOCOL          *HiiString;
  94   EFI_HII_CONFIG_ROUTING_PROTOCOL  *HiiConfigRouting;
  95   EFI_FORM_BROWSER2_PROTOCOL       *FormBrowser2;
  96
  97   //
  98   // Produced protocol
  99   //
 100   EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;
 101 } DRIVER_SAMPLE_PRIVATE_DATA;
 102
 103 #define DRIVER_SAMPLE_PRIVATE_FROM_THIS(a)  CR (a, DRIVER_SAMPLE_PRIVATE_DATA, ConfigAccess, DRIVER_SAMPLE_PRIVATE_SIGNATURE)
 104
 105 #pragma pack(1)
 106
 107 ///
 108 /// HII specific Vendor Device Path definition.
 109 ///
 110 typedef struct {
 111   VENDOR_DEVICE_PATH             VendorDevicePath;
 112   EFI_DEVICE_PATH_PROTOCOL       End;
 113 } HII_VENDOR_DEVICE_PATH;
 114
 115 #pragma pack()
 116
 117 #endif