[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Efi / Protocol / DriverConfiguration2 / DriverConfiguration2.h

/*++\r
\r
Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
    DriverConfiguration2.h\r
\r
Abstract:\r
\r
    EFI Driver Configuration2 Protocol\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _EFI_DRIVER_CONFIGURATION2_H_\r
#define _EFI_DRIVER_CONFIGURATION2_H_\r
\r
#include EFI_PROTOCOL_DEFINITION (DriverConfiguration)\r
\r
//\r
// Global ID for the Driver Configuration Protocol\r
//\r
#define EFI_DRIVER_CONFIGURATION2_PROTOCOL_GUID \\r
  { \\r
    0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe} \\r
  }\r
\r
EFI_FORWARD_DECLARATION (EFI_DRIVER_CONFIGURATION2_PROTOCOL);\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DRIVER_CONFIGURATION2_SET_OPTIONS) (\r
  IN EFI_DRIVER_CONFIGURATION2_PROTOCOL                       * This,\r
  IN  EFI_HANDLE                                              ControllerHandle,\r
  IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
  IN  CHAR8                                                   *Language,\r
  OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED                * ActionRequired\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Allows the user to set controller specific options for a controller that a\r
    driver is currently managing.\r
\r
  Arguments:\r
    This             - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
    ControllerHandle - The handle of the controller to set options on.\r
    ChildHandle      - The handle of the child controller to set options on.  This\r
                       is an optional parameter that may be NULL.  It will be NULL\r
                       for device drivers, and for a bus drivers that wish to set\r
                       options for the bus controller.  It will not be NULL for a\r
                       bus driver that wishes to set options for one of its child\r
                       controllers.\r
    Language         - A pointer to a three character RFC 3066 language identifier.\r
                       This is the language of the user interface that should be\r
                       presented to the user, and it must match one of the languages\r
                       specified in SupportedLanguages.  The number of languages\r
                       supported by a driver is up to the driver writer.\r
    ActionRequired   - A pointer to the action that the calling agent is required\r
                       to perform when this function returns.  See "Related\r
                       Definitions" for a list of the actions that the calling\r
                       agent is required to perform prior to accessing\r
                       ControllerHandle again.\r
\r
  Returns:\r
    EFI_SUCCESS           - The driver specified by This successfully set the\r
                            configuration options for the controller specified\r
                            by ControllerHandle..\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ActionRequired is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support setting\r
                            configuration options for the controller specified by\r
                            ControllerHandle and ChildHandle.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the\r
                            language specified by Language.\r
    EFI_DEVICE_ERROR      - A device error occurred while attempt to set the\r
                            configuration options for the controller specified\r
                            by ControllerHandle and ChildHandle.\r
    EFI_OUT_RESOURCES     - There are not enough resources available to set the\r
                            configuration options for the controller specified\r
                            by ControllerHandle and ChildHandle.\r
\r
--*/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID) (\r
  IN EFI_DRIVER_CONFIGURATION2_PROTOCOL                       * This,\r
  IN  EFI_HANDLE                                              ControllerHandle,\r
  IN  EFI_HANDLE                                              ChildHandle  OPTIONAL\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Tests to see if a controller's current configuration options are valid.\r
\r
  Arguments:\r
    This             - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
    ControllerHandle - The handle of the controller to test if it's current\r
                       configuration options are valid.\r
    ChildHandle      - The handle of the child controller to test if it's current\r
                       configuration options are valid.  This is an optional\r
                       parameter that may be NULL.  It will be NULL for device\r
                       drivers.  It will also be NULL for a bus drivers that wish\r
                       to test the configuration options for the bus controller.\r
                       It will not be NULL for a bus driver that wishes to test\r
                       configuration options for one of its child controllers.\r
\r
  Returns:\r
    EFI_SUCCESS           - The controller specified by ControllerHandle and\r
                            ChildHandle that is being managed by the driver\r
                            specified by This has a valid set of  configuration\r
                            options.\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
    EFI_UNSUPPORTED       - The driver specified by This is not currently\r
                            managing the controller specified by ControllerHandle\r
                            and ChildHandle.\r
    EFI_DEVICE_ERROR      - The controller specified by ControllerHandle and\r
                            ChildHandle that is being managed by the driver\r
                            specified by This has an invalid set of configuration\r
                            options.\r
\r
--*/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS) (\r
  IN EFI_DRIVER_CONFIGURATION2_PROTOCOL                       * This,\r
  IN  EFI_HANDLE                                              ControllerHandle,\r
  IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
  IN  UINT32                                                  DefaultType,\r
  OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED                * ActionRequired\r
  );\r
\r
/*++\r
\r
  Routine Description:\r
    Forces a driver to set the default configuration options for a controller.\r
\r
  Arguments:\r
    This             - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
    ControllerHandle - The handle of the controller to force default configuration options on.\r
    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.\r
    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.\r
    ActionRequired   - A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
\r
  Returns:\r
    EFI_SUCCESS           - The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ActionRequired is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support forcing the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the configuration type specified by DefaultType.\r
    EFI_DEVICE_ERROR      - A device error occurred while attempt to force the default configuration options on the controller specified by  ControllerHandle and ChildHandle.\r
    EFI_OUT_RESOURCES     - There are not enough resources available to force the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
\r
--*/\r
\r
//\r
// Interface structure for the Driver Configuration Protocol\r
//\r
struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL {\r
  EFI_DRIVER_CONFIGURATION2_SET_OPTIONS    SetOptions;\r
  EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID  OptionsValid;\r
  EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS ForceDefaults;\r
  CHAR8                                   *SupportedLanguages;\r
};\r
\r
/*++\r
\r
  Protocol Description:\r
    Used to set configuration options for a controller that an EFI Driver is managing.\r
\r
  Parameters:\r
    SetOptions         - Allows the use to set drivers specific configuration\r
                         options for a controller that the driver is currently\r
                         managing.\r
    OptionsValid       - Tests to see if a controller's current configuration\r
                         options are valid.\r
    ForceDefaults      - Forces a driver to set the default configuration options\r
                         for a controller.\r
    SupportedLanguages - A Null-terminated ASCII string that contains one or more\r
                         RFC 3066 language codes.  This is the list of language\r
                         codes that this protocol supports.\r
\r
--*/\r
\r
extern EFI_GUID gEfiDriverConfiguration2ProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
03284334	1	/*++\r
03284334	2	\r
f57387d5 HT	3	Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r
f57387d5 HT	4	This program and the accompanying materials\r
03284334	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	DriverConfiguration2.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	EFI Driver Configuration2 Protocol\r
	19	\r
	20	Revision History\r
	21	\r
	22	--*/\r
	23	\r
	24	#ifndef _EFI_DRIVER_CONFIGURATION2_H_\r
	25	#define _EFI_DRIVER_CONFIGURATION2_H_\r
	26	\r
	27	#include EFI_PROTOCOL_DEFINITION (DriverConfiguration)\r
	28	\r
	29	//\r
	30	// Global ID for the Driver Configuration Protocol\r
	31	//\r
	32	#define EFI_DRIVER_CONFIGURATION2_PROTOCOL_GUID \\r
	33	{ \\r
	34	0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe} \\r
	35	}\r
	36	\r
	37	EFI_FORWARD_DECLARATION (EFI_DRIVER_CONFIGURATION2_PROTOCOL);\r
	38	\r
	39	typedef\r
	40	EFI_STATUS\r
	41	(EFIAPI *EFI_DRIVER_CONFIGURATION2_SET_OPTIONS) (\r
	42	IN EFI_DRIVER_CONFIGURATION2_PROTOCOL * This,\r
	43	IN EFI_HANDLE ControllerHandle,\r
	44	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	45	IN CHAR8 *Language,\r
	46	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED * ActionRequired\r
	47	);\r
	48	\r
	49	/*++\r
	50	\r
	51	Routine Description:\r
	52	Allows the user to set controller specific options for a controller that a\r
	53	driver is currently managing.\r
	54	\r
	55	Arguments:\r
	56	This - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
	57	ControllerHandle - The handle of the controller to set options on.\r
	58	ChildHandle - The handle of the child controller to set options on. This\r
	59	is an optional parameter that may be NULL. It will be NULL\r
	60	for device drivers, and for a bus drivers that wish to set\r
	61	options for the bus controller. It will not be NULL for a\r
	62	bus driver that wishes to set options for one of its child\r
	63	controllers.\r
	64	Language - A pointer to a three character RFC 3066 language identifier.\r
	65	This is the language of the user interface that should be\r
	66	presented to the user, and it must match one of the languages\r
	67	specified in SupportedLanguages. The number of languages\r
	68	supported by a driver is up to the driver writer.\r
69	ActionRequired - A pointer to the action that the calling agent is required\r
70	to perform when this function returns. See "Related\r
71	Definitions" for a list of the actions that the calling\r
72	agent is required to perform prior to accessing\r
73	ControllerHandle again.\r
74	\r
75	Returns:\r
76	EFI_SUCCESS - The driver specified by This successfully set the\r
77	configuration options for the controller specified\r
78	by ControllerHandle..\r
79	EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
80	EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
81	EFI_INVALID_PARAMETER - ActionRequired is NULL.\r
82	EFI_UNSUPPORTED - The driver specified by This does not support setting\r
83	configuration options for the controller specified by\r
84	ControllerHandle and ChildHandle.\r
85	EFI_UNSUPPORTED - The driver specified by This does not support the\r
86	language specified by Language.\r
87	EFI_DEVICE_ERROR - A device error occurred while attempt to set the\r
88	configuration options for the controller specified\r
89	by ControllerHandle and ChildHandle.\r
90	EFI_OUT_RESOURCES - There are not enough resources available to set the\r
91	configuration options for the controller specified\r
92	by ControllerHandle and ChildHandle.\r
93	\r
94	--*/\r
95	typedef\r
96	EFI_STATUS\r
97	(EFIAPI *EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID) (\r
98	IN EFI_DRIVER_CONFIGURATION2_PROTOCOL * This,\r
99	IN EFI_HANDLE ControllerHandle,\r
100	IN EFI_HANDLE ChildHandle OPTIONAL\r
101	);\r
102	\r
103	/*++\r
104	\r
105	Routine Description:\r
106	Tests to see if a controller's current configuration options are valid.\r
107	\r
108	Arguments:\r
109	This - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
110	ControllerHandle - The handle of the controller to test if it's current\r
111	configuration options are valid.\r
112	ChildHandle - The handle of the child controller to test if it's current\r
113	configuration options are valid. This is an optional\r
114	parameter that may be NULL. It will be NULL for device\r
115	drivers. It will also be NULL for a bus drivers that wish\r
116	to test the configuration options for the bus controller.\r
117	It will not be NULL for a bus driver that wishes to test\r
118	configuration options for one of its child controllers.\r
119	\r
120	Returns:\r
121	EFI_SUCCESS - The controller specified by ControllerHandle and\r
122	ChildHandle that is being managed by the driver\r
123	specified by This has a valid set of configuration\r
124	options.\r
125	EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
126	EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
127	EFI_UNSUPPORTED - The driver specified by This is not currently\r
128	managing the controller specified by ControllerHandle\r
129	and ChildHandle.\r
130	EFI_DEVICE_ERROR - The controller specified by ControllerHandle and\r
131	ChildHandle that is being managed by the driver\r
132	specified by This has an invalid set of configuration\r
133	options.\r
134	\r
135	--*/\r
136	typedef\r
137	EFI_STATUS\r
138	(EFIAPI *EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS) (\r
139	IN EFI_DRIVER_CONFIGURATION2_PROTOCOL * This,\r
140	IN EFI_HANDLE ControllerHandle,\r
141	IN EFI_HANDLE ChildHandle OPTIONAL,\r
142	IN UINT32 DefaultType,\r
143	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED * ActionRequired\r
144	);\r
145	\r
146	/*++\r
147	\r
148	Routine Description:\r
149	Forces a driver to set the default configuration options for a controller.\r
150	\r
151	Arguments:\r
152	This - A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
153	ControllerHandle - The handle of the controller to force default configuration options on.\r
154	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.\r
155	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.\r
156	ActionRequired - A pointer to the action that the calling agent is required to perform when this function returns. See "Related Definitions" in Section 9.1for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
157	\r
158	Returns:\r
159	EFI_SUCCESS - The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
160	EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
161	EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
162	EFI_INVALID_PARAMETER - ActionRequired is NULL.\r
163	EFI_UNSUPPORTED - The driver specified by This does not support forcing the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
164	EFI_UNSUPPORTED - The driver specified by This does not support the configuration type specified by DefaultType.\r
165	EFI_DEVICE_ERROR - A device error occurred while attempt to force the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
166	EFI_OUT_RESOURCES - There are not enough resources available to force the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
167	\r
168	--*/\r
169	\r
170	//\r
171	// Interface structure for the Driver Configuration Protocol\r
172	//\r
a1cb16bd	173	struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL {\r
03284334	174	EFI_DRIVER_CONFIGURATION2_SET_OPTIONS SetOptions;\r
	175	EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID OptionsValid;\r
	176	EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS ForceDefaults;\r
	177	CHAR8 *SupportedLanguages;\r
a1cb16bd	178	};\r
03284334	179	\r
	180	/*++\r
	181	\r
	182	Protocol Description:\r
	183	Used to set configuration options for a controller that an EFI Driver is managing.\r
	184	\r
	185	Parameters:\r
	186	SetOptions - Allows the use to set drivers specific configuration\r
	187	options for a controller that the driver is currently\r
	188	managing.\r
	189	OptionsValid - Tests to see if a controller's current configuration\r
	190	options are valid.\r
	191	ForceDefaults - Forces a driver to set the default configuration options\r
	192	for a controller.\r
	193	SupportedLanguages - A Null-terminated ASCII string that contains one or more\r
	194	RFC 3066 language codes. This is the list of language\r
	195	codes that this protocol supports.\r
	196	\r
	197	--*/\r
	198	\r
	199	extern EFI_GUID gEfiDriverConfiguration2ProtocolGuid;\r
	200	\r
	201	#endif\r