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

/** @file\r
  The protocol provides information about the version of the EFI\r
  specification that a driver is following. This protocol is\r
  required for EFI drivers that are on PCI and other plug in\r
  cards.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation\r
  All rights reserved. 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
**/\r
\r
#ifndef __DRIVER_SUPPORTED_EFI_VERSION_H__\r
#define __DRIVER_SUPPORTED_EFI_VERSION_H__\r
\r
#define EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL_GUID  \\r
  { 0x5c198761, 0x16a8, 0x4e69, { 0x97, 0x2c, 0x89, 0xd6, 0x79, 0x54, 0xf8, 0x1d } }\r
\r
\r
/**\r
  @par Protocol Description:  \r
  The EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL provides a\r
  mechanism for an EFI driver to publish the version of the EFI   \r
  specification it conforms to. This protocol must be placed on   \r
  the drivers image handle when the driver's entry point is   \r
  called.\r
**/ \r
typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {\r
  ///\r
  /// The size, in bytes, of the entire structure. Future versions of this \r
  /// specification may grow the size of the structure.\r
  /// \r
  UINT32 Length;\r
  ///\r
  /// The version of the EFI specification that this driver conforms to.\r
  /// EFI_2_10_SYSTEM_TABLE_REVISION for this version of this specification.  \r
  ///\r
  UINT32 FirmwareVersion;\r
} EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL;\r
\r
extern EFI_GUID gEfiDriverSupportedEfiVersionProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
d1f95000	1	/** @file\r
4ca9b6c4	2	The protocol provides information about the version of the EFI\r
d1f95000	3	specification that a driver is following. This protocol is\r
	4	required for EFI drivers that are on PCI and other plug in\r
	5	cards.\r
	6	\r
4ca9b6c4	7	Copyright (c) 2006 - 2008, Intel Corporation\r
d1f95000	8	All rights reserved. This program and the accompanying materials \r
	9	are licensed and made available under the terms and conditions of the BSD License \r
	10	which accompanies this distribution. The full text of the license may be found at \r
	11	http://opensource.org/licenses/bsd-license.php \r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	15	\r
d1f95000	16	**/\r
	17	\r
	18	#ifndef __DRIVER_SUPPORTED_EFI_VERSION_H__\r
	19	#define __DRIVER_SUPPORTED_EFI_VERSION_H__\r
	20	\r
	21	#define EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL_GUID \\r
	22	{ 0x5c198761, 0x16a8, 0x4e69, { 0x97, 0x2c, 0x89, 0xd6, 0x79, 0x54, 0xf8, 0x1d } }\r
	23	\r
	24	\r
	25	/**\r
4ca9b6c4	26	@par Protocol Description: \r
d1f95000	27	The EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL provides a\r
	28	mechanism for an EFI driver to publish the version of the EFI \r
	29	specification it conforms to. This protocol must be placed on \r
e89b6bfc	30	the drivers image handle when the driver's entry point is \r
d1f95000	31	called.\r
d1f95000	32	**/ \r
d1f95000	33	typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {\r
3354353d	34	///\r
	35	/// The size, in bytes, of the entire structure. Future versions of this \r
	36	/// specification may grow the size of the structure.\r
	37	/// \r
d1f95000	38	UINT32 Length;\r
3354353d	39	///\r
	40	/// The version of the EFI specification that this driver conforms to.\r
	41	/// EFI_2_10_SYSTEM_TABLE_REVISION for this version of this specification. \r
	42	///\r
d1f95000	43	UINT32 FirmwareVersion;\r
	44	} EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL;\r
	45	\r
	46	extern EFI_GUID gEfiDriverSupportedEfiVersionProtocolGuid;\r
	47	\r
	48	#endif\r