[mirror_edk2.git] / MdePkg / Include / Protocol / DriverConfiguration.h

/** @file\r
  EFI Driver Configuration Protocol\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EFI_DRIVER_CONFIGURATION_H__\r
#define __EFI_DRIVER_CONFIGURATION_H__\r
\r
#include <Protocol/DriverConfiguration2.h>\r
\r
///\r
/// Global ID for the Driver Configuration Protocol defined in EFI 1.1\r
///\r
#define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
  { \\r
    0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
  }\r
\r
typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROTOCOL;\r
\r
/**\r
  Allows the user to set controller specific options for a controller that a\r
  driver is currently managing.\r
\r
  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
  @param  ControllerHandle The handle of the controller to set options on.\r
  @param  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 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
  @param  Language         A pointer to a three character ISO 639-2 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
  @param  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
  @retval EFI_SUCCESS           The driver specified by This successfully set the\r
                                configuration options for the controller specified\r
                                by ControllerHandle..\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support setting\r
                                configuration options for the controller specified by\r
                                ControllerHandle and ChildHandle.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the\r
                                language specified by Language.\r
  @retval 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
  @retval 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_CONFIGURATION_SET_OPTIONS)(\r
  IN EFI_DRIVER_CONFIGURATION_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
  Tests to see if a controller's current configuration options are valid.\r
\r
  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
  @param  ControllerHandle The handle of the controller to test if it's current\r
                           configuration options are valid.\r
  @param  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 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
  @retval 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
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by ControllerHandle\r
                                and ChildHandle.\r
  @retval 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_CONFIGURATION_OPTIONS_VALID)(\r
  IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
  IN  EFI_HANDLE                                              ControllerHandle,\r
  IN  EFI_HANDLE                                              ChildHandle  OPTIONAL\r
  );\r
\r
/**\r
  Forces a driver to set the default configuration options for a controller.\r
\r
  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
  @param  ControllerHandle The handle of the controller to force default configuration options on.\r
  @param  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 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
  @param  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
  @param  ActionRequired   A pointer to the action that the calling agent is required to perform when this function returns.  See "Related Definitions" in Section 9.1 for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
\r
  @retval EFI_SUCCESS           The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support forcing the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support the configuration type specified by DefaultType.\r
  @retval EFI_DEVICE_ERROR      A device error occurred while attempt to force the default configuration options on the controller specified by  ControllerHandle and ChildHandle.\r
  @retval 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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS)(\r
  IN EFI_DRIVER_CONFIGURATION_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
/// Used to set configuration options for a controller that an EFI Driver is managing.\r
///\r
struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {\r
  EFI_DRIVER_CONFIGURATION_SET_OPTIONS    SetOptions;\r
  EFI_DRIVER_CONFIGURATION_OPTIONS_VALID  OptionsValid;\r
  EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
  ///\r
  /// A Null-terminated ASCII string that contains one or more\r
  /// ISO 639-2 language codes.  This is the list of language\r
  /// codes that this protocol supports.\r
  ///\r
  CHAR8                                   *SupportedLanguages;\r
};\r
\r
\r
extern EFI_GUID gEfiDriverConfigurationProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
d1f95000	1	/** @file\r
	2	EFI Driver Configuration Protocol\r
	3	\r
9095d37b	4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
d1f95000	6	\r
d1f95000	7	**/\r
	8	\r
	9	#ifndef __EFI_DRIVER_CONFIGURATION_H__\r
	10	#define __EFI_DRIVER_CONFIGURATION_H__\r
	11	\r
f22a5f43	12	#include <Protocol/DriverConfiguration2.h>\r
f22a5f43	13	\r
99e8ed21	14	///\r
74fec708	15	/// Global ID for the Driver Configuration Protocol defined in EFI 1.1\r
99e8ed21	16	///\r
d1f95000	17	#define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
	18	{ \\r
	19	0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
	20	}\r
9095d37b	21	\r
d1f95000	22	typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL EFI_DRIVER_CONFIGURATION_PROTOCOL;\r
d1f95000	23	\r
d1f95000	24	/**\r
9095d37b	25	Allows the user to set controller specific options for a controller that a\r
d1f95000	26	driver is currently managing.\r
d1f95000	27	\r
4ca9b6c4	28	@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
d1f95000	29	@param ControllerHandle The handle of the controller to set options on.\r
	30	@param ChildHandle The handle of the child controller to set options on. This\r
	31	is an optional parameter that may be NULL. It will be NULL\r
630b4187	32	for device drivers, and for bus drivers that wish to set\r
d1f95000	33	options for the bus controller. It will not be NULL for a\r
	34	bus driver that wishes to set options for one of its child\r
	35	controllers.\r
	36	@param Language A pointer to a three character ISO 639-2 language identifier.\r
	37	This is the language of the user interface that should be\r
	38	presented to the user, and it must match one of the languages\r
	39	specified in SupportedLanguages. The number of languages\r
	40	supported by a driver is up to the driver writer.\r
	41	@param ActionRequired A pointer to the action that the calling agent is required\r
	42	to perform when this function returns. See "Related\r
	43	Definitions" for a list of the actions that the calling\r
	44	agent is required to perform prior to accessing\r
	45	ControllerHandle again.\r
	46	\r
	47	@retval EFI_SUCCESS The driver specified by This successfully set the\r
	48	configuration options for the controller specified\r
	49	by ControllerHandle..\r
	50	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	51	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
	52	@retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
	53	@retval EFI_UNSUPPORTED The driver specified by This does not support setting\r
	54	configuration options for the controller specified by\r
	55	ControllerHandle and ChildHandle.\r
	56	@retval EFI_UNSUPPORTED The driver specified by This does not support the\r
	57	language specified by Language.\r
	58	@retval EFI_DEVICE_ERROR A device error occurred while attempt to set the\r
	59	configuration options for the controller specified\r
	60	by ControllerHandle and ChildHandle.\r
	61	@retval EFI_OUT_RESOURCES There are not enough resources available to set the\r
	62	configuration options for the controller specified\r
	63	by ControllerHandle and ChildHandle.\r
	64	\r
	65	**/\r
	66	typedef\r
	67	EFI_STATUS\r
8b13229b	68	(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS)(\r
d1f95000	69	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,\r
	70	IN EFI_HANDLE ControllerHandle,\r
	71	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	72	IN CHAR8 *Language,\r
	73	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired\r
	74	);\r
	75	\r
	76	/**\r
	77	Tests to see if a controller's current configuration options are valid.\r
	78	\r
	79	@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
	80	@param ControllerHandle The handle of the controller to test if it's current\r
	81	configuration options are valid.\r
	82	@param ChildHandle The handle of the child controller to test if it's current\r
	83	configuration options are valid. This is an optional\r
	84	parameter that may be NULL. It will be NULL for device\r
630b4187	85	drivers. It will also be NULL for bus drivers that wish\r
d1f95000	86	to test the configuration options for the bus controller.\r
	87	It will not be NULL for a bus driver that wishes to test\r
	88	configuration options for one of its child controllers.\r
	89	\r
	90	@retval EFI_SUCCESS The controller specified by ControllerHandle and\r
	91	ChildHandle that is being managed by the driver\r
	92	specified by This has a valid set of configuration\r
	93	options.\r
	94	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	95	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
	96	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	97	managing the controller specified by ControllerHandle\r
	98	and ChildHandle.\r
	99	@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and\r
	100	ChildHandle that is being managed by the driver\r
	101	specified by This has an invalid set of configuration\r
	102	options.\r
	103	\r
	104	**/\r
	105	typedef\r
	106	EFI_STATUS\r
8b13229b	107	(EFIAPI *EFI_DRIVER_CONFIGURATION_OPTIONS_VALID)(\r
d1f95000	108	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,\r
	109	IN EFI_HANDLE ControllerHandle,\r
	110	IN EFI_HANDLE ChildHandle OPTIONAL\r
	111	);\r
	112	\r
	113	/**\r
	114	Forces a driver to set the default configuration options for a controller.\r
	115	\r
4ca9b6c4	116	@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
d1f95000	117	@param ControllerHandle The handle of the controller to force default configuration options on.\r
630b4187	118	@param 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 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
d1f95000	119	@param 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
630b4187	120	@param ActionRequired A pointer to the action that the calling agent is required to perform when this function returns. See "Related Definitions" in Section 9.1 for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
d1f95000	121	\r
	122	@retval EFI_SUCCESS The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
	123	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	124	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
	125	@retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
	126	@retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
	127	@retval EFI_UNSUPPORTED The driver specified by This does not support the configuration type specified by DefaultType.\r
	128	@retval EFI_DEVICE_ERROR A device error occurred while attempt to force the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
	129	@retval EFI_OUT_RESOURCES There are not enough resources available to force the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
	130	\r
	131	**/\r
	132	typedef\r
	133	EFI_STATUS\r
8b13229b	134	(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS)(\r
d1f95000	135	IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This,\r
	136	IN EFI_HANDLE ControllerHandle,\r
	137	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	138	IN UINT32 DefaultType,\r
	139	OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired\r
	140	);\r
	141	\r
	142	\r
44717a39	143	///\r
	144	/// Used to set configuration options for a controller that an EFI Driver is managing.\r
	145	///\r
4ca9b6c4 LG	146	struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {\r
	147	EFI_DRIVER_CONFIGURATION_SET_OPTIONS SetOptions;\r
	148	EFI_DRIVER_CONFIGURATION_OPTIONS_VALID OptionsValid;\r
	149	EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
3354353d	150	///\r
9095d37b LG	151	/// A Null-terminated ASCII string that contains one or more\r
	152	/// ISO 639-2 language codes. This is the list of language\r
	153	/// codes that this protocol supports.\r
3354353d	154	///\r
4ca9b6c4 LG	155	CHAR8 *SupportedLanguages;\r
	156	};\r
	157	\r
d1f95000	158	\r
d1f95000	159	extern EFI_GUID gEfiDriverConfigurationProtocolGuid;\r
d1f95000	160	\r
d1f95000	161	#endif\r