Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10249 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -1,19 +1,19 @@
|
||||
/** @file
|
||||
This file declares Smm Gpi Smi Child Protocol.
|
||||
This file declares the Smm Gpi Smi Child Protocol.
|
||||
|
||||
The EFI_SMM_GPI_DISPATCH_PROTOCOL is defined in Framework of EFI SMM Core Interface Spec
|
||||
Version 0.9. It provides the ability to install child handlers for the given event types.
|
||||
Several inputs can be enabled. This purpose of this interface is to generate an
|
||||
SMI in response to any of these inputs having a true value provided.
|
||||
|
||||
Copyright (c) 2007 - 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.
|
||||
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
|
||||
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.
|
||||
|
||||
**/
|
||||
|
||||
@@ -54,10 +54,11 @@ typedef struct {
|
||||
/**
|
||||
Dispatch function for a GPI SMI handler.
|
||||
|
||||
@param DispatchHandle Handle of this dispatch function.
|
||||
@param DispatchContext Pointer to the dispatch function's context.
|
||||
The DispatchContext fields are filled in by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
@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.
|
||||
**/
|
||||
typedef
|
||||
VOID
|
||||
@@ -69,17 +70,17 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
|
||||
@param This The pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext Pointer to the dispatch function's context.
|
||||
@param DispatchContext The pointer to the dispatch function's context.
|
||||
Indicates to the register
|
||||
function the GPI(s) for which the dispatch function
|
||||
should be invoked.
|
||||
@param DispatchHandle Handle generated by the dispatcher to track the
|
||||
@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.
|
||||
registered, and the SMI source has been enabled.
|
||||
@retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
|
||||
@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
|
||||
child.
|
||||
@@ -99,11 +100,11 @@ EFI_STATUS
|
||||
/**
|
||||
Unregisters a General Purpose Input (GPI) service.
|
||||
|
||||
@param This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
@param This The pointer to the EFI_SMM_GPI_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 DispatchHandle is invalid.
|
||||
|
Reference in New Issue
Block a user