Import EhciDxe and UhciDxe into MdeModulePkg.
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UhciDxe / ComponentName.c
1 /** @file
2
3 Copyright (c) 2004 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 ComponentName.c
15
16 Abstract:
17
18
19 **/
20
21 #include "uhci.h"
22
23 //
24 // EFI Component Name Functions
25 //
26 EFI_STATUS
27 EFIAPI
28 UhciComponentNameGetDriverName (
29 IN EFI_COMPONENT_NAME_PROTOCOL *This,
30 IN CHAR8 *Language,
31 OUT CHAR16 **DriverName
32 );
33
34 EFI_STATUS
35 EFIAPI
36 UhciComponentNameGetControllerName (
37 IN EFI_COMPONENT_NAME_PROTOCOL *This,
38 IN EFI_HANDLE ControllerHandle,
39 IN EFI_HANDLE ChildHandle, OPTIONAL
40 IN CHAR8 *Language,
41 OUT CHAR16 **ControllerName
42 );
43
44 //
45 // EFI Component Name Protocol
46 //
47 EFI_COMPONENT_NAME_PROTOCOL gUhciComponentName = {
48 UhciComponentNameGetDriverName,
49 UhciComponentNameGetControllerName,
50 "eng"
51 };
52
53 static EFI_UNICODE_STRING_TABLE mUhciDriverNameTable[] = {
54 { "eng", L"Usb Uhci Driver" },
55 { NULL, NULL }
56 };
57
58 EFI_STATUS
59 EFIAPI
60 UhciComponentNameGetDriverName (
61 IN EFI_COMPONENT_NAME_PROTOCOL *This,
62 IN CHAR8 *Language,
63 OUT CHAR16 **DriverName
64 )
65 /*++
66
67 Routine Description:
68 Retrieves a Unicode string that is the user readable name of the EFI Driver.
69
70 Arguments:
71 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
72 Language - A pointer to a three character ISO 639-2 language identifier.
73 This is the language of the driver name that that the caller
74 is requesting, and it must match one of the languages specified
75 in SupportedLanguages. The number of languages supported by a
76 driver is up to the driver writer.
77 DriverName - A pointer to the Unicode string to return. This Unicode string
78 is the name of the driver specified by This in the language
79 specified by Language.
80
81 Returns:
82 EFI_SUCCESS - The Unicode string for the Driver specified by This
83 and the language specified by Language was returned
84 in DriverName.
85 EFI_INVALID_PARAMETER - Language is NULL.
86 EFI_INVALID_PARAMETER - DriverName is NULL.
87 EFI_UNSUPPORTED - The driver specified by This does not support the
88 language specified by Language.
89
90 --*/
91 {
92 return LookupUnicodeString (
93 Language,
94 gUhciComponentName.SupportedLanguages,
95 mUhciDriverNameTable,
96 DriverName
97 );
98 }
99
100 EFI_STATUS
101 EFIAPI
102 UhciComponentNameGetControllerName (
103 IN EFI_COMPONENT_NAME_PROTOCOL *This,
104 IN EFI_HANDLE ControllerHandle,
105 IN EFI_HANDLE ChildHandle, OPTIONAL
106 IN CHAR8 *Language,
107 OUT CHAR16 **ControllerName
108 )
109 /*++
110
111 Routine Description:
112 Retrieves a Unicode string that is the user readable name of the controller
113 that is being managed by an EFI Driver.
114
115 Arguments:
116 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
117 ControllerHandle - The handle of a controller that the driver specified by
118 This is managing. This handle specifies the controller
119 whose name is to be returned.
120 ChildHandle - The handle of the child controller to retrieve the name
121 of. This is an optional parameter that may be NULL. It
122 will be NULL for device drivers. It will also be NULL
123 for a bus drivers that wish to retrieve the name of the
124 bus controller. It will not be NULL for a bus driver
125 that wishes to retrieve the name of a child controller.
126 Language - A pointer to a three character ISO 639-2 language
127 identifier. This is the language of the controller name
128 that that the caller is requesting, and it must match one
129 of the languages specified in SupportedLanguages. The
130 number of languages supported by a driver is up to the
131 driver writer.
132 ControllerName - A pointer to the Unicode string to return. This Unicode
133 string is the name of the controller specified by
134 ControllerHandle and ChildHandle in the language
135 specified by Language from the point of view of the
136 driver specified by This.
137
138 Returns:
139 EFI_SUCCESS - The Unicode string for the user readable name in the
140 language specified by Language for the driver
141 specified by This was returned in DriverName.
142 EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
143 EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid
144 EFI_HANDLE.
145 EFI_INVALID_PARAMETER - Language is NULL.
146 EFI_INVALID_PARAMETER - ControllerName is NULL.
147 EFI_UNSUPPORTED - The driver specified by This is not currently
148 managing the controller specified by
149 ControllerHandle and ChildHandle.
150 EFI_UNSUPPORTED - The driver specified by This does not support the
151 language specified by Language.
152
153 --*/
154 {
155 EFI_STATUS Status;
156 USB_HC_DEV *UhciDev;
157 EFI_USB_HC_PROTOCOL *UsbHc;
158
159 //
160 // This is a device driver, so ChildHandle must be NULL.
161 //
162 if (ChildHandle != NULL) {
163 return EFI_UNSUPPORTED;
164 }
165
166 //
167 // Make sure this driver is currently managing ControllerHandle
168 //
169 Status = EfiTestManagedDevice (
170 ControllerHandle,
171 gUhciDriverBinding.DriverBindingHandle,
172 &gEfiPciIoProtocolGuid
173 );
174 if (EFI_ERROR (Status)) {
175 return Status;
176 }
177
178 //
179 // Get the device context
180 //
181 Status = gBS->OpenProtocol (
182 ControllerHandle,
183 &gEfiUsbHcProtocolGuid,
184 (VOID **) &UsbHc,
185 gUhciDriverBinding.DriverBindingHandle,
186 ControllerHandle,
187 EFI_OPEN_PROTOCOL_GET_PROTOCOL
188 );
189
190 if (EFI_ERROR (Status)) {
191 return Status;
192 }
193
194 UhciDev = UHC_FROM_USB_HC_PROTO (UsbHc);
195
196 return LookupUnicodeString (
197 Language,
198 gUhciComponentName.SupportedLanguages,
199 UhciDev->CtrlNameTable,
200 ControllerName
201 );
202
203 }