/** @file\r
- This file declares EFI Smm Software Smi Child Protocol\r
+ Provides the parent dispatch service for a given SMI source generator.\r
\r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
Module Name: SmmSwDispatch.h\r
\r
@par Revision Reference:\r
- This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
+ This Protocol is defined in Framework for EFI SMM Core Interface Spec\r
Version 0.9.\r
\r
**/\r
The dispatch function will only be called\r
for input values for which it is registered.\r
\r
- Nothing\r
+ @return None\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SMM_SW_DISPATCH) (\r
+(EFIAPI *EFI_SMM_SW_DISPATCH)(\r
IN EFI_HANDLE DispatchHandle,\r
IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext\r
);\r
/**\r
Register a child SMI source dispatch function with a parent SMM driver\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchFunction Pointer to dispatch function to be invoked for\r
- this SMI source\r
+ @param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.\r
+ @param DispatchFunction Function to install.\r
@param DispatchContext Pointer to the dispatch function's context.\r
The caller fills this context in before calling\r
the register function to indicate to the register\r
function which Software SMI input value the\r
dispatch function should be invoked for.\r
- @param DispatchHandle Handle of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\r
+ @param DispatchHandle Handle generated by the dispatcher to track the function instance.\r
\r
@retval EFI_SUCCESS The dispatch function has been successfully\r
registered and the SMI source has been enabled.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_REGISTER) (\r
- IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,\r
- IN EFI_SMM_SW_DISPATCH DispatchFunction,\r
- IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
+(EFIAPI *EFI_SMM_SW_REGISTER)(\r
+ IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,\r
+ IN EFI_SMM_SW_DISPATCH DispatchFunction,\r
+ IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext,\r
+ OUT EFI_HANDLE *DispatchHandle\r
);\r
\r
/**\r
Unregister a child SMI source dispatch function with a parent SMM driver\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\r
+ @param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.\r
+ @param DispatchHandle Handle of the service to remove.\r
\r
@retval EFI_SUCCESS The dispatch function has been successfully\r
unregistered and the SMI source has been disabled\r
if there are no other registered child dispatch\r
functions for this SMI source.\r
@retval EFI_INVALID_PARAMETER Handle is invalid.\r
- @retval other TBD\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_UNREGISTER) (\r
- IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
+(EFIAPI *EFI_SMM_SW_UNREGISTER)(\r
+ IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
);\r
\r
//\r
/**\r
@par Protocol Description:\r
Provides the parent dispatch service for a given SMI source generator.\r
-\r
- @param Register\r
- Installs a child service to be dispatched by this protocol.\r
-\r
- @param UnRegister\r
- Removes a child service dispatched by this protocol.\r
-\r
- @param MaximumSwiValue\r
- A read-only field that describes the maximum value that can be used\r
- in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
-\r
**/\r
struct _EFI_SMM_SW_DISPATCH_PROTOCOL {\r
+///\r
+/// Installs a child service to be dispatched by this protocol.\r
+///\r
EFI_SMM_SW_REGISTER Register;\r
+///\r
+/// Removes a child service dispatched by this protocol.\r
+///\r
EFI_SMM_SW_UNREGISTER UnRegister;\r
- UINTN MaximumSwiValue;\r
+///\r
+/// A read-only field that describes the maximum value that can be used\r
+/// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
+///\r
+UINTN MaximumSwiValue;\r
};\r
\r
extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;\r