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:
@ -8,14 +8,14 @@
|
||||
environment varibles. Multi-instance device paths should never be placed
|
||||
on a Handle.
|
||||
|
||||
Copyright (c) 2013, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
Copyright (c) 2013 - 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
@ -29,14 +29,14 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *mDevicePathLib
|
||||
/**
|
||||
The constructor function caches the pointer to DevicePathUtilites protocol,
|
||||
DevicePathToText protocol and DevicePathFromText protocol.
|
||||
|
||||
|
||||
The constructor function locates these three protocols from protocol database.
|
||||
It will caches the pointer to local protocol instance if that operation fails
|
||||
and it will always return EFI_SUCCESS.
|
||||
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.
|
||||
|
||||
**/
|
||||
@ -62,7 +62,7 @@ UefiDevicePathLibOptionalDevicePathProtocolConstructor (
|
||||
/**
|
||||
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.
|
||||
|
||||
@ -88,18 +88,18 @@ 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. 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.
|
||||
|
||||
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.
|
||||
|
||||
@param DevicePath A pointer to a device path data structure.
|
||||
|
||||
@retval NULL DevicePath is NULL or invalid.
|
||||
@retval Others A pointer to the duplicated device path.
|
||||
|
||||
|
||||
**/
|
||||
EFI_DEVICE_PATH_PROTOCOL *
|
||||
EFIAPI
|
||||
@ -117,21 +117,21 @@ DuplicateDevicePath (
|
||||
/**
|
||||
Creates a new device path by appending a second device path to a first device path.
|
||||
|
||||
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. If both FirstDevicePath and
|
||||
SecondDevicePath are NULL, then a copy of an end-of-device-path is returned.
|
||||
|
||||
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. If both FirstDevicePath and
|
||||
SecondDevicePath are NULL, then a copy of an end-of-device-path is 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.
|
||||
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.
|
||||
@ -155,18 +155,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
|
||||
in an allocated buffer. The end-of-device-path device node is moved after the
|
||||
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.
|
||||
@ -174,9 +174,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.
|
||||
|
||||
**/
|
||||
@ -197,20 +197,20 @@ AppendDevicePathNode (
|
||||
/**
|
||||
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.
|
||||
|
||||
@ -235,25 +235,25 @@ AppendDevicePathInstance (
|
||||
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 DevicePath points to a invalid device path, 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.
|
||||
@ -276,13 +276,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.
|
||||
@ -318,7 +318,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.
|
||||
|
||||
**/
|
||||
|
Reference in New Issue
Block a user