1bfda055 |
1 | /** @file\r |
2 | Component Name Protocol implementation for the MMC DXE driver\r |
3 | \r |
4 | Copyright (c) 2011, ARM Limited. All rights reserved.\r |
5 | \r |
6 | This program and the accompanying materials \r |
7 | are licensed and made available under the terms and conditions of the BSD License \r |
8 | which accompanies this distribution. The full text of the license may be found at \r |
9 | http://opensource.org/licenses/bsd-license.php \r |
10 | \r |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
13 | \r |
14 | **/\r |
15 | \r |
16 | #include "Mmc.h"\r |
17 | \r |
18 | //\r |
19 | // EFI Component Name Protocol\r |
20 | //\r |
21 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMmcComponentName = {\r |
22 | MmcGetDriverName,\r |
23 | MmcGetControllerName,\r |
24 | "eng"\r |
25 | };\r |
26 | \r |
27 | //\r |
28 | // EFI Component Name 2 Protocol\r |
29 | //\r |
30 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMmcComponentName2 = {\r |
31 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) MmcGetDriverName,\r |
32 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) MmcGetControllerName,\r |
33 | "en"\r |
34 | };\r |
35 | \r |
36 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE\r |
37 | mMmcDriverNameTable[] = {\r |
38 | {"eng;en", L"MMC/SD Card Interface Driver"},\r |
39 | {NULL, NULL}\r |
40 | };\r |
41 | \r |
42 | /**\r |
43 | Retrieves a Unicode string that is the user readable name of the driver.\r |
44 | \r |
45 | This function retrieves the user readable name of a driver in the form of a\r |
46 | Unicode string. If the driver specified by This has a user readable name in\r |
47 | the language specified by Language, then a pointer to the driver name is\r |
48 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r |
49 | by This does not support the language specified by Language,\r |
50 | then EFI_UNSUPPORTED is returned.\r |
51 | \r |
52 | @param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
53 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
54 | @param 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 | @param DriverName A pointer to the Unicode string to return.\r |
63 | This Unicode string is the name of the\r |
64 | driver specified by This in the language\r |
65 | specified by Language.\r |
66 | \r |
67 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r |
68 | This and the language specified by Language was\r |
69 | returned in DriverName.\r |
70 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
71 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r |
72 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
73 | the language specified by Language.\r |
74 | \r |
75 | **/\r |
76 | EFI_STATUS\r |
77 | EFIAPI\r |
78 | MmcGetDriverName (\r |
79 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
80 | IN CHAR8 *Language,\r |
81 | OUT CHAR16 **DriverName\r |
82 | )\r |
83 | {\r |
84 | return LookupUnicodeString2 (\r |
85 | Language,\r |
86 | This->SupportedLanguages,\r |
87 | mMmcDriverNameTable,\r |
88 | DriverName,\r |
89 | (BOOLEAN)(This == &gMmcComponentName)\r |
90 | );\r |
91 | }\r |
92 | \r |
93 | /**\r |
94 | Retrieves a Unicode string that is the user readable name of the controller\r |
95 | that is being managed by a driver.\r |
96 | \r |
97 | This function retrieves the user readable name of the controller specified by\r |
98 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r |
99 | driver specified by This has a user readable name in the language specified by\r |
100 | Language, then a pointer to the controller name is returned in ControllerName,\r |
101 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r |
102 | managing the controller specified by ControllerHandle and ChildHandle,\r |
103 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r |
104 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r |
105 | \r |
106 | @param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r |
107 | EFI_COMPONENT_NAME_PROTOCOL instance.\r |
108 | @param ControllerHandle The handle of a controller that the driver\r |
109 | specified by This is managing. This handle\r |
110 | specifies the controller whose name is to be\r |
111 | returned.\r |
112 | @param ChildHandle The handle of the child controller to retrieve\r |
113 | the name of. This is an optional parameter that\r |
114 | may be NULL. It will be NULL for device\r |
115 | drivers. It will also be NULL for a bus drivers\r |
116 | that wish to retrieve the name of the bus\r |
117 | controller. It will not be NULL for a bus\r |
118 | driver that wishes to retrieve the name of a\r |
119 | child controller.\r |
120 | @param Language A pointer to a Null-terminated ASCII string\r |
121 | array indicating the language. This is the\r |
122 | language of the driver name that the caller is\r |
123 | requesting, and it must match one of the\r |
124 | languages specified in SupportedLanguages. The\r |
125 | number of languages supported by a driver is up\r |
126 | to the driver writer. Language is specified in\r |
127 | RFC 4646 or ISO 639-2 language code format.\r |
128 | @param ControllerName A pointer to the Unicode string to return.\r |
129 | This Unicode string is the name of the\r |
130 | controller specified by ControllerHandle and\r |
131 | ChildHandle in the language specified by\r |
132 | Language from the point of view of the driver\r |
133 | specified by This.\r |
134 | \r |
135 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r |
136 | the language specified by Language for the\r |
137 | driver specified by This was returned in\r |
138 | DriverName.\r |
139 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r |
140 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r |
141 | EFI_HANDLE.\r |
142 | @retval EFI_INVALID_PARAMETER Language is NULL.\r |
143 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r |
144 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r |
145 | managing the controller specified by\r |
146 | ControllerHandle and ChildHandle.\r |
147 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r |
148 | the language specified by Language.\r |
149 | \r |
150 | **/\r |
151 | EFI_STATUS\r |
152 | EFIAPI\r |
153 | MmcGetControllerName (\r |
154 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
155 | IN EFI_HANDLE ControllerHandle,\r |
156 | IN EFI_HANDLE ChildHandle OPTIONAL,\r |
157 | IN CHAR8 *Language,\r |
158 | OUT CHAR16 **ControllerName\r |
159 | )\r |
160 | {\r |
161 | return EFI_UNSUPPORTED;\r |
162 | }\r |