1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
DriverConfiguration.c
Abstract:
--*/
#include "idebus.h"
CHAR16 *OptionString[4] = {
L"Enable Primary Master (Y/N)? -->",
L"Enable Primary Slave (Y/N)? -->",
L"Enable Secondary Master (Y/N)? -->",
L"Enable Secondary Slave (Y/N)? -->"
};
//
// EFI Driver Configuration Functions
//
EFI_STATUS
IDEBusDriverConfigurationSetOptions (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
);
EFI_STATUS
IDEBusDriverConfigurationOptionsValid (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL
);
EFI_STATUS
IDEBusDriverConfigurationForceDefaults (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN UINT32 DefaultType,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
);
//
// EFI Driver Configuration Protocol
//
EFI_DRIVER_CONFIGURATION_PROTOCOL gIDEBusDriverConfiguration = {
IDEBusDriverConfigurationSetOptions,
IDEBusDriverConfigurationOptionsValid,
IDEBusDriverConfigurationForceDefaults,
"eng"
};
EFI_STATUS
GetResponse (
VOID
)
/*++
Routine Description:
TODO: Add function description
Arguments:
None
Returns:
EFI_ABORTED - TODO: Add description for return value
EFI_SUCCESS - TODO: Add description for return value
EFI_NOT_FOUND - TODO: Add description for return value
--*/
{
EFI_STATUS Status;
EFI_INPUT_KEY Key;
while (TRUE) {
Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
if (!EFI_ERROR (Status)) {
if (Key.ScanCode == SCAN_ESC) {
return EFI_ABORTED;
}
switch (Key.UnicodeChar) {
//
// fall through
//
case L'y':
case L'Y':
gST->ConOut->OutputString (gST->ConOut, L"Y\n");
return EFI_SUCCESS;
//
// fall through
//
case L'n':
case L'N':
gST->ConOut->OutputString (gST->ConOut, L"N\n");
return EFI_NOT_FOUND;
}
}
}
}
EFI_STATUS
IDEBusDriverConfigurationSetOptions (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
)
/*++
Routine Description:
Allows the user to set controller specific options for a controller that a
driver is currently managing.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
ControllerHandle - The handle of the controller to set options on.
ChildHandle - The handle of the child controller to set options on.
This is an optional parameter that may be NULL.
It will be NULL for device drivers, and for a bus drivers
that wish to set options for the bus controller.
It will not be NULL for a bus driver that wishes to set
options for one of its child controllers.
Language - A pointer to a three character ISO 639-2 language
identifier. This is the language of the user interface
that should be presented to the user, and it must match
one of the languages specified in SupportedLanguages.
The number of languages supported by a driver is up to
the driver writer.
ActionRequired - A pointer to the action that the calling agent is
required to perform when this function returns.
See "Related Definitions" for a list of the actions that
the calling agent is required to perform prior to
accessing ControllerHandle again.
Returns:
EFI_SUCCESS - The driver specified by This successfully set the
configuration options for the controller specified
by ControllerHandle..
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a
valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ActionRequired is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support
setting configuration options for the controller
specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support the
language specified by Language.
EFI_DEVICE_ERROR - A device error occurred while attempt to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
EFI_OUT_RESOURCES - There are not enough resources available to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
--*/
{
EFI_STATUS Status;
UINT8 Value;
UINT8 NewValue;
UINTN DataSize;
UINTN Index;
UINT32 Attributes;
if (ChildHandle != NULL) {
return EFI_UNSUPPORTED;
}
*ActionRequired = EfiDriverConfigurationActionNone;
DataSize = sizeof (Value);
Status = gRT->GetVariable (
L"Configuration",
&gEfiCallerIdGuid,
&Attributes,
&DataSize,
&Value
);
gST->ConOut->OutputString (gST->ConOut, L"IDE Bus Driver Configuration\n");
gST->ConOut->OutputString (gST->ConOut, L"===============================\n");
NewValue = 0;
for (Index = 0; Index < 4; Index++) {
gST->ConOut->OutputString (gST->ConOut, OptionString[Index]);
Status = GetResponse ();
if (Status == EFI_ABORTED) {
return EFI_SUCCESS;
}
if (!EFI_ERROR (Status)) {
NewValue |= (UINT8) (1 << Index);
}
}
if (EFI_ERROR (Status) || (NewValue != Value)) {
gRT->SetVariable (
L"Configuration",
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
sizeof (NewValue),
&NewValue
);
*ActionRequired = EfiDriverConfigurationActionRestartController;
} else {
*ActionRequired = EfiDriverConfigurationActionNone;
}
return EFI_SUCCESS;
}
EFI_STATUS
IDEBusDriverConfigurationOptionsValid (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL
)
/*++
Routine Description:
Tests to see if a controller's current configuration options are valid.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL
instance.
ControllerHandle - The handle of the controller to test if it's current
configuration options are valid.
ChildHandle - The handle of the child controller to test if it's
current
configuration options are valid. This is an optional
parameter that may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers that
wish to test the configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to test configuration options for one of
its child controllers.
Returns:
EFI_SUCCESS - The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has a valid set of configuration
options.
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
EFI_UNSUPPORTED - The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
EFI_DEVICE_ERROR - The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has an invalid set of
configuration options.
--*/
{
EFI_STATUS Status;
UINT8 Value;
UINTN DataSize;
UINT32 Attributes;
if (ChildHandle != NULL) {
return EFI_UNSUPPORTED;
}
DataSize = sizeof (Value);
Status = gRT->GetVariable (
L"Configuration",
&gEfiCallerIdGuid,
&Attributes,
&DataSize,
&Value
);
if (EFI_ERROR (Status) || Value > 0x0f) {
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
EFI_STATUS
IDEBusDriverConfigurationForceDefaults (
IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN UINT32 DefaultType,
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
)
/*++
Routine Description:
Forces a driver to set the default configuration options for a controller.
Arguments:
This - A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
ControllerHandle - The handle of the controller to force default
configuration options on.
ChildHandle - The handle of the child controller to force default
configuration options on This is an optional parameter
that may be NULL. It will be NULL for device drivers.
It will also be NULL for a bus drivers that wish to
force default configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to force default configuration options for one
of its child controllers.
DefaultType - The type of default configuration options to force on
the controller specified by ControllerHandle and
ChildHandle. See Table 9-1 for legal values.
A DefaultType of 0x00000000 must be supported
by this protocol.
ActionRequired - A pointer to the action that the calling agent
is required to perform when this function returns.
Returns:
EFI_SUCCESS - The driver specified by This successfully forced
the default configuration options on the
controller specified by ControllerHandle and
ChildHandle.
EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a
valid EFI_HANDLE.
EFI_INVALID_PARAMETER - ActionRequired is NULL.
EFI_UNSUPPORTED - The driver specified by This does not support
forcing the default configuration options on
the controller specified by ControllerHandle
and ChildHandle.
EFI_UNSUPPORTED - The driver specified by This does not support
the configuration type specified by DefaultType.
EFI_DEVICE_ERROR - A device error occurred while attempt to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
EFI_OUT_RESOURCES - There are not enough resources available to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
--*/
{
UINT8 Value;
if (ChildHandle != NULL) {
return EFI_UNSUPPORTED;
}
Value = 0x0f;
gRT->SetVariable (
L"Configuration",
&gEfiCallerIdGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
sizeof (Value),
&Value
);
*ActionRequired = EfiDriverConfigurationActionRestartController;
return EFI_SUCCESS;
}
|
