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 <PiDxe.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 <Library/DebugLib.h>
  36 #include <Library/BaseMemoryLib.h>
  37 #include <Library/UefiRuntimeServicesTableLib.h>
  38 #include <Library/UefiDriverEntryPoint.h>
  39 #include <Library/UefiBootServicesTableLib.h>
  40 #include <Library/MemoryAllocationLib.h>
  41 #include <Library/IfrSupportLib.h>
  42 #include <Library/HiiLib.h>
  43
  44 #include <MdeModuleHii.h>
  45
  46
  47 #include "NVDataStruc.h"
  48
  49 //
  50 // This is the generated <AltResp> for defaults defined in VFR
  51 //
  52 extern UINT8 VfrMyIfrNVDataDefault0000[];
  53
  54 //
  55 // This is the generated IFR binary data for each formset defined in VFR.
  56 // This data array is ready to be used as input of PreparePackageList() to
  57 // create a packagelist (which contains Form packages, String packages, etc).
  58 //
  59 extern UINT8  VfrBin[];
  60 extern UINT8  InventoryBin[];
  61
  62 //
  63 // This is the generated String package data for all .UNI files.
  64 // This data array is ready to be used as input of PreparePackageList() to
  65 // create a packagelist (which contains Form packages, String packages, etc).
  66 //
  67 extern UINT8  DriverSampleStrings[];
  68
  69 #define SAMPLE_STRING               L"This is an error!"
  70
  71 #define DRIVER_SAMPLE_PRIVATE_SIGNATURE EFI_SIGNATURE_32 ('D', 'S', 'p', 's')
  72
  73 typedef struct {
  74   UINTN                            Signature;
  75
  76   EFI_HANDLE                       DriverHandle[2];
  77   EFI_HII_HANDLE                   HiiHandle[2];
  78   DRIVER_SAMPLE_CONFIGURATION      Configuration;
  79   UINT8                            PasswordState;
  80
  81   //
  82   // Consumed protocol
  83   //
  84   EFI_HII_DATABASE_PROTOCOL        *HiiDatabase;
  85   EFI_HII_STRING_PROTOCOL          *HiiString;
  86   EFI_HII_CONFIG_ROUTING_PROTOCOL  *HiiConfigRouting;
  87   EFI_FORM_BROWSER2_PROTOCOL       *FormBrowser2;
  88
  89   //
  90   // Produced protocol
  91   //
  92   EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;
  93 } DRIVER_SAMPLE_PRIVATE_DATA;
  94
  95 #define DRIVER_SAMPLE_PRIVATE_FROM_THIS(a)  CR (a, DRIVER_SAMPLE_PRIVATE_DATA, ConfigAccess, DRIVER_SAMPLE_PRIVATE_SIGNATURE)
  96
  97 #endif