[mirror_edk2.git] / OldMdePkg / Include / Library / UefiDriverModelLib.h

/** @file\r
  UEFI Driver Model Library Services\r
\r
  Copyright (c) 2006, 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
  Module Name:  UefiDriverModelLib.h\r
\r
**/\r
\r
#ifndef __UEFI_DRIVER_MODEL_LIB_H__\r
#define __UEFI_DRIVER_MODEL_LIB_H__\r
\r
//\r
// Declare bitmask values for the protocols that are enabled \r
//\r
#define UEFI_DRIVER_MODEL_LIBRARY_COMPONENT_NAME_PROTOCOL_ENABLED        0x01\r
#define UEFI_DRIVER_MODEL_LIBRARY_DRIVER_DIAGNOSTICS_PROTOCOL_ENABLED    0x02\r
#define UEFI_DRIVER_MODEL_LIBRARY_DRIVER_CONFIGURATION_PROTOCOL_ENABLED  0x04\r
\r
//\r
// Bitmask values for the protocols that are enabled\r
//\r
extern const UINT8                           _gDriverModelProtocolBitmask;\r
\r
//\r
// Data structure that declares pointers to the Driver Model \r
// Protocols.\r
//\r
typedef struct {\r
  const EFI_DRIVER_BINDING_PROTOCOL        *DriverBinding;\r
  const EFI_COMPONENT_NAME_PROTOCOL        *ComponentName;\r
  const EFI_DRIVER_CONFIGURATION_PROTOCOL  *DriverConfiguration;\r
  const EFI_DRIVER_DIAGNOSTICS_PROTOCOL    *DriverDiagnostics;\r
} EFI_DRIVER_MODEL_PROTOCOL_LIST;\r
\r
//\r
// The number of UEFI Driver Model Protocols that the module\r
// produces.  Typically drivers only produce one.\r
// When UEFI drivers are merged, they will produce several.\r
//\r
extern const UINTN                           _gDriverModelProtocolListEntries;\r
\r
//\r
// UEFI Driver Model Protocols arrary\r
//\r
extern const EFI_DRIVER_MODEL_PROTOCOL_LIST  _gDriverModelProtocolList[];\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	UEFI Driver Model Library Services\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	Module Name: UefiDriverModelLib.h\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __UEFI_DRIVER_MODEL_LIB_H__\r
	18	#define __UEFI_DRIVER_MODEL_LIB_H__\r
	19	\r
	20	//\r
	21	// Declare bitmask values for the protocols that are enabled \r
	22	//\r
	23	#define UEFI_DRIVER_MODEL_LIBRARY_COMPONENT_NAME_PROTOCOL_ENABLED 0x01\r
	24	#define UEFI_DRIVER_MODEL_LIBRARY_DRIVER_DIAGNOSTICS_PROTOCOL_ENABLED 0x02\r
	25	#define UEFI_DRIVER_MODEL_LIBRARY_DRIVER_CONFIGURATION_PROTOCOL_ENABLED 0x04\r
	26	\r
	27	//\r
	28	// Bitmask values for the protocols that are enabled\r
	29	//\r
	30	extern const UINT8 _gDriverModelProtocolBitmask;\r
	31	\r
	32	//\r
	33	// Data structure that declares pointers to the Driver Model \r
	34	// Protocols.\r
	35	//\r
	36	typedef struct {\r
	37	const EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;\r
	38	const EFI_COMPONENT_NAME_PROTOCOL *ComponentName;\r
	39	const EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration;\r
	40	const EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics;\r
	41	} EFI_DRIVER_MODEL_PROTOCOL_LIST;\r
	42	\r
	43	//\r
	44	// The number of UEFI Driver Model Protocols that the module\r
	45	// produces. Typically drivers only produce one.\r
	46	// When UEFI drivers are merged, they will produce several.\r
	47	//\r
	48	extern const UINTN _gDriverModelProtocolListEntries;\r
	49	\r
	50	//\r
	51	// UEFI Driver Model Protocols arrary\r
	52	//\r
	53	extern const EFI_DRIVER_MODEL_PROTOCOL_LIST _gDriverModelProtocolList[];\r
	54	\r
	55	#endif\r