]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
c6d0ee4b | 2 | UEFI Component Name(2) protocol implementation for ArpDxe driver.\r |
772db4bb | 3 | \r |
d1102dba | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
772db4bb | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
c6d0ee4b | 7 | which accompanies this distribution. The full text of the license may be found at<BR>\r |
772db4bb | 8 | http://opensource.org/licenses/bsd-license.php\r |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
772db4bb | 13 | **/\r |
14 | \r | |
15 | #include "ArpDriver.h"\r | |
16 | \r | |
83cbd279 | 17 | \r |
772db4bb | 18 | //\r |
19 | // EFI Component Name Protocol\r | |
20 | //\r | |
1307dcd7 | 21 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gArpComponentName = {\r |
772db4bb | 22 | ArpComponentNameGetDriverName,\r |
23 | ArpComponentNameGetControllerName,\r | |
24 | "eng"\r | |
1307dcd7 | 25 | };\r |
83cbd279 | 26 | \r |
27 | //\r | |
28 | // EFI Component Name 2 Protocol\r | |
29 | //\r | |
1307dcd7 | 30 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2 = {\r |
83cbd279 | 31 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ArpComponentNameGetDriverName,\r |
32 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ArpComponentNameGetControllerName,\r | |
33 | "en"\r | |
1307dcd7 | 34 | };\r |
83cbd279 | 35 | \r |
772db4bb | 36 | \r |
d1aeb0bd | 37 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpDriverNameTable[] = {\r |
83cbd279 | 38 | { "eng;en", L"ARP Network Service Driver" },\r |
772db4bb | 39 | { NULL, NULL }\r |
40 | };\r | |
41 | \r | |
216f7970 | 42 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpControllerNameTable[] = {\r |
43 | { "eng;en", L"ARP Controller" },\r | |
44 | { NULL, NULL }\r | |
45 | };\r | |
46 | \r | |
83cbd279 | 47 | /**\r |
48 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
49 | \r | |
50 | This function retrieves the user readable name of a driver in the form of a\r | |
51 | Unicode string. If the driver specified by This has a user readable name in\r | |
52 | the language specified by Language, then a pointer to the driver name is\r | |
53 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
54 | by This does not support the language specified by Language,\r | |
55 | then EFI_UNSUPPORTED is returned.\r | |
56 | \r | |
c6d0ee4b | 57 | @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
83cbd279 | 58 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
59 | \r | |
c6d0ee4b | 60 | @param[in] Language A pointer to a Null-terminated ASCII string\r |
83cbd279 | 61 | array indicating the language. This is the\r |
62 | language of the driver name that the caller is\r | |
63 | requesting, and it must match one of the\r | |
64 | languages specified in SupportedLanguages. The\r | |
65 | number of languages supported by a driver is up\r | |
66 | to the driver writer. Language is specified\r | |
0254efc0 | 67 | in RFC 4646 or ISO 639-2 language code format.\r |
83cbd279 | 68 | \r |
c6d0ee4b | 69 | @param[out] DriverName A pointer to the Unicode string to return.\r |
83cbd279 | 70 | This Unicode string is the name of the\r |
71 | driver specified by This in the language\r | |
72 | specified by Language.\r | |
73 | \r | |
74 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
75 | This and the language specified by Language was\r | |
76 | returned in DriverName.\r | |
77 | \r | |
78 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
79 | \r | |
80 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
81 | \r | |
82 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
83 | the language specified by Language.\r | |
84 | \r | |
85 | **/\r | |
772db4bb | 86 | EFI_STATUS\r |
87 | EFIAPI\r | |
88 | ArpComponentNameGetDriverName (\r | |
89 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
90 | IN CHAR8 *Language,\r | |
91 | OUT CHAR16 **DriverName\r | |
92 | )\r | |
772db4bb | 93 | {\r |
83cbd279 | 94 | return LookupUnicodeString2 (\r |
772db4bb | 95 | Language,\r |
83cbd279 | 96 | This->SupportedLanguages,\r |
772db4bb | 97 | mArpDriverNameTable,\r |
83cbd279 | 98 | DriverName,\r |
99 | (BOOLEAN)(This == &gArpComponentName)\r | |
772db4bb | 100 | );\r |
101 | }\r | |
102 | \r | |
83cbd279 | 103 | /**\r |
104 | Retrieves a Unicode string that is the user readable name of the controller\r | |
105 | that is being managed by a driver.\r | |
106 | \r | |
107 | This function retrieves the user readable name of the controller specified by\r | |
108 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
109 | driver specified by This has a user readable name in the language specified by\r | |
110 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
111 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
112 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
113 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
114 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
115 | \r | |
c6d0ee4b | 116 | @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
83cbd279 | 117 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
118 | \r | |
c6d0ee4b | 119 | @param[in] ControllerHandle The handle of a controller that the driver\r |
83cbd279 | 120 | specified by This is managing. This handle\r |
121 | specifies the controller whose name is to be\r | |
122 | returned.\r | |
123 | \r | |
c6d0ee4b | 124 | @param[in] ChildHandle The handle of the child controller to retrieve\r |
83cbd279 | 125 | the name of. This is an optional parameter that\r |
126 | may be NULL. It will be NULL for device\r | |
127 | drivers. It will also be NULL for a bus drivers\r | |
128 | that wish to retrieve the name of the bus\r | |
129 | controller. It will not be NULL for a bus\r | |
130 | driver that wishes to retrieve the name of a\r | |
131 | child controller.\r | |
132 | \r | |
c6d0ee4b | 133 | @param[in] Language A pointer to a Null-terminated ASCII string\r |
83cbd279 | 134 | array indicating the language. This is the\r |
135 | language of the driver name that the caller is\r | |
136 | requesting, and it must match one of the\r | |
137 | languages specified in SupportedLanguages. The\r | |
138 | number of languages supported by a driver is up\r | |
139 | to the driver writer. Language is specified in\r | |
0254efc0 | 140 | RFC 4646 or ISO 639-2 language code format.\r |
83cbd279 | 141 | \r |
c6d0ee4b | 142 | @param[out] ControllerName A pointer to the Unicode string to return.\r |
83cbd279 | 143 | This Unicode string is the name of the\r |
144 | controller specified by ControllerHandle and\r | |
145 | ChildHandle in the language specified by\r | |
146 | Language from the point of view of the driver\r | |
147 | specified by This.\r | |
148 | \r | |
149 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
150 | the language specified by Language for the\r | |
151 | driver specified by This was returned in\r | |
152 | DriverName.\r | |
153 | \r | |
284ee2e8 | 154 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r |
83cbd279 | 155 | \r |
156 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
157 | EFI_HANDLE.\r | |
158 | \r | |
159 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
160 | \r | |
161 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
162 | \r | |
163 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
164 | managing the controller specified by\r | |
165 | ControllerHandle and ChildHandle.\r | |
166 | \r | |
167 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
168 | the language specified by Language.\r | |
169 | \r | |
170 | **/\r | |
772db4bb | 171 | EFI_STATUS\r |
172 | EFIAPI\r | |
173 | ArpComponentNameGetControllerName (\r | |
83cbd279 | 174 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
175 | IN EFI_HANDLE ControllerHandle,\r | |
176 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
177 | IN CHAR8 *Language,\r | |
178 | OUT CHAR16 **ControllerName\r | |
772db4bb | 179 | )\r |
772db4bb | 180 | {\r |
216f7970 | 181 | EFI_STATUS Status;\r |
182 | EFI_ARP_PROTOCOL *Arp;\r | |
183 | \r | |
184 | //\r | |
185 | // Only provide names for child handles.\r | |
186 | //\r | |
187 | if (ChildHandle == NULL) {\r | |
188 | return EFI_UNSUPPORTED;\r | |
189 | }\r | |
d1102dba LG |
190 | \r |
191 | //\r | |
192 | // Make sure this driver produced ChildHandle\r | |
193 | //\r | |
216f7970 | 194 | Status = EfiTestChildHandle (\r |
195 | ControllerHandle,\r | |
196 | ChildHandle,\r | |
197 | &gEfiManagedNetworkProtocolGuid\r | |
198 | );\r | |
199 | if (EFI_ERROR (Status)) {\r | |
200 | return Status;\r | |
201 | }\r | |
202 | \r | |
d1102dba LG |
203 | //\r |
204 | // Retrieve an instance of a produced protocol from ChildHandle\r | |
205 | //\r | |
216f7970 | 206 | Status = gBS->OpenProtocol (\r |
207 | ChildHandle,\r | |
208 | &gEfiArpProtocolGuid,\r | |
209 | (VOID **)&Arp,\r | |
210 | NULL,\r | |
211 | NULL,\r | |
212 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
213 | );\r | |
214 | if (EFI_ERROR (Status)) {\r | |
215 | return Status;\r | |
216 | }\r | |
772db4bb | 217 | \r |
216f7970 | 218 | return LookupUnicodeString2 (\r |
219 | Language,\r | |
220 | This->SupportedLanguages,\r | |
221 | mArpControllerNameTable,\r | |
222 | ControllerName,\r | |
223 | (BOOLEAN)(This == &gArpComponentName)\r | |
224 | );\r | |
225 | }\r |