Update the copyright notice format

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

/** @file\r
  UEFI Component Name 2 Protocol as defined in the UEFI 2.1 specification.\r
  This protocol is used to retrieve user readable names of drivers \r
  and controllers managed by UEFI Drivers.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
  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
\r
**/\r
\r
#ifndef __EFI_COMPONENT_NAME2_H__\r
#define __EFI_COMPONENT_NAME2_H__\r
\r
///\r
/// Global ID for the Component Name Protocol\r
///\r
#define EFI_COMPONENT_NAME2_PROTOCOL_GUID \\r
  {0x6a7a5cff, 0xe8d9, 0x4f70, { 0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14 } }\r
\r
typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;\r
\r
\r
/**\r
  Retrieves a string that is the user readable name of\r
  the EFI Driver.\r
\r
  @param  This       A pointer to the\r
                     EFI_COMPONENT_NAME2_PROTOCOL instance.\r
  \r
  @param  Language   A pointer to a Null-terminated ASCII string\r
                     array indicating the language. This is the\r
                     language of the driver name that the caller\r
                     is requesting, and it must match one of the\r
                     languages specified in SupportedLanguages.\r
                     The number of languages supported by a\r
                     driver is up to the driver writer. Language\r
                     is specified in RFC 4646 language code\r
                     format.\r
  \r
  @param  DriverName A pointer to the string to return.\r
                     This string is the name of the\r
                     driver specified by This in the language\r
                     specified by Language.\r
\r
  @retval EFI_SUCCESS           The string for the\r
                                Driver specified by This and the\r
                                language specified by Language\r
                                was returned in DriverName.\r
  \r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
  \r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
  \r
  @retval EFI_UNSUPPORTED       The driver specified by This\r
                                does not support the language\r
                                specified by Language.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_COMPONENT_NAME2_GET_DRIVER_NAME)(\r
  IN EFI_COMPONENT_NAME2_PROTOCOL          *This,\r
  IN  CHAR8                                *Language,\r
  OUT CHAR16                               **DriverName\r
  );\r
\r
\r
/**\r
  Retrieves a string that is the user readable name of\r
  the controller that is being managed by an EFI Driver.\r
\r
  @param  This             A pointer to the\r
                           EFI_COMPONENT_NAME2_PROTOCOL instance.\r
\r
  @param  ControllerHandle The handle of a controller that the\r
                           driver specified by This is managing.\r
                           This handle specifies the controller\r
                           whose name is to be returned.\r
\r
  @param  ChildHandle      The handle of the child controller to\r
                           retrieve the name of.  This is an\r
                           optional parameter that may be NULL.\r
                           It will be NULL for device drivers.\r
                           It will also be NULL for bus\r
                           drivers that wish to retrieve the\r
                           name of the bus controller.  It will\r
                           not be NULL for a bus driver that\r
                           wishes to retrieve the name of a\r
                           child controller.\r
\r
  @param  Language         A pointer to a Null-terminated ASCII\r
                           string array indicating the language.\r
                           This is the language of the driver\r
                           name that the caller is requesting,\r
                           and it must match one of the\r
                           languages specified in\r
                           SupportedLanguages. The number of\r
                           languages supported by a driver is up\r
                           to the driver writer. Language is\r
                           specified in RFC 4646 language code\r
                           format.\r
\r
  @param  ControllerName   A pointer to the string to return.\r
                           This string is the name of the controller\r
                           specified by ControllerHandle and ChildHandle\r
                           in the language specified by Language\r
                           from the point of view of the driver\r
                           specified by This.\r
\r
  @retval EFI_SUCCESS           The string for the user\r
                                readable name in the language\r
                                specified by Language for the\r
                                driver specified by This was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it\r
                                is not a valid EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is\r
                                not currently managing the\r
                                controller specified by\r
                                ControllerHandle and\r
                                ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This\r
                                does not support the language\r
                                specified by Language.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)(\r
  IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r
  IN  EFI_HANDLE                  ControllerHandle,\r
  IN  EFI_HANDLE                  ChildHandle        OPTIONAL,\r
  IN  CHAR8                       *Language,\r
  OUT CHAR16                      **ControllerName\r
  );\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_NAME2_PROTOCOL {\r
  EFI_COMPONENT_NAME2_GET_DRIVER_NAME      GetDriverName;\r
  EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME  GetControllerName;\r
\r
  ///\r
  /// A Null-terminated ASCII string array that contains one or more\r
  /// supported language codes. This is the list of language codes that\r
  /// this protocol supports. The number of languages supported by a\r
  /// driver is up to the driver writer. SupportedLanguages is\r
  /// specified in RFC 4646 format.  \r
  ///\r
  CHAR8                                    *SupportedLanguages;\r
};\r
\r
extern EFI_GUID gEfiComponentName2ProtocolGuid;\r
\r
#endif\r