environment varibles. Multi-instance device paths should never be placed\r
on a Handle.\r
\r
- Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
- 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
- http://opensource.org/licenses/bsd-license.php. \r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ 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
+ http://opensource.org/licenses/bsd-license.php.\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
/**\r
Returns the size of a device path in bytes.\r
\r
- This function returns the size, in bytes, of the device path data structure \r
+ This function returns the size, in bytes, of the device path data structure\r
specified by DevicePath including the end of device path node.\r
If DevicePath is NULL or invalid, then 0 is returned.\r
\r
/**\r
Creates a new copy of an existing device path.\r
\r
- This function allocates space for a new copy of the device path specified by DevicePath. \r
- If DevicePath is NULL, then NULL is returned. If the memory is successfully \r
- allocated, then the contents of DevicePath are copied to the newly allocated \r
- buffer, and a pointer to that buffer is returned. Otherwise, NULL is returned. \r
- The memory for the new device path is allocated from EFI boot services memory. \r
- It is the responsibility of the caller to free the memory allocated. \r
- \r
+ This function allocates space for a new copy of the device path specified by DevicePath.\r
+ If DevicePath is NULL, then NULL is returned. If the memory is successfully\r
+ allocated, then the contents of DevicePath are copied to the newly allocated\r
+ buffer, and a pointer to that buffer is returned. Otherwise, NULL is returned.\r
+ The memory for the new device path is allocated from EFI boot services memory.\r
+ It is the responsibility of the caller to free the memory allocated.\r
+\r
@param DevicePath A pointer to a device path data structure.\r
\r
@retval NULL DevicePath is NULL or invalid.\r
@retval Others A pointer to the duplicated device path.\r
- \r
+\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
/**\r
Creates a new device path by appending a second device path to a first device path.\r
\r
- This function creates a new device path by appending a copy of SecondDevicePath \r
- to a copy of FirstDevicePath in a newly allocated buffer. Only the end-of-device-path \r
- device node from SecondDevicePath is retained. The newly created device path is \r
- returned. If FirstDevicePath is NULL, then it is ignored, and a duplicate of \r
- SecondDevicePath is returned. If SecondDevicePath is NULL, then it is ignored, \r
- and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and \r
- SecondDevicePath are NULL, then a copy of an end-of-device-path is returned. \r
- \r
+ This function creates a new device path by appending a copy of SecondDevicePath\r
+ to a copy of FirstDevicePath in a newly allocated buffer. Only the end-of-device-path\r
+ device node from SecondDevicePath is retained. The newly created device path is\r
+ returned. If FirstDevicePath is NULL, then it is ignored, and a duplicate of\r
+ SecondDevicePath is returned. If SecondDevicePath is NULL, then it is ignored,\r
+ and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and\r
+ SecondDevicePath are NULL, then a copy of an end-of-device-path is returned.\r
+\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. \r
+ The memory for the new device path is allocated from EFI boot services memory.\r
It is the responsibility of the caller to free the memory allocated.\r
\r
@param FirstDevicePath A pointer to a device path data structure.\r
@param SecondDevicePath A pointer to a device path data structure.\r
- \r
+\r
@retval NULL If there is not enough memory for the newly allocated buffer.\r
@retval NULL If FirstDevicePath or SecondDevicePath is invalid.\r
@retval Others A pointer to the new device path if success.\r
/**\r
Creates a new path by appending the device node to the device path.\r
\r
- This function creates a new device path by appending a copy of the device node \r
- specified by DevicePathNode to a copy of the device path specified by DevicePath \r
- in an allocated buffer. The end-of-device-path device node is moved after the \r
+ This function creates a new device path by appending a copy of the device node\r
+ specified by DevicePathNode to a copy of the device path specified by DevicePath\r
+ in an allocated buffer. The end-of-device-path device node is moved after the\r
end of the appended device node.\r
If DevicePathNode is NULL then a copy of DevicePath is returned.\r
- If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device \r
+ If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device\r
path device node is returned.\r
- If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path \r
+ If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path\r
device node is returned.\r
- If there is not enough memory to allocate space for the new device path, then \r
- NULL is returned. \r
- The memory is allocated from EFI boot services memory. It is the responsibility \r
+ If there is not enough memory to allocate space for the new device path, then\r
+ NULL is returned.\r
+ The memory is allocated from EFI boot services memory. It is the responsibility\r
of the caller to free the memory allocated.\r
\r
@param DevicePath A pointer to a device path data structure.\r
\r
@retval NULL If there is not enough memory for the new device path.\r
@retval Others A pointer to the new device path if success.\r
- A copy of DevicePathNode followed by an end-of-device-path node \r
+ A copy of DevicePathNode followed by an end-of-device-path node\r
if both FirstDevicePath and SecondDevicePath are NULL.\r
- A copy of an end-of-device-path node if both FirstDevicePath \r
+ A copy of an end-of-device-path node if both FirstDevicePath\r
and SecondDevicePath are NULL.\r
\r
**/\r
/**\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 \r
- instance specified by DevicePathInstance to a copy of the device path specified \r
+\r
+ This function creates a new device path by appending a copy of the device path\r
+ instance specified by DevicePathInstance to a copy of the device path specified\r
by DevicePath in a allocated buffer.\r
- The end-of-device-path device node is moved after the end of the appended device \r
- path instance and a new end-of-device-path-instance node is inserted between. \r
+ The end-of-device-path device node is moved after the end of the appended device\r
+ path instance 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 DevicePath or DevicePathInstance is invalid, then NULL is returned.\r
- If there is not enough memory to allocate space for the new device path, then \r
- NULL is returned. \r
- The memory is allocated from EFI boot services memory. It is the responsibility \r
+ If there is not enough memory to allocate space for the new device path, then\r
+ NULL is returned.\r
+ The memory is allocated from EFI boot services memory. It is the responsibility\r
of the caller to free the memory allocated.\r
- \r
+\r
@param DevicePath A pointer to a device path data structure.\r
@param DevicePathInstance A pointer to a device path instance.\r
\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 \r
- DevicePath to point to the next device path instance in the device path (or NULL \r
+ This function creates a copy of the current device path instance. It also updates\r
+ DevicePath to point to the next device path instance in the device path (or NULL\r
if no more) and updates Size to hold the size of the device path instance copy.\r
If DevicePath is NULL, then NULL is returned.\r
If DevicePath points to a invalid device path, then NULL is returned.\r
- If there is not enough memory to allocate space for the new device path, then \r
- NULL is returned. \r
- The memory is allocated from EFI boot services memory. It is the responsibility \r
+ If there is not enough memory to allocate space for the new device path, then\r
+ NULL is returned.\r
+ The memory is allocated from EFI boot services memory. It is the responsibility\r
of the caller to free the memory allocated.\r
If Size is NULL, then ASSERT().\r
- \r
- @param DevicePath On input, this holds the pointer to the current \r
- device path instance. On output, this holds \r
- the pointer to the next device path instance \r
+\r
+ @param DevicePath On input, this holds the pointer to the current\r
+ device path instance. On output, this holds\r
+ the pointer to the next device path instance\r
or NULL if there are no more device path\r
- instances in the device path pointer to a \r
+ instances in the device path pointer to a\r
device path data structure.\r
- @param Size On output, this holds the size of the device \r
- path instance, in bytes or zero, if DevicePath \r
+ @param Size On output, this holds the size of the device\r
+ path instance, in bytes or zero, if DevicePath\r
is NULL.\r
\r
@return A pointer to the current device path instance.\r
/**\r
Creates a device node.\r
\r
- This function creates a new device node in a newly allocated buffer of size \r
- NodeLength and initializes the device path node header with NodeType and NodeSubType. \r
+ This function creates a new device node in a newly allocated buffer of size\r
+ NodeLength and initializes the device path node header with NodeType and NodeSubType.\r
The new device path node 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 \r
- NULL is returned. \r
- The memory is allocated from EFI boot services memory. It is the responsibility \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\r
+ NULL is returned.\r
+ The memory is allocated from EFI boot services memory. It is the responsibility\r
of the caller to free the memory allocated.\r
\r
@param NodeType The device node type for the new device node.\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 \r
+ @retval FALSE DevicePath is not multi-instance, or DevicePath\r
is NULL or invalid.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff