IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h

   1 /** @file
   2   Provides the parent dispatch service for a given Sx-state source generator.
   3
   4   Copyright (c) 2007 - 2009, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  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   Module Name:  SmmSxDispatch.h
  14
  15   @par Revision Reference:
  16   This Protocol is defined in Framework of EFI SMM Core Interface Spec
  17   Version 0.9.
  18
  19 **/
  20
  21 #ifndef _EFI_SMM_SX_DISPATCH_H_
  22 #define _EFI_SMM_SX_DISPATCH_H_
  23
  24
  25 //
  26 // Global ID for the Sx SMI Protocol
  27 //
  28 #define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID \
  29   { \
  30     0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \
  31   }
  32
  33 typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL  EFI_SMM_SX_DISPATCH_PROTOCOL;
  34 //
  35 // Related Definitions
  36 //
  37 typedef enum {
  38   SxS0,
  39   SxS1,
  40   SxS2,
  41   SxS3,
  42   SxS4,
  43   SxS5,
  44   EfiMaximumSleepType
  45 } EFI_SLEEP_TYPE;
  46
  47 typedef enum {
  48   SxEntry,
  49   SxExit,
  50   EfiMaximumPhase
  51 } EFI_SLEEP_PHASE;
  52
  53 typedef struct {
  54   EFI_SLEEP_TYPE  Type;
  55   EFI_SLEEP_PHASE Phase;
  56 } EFI_SMM_SX_DISPATCH_CONTEXT;
  57
  58 //
  59 // Member functions
  60 //
  61 /**
  62   Dispatch function for a Sx state SMI handler.
  63
  64   @param  DispatchHandle        Handle of this dispatch function.
  65   @param  DispatchContext       Pointer to the dispatch function's context.
  66                                 The Type and Phase fields are filled in by the Sx dispatch driver
  67                                 prior to invoking this dispatch function. For this interface,
  68                                 the Sx driver will call the dispatch function for all Sx type
  69                                 and phases, so the Sx state handler(s) must check the Type and
  70                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
  71
  72   @return None
  73
  74 **/
  75 typedef
  76 VOID
  77 (EFIAPI *EFI_SMM_SX_DISPATCH)(
  78   IN  EFI_HANDLE                    DispatchHandle,
  79   IN  EFI_SMM_SX_DISPATCH_CONTEXT   *DispatchContext
  80   );
  81
  82 /**
  83   Register a child SMI source dispatch function with a parent SMM driver
  84
  85   @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
  86   @param  DispatchFunction      Function to install.
  87   @param  DispatchContext       Pointer to the dispatch function's context.
  88                                 The caller fills this context in before calling
  89                                 the register function to indicate to the register
  90                                 function which Sx state type and phase the caller
  91                                 wishes to be called back on. For this intertace,
  92                                 the Sx driver will call the registered handlers for
  93                                 all Sx type and phases, so the Sx state handler(s)
  94                                 must check the Type and Phase field of the Dispatch
  95                                 context and act accordingly.
  96   @param  DispatchHandle        Handle of dispatch function, for when interfacing
  97                                 with the parent Sx state SMM driver.
  98
  99   @retval EFI_SUCCESS           The dispatch function has been successfully
 100                                 registered and the SMI source has been enabled.
 101   @retval EFI_UNSUPPORTED       The Sx driver or hardware does not support that
 102                                 Sx Type/Phase.
 103   @retval EFI_DEVICE_ERROR      The Sx driver was unable to enable the SMI source.
 104   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this
 105                                 child.
 106   @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
 107                                 within valid range.
 108
 109 **/
 110 typedef
 111 EFI_STATUS
 112 (EFIAPI *EFI_SMM_SX_REGISTER)(
 113   IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,
 114   IN EFI_SMM_SX_DISPATCH                   DispatchFunction,
 115   IN EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,
 116   OUT EFI_HANDLE                           *DispatchHandle
 117   );
 118
 119 /**
 120   Unregisters an Sx-state service
 121
 122   @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
 123   @param  DispatchHandle        Handle of the service to remove.
 124
 125   @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the
 126                                 SMI source has been disabled if there are no other registered child
 127                                 dispatch functions for this SMI source.
 128   @retval EFI_INVALID_PARAMETER Handle is invalid.
 129
 130 **/
 131 typedef
 132 EFI_STATUS
 133 (EFIAPI *EFI_SMM_SX_UNREGISTER)(
 134   IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,
 135   IN EFI_HANDLE                            DispatchHandle
 136   );
 137
 138 //
 139 // Interface structure for the SMM Child Dispatch Protocol
 140 //
 141 /**
 142   Provides the parent dispatch service for a given Sx-state source generator.
 143 **/
 144 struct _EFI_SMM_SX_DISPATCH_PROTOCOL {
 145   EFI_SMM_SX_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.
 146   EFI_SMM_SX_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.
 147 };
 148
 149 extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;
 150
 151 #endif