X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmIchnDispatch.h;h=56e9e3844e7f1b5366f42001ee248cb6b2a616bd;hp=1719371314df3c92669ef2a877fdc6dfad646cd1;hb=2b3687dbb512ccd3cfbb75fa8966c3c93b3c067d;hpb=2bbaeb0d624f1d7758edd0a8d61322af209a1b1a diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h index 1719371314..56e9e3844e 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h @@ -3,16 +3,14 @@ The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for the given event types. - Copyright (c) 2008 - 2009, 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: SmmIchnDispatch.h +Copyright (c) 2008 - 2010, 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 that 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. @par Revision Reference: This Protocol is defined in Framework of EFI SMM Core Interface Spec @@ -23,7 +21,6 @@ #ifndef _EFI_SMM_ICHN_DISPATCH_H_ #define _EFI_SMM_ICHN_DISPATCH_H_ -#include // // Global ID for the ICH SMI Protocol @@ -109,8 +106,8 @@ typedef struct { /** Dispatch function for a ICHN specific SMI handler. - @param DispatchHandle Handle of this dispatch function. - @param DispatchContext Pointer to the dispatch function's context. + @param DispatchHandle The handle of this dispatch function. + @param DispatchContext The pointer to the dispatch function's context. The DispatchContext fields are filled in by the dispatching driver prior to invoking this dispatch function. @@ -126,21 +123,21 @@ VOID ); /** - Register a child SMI source dispatch function with a parent SMM driver + Register a child SMI source dispatch function with a parent SMM driver. - @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance. - @param DispatchFunction Function to install. - @param DispatchContext Pointer to the dispatch function's context. - The caller fills this context in before calling + @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance. + @param DispatchFunction The function to install. + @param DispatchContext The pointer to the dispatch function's context. + The caller fills in this context before calling the register function to indicate to the register function the ICHN SMI source for which the dispatch function should be invoked. - @param DispatchHandle Handle generated by the dispatcher to track the function + @param DispatchHandle The handle generated by the dispatcher to track the function instance. @retval EFI_SUCCESS The dispatch function has been successfully registered and the SMI source has been enabled. - @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source. + @retval EFI_DEVICE_ERROR The driver could not 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 ICHN input value @@ -159,14 +156,14 @@ EFI_STATUS /** Unregister a child SMI source dispatch function with a parent SMM driver - @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance. - @param DispatchHandle Handle of the service to remove. + @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance. + @param DispatchHandle The handle of the service to remove. @retval EFI_SUCCESS The dispatch function has been successfully - unregistered and the SMI source has been disabled + 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 EFI_INVALID_PARAMETER The handle is invalid. **/ typedef