| /** @file | |
| EFI Component Name 2 Protocol | |
| Copyright (c) 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 | |
| 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: ComponentName2.h | |
| @par Revision Reference: | |
| Component Name 2 Protocol from the UEFI 2.1 specification. | |
| **/ | |
| #ifndef _EFI_COMPONENT_NAME2_H_ | |
| #define _EFI_COMPONENT_NAME2_H_ | |
| // | |
| // Global ID for the Component Name Protocol | |
| // | |
| #define EFI_COMPONENT_NAME2_PROTOCOL_GUID \ | |
| { \ | |
| 0x6a7a5cff, 0xe8d9, 0x4f70, {0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14} \ | |
| } | |
| typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; | |
| /** | |
| 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 or DriverName is NULL. | |
| @retval EFI_UNSUPPORTED The driver specified by This does not support | |
| the language specified by Language. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ( | |
| IN EFI_COMPONENT_NAME2_PROTOCOL *This, | |
| IN CHAR8 *Language, | |
| OUT CHAR16 **DriverName | |
| ); | |
| /** | |
| 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 controller 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; | |
| ChildHandle is not NULL and it is not a valid | |
| EFI_HANDLE;Language is NULL;ControllerName is | |
| NULL. | |
| @retval EFI_UNSUPPORTED The driver specified by This is not currently | |
| managing the controller specified by | |
| ControllerHandle and ChildHandle;The driver | |
| specified by This does not support the language | |
| specified by Language. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ( | |
| IN EFI_COMPONENT_NAME2_PROTOCOL *This, | |
| IN EFI_HANDLE ControllerHandle, | |
| IN EFI_HANDLE ChildHandle OPTIONAL, | |
| IN CHAR8 *Language, | |
| OUT CHAR16 **ControllerName | |
| ); | |
| // | |
| // Interface structure for the Component Name 2 Protocol | |
| // | |
| struct _EFI_COMPONENT_NAME2_PROTOCOL { | |
| EFI_COMPONENT_NAME2_GET_DRIVER_NAME GetDriverName; | |
| EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME GetControllerName; | |
| CHAR8 *SupportedLanguages; | |
| }; | |
| // | |
| // Extern the GUID for protocol users. | |
| // | |
| extern EFI_GUID gEfiComponentName2ProtocolGuid; | |
| #endif |