Remove the error checking for multi-instance device path since Dxecore has been enhan...

[mirror_edk2.git] / MdePkg / Include / Protocol / SmmPowerButtonDispatch2.h

/** @file\r
  SMM Power Button Dispatch2 Protocol as defined in PI 1.1 Specification\r
  Volume 4 System Management Mode Core Interface.\r
\r
  This protocol provides the parent dispatch service for the power button SMI source generator.\r
\r
  Copyright (c) 2009, 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
  @par Revision Reference:\r
  This protocol is from PI Version 1.1.\r
\r
**/\r
\r
#ifndef _SMM_POWER_BUTTON_DISPATCH2_H_\r
#define _SMM_POWER_BUTTON_DISPATCH2_H_\r
\r
#include <Pi/PiSmmCis.h>\r
\r
#define EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL_GUID \\r
  { \\r
    0x1b1183fa, 0x1823, 0x46a7, {0x88, 0x72, 0x9c, 0x57, 0x87, 0x55, 0x40, 0x9d } \\r
  }\r
\r
///\r
/// Power Button phases.\r
///\r
typedef enum {\r
  EfiPowerButtonEntry,\r
  EfiPowerButtonExit,\r
  EfiPowerButtonMax\r
} EFI_POWER_BUTTON_PHASE;\r
\r
///\r
/// The dispatch function's context.\r
///\r
typedef struct {\r
  ///\r
  /// Designates whether this handler should be invoked upon entry or exit.\r
  ///\r
  EFI_POWER_BUTTON_PHASE  Phase;\r
} EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT;\r
\r
typedef struct _EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL;\r
\r
/**\r
  Provides the parent dispatch service for a power button event.\r
\r
  This service registers a function (DispatchFunction) which will be called when an SMI is \r
  generated because the power button was pressed or released, as specified by RegisterContext. \r
  On return, DispatchHandle contains a unique handle which may be used later to unregister the \r
  function using UnRegister().\r
  The DispatchFunction will be called with Context set to the same value as was passed into \r
  this function in RegisterContext and with CommBuffer and CommBufferSize set to NULL.\r
\r
  @param[in]  This               Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL instance.\r
  @param[in]  DispatchFunction   Function to register for handler when power button is pressed or released.\r