| 1 | /** @file
|
|---|
| 2 | EFI Component Name Protocol as defined in the EFI 1.1 specification.
|
|---|
| 3 | This protocol is used to retrieve user readable names of EFI Drivers
|
|---|
| 4 | and controllers managed by EFI Drivers.
|
|---|
| 5 |
|
|---|
| 6 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
|---|
| 7 | This program and the accompanying materials are licensed and made available under
|
|---|
| 8 | the terms and conditions of the BSD License that accompanies this distribution.
|
|---|
| 9 | The full text of the license may be found at
|
|---|
| 10 | http://opensource.org/licenses/bsd-license.php.
|
|---|
| 11 |
|
|---|
| 12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|---|
| 13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|---|
| 14 |
|
|---|
| 15 | **/
|
|---|
| 16 |
|
|---|
| 17 | #ifndef __EFI_COMPONENT_NAME_H__
|
|---|
| 18 | #define __EFI_COMPONENT_NAME_H__
|
|---|
| 19 |
|
|---|
| 20 | ///
|
|---|
| 21 | /// The global ID for the Component Name Protocol.
|
|---|
| 22 | ///
|
|---|
| 23 | #define EFI_COMPONENT_NAME_PROTOCOL_GUID \
|
|---|
| 24 | { \
|
|---|
| 25 | 0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
|
|---|
| 26 | }
|
|---|
| 27 |
|
|---|
| 28 | typedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL;
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 | /**
|
|---|
| 32 | Retrieves a Unicode string that is the user-readable name of the EFI Driver.
|
|---|
| 33 |
|
|---|
| 34 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
|---|
| 35 | @param Language A pointer to a three-character ISO 639-2 language identifier.
|
|---|
| 36 | This is the language of the driver name that that the caller
|
|---|
| 37 | is requesting, and it must match one of the languages specified
|
|---|
| 38 | in SupportedLanguages. The number of languages supported by a
|
|---|
| 39 | driver is up to the driver writer.
|
|---|
| 40 | @param DriverName A pointer to the Unicode string to return. This Unicode string
|
|---|
| 41 | is the name of the driver specified by This in the language
|
|---|
| 42 | specified by Language.
|
|---|
| 43 |
|
|---|
| 44 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This
|
|---|
| 45 | and the language specified by Language was returned
|
|---|
| 46 | in DriverName.
|
|---|
| 47 | @retval EFI_INVALID_PARAMETER Language is NULL.
|
|---|
| 48 | @retval EFI_INVALID_PARAMETER DriverName is NULL.
|
|---|
| 49 | @retval EFI_UNSUPPORTED The driver specified by This does not support the
|
|---|
| 50 | language specified by Language.
|
|---|
| 51 |
|
|---|
| 52 | **/
|
|---|
| 53 | typedef
|
|---|
| 54 | EFI_STATUS
|
|---|
| 55 | (EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME)(
|
|---|
| 56 | IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
|---|
| 57 | IN CHAR8 *Language,
|
|---|
| 58 | OUT CHAR16 **DriverName
|
|---|
| 59 | );
|
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 | /**
|
|---|
| 63 | Retrieves a Unicode string that is the user readable name of the controller
|
|---|
| 64 | that is being managed by an EFI Driver.
|
|---|
| 65 |
|
|---|
| 66 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
|---|
| 67 | @param ControllerHandle The handle of a controller that the driver specified by
|
|---|
| 68 | This is managing. This handle specifies the controller
|
|---|
| 69 | whose name is to be returned.
|
|---|
| 70 | @param ChildHandle The handle of the child controller to retrieve the name
|
|---|
| 71 | of. This is an optional parameter that may be NULL. It
|
|---|
| 72 | will be NULL for device drivers. It will also be NULL
|
|---|
| 73 | for a bus drivers that wish to retrieve the name of the
|
|---|
| 74 | bus controller. It will not be NULL for a bus driver
|
|---|
| 75 | that wishes to retrieve the name of a child controller.
|
|---|
| 76 | @param Language A pointer to a three character ISO 639-2 language
|
|---|
| 77 | identifier. This is the language of the controller name
|
|---|
| 78 | that the caller is requesting, and it must match one
|
|---|
| 79 | of the languages specified in SupportedLanguages. The
|
|---|
| 80 | number of languages supported by a driver is up to the
|
|---|
| 81 | driver writer.
|
|---|
| 82 | @param ControllerName A pointer to the Unicode string to return. This Unicode
|
|---|
| 83 | string is the name of the controller specified by
|
|---|
| 84 | ControllerHandle and ChildHandle in the language specified
|
|---|
| 85 | by Language, from the point of view of the driver specified
|
|---|
| 86 | by This.
|
|---|
| 87 |
|
|---|
| 88 | @retval EFI_SUCCESS The Unicode string for the user-readable name in the
|
|---|
| 89 | language specified by Language for the driver
|
|---|
| 90 | specified by This was returned in DriverName.
|
|---|
| 91 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
|
|---|
| 92 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
|
|---|
| 93 | @retval EFI_INVALID_PARAMETER Language is NULL.
|
|---|
| 94 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
|---|
| 95 | @retval EFI_UNSUPPORTED The driver specified by This is not currently managing
|
|---|
| 96 | the controller specified by ControllerHandle and
|
|---|
| 97 | ChildHandle.
|
|---|
| 98 | @retval EFI_UNSUPPORTED The driver specified by This does not support the
|
|---|
| 99 | language specified by Language.
|
|---|
| 100 |
|
|---|
| 101 | **/
|
|---|
| 102 | typedef
|
|---|
| 103 | EFI_STATUS
|
|---|
| 104 | (EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)(
|
|---|
| 105 | IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
|---|
| 106 | IN EFI_HANDLE ControllerHandle,
|
|---|
| 107 | IN EFI_HANDLE ChildHandle OPTIONAL,
|
|---|
| 108 | IN CHAR8 *Language,
|
|---|
| 109 | OUT CHAR16 **ControllerName
|
|---|
| 110 | );
|
|---|
| 111 |
|
|---|
| 112 | ///
|
|---|
| 113 | /// This protocol is used to retrieve user readable names of drivers
|
|---|
| 114 | /// and controllers managed by UEFI Drivers.
|
|---|
| 115 | ///
|
|---|
| 116 | struct _EFI_COMPONENT_NAME_PROTOCOL {
|
|---|
| 117 | EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName;
|
|---|
| 118 | EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;
|
|---|
| 119 | ///
|
|---|
| 120 | /// A Null-terminated ASCII string that contains one or more
|
|---|
| 121 | /// ISO 639-2 language codes. This is the list of language codes
|
|---|
| 122 | /// that this protocol supports.
|
|---|
| 123 | ///
|
|---|
| 124 | CHAR8 *SupportedLanguages;
|
|---|
| 125 | };
|
|---|
| 126 |
|
|---|
| 127 | extern EFI_GUID gEfiComponentNameProtocolGuid;
|
|---|
| 128 |
|
|---|
| 129 | #endif
|
|---|
