From 24e25d11c0460dfb39fade685375c0e58cbcb40e Mon Sep 17 00:00:00 2001 From: qhuang8 Date: Mon, 26 Jun 2006 10:18:28 +0000 Subject: =?UTF-8?q?=E2=80=A2=09BaseMemoryLib:=20=09Modify=20some=20Aassert?= =?UTF-8?q?()s=20conditions=20to=20sync=20with=20MWG=200.56d=20=09Modify?= =?UTF-8?q?=20some=20defects=20in=20function=20header.=20=E2=80=A2=09PostC?= =?UTF-8?q?odeLib:=20Implement=20PeiDxePostCodeLibReportStatusCode.=20?= =?UTF-8?q?=E2=80=A2=09Misc=20Rename=20BaseDebugLibReportStatusCode=20to?= =?UTF-8?q?=20PeiDxeDebugLibReportStatusCode=20=09Remove=20tabs=20in=20all?= =?UTF-8?q?=20.c=20and=20.h=20files=20in=20MdePkg.=20=09Rename=20PeiServic?= =?UTF-8?q?esReinstallPpi()=20to=20PeiServicesReInstallPpi()=20=09Adjust?= =?UTF-8?q?=20some=20minor=20coding=20style=20in=20PeCoffLoaderGetEntryPoi?= =?UTF-8?q?nterLib()?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@626 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Library/DevicePathLib.h | 132 ++++++++++++++++----------------- 1 file changed, 66 insertions(+), 66 deletions(-) (limited to 'MdePkg/Include/Library/DevicePathLib.h') diff --git a/MdePkg/Include/Library/DevicePathLib.h b/MdePkg/Include/Library/DevicePathLib.h index b42a8fecfd..299d607118 100644 --- a/MdePkg/Include/Library/DevicePathLib.h +++ b/MdePkg/Include/Library/DevicePathLib.h @@ -1,16 +1,16 @@ /** @file - Entry point to a DXE Boot Services Driver + Entry point to a DXE Boot Services Driver - Copyright (c) 2006, Intel Corporation - All rights reserved. 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) 2006, Intel Corporation + All rights reserved. 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. - Module Name: DevicePathLib.h + Module Name: DevicePathLib.h **/ @@ -18,13 +18,13 @@ #define __DEVICE_PATH_LIB_H__ /** - This function returns the size, in bytes, - of the device path data structure specified by DevicePath. - If DevicePath is NULL, then 0 is returned. + This function returns the size, in bytes, + of the device path data structure specified by DevicePath. + If DevicePath is NULL, then 0 is returned. - @param DevicePath A pointer to a device path data structure. + @param DevicePath A pointer to a device path data structure. - @return The size of a device path in bytes. + @return The size of a device path in bytes. **/ UINTN @@ -35,12 +35,12 @@ GetDevicePathSize ( ; /** - This function allocates space for a new copy of the device path - specified by DevicePath. + This function allocates space for a new copy of the device path + specified by DevicePath. - @param DevicePath A pointer to a device path data structure. + @param DevicePath A pointer to a device path data structure. - @return The duplicated device path. + @return The duplicated device path. **/ EFI_DEVICE_PATH_PROTOCOL * @@ -51,18 +51,18 @@ DuplicateDevicePath ( ; /** - This function appends the device path SecondDevicePath - to every device path instance in FirstDevicePath. + This function appends the device path SecondDevicePath + to every device path instance in FirstDevicePath. - @param FirstDevicePath A pointer to a device path data structure. - - @param SecondDevicePath A pointer to a device path data structure. + @param FirstDevicePath A pointer to a device path data structure. + + @param SecondDevicePath A pointer to a device path data structure. - @return - A pointer to the new device path is returned. - NULL is returned if space for the new device path could not be allocated from pool. - It is up to the caller to free the memory used by FirstDevicePath and SecondDevicePath - if they are no longer needed. + @return + A pointer to the new device path is returned. + NULL is returned if space for the new device path could not be allocated from pool. + It is up to the caller to free the memory used by FirstDevicePath and SecondDevicePath + if they are no longer needed. **/ EFI_DEVICE_PATH_PROTOCOL * @@ -95,16 +95,16 @@ AppendDevicePathNode ( ; /** - This function appends the device path instance Instance to the device path Source. - If Source is NULL, then a new device path with one instance is created. + This function appends the device path instance Instance to the device path Source. + If Source is NULL, then a new device path with one instance is created. - @param Source A pointer to a device path data structure. - @param Instance A pointer to a device path instance. + @param Source A pointer to a device path data structure. + @param Instance A pointer to a device path instance. - @return - A pointer to the new device path. - If there is not enough temporary pool memory available to complete this function, - then NULL is returned. + @return + A pointer to the new device path. + If there is not enough temporary pool memory available to complete this function, + then NULL is returned. **/ EFI_DEVICE_PATH_PROTOCOL * @@ -116,17 +116,17 @@ AppendDevicePathInstance ( ; /** - Function retrieves the next device path instance from a device path data structure. + Function retrieves the next device path instance from a device path data structure. - @param DevicePath A pointer to a device path data structure. - - @param Size A pointer to the size of a device path instance in bytes. + @param DevicePath A pointer to a device path data structure. + + @param Size A pointer to the size of a device path instance in bytes. - @return - This function returns a pointer to the current device path instance. - In addition, it returns the size in bytes of the current device path instance in Size, - and a pointer to the next device path instance in DevicePath. - If there are no more device path instances in DevicePath, then DevicePath will be set to NULL. + @return + This function returns a pointer to the current device path instance. + In addition, it returns the size in bytes of the current device path instance in Size, + and a pointer to the next device path instance in DevicePath. + If there are no more device path instances in DevicePath, then DevicePath will be set to NULL. **/ EFI_DEVICE_PATH_PROTOCOL * @@ -138,12 +138,12 @@ GetNextDevicePathInstance ( ; /** - Return TRUE is this is a multi instance device path. + Return TRUE is this is a multi instance device path. - @param DevicePath A pointer to a device path data structure. + @param DevicePath A pointer to a device path data structure. - @retval TRUE If DevicePath is multi-instance. - @retval FALSE If DevicePath is not multi-instance or DevicePath is NULL. + @retval TRUE If DevicePath is multi-instance. + @retval FALSE If DevicePath is not multi-instance or DevicePath is NULL. **/ BOOLEAN @@ -154,13 +154,13 @@ IsDevicePathMultiInstance ( ; /** - This function retrieves the device path protocol from a handle. + This function retrieves the device path protocol from a handle. - @param Handle The handle from which to retrieve the device path protocol. + @param Handle The handle from which to retrieve the device path protocol. - @return - 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. + @return + 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. **/ EFI_DEVICE_PATH_PROTOCOL * @@ -171,18 +171,18 @@ DevicePathFromHandle ( ; /** - This function allocates a device path for a file and appends it to an existing device path. - - @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. - - @return - 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. + This function allocates a device path for a file and appends it to an existing device path. + + @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. + + @return + 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. **/ EFI_DEVICE_PATH_PROTOCOL * -- cgit v1.2.3