MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h

   1 /** @file
   2
   3 Copyright (c) 2007, 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/BaseMemoryLib.h>
  38 #include <Library/UefiRuntimeServicesTableLib.h>
  39 #include <Library/UefiDriverEntryPoint.h>
  40 #include <Library/UefiBootServicesTableLib.h>
  41 #include <Library/MemoryAllocationLib.h>
  42 #include <Library/IfrSupportLib.h>
  43 #include <Library/ExtendedIfrSupportLib.h>
  44 #include <Library/HiiLib.h>
  45 #include <Library/DevicePathLib.h>
  46
  47 #include "NVDataStruc.h"
  48
  49 //
  50 // This is the generated <AltResp> for defaults defined in VFR
  51 //
  52 extern UINT8 VfrMyIfrNVDataDefault0000[];
  53 extern UINT8 VfrMyIfrNVDataDefault0001[];
  54 extern UINT8 VfrMyIfrNVDataBlockName[];
  55
  56 //
  57 // This is the generated IFR binary data for each formset defined in VFR.
  58 // This data array is ready to be used as input of HiiLibPreparePackageList() to
  59 // create a packagelist (which contains Form packages, String packages, etc).
  60 //
  61 extern UINT8  VfrBin[];
  62 extern UINT8  InventoryBin[];
  63
  64 //
  65 // This is the generated String package data for all .UNI files.
  66 // This data array is ready to be used as input of HiiLibPreparePackageList() to
  67 // create a packagelist (which contains Form packages, String packages, etc).
  68 //
  69 extern UINT8  DriverSampleStrings[];
  70
  71 #define DYNAMIC_ONE_OF_VAR_OFFSET        OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION, DynamicOneof)
  72 #define DYNAMIC_ORDERED_LIST_VAR_OFFSET  OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION, DynamicOrderedList)
  73
  74 #define DRIVER_SAMPLE_PRIVATE_SIGNATURE SIGNATURE_32 ('D', 'S', 'p', 's')
  75
  76 typedef struct {
  77   UINTN                            Signature;
  78
  79   EFI_HANDLE                       DriverHandle[2];
  80   EFI_HII_HANDLE                   HiiHandle[2];
  81   DRIVER_SAMPLE_CONFIGURATION      Configuration;
  82   UINT8                            PasswordState;
  83
  84   //
  85   // Consumed protocol
  86   //
  87   EFI_HII_DATABASE_PROTOCOL        *HiiDatabase;
  88   EFI_HII_STRING_PROTOCOL          *HiiString;
  89   EFI_HII_CONFIG_ROUTING_PROTOCOL  *HiiConfigRouting;
  90   EFI_FORM_BROWSER2_PROTOCOL       *FormBrowser2;
  91
  92   //
  93   // Produced protocol
  94   //
  95   EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;
  96 } DRIVER_SAMPLE_PRIVATE_DATA;
  97
  98 #define DRIVER_SAMPLE_PRIVATE_FROM_THIS(a)  CR (a, DRIVER_SAMPLE_PRIVATE_DATA, ConfigAccess, DRIVER_SAMPLE_PRIVATE_SIGNATURE)
  99
 100 #pragma pack(1)
 101
 102 ///
 103 /// HII specific Vendor Device Path definition.
 104 ///
 105 typedef struct {
 106   VENDOR_DEVICE_PATH             VendorDevicePath;
 107   EFI_DEVICE_PATH_PROTOCOL       End;
 108 } HII_VENDOR_DEVICE_PATH;
 109
 110 #pragma pack()
 111
 112 #endif