adbcbf8f |
1 | /** @file\r |
2 | UEFI Component Name protocol for Partition driver.\r |
3 | \r |
4 | Copyright (c) 2006 - 2007, Intel Corporation \r |
5 | All rights reserved. This program and the accompanying materials \r |
6 | are licensed and made available under the terms and conditions of the BSD License \r |
7 | which accompanies this distribution. The full text of the license may be found at \r |
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 |
13 | **/\r |
14 | \r |
15 | #include "Partition.h"\r |
16 | \r |
17 | //\r |
18 | // EFI Component Name Protocol\r |
19 | //\r |
1307dcd7 |
20 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName = {\r |
adbcbf8f |
21 | PartitionComponentNameGetDriverName,\r |
22 | PartitionComponentNameGetControllerName,\r |
23 | "eng"\r |
1307dcd7 |
24 | };\r |
d38a0f44 |
25 | \r |
26 | //\r |
27 | // EFI Component Name 2 Protocol\r |
28 | //\r |
1307dcd7 |
29 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gPartitionComponentName2 = {\r |
d38a0f44 |
30 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) PartitionComponentNameGetDriverName,\r |
31 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) PartitionComponentNameGetControllerName,\r |
32 | "en"\r |
1307dcd7 |
33 | };\r |
d38a0f44 |
34 | \r |
adbcbf8f |
35 | \r |
d1aeb0bd |
36 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPartitionDriverNameTable[] = {\r |
adbcbf8f |
37 | {\r |
d38a0f44 |
38 | "eng;en",\r |
adbcbf8f |
39 | (CHAR16 *)L"Partition Driver(MBR/GPT/El Torito)"\r |
40 | },\r |
41 | {\r |
42 | NULL,\r |
43 | NULL\r |
44 | }\r |
45 | };\r |
46 | \r |
47 | \r |
48 | \r |
49 | /**\r |
d38a0f44 |
50 | Retrieves a Unicode string that is the user readable name of the driver.\r |
51 | \r |
52 | This function retrieves the user readable name of a driver in the form of a\r |
53 | Unicode string. If the driver specified by This has a user readable name in\r |
54 | the language specified by Language, then a pointer to the driver name is\r |
55 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r |
56 | by This does not support the language specified by Language,\r |
57 | then EFI_UNSUPPORTED is returned.\r |
58 | \r |
59 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
60 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
61 | \r |
62 | @param Language[in] A pointer to a Null-terminated ASCII string\r |
63 | array indicating the language. This is the\r |
64 | language of the driver name that the caller is\r |
65 | requesting, and it must match one of the\r |
66 | languages specified in SupportedLanguages. The\r |
67 | number of languages supported by a driver is up\r |
68 | to the driver writer. Language is specified\r |
69 | in RFC 3066 or ISO 639-2 language code format.\r |
70 | \r |
71 | @param DriverName[out] A pointer to the Unicode string to return.\r |
72 | This Unicode string is the name of the\r |
73 | driver specified by This in the language\r |
74 | specified by Language.\r |
75 | \r |
76 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r |
77 | This and the language specified by Language was\r |
78 | returned in DriverName.\r |
adbcbf8f |
79 | \r |
adbcbf8f |
80 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
d38a0f44 |
81 | \r |
adbcbf8f |
82 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r |
d38a0f44 |
83 | \r |
84 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
85 | the language specified by Language.\r |
adbcbf8f |
86 | \r |
87 | **/\r |
88 | EFI_STATUS\r |
89 | EFIAPI\r |
90 | PartitionComponentNameGetDriverName (\r |
91 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
92 | IN CHAR8 *Language,\r |
93 | OUT CHAR16 **DriverName\r |
94 | )\r |
95 | {\r |
d38a0f44 |
96 | return LookupUnicodeString2 (\r |
97 | Language,\r |
98 | This->SupportedLanguages,\r |
99 | mPartitionDriverNameTable,\r |
100 | DriverName,\r |
101 | (BOOLEAN)(This == &gPartitionComponentName)\r |
102 | );\r |
adbcbf8f |
103 | }\r |
104 | \r |
105 | \r |
106 | /**\r |
d38a0f44 |
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 3066 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 not a valid EFI_HANDLE.\r |
158 | \r |
159 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r |
adbcbf8f |
160 | EFI_HANDLE.\r |
161 | \r |
adbcbf8f |
162 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
163 | \r |
164 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r |
165 | \r |
d38a0f44 |
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 |
adbcbf8f |
169 | \r |
d38a0f44 |
170 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
171 | the language specified by Language.\r |
adbcbf8f |
172 | \r |
173 | **/\r |
174 | EFI_STATUS\r |
175 | EFIAPI\r |
176 | PartitionComponentNameGetControllerName (\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 | return EFI_UNSUPPORTED;\r |
185 | }\r |