clean up the un-suitable ';' location when declaring the functions.

[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
  This function is invoked if user selected a iteractive opcode from Device Manager's\r
  Formset. The decision by user is saved to gCallbackKey for later processing. If\r
  user set VBIOS, the new value is saved to EFI variable.\r
\r
\r
  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Action          Specifies the type of action taken by the browser.\r
  @param QuestionId      A unique value which is sent to the original exporting driver\r
                         so that it can identify the type of data to expect.\r
  @param Type            The type of value for the question.\r
  @param Value           A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest   On return, points to the action requested by the callback function.\r
\r
  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\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
  This function registers HII packages to HII database.\r
\r
  @retval EFI_SUCCESS This function complete successfully.\r
  @return Other value if failed to register HII packages.\r
\r
**/\r
EFI_STATUS\r
InitializeDeviceManager (\r
  VOID\r
  );\r
\r
/**\r
\r
  Call the browser and display the device manager to allow user\r
  to configure the platform.\r
\r
  This function create the dynamic content for device manager. It includes\r
  section header for all class of devices, one-of opcode to set VBIOS.\r
  \r
  @retval  EFI_SUCCESS             Operation is successful.\r
  @retval  Other values if failed to clean up the dynamic content from HII\r
           database.\r
\r
**/\r
EFI_STATUS\r
CallDeviceManager (\r
  VOID\r
  );\r
\r
#endif\r