#ifndef __DEBUG_IMAGE_INFO_H__\r
#define __DEBUG_IMAGE_INFO_H__\r
\r
-#define FOUR_MEG_PAGES 0x400 \r
+#define FOUR_MEG_PAGES 0x400\r
#define FOUR_MEG_MASK ((FOUR_MEG_PAGES * EFI_PAGE_SIZE) - 1)\r
\r
#define EFI_DEBUG_TABLE_ENTRY_SIZE (sizeof (VOID *))\r
Adds a new DebugImageInfo structure to the DebugImageInfo Table. Re-Allocates\r
the table if it's not large enough to accomidate another entry.\r
\r
- @param ImageInfoType type of debug image information \r
- @param LoadedImage pointer to the loaded image protocol for the image being \r
- loaded \r
+ @param ImageInfoType type of debug image information\r
+ @param LoadedImage pointer to the loaded image protocol for the image being\r
+ loaded\r
@param ImageHandle image handle for the image being loaded\r
\r
**/\r
/**\r
Grow size of the Depex stack\r
\r
- @retval EFI_SUCCESS Stack successfully growed. \r
+ @retval EFI_SUCCESS Stack successfully growed.\r
@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.\r
\r
**/\r
// Copy to Old Stack to the New Stack\r
//\r
CopyMem (\r
- NewStack, \r
- mDepexEvaluationStack, \r
+ NewStack,\r
+ mDepexEvaluationStack,\r
(mDepexEvaluationStackEnd - mDepexEvaluationStack) * sizeof (BOOLEAN)\r
);\r
\r
/**\r
Push an element onto the Boolean Stack.\r
\r
- @param Value BOOLEAN to push. \r
+ @param Value BOOLEAN to push.\r
\r
- @retval EFI_SUCCESS The value was pushed onto the stack. \r
+ @retval EFI_SUCCESS The value was pushed onto the stack.\r
@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.\r
\r
**/\r
/**\r
Pop an element from the Boolean stack.\r
\r
- @param Value BOOLEAN to pop. \r
+ @param Value BOOLEAN to pop.\r
\r
- @retval EFI_SUCCESS The value was popped onto the stack. \r
+ @retval EFI_SUCCESS The value was popped onto the stack.\r
@retval EFI_ACCESS_DENIED The pop operation underflowed the stack.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
PopBool (\r
OUT BOOLEAN *Value\r
)\r
//\r
mDepexEvaluationStackPointer--;\r
*Value = *mDepexEvaluationStackPointer;\r
- return EFI_SUCCESS; \r
+ return EFI_SUCCESS;\r
}\r
\r
\r
**/\r
EFI_STATUS\r
CorePreProcessDepex (\r
- IN EFI_CORE_DRIVER_ENTRY *DriverEntry \r
+ IN EFI_CORE_DRIVER_ENTRY *DriverEntry\r
)\r
{\r
UINT8 *Iterator;\r
- \r
+\r
Iterator = DriverEntry->Depex;\r
if (*Iterator == EFI_DEP_SOR) {\r
DriverEntry->Unrequested = TRUE;\r
} else {\r
DriverEntry->Dependent = TRUE;\r
}\r
- \r
+\r
if (*Iterator == EFI_DEP_BEFORE) {\r
DriverEntry->Before = TRUE;\r
} else if (*Iterator == EFI_DEP_AFTER) {\r
DriverEntry->After = TRUE;\r
- } \r
+ }\r
\r
if (DriverEntry->Before || DriverEntry->After) {\r
CopyMem (&DriverEntry->BeforeAfterGuid, Iterator + 1, sizeof (EFI_GUID));\r
routine in this case. The SOR is just ignored and is a nop in the grammer.\r
POSTFIX means all the math is done on top of the stack.\r
\r
- @param DriverEntry DriverEntry element to update. \r
+ @param DriverEntry DriverEntry element to update.\r
\r
- @retval TRUE If driver is ready to run. \r
- @retval FALSE If driver is not ready to run or some fatal error \r
+ @retval TRUE If driver is ready to run.\r
+ @retval FALSE If driver is not ready to run or some fatal error\r
was found.\r
\r
**/\r
BOOLEAN\r
CoreIsSchedulable (\r
- IN EFI_CORE_DRIVER_ENTRY *DriverEntry \r
+ IN EFI_CORE_DRIVER_ENTRY *DriverEntry\r
)\r
{\r
EFI_STATUS Status;\r
\r
\r
Iterator = DriverEntry->Depex;\r
- \r
+\r
while (TRUE) {\r
//\r
// Check to see if we are attempting to fetch dependency expression instructions\r
ASSERT (FALSE);\r
case EFI_DEP_SOR:\r
//\r
- // These opcodes can only appear once as the first opcode. If it is found \r
+ // These opcodes can only appear once as the first opcode. If it is found\r
// at any other location, then the dependency expression evaluates to FALSE\r
//\r
if (Iterator != DriverEntry->Depex) {\r
//\r
break;\r
\r
- case EFI_DEP_PUSH: \r
+ case EFI_DEP_PUSH:\r
//\r
// Push operator is followed by a GUID. Test to see if the GUID protocol\r
// is installed and push the boolean result on the stack.\r
Iterator += sizeof (EFI_GUID);\r
break;\r
\r
- case EFI_DEP_AND: \r
+ case EFI_DEP_AND:\r
Status = PopBool (&Operator);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
}\r
break;\r
\r
- case EFI_DEP_OR: \r
+ case EFI_DEP_OR:\r
Status = PopBool (&Operator);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
}\r
break;\r
\r
- case EFI_DEP_NOT: \r
+ case EFI_DEP_NOT:\r
Status = PopBool (&Operator);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
}\r
break;\r
\r
- case EFI_DEP_TRUE: \r
+ case EFI_DEP_TRUE:\r
Status = PushBool (TRUE);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
}\r
break;\r
\r
- case EFI_DEP_FALSE: \r
+ case EFI_DEP_FALSE:\r
Status = PushBool (FALSE);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
}\r
break;\r
\r
- case EFI_DEP_END: \r
+ case EFI_DEP_END:\r
Status = PopBool (&Operator);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
Iterator += sizeof (EFI_GUID);\r
break;\r
\r
- default: \r
+ default:\r
goto Done;\r
}\r
- \r
+\r
//\r
// Skip over the Dependency Op Code we just processed in the switch.\r
// The math is done out of order, but it should not matter. That is\r
DXE Dispatcher.\r
\r
Step #1 - When a FV protocol is added to the system every driver in the FV\r
- is added to the mDiscoveredList. The SOR, Before, and After Depex are \r
- pre-processed as drivers are added to the mDiscoveredList. If an Apriori \r
- file exists in the FV those drivers are addeded to the \r
- mScheduledQueue. The mFvHandleList is used to make sure a \r
+ is added to the mDiscoveredList. The SOR, Before, and After Depex are\r
+ pre-processed as drivers are added to the mDiscoveredList. If an Apriori\r
+ file exists in the FV those drivers are addeded to the\r
+ mScheduledQueue. The mFvHandleList is used to make sure a\r
FV is only processed once.\r
\r
Step #2 - Dispatch. Remove driver from the mScheduledQueue and load and\r
- start it. After mScheduledQueue is drained check the \r
- mDiscoveredList to see if any item has a Depex that is ready to \r
+ start it. After mScheduledQueue is drained check the\r
+ mDiscoveredList to see if any item has a Depex that is ready to\r
be placed on the mScheduledQueue.\r
\r
- Step #3 - Adding to the mScheduledQueue requires that you process Before \r
+ Step #3 - Adding to the mScheduledQueue requires that you process Before\r
and After dependencies. This is done recursively as the call to add\r
- to the mScheduledQueue checks for Before and recursively adds \r
- all Befores. It then addes the item that was passed in and then \r
+ to the mScheduledQueue checks for Before and recursively adds\r
+ all Befores. It then addes the item that was passed in and then\r
processess the After dependecies by recursively calling the routine.\r
\r
Dispatcher Rules:\r
- The rules for the dispatcher are in chapter 10 of the DXE CIS. Figure 10-3 \r
+ The rules for the dispatcher are in chapter 10 of the DXE CIS. Figure 10-3\r
is the state diagram for the DXE dispatcher\r
\r
Depex - Dependency Expresion.\r
// The Driver List contains one copy of every driver that has been discovered.\r
// Items are never removed from the driver list. List of EFI_CORE_DRIVER_ENTRY\r
//\r
-LIST_ENTRY mDiscoveredList = INITIALIZE_LIST_HEAD_VARIABLE (mDiscoveredList); \r
+LIST_ENTRY mDiscoveredList = INITIALIZE_LIST_HEAD_VARIABLE (mDiscoveredList);\r
\r
//\r
// Queue of drivers that are ready to dispatch. This queue is a subset of the\r
//\r
// List of file types supported by dispatcher\r
//\r
-EFI_FV_FILETYPE mDxeFileTypes[] = { \r
- EFI_FV_FILETYPE_DRIVER, \r
- EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER, \r
+EFI_FV_FILETYPE mDxeFileTypes[] = {\r
+ EFI_FV_FILETYPE_DRIVER,\r
+ EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER,\r
EFI_FV_FILETYPE_DXE_CORE,\r
EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE\r
};\r
CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (\r
IN EFI_CORE_DRIVER_ENTRY *InsertedDriverEntry\r
);\r
- \r
+\r
/**\r
Event notification that is fired every time a FV dispatch protocol is added.\r
More than one protocol may have been added when this event is fired, so you\r
While you are at it read the A Priori file into memory.\r
Place drivers in the A Priori list onto the mScheduledQueue.\r
\r
- @param Event The Event that is being processed, not used. \r
+ @param Event The Event that is being processed, not used.\r
@param Context Event Context, not used.\r
\r
**/\r
);\r
\r
/**\r
- Convert FvHandle and DriverName into an EFI device path.\r
+ Convert FvHandle and DriverName into an EFI device path\r
\r
- @param Fv Fv protocol, needed to read Depex info out of \r
- FLASH. \r
- @param FvHandle Handle for Fv, needed in the \r
- EFI_CORE_DRIVER_ENTRY so that the PE image can be \r
- read out of the FV at a later time. \r
- @param DriverName Name of driver to add to mDiscoveredList. \r
+ @param Fv Fv protocol, needed to read Depex info out of\r
+ FLASH.\r
+ @param FvHandle Handle for Fv, needed in the\r
+ EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
+ read out of the FV at a later time.\r
+ @param DriverName Name of driver to add to mDiscoveredList.\r
\r
@return Pointer to device path constructed from FvHandle and DriverName\r
\r
The Discovered list is never free'ed and contains booleans that represent the\r
other possible DXE driver states.\r
\r
- @param Fv Fv protocol, needed to read Depex info out of \r
- FLASH. \r
- @param FvHandle Handle for Fv, needed in the \r
- EFI_CORE_DRIVER_ENTRY so that the PE image can be \r
- read out of the FV at a later time. \r
- @param DriverName Name of driver to add to mDiscoveredList. \r
+ @param Fv Fv protocol, needed to read Depex info out of\r
+ FLASH.\r
+ @param FvHandle Handle for Fv, needed in the\r
+ EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
+ read out of the FV at a later time.\r
+ @param DriverName Name of driver to add to mDiscoveredList.\r
\r
- @retval EFI_SUCCESS If driver was added to the mDiscoveredList. \r
- @retval EFI_ALREADY_STARTED The driver has already been started. Only one \r
- DriverName may be active in the system at any one \r
+ @retval EFI_SUCCESS If driver was added to the mDiscoveredList.\r
+ @retval EFI_ALREADY_STARTED The driver has already been started. Only one\r
+ DriverName may be active in the system at any one\r
time.\r
\r
**/\r
/**\r
Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.\r
\r
- @param Fv The FIRMWARE_VOLUME protocol installed on the FV. \r
- @param FvHandle The handle which FVB protocol installed on. \r
- @param DriverName The driver guid specified. \r
+ @param Fv The FIRMWARE_VOLUME protocol installed on the FV.\r
+ @param FvHandle The handle which FVB protocol installed on.\r
+ @param DriverName The driver guid specified.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough memory or other resource. \r
- @retval EFI_VOLUME_CORRUPTED Corrupted volume. \r
+ @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.\r
+ @retval EFI_VOLUME_CORRUPTED Corrupted volume.\r
@retval EFI_SUCCESS Function successfully returned.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
CoreProcessFvImageFile (\r
IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
IN EFI_HANDLE FvHandle,\r
Read Depex and pre-process the Depex for Before and After. If Section Extraction\r
protocol returns an error via ReadSection defer the reading of the Depex.\r
\r
- @param DriverEntry Driver to work on. \r
+ @param DriverEntry Driver to work on.\r
\r
- @retval EFI_SUCCESS Depex read and preprossesed \r
- @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error \r
- and Depex reading needs to be retried. \r
+ @retval EFI_SUCCESS Depex read and preprossesed\r
+ @retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error\r
+ and Depex reading needs to be retried.\r
@retval Error DEPEX not found.\r
\r
**/\r
UINT32 AuthenticationStatus;\r
EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
\r
- \r
+\r
Fv = DriverEntry->Fv;\r
\r
//\r
//\r
SectionType = EFI_SECTION_DXE_DEPEX;\r
Status = Fv->ReadSection (\r
- DriverEntry->Fv, \r
+ DriverEntry->Fv,\r
&DriverEntry->FileName,\r
- SectionType, \r
- 0, \r
- &DriverEntry->Depex, \r
+ SectionType,\r
+ 0,\r
+ &DriverEntry->Depex,\r
(UINTN *)&DriverEntry->DepexSize,\r
&AuthenticationStatus\r
);\r
//\r
CorePreProcessDepex (DriverEntry);\r
DriverEntry->DepexProtocolError = FALSE;\r
- } \r
+ }\r
\r
return Status;\r
}\r
Check every driver and locate a matching one. If the driver is found, the Unrequested\r
state flag is cleared.\r
\r
- @param FirmwareVolumeHandle The handle of the Firmware Volume that contains \r
- the firmware file specified by DriverName. \r
- @param DriverName The Driver name to put in the Dependent state. \r
+ @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
+ the firmware file specified by DriverName.\r
+ @param DriverName The Driver name to put in the Dependent state.\r
\r
- @retval EFI_SUCCESS The DriverName was found and it's SOR bit was \r
- cleared \r
- @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was \r
- not set. \r
+ @retval EFI_SUCCESS The DriverName was found and it's SOR bit was\r
+ cleared\r
+ @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was\r
+ not set.\r
\r
**/\r
EFI_STATUS\r
for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
if (DriverEntry->FvHandle == FirmwareVolumeHandle &&\r
- DriverEntry->Unrequested && \r
+ DriverEntry->Unrequested &&\r
CompareGuid (DriverName, &DriverEntry->FileName)) {\r
//\r
// Move the driver from the Unrequested to the Dependent state\r
DriverEntry->Unrequested = FALSE;\r
DriverEntry->Dependent = TRUE;\r
CoreReleaseDispatcherLock ();\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
}\r
- return EFI_NOT_FOUND; \r
+ return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
Convert a driver from the Untrused back to the Scheduled state.\r
\r
- @param FirmwareVolumeHandle The handle of the Firmware Volume that contains \r
- the firmware file specified by DriverName. \r
- @param DriverName The Driver name to put in the Scheduled state \r
+ @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
+ the firmware file specified by DriverName.\r
+ @param DriverName The Driver name to put in the Scheduled state\r
\r
- @retval EFI_SUCCESS The file was found in the untrusted state, and it \r
- was promoted to the trusted state. \r
- @retval EFI_NOT_FOUND The file was not found in the untrusted state. \r
+ @retval EFI_SUCCESS The file was found in the untrusted state, and it\r
+ was promoted to the trusted state.\r
+ @retval EFI_NOT_FOUND The file was not found in the untrusted state.\r
\r
**/\r
EFI_STATUS\r
for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
if (DriverEntry->FvHandle == FirmwareVolumeHandle &&\r
- DriverEntry->Untrusted && \r
+ DriverEntry->Untrusted &&\r
CompareGuid (DriverName, &DriverEntry->FileName)) {\r
//\r
// Transition driver from Untrusted to Scheduled state.\r
DriverEntry->Scheduled = TRUE;\r
InsertTailList (&mScheduledQueue, &DriverEntry->ScheduledLink);\r
CoreReleaseDispatcherLock ();\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
}\r
- return EFI_NOT_FOUND; \r
+ return EFI_NOT_FOUND;\r
}\r
\r
\r
will be called, and when the Bds() exits the Dispatcher will be called\r
again.\r
\r
- @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running \r
- @retval EFI_NOT_FOUND No DXE Drivers were dispatched \r
- @retval EFI_SUCCESS One or more DXE Drivers were dispatched \r
+ @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running\r
+ @retval EFI_NOT_FOUND No DXE Drivers were dispatched\r
+ @retval EFI_SUCCESS One or more DXE Drivers were dispatched\r
\r
**/\r
EFI_STATUS\r
//\r
if (DriverEntry->ImageHandle == NULL) {\r
Status = CoreLoadImage (\r
- FALSE, \r
- gDxeCoreImageHandle, \r
+ FALSE,\r
+ gDxeCoreImageHandle,\r
DriverEntry->FvFileDevicePath,\r
- NULL, \r
- 0, \r
+ NULL,\r
+ 0,\r
&DriverEntry->ImageHandle\r
);\r
\r
} else {\r
//\r
// The DXE Driver could not be loaded, and do not attempt to load or start it again.\r
- // Take driver from Scheduled to Initialized. \r
+ // Take driver from Scheduled to Initialized.\r
//\r
// This case include the Never Trusted state if EFI_ACCESS_DENIED is returned\r
//\r
\r
DriverEntry->Scheduled = FALSE;\r
RemoveEntryList (&DriverEntry->ScheduledLink);\r
- \r
+\r
CoreReleaseDispatcherLock ();\r
- \r
+\r
//\r
// If it's an error don't try the StartImage\r
//\r
DriverEntry->Scheduled = FALSE;\r
DriverEntry->Initialized = TRUE;\r
RemoveEntryList (&DriverEntry->ScheduledLink);\r
- \r
+\r
CoreReleaseDispatcherLock ();\r
\r
CoreReportProgressCodeSpecific (\r
- FixedPcdGet32(PcdStatusCodeValueDxeDriverBegin), \r
+ FixedPcdGet32(PcdStatusCodeValueDxeDriverBegin),\r
DriverEntry->ImageHandle\r
);\r
Status = CoreStartImage (DriverEntry->ImageHandle, NULL, NULL);\r
CoreReportProgressCodeSpecific (\r
- FixedPcdGet32(PcdStatusCodeValueDxeDriverEnd), \r
+ FixedPcdGet32(PcdStatusCodeValueDxeDriverEnd),\r
DriverEntry->ImageHandle\r
);\r
\r
// If Section Extraction Protocol did not let the Depex be read before retry the read\r
//\r
Status = CoreGetDepexSectionAndPreProccess (DriverEntry);\r
- } \r
+ }\r
\r
if (DriverEntry->Dependent) {\r
if (CoreIsSchedulable (DriverEntry)) {\r
- CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry); \r
+ CoreInsertOnScheduledQueueWhileProcessingBeforeAndAfter (DriverEntry);\r
ReadyToRun = TRUE;\r
- } \r
+ }\r
}\r
}\r
} while (ReadyToRun);\r
InsertedDriverEntry->Dependent = FALSE;\r
InsertedDriverEntry->Scheduled = TRUE;\r
InsertTailList (&mScheduledQueue, &InsertedDriverEntry->ScheduledLink);\r
- \r
+\r
CoreReleaseDispatcherLock ();\r
\r
//\r
/**\r
Return TRUE if the Fv has been processed, FALSE if not.\r
\r
- @param FvHandle The handle of a FV that's being tested \r
+ @param FvHandle The handle of a FV that's being tested\r
\r
- @retval TRUE Fv protocol on FvHandle has been processed \r
+ @retval TRUE Fv protocol on FvHandle has been processed\r
@retval FALSE Fv protocol on FvHandle has not yet been processed\r
\r
**/\r
/**\r
Convert FvHandle and DriverName into an EFI device path\r
\r
- @param Fv Fv protocol, needed to read Depex info out of \r
- FLASH. \r
- @param FvHandle Handle for Fv, needed in the \r
- EFI_CORE_DRIVER_ENTRY so that the PE image can be \r
- read out of the FV at a later time. \r
- @param DriverName Name of driver to add to mDiscoveredList. \r
+ @param Fv Fv protocol, needed to read Depex info out of\r
+ FLASH.\r
+ @param FvHandle Handle for Fv, needed in the\r
+ EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
+ read out of the FV at a later time.\r
+ @param DriverName Name of driver to add to mDiscoveredList.\r
\r
@return Pointer to device path constructed from FvHandle and DriverName\r
\r
SetDevicePathNodeLength (&mFvDevicePath.End, sizeof (EFI_DEVICE_PATH_PROTOCOL));\r
\r
FileNameDevicePath = CoreAppendDevicePath (\r
- FvDevicePath, \r
+ FvDevicePath,\r
(EFI_DEVICE_PATH_PROTOCOL *)&mFvDevicePath\r
);\r
}\r
The Discovered list is never free'ed and contains booleans that represent the\r
other possible DXE driver states.\r
\r
- @param Fv Fv protocol, needed to read Depex info out of \r
- FLASH. \r
- @param FvHandle Handle for Fv, needed in the \r
- EFI_CORE_DRIVER_ENTRY so that the PE image can be \r
- read out of the FV at a later time. \r
- @param DriverName Name of driver to add to mDiscoveredList. \r
+ @param Fv Fv protocol, needed to read Depex info out of\r
+ FLASH.\r
+ @param FvHandle Handle for Fv, needed in the\r
+ EFI_CORE_DRIVER_ENTRY so that the PE image can be\r
+ read out of the FV at a later time.\r
+ @param DriverName Name of driver to add to mDiscoveredList.\r
\r
- @retval EFI_SUCCESS If driver was added to the mDiscoveredList. \r
- @retval EFI_ALREADY_STARTED The driver has already been started. Only one \r
- DriverName may be active in the system at any one \r
+ @retval EFI_SUCCESS If driver was added to the mDiscoveredList.\r
+ @retval EFI_ALREADY_STARTED The driver has already been started. Only one\r
+ DriverName may be active in the system at any one\r
time.\r
\r
**/\r
{\r
EFI_CORE_DRIVER_ENTRY *DriverEntry;\r
\r
- \r
+\r
//\r
- // Create the Driver Entry for the list. ZeroPool initializes lots of variables to \r
+ // Create the Driver Entry for the list. ZeroPool initializes lots of variables to\r
// NULL or FALSE.\r
//\r
DriverEntry = CoreAllocateZeroBootServicesPool (sizeof (EFI_CORE_DRIVER_ENTRY));\r
DriverEntry->FvFileDevicePath = CoreFvToDevicePath (Fv, FvHandle, DriverName);\r
\r
CoreGetDepexSectionAndPreProccess (DriverEntry);\r
- \r
+\r
CoreAcquireDispatcherLock ();\r
- \r
+\r
InsertTailList (&mDiscoveredList, &DriverEntry->Link);\r
\r
CoreReleaseDispatcherLock ();\r
Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is\r
described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.\r
\r
- @param FvHandle The handle which FVB protocol installed on. \r
- @param DriverName The driver guid specified. \r
+ @param FvHandle The handle which FVB protocol installed on.\r
+ @param DriverName The driver guid specified.\r
\r
- @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2 \r
- Hob. \r
+ @retval TRUE This file is found in a EFI_HOB_FIRMWARE_VOLUME2\r
+ Hob.\r
@retval FALSE Not found.\r
\r
**/\r
)\r
{\r
EFI_PEI_HOB_POINTERS HobFv2;\r
- \r
+\r
HobFv2.Raw = GetHobList ();\r
- \r
+\r
while ((HobFv2.Raw = GetNextHob (EFI_HOB_TYPE_FV2, HobFv2.Raw)) != NULL) {\r
if (CompareGuid (DriverName, &HobFv2.FirmwareVolume2->FileName)) {\r
return TRUE;\r
/**\r
Get the driver from the FV through driver name, and produce a FVB protocol on FvHandle.\r
\r
- @param Fv The FIRMWARE_VOLUME protocol installed on the FV. \r
- @param FvHandle The handle which FVB protocol installed on. \r
- @param DriverName The driver guid specified. \r
+ @param Fv The FIRMWARE_VOLUME protocol installed on the FV.\r
+ @param FvHandle The handle which FVB protocol installed on.\r
+ @param DriverName The driver guid specified.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough memory or other resource. \r
- @retval EFI_VOLUME_CORRUPTED Corrupted volume. \r
+ @retval EFI_OUT_OF_RESOURCES No enough memory or other resource.\r
+ @retval EFI_VOLUME_CORRUPTED Corrupted volume.\r
@retval EFI_SUCCESS Function successfully returned.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
CoreProcessFvImageFile (\r
IN EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv,\r
IN EFI_HANDLE FvHandle,\r
VOID *AlignedBuffer;\r
UINTN BufferSize;\r
EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r
- UINT32 FvAlignment; \r
+ UINT32 FvAlignment;\r
\r
//\r
// Read the first (and only the first) firmware volume section\r
BufferSize = 0;\r
AlignedBuffer = NULL;\r
Status = Fv->ReadSection (\r
- Fv, \r
- DriverName, \r
- SectionType, \r
- 0, \r
- &Buffer, \r
+ Fv,\r
+ DriverName,\r
+ SectionType,\r
+ 0,\r
+ &Buffer,\r
&BufferSize,\r
&AuthenticationStatus\r
);\r
FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);\r
//\r
// FvAlignment must be more than 8 bytes required by FvHeader structure.\r
- // \r
+ //\r
if (FvAlignment < 8) {\r
FvAlignment = 8;\r
}\r
}\r
}\r
\r
- if (EFI_ERROR (Status)) { \r
+ if (EFI_ERROR (Status)) {\r
//\r
// ReadSection or Produce FVB failed, Free data buffer\r
//\r
if (Buffer != NULL) {\r
- CoreFreePool (Buffer); \r
+ CoreFreePool (Buffer);\r
}\r
- \r
+\r
if (AlignedBuffer != NULL) {\r
FreeAlignedPages (AlignedBuffer, EFI_SIZE_TO_PAGES (BufferSize));\r
}\r
While you are at it read the A Priori file into memory.\r
Place drivers in the A Priori list onto the mScheduledQueue.\r
\r
- @param Event The Event that is being processed, not used. \r
+ @param Event The Event that is being processed, not used.\r
@param Context Event Context, not used.\r
\r
**/\r
ASSERT (FALSE);\r
continue;\r
}\r
- \r
+\r
Status = CoreHandleProtocol (FvHandle, &gEfiDevicePathProtocolGuid, (VOID **)&FvDevicePath);\r
if (EFI_ERROR (Status)) {\r
//\r
//\r
continue;\r
}\r
- \r
+\r
//\r
- // Evaluate the authentication status of the Firmware Volume through \r
+ // Evaluate the authentication status of the Firmware Volume through\r
// Security Architectural Protocol\r
//\r
if (gSecurity != NULL) {\r
SecurityStatus = gSecurity->FileAuthenticationState (\r
- gSecurity, \r
- 0, \r
+ gSecurity,\r
+ 0,\r
FvDevicePath\r
);\r
if (SecurityStatus != EFI_SUCCESS) {\r
//\r
continue;\r
}\r
- } \r
- \r
+ }\r
+\r
//\r
- // Discover Drivers in FV and add them to the Discovered Driver List. \r
- // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER \r
+ // Discover Drivers in FV and add them to the Discovered Driver List.\r
+ // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER\r
// EFI_FV_FILETYPE_DXE_CORE is processed to produce a Loaded Image protocol for the core\r
// EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE is processed to create a Fvb\r
//\r
do {\r
Type = mDxeFileTypes[Index];\r
GetNextFileStatus = Fv->GetNextFile (\r
- Fv, \r
+ Fv,\r
&Key,\r
- &Type, \r
- &NameGuid, \r
- &Attributes, \r
+ &Type,\r
+ &NameGuid,\r
+ &Attributes,\r
&Size\r
);\r
if (!EFI_ERROR (GetNextFileStatus)) {\r
}\r
} else if (Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {\r
//\r
- // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already \r
+ // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already\r
// been extracted.\r
//\r
if (FvFoundInHobFv2 (FvHandle, &NameGuid)) {\r
}\r
//\r
// Found a firmware volume image. Produce a firmware volume block\r
- // protocol for it so it gets dispatched from. This is usually a \r
+ // protocol for it so it gets dispatched from. This is usually a\r
// capsule.\r
//\r
CoreProcessFvImageFile (Fv, FvHandle, &NameGuid);\r
}\r
} while (!EFI_ERROR (GetNextFileStatus));\r
}\r
- \r
+\r
//\r
// Read the array of GUIDs from the Apriori file if it is present in the firmware volume\r
//\r
// is only valid for the FV that it resided in.\r
//\r
CoreAcquireDispatcherLock ();\r
- \r
+\r
for (Index = 0; Index < AprioriEntryCount; Index++) {\r
for (Link = mDiscoveredList.ForwardLink; Link != &mDiscoveredList; Link = Link->ForwardLink) {\r
DriverEntry = CR(Link, EFI_CORE_DRIVER_ENTRY, Link, EFI_CORE_DRIVER_ENTRY_SIGNATURE);\r
CoreReleaseDispatcherLock ();\r
\r
//\r
- // Free data allocated by Fv->ReadSection () \r
+ // Free data allocated by Fv->ReadSection ()\r
//\r
- CoreFreePool (AprioriFile); \r
+ CoreFreePool (AprioriFile);\r
}\r
}\r
\r
)\r
{\r
mFwVolEvent = CoreCreateProtocolNotifyEvent (\r
- &gEfiFirmwareVolume2ProtocolGuid, \r
+ &gEfiFirmwareVolume2ProtocolGuid,\r
TPL_CALLBACK,\r
CoreFwVolEventProtocolNotify,\r
NULL,\r
\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/GuidedSectionExtraction.h>\r
-#include <Guid/DebugImageInfoTable.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/Runtime.h>\r
#include <Protocol/LoadFile.h>\r
#include <Protocol/VariableWrite.h>\r
#include <Protocol/PlatformDriverOverride.h>\r
#include <Protocol/Variable.h>\r
-#include <Guid/MemoryTypeInformation.h>\r
-#include <Guid/FirmwareFileSystem2.h>\r
-#include <Guid/HobList.h>\r
#include <Protocol/Timer.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/Bds.h>\r
-#include <Guid/FileInfo.h>\r
#include <Protocol/RealTimeClock.h>\r
-#include <Guid/Apriori.h>\r
#include <Protocol/WatchdogTimer.h>\r
#include <Protocol/FirmwareVolume2.h>\r
#include <Protocol/MonotonicCounter.h>\r
-#include <Guid/DxeServices.h>\r
-#include <Guid/MemoryAllocationHob.h>\r
#include <Protocol/StatusCode.h>\r
#include <Protocol/Decompress.h>\r
#include <Protocol/LoadPe32Image.h>\r
#include <Protocol/FirmwareVolumeDispatch.h>\r
#include <Protocol/Security.h>\r
#include <Protocol/Ebc.h>\r
-#include <Guid/EventLegacyBios.h>\r
#include <Protocol/Reset.h>\r
#include <Protocol/Cpu.h>\r
-#include <Guid/EventGroup.h>\r
#include <Protocol/Metronome.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
#include <Protocol/Capsule.h>\r
#include <Protocol/BusSpecificDriverOverride.h>\r
#include <Protocol/Performance.h>\r
-#include <Uefi/UefiTcgPlatform.h>\r
+#include <Protocol/TcgService.h>\r
#include <Protocol/TcgPlatform.h>\r
+#include <Guid/MemoryTypeInformation.h>\r
+#include <Guid/FirmwareFileSystem2.h>\r
+#include <Guid/HobList.h>\r
+#include <Guid/DebugImageInfoTable.h>\r
+#include <Guid/FileInfo.h>\r
+#include <Guid/Apriori.h>\r
+#include <Guid/DxeServices.h>\r
+#include <Guid/MemoryAllocationHob.h>\r
+#include <Guid/EventLegacyBios.h>\r
+#include <Guid/EventGroup.h>\r
+\r
\r
#include <Library/DxeCoreEntryPoint.h>\r
#include <Library/DebugLib.h>\r
#define KNOWN_HANDLE_SIGNATURE EFI_SIGNATURE_32('k','n','o','w')\r
typedef struct {\r
UINTN Signature;\r
- LIST_ENTRY Link; // mFvHandleList \r
+ LIST_ENTRY Link; // mFvHandleList\r
EFI_HANDLE Handle;\r
} KNOWN_HANDLE;\r
\r
The first descriptor that is added must be general usable\r
memory as the addition allocates heap.\r
\r
- @param Type The type of memory to add \r
- @param Start The starting address in the memory range Must be \r
- page aligned \r
- @param NumberOfPages The number of pages in the range \r
- @param Attribute Attributes of the memory to add \r
+ @param Type The type of memory to add\r
+ @param Start The starting address in the memory range Must be\r
+ page aligned\r
+ @param NumberOfPages The number of pages in the range\r
+ @param Attribute Attributes of the memory to add\r
\r
@return None. The range is added to the memory map\r
\r
memory descriptor is provided to the memory services. Then the memory services\r
can be used to intialize the GCD map.\r
\r
- @param HobStart The start address of the HOB. \r
- @param MemoryBaseAddress Start address of memory region found to init DXE \r
- core. \r
- @param MemoryLength Length of memory region found to init DXE core. \r
+ @param HobStart The start address of the HOB.\r
+ @param MemoryBaseAddress Start address of memory region found to init DXE\r
+ core.\r
+ @param MemoryLength Length of memory region found to init DXE core.\r
\r
@retval EFI_SUCCESS Memory services successfully initialized.\r
\r
can be used to intialize the GCD map. The HobStart will be relocated to a pool\r
buffer.\r
\r
- @param HobStart The start address of the HOB \r
- @param MemoryBaseAddress Start address of memory region found to init DXE \r
- core. \r
- @param MemoryLength Length of memory region found to init DXE core. \r
+ @param HobStart The start address of the HOB\r
+ @param MemoryBaseAddress Start address of memory region found to init DXE\r
+ core.\r
+ @param MemoryLength Length of memory region found to init DXE core.\r
\r
@retval EFI_SUCCESS GCD services successfully initialized.\r
\r
**/\r
EFI_STATUS\r
CoreInitializeGcdServices (\r
- IN OUT VOID **HobStart,\r
+ IN OUT VOID **HobStart,\r
IN EFI_PHYSICAL_ADDRESS MemoryBaseAddress,\r
IN UINT64 MemoryLength\r
);\r
/**\r
Initializes "event" support and populates parts of the System and Runtime Table.\r
\r
-\r
@retval EFI_SUCCESS Always return success\r
\r
**/\r
Add the Image Services to EFI Boot Services Table and install the protocol\r
interfaces for this image.\r
\r
- @param HobStart The HOB to initialize \r
+ @param HobStart The HOB to initialize\r
\r
@return Status code.\r
\r
/**\r
Return TRUE if all AP services are availible.\r
\r
-\r
- @retval EFI_SUCCESS All AP services are available \r
+ @retval EFI_SUCCESS All AP services are available\r
@retval EFI_NOT_FOUND At least one AP service is not available\r
\r
**/\r
/**\r
Called by the platform code to process a tick.\r
\r
- @param Duration The number of 100ns elasped since the last call \r
+ @param Duration The number of 100ns elasped since the last call\r
to TimerTick\r
\r
**/\r
\r
/**\r
Initialize the dispatcher. Initialize the notification function that runs when\r
- a FV protocol is added to the system.\r
+ an FV2 protocol is added to the system.\r
\r
**/\r
VOID\r
routine in this case. The SOR is just ignored and is a nop in the grammer.\r
POSTFIX means all the math is done on top of the stack.\r
\r
- @param DriverEntry DriverEntry element to update \r
+ @param DriverEntry DriverEntry element to update.\r
\r
- @retval TRUE If driver is ready to run. \r
- @retval FALSE If driver is not ready to run or some fatal error \r
+ @retval TRUE If driver is ready to run.\r
+ @retval FALSE If driver is not ready to run or some fatal error\r
was found.\r
\r
**/\r
BOOLEAN\r
CoreIsSchedulable (\r
- IN EFI_CORE_DRIVER_ENTRY *DriverEntry \r
+ IN EFI_CORE_DRIVER_ENTRY *DriverEntry\r
);\r
\r
\r
it will be cleared by CoreSchedule(), and then the driver can be\r
dispatched.\r
\r
- @param DriverEntry DriverEntry element to update \r
+ @param DriverEntry DriverEntry element to update .\r
\r
@retval EFI_SUCCESS It always works.\r
\r
**/\r
EFI_STATUS\r
CorePreProcessDepex (\r
- IN EFI_CORE_DRIVER_ENTRY *DriverEntry \r
+ IN EFI_CORE_DRIVER_ENTRY *DriverEntry\r
);\r
\r
\r
/**\r
Terminates all boot services.\r
\r
- @param ImageHandle Handle that identifies the exiting image. \r
+ @param ImageHandle Handle that identifies the exiting image.\r
@param MapKey Key to the latest memory map.\r
\r
- @retval EFI_SUCCESS Boot Services terminated \r
+ @retval EFI_SUCCESS Boot Services terminated\r
@retval EFI_INVALID_PARAMETER MapKey is incorrect.\r
\r
**/\r
Make sure the memory map is following all the construction rules,\r
it is the last time to check memory map error before exit boot services.\r
\r
- @param MapKey Memory map key \r
+ @param MapKey Memory map key\r
\r
- @retval EFI_INVALID_PARAMETER Memory map not consistent with construction \r
- rules. \r
+ @retval EFI_INVALID_PARAMETER Memory map not consistent with construction\r
+ rules.\r
@retval EFI_SUCCESS Valid memory map.\r
\r
**/\r
Boot Service called to add, modify, or remove a system configuration table from\r
the EFI System Table.\r
\r
- @param Guid Pointer to the GUID for the entry to add, update, or \r
- remove \r
- @param Table Pointer to the configuration table for the entry to add, \r
- update, or remove, may be NULL. \r
+ @param Guid Pointer to the GUID for the entry to add, update, or\r
+ remove\r
+ @param Table Pointer to the configuration table for the entry to add,\r
+ update, or remove, may be NULL.\r
\r
@return EFI_SUCCESS Guid, Table pair added, updated, or removed.\r
@return EFI_INVALID_PARAMETER Input GUID not valid.\r
Raise the task priority level to the new level.\r
High level is implemented by disabling processor interrupts.\r
\r
- @param NewTpl New task priority level \r
+ @param NewTpl New task priority level\r
\r
@return The previous task priority level\r
\r
\r
@param Microseconds The number of microseconds to stall execution.\r
\r
- @retval EFI_SUCCESS Execution was stalled for at least the requested \r
- amount of microseconds. \r
+ @retval EFI_SUCCESS Execution was stalled for at least the requested\r
+ amount of microseconds.\r
@retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet\r
\r
**/\r
Wrapper function to CoreInstallProtocolInterfaceNotify. This is the public API which\r
Calls the private one which contains a BOOLEAN parameter for notifications\r
\r
- @param UserHandle The handle to install the protocol handler on, \r
- or NULL if a new handle is to be allocated \r
- @param Protocol The protocol to add to the handle \r
- @param InterfaceType Indicates whether Interface is supplied in \r
- native form. \r
- @param Interface The interface for the protocol being added \r
+ @param UserHandle The handle to install the protocol handler on,\r
+ or NULL if a new handle is to be allocated\r
+ @param Protocol The protocol to add to the handle\r
+ @param InterfaceType Indicates whether Interface is supplied in\r
+ native form.\r
+ @param Interface The interface for the protocol being added\r
\r
@return Status code\r
\r
/**\r
Installs a protocol interface into the boot services environment.\r
\r
- @param UserHandle The handle to install the protocol handler on, \r
- or NULL if a new handle is to be allocated \r
- @param Protocol The protocol to add to the handle \r
- @param InterfaceType Indicates whether Interface is supplied in \r
- native form. \r
- @param Interface The interface for the protocol being added \r
- @param Notify indicates whether notify the notification list \r
- for this protocol \r
+ @param UserHandle The handle to install the protocol handler on,\r
+ or NULL if a new handle is to be allocated\r
+ @param Protocol The protocol to add to the handle\r
+ @param InterfaceType Indicates whether Interface is supplied in\r
+ native form.\r
+ @param Interface The interface for the protocol being added\r
+ @param Notify indicates whether notify the notification list\r
+ for this protocol\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Protocol interface successfully installed\r
\r
**/\r
occures all the protocols added by this function are removed. This is\r
basically a lib function to save space.\r
\r
- @param Handle The handle to install the protocol handlers on, \r
- or NULL if a new handle is to be allocated \r
- @param ... EFI_GUID followed by protocol instance. A NULL \r
- terminates the list. The pairs are the \r
- arguments to InstallProtocolInterface(). All the \r
- protocols are added to Handle. \r
+ @param Handle The handle to install the protocol handlers on,\r
+ or NULL if a new handle is to be allocated\r
+ @param ... EFI_GUID followed by protocol instance. A NULL\r
+ terminates the list. The pairs are the\r
+ arguments to InstallProtocolInterface(). All the\r
+ protocols are added to Handle.\r
\r
- @retval EFI_INVALID_PARAMETER Handle is NULL. \r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
@retval EFI_SUCCESS Protocol interfaces successfully installed.\r
\r
**/\r
This function calls UnisatllProtocolInterface() in a loop. This is\r
basically a lib function to save space.\r
\r
- @param Handle The handle to uninstall the protocol \r
- @param ... EFI_GUID followed by protocol instance. A NULL \r
- terminates the list. The pairs are the \r
- arguments to UninstallProtocolInterface(). All \r
- the protocols are added to Handle. \r
+ @param Handle The handle to uninstall the protocol\r
+ @param ... EFI_GUID followed by protocol instance. A NULL\r
+ terminates the list. The pairs are the\r
+ arguments to UninstallProtocolInterface(). All\r
+ the protocols are added to Handle.\r
\r
@return Status code\r
\r
/**\r
Reinstall a protocol interface on a device handle. The OldInterface for Protocol is replaced by the NewInterface.\r
\r
- @param UserHandle Handle on which the interface is to be \r
- reinstalled \r
- @param Protocol The numeric ID of the interface \r
- @param OldInterface A pointer to the old interface \r
- @param NewInterface A pointer to the new interface \r
+ @param UserHandle Handle on which the interface is to be\r
+ reinstalled\r
+ @param Protocol The numeric ID of the interface\r
+ @param OldInterface A pointer to the old interface\r
+ @param NewInterface A pointer to the new interface\r
\r
@retval EFI_SUCCESS The protocol interface was installed\r
@retval EFI_NOT_FOUND The OldInterface on the handle was not found\r
If the last protocol interface is remove from the handle, the\r
handle is freed.\r
\r
- @param UserHandle The handle to remove the protocol handler from \r
- @param Protocol The protocol, of protocol:interface, to remove \r
- @param Interface The interface, of protocol:interface, to remove \r
+ @param UserHandle The handle to remove the protocol handler from\r
+ @param Protocol The protocol, of protocol:interface, to remove\r
+ @param Interface The interface, of protocol:interface, to remove\r
\r
- @retval EFI_INVALID_PARAMETER Protocol is NULL. \r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
@retval EFI_SUCCESS Protocol interface successfully uninstalled.\r
\r
**/\r
/**\r
Queries a handle to determine if it supports a specified protocol.\r
\r
- @param UserHandle The handle being queried. \r
- @param Protocol The published unique identifier of the protocol. \r
- @param Interface Supplies the address where a pointer to the \r
- corresponding Protocol Interface is returned. \r
+ @param UserHandle The handle being queried.\r
+ @param Protocol The published unique identifier of the protocol.\r
+ @param Interface Supplies the address where a pointer to the\r
+ corresponding Protocol Interface is returned.\r
\r
@return The requested protocol interface for the handle\r
\r
invokes it to obtain the protocol interface. Usage information\r
is registered in the protocol data base.\r
\r
- @param UserHandle The handle to obtain the protocol interface on \r
- @param Protocol The ID of the protocol \r
- @param Interface The location to return the protocol interface \r
- @param ImageHandle The handle of the Image that is opening the \r
- protocol interface specified by Protocol and \r
- Interface. \r
- @param ControllerHandle The controller handle that is requiring this \r
- interface. \r
- @param Attributes The open mode of the protocol interface \r
- specified by Handle and Protocol. \r
-\r
- @retval EFI_INVALID_PARAMETER Protocol is NULL. \r
+ @param UserHandle The handle to obtain the protocol interface on\r
+ @param Protocol The ID of the protocol\r
+ @param Interface The location to return the protocol interface\r
+ @param ImageHandle The handle of the Image that is opening the\r
+ protocol interface specified by Protocol and\r
+ Interface.\r
+ @param ControllerHandle The controller handle that is requiring this\r
+ interface.\r
+ @param Attributes The open mode of the protocol interface\r
+ specified by Handle and Protocol.\r
+\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
@retval EFI_SUCCESS Get the protocol interface.\r
\r
**/\r
/**\r
Return information about Opened protocols in the system\r
\r
- @param UserHandle The handle to close the protocol interface on \r
- @param Protocol The ID of the protocol \r
- @param EntryBuffer A pointer to a buffer of open protocol \r
- information in the form of \r
- EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures. \r
+ @param UserHandle The handle to close the protocol interface on\r
+ @param Protocol The ID of the protocol\r
+ @param EntryBuffer A pointer to a buffer of open protocol\r
+ information in the form of\r
+ EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r
@param EntryCount Number of EntryBuffer entries\r
\r
**/\r
/**\r
Closes a protocol on a handle that was opened using OpenProtocol().\r
\r
- @param UserHandle The handle for the protocol interface that was \r
- previously opened with OpenProtocol(), and is \r
- now being closed. \r
- @param Protocol The published unique identifier of the protocol. \r
- It is the caller's responsibility to pass in a \r
- valid GUID. \r
- @param AgentHandle The handle of the agent that is closing the \r
- protocol interface. \r
- @param ControllerHandle If the agent that opened a protocol is a driver \r
- that follows the EFI Driver Model, then this \r
- parameter is the controller handle that required \r
- the protocol interface. If the agent does not \r
- follow the EFI Driver Model, then this parameter \r
- is optional and may be NULL. \r
-\r
- @retval EFI_SUCCESS The protocol instance was closed. \r
- @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a \r
- valid EFI_HANDLE. \r
- @retval EFI_NOT_FOUND Can not find the specified protocol or \r
+ @param UserHandle The handle for the protocol interface that was\r
+ previously opened with OpenProtocol(), and is\r
+ now being closed.\r
+ @param Protocol The published unique identifier of the protocol.\r
+ It is the caller's responsibility to pass in a\r
+ valid GUID.\r
+ @param AgentHandle The handle of the agent that is closing the\r
+ protocol interface.\r
+ @param ControllerHandle If the agent that opened a protocol is a driver\r
+ that follows the EFI Driver Model, then this\r
+ parameter is the controller handle that required\r
+ the protocol interface. If the agent does not\r
+ follow the EFI Driver Model, then this parameter\r
+ is optional and may be NULL.\r
+\r
+ @retval EFI_SUCCESS The protocol instance was closed.\r
+ @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a\r
+ valid EFI_HANDLE.\r
+ @retval EFI_NOT_FOUND Can not find the specified protocol or\r
AgentHandle.\r
\r
**/\r
IN EFI_HANDLE UserHandle,\r
IN EFI_GUID *Protocol,\r
IN EFI_HANDLE AgentHandle,\r
- IN EFI_HANDLE ControllerHandle \r
+ IN EFI_HANDLE ControllerHandle\r
);\r
\r
\r
Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated\r
from pool.\r
\r
- @param UserHandle The handle from which to retrieve the list of \r
- protocol interface GUIDs. \r
- @param ProtocolBuffer A pointer to the list of protocol interface GUID \r
- pointers that are installed on Handle. \r
- @param ProtocolBufferCount A pointer to the number of GUID pointers present \r
- in ProtocolBuffer. \r
-\r
- @retval EFI_SUCCESS The list of protocol interface GUIDs installed \r
- on Handle was returned in ProtocolBuffer. The \r
- number of protocol interface GUIDs was returned \r
- in ProtocolBufferCount. \r
- @retval EFI_INVALID_PARAMETER Handle is NULL. \r
- @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL. \r
- @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL. \r
- @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the \r
+ @param UserHandle The handle from which to retrieve the list of\r
+ protocol interface GUIDs.\r
+ @param ProtocolBuffer A pointer to the list of protocol interface GUID\r
+ pointers that are installed on Handle.\r
+ @param ProtocolBufferCount A pointer to the number of GUID pointers present\r
+ in ProtocolBuffer.\r
+\r
+ @retval EFI_SUCCESS The list of protocol interface GUIDs installed\r
+ on Handle was returned in ProtocolBuffer. The\r
+ number of protocol interface GUIDs was returned\r
+ in ProtocolBufferCount.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the\r
results.\r
\r
**/\r
/**\r
Add a new protocol notification record for the request protocol.\r
\r
- @param Protocol The requested protocol to add the notify \r
- registration \r
- @param Event The event to signal \r
- @param Registration Returns the registration record \r
+ @param Protocol The requested protocol to add the notify\r
+ registration\r
+ @param Event The event to signal\r
+ @param Registration Returns the registration record\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_SUCCESS Successfully returned the registration record \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_SUCCESS Successfully returned the registration record\r
that has been added\r
\r
**/\r
CoreRegisterProtocolNotify (\r
IN EFI_GUID *Protocol,\r
IN EFI_EVENT Event,\r
- OUT VOID **Registration\r
+ OUT VOID **Registration\r
);\r
- \r
+\r
\r
\r
/**\r
Locates the requested handle(s) and returns them in Buffer.\r
\r
- @param SearchType The type of search to perform to locate the \r
- handles \r
- @param Protocol The protocol to search for \r
- @param SearchKey Dependant on SearchType \r
- @param BufferSize On input the size of Buffer. On output the \r
- size of data returned. \r
- @param Buffer The buffer to return the results in \r
+ @param SearchType The type of search to perform to locate the\r
+ handles\r
+ @param Protocol The protocol to search for\r
+ @param SearchKey Dependant on SearchType\r
+ @param BufferSize On input the size of Buffer. On output the\r
+ size of data returned.\r
+ @param Buffer The buffer to return the results in\r
\r
- @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is \r
- returned in BufferSize. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_SUCCESS Successfully found the requested handle(s) and \r
+ @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is\r
+ returned in BufferSize.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_SUCCESS Successfully found the requested handle(s) and\r
returns them in Buffer.\r
\r
**/\r
IN OUT UINTN *BufferSize,\r
OUT EFI_HANDLE *Buffer\r
);\r
- \r
+\r
\r
\r
/**\r
Locates the handle to a device on the device path that best matches the specified protocol.\r
\r
- @param Protocol The protocol to search for. \r
- @param DevicePath On input, a pointer to a pointer to the device \r
- path. On output, the device path pointer is \r
- modified to point to the remaining part of the \r
- devicepath. \r
- @param Device A pointer to the returned device handle. \r
+ @param Protocol The protocol to search for.\r
+ @param DevicePath On input, a pointer to a pointer to the device\r
+ path. On output, the device path pointer is\r
+ modified to point to the remaining part of the\r
+ devicepath.\r
+ @param Device A pointer to the returned device handle.\r
\r
- @retval EFI_SUCCESS The resulting handle was returned. \r
- @retval EFI_NOT_FOUND No handles matched the search. \r
+ @retval EFI_SUCCESS The resulting handle was returned.\r
+ @retval EFI_NOT_FOUND No handles matched the search.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
**/\r
OUT EFI_HANDLE *Device\r
);\r
\r
- \r
+\r
\r
/**\r
Function returns an array of handles that support the requested protocol\r
in a buffer allocated from pool. This is a version of CoreLocateHandle()\r
that allocates a buffer for the caller.\r
\r
- @param SearchType Specifies which handle(s) are to be returned. \r
- @param Protocol Provides the protocol to search by. This \r
- parameter is only valid for SearchType \r
- ByProtocol. \r
- @param SearchKey Supplies the search key depending on the \r
- SearchType. \r
- @param NumberHandles The number of handles returned in Buffer. \r
- @param Buffer A pointer to the buffer to return the requested \r
- array of handles that support Protocol. \r
-\r
- @retval EFI_SUCCESS The result array of handles was returned. \r
- @retval EFI_NOT_FOUND No handles match the search. \r
- @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the \r
- matching results. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @param SearchType Specifies which handle(s) are to be returned.\r
+ @param Protocol Provides the protocol to search by. This\r
+ parameter is only valid for SearchType\r
+ ByProtocol.\r
+ @param SearchKey Supplies the search key depending on the\r
+ SearchType.\r
+ @param NumberHandles The number of handles returned in Buffer.\r
+ @param Buffer A pointer to the buffer to return the requested\r
+ array of handles that support Protocol.\r
+\r
+ @retval EFI_SUCCESS The result array of handles was returned.\r
+ @retval EFI_NOT_FOUND No handles match the search.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the\r
+ matching results.\r
+ @retval EFI_INVALID_PARAMETER One or more paramters are not valid.\r
\r
**/\r
EFI_STATUS\r
OUT EFI_HANDLE **Buffer\r
);\r
\r
- \r
+\r
\r
/**\r
Return the first Protocol Interface that matches the Protocol GUID. If\r
/**\r
Go connect any handles that were created or modified while a image executed.\r
\r
- @param Key The Key to show that the handle has been \r
+ @param Key The Key to show that the handle has been\r
created/modified\r
\r
**/\r
/**\r
Connects one or more drivers to a controller.\r
\r
- @param ControllerHandle Handle of the controller to be \r
- connected. \r
- @param DriverImageHandle DriverImageHandle A pointer to an \r
- ordered list of driver image \r
- handles. \r
- @param RemainingDevicePath RemainingDevicePath A pointer to \r
- the device path that specifies a \r
- child of the controller specified \r
- by ControllerHandle. \r
- @param Recursive Whether the function would be \r
- called recursively or not. \r
+ @param ControllerHandle Handle of the controller to be\r
+ connected.\r
+ @param DriverImageHandle DriverImageHandle A pointer to an\r
+ ordered list of driver image\r
+ handles.\r
+ @param RemainingDevicePath RemainingDevicePath A pointer to\r
+ the device path that specifies a\r
+ child of the controller specified\r
+ by ControllerHandle.\r
+ @param Recursive Whether the function would be\r
+ called recursively or not.\r
\r
@return Status code.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreConnectController (\r
IN EFI_HANDLE ControllerHandle,\r
/**\r
Disonnects a controller from a driver\r
\r
- @param ControllerHandle ControllerHandle The handle of \r
- the controller from which \r
- driver(s) are to be \r
- disconnected. \r
- @param DriverImageHandle DriverImageHandle The driver to \r
- disconnect from ControllerHandle. \r
- @param ChildHandle ChildHandle The handle of the \r
- child to destroy. \r
-\r
- @retval EFI_SUCCESS One or more drivers were \r
- disconnected from the controller. \r
- @retval EFI_SUCCESS On entry, no drivers are managing \r
- ControllerHandle. \r
- @retval EFI_SUCCESS DriverImageHandle is not NULL, \r
- and on entry DriverImageHandle is \r
- not managing ControllerHandle. \r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
- EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL, \r
- and it is not a valid EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it \r
- is not a valid EFI_HANDLE. \r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources \r
- available to disconnect any \r
- drivers from ControllerHandle. \r
- @retval EFI_DEVICE_ERROR The controller could not be \r
- disconnected because of a device \r
+ @param ControllerHandle ControllerHandle The handle of\r
+ the controller from which\r
+ driver(s) are to be\r
+ disconnected.\r
+ @param DriverImageHandle DriverImageHandle The driver to\r
+ disconnect from ControllerHandle.\r
+ @param ChildHandle ChildHandle The handle of the\r
+ child to destroy.\r
+\r
+ @retval EFI_SUCCESS One or more drivers were\r
+ disconnected from the controller.\r
+ @retval EFI_SUCCESS On entry, no drivers are managing\r
+ ControllerHandle.\r
+ @retval EFI_SUCCESS DriverImageHandle is not NULL,\r
+ and on entry DriverImageHandle is\r
+ not managing ControllerHandle.\r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
+ EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL,\r
+ and it is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it\r
+ is not a valid EFI_HANDLE.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources\r
+ available to disconnect any\r
+ drivers from ControllerHandle.\r
+ @retval EFI_DEVICE_ERROR The controller could not be\r
+ disconnected because of a device\r
error.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreDisconnectController (\r
IN EFI_HANDLE ControllerHandle,\r
/**\r
Allocates pages from the memory map.\r
\r
- @param Type The type of allocation to perform \r
- @param MemoryType The type of memory to turn the allocated pages \r
- into \r
- @param NumberOfPages The number of pages to allocate \r
- @param Memory A pointer to receive the base allocated memory \r
- address \r
+ @param Type The type of allocation to perform\r
+ @param MemoryType The type of memory to turn the allocated pages\r
+ into\r
+ @param NumberOfPages The number of pages to allocate\r
+ @param Memory A pointer to receive the base allocated memory\r
+ address\r
\r
@return Status. On success, Memory is filled in with the base address allocated\r
- @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in \r
- spec. \r
- @retval EFI_NOT_FOUND Could not allocate pages match the requirement. \r
- @retval EFI_OUT_OF_RESOURCES No enough pages to allocate. \r
+ @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in\r
+ spec.\r
+ @retval EFI_NOT_FOUND Could not allocate pages match the requirement.\r
+ @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.\r
@retval EFI_SUCCESS Pages successfully allocated.\r
\r
**/\r
/**\r
Frees previous allocated pages.\r
\r
- @param Memory Base address of memory being freed \r
- @param NumberOfPages The number of pages to free \r
+ @param Memory Base address of memory being freed\r
+ @param NumberOfPages The number of pages to free\r
\r
- @retval EFI_NOT_FOUND Could not find the entry that covers the range \r
- @retval EFI_INVALID_PARAMETER Address not aligned \r
+ @retval EFI_NOT_FOUND Could not find the entry that covers the range\r
+ @retval EFI_INVALID_PARAMETER Address not aligned\r
@return EFI_SUCCESS -Pages successfully freed.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreFreePages (\r
IN EFI_PHYSICAL_ADDRESS Memory,\r
This function returns a copy of the current memory map. The map is an array of\r
memory descriptors, each of which describes a contiguous block of memory.\r
\r
- @param MemoryMapSize A pointer to the size, in bytes, of the \r
- MemoryMap buffer. On input, this is the size of \r
- the buffer allocated by the caller. On output, \r
- it is the size of the buffer returned by the \r
- firmware if the buffer was large enough, or the \r
- size of the buffer needed to contain the map if \r
- the buffer was too small. \r
- @param MemoryMap A pointer to the buffer in which firmware places \r
- the current memory map. \r
- @param MapKey A pointer to the location in which firmware \r
- returns the key for the current memory map. \r
- @param DescriptorSize A pointer to the location in which firmware \r
- returns the size, in bytes, of an individual \r
- EFI_MEMORY_DESCRIPTOR. \r
- @param DescriptorVersion A pointer to the location in which firmware \r
- returns the version number associated with the \r
- EFI_MEMORY_DESCRIPTOR. \r
-\r
- @retval EFI_SUCCESS The memory map was returned in the MemoryMap \r
- buffer. \r
- @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current \r
- buffer size needed to hold the memory map is \r
- returned in MemoryMapSize. \r
+ @param MemoryMapSize A pointer to the size, in bytes, of the\r
+ MemoryMap buffer. On input, this is the size of\r
+ the buffer allocated by the caller. On output,\r
+ it is the size of the buffer returned by the\r
+ firmware if the buffer was large enough, or the\r
+ size of the buffer needed to contain the map if\r
+ the buffer was too small.\r
+ @param MemoryMap A pointer to the buffer in which firmware places\r
+ the current memory map.\r
+ @param MapKey A pointer to the location in which firmware\r
+ returns the key for the current memory map.\r
+ @param DescriptorSize A pointer to the location in which firmware\r
+ returns the size, in bytes, of an individual\r
+ EFI_MEMORY_DESCRIPTOR.\r
+ @param DescriptorVersion A pointer to the location in which firmware\r
+ returns the version number associated with the\r
+ EFI_MEMORY_DESCRIPTOR.\r
+\r
+ @retval EFI_SUCCESS The memory map was returned in the MemoryMap\r
+ buffer.\r
+ @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current\r
+ buffer size needed to hold the memory map is\r
+ returned in MemoryMapSize.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
**/\r
/**\r
Allocate pool of a particular type.\r
\r
- @param PoolType Type of pool to allocate \r
- @param Size The amount of pool to allocate \r
- @param Buffer The address to return a pointer to the allocated \r
- pool \r
+ @param PoolType Type of pool to allocate\r
+ @param Size The amount of pool to allocate\r
+ @param Buffer The address to return a pointer to the allocated\r
+ pool\r
\r
- @retval EFI_INVALID_PARAMETER PoolType not valid \r
- @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed. \r
+ @retval EFI_INVALID_PARAMETER PoolType not valid\r
+ @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.\r
@retval EFI_SUCCESS Pool successfully allocated.\r
\r
**/\r
/**\r
Frees pool.\r
\r
- @param Buffer The allocated pool entry to free \r
+ @param Buffer The allocated pool entry to free\r
\r
- @retval EFI_INVALID_PARAMETER Buffer is not a valid value. \r
+ @retval EFI_INVALID_PARAMETER Buffer is not a valid value.\r
@retval EFI_SUCCESS Pool successfully freed.\r
\r
**/\r
/**\r
Loads an EFI image into memory and returns a handle to the image.\r
\r
- @param BootPolicy If TRUE, indicates that the request originates \r
- from the boot manager, and that the boot \r
- manager is attempting to load FilePath as a \r
- boot selection. \r
- @param ParentImageHandle The caller's image handle. \r
- @param FilePath The specific file path from which the image is \r
- loaded. \r
- @param SourceBuffer If not NULL, a pointer to the memory location \r
- containing a copy of the image to be loaded. \r
- @param SourceSize The size in bytes of SourceBuffer. \r
- @param ImageHandle Pointer to the returned image handle that is \r
- created when the image is successfully loaded. \r
-\r
- @retval EFI_SUCCESS The image was loaded into memory. \r
- @retval EFI_NOT_FOUND The FilePath was not found. \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. \r
- @retval EFI_UNSUPPORTED The image type is not supported, or the device \r
- path cannot be parsed to locate the proper \r
- protocol for loading the file. \r
- @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient \r
+ @param BootPolicy If TRUE, indicates that the request originates\r
+ from the boot manager, and that the boot\r
+ manager is attempting to load FilePath as a\r
+ boot selection.\r
+ @param ParentImageHandle The caller's image handle.\r
+ @param FilePath The specific file path from which the image is\r
+ loaded.\r
+ @param SourceBuffer If not NULL, a pointer to the memory location\r
+ containing a copy of the image to be loaded.\r
+ @param SourceSize The size in bytes of SourceBuffer.\r
+ @param ImageHandle Pointer to the returned image handle that is\r
+ created when the image is successfully loaded.\r
+\r
+ @retval EFI_SUCCESS The image was loaded into memory.\r
+ @retval EFI_NOT_FOUND The FilePath was not found.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_UNSUPPORTED The image type is not supported, or the device\r
+ path cannot be parsed to locate the proper\r
+ protocol for loading the file.\r
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient\r
resources.\r
\r
**/\r
/**\r
Unloads an image.\r
\r
- @param ImageHandle Handle that identifies the image to be \r
- unloaded. \r
+ @param ImageHandle Handle that identifies the image to be\r
+ unloaded.\r
\r
- @retval EFI_SUCCESS The image has been unloaded. \r
- @retval EFI_UNSUPPORTED The image has been sarted, and does not support \r
- unload. \r
+ @retval EFI_SUCCESS The image has been unloaded.\r
+ @retval EFI_UNSUPPORTED The image has been sarted, and does not support\r
+ unload.\r
@retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.\r
\r
**/\r
/**\r
Transfer control to a loaded image's entry point.\r
\r
- @param ImageHandle Handle of image to be started. \r
- @param ExitDataSize Pointer of the size to ExitData \r
- @param ExitData Pointer to a pointer to a data buffer that \r
- includes a Null-terminated Unicode string, \r
- optionally followed by additional binary data. \r
- The string is a description that the caller may \r
- use to further indicate the reason for the \r
- image's exit. \r
-\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
- @retval EFI_SUCCESS Successfully transfer control to the image's \r
+ @param ImageHandle Handle of image to be started.\r
+ @param ExitDataSize Pointer of the size to ExitData\r
+ @param ExitData Pointer to a pointer to a data buffer that\r
+ includes a Null-terminated Unicode string,\r
+ optionally followed by additional binary data.\r
+ The string is a description that the caller may\r
+ use to further indicate the reason for the\r
+ image's exit.\r
+\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
+ @retval EFI_SUCCESS Successfully transfer control to the image's\r
entry point.\r
\r
**/\r
/**\r
Terminates the currently loaded EFI image and returns control to boot services.\r
\r
- @param ImageHandle Handle that identifies the image. This \r
- parameter is passed to the image on entry. \r
- @param Status The image's exit code. \r
- @param ExitDataSize The size, in bytes, of ExitData. Ignored if \r
- ExitStatus is EFI_SUCCESS. \r
- @param ExitData Pointer to a data buffer that includes a \r
- Null-terminated Unicode string, optionally \r
- followed by additional binary data. The string \r
- is a description that the caller may use to \r
- further indicate the reason for the image's \r
- exit. \r
-\r
- @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current \r
- image. \r
- @retval EFI_SUCCESS Successfully terminates the currently loaded \r
- EFI image. \r
- @retval EFI_ACCESS_DENIED Should never reach there. \r
+ @param ImageHandle Handle that identifies the image. This\r
+ parameter is passed to the image on entry.\r
+ @param Status The image's exit code.\r
+ @param ExitDataSize The size, in bytes, of ExitData. Ignored if\r
+ ExitStatus is EFI_SUCCESS.\r
+ @param ExitData Pointer to a data buffer that includes a\r
+ Null-terminated Unicode string, optionally\r
+ followed by additional binary data. The string\r
+ is a description that the caller may use to\r
+ further indicate the reason for the image's\r
+ exit.\r
+\r
+ @retval EFI_INVALID_PARAMETER Image handle is NULL or it is not current\r
+ image.\r
+ @retval EFI_SUCCESS Successfully terminates the currently loaded\r
+ EFI image.\r
+ @retval EFI_ACCESS_DENIED Should never reach there.\r
@retval EFI_OUT_OF_RESOURCES Could not allocate pool\r
\r
**/\r
/**\r
Creates a general-purpose event structure.\r
\r
- @param Type The type of event to create and its mode and \r
- attributes \r
- @param NotifyTpl The task priority level of event notifications \r
- @param NotifyFunction Pointer to the events notification function \r
- @param NotifyContext Pointer to the notification functions context; \r
- corresponds to parameter "Context" in the \r
- notification function \r
- @param Event Pointer to the newly created event if the call \r
- succeeds; undefined otherwise \r
-\r
- @retval EFI_SUCCESS The event structure was created \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value \r
+ @param Type The type of event to create and its mode and\r
+ attributes\r
+ @param NotifyTpl The task priority level of event notifications\r
+ @param NotifyFunction Pointer to the events notification function\r
+ @param NotifyContext Pointer to the notification functions context;\r
+ corresponds to parameter "Context" in the\r
+ notification function\r
+ @param Event Pointer to the newly created event if the call\r
+ succeeds; undefined otherwise\r
+\r
+ @retval EFI_SUCCESS The event structure was created\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value\r
@retval EFI_OUT_OF_RESOURCES The event could not be allocated\r
\r
**/\r
/**\r
Creates a general-purpose event structure\r
\r
- @param Type The type of event to create and its mode and \r
- attributes \r
- @param NotifyTpl The task priority level of event notifications \r
- @param NotifyFunction Pointer to the events notification function \r
- @param NotifyContext Pointer to the notification functions context; \r
- corresponds to parameter "Context" in the \r
- notification function \r
- @param EventGroup GUID for EventGroup if NULL act the same as \r
- gBS->CreateEvent(). \r
- @param Event Pointer to the newly created event if the call \r
- succeeds; undefined otherwise \r
-\r
- @retval EFI_SUCCESS The event structure was created \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value \r
+ @param Type The type of event to create and its mode and\r
+ attributes\r
+ @param NotifyTpl The task priority level of event notifications\r
+ @param NotifyFunction Pointer to the events notification function\r
+ @param NotifyContext Pointer to the notification functions context;\r
+ corresponds to parameter "Context" in the\r
+ notification function\r
+ @param EventGroup GUID for EventGroup if NULL act the same as\r
+ gBS->CreateEvent().\r
+ @param Event Pointer to the newly created event if the call\r
+ succeeds; undefined otherwise\r
+\r
+ @retval EFI_SUCCESS The event structure was created\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value\r
@retval EFI_OUT_OF_RESOURCES The event could not be allocated\r
\r
**/\r
/**\r
Sets the type of timer and the trigger time for a timer event.\r
\r
- @param UserEvent The timer event that is to be signaled at the \r
- specified time \r
- @param Type The type of time that is specified in \r
- TriggerTime \r
- @param TriggerTime The number of 100ns units until the timer \r
- expires \r
+ @param UserEvent The timer event that is to be signaled at the\r
+ specified time\r
+ @param Type The type of time that is specified in\r
+ TriggerTime\r
+ @param TriggerTime The number of 100ns units until the timer\r
+ expires\r
\r
- @retval EFI_SUCCESS The event has been set to be signaled at the \r
- requested time \r
+ @retval EFI_SUCCESS The event has been set to be signaled at the\r
+ requested time\r
@retval EFI_INVALID_PARAMETER Event or Type is not valid\r
\r
**/\r
\r
\r
/**\r
- Signals the event. Queues the event to be notified if needed\r
+ Signals the event. Queues the event to be notified if needed.\r
\r
- @param UserEvent The event to signal \r
+ @param UserEvent The event to signal .\r
\r
- @retval EFI_INVALID_PARAMETER Parameters are not valid. \r
+ @retval EFI_INVALID_PARAMETER Parameters are not valid.\r
@retval EFI_SUCCESS The event was signaled.\r
\r
**/\r
/**\r
Stops execution until an event is signaled.\r
\r
- @param NumberOfEvents The number of events in the UserEvents array \r
- @param UserEvents An array of EFI_EVENT \r
- @param UserIndex Pointer to the index of the event which \r
- satisfied the wait condition \r
+ @param NumberOfEvents The number of events in the UserEvents array\r
+ @param UserEvents An array of EFI_EVENT\r
+ @param UserIndex Pointer to the index of the event which\r
+ satisfied the wait condition\r
\r
- @retval EFI_SUCCESS The event indicated by Index was signaled. \r
- @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification \r
- function or Event was not a valid type \r
+ @retval EFI_SUCCESS The event indicated by Index was signaled.\r
+ @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification\r
+ function or Event was not a valid type\r
@retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION\r
\r
**/\r
/**\r
Closes an event and frees the event structure.\r
\r
- @param UserEvent Event to close \r
+ @param UserEvent Event to close\r
\r
- @retval EFI_INVALID_PARAMETER Parameters are not valid. \r
+ @retval EFI_INVALID_PARAMETER Parameters are not valid.\r
@retval EFI_SUCCESS The event has been closed\r
\r
**/\r
/**\r
Check the status of an event.\r
\r
- @param UserEvent The event to check \r
+ @param UserEvent The event to check\r
\r
- @retval EFI_SUCCESS The event is in the signaled state \r
- @retval EFI_NOT_READY The event is not in the signaled state \r
+ @retval EFI_SUCCESS The event is in the signaled state\r
+ @retval EFI_NOT_READY The event is not in the signaled state\r
@retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL\r
\r
**/\r
Adds reserved memory, system memory, or memory-mapped I/O resources to the\r
global coherency domain of the processor.\r
\r
- @param GcdMemoryType Memory type of the memory space. \r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
- @param Capabilities alterable attributes of the memory space. \r
+ @param GcdMemoryType Memory type of the memory space.\r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
+ @param Capabilities alterable attributes of the memory space.\r
\r
@retval EFI_SUCCESS Merged this memory space into GCD map.\r
\r
Allocates nonexistent memory, reserved memory, system memory, or memorymapped\r
I/O resources from the global coherency domain of the processor.\r
\r
- @param GcdAllocateType The type of allocate operation \r
- @param GcdMemoryType The desired memory type \r
- @param Alignment Align with 2^Alignment \r
- @param Length Length to allocate \r
- @param BaseAddress Base address to allocate \r
- @param ImageHandle The image handle consume the allocated space. \r
- @param DeviceHandle The device handle consume the allocated space. \r
+ @param GcdAllocateType The type of allocate operation\r
+ @param GcdMemoryType The desired memory type\r
+ @param Alignment Align with 2^Alignment\r
+ @param Length Length to allocate\r
+ @param BaseAddress Base address to allocate\r
+ @param ImageHandle The image handle consume the allocated space.\r
+ @param DeviceHandle The device handle consume the allocated space.\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
- @retval EFI_NOT_FOUND No descriptor contains the desired space. \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.\r
@retval EFI_SUCCESS Memory space successfully allocated.\r
\r
**/\r
Frees nonexistent memory, reserved memory, system memory, or memory-mapped\r
I/O resources from the global coherency domain of the processor.\r
\r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
\r
@retval EFI_SUCCESS Space successfully freed.\r
\r
Removes reserved memory, system memory, or memory-mapped I/O resources from\r
the global coherency domain of the processor.\r
\r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
\r
@retval EFI_SUCCESS Successfully remove a segment of memory space.\r
\r
/**\r
Retrieves the descriptor for a memory region containing a specified address.\r
\r
- @param BaseAddress Specified start address \r
- @param Descriptor Specified length \r
+ @param BaseAddress Specified start address\r
+ @param Descriptor Specified length\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
@retval EFI_SUCCESS Successfully get memory space descriptor.\r
\r
**/\r
Modifies the attributes for a memory region in the global coherency domain of the\r
processor.\r
\r
- @param BaseAddress Specified start address \r
- @param Length Specified length \r
- @param Attributes Specified attributes \r
+ @param BaseAddress Specified start address\r
+ @param Length Specified length\r
+ @param Attributes Specified attributes\r
\r
- @retval EFI_SUCCESS Successfully set attribute of a segment of \r
+ @retval EFI_SUCCESS Successfully set attribute of a segment of\r
memory space.\r
\r
**/\r
Returns a map of the memory resources in the global coherency domain of the\r
processor.\r
\r
- @param NumberOfDescriptors Number of descriptors. \r
- @param MemorySpaceMap Descriptor array \r
+ @param NumberOfDescriptors Number of descriptors.\r
+ @param MemorySpaceMap Descriptor array\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Successfully get memory space map.\r
\r
**/\r
/**\r
Adds reserved I/O or I/O resources to the global coherency domain of the processor.\r
\r
- @param GcdIoType IO type of the segment. \r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param GcdIoType IO type of the segment.\r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
- @retval EFI_SUCCESS Merged this segment into GCD map. \r
+ @retval EFI_SUCCESS Merged this segment into GCD map.\r
@retval EFI_INVALID_PARAMETER Parameter not valid\r
\r
**/\r
Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
domain of the processor.\r
\r
- @param GcdAllocateType The type of allocate operation \r
- @param GcdIoType The desired IO type \r
- @param Alignment Align with 2^Alignment \r
- @param Length Length to allocate \r
- @param BaseAddress Base address to allocate \r
- @param ImageHandle The image handle consume the allocated space. \r
- @param DeviceHandle The device handle consume the allocated space. \r
+ @param GcdAllocateType The type of allocate operation\r
+ @param GcdIoType The desired IO type\r
+ @param Alignment Align with 2^Alignment\r
+ @param Length Length to allocate\r
+ @param BaseAddress Base address to allocate\r
+ @param ImageHandle The image handle consume the allocated space.\r
+ @param DeviceHandle The device handle consume the allocated space.\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
- @retval EFI_NOT_FOUND No descriptor contains the desired space. \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.\r
@retval EFI_SUCCESS IO space successfully allocated.\r
\r
**/\r
Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
domain of the processor.\r
\r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
@retval EFI_SUCCESS Space successfully freed.\r
\r
Removes reserved I/O or I/O resources from the global coherency domain of the\r
processor.\r
\r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
@retval EFI_SUCCESS Successfully removed a segment of IO space.\r
\r
/**\r
Retrieves the descriptor for an I/O region containing a specified address.\r
\r
- @param BaseAddress Specified start address \r
- @param Descriptor Specified length \r
+ @param BaseAddress Specified start address\r
+ @param Descriptor Specified length\r
\r
- @retval EFI_INVALID_PARAMETER Descriptor is NULL. \r
+ @retval EFI_INVALID_PARAMETER Descriptor is NULL.\r
@retval EFI_SUCCESS Successfully get the IO space descriptor.\r
\r
**/\r
/**\r
Returns a map of the I/O resources in the global coherency domain of the processor.\r
\r
- @param NumberOfDescriptors Number of descriptors. \r
- @param IoSpaceMap Descriptor array \r
+ @param NumberOfDescriptors Number of descriptors.\r
+ @param IoSpaceMap Descriptor array\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Successfully get IO space map.\r
\r
**/\r
will be called, and when the Bds() exits the Dispatcher will be called\r
again.\r
\r
- @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running \r
- @retval EFI_NOT_FOUND No DXE Drivers were dispatched \r
- @retval EFI_SUCCESS One or more DXE Drivers were dispatched \r
+ @retval EFI_ALREADY_STARTED The DXE Dispatcher is already running\r
+ @retval EFI_NOT_FOUND No DXE Drivers were dispatched\r
+ @retval EFI_SUCCESS One or more DXE Drivers were dispatched\r
\r
**/\r
EFI_STATUS\r
Check every driver and locate a matching one. If the driver is found, the Unrequested\r
state flag is cleared.\r
\r
- @param FirmwareVolumeHandle The handle of the Firmware Volume that contains \r
- the firmware file specified by DriverName. \r
- @param DriverName The Driver name to put in the Dependent state. \r
+ @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
+ the firmware file specified by DriverName.\r
+ @param DriverName The Driver name to put in the Dependent state.\r
\r
- @retval EFI_SUCCESS The DriverName was found and it's SOR bit was \r
- cleared \r
- @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit \r
- was not set. \r
+ @retval EFI_SUCCESS The DriverName was found and it's SOR bit was\r
+ cleared\r
+ @retval EFI_NOT_FOUND The DriverName does not exist or it's SOR bit was\r
+ not set.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Convert a driver from the Untrused back to the Scheduled state\r
+ Convert a driver from the Untrused back to the Scheduled state.\r
\r
- @param FirmwareVolumeHandle The handle of the Firmware Volume that contains \r
- the firmware file specified by DriverName. \r
- @param DriverName The Driver name to put in the Scheduled state \r
+ @param FirmwareVolumeHandle The handle of the Firmware Volume that contains\r
+ the firmware file specified by DriverName.\r
+ @param DriverName The Driver name to put in the Scheduled state\r
\r
- @retval EFI_SUCCESS The file was found in the untrusted state, and \r
- it was promoted to the trusted state. \r
- @retval EFI_NOT_FOUND The file was not found in the untrusted state. \r
+ @retval EFI_SUCCESS The file was found in the untrusted state, and it\r
+ was promoted to the trusted state.\r
+ @retval EFI_NOT_FOUND The file was not found in the untrusted state.\r
\r
**/\r
EFI_STATUS\r
to allocate the proper sized buffer for various\r
EFI interfaces.\r
\r
- @param Status Current status \r
- @param Buffer Current allocated buffer, or NULL \r
- @param BufferSize Current buffer size needed \r
+ @param Status Current status\r
+ @param Buffer Current allocated buffer, or NULL\r
+ @param BufferSize Current buffer size needed\r
\r
- @retval TRUE if the buffer was reallocated and the caller \r
- should try the API again. \r
- @retval FALSE buffer could not be allocated and the caller \r
+ @retval TRUE if the buffer was reallocated and the caller\r
+ should try the API again.\r
+ @retval FALSE buffer could not be allocated and the caller\r
should not try the API again.\r
\r
**/\r
libraries, and registers two notification functions. These notification\r
functions are responsible for building the FV stack dynamically.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
@retval EFI_SUCCESS Function successfully returned.\r
\r
particular, it can be called by BDS to process a single firmware\r
volume found in a capsule.\r
\r
- @param FvHeader pointer to a firmware volume header \r
- @param Size the size of the buffer pointed to by FvHeader \r
- @param FVProtocolHandle the handle on which a firmware volume protocol \r
- was produced for the firmware volume passed in. \r
+ @param FvHeader pointer to a firmware volume header\r
+ @param Size the size of the buffer pointed to by FvHeader\r
+ @param FVProtocolHandle the handle on which a firmware volume protocol\r
+ was produced for the firmware volume passed in.\r
\r
- @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of \r
- system resources \r
- @retval EFI_VOLUME_CORRUPTED if the volume was corrupted \r
- @retval EFI_SUCCESS a firmware volume protocol was produced for the \r
+ @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of\r
+ system resources\r
+ @retval EFI_VOLUME_CORRUPTED if the volume was corrupted\r
+ @retval EFI_SUCCESS a firmware volume protocol was produced for the\r
firmware volume\r
\r
**/\r
EFI_STATUS\r
CoreProcessFirmwareVolume (\r
IN VOID *FvHeader,\r
- IN UINTN Size, \r
+ IN UINTN Size,\r
OUT EFI_HANDLE *FVProtocolHandle\r
);\r
\r
CoreDisplayMissingArchProtocols (\r
VOID\r
);\r
- \r
+\r
\r
/**\r
Traverse the discovered list for any drivers that were discovered but not loaded\r
Place holder function until all the Boot Services and Runtime Services are\r
available.\r
\r
- @param Arg1 Undefined \r
+ @param Arg1 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
- @param Arg4 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
+ @param Arg4 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
- @param Arg4 Undefined \r
- @param Arg5 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
+ @param Arg4 Undefined\r
+ @param Arg5 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Searches for a Protocol Interface passed from PEI through a HOB.\r
\r
- @param ProtocolGuid The Protocol GUID to search for in the HOB List \r
- @param Interface A pointer to the interface for the Protocol GUID \r
+ @param ProtocolGuid The Protocol GUID to search for in the HOB List\r
+ @param Interface A pointer to the interface for the Protocol GUID\r
\r
- @retval EFI_SUCCESS The Protocol GUID was found and its interface is \r
- returned in Interface \r
+ @retval EFI_SUCCESS The Protocol GUID was found and its interface is\r
+ returned in Interface\r
@retval EFI_NOT_FOUND The Protocol GUID was not found in the HOB List\r
\r
**/\r
buffer that is required to decompress the\r
compressed buffer specified by Source and\r
SourceSize.\r
- \r
+\r
@retval EFI_SUCCESS The size of the uncompressed data was returned in\r
DestinationSize and the size of the scratch buffer\r
was returned in ScratchSize.\r
the decompression.\r
@param ScratchSize The size of scratch buffer. The size of the\r
scratch buffer needed is obtained from GetInfo().\r
- \r
+\r
@retval EFI_SUCCESS Decompression completed successfully, and the\r
uncompressed buffer is returned in Destination.\r
@retval EFI_INVALID_PARAMETER The source buffer specified by Source and\r
EFI_STATUS\r
EFIAPI\r
DxeMainUefiDecompress (\r
- IN EFI_DECOMPRESS_PROTOCOL *This,\r
+ IN EFI_DECOMPRESS_PROTOCOL *This,\r
IN VOID *Source,\r
IN UINT32 SourceSize,\r
IN OUT VOID *Destination,\r
SEP member function. This function creates and returns a new section stream\r
handle to represent the new section stream.\r
\r
- @param SectionStreamLength Size in bytes of the section stream. \r
- @param SectionStream Buffer containing the new section stream. \r
- @param SectionStreamHandle A pointer to a caller allocated UINTN that on \r
- output contains the new section stream handle. \r
+ @param SectionStreamLength Size in bytes of the section stream.\r
+ @param SectionStream Buffer containing the new section stream.\r
+ @param SectionStreamHandle A pointer to a caller allocated UINTN that on\r
+ output contains the new section stream handle.\r
\r
@retval EFI_SUCCESS The section stream is created successfully.\r
- @retval EFI_OUT_OF_RESOURCES memory allocation failed. \r
- @retval EFI_INVALID_PARAMETER Section stream does not end concident with end \r
+ @retval EFI_OUT_OF_RESOURCES memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER Section stream does not end concident with end\r
of last section.\r
\r
**/\r
/**\r
SEP member function. Deletes an existing section stream\r
\r
- @param StreamHandleToClose Indicates the stream to close \r
+ @param StreamHandleToClose Indicates the stream to close\r
\r
@retval EFI_SUCCESS The section stream is closed sucessfully.\r
- @retval EFI_OUT_OF_RESOURCES Memory allocation failed. \r
- @retval EFI_INVALID_PARAMETER Section stream does not end concident with end \r
+ @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER Section stream does not end concident with end\r
of last section.\r
\r
**/\r
\r
ENTRY_POINT = DxeMain\r
\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
+# VALID_ARCHITECTURES = IA32 X64 IPF\r
\r
[Sources.common]\r
Library.h\r
[Packages]\r
MdePkg/MdePkg.dec\r
MdeModulePkg/MdeModulePkg.dec\r
- \r
+\r
[LibraryClasses]\r
BaseMemoryLib\r
CacheMaintenanceLib\r
/**\r
Main entry point to DXE Core.\r
\r
- @param HobStart Pointer to the beginning of the HOB List from PEI. \r
+ @param HobStart Pointer to the beginning of the HOB List from PEI.\r
\r
@return This function should never return.\r
\r
// Report Status code before transfer control to BDS\r
//\r
CoreReportProgressCode (FixedPcdGet32 (PcdStatusCodeValueDxeCoreHandoffToBds));\r
- \r
+\r
//\r
// Display any drivers that were not dispatched because dependency expression\r
// evaluated to false if this is a debug build\r
Place holder function until all the Boot Services and Runtime Services are\r
available.\r
\r
- @param Arg1 Undefined \r
+ @param Arg1 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
- @param Arg4 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
+ @param Arg4 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Place holder function until all the Boot Services and Runtime Services are available.\r
\r
- @param Arg1 Undefined \r
- @param Arg2 Undefined \r
- @param Arg3 Undefined \r
- @param Arg4 Undefined \r
- @param Arg5 Undefined \r
+ @param Arg1 Undefined\r
+ @param Arg2 Undefined\r
+ @param Arg3 Undefined\r
+ @param Arg4 Undefined\r
+ @param Arg5 Undefined\r
\r
@return EFI_NOT_AVAILABLE_YET\r
\r
/**\r
Searches for a Protocol Interface passed from PEI through a HOB.\r
\r
- @param ProtocolGuid The Protocol GUID to search for in the HOB List \r
- @param Interface A pointer to the interface for the Protocol GUID \r
+ @param ProtocolGuid The Protocol GUID to search for in the HOB List\r
+ @param Interface A pointer to the interface for the Protocol GUID\r
\r
- @retval EFI_SUCCESS The Protocol GUID was found and its interface is \r
- returned in Interface \r
+ @retval EFI_SUCCESS The Protocol GUID was found and its interface is\r
+ returned in Interface\r
@retval EFI_NOT_FOUND The Protocol GUID was not found in the HOB List\r
\r
**/\r
/**\r
Terminates all boot services.\r
\r
- @param ImageHandle Handle that identifies the exiting image. \r
+ @param ImageHandle Handle that identifies the exiting image.\r
@param MapKey Key to the latest memory map.\r
\r
- @retval EFI_SUCCESS Boot Services terminated \r
+ @retval EFI_SUCCESS Boot Services terminated\r
@retval EFI_INVALID_PARAMETER MapKey is incorrect.\r
\r
**/\r
EFI_TCG_PLATFORM_PROTOCOL *TcgPlatformProtocol;\r
\r
//\r
- // Measure invocation of ExitBootServices, \r
+ // Measure invocation of ExitBootServices,\r
// which is defined by TCG_EFI_Platform_1_20_Final Specification\r
//\r
TcgPlatformProtocol = NULL;\r
StatusTemp = TcgPlatformProtocol->MeasureAction (EFI_EXIT_BOOT_SERVICES_SUCCEEDED);\r
ASSERT_EFI_ERROR (StatusTemp);\r
}\r
- \r
+\r
return Status;\r
}\r
\r
buffer that is required to decompress the\r
compressed buffer specified by Source and\r
SourceSize.\r
- \r
+\r
@retval EFI_SUCCESS The size of the uncompressed data was returned in\r
DestinationSize and the size of the scratch buffer\r
was returned in ScratchSize.\r
the decompression.\r
@param ScratchSize The size of scratch buffer. The size of the\r
scratch buffer needed is obtained from GetInfo().\r
- \r
+\r
@retval EFI_SUCCESS Decompression completed successfully, and the\r
uncompressed buffer is returned in Destination.\r
@retval EFI_INVALID_PARAMETER The source buffer specified by Source and\r
EFI_STATUS Status;\r
UINT32 TestDestinationSize;\r
UINT32 TestScratchSize;\r
- \r
+\r
if (Source == NULL || Destination== NULL || Scratch == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
Status = UefiDecompressGetInfo (Source, SourceSize, &TestDestinationSize, &TestScratchSize);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
/**\r
Return TRUE if all AP services are availible.\r
\r
- @retval EFI_SUCCESS All AP services are available \r
+ @retval EFI_SUCCESS All AP services are available\r
@retval EFI_NOT_FOUND At least one AP service is not available\r
\r
**/\r
present flag to TRUE. If any constructor is required it is executed. The EFI\r
System Table headers are updated.\r
\r
- @param Event The Event that is being processed, not used. \r
+ @param Event The Event that is being processed, not used.\r
@param Context Event Context, not used.\r
\r
**/\r
/**\r
Dispatches all pending events.\r
\r
- @param Priority The task priority level of event notifications \r
+ @param Priority The task priority level of event notifications\r
to dispatch\r
\r
**/\r
/**\r
Creates a general-purpose event structure.\r
\r
- @param Type The type of event to create and its mode and \r
- attributes \r
- @param NotifyTpl The task priority level of event notifications \r
- @param NotifyFunction Pointer to the events notification function \r
- @param NotifyContext Pointer to the notification functions context; \r
- corresponds to parameter "Context" in the \r
- notification function \r
- @param Event Pointer to the newly created event if the call \r
- succeeds; undefined otherwise \r
-\r
- @retval EFI_SUCCESS The event structure was created \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value \r
+ @param Type The type of event to create and its mode and\r
+ attributes\r
+ @param NotifyTpl The task priority level of event notifications\r
+ @param NotifyFunction Pointer to the events notification function\r
+ @param NotifyContext Pointer to the notification functions context;\r
+ corresponds to parameter "Context" in the\r
+ notification function\r
+ @param Event Pointer to the newly created event if the call\r
+ succeeds; undefined otherwise\r
+\r
+ @retval EFI_SUCCESS The event structure was created\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value\r
@retval EFI_OUT_OF_RESOURCES The event could not be allocated\r
\r
**/\r
/**\r
Creates a general-purpose event structure\r
\r
- @param Type The type of event to create and its mode and \r
- attributes \r
- @param NotifyTpl The task priority level of event notifications \r
- @param NotifyFunction Pointer to the events notification function \r
- @param NotifyContext Pointer to the notification functions context; \r
- corresponds to parameter "Context" in the \r
- notification function \r
- @param EventGroup GUID for EventGroup if NULL act the same as \r
- gBS->CreateEvent(). \r
- @param Event Pointer to the newly created event if the call \r
- succeeds; undefined otherwise \r
-\r
- @retval EFI_SUCCESS The event structure was created \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value \r
+ @param Type The type of event to create and its mode and\r
+ attributes\r
+ @param NotifyTpl The task priority level of event notifications\r
+ @param NotifyFunction Pointer to the events notification function\r
+ @param NotifyContext Pointer to the notification functions context;\r
+ corresponds to parameter "Context" in the\r
+ notification function\r
+ @param EventGroup GUID for EventGroup if NULL act the same as\r
+ gBS->CreateEvent().\r
+ @param Event Pointer to the newly created event if the call\r
+ succeeds; undefined otherwise\r
+\r
+ @retval EFI_SUCCESS The event structure was created\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value\r
@retval EFI_OUT_OF_RESOURCES The event could not be allocated\r
\r
**/\r
\r
@param UserEvent The event to signal .\r
\r
- @retval EFI_INVALID_PARAMETER Parameters are not valid. \r
+ @retval EFI_INVALID_PARAMETER Parameters are not valid.\r
@retval EFI_SUCCESS The event was signaled.\r
\r
**/\r
/**\r
Check the status of an event.\r
\r
- @param UserEvent The event to check \r
+ @param UserEvent The event to check\r
\r
- @retval EFI_SUCCESS The event is in the signaled state \r
- @retval EFI_NOT_READY The event is not in the signaled state \r
+ @retval EFI_SUCCESS The event is in the signaled state\r
+ @retval EFI_NOT_READY The event is not in the signaled state\r
@retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL\r
\r
**/\r
/**\r
Stops execution until an event is signaled.\r
\r
- @param NumberOfEvents The number of events in the UserEvents array \r
- @param UserEvents An array of EFI_EVENT \r
- @param UserIndex Pointer to the index of the event which \r
- satisfied the wait condition \r
+ @param NumberOfEvents The number of events in the UserEvents array\r
+ @param UserEvents An array of EFI_EVENT\r
+ @param UserIndex Pointer to the index of the event which\r
+ satisfied the wait condition\r
\r
- @retval EFI_SUCCESS The event indicated by Index was signaled. \r
- @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification \r
- function or Event was not a valid type \r
+ @retval EFI_SUCCESS The event indicated by Index was signaled.\r
+ @retval EFI_INVALID_PARAMETER The event indicated by Index has a notification\r
+ function or Event was not a valid type\r
@retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION\r
\r
**/\r
/**\r
Closes an event and frees the event structure.\r
\r
- @param UserEvent Event to close \r
+ @param UserEvent Event to close\r
\r
- @retval EFI_INVALID_PARAMETER Parameters are not valid. \r
+ @retval EFI_INVALID_PARAMETER Parameters are not valid.\r
@retval EFI_SUCCESS The event has been closed\r
\r
**/\r
Checks the sorted timer list against the current system time.\r
Signals any expired event timer.\r
\r
- @param CheckEvent Not used \r
+ @param CheckEvent Not used\r
@param Context Not used\r
\r
**/\r
/**\r
Inserts the timer event.\r
\r
- @param Event Points to the internal structure of timer event \r
+ @param Event Points to the internal structure of timer event\r
to be installed\r
\r
**/\r
CoreAcquireLock (&mEfiSystemTimeLock);\r
SystemTime = mEfiSystemTime;\r
CoreReleaseLock (&mEfiSystemTimeLock);\r
- \r
+\r
return SystemTime;\r
}\r
\r
/**\r
Called by the platform code to process a tick.\r
\r
- @param Duration The number of 100ns elasped since the last call \r
+ @param Duration The number of 100ns elasped since the last call\r
to TimerTick\r
\r
**/\r
Checks the sorted timer list against the current system time.\r
Signals any expired event timer.\r
\r
- @param CheckEvent Not used \r
+ @param CheckEvent Not used\r
@param Context Not used\r
\r
**/\r
/**\r
Inserts the timer event.\r
\r
- @param Event Points to the internal structure of timer event \r
+ @param Event Points to the internal structure of timer event\r
to be installed\r
\r
**/\r
/**\r
Sets the type of timer and the trigger time for a timer event.\r
\r
- @param UserEvent The timer event that is to be signaled at the \r
- specified time \r
- @param Type The type of time that is specified in \r
- TriggerTime \r
- @param TriggerTime The number of 100ns units until the timer \r
- expires \r
+ @param UserEvent The timer event that is to be signaled at the\r
+ specified time\r
+ @param Type The type of time that is specified in\r
+ TriggerTime\r
+ @param TriggerTime The number of 100ns units until the timer\r
+ expires\r
\r
- @retval EFI_SUCCESS The event has been set to be signaled at the \r
- requested time \r
+ @retval EFI_SUCCESS The event has been set to be signaled at the\r
+ requested time\r
@retval EFI_INVALID_PARAMETER Event or Type is not valid\r
\r
**/\r
/**\r
Return the highest set bit.\r
\r
- @param Number The value to check \r
+ @param Number The value to check\r
\r
@return Bit position of the highest set bit\r
\r
)\r
{\r
UINTN Msb;\r
- \r
+\r
Msb = 31;\r
while ((Msb > 0) && ((Number & (UINTN)(1 << Msb)) == 0)) {\r
Msb--;\r
Raise the task priority level to the new level.\r
High level is implemented by disabling processor interrupts.\r
\r
- @param NewTpl New task priority level \r
+ @param NewTpl New task priority level\r
\r
@return The previous task priority level\r
\r
//\r
\r
if (OldTpl >= TPL_HIGH_LEVEL && NewTpl < TPL_HIGH_LEVEL) {\r
- gEfiCurrentTpl = TPL_HIGH_LEVEL; \r
+ gEfiCurrentTpl = TPL_HIGH_LEVEL;\r
}\r
\r
//\r
EFI_EVENT_NOTIFY NotifyFunction;\r
VOID *NotifyContext;\r
EFI_GUID EventGroup;\r
- LIST_ENTRY NotifyLink; \r
+ LIST_ENTRY NotifyLink;\r
BOOLEAN ExFlag;\r
- \r
+\r
//\r
// A list of all runtime events\r
//\r
} Timer;\r
} u;\r
\r
-} IEVENT; \r
+} IEVENT;\r
\r
//\r
// Internal prototypes\r
/**\r
Dispatches all pending events.\r
\r
- @param Priority The task priority level of event notifications \r
+ @param Priority The task priority level of event notifications\r
to dispatch\r
\r
**/\r
/**\r
Return the highest set bit.\r
\r
- @param Number The value to check \r
+ @param Number The value to check\r
\r
@return Bit position of the highest set bit\r
\r
/**\r
Disables CPU interrupts.\r
\r
- @retval EFI_SUCCESS If interrupts were disabled in the CPU. \r
+ @retval EFI_SUCCESS If interrupts were disabled in the CPU.\r
@retval EFI_INVALID_PARAMETER State is NULL.\r
\r
**/\r
BOOLEAN\r
GetInterruptState (\r
- VOID \r
+ VOID\r
);\r
\r
//\r
/**\r
Get the FFS file state by checking the highest bit set in the header's state field.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file header \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file header\r
\r
@return FFS File state\r
\r
/**\r
Check if a block of buffer is erased.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param InBuffer The buffer to be checked \r
- @param BufferSize Size of the buffer in bytes \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param InBuffer The buffer to be checked\r
+ @param BufferSize Size of the buffer in bytes\r
\r
- @retval TRUE The block of buffer is erased \r
+ @retval TRUE The block of buffer is erased\r
@retval FALSE The block of buffer is not erased\r
\r
**/\r
/**\r
Verify checksum of the firmware volume header.\r
\r
- @param FvHeader Points to the firmware volume header to be checked \r
+ @param FvHeader Points to the firmware volume header to be checked\r
\r
- @retval TRUE Checksum verification passed \r
+ @retval TRUE Checksum verification passed\r
@retval FALSE Checksum verification failed\r
\r
**/\r
/**\r
Verify checksum of the FFS file header.\r
\r
- @param FfsHeader Points to the FFS file header to be checked \r
+ @param FfsHeader Points to the FFS file header to be checked\r
\r
- @retval TRUE Checksum verification passed \r
+ @retval TRUE Checksum verification passed\r
@retval FALSE Checksum verification failed\r
\r
**/\r
/**\r
Check if it's a valid FFS file header.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file header to be checked \r
- @param FileState FFS file state to be returned \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file header to be checked\r
+ @param FileState FFS file state to be returned\r
\r
- @retval TRUE Valid FFS file header \r
+ @retval TRUE Valid FFS file header\r
@retval FALSE Invalid FFS file header\r
\r
**/\r
// Here we need to verify header checksum\r
//\r
return VerifyHeaderChecksum (FfsHeader);\r
- \r
+\r
case EFI_FILE_HEADER_CONSTRUCTION:\r
case EFI_FILE_HEADER_INVALID:\r
default:\r
Check if it's a valid FFS file.\r
Here we are sure that it has a valid FFS file header since we must call IsValidFfsHeader() first.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file to be checked \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file to be checked\r
\r
- @retval TRUE Valid FFS file \r
+ @retval TRUE Valid FFS file\r
@retval FALSE Invalid FFS file\r
\r
**/\r
/** @file\r
Firmware File System driver that produce Firmware Volume protocol.\r
- Layers on top of Firmware Block protocol to produce a file abstraction \r
+ Layers on top of Firmware Block protocol to produce a file abstraction\r
of FV based files.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
given the supplied FW_VOL_BLOCK_PROTOCOL, allocate a buffer for output and\r
copy the volume header into it.\r
\r
- @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to \r
- read the volume header \r
- @param FwVolHeader Pointer to pointer to allocated buffer in which \r
- the volume header is returned. \r
+ @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to\r
+ read the volume header\r
+ @param FwVolHeader Pointer to pointer to allocated buffer in which\r
+ the volume header is returned.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated. \r
- @retval EFI_SUCCESS Successfully read volume header to the allocated \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS Successfully read volume header to the allocated\r
buffer.\r
\r
**/\r
//\r
CoreFreePool (*FwVolHeader);\r
}\r
- \r
+\r
return Status;\r
}\r
\r
/**\r
Free FvDevice resource when error happens\r
\r
- @param FvDevice pointer to the FvDevice to be freed. \r
+ @param FvDevice pointer to the FvDevice to be freed.\r
\r
**/\r
VOID\r
FfsFileEntry = (FFS_FILE_LIST_ENTRY *)FvDevice->FfsFileListHeader.ForwardLink;\r
while (&FfsFileEntry->Link != &FvDevice->FfsFileListHeader) {\r
NextEntry = (&FfsFileEntry->Link)->ForwardLink;\r
- \r
+\r
if (FfsFileEntry->StreamHandle != 0) {\r
//\r
// Close stream and free resources from SEP\r
/**\r
Check if an FV is consistent and allocate cache for it.\r
\r
- @param FvDevice A pointer to the FvDevice to be checked. \r
+ @param FvDevice A pointer to the FvDevice to be checked.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated. \r
- @retval EFI_SUCCESS FV is consistent and cache is allocated. \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS FV is consistent and cache is allocated.\r
@retval EFI_VOLUME_CORRUPTED File system is corrupted.\r
\r
**/\r
\r
Fvb = FvDevice->Fvb;\r
FwVolHeader = FvDevice->FwVolHeader;\r
- \r
+\r
Status = Fvb->GetAttributes (Fvb, &FvbAttributes);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
LbaIndex = 0;\r
LbaOffset = FwVolHeader->HeaderLength;\r
while ((BlockMap->NumBlocks != 0) || (BlockMap->Length != 0)) {\r
- \r
+\r
for (Index = 0; Index < BlockMap->NumBlocks; Index ++) {\r
\r
Size = BlockMap->Length;\r
if (EFI_ERROR (Status)) {\r
goto Done;\r
}\r
- \r
+\r
//\r
// After we skip Fv Header always read from start of block\r
//\r
FvDevice->ErasePolarity = 1;\r
} else {\r
FvDevice->ErasePolarity = 0;\r
- } \r
+ }\r
\r
\r
//\r
}\r
\r
if (!IsValidFfsHeader (FvDevice->ErasePolarity, FfsHeader, &FileState)) {\r
- if ((FileState == EFI_FILE_HEADER_INVALID) || \r
+ if ((FileState == EFI_FILE_HEADER_INVALID) ||\r
(FileState == EFI_FILE_HEADER_CONSTRUCTION)) {\r
FfsHeader++;\r
continue;\r
FileLength = *(UINT32 *)&FfsHeader->Size[0] & 0x00FFFFFF;\r
\r
FileState = GetFileState (FvDevice->ErasePolarity, FfsHeader);\r
- \r
+\r
//\r
// check for non-deleted file\r
//\r
Status = EFI_OUT_OF_RESOURCES;\r
goto Done;\r
}\r
- \r
+\r
FfsFileEntry->FfsHeader = FfsHeader;\r
InsertTailList (&FvDevice->FfsFileListHeader, &FfsFileEntry->Link);\r
}\r
\r
FfsHeader = (EFI_FFS_FILE_HEADER *)(((UINT8 *)FfsHeader) + FileLength);\r
- \r
+\r
//\r
// Adjust pointer to the next 8-byte aligned boundry.\r
//\r
FfsHeader = (EFI_FFS_FILE_HEADER *)(((UINTN)FfsHeader + 7) & ~0x07);\r
- \r
+\r
}\r
\r
Done:\r
EFI_FIRMWARE_VOLUME2_PROTOCOL on the same handle. This is the function where\r
the actual initialization of the EFI_FIRMWARE_VOLUME2_PROTOCOL is done.\r
\r
- @param Event The event that occured \r
+ @param Event The event that occured\r
@param Context For EFI compatiblity. Not used.\r
\r
**/\r
if (EFI_ERROR (Status)) {\r
continue;\r
}\r
- \r
+\r
//\r
// Get the FirmwareVolumeBlock protocol on that handle\r
//\r
- Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb); \r
+ Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
\r
//\r
// Make sure the Fv Header is O.K.\r
if (FvDevice == NULL) {\r
return;\r
}\r
- \r
+\r
FvDevice->Fvb = Fvb;\r
FvDevice->Handle = Handle;\r
FvDevice->FwVolHeader = FwVolHeader;\r
FvDevice->Fv.ParentHandle = Fvb->ParentHandle;\r
- \r
+\r
//\r
// Install an New FV protocol on the existing handle\r
//\r
ASSERT_EFI_ERROR (Status);\r
}\r
}\r
- \r
+\r
return;\r
}\r
\r
libraries, and registers two notification functions. These notification\r
functions are responsible for building the FV stack dynamically.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
@retval EFI_SUCCESS Function successfully returned.\r
\r
Retrieves attributes, insures positive polarity of attribute bits, returns\r
resulting attributes in output parameter.\r
\r
- @param This Calling context \r
- @param Attributes output buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes output buffer which contains attributes\r
\r
@retval EFI_SUCCESS Successfully got volume attributes\r
\r
Status = Fvb->GetAttributes (Fvb, &FvbAttributes);\r
\r
//\r
- // Mask out Fvb bits that are not defined in FV \r
+ // Mask out Fvb bits that are not defined in FV\r
//\r
FvbAttributes &= 0xfffff0ff;\r
- \r
- *Attributes = (EFI_FV_ATTRIBUTES)FvbAttributes; \r
- \r
+\r
+ *Attributes = (EFI_FV_ATTRIBUTES)FvbAttributes;\r
+\r
return Status;\r
}\r
\r
/**\r
Sets current attributes for volume\r
\r
- @param This Calling context \r
- @param Attributes At input, contains attributes to be set. At output \r
- contains new value of FV \r
+ @param This Calling context\r
+ @param Attributes At input, contains attributes to be set. At output\r
+ contains new value of FV\r
\r
@retval EFI_UNSUPPORTED Could not be set.\r
\r
Return information of type InformationType for the requested firmware\r
volume.\r
\r
- @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
- @param InformationType InformationType for requested. \r
- @param BufferSize On input, size of Buffer.On output, the amount of data \r
- returned in Buffer. \r
- @param Buffer A poniter to the data buffer to return. \r
+ @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+ @param InformationType InformationType for requested.\r
+ @param BufferSize On input, size of Buffer.On output, the amount of data\r
+ returned in Buffer.\r
+ @param Buffer A poniter to the data buffer to return.\r
\r
@retval EFI_SUCCESS Successfully got volume Information.\r
\r
Set information of type InformationType for the requested firmware\r
volume.\r
\r
- @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
- @param InformationType InformationType for requested. \r
- @param BufferSize On input, size of Buffer.On output, the amount of data \r
- returned in Buffer. \r
- @param Buffer A poniter to the data buffer to return. \r
+ @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+ @param InformationType InformationType for requested.\r
+ @param BufferSize On input, size of Buffer.On output, the amount of data\r
+ returned in Buffer.\r
+ @param Buffer A poniter to the data buffer to return.\r
\r
@retval EFI_SUCCESS Successfully set volume Information.\r
\r
\r
--*/\r
\r
-UINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16}; \r
+UINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16};\r
\r
\r
\r
/**\r
Convert the FFS File Attributes to FV File Attributes\r
\r
- @param FfsAttributes The attributes of UINT8 type. \r
+ @param FfsAttributes The attributes of UINT8 type.\r
\r
@return The attributes of EFI_FV_FILE_ATTRIBUTES\r
\r
/**\r
Given the input key, search for the next matching file in the volume.\r
\r
- @param This Indicates the calling context. \r
- @param Key Key is a pointer to a caller allocated \r
- buffer that contains implementation specific \r
- data that is used to track where to begin \r
- the search for the next file. The size of \r
- the buffer must be at least This->KeySize \r
- bytes long. To reinitialize the search and \r
- begin from the beginning of the firmware \r
- volume, the entire buffer must be cleared to \r
- zero. Other than clearing the buffer to \r
- initiate a new search, the caller must not \r
- modify the data in the buffer between calls \r
- to GetNextFile(). \r
- @param FileType FileType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE. The GetNextFile() API can \r
- filter it's search for files based on the \r
- value of *FileType input. A *FileType input \r
- of 0 causes GetNextFile() to search for \r
- files of all types. If a file is found, the \r
- file's type is returned in *FileType. \r
- *FileType is not modified if no file is \r
- found. \r
- @param NameGuid NameGuid is a pointer to a caller allocated \r
- EFI_GUID. If a file is found, the file's \r
- name is returned in *NameGuid. *NameGuid is \r
- not modified if no file is found. \r
- @param Attributes Attributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. If a file \r
- is found, the file's attributes are returned \r
- in *Attributes. *Attributes is not modified \r
- if no file is found. \r
- @param Size Size is a pointer to a caller allocated \r
- UINTN. If a file is found, the file's size \r
- is returned in *Size. *Size is not modified \r
- if no file is found. \r
-\r
- @retval EFI_SUCCESS Successfully find the file. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Fv could not read. \r
- @retval EFI_NOT_FOUND No matching file found. \r
+ @param This Indicates the calling context.\r
+ @param Key Key is a pointer to a caller allocated\r
+ buffer that contains implementation specific\r
+ data that is used to track where to begin\r
+ the search for the next file. The size of\r
+ the buffer must be at least This->KeySize\r
+ bytes long. To reinitialize the search and\r
+ begin from the beginning of the firmware\r
+ volume, the entire buffer must be cleared to\r
+ zero. Other than clearing the buffer to\r
+ initiate a new search, the caller must not\r
+ modify the data in the buffer between calls\r
+ to GetNextFile().\r
+ @param FileType FileType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE. The GetNextFile() API can\r
+ filter it's search for files based on the\r
+ value of *FileType input. A *FileType input\r
+ of 0 causes GetNextFile() to search for\r
+ files of all types. If a file is found, the\r
+ file's type is returned in *FileType.\r
+ *FileType is not modified if no file is\r
+ found.\r
+ @param NameGuid NameGuid is a pointer to a caller allocated\r
+ EFI_GUID. If a file is found, the file's\r
+ name is returned in *NameGuid. *NameGuid is\r
+ not modified if no file is found.\r
+ @param Attributes Attributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. If a file\r
+ is found, the file's attributes are returned\r
+ in *Attributes. *Attributes is not modified\r
+ if no file is found.\r
+ @param Size Size is a pointer to a caller allocated\r
+ UINTN. If a file is found, the file's size\r
+ is returned in *Size. *Size is not modified\r
+ if no file is found.\r
+\r
+ @retval EFI_SUCCESS Successfully find the file.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Fv could not read.\r
+ @retval EFI_NOT_FOUND No matching file found.\r
@retval EFI_INVALID_PARAMETER Invalid parameter\r
\r
**/\r
break;\r
}\r
\r
- } \r
+ }\r
\r
//\r
// Return FileType, NameGuid, and Attributes\r
Locates a file in the firmware volume and\r
copies it to the supplied buffer.\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
- UINTN. On input *BufferSize indicates the \r
- size in bytes of the memory region pointed \r
- to by Buffer. On output, *BufferSize \r
- contains the number of bytes required to \r
- read the file. \r
- @param FoundType FoundType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE that on successful return \r
- from Read() contains the type of file read. \r
- This output reflects the file type \r
- irrespective of the value of the SectionType \r
- input. \r
- @param FileAttributes FileAttributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. On \r
- successful return from Read(), \r
- *FileAttributes contains the attributes of \r
- the file read. \r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINTN in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read to memory buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
+ UINTN. On input *BufferSize indicates the\r
+ size in bytes of the memory region pointed\r
+ to by Buffer. On output, *BufferSize\r
+ contains the number of bytes required to\r
+ read the file.\r
+ @param FoundType FoundType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE that on successful return\r
+ from Read() contains the type of file read.\r
+ This output reflects the file type\r
+ irrespective of the value of the SectionType\r
+ input.\r
+ @param FileAttributes FileAttributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. On\r
+ successful return from Read(),\r
+ *FileAttributes contains the attributes of\r
+ the file read.\r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINTN in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read to memory buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
@retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.\r
\r
**/\r
UINT8 *SrcPtr;\r
EFI_FFS_FILE_HEADER *FfsHeader;\r
UINTN InputBufferSize;\r
- \r
+\r
if (NameGuid == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
FvDevice = FV_DEVICE_FROM_THIS (This);\r
- \r
+\r
\r
//\r
// Keep looking until we find the matching NameGuid.\r
} else if (FileSize > InputBufferSize) {\r
//\r
// Callers buffer was not big enough\r
- // \r
+ //\r
Status = EFI_WARN_BUFFER_TOO_SMALL;\r
FileSize = InputBufferSize;\r
}\r
- \r
+\r
//\r
- // Copy data into callers buffer \r
+ // Copy data into callers buffer\r
//\r
CopyMem (*Buffer, SrcPtr, FileSize);\r
\r
Locates a section in a given FFS File and\r
copies it to the supplied buffer (not including section header).\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param SectionType Indicates the section type to return. \r
- @param SectionInstance Indicates which instance of sections with a \r
- type of SectionType to return. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param SectionType Indicates the section type to return.\r
+ @param SectionInstance Indicates which instance of sections with a\r
+ type of SectionType to return.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
UINTN.\r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINT32 in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read the file section into \r
- buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Section not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINT32 in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read the file section into\r
+ buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Section not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
@retval EFI_INVALID_PARAMETER Invalid parameter.\r
\r
**/\r
UINTN FileSize;\r
UINT8 *FileBuffer;\r
FFS_FILE_LIST_ENTRY *FfsEntry;\r
- \r
+\r
if (NameGuid == NULL || Buffer == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
&FileType,\r
&FileAttributes,\r
AuthenticationStatus\r
- ); \r
+ );\r
//\r
// Get the last key used by our call to FvReadFile as it is the FfsEntry for this file.\r
- // \r
+ //\r
FfsEntry = (FFS_FILE_LIST_ENTRY *) FvDevice->LastKey;\r
\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- \r
+\r
//\r
// Check to see that the file actually HAS sections before we go any further.\r
//\r
/**\r
Writes one or more files to the firmware volume.\r
\r
- @param This Indicates the calling context. \r
- @param NumberOfFiles Number of files. \r
- @param WritePolicy WritePolicy indicates the level of reliability \r
- for the write in the event of a power failure or \r
- other system failure during the write operation. \r
- @param FileData FileData is an pointer to an array of \r
+ @param This Indicates the calling context.\r
+ @param NumberOfFiles Number of files.\r
+ @param WritePolicy WritePolicy indicates the level of reliability\r
+ for the write in the event of a power failure or\r
+ other system failure during the write operation.\r
+ @param FileData FileData is an pointer to an array of\r
EFI_FV_WRITE_DATA. Each element of array\r
- FileData represents a file to be written. \r
-\r
- @retval EFI_SUCCESS Files successfully written to firmware volume \r
- @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_WRITE_PROTECTED Write protected. \r
- @retval EFI_NOT_FOUND Not found. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
+ FileData represents a file to be written.\r
+\r
+ @retval EFI_SUCCESS Files successfully written to firmware volume\r
+ @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_WRITE_PROTECTED Write protected.\r
+ @retval EFI_NOT_FOUND Not found.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
@retval EFI_UNSUPPORTED This function not supported.\r
\r
**/\r
IN EFI_FV_WRITE_POLICY WritePolicy,\r
IN EFI_FV_WRITE_FILE_DATA *FileData\r
)\r
-{ \r
+{\r
return EFI_UNSUPPORTED;\r
}\r
\r
/** @file\r
- Firmware Volume Block protocol functions. \r
+ Firmware Volume Block protocol functions.\r
Consumes FV hobs and creates appropriate block protocols.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
libraries, consumes FV hobs and NT_NON_MM_FV environment variable and\r
produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
- @retval EFI_SUCCESS Successfully initialized firmware volume block \r
+ @retval EFI_SUCCESS Successfully initialized firmware volume block\r
driver.\r
\r
**/\r
/**\r
Retrieves Volume attributes. No polarity translations are done.\r
\r
- @param This Calling context \r
- @param Attributes output buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes output buffer which contains attributes\r
\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
\r
/**\r
Modifies the current settings of the firmware volume according to the input parameter.\r
\r
- @param This Calling context \r
- @param Attributes input buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes input buffer which contains attributes\r
\r
- @retval EFI_SUCCESS The firmware volume attributes were returned. \r
- @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with \r
- the capabilities as declared in the firmware \r
- volume header. \r
+ @retval EFI_SUCCESS The firmware volume attributes were returned.\r
+ @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with\r
+ the capabilities as declared in the firmware\r
+ volume header.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
block of the firmware volume), the EraseBlock() function must return\r
EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
\r
- @param This Calling context \r
- @param ... Starting LBA followed by Number of Lba to erase. \r
- a -1 to terminate the list. \r
-\r
- @retval EFI_SUCCESS The erase request was successfully completed. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly \r
- and could not be written. The firmware device \r
- may have been partially erased. \r
- @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable \r
- argument list do \r
+ @param This Calling context\r
+ @param ... Starting LBA followed by Number of Lba to erase.\r
+ a -1 to terminate the list.\r
+\r
+ @retval EFI_SUCCESS The erase request was successfully completed.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is not functioning correctly\r
+ and could not be written. The firmware device\r
+ may have been partially erased.\r
+ @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable\r
+ argument list do\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
/**\r
Read the specified number of bytes from the block to the input buffer.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to read. \r
- @param Offset Offset into the block at which to begin reading. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually read. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the destine for the read. \r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary. \r
- @retval EFI_ACCESS_DENIED Access denied. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to read.\r
+ @param Offset Offset into the block at which to begin reading.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually read.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the destine for the read.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was read successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary.\r
+ @retval EFI_ACCESS_DENIED Access denied.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
be read.\r
\r
**/\r
IN OUT UINT8 *Buffer\r
);\r
\r
- \r
+\r
\r
/**\r
Writes the specified number of bytes from the input buffer to the block.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to write to. \r
- @param Offset Offset into the block at which to begin writing. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually written. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the source for the write. \r
-\r
- @retval EFI_SUCCESS The firmware volume was written successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary. \r
- On output, NumBytes contains the total number of \r
- bytes actually written. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
- be written. \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to write to.\r
+ @param Offset Offset into the block at which to begin writing.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually written.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the source for the write.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was written successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.\r
+ On output, NumBytes contains the total number of\r
+ bytes actually written.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
+ be written.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
IN UINT8 *Buffer\r
);\r
\r
- \r
+\r
\r
/**\r
Get Fvb's base address.\r
\r
- @param This Indicates the calling context. \r
- @param Address Fvb device base address. \r
+ @param This Indicates the calling context.\r
+ @param Address Fvb device base address.\r
\r
- @retval EFI_SUCCESS Successfully got Fvb's base address. \r
+ @retval EFI_SUCCESS Successfully got Fvb's base address.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
/**\r
Retrieves the size in bytes of a specific block within a firmware volume.\r
\r
- @param This Indicates the calling context. \r
- @param Lba Indicates the block for which to return the \r
- size. \r
- @param BlockSize Pointer to a caller-allocated UINTN in which the \r
- size of the block is returned. \r
- @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the \r
- number of consecutive blocks starting with Lba \r
- is returned. All blocks in this range have a \r
- size of BlockSize. \r
-\r
- @retval EFI_SUCCESS The firmware volume base address is returned. \r
+ @param This Indicates the calling context.\r
+ @param Lba Indicates the block for which to return the\r
+ size.\r
+ @param BlockSize Pointer to a caller-allocated UINTN in which the\r
+ size of the block is returned.\r
+ @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the\r
+ number of consecutive blocks starting with Lba\r
+ is returned. All blocks in this range have a\r
+ size of BlockSize.\r
+\r
+ @retval EFI_SUCCESS The firmware volume base address is returned.\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
**/\r
libraries, consumes FV hobs and NT_NON_MM_FV environment variable and\r
produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
- @retval EFI_SUCCESS Successfully initialized firmware volume block \r
+ @retval EFI_SUCCESS Successfully initialized firmware volume block\r
driver.\r
\r
**/\r
This routine produces a firmware volume block protocol on a given\r
buffer.\r
\r
- @param BaseAddress base address of the firmware volume image \r
- @param Length length of the firmware volume image \r
- @param ParentHandle handle of parent firmware volume, if this image \r
- came from an FV image file in another firmware \r
- volume (ala capsules) \r
- @param FvProtocol Firmware volume block protocol produced. \r
+ @param BaseAddress base address of the firmware volume image\r
+ @param Length length of the firmware volume image\r
+ @param ParentHandle handle of parent firmware volume, if this image\r
+ came from an FV image file in another firmware\r
+ volume (ala capsules)\r
+ @param FvProtocol Firmware volume block protocol produced.\r
\r
- @retval EFI_VOLUME_CORRUPTED Volume corrupted. \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated. \r
- @retval EFI_SUCCESS Successfully produced a FVB protocol on given \r
+ @retval EFI_VOLUME_CORRUPTED Volume corrupted.\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.\r
+ @retval EFI_SUCCESS Successfully produced a FVB protocol on given\r
buffer.\r
\r
**/\r
/** @file\r
- Implementations for Firmware Volume Block protocol. \r
- \r
- It consumes FV HOBs and creates read-lonly Firmare Volume Block protocol \r
+ Implementations for Firmware Volume Block protocol.\r
+\r
+ It consumes FV HOBs and creates read-lonly Firmare Volume Block protocol\r
instances for each of them.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
{\r
END_DEVICE_PATH_TYPE,\r
END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
- { \r
+ {\r
END_DEVICE_PATH_LENGTH,\r
0\r
- } \r
+ }\r
},\r
},\r
{\r
FwVolBlockReadBlock,\r
(EFI_FVB_WRITE)FwVolBlockWriteBlock,\r
(EFI_FVB_ERASE_BLOCKS)FwVolBlockEraseBlock,\r
- NULL \r
+ NULL\r
},\r
0,\r
NULL,\r
/**\r
Retrieves Volume attributes. No polarity translations are done.\r
\r
- @param This Calling context \r
- @param Attributes output buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes output buffer which contains attributes\r
\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
\r
)\r
{\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
//\r
/**\r
Modifies the current settings of the firmware volume according to the input parameter.\r
\r
- @param This Calling context \r
- @param Attributes input buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes input buffer which contains attributes\r
\r
- @retval EFI_SUCCESS The firmware volume attributes were returned. \r
- @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with \r
- the capabilities as declared in the firmware \r
- volume header. \r
+ @retval EFI_SUCCESS The firmware volume attributes were returned.\r
+ @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with\r
+ the capabilities as declared in the firmware\r
+ volume header.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
block of the firmware volume), the EraseBlock() function must return\r
EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
\r
- @param This Calling context \r
- @param ... Starting LBA followed by Number of Lba to erase. \r
- a -1 to terminate the list. \r
-\r
- @retval EFI_SUCCESS The erase request was successfully completed. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly \r
- and could not be written. The firmware device \r
- may have been partially erased. \r
- @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable \r
- argument list do \r
+ @param This Calling context\r
+ @param ... Starting LBA followed by Number of Lba to erase.\r
+ a -1 to terminate the list.\r
+\r
+ @retval EFI_SUCCESS The erase request was successfully completed.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is not functioning correctly\r
+ and could not be written. The firmware device\r
+ may have been partially erased.\r
+ @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable\r
+ argument list do\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
/**\r
Read the specified number of bytes from the block to the input buffer.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to read. \r
- @param Offset Offset into the block at which to begin reading. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually read. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the destine for the read. \r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary. \r
- @retval EFI_ACCESS_DENIED Access denied. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to read.\r
+ @param Offset Offset into the block at which to begin reading.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually read.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the destine for the read.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was read successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary.\r
+ @retval EFI_ACCESS_DENIED Access denied.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
be read.\r
\r
**/\r
UINTN LbaStart;\r
UINTN NumOfBytesRead;\r
UINTN LbaIndex;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
//\r
if ((FvbDevice->FvbAttributes & EFI_FVB2_READ_STATUS) == 0) {\r
return EFI_ACCESS_DENIED;\r
}\r
- \r
+\r
LbaIndex = (UINTN) Lba;\r
if (LbaIndex >= FvbDevice->NumBlocks) {\r
//\r
*NumBytes = 0;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
if (Offset > FvbDevice->LbaCache[LbaIndex].Length) {\r
//\r
// all exceed boundry, read nothing.\r
*NumBytes = 0;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
NumOfBytesRead = *NumBytes;\r
if (Offset + NumOfBytesRead > FvbDevice->LbaCache[LbaIndex].Length) {\r
//\r
//\r
NumOfBytesRead = FvbDevice->LbaCache[LbaIndex].Length - Offset;\r
}\r
- \r
+\r
LbaStart = FvbDevice->LbaCache[LbaIndex].Base;\r
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINTN) FvbDevice->BaseAddress);\r
LbaOffset = (UINT8 *) FwVolHeader + LbaStart + Offset;\r
// Perform read operation\r
//\r
CopyMem (Buffer, LbaOffset, NumOfBytesRead);\r
- \r
+\r
if (NumOfBytesRead == *NumBytes) {\r
return EFI_SUCCESS;\r
}\r
- \r
+\r
*NumBytes = NumOfBytesRead;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
\r
\r
/**\r
Writes the specified number of bytes from the input buffer to the block.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to write to. \r
- @param Offset Offset into the block at which to begin writing. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually written. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the source for the write. \r
-\r
- @retval EFI_SUCCESS The firmware volume was written successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary. \r
- On output, NumBytes contains the total number of \r
- bytes actually written. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
- be written. \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to write to.\r
+ @param Offset Offset into the block at which to begin writing.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually written.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the source for the write.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was written successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.\r
+ On output, NumBytes contains the total number of\r
+ bytes actually written.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
+ be written.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
{\r
return EFI_UNSUPPORTED;\r
}\r
- \r
+\r
\r
\r
/**\r
Get Fvb's base address.\r
\r
- @param This Indicates the calling context. \r
- @param Address Fvb device base address. \r
+ @param This Indicates the calling context.\r
+ @param Address Fvb device base address.\r
\r
- @retval EFI_SUCCESS Successfully got Fvb's base address. \r
+ @retval EFI_SUCCESS Successfully got Fvb's base address.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
)\r
{\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
- \r
+\r
if (FvbDevice->FvbAttributes & EFI_FVB2_MEMORY_MAPPED) {\r
*Address = FvbDevice->BaseAddress;\r
return EFI_SUCCESS;\r
}\r
- \r
+\r
return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
Retrieves the size in bytes of a specific block within a firmware volume.\r
\r
- @param This Indicates the calling context. \r
- @param Lba Indicates the block for which to return the \r
- size. \r
- @param BlockSize Pointer to a caller-allocated UINTN in which the \r
- size of the block is returned. \r
- @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the \r
- number of consecutive blocks starting with Lba \r
- is returned. All blocks in this range have a \r
- size of BlockSize. \r
-\r
- @retval EFI_SUCCESS The firmware volume base address is returned. \r
+ @param This Indicates the calling context.\r
+ @param Lba Indicates the block for which to return the\r
+ size.\r
+ @param BlockSize Pointer to a caller-allocated UINTN in which the\r
+ size of the block is returned.\r
+ @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the\r
+ number of consecutive blocks starting with Lba\r
+ is returned. All blocks in this range have a\r
+ size of BlockSize.\r
+\r
+ @retval EFI_SUCCESS The firmware volume base address is returned.\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
**/\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
- \r
+\r
//\r
// Do parameter checking\r
//\r
if (Lba >= FvbDevice->NumBlocks) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINTN)FvbDevice->BaseAddress);\r
- \r
+\r
PtrBlockMapEntry = FwVolHeader->BlockMap;\r
- \r
+\r
//\r
// Search the block map for the given block\r
//\r
//\r
break;\r
}\r
- \r
+\r
PtrBlockMapEntry++;\r
}\r
- \r
+\r
*BlockSize = PtrBlockMapEntry->Length;\r
*NumberOfBlocks = TotalBlocks - (UINTN)Lba;\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
\r
This routine produces a firmware volume block protocol on a given\r
buffer.\r
\r
- @param BaseAddress base address of the firmware volume image \r
- @param Length length of the firmware volume image \r
- @param ParentHandle handle of parent firmware volume, if this image \r
- came from an FV image file in another firmware \r
- volume (ala capsules) \r
- @param FvProtocol Firmware volume block protocol produced. \r
+ @param BaseAddress base address of the firmware volume image\r
+ @param Length length of the firmware volume image\r
+ @param ParentHandle handle of parent firmware volume, if this image\r
+ came from an FV image file in another firmware\r
+ volume (ala capsules)\r
+ @param FvProtocol Firmware volume block protocol produced.\r
\r
- @retval EFI_VOLUME_CORRUPTED Volume corrupted. \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated. \r
- @retval EFI_SUCCESS Successfully produced a FVB protocol on given \r
+ @retval EFI_VOLUME_CORRUPTED Volume corrupted.\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.\r
+ @retval EFI_SUCCESS Successfully produced a FVB protocol on given\r
buffer.\r
\r
**/\r
UINTN LinearOffset;\r
UINT32 FvAlignment;\r
EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r
- \r
+\r
FvAlignment = 0;\r
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(UINTN) BaseAddress;\r
//\r
return EFI_VOLUME_CORRUPTED;\r
}\r
//\r
- // Allocate EFI_FW_VOL_BLOCK_DEVICE \r
+ // Allocate EFI_FW_VOL_BLOCK_DEVICE\r
//\r
FvbDev = CoreAllocateCopyPool (sizeof (EFI_FW_VOL_BLOCK_DEVICE), &mFwVolBlock);\r
if (FvbDev == NULL) {\r
libraries, consumes FV hobs and NT_NON_MM_FV environment variable and\r
produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
- @retval EFI_SUCCESS Successfully initialized firmware volume block \r
+ @retval EFI_SUCCESS Successfully initialized firmware volume block\r
driver.\r
\r
**/\r
//\r
// Produce an FVB protocol for it\r
//\r
- ProduceFVBProtocolOnBuffer (FvHob.FirmwareVolume->BaseAddress, FvHob.FirmwareVolume->Length, NULL, NULL); \r
+ ProduceFVBProtocolOnBuffer (FvHob.FirmwareVolume->BaseAddress, FvHob.FirmwareVolume->Length, NULL, NULL);\r
FvHob.Raw = GET_NEXT_HOB (FvHob);\r
}\r
\r
particular, it can be called by BDS to process a single firmware\r
volume found in a capsule.\r
\r
- @param FvHeader pointer to a firmware volume header \r
- @param Size the size of the buffer pointed to by FvHeader \r
- @param FVProtocolHandle the handle on which a firmware volume protocol \r
- was produced for the firmware volume passed in. \r
+ @param FvHeader pointer to a firmware volume header\r
+ @param Size the size of the buffer pointed to by FvHeader\r
+ @param FVProtocolHandle the handle on which a firmware volume protocol\r
+ was produced for the firmware volume passed in.\r
\r
- @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of \r
- system resources \r
- @retval EFI_VOLUME_CORRUPTED if the volume was corrupted \r
- @retval EFI_SUCCESS a firmware volume protocol was produced for the \r
+ @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of\r
+ system resources\r
+ @retval EFI_VOLUME_CORRUPTED if the volume was corrupted\r
+ @retval EFI_SUCCESS a firmware volume protocol was produced for the\r
firmware volume\r
\r
**/\r
EFI_STATUS\r
CoreProcessFirmwareVolume (\r
IN VOID *FvHeader,\r
- IN UINTN Size, \r
+ IN UINTN Size,\r
OUT EFI_HANDLE *FVProtocolHandle\r
)\r
{\r
EFI_STATUS Status;\r
\r
*FVProtocolHandle = NULL;\r
- Status = ProduceFVBProtocolOnBuffer ( \r
- (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader, \r
- (UINT64)Size, \r
- NULL, \r
+ Status = ProduceFVBProtocolOnBuffer (\r
+ (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
+ (UINT64)Size,\r
+ NULL,\r
FVProtocolHandle\r
);\r
//\r
// Since in our implementation we use register-protocol-notify to put a\r
// FV protocol on the FVB protocol handle, we can't directly verify that\r
// the FV protocol was produced. Therefore here we will check the handle\r
- // and make sure an FV protocol is on it. This indicates that all went \r
- // well. Otherwise we have to assume that the volume was corrupted \r
+ // and make sure an FV protocol is on it. This indicates that all went\r
+ // well. Otherwise we have to assume that the volume was corrupted\r
// somehow.\r
//\r
if (!EFI_ERROR(Status)) {\r
Retrieves attributes, insures positive polarity of attribute bits, returns\r
resulting attributes in output parameter.\r
\r
- @param This Calling context \r
- @param Attributes output buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes output buffer which contains attributes\r
\r
@retval EFI_SUCCESS Successfully got volume attributes\r
\r
/**\r
Sets current attributes for volume\r
\r
- @param This Calling context \r
- @param Attributes At input, contains attributes to be set. At output \r
- contains new value of FV \r
+ @param This Calling context\r
+ @param Attributes At input, contains attributes to be set. At output\r
+ contains new value of FV\r
\r
@retval EFI_UNSUPPORTED Could not be set.\r
\r
/**\r
Given the input key, search for the next matching file in the volume.\r
\r
- @param This Indicates the calling context. \r
- @param Key Key is a pointer to a caller allocated \r
- buffer that contains implementation specific \r
- data that is used to track where to begin \r
- the search for the next file. The size of \r
- the buffer must be at least This->KeySize \r
- bytes long. To reinitialize the search and \r
- begin from the beginning of the firmware \r
- volume, the entire buffer must be cleared to \r
- zero. Other than clearing the buffer to \r
- initiate a new search, the caller must not \r
- modify the data in the buffer between calls \r
- to GetNextFile(). \r
- @param FileType FileType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE. The GetNextFile() API can \r
- filter it's search for files based on the \r
- value of *FileType input. A *FileType input \r
- of 0 causes GetNextFile() to search for \r
- files of all types. If a file is found, the \r
- file's type is returned in *FileType. \r
- *FileType is not modified if no file is \r
- found. \r
- @param NameGuid NameGuid is a pointer to a caller allocated \r
- EFI_GUID. If a file is found, the file's \r
- name is returned in *NameGuid. *NameGuid is \r
- not modified if no file is found. \r
- @param Attributes Attributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. If a file \r
- is found, the file's attributes are returned \r
- in *Attributes. *Attributes is not modified \r
- if no file is found. \r
- @param Size Size is a pointer to a caller allocated \r
- UINTN. If a file is found, the file's size \r
- is returned in *Size. *Size is not modified \r
- if no file is found. \r
-\r
- @retval EFI_SUCCESS Successfully find the file. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Fv could not read. \r
- @retval EFI_NOT_FOUND No matching file found. \r
+ @param This Indicates the calling context.\r
+ @param Key Key is a pointer to a caller allocated\r
+ buffer that contains implementation specific\r
+ data that is used to track where to begin\r
+ the search for the next file. The size of\r
+ the buffer must be at least This->KeySize\r
+ bytes long. To reinitialize the search and\r
+ begin from the beginning of the firmware\r
+ volume, the entire buffer must be cleared to\r
+ zero. Other than clearing the buffer to\r
+ initiate a new search, the caller must not\r
+ modify the data in the buffer between calls\r
+ to GetNextFile().\r
+ @param FileType FileType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE. The GetNextFile() API can\r
+ filter it's search for files based on the\r
+ value of *FileType input. A *FileType input\r
+ of 0 causes GetNextFile() to search for\r
+ files of all types. If a file is found, the\r
+ file's type is returned in *FileType.\r
+ *FileType is not modified if no file is\r
+ found.\r
+ @param NameGuid NameGuid is a pointer to a caller allocated\r
+ EFI_GUID. If a file is found, the file's\r
+ name is returned in *NameGuid. *NameGuid is\r
+ not modified if no file is found.\r
+ @param Attributes Attributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. If a file\r
+ is found, the file's attributes are returned\r
+ in *Attributes. *Attributes is not modified\r
+ if no file is found.\r
+ @param Size Size is a pointer to a caller allocated\r
+ UINTN. If a file is found, the file's size\r
+ is returned in *Size. *Size is not modified\r
+ if no file is found.\r
+\r
+ @retval EFI_SUCCESS Successfully find the file.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Fv could not read.\r
+ @retval EFI_NOT_FOUND No matching file found.\r
@retval EFI_INVALID_PARAMETER Invalid parameter\r
\r
**/\r
Locates a file in the firmware volume and\r
copies it to the supplied buffer.\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
- UINTN. On input *BufferSize indicates the \r
- size in bytes of the memory region pointed \r
- to by Buffer. On output, *BufferSize \r
- contains the number of bytes required to \r
- read the file. \r
- @param FoundType FoundType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE that on successful return \r
- from Read() contains the type of file read. \r
- This output reflects the file type \r
- irrespective of the value of the SectionType \r
- input. \r
- @param FileAttributes FileAttributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. On \r
- successful return from Read(), \r
- *FileAttributes contains the attributes of \r
- the file read. \r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINTN in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read to memory buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
+ UINTN. On input *BufferSize indicates the\r
+ size in bytes of the memory region pointed\r
+ to by Buffer. On output, *BufferSize\r
+ contains the number of bytes required to\r
+ read the file.\r
+ @param FoundType FoundType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE that on successful return\r
+ from Read() contains the type of file read.\r
+ This output reflects the file type\r
+ irrespective of the value of the SectionType\r
+ input.\r
+ @param FileAttributes FileAttributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. On\r
+ successful return from Read(),\r
+ *FileAttributes contains the attributes of\r
+ the file read.\r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINTN in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read to memory buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
@retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.\r
\r
**/\r
Locates a section in a given FFS File and\r
copies it to the supplied buffer (not including section header).\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param SectionType Indicates the section type to return. \r
- @param SectionInstance Indicates which instance of sections with a \r
- type of SectionType to return. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param SectionType Indicates the section type to return.\r
+ @param SectionInstance Indicates which instance of sections with a\r
+ type of SectionType to return.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
UINTN.\r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINT32 in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read the file section into \r
- buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Section not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINT32 in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read the file section into\r
+ buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Section not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
@retval EFI_INVALID_PARAMETER Invalid parameter.\r
\r
**/\r
/**\r
Writes one or more files to the firmware volume.\r
\r
- @param This Indicates the calling context. \r
- @param NumberOfFiles Number of files. \r
- @param WritePolicy WritePolicy indicates the level of reliability \r
- for the write in the event of a power failure or \r
- other system failure during the write operation. \r
- @param FileData FileData is an pointer to an array of \r
+ @param This Indicates the calling context.\r
+ @param NumberOfFiles Number of files.\r
+ @param WritePolicy WritePolicy indicates the level of reliability\r
+ for the write in the event of a power failure or\r
+ other system failure during the write operation.\r
+ @param FileData FileData is an pointer to an array of\r
EFI_FV_WRITE_DATA. Each element of array\r
- FileData represents a file to be written. \r
-\r
- @retval EFI_SUCCESS Files successfully written to firmware volume \r
- @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_WRITE_PROTECTED Write protected. \r
- @retval EFI_NOT_FOUND Not found. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
+ FileData represents a file to be written.\r
+\r
+ @retval EFI_SUCCESS Files successfully written to firmware volume\r
+ @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_WRITE_PROTECTED Write protected.\r
+ @retval EFI_NOT_FOUND Not found.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
@retval EFI_UNSUPPORTED This function not supported.\r
\r
**/\r
Return information of type InformationType for the requested firmware\r
volume.\r
\r
- @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
- @param InformationType InformationType for requested. \r
- @param BufferSize On input, size of Buffer.On output, the amount of data \r
- returned in Buffer. \r
- @param Buffer A poniter to the data buffer to return. \r
+ @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+ @param InformationType InformationType for requested.\r
+ @param BufferSize On input, size of Buffer.On output, the amount of data\r
+ returned in Buffer.\r
+ @param Buffer A poniter to the data buffer to return.\r
\r
@retval EFI_SUCCESS Successfully got volume Information.\r
\r
Set information of type InformationType for the requested firmware\r
volume.\r
\r
- @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
- @param InformationType InformationType for requested. \r
- @param BufferSize On input, size of Buffer.On output, the amount of data \r
- returned in Buffer. \r
- @param Buffer A poniter to the data buffer to return. \r
+ @param This Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
+ @param InformationType InformationType for requested.\r
+ @param BufferSize On input, size of Buffer.On output, the amount of data\r
+ returned in Buffer.\r
+ @param Buffer A poniter to the data buffer to return.\r
\r
@retval EFI_SUCCESS Successfully set volume Information.\r
\r
IN UINTN BufferSize,\r
IN CONST VOID *Buffer\r
);\r
- \r
+\r
//\r
//Internal functions\r
//\r
/**\r
Check if a block of buffer is erased.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param InBuffer The buffer to be checked \r
- @param BufferSize Size of the buffer in bytes \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param InBuffer The buffer to be checked\r
+ @param BufferSize Size of the buffer in bytes\r
\r
- @retval TRUE The block of buffer is erased \r
+ @retval TRUE The block of buffer is erased\r
@retval FALSE The block of buffer is not erased\r
\r
**/\r
/**\r
Get the FFS file state by checking the highest bit set in the header's state field.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file header \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file header\r
\r
@return FFS File state\r
\r
/**\r
Set the FFS file state.\r
\r
- @param State The state to be set. \r
- @param FfsHeader Points to the FFS file header \r
+ @param State The state to be set.\r
+ @param FfsHeader Points to the FFS file header\r
\r
@return None.\r
\r
/**\r
Verify checksum of the firmware volume header.\r
\r
- @param FvHeader Points to the firmware volume header to be checked \r
+ @param FvHeader Points to the firmware volume header to be checked\r
\r
- @retval TRUE Checksum verification passed \r
+ @retval TRUE Checksum verification passed\r
@retval FALSE Checksum verification failed\r
\r
**/\r
VerifyFvHeaderChecksum (\r
IN EFI_FIRMWARE_VOLUME_HEADER *FvHeader\r
);\r
- \r
+\r
\r
/**\r
Check if it's a valid FFS file header.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file header to be checked \r
- @param FileState FFS file state to be returned \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file header to be checked\r
+ @param FileState FFS file state to be returned\r
\r
- @retval TRUE Valid FFS file header \r
+ @retval TRUE Valid FFS file header\r
@retval FALSE Invalid FFS file header\r
\r
**/\r
Check if it's a valid FFS file.\r
Here we are sure that it has a valid FFS file header since we must call IsValidFfsHeader() first.\r
\r
- @param ErasePolarity Erase polarity attribute of the firmware volume \r
- @param FfsHeader Points to the FFS file to be checked \r
+ @param ErasePolarity Erase polarity attribute of the firmware volume\r
+ @param FfsHeader Points to the FFS file to be checked\r
\r
- @retval TRUE Valid FFS file \r
+ @retval TRUE Valid FFS file\r
@retval FALSE Invalid FFS file\r
\r
**/\r
given the supplied FW_VOL_BLOCK_PROTOCOL, allocate a buffer for output and\r
copy the volume header into it.\r
\r
- @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to \r
- read the volume header \r
- @param FwVolHeader Pointer to pointer to allocated buffer in which \r
- the volume header is returned. \r
+ @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to\r
+ read the volume header\r
+ @param FwVolHeader Pointer to pointer to allocated buffer in which\r
+ the volume header is returned.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated. \r
- @retval EFI_SUCCESS Successfully read volume header to the allocated \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS Successfully read volume header to the allocated\r
buffer.\r
\r
**/\r
\r
\r
/**\r
- Check if a FV is consistent and allocate cache\r
+ Check if an FV is consistent and allocate cache for it.\r
\r
- @param FvDevice pointer to the FvDevice to be checked. \r
+ @param FvDevice A pointer to the FvDevice to be checked.\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated. \r
- @retval EFI_SUCCESS FV is consistent and cache is allocated. \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS FV is consistent and cache is allocated.\r
@retval EFI_VOLUME_CORRUPTED File system is corrupted.\r
\r
**/\r
/** @file\r
- GCD Operations and data structure used to \r
+ GCD Operations and data structure used to\r
convert from GCD attributes to EFI Memory Map attributes.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
/** @file\r
The file contains the GCD related services in the EFI Boot Services Table.\r
- The GCD services are used to manage the memory and I/O regions that \r
+ The GCD services are used to manage the memory and I/O regions that\r
are accessible to the CPU that is executing the DXE core.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED | \\r
EFI_RESOURCE_ATTRIBUTE_16_BIT_IO | \\r
EFI_RESOURCE_ATTRIBUTE_32_BIT_IO | \\r
- EFI_RESOURCE_ATTRIBUTE_64_BIT_IO ) \r
+ EFI_RESOURCE_ATTRIBUTE_64_BIT_IO )\r
\r
#define TESTED_MEMORY_ATTRIBUTES (EFI_RESOURCE_ATTRIBUTE_PRESENT | \\r
EFI_RESOURCE_ATTRIBUTE_INITIALIZED | \\r
\r
EFI_GCD_MAP_ENTRY mGcdMemorySpaceMapEntryTemplate = {\r
EFI_GCD_MAP_SIGNATURE,\r
- { \r
+ {\r
NULL,\r
NULL\r
},\r
\r
GCD_ATTRIBUTE_CONVERSION_ENTRY mAttributeConversionTable[] = {\r
{ EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE, EFI_MEMORY_UC, TRUE },\r
- { EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED, EFI_MEMORY_UCE, TRUE }, \r
+ { EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED, EFI_MEMORY_UCE, TRUE },\r
{ EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE, EFI_MEMORY_WC, TRUE },\r
{ EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE, EFI_MEMORY_WT, TRUE },\r
{ EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE, EFI_MEMORY_WB, TRUE },\r
/**\r
Aligns a value to the specified boundary.\r
\r
- @param Value 64 bit value to align \r
- @param Alignment Log base 2 of the boundary to align Value to \r
- @param RoundUp TRUE if Value is to be rounded up to the nearest \r
- aligned boundary. FALSE is Value is to be \r
- rounded down to the nearest aligned boundary. \r
+ @param Value 64 bit value to align\r
+ @param Alignment Log base 2 of the boundary to align Value to\r
+ @param RoundUp TRUE if Value is to be rounded up to the nearest\r
+ aligned boundary. FALSE is Value is to be\r
+ rounded down to the nearest aligned boundary.\r
\r
@return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.\r
\r
/**\r
Aligns address to the page boundary.\r
\r
- @param Value 64 bit address to align \r
+ @param Value 64 bit address to align\r
\r
@return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.\r
\r
/**\r
Aligns length to the page boundary.\r
\r
- @param Value 64 bit length to align \r
+ @param Value 64 bit length to align\r
\r
@return A 64 bit value is the aligned to the value nearest Value with an alignment by Alignment.\r
\r
/**\r
Allocate pool for two entries.\r
\r
- @param TopEntry An entry of GCD map \r
- @param BottomEntry An entry of GCD map \r
+ @param TopEntry An entry of GCD map\r
+ @param BottomEntry An entry of GCD map\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated. \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.\r
@retval EFI_SUCCESS Both entries successfully allocated.\r
\r
**/\r
/**\r
Internal function. Inserts a new descriptor into a sorted list\r
\r
- @param Link The linked list to insert the range BaseAddress \r
- and Length into \r
- @param Entry A pointer to the entry that is inserted \r
- @param BaseAddress The base address of the new range \r
- @param Length The length of the new range in bytes \r
- @param TopEntry Top pad entry to insert if needed. \r
- @param BottomEntry Bottom pad entry to insert if needed. \r
+ @param Link The linked list to insert the range BaseAddress\r
+ and Length into\r
+ @param Entry A pointer to the entry that is inserted\r
+ @param BaseAddress The base address of the new range\r
+ @param Length The length of the new range in bytes\r
+ @param TopEntry Top pad entry to insert if needed.\r
+ @param BottomEntry Bottom pad entry to insert if needed.\r
\r
@retval EFI_SUCCESS The new range was inserted into the linked list\r
\r
Entry->BaseAddress = BaseAddress;\r
BottomEntry->EndAddress = BaseAddress - 1;\r
InsertTailList (Link, &BottomEntry->Link);\r
- } \r
+ }\r
\r
if ((BaseAddress + Length - 1) < Entry->EndAddress) {\r
CopyMem (TopEntry, Entry, sizeof (EFI_GCD_MAP_ENTRY));\r
/**\r
Merge the Gcd region specified by Link and its adjacent entry.\r
\r
- @param Link Specify the entry to be merged (with its \r
- adjacent entry). \r
- @param Forward Direction (forward or backward). \r
- @param Map Boundary. \r
+ @param Link Specify the entry to be merged (with its\r
+ adjacent entry).\r
+ @param Forward Direction (forward or backward).\r
+ @param Map Boundary.\r
\r
- @retval EFI_SUCCESS Successfully returned. \r
+ @retval EFI_SUCCESS Successfully returned.\r
@retval EFI_UNSUPPORTED These adjacent regions could not merge.\r
\r
**/\r
/**\r
Merge adjacent entries on total chain.\r
\r
- @param TopEntry Top entry of GCD map. \r
- @param BottomEntry Bottom entry of GCD map. \r
- @param StartLink Start link of the list for this loop. \r
- @param EndLink End link of the list for this loop. \r
- @param Map Boundary. \r
+ @param TopEntry Top entry of GCD map.\r
+ @param BottomEntry Bottom entry of GCD map.\r
+ @param StartLink Start link of the list for this loop.\r
+ @param EndLink End link of the list for this loop.\r
+ @param Map Boundary.\r
\r
@retval EFI_SUCCESS GCD map successfully cleaned up.\r
\r
/**\r
Search a segment of memory space in GCD map. The result is a range of GCD entry list.\r
\r
- @param BaseAddress The start address of the segment. \r
- @param Length The length of the segment. \r
- @param StartLink The first GCD entry involves this segment of \r
- memory space. \r
- @param EndLink The first GCD entry involves this segment of \r
- memory space. \r
- @param Map Points to the start entry to search. \r
+ @param BaseAddress The start address of the segment.\r
+ @param Length The length of the segment.\r
+ @param StartLink The first GCD entry involves this segment of\r
+ memory space.\r
+ @param EndLink The first GCD entry involves this segment of\r
+ memory space.\r
+ @param Map Points to the start entry to search.\r
\r
- @retval EFI_SUCCESS Successfully found the entry. \r
+ @retval EFI_SUCCESS Successfully found the entry.\r
@retval EFI_NOT_FOUND Not found.\r
\r
**/\r
*StartLink = Link;\r
}\r
if (*StartLink != NULL) {\r
- if ((BaseAddress + Length - 1) >= Entry->BaseAddress && \r
+ if ((BaseAddress + Length - 1) >= Entry->BaseAddress &&\r
(BaseAddress + Length - 1) <= Entry->EndAddress ) {\r
*EndLink = Link;\r
return EFI_SUCCESS;\r
/**\r
Count the amount of GCD map entries.\r
\r
- @param Map Points to the start entry to do the count loop. \r
+ @param Map Points to the start entry to do the count loop.\r
\r
@return The count.\r
\r
Count++;\r
Link = Link->ForwardLink;\r
}\r
- \r
+\r
return Count;\r
}\r
\r
/**\r
Return the memory attribute specified by Attributes\r
\r
- @param Attributes A num with some attribute bits on. \r
+ @param Attributes A num with some attribute bits on.\r
\r
@return The enum value of memory attribute.\r
\r
/**\r
Do operation on a segment of memory space specified (add, free, remove, change attribute ...).\r
\r
- @param Operation The type of the operation \r
- @param GcdMemoryType Additional information for the operation \r
- @param GcdIoType Additional information for the operation \r
- @param BaseAddress Start address of the segment \r
- @param Length length of the segment \r
- @param Capabilities The alterable attributes of a newly added entry \r
- @param Attributes The attributes needs to be set \r
-\r
- @retval EFI_INVALID_PARAMETER Length is 0 or address (length) not aligned when \r
- setting attribute. \r
- @retval EFI_SUCCESS Action successfully done. \r
- @retval EFI_UNSUPPORTED Could not find the proper descriptor on this \r
- segment or set an upsupported attribute. \r
- @retval EFI_ACCESS_DENIED Operate on an space non-exist or is used for an \r
- image. \r
- @retval EFI_NOT_FOUND Free a non-using space or remove a non-exist \r
- space, and so on. \r
+ @param Operation The type of the operation\r
+ @param GcdMemoryType Additional information for the operation\r
+ @param GcdIoType Additional information for the operation\r
+ @param BaseAddress Start address of the segment\r
+ @param Length length of the segment\r
+ @param Capabilities The alterable attributes of a newly added entry\r
+ @param Attributes The attributes needs to be set\r
+\r
+ @retval EFI_INVALID_PARAMETER Length is 0 or address (length) not aligned when\r
+ setting attribute.\r
+ @retval EFI_SUCCESS Action successfully done.\r
+ @retval EFI_UNSUPPORTED Could not find the proper descriptor on this\r
+ segment or set an upsupported attribute.\r
+ @retval EFI_ACCESS_DENIED Operate on an space non-exist or is used for an\r
+ image.\r
+ @retval EFI_NOT_FOUND Free a non-using space or remove a non-exist\r
+ space, and so on.\r
@retval EFI_OUT_OF_RESOURCES No buffer could be allocated.\r
\r
**/\r
EFI_GCD_MAP_ENTRY *BottomEntry;\r
LIST_ENTRY *StartLink;\r
LIST_ENTRY *EndLink;\r
- \r
+\r
EFI_CPU_ARCH_PROTOCOL *CpuArch;\r
UINT64 CpuArchAttributes;\r
\r
/**\r
Check whether an entry could be used to allocate space.\r
\r
- @param Operation Allocate memory or IO \r
- @param Entry The entry to be tested \r
- @param GcdMemoryType The desired memory type \r
- @param GcdIoType The desired IO type \r
+ @param Operation Allocate memory or IO\r
+ @param Entry The entry to be tested\r
+ @param GcdMemoryType The desired memory type\r
+ @param GcdIoType The desired IO type\r
\r
- @retval EFI_NOT_FOUND The memory type does not match or there's an \r
- image handle on the entry. \r
- @retval EFI_UNSUPPORTED The operation unsupported. \r
- @retval EFI_SUCCESS It's ok for this entry to be used to allocate \r
+ @retval EFI_NOT_FOUND The memory type does not match or there's an\r
+ image handle on the entry.\r
+ @retval EFI_UNSUPPORTED The operation unsupported.\r
+ @retval EFI_SUCCESS It's ok for this entry to be used to allocate\r
space.\r
\r
**/\r
/**\r
Allocate space on specified address and length.\r
\r
- @param Operation The type of operation (memory or IO) \r
- @param GcdAllocateType The type of allocate operation \r
- @param GcdMemoryType The desired memory type \r
- @param GcdIoType The desired IO type \r
- @param Alignment Align with 2^Alignment \r
- @param Length Length to allocate \r
- @param BaseAddress Base address to allocate \r
- @param ImageHandle The image handle consume the allocated space. \r
- @param DeviceHandle The device handle consume the allocated space. \r
-\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
- @retval EFI_NOT_FOUND No descriptor for the desired space exists. \r
+ @param Operation The type of operation (memory or IO)\r
+ @param GcdAllocateType The type of allocate operation\r
+ @param GcdMemoryType The desired memory type\r
+ @param GcdIoType The desired IO type\r
+ @param Alignment Align with 2^Alignment\r
+ @param Length Length to allocate\r
+ @param BaseAddress Base address to allocate\r
+ @param ImageHandle The image handle consume the allocated space.\r
+ @param DeviceHandle The device handle consume the allocated space.\r
+\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_NOT_FOUND No descriptor for the desired space exists.\r
@retval EFI_SUCCESS Space successfully allocated.\r
\r
**/\r
/**\r
Add a segment of memory to GCD map.\r
\r
- @param GcdMemoryType Memory type of the segment. \r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
- @param Capabilities alterable attributes of the segment. \r
+ @param GcdMemoryType Memory type of the segment.\r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
+ @param Capabilities alterable attributes of the segment.\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameters. \r
+ @retval EFI_INVALID_PARAMETER Invalid parameters.\r
@retval EFI_SUCCESS Successfully add a segment of memory space.\r
\r
**/\r
Allocates nonexistent memory, reserved memory, system memory, or memorymapped\r
I/O resources from the global coherency domain of the processor.\r
\r
- @param GcdAllocateType The type of allocate operation \r
- @param GcdMemoryType The desired memory type \r
- @param Alignment Align with 2^Alignment \r
- @param Length Length to allocate \r
- @param BaseAddress Base address to allocate \r
- @param ImageHandle The image handle consume the allocated space. \r
- @param DeviceHandle The device handle consume the allocated space. \r
+ @param GcdAllocateType The type of allocate operation\r
+ @param GcdMemoryType The desired memory type\r
+ @param Alignment Align with 2^Alignment\r
+ @param Length Length to allocate\r
+ @param BaseAddress Base address to allocate\r
+ @param ImageHandle The image handle consume the allocated space.\r
+ @param DeviceHandle The device handle consume the allocated space.\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
- @retval EFI_NOT_FOUND No descriptor contains the desired space. \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.\r
@retval EFI_SUCCESS Memory space successfully allocated.\r
\r
**/\r
)\r
{\r
return CoreAllocateSpace (\r
- GCD_ALLOCATE_MEMORY_OPERATION, \r
- GcdAllocateType, \r
- GcdMemoryType, \r
- (EFI_GCD_IO_TYPE) 0, \r
- Alignment, \r
- Length, \r
- BaseAddress, \r
- ImageHandle, \r
+ GCD_ALLOCATE_MEMORY_OPERATION,\r
+ GcdAllocateType,\r
+ GcdMemoryType,\r
+ (EFI_GCD_IO_TYPE) 0,\r
+ Alignment,\r
+ Length,\r
+ BaseAddress,\r
+ ImageHandle,\r
DeviceHandle\r
);\r
}\r
Adds reserved memory, system memory, or memory-mapped I/O resources to the\r
global coherency domain of the processor.\r
\r
- @param GcdMemoryType Memory type of the memory space. \r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
- @param Capabilities alterable attributes of the memory space. \r
+ @param GcdMemoryType Memory type of the memory space.\r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
+ @param Capabilities alterable attributes of the memory space.\r
\r
@retval EFI_SUCCESS Merged this memory space into GCD map.\r
\r
Status = CoreAllocateMemorySpace (\r
EfiGcdAllocateAddress,\r
GcdMemoryType,\r
- EFI_PAGE_SHIFT, \r
+ EFI_PAGE_SHIFT,\r
PageLength,\r
&PageBaseAddress,\r
gDxeCoreImageHandle,\r
Status = CoreAllocateMemorySpace (\r
EfiGcdAllocateAddress,\r
GcdMemoryType,\r
- EFI_PAGE_SHIFT, \r
+ EFI_PAGE_SHIFT,\r
EFI_PAGE_SIZE,\r
&PageBaseAddress,\r
gDxeCoreImageHandle,\r
Frees nonexistent memory, reserved memory, system memory, or memory-mapped\r
I/O resources from the global coherency domain of the processor.\r
\r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
\r
@retval EFI_SUCCESS Space successfully freed.\r
\r
Removes reserved memory, system memory, or memory-mapped I/O resources from\r
the global coherency domain of the processor.\r
\r
- @param BaseAddress Base address of the memory space. \r
- @param Length Length of the memory space. \r
+ @param BaseAddress Base address of the memory space.\r
+ @param Length Length of the memory space.\r
\r
@retval EFI_SUCCESS Successfully remove a segment of memory space.\r
\r
/**\r
Build a memory descriptor according to an entry.\r
\r
- @param Descriptor The descriptor to be built \r
+ @param Descriptor The descriptor to be built\r
@param Entry According to this entry\r
\r
**/\r
/**\r
Retrieves the descriptor for a memory region containing a specified address.\r
\r
- @param BaseAddress Specified start address \r
- @param Descriptor Specified length \r
+ @param BaseAddress Specified start address\r
+ @param Descriptor Specified length\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
@retval EFI_SUCCESS Successfully get memory space descriptor.\r
\r
**/\r
CoreAcquireGcdMemoryLock ();\r
\r
//\r
- // Search for the list of descriptors that contain BaseAddress \r
+ // Search for the list of descriptors that contain BaseAddress\r
//\r
Status = CoreSearchGcdMapEntry (BaseAddress, 1, &StartLink, &EndLink, &mGcdMemorySpaceMap);\r
if (EFI_ERROR (Status)) {\r
Modifies the attributes for a memory region in the global coherency domain of the\r
processor.\r
\r
- @param BaseAddress Specified start address \r
- @param Length Specified length \r
- @param Attributes Specified attributes \r
+ @param BaseAddress Specified start address\r
+ @param Length Specified length\r
+ @param Attributes Specified attributes\r
\r
- @retval EFI_SUCCESS Successfully set attribute of a segment of \r
+ @retval EFI_SUCCESS Successfully set attribute of a segment of\r
memory space.\r
\r
**/\r
Returns a map of the memory resources in the global coherency domain of the\r
processor.\r
\r
- @param NumberOfDescriptors Number of descriptors. \r
- @param MemorySpaceMap Descriptor array \r
+ @param NumberOfDescriptors Number of descriptors.\r
+ @param MemorySpaceMap Descriptor array\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Successfully get memory space map.\r
\r
**/\r
/**\r
Adds reserved I/O or I/O resources to the global coherency domain of the processor.\r
\r
- @param GcdIoType IO type of the segment. \r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param GcdIoType IO type of the segment.\r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
- @retval EFI_SUCCESS Merged this segment into GCD map. \r
+ @retval EFI_SUCCESS Merged this segment into GCD map.\r
@retval EFI_INVALID_PARAMETER Parameter not valid\r
\r
**/\r
Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
domain of the processor.\r
\r
- @param GcdAllocateType The type of allocate operation \r
- @param GcdIoType The desired IO type \r
- @param Alignment Align with 2^Alignment \r
- @param Length Length to allocate \r
- @param BaseAddress Base address to allocate \r
- @param ImageHandle The image handle consume the allocated space. \r
- @param DeviceHandle The device handle consume the allocated space. \r
+ @param GcdAllocateType The type of allocate operation\r
+ @param GcdIoType The desired IO type\r
+ @param Alignment Align with 2^Alignment\r
+ @param Length Length to allocate\r
+ @param BaseAddress Base address to allocate\r
+ @param ImageHandle The image handle consume the allocated space.\r
+ @param DeviceHandle The device handle consume the allocated space.\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
- @retval EFI_NOT_FOUND No descriptor contains the desired space. \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.\r
@retval EFI_SUCCESS IO space successfully allocated.\r
\r
**/\r
)\r
{\r
return CoreAllocateSpace (\r
- GCD_ALLOCATE_IO_OPERATION, \r
- GcdAllocateType, \r
- (EFI_GCD_MEMORY_TYPE) 0, \r
- GcdIoType, \r
- Alignment, \r
- Length, \r
- BaseAddress, \r
- ImageHandle, \r
+ GCD_ALLOCATE_IO_OPERATION,\r
+ GcdAllocateType,\r
+ (EFI_GCD_MEMORY_TYPE) 0,\r
+ GcdIoType,\r
+ Alignment,\r
+ Length,\r
+ BaseAddress,\r
+ ImageHandle,\r
DeviceHandle\r
);\r
}\r
Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
domain of the processor.\r
\r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
@retval EFI_SUCCESS Space successfully freed.\r
\r
Removes reserved I/O or I/O resources from the global coherency domain of the\r
processor.\r
\r
- @param BaseAddress Base address of the segment. \r
- @param Length Length of the segment. \r
+ @param BaseAddress Base address of the segment.\r
+ @param Length Length of the segment.\r
\r
@retval EFI_SUCCESS Successfully removed a segment of IO space.\r
\r
/**\r
Build a IO descriptor according to an entry.\r
\r
- @param Descriptor The descriptor to be built \r
+ @param Descriptor The descriptor to be built\r
@param Entry According to this entry\r
\r
**/\r
/**\r
Retrieves the descriptor for an I/O region containing a specified address.\r
\r
- @param BaseAddress Specified start address \r
- @param Descriptor Specified length \r
+ @param BaseAddress Specified start address\r
+ @param Descriptor Specified length\r
\r
- @retval EFI_INVALID_PARAMETER Descriptor is NULL. \r
+ @retval EFI_INVALID_PARAMETER Descriptor is NULL.\r
@retval EFI_SUCCESS Successfully get the IO space descriptor.\r
\r
**/\r
CoreAcquireGcdIoLock ();\r
\r
//\r
- // Search for the list of descriptors that contain BaseAddress \r
+ // Search for the list of descriptors that contain BaseAddress\r
//\r
Status = CoreSearchGcdMapEntry (BaseAddress, 1, &StartLink, &EndLink, &mGcdIoSpaceMap);\r
if (EFI_ERROR (Status)) {\r
/**\r
Returns a map of the I/O resources in the global coherency domain of the processor.\r
\r
- @param NumberOfDescriptors Number of descriptors. \r
- @param IoSpaceMap Descriptor array \r
+ @param NumberOfDescriptors Number of descriptors.\r
+ @param IoSpaceMap Descriptor array\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Successfully get IO space map.\r
\r
**/\r
Done:\r
CoreReleaseGcdIoLock ();\r
return Status;\r
-} \r
+}\r
\r
\r
/**\r
Converts a Resource Descriptor HOB attributes mask to an EFI Memory Descriptor\r
capabilities mask\r
\r
- @param GcdMemoryType Type of resource in the GCD memory map. \r
- @param Attributes The attribute mask in the Resource Descriptor \r
- HOB. \r
+ @param GcdMemoryType Type of resource in the GCD memory map.\r
+ @param Attributes The attribute mask in the Resource Descriptor\r
+ HOB.\r
\r
@return The capabilities mask for an EFI Memory Descriptor.\r
\r
{\r
UINT64 Capabilities;\r
GCD_ATTRIBUTE_CONVERSION_ENTRY *Conversion;\r
- \r
+\r
//\r
// Convert the Resource HOB Attributes to an EFI Memory Capabilities mask\r
//\r
}\r
}\r
}\r
- \r
+\r
return Capabilities;\r
}\r
\r
memory descriptor is provided to the memory services. Then the memory services\r
can be used to intialize the GCD map.\r
\r
- @param HobStart The start address of the HOB. \r
- @param MemoryBaseAddress Start address of memory region found to init DXE \r
- core. \r
- @param MemoryLength Length of memory region found to init DXE core. \r
+ @param HobStart The start address of the HOB.\r
+ @param MemoryBaseAddress Start address of memory region found to init DXE\r
+ core.\r
+ @param MemoryLength Length of memory region found to init DXE core.\r
\r
@retval EFI_SUCCESS Memory services successfully initialized.\r
\r
if (ResourceHob->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY &&\r
(ResourceHob->ResourceAttribute & MEMORY_ATTRIBUTE_MASK) == TESTED_MEMORY_ATTRIBUTES ) {\r
\r
- if (PhitHob->EfiFreeMemoryBottom >= ResourceHob->PhysicalStart && \r
+ if (PhitHob->EfiFreeMemoryBottom >= ResourceHob->PhysicalStart &&\r
PhitHob->EfiFreeMemoryTop <= (ResourceHob->PhysicalStart + ResourceHob->ResourceLength) ) {\r
\r
//\r
can be used to intialize the GCD map. The HobStart will be relocated to a pool\r
buffer.\r
\r
- @param HobStart The start address of the HOB \r
- @param MemoryBaseAddress Start address of memory region found to init DXE \r
- core. \r
- @param MemoryLength Length of memory region found to init DXE core. \r
+ @param HobStart The start address of the HOB\r
+ @param MemoryBaseAddress Start address of memory region found to init DXE\r
+ core.\r
+ @param MemoryLength Length of memory region found to init DXE core.\r
\r
@retval EFI_SUCCESS GCD services successfully initialized.\r
\r
ASSERT (CpuHob != NULL);\r
SizeOfMemorySpace = CpuHob->SizeOfMemorySpace;\r
SizeOfIoSpace = CpuHob->SizeOfIoSpace;\r
- \r
+\r
//\r
// Initialize the GCD Memory Space Map\r
//\r
InsertHeadList (&mGcdIoSpaceMap, &Entry->Link);\r
\r
//\r
- // Walk the HOB list and add all resource descriptors to the GCD \r
+ // Walk the HOB list and add all resource descriptors to the GCD\r
//\r
for (Hob.Raw = *HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {\r
\r
if (!EFI_ERROR (Status)) {\r
Status = CoreAllocateMemorySpace (\r
EfiGcdAllocateAddress,\r
- Descriptor.GcdMemoryType, \r
+ Descriptor.GcdMemoryType,\r
0,\r
MemoryHob->AllocDescriptor.MemoryLength,\r
&BaseAddress,\r
BaseAddress = FirmwareVolumeHob->BaseAddress;\r
Status = CoreAllocateMemorySpace (\r
EfiGcdAllocateAddress,\r
- EfiGcdMemoryTypeMemoryMappedIo, \r
+ EfiGcdMemoryTypeMemoryMappedIo,\r
0,\r
FirmwareVolumeHob->Length,\r
&BaseAddress,\r
// Relocate HOB List to an allocated pool buffer.\r
//\r
NewHobList = CoreAllocateCopyPool (\r
- (UINTN)PhitHob->EfiFreeMemoryBottom - (UINTN)(*HobStart), \r
+ (UINTN)PhitHob->EfiFreeMemoryBottom - (UINTN)(*HobStart),\r
*HobStart\r
);\r
ASSERT (NewHobList != NULL);\r
UINTN Signature;\r
LIST_ENTRY AllHandles; // All handles list of IHANDLE\r
LIST_ENTRY Protocols; // List of PROTOCOL_INTERFACE's for this handle\r
- UINTN LocateRequest; // \r
+ UINTN LocateRequest; //\r
UINT64 Key; // The Handle Database Key value when this handle was last created or modified\r
} IHANDLE;\r
\r
\r
\r
//\r
-// PROTOCOL_ENTRY - each different protocol has 1 entry in the protocol \r
+// PROTOCOL_ENTRY - each different protocol has 1 entry in the protocol\r
// database. Each handler that supports this protocol is listed, along\r
// with a list of registered notifies.\r
//\r
LIST_ENTRY ByProtocol; // Link on PROTOCOL_ENTRY.Protocols\r
PROTOCOL_ENTRY *Protocol; // The protocol ID\r
VOID *Interface; // The interface value\r
- \r
+\r
LIST_ENTRY OpenList; // OPEN_PROTOCOL_DATA list.\r
- UINTN OpenListCount; \r
- \r
+ UINTN OpenListCount;\r
+\r
EFI_HANDLE ControllerHandle;\r
\r
} PROTOCOL_INTERFACE;\r
Finds the protocol entry for the requested protocol.\r
The gProtocolDatabaseLock must be owned\r
\r
- @param Protocol The ID of the protocol \r
- @param Create Create a new entry if not found \r
+ @param Protocol The ID of the protocol\r
+ @param Create Create a new entry if not found\r
\r
@return Protocol entry\r
\r
Note: This function doesn't do parameters checking, it's caller's responsibility\r
to pass in valid parameters.\r
\r
- @param Handle The handle to search the protocol on \r
- @param Protocol GUID of the protocol \r
- @param Interface The interface for the protocol being searched \r
+ @param Handle The handle to search the protocol on\r
+ @param Protocol GUID of the protocol\r
+ @param Interface The interface for the protocol being searched\r
\r
@return Protocol instance (NULL: Not found)\r
\r
/**\r
Removes Protocol from the protocol list (but not the handle list).\r
\r
- @param Handle The handle to remove protocol on. \r
- @param Protocol GUID of the protocol to be moved \r
- @param Interface The interface of the protocol \r
+ @param Handle The handle to remove protocol on.\r
+ @param Protocol GUID of the protocol to be moved\r
+ @param Interface The interface of the protocol\r
\r
@return Protocol Entry\r
\r
/**\r
Removes all the events in the protocol database that match Event.\r
\r
- @param Event The event to search for in the protocol \r
- database. \r
+ @param Event The event to search for in the protocol\r
+ database.\r
\r
@return EFI_SUCCESS when done searching the entire database.\r
\r
/**\r
Connects a controller to a driver.\r
\r
- @param ControllerHandle Handle of the controller to be \r
- connected. \r
- @param ContextDriverImageHandles DriverImageHandle A pointer to an \r
- ordered list of driver image \r
- handles. \r
- @param RemainingDevicePath RemainingDevicePath A pointer to \r
- the device path that specifies a \r
- child of the controller \r
- specified by ControllerHandle. \r
-\r
- @retval EFI_SUCCESS One or more drivers were \r
- connected to ControllerHandle. \r
- @retval EFI_OUT_OF_RESOURCES No enough system resources to \r
- complete the request. \r
- @retval EFI_NOT_FOUND No drivers were connected to \r
+ @param ControllerHandle Handle of the controller to be\r
+ connected.\r
+ @param ContextDriverImageHandles DriverImageHandle A pointer to an\r
+ ordered list of driver image\r
+ handles.\r
+ @param RemainingDevicePath RemainingDevicePath A pointer to\r
+ the device path that specifies a\r
+ child of the controller\r
+ specified by ControllerHandle.\r
+\r
+ @retval EFI_SUCCESS One or more drivers were\r
+ connected to ControllerHandle.\r
+ @retval EFI_OUT_OF_RESOURCES No enough system resources to\r
+ complete the request.\r
+ @retval EFI_NOT_FOUND No drivers were connected to\r
ControllerHandle.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
CoreConnectSingleController (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE *ContextDriverImageHandles OPTIONAL,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL \r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
);\r
\r
/**\r
Note: This function doesn't do parameters checking, it's caller's responsibility\r
to pass in valid parameters.\r
\r
- @param UserHandle The handle on which the protocol is installed \r
- @param Prot The protocol to disconnect drivers from \r
+ @param UserHandle The handle on which the protocol is installed\r
+ @param Prot The protocol to disconnect drivers from\r
\r
- @retval EFI_SUCCESS Drivers using the protocol interface are all \r
- disconnected \r
+ @retval EFI_SUCCESS Drivers using the protocol interface are all\r
+ disconnected\r
@retval EFI_ACCESS_DENIED Failed to disconnect one or all of the drivers\r
\r
**/\r
/**\r
Check whether a handle is a valid EFI_HANDLE\r
\r
- @param UserHandle The handle to check \r
+ @param UserHandle The handle to check\r
\r
- @retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE. \r
+ @retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE.\r
@retval EFI_SUCCESS The handle is valid EFI_HANDLE.\r
\r
**/\r
/**\r
Connects one or more drivers to a controller.\r
\r
- @param ControllerHandle Handle of the controller to be \r
- connected. \r
- @param DriverImageHandle DriverImageHandle A pointer to an \r
- ordered list of driver image \r
- handles. \r
- @param RemainingDevicePath RemainingDevicePath A pointer to \r
- the device path that specifies a \r
- child of the controller specified \r
- by ControllerHandle. \r
- @param Recursive Whether the function would be \r
- called recursively or not. \r
+ @param ControllerHandle Handle of the controller to be\r
+ connected.\r
+ @param DriverImageHandle DriverImageHandle A pointer to an\r
+ ordered list of driver image\r
+ handles.\r
+ @param RemainingDevicePath RemainingDevicePath A pointer to\r
+ the device path that specifies a\r
+ child of the controller specified\r
+ by ControllerHandle.\r
+ @param Recursive Whether the function would be\r
+ called recursively or not.\r
\r
@return Status code.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreConnectController (\r
IN EFI_HANDLE ControllerHandle,\r
EFI_HANDLE *ChildHandleBuffer;\r
UINTN ChildHandleCount;\r
UINTN Index;\r
- \r
+\r
//\r
// Make sure ControllerHandle is valid\r
//\r
//\r
for (Link = Handle->Protocols.ForwardLink, ChildHandleCount = 0; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
//\r
for (Link = Handle->Protocols.ForwardLink, ChildHandleCount = 0; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
NULL,\r
NULL,\r
TRUE\r
- ); \r
+ );\r
}\r
\r
//\r
Add Driver Binding Protocols from Context Driver Image Handles to sorted\r
Driver Binding Protocol list.\r
\r
- @param DriverBindingHandle Handle of the driver binding \r
- protocol. \r
- @param NumberOfSortedDriverBindingProtocols Number Of sorted driver binding \r
- protocols \r
- @param SortedDriverBindingProtocols The sorted protocol list. \r
- @param DriverBindingHandleCount Driver Binding Handle Count. \r
- @param DriverBindingHandleBuffer The buffer of driver binding \r
- protocol to be modified. \r
- @param IsImageHandle Indicate whether \r
- DriverBindingHandle is an image \r
- handle \r
+ @param DriverBindingHandle Handle of the driver binding\r
+ protocol.\r
+ @param NumberOfSortedDriverBindingProtocols Number Of sorted driver binding\r
+ protocols\r
+ @param SortedDriverBindingProtocols The sorted protocol list.\r
+ @param DriverBindingHandleCount Driver Binding Handle Count.\r
+ @param DriverBindingHandleBuffer The buffer of driver binding\r
+ protocol to be modified.\r
+ @param IsImageHandle Indicate whether\r
+ DriverBindingHandle is an image\r
+ handle\r
\r
@return None.\r
\r
VOID\r
AddSortedDriverBindingProtocol (\r
IN EFI_HANDLE DriverBindingHandle,\r
- IN OUT UINTN *NumberOfSortedDriverBindingProtocols, \r
+ IN OUT UINTN *NumberOfSortedDriverBindingProtocols,\r
IN OUT EFI_DRIVER_BINDING_PROTOCOL **SortedDriverBindingProtocols,\r
IN UINTN DriverBindingHandleCount,\r
IN OUT EFI_HANDLE *DriverBindingHandleBuffer,\r
if (DriverBinding->ImageHandle == DriverBindingHandle) {\r
AddSortedDriverBindingProtocol (\r
DriverBindingHandleBuffer[Index],\r
- NumberOfSortedDriverBindingProtocols, \r
+ NumberOfSortedDriverBindingProtocols,\r
SortedDriverBindingProtocols,\r
DriverBindingHandleCount,\r
DriverBindingHandleBuffer,\r
}\r
}\r
}\r
- \r
+\r
\r
/**\r
Connects a controller to a driver.\r
\r
- @param ControllerHandle Handle of the controller to be \r
- connected. \r
- @param ContextDriverImageHandles DriverImageHandle A pointer to an \r
- ordered list of driver image \r
- handles. \r
- @param RemainingDevicePath RemainingDevicePath A pointer to \r
- the device path that specifies a \r
- child of the controller \r
- specified by ControllerHandle. \r
-\r
- @retval EFI_SUCCESS One or more drivers were \r
- connected to ControllerHandle. \r
- @retval EFI_OUT_OF_RESOURCES No enough system resources to \r
- complete the request. \r
- @retval EFI_NOT_FOUND No drivers were connected to \r
+ @param ControllerHandle Handle of the controller to be\r
+ connected.\r
+ @param ContextDriverImageHandles DriverImageHandle A pointer to an\r
+ ordered list of driver image\r
+ handles.\r
+ @param RemainingDevicePath RemainingDevicePath A pointer to\r
+ the device path that specifies a\r
+ child of the controller\r
+ specified by ControllerHandle.\r
+\r
+ @retval EFI_SUCCESS One or more drivers were\r
+ connected to ControllerHandle.\r
+ @retval EFI_OUT_OF_RESOURCES No enough system resources to\r
+ complete the request.\r
+ @retval EFI_NOT_FOUND No drivers were connected to\r
ControllerHandle.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
CoreConnectSingleController (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE *ContextDriverImageHandles OPTIONAL,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL \r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
)\r
{\r
EFI_STATUS Status;\r
// Get list of all Driver Binding Protocol Instances\r
//\r
Status = CoreLocateHandleBuffer (\r
- ByProtocol, \r
- &gEfiDriverBindingProtocolGuid, \r
+ ByProtocol,\r
+ &gEfiDriverBindingProtocolGuid,\r
NULL,\r
- &DriverBindingHandleCount, \r
+ &DriverBindingHandleCount,\r
&DriverBindingHandleBuffer\r
);\r
if (EFI_ERROR (Status) || (DriverBindingHandleCount == 0)) {\r
for (Index = 0; ContextDriverImageHandles[Index] != NULL; Index++) {\r
AddSortedDriverBindingProtocol (\r
ContextDriverImageHandles[Index],\r
- &NumberOfSortedDriverBindingProtocols, \r
+ &NumberOfSortedDriverBindingProtocols,\r
SortedDriverBindingProtocols,\r
DriverBindingHandleCount,\r
DriverBindingHandleBuffer,\r
// Add the Platform Driver Override Protocol drivers for ControllerHandle next\r
//\r
Status = CoreLocateProtocol (\r
- &gEfiPlatformDriverOverrideProtocolGuid, \r
- NULL, \r
+ &gEfiPlatformDriverOverrideProtocolGuid,\r
+ NULL,\r
(VOID **) &PlatformDriverOverride\r
);\r
if (!EFI_ERROR (Status) && (PlatformDriverOverride != NULL)) {\r
if (!EFI_ERROR (Status)) {\r
AddSortedDriverBindingProtocol (\r
DriverImageHandle,\r
- &NumberOfSortedDriverBindingProtocols, \r
+ &NumberOfSortedDriverBindingProtocols,\r
SortedDriverBindingProtocols,\r
DriverBindingHandleCount,\r
DriverBindingHandleBuffer,\r
// Get the Bus Specific Driver Override Protocol instance on the Controller Handle\r
//\r
Status = CoreHandleProtocol (\r
- ControllerHandle, \r
- &gEfiBusSpecificDriverOverrideProtocolGuid, \r
+ ControllerHandle,\r
+ &gEfiBusSpecificDriverOverrideProtocolGuid,\r
(VOID **) &BusSpecificDriverOverride\r
);\r
if (!EFI_ERROR (Status) && (BusSpecificDriverOverride != NULL)) {\r
if (!EFI_ERROR (Status)) {\r
AddSortedDriverBindingProtocol (\r
DriverImageHandle,\r
- &NumberOfSortedDriverBindingProtocols, \r
+ &NumberOfSortedDriverBindingProtocols,\r
SortedDriverBindingProtocols,\r
DriverBindingHandleCount,\r
DriverBindingHandleBuffer,\r
for (Index = 0; Index < DriverBindingHandleCount; Index++) {\r
AddSortedDriverBindingProtocol (\r
DriverBindingHandleBuffer[Index],\r
- &NumberOfSortedDriverBindingProtocols, \r
+ &NumberOfSortedDriverBindingProtocols,\r
SortedDriverBindingProtocols,\r
DriverBindingHandleCount,\r
DriverBindingHandleBuffer,\r
// EFI_NOT_READY, so it will be restarted\r
//\r
Status = CoreLocateHandleBuffer (\r
- ByProtocol, \r
- &gEfiDriverBindingProtocolGuid, \r
+ ByProtocol,\r
+ &gEfiDriverBindingProtocolGuid,\r
NULL,\r
- &NewDriverBindingHandleCount, \r
+ &NewDriverBindingHandleCount,\r
&NewDriverBindingHandleBuffer\r
);\r
CoreFreePool (NewDriverBindingHandleBuffer);\r
\r
//\r
// Loop through the sorted Driver Binding Protocol Instances in order, and see if\r
- // any of the Driver Binding Protocols support the controller specified by \r
+ // any of the Driver Binding Protocols support the controller specified by\r
// ControllerHandle.\r
//\r
DriverBinding = NULL;\r
if (SortedDriverBindingProtocols[Index] != NULL) {\r
DriverBinding = SortedDriverBindingProtocols[Index];\r
Status = DriverBinding->Supported(\r
- DriverBinding, \r
+ DriverBinding,\r
ControllerHandle,\r
RemainingDevicePath\r
);\r
//\r
PERF_START (DriverBinding->DriverBindingHandle, DRIVERBINDING_START_TOK, NULL, 0);\r
Status = DriverBinding->Start (\r
- DriverBinding, \r
+ DriverBinding,\r
ControllerHandle,\r
RemainingDevicePath\r
);\r
//\r
if (OneStarted) {\r
return EFI_SUCCESS;\r
- } \r
+ }\r
\r
//\r
// If no drivers started and RemainingDevicePath is an End Device Path Node, then return EFI_SUCCESS\r
if (IsDevicePathEnd (RemainingDevicePath)) {\r
return EFI_SUCCESS;\r
}\r
- } \r
+ }\r
\r
//\r
// Otherwise, no drivers were started on ControllerHandle, so return EFI_NOT_FOUND\r
/**\r
Disonnects a controller from a driver\r
\r
- @param ControllerHandle ControllerHandle The handle of \r
- the controller from which \r
- driver(s) are to be \r
- disconnected. \r
- @param DriverImageHandle DriverImageHandle The driver to \r
- disconnect from ControllerHandle. \r
- @param ChildHandle ChildHandle The handle of the \r
- child to destroy. \r
-\r
- @retval EFI_SUCCESS One or more drivers were \r
- disconnected from the controller. \r
- @retval EFI_SUCCESS On entry, no drivers are managing \r
- ControllerHandle. \r
- @retval EFI_SUCCESS DriverImageHandle is not NULL, \r
- and on entry DriverImageHandle is \r
- not managing ControllerHandle. \r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
- EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL, \r
- and it is not a valid EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it \r
- is not a valid EFI_HANDLE. \r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources \r
- available to disconnect any \r
- drivers from ControllerHandle. \r
- @retval EFI_DEVICE_ERROR The controller could not be \r
- disconnected because of a device \r
+ @param ControllerHandle ControllerHandle The handle of\r
+ the controller from which\r
+ driver(s) are to be\r
+ disconnected.\r
+ @param DriverImageHandle DriverImageHandle The driver to\r
+ disconnect from ControllerHandle.\r
+ @param ChildHandle ChildHandle The handle of the\r
+ child to destroy.\r
+\r
+ @retval EFI_SUCCESS One or more drivers were\r
+ disconnected from the controller.\r
+ @retval EFI_SUCCESS On entry, no drivers are managing\r
+ ControllerHandle.\r
+ @retval EFI_SUCCESS DriverImageHandle is not NULL,\r
+ and on entry DriverImageHandle is\r
+ not managing ControllerHandle.\r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
+ EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER DriverImageHandle is not NULL,\r
+ and it is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it\r
+ is not a valid EFI_HANDLE.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources\r
+ available to disconnect any\r
+ drivers from ControllerHandle.\r
+ @retval EFI_DEVICE_ERROR The controller could not be\r
+ disconnected because of a device\r
error.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreDisconnectController (\r
IN EFI_HANDLE ControllerHandle,\r
// Get list of drivers that are currently managing ControllerHandle\r
//\r
DriverImageHandleBuffer = NULL;\r
- DriverImageHandleCount = 1; \r
- \r
+ DriverImageHandleCount = 1;\r
+\r
if (DriverImageHandle == NULL) {\r
//\r
// Look at each protocol interface for a match\r
CoreAcquireProtocolLock ();\r
for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
}\r
}\r
CoreReleaseProtocolLock ();\r
- \r
+\r
//\r
// If there are no drivers managing this controller, then return EFI_SUCCESS\r
//\r
CoreAcquireProtocolLock ();\r
for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
// Get the Driver Binding Protocol of the driver that is managing this controller\r
//\r
Status = CoreHandleProtocol (\r
- DriverImageHandle, \r
- &gEfiDriverBindingProtocolGuid, \r
+ DriverImageHandle,\r
+ &gEfiDriverBindingProtocolGuid,\r
(VOID **)&DriverBinding\r
);\r
if (EFI_ERROR (Status)) {\r
CoreAcquireProtocolLock ();\r
for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if (OpenData->AgentHandle == DriverImageHandle) {\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
ChildBufferCount++;\r
- } \r
+ }\r
if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
DriverImageHandleValid = TRUE;\r
}\r
CoreAcquireProtocolLock ();\r
for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
- for (ProtLink = Prot->OpenList.ForwardLink; \r
- ProtLink != &Prot->OpenList; \r
+ for (ProtLink = Prot->OpenList.ForwardLink;\r
+ ProtLink != &Prot->OpenList;\r
ProtLink = ProtLink->ForwardLink) {\r
OpenData = CR (ProtLink, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
if ((OpenData->AgentHandle == DriverImageHandle) &&\r
} else {\r
Status = EFI_NOT_FOUND;\r
}\r
- \r
-Done: \r
+\r
+Done:\r
\r
if (DriverImageHandleBuffer != NULL) {\r
CoreFreePool (DriverImageHandleBuffer);\r
/**\r
Check whether a handle is a valid EFI_HANDLE\r
\r
- @param UserHandle The handle to check \r
+ @param UserHandle The handle to check\r
\r
- @retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE. \r
+ @retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE.\r
@retval EFI_SUCCESS The handle is valid EFI_HANDLE.\r
\r
**/\r
Finds the protocol entry for the requested protocol.\r
The gProtocolDatabaseLock must be owned\r
\r
- @param Protocol The ID of the protocol \r
- @param Create Create a new entry if not found \r
+ @param Protocol The ID of the protocol\r
+ @param Create Create a new entry if not found\r
\r
@return Protocol entry\r
\r
//\r
\r
ProtEntry = NULL;\r
- for (Link = mProtocolDatabase.ForwardLink; \r
- Link != &mProtocolDatabase; \r
+ for (Link = mProtocolDatabase.ForwardLink;\r
+ Link != &mProtocolDatabase;\r
Link = Link->ForwardLink) {\r
\r
Item = CR(Link, PROTOCOL_ENTRY, AllEntries, PROTOCOL_ENTRY_SIGNATURE);\r
}\r
\r
//\r
- // If the protocol entry was not found and Create is TRUE, then \r
+ // If the protocol entry was not found and Create is TRUE, then\r
// allocate a new entry\r
- // \r
+ //\r
if ((ProtEntry == NULL) && Create) {\r
ProtEntry = CoreAllocateBootServicesPool (sizeof(PROTOCOL_ENTRY));\r
- \r
+\r
if (ProtEntry != NULL) {\r
//\r
// Initialize new protocol entry structure\r
Note: This function doesn't do parameters checking, it's caller's responsibility\r
to pass in valid parameters.\r
\r
- @param Handle The handle to search the protocol on \r
- @param Protocol GUID of the protocol \r
- @param Interface The interface for the protocol being searched \r
+ @param Handle The handle to search the protocol on\r
+ @param Protocol GUID of the protocol\r
+ @param Interface The interface for the protocol being searched\r
\r
@return Protocol instance (NULL: Not found)\r
\r
/**\r
Removes an event from a register protocol notify list on a protocol.\r
\r
- @param Event The event to search for in the protocol \r
- database. \r
+ @param Event The event to search for in the protocol\r
+ database.\r
\r
@return EFI_SUCCESS if the event was found and removed.\r
@return EFI_NOT_FOUND if the event was not found in the protocl database.\r
\r
CoreAcquireProtocolLock ();\r
\r
- for ( Link = mProtocolDatabase.ForwardLink; \r
- Link != &mProtocolDatabase; \r
+ for ( Link = mProtocolDatabase.ForwardLink;\r
+ Link != &mProtocolDatabase;\r
Link = Link->ForwardLink) {\r
\r
ProtEntry = CR(Link, PROTOCOL_ENTRY, AllEntries, PROTOCOL_ENTRY_SIGNATURE);\r
\r
- for ( NotifyLink = ProtEntry->Notify.ForwardLink; \r
- NotifyLink != &ProtEntry->Notify; \r
+ for ( NotifyLink = ProtEntry->Notify.ForwardLink;\r
+ NotifyLink != &ProtEntry->Notify;\r
NotifyLink = NotifyLink->ForwardLink) {\r
\r
ProtNotify = CR(NotifyLink, PROTOCOL_NOTIFY, Link, PROTOCOL_NOTIFY_SIGNATURE);\r
/**\r
Removes all the events in the protocol database that match Event.\r
\r
- @param Event The event to search for in the protocol \r
- database. \r
+ @param Event The event to search for in the protocol\r
+ database.\r
\r
@return EFI_SUCCESS when done searching the entire database.\r
\r
Wrapper function to CoreInstallProtocolInterfaceNotify. This is the public API which\r
Calls the private one which contains a BOOLEAN parameter for notifications\r
\r
- @param UserHandle The handle to install the protocol handler on, \r
- or NULL if a new handle is to be allocated \r
- @param Protocol The protocol to add to the handle \r
- @param InterfaceType Indicates whether Interface is supplied in \r
- native form. \r
- @param Interface The interface for the protocol being added \r
+ @param UserHandle The handle to install the protocol handler on,\r
+ or NULL if a new handle is to be allocated\r
+ @param Protocol The protocol to add to the handle\r
+ @param InterfaceType Indicates whether Interface is supplied in\r
+ native form.\r
+ @param Interface The interface for the protocol being added\r
\r
@return Status code\r
\r
)\r
{\r
return CoreInstallProtocolInterfaceNotify (\r
- UserHandle, \r
- Protocol, \r
- InterfaceType, \r
- Interface, \r
+ UserHandle,\r
+ Protocol,\r
+ InterfaceType,\r
+ Interface,\r
TRUE\r
);\r
}\r
/**\r
Installs a protocol interface into the boot services environment.\r
\r
- @param UserHandle The handle to install the protocol handler on, \r
- or NULL if a new handle is to be allocated \r
- @param Protocol The protocol to add to the handle \r
- @param InterfaceType Indicates whether Interface is supplied in \r
- native form. \r
- @param Interface The interface for the protocol being added \r
- @param Notify indicates whether notify the notification list \r
- for this protocol \r
-\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate \r
+ @param UserHandle The handle to install the protocol handler on,\r
+ or NULL if a new handle is to be allocated\r
+ @param Protocol The protocol to add to the handle\r
+ @param InterfaceType Indicates whether Interface is supplied in\r
+ native form.\r
+ @param Interface The interface for the protocol being added\r
+ @param Notify indicates whether notify the notification list\r
+ for this protocol\r
+\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
@retval EFI_SUCCESS Protocol interface successfully installed\r
\r
**/\r
}\r
\r
//\r
- // Lock the protocol database \r
+ // Lock the protocol database\r
//\r
CoreAcquireProtocolLock ();\r
\r
// in the system\r
//\r
InsertTailList (&gHandleList, &Handle->AllHandles);\r
- } \r
+ }\r
\r
Status = CoreValidateHandle (Handle);\r
if (EFI_ERROR (Status)) {\r
Prot->OpenListCount = 0;\r
\r
//\r
- // Add this protocol interface to the head of the supported \r
+ // Add this protocol interface to the head of the supported\r
// protocol list for this handle\r
//\r
InsertHeadList (&Handle->Protocols, &Prot->Link);\r
\r
//\r
- // Add this protocol interface to the tail of the \r
+ // Add this protocol interface to the tail of the\r
// protocol entry\r
- // \r
+ //\r
InsertTailList (&ProtEntry->Protocols, &Prot->ByProtocol);\r
\r
//\r
- // Notify the notification list for this protocol \r
+ // Notify the notification list for this protocol\r
//\r
if (Notify) {\r
CoreNotifyProtocolEntry (ProtEntry);\r
occures all the protocols added by this function are removed. This is\r
basically a lib function to save space.\r
\r
- @param Handle The handle to install the protocol handlers on, \r
- or NULL if a new handle is to be allocated \r
- @param ... EFI_GUID followed by protocol instance. A NULL \r
- terminates the list. The pairs are the \r
- arguments to InstallProtocolInterface(). All the \r
- protocols are added to Handle. \r
+ @param Handle The handle to install the protocol handlers on,\r
+ or NULL if a new handle is to be allocated\r
+ @param ... EFI_GUID followed by protocol instance. A NULL\r
+ terminates the list. The pairs are the\r
+ arguments to InstallProtocolInterface(). All the\r
+ protocols are added to Handle.\r
\r
- @retval EFI_INVALID_PARAMETER Handle is NULL. \r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
@retval EFI_SUCCESS Protocol interfaces successfully installed.\r
\r
**/\r
EFI_HANDLE OldHandle;\r
EFI_HANDLE DeviceHandle;\r
EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
- \r
+\r
if (Handle == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
+ //\r
+ // Syncronize with notifcations.\r
//\r
- // Syncronize with notifcations. \r
- // \r
OldTpl = CoreRaiseTpl (TPL_NOTIFY);\r
OldHandle = *Handle;\r
\r
continue;\r
}\r
}\r
- \r
+\r
//\r
// Install it\r
//\r
Status = CoreInstallProtocolInterface (Handle, Protocol, EFI_NATIVE_INTERFACE, Interface);\r
}\r
- \r
+\r
//\r
// If there was an error, remove all the interfaces that were installed without any errors\r
//\r
Protocol = VA_ARG (Args, EFI_GUID *);\r
Interface = VA_ARG (Args, VOID *);\r
CoreUninstallProtocolInterface (*Handle, Protocol, Interface);\r
- } \r
+ }\r
*Handle = OldHandle;\r
}\r
\r
Note: This function doesn't do parameters checking, it's caller's responsibility\r
to pass in valid parameters.\r
\r
- @param UserHandle The handle on which the protocol is installed \r
- @param Prot The protocol to disconnect drivers from \r
+ @param UserHandle The handle on which the protocol is installed\r
+ @param Prot The protocol to disconnect drivers from\r
\r
- @retval EFI_SUCCESS Drivers using the protocol interface are all \r
- disconnected \r
+ @retval EFI_SUCCESS Drivers using the protocol interface are all\r
+ disconnected\r
@retval EFI_ACCESS_DENIED Failed to disconnect one or all of the drivers\r
\r
**/\r
OPEN_PROTOCOL_DATA *OpenData;\r
\r
Status = EFI_SUCCESS;\r
- \r
+\r
//\r
// Attempt to disconnect all drivers from this protocol interface\r
//\r
(Link != &Prot->OpenList) && !ItemFound;\r
Link = Link->ForwardLink ) {\r
OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
- if (OpenData->Attributes & \r
+ if (OpenData->Attributes &\r
(EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL | EFI_OPEN_PROTOCOL_GET_PROTOCOL | EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {\r
ItemFound = TRUE;\r
- RemoveEntryList (&OpenData->Link); \r
+ RemoveEntryList (&OpenData->Link);\r
Prot->OpenListCount--;\r
CoreFreePool (OpenData);\r
}\r
If the last protocol interface is remove from the handle, the\r
handle is freed.\r
\r
- @param UserHandle The handle to remove the protocol handler from \r
- @param Protocol The protocol, of protocol:interface, to remove \r
- @param Interface The interface, of protocol:interface, to remove \r
+ @param UserHandle The handle to remove the protocol handler from\r
+ @param Protocol The protocol, of protocol:interface, to remove\r
+ @param Interface The interface, of protocol:interface, to remove\r
\r
- @retval EFI_INVALID_PARAMETER Protocol is NULL. \r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
@retval EFI_SUCCESS Protocol interface successfully uninstalled.\r
\r
**/\r
//\r
gHandleDatabaseKey++;\r
Handle->Key = gHandleDatabaseKey;\r
- \r
+\r
//\r
// Remove the protocol interface from the handle\r
//\r
CoreFreePool (Handle);\r
}\r
\r
-Done: \r
+Done:\r
//\r
// Done, unlock the database and return\r
//\r
This function calls UnisatllProtocolInterface() in a loop. This is\r
basically a lib function to save space.\r
\r
- @param Handle The handle to uninstall the protocol \r
- @param ... EFI_GUID followed by protocol instance. A NULL \r
- terminates the list. The pairs are the \r
- arguments to UninstallProtocolInterface(). All \r
- the protocols are added to Handle. \r
+ @param Handle The handle to uninstall the protocol\r
+ @param ... EFI_GUID followed by protocol instance. A NULL\r
+ terminates the list. The pairs are the\r
+ arguments to UninstallProtocolInterface(). All\r
+ the protocols are added to Handle.\r
\r
@return Status code\r
\r
Protocol = VA_ARG(Args, EFI_GUID *);\r
Interface = VA_ARG(Args, VOID *);\r
CoreInstallProtocolInterface (&Handle, Protocol, EFI_NATIVE_INTERFACE, Interface);\r
- } \r
+ }\r
}\r
\r
return Status;\r
-} \r
+}\r
\r
\r
/**\r
Locate a certain GUID protocol interface in a Handle's protocols.\r
\r
- @param UserHandle The handle to obtain the protocol interface on \r
- @param Protocol The GUID of the protocol \r
+ @param UserHandle The handle to obtain the protocol interface on\r
+ @param Protocol The GUID of the protocol\r
\r
@return The requested protocol interface for the handle\r
\r
if (EFI_ERROR (Status)) {\r
return NULL;\r
}\r
- \r
+\r
Handle = (IHANDLE *)UserHandle;\r
\r
//\r
/**\r
Queries a handle to determine if it supports a specified protocol.\r
\r
- @param UserHandle The handle being queried. \r
- @param Protocol The published unique identifier of the protocol. \r
- @param Interface Supplies the address where a pointer to the \r
- corresponding Protocol Interface is returned. \r
+ @param UserHandle The handle being queried.\r
+ @param Protocol The published unique identifier of the protocol.\r
+ @param Interface Supplies the address where a pointer to the\r
+ corresponding Protocol Interface is returned.\r
\r
@return The requested protocol interface for the handle\r
\r
)\r
{\r
return CoreOpenProtocol (\r
- UserHandle, \r
- Protocol, \r
- Interface, \r
- gDxeCoreImageHandle, \r
- NULL, \r
+ UserHandle,\r
+ Protocol,\r
+ Interface,\r
+ gDxeCoreImageHandle,\r
+ NULL,\r
EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL\r
);\r
}\r
invokes it to obtain the protocol interface. Usage information\r
is registered in the protocol data base.\r
\r
- @param UserHandle The handle to obtain the protocol interface on \r
- @param Protocol The ID of the protocol \r
- @param Interface The location to return the protocol interface \r
- @param ImageHandle The handle of the Image that is opening the \r
- protocol interface specified by Protocol and \r
- Interface. \r
- @param ControllerHandle The controller handle that is requiring this \r
- interface. \r
- @param Attributes The open mode of the protocol interface \r
- specified by Handle and Protocol. \r
-\r
- @retval EFI_INVALID_PARAMETER Protocol is NULL. \r
+ @param UserHandle The handle to obtain the protocol interface on\r
+ @param Protocol The ID of the protocol\r
+ @param Interface The location to return the protocol interface\r
+ @param ImageHandle The handle of the Image that is opening the\r
+ protocol interface specified by Protocol and\r
+ Interface.\r
+ @param ControllerHandle The controller handle that is requiring this\r
+ interface.\r
+ @param Attributes The open mode of the protocol interface\r
+ specified by Handle and Protocol.\r
+\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
@retval EFI_SUCCESS Get the protocol interface.\r
\r
**/\r
*Interface = NULL;\r
}\r
}\r
- \r
+\r
//\r
// Check for invalid UserHandle\r
//\r
\r
//\r
// This is the protocol interface entry for this protocol\r
- // \r
+ //\r
if (Attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {\r
*Interface = Prot->Interface;\r
}\r
Exclusive = FALSE;\r
for ( Link = Prot->OpenList.ForwardLink; Link != &Prot->OpenList; Link = Link->ForwardLink) {\r
OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
- ExactMatch = (BOOLEAN)((OpenData->AgentHandle == ImageHandle) && \r
+ ExactMatch = (BOOLEAN)((OpenData->AgentHandle == ImageHandle) &&\r
(OpenData->Attributes == Attributes) &&\r
(OpenData->ControllerHandle == ControllerHandle));\r
if (OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
}\r
}\r
} while (Disconnect);\r
- } \r
+ }\r
break;\r
case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER :\r
case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL :\r
/**\r
Closes a protocol on a handle that was opened using OpenProtocol().\r
\r
- @param UserHandle The handle for the protocol interface that was \r
- previously opened with OpenProtocol(), and is \r
- now being closed. \r
- @param Protocol The published unique identifier of the protocol. \r
- It is the caller's responsibility to pass in a \r
- valid GUID. \r
- @param AgentHandle The handle of the agent that is closing the \r
- protocol interface. \r
- @param ControllerHandle If the agent that opened a protocol is a driver \r
- that follows the EFI Driver Model, then this \r
- parameter is the controller handle that required \r
- the protocol interface. If the agent does not \r
- follow the EFI Driver Model, then this parameter \r
- is optional and may be NULL. \r
-\r
- @retval EFI_SUCCESS The protocol instance was closed. \r
- @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a \r
- valid EFI_HANDLE. \r
- @retval EFI_NOT_FOUND Can not find the specified protocol or \r
+ @param UserHandle The handle for the protocol interface that was\r
+ previously opened with OpenProtocol(), and is\r
+ now being closed.\r
+ @param Protocol The published unique identifier of the protocol.\r
+ It is the caller's responsibility to pass in a\r
+ valid GUID.\r
+ @param AgentHandle The handle of the agent that is closing the\r
+ protocol interface.\r
+ @param ControllerHandle If the agent that opened a protocol is a driver\r
+ that follows the EFI Driver Model, then this\r
+ parameter is the controller handle that required\r
+ the protocol interface. If the agent does not\r
+ follow the EFI Driver Model, then this parameter\r
+ is optional and may be NULL.\r
+\r
+ @retval EFI_SUCCESS The protocol instance was closed.\r
+ @retval EFI_INVALID_PARAMETER Handle, AgentHandle or ControllerHandle is not a\r
+ valid EFI_HANDLE.\r
+ @retval EFI_NOT_FOUND Can not find the specified protocol or\r
AgentHandle.\r
\r
**/\r
IN EFI_HANDLE UserHandle,\r
IN EFI_GUID *Protocol,\r
IN EFI_HANDLE AgentHandle,\r
- IN EFI_HANDLE ControllerHandle \r
+ IN EFI_HANDLE ControllerHandle\r
)\r
{\r
EFI_STATUS Status;\r
OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
Link = Link->ForwardLink;\r
if ((OpenData->AgentHandle == AgentHandle) && (OpenData->ControllerHandle == ControllerHandle)) {\r
- RemoveEntryList (&OpenData->Link); \r
+ RemoveEntryList (&OpenData->Link);\r
ProtocolInterface->OpenListCount--;\r
CoreFreePool (OpenData);\r
Status = EFI_SUCCESS;\r
/**\r
Return information about Opened protocols in the system\r
\r
- @param UserHandle The handle to close the protocol interface on \r
- @param Protocol The ID of the protocol \r
- @param EntryBuffer A pointer to a buffer of open protocol \r
- information in the form of \r
- EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures. \r
+ @param UserHandle The handle to close the protocol interface on\r
+ @param Protocol The ID of the protocol\r
+ @param EntryBuffer A pointer to a buffer of open protocol\r
+ information in the form of\r
+ EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r
@param EntryCount Number of EntryBuffer entries\r
\r
**/\r
//\r
// Count the number of Open Entries\r
//\r
- for ( Link = ProtocolInterface->OpenList.ForwardLink, Count = 0; \r
+ for ( Link = ProtocolInterface->OpenList.ForwardLink, Count = 0;\r
(Link != &ProtocolInterface->OpenList) ;\r
Link = Link->ForwardLink ) {\r
Count++;\r
- } \r
+ }\r
\r
ASSERT (Count == ProtocolInterface->OpenListCount);\r
\r
}\r
\r
Status = EFI_SUCCESS;\r
- for ( Link = ProtocolInterface->OpenList.ForwardLink, Count = 0; \r
+ for ( Link = ProtocolInterface->OpenList.ForwardLink, Count = 0;\r
(Link != &ProtocolInterface->OpenList);\r
Link = Link->ForwardLink, Count++ ) {\r
OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
Buffer[Count].ControllerHandle = OpenData->ControllerHandle;\r
Buffer[Count].Attributes = OpenData->Attributes;\r
Buffer[Count].OpenCount = OpenData->OpenCount;\r
- } \r
+ }\r
\r
*EntryBuffer = Buffer;\r
*EntryCount = Count;\r
- \r
+\r
Done:\r
//\r
// Done. Release the database lock are return\r
Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated\r
from pool.\r
\r
- @param UserHandle The handle from which to retrieve the list of \r
- protocol interface GUIDs. \r
- @param ProtocolBuffer A pointer to the list of protocol interface GUID \r
- pointers that are installed on Handle. \r
- @param ProtocolBufferCount A pointer to the number of GUID pointers present \r
- in ProtocolBuffer. \r
-\r
- @retval EFI_SUCCESS The list of protocol interface GUIDs installed \r
- on Handle was returned in ProtocolBuffer. The \r
- number of protocol interface GUIDs was returned \r
- in ProtocolBufferCount. \r
- @retval EFI_INVALID_PARAMETER Handle is NULL. \r
- @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE. \r
- @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL. \r
- @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL. \r
- @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the \r
+ @param UserHandle The handle from which to retrieve the list of\r
+ protocol interface GUIDs.\r
+ @param ProtocolBuffer A pointer to the list of protocol interface GUID\r
+ pointers that are installed on Handle.\r
+ @param ProtocolBufferCount A pointer to the number of GUID pointers present\r
+ in ProtocolBuffer.\r
+\r
+ @retval EFI_SUCCESS The list of protocol interface GUIDs installed\r
+ on Handle was returned in ProtocolBuffer. The\r
+ number of protocol interface GUIDs was returned\r
+ in ProtocolBufferCount.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the\r
results.\r
\r
**/\r
ProtocolCount = 0;\r
\r
CoreAcquireProtocolLock ();\r
- \r
+\r
for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
ProtocolCount++;\r
}\r
*ProtocolBufferCount = ProtocolCount;\r
\r
for ( Link = Handle->Protocols.ForwardLink, ProtocolCount = 0;\r
- Link != &Handle->Protocols; \r
+ Link != &Handle->Protocols;\r
Link = Link->ForwardLink, ProtocolCount++) {\r
Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
Buffer[ProtocolCount] = &(Prot->Protocol->ProtocolID);\r
/**\r
Go connect any handles that were created or modified while a image executed.\r
\r
- @param Key The Key to show that the handle has been \r
+ @param Key The Key to show that the handle has been\r
created/modified\r
\r
**/\r
CoreReleaseProtocolLock ();\r
return;\r
}\r
- \r
+\r
for (Link = gHandleList.ForwardLink, Count = 0; Link != &gHandleList; Link = Link->ForwardLink) {\r
Handle = CR (Link, IHANDLE, AllHandles, EFI_HANDLE_SIGNATURE);\r
if (Handle->Key > Key) {\r
for (Index = 0; Index < Count; Index++) {\r
CoreConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
}\r
- \r
+\r
CoreFreePool(HandleBuffer);\r
}\r
PROTOCOL_ENTRY *ProtEntry;\r
} LOCATE_POSITION;\r
\r
-typedef \r
+typedef\r
IHANDLE *\r
(* CORE_GET_NEXT) (\r
IN OUT LOCATE_POSITION *Position,\r
/**\r
Routine to get the next Handle, when you are searching for all handles.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
- @retval IHANDLE An IHANDLE is returned if the next Position is \r
- not the end of the list. A NULL_HANDLE is \r
- returned if it's the end of the list.\r
+ @return An pointer to IHANDLE if the next Position is not the end of the list.\r
+ Otherwise,NULL_HANDLE is returned.\r
\r
**/\r
IHANDLE *\r
Routine to get the next Handle, when you are searching for register protocol\r
notifies.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
- @retval IHANDLE An IHANDLE is returned if the next Position is \r
- not the end of the list. A NULL_HANDLE is \r
- returned if it's the end of the list.\r
+ @return An pointer to IHANDLE if the next Position is not the end of the list.\r
+ Otherwise,NULL_HANDLE is returned.\r
\r
**/\r
IHANDLE *\r
/**\r
Routine to get the next Handle, when you are searching for a given protocol.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
- @retval IHANDLE An IHANDLE is returned if the next Position is \r
- not the end of the list. A NULL_HANDLE is \r
- returned if it's the end of the list.\r
+ @return An pointer to IHANDLE if the next Position is not the end of the list.\r
+ Otherwise,NULL_HANDLE is returned.\r
\r
**/\r
IHANDLE *\r
/**\r
Locates the requested handle(s) and returns them in Buffer.\r
\r
- @param SearchType The type of search to perform to locate the \r
- handles \r
- @param Protocol The protocol to search for \r
- @param SearchKey Dependant on SearchType \r
- @param BufferSize On input the size of Buffer. On output the \r
- size of data returned. \r
- @param Buffer The buffer to return the results in \r
-\r
- @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is \r
- returned in BufferSize. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_SUCCESS Successfully found the requested handle(s) and \r
+ @param SearchType The type of search to perform to locate the\r
+ handles\r
+ @param Protocol The protocol to search for\r
+ @param SearchKey Dependant on SearchType\r
+ @param BufferSize On input the size of Buffer. On output the\r
+ size of data returned.\r
+ @param Buffer The buffer to return the results in\r
+\r
+ @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is\r
+ returned in BufferSize.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_SUCCESS Successfully found the requested handle(s) and\r
returns them in Buffer.\r
\r
**/\r
IHANDLE *Handle;\r
IHANDLE **ResultBuffer;\r
VOID *Interface;\r
- \r
+\r
if (BufferSize == NULL) {\r
Status = EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if ((*BufferSize > 0) && (Buffer == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
GetNext = NULL;\r
\r
//\r
// Get the search function based on type\r
//\r
switch (SearchType) {\r
- case AllHandles: \r
- GetNext = CoreGetNextLocateAllHandles; \r
+ case AllHandles:\r
+ GetNext = CoreGetNextLocateAllHandles;\r
break;\r
\r
- case ByRegisterNotify: \r
+ case ByRegisterNotify:\r
//\r
// Must have SearchKey for locate ByRegisterNotify\r
//\r
Status = EFI_INVALID_PARAMETER;\r
break;\r
}\r
- GetNext = CoreGetNextLocateByRegisterNotify; \r
+ GetNext = CoreGetNextLocateByRegisterNotify;\r
break;\r
\r
- case ByProtocol: \r
+ case ByProtocol:\r
GetNext = CoreGetNextLocateByProtocol;\r
if (Protocol == NULL) {\r
Status = EFI_INVALID_PARAMETER;\r
//\r
if (ResultSize > *BufferSize) {\r
Status = EFI_BUFFER_TOO_SMALL;\r
- } \r
- \r
+ }\r
+\r
*BufferSize = ResultSize;\r
\r
if (SearchType == ByRegisterNotify && !EFI_ERROR(Status)) {\r
//\r
// If this is a search by register notify and a handle was\r
// returned, update the register notification position\r
- // \r
+ //\r
ProtNotify = SearchKey;\r
ProtNotify->Position = ProtNotify->Position->ForwardLink;\r
}\r
/**\r
Routine to get the next Handle, when you are searching for all handles.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
@return An pointer to IHANDLE if the next Position is not the end of the list.\r
Otherwise,NULL_HANDLE is returned.\r
Routine to get the next Handle, when you are searching for register protocol\r
notifies.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
@return An pointer to IHANDLE if the next Position is not the end of the list.\r
Otherwise,NULL_HANDLE is returned.\r
IHANDLE *Handle;\r
PROTOCOL_NOTIFY *ProtNotify;\r
PROTOCOL_INTERFACE *Prot;\r
- LIST_ENTRY *Link; \r
+ LIST_ENTRY *Link;\r
\r
Handle = NULL_HANDLE;\r
*Interface = NULL;\r
Prot = CR (Link, PROTOCOL_INTERFACE, ByProtocol, PROTOCOL_INTERFACE_SIGNATURE);\r
Handle = (IHANDLE *) Prot->Handle;\r
*Interface = Prot->Interface;\r
- } \r
+ }\r
}\r
\r
return Handle;\r
/**\r
Routine to get the next Handle, when you are searching for a given protocol.\r
\r
- @param Position Information about which Handle to seach for. \r
- @param Interface Return the interface structure for the matching \r
- protocol. \r
+ @param Position Information about which Handle to seach for.\r
+ @param Interface Return the interface structure for the matching\r
+ protocol.\r
\r
@return An pointer to IHANDLE if the next Position is not the end of the list.\r
Otherwise,NULL_HANDLE is returned.\r
IHANDLE *Handle;\r
LIST_ENTRY *Link;\r
PROTOCOL_INTERFACE *Prot;\r
- \r
+\r
Handle = NULL_HANDLE;\r
*Interface = NULL;\r
for (; ;) {\r
*Interface = Prot->Interface;\r
\r
//\r
- // If this handle has not been returned this request, then \r
+ // If this handle has not been returned this request, then\r
// return it now\r
//\r
if (Handle->LocateRequest != mEfiLocateHandleRequest) {\r
/**\r
Locates the handle to a device on the device path that best matches the specified protocol.\r
\r
- @param Protocol The protocol to search for. \r
- @param DevicePath On input, a pointer to a pointer to the device \r
- path. On output, the device path pointer is \r
- modified to point to the remaining part of the \r
- devicepath. \r
- @param Device A pointer to the returned device handle. \r
+ @param Protocol The protocol to search for.\r
+ @param DevicePath On input, a pointer to a pointer to the device\r
+ path. On output, the device path pointer is\r
+ modified to point to the remaining part of the\r
+ devicepath.\r
+ @param Device A pointer to the returned device handle.\r
\r
- @retval EFI_SUCCESS The resulting handle was returned. \r
- @retval EFI_NOT_FOUND No handles matched the search. \r
+ @retval EFI_SUCCESS The resulting handle was returned.\r
+ @retval EFI_NOT_FOUND No handles matched the search.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
**/\r
EFI_HANDLE Handle;\r
EFI_DEVICE_PATH_PROTOCOL *SourcePath;\r
EFI_DEVICE_PATH_PROTOCOL *TmpDevicePath;\r
- \r
+\r
if (Protocol == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if ((DevicePath == NULL) || (*DevicePath == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if (Device == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
*Device = NULL_HANDLE;\r
SourcePath = *DevicePath;\r
SourceSize = CoreDevicePathSize (SourcePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL);\r
- \r
+\r
//\r
// The source path can only have 1 instance\r
//\r
// handles\r
//\r
ASSERT (Size != BestMatch);\r
- \r
+\r
//\r
// We've got a match, see if it's the best match so far\r
//\r
}\r
\r
CoreFreePool (Handles);\r
- \r
+\r
//\r
- // If there wasn't any match, then no parts of the device path was found. \r
+ // If there wasn't any match, then no parts of the device path was found.\r
// Which is strange since there is likely a "root level" device path in the system.\r
//\r
if (BestMatch == -1) {\r
to the system. If Retistration is NULL return the first Protocol Interface\r
you find.\r
\r
- @param Protocol The protocol to search for \r
- @param Registration Optional Registration Key returned from \r
- RegisterProtocolNotify() \r
- @param Interface Return the Protocol interface (instance). \r
+ @param Protocol The protocol to search for\r
+ @param Registration Optional Registration Key returned from\r
+ RegisterProtocolNotify()\r
+ @param Interface Return the Protocol interface (instance).\r
\r
- @retval EFI_SUCCESS If a valid Interface is returned \r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
+ @retval EFI_SUCCESS If a valid Interface is returned\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
@retval EFI_NOT_FOUND Protocol interface not found\r
\r
**/\r
if (Interface == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if (Protocol == NULL) {\r
return EFI_NOT_FOUND;\r
}\r
- \r
+\r
*Interface = NULL;\r
Status = EFI_SUCCESS;\r
\r
Position.Protocol = Protocol;\r
Position.SearchKey = Registration;\r
Position.Position = &gHandleList;\r
- \r
+\r
//\r
// Lock the protocol database\r
//\r
\r
Handle = CoreGetNextLocateByProtocol (&Position, Interface);\r
} else {\r
- Handle = CoreGetNextLocateByRegisterNotify (&Position, Interface); \r
+ Handle = CoreGetNextLocateByRegisterNotify (&Position, Interface);\r
}\r
\r
if (Handle == NULL) {\r
//\r
// If this is a search by register notify and a handle was\r
// returned, update the register notification position\r
- // \r
+ //\r
ProtNotify = Registration;\r
ProtNotify->Position = ProtNotify->Position->ForwardLink;\r
}\r
in a buffer allocated from pool. This is a version of CoreLocateHandle()\r
that allocates a buffer for the caller.\r
\r
- @param SearchType Specifies which handle(s) are to be returned. \r
- @param Protocol Provides the protocol to search by. This \r
- parameter is only valid for SearchType \r
- ByProtocol. \r
- @param SearchKey Supplies the search key depending on the \r
- SearchType. \r
- @param NumberHandles The number of handles returned in Buffer. \r
- @param Buffer A pointer to the buffer to return the requested \r
- array of handles that support Protocol. \r
-\r
- @retval EFI_SUCCESS The result array of handles was returned. \r
- @retval EFI_NOT_FOUND No handles match the search. \r
- @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the \r
- matching results. \r
+ @param SearchType Specifies which handle(s) are to be returned.\r
+ @param Protocol Provides the protocol to search by. This\r
+ parameter is only valid for SearchType\r
+ ByProtocol.\r
+ @param SearchKey Supplies the search key depending on the\r
+ SearchType.\r
+ @param NumberHandles The number of handles returned in Buffer.\r
+ @param Buffer A pointer to the buffer to return the requested\r
+ array of handles that support Protocol.\r
+\r
+ @retval EFI_SUCCESS The result array of handles was returned.\r
+ @retval EFI_NOT_FOUND No handles match the search.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the\r
+ matching results.\r
@retval EFI_INVALID_PARAMETER One or more paramters are not valid.\r
\r
**/\r
/**\r
Removes Protocol from the protocol list (but not the handle list).\r
\r
- @param Handle The handle to remove protocol on. \r
- @param Protocol GUID of the protocol to be moved \r
- @param Interface The interface of the protocol \r
+ @param Handle The handle to remove protocol on.\r
+ @param Protocol GUID of the protocol to be moved\r
+ @param Interface The interface of the protocol\r
\r
@return Protocol Entry\r
\r
/**\r
Add a new protocol notification record for the request protocol.\r
\r
- @param Protocol The requested protocol to add the notify \r
- registration \r
- @param Event The event to signal \r
- @param Registration Returns the registration record \r
+ @param Protocol The requested protocol to add the notify\r
+ registration\r
+ @param Event The event to signal\r
+ @param Registration Returns the registration record\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_SUCCESS Successfully returned the registration record \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_SUCCESS Successfully returned the registration record\r
that has been added\r
\r
**/\r
PROTOCOL_ENTRY *ProtEntry;\r
PROTOCOL_NOTIFY *ProtNotify;\r
EFI_STATUS Status;\r
- \r
+\r
if ((Protocol == NULL) || (Event == NULL) || (Registration == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
CoreAcquireProtocolLock ();\r
\r
ProtNotify = NULL;\r
- \r
+\r
//\r
// Get the protocol entry to add the notification too\r
//\r
//\r
ProtNotify = CoreAllocateBootServicesPool (sizeof(PROTOCOL_NOTIFY));\r
if (ProtNotify != NULL) {\r
- \r
+\r
ProtNotify->Signature = PROTOCOL_NOTIFY_SIGNATURE;\r
ProtNotify->Protocol = ProtEntry;\r
ProtNotify->Event = Event;\r
//\r
// start at the begining\r
//\r
- ProtNotify->Position = &ProtEntry->Protocols; \r
+ ProtNotify->Position = &ProtEntry->Protocols;\r
\r
InsertTailList (&ProtEntry->Notify, &ProtNotify->Link);\r
}\r
/**\r
Reinstall a protocol interface on a device handle. The OldInterface for Protocol is replaced by the NewInterface.\r
\r
- @param UserHandle Handle on which the interface is to be \r
- reinstalled \r
- @param Protocol The numeric ID of the interface \r
- @param OldInterface A pointer to the old interface \r
- @param NewInterface A pointer to the new interface \r
+ @param UserHandle Handle on which the interface is to be\r
+ reinstalled\r
+ @param Protocol The numeric ID of the interface\r
+ @param OldInterface A pointer to the old interface\r
+ @param NewInterface A pointer to the new interface\r
\r
@retval EFI_SUCCESS The protocol interface was installed\r
@retval EFI_NOT_FOUND The OldInterface on the handle was not found\r
//\r
CoreReleaseProtocolLock ();\r
Status = CoreConnectController (\r
- UserHandle, \r
- NULL, \r
- NULL, \r
+ UserHandle,\r
+ NULL,\r
+ NULL,\r
TRUE\r
);\r
CoreAcquireProtocolLock ();\r
- \r
+\r
//\r
// Notify the notification list for this protocol\r
//\r
CoreNotifyProtocolEntry (ProtEntry);\r
\r
CoreReleaseProtocolLock ();\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
will access the file either from a memory copy, from a file\r
system interface, or from the load file interface.\r
\r
- @param BootPolicy Policy for Open Image File. \r
- @param SourceBuffer Pointer to the memory location containing copy \r
- of the image to be loaded. \r
- @param SourceSize The size in bytes of SourceBuffer. \r
- @param FilePath The specific file path from which the image is \r
- loaded \r
- @param DeviceHandle Pointer to the return device handle. \r
- @param ImageFileHandle Pointer to the image file handle. \r
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which \r
- the authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Image file successfully opened. \r
- @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and \r
- SourceSize is 0. \r
- @retval EFI_INVALID_PARAMETER File path is not valid. \r
+ @param BootPolicy Policy for Open Image File.\r
+ @param SourceBuffer Pointer to the memory location containing copy\r
+ of the image to be loaded.\r
+ @param SourceSize The size in bytes of SourceBuffer.\r
+ @param FilePath The specific file path from which the image is\r
+ loaded\r
+ @param DeviceHandle Pointer to the return device handle.\r
+ @param ImageFileHandle Pointer to the image file handle.\r
+ @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which\r
+ the authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Image file successfully opened.\r
+ @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and\r
+ SourceSize is 0.\r
+ @retval EFI_INVALID_PARAMETER File path is not valid.\r
@retval EFI_NOT_FOUND File not found.\r
\r
**/\r
Read image file (specified by UserHandle) into user specified buffer with specified offset\r
and length.\r
\r
- @param UserHandle Image file handle \r
- @param Offset Offset to the source file \r
- @param ReadSize For input, pointer of size to read; For output, \r
- pointer of size actually read. \r
- @param Buffer Buffer to write into \r
+ @param UserHandle Image file handle\r
+ @param Offset Offset to the source file\r
+ @param ReadSize For input, pointer of size to read; For output,\r
+ pointer of size actually read.\r
+ @param Buffer Buffer to write into\r
\r
- @retval EFI_SUCCESS Successfully read the specified part of file \r
+ @retval EFI_SUCCESS Successfully read the specified part of file\r
into buffer.\r
\r
**/\r
Search a handle to a device on a specified device path that supports a specified protocol,\r
interface of that protocol on that handle is another output.\r
\r
- @param Protocol The protocol to search for \r
- @param FilePath The specified device path \r
- @param Interface Interface of the protocol on the handle \r
- @param Handle The handle to the device on the specified device \r
- path that supports the protocol. \r
+ @param Protocol The protocol to search for\r
+ @param FilePath The specified device path\r
+ @param Interface Interface of the protocol on the handle\r
+ @param Handle The handle to the device on the specified device\r
+ path that supports the protocol.\r
\r
@return Status code.\r
\r
/**\r
Loads, relocates, and invokes a PE/COFF image\r
\r
- @param BootPolicy If TRUE, indicates that the request originates \r
- from the boot manager, and that the boot \r
- manager is attempting to load FilePath as a \r
- boot selection. \r
- @param Pe32Handle The handle of PE32 image \r
- @param Image PE image to be loaded \r
- @param DstBuffer The buffer to store the image \r
- @param EntryPoint A pointer to the entry point \r
- @param Attribute The bit mask of attributes to set for the load \r
- PE image \r
-\r
- @retval EFI_SUCCESS The file was loaded, relocated, and invoked \r
- @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and \r
- relocate the PE/COFF file \r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
+ @param BootPolicy If TRUE, indicates that the request originates\r
+ from the boot manager, and that the boot\r
+ manager is attempting to load FilePath as a\r
+ boot selection.\r
+ @param Pe32Handle The handle of PE32 image\r
+ @param Image PE image to be loaded\r
+ @param DstBuffer The buffer to store the image\r
+ @param EntryPoint A pointer to the entry point\r
+ @param Attribute The bit mask of attributes to set for the load\r
+ PE image\r
+\r
+ @retval EFI_SUCCESS The file was loaded, relocated, and invoked\r
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory to load and\r
+ relocate the PE/COFF file\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
@retval EFI_BUFFER_TOO_SMALL Buffer for image is too small\r
\r
**/\r
EFI_STATUS\r
CoreLoadPeImage (\r
- IN BOOLEAN BootPolicy, \r
+ IN BOOLEAN BootPolicy,\r
IN VOID *Pe32Handle,\r
IN LOADED_IMAGE_PRIVATE_DATA *Image,\r
IN EFI_PHYSICAL_ADDRESS DstBuffer OPTIONAL,\r
/**\r
Get the image's private data from its handle.\r
\r
- @param ImageHandle The image handle \r
+ @param ImageHandle The image handle\r
\r
@return Return the image private data associated with ImageHandle.\r
\r
/**\r
Unloads EFI image from memory.\r
\r
- @param Image EFI image \r
+ @param Image EFI image\r
@param FreePage Free allocated pages\r
\r
**/\r
/**\r
Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
\r
- @param This Calling context \r
- @param ParentImageHandle The caller's image handle. \r
- @param FilePath The specific file path from which the image is \r
- loaded. \r
- @param SourceBuffer If not NULL, a pointer to the memory location \r
- containing a copy of the image to be loaded. \r
- @param SourceSize The size in bytes of SourceBuffer. \r
- @param DstBuffer The buffer to store the image. \r
- @param NumberOfPages For input, specifies the space size of the \r
- image by caller if not NULL. For output, \r
- specifies the actual space size needed. \r
- @param ImageHandle Image handle for output. \r
- @param EntryPoint Image entry point for output. \r
- @param Attribute The bit mask of attributes to set for the load \r
- PE image. \r
-\r
- @retval EFI_SUCCESS The image was loaded into memory. \r
- @retval EFI_NOT_FOUND The FilePath was not found. \r
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. \r
- @retval EFI_UNSUPPORTED The image type is not supported, or the device \r
- path cannot be parsed to locate the proper \r
- protocol for loading the file. \r
- @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient \r
+ @param This Calling context\r
+ @param ParentImageHandle The caller's image handle.\r
+ @param FilePath The specific file path from which the image is\r
+ loaded.\r
+ @param SourceBuffer If not NULL, a pointer to the memory location\r
+ containing a copy of the image to be loaded.\r
+ @param SourceSize The size in bytes of SourceBuffer.\r
+ @param DstBuffer The buffer to store the image.\r
+ @param NumberOfPages For input, specifies the space size of the\r
+ image by caller if not NULL. For output,\r
+ specifies the actual space size needed.\r
+ @param ImageHandle Image handle for output.\r
+ @param EntryPoint Image entry point for output.\r
+ @param Attribute The bit mask of attributes to set for the load\r
+ PE image.\r
+\r
+ @retval EFI_SUCCESS The image was loaded into memory.\r
+ @retval EFI_NOT_FOUND The FilePath was not found.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_UNSUPPORTED The image type is not supported, or the device\r
+ path cannot be parsed to locate the proper\r
+ protocol for loading the file.\r
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient\r
resources.\r
\r
**/\r
/**\r
Unload the specified image.\r
\r
- @param This Indicates the calling context. \r
- @param ImageHandle The specified image handle. \r
+ @param This Indicates the calling context.\r
+ @param ImageHandle The specified image handle.\r
\r
- @retval EFI_INVALID_PARAMETER Image handle is NULL. \r
- @retval EFI_UNSUPPORTED Attempt to unload an unsupported image. \r
+ @retval EFI_INVALID_PARAMETER Image handle is NULL.\r
+ @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.\r
@retval EFI_SUCCESS Image successfully unloaded.\r
\r
**/\r
UINTN StartIndex;\r
CHAR8 EfiFileName[256];\r
\r
- \r
+\r
DEBUG ((DEBUG_INFO | DEBUG_LOAD,\r
"Loading driver at 0x%10p EntryPoint=0x%10p ",\r
(VOID *)(UINTN) Image->ImageContext.ImageAddress,\r
FUNCTION_ENTRY_POINT ((UINTN) Image->ImageContext.EntryPoint)));\r
- \r
+\r
\r
//\r
// Print Module Name by Pdb file path\r
will access the file either from a memory copy, from a file\r
system interface, or from the load file interface.\r
\r
- @param BootPolicy Policy for Open Image File. \r
- @param SourceBuffer Pointer to the memory location containing copy \r
- of the image to be loaded. \r
- @param SourceSize The size in bytes of SourceBuffer. \r
- @param FilePath The specific file path from which the image is \r
- loaded \r
- @param DeviceHandle Pointer to the return device handle. \r
- @param ImageFileHandle Pointer to the image file handle. \r
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which \r
- the authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Image file successfully opened. \r
- @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and \r
- SourceSize is 0. \r
- @retval EFI_INVALID_PARAMETER File path is not valid. \r
+ @param BootPolicy Policy for Open Image File.\r
+ @param SourceBuffer Pointer to the memory location containing copy\r
+ of the image to be loaded.\r
+ @param SourceSize The size in bytes of SourceBuffer.\r
+ @param FilePath The specific file path from which the image is\r
+ loaded\r
+ @param DeviceHandle Pointer to the return device handle.\r
+ @param ImageFileHandle Pointer to the image file handle.\r
+ @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which\r
+ the authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Image file successfully opened.\r
+ @retval EFI_LOAD_ERROR If the caller passed a copy of the file, and\r
+ SourceSize is 0.\r
+ @retval EFI_INVALID_PARAMETER File path is not valid.\r
@retval EFI_NOT_FOUND File not found.\r
\r
**/\r
//\r
// Duplicate the device path to avoid the access to unaligned device path node.\r
// Because the device path consists of one or more FILE PATH MEDIA DEVICE PATH\r
- // nodes, It assures the fields in device path nodes are 2 byte aligned. \r
+ // nodes, It assures the fields in device path nodes are 2 byte aligned.\r
//\r
FilePathNode = (FILEPATH_DEVICE_PATH *)CoreDuplicateDevicePath((EFI_DEVICE_PATH_PROTOCOL *)(UINTN)FilePathNode);\r
if (FilePathNode == NULL) {\r
FilePathNode = (FILEPATH_DEVICE_PATH *) NextDevicePathNode (&FilePathNode->Header);\r
}\r
//\r
- // Free the allocated memory pool \r
+ // Free the allocated memory pool\r
//\r
CoreFreePool(OriginalFilePathNode);\r
}\r
Read image file (specified by UserHandle) into user specified buffer with specified offset\r
and length.\r
\r
- @param UserHandle Image file handle \r
- @param Offset Offset to the source file \r
- @param ReadSize For input, pointer of size to read; For output, \r
- pointer of size actually read. \r
- @param Buffer Buffer to write into \r
+ @param UserHandle Image file handle\r
+ @param Offset Offset to the source file\r
+ @param ReadSize For input, pointer of size to read; For output,\r
+ pointer of size actually read.\r
+ @param Buffer Buffer to write into\r
\r
- @retval EFI_SUCCESS Successfully read the specified part of file \r
+ @retval EFI_SUCCESS Successfully read the specified part of file\r
into buffer.\r
\r
**/\r
Search a handle to a device on a specified device path that supports a specified protocol,\r
interface of that protocol on that handle is another output.\r
\r
- @param Protocol The protocol to search for \r
- @param FilePath The specified device path \r
- @param Interface Interface of the protocol on the handle \r
- @param Handle The handle to the device on the specified device \r
- path that supports the protocol. \r
+ @param Protocol The protocol to search for\r
+ @param FilePath The specified device path\r
+ @param Interface Interface of the protocol on the handle\r
+ @param Handle The handle to the device on the specified device\r
+ path that supports the protocol.\r
\r
@return Status code.\r
\r
to allocate the proper sized buffer for various\r
EFI interfaces.\r
\r
- @param Status Current status \r
- @param Buffer Current allocated buffer, or NULL \r
- @param BufferSize Current buffer size needed \r
+ @param Status Current status\r
+ @param Buffer Current allocated buffer, or NULL\r
+ @param BufferSize Current buffer size needed\r
\r
- @retval TRUE if the buffer was reallocated and the caller \r
- should try the API again. \r
- @retval FALSE buffer could not be allocated and the caller \r
+ @retval TRUE if the buffer was reallocated and the caller\r
+ should try the API again.\r
+ @retval FALSE buffer could not be allocated and the caller\r
should not try the API again.\r
\r
**/\r
Internal function. Used by the pool functions to allocate pages\r
to back pool allocation requests.\r
\r
- @param PoolType The type of memory for the new pool pages \r
- @param NumberOfPages No of pages to allocate \r
- @param Alignment Bits to align. \r
+ @param PoolType The type of memory for the new pool pages\r
+ @param NumberOfPages No of pages to allocate\r
+ @param Alignment Bits to align.\r
\r
@return The allocated memory, or NULL\r
\r
/**\r
Internal function. Frees pool pages allocated via AllocatePoolPages ()\r
\r
- @param Memory The base address to free \r
+ @param Memory The base address to free\r
@param NumberOfPages The number of pages to free\r
\r
**/\r
Internal function to allocate pool of a particular type.\r
Caller must have the memory lock held\r
\r
- @param PoolType Type of pool to allocate \r
- @param Size The amount of pool to allocate \r
+ @param PoolType Type of pool to allocate\r
+ @param Size The amount of pool to allocate\r
\r
@return The allocate pool, or NULL\r
\r
Internal function to free a pool entry.\r
Caller must have the memory lock held\r
\r
- @param Buffer The allocated pool entry to free \r
+ @param Buffer The allocated pool entry to free\r
\r
- @retval EFI_INVALID_PARAMETER Buffer not valid \r
+ @retval EFI_INVALID_PARAMETER Buffer not valid\r
@retval EFI_SUCCESS Buffer successfully freed.\r
\r
**/\r
// Internal Global data\r
//\r
\r
-extern EFI_LOCK gMemoryLock; \r
+extern EFI_LOCK gMemoryLock;\r
extern LIST_ENTRY gMemoryMap;\r
extern MEMORY_MAP *gMemoryLastConvert;\r
extern LIST_ENTRY mGcdMemorySpaceMap;\r
/**\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid.\r
\r
- @param Value Describes the class/subclass/operation of the \r
- hardware or software entity that the Status Code \r
+ @param Value Describes the class/subclass/operation of the\r
+ hardware or software entity that the Status Code\r
relates to.\r
\r
**/\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid,\r
with a handle as additional information.\r
\r
- @param Value Describes the class/subclass/operation of the \r
- hardware or software entity that the Status Code \r
- relates to. \r
+ @param Value Describes the class/subclass/operation of the\r
+ hardware or software entity that the Status Code\r
+ relates to.\r
@param Handle Additional information.\r
\r
**/\r
Raising to the task priority level of the mutual exclusion\r
lock, and then acquires ownership of the lock.\r
\r
- @param Lock The lock to acquire \r
+ @param Lock The lock to acquire\r
\r
@return Lock owned\r
\r
multiprocessor support, acquiring the lock only consists\r
of raising to the locks TPL.\r
\r
- @param Lock The EFI_LOCK structure to initialize \r
+ @param Lock The EFI_LOCK structure to initialize\r
\r
- @retval EFI_SUCCESS Lock Owned. \r
+ @retval EFI_SUCCESS Lock Owned.\r
@retval EFI_ACCESS_DENIED Reentrant Lock Acquisition, Lock not Owned.\r
\r
**/\r
Releases ownership of the mutual exclusion lock, and\r
restores the previous task priority level.\r
\r
- @param Lock The lock to release \r
+ @param Lock The lock to release\r
\r
@return Lock unowned\r
\r
/**\r
Calculate the size of a whole device path.\r
\r
- @param DevicePath The pointer to the device path data. \r
+ @param DevicePath The pointer to the device path data.\r
\r
@return Size of device path data structure..\r
\r
/**\r
Return TRUE is this is a multi instance device path.\r
\r
- @param DevicePath A pointer to a device path data structure. \r
+ @param DevicePath A pointer to a device path data structure.\r
\r
- @retval TRUE If DevicePath is multi instance. FALSE - If \r
+ @retval TRUE If DevicePath is multi instance. FALSE - If\r
DevicePath is not multi instance.\r
\r
**/\r
/**\r
Duplicate a new device path data structure from the old one.\r
\r
- @param DevicePath A pointer to a device path data structure. \r
+ @param DevicePath A pointer to a device path data structure.\r
\r
@return A pointer to the new allocated device path data.\r
@return Caller must free the memory used by DevicePath if it is no longer needed.\r
/**\r
Function is used to append a Src1 and Src2 together.\r
\r
- @param Src1 A pointer to a device path data structure. \r
- @param Src2 A pointer to a device path data structure. \r
+ @param Src1 A pointer to a device path data structure.\r
+ @param Src2 A pointer to a device path data structure.\r
\r
@return A pointer to the new device path is returned.\r
@return NULL is returned if space for the new device path could not be allocated from pool.\r
/**\r
Allocate pool of type EfiBootServicesData, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of type EfiBootServicesData and zero it, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Find a config table by name in system table's ConfigurationTable.\r
\r
- @param Guid The table name to look for \r
- @param Table Pointer of the config table \r
+ @param Guid The table name to look for\r
+ @param Table Pointer of the config table\r
\r
- @retval EFI_NOT_FOUND Could not find the table in system table's \r
- ConfigurationTable. \r
+ @retval EFI_NOT_FOUND Could not find the table in system table's\r
+ ConfigurationTable.\r
@retval EFI_SUCCESS Table successfully found.\r
\r
**/\r
/**\r
Allocate pool of specified size with EfiRuntimeServicesData type, and copy specified buffer to this pool.\r
\r
- @param AllocationSize Size to allocate. \r
- @param Buffer Specified buffer that will be copy to the allocated \r
- pool \r
+ @param AllocationSize Size to allocate.\r
+ @param Buffer Specified buffer that will be copy to the allocated\r
+ pool\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of type EfiRuntimeServicesData, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of specified size with EfiBootServicesData type, and copy specified buffer to this pool.\r
\r
- @param AllocationSize Size to allocate. \r
- @param Buffer Specified buffer that will be copy to the allocated \r
- pool \r
+ @param AllocationSize Size to allocate.\r
+ @param Buffer Specified buffer that will be copy to the allocated\r
+ pool\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Create a protocol notification event and return it.\r
\r
- @param ProtocolGuid Protocol to register notification event on. \r
- @param NotifyTpl Maximum TPL to signal the NotifyFunction. \r
- @param NotifyFunction EFI notification routine. \r
- @param NotifyContext Context passed into Event when it is created. \r
- @param Registration Registration key returned from \r
- RegisterProtocolNotify(). \r
- @param SignalFlag Boolean value to decide whether kick the event after \r
- register or not. \r
+ @param ProtocolGuid Protocol to register notification event on.\r
+ @param NotifyTpl Maximum TPL to signal the NotifyFunction.\r
+ @param NotifyFunction EFI notification routine.\r
+ @param NotifyContext Context passed into Event when it is created.\r
+ @param Registration Registration key returned from\r
+ RegisterProtocolNotify().\r
+ @param SignalFlag Boolean value to decide whether kick the event after\r
+ register or not.\r
\r
@return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
is added to the system.\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid,\r
with a handle as additional information.\r
\r
- @param Value Describes the class/subclass/operation of the \r
- hardware or software entity that the Status Code \r
- relates to. \r
+ @param Value Describes the class/subclass/operation of the\r
+ hardware or software entity that the Status Code\r
+ relates to.\r
@param Handle Additional information.\r
\r
**/\r
/**\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid.\r
\r
- @param Value Describes the class/subclass/operation of the \r
- hardware or software entity that the Status Code \r
+ @param Value Describes the class/subclass/operation of the\r
+ hardware or software entity that the Status Code\r
relates to.\r
\r
**/\r
/**\r
Allocate pool of type EfiBootServicesData, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of type EfiBootServicesData and zero it, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of specified size with EfiBootServicesData type, and copy specified buffer to this pool.\r
\r
- @param AllocationSize Size to allocate. \r
- @param Buffer Specified buffer that will be copy to the allocated \r
- pool \r
+ @param AllocationSize Size to allocate.\r
+ @param Buffer Specified buffer that will be copy to the allocated\r
+ pool\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of type EfiRuntimeServicesData, the size is specified with AllocationSize.\r
\r
- @param AllocationSize Size to allocate. \r
+ @param AllocationSize Size to allocate.\r
\r
@return Pointer of the allocated pool.\r
\r
/**\r
Allocate pool of specified size with EfiRuntimeServicesData type, and copy specified buffer to this pool.\r
\r
- @param AllocationSize Size to allocate. \r
- @param Buffer Specified buffer that will be copy to the allocated \r
- pool \r
+ @param AllocationSize Size to allocate.\r
+ @param Buffer Specified buffer that will be copy to the allocated\r
+ pool\r
\r
@return Pointer of the allocated pool.\r
\r
multiprocessor support, acquiring the lock only consists\r
of raising to the locks TPL.\r
\r
- @param Lock The EFI_LOCK structure to initialize \r
+ @param Lock The EFI_LOCK structure to initialize\r
\r
- @retval EFI_SUCCESS Lock Owned. \r
+ @retval EFI_SUCCESS Lock Owned.\r
@retval EFI_ACCESS_DENIED Reentrant Lock Acquisition, Lock not Owned.\r
\r
**/\r
Raising to the task priority level of the mutual exclusion\r
lock, and then acquires ownership of the lock.\r
\r
- @param Lock The lock to acquire \r
+ @param Lock The lock to acquire\r
\r
@return Lock owned\r
\r
Releases ownership of the mutual exclusion lock, and\r
restores the previous task priority level.\r
\r
- @param Lock The lock to release \r
+ @param Lock The lock to release\r
\r
@return Lock unowned\r
\r
/**\r
Calculate the size of a whole device path.\r
\r
- @param DevicePath The pointer to the device path data. \r
+ @param DevicePath The pointer to the device path data.\r
\r
@return Size of device path data structure..\r
\r
/**\r
Return TRUE is this is a multi instance device path.\r
\r
- @param DevicePath A pointer to a device path data structure. \r
+ @param DevicePath A pointer to a device path data structure.\r
\r
- @retval TRUE If DevicePath is multi instance. FALSE - If \r
+ @retval TRUE If DevicePath is multi instance. FALSE - If\r
DevicePath is not multi instance.\r
\r
**/\r
/**\r
Duplicate a new device path data structure from the old one.\r
\r
- @param DevicePath A pointer to a device path data structure. \r
+ @param DevicePath A pointer to a device path data structure.\r
\r
@return A pointer to the new allocated device path data.\r
@return Caller must free the memory used by DevicePath if it is no longer needed.\r
/**\r
Function is used to append a Src1 and Src2 together.\r
\r
- @param Src1 A pointer to a device path data structure. \r
- @param Src2 A pointer to a device path data structure. \r
+ @param Src1 A pointer to a device path data structure.\r
+ @param Src2 A pointer to a device path data structure.\r
\r
@return A pointer to the new device path is returned.\r
@return NULL is returned if space for the new device path could not be allocated from pool.\r
/**\r
Create a protocol notification event and return it.\r
\r
- @param ProtocolGuid Protocol to register notification event on. \r
- @param NotifyTpl Maximum TPL to signal the NotifyFunction. \r
- @param NotifyFunction EFI notification routine. \r
- @param NotifyContext Context passed into Event when it is created. \r
- @param Registration Registration key returned from \r
- RegisterProtocolNotify(). \r
- @param SignalFlag Boolean value to decide whether kick the event after \r
- register or not. \r
+ @param ProtocolGuid Protocol to register notification event on.\r
+ @param NotifyTpl Maximum TPL to signal the NotifyFunction.\r
+ @param NotifyFunction EFI notification routine.\r
+ @param NotifyContext Context passed into Event when it is created.\r
+ @param Registration Registration key returned from\r
+ RegisterProtocolNotify().\r
+ @param SignalFlag Boolean value to decide whether kick the event after\r
+ register or not.\r
\r
@return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
is added to the system.\r
Internal function. Adds a ranges to the memory map.\r
The range must not already exist in the map.\r
\r
- @param Type The type of memory range to add \r
- @param Start The starting address in the memory range Must be \r
- paged aligned \r
- @param End The last address in the range Must be the last \r
- byte of a page \r
- @param Attribute The attributes of the memory range to add \r
+ @param Type The type of memory range to add\r
+ @param Start The starting address in the memory range Must be\r
+ paged aligned\r
+ @param End The last address in the range Must be the last\r
+ byte of a page\r
+ @param Attribute The attributes of the memory range to add\r
\r
**/\r
VOID\r
Internal function. Converts a memory range to the specified type.\r
The range must exist in the memory map.\r
\r
- @param Start The first address of the range Must be page \r
- aligned \r
- @param NumberOfPages The number of pages to convert \r
- @param NewType The new type for the memory range \r
+ @param Start The first address of the range Must be page\r
+ aligned\r
+ @param NumberOfPages The number of pages to convert\r
+ @param NewType The new type for the memory range\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_NOT_FOUND Could not find a descriptor cover the specified \r
- range or convertion not allowed. \r
- @retval EFI_SUCCESS Successfully converts the memory range to the \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_NOT_FOUND Could not find a descriptor cover the specified\r
+ range or convertion not allowed.\r
+ @retval EFI_SUCCESS Successfully converts the memory range to the\r
specified type.\r
\r
**/\r
**/\r
VOID\r
RemoveMemoryMapEntry (\r
- MEMORY_MAP *Entry\r
+ IN OUT MEMORY_MAP *Entry\r
);\r
- \r
+\r
/**\r
Internal function. Deque a descriptor entry from the mFreeMemoryMapEntryList.\r
If the list is emtry, then allocate a new page to refuel the list.\r
AllocateMemoryMapEntry (\r
VOID\r
);\r
- \r
+\r
\r
/**\r
Enter critical section by gaining lock on gMemoryLock.\r
EFI_GCD_MAP_ENTRY *Entry;\r
\r
DEBUG ((DEBUG_ERROR | DEBUG_PAGE, "Promote the memory resource\n"));\r
- \r
+\r
CoreAcquireGcdMemoryLock ();\r
- \r
+\r
Link = mGcdMemorySpaceMap.ForwardLink;\r
while (Link != &mGcdMemorySpaceMap) {\r
\r
\r
//\r
// Add to allocable system memory resource\r
- // \r
+ //\r
\r
CoreAddRange (\r
- EfiConventionalMemory, \r
- Entry->BaseAddress, \r
- Entry->EndAddress, \r
+ EfiConventionalMemory,\r
+ Entry->BaseAddress,\r
+ Entry->EndAddress,\r
Entry->Capabilities & ~(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED | EFI_MEMORY_RUNTIME)\r
);\r
CoreFreeMemoryMapStack ();\r
- \r
+\r
}\r
\r
Link = Link->ForwardLink;\r
}\r
- \r
+\r
CoreReleaseGcdMemoryLock ();\r
- \r
+\r
return;\r
}\r
\r
The first descriptor that is added must be general usable\r
memory as the addition allocates heap.\r
\r
- @param Type The type of memory to add \r
- @param Start The starting address in the memory range Must be \r
- page aligned \r
- @param NumberOfPages The number of pages in the range \r
- @param Attribute Attributes of the memory to add \r
+ @param Type The type of memory to add\r
+ @param Start The starting address in the memory range Must be\r
+ page aligned\r
+ @param NumberOfPages The number of pages in the range\r
+ @param Attribute Attributes of the memory to add\r
\r
@return None. The range is added to the memory map\r
\r
if (Type >= EfiMaxMemoryType && Type <= 0x7fffffff) {\r
return;\r
}\r
- \r
+\r
CoreAcquireMemoryLock ();\r
End = Start + LShiftU64 (NumberOfPages, EFI_PAGE_SHIFT) - 1;\r
CoreAddRange (Type, Start, End, Attribute);\r
);\r
if (EFI_ERROR (Status)) {\r
//\r
- // If an error occurs allocating the pages for the current memory type, then \r
+ // If an error occurs allocating the pages for the current memory type, then\r
// free all the pages allocates for the previous memory types and return. This\r
// operation with be retied when/if more memory is added to the system\r
//\r
\r
if (gMemoryTypeInformation[FreeIndex].NumberOfPages != 0) {\r
CoreFreePages (\r
- mMemoryTypeStatistics[Type].BaseAddress, \r
+ mMemoryTypeStatistics[Type].BaseAddress,\r
gMemoryTypeInformation[FreeIndex].NumberOfPages\r
);\r
mMemoryTypeStatistics[Type].BaseAddress = 0;\r
//\r
// Compute the address at the top of the current statistics\r
//\r
- mMemoryTypeStatistics[Type].MaximumAddress = \r
- mMemoryTypeStatistics[Type].BaseAddress + \r
+ mMemoryTypeStatistics[Type].MaximumAddress =\r
+ mMemoryTypeStatistics[Type].BaseAddress +\r
LShiftU64 (gMemoryTypeInformation[Index].NumberOfPages, EFI_PAGE_SHIFT) - 1;\r
\r
//\r
- // If the current base address is the lowest address so far, then update the default \r
+ // If the current base address is the lowest address so far, then update the default\r
// maximum address\r
//\r
if (mMemoryTypeStatistics[Type].BaseAddress < mDefaultMaximumAddress) {\r
\r
if (gMemoryTypeInformation[Index].NumberOfPages != 0) {\r
CoreFreePages (\r
- mMemoryTypeStatistics[Type].BaseAddress, \r
+ mMemoryTypeStatistics[Type].BaseAddress,\r
gMemoryTypeInformation[Index].NumberOfPages\r
);\r
mMemoryTypeStatistics[Type].NumberOfPages = gMemoryTypeInformation[Index].NumberOfPages;\r
Internal function. Adds a ranges to the memory map.\r
The range must not already exist in the map.\r
\r
- @param Type The type of memory range to add \r
- @param Start The starting address in the memory range Must be \r
- paged aligned \r
- @param End The last address in the range Must be the last \r
- byte of a page \r
- @param Attribute The attributes of the memory range to add \r
-\r
- @return None. The range is added to the memory map\r
+ @param Type The type of memory range to add\r
+ @param Start The starting address in the memory range Must be\r
+ paged aligned\r
+ @param End The last address in the range Must be the last\r
+ byte of a page\r
+ @param Attribute The attributes of the memory range to add\r
\r
**/\r
VOID\r
ASSERT (End > Start) ;\r
\r
ASSERT_LOCKED (&gMemoryLock);\r
- \r
+\r
DEBUG ((DEBUG_PAGE, "AddRange: %lx-%lx to %d\n", Start, End, Type));\r
\r
//\r
//\r
// UEFI 2.0 added an event group for notificaiton on memory map changes.\r
// So we need to signal this Event Group every time the memory map changes.\r
- // If we are in EFI 1.10 compatability mode no event groups will be \r
+ // If we are in EFI 1.10 compatability mode no event groups will be\r
// found and nothing will happen we we call this function. These events\r
- // will get signaled but since a lock is held around the call to this \r
+ // will get signaled but since a lock is held around the call to this\r
// function the notificaiton events will only be called after this funciton\r
// returns and the lock is released.\r
//\r
//\r
// Look for adjoining memory descriptor\r
//\r
- \r
+\r
// Two memory descriptors can only be merged if they have the same Type\r
// and the same Attribute\r
//\r
}\r
\r
if (Entry->End + 1 == Start) {\r
- \r
+\r
Start = Entry->Start;\r
RemoveMemoryMapEntry (Entry);\r
\r
} else if (Entry->Start == End + 1) {\r
- \r
+\r
End = Entry->End;\r
RemoveMemoryMapEntry (Entry);\r
}\r
}\r
\r
//\r
- // Add descriptor \r
+ // Add descriptor\r
//\r
\r
mMapStack[mMapDepth].Signature = MEMORY_MAP_SIGNATURE;\r
\r
while (mMapDepth != 0) {\r
//\r
- // Deque an memory map entry from mFreeMemoryMapEntryList \r
+ // Deque an memory map entry from mFreeMemoryMapEntryList\r
//\r
Entry = AllocateMemoryMapEntry ();\r
- \r
+\r
ASSERT (Entry);\r
\r
//\r
InsertTailList (Link2, &Entry->Link);\r
\r
} else {\r
- // \r
+ //\r
// This item of mMapStack[mMapDepth] has already been dequeued from gMemoryMap list,\r
// so here no need to move it to memory.\r
//\r
MEMORY_MAP* FreeDescriptorEntries;\r
MEMORY_MAP* Entry;\r
UINTN Index;\r
- \r
+\r
if (IsListEmpty (&mFreeMemoryMapEntryList)) {\r
- // \r
+ //\r
// The list is empty, to allocate one page to refuel the list\r
//\r
FreeDescriptorEntries = CoreAllocatePoolPages (EfiBootServicesData, EFI_SIZE_TO_PAGES(DEFAULT_PAGE_ALLOCATION), DEFAULT_PAGE_ALLOCATION);\r
for (Index = 0; Index< DEFAULT_PAGE_ALLOCATION / sizeof(MEMORY_MAP); Index++) {\r
FreeDescriptorEntries[Index].Signature = MEMORY_MAP_SIGNATURE;\r
InsertTailList (&mFreeMemoryMapEntryList, &FreeDescriptorEntries[Index].Link);\r
- } \r
+ }\r
} else {\r
return NULL;\r
}\r
//\r
Entry = CR (mFreeMemoryMapEntryList.ForwardLink, MEMORY_MAP, Link, MEMORY_MAP_SIGNATURE);\r
RemoveEntryList (&Entry->Link);\r
- \r
+\r
return Entry;\r
-} \r
+}\r
\r
\r
/**\r
Internal function. Converts a memory range to the specified type.\r
The range must exist in the memory map.\r
\r
- @param Start The first address of the range Must be page \r
- aligned \r
- @param NumberOfPages The number of pages to convert \r
- @param NewType The new type for the memory range \r
+ @param Start The first address of the range Must be page\r
+ aligned\r
+ @param NumberOfPages The number of pages to convert\r
+ @param NewType The new type for the memory range\r
\r
- @retval EFI_INVALID_PARAMETER Invalid parameter \r
- @retval EFI_NOT_FOUND Could not find a descriptor cover the specified \r
- range or convertion not allowed. \r
- @retval EFI_SUCCESS Successfully converts the memory range to the \r
+ @retval EFI_INVALID_PARAMETER Invalid parameter\r
+ @retval EFI_NOT_FOUND Could not find a descriptor cover the specified\r
+ range or convertion not allowed.\r
+ @retval EFI_SUCCESS Successfully converts the memory range to the\r
specified type.\r
\r
**/\r
if (!(NewType == EfiConventionalMemory ? 1 : 0) ^ (Entry->Type == EfiConventionalMemory ? 1 : 0)) {\r
DEBUG ((DEBUG_ERROR , "ConvertPages: Incompatible memory types\n"));\r
return EFI_NOT_FOUND;\r
- } \r
+ }\r
\r
//\r
// Update counters for the number of pages allocated to each memory type\r
//\r
if (Entry->Type >= 0 && Entry->Type < EfiMaxMemoryType) {\r
- if (Start >= mMemoryTypeStatistics[Entry->Type].BaseAddress && \r
+ if (Start >= mMemoryTypeStatistics[Entry->Type].BaseAddress &&\r
Start <= mMemoryTypeStatistics[Entry->Type].MaximumAddress) {\r
if (NumberOfPages > mMemoryTypeStatistics[Entry->Type].CurrentNumberOfPages) {\r
mMemoryTypeStatistics[Entry->Type].CurrentNumberOfPages = 0;\r
if (NewType >= 0 && NewType < EfiMaxMemoryType) {\r
if (Start >= mMemoryTypeStatistics[NewType].BaseAddress && Start <= mMemoryTypeStatistics[NewType].MaximumAddress) {\r
mMemoryTypeStatistics[NewType].CurrentNumberOfPages += NumberOfPages;\r
- if (mMemoryTypeStatistics[NewType].CurrentNumberOfPages > \r
+ if (mMemoryTypeStatistics[NewType].CurrentNumberOfPages >\r
gMemoryTypeInformation[mMemoryTypeStatistics[NewType].InformationIndex].NumberOfPages) {\r
gMemoryTypeInformation[mMemoryTypeStatistics[NewType].InformationIndex].NumberOfPages = (UINT32)mMemoryTypeStatistics[NewType].CurrentNumberOfPages;\r
}\r
// Pull range out of descriptor\r
//\r
if (Entry->Start == Start) {\r
- \r
+\r
//\r
// Clip start\r
//\r
Entry->Start = RangeEnd + 1;\r
\r
} else if (Entry->End == RangeEnd) {\r
- \r
+\r
//\r
// Clip end\r
//\r
//\r
// Pull it out of the center, clip current\r
//\r
- \r
+\r
//\r
// Add a new one\r
//\r
}\r
\r
//\r
- // The new range inherits the same Attribute as the Entry \r
+ // The new range inherits the same Attribute as the Entry\r
//it is being cut out of\r
//\r
Attribute = Entry->Attribute;\r
RemoveMemoryMapEntry (Entry);\r
Entry = NULL;\r
}\r
- \r
+\r
//\r
// Add our new range in\r
//\r
Internal function. Finds a consecutive free page range below\r
the requested address.\r
\r
- @param MaxAddress The address that the range must be below \r
- @param NumberOfPages Number of pages needed \r
- @param NewType The type of memory the range is going to be \r
- turned into \r
- @param Alignment Bits to align with \r
+ @param MaxAddress The address that the range must be below\r
+ @param NumberOfPages Number of pages needed\r
+ @param NewType The type of memory the range is going to be\r
+ turned into\r
+ @param Alignment Bits to align with\r
\r
@return The base address of the range, or 0 if the range was not found\r
\r
}\r
\r
if ((MaxAddress & EFI_PAGE_MASK) != EFI_PAGE_MASK) {\r
- \r
+\r
//\r
// If MaxAddress is not aligned to the end of a page\r
//\r
- \r
+\r
//\r
// Change MaxAddress to be 1 page lower\r
//\r
MaxAddress -= (EFI_PAGE_MASK + 1);\r
- \r
+\r
//\r
// Set MaxAddress to a page boundary\r
//\r
MaxAddress &= ~EFI_PAGE_MASK;\r
- \r
+\r
//\r
// Set MaxAddress to end of the page\r
//\r
\r
for (Link = gMemoryMap.ForwardLink; Link != &gMemoryMap; Link = Link->ForwardLink) {\r
Entry = CR (Link, MEMORY_MAP, Link, MEMORY_MAP_SIGNATURE);\r
- \r
+\r
//\r
// If it's not a free entry, don't bother with it\r
//\r
DescEnd = ((DescEnd + 1) & (~(Alignment - 1))) - 1;\r
\r
//\r
- // Compute the number of bytes we can used from this \r
+ // Compute the number of bytes we can used from this\r
// descriptor, and see it's enough to satisfy the request\r
//\r
DescNumberOfBytes = DescEnd - DescStart + 1;\r
Target = DescEnd;\r
}\r
}\r
- } \r
+ }\r
\r
//\r
// If this is a grow down, adjust target to be the allocation base\r
Internal function. Finds a consecutive free page range below\r
the requested address\r
\r
- @param MaxAddress The address that the range must be below \r
- @param NoPages Number of pages needed \r
- @param NewType The type of memory the range is going to be \r
- turned into \r
- @param Alignment Bits to align with \r
+ @param MaxAddress The address that the range must be below\r
+ @param NoPages Number of pages needed\r
+ @param NewType The type of memory the range is going to be\r
+ turned into\r
+ @param Alignment Bits to align with\r
\r
@return The base address of the range, or 0 if the range was not found.\r
\r
/**\r
Allocates pages from the memory map.\r
\r
- @param Type The type of allocation to perform \r
- @param MemoryType The type of memory to turn the allocated pages \r
- into \r
- @param NumberOfPages The number of pages to allocate \r
- @param Memory A pointer to receive the base allocated memory \r
- address \r
+ @param Type The type of allocation to perform\r
+ @param MemoryType The type of memory to turn the allocated pages\r
+ into\r
+ @param NumberOfPages The number of pages to allocate\r
+ @param Memory A pointer to receive the base allocated memory\r
+ address\r
\r
@return Status. On success, Memory is filled in with the base address allocated\r
- @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in \r
- spec. \r
- @retval EFI_NOT_FOUND Could not allocate pages match the requirement. \r
- @retval EFI_OUT_OF_RESOURCES No enough pages to allocate. \r
+ @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in\r
+ spec.\r
+ @retval EFI_NOT_FOUND Could not allocate pages match the requirement.\r
+ @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.\r
@retval EFI_SUCCESS Pages successfully allocated.\r
\r
**/\r
NumberOfPages &= ~(EFI_SIZE_TO_PAGES (Alignment) - 1);\r
\r
//\r
- // If this is for below a particular address, then \r
+ // If this is for below a particular address, then\r
//\r
Start = *Memory;\r
- \r
+\r
//\r
// The max address is the max natively addressable address for the processor\r
//\r
MaxAddress = EFI_MAX_ADDRESS;\r
- \r
+\r
if (Type == AllocateMaxAddress) {\r
MaxAddress = Start;\r
}\r
\r
CoreAcquireMemoryLock ();\r
- \r
+\r
//\r
// If not a specific address, then find an address to allocate\r
//\r
/**\r
Frees previous allocated pages.\r
\r
- @param Memory Base address of memory being freed \r
- @param NumberOfPages The number of pages to free \r
+ @param Memory Base address of memory being freed\r
+ @param NumberOfPages The number of pages to free\r
\r
- @retval EFI_NOT_FOUND Could not find the entry that covers the range \r
- @retval EFI_INVALID_PARAMETER Address not aligned \r
+ @retval EFI_NOT_FOUND Could not find the entry that covers the range\r
+ @retval EFI_INVALID_PARAMETER Address not aligned\r
@return EFI_SUCCESS -Pages successfully freed.\r
\r
**/\r
-EFI_STATUS \r
+EFI_STATUS\r
EFIAPI\r
CoreFreePages (\r
IN EFI_PHYSICAL_ADDRESS Memory,\r
if (Memory < EFI_MAX_ADDRESS) {\r
DEBUG_CLEAR_MEMORY ((VOID *)(UINTN)Memory, NumberOfPages << EFI_PAGE_SHIFT);\r
}\r
- \r
+\r
return Status;\r
}\r
\r
This function returns a copy of the current memory map. The map is an array of\r
memory descriptors, each of which describes a contiguous block of memory.\r
\r
- @param MemoryMapSize A pointer to the size, in bytes, of the \r
- MemoryMap buffer. On input, this is the size of \r
- the buffer allocated by the caller. On output, \r
- it is the size of the buffer returned by the \r
- firmware if the buffer was large enough, or the \r
- size of the buffer needed to contain the map if \r
- the buffer was too small. \r
- @param MemoryMap A pointer to the buffer in which firmware places \r
- the current memory map. \r
- @param MapKey A pointer to the location in which firmware \r
- returns the key for the current memory map. \r
- @param DescriptorSize A pointer to the location in which firmware \r
- returns the size, in bytes, of an individual \r
- EFI_MEMORY_DESCRIPTOR. \r
- @param DescriptorVersion A pointer to the location in which firmware \r
- returns the version number associated with the \r
- EFI_MEMORY_DESCRIPTOR. \r
-\r
- @retval EFI_SUCCESS The memory map was returned in the MemoryMap \r
- buffer. \r
- @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current \r
- buffer size needed to hold the memory map is \r
- returned in MemoryMapSize. \r
+ @param MemoryMapSize A pointer to the size, in bytes, of the\r
+ MemoryMap buffer. On input, this is the size of\r
+ the buffer allocated by the caller. On output,\r
+ it is the size of the buffer returned by the\r
+ firmware if the buffer was large enough, or the\r
+ size of the buffer needed to contain the map if\r
+ the buffer was too small.\r
+ @param MemoryMap A pointer to the buffer in which firmware places\r
+ the current memory map.\r
+ @param MapKey A pointer to the location in which firmware\r
+ returns the key for the current memory map.\r
+ @param DescriptorSize A pointer to the location in which firmware\r
+ returns the size, in bytes, of an individual\r
+ EFI_MEMORY_DESCRIPTOR.\r
+ @param DescriptorVersion A pointer to the location in which firmware\r
+ returns the version number associated with the\r
+ EFI_MEMORY_DESCRIPTOR.\r
+\r
+ @retval EFI_SUCCESS The memory map was returned in the MemoryMap\r
+ buffer.\r
+ @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current\r
+ buffer size needed to hold the memory map is\r
+ returned in MemoryMapSize.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
\r
**/\r
)\r
{\r
EFI_STATUS Status;\r
- UINTN Size; \r
- UINTN BufferSize; \r
+ UINTN Size;\r
+ UINTN BufferSize;\r
UINTN NumberOfRuntimeEntries;\r
LIST_ENTRY *Link;\r
- MEMORY_MAP *Entry; \r
- EFI_GCD_MAP_ENTRY *GcdMapEntry; \r
+ MEMORY_MAP *Entry;\r
+ EFI_GCD_MAP_ENTRY *GcdMapEntry;\r
EFI_MEMORY_TYPE Type;\r
\r
//\r
if (MemoryMapSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
CoreAcquireGcdMemoryLock ();\r
- \r
+\r
//\r
// Count the number of Reserved and MMIO entries that are marked for runtime use\r
//\r
if (DescriptorSize != NULL) {\r
*DescriptorSize = Size;\r
}\r
- \r
+\r
if (DescriptorVersion != NULL) {\r
*DescriptorVersion = EFI_MEMORY_DESCRIPTOR_VERSION;\r
}\r
MemoryMap->NumberOfPages = RShiftU64 (Entry->End - Entry->Start + 1, EFI_PAGE_SHIFT);\r
//\r
// If the memory type is EfiConventionalMemory, then determine if the range is part of a\r
- // memory type bin and needs to be converted to the same memory type as the rest of the \r
- // memory type bin in order to minimize EFI Memory Map changes across reboots. This \r
+ // memory type bin and needs to be converted to the same memory type as the rest of the\r
+ // memory type bin in order to minimize EFI Memory Map changes across reboots. This\r
// improves the chances for a successful S4 resume in the presence of minor page allocation\r
// differences across reboots.\r
//\r
if (mMemoryTypeStatistics[MemoryMap->Type].Runtime) {\r
MemoryMap->Attribute |= EFI_MEMORY_RUNTIME;\r
}\r
- \r
+\r
MemoryMap = NextMemoryDescriptor (MemoryMap, Size);\r
}\r
\r
if ((GcdMapEntry->GcdMemoryType == EfiGcdMemoryTypeReserved) ||\r
(GcdMapEntry->GcdMemoryType == EfiGcdMemoryTypeMemoryMappedIo)) {\r
if ((GcdMapEntry->Attributes & EFI_MEMORY_RUNTIME) == EFI_MEMORY_RUNTIME) {\r
- \r
+\r
MemoryMap->PhysicalStart = GcdMapEntry->BaseAddress;\r
MemoryMap->VirtualStart = 0;\r
MemoryMap->NumberOfPages = RShiftU64 ((GcdMapEntry->EndAddress - GcdMapEntry->BaseAddress + 1), EFI_PAGE_SHIFT);\r
}\r
}\r
}\r
- \r
+\r
Status = EFI_SUCCESS;\r
\r
Done:\r
\r
CoreReleaseMemoryLock ();\r
- \r
+\r
CoreReleaseGcdMemoryLock ();\r
- \r
- // \r
- // Update the map key finally \r
- // \r
+\r
+ //\r
+ // Update the map key finally\r
+ //\r
if (MapKey != NULL) {\r
*MapKey = mMemoryMapKey;\r
}\r
- \r
+\r
*MemoryMapSize = BufferSize;\r
- \r
+\r
return Status;\r
}\r
\r
Internal function. Used by the pool functions to allocate pages\r
to back pool allocation requests.\r
\r
- @param PoolType The type of memory for the new pool pages \r
- @param NumberOfPages No of pages to allocate \r
- @param Alignment Bits to align. \r
+ @param PoolType The type of memory for the new pool pages\r
+ @param NumberOfPages No of pages to allocate\r
+ @param Alignment Bits to align.\r
\r
@return The allocated memory, or NULL\r
\r
/**\r
Internal function. Frees pool pages allocated via AllocatePoolPages ()\r
\r
- @param Memory The base address to free \r
+ @param Memory The base address to free\r
@param NumberOfPages The number of pages to free\r
\r
**/\r
Make sure the memory map is following all the construction rules,\r
it is the last time to check memory map error before exit boot services.\r
\r
- @param MapKey Memory map key \r
+ @param MapKey Memory map key\r
\r
- @retval EFI_INVALID_PARAMETER Memory map not consistent with construction \r
- rules. \r
+ @retval EFI_INVALID_PARAMETER Memory map not consistent with construction\r
+ rules.\r
@retval EFI_SUCCESS Valid memory map.\r
\r
**/\r
\r
for (Link = gMemoryMap.ForwardLink; Link != &gMemoryMap; Link = Link->ForwardLink) {\r
Entry = CR(Link, MEMORY_MAP, Link, MEMORY_MAP_SIGNATURE);\r
- if (Entry->Attribute & EFI_MEMORY_RUNTIME) { \r
+ if (Entry->Attribute & EFI_MEMORY_RUNTIME) {\r
if (Entry->Type == EfiACPIReclaimMemory || Entry->Type == EfiACPIMemoryNVS) {\r
DEBUG((DEBUG_ERROR, "ExitBootServices: ACPI memory entry has RUNTIME attribute set.\n"));\r
CoreReleaseMemoryLock ();\r
EFI_MEMORY_TYPE MemoryType;\r
LIST_ENTRY FreeList[MAX_POOL_LIST];\r
LIST_ENTRY Link;\r
-} POOL; \r
+} POOL;\r
\r
//\r
// Pool header for each memory type.\r
/**\r
Look up pool head for specified memory type.\r
\r
- @param MemoryType Memory type of which pool head is looked for \r
+ @param MemoryType Memory type of which pool head is looked for\r
\r
@return Pointer of Corresponding pool head.\r
\r
return NULL;\r
}\r
\r
- \r
+\r
\r
/**\r
Allocate pool of a particular type.\r
\r
- @param PoolType Type of pool to allocate \r
- @param Size The amount of pool to allocate \r
- @param Buffer The address to return a pointer to the allocated \r
- pool \r
+ @param PoolType Type of pool to allocate\r
+ @param Size The amount of pool to allocate\r
+ @param Buffer The address to return a pointer to the allocated\r
+ pool\r
\r
- @retval EFI_INVALID_PARAMETER PoolType not valid \r
- @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed. \r
+ @retval EFI_INVALID_PARAMETER PoolType not valid\r
+ @retval EFI_OUT_OF_RESOURCES Size exceeds max pool size or allocation failed.\r
@retval EFI_SUCCESS Pool successfully allocated.\r
\r
**/\r
PoolType == EfiConventionalMemory) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
*Buffer = NULL;\r
- \r
+\r
//\r
// If size is too large, fail it\r
// Base on the EFI spec, return status of EFI_OUT_OF_RESOURCES\r
Internal function to allocate pool of a particular type.\r
Caller must have the memory lock held\r
\r
- @param PoolType Type of pool to allocate \r
- @param Size The amount of pool to allocate \r
+ @param PoolType Type of pool to allocate\r
+ @param Size The amount of pool to allocate\r
\r
@return The allocate pool, or NULL\r
\r
//\r
// Adjust the size by the pool header & tail overhead\r
//\r
- \r
+\r
//\r
// Adjusting the Size to be of proper alignment so that\r
// we don't get an unaligned access fault later when\r
FSize = LIST_TO_SIZE(Index);\r
\r
while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
- Free = (POOL_FREE *) &NewPage[Offset]; \r
+ Free = (POOL_FREE *) &NewPage[Offset];\r
Free->Signature = POOL_FREE_SIGNATURE;\r
Free->Index = (UINT32)Index;\r
InsertHeadList (&Pool->FreeList[Index], &Free->Link);\r
Buffer = NULL;\r
\r
if (Head != NULL) {\r
- \r
+\r
//\r
// If we have a pool buffer, fill in the header & tail info\r
//\r
\r
DEBUG ((\r
DEBUG_POOL,\r
- "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n", PoolType, \r
- Buffer, \r
- Size - POOL_OVERHEAD, \r
+ "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n", PoolType,\r
+ Buffer,\r
+ Size - POOL_OVERHEAD,\r
Pool->Used\r
));\r
\r
\r
return Buffer;\r
}\r
- \r
+\r
\r
\r
/**\r
Frees pool.\r
\r
- @param Buffer The allocated pool entry to free \r
+ @param Buffer The allocated pool entry to free\r
\r
- @retval EFI_INVALID_PARAMETER Buffer is not a valid value. \r
+ @retval EFI_INVALID_PARAMETER Buffer is not a valid value.\r
@retval EFI_SUCCESS Pool successfully freed.\r
\r
**/\r
Internal function to free a pool entry.\r
Caller must have the memory lock held\r
\r
- @param Buffer The allocated pool entry to free \r
+ @param Buffer The allocated pool entry to free\r
\r
- @retval EFI_INVALID_PARAMETER Buffer not valid \r
+ @retval EFI_INVALID_PARAMETER Buffer not valid\r
@retval EFI_SUCCESS Buffer successfully freed.\r
\r
**/\r
DEBUG ((DEBUG_POOL, "FreePool: %x (len %x) %,d\n", Head->Data, Head->Size - POOL_OVERHEAD, Pool->Used));\r
\r
//\r
- // Determine the pool list \r
+ // Determine the pool list\r
//\r
Index = SIZE_TO_LIST(Size);\r
DEBUG_CLEAR_MEMORY (Head, Size);\r
InsertHeadList (&Pool->FreeList[Index], &Free->Link);\r
\r
//\r
- // See if all the pool entries in the same page as Free are freed pool \r
+ // See if all the pool entries in the same page as Free are freed pool\r
// entries\r
//\r
NewPage = (CHAR8 *)((UINTN)Free & ~((DEFAULT_PAGE_ALLOCATION) -1));\r
\r
AllFree = TRUE;\r
Offset = 0;\r
- \r
+\r
while ((Offset < DEFAULT_PAGE_ALLOCATION) && (AllFree)) {\r
FSize = LIST_TO_SIZE(Index);\r
while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
if (AllFree) {\r
\r
//\r
- // All of the pool entries in the same page as Free are free pool \r
+ // All of the pool entries in the same page as Free are free pool\r
// entries\r
// Remove all of these pool entries from the free loop lists.\r
//\r
ASSERT(NULL != Free);\r
Index = Free->Index;\r
Offset = 0;\r
- \r
+\r
while (Offset < DEFAULT_PAGE_ALLOCATION) {\r
FSize = LIST_TO_SIZE(Index);\r
while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
}\r
\r
//\r
- // If this is an OS specific memory type, then check to see if the last \r
+ // If this is an OS specific memory type, then check to see if the last\r
// portion of that memory type has been freed. If it has, then free the\r
// list entry for that memory type\r
//\r
\r
EFI_SYSTEM_TABLE_POINTER *mDebugTable = NULL;\r
\r
- \r
+\r
\r
/**\r
Creates and initializes the DebugImageInfo Table. Also creates the configuration\r
CoreInitializeDebugImageInfoTable (\r
VOID\r
)\r
-{ \r
+{\r
EFI_STATUS Status;\r
EFI_PHYSICAL_ADDRESS Mem;\r
- UINTN NumberOfPages; \r
+ UINTN NumberOfPages;\r
\r
//\r
// Allocate boot services memory for the structure. It's required to be aligned on\r
// a 4M aligned address within the memory we just freed, and then allocate memory at that\r
// address for our initial structure.\r
//\r
- NumberOfPages = FOUR_MEG_PAGES + EFI_SIZE_TO_PAGES(sizeof (EFI_SYSTEM_TABLE_POINTER)); \r
+ NumberOfPages = FOUR_MEG_PAGES + EFI_SIZE_TO_PAGES(sizeof (EFI_SYSTEM_TABLE_POINTER));\r
\r
- Status = CoreAllocatePages (AllocateAnyPages, EfiBootServicesData, NumberOfPages , &Mem); \r
+ Status = CoreAllocatePages (AllocateAnyPages, EfiBootServicesData, NumberOfPages , &Mem);\r
ASSERT_EFI_ERROR (Status);\r
if (EFI_ERROR(Status)) {\r
return;\r
}\r
- Status = CoreFreePages (Mem, NumberOfPages); \r
+ Status = CoreFreePages (Mem, NumberOfPages);\r
ASSERT_EFI_ERROR (Status);\r
if (EFI_ERROR(Status)) {\r
return;\r
// Then allocate memory at that address\r
//\r
Mem = (Mem + FOUR_MEG_MASK) & (~FOUR_MEG_MASK);\r
- \r
- Status = CoreAllocatePages (AllocateAddress, EfiBootServicesData, NumberOfPages - FOUR_MEG_PAGES, &Mem); \r
+\r
+ Status = CoreAllocatePages (AllocateAddress, EfiBootServicesData, NumberOfPages - FOUR_MEG_PAGES, &Mem);\r
ASSERT_EFI_ERROR (Status);\r
if (EFI_ERROR(Status)) {\r
return;\r
Adds a new DebugImageInfo structure to the DebugImageInfo Table. Re-Allocates\r
the table if it's not large enough to accomidate another entry.\r
\r
- @param ImageInfoType type of debug image information \r
- @param LoadedImage pointer to the loaded image protocol for the image being \r
- loaded \r
+ @param ImageInfoType type of debug image information\r
+ @param LoadedImage pointer to the loaded image protocol for the image being\r
+ loaded\r
@param ImageHandle image handle for the image being loaded\r
\r
**/\r
IN EFI_LOADED_IMAGE_PROTOCOL *LoadedImage,\r
IN EFI_HANDLE ImageHandle\r
)\r
-{ \r
+{\r
EFI_DEBUG_IMAGE_INFO *Table;\r
EFI_DEBUG_IMAGE_INFO *NewTable;\r
UINTN Index;\r
CoreRemoveDebugImageInfoEntry (\r
EFI_HANDLE ImageHandle\r
)\r
-{ \r
+{\r
EFI_DEBUG_IMAGE_INFO *Table;\r
UINTN Index;\r
\r
/**\r
Find a config table by name in system table's ConfigurationTable.\r
\r
- @param Guid The table name to look for \r
- @param Table Pointer of the config table \r
+ @param Guid The table name to look for\r
+ @param Table Pointer of the config table\r
\r
- @retval EFI_NOT_FOUND Could not find the table in system table's \r
- ConfigurationTable. \r
+ @retval EFI_NOT_FOUND Could not find the table in system table's\r
+ ConfigurationTable.\r
@retval EFI_SUCCESS Table successfully found.\r
\r
**/\r
Boot Service called to add, modify, or remove a system configuration table from\r
the EFI System Table.\r
\r
- @param Guid Pointer to the GUID for the entry to add, update, or \r
- remove \r
- @param Table Pointer to the configuration table for the entry to add, \r
- update, or remove, may be NULL. \r
+ @param Guid Pointer to the GUID for the entry to add, update, or\r
+ remove\r
+ @param Table Pointer to the configuration table for the entry to add,\r
+ update, or remove, may be NULL.\r
\r
@return EFI_SUCCESS Guid, Table pair added, updated, or removed.\r
@return EFI_INVALID_PARAMETER Input GUID not valid.\r
\r
@param Microseconds The number of microseconds to stall execution.\r
\r
- @retval EFI_SUCCESS Execution was stalled for at least the requested \r
- amount of microseconds. \r
+ @retval EFI_SUCCESS Execution was stalled for at least the requested\r
+ amount of microseconds.\r
@retval EFI_NOT_AVAILABLE_YET gMetronome is not available yet\r
\r
**/\r
/** @file\r
Section Extraction Protocol implementation.\r
- \r
+\r
Stream database is implemented as a linked list of section streams,\r
where each stream contains a linked list of children, which may be leaves or\r
- encapsulations. \r
- \r
+ encapsulations.\r
+\r
Children that are encapsulations generate new stream entries\r
- when they are created. Streams can also be created by calls to \r
+ when they are created. Streams can also be created by calls to\r
SEP->OpenSectionStream().\r
- \r
+\r
The database is only created far enough to return the requested data from\r
any given stream, or to determine that the requested data is not found.\r
- \r
+\r
If a GUIDed encapsulation is encountered, there are three possiblilites.\r
- \r
+\r
1) A support protocol is found, in which the stream is simply processed with\r
the support protocol.\r
- \r
+\r
2) A support protocol is not found, but the data is available to be read\r
without processing. In this case, the database is built up through the\r
recursions to return the data, and a RPN event is set that will enable\r
the stream in question to be refreshed if and when the required section\r
- extraction protocol is published.This insures the AuthenticationStatus \r
+ extraction protocol is published.This insures the AuthenticationStatus\r
does not become stale in the cache.\r
- \r
+\r
3) A support protocol is not found, and the data is not available to be read\r
without it. This results in EFI_PROTOCOL_ERROR.\r
\r
VOID *Registration;\r
EFI_EVENT Event;\r
} RPN_EVENT_CONTEXT;\r
- \r
- \r
+\r
+\r
\r
//\r
// Local prototypes\r
/**\r
Worker function. Determine if the input stream:child matches the input type.\r
\r
- @param Stream Indicates the section stream associated with the \r
- child \r
- @param Child Indicates the child to check \r
- @param SearchType Indicates the type of section to check against \r
- for \r
- @param SectionDefinitionGuid Indicates the GUID to check against if the type \r
- is EFI_SECTION_GUID_DEFINED \r
+ @param Stream Indicates the section stream associated with the\r
+ child\r
+ @param Child Indicates the child to check\r
+ @param SearchType Indicates the type of section to check against\r
+ for\r
+ @param SectionDefinitionGuid Indicates the GUID to check against if the type\r
+ is EFI_SECTION_GUID_DEFINED\r
\r
- @retval TRUE The child matches \r
+ @retval TRUE The child matches\r
@retval FALSE The child doesn't match\r
\r
**/\r
/**\r
Worker function. Search stream database for requested stream handle.\r
\r
- @param SearchHandle Indicates which stream to look for. \r
- @param FoundStream Output pointer to the found stream. \r
+ @param SearchHandle Indicates which stream to look for.\r
+ @param FoundStream Output pointer to the found stream.\r
\r
- @retval EFI_SUCCESS StreamHandle was found and *FoundStream contains \r
- the stream node. \r
- @retval EFI_NOT_FOUND SearchHandle was not found in the stream \r
+ @retval EFI_SUCCESS StreamHandle was found and *FoundStream contains\r
+ the stream node.\r
+ @retval EFI_NOT_FOUND SearchHandle was not found in the stream\r
database.\r
\r
**/\r
IN UINTN SearchHandle,\r
OUT CORE_SECTION_STREAM_NODE **FoundStream\r
);\r
- \r
+\r
\r
/**\r
Worker function Recursively searches / builds section stream database\r
looking for requested section.\r
\r
- @param SourceStream Indicates the section stream in which to do the \r
- search. \r
- @param SearchType Indicates the type of section to search for. \r
- @param SectionInstance Indicates which instance of section to find. \r
- This is an in/out parameter to deal with \r
- recursions. \r
- @param SectionDefinitionGuid Guid of section definition \r
- @param FoundChild Output indicating the child node that is found. \r
- @param FoundStream Output indicating which section stream the child \r
- was found in. If this stream was generated as a \r
- result of an encapsulation section, the \r
- streamhandle is visible within the SEP driver \r
+ @param SourceStream Indicates the section stream in which to do the\r
+ search.\r
+ @param SearchType Indicates the type of section to search for.\r
+ @param SectionInstance Indicates which instance of section to find.\r
+ This is an in/out parameter to deal with\r
+ recursions.\r
+ @param SectionDefinitionGuid Guid of section definition\r
+ @param FoundChild Output indicating the child node that is found.\r
+ @param FoundStream Output indicating which section stream the child\r
+ was found in. If this stream was generated as a\r
+ result of an encapsulation section, the\r
+ streamhandle is visible within the SEP driver\r
only.\r
- @param AuthenticationStatus Indicates the authentication status of the found section. \r
+ @param AuthenticationStatus Indicates the authentication status of the found section.\r
\r
- @retval EFI_SUCCESS Child node was found and returned. \r
- EFI_OUT_OF_RESOURCES- Memory allocation failed. \r
- @retval EFI_NOT_FOUND Requested child node does not exist. \r
- @retval EFI_PROTOCOL_ERROR a required GUIDED section extraction protocol \r
+ @retval EFI_SUCCESS Child node was found and returned.\r
+ EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_NOT_FOUND Requested child node does not exist.\r
+ @retval EFI_PROTOCOL_ERROR a required GUIDED section extraction protocol\r
does not exist\r
\r
**/\r
OUT CORE_SECTION_STREAM_NODE **FoundStream,\r
OUT UINT32 *AuthenticationStatus\r
);\r
- \r
+\r
\r
/**\r
Worker function. Constructor for new child nodes.\r
\r
- @param Stream Indicates the section stream in which to add the \r
- child. \r
- @param ChildOffset Indicates the offset in Stream that is the \r
- beginning of the child section. \r
- @param ChildNode Indicates the Callee allocated and initialized \r
- child. \r
-\r
- @retval EFI_SUCCESS Child node was found and returned. \r
- EFI_OUT_OF_RESOURCES- Memory allocation failed. \r
- @retval EFI_PROTOCOL_ERROR Encapsulation sections produce new stream \r
- handles when the child node is created. If the \r
- section type is GUID defined, and the extraction \r
- GUID does not exist, and producing the stream \r
- requires the GUID, then a protocol error is \r
- generated and no child is produced. Values \r
+ @param Stream Indicates the section stream in which to add the\r
+ child.\r
+ @param ChildOffset Indicates the offset in Stream that is the\r
+ beginning of the child section.\r
+ @param ChildNode Indicates the Callee allocated and initialized\r
+ child.\r
+\r
+ @retval EFI_SUCCESS Child node was found and returned.\r
+ EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_PROTOCOL_ERROR Encapsulation sections produce new stream\r
+ handles when the child node is created. If the\r
+ section type is GUID defined, and the extraction\r
+ GUID does not exist, and producing the stream\r
+ requires the GUID, then a protocol error is\r
+ generated and no child is produced. Values\r
returned by OpenSectionStreamEx.\r
\r
**/\r
IN UINT32 ChildOffset,\r
OUT CORE_SECTION_CHILD_NODE **ChildNode\r
);\r
- \r
+\r
\r
/**\r
Worker function. Destructor for child nodes.\r
/**\r
Worker function. Constructor for section streams.\r
\r
- @param SectionStreamLength Size in bytes of the section stream. \r
- @param SectionStream Buffer containing the new section stream. \r
- @param AllocateBuffer Indicates whether the stream buffer is to be \r
- copied or the input buffer is to be used in \r
- place. AuthenticationStatus- Indicates the \r
- default authentication status for the new \r
- stream. \r
+ @param SectionStreamLength Size in bytes of the section stream.\r
+ @param SectionStream Buffer containing the new section stream.\r
+ @param AllocateBuffer Indicates whether the stream buffer is to be\r
+ copied or the input buffer is to be used in\r
+ place. AuthenticationStatus- Indicates the\r
+ default authentication status for the new\r
+ stream.\r
@param AuthenticationStatus A pointer to a caller-allocated UINT32 that\r
indicates the authentication status of the\r
output buffer. If the input section's\r
function returns anything other than\r
EFI_SUCCESS, the value of *AuthenticationStatus\r
is undefined.\r
- @param SectionStreamHandle A pointer to a caller allocated section stream \r
- handle. \r
+ @param SectionStreamHandle A pointer to a caller allocated section stream\r
+ handle.\r
\r
- @retval EFI_SUCCESS Stream was added to stream database. \r
+ @retval EFI_SUCCESS Stream was added to stream database.\r
@retval EFI_OUT_OF_RESOURCES memory allocation failed.\r
\r
**/\r
IN UINTN SectionStreamLength,\r
IN VOID *SectionStream,\r
IN BOOLEAN AllocateBuffer,\r
- IN UINT32 AuthenticationStatus, \r
+ IN UINT32 AuthenticationStatus,\r
OUT UINTN *SectionStreamHandle\r
);\r
\r
/**\r
Check if a stream is valid.\r
\r
- @param SectionStream The section stream to be checked \r
- @param SectionStreamLength The length of section stream \r
+ @param SectionStream The section stream to be checked\r
+ @param SectionStreamLength The length of section stream\r
\r
@return A boolean value indicating the validness of the section stream.\r
\r
EFI_TPL above TPL_NOTIFY is undefined. Type EFI_TPL is\r
defined in RaiseTPL() in the UEFI 2.0 specification.\r
\r
- \r
+\r
@param This Indicates the\r
EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
@param InputSection Buffer containing the input GUIDed section\r
is stored. If the function returns\r
anything other than EFI_SUCCESS, the value\r
of OutputSize is undefined.\r
+\r
@param AuthenticationStatus A pointer to a caller-allocated\r
UINT32 that indicates the\r
authentication status of the\r
OUT VOID **OutputBuffer,\r
OUT UINTN *OutputSize,\r
OUT UINT32 *AuthenticationStatus\r
- ); \r
+ );\r
\r
//\r
// Module globals\r
EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL mCustomGuidedSectionExtractionProtocol = {\r
CustomGuidedSectionExtract\r
};\r
- \r
+\r
\r
/**\r
Entry point of the section extraction code. Initializes an instance of the\r
UINTN ExtractHandlerNumber;\r
\r
//\r
- // Get custom extract guided section method guid list \r
+ // Get custom extract guided section method guid list\r
//\r
ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
- \r
+\r
Status = EFI_SUCCESS;\r
//\r
- // Install custom guided extraction protocol \r
+ // Install custom guided extraction protocol\r
//\r
while (ExtractHandlerNumber-- > 0) {\r
Status = CoreInstallProtocolInterface (\r
SEP member function. This function creates and returns a new section stream\r
handle to represent the new section stream.\r
\r
- @param SectionStreamLength Size in bytes of the section stream. \r
- @param SectionStream Buffer containing the new section stream. \r
- @param SectionStreamHandle A pointer to a caller allocated UINTN that on \r
- output contains the new section stream handle. \r
+ @param SectionStreamLength Size in bytes of the section stream.\r
+ @param SectionStream Buffer containing the new section stream.\r
+ @param SectionStreamHandle A pointer to a caller allocated UINTN that on\r
+ output contains the new section stream handle.\r
\r
@retval EFI_SUCCESS The section stream is created successfully.\r
- @retval EFI_OUT_OF_RESOURCES memory allocation failed. \r
- @retval EFI_INVALID_PARAMETER Section stream does not end concident with end \r
+ @retval EFI_OUT_OF_RESOURCES memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER Section stream does not end concident with end\r
of last section.\r
\r
**/\r
if (!IsValidSectionStream (SectionStream, SectionStreamLength)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
- return OpenSectionStreamEx ( \r
- SectionStreamLength, \r
+\r
+ return OpenSectionStreamEx (\r
+ SectionStreamLength,\r
SectionStream,\r
TRUE,\r
0,\r
SectionStreamHandle\r
);\r
}\r
- \r
+\r
\r
/**\r
SEP member function. Retrieves requested section from section stream.\r
UINTN Instance;\r
UINT8 *CopyBuffer;\r
UINTN SectionSize;\r
- \r
+\r
\r
OldTpl = CoreRaiseTpl (TPL_NOTIFY);\r
Instance = SectionInstance + 1;\r
- \r
+\r
//\r
// Locate target stream\r
//\r
Status = EFI_INVALID_PARAMETER;\r
goto GetSection_Done;\r
}\r
- \r
+\r
//\r
// Found the stream, now locate and return the appropriate section\r
//\r
// There's a requested section type, so go find it and return it...\r
//\r
Status = FindChildNode (\r
- StreamNode, \r
- *SectionType, \r
- &Instance, \r
+ StreamNode,\r
+ *SectionType,\r
+ &Instance,\r
SectionDefinitionGuid,\r
&ChildNode,\r
- &ChildStreamNode, \r
+ &ChildStreamNode,\r
&ExtractedAuthenticationStatus\r
);\r
if (EFI_ERROR (Status)) {\r
CopySize = ChildNode->Size - sizeof (EFI_COMMON_SECTION_HEADER);\r
CopyBuffer = ChildStreamNode->StreamBuffer + ChildNode->OffsetInStream + sizeof (EFI_COMMON_SECTION_HEADER);\r
*AuthenticationStatus = ExtractedAuthenticationStatus;\r
- } \r
- \r
- SectionSize = CopySize; \r
+ }\r
+\r
+ SectionSize = CopySize;\r
if (*Buffer != NULL) {\r
//\r
// Caller allocated buffer. Fill to size and return required size...\r
}\r
CopyMem (*Buffer, CopyBuffer, CopySize);\r
*BufferSize = SectionSize;\r
- \r
+\r
GetSection_Done:\r
CoreRestoreTpl (OldTpl);\r
- \r
+\r
return Status;\r
}\r
\r
/**\r
SEP member function. Deletes an existing section stream\r
\r
- @param StreamHandleToClose Indicates the stream to close \r
+ @param StreamHandleToClose Indicates the stream to close\r
\r
@retval EFI_SUCCESS The section stream is closed sucessfully.\r
- @retval EFI_OUT_OF_RESOURCES Memory allocation failed. \r
- @retval EFI_INVALID_PARAMETER Section stream does not end concident with end \r
+ @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER Section stream does not end concident with end\r
of last section.\r
\r
**/\r
EFI_STATUS Status;\r
LIST_ENTRY *Link;\r
CORE_SECTION_CHILD_NODE *ChildNode;\r
- \r
+\r
OldTpl = CoreRaiseTpl (TPL_NOTIFY);\r
- \r
+\r
//\r
// Locate target stream\r
//\r
} else {\r
Status = EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
CoreRestoreTpl (OldTpl);\r
return Status;\r
}\r
/**\r
Worker function. Determine if the input stream:child matches the input type.\r
\r
- @param Stream Indicates the section stream associated with the \r
- child \r
- @param Child Indicates the child to check \r
- @param SearchType Indicates the type of section to check against \r
- for \r
- @param SectionDefinitionGuid Indicates the GUID to check against if the type \r
- is EFI_SECTION_GUID_DEFINED \r
+ @param Stream Indicates the section stream associated with the\r
+ child\r
+ @param Child Indicates the child to check\r
+ @param SearchType Indicates the type of section to check against\r
+ for\r
+ @param SectionDefinitionGuid Indicates the GUID to check against if the type\r
+ is EFI_SECTION_GUID_DEFINED\r
\r
- @retval TRUE The child matches \r
+ @retval TRUE The child matches\r
@retval FALSE The child doesn't match\r
\r
**/\r
)\r
{\r
EFI_GUID_DEFINED_SECTION *GuidedSection;\r
- \r
+\r
if (SearchType == EFI_SECTION_ALL) {\r
return TRUE;\r
}\r
Worker function Recursively searches / builds section stream database\r
looking for requested section.\r
\r
- @param SourceStream Indicates the section stream in which to do the \r
- search. \r
- @param SearchType Indicates the type of section to search for. \r
- @param SectionInstance Indicates which instance of section to find. \r
- This is an in/out parameter to deal with \r
- recursions. \r
- @param SectionDefinitionGuid Guid of section definition \r
- @param FoundChild Output indicating the child node that is found. \r
- @param FoundStream Output indicating which section stream the child \r
- was found in. If this stream was generated as a \r
- result of an encapsulation section, the \r
- streamhandle is visible within the SEP driver \r
+ @param SourceStream Indicates the section stream in which to do the\r
+ search.\r
+ @param SearchType Indicates the type of section to search for.\r
+ @param SectionInstance Indicates which instance of section to find.\r
+ This is an in/out parameter to deal with\r
+ recursions.\r
+ @param SectionDefinitionGuid Guid of section definition\r
+ @param FoundChild Output indicating the child node that is found.\r
+ @param FoundStream Output indicating which section stream the child\r
+ was found in. If this stream was generated as a\r
+ result of an encapsulation section, the\r
+ streamhandle is visible within the SEP driver\r
only.\r
- @param AuthenticationStatus Indicates the authentication status of the found section. \r
+ @param AuthenticationStatus Indicates the authentication status of the found section.\r
\r
- @retval EFI_SUCCESS Child node was found and returned. \r
- EFI_OUT_OF_RESOURCES- Memory allocation failed. \r
- @retval EFI_NOT_FOUND Requested child node does not exist. \r
- @retval EFI_PROTOCOL_ERROR a required GUIDED section extraction protocol \r
+ @retval EFI_SUCCESS Child node was found and returned.\r
+ EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_NOT_FOUND Requested child node does not exist.\r
+ @retval EFI_PROTOCOL_ERROR a required GUIDED section extraction protocol\r
does not exist\r
\r
**/\r
UINT32 NextChildOffset;\r
EFI_STATUS ErrorStatus;\r
EFI_STATUS Status;\r
- \r
+\r
CurrentChildNode = NULL;\r
ErrorStatus = EFI_NOT_FOUND;\r
- \r
+\r
if (SourceStream->StreamLength == 0) {\r
return EFI_NOT_FOUND;\r
}\r
- \r
- if (IsListEmpty (&SourceStream->Children) && \r
+\r
+ if (IsListEmpty (&SourceStream->Children) &&\r
SourceStream->StreamLength >= sizeof (EFI_COMMON_SECTION_HEADER)) {\r
//\r
// This occurs when a section stream exists, but no child sections\r
// have been parsed out yet. Therefore, extract the first child and add it\r
// to the list of children so we can get started.\r
- // Section stream may contain an array of zero or more bytes. \r
+ // Section stream may contain an array of zero or more bytes.\r
// So, its size should be >= the size of commen section header.\r
//\r
Status = CreateChildNode (SourceStream, 0, &CurrentChildNode);\r
return Status;\r
}\r
}\r
- \r
+\r
//\r
// At least one child has been parsed out of the section stream. So, walk\r
// through the sections that have already been parsed out looking for the\r
return EFI_SUCCESS;\r
}\r
}\r
- \r
+\r
if (CurrentChildNode->EncapsulatedStreamHandle != NULL_STREAM_HANDLE) {\r
//\r
// If the current node is an encapsulating node, recurse into it...\r
ErrorStatus = Status;\r
}\r
}\r
- \r
+\r
if (!IsNodeAtEnd (&SourceStream->Children, &CurrentChildNode->Link)) {\r
//\r
// We haven't found the child node we're interested in yet, but there's\r
/**\r
Worker function. Constructor for new child nodes.\r
\r
- @param Stream Indicates the section stream in which to add the \r
- child. \r
- @param ChildOffset Indicates the offset in Stream that is the \r
- beginning of the child section. \r
- @param ChildNode Indicates the Callee allocated and initialized \r
- child. \r
-\r
- @retval EFI_SUCCESS Child node was found and returned. \r
- EFI_OUT_OF_RESOURCES- Memory allocation failed. \r
- @retval EFI_PROTOCOL_ERROR Encapsulation sections produce new stream \r
- handles when the child node is created. If the \r
- section type is GUID defined, and the extraction \r
- GUID does not exist, and producing the stream \r
- requires the GUID, then a protocol error is \r
- generated and no child is produced. Values \r
+ @param Stream Indicates the section stream in which to add the\r
+ child.\r
+ @param ChildOffset Indicates the offset in Stream that is the\r
+ beginning of the child section.\r
+ @param ChildNode Indicates the Callee allocated and initialized\r
+ child.\r
+\r
+ @retval EFI_SUCCESS Child node was found and returned.\r
+ EFI_OUT_OF_RESOURCES- Memory allocation failed.\r
+ @retval EFI_PROTOCOL_ERROR Encapsulation sections produce new stream\r
+ handles when the child node is created. If the\r
+ section type is GUID defined, and the extraction\r
+ GUID does not exist, and producing the stream\r
+ requires the GUID, then a protocol error is\r
+ generated and no child is produced. Values\r
returned by OpenSectionStreamEx.\r
\r
**/\r
UINTN NewStreamBufferSize;\r
UINT32 AuthenticationStatus;\r
UINT32 SectionLength;\r
- \r
+\r
CORE_SECTION_CHILD_NODE *Node;\r
\r
SectionHeader = (EFI_COMMON_SECTION_HEADER *) (Stream->StreamBuffer + ChildOffset);\r
if (Node == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
- \r
+\r
//\r
// Now initialize it\r
//\r
Node->OffsetInStream = ChildOffset;\r
Node->EncapsulatedStreamHandle = NULL_STREAM_HANDLE;\r
Node->EncapsulationGuid = NULL;\r
- \r
+\r
//\r
// If it's an encapsulating section, then create the new section stream also\r
//\r
// Get the CompressionSectionHeader\r
//\r
ASSERT (Node->Size >= sizeof (EFI_COMPRESSION_SECTION));\r
- \r
+\r
CompressionHeader = (EFI_COMPRESSION_SECTION *) SectionHeader;\r
- \r
+\r
//\r
// Allocate space for the new stream\r
//\r
CoreFreePool (Node);\r
return EFI_OUT_OF_RESOURCES;\r
}\r
- \r
+\r
if (CompressionHeader->CompressionType == EFI_NOT_COMPRESSED) {\r
//\r
// stream is not actually compressed, just encapsulated. So just copy it.\r
} else if (CompressionHeader->CompressionType == EFI_STANDARD_COMPRESSION) {\r
//\r
// Only support the EFI_SATNDARD_COMPRESSION algorithm.\r
- // \r
+ //\r
\r
//\r
// Decompress the stream\r
//\r
Status = CoreLocateProtocol (&gEfiDecompressProtocolGuid, NULL, (VOID **)&Decompress);\r
- \r
+\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
Status = Decompress->GetInfo (\r
Decompress,\r
CompressionHeader + 1,\r
ScratchSize\r
);\r
ASSERT_EFI_ERROR (Status);\r
- CoreFreePool (ScratchBuffer); \r
+ CoreFreePool (ScratchBuffer);\r
}\r
} else {\r
NewStreamBuffer = NULL;\r
NewStreamBufferSize = 0;\r
}\r
- \r
+\r
Status = OpenSectionStreamEx (\r
NewStreamBufferSize,\r
NewStreamBuffer,\r
CoreFreePool (*ChildNode);\r
return EFI_PROTOCOL_ERROR;\r
}\r
- \r
+\r
//\r
- // Make sure we initialize the new stream with the correct \r
+ // Make sure we initialize the new stream with the correct\r
// authentication status for both aggregate and local status fields.\r
//\r
if (GuidedHeader->Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID) {\r
//\r
AuthenticationStatus = Stream->AuthenticationStatus;\r
}\r
- \r
+\r
Status = OpenSectionStreamEx (\r
NewStreamBufferSize,\r
NewStreamBuffer,\r
CoreFreePool (*ChildNode);\r
return EFI_PROTOCOL_ERROR;\r
}\r
- \r
+\r
//\r
// Figure out the proper authentication status\r
//\r
AuthenticationStatus = Stream->AuthenticationStatus;\r
- \r
+\r
SectionLength = SECTION_SIZE (GuidedHeader);\r
Status = OpenSectionStreamEx (\r
SectionLength - GuidedHeader->DataOffset,\r
return Status;\r
}\r
}\r
- \r
+\r
break;\r
\r
default:\r
- \r
+\r
//\r
// Nothing to do if it's a leaf\r
//\r
break;\r
}\r
- \r
+\r
//\r
// Last, add the new child node to the stream\r
//\r
// Remove the child from it's list\r
//\r
RemoveEntryList (&ChildNode->Link);\r
- \r
+\r
if (ChildNode->EncapsulatedStreamHandle != NULL_STREAM_HANDLE) {\r
//\r
// If it's an encapsulating section, we close the resulting section stream.\r
// Last, free the child node itself\r
//\r
CoreFreePool (ChildNode);\r
-} \r
+}\r
\r
\r
\r
/**\r
Worker function. Constructor for section streams.\r
\r
- @param SectionStreamLength Size in bytes of the section stream. \r
- @param SectionStream Buffer containing the new section stream. \r
- @param AllocateBuffer Indicates whether the stream buffer is to be \r
- copied or the input buffer is to be used in \r
- place. AuthenticationStatus- Indicates the \r
- default authentication status for the new \r
- stream. \r
+ @param SectionStreamLength Size in bytes of the section stream.\r
+ @param SectionStream Buffer containing the new section stream.\r
+ @param AllocateBuffer Indicates whether the stream buffer is to be\r
+ copied or the input buffer is to be used in\r
+ place. AuthenticationStatus- Indicates the\r
+ default authentication status for the new\r
+ stream.\r
@param AuthenticationStatus A pointer to a caller-allocated UINT32 that\r
indicates the authentication status of the\r
output buffer. If the input section's\r
function returns anything other than\r
EFI_SUCCESS, the value of *AuthenticationStatus\r
is undefined.\r
- @param SectionStreamHandle A pointer to a caller allocated section stream \r
- handle. \r
+ @param SectionStreamHandle A pointer to a caller allocated section stream\r
+ handle.\r
\r
- @retval EFI_SUCCESS Stream was added to stream database. \r
+ @retval EFI_SUCCESS Stream was added to stream database.\r
@retval EFI_OUT_OF_RESOURCES memory allocation failed.\r
\r
**/\r
IN UINTN SectionStreamLength,\r
IN VOID *SectionStream,\r
IN BOOLEAN AllocateBuffer,\r
- IN UINT32 AuthenticationStatus, \r
+ IN UINT32 AuthenticationStatus,\r
OUT UINTN *SectionStreamHandle\r
)\r
{\r
CORE_SECTION_STREAM_NODE *NewStream;\r
EFI_TPL OldTpl;\r
- \r
+\r
//\r
// Allocate a new stream\r
//\r
if (NewStream == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
- \r
- if (AllocateBuffer) { \r
+\r
+ if (AllocateBuffer) {\r
//\r
// if we're here, we're double buffering, allocate the buffer and copy the\r
// data in\r
//\r
if (SectionStreamLength > 0) {\r
- NewStream->StreamBuffer = CoreAllocateBootServicesPool (SectionStreamLength); \r
+ NewStream->StreamBuffer = CoreAllocateBootServicesPool (SectionStreamLength);\r
if (NewStream->StreamBuffer == NULL) {\r
CoreFreePool (NewStream);\r
return EFI_OUT_OF_RESOURCES;\r
//\r
NewStream->StreamBuffer = SectionStream;\r
}\r
- \r
+\r
//\r
// Initialize the rest of the section stream\r
//\r
NewStream->StreamLength = SectionStreamLength;\r
InitializeListHead (&NewStream->Children);\r
NewStream->AuthenticationStatus = AuthenticationStatus;\r
- \r
+\r
//\r
// Add new stream to stream list\r
//\r
CoreRestoreTpl (OldTpl);\r
\r
*SectionStreamHandle = NewStream->StreamHandle;\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
\r
/**\r
Worker function. Search stream database for requested stream handle.\r
\r
- @param SearchHandle Indicates which stream to look for. \r
- @param FoundStream Output pointer to the found stream. \r
+ @param SearchHandle Indicates which stream to look for.\r
+ @param FoundStream Output pointer to the found stream.\r
\r
- @retval EFI_SUCCESS StreamHandle was found and *FoundStream contains \r
- the stream node. \r
- @retval EFI_NOT_FOUND SearchHandle was not found in the stream \r
+ @retval EFI_SUCCESS StreamHandle was found and *FoundStream contains\r
+ the stream node.\r
+ @retval EFI_NOT_FOUND SearchHandle was not found in the stream\r
database.\r
\r
**/\r
IN UINTN SearchHandle,\r
OUT CORE_SECTION_STREAM_NODE **FoundStream\r
)\r
-{ \r
+{\r
CORE_SECTION_STREAM_NODE *StreamNode;\r
- \r
+\r
if (!IsListEmpty (&mStreamRoot)) {\r
StreamNode = STREAM_NODE_FROM_LINK (GetFirstNode (&mStreamRoot));\r
for (;;) {\r
}\r
}\r
}\r
- \r
+\r
return EFI_NOT_FOUND;\r
}\r
\r
/**\r
Check if a stream is valid.\r
\r
- @param SectionStream The section stream to be checked \r
- @param SectionStreamLength The length of section stream \r
+ @param SectionStream The section stream to be checked\r
+ @param SectionStreamLength The length of section stream\r
\r
@return A boolean value indicating the validness of the section stream.\r
\r
\r
TotalLength = 0;\r
SectionHeader = (EFI_COMMON_SECTION_HEADER *)SectionStream;\r
- \r
+\r
while (TotalLength < SectionStreamLength) {\r
SectionLength = SECTION_SIZE (SectionHeader);\r
TotalLength += SectionLength;\r
\r
if (TotalLength == SectionStreamLength) {\r
- return TRUE; \r
+ return TRUE;\r
}\r
\r
//\r
// Move to the next byte following the section...\r
//\r
SectionHeader = (EFI_COMMON_SECTION_HEADER *) ((UINT8 *) SectionHeader + SectionLength);\r
- \r
+\r
//\r
// Figure out where the next section begins\r
//\r
EFI_TPL above TPL_NOTIFY is undefined. Type EFI_TPL is\r
defined in RaiseTPL() in the UEFI 2.0 specification.\r
\r
- \r
+\r
@param This Indicates the\r
EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
@param InputSection Buffer containing the input GUIDed section\r
UINT32 OutputBufferSize;\r
UINT32 ScratchBufferSize;\r
UINT16 SectionAttribute;\r
- \r
+\r
//\r
// Init local variable\r
//\r
&ScratchBufferSize,\r
&SectionAttribute\r
);\r
- \r
+\r
if (EFI_ERROR (Status)) {\r
DEBUG ((DEBUG_ERROR, "GetInfo from guided section Failed - %r\n", Status));\r
return Status;\r
}\r
- \r
+\r
if (ScratchBufferSize != 0) {\r
//\r
// Allocate scratch buffer\r
}\r
}\r
\r
- if (OutputBufferSize > 0) { \r
+ if (OutputBufferSize > 0) {\r
//\r
// Allocate output buffer\r
//\r
// Call decode function to extract raw data from the guided section.\r
//\r
Status = ExtractGuidedSectionDecode (\r
- InputSection, \r
+ InputSection,\r
OutputBuffer,\r
ScratchBuffer,\r
AuthenticationStatus\r
\r
if (*OutputBuffer != AllocatedOutputBuffer) {\r
//\r
- // OutputBuffer was returned as a different value, \r
+ // OutputBuffer was returned as a different value,\r
// so copy section contents to the allocated memory buffer.\r
- // \r
+ //\r
CopyMem (AllocatedOutputBuffer, *OutputBuffer, OutputBufferSize);\r
*OutputBuffer = AllocatedOutputBuffer;\r
}\r
projects / mirror_edk2.git / commitdiff