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