Vlv2DeviceRefCodePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Vlv2DeviceRefCodePkg / ValleyView2Soc / SouthCluster / Include / Protocol / PchReset.h

/**\r
**/\r
/**\r
\r
Copyright (c) 2011  - 2014, Intel Corporation. All rights reserved\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
\r
  @file\r
  PchReset.h\r
\r
  @brief\r
  PCH Reset Protocol\r
\r
**/\r
#ifndef _PCH_RESET_H_\r
#define _PCH_RESET_H_\r
\r
\r
//\r
#define PCH_RESET_PROTOCOL_GUID \\r
  { \\r
    0xdb63592c, 0xb8cc, 0x44c8, 0x91, 0x8c, 0x51, 0xf5, 0x34, 0x59, 0x8a, 0x5a \\r
  }\r
#define PCH_RESET_CALLBACK_PROTOCOL_GUID \\r
  { \\r
    0x3a3300ab, 0xc929, 0x487d, 0xab, 0x34, 0x15, 0x9b, 0xc1, 0x35, 0x62, 0xc0 \\r
  }\r
extern EFI_GUID                             gPchResetProtocolGuid;\r
extern EFI_GUID                             gPchResetCallbackProtocolGuid;\r
\r
///\r
/// Forward reference for ANSI C compatibility\r
///\r
typedef struct _PCH_RESET_PROTOCOL          PCH_RESET_PROTOCOL;\r
\r
typedef struct _PCH_RESET_CALLBACK_PROTOCOL PCH_RESET_CALLBACK_PROTOCOL;\r
\r
///\r
/// Related Definitions\r
///\r
///\r
/// PCH Reset Types\r
///\r
typedef enum {\r
  ColdReset,\r
  WarmReset,\r
  ShutdownReset,\r
  PowerCycleReset,\r
  GlobalReset,\r
  GlobalResetWithEc\r
} PCH_RESET_TYPE;\r
\r
///\r
/// Member functions\r
///\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCH_RESET) (\r
  IN     PCH_RESET_PROTOCOL       * This,\r
  IN     PCH_RESET_TYPE           PchResetType\r
  )\r
/**\r
\r
  @brief\r
  Execute Pch Reset from the host controller.\r
\r
  @param[in] This                 Pointer to the PCH_RESET_PROTOCOL instance.\r
  @param[in] PchResetType         Pch Reset Types which includes ColdReset, WarmReset, ShutdownReset,\r
                                  PowerCycleReset, GlobalReset, GlobalResetWithEc\r
\r
  @retval EFI_SUCCESS             Successfully completed.\r
  @retval EFI_INVALID_PARAMETER   If ResetType is invalid.\r
\r
**/\r
;\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCH_RESET_CALLBACK) (\r
  IN     PCH_RESET_TYPE           PchResetType\r
  )\r
/**\r
\r
  @brief\r
  Execute call back function for Pch Reset.\r
\r
  @param[in] PchResetType         Pch Reset Types which includes PowerCycle, Globalreset.\r
\r
  @retval EFI_SUCCESS             The callback function has been done successfully\r
  @retval EFI_NOT_FOUND           Failed to find Pch Reset Callback protocol. Or, none of\r
                                  callback protocol is installed.\r
  @retval Others                  Do not do any reset from PCH\r
\r
**/\r
;\r
\r
///\r
/// Interface structure for the Pch Reset Protocol\r
///\r
struct _PCH_RESET_PROTOCOL {\r
  PCH_RESET Reset;\r
};\r
\r
///\r
/// PCH_RESET_CALLBACK_PROTOCOL Structure Definition\r
///\r
struct _PCH_RESET_CALLBACK_PROTOCOL {\r
  PCH_RESET_CALLBACK  ResetCallback;\r
};\r
\r
#endif\r