MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / ComponentName.h

diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 34dd5bd9fb267c98a134afb17583cd336b09e4c4..14c1343d4c3f0b443b9f833fa646848fc4c99c23 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -1,25 +1,19 @@
 /** @file\r
-  EFI Component Name Protocol\r
+  EFI Component Name Protocol as defined in the EFI 1.1 specification.\r
+  This protocol is used to retrieve user readable names of EFI Drivers\r
+  and controllers managed by EFI Drivers.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
 #ifndef __EFI_COMPONENT_NAME_H__\r
 #define __EFI_COMPONENT_NAME_H__\r
 \r
-#include <PiDxe.h>\r
-\r
-//\r
-// Global ID for the Component Name Protocol\r
-//\r
+///\r
+/// The global ID for the Component Name Protocol.\r
+///\r
 #define EFI_COMPONENT_NAME_PROTOCOL_GUID \\r
   { \\r
     0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -29,10 +23,10 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL  EFI_COMPONENT_NAME_PROTOCOL;
 \r
 \r
 /**\r
-  Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
+  Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r
 \r
   @param  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
-  @param  Language   A pointer to a three character ISO 639-2 language identifier.\r
+  @param  Language   A pointer to a three-character ISO 639-2 language identifier.\r
                      This is the language of the driver name that that the caller\r
                      is requesting, and it must match one of the languages specified\r
                      in SupportedLanguages.  The number of languages supported by a\r
@@ -52,7 +46,7 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL  EFI_COMPONENT_NAME_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME) (\r
+(EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME)(\r
   IN EFI_COMPONENT_NAME_PROTOCOL           *This,\r
   IN  CHAR8                                *Language,\r
   OUT CHAR16                               **DriverName\r
@@ -75,20 +69,20 @@ EFI_STATUS
                            that wishes to retrieve the name of a child controller.\r
   @param  Language         A pointer to a three character ISO 639-2 language\r
                            identifier.  This is the language of the controller name\r
-                           that that the caller is requesting, and it must match one\r
+                           that the caller is requesting, and it must match one\r
                            of the languages specified in SupportedLanguages.  The\r
                            number of languages supported by a driver is up to the\r
                            driver writer.\r
   @param  ControllerName   A pointer to the Unicode string to return.  This Unicode\r
                            string is the name of the controller specified by\r
                            ControllerHandle and ChildHandle in the language specified\r
-                           by Language from the point of view of the driver specified\r
+                           by Language, from the point of view of the driver specified\r
                            by This.\r
 \r
-  @retval EFI_SUCCESS           The Unicode string for the user readable name in the\r
+  @retval EFI_SUCCESS           The Unicode string for the user-readable name in the\r
                                 language specified by Language for the driver\r
                                 specified by This was returned in DriverName.\r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
   @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
@@ -101,7 +95,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME) (\r
+(EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)(\r
   IN EFI_COMPONENT_NAME_PROTOCOL                              *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle        OPTIONAL,\r
@@ -109,12 +103,18 @@ EFI_STATUS
   OUT CHAR16                                                  **ControllerName\r
   );\r
 \r
-//\r
-// Interface structure for the Component Name Protocol\r
-//\r
+///\r
+/// This protocol is used to retrieve user readable names of drivers\r
+/// and controllers managed by UEFI Drivers.\r
+///\r
 struct _EFI_COMPONENT_NAME_PROTOCOL {\r
   EFI_COMPONENT_NAME_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME_GET_CONTROLLER_NAME  GetControllerName;\r
+  ///\r
+  /// A Null-terminated ASCII string that contains one or more\r
+  /// ISO 639-2 language codes. This is the list of language codes\r
+  /// that this protocol supports.\r
+  ///\r
   CHAR8                                   *SupportedLanguages;\r
 };\r
 \r