2 Function declaration and internal data for XenBusDxe.
4 Copyright (C) 2014, Citrix Ltd.
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __EFI_XENBUS_DXE_H__
17 #define __EFI_XENBUS_DXE_H__
24 #include <Library/UefiBootServicesTableLib.h>
25 #include <Library/MemoryAllocationLib.h>
26 #include <Library/BaseMemoryLib.h>
27 #include <Library/BaseLib.h>
28 #include <Library/UefiLib.h>
29 #include <Library/DevicePathLib.h>
30 #include <Library/DebugLib.h>
34 // UEFI Driver Model Protocols
36 #include <Protocol/DriverBinding.h>
42 #include <Protocol/XenIo.h>
48 #include <Protocol/XenBus.h>
54 #define XENBUS_DXE_VERSION 0x00000010
60 extern EFI_DRIVER_BINDING_PROTOCOL gXenBusDxeDriverBinding
;
61 extern EFI_COMPONENT_NAME2_PROTOCOL gXenBusDxeComponentName2
;
62 extern EFI_COMPONENT_NAME_PROTOCOL gXenBusDxeComponentName
;
66 // Include files with function prototypes
68 #include "DriverBinding.h"
69 #include "ComponentName.h"
74 #include <IndustryStandard/Xen/xen.h>
76 typedef struct _XENBUS_DEVICE_PATH XENBUS_DEVICE_PATH
;
77 typedef struct _XENBUS_DEVICE XENBUS_DEVICE
;
79 // Have the state of the driver.
80 #define XENBUS_DEVICE_SIGNATURE SIGNATURE_32 ('X','B','s','t')
81 struct _XENBUS_DEVICE
{
83 EFI_DRIVER_BINDING_PROTOCOL
*This
;
84 EFI_HANDLE ControllerHandle
;
85 XENIO_PROTOCOL
*XenIo
;
86 EFI_EVENT ExitBootEvent
;
87 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
90 shared_info_t
*SharedInfo
;
93 // There is one of this struct allocated for every child.
94 #define XENBUS_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('X', 'B', 'p', 'd')
99 XENBUS_PROTOCOL XenBusIo
;
101 XENBUS_DEVICE_PATH
*DevicePath
;
102 } XENBUS_PRIVATE_DATA
;
104 #define XENBUS_PRIVATE_DATA_FROM_THIS(a) \
105 CR (a, XENBUS_PRIVATE_DATA, XenBusIo, XENBUS_PRIVATE_DATA_SIGNATURE)
106 #define XENBUS_PRIVATE_DATA_FROM_LINK(a) \
107 CR (a, XENBUS_PRIVATE_DATA, Link, XENBUS_PRIVATE_DATA_SIGNATURE)
114 Atomically test and clear a bit.
116 @param Bit Bit index to test in *Address
117 @param Address The Address to the buffer that contain the bit to test.
119 @return Value of the Bit before it was cleared.