+++ /dev/null
-/** @file\r
- EFI Component Name 2 Protocol\r
-\r
- Copyright (c) 2007, 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
-\r
- Module Name: ComponentName2.h\r
-\r
- @par Revision Reference:\r
- Component Name 2 Protocol from the UEFI 2.1 specification.\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
-\r
-#define EFI_COMPONENT_NAME2_PROTOCOL_GUID \\r
- { \\r
- 0x6a7a5cff, 0xe8d9, 0x4f70, {0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14} \\r
- }\r
-\r
-typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL;\r
-\r
-/**\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 \r
- instance. \r
- @param Language A pointer to a Null-terminated ASCII string array indicating the\r
- language. This is the language of the driver name that the caller\r
- is requesting, and it must match one of the languages specified in\r
- SupportedLanguages. The number of languages supported by a\r
- driver is up to the driver writer. Language is specified in RFC\r
- 3066 language code format.\r
- @param DriverName A pointer to the Unicode string to return. This \r
- Unicode string is the name of the driver \r
- specified by This in the language specified by \r
- Language. \r
-\r
- @retval EFI_SUCCESS The Unicode string for the Driver specified by \r
- This and the language specified by Language was \r
- returned in DriverName. \r
- @retval EFI_INVALID_PARAMETER Language is NULL or DriverName is NULL. \r
- @retval EFI_UNSUPPORTED The driver specified by This does not support \r
- the language 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
- Retrieves a Unicode string that is the user readable name of the controller\r
- that is being managed by an EFI Driver.\r
-\r
- @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL \r
- instance. \r
- @param ControllerHandle The handle of a controller that the driver \r
- specified by This is managing. This handle \r
- specifies the controller whose name is to be \r
- returned. \r
- @param ChildHandle The handle of the child controller to retrieve \r
- the name of. This is an optional parameter \r
- that may be NULL. It will be NULL for device \r
- drivers. It will also be NULL for a bus \r
- drivers that wish to retrieve the name of the \r
- bus controller. It will not be NULL for a bus \r
- driver that wishes to retrieve the name of a \r
- child controller. \r
- @param Language A pointer to a Null- terminated ASCII string array indicating the\r
- language. This is the language of the controller name that the\r
- caller is requesting, and it must match one of the languages\r
- specified in SupportedLanguages. The number of languages\r
- supported by a driver is up to the driver writer. Language is\r
- specified in RFC 3066 language code format.\r
- @param ControllerName A pointer to the Unicode string to return. This \r
- Unicode string is the name of the controller \r
- specified by ControllerHandle and ChildHandle \r
- in the language specified by Language from the \r
- point of view of the driver specified by This. \r
-\r
- @retval EFI_SUCCESS The Unicode string for the user readable name in \r
- the language specified by Language for the \r
- driver specified by This was returned in \r
- DriverName. \r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE; \r
- ChildHandle is not NULL and it is not a valid \r
- EFI_HANDLE;Language is NULL;ControllerName is \r
- NULL. \r
- @retval EFI_UNSUPPORTED The driver specified by This is not currently \r
- managing the controller specified by \r
- ControllerHandle and ChildHandle;The driver \r
- specified by This 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
-//\r
-// Interface structure for the Component Name 2 Protocol\r
-//\r
-struct _EFI_COMPONENT_NAME2_PROTOCOL {\r
- EFI_COMPONENT_NAME2_GET_DRIVER_NAME GetDriverName;\r
- EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME GetControllerName;\r
- CHAR8 *SupportedLanguages;\r
-};\r
-\r
-//\r
-// Extern the GUID for protocol users.\r
-//\r
-extern EFI_GUID gEfiComponentName2ProtocolGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff