]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
4ca9b6c4 | 2 | EFI Component Name Protocol as defined in the EFI 1.1 specification.\r |
9095d37b | 3 | This protocol is used to retrieve user readable names of EFI Drivers\r |
4ca9b6c4 | 4 | and controllers managed by EFI Drivers.\r |
d1f95000 | 5 | \r |
9095d37b | 6 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
d1f95000 | 8 | \r |
d1f95000 | 9 | **/\r |
10 | \r | |
11 | #ifndef __EFI_COMPONENT_NAME_H__\r | |
12 | #define __EFI_COMPONENT_NAME_H__\r | |
13 | \r | |
99e8ed21 | 14 | ///\r |
af2dc6a7 | 15 | /// The global ID for the Component Name Protocol.\r |
99e8ed21 | 16 | ///\r |
d1f95000 | 17 | #define EFI_COMPONENT_NAME_PROTOCOL_GUID \\r |
18 | { \\r | |
19 | 0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r | |
20 | }\r | |
21 | \r | |
2f88bd3a | 22 | typedef struct _EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL;\r |
d1f95000 | 23 | \r |
24 | /**\r | |
af2dc6a7 | 25 | Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r |
d1f95000 | 26 | \r |
27 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
af2dc6a7 | 28 | @param Language A pointer to a three-character ISO 639-2 language identifier.\r |
d1f95000 | 29 | This is the language of the driver name that that the caller\r |
30 | is requesting, and it must match one of the languages specified\r | |
31 | in SupportedLanguages. The number of languages supported by a\r | |
32 | driver is up to the driver writer.\r | |
33 | @param DriverName A pointer to the Unicode string to return. This Unicode string\r | |
34 | is the name of the driver specified by This in the language\r | |
35 | specified by Language.\r | |
36 | \r | |
37 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r | |
38 | and the language specified by Language was returned\r | |
39 | in DriverName.\r | |
40 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
41 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
42 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
43 | language specified by Language.\r | |
44 | \r | |
45 | **/\r | |
46 | typedef\r | |
47 | EFI_STATUS\r | |
8b13229b | 48 | (EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME)(\r |
d1f95000 | 49 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
50 | IN CHAR8 *Language,\r | |
51 | OUT CHAR16 **DriverName\r | |
52 | );\r | |
53 | \r | |
d1f95000 | 54 | /**\r |
55 | Retrieves a Unicode string that is the user readable name of the controller\r | |
56 | that is being managed by an EFI Driver.\r | |
57 | \r | |
58 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
59 | @param ControllerHandle The handle of a controller that the driver specified by\r | |
60 | This is managing. This handle specifies the controller\r | |
61 | whose name is to be returned.\r | |
62 | @param ChildHandle The handle of the child controller to retrieve the name\r | |
63 | of. This is an optional parameter that may be NULL. It\r | |
64 | will be NULL for device drivers. It will also be NULL\r | |
65 | for a bus drivers that wish to retrieve the name of the\r | |
66 | bus controller. It will not be NULL for a bus driver\r | |
67 | that wishes to retrieve the name of a child controller.\r | |
68 | @param Language A pointer to a three character ISO 639-2 language\r | |
69 | identifier. This is the language of the controller name\r | |
af2dc6a7 | 70 | that the caller is requesting, and it must match one\r |
d1f95000 | 71 | of the languages specified in SupportedLanguages. The\r |
72 | number of languages supported by a driver is up to the\r | |
73 | driver writer.\r | |
74 | @param ControllerName A pointer to the Unicode string to return. This Unicode\r | |
75 | string is the name of the controller specified by\r | |
76 | ControllerHandle and ChildHandle in the language specified\r | |
af2dc6a7 | 77 | by Language, from the point of view of the driver specified\r |
d1f95000 | 78 | by This.\r |
79 | \r | |
af2dc6a7 | 80 | @retval EFI_SUCCESS The Unicode string for the user-readable name in the\r |
d1f95000 | 81 | language specified by Language for the driver\r |
82 | specified by This was returned in DriverName.\r | |
18bd7e85 | 83 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
d1f95000 | 84 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r |
85 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
86 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
87 | @retval EFI_UNSUPPORTED The driver specified by This is not currently managing\r | |
88 | the controller specified by ControllerHandle and\r | |
89 | ChildHandle.\r | |
90 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
91 | language specified by Language.\r | |
92 | \r | |
93 | **/\r | |
94 | typedef\r | |
95 | EFI_STATUS\r | |
8b13229b | 96 | (EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)(\r |
d1f95000 | 97 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
98 | IN EFI_HANDLE ControllerHandle,\r | |
99 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
100 | IN CHAR8 *Language,\r | |
101 | OUT CHAR16 **ControllerName\r | |
102 | );\r | |
103 | \r | |
44717a39 | 104 | ///\r |
9095d37b | 105 | /// This protocol is used to retrieve user readable names of drivers\r |
44717a39 | 106 | /// and controllers managed by UEFI Drivers.\r |
107 | ///\r | |
d1f95000 | 108 | struct _EFI_COMPONENT_NAME_PROTOCOL {\r |
2f88bd3a MK |
109 | EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName;\r |
110 | EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;\r | |
8b6c989b | 111 | ///\r |
112 | /// A Null-terminated ASCII string that contains one or more\r | |
113 | /// ISO 639-2 language codes. This is the list of language codes\r | |
9095d37b | 114 | /// that this protocol supports.\r |
8b6c989b | 115 | ///\r |
2f88bd3a | 116 | CHAR8 *SupportedLanguages;\r |
d1f95000 | 117 | };\r |
118 | \r | |
2f88bd3a | 119 | extern EFI_GUID gEfiComponentNameProtocolGuid;\r |
d1f95000 | 120 | \r |
121 | #endif\r |