Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Protocol/PchExtendedReset.h

   1 /*++
   2
   3 Copyright (c) 2008  - 2014, Intel Corporation. All rights reserved
   4
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14
  15 Module Name:
  16
  17   PchExtendedReset.h
  18
  19 Abstract:
  20
  21   PCH Extended Reset Protocol
  22
  23 --*/
  24 #ifndef _EFI_PCH_EXTENDED_RESET_H_
  25 #define _EFI_PCH_EXTENDED_RESET_H_
  26
  27
  28
  29 //
  30 #define EFI_PCH_EXTENDED_RESET_PROTOCOL_GUID \
  31   { \
  32     0xf0bbfca0, 0x684e, 0x48b3, 0xba, 0xe2, 0x6c, 0x84, 0xb8, 0x9e, 0x53, 0x39 \
  33   }
  34 extern EFI_GUID                                 gEfiPchExtendedResetProtocolGuid;
  35
  36 //
  37 // Forward reference for ANSI C compatibility
  38 //
  39 typedef struct _EFI_PCH_EXTENDED_RESET_PROTOCOL EFI_PCH_EXTENDED_RESET_PROTOCOL;
  40
  41 //
  42 // Related Definitions
  43 //
  44 //
  45 // PCH Extended Reset Types
  46 //
  47 typedef struct {
  48   UINT8 PowerCycle  : 1;  // 0: Disabled*; 1: Enabled
  49   UINT8 GlobalReset : 1;  // 0: Disabled*; 1: Enabled
  50   UINT8 SusPwrDnAck : 1;  // 0: Do Nothing;
  51   // 1: GPIO[30](SUS_PWR_DN_ACK) level is set low prior to Global Reset(for systems with an embedded controller)
  52   UINT8 RsvdBits : 5;     // Reserved fields for future expansion w/o protocol change
  53 } PCH_EXTENDED_RESET_TYPES;
  54
  55 //
  56 // Member functions
  57 //
  58 typedef
  59 EFI_STATUS
  60 (EFIAPI *EFI_PCH_EXTENDED_RESET) (
  61   IN     EFI_PCH_EXTENDED_RESET_PROTOCOL   * This,
  62   IN     PCH_EXTENDED_RESET_TYPES          PchExtendedResetTypes
  63   );
  64
  65 /*++
  66
  67 Routine Description:
  68
  69   Execute Pch Extended Reset from the host controller.
  70
  71 Arguments:
  72
  73   This                    - Pointer to the EFI_PCH_EXTENDED_RESET_PROTOCOL instance.
  74   PchExtendedResetTypes   - Pch Extended Reset Types which includes PowerCycle, Globalreset.
  75
  76 Returns:
  77
  78   Does not return if the reset takes place.
  79   EFI_INVALID_PARAMETER   - If ResetType is invalid.
  80
  81 --*/
  82
  83 //
  84 // Interface structure for the Pch Extended Reset Protocol
  85 //
  86 struct _EFI_PCH_EXTENDED_RESET_PROTOCOL {
  87   EFI_PCH_EXTENDED_RESET  Reset;
  88 };
  89
  90 #endif