]>
Commit | Line | Data |
---|---|---|
6e4bac4d | 1 | /** @file\r |
2 | The header file of UEFI Component Name(2) protocol.\r | |
3 | \r | |
216f7970 | 4 | Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
6e4bac4d | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _COMPONENT_NAME_H_\r | |
10 | #define _COMPONENT_NAME_H_\r | |
11 | \r | |
12 | #include <Protocol/ComponentName.h>\r | |
13 | #include <Protocol/ComponentName2.h>\r | |
14 | \r | |
d1050b9d MK |
15 | extern EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2;\r |
16 | extern EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName;\r | |
17 | extern EFI_UNICODE_STRING_TABLE *gMnpControllerNameTable;\r | |
6e4bac4d | 18 | \r |
19 | /**\r | |
20 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
21 | \r | |
22 | This function retrieves the user readable name of a driver in the form of a\r | |
23 | Unicode string. If the driver specified by This has a user readable name in\r | |
24 | the language specified by Language, then a pointer to the driver name is\r | |
25 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
26 | by This does not support the language specified by Language,\r | |
27 | then EFI_UNSUPPORTED is returned.\r | |
28 | \r | |
29 | @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
30 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
31 | \r | |
32 | @param[in] Language A pointer to a Null-terminated ASCII string\r | |
33 | array indicating the language. This is the\r | |
34 | language of the driver name that the caller is\r | |
35 | requesting, and it must match one of the\r | |
36 | languages specified in SupportedLanguages. The\r | |
37 | number of languages supported by a driver is up\r | |
38 | to the driver writer. Language is specified\r | |
718a15c6 | 39 | in RFC 4646 or ISO 639-2 language code format.\r |
6e4bac4d | 40 | \r |
41 | @param[out] DriverName A pointer to the Unicode string to return.\r | |
42 | This Unicode string is the name of the\r | |
43 | driver specified by This in the language\r | |
44 | specified by Language.\r | |
45 | \r | |
46 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
47 | This and the language specified by Language was\r | |
48 | returned in DriverName.\r | |
49 | \r | |
50 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
51 | \r | |
52 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
53 | \r | |
54 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
55 | the language specified by Language.\r | |
56 | \r | |
57 | **/\r | |
58 | EFI_STATUS\r | |
59 | EFIAPI\r | |
60 | MnpComponentNameGetDriverName (\r | |
d1050b9d MK |
61 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
62 | IN CHAR8 *Language,\r | |
63 | OUT CHAR16 **DriverName\r | |
6e4bac4d | 64 | );\r |
65 | \r | |
6e4bac4d | 66 | /**\r |
67 | Retrieves a Unicode string that is the user readable name of the controller\r | |
68 | that is being managed by a driver.\r | |
69 | \r | |
70 | This function retrieves the user readable name of the controller specified by\r | |
71 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
72 | driver specified by This has a user readable name in the language specified by\r | |
73 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
74 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
75 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
76 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
77 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
78 | Currently not implemented.\r | |
79 | \r | |
80 | @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
81 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
82 | \r | |
83 | @param[in] ControllerHandle The handle of a controller that the driver\r | |
84 | specified by This is managing. This handle\r | |
85 | specifies the controller whose name is to be\r | |
86 | returned.\r | |
87 | \r | |
88 | @param[in] ChildHandle The handle of the child controller to retrieve\r | |
89 | the name of. This is an optional parameter that\r | |
90 | may be NULL. It will be NULL for device\r | |
91 | drivers. It will also be NULL for a bus drivers\r | |
92 | that wish to retrieve the name of the bus\r | |
93 | controller. It will not be NULL for a bus\r | |
94 | driver that wishes to retrieve the name of a\r | |
95 | child controller.\r | |
96 | \r | |
97 | @param[in] Language A pointer to a Null-terminated ASCII string\r | |
98 | array indicating the language. This is the\r | |
99 | language of the driver name that the caller is\r | |
100 | requesting, and it must match one of the\r | |
101 | languages specified in SupportedLanguages. The\r | |
102 | number of languages supported by a driver is up\r | |
103 | to the driver writer. Language is specified in\r | |
718a15c6 | 104 | RFC 4646 or ISO 639-2 language code format.\r |
6e4bac4d | 105 | \r |
106 | @param[out] ControllerName A pointer to the Unicode string to return.\r | |
107 | This Unicode string is the name of the\r | |
108 | controller specified by ControllerHandle and\r | |
109 | ChildHandle in the language specified by\r | |
110 | Language from the point of view of the driver\r | |
111 | specified by This.\r | |
112 | \r | |
779ae357 | 113 | @retval EFI_SUCCESS The Unicode string for the user readable name\r |
6e4bac4d | 114 | specified by This, ControllerHandle, ChildHandle,\r |
779ae357 | 115 | and Language was returned in ControllerName.\r |
6e4bac4d | 116 | \r |
284ee2e8 | 117 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
6e4bac4d | 118 | \r |
119 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
120 | EFI_HANDLE.\r | |
121 | \r | |
122 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
123 | \r | |
124 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
125 | \r | |
126 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
127 | managing the controller specified by\r | |
128 | ControllerHandle and ChildHandle.\r | |
129 | \r | |
130 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
131 | the language specified by Language.\r | |
132 | \r | |
133 | **/\r | |
134 | EFI_STATUS\r | |
135 | EFIAPI\r | |
136 | MnpComponentNameGetControllerName (\r | |
d1050b9d MK |
137 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
138 | IN EFI_HANDLE ControllerHandle,\r | |
139 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
140 | IN CHAR8 *Language,\r | |
141 | OUT CHAR16 **ControllerName\r | |
6e4bac4d | 142 | );\r |
143 | \r | |
144 | #endif\r |