Add WinNtBlockIoDxe module into Nt32Pkg.
[mirror_edk2.git] / Nt32Pkg / WinNtBlockIoDxe / ComponentName.c
1 /*++
2
3 Copyright (c) 2006, 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 #include <Uefi.h>
20 #include <WinNtDxe.h>
21 #include <Protocol/ComponentName.h>
22 #include <Protocol/DriverBinding.h>
23
24 #include "WinNtBlockIo.h"
25
26 //
27 // EFI Component Name Functions
28 //
29 EFI_STATUS
30 EFIAPI
31 WinNtBlockIoComponentNameGetDriverName (
32 IN EFI_COMPONENT_NAME_PROTOCOL *This,
33 IN CHAR8 *Language,
34 OUT CHAR16 **DriverName
35 );
36
37 EFI_STATUS
38 EFIAPI
39 WinNtBlockIoComponentNameGetControllerName (
40 IN EFI_COMPONENT_NAME_PROTOCOL *This,
41 IN EFI_HANDLE ControllerHandle,
42 IN EFI_HANDLE ChildHandle OPTIONAL,
43 IN CHAR8 *Language,
44 OUT CHAR16 **ControllerName
45 );
46
47 //
48 // EFI Component Name Protocol
49 //
50 EFI_COMPONENT_NAME_PROTOCOL gWinNtBlockIoComponentName = {
51 WinNtBlockIoComponentNameGetDriverName,
52 WinNtBlockIoComponentNameGetControllerName,
53 "eng"
54 };
55
56 static EFI_UNICODE_STRING_TABLE mWinNtBlockIoDriverNameTable[] = {
57 { "eng", L"Windows Block I/O Driver" },
58 { NULL , NULL }
59 };
60
61 EFI_STATUS
62 EFIAPI
63 WinNtBlockIoComponentNameGetDriverName (
64 IN EFI_COMPONENT_NAME_PROTOCOL *This,
65 IN CHAR8 *Language,
66 OUT CHAR16 **DriverName
67 )
68 /*++
69
70 Routine Description:
71 Retrieves a Unicode string that is the user readable name of the EFI Driver.
72
73 Arguments:
74 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
75 Language - A pointer to a three character ISO 639-2 language identifier.
76 This is the language of the driver name that that the caller
77 is requesting, and it must match one of the languages specified
78 in SupportedLanguages. The number of languages supported by a
79 driver is up to the driver writer.
80 DriverName - A pointer to the Unicode string to return. This Unicode string
81 is the name of the driver specified by This in the language
82 specified by Language.
83
84 Returns:
85 EFI_SUCCESS - The Unicode string for the Driver specified by This
86 and the language specified by Language was returned
87 in DriverName.
88 EFI_INVALID_PARAMETER - Language is NULL.
89 EFI_INVALID_PARAMETER - DriverName is NULL.
90 EFI_UNSUPPORTED - The driver specified by This does not support the
91 language specified by Language.
92
93 --*/
94 {
95 return LookupUnicodeString (
96 Language,
97 gWinNtBlockIoComponentName.SupportedLanguages,
98 mWinNtBlockIoDriverNameTable,
99 DriverName
100 );
101 }
102
103 EFI_STATUS
104 EFIAPI
105 WinNtBlockIoComponentNameGetControllerName (
106 IN EFI_COMPONENT_NAME_PROTOCOL *This,
107 IN EFI_HANDLE ControllerHandle,
108 IN EFI_HANDLE ChildHandle OPTIONAL,
109 IN CHAR8 *Language,
110 OUT CHAR16 **ControllerName
111 )
112 /*++
113
114 Routine Description:
115 Retrieves a Unicode string that is the user readable name of the controller
116 that is being managed by an EFI Driver.
117
118 Arguments:
119 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
120 ControllerHandle - The handle of a controller that the driver specified by
121 This is managing. This handle specifies the controller
122 whose name is to be returned.
123 ChildHandle - The handle of the child controller to retrieve the name
124 of. This is an optional parameter that may be NULL. It
125 will be NULL for device drivers. It will also be NULL
126 for a bus drivers that wish to retrieve the name of the
127 bus controller. It will not be NULL for a bus driver
128 that wishes to retrieve the name of a child controller.
129 Language - A pointer to a three character ISO 639-2 language
130 identifier. This is the language of the controller name
131 that that the caller is requesting, and it must match one
132 of the languages specified in SupportedLanguages. The
133 number of languages supported by a driver is up to the
134 driver writer.
135 ControllerName - A pointer to the Unicode string to return. This Unicode
136 string is the name of the controller specified by
137 ControllerHandle and ChildHandle in the language specified
138 by Language from the point of view of the driver specified
139 by This.
140
141 Returns:
142 EFI_SUCCESS - The Unicode string for the user readable name in the
143 language specified by Language for the driver
144 specified by This was returned in DriverName.
145 EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
146 EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.
147 EFI_INVALID_PARAMETER - Language is NULL.
148 EFI_INVALID_PARAMETER - ControllerName is NULL.
149 EFI_UNSUPPORTED - The driver specified by This is not currently managing
150 the controller specified by ControllerHandle and
151 ChildHandle.
152 EFI_UNSUPPORTED - The driver specified by This does not support the
153 language specified by Language.
154
155 --*/
156 {
157 EFI_STATUS Status;
158 EFI_BLOCK_IO_PROTOCOL *BlockIo;
159 WIN_NT_BLOCK_IO_PRIVATE *Private;
160
161 //
162 // This is a device driver, so ChildHandle must be NULL.
163 //
164 if (ChildHandle != NULL) {
165 return EFI_UNSUPPORTED;
166 }
167 //
168 // Make sure this driver is currently managing ControllerHandle
169 //
170 Status = EfiTestManagedDevice (
171 ControllerHandle,
172 gWinNtBlockIoDriverBinding.DriverBindingHandle,
173 &gEfiWinNtIoProtocolGuid
174 );
175 if (EFI_ERROR (Status)) {
176 return EFI_UNSUPPORTED;
177 }
178 //
179 // Get our context back
180 //
181 Status = gBS->OpenProtocol (
182 ControllerHandle,
183 &gEfiBlockIoProtocolGuid,
184 &BlockIo,
185 gWinNtBlockIoDriverBinding.DriverBindingHandle,
186 ControllerHandle,
187 EFI_OPEN_PROTOCOL_GET_PROTOCOL
188 );
189 if (EFI_ERROR (Status)) {
190 return EFI_UNSUPPORTED;
191 }
192
193 Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (BlockIo);
194
195 return LookupUnicodeString (
196 Language,
197 gWinNtBlockIoComponentName.SupportedLanguages,
198 Private->ControllerNameTable,
199 ControllerName
200 );
201 }