DriverConfiguration.c@ 48736

Last change on this file since 48736 was 48674, checked in by vboxsync, 12 years ago
EFI: Export newly imported tinaocore UEFI sources to OSE.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 13.0 KB

Line
1	/* $Id: DriverConfiguration.c 48674 2013-09-25 08:26:15Z vboxsync $ */
2	/** @file
3	* DriverConfiguration.c
4	*/
5
6	/*
7	* Copyright (C) 2009-2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27	/** @file
28	Implementation of UEFI Driver Configuration Protocol for IDE bus driver which
29	provides ability to set IDE bus controller specific options.
30
31	Copyright (c) 2006 - 2008, Intel Corporation
32	All rights reserved. This program and the accompanying materials
33	are licensed and made available under the terms and conditions of the BSD License
34	which accompanies this distribution. The full text of the license may be found at
35	http://opensource.org/licenses/bsd-license.php
36
37	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
38	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
39
40	**/
41
42
43	#include "IdeBus.h"
44
45	CHAR16 *OptionString[4] = {
46	L"Enable Primary Master (Y/N)? -->",
47	L"Enable Primary Slave (Y/N)? -->",
48	L"Enable Secondary Master (Y/N)? -->",
49	L"Enable Secondary Slave (Y/N)? -->"
50	};
51
52	//
53	// EFI Driver Configuration Protocol
54	//
55	EFI_DRIVER_CONFIGURATION_PROTOCOL gIDEBusDriverConfiguration = {
56	IDEBusDriverConfigurationSetOptions,
57	IDEBusDriverConfigurationOptionsValid,
58	IDEBusDriverConfigurationForceDefaults,
59	"eng"
60	};
61
62	/**
63	Interpret keyboard input.
64
65	@retval EFI_ABORTED Get an 'ESC' key inputted.
66	@retval EFI_SUCCESS Get an 'Y' or 'y' inputted.
67	@retval EFI_NOT_FOUND Get an 'N' or 'n' inputted..
68
69	**/
70	EFI_STATUS
71	GetResponse (
72	VOID
73	)
74	{
75	EFI_STATUS Status;
76	EFI_INPUT_KEY Key;
77
78	while (TRUE) {
79	Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
80	if (!EFI_ERROR (Status)) {
81	if (Key.ScanCode == SCAN_ESC) {
82	return EFI_ABORTED;
83	}
84
85	switch (Key.UnicodeChar) {
86
87	//
88	// fall through
89	//
90	case L'y':
91	case L'Y':
92	gST->ConOut->OutputString (gST->ConOut, L"Y\n");
93	return EFI_SUCCESS;
94
95	//
96	// fall through
97	//
98	case L'n':
99	case L'N':
100	gST->ConOut->OutputString (gST->ConOut, L"N\n");
101	return EFI_NOT_FOUND;
102	}
103
104	}
105	}
106	}
107
108	/**
109	Allows the user to set controller specific options for a controller that a
110	driver is currently managing.
111
112	@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.
113	@param ControllerHandle The handle of the controller to set options on.
114	@param ChildHandle The handle of the child controller to set options on.
115	This is an optional parameter that may be NULL.
116	It will be NULL for device drivers, and for a bus drivers
117	that wish to set options for the bus controller.
118	It will not be NULL for a bus driver that wishes to set
119	options for one of its child controllers.
120	@param Language A pointer to a three character ISO 639-2 language identifier.
121	This is the language of the user interface that should be presented
122	to the user, and it must match one of the languages specified in
123	SupportedLanguages. The number of languages supported by a driver is up to
124	the driver writer.
125	@param ActionRequired A pointer to the action that the calling agent is required
126	to perform when this function returns.
127
128
129	@retval EFI_SUCCESS The driver specified by This successfully set the configuration
130	options for the controller specified by ControllerHandle..
131	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
132	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
133	@retval EFI_INVALID_PARAMETER ActionRequired is NULL.
134	@retval EFI_UNSUPPORTED The driver specified by This does not support setting configuration options for
135	the controller specified by ControllerHandle and ChildHandle.
136	@retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language.
137	@retval EFI_DEVICE_ERROR A device error occurred while attempt to set the configuration options for the
138	controller specified by ControllerHandle and ChildHandle.
139	@retval EFI_OUT_RESOURCES There are not enough resources available to set the configuration options for the
140	controller specified by ControllerHandle and ChildHandle
141	**/
142	EFI_STATUS
143	EFIAPI
144	IDEBusDriverConfigurationSetOptions (
145	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
146	IN EFI_HANDLE ControllerHandle,
147	IN EFI_HANDLE ChildHandle OPTIONAL,
148	IN CHAR8 *Language,
149	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
150	)
151	{
152	EFI_STATUS Status;
153	UINT8 Value;
154	UINT8 NewValue;
155	UINTN DataSize;
156	UINTN Index;
157
158	if (ChildHandle != NULL) {
159	return EFI_UNSUPPORTED;
160	}
161
162	*ActionRequired = EfiDriverConfigurationActionNone;
163
164	DataSize = sizeof (Value);
165	Status = gRT->GetVariable (
166	L"Configuration",
167	&gEfiCallerIdGuid,
168	NULL,
169	&DataSize,
170	&Value
171	);
172
173	gST->ConOut->OutputString (gST->ConOut, L"IDE Bus Driver Configuration\n");
174	gST->ConOut->OutputString (gST->ConOut, L"===============================\n");
175
176	NewValue = 0;
177	for (Index = 0; Index < 4; Index++) {
178	gST->ConOut->OutputString (gST->ConOut, OptionString[Index]);
179
180	Status = GetResponse ();
181	if (Status == EFI_ABORTED) {
182	return EFI_SUCCESS;
183	}
184
185	if (!EFI_ERROR (Status)) {
186	NewValue = (UINT8) (NewValue \| (1 << Index));
187	}
188	}
189
190	if (EFI_ERROR (Status) \|\| (NewValue != Value)) {
191	gRT->SetVariable (
192	L"Configuration",
193	&gEfiCallerIdGuid,
194	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS,
195	sizeof (NewValue),
196	&NewValue
197	);
198
199	*ActionRequired = EfiDriverConfigurationActionRestartController;
200	} else {
201	*ActionRequired = EfiDriverConfigurationActionNone;
202	}
203
204	return EFI_SUCCESS;
205	}
206
207	/**
208	Tests to see if a controller's current configuration options are valid.
209
210	@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.
211	@param ControllerHandle The handle of the controller to test if it's current configuration options
212	are valid.
213	@param ChildHandle The handle of the child controller to test if it's current configuration
214	options are valid. This is an optional parameter that may be NULL. It will
215	be NULL for device drivers. It will also be NULL for a bus drivers that
216	wish to test the configuration options for the bus controller. It will
217	not be NULL for a bus driver that wishes to test configuration options for
218	one of its child controllers.
219	@retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle that is being
220	managed by the driver specified by This has a valid set of configuration
221	options.
222	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
223	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
224	@retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller
225	specified by ControllerHandle and ChildHandle.
226	@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle that is being
227	managed by the driver specified by This has an invalid set of configuration
228	options.
229	**/
230	EFI_STATUS
231	EFIAPI
232	IDEBusDriverConfigurationOptionsValid (
233	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
234	IN EFI_HANDLE ControllerHandle,
235	IN EFI_HANDLE ChildHandle OPTIONAL
236	)
237	{
238	EFI_STATUS Status;
239	UINT8 Value;
240	UINTN DataSize;
241
242	if (ChildHandle != NULL) {
243	return EFI_UNSUPPORTED;
244	}
245
246	DataSize = sizeof (Value);
247	Status = gRT->GetVariable (
248	L"Configuration",
249	&gEfiCallerIdGuid,
250	NULL,
251	&DataSize,
252	&Value
253	);
254	if (EFI_ERROR (Status) \|\| Value > 0x0f) {
255	return EFI_DEVICE_ERROR;
256	}
257
258	return EFI_SUCCESS;
259	}
260	/**
261	Forces a driver to set the default configuration options for a controller.
262
263	@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.
264	@param ControllerHandle The handle of the controller to force default configuration options on.
265	@param ChildHandle The handle of the child controller to force default configuration
266	options on This is an optional parameter that may be NULL. It
267	will be NULL for device drivers. It will also be NULL for a bus
268	drivers that wish to force default configuration options for the bus
269	controller. It will not be NULL for a bus driver that wishes to force
270	default configuration options for one of its child controllers.
271	@param DefaultType The type of default configuration options to force on the controller
272	specified by ControllerHandle and ChildHandle.
273	@param ActionRequired A pointer to the action that the calling agent is required to perform
274	when this function returns.
275
276	@retval EFI_SUCCESS The driver specified by This successfully forced the
277	default configuration options on the controller specified by
278	ControllerHandle and ChildHandle.
279	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
280	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
281	@retval EFI_INVALID_PARAMETER ActionRequired is NULL.
282	@retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default
283	configuration options on the controller specified by ControllerHandle
284	and ChildHandle.
285	@retval EFI_UNSUPPORTED The driver specified by This does not support the configuration type
286	specified by DefaultType.
287	@retval EFI_DEVICE_ERROR A device error occurred while attempt to force the default configuration
288	options on the controller specified by ControllerHandle and ChildHandle.
289	@retval EFI_OUT_RESOURCES There are not enough resources available to force the default configuration
290	options on the controller specified by ControllerHandle and ChildHandle.
291	**/
292	EFI_STATUS
293	EFIAPI
294	IDEBusDriverConfigurationForceDefaults (
295	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,
296	IN EFI_HANDLE ControllerHandle,
297	IN EFI_HANDLE ChildHandle OPTIONAL,
298	IN UINT32 DefaultType,
299	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired
300	)
301	{
302	UINT8 Value;
303
304	if (ChildHandle != NULL) {
305	return EFI_UNSUPPORTED;
306	}
307
308	Value = 0x0f;
309	gRT->SetVariable (
310	L"Configuration",
311	&gEfiCallerIdGuid,
312	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS,
313	sizeof (Value),
314	&Value
315	);
316	*ActionRequired = EfiDriverConfigurationActionRestartController;
317	return EFI_SUCCESS;
318	}

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/VBoxPkg/VBoxIdeBusDxe/DriverConfiguration.c@ 48736

Download in other formats: