MdePkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Liming Gao
@ -2,7 +2,7 @@
|
||||
Library instance that implement UEFI Device Path Library class based on protocol
|
||||
gEfiDevicePathUtilitiesProtocolGuid.
|
||||
|
||||
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
@ -46,13 +46,13 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_PROTOCOL mUefiDevicePathLib
|
||||
|
||||
/**
|
||||
The constructor function caches the pointer to DevicePathUtilites protocol.
|
||||
|
||||
|
||||
The constructor function locates DevicePathUtilities protocol from protocol database.
|
||||
It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
|
||||
It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
|
||||
|
||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
||||
@param SystemTable A pointer to the EFI System Table.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
|
||||
|
||||
**/
|
||||
@ -193,9 +193,9 @@ DevicePathSubType (
|
||||
/**
|
||||
Returns the 16-bit Length field of a device path node.
|
||||
|
||||
Returns the 16-bit Length field of the device path node specified by Node.
|
||||
Returns the 16-bit Length field of the device path node specified by Node.
|
||||
Node is not required to be aligned on a 16-bit boundary, so it is recommended
|
||||
that a function such as ReadUnaligned16() be used to extract the contents of
|
||||
that a function such as ReadUnaligned16() be used to extract the contents of
|
||||
the Length field.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
@ -218,14 +218,14 @@ DevicePathNodeLength (
|
||||
/**
|
||||
Returns a pointer to the next node in a device path.
|
||||
|
||||
Returns a pointer to the device path node that follows the device path node
|
||||
Returns a pointer to the device path node that follows the device path node
|
||||
specified by Node.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
|
||||
@param Node A pointer to a device path node data structure.
|
||||
|
||||
@return a pointer to the device path node that follows the device path node
|
||||
@return a pointer to the device path node that follows the device path node
|
||||
specified by Node.
|
||||
|
||||
**/
|
||||
@ -241,12 +241,12 @@ NextDevicePathNode (
|
||||
|
||||
/**
|
||||
Determines if a device path node is an end node of a device path.
|
||||
This includes nodes that are the end of a device path instance and nodes that
|
||||
This includes nodes that are the end of a device path instance and nodes that
|
||||
are the end of an entire device path.
|
||||
|
||||
Determines if the device path node specified by Node is an end node of a device path.
|
||||
This includes nodes that are the end of a device path instance and nodes that are the
|
||||
end of an entire device path. If Node represents an end node of a device path,
|
||||
Determines if the device path node specified by Node is an end node of a device path.
|
||||
This includes nodes that are the end of a device path instance and nodes that are the
|
||||
end of an entire device path. If Node represents an end node of a device path,
|
||||
then TRUE is returned. Otherwise, FALSE is returned.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
@ -254,9 +254,9 @@ NextDevicePathNode (
|
||||
@param Node A pointer to a device path node data structure.
|
||||
|
||||
@retval TRUE The device path node specified by Node is an end node of a device path.
|
||||
@retval FALSE The device path node specified by Node is not an end node of
|
||||
@retval FALSE The device path node specified by Node is not an end node of
|
||||
a device path.
|
||||
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
@ -271,9 +271,9 @@ IsDevicePathEndType (
|
||||
/**
|
||||
Determines if a device path node is an end node of an entire device path.
|
||||
|
||||
Determines if a device path node specified by Node is an end node of an entire
|
||||
Determines if a device path node specified by Node is an end node of an entire
|
||||
device path.
|
||||
If Node represents the end of an entire device path, then TRUE is returned.
|
||||
If Node represents the end of an entire device path, then TRUE is returned.
|
||||
Otherwise, FALSE is returned.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
@ -297,18 +297,18 @@ IsDevicePathEnd (
|
||||
/**
|
||||
Determines if a device path node is an end node of a device path instance.
|
||||
|
||||
Determines if a device path node specified by Node is an end node of a device
|
||||
Determines if a device path node specified by Node is an end node of a device
|
||||
path instance.
|
||||
If Node represents the end of a device path instance, then TRUE is returned.
|
||||
If Node represents the end of a device path instance, then TRUE is returned.
|
||||
Otherwise, FALSE is returned.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
|
||||
@param Node A pointer to a device path node data structure.
|
||||
|
||||
@retval TRUE The device path node specified by Node is the end of a device
|
||||
@retval TRUE The device path node specified by Node is the end of a device
|
||||
path instance.
|
||||
@retval FALSE The device path node specified by Node is not the end of a
|
||||
@retval FALSE The device path node specified by Node is not the end of a
|
||||
device path instance.
|
||||
|
||||
**/
|
||||
@ -325,8 +325,8 @@ IsDevicePathEndInstance (
|
||||
/**
|
||||
Sets the length, in bytes, of a device path node.
|
||||
|
||||
Sets the length of the device path node specified by Node to the value specified
|
||||
by NodeLength. NodeLength is returned. Node is not required to be aligned on
|
||||
Sets the length of the device path node specified by Node to the value specified
|
||||
by NodeLength. NodeLength is returned. Node is not required to be aligned on
|
||||
a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16()
|
||||
be used to set the contents of the Length field.
|
||||
|
||||
@ -355,15 +355,15 @@ SetDevicePathNodeLength (
|
||||
/**
|
||||
Fills in all the fields of a device path node that is the end of an entire device path.
|
||||
|
||||
Fills in all the fields of a device path node specified by Node so Node represents
|
||||
the end of an entire device path. The Type field of Node is set to
|
||||
END_DEVICE_PATH_TYPE, the SubType field of Node is set to
|
||||
END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to
|
||||
END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary,
|
||||
so it is recommended that a function such as WriteUnaligned16() be used to set
|
||||
the contents of the Length field.
|
||||
Fills in all the fields of a device path node specified by Node so Node represents
|
||||
the end of an entire device path. The Type field of Node is set to
|
||||
END_DEVICE_PATH_TYPE, the SubType field of Node is set to
|
||||
END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to
|
||||
END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary,
|
||||
so it is recommended that a function such as WriteUnaligned16() be used to set
|
||||
the contents of the Length field.
|
||||
|
||||
If Node is NULL, then ASSERT().
|
||||
If Node is NULL, then ASSERT().
|
||||
|
||||
@param Node A pointer to a device path node data structure.
|
||||
|
||||
@ -381,7 +381,7 @@ SetDevicePathEndNode (
|
||||
/**
|
||||
Returns the size of a device path in bytes.
|
||||
|
||||
This function returns the size, in bytes, of the device path data structure
|
||||
This function returns the size, in bytes, of the device path data structure
|
||||
specified by DevicePath including the end of device path node.
|
||||
If DevicePath is NULL or invalid, then 0 is returned.
|
||||
|
||||
@ -403,19 +403,19 @@ GetDevicePathSize (
|
||||
/**
|
||||
Creates a new copy of an existing device path.
|
||||
|
||||
This function allocates space for a new copy of the device path specified by
|
||||
DevicePath. If DevicePath is NULL, then NULL is returned.
|
||||
This function allocates space for a new copy of the device path specified by
|
||||
DevicePath. If DevicePath is NULL, then NULL is returned.
|
||||
If the memory is successfully allocated, then the
|
||||
contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer
|
||||
is returned. Otherwise, NULL is returned.
|
||||
The memory for the new device path is allocated from EFI boot services memory.
|
||||
It is the responsibility of the caller to free the memory allocated.
|
||||
|
||||
is returned. Otherwise, NULL is returned.
|
||||
The memory for the new device path is allocated from EFI boot services memory.
|
||||
It is the responsibility of the caller to free the memory allocated.
|
||||
|
||||
@param DevicePath A pointer to a device path data structure.
|
||||
|
||||
@retval NULL If DevicePath is NULL or invalid.
|
||||
@retval Others A pointer to the duplicated device path.
|
||||
|
||||
|
||||
**/
|
||||
EFI_DEVICE_PATH_PROTOCOL *
|
||||
EFIAPI
|
||||
@ -431,22 +431,22 @@ DuplicateDevicePath (
|
||||
|
||||
This function creates a new device path by appending a copy of SecondDevicePath to a copy of
|
||||
FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from
|
||||
SecondDevicePath is retained. The newly created device path is returned.
|
||||
If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.
|
||||
If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.
|
||||
SecondDevicePath is retained. The newly created device path is returned.
|
||||
If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.
|
||||
If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.
|
||||
If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is
|
||||
returned.
|
||||
returned.
|
||||
If there is not enough memory for the newly allocated buffer, then NULL is returned.
|
||||
The memory for the new device path is allocated from EFI boot services memory. It is the
|
||||
responsibility of the caller to free the memory allocated.
|
||||
|
||||
@param FirstDevicePath A pointer to a device path data structure.
|
||||
@param SecondDevicePath A pointer to a device path data structure.
|
||||
|
||||
|
||||
@retval NULL If there is not enough memory for the newly allocated buffer.
|
||||
@retval NULL If FirstDevicePath or SecondDevicePath is invalid.
|
||||
@retval Others A pointer to the new device path if success.
|
||||
Or a copy an end-of-device-path if both FirstDevicePath and
|
||||
Or a copy an end-of-device-path if both FirstDevicePath and
|
||||
SecondDevicePath are NULL.
|
||||
|
||||
**/
|
||||
@ -463,18 +463,18 @@ AppendDevicePath (
|
||||
/**
|
||||
Creates a new path by appending the device node to the device path.
|
||||
|
||||
This function creates a new device path by appending a copy of the device node
|
||||
specified by DevicePathNode to a copy of the device path specified by DevicePath
|
||||
This function creates a new device path by appending a copy of the device node
|
||||
specified by DevicePathNode to a copy of the device path specified by DevicePath
|
||||
in an allocated buffer.
|
||||
The end-of-device-path device node is moved after the end of the appended device node.
|
||||
If DevicePathNode is NULL then a copy of DevicePath is returned.
|
||||
If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
|
||||
If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
|
||||
path device node is returned.
|
||||
If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
|
||||
If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
|
||||
device node is returned.
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
of the caller to free the memory allocated.
|
||||
|
||||
@param DevicePath A pointer to a device path data structure.
|
||||
@ -482,9 +482,9 @@ AppendDevicePath (
|
||||
|
||||
@retval NULL If there is not enough memory for the new device path.
|
||||
@retval Others A pointer to the new device path if success.
|
||||
A copy of DevicePathNode followed by an end-of-device-path node
|
||||
A copy of DevicePathNode followed by an end-of-device-path node
|
||||
if both FirstDevicePath and SecondDevicePath are NULL.
|
||||
A copy of an end-of-device-path node if both FirstDevicePath
|
||||
A copy of an end-of-device-path node if both FirstDevicePath
|
||||
and SecondDevicePath are NULL.
|
||||
|
||||
**/
|
||||
@ -499,22 +499,22 @@ AppendDevicePathNode (
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a new device path by appending the specified device path instance to
|
||||
Creates a new device path by appending the specified device path instance to
|
||||
the specified device path.
|
||||
|
||||
This function creates a new device path by appending a copy of the device path
|
||||
instance specified by DevicePathInstance to a copy of the device path specified
|
||||
|
||||
This function creates a new device path by appending a copy of the device path
|
||||
instance specified by DevicePathInstance to a copy of the device path specified
|
||||
by DevicePath in a allocated buffer.
|
||||
The end-of-device-path device node is moved after the end of the appended device
|
||||
path instance and a new end-of-device-path-instance node is inserted between.
|
||||
The end-of-device-path device node is moved after the end of the appended device
|
||||
path instance and a new end-of-device-path-instance node is inserted between.
|
||||
If DevicePath is NULL, then a copy if DevicePathInstance is returned.
|
||||
If DevicePathInstance is NULL, then NULL is returned.
|
||||
If DevicePath or DevicePathInstance is invalid, then NULL is returned.
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
of the caller to free the memory allocated.
|
||||
|
||||
|
||||
@param DevicePath A pointer to a device path data structure.
|
||||
@param DevicePathInstance A pointer to a device path instance.
|
||||
|
||||
@ -532,27 +532,27 @@ AppendDevicePathInstance (
|
||||
}
|
||||
|
||||
/**
|
||||
Creates a copy of the current device path instance and returns a pointer to the
|
||||
Creates a copy of the current device path instance and returns a pointer to the
|
||||
next device path instance.
|
||||
|
||||
This function creates a copy of the current device path instance. It also updates
|
||||
DevicePath to point to the next device path instance in the device path (or NULL
|
||||
This function creates a copy of the current device path instance. It also updates
|
||||
DevicePath to point to the next device path instance in the device path (or NULL
|
||||
if no more) and updates Size to hold the size of the device path instance copy.
|
||||
If DevicePath is NULL, then NULL is returned.
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
of the caller to free the memory allocated.
|
||||
If Size is NULL, then ASSERT().
|
||||
|
||||
@param DevicePath On input, this holds the pointer to the current
|
||||
device path instance. On output, this holds
|
||||
the pointer to the next device path instance
|
||||
|
||||
@param DevicePath On input, this holds the pointer to the current
|
||||
device path instance. On output, this holds
|
||||
the pointer to the next device path instance
|
||||
or NULL if there are no more device path
|
||||
instances in the device path pointer to a
|
||||
instances in the device path pointer to a
|
||||
device path data structure.
|
||||
@param Size On output, this holds the size of the device
|
||||
path instance, in bytes or zero, if DevicePath
|
||||
@param Size On output, this holds the size of the device
|
||||
path instance, in bytes or zero, if DevicePath
|
||||
is NULL.
|
||||
|
||||
@return A pointer to the current device path instance.
|
||||
@ -572,13 +572,13 @@ GetNextDevicePathInstance (
|
||||
/**
|
||||
Creates a device node.
|
||||
|
||||
This function creates a new device node in a newly allocated buffer of size
|
||||
NodeLength and initializes the device path node header with NodeType and NodeSubType.
|
||||
This function creates a new device node in a newly allocated buffer of size
|
||||
NodeLength and initializes the device path node header with NodeType and NodeSubType.
|
||||
The new device path node is returned.
|
||||
If NodeLength is smaller than a device path header, then NULL is returned.
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
If NodeLength is smaller than a device path header, then NULL is returned.
|
||||
If there is not enough memory to allocate space for the new device path, then
|
||||
NULL is returned.
|
||||
The memory is allocated from EFI boot services memory. It is the responsibility
|
||||
of the caller to free the memory allocated.
|
||||
|
||||
@param NodeType The device node type for the new device node.
|
||||
@ -610,7 +610,7 @@ CreateDeviceNode (
|
||||
@param DevicePath A pointer to a device path data structure.
|
||||
|
||||
@retval TRUE DevicePath is multi-instance.
|
||||
@retval FALSE DevicePath is not multi-instance, or DevicePath
|
||||
@retval FALSE DevicePath is not multi-instance, or DevicePath
|
||||
is NULL or invalid.
|
||||
|
||||
**/
|
||||
@ -626,11 +626,11 @@ IsDevicePathMultiInstance (
|
||||
/**
|
||||
Retrieves the device path protocol from a handle.
|
||||
|
||||
This function returns the device path protocol from the handle specified by Handle.
|
||||
If Handle is NULL or Handle does not contain a device path protocol, then NULL
|
||||
This function returns the device path protocol from the handle specified by Handle.
|
||||
If Handle is NULL or Handle does not contain a device path protocol, then NULL
|
||||
is returned.
|
||||
|
||||
@param Handle The handle from which to retrieve the device
|
||||
|
||||
@param Handle The handle from which to retrieve the device
|
||||
path protocol.
|
||||
|
||||
@return The device path protocol from the handle specified by Handle.
|
||||
@ -659,19 +659,19 @@ DevicePathFromHandle (
|
||||
/**
|
||||
Allocates a device path for a file and appends it to an existing device path.
|
||||
|
||||
If Device is a valid device handle that contains a device path protocol, then
|
||||
a device path for the file specified by FileName is allocated and appended to
|
||||
the device path associated with the handle Device. The allocated device path
|
||||
is returned. If Device is NULL or Device is a handle that does not support the
|
||||
device path protocol, then a device path containing a single device path node
|
||||
If Device is a valid device handle that contains a device path protocol, then
|
||||
a device path for the file specified by FileName is allocated and appended to
|
||||
the device path associated with the handle Device. The allocated device path
|
||||
is returned. If Device is NULL or Device is a handle that does not support the
|
||||
device path protocol, then a device path containing a single device path node
|
||||
for the file specified by FileName is allocated and returned.
|
||||
The memory for the new device path is allocated from EFI boot services memory.
|
||||
The memory for the new device path is allocated from EFI boot services memory.
|
||||
It is the responsibility of the caller to free the memory allocated.
|
||||
|
||||
|
||||
If FileName is NULL, then ASSERT().
|
||||
If FileName is not aligned on a 16-bit boundary, then ASSERT().
|
||||
|
||||
@param Device A pointer to a device handle. This parameter
|
||||
@param Device A pointer to a device handle. This parameter
|
||||
is optional and may be NULL.
|
||||
@param FileName A pointer to a Null-terminated Unicode string.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user