}\r
\r
/**\r
- This function returns the size, in bytes, \r
- of the device path data structure specified by DevicePath.\r
- If DevicePath is NULL, then 0 is returned.\r
+ Returns the size of a device path in bytes.\r
\r
- @param DevicePath A pointer to a device path data structure.\r
+ This function returns the size, in bytes, of the device path data structure specified by\r
+ DevicePath including the end of device path node. If DevicePath is NULL, then 0 is returned.\r
+\r
+ @param DevicePath A pointer to a device path data structure.\r
\r
@return The size of a device path in bytes.\r
\r
}\r
\r
/**\r
- This function allocates space for a new copy of the device path\r
- specified by DevicePath.\r
+ Creates a new device path by appending a second device path to a first device path.\r
\r
- @param DevicePath A pointer to a device path data structure.\r
+ This function allocates space for a new copy of the device path specified by DevicePath. If\r
+ DevicePath is NULL, then NULL is returned. If the memory is successfully allocated, then the\r
+ contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer\r
+ is returned. Otherwise, NULL is returned. \r
+ \r
+ @param DevicePath A pointer to a device path data structure.\r
\r
- @return The duplicated device path.\r
+ @return A pointer to the duplicated device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
DuplicateDevicePath (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
)\r
{\r
return mDevicePathUtilities->DuplicateDevicePath (DevicePath);\r
}\r
\r
/**\r
- This function appends the device path SecondDevicePath\r
- to every device path instance in FirstDevicePath. \r
+ Creates a new device path by appending a second device path to a first device path.\r
\r
- @param FirstDevicePath A pointer to a device path data structure.\r
- \r
- @param SecondDevicePath A pointer to a device path data structure.\r
+ This function creates a new device path by appending a copy of SecondDevicePath to a copy of\r
+ FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from\r
+ SecondDevicePath is retained. The newly created device path is returned. \r
+ If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned. \r
+ If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned. \r
+ If both FirstDevicePath and SecondDevicePath are NULL, then NULL is returned. \r
+ If there is not enough memory for the newly allocated buffer, then NULL is returned.\r
+ The memory for the new device path is allocated from EFI boot services memory. It is the\r
+ responsibility of the caller to free the memory allocated.\r
\r
- @return 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 FirstDevicePath and SecondDevicePath\r
- if they are no longer needed.\r
+ @param FirstDevicePath A pointer to a device path data structure.\r
+ @param SecondDevicePath A pointer to a device path data structure.\r
+\r
+ @return A pointer to the new device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePath (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath, OPTIONAL\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath OPTIONAL\r
)\r
{\r
return mDevicePathUtilities->AppendDevicePath (FirstDevicePath, SecondDevicePath);\r
}\r
\r
/**\r
- This function appends the device path node SecondDevicePath\r
- to every device path instance in FirstDevicePath.\r
+ Creates a new path by appending the device node to the device path.\r
\r
- @param FirstDevicePath A pointer to a device path data structure.\r
- \r
- @param SecondDevicePath A pointer to a single device path node.\r
+ This function creates a new device path by appending a copy of the device node specified by\r
+ DevicePathNode to a copy of the device path specified by DevicePath in an allocated buffer.\r
+ The end-of-device-path device node is moved after the end of the appended device node.\r
+ If DevicePath is NULL, then NULL is returned.\r
+ If DevicePathNode is NULL, then NULL is returned.\r
+ If there is not enough memory to allocate space for the new device path, then NULL is returned. \r
+ The memory is allocated from EFI boot services memory. It is the responsibility of the caller to\r
+ free the memory allocated.\r
+\r
+ @param DevicePath A pointer to a device path data structure.\r
+ @param DevicePathNode A pointer to a single device path node.\r
\r
@return A pointer to the new device path.\r
- If there is not enough temporary pool memory available to complete this function,\r
- then NULL is returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePathNode (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, OPTIONAL\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathNode OPTIONAL\r
)\r
{\r
- return mDevicePathUtilities->AppendDeviceNode (FirstDevicePath, SecondDevicePath);\r
+ return mDevicePathUtilities->AppendDeviceNode (DevicePath, DevicePathNode);\r
}\r
\r
/**\r
- This function appends the device path instance Instance to the device path Source.\r
- If Source is NULL, then a new device path with one instance is created. \r
-\r
- @param Source A pointer to a device path data structure.\r
- @param Instance A pointer to a device path instance.\r
+ Creates a new device path by appending the specified device path instance to the specified device\r
+ path.\r
+ \r
+ This function creates a new device path by appending a copy of the device path instance specified\r
+ by DevicePathInstance to a copy of the device path secified by DevicePath in a allocated buffer.\r
+ The end-of-device-path device node is moved after the end of the appended device path instance\r
+ and a new end-of-device-path-instance node is inserted between. \r
+ If DevicePath is NULL, then a copy if DevicePathInstance is returned.\r
+ If DevicePathInstance is NULL, then NULL is returned.\r
+ If there is not enough memory to allocate space for the new device path, then NULL is returned. \r
+ The memory is allocated from EFI boot services memory. It is the responsibility of the caller to\r
+ free the memory allocated.\r
+ \r
+ @param DevicePath A pointer to a device path data structure.\r
+ @param DevicePathInstance A pointer to a device path instance.\r
\r
@return A pointer to the new device path.\r
- If there is not enough temporary pool memory available to complete this function,\r
- then NULL is returned.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
AppendDevicePathInstance (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *Source,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *Instance\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, OPTIONAL\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance OPTIONAL\r
)\r
{\r
- return mDevicePathUtilities->AppendDevicePathInstance (Source, Instance);\r
+ return mDevicePathUtilities->AppendDevicePathInstance (DevicePath, DevicePathInstance);\r
}\r
\r
/**\r
- Function retrieves the next device path instance from a device path data structure.\r
-\r
- @param DevicePath A pointer to a device path data structure.\r
- \r
- @param Size A pointer to the size of a device path instance in bytes.\r
-\r
- @return This function returns a pointer to the current device path instance.\r
- In addition, it returns the size in bytes of the current device path instance in Size,\r
- and a pointer to the next device path instance in DevicePath.\r
- If there are no more device path instances in DevicePath, then DevicePath will be set to NULL.\r
+ Creates a copy of the current device path instance and returns a pointer to the next device path\r
+ instance.\r
+\r
+ This function creates a copy of the current device path instance. It also updates DevicePath to\r
+ point to the next device path instance in the device path (or NULL if no more) and updates Size\r
+ to hold the size of the device path instance copy.\r
+ If DevicePath is NULL, then NULL is returned.\r
+ If there is not enough memory to allocate space for the new device path, then NULL is returned. \r
+ The memory is allocated from EFI boot services memory. It is the responsibility of the caller to\r
+ free the memory allocated.\r
+ If Size is NULL, then ASSERT().\r
+ \r
+ @param DevicePath On input, this holds the pointer to the current device path\r
+ instance. On output, this holds the pointer to the next device\r
+ path instance or NULL if there are no more device path\r
+ instances in the device path pointer to a device path data\r
+ structure.\r
+ @param Size On output, this holds the size of the device path instance, in\r
+ bytes or zero, if DevicePath is NULL.\r
+\r
+ @return A pointer to the current device path instance.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
GetNextDevicePathInstance (\r
- IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r
- OUT UINTN *Size\r
+ IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r
+ OUT UINTN *Size\r
)\r
{\r
- ASSERT (DevicePath != NULL);\r
ASSERT (Size != NULL);\r
return mDevicePathUtilities->GetNextDevicePathInstance (DevicePath, Size);\r
}\r
\r
/**\r
- Return TRUE is this is a multi instance device path.\r
+ Creates a copy of the current device path instance and returns a pointer to the next device path\r
+ instance.\r
+\r
+ This function creates a new device node in a newly allocated buffer of size NodeLength and\r
+ initializes the device path node header with NodeType and NodeSubType. The new device path node\r
+ is returned.\r
+ If NodeLength is smaller than a device path header, then NULL is returned. \r
+ If there is not enough memory to allocate space for the new device path, then NULL is returned. \r
+ The memory is allocated from EFI boot services memory. It is the responsibility of the caller to\r
+ free the memory allocated.\r
+\r
+ @param NodeType The device node type for the new device node.\r
+ @param NodeSubType The device node sub-type for the new device node.\r
+ @param NodeLength The length of the new device node.\r
+\r
+ @return The new device path.\r
+\r
+**/\r
+EFI_DEVICE_PATH_PROTOCOL *\r
+EFIAPI\r
+CreateDeviceNode (\r
+ IN UINT8 NodeType,\r
+ IN UINT8 NodeSubType,\r
+ IN UINT16 NodeLength\r
+ )\r
+{\r
+ return mDevicePathUtilities->CreateDeviceNode (NodeType, NodeSubType, NodeLength);\r
+}\r
+\r
+/**\r
+ Determines if a device path is single or multi-instance.\r
\r
- @param DevicePath A pointer to a device path data structure.\r
+ This function returns TRUE if the device path specified by DevicePath is multi-instance.\r
+ Otherwise, FALSE is returned. If DevicePath is NULL, then FALSE is returned.\r
\r
- @retval TRUE If DevicePath is multi-instance.\r
- @retval FALSE If DevicePath is not multi-instance or DevicePath is NULL.\r
+ @param DevicePath A pointer to a device path data structure.\r
+\r
+ @retval TRUE DevicePath is multi-instance.\r
+ @retval FALSE DevicePath is not multi-instance or DevicePath is NULL.\r
\r
**/\r
BOOLEAN\r
}\r
\r
/**\r
- This function retrieves the device path protocol from a handle.\r
+ Retrieves the device path protocol from a handle.\r
\r
- @param Handle The handle from which to retrieve the device path protocol.\r
+ This function returns the device path protocol from the handle specified by Handle. If Handle is\r
+ NULL or Handle does not contain a device path protocol, then NULL is returned.\r
+ \r
+ @param Handle The handle from which to retrieve the device path protocol.\r
\r
- @return This function returns the device path protocol from the handle specified by Handle.\r
- If Handle is NULL or Handle does not contain a device path protocol, then NULL is returned.\r
+ @return The device path protocol from the handle specified by Handle.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
DevicePathFromHandle (\r
- IN EFI_HANDLE Handle\r
+ IN EFI_HANDLE Handle\r
)\r
{\r
EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
}\r
\r
/**\r
- This function allocates a device path for a file and appends it to an existing device path.\r
+ Allocates a device path for a file and appends it to an existing device path.\r
+\r
+ If Device is a valid device handle that contains a device path protocol, then a device path for\r
+ the file specified by FileName is allocated and appended to the device path associated with the\r
+ handle Device. The allocated device path is returned. If Device is NULL or Device is a handle\r
+ that does not support the device path protocol, then a device path containing a single device\r
+ path node for the file specified by FileName is allocated and returned.\r
+ If FileName is NULL, then ASSERT().\r
\r
- @param Device A pointer to a device handle. This parameter is optional and may be NULL.\r
- @param FileName A pointer to a Null-terminated Unicode string.\r
+ @param Device A pointer to a device handle. This parameter is optional and\r
+ may be NULL.\r
+ @param FileName A pointer to a Null-terminated Unicode string.\r
\r
- @return If Device is a valid device handle that contains a device path protocol,\r
- then a device path for the file specified by FileName is allocated\r
- and appended to the device path associated with the handle Device. The allocated device path is returned.\r
- If Device is NULL or Device is a handle that does not support the device path protocol,\r
- then a device path containing a single device path node for the file specified by FileName\r
- is allocated and returned.\r
+ @return The allocated device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
FileDevicePath (\r
- IN EFI_HANDLE Device, OPTIONAL\r
- IN CONST CHAR16 *FileName\r
+ IN EFI_HANDLE Device, OPTIONAL\r
+ IN CONST CHAR16 *FileName\r
)\r
{\r
UINTN Size;\r
DevicePath = NULL;\r
\r
Size = StrSize (FileName);\r
- FileDevicePathNode = mDevicePathUtilities->CreateDeviceNode (\r
- MEDIA_DEVICE_PATH,\r
- MEDIA_FILEPATH_DP,\r
- (UINT16) (Size + SIZE_OF_FILEPATH_DEVICE_PATH)\r
- );\r
+ FileDevicePathNode = CreateDeviceNode (\r
+ MEDIA_DEVICE_PATH,\r
+ MEDIA_FILEPATH_DP,\r
+ (UINT16) (Size + SIZE_OF_FILEPATH_DEVICE_PATH)\r
+ );\r
if (FileDevicePathNode != NULL) {\r
FilePath = (FILEPATH_DEVICE_PATH *) FileDevicePathNode;\r
CopyMem (&FilePath->PathName, FileName, Size);\r
DevicePath = AppendDevicePathNode (DevicePath, FileDevicePathNode);\r
FreePool (FileDevicePathNode);\r
}\r
+\r
return DevicePath;\r
}\r
\r
projects / mirror_edk2.git / blobdiff