MdeModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.h

   1 /** @file
   2   The platform device manager reference implement
   3
   4 Copyright (c) 2004 - 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 _DEVICE_MANAGER_H
  16 #define _DEVICE_MANAGER_H
  17
  18 #include "Bds.h"
  19 #include "FrontPage.h"
  20
  21 //
  22 // These are defined as the same with vfr file
  23 //
  24 #define DEVICE_MANAGER_FORMSET_GUID  \
  25   { \
  26   0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27} \
  27   }
  28
  29 #define LABEL_VBIOS                          0x0040
  30
  31 #define DEVICE_MANAGER_FORM_ID               0x1000
  32
  33 #define DEVICE_KEY_OFFSET                    0x1000
  34 #define DEVICE_MANAGER_KEY_VBIOS             0x2000
  35
  36 //
  37 // These are the VFR compiler generated data representing our VFR data.
  38 //
  39 extern UINT8  DeviceManagerVfrBin[];
  40
  41 #define DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE  EFI_SIGNATURE_32 ('D', 'M', 'C', 'B')
  42
  43 typedef struct {
  44   UINTN                           Signature;
  45
  46   //
  47   // HII relative handles
  48   //
  49   EFI_HII_HANDLE                  HiiHandle;
  50   EFI_HANDLE                      DriverHandle;
  51
  52   //
  53   // Produced protocols
  54   //
  55   EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;
  56
  57   //
  58   // Configuration data
  59   //
  60   UINT8                           VideoBios;
  61 } DEVICE_MANAGER_CALLBACK_DATA;
  62
  63 #define DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS(a) \
  64   CR (a, \
  65       DEVICE_MANAGER_CALLBACK_DATA, \
  66       ConfigAccess, \
  67       DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \
  68       )
  69 typedef struct {
  70   EFI_STRING_ID  StringId;
  71   UINT16         Class;
  72 } DEVICE_MANAGER_MENU_ITEM;
  73
  74 /**
  75   EDES_TODO: Add function description.
  76
  77   @param This            EDES_TODO: Add parameter description
  78   @param Action          EDES_TODO: Add parameter description
  79   @param QuestionId      EDES_TODO: Add parameter description
  80   @param Type            EDES_TODO: Add parameter description
  81   @param Value           EDES_TODO: Add parameter description
  82   @param ActionRequest   EDES_TODO: Add parameter description
  83
  84   @return EDES_TODO: Add description for return value
  85
  86 **/
  87 EFI_STATUS
  88 EFIAPI
  89 DeviceManagerCallback (
  90   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
  91   IN  EFI_BROWSER_ACTION                     Action,
  92   IN  EFI_QUESTION_ID                        QuestionId,
  93   IN  UINT8                                  Type,
  94   IN  EFI_IFR_TYPE_VALUE                     *Value,
  95   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest
  96   )
  97 ;
  98
  99 /**
 100   EDES_TODO: Add function description.
 101
 102   @param VOID            EDES_TODO: Add parameter description
 103
 104   @return EDES_TODO: Add description for return value
 105
 106 **/
 107 EFI_STATUS
 108 InitializeDeviceManager (
 109   VOID
 110   )
 111 ;
 112
 113 /**
 114   EDES_TODO: Add function description.
 115
 116   @param VOID            EDES_TODO: Add parameter description
 117
 118   @return EDES_TODO: Add description for return value
 119
 120 **/
 121 EFI_STATUS
 122 CallDeviceManager (
 123   VOID
 124   )
 125 ;
 126
 127 #endif