Initial directory structure of IntelFrameworkPkg.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2657 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 149 insertions, 0 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
new file mode 100644
index 0000000000..e003fb74ef
--- /dev/null
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -0,0 +1,149 @@
+/** @file

+  This file declares EFI Smm Software Smi Child Protocol

+

+  Copyright (c) 2007, Intel Corporation

+  All rights reserved. This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+  Module Name:  SmmSwDispatch.h

+

+  @par Revision Reference:

+  This Protocol is defined in Framework of EFI SMM Core Interface Spec

+  Version 0.9.

+

+**/

+

+#ifndef _EFI_SMM_SW_DISPATCH_H_

+#define _EFI_SMM_SW_DISPATCH_H_

+

+//

+// Global ID for the SW SMI Protocol

+//

+#define EFI_SMM_SW_DISPATCH_PROTOCOL_GUID \

+  { \

+    0xe541b773, 0xdd11, 0x420c, {0xb0, 0x26, 0xdf, 0x99, 0x36, 0x53, 0xf8, 0xbf } \

+  }

+

+typedef struct _EFI_SMM_SW_DISPATCH_PROTOCOL  EFI_SMM_SW_DISPATCH_PROTOCOL;

+

+//

+// Related Definitions

+//

+//

+// A particular chipset may not support all possible software SMI input values.

+// For example, the ICH supports only values 00h to 0FFh.  The parent only allows a single

+// child registration for each SwSmiInputValue.

+//

+typedef struct {

+  UINTN SwSmiInputValue;

+} EFI_SMM_SW_DISPATCH_CONTEXT;

+

+//

+// Member functions

+//

+/**

+  Dispatch function for a Software SMI handler.

+

+  @param  DispatchHandle        Handle of this dispatch function.

+  @param  DispatchContext       Pointer to the dispatch function's context.

+                                The SwSmiInputValue field is filled in

+                                by the software dispatch driver prior to

+                                invoking this dispatch function.

+                                The dispatch function will only be called

+                                for input values for which it is registered.

+

+  Nothing

+

+**/

+typedef

+VOID

+(EFIAPI *EFI_SMM_SW_DISPATCH) (

+  IN  EFI_HANDLE                    DispatchHandle,

+  IN  EFI_SMM_SW_DISPATCH_CONTEXT   *DispatchContext

+  );

+

+/**

+  Register a child SMI source dispatch function with a parent SMM driver

+

+  @param  This                  Protocol instance pointer.

+  @param  DispatchFunction      Pointer to dispatch function to be invoked for

+                                this SMI source

+  @param  DispatchContext       Pointer to the dispatch function's context.

+                                The caller fills this context in before calling

+                                the register function to indicate to the register

+                                function which Software SMI input value the

+                                dispatch function should be invoked for.

+  @param  DispatchHandle        Handle of dispatch function, for when interfacing

+                                with the parent Sx state SMM driver.

+

+  @retval EFI_SUCCESS           The dispatch function has been successfully

+                                registered and the SMI source has been enabled.

+  @retval EFI_DEVICE_ERROR      The SW driver was unable to enable the SMI source.

+  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this

+                                child.

+  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value

+                                is not within valid range.

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SMM_SW_REGISTER) (

+  IN EFI_SMM_SW_DISPATCH_PROTOCOL           *This,

+  IN  EFI_SMM_SW_DISPATCH                   DispatchFunction,

+  IN  EFI_SMM_SW_DISPATCH_CONTEXT           *DispatchContext,

+  OUT EFI_HANDLE                            *DispatchHandle

+  );

+

+/**

+  Unregister a child SMI source dispatch function with a parent SMM driver

+

+  @param  This                  Protocol instance pointer.

+  @param  DispatchHandle        Handle of dispatch function to deregister.

+

+  @retval EFI_SUCCESS           The dispatch function has been successfully

+                                unregistered and the SMI source has been disabled

+                                if there are no other registered child dispatch

+                                functions for this SMI source.

+  @retval EFI_INVALID_PARAMETER Handle is invalid.

+  @retval other                 TBD

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SMM_SW_UNREGISTER) (

+  IN EFI_SMM_SW_DISPATCH_PROTOCOL           *This,

+  IN  EFI_HANDLE                            DispatchHandle

+  );

+

+//

+// Interface structure for the SMM Software SMI Dispatch Protocol

+//

+/**

+  @par Protocol Description:

+  Provides the parent dispatch service for a given SMI source generator.

+

+  @param Register

+  Installs a child service to be dispatched by this protocol.

+

+  @param UnRegister

+  Removes a child service dispatched by this protocol.

+

+  @param MaximumSwiValue

+  A read-only field that describes the maximum value that can be used

+  in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.

+

+**/

+struct _EFI_SMM_SW_DISPATCH_PROTOCOL {

+  EFI_SMM_SW_REGISTER   Register;

+  EFI_SMM_SW_UNREGISTER UnRegister;

+  UINTN                 MaximumSwiValue;

+};

+

+extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;

+

+#endif