2 Function declaration and internal data for XenBusDxe.
4 Copyright (C) 2014, Citrix Ltd.
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef __EFI_XENBUS_DXE_H__
11 #define __EFI_XENBUS_DXE_H__
18 #include <Library/UefiBootServicesTableLib.h>
19 #include <Library/MemoryAllocationLib.h>
20 #include <Library/BaseMemoryLib.h>
21 #include <Library/BaseLib.h>
22 #include <Library/UefiLib.h>
23 #include <Library/DevicePathLib.h>
24 #include <Library/DebugLib.h>
25 #include <Library/PcdLib.h>
29 // UEFI Driver Model Protocols
31 #include <Protocol/DriverBinding.h>
37 #include <Protocol/XenIo.h>
43 #include <Protocol/XenBus.h>
49 #define XENBUS_DXE_VERSION 0x00000010
55 extern EFI_DRIVER_BINDING_PROTOCOL gXenBusDxeDriverBinding
;
56 extern EFI_COMPONENT_NAME2_PROTOCOL gXenBusDxeComponentName2
;
57 extern EFI_COMPONENT_NAME_PROTOCOL gXenBusDxeComponentName
;
61 // Include files with function prototypes
63 #include "DriverBinding.h"
64 #include "ComponentName.h"
69 #include <IndustryStandard/Xen/xen.h>
71 typedef struct _XENBUS_DEVICE_PATH XENBUS_DEVICE_PATH
;
72 typedef struct _XENBUS_DEVICE XENBUS_DEVICE
;
74 // Have the state of the driver.
75 #define XENBUS_DEVICE_SIGNATURE SIGNATURE_32 ('X','B','s','t')
76 struct _XENBUS_DEVICE
{
78 EFI_DRIVER_BINDING_PROTOCOL
*This
;
79 EFI_HANDLE ControllerHandle
;
80 XENIO_PROTOCOL
*XenIo
;
81 EFI_EVENT ExitBootEvent
;
82 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
85 shared_info_t
*SharedInfo
;
88 // There is one of this struct allocated for every child.
89 #define XENBUS_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('X', 'B', 'p', 'd')
94 XENBUS_PROTOCOL XenBusIo
;
96 XENBUS_DEVICE_PATH
*DevicePath
;
97 } XENBUS_PRIVATE_DATA
;
99 #define XENBUS_PRIVATE_DATA_FROM_THIS(a) \
100 CR (a, XENBUS_PRIVATE_DATA, XenBusIo, XENBUS_PRIVATE_DATA_SIGNATURE)
101 #define XENBUS_PRIVATE_DATA_FROM_LINK(a) \
102 CR (a, XENBUS_PRIVATE_DATA, Link, XENBUS_PRIVATE_DATA_SIGNATURE)
109 Atomically test and clear a bit.
111 @param Bit Bit index to test in *Address
112 @param Address The Address to the buffer that contain the bit to test.
114 @return Value of the Bit before it was cleared.