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

Per code review, Update Doxygen comments - restore reference to framework spec in header, add /// comments from spec to data and protocol structs

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8703 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgr 2009-07-01 15:55:08 +00:00
parent 1919913f7b
commit c3b35b6099
1 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
View File

@ -5,7 +5,7 @@
the Intel Platform Innovation Framework for EFI SMM Core Interface Specification the Intel Platform Innovation Framework for EFI SMM Core Interface Specification
(SMM CIS) Version 0.9. (SMM CIS) Version 0.9.
Copyright (c) 2007, Intel Corporation Copyright (c) 2007, 2009 Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -14,6 +14,10 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 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
Version 0.9.
**/ **/
#ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_ #ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_
@ -35,22 +39,20 @@ typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL EFI_SMM_STANDBY_BUTTON
// Related Definitions // Related Definitions
// //
// ///
// Standby Button. Example, Use for changing LEDs before ACPI OS is on. /// Standby Button. Example, Use for changing LEDs before ACPI OS is on.
// - DXE/BDS Phase /// - DXE/BDS Phase
// - OS Install Phase /// - OS Install Phase
// ///
typedef enum { typedef enum {
EfiStandbyButtonEntry, EfiStandbyButtonEntry,
EfiStandbyButtonExit EfiStandbyButtonExit
} EFI_STANDBY_BUTTON_PHASE; } EFI_STANDBY_BUTTON_PHASE;
typedef struct { typedef struct {
// /// Describes whether the child handler should be invoked upon the entry to the button
// Describes whether the child handler should be invoked upon the entry to the button /// activation or upon exit (i.e., upon receipt of the button press event or upon release of
// activation or upon exit (i.e., upon receipt of the button press event or upon release of /// the event).
// the event).
//
EFI_STANDBY_BUTTON_PHASE Phase; EFI_STANDBY_BUTTON_PHASE Phase;
} EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT; } EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT;
@ -128,9 +130,18 @@ EFI_STATUS
// //
// Interface structure for the SMM Standby Button SMI Dispatch Protocol // Interface structure for the SMM Standby Button SMI Dispatch Protocol
// //
/**
This protocol provices the parent dispatch service for the standby button SMI source generator.
Provides the ability to install child handlers for the given event types.
**/
struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL { struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL {
EFI_SMM_STANDBY_BUTTON_REGISTER Register; ///
/// Installs a child service to be dispatched by this protocol.
///
EFI_SMM_STANDBY_BUTTON_REGISTER Register;\
///
/// Removes a child service dispatched by this protocol.
///
EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister; EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister;
}; };