Clean up Device Manager module in BdsDxe.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / DeviceMngr / DeviceManager.h

/** @file\r
  The platform device manager reference implement\r
\r
Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _DEVICE_MANAGER_H_\r
#define _DEVICE_MANAGER_H_\r
\r
#include "Bds.h"\r
#include "FrontPage.h"\r
\r
//\r
// These are defined as the same with vfr file\r
//\r
#define DEVICE_MANAGER_FORMSET_GUID  \\r
  { \\r
  0x3ebfa8e6, 0x511d, 0x4b5b, {0xa9, 0x5f, 0xfb, 0x38, 0x26, 0xf, 0x1c, 0x27} \\r
  }\r
\r
#define LABEL_VBIOS                          0x0040\r
\r
#define DEVICE_MANAGER_FORM_ID               0x1000\r
\r
#define DEVICE_KEY_OFFSET                    0x1000\r
#define DEVICE_MANAGER_KEY_VBIOS             0x2000\r
\r
//\r
// These are the VFR compiler generated data representing our VFR data.\r
//\r
extern UINT8  DeviceManagerVfrBin[];\r
\r
#define DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE  EFI_SIGNATURE_32 ('D', 'M', 'C', 'B')\r
\r
typedef struct {\r
  UINTN                           Signature;\r
\r
  //\r
  // HII relative handles\r
  //\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
\r
  //\r
  // Produced protocols\r
  //\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;\r
\r
  //\r
  // Configuration data\r
  //\r
  UINT8                           VideoBios;\r
} DEVICE_MANAGER_CALLBACK_DATA;\r
\r
#define DEVICE_MANAGER_CALLBACK_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      DEVICE_MANAGER_CALLBACK_DATA, \\r
      ConfigAccess, \\r
      DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE \\r
      )\r
typedef struct {\r
  EFI_STRING_ID  StringId;\r
  UINT16         Class;\r
} DEVICE_MANAGER_MENU_ITEM;\r
\r
/**\r
  EDES_TODO: Add function description.\r
\r
  @param This            EDES_TODO: Add parameter description\r
  @param Action          EDES_TODO: Add parameter description\r
  @param QuestionId      EDES_TODO: Add parameter description\r
  @param Type            EDES_TODO: Add parameter description\r
  @param Value           EDES_TODO: Add parameter description\r
  @param ActionRequest   EDES_TODO: Add parameter description\r
\r
  @return EDES_TODO: Add description for return value\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DeviceManagerCallback (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  EFI_BROWSER_ACTION                     Action,\r
  IN  EFI_QUESTION_ID                        QuestionId,\r
  IN  UINT8                                  Type,\r
  IN  EFI_IFR_TYPE_VALUE                     *Value,\r
  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
  )\r
;\r
\r
/**\r
  EDES_TODO: Add function description.\r
\r
  @param VOID            EDES_TODO: Add parameter description\r
\r
  @return EDES_TODO: Add description for return value\r
\r
**/\r
EFI_STATUS\r
InitializeDeviceManager (\r
  VOID\r
  )\r
;\r
\r
/**\r
  EDES_TODO: Add function description.\r
\r
  @param VOID            EDES_TODO: Add parameter description\r
\r
  @return EDES_TODO: Add description for return value\r
\r
**/\r
EFI_STATUS\r
CallDeviceManager (\r
  VOID\r
  )\r
;\r
\r
#endif\r