iPXE
ComponentName.h
Go to the documentation of this file.
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 FILE_LICENCE ( BSD3 );
21 
22 ///
23 /// The global ID for the Component Name Protocol.
24 ///
25 #define EFI_COMPONENT_NAME_PROTOCOL_GUID \
26  { \
27  0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
28  }
29 
31 
32 
33 /**
34  Retrieves a Unicode string that is the user-readable name of the EFI Driver.
35 
36  @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
37  @param Language A pointer to a three-character ISO 639-2 language identifier.
38  This is the language of the driver name that that the caller
39  is requesting, and it must match one of the languages specified
40  in SupportedLanguages. The number of languages supported by a
41  driver is up to the driver writer.
42  @param DriverName A pointer to the Unicode string to return. This Unicode string
43  is the name of the driver specified by This in the language
44  specified by Language.
45 
46  @retval EFI_SUCCESS The Unicode string for the Driver specified by This
47  and the language specified by Language was returned
48  in DriverName.
49  @retval EFI_INVALID_PARAMETER Language is NULL.
50  @retval EFI_INVALID_PARAMETER DriverName is NULL.
51  @retval EFI_UNSUPPORTED The driver specified by This does not support the
52  language specified by Language.
53 
54 **/
55 typedef
59  IN CHAR8 *Language,
60  OUT CHAR16 **DriverName
61  );
62 
63 
64 /**
65  Retrieves a Unicode string that is the user readable name of the controller
66  that is being managed by an EFI Driver.
67 
68  @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
69  @param ControllerHandle The handle of a controller that the driver specified by
70  This is managing. This handle specifies the controller
71  whose name is to be returned.
72  @param ChildHandle The handle of the child controller to retrieve the name
73  of. This is an optional parameter that may be NULL. It
74  will be NULL for device drivers. It will also be NULL
75  for a bus drivers that wish to retrieve the name of the
76  bus controller. It will not be NULL for a bus driver
77  that wishes to retrieve the name of a child controller.
78  @param Language A pointer to a three character ISO 639-2 language
79  identifier. This is the language of the controller name
80  that the caller is requesting, and it must match one
81  of the languages specified in SupportedLanguages. The
82  number of languages supported by a driver is up to the
83  driver writer.
84  @param ControllerName A pointer to the Unicode string to return. This Unicode
85  string is the name of the controller specified by
86  ControllerHandle and ChildHandle in the language specified
87  by Language, from the point of view of the driver specified
88  by This.
89 
90  @retval EFI_SUCCESS The Unicode string for the user-readable name in the
91  language specified by Language for the driver
92  specified by This was returned in DriverName.
93  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
94  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
95  @retval EFI_INVALID_PARAMETER Language is NULL.
96  @retval EFI_INVALID_PARAMETER ControllerName is NULL.
97  @retval EFI_UNSUPPORTED The driver specified by This is not currently managing
98  the controller specified by ControllerHandle and
99  ChildHandle.
100  @retval EFI_UNSUPPORTED The driver specified by This does not support the
101  language specified by Language.
102 
103 **/
104 typedef
109  IN EFI_HANDLE ChildHandle OPTIONAL,
110  IN CHAR8 *Language,
111  OUT CHAR16 **ControllerName
112  );
113 
114 ///
115 /// This protocol is used to retrieve user readable names of drivers
116 /// and controllers managed by UEFI Drivers.
117 ///
121  ///
122  /// A Null-terminated ASCII string that contains one or more
123  /// ISO 639-2 language codes. This is the list of language codes
124  /// that this protocol supports.
125  ///
127 };
128 
130 
131 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:340
This protocol is used to retrieve user readable names of drivers and controllers managed by UEFI Driv...
FILE_LICENCE(BSD3)
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName
unsigned short CHAR16
Definition: ProcessorBind.h:59
EFI_STATUS(EFIAPI * EFI_COMPONENT_NAME_GET_DRIVER_NAME)(IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName)
Retrieves a Unicode string that is the user-readable name of the EFI Driver.
Definition: ComponentName.h:57
EFI_GUID gEfiComponentNameProtocolGuid
EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName
#define OUT
Definition: mlx_utils.h:29
CHAR8 * SupportedLanguages
A Null-terminated ASCII string that contains one or more ISO 639-2 language codes.
#define EFIAPI
EFI_HANDLE ControllerHandle
Definition: efi_bofm.c:109
EFI_STATUS(EFIAPI * EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)(IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT CHAR16 **ControllerName)
Retrieves a Unicode string that is the user readable name of the controller that is being managed by ...
#define IN
Definition: mlx_utils.h:28
char CHAR8
Definition: ProcessorBind.h:63
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
Definition: efi.h:55