X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FPpi%2FCapsule.h;h=cddc12ae4f43aec644c22ee68ed9a4009674e578;hp=c8fd72fcd8172aa00c970b8c4cb34dad89cd1b6a;hb=9095d37b8fe5bfc3d02adad6ba7fd7359ebc0107;hpb=d1102dba7210b95e41d06c2338a22ba6af248645 diff --git a/MdePkg/Include/Ppi/Capsule.h b/MdePkg/Include/Ppi/Capsule.h index c8fd72fcd8..cddc12ae4f 100644 --- a/MdePkg/Include/Ppi/Capsule.h +++ b/MdePkg/Include/Ppi/Capsule.h @@ -1,12 +1,12 @@ /** @file - Defines the APIs that enable PEI services to work with + Defines the APIs that enable PEI services to work with the underlying capsule capabilities of the platform. -Copyright (c) 2015, 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 that accompanies this distribution. +Copyright (c) 2015 - 2018, 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 that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. +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. @@ -38,23 +38,23 @@ typedef struct _EFI_PEI_CAPSULE_PPI EFI_PEI_CAPSULE_PPI; typedef struct _EFI_PEI_CAPSULE_PPI PEI_CAPSULE_PPI; /** - Upon determining that there is a capsule to operate on, this service - will use a series of EFI_CAPSULE_BLOCK_DESCRIPTOR entries to determine - the current location of the various capsule fragments and coalesce them - into a contiguous region of system memory. + Upon determining that there is a capsule to operate on, this service + will use a series of EFI_CAPSULE_BLOCK_DESCRIPTOR entries to determine + the current location of the various capsule fragments and coalesce them + into a contiguous region of system memory. @param[in] PeiServices Pointer to the PEI Services Table. @param[out] MemoryBase Pointer to the base of a block of memory into which the buffers will be coalesced. - On output, this variable will hold the base address + On output, this variable will hold the base address of a coalesced capsule. @param[out] MemorySize Size of the memory region pointed to by MemoryBase. On output, this variable will contain the size of the coalesced capsule. - @retval EFI_NOT_FOUND If: boot modecould not be determined, or the - boot mode is not flash-update, or the capsule descriptors were not found. - @retval EFI_BUFFER_TOO_SMALL The capsule could not be coalesced in the provided memory region. - @retval EFI_SUCCESS There was no capsule, or the capsule was processed successfully. + @retval EFI_NOT_FOUND If: boot modecould not be determined, or the + boot mode is not flash-update, or the capsule descriptors were not found. + @retval EFI_BUFFER_TOO_SMALL The capsule could not be coalesced in the provided memory region. + @retval EFI_SUCCESS There was no capsule, or the capsule was processed successfully. **/ typedef @@ -66,12 +66,12 @@ EFI_STATUS ); /** - Determine if a capsule needs to be processed. + Determine if a capsule needs to be processed. The means by which the presence of a capsule is determined is platform - specific. For example, an implementation could be driven by the presence - of a Capsule EFI Variable containing a list of EFI_CAPSULE_BLOCK_DESCRIPTOR + specific. For example, an implementation could be driven by the presence + of a Capsule EFI Variable containing a list of EFI_CAPSULE_BLOCK_DESCRIPTOR entries. If present, return EFI_SUCCESS, otherwise return EFI_NOT_FOUND. - + @param[in] PeiServices Pointer to the PEI Services Table. @retval EFI_SUCCESS If a capsule is available. @@ -87,9 +87,9 @@ EFI_STATUS /** The Capsule PPI service that gets called after memory is available. The capsule coalesce function, which must be called first, returns a base - address and size. Once the memory init PEIM has discovered memory, - it should call this function and pass in the base address and size - returned by the Coalesce() function. Then this function can create a + address and size. Once the memory init PEIM has discovered memory, + it should call this function and pass in the base address and size + returned by the Coalesce() function. Then this function can create a capsule HOB and return. @par Notes: @@ -97,7 +97,7 @@ EFI_STATUS actual capsule update. @param[in] PeiServices Pointer to the PEI Services Table. - @param[in] CapsuleBase Address returned by the capsule coalesce function. + @param[in] CapsuleBase Address returned by the capsule coalesce function. @param[in] CapsuleSize Value returned by the capsule coalesce function. @retval EFI_VOLUME_CORRUPTED CapsuleBase does not appear to point to a @@ -110,13 +110,13 @@ EFI_STATUS (EFIAPI *EFI_PEI_CAPSULE_CREATE_STATE)( IN EFI_PEI_SERVICES **PeiServices, IN VOID *CapsuleBase, - IN UINTN CapsuleSize + IN UINTN CapsuleSize ); /// /// This PPI provides several services in PEI to work with the underlying -/// capsule capabilities of the platform. These services include the ability -/// for PEI to coalesce a capsule from a scattered set of memory locations +/// capsule capabilities of the platform. These services include the ability +/// for PEI to coalesce a capsule from a scattered set of memory locations /// into a contiguous space in memory, detect if a capsule is present for /// processing, and once memory is available, create a HOB for the capsule. ///