sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update comments for coding style.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8711 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jljusten
2009-07-02 00:47:58 +00:00
parent 412fb9ef2d
commit ac9868ecb8
2 changed files with 159 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

220
IntelFrameworkPkg/Include/Protocol/SmmBase.h
View File

@ -18,20 +18,20 @@
call before boot services are terminated. On the other hand, handlers for services such as chipset call before boot services are terminated. On the other hand, handlers for services such as chipset
workarounds for the century rollover in CMOS should provide commensurate services throughout workarounds for the century rollover in CMOS should provide commensurate services throughout
preboot and OS runtime. preboot and OS runtime.
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.
@par Revision Reference: @par Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec This Protocol is defined in Framework of EFI SMM Core Interface Spec
Version 0.9. Version 0.9.
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.
**/ **/
#ifndef _SMM_BASE_H_ #ifndef _SMM_BASE_H_
@ -57,14 +57,14 @@ typedef struct _EFI_SMM_BASE_PROTOCOL EFI_SMM_BASE_PROTOCOL;
/** /**
Entry Point to Callback service Entry Point to Callback service
@param SmmImageHandle A handle allocated by the SMM infrastructure code @param[in] SmmImageHandle A handle allocated by the SMM infrastructure code
to uniquely designate a specific DXE SMM driver. to uniquely designate a specific DXE SMM driver.
@param CommunicationBuffer A pointer to a collection of data in memory @param[in] CommunicationBuffer A pointer to a collection of data in memory
that will be conveyed from a non-SMM environment into an SMM environment. that will be conveyed from a non-SMM environment into an SMM environment.
The buffer must be contiguous, physically mapped, and be a physical address. The buffer must be contiguous, physically mapped, and be a physical address.
@param SourceSize The size of the CommunicationBuffer. @param[in] SourceSize The size of the CommunicationBuffer.
@return Status code @return Status code
**/ **/
typedef typedef
@ -82,22 +82,22 @@ EFI_STATUS
Register a given driver into SMRAM.This is the equivalent of performing Register a given driver into SMRAM.This is the equivalent of performing
the LoadImage/StartImage into System Management Mode. the LoadImage/StartImage into System Management Mode.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param FilePath Location of the image to be installed as the handler. @param[in] FilePath Location of the image to be installed as the handler.
@param SourceBuffer Optional source buffer in case of the image file @param[in] SourceBuffer Optional source buffer in case of the image file
being in memory. being in memory.
@param SourceSize Size of the source image file, if in memory. @param[in] SourceSize Size of the source image file, if in memory.
@param ImageHandle The handle that the base driver uses to decode @param[out] ImageHandle The handle that the base driver uses to decode
the handler. Unique among SMM handlers only, the handler. Unique among SMM handlers only,
not unique across DXE/EFI. not unique across DXE/EFI.
@param LegacyIA32Binary An optional parameter that details that the associated @param[in] LegacyIA32Binary An optional parameter that details that the associated
file is a real-mode IA-32 binary. file is a real-mode IA-32 binary.
@retval EFI_SUCCESS The operation was successful. @retval EFI_SUCCESS The operation was successful.
@retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
@retval EFI_UNSUPPORTED This platform does not support 16-bit handlers. @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
@retval EFI_INVALID_PARAMETER The handlers was not the correct image type @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
**/ **/
typedef typedef
@ -115,12 +115,12 @@ EFI_STATUS
Removes a handler from execution within SMRAM. This is the equivalent of performing Removes a handler from execution within SMRAM. This is the equivalent of performing
the UnloadImage in System Management Mode. the UnloadImage in System Management Mode.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param ImageHandle The handler to be removed. @param[in] ImageHandle The handler to be removed.
@retval EFI_SUCCESS The operation was successful @retval EFI_SUCCESS The operation was successful
@retval EFI_INVALID_PARAMETER The handler did not exist @retval EFI_INVALID_PARAMETER The handler did not exist
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
**/ **/
typedef typedef
@ -136,13 +136,13 @@ EFI_STATUS
EFI service. The BASE protocol driver is responsible for doing EFI service. The BASE protocol driver is responsible for doing
any of the copies such that the data lives in boot-service-accessible RAM. any of the copies such that the data lives in boot-service-accessible RAM.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param ImageHandle The handle of the registered driver. @param[in] ImageHandle The handle of the registered driver.
@param CommunicationBuffer Pointer to the buffer to convey into SMRAM. @param[in,out] CommunicationBuffer Pointer to the buffer to convey into SMRAM.
@param SourceSize The size of the data buffer being passed in. @param[in,out] SourceSize The size of the data buffer being passed in.
@retval EFI_SUCCESS The message was successfully posted @retval EFI_SUCCESS The message was successfully posted
@retval EFI_INVALID_PARAMETER The buffer was NULL @retval EFI_INVALID_PARAMETER The buffer was NULL
**/ **/
typedef typedef
@ -158,20 +158,20 @@ EFI_STATUS
Register a callback to execute within SMM. Register a callback to execute within SMM.
This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate(). This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param SmmImageHandle Handle of the callback service. @param[in] SmmImageHandle Handle of the callback service.
@param CallbackAddress Address of the callback service. @param[in] CallbackAddress Address of the callback service.
@param MakeLast If present, will stipulate that the handler is posted to @param[in] MakeLast If present, will stipulate that the handler is posted to
be executed last in the dispatch table. be executed last in the dispatch table.
@param FloatingPointSave This is an optional parameter which informs the @param[in] FloatingPointSave This is an optional parameter which informs the
EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
the floating point register state. If any of the handlers the floating point register state. If any of the handlers
require this, then the state will be saved for all of the handlers. require this, then the state will be saved for all of the handlers.
@retval EFI_SUCCESS The operation was successful @retval EFI_SUCCESS The operation was successful
@retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
@retval EFI_UNSUPPORTED The caller is not in SMM. @retval EFI_UNSUPPORTED The caller is not in SMM.
**/ **/
typedef typedef
@ -190,20 +190,20 @@ EFI_STATUS
by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the
requested pool type. All allocations are eight-byte aligned. requested pool type. All allocations are eight-byte aligned.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param PoolType The type of pool to allocate. @param[in] PoolType The type of pool to allocate.
The only supported type is EfiRuntimeServicesData; The only supported type is EfiRuntimeServicesData;
the interface will internally map this runtime request to the interface will internally map this runtime request to
SMRAM for IA-32 and leave as this type for the Itanium SMRAM for IA-32 and leave as this type for the Itanium
processor family. Other types can be ignored. processor family. Other types can be ignored.
@param Size The number of bytes to allocate from the pool. @param[in] Size The number of bytes to allocate from the pool.
@param Buffer A pointer to a pointer to the allocated buffer if the call @param[out] Buffer A pointer to a pointer to the allocated buffer if the call
succeeds; undefined otherwise. succeeds; undefined otherwise.
@retval EFI_SUCCESS The requested number of bytes was allocated. @retval EFI_SUCCESS The requested number of bytes was allocated.
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated. @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
@retval EFI_INVALID_PARAMETER PoolType was invalid. @retval EFI_INVALID_PARAMETER PoolType was invalid.
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
**/ **/
typedef typedef
@ -220,12 +220,12 @@ EFI_STATUS
On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must
have been allocated by SmmAllocatePool(). have been allocated by SmmAllocatePool().
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param Buffer Pointer to the buffer allocation. @param[in] Buffer Pointer to the buffer allocation.
@retval EFI_SUCCESS The memory was returned to the system. @retval EFI_SUCCESS The memory was returned to the system.
@retval EFI_INVALID_PARAMETER Buffer was invalid. @retval EFI_INVALID_PARAMETER Buffer was invalid.
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
**/ **/
typedef typedef
@ -238,10 +238,13 @@ EFI_STATUS
/** /**
This routine tells caller if execution context is SMM or not. This routine tells caller if execution context is SMM or not.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family. @param[out] InSmm Whether the caller is inside SMM for IA-32
or servicing a PMI for the Itanium processor
family.
@retval EFI_SUCCESS The operation was successful @retval EFI_SUCCESS The operation was successful
@retval EFI_INVALID_PARAMETER InSmm was NULL.
**/ **/
typedef typedef
@ -257,12 +260,12 @@ EFI_STATUS
location of the SMST in its entry point and then cache it in some driver location of the SMST in its entry point and then cache it in some driver
global variable so that the SMST can be invoked in subsequent callbacks. global variable so that the SMST can be invoked in subsequent callbacks.
@param This Protocol instance pointer. @param[in] This Protocol instance pointer.
@param Smst Pointer to the SMST. @param[in] Smst Pointer to the SMST.
@retval EFI_SUCCESS The operation was successful @retval EFI_SUCCESS The operation was successful
@retval EFI_INVALID_PARAMETER Smst was invalid. @retval EFI_INVALID_PARAMETER Smst was invalid.
@retval EFI_UNSUPPORTED Not in SMM. @retval EFI_UNSUPPORTED Not in SMM.
**/ **/
typedef typedef
@ -277,39 +280,46 @@ EFI_STATUS
This protocol is used to install SMM handlers for support of subsequent SMI/PMI This protocol is used to install SMM handlers for support of subsequent SMI/PMI
activations. This protocol is available on both IA-32 and Itanium-based systems. activations. This protocol is available on both IA-32 and Itanium-based systems.
@param Register
Registers a handler to run in System Management RAM (SMRAM).
@param UnRegister
Removes a handler from execution in SMRAM.
@param Communicate
Sends/receives a message for a registered handler.
@param RegisterCallback
Registers a callback from the constructor.
@param InSmm
Detects whether the caller is inside or outside of SMM. SName
@param SmmAllocatePool
Allocates SMRAM.
@param SmmFreePool
Deallocates SMRAM.
@param GetSmstLocation
Retrieves the location of the System Management System Table (SMST).
**/ **/
struct _EFI_SMM_BASE_PROTOCOL { struct _EFI_SMM_BASE_PROTOCOL {
///
/// Registers a handler to run in System Management RAM (SMRAM).
///
EFI_SMM_REGISTER_HANDLER Register; EFI_SMM_REGISTER_HANDLER Register;
///
/// Removes a handler from execution in SMRAM.
///
EFI_SMM_UNREGISTER_HANDLER UnRegister; EFI_SMM_UNREGISTER_HANDLER UnRegister;
///
/// Sends/receives a message for a registered handler.
///
EFI_SMM_COMMUNICATE Communicate; EFI_SMM_COMMUNICATE Communicate;
///
/// Registers a callback from the constructor.
///
EFI_SMM_CALLBACK_SERVICE RegisterCallback; EFI_SMM_CALLBACK_SERVICE RegisterCallback;
///
/// Detects whether the caller is inside or outside of SMM. SName
///
EFI_SMM_INSIDE_OUT InSmm; EFI_SMM_INSIDE_OUT InSmm;
///
/// Allocates SMRAM.
///
EFI_SMM_ALLOCATE_POOL SmmAllocatePool; EFI_SMM_ALLOCATE_POOL SmmAllocatePool;
///
/// Deallocates SMRAM.
///
EFI_SMM_FREE_POOL SmmFreePool; EFI_SMM_FREE_POOL SmmFreePool;
///
/// Retrieves the location of the System Management System Table (SMST).
///
EFI_SMM_GET_SMST_LOCATION GetSmstLocation; EFI_SMM_GET_SMST_LOCATION GetSmstLocation;
}; };

93
IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
View File

@ -1,21 +1,19 @@
/** @file /** @file
Provides the parent dispatch service for the power button SMI source generator. Provides the parent dispatch service for the power button SMI source generator.
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: SmmPowerButtonDispatch.h
@par Revision Reference: @par Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec This Protocol is defined in Framework of EFI SMM Core Interface Spec
Version 0.9. Version 0.9.
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.
**/ **/
#ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_ #ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_
@ -56,13 +54,11 @@ typedef struct {
/** /**
Dispatch function for a Power Button SMI handler. Dispatch function for a Power Button SMI handler.
@param DispatchHandle Handle of this dispatch function. @param[in] DispatchHandle Handle of this dispatch function.
@param DispatchContext Pointer to the dispatch function's context. @param[in] DispatchContext Pointer to the dispatch function's context.
The DispatchContext fields are filled in The DispatchContext fields are filled in
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
@return None
**/ **/
typedef typedef
@ -75,22 +71,22 @@ VOID
/** /**
Provides the parent dispatch service for a given SMI source generator Provides the parent dispatch service for a given SMI source generator
@param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance. @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchFunction Function to install. @param[in] DispatchFunction Function to install.
@param DispatchContext Pointer to the dispatch function's context. @param[in] DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the Power Button SMI phase for which the dispatch function the Power Button SMI phase for which the dispatch
function should be invoked. function should be invoked.
@param DispatchHandle Handle generated by the dispatcher to track the function instance. @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance.
@retval EFI_SUCCESS The dispatch function has been successfully @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_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 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
child. child.
@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
phase is not within valid range. phase is not within valid range.
**/ **/
typedef typedef
@ -105,14 +101,15 @@ EFI_STATUS
/** /**
Unregisters a power-button service. Unregisters a power-button service.
@param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance. @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of the service to remove. @param[in] DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been
if there are no other registered child dispatch disabled if there are no other registered
functions for this SMI source. child dispatch functions for this SMI
@retval EFI_INVALID_PARAMETER Handle is invalid. source.
@retval EFI_INVALID_PARAMETER Handle is invalid.
**/ **/
typedef typedef
@ -122,22 +119,20 @@ EFI_STATUS
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
//
// Interface structure for the SMM Power Button SMI Dispatch Protocol
//
/** /**
@par Protocol Description: @par Protocol Description:
Provides the parent dispatch service for the SMM power button SMI source generator. Provides the parent dispatch service for the SMM power button 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.
**/ **/
struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL { struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL {
///
/// Installs a child service to be dispatched by this protocol.
///
EFI_SMM_POWER_BUTTON_REGISTER Register; EFI_SMM_POWER_BUTTON_REGISTER Register;
///
/// Removes a child service dispatched by this protocol.
///
EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister; EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister;
}; };