Update comment in SMM Library class include file.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmStandbyButtonDispatch.h

/** @file\r
  Provides the parent dispatch service for the standby button SMI source generator.\r
\r
  Copyright (c) 2007, Intel Corporation\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
  Module Name:  SmmStandbyButtonDispatch.h\r
\r
  @par Revision Reference:\r
  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_\r
#define _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_\r
\r
#include <PiDxe.h>\r
\r
//\r
// Global ID for the Standby Button SMI Protocol\r
//\r
#define EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0x78965b98, 0xb0bf, 0x449e, {0x8b, 0x22, 0xd2, 0x91, 0x4e, 0x49, 0x8a, 0x98 } \\r
  }\r
\r
typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL;\r
\r
//\r
// Related Definitions\r
//\r
//\r
// Standby Button. Example, Use for changing LEDs before ACPI OS is on.\r
//    - DXE/BDS Phase\r
//    - OS Install Phase\r
//\r
typedef enum {\r
  EfiStandbyButtonEntry,\r
  EfiStandbyButtonExit,\r
  EfiStandbyButtonMax\r
} EFI_STANDBY_BUTTON_PHASE;\r
\r
typedef struct {\r
  EFI_STANDBY_BUTTON_PHASE  Phase;\r
} EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT;\r
\r
//\r
// Member functions\r
//\r
/**\r
  Dispatch function for a Standby Button SMI handler.\r
\r
  @param  DispatchHandle        Handle of this dispatch function.\r
  @param  DispatchContext       Pointer to the dispatch function's context.\r
                                The DispatchContext fields are filled in\r
                                by the dispatching driver prior to\r
                                invoking this dispatch function.\r
\r
  @return None\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_SMM_STANDBY_BUTTON_DISPATCH)(\r
  IN  EFI_HANDLE                                DispatchHandle,\r
  IN  EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT   *DispatchContext\r
  );\r
\r
/**\r
  Provides the parent dispatch service for a given SMI source generator\r
\r
  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
  @param  DispatchFunction      Function to install.\r
  @param  DispatchContext       Pointer to the dispatch function's context.\r
                                The caller fills this context in before calling\r
                                the register function to indicate to the register\r
                                function the Standby Button SMI phase for which the dispatch\r
                                function should be invoked.\r
  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
\r
  @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                registered and the SMI source has been enabled.\r
  @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                child.\r
  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI\r
                                phase is not within valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)(\r
  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL          *This,\r
  IN EFI_SMM_STANDBY_BUTTON_DISPATCH                   DispatchFunction,\r
  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT           *DispatchContext,\r
  OUT EFI_HANDLE                                       *DispatchHandle\r
  );\r
\r
/**\r
  Unregister a child SMI source dispatch function with a parent SMM driver\r
\r
  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
  @param  DispatchHandle        Handle of the service to remove.\r
\r
  @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                unregistered and the SMI source has been disabled\r
                                if there are no other registered child dispatch\r
                                functions for this SMI source.\r
  @retval EFI_INVALID_PARAMETER Handle is invalid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_STANDBY_BUTTON_UNREGISTER)(\r
  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL           *This,\r
  IN EFI_HANDLE                                        DispatchHandle\r
  );\r
\r
//\r
// Interface structure for the SMM Standby Button SMI Dispatch Protocol\r
//\r
/**\r
  @par Protocol Description:\r
  Provides the parent dispatch service for the standby button SMI source generator.\r
\r
  @param Register\r
  Installs a child service to be dispatched by this protocol.\r
\r
  @param UnRegister\r
  Removes a child service dispatched by this protocol.\r
\r
**/\r
struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL {\r
  EFI_SMM_STANDBY_BUTTON_REGISTER   Register;\r
  EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister;\r
};\r
\r
extern EFI_GUID gEfiSmmStandbyButtonDispatchProtocolGuid;\r
\r
#endif\r