tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refine include file for Device Recovery Module PPI. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8758 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24 2009-07-06 06:06:15 +00:00
parent 42c65073d2
commit 918294597a
1 changed files with 25 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
View File

@ -36,15 +36,17 @@
typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI; typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI;
/** /**
Returns the number of DXE capsules residing on the device.
This function searches for DXE capsules from the associated device and returns the number This function searches for DXE capsules from the associated device and returns the number
and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the
highest load priority and entry N is assumed to be the lowest priority. 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[in] PeiServices General-purpose services that are available to every PEIM
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output, @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
*NumberRecoveryCapsules contains the number of recovery capsule *NumberRecoveryCapsules contains the number of recovery capsule
images available for retrieval from this PEIM instance. images available for retrieval from this PEIM instance.
@retval EFI_SUCCESS One or more capsules were discovered. @retval EFI_SUCCESS One or more capsules were discovered.
@retval EFI_DEVICE_ERROR A device error occurred. @retval EFI_DEVICE_ERROR A device error occurred.
@ -60,15 +62,19 @@ EFI_STATUS
); );
/** /**
Returns the size and type of the requested recovery capsule.
This function gets the size and type of the requested recovery capsule. This function gets the size and type of the requested recovery capsule.
@param PeiServices General-purpose services that are available to every PEIM @param[in] PeiServices General-purpose services that are available to every PEIM
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies for which capsule instance to retrieve the information. @param[in] CapsuleInstance Specifies for which capsule instance to retrieve the information.
@param Size A pointer to a caller-allocated UINTN in which the size of This parameter must be between one and the value returned by
the requested recovery module is returned. GetNumberRecoveryCapsules() in NumberRecoveryCapsules.
@param CapsuleType A pointer to a caller-allocated EFI_GUID in @param[out] Size A pointer to a caller-allocated UINTN in which the size of
which the type of the requested recovery capsule is returned. the requested recovery module is returned.
@param[out] 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_SUCCESS One or more capsules were discovered.
@retval EFI_DEVICE_ERROR A device error occurred. @retval EFI_DEVICE_ERROR A device error occurred.
@ -86,14 +92,16 @@ EFI_STATUS
); );
/** /**
Loads a DXE capsule from some media into memory.
This function retrieves a DXE capsule from some device and loads it into memory. This function retrieves a DXE capsule from some device and loads it into memory.
Note that the published interface is device neutral. Note that the published interface is device neutral.
@param PeiServices General-purpose services that are available to every PEIM @param[in, out] PeiServices General-purpose services that are available to every PEIM
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies which capsule instance to retrieve. @param[in] CapsuleInstance Specifies which capsule instance to retrieve.
@param Buffer Specifies a caller-allocated buffer in which the requested @param[out] Buffer Specifies a caller-allocated buffer in which the requested
recovery capsule will be returned. recovery capsule will be returned.
@retval EFI_SUCCESS One or more capsules were discovered. @retval EFI_SUCCESS One or more capsules were discovered.
@retval EFI_DEVICE_ERROR A device error occurred. @retval EFI_DEVICE_ERROR A device error occurred.
@ -114,19 +122,8 @@ EFI_STATUS
/// regardless of the underlying device(s). /// regardless of the underlying device(s).
/// ///
struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI { struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {
///
/// Returns the number of DXE capsules that were found.
///
EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE GetNumberRecoveryCapsules; EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE GetNumberRecoveryCapsules;
///
/// Returns the capsule image type and the size of a given image.
///
EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO GetRecoveryCapsuleInfo; EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO GetRecoveryCapsuleInfo;
///
/// Loads a DXE capsule into memory
///
EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule; EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;
}; };