-/**@file\r
+/** @file\r
DXE Core library services.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
#include <DxeMain.h>\r
\r
-UINTN mErrorLevel = EFI_D_ERROR | EFI_D_LOAD;\r
+UINTN mErrorLevel = DEBUG_ERROR | DEBUG_LOAD;\r
\r
EFI_DXE_DEVICE_HANDLE_EXTENDED_DATA mStatusCodeData = {\r
{\r
NULL\r
};\r
\r
-VOID\r
-CoreReportProgressCodeSpecific (\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN EFI_HANDLE Handle\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid,\r
with a handle as additional information.\r
\r
-Arguments:\r
-\r
- Value - Describes the class/subclass/operation of the hardware or software entity\r
- that the Status Code 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
- Handle - Additional information.\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreReportProgressCodeSpecific (\r
+ IN EFI_STATUS_CODE_VALUE Value,\r
+ IN EFI_HANDLE Handle\r
+ )\r
{\r
mStatusCodeData.DataHeader.Size = sizeof (EFI_DXE_DEVICE_HANDLE_EXTENDED_DATA) - sizeof (EFI_STATUS_CODE_DATA);\r
mStatusCodeData.Handle = Handle;\r
}\r
}\r
\r
-VOID\r
-CoreReportProgressCode (\r
- IN EFI_STATUS_CODE_VALUE Value\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid.\r
\r
-Arguments:\r
-\r
- Value - Describes the class/subclass/operation of the hardware or software entity\r
- that the Status Code 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
\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreReportProgressCode (\r
+ IN EFI_STATUS_CODE_VALUE Value\r
+ )\r
{\r
if ((gStatusCode != NULL) && (gStatusCode->ReportStatusCode != NULL) ) {\r
gStatusCode->ReportStatusCode (\r
}\r
\r
\r
-VOID *\r
-CoreAllocateBootServicesPool (\r
- IN UINTN AllocationSize\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Allocate pool of type EfiBootServicesData, the size is specified with AllocationSize.\r
\r
-Arguments:\r
-\r
- AllocationSize - Size to allocate.\r
+ @param AllocationSize Size to allocate. \r
\r
-Returns:\r
+ @return Pointer of the allocated pool.\r
\r
- Pointer of the allocated pool.\r
-\r
---*/\r
+**/\r
+VOID *\r
+CoreAllocateBootServicesPool (\r
+ IN UINTN AllocationSize\r
+ )\r
{\r
VOID *Memory;\r
\r
}\r
\r
\r
-VOID *\r
-CoreAllocateZeroBootServicesPool (\r
- IN UINTN AllocationSize\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Allocate pool of type EfiBootServicesData and zero it, the size is specified with AllocationSize.\r
\r
-Arguments:\r
-\r
- AllocationSize - Size to allocate.\r
+ @param AllocationSize Size to allocate. \r
\r
-Returns:\r
+ @return Pointer of the allocated pool.\r
\r
- Pointer of the allocated pool.\r
-\r
---*/\r
+**/\r
+VOID *\r
+CoreAllocateZeroBootServicesPool (\r
+ IN UINTN AllocationSize\r
+ )\r
{\r
VOID *Memory;\r
\r
}\r
\r
\r
-VOID *\r
-CoreAllocateCopyPool (\r
- IN UINTN AllocationSize,\r
- IN VOID *Buffer\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Allocate pool of specified size with EfiBootServicesData type, and copy specified buffer to this pool.\r
\r
-Arguments:\r
-\r
- AllocationSize - Size to allocate.\r
+ @param AllocationSize Size to allocate. \r
+ @param Buffer Specified buffer that will be copy to the allocated \r
+ pool \r
\r
- Buffer - Specified buffer that will be copy to the allocated pool\r
+ @return Pointer of the allocated pool.\r
\r
-Returns:\r
-\r
- Pointer of the allocated pool.\r
-\r
---*/\r
+**/\r
+VOID *\r
+CoreAllocateCopyPool (\r
+ IN UINTN AllocationSize,\r
+ IN VOID *Buffer\r
+ )\r
{\r
VOID *Memory;\r
\r
\r
\r
\r
-VOID *\r
-CoreAllocateRuntimePool (\r
- IN UINTN AllocationSize\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Allocate pool of type EfiRuntimeServicesData, the size is specified with AllocationSize.\r
\r
-Arguments:\r
-\r
- AllocationSize - Size to allocate.\r
-\r
-Returns:\r
+ @param AllocationSize Size to allocate. \r
\r
- Pointer of the allocated pool.\r
+ @return Pointer of the allocated pool.\r
\r
---*/\r
+**/\r
+VOID *\r
+CoreAllocateRuntimePool (\r
+ IN UINTN AllocationSize\r
+ )\r
{\r
VOID *Memory;\r
\r
return Memory;\r
}\r
\r
-VOID *\r
-CoreAllocateRuntimeCopyPool (\r
- IN UINTN AllocationSize,\r
- IN VOID *Buffer\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Allocate pool of specified size with EfiRuntimeServicesData type, and copy specified buffer to this pool.\r
\r
-Arguments:\r
-\r
- AllocationSize - Size to allocate.\r
+ @param AllocationSize Size to allocate. \r
+ @param Buffer Specified buffer that will be copy to the allocated \r
+ pool \r
\r
- Buffer - Specified buffer that will be copy to the allocated pool\r
-\r
-Returns:\r
-\r
- Pointer of the allocated pool.\r
-\r
---*/\r
+ @return Pointer of the allocated pool.\r
\r
+**/\r
+VOID *\r
+CoreAllocateRuntimeCopyPool (\r
+ IN UINTN AllocationSize,\r
+ IN VOID *Buffer\r
+ )\r
{\r
VOID *Memory;\r
\r
//\r
\r
\r
-\r
-EFI_STATUS\r
-CoreAcquireLockOrFail (\r
- IN EFI_LOCK *Lock\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Initialize a basic mutual exclusion lock. Each lock\r
provides mutual exclusion access at it's task priority\r
level. Since there is no-premption (at any TPL) or\r
multiprocessor support, acquiring the lock only consists\r
of raising to the locks TPL.\r
\r
-Arguments:\r
+ @param Lock The EFI_LOCK structure to initialize \r
\r
- Lock - The EFI_LOCK structure to initialize\r
+ @retval EFI_SUCCESS Lock Owned. \r
+ @retval EFI_ACCESS_DENIED Reentrant Lock Acquisition, Lock not Owned.\r
\r
-Returns:\r
-\r
- EFI_SUCCESS - Lock Owned.\r
- EFI_ACCESS_DENIED - Reentrant Lock Acquisition, Lock not Owned.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+CoreAcquireLockOrFail (\r
+ IN EFI_LOCK *Lock\r
+ )\r
{\r
ASSERT (Lock != NULL);\r
ASSERT (Lock->Lock != EfiLockUninitialized);\r
}\r
\r
\r
-VOID\r
-CoreAcquireLock (\r
- IN EFI_LOCK *Lock\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Raising to the task priority level of the mutual exclusion\r
lock, and then acquires ownership of the lock.\r
\r
-Arguments:\r
+ @param Lock The lock to acquire \r
\r
- Lock - The lock to acquire\r
+ @return Lock owned\r
\r
-Returns:\r
-\r
- Lock owned\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreAcquireLock (\r
+ IN EFI_LOCK *Lock\r
+ )\r
{\r
ASSERT (Lock != NULL);\r
ASSERT (Lock->Lock == EfiLockReleased);\r
}\r
\r
\r
-VOID\r
-CoreReleaseLock (\r
- IN EFI_LOCK *Lock\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Releases ownership of the mutual exclusion lock, and\r
- restores the previous task priority level.\r
\r
-Arguments:\r
+/**\r
+ Releases ownership of the mutual exclusion lock, and\r
+ restores the previous task priority level.\r
\r
- Lock - The lock to release\r
+ @param Lock The lock to release \r
\r
-Returns:\r
+ @return Lock unowned\r
\r
- Lock unowned\r
-\r
---*/\r
+**/\r
+VOID\r
+CoreReleaseLock (\r
+ IN EFI_LOCK *Lock\r
+ )\r
{\r
EFI_TPL Tpl;\r
\r
}\r
\r
\r
-UINTN\r
-CoreDevicePathSize (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Calculate the size of a whole device path.\r
\r
-Arguments:\r
-\r
- DevicePath - The pointer to the device path data.\r
+ @param DevicePath The pointer to the device path data. \r
\r
-Returns:\r
+ @return Size of device path data structure..\r
\r
- Size of device path data structure..\r
-\r
---*/\r
+**/\r
+UINTN\r
+CoreDevicePathSize (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
+ )\r
{\r
EFI_DEVICE_PATH_PROTOCOL *Start;\r
\r
}\r
\r
\r
-BOOLEAN\r
-CoreIsDevicePathMultiInstance (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Return TRUE is this is a multi instance device path.\r
\r
-Arguments:\r
- DevicePath - A pointer to a device path data structure.\r
-\r
+ @param DevicePath A pointer to a device path data structure. \r
\r
-Returns:\r
- TRUE - If DevicePath is multi instance. FALSE - If DevicePath is not multi\r
- instance.\r
+ @retval TRUE If DevicePath is multi instance. FALSE - If \r
+ DevicePath is not multi instance.\r
\r
---*/\r
+**/\r
+BOOLEAN\r
+CoreIsDevicePathMultiInstance (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
+ )\r
{\r
EFI_DEVICE_PATH_PROTOCOL *Node;\r
\r
\r
\r
\r
-EFI_DEVICE_PATH_PROTOCOL *\r
-CoreDuplicateDevicePath (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Duplicate a new device path data structure from the old one.\r
\r
-Arguments:\r
- DevicePath - A pointer to a device path data structure.\r
+ @param DevicePath A pointer to a device path data structure. \r
\r
-Returns:\r
- A pointer to the new allocated device path data.\r
- Caller must free the memory used by DevicePath if it is no longer needed.\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
---*/\r
+**/\r
+EFI_DEVICE_PATH_PROTOCOL *\r
+CoreDuplicateDevicePath (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
+ )\r
{\r
EFI_DEVICE_PATH_PROTOCOL *NewDevicePath;\r
UINTN Size;\r
\r
\r
\r
-EFI_DEVICE_PATH_PROTOCOL *\r
-CoreAppendDevicePath (\r
- IN EFI_DEVICE_PATH_PROTOCOL *Src1,\r
- IN EFI_DEVICE_PATH_PROTOCOL *Src2\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Function is used to append a Src1 and Src2 together.\r
\r
-Arguments:\r
- Src1 - A pointer to a device path data structure.\r
-\r
- 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
-Returns:\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
+ @return It is up to the caller to free the memory used by Src1 and Src2 if they are no longer needed.\r
\r
- A pointer to the new device path is returned.\r
- NULL is returned if space for the new device path could not be allocated from pool.\r
- It is up to the caller to free the memory used by Src1 and Src2 if they are no longer needed.\r
-\r
---*/\r
+**/\r
+EFI_DEVICE_PATH_PROTOCOL *\r
+CoreAppendDevicePath (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *Src1,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *Src2\r
+ )\r
{\r
UINTN Size;\r
UINTN Size1;\r
\r
\r
\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
+\r
+ @return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
+ is added to the system.\r
+\r
+**/\r
EFI_EVENT\r
CoreCreateProtocolNotifyEvent (\r
IN EFI_GUID *ProtocolGuid,\r
OUT VOID **Registration,\r
IN BOOLEAN SignalFlag\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Create a protocol notification event and return it.\r
-\r
-Arguments:\r
-\r
- ProtocolGuid - Protocol to register notification event on.\r
-\r
- NotifyTpl - Maximum TPL to signal the NotifyFunction.\r
-\r
- NotifyFuncition - EFI notification routine.\r
-\r
- NotifyContext - Context passed into Event when it is created.\r
-\r
- Registration - Registration key returned from RegisterProtocolNotify().\r
-\r
- SignalFlag - Boolean value to decide whether kick the event after register or not.\r
-\r
-Returns:\r
-\r
- The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
- is added to the system.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_EVENT Event;\r
return Event;\r
}\r
\r
+\r
projects / mirror_edk2.git / blobdiff