Clean up formatting and some Doxygen comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8746 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@ -17,8 +17,6 @@
|
|||||||
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.
|
||||||
|
|
||||||
Module Name: DeviceRecoveryModule.h
|
|
||||||
|
|
||||||
@par Revision Reference:
|
@par Revision Reference:
|
||||||
This PPI is defined in Framework of EFI Recovery spec.
|
This PPI is defined in Framework of EFI Recovery spec.
|
||||||
Version 0.9
|
Version 0.9
|
||||||
@ -38,10 +36,9 @@
|
|||||||
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;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This function, by whatever mechanism, searches for DXE capsules from the
|
This function searches for DXE capsules from the associated device and returns the number
|
||||||
associated device and returns the number and maximum size in bytes of
|
and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the
|
||||||
the capsules discovered. Entry 1 is assumed to be the highest load priority
|
highest load priority and entry N is assumed to be the lowest priority.
|
||||||
and entry N is assumed to be the lowest priority.
|
|
||||||
|
|
||||||
@param PeiServices General-purpose services that are available to every PEIM
|
@param PeiServices General-purpose services that are available to every PEIM
|
||||||
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
|
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
|
||||||
@ -57,9 +54,9 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
|
|||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
(EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE)(
|
(EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE)(
|
||||||
IN EFI_PEI_SERVICES **PeiServices,
|
IN EFI_PEI_SERVICES **PeiServices,
|
||||||
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
||||||
OUT UINTN *NumberRecoveryCapsules
|
OUT UINTN *NumberRecoveryCapsules
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -81,16 +78,16 @@ EFI_STATUS
|
|||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
(EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO)(
|
(EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO)(
|
||||||
IN EFI_PEI_SERVICES **PeiServices,
|
IN EFI_PEI_SERVICES **PeiServices,
|
||||||
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
||||||
IN UINTN CapsuleInstance,
|
IN UINTN CapsuleInstance,
|
||||||
OUT UINTN *Size,
|
OUT UINTN *Size,
|
||||||
OUT EFI_GUID *CapsuleType
|
OUT EFI_GUID *CapsuleType
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This function, by whatever mechanism, retrieves a DXE capsule from some device
|
This function retrieves a DXE capsule from some device and loads it into memory.
|
||||||
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 PeiServices General-purpose services that are available to every PEIM
|
||||||
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
|
@param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
|
||||||
@ -107,9 +104,9 @@ typedef
|
|||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE)(
|
(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE)(
|
||||||
IN OUT EFI_PEI_SERVICES **PeiServices,
|
IN OUT EFI_PEI_SERVICES **PeiServices,
|
||||||
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
|
||||||
IN UINTN CapsuleInstance,
|
IN UINTN CapsuleInstance,
|
||||||
OUT VOID *Buffer
|
OUT VOID *Buffer
|
||||||
);
|
);
|
||||||
|
|
||||||
///
|
///
|
||||||
@ -135,4 +132,4 @@ struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {
|
|||||||
|
|
||||||
extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid;
|
extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid;
|
||||||
|
|
||||||
#endif
|
#endif /* _PEI_DEVICE_RECOVERY_MODULE_PPI_H_ */
|
||||||
|
Reference in New Issue
Block a user