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