pdated code per coding standard. Changed comments, converted all \ to / and removed the extra generated files by merging them into existing files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2736 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 120 insertions, 91 deletions

diff --git a/MdeModulePkg/Universal/Disk/Partition/Dxe/ComponentName.c b/MdeModulePkg/Universal/Disk/Partition/Dxe/ComponentName.c
index ab534926c2..e922cb0f92 100644
--- a/MdeModulePkg/Universal/Disk/Partition/Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Disk/Partition/Dxe/ComponentName.c
@@ -1,26 +1,16 @@
-/*++

+/** @file

+  UEFI Component Name protocol for Partition driver.

+  

+  Copyright (c) 2006 - 2007, 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:

-

-  ComponentName.c

-

-Abstract:

-

---*/

-

-//

-// Include common header file for this module.

-//

-#include "CommonHeader.h"

+**/

 

 #include "Partition.h"

 

@@ -44,6 +34,44 @@ static EFI_UNICODE_STRING_TABLE mPartitionDriverNameTable[] = {
   }

 };

 

+

+

+/**

+  Retrieves a Unicode string that is the user readable name of

+  the EFI Driver.

+

+  @param  This       A pointer to the

+                     EFI_COMPONENT_NAME_PROTOCOL instance.

+  

+  @param  Language   A pointer to a Null-terminated ASCII string

+                     array indicating the language. This is the

+                     language of the driver name that the caller

+                     is requesting, and it must match one of the

+                     languages specified in SupportedLanguages.

+                     The number of languages supported by a

+                     driver is up to the driver writer. Language

+                     is specified in RFC 3066 language code

+                     format.

+  

+  @param  DriverName A pointer to the Unicode string to return.

+                     This Unicode string is the name of the

+                     driver specified by This in the language

+                     specified by Language.

+

+  @retval EFI_SUCCESS           The Unicode string for the

+                                Driver specified by This and the

+                                language specified by Language

+                                was returned in DriverName.

+  

+  @retval EFI_INVALID_PARAMETER Language is NULL.

+  

+  @retval EFI_INVALID_PARAMETER DriverName is NULL.

+  

+  @retval EFI_UNSUPPORTED       The driver specified by This

+                                does not support the language

+                                specified by Language.

+

+**/

 EFI_STATUS

 EFIAPI

 PartitionComponentNameGetDriverName (

@@ -51,32 +79,6 @@ PartitionComponentNameGetDriverName (
   IN  CHAR8                        *Language,

   OUT CHAR16                       **DriverName

   )

-/*++

-

-  Routine Description:

-    Retrieves a Unicode string that is the user readable name of the EFI Driver.

-

-  Arguments:

-    This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

-    Language   - A pointer to a three character ISO 639-2 language identifier.

-                 This is the language of the driver name that that the caller 

-                 is requesting, and it must match one of the languages specified

-                 in SupportedLanguages.  The number of languages supported by a 

-                 driver is up to the driver writer.

-    DriverName - A pointer to the Unicode string to return.  This Unicode string

-                 is the name of the driver specified by This in the language 

-                 specified by Language.

-

-  Returns:

-    EFI_SUCCESS           - The Unicode string for the Driver specified by This

-                            and the language specified by Language was returned 

-                            in DriverName.

-    EFI_INVALID_PARAMETER - Language is NULL.

-    EFI_INVALID_PARAMETER - DriverName is NULL.

-    EFI_UNSUPPORTED       - The driver specified by This does not support the 

-                            language specified by Language.

-

---*/

 {

   return LookupUnicodeString (

           Language,

@@ -86,6 +88,77 @@ PartitionComponentNameGetDriverName (
           );

 }

 

+

+/**

+  Retrieves a Unicode string that is the user readable name of

+  the controller that is being managed by an EFI Driver.

+

+  @param  This             A pointer to the

+                           EFI_COMPONENT_NAME_PROTOCOL instance.

+

+  @param  ControllerHandle The handle of a controller that the

+                           driver specified by This is managing.

+                           This handle specifies the controller

+                           whose name is to be returned.

+

+  @param ChildHandle      The handle of the child controller to

+                           retrieve the name of.  This is an

+                           optional parameter that may be NULL.

+                           It will be NULL for device drivers.

+                           It will also be NULL for a bus

+                           drivers that wish to retrieve the

+                           name of the bus controller.  It will

+                           not be NULL for a bus driver that

+                           wishes to retrieve the name of a

+                           child controller.

+

+  @param  Language         A pointer to a Null-terminated ASCII

+                           string array indicating the language.

+                           This is the language of the driver

+                           name that the caller is requesting,

+                           and it must match one of the

+                           languages specified in

+                           SupportedLanguages. The number of

+                           languages supported by a driver is up

+                           to the driver writer. Language is

+                           specified in RFC 3066 language code

+                           format.

+

+  @param  ControllerName   A pointer to the Unicode string to

+                           return.  This Unicode string is the

+                           name of the controller specified by

+                           ControllerHandle and ChildHandle in

+                           the language specified by Language

+                           from the point of view of the driver

+                           specified by This.

+

+  @retval EFI_SUCCESS           The Unicode string for the user

+                                readable name in the language

+                                specified by Language for the

+                                driver specified by This was

+                                returned in DriverName.

+

+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid

+                                EFI_HANDLE.

+

+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it

+                                is not a valid EFI_HANDLE.

+

+  @retval EFI_INVALID_PARAMETER Language is NULL.

+

+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.

+

+  @retval EFI_UNSUPPORTED       The driver specified by This is

+                                not currently managing the

+                                controller specified by

+                                ControllerHandle and

+                                ChildHandle.

+

+  @retval EFI_UNSUPPORTED       The driver specified by This

+                                does not support the language

+                                specified by Language.

+

+**/

 EFI_STATUS

 EFIAPI

 PartitionComponentNameGetControllerName (

@@ -95,50 +168,6 @@ PartitionComponentNameGetControllerName (
   IN  CHAR8                                           *Language,

   OUT CHAR16                                          **ControllerName

   )

-/*++

-

-  Routine Description:

-    Retrieves a Unicode string that is the user readable name of the controller

-    that is being managed by an EFI Driver.

-

-  Arguments:

-    This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

-    ControllerHandle - The handle of a controller that the driver specified by 

-                       This is managing.  This handle specifies the controller 

-                       whose name is to be returned.

-    ChildHandle      - The handle of the child controller to retrieve the name 

-                       of.  This is an optional parameter that may be NULL.  It 

-                       will be NULL for device drivers.  It will also be NULL 

-                       for a bus drivers that wish to retrieve the name of the 

-                       bus controller.  It will not be NULL for a bus driver 

-                       that wishes to retrieve the name of a child controller.

-    Language         - A pointer to a three character ISO 639-2 language 

-                       identifier.  This is the language of the controller name 

-                       that that the caller is requesting, and it must match one

-                       of the languages specified in SupportedLanguages.  The 

-                       number of languages supported by a driver is up to the 

-                       driver writer.

-    ControllerName   - A pointer to the Unicode string to return.  This Unicode

-                       string is the name of the controller specified by 

-                       ControllerHandle and ChildHandle in the language specified

-                       by Language from the point of view of the driver specified

-                       by This. 

-

-  Returns:

-    EFI_SUCCESS           - The Unicode string for the user readable name in the 

-                            language specified by Language for the driver 

-                            specified by This was returned in DriverName.

-    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.

-    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.

-    EFI_INVALID_PARAMETER - Language is NULL.

-    EFI_INVALID_PARAMETER - ControllerName is NULL.

-    EFI_UNSUPPORTED       - The driver specified by This is not currently managing 

-                            the controller specified by ControllerHandle and 

-                            ChildHandle.

-    EFI_UNSUPPORTED       - The driver specified by This does not support the 

-                            language specified by Language.

-

---*/

 {

   return EFI_UNSUPPORTED;

 }