From 8069d49e9abf619afac16e44bf72266de57b1411 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Mon, 25 Feb 2008 07:01:44 +0000 Subject: update comments and add assert for these files. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4750 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/IndustryStandard/Tpm12.h | 31 +++---- MdePkg/Include/Library/IfrSupportLib.h | 33 +++---- MdePkg/Include/Library/PeiPiLib.h | 2 +- MdePkg/Include/Protocol/TcgService.h | 148 +++++++++++++++++++++++++++----- MdePkg/Include/Protocol/UsbIo.h | 4 +- 5 files changed, 155 insertions(+), 63 deletions(-) (limited to 'MdePkg/Include') diff --git a/MdePkg/Include/IndustryStandard/Tpm12.h b/MdePkg/Include/IndustryStandard/Tpm12.h index 1d489815ca..374d3131e3 100644 --- a/MdePkg/Include/IndustryStandard/Tpm12.h +++ b/MdePkg/Include/IndustryStandard/Tpm12.h @@ -1,25 +1,18 @@ -/*++ - -Copyright (c) 2005 - 2006, 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: - - Tpm12.h - -Abstract: - +/** + @file TPM Specification data structures (TCG TPM Specification Version 1.2 Revision 94) - See http://trustedcomputinggroup.org for latest specification updates ---*/ + Copyright (c) 2006 - 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 _TPM12_H_ #define _TPM12_H_ diff --git a/MdePkg/Include/Library/IfrSupportLib.h b/MdePkg/Include/Library/IfrSupportLib.h index 75c7f4785b..e3885e1db3 100644 --- a/MdePkg/Include/Library/IfrSupportLib.h +++ b/MdePkg/Include/Library/IfrSupportLib.h @@ -1,24 +1,17 @@ -/*++ - -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: - - IfrSupportLibrary.h - -Abstract: - +/** @file The file contain all library functions and definitions for IFR opcode creation and - related Form Browser utility Operations. - ---*/ + related Form Browser utility Operations. + + 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 _IFR_SUPPORT_LIBRARY_H #define _IFR_SUPPORT_LIBRARY_H diff --git a/MdePkg/Include/Library/PeiPiLib.h b/MdePkg/Include/Library/PeiPiLib.h index a1b472ac69..c79552c597 100644 --- a/MdePkg/Include/Library/PeiPiLib.h +++ b/MdePkg/Include/Library/PeiPiLib.h @@ -23,7 +23,7 @@ The function allocate the EFI_PEI_PPI_DESCRIPTOR structure and update the fields accordingly to parameter passed in and install the PPI. - @param FvStart Unique identifier of the format of the memory-mapped firmware volume. If NULL is specified, + @param FvFormat Unique identifier of the format of the memory-mapped firmware volume. If NULL is specified, EFI_FIRMWARE_FILE_SYSTEM2_GUID is used as the Format GUID. @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For diff --git a/MdePkg/Include/Protocol/TcgService.h b/MdePkg/Include/Protocol/TcgService.h index ddc4eaf286..aadd701719 100644 --- a/MdePkg/Include/Protocol/TcgService.h +++ b/MdePkg/Include/Protocol/TcgService.h @@ -1,25 +1,17 @@ -/*++ - -Copyright (c) 2006, 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: - - TcgService.h - -Abstract: - +/** @file TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final - - See http://trustedcomputinggroup.org for the latest specification - ---*/ + See http://trustedcomputinggroup.org for the latest specification + + 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 _TCG_SERVICE_PROTOCOL_H_ #define _TCG_SERVICE_PROTOCOL_H_ @@ -60,6 +52,31 @@ typedef UINT32 TCG_ALGORITHM_ID; // #pragma pack (pop) +/** + This service provides EFI protocol capability information, state information + about the TPM, and Event Log state information. + + @param This Indicates the calling context + @param ProtocolCapability The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY + structure and fills in the fields with the EFI protocol + capability information and the current TPM state information. + @param TCGFeatureFlags This is a pointer to the feature flags. No feature + flags are currently defined so this parameter + MUST be set to 0. However, in the future, + feature flags may be defined that, for example, + enable hash algorithm agility. + @param EventLogLocation This is a pointer to the address of the event log in memory. + @param EventLogLastEntry If the Event Log contains more than one entry, + this is a pointer to the address of the start of + the last entry in the event log in memory. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The receive buffer is too small. + @retval EFI_NOT_FOUND The component was not running + +**/ typedef EFI_STATUS (EFIAPI *EFI_TCG_STATUS_CHECK) ( @@ -71,6 +88,23 @@ EFI_STATUS OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry ); +/** + This service abstracts the capability to do a hash operation on a data buffer. + + @param This Indicates the calling context + @param HashData Pointer to the data buffer to be hashed + @param HashDataLen Length of the data buffer to be hashed + @param AlgorithmId Identification of the Algorithm to use for the hashing operation + @param HashedDataLen Resultant length of the hashed data + @param HashedDataResult Resultant buffer of the hashed data + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The receive buffer is too small. + @retval EFI_NOT_FOUND The component was not running + +**/ typedef EFI_STATUS (EFIAPI *EFI_TCG_HASH_ALL) ( @@ -82,6 +116,25 @@ EFI_STATUS IN OUT UINT8 **HashedDataResult ); +/** + This service abstracts the capability to add an entry to the Event Log. + + @param This Indicates the calling context + @param TCGLogData Pointer to the start of the data buffer containing + the TCG_PCR_EVENT data structure. All fields in + this structure are properly filled by the caller. + @param EventNumber The event number of the event just logged + @param Flags Indicate additional flags. Only one flag has been + defined at this time, which is 0x01 and means the + extend operation should not be performed. All + other bits are reserved. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The receive buffer is too small. + @retval EFI_NOT_FOUND The component was not running +**/ typedef EFI_STATUS (EFIAPI *EFI_TCG_LOG_EVENT) ( @@ -91,6 +144,21 @@ EFI_STATUS IN UINT32 Flags ); +/** + This service is a proxy for commands to the TPM. + + @param This Indicates the calling context + @param TpmInputParameterBlockSize Size of the TPM input parameter block + @param TpmInputParameterBlock Pointer to the TPM input parameter block + @param TpmOutputParameterBlockSize Size of the TPM output parameter block + @param TpmOutputParameterBlock Pointer to the TPM output parameter block + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The receive buffer is too small. + @retval EFI_NOT_FOUND The component was not running +**/ typedef EFI_STATUS (EFIAPI *EFI_TCG_PASS_THROUGH_TO_TPM) ( @@ -101,6 +169,29 @@ EFI_STATUS IN UINT8 *TpmOutputParameterBlock ); +/** + This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log + + @param This Indicates the calling context + @param HashData Physical address of the start of the data buffer + to be hashed, extended, and logged. + @param HashDataLen The length, in bytes, of the buffer referenced by HashData + @param AlgorithmId Identification of the Algorithm to use for the hashing operation + @param TCGLogData The physical address of the start of the data + buffer containing the TCG_PCR_EVENT data structure. + @param EventNumber The event number of the event just logged. + @param EventLogLastEntry Physical address of the first byte of the entry + just placed in the Event Log. If the Event Log was + empty when this function was called then this physical + address will be the same as the physical address of + the start of the Event Log. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_BUFFER_TOO_SMALL The receive buffer is too small. + @retval EFI_NOT_FOUND The component was not running +**/ typedef EFI_STATUS (EFIAPI *EFI_TCG_HASH_LOG_EXTEND_EVENT) ( @@ -113,6 +204,21 @@ EFI_STATUS OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry ); +/** + The EFI_TCG Protocol abstracts TCG activity. + + @param StatusCheck This service provides information on the TPM. + @param HashAll This service abstracts the capability to do a hash + operation on a data buffer. + @param LogEvent This service abstracts the capability to add + an entry to the Event Log. + @param PassThroughToTPM This service provides a pass-through capability + from the caller to the system¡¯s TPM. + @param HashLogExtendEvent This service abstracts the capability to do a hash + operation on a data buffer, extend a specific TPM PCR + with the hash result, and add an entry to the Event Log. + +**/ typedef struct _EFI_TCG_PROTOCOL { EFI_TCG_STATUS_CHECK StatusCheck; EFI_TCG_HASH_ALL HashAll; diff --git a/MdePkg/Include/Protocol/UsbIo.h b/MdePkg/Include/Protocol/UsbIo.h index 7d6ce276ab..833b706847 100644 --- a/MdePkg/Include/Protocol/UsbIo.h +++ b/MdePkg/Include/Protocol/UsbIo.h @@ -99,10 +99,10 @@ EFI_STATUS @param Request A pointer to the USB device request that will be sent to the USB device. @param Direction Indicates the data direction. - @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. @param Timeout Indicating the transfer should be completed within this time frame. The units are in milliseconds. + @param Data A pointer to the buffer of data that will be transmitted to USB + device or received from USB device. @param DataLength The size, in bytes, of the data buffer specified by Data. @param Status A pointer to the result of the USB transfer. -- cgit v1.2.3