The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r
Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
\r
- @param FfsHeader Pointer to the FFS file header. \r
- \r
- @param PeiServices Describes the list of possible PEI Services.\r
+ @param FfsHeader Pointer to the FFS file header.\r
+ @param PeiServices Describes the list of possible PEI Services.\r
\r
@return Status code\r
\r
/**\r
Entry point of the notification callback function itself within the PEIM.\r
\r
- @param PeiServices Indirect reference to the PEI Services Table.\r
- \r
+ @param PeiServices Indirect reference to the PEI Services Table.\r
@param NotifyDescriptor Address of the notification descriptor data structure.\r
- \r
- @param Ppi Address of the PPI that was installed.\r
+ @param Ppi Address of the PPI that was installed.\r
\r
@return Status code\r
\r
service is to publish an interface that other parties can use to call \r
additional PEIMs.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table \r
- published by the PEI Foundation. \r
- \r
- @param PpiList A pointer to the list of interfaces that the caller shall install.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
+ published by the PEI Foundation.\r
+ @param PpiList A pointer to the list of interfaces that the caller shall install.\r
\r
- @retval EFI_SUCCESS The interface was successfully installed.\r
- \r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
- \r
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
+ @retval EFI_SUCCESS The interface was successfully installed.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
typedef\r
can use to replace a same-named interface in the protocol database \r
with a different interface. \r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table \r
- published by the PEI Foundation. \r
- \r
- @param OldPpi A pointer to the former PPI in the database. \r
- \r
- @param NewPpi A pointer to the new interfaces that the caller shall install.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
+ published by the PEI Foundation.\r
+ @param OldPpi A pointer to the former PPI in the database.\r
+ @param NewPpi A pointer to the new interfaces that the caller shall install.\r
\r
- @retval EFI_SUCCESS The interface was successfully installed.\r
- \r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
- \r
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
- \r
- @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
+ @retval EFI_SUCCESS The interface was successfully installed.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+ list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
+ @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
\r
**/\r
typedef\r
/**\r
This function locates an interface in the PEI PPI database by GUID. \r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
- \r
- @param Guid A pointer to the GUID whose corresponding interface needs to be found.\r
- \r
- @param Instance The N-th instance of the interface that is required.\r
- \r
- @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
- \r
- @param Ppi A pointer to the instance of the interface. \r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
+ @param Guid A pointer to the GUID whose corresponding interface needs to be found.\r
+ @param Instance The N-th instance of the interface that is required.\r
+ @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
+ @param Ppi A pointer to the instance of the interface.\r
\r
- @retval EFI_SUCCESS The interface was successfully returned.\r
- \r
- @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r
+ @retval EFI_SUCCESS The interface was successfully returned.\r
+ @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r
\r
**/\r
typedef\r
is to publish an interface that other parties can use to call additional PPIs \r
that may materialize later.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
- \r
- @param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+ @param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
\r
- @retval EFI_SUCCESS The interface was successfully installed.\r
- \r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
- \r
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
+ @retval EFI_SUCCESS The interface was successfully installed.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+ list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
typedef\r
/**\r
This function returns the present value of the boot mode.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. \r
- \r
- @param BootMode A pointer to contain the value of the boot mode.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param BootMode A pointer to contain the value of the boot mode.\r
\r
- @retval EFI_SUCCESS The boot mode was returned successfully.\r
+ @retval EFI_SUCCESS The boot mode was returned successfully.\r
\r
**/\r
typedef\r
/**\r
This function sets the value of the boot mode.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
- \r
- @param BootMode The value of the boot mode to set.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+ @param BootMode The value of the boot mode to set.\r
\r
- @retval EFI_SUCCESS The boot mode was returned successfully.\r
+ @retval EFI_SUCCESS The boot mode was returned successfully.\r
\r
**/\r
typedef\r
/**\r
This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
- \r
- @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+ @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
\r
- @retval EFI_SUCCESS The list was successfully returned.\r
- \r
+ @retval EFI_SUCCESS The list was successfully returned.\r
@retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r
\r
**/\r
/**\r
This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB¡¯s) headers.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param Type The type of HOB to be installed.\r
- \r
- @param Length The length of the HOB to be added.\r
- \r
- @param Hob The address of a pointer that will contain the HOB header.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Type The type of HOB to be installed.\r
+ @param Length The length of the HOB to be added.\r
+ @param Hob The address of a pointer that will contain the HOB header.\r
\r
- @retval EFI_SUCCESS The HOB was successfully created.\r
- \r
- @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
+ @retval EFI_SUCCESS The HOB was successfully created.\r
+ @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
\r
**/\r
typedef\r
Given the input file pointer, this service searches for the next \r
matching file in the Firmware File System (FFS) volume.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).\r
- \r
- @param FwVolHeader Pointer to the firmware volume header of the volume to return.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).\r
+ @param FwVolHeader Pointer to the firmware volume header of the volume to return.\r
\r
- @retval EFI_SUCCESS The volume was found.\r
- \r
- @retval EFI_NOT_FOUND The volume was not found.\r
- \r
+ @retval EFI_SUCCESS The volume was found.\r
+ @retval EFI_NOT_FOUND The volume was not found.\r
@retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
\r
**/\r
Given the input file pointer, this service searches for the next matching \r
file in the Firmware File System (FFS) volume.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param SearchType A filter to find files only of this type.\r
- \r
- @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter must point to a valid FFS volume.\r
- \r
- @param FileHeader Pointer to the current file from which to begin searching.This pointer will be updated upon return to reflect the file found.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param SearchType A filter to find files only of this type.\r
+ @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter \r
+ must point to a valid FFS volume.\r
+ @param FileHeader Pointer to the current file from which to begin searching.This pointer will be \r
+ updated upon return to reflect the file found.\r
\r
- @retval EFI_SUCCESS The file was found.\r
- \r
- @retval EFI_NOT_FOUND The file was not found.\r
- \r
- @retval EFI_NOT_FOUND The header checksum was not zero.\r
+ @retval EFI_SUCCESS The file was found.\r
+ @retval EFI_NOT_FOUND The file was not found.\r
+ @retval EFI_NOT_FOUND The header checksum was not zero.\r
\r
**/\r
typedef\r
Given the input file pointer, this service searches for the next \r
matching file in the Firmware File System (FFS) volume. \r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param SectionType The value of the section type to find.\r
- \r
- @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.\r
- \r
- @param SectionData A pointer to the discovered section, if successful.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param SectionType The value of the section type to find.\r
+ @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.\r
+ @param SectionData A pointer to the discovered section, if successful.\r
\r
- @retval EFI_SUCCESS The section was found.\r
- \r
- @retval EFI_NOT_FOUND The section was not found.\r
+ @retval EFI_SUCCESS The section was found.\r
+ @retval EFI_NOT_FOUND The section was not found.\r
\r
**/\r
typedef\r
/**\r
This function registers the found memory configuration with the PEI Foundation.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param MemoryBegin The value of a region of installed memory\r
- \r
- @param MemoryLength The corresponding length of a region of installed memory.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param MemoryBegin The value of a region of installed memory\r
+ @param MemoryLength The corresponding length of a region of installed memory.\r
\r
- @retval EFI_SUCCESS The region was successfully installed in a HOB.\r
- \r
+ @retval EFI_SUCCESS The region was successfully installed in a HOB.\r
@retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r
- \r
- @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
+ @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
\r
**/\r
typedef\r
The purpose of the service is to publish an interface that allows \r
PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param MemoryType The type of memory to allocate. \r
- \r
- @param Pages The number of contiguous 4 KB pages to allocate.\r
- \r
- @param Memory Pointer to a physical address. On output, the address is set to the base of the page range that was allocated.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param MemoryType The type of memory to allocate.\r
+ @param Pages The number of contiguous 4 KB pages to allocate.\r
+ @param Memory Pointer to a physical address. On output, the address is set to the base \r
+ of the page range that was allocated.\r
\r
- @retval EFI_SUCCESS The memory range was successfully allocated.\r
- \r
+ @retval EFI_SUCCESS The memory range was successfully allocated.\r
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
- \r
@retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
\r
**/\r
The purpose of this service is to publish an interface that \r
allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param Size The number of bytes to allocate from the pool.\r
- \r
- @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Size The number of bytes to allocate from the pool.\r
+ @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r
\r
- @retval EFI_SUCCESS The allocation was successful.\r
- \r
- @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r
+ @retval EFI_SUCCESS The allocation was successful.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r
\r
**/\r
typedef\r
/**\r
This service copies the contents of one buffer to another buffer.\r
\r
- @param Destination Pointer to the destination buffer of the memory copy.\r
- \r
- @param Source Pointer to the source buffer of the memory copy\r
- \r
- @param Length Number of bytes to copy from Source to Destination.\r
+ @param Destination Pointer to the destination buffer of the memory copy.\r
+ @param Source Pointer to the source buffer of the memory copy\r
+ @param Length Number of bytes to copy from Source to Destination.\r
\r
@return None\r
\r
/**\r
The service fills a buffer with a specified value.\r
\r
- @param Buffer Pointer to the buffer to fill.\r
- \r
- @param Size Number of bytes in Buffer to fill.\r
- \r
- @param Value Value to fill Buffer with\r
+ @param Buffer Pointer to the buffer to fill.\r
+ @param Size Number of bytes in Buffer to fill.\r
+ @param Value Value to fill Buffer with\r
\r
@return None\r
\r
/**\r
This service publishes an interface that allows PEIMs to report status codes.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- \r
- @param Type Indicates the type of status code being reported. \r
- \r
- @param Value Describes the current status of a hardware or \r
- software entity. This includes information about the class and \r
- subclass that is used to classify the entity as well as an operation.\r
- For progress codes, the operation is the current activity.\r
- For error codes, it is the exception.For debug codes,it is not defined at this time. \r
- \r
- @param Instance The enumeration of a hardware or software entity within \r
- the system. A system may contain multiple entities that match a class/subclass \r
- pairing. The instance differentiates between them. An instance of 0 indicates \r
- that instance information is unavailable, not meaningful, or not relevant.\r
- Valid instance numbers start with 1.\r
- \r
- @param CallerId This optional parameter may be used to identify the caller. \r
- This parameter allows the status code driver to apply different rules to \r
- different callers.\r
- \r
- @param Data This optional parameter may be used to pass additional data.\r
-\r
- @retval EFI_SUCCESS The function completed successfully. \r
- \r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Type Indicates the type of status code being reported.\r
+ @param Value Describes the current status of a hardware or\r
+ software entity. This includes information about the class and\r
+ subclass that is used to classify the entity as well as an operation.\r
+ For progress codes, the operation is the current activity.\r
+ For error codes, it is the exception.For debug codes,it is not defined at this time.\r
+ @param Instance The enumeration of a hardware or software entity within\r
+ the system. A system may contain multiple entities that match a class/subclass\r
+ pairing. The instance differentiates between them. An instance of 0 indicates\r
+ that instance information is unavailable, not meaningful, or not relevant.\r
+ Valid instance numbers start with 1.\r
+ @param CallerId This optional parameter may be used to identify the caller.\r
+ This parameter allows the status code driver to apply different rules to\r
+ different callers.\r
+ @param Data This optional parameter may be used to pass additional data.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.\r
\r
**/\r
/**\r
Resets the entire platform.\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES \r
- table published by the PEI Foundation.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r
+ table published by the PEI Foundation.\r
\r
- @retval EFI_SUCCESS The function completed successfully. \r
- \r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff