diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
| commit | 0647c9adf92c6a8712091607a73b2768327a865d (patch) | |
| tree | 41c00f087dea23a35388100f5b9895753555ac3c /MdePkg/Include/Ppi | |
| parent | 151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff) | |
| download | edk2-platforms-0647c9adf92c6a8712091607a73b2768327a865d.tar.xz | |
Remove BugBug in comments and adjust function header according to code style doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Ppi')
| -rw-r--r-- | MdePkg/Include/Ppi/BlockIo.h | 71 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/BootScriptExecuter.h | 30 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/CpuIo.h | 176 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/DeviceRecoveryModule.h | 68 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/DxeIpl.h | 14 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/FindFv.h | 19 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/LoadFile.h | 26 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/PciCfg.h | 46 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/ReadOnlyVariable.h | 66 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/RecoveryModule.h | 15 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/S3Resume.h | 9 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/SecPlatformInformation.h | 15 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/SectionExtraction.h | 76 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/Security.h | 16 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/Smbus.h | 164 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/Stall.h | 14 |
16 files changed, 325 insertions, 500 deletions
diff --git a/MdePkg/Include/Ppi/BlockIo.h b/MdePkg/Include/Ppi/BlockIo.h index debcc0c8e4..4bb029ff43 100644 --- a/MdePkg/Include/Ppi/BlockIo.h +++ b/MdePkg/Include/Ppi/BlockIo.h @@ -48,10 +48,8 @@ typedef struct { /**
Gets the count of block I/O devices that one specific block driver detects.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
@param NumberBlockDevices The number of block I/O devices discovered.
@return Status code
@@ -68,21 +66,17 @@ EFI_STATUS /**
Gets a block device¡¯s media information.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
- @param DeviceIndex Specifies the block device to which the function
- wants to talk. Because the driver that implements Block I/O PPIs
- will manage multiple block devices, the PPIs that want to talk to a single
- device must specify the device index that was assigned during the enumeration
- process. This index is a number from one to NumberBlockDevices.
-
- @param MediaInfo The media information of the specified block media.
-
- @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
-
- @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
+ @param DeviceIndex Specifies the block device to which the function
+ wants to talk. Because the driver that implements Block I/O PPIs
+ will manage multiple block devices, the PPIs that want to talk to a single
+ device must specify the device index that was assigned during the enumeration
+ process. This index is a number from one to NumberBlockDevices.
+ @param MediaInfo The media information of the specified block media.
+
+ @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
+ @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
**/
typedef
@@ -97,31 +91,22 @@ EFI_STATUS /**
Reads the requested number of blocks from the specified block device.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
- @param DeviceIndex Specifies the block device to which the function wants to talk.
-
- @param StartLBA The starting logical block address (LBA) to read from on the device
-
- @param BufferSize The size of the Buffer in bytes. This number must
- be a multiple of the intrinsic block size of the device.
-
- @param Buffer A pointer to the destination buffer for the data.
- The caller is responsible for the ownership of the buffer.
-
- @retval EFI_SUCCESS The data was read correctly from the device.
-
- @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
-
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
+ @param DeviceIndex Specifies the block device to which the function wants to talk.
+ @param StartLBA The starting logical block address (LBA) to read from on the device
+ @param BufferSize The size of the Buffer in bytes. This number must
+ be a multiple of the intrinsic block size of the device.
+ @param Buffer A pointer to the destination buffer for the data.
+ The caller is responsible for the ownership of the buffer.
+
+ @retval EFI_SUCCESS The data was read correctly from the device.
+ @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
- or the buffer is not properly aligned.
-
- @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
- the intrinsic block size of the device.
-
- @retval EFI_NO_MEDIA There is no media in the device.
+ or the buffer is not properly aligned.
+ @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
+ the intrinsic block size of the device.
+ @retval EFI_NO_MEDIA There is no media in the device.
**/
typedef
diff --git a/MdePkg/Include/Ppi/BootScriptExecuter.h b/MdePkg/Include/Ppi/BootScriptExecuter.h index b73396d7fa..5b10292dff 100644 --- a/MdePkg/Include/Ppi/BootScriptExecuter.h +++ b/MdePkg/Include/Ppi/BootScriptExecuter.h @@ -31,25 +31,19 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP /**
Executes the Framework boot script table.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
-
- @param Address The physical memory address where the table is stored.
- It must be zero if the table to be executed is stored in a firmware volume file.
-
- @param FvFile The firmware volume file name that contains the table to
- be executed. It must be NULL if the table to be executed is stored in physical memory.
-
- @retval EFI_SUCCESS The boot script table was executed successfully.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
+ @param Address The physical memory address where the table is stored.
+ It must be zero if the table to be executed is stored in a firmware volume file.
+ @param FvFile The firmware volume file name that contains the table to
+ be executed. It must be NULL if the table to be executed is stored in physical memory.
+
+ @retval EFI_SUCCESS The boot script table was executed successfully.
@retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
-
- @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
-
- @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
- Or An unsupported opcode occurred in the table.
- Or There were opcode execution errors, such as an insufficient dependency.
+ @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
+ @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
+ Or An unsupported opcode occurred in the table.
+ Or There were opcode execution errors, such as an insufficient dependency.
**/
typedef
diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h index 038703386d..791348d3f9 100644 --- a/MdePkg/Include/Ppi/CpuIo.h +++ b/MdePkg/Include/Ppi/CpuIo.h @@ -52,21 +52,15 @@ typedef enum { /**
Memory-based access services and I/O-based access services.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param Count The number of accesses to perform.
-
- @param Buffer A pointer to the buffer of data.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param Count The number of accesses to perform.
+ @param Buffer A pointer to the buffer of data.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
**/
typedef
@@ -93,11 +87,9 @@ typedef struct { /**
8-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT8
@@ -113,11 +105,9 @@ UINT8 /**
16-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT16
@@ -133,11 +123,9 @@ UINT16 /**
32-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT32
@@ -153,11 +141,9 @@ UINT32 /**
64-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT64
@@ -173,13 +159,10 @@ UINT64 /**
8-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -196,13 +179,10 @@ VOID /**
16-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -219,13 +199,10 @@ VOID /**
32-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -242,13 +219,10 @@ VOID /**
64-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -265,11 +239,9 @@ VOID /**
8-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT8
@@ -285,11 +257,9 @@ UINT8 /**
16-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT16
@@ -305,11 +275,9 @@ UINT16 /**
32-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT32
@@ -325,11 +293,9 @@ UINT32 /**
64-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT64
@@ -345,13 +311,10 @@ UINT64 /**
8-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -368,13 +331,10 @@ VOID /**
16-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -391,13 +351,10 @@ VOID /**
32-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -414,13 +371,10 @@ VOID /**
64-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h index 3847686b04..46c5cdeaae 100644 --- a/MdePkg/Include/Ppi/DeviceRecoveryModule.h +++ b/MdePkg/Include/Ppi/DeviceRecoveryModule.h @@ -34,19 +34,15 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL the capsules discovered. Entry 1 is assumed to be the highest load priority
and entry N is assumed to be the lowest priority.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
- @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
- *NumberRecoveryCapsules contains the number of recovery capsule images available
- for retrieval from this PEIM instance.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
+ @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
+ *NumberRecoveryCapsules contains the number of recovery capsule
+ images available for retrieval from this PEIM instance.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -60,23 +56,17 @@ EFI_STATUS /**
This function gets the size and type of the requested recovery capsule.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies for which capsule instance to retrieve the information.
-
- @param Size A pointer to a caller-allocated UINTN in which the size of
- the requested recovery module is returned.
-
- @param CapsuleType A pointer to a caller-allocated EFI_GUID in
- which the type of the requested recovery capsule is returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Size A pointer to a caller-allocated UINTN in which the size of
+ the requested recovery module is returned.
+ @param CapsuleType A pointer to a caller-allocated EFI_GUID in
+ which the type of the requested recovery capsule is returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -93,19 +83,15 @@ EFI_STATUS This function, by whatever mechanism, retrieves a DXE capsule from some device
and loads it into memory. Note that the published interface is device neutral.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies which capsule instance to retrieve.
-
- @param Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Buffer Specifies a caller-allocated buffer in which the requested
+ recovery capsule will be returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h index bed579522c..3a92135651 100644 --- a/MdePkg/Include/Ppi/DxeIpl.h +++ b/MdePkg/Include/Ppi/DxeIpl.h @@ -33,14 +33,12 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI; The architectural PPI that the PEI Foundation invokes when
there are no additional PEIMs to invoke.
- @param This Pointer to the DXE IPL PPI instance
-
- @param PeiServices Pointer to the PEI Services Table.
-
- @param HobList Pointer to the list of Hand-Off Block (HOB) entries.
-
- @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter
- some exception handling.Under normal circumstances, the DXE IPL PPI should not return.
+ @param This Pointer to the DXE IPL PPI instance
+ @param PeiServices Pointer to the PEI Services Table.
+ @param HobList Pointer to the list of Hand-Off Block (HOB) entries.
+
+ @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter
+ some exception handling.Under normal circumstances, the DXE IPL PPI should not return.
**/
typedef
diff --git a/MdePkg/Include/Ppi/FindFv.h b/MdePkg/Include/Ppi/FindFv.h index 971512558b..9a3e173742 100644 --- a/MdePkg/Include/Ppi/FindFv.h +++ b/MdePkg/Include/Ppi/FindFv.h @@ -33,18 +33,13 @@ typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI; was passed in FvNumber.Once this function reports a firmware volume
index/base address pair, that index/address pairing must continue throughout PEI.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Interface pointer that implements the Find FV service.
-
- @param FvNumber The index of the firmware volume to locate.
-
- @param FvAddress The address of the volume to discover.
-
- @retval EFI_SUCCESS An additional firmware volume was found.
-
- @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Interface pointer that implements the Find FV service.
+ @param FvNumber The index of the firmware volume to locate.
+ @param FvAddress The address of the volume to discover.
+
+ @retval EFI_SUCCESS An additional firmware volume was found.
+ @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
@retval EFI_INVALID_PARAMETER *FvAddress is NULL.
**/
diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h index af02be7c9e..f6d8a704ee 100644 --- a/MdePkg/Include/Ppi/LoadFile.h +++ b/MdePkg/Include/Ppi/LoadFile.h @@ -30,22 +30,16 @@ typedef struct _EFI_PEI_FV_FILE_LOADER_PPI EFI_PEI_FV_FILE_LOADER_PPI; /**
Loads a PEIM into memory for subsequent execution.
- @param This Interface pointer that implements the Load File PPI instance.
-
- @param FfsHeader Pointer to the FFS header of the file to load.
-
- @param ImageAddress Pointer to the address of the loaded Image
-
- @param ImageSize Pointer to the size of the loaded image.
-
- @param EntryPoint Pointer to the entry point of the image.
-
- @retval EFI_SUCCESS The image was loaded successfully.
-
- @retval EFI_OUT_OF_RESOURCES There was not enough memory.
-
- @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
- contain a valid PE/COFF image that could be loaded.
+ @param This Interface pointer that implements the Load File PPI instance.
+ @param FfsHeader Pointer to the FFS header of the file to load.
+ @param ImageAddress Pointer to the address of the loaded Image
+ @param ImageSize Pointer to the size of the loaded image.
+ @param EntryPoint Pointer to the entry point of the image.
+
+ @retval EFI_SUCCESS The image was loaded successfully.
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory.
+ @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
+ contain a valid PE/COFF image that could be loaded.
**/
typedef
diff --git a/MdePkg/Include/Ppi/PciCfg.h b/MdePkg/Include/Ppi/PciCfg.h index b38a0db3ce..987f54ed43 100644 --- a/MdePkg/Include/Ppi/PciCfg.h +++ b/MdePkg/Include/Ppi/PciCfg.h @@ -51,19 +51,14 @@ typedef struct { /**
PCI read and write operation.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param Buffer A pointer to the buffer of data.
-
- @retval EFI_SUCCESS The function completed successfully.
-
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param Buffer A pointer to the buffer of data.
+
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_YET_AVAILABLE The service has not been installed.
**/
@@ -80,20 +75,15 @@ EFI_STATUS /**
PCI read-modify-write operation.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param SetBits Value of the bits to set.
-
- @param ClearBits Value of the bits to clear.
-
- @retval EFI_SUCCESS The function completed successfully.
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param SetBits Value of the bits to set.
+ @param ClearBits Value of the bits to clear.
+
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -119,7 +109,7 @@ EFI_STATUS PCI write services. See the Write() function description.
@param Modify
-PCI read-modify-write services. See the Modify() function description.
+ PCI read-modify-write services. See the Modify() function description.
**/
struct _EFI_PEI_PCI_CFG_PPI {
diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable.h b/MdePkg/Include/Ppi/ReadOnlyVariable.h index 3ea3c77535..e730ce8493 100644 --- a/MdePkg/Include/Ppi/ReadOnlyVariable.h +++ b/MdePkg/Include/Ppi/ReadOnlyVariable.h @@ -39,29 +39,20 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI; /**
Get Variable value by Name and GUID pair
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes If not NULL, a pointer to the memory location to return
- the attributes bitmask for the variable.
-
- @param DataSize On input, the size in bytes of the return Data buffer.
- On output, the size of data returned in Data.
-
- @param Data The buffer to return the contents of the variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
-
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes If not NULL, a pointer to the memory location to return
+ the attributes bitmask for the variable.
+ @param DataSize On input, the size in bytes of the return Data buffer.
+ On output, the size of data returned in Data.
+ @param Data The buffer to return the contents of the variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
+ @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
**/
typedef
@@ -82,27 +73,20 @@ EFI_STATUS and on output the interface returns the next variable name data. When the
entire variable list has been returned, the error EFI_NOT_FOUND is returned.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
@param VariableNameSize The size of the VariableName buffer.
-
- @param VariableName On input, supplies the last VariableName that was
- returned by GetNextVariableName(). On output, returns the Null-terminated
- Unicode string of the current variable.
-
- @param VendorGuid On input, supplies the last VendorGuid that was
- returned by GetNextVariableName(). On output, returns the VendorGuid
- of the current variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The next variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
-
+ @param VariableName On input, supplies the last VariableName that was
+ returned by GetNextVariableName(). On output, returns the Null-terminated
+ Unicode string of the current variable.
+ @param VendorGuid On input, supplies the last VendorGuid that was
+ returned by GetNextVariableName(). On output, returns the VendorGuid
+ of the current variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The next variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
+ @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
**/
typedef
diff --git a/MdePkg/Include/Ppi/RecoveryModule.h b/MdePkg/Include/Ppi/RecoveryModule.h index 044a68aa72..8dbb951df5 100644 --- a/MdePkg/Include/Ppi/RecoveryModule.h +++ b/MdePkg/Include/Ppi/RecoveryModule.h @@ -32,15 +32,12 @@ typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI; Loads a DXE capsule from some media into memory and updates the HOB table
with the DXE firmware volume information.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
-
- @retval EFI_SUCCESS The capsule was loaded correctly.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
+
+ @retval EFI_SUCCESS The capsule was loaded correctly.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
diff --git a/MdePkg/Include/Ppi/S3Resume.h b/MdePkg/Include/Ppi/S3Resume.h index c458430b98..c5c02595f7 100644 --- a/MdePkg/Include/Ppi/S3Resume.h +++ b/MdePkg/Include/Ppi/S3Resume.h @@ -32,12 +32,11 @@ typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI; Restores the platform to its preboot configuration for an S3 resume and
jumps to the OS waking vector.
- @param PeiServices Pointer to the PEI Services Table
+ @param PeiServices Pointer to the PEI Services Table
- @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
-
- @retval EFI_NOT_FOUND Some necessary information that is used for
- the S3 resume boot path could not be located.
+ @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
+ @retval EFI_NOT_FOUND Some necessary information that is used for
+ the S3 resume boot path could not be located.
**/
typedef
diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h index 1e9625923c..b7dd03e6ce 100644 --- a/MdePkg/Include/Ppi/SecPlatformInformation.h +++ b/MdePkg/Include/Ppi/SecPlatformInformation.h @@ -54,15 +54,12 @@ typedef struct { /**
This interface conveys state information out of the Security (SEC) phase into PEI.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param StructureSize Pointer to the variable describing size of the input buffer.
-
- @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
-
- @retval EFI_SUCCESS The data was successfully returned.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
+ @param PeiServices Pointer to the PEI Services Table.
+ @param StructureSize Pointer to the variable describing size of the input buffer.
+ @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
+
+ @retval EFI_SUCCESS The data was successfully returned.
+ @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
**/
typedef
diff --git a/MdePkg/Include/Ppi/SectionExtraction.h b/MdePkg/Include/Ppi/SectionExtraction.h index afa473d9ef..fb95f6065a 100644 --- a/MdePkg/Include/Ppi/SectionExtraction.h +++ b/MdePkg/Include/Ppi/SectionExtraction.h @@ -41,50 +41,40 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI; It will retrieve both encapsulation sections and leaf sections in their entirety,
exclusive of the section header.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Indicates the calling context
-
- @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,
- the contents of the entire section are returned in Buffer. If SectionType
- is not NULL, only the requested section is returned.
-
- @param SectionDefinitionGuid Pointer to an EFI_GUID.
- If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
- indicates for which section GUID to search.
- If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
- is unused and is ignored.
-
- @param SectionInstance If SectionType is not NULL, indicates which
- instance of the requested section type to return.
-
- @param Buffer Pointer to a pointer to a buffer in which the section
- contents are returned.
-
- @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize
- indicates the size in bytes of the memory region pointed to by Buffer.On output,
- *BufferSize contains the number of bytes required to read the section.
-
- @param AuthenticationStatus A pointer to a caller-allocated UINT32 in
- which any metadata from encapsulating GUID-defined sections is returned.
-
- @retval EFI_SUCCESS The section was successfully processed and the section
- contents were returned in Buffer.
-
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
- the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but
- there was no corresponding GUIDed Section Extraction Protocol in the
- handle database.*Buffer is unmodified.
-
- @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.
-
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Indicates the calling context
+ @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,
+ the contents of the entire section are returned in Buffer. If SectionType
+ is not NULL, only the requested section is returned.
+ @param SectionDefinitionGuid
+ Pointer to an EFI_GUID.
+ If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
+ indicates for which section GUID to search.
+ If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
+ is unused and is ignored.
+ @param SectionInstance If SectionType is not NULL, indicates which
+ instance of the requested section type to return.
+ @param Buffer Pointer to a pointer to a buffer in which the section
+ contents are returned.
+ @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize
+ indicates the size in bytes of the memory region pointed to by Buffer.On output,
+ *BufferSize contains the number of bytes required to read the section.
+ @param AuthenticationStatus
+ A pointer to a caller-allocated UINT32 in
+ which any metadata from encapsulating GUID-defined sections is returned.
+
+ @retval EFI_SUCCESS The section was successfully processed and the section
+ contents were returned in Buffer.
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
+ the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but
+ there was no corresponding GUIDed Section Extraction Protocol in the
+ handle database.*Buffer is unmodified.
+ @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
-
- @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to
- contain the requested section. The input buffer is filled and contents are
- section contents are truncated.
+ @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to
+ contain the requested section. The input buffer is filled and contents are
+ section contents are truncated.
**/
typedef
diff --git a/MdePkg/Include/Ppi/Security.h b/MdePkg/Include/Ppi/Security.h index cc59023bf5..b0f0626406 100644 --- a/MdePkg/Include/Ppi/Security.h +++ b/MdePkg/Include/Ppi/Security.h @@ -32,18 +32,14 @@ typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI; Allows the platform builder to implement a security policy in response
to varying file authentication states.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
-
- @param AuthenticationStatus Status returned by the verification service as part of section extraction.
-
- @param FfsFileHeader Pointer to the file under review.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
+ @param AuthenticationStatus
+ Status returned by the verification service as part of section extraction.
+ @param FfsFileHeader Pointer to the file under review.
@param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
- @retval EFI_SUCCESS The service performed its action successfully.
-
+ @retval EFI_SUCCESS The service performed its action successfully.
@retval EFI_SECURITY_VIOLATION The object cannot be trusted
**/
diff --git a/MdePkg/Include/Ppi/Smbus.h b/MdePkg/Include/Ppi/Smbus.h index 7360e5b12f..c0e1d9022d 100644 --- a/MdePkg/Include/Ppi/Smbus.h +++ b/MdePkg/Include/Ppi/Smbus.h @@ -31,48 +31,34 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI; /**
Executes an SMBus operation to an SMBus controller.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Command This command is transmitted by the SMBus host
- controller to the SMBus slave device and the interpretation is
- SMBus slave device specific.
-
- @param Operation Signifies which particular SMBus hardware protocol
- instance that it will use to execute the SMBus transactions.
-
- @param PecCheck Defines if Packet Error Code (PEC) checking is required
- for this operation.
-
- @param Length Signifies the number of bytes that this operation will do.
-
- @param Buffer Contains the value of data to execute to the SMBus slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
-
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_DEVICE_ERROR The request was not completed because
- a failure reflected in the Host Status Register bit.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Command This command is transmitted by the SMBus host
+ controller to the SMBus slave device and the interpretation is
+ SMBus slave device specific.
+ @param Operation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param PecCheck Defines if Packet Error Code (PEC) checking is required
+ for this operation.
+ @param Length Signifies the number of bytes that this operation will do.
+ @param Buffer Contains the value of data to execute to the SMBus slave device.
+
+ @retval EFI_SUCCESS The last data that was returned from the access
+ matched the poll exit criteria.
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.
+ Timeout is determined by the SMBus host controller device.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_DEVICE_ERROR The request was not completed because
+ a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
- Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
- EfiSmbusQuickWrite. Length is outside the range of valid values.
-
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
-
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
+ EfiSmbusQuickWrite. Length is outside the range of valid values.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
+ @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
**/
typedef
@@ -102,15 +88,12 @@ typedef struct { /**
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Data Data of the SMBus host notify command that
- the caller wants to be called.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Data Data of the SMBus host notify command that
+ the caller wants to be called.
@return Status Code
@@ -128,32 +111,24 @@ EFI_STATUS The ArpDevice() function enumerates the entire bus or enumerates a specific
device that is identified by SmbusUdid.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param ArpAll A Boolean expression that indicates if the host drivers need
- to enumerate all the devices or enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
- will be at SlaveAddress.
-
- @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
- The UDID may not exist for SMBus devices with fixed addresses.
-
- @param SlaveAddress The new SMBus address for the slave device for
- which the operation is targeted.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param ArpAll A Boolean expression that indicates if the host drivers need
+ to enumerate all the devices or enumerate only the device that is identified
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
+ will be at SlaveAddress.
+ @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
+ The UDID may not exist for SMBus devices with fixed addresses.
+ @param SlaveAddress The new SMBus address for the slave device for
+ which the operation is targeted.
+
+ @retval EFI_SUCCESS The SMBus slave device address was set.
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
-
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_TIMEOUT The SMBus slave device did not respond.
+ @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
**/
typedef
@@ -175,16 +150,13 @@ typedef struct { The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param Length Size of the buffer that contains the SMBus device map.
-
- @param SmbusDeviceMap The pointer to the device map as enumerated
- by the SMBus controller driver.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param Length Size of the buffer that contains the SMBus device map.
+ @param SmbusDeviceMap The pointer to the device map as enumerated
+ by the SMBus controller driver.
- @retval EFI_SUCCESS The device map was returned correctly in the buffer.
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/
typedef
@@ -200,20 +172,16 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress Address that the host controller detects as
- sending a message and calls all the registered functions.
-
- @param Data Data that the host controller detects as sending a message
- and calls all the registered functions.
-
- @param NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction has been registered.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress Address that the host controller detects as
+ sending a message and calls all the registered functions.
+ @param Data Data that the host controller detects as sending a message
+ and calls all the registered functions.
+ @param NotifyFunction The function to call when the bus driver
+ detects the SlaveAddress and Data pair.
+
+ @retval EFI_SUCCESS NotifyFunction has been registered.
**/
typedef
diff --git a/MdePkg/Include/Ppi/Stall.h b/MdePkg/Include/Ppi/Stall.h index 363baa6d39..a54e7ce640 100644 --- a/MdePkg/Include/Ppi/Stall.h +++ b/MdePkg/Include/Ppi/Stall.h @@ -34,14 +34,12 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI; The Stall() function provides a blocking stall for at least the number
of microseconds stipulated in the final argument of the API.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to the local data for the interface.
-
- @param Microseconds Number of microseconds for which to stall.
-
- @retval EFI_SUCCESS The service provided at least the required delay.
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to the local data for the interface.
+ @param Microseconds Number of microseconds for which to stall.
+
+ @retval EFI_SUCCESS The service provided at least the required delay.
**/
typedef
|