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