[mirror_edk2.git] / OvmfPkg / XenBusDxe / XenStore.h

/** @file\r
  Method declarations and structures for accessing the XenStore\r
\r
  Copyright (C) 2005 Rusty Russell, IBM Corporation\r
  Copyright (C) 2005 XenSource Ltd.\r
  Copyright (C) 2009,2010 Spectra Logic Corporation\r
  Copyright (C) 2014, Citrix Ltd.\r
\r
  This file may be distributed separately from the Linux kernel, or\r
  incorporated into other software packages, subject to the following license:\r
\r
  SPDX-License-Identifier: MIT\r
**/\r
\r
#ifndef _XEN_XENSTORE_XENSTOREVAR_H\r
#define _XEN_XENSTORE_XENSTOREVAR_H\r
\r
#include "XenBusDxe.h"\r
\r
#include <IndustryStandard/Xen/io/xs_wire.h>\r
\r
typedef struct _XENSTORE_WATCH XENSTORE_WATCH;\r
\r
/**\r
  Fetch the contents of a directory in the XenStore.\r
\r
  @param Transaction        The XenStore transaction covering this request.\r
  @param DirectoryPath      The dirname of the path to read.\r
  @param Node               The basename of the path to read.\r
  @param DirectoryCountPtr  The returned number of directory entries.\r
  @param DirectoryListPtr   An array of directory entry strings.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
\r
  @note The results buffer is alloced and should be free'd by the\r
        caller.\r
**/\r
XENSTORE_STATUS\r
XenStoreListDirectory (\r
  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN  CONST CHAR8                 *DirectoryPath,\r
  IN  CONST CHAR8                 *Node,\r
  OUT UINT32                      *DirectoryCountPtr,\r
  OUT CONST CHAR8                 ***DirectoryListPtr\r
  );\r
\r
/**\r
  Determine if a path exists in the XenStore.\r
\r
  @param Transaction  The XenStore transaction covering this request.\r
  @param Directory    The dirname of the path to read.\r
  @param Node         The basename of the path to read.\r
\r
  @retval TRUE  The path exists.\r
  @retval FALSE The path does not exist or an error occurred attempting\r
                to make that determination.\r
**/\r
BOOLEAN\r
XenStorePathExists (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *Directory,\r
  IN CONST CHAR8                 *Node\r
  );\r
\r
/**\r
  Get the contents of a single "file".  Returns the contents in *Result which\r
  should be freed after use.  The length of the value in bytes is returned in\r
  *LenPtr.\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the file to read.\r
  @param Node           The basename of the file to read.\r
  @param LenPtr         The amount of data read.\r
  @param Result         The returned contents from this file.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
\r
  @note The results buffer is malloced and should be free'd by the\r
        caller.\r
**/\r
XENSTORE_STATUS\r
XenStoreRead (\r
  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN  CONST CHAR8                 *DirectoryPath,\r
  IN  CONST CHAR8                 *Node,\r
  OUT UINT32                      *LenPtr OPTIONAL,\r
  OUT VOID                        **Result\r
  );\r
\r
/**\r
  Write to a single file.\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the file to write.\r
  @param Node           The basename of the file to write.\r
  @param Str            The NUL terminated string of data to write.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreWrite (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *DirectoryPath,\r
  IN CONST CHAR8                 *Node,\r
  IN CONST CHAR8                 *Str\r
  );\r
\r
/**\r
  Remove a file or directory (directories must be empty).\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the directory to remove.\r
  @param Node           The basename of the directory to remove.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreRemove (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *DirectoryPath,\r
  IN CONST CHAR8                 *Node\r
  );\r
\r
/**\r
  Start a transaction.\r
\r
  Changes by others will not be seen during the lifetime of this\r
  transaction, and changes will not be visible to others until it\r
  is committed (XenStoreTransactionEnd).\r
\r
  @param Transaction  The returned transaction.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreTransactionStart (\r
  OUT XENSTORE_TRANSACTION  *Transaction\r
  );\r
\r
/**\r
  End a transaction.\r
\r
  @param Transaction  The transaction to end/commit.\r
  @param Abort        If TRUE, the transaction is discarded\r
                      instead of committed.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of failure.\r
**/\r
XENSTORE_STATUS\r
XenStoreTransactionEnd (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN BOOLEAN                     Abort\r
  );\r
\r
/**\r
  Printf formatted write to a XenStore file.\r
\r
  @param Transaction      The XenStore transaction covering this request.\r
  @param DirectoryPath    The dirname of the path to read.\r
  @param Node             The basename of the path to read.\r
  @param FormatString     AsciiSPrint format string followed by a variable number\r
                          of arguments.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.\r
**/\r
XENSTORE_STATUS\r
EFIAPI\r
XenStoreSPrint (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *DirectoryPath,\r
  IN CONST CHAR8                 *Node,\r
  IN CONST CHAR8                 *FormatString,\r
  ...\r
  );\r
\r
/**\r
  VA_LIST version of XenStoreSPrint().\r
\r
  @param Transaction    The XenStore transaction covering this request.\r
  @param DirectoryPath  The dirname of the path to read.\r
  @param Node           The basename of the path to read.\r
  @param FormatString   Printf format string.\r
  @param Marker         VA_LIST of printf arguments.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.\r
**/\r
XENSTORE_STATUS\r
EFIAPI\r
XenStoreVSPrint (\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *DirectoryPath,\r
  IN CONST CHAR8                 *Node,\r
  IN CONST CHAR8                 *FormatString,\r
  IN VA_LIST                     Marker\r
  );\r
\r
/**\r
  Register a XenStore watch.\r
\r
  XenStore watches allow a client to be notified via a callback (embedded\r
  within the watch object) of changes to an object in the XenStore.\r
\r
  @param DirectoryPath  The dirname of the path to watch.\r
  @param Node           The basename of the path to watch.\r
  @param WatchPtr       A returned XENSTORE_WATCH pointer.\r
\r
  @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
           indicating the type of write failure.  EEXIST errors from the\r
           XenStore are suppressed, allowing multiple, physically different,\r
           xenbus_watch objects, to watch the same path in the XenStore.\r
**/\r
XENSTORE_STATUS\r
XenStoreRegisterWatch (\r
  IN  CONST CHAR8     *DirectoryPath,\r
  IN  CONST CHAR8     *Node,\r
  OUT XENSTORE_WATCH  **WatchPtr\r
  );\r
\r
/**\r
  Unregister a XenStore watch.\r
\r
  @param Watch  An XENSTORE_WATCH object previously returned by a successful\r
                call to XenStoreRegisterWatch ().\r
**/\r
VOID\r
XenStoreUnregisterWatch (\r
  IN XENSTORE_WATCH  *Watch\r
  );\r
\r
/**\r
  Allocate and return the XenStore path string <DirectoryPath>/<Node>.  If name\r
  is the NUL string, the returned value contains the path string\r
  <DirectoryPath>.\r
\r
  @param DirectoryPath  The NUL terminated directory prefix for new path.\r
  @param Node           The NUL terminated basename for the new path.\r
\r
  @return  A buffer containing the joined path.\r
 */\r
CHAR8 *\r
XenStoreJoin (\r
  IN CONST CHAR8  *DirectoryPath,\r
  IN CONST CHAR8  *Node\r
  );\r
\r
/**\r
  Initialize the XenStore states and rings.\r
\r
  @param Dev  A pointer to a XENBUS_DEVICE instance.\r
\r
  @return     EFI_SUCCESS if everything went smoothly.\r
**/\r
EFI_STATUS\r
XenStoreInit (\r
  XENBUS_DEVICE  *Dev\r
  );\r
\r
/**\r
  Deinitialize the XenStore states and rings.\r
\r
  @param Dev  A pointer to a XENBUS_DEVICE instance.\r
**/\r
VOID\r
XenStoreDeinit (\r
  IN XENBUS_DEVICE  *Dev\r
  );\r
\r
//\r
// XENBUS protocol\r
//\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusWaitForWatch (\r
  IN XENBUS_PROTOCOL  *This,\r
  IN VOID             *Token\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreRead (\r
  IN  XENBUS_PROTOCOL             *This,\r
  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN  CONST CHAR8                 *Node,\r
  OUT VOID                        **Value\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreBackendRead (\r
  IN  XENBUS_PROTOCOL             *This,\r
  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN  CONST CHAR8                 *Node,\r
  OUT VOID                        **Value\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreRemove (\r
  IN XENBUS_PROTOCOL             *This,\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *Node\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreTransactionStart (\r
  IN  XENBUS_PROTOCOL       *This,\r
  OUT XENSTORE_TRANSACTION  *Transaction\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreTransactionEnd (\r
  IN XENBUS_PROTOCOL             *This,\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN BOOLEAN                     Abort\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusXenStoreSPrint (\r
  IN XENBUS_PROTOCOL             *This,\r
  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
  IN CONST CHAR8                 *DirectoryPath,\r
  IN CONST CHAR8                 *Node,\r
  IN CONST CHAR8                 *FormatString,\r
  ...\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusRegisterWatch (\r
  IN  XENBUS_PROTOCOL  *This,\r
  IN  CONST CHAR8      *Node,\r
  OUT VOID             **Token\r
  );\r
\r
XENSTORE_STATUS\r
EFIAPI\r
XenBusRegisterWatchBackend (\r
  IN  XENBUS_PROTOCOL  *This,\r
  IN  CONST CHAR8      *Node,\r
  OUT VOID             **Token\r
  );\r
\r
VOID\r
EFIAPI\r
XenBusUnregisterWatch (\r
  IN XENBUS_PROTOCOL  *This,\r
  IN VOID             *Token\r
  );\r
\r
#endif /* _XEN_XENSTORE_XENSTOREVAR_H */\r
Commit	Line	Data
a9090a94 AP	1	/** @file\r
	2	Method declarations and structures for accessing the XenStore\r
	3	\r
	4	Copyright (C) 2005 Rusty Russell, IBM Corporation\r
	5	Copyright (C) 2005 XenSource Ltd.\r
	6	Copyright (C) 2009,2010 Spectra Logic Corporation\r
	7	Copyright (C) 2014, Citrix Ltd.\r
	8	\r
	9	This file may be distributed separately from the Linux kernel, or\r
	10	incorporated into other software packages, subject to the following license:\r
	11	\r
34131e1b	12	SPDX-License-Identifier: MIT\r
a9090a94 AP	13	**/\r
	14	\r
	15	#ifndef _XEN_XENSTORE_XENSTOREVAR_H\r
	16	#define _XEN_XENSTORE_XENSTOREVAR_H\r
	17	\r
	18	#include "XenBusDxe.h"\r
	19	\r
	20	#include <IndustryStandard/Xen/io/xs_wire.h>\r
	21	\r
	22	typedef struct _XENSTORE_WATCH XENSTORE_WATCH;\r
	23	\r
	24	/**\r
	25	Fetch the contents of a directory in the XenStore.\r
	26	\r
	27	@param Transaction The XenStore transaction covering this request.\r
	28	@param DirectoryPath The dirname of the path to read.\r
	29	@param Node The basename of the path to read.\r
	30	@param DirectoryCountPtr The returned number of directory entries.\r
	31	@param DirectoryListPtr An array of directory entry strings.\r
	32	\r
	33	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	34	indicating the type of failure.\r
	35	\r
	36	@note The results buffer is alloced and should be free'd by the\r
	37	caller.\r
	38	**/\r
	39	XENSTORE_STATUS\r
	40	XenStoreListDirectory (\r
ac0a286f MK	41	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	42	IN CONST CHAR8 *DirectoryPath,\r
	43	IN CONST CHAR8 *Node,\r
	44	OUT UINT32 *DirectoryCountPtr,\r
	45	OUT CONST CHAR8 ***DirectoryListPtr\r
a9090a94 AP	46	);\r
	47	\r
	48	/**\r
	49	Determine if a path exists in the XenStore.\r
	50	\r
	51	@param Transaction The XenStore transaction covering this request.\r
	52	@param Directory The dirname of the path to read.\r
	53	@param Node The basename of the path to read.\r
	54	\r
	55	@retval TRUE The path exists.\r
	56	@retval FALSE The path does not exist or an error occurred attempting\r
	57	to make that determination.\r
	58	**/\r
	59	BOOLEAN\r
	60	XenStorePathExists (\r
ac0a286f MK	61	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	62	IN CONST CHAR8 *Directory,\r
	63	IN CONST CHAR8 *Node\r
a9090a94 AP	64	);\r
	65	\r
	66	/**\r
	67	Get the contents of a single "file". Returns the contents in *Result which\r
	68	should be freed after use. The length of the value in bytes is returned in\r
	69	*LenPtr.\r
	70	\r
	71	@param Transaction The XenStore transaction covering this request.\r
	72	@param DirectoryPath The dirname of the file to read.\r
	73	@param Node The basename of the file to read.\r
	74	@param LenPtr The amount of data read.\r
	75	@param Result The returned contents from this file.\r
	76	\r
	77	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	78	indicating the type of failure.\r
	79	\r
	80	@note The results buffer is malloced and should be free'd by the\r
	81	caller.\r
	82	**/\r
	83	XENSTORE_STATUS\r
	84	XenStoreRead (\r
ac0a286f MK	85	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	86	IN CONST CHAR8 *DirectoryPath,\r
	87	IN CONST CHAR8 *Node,\r
	88	OUT UINT32 *LenPtr OPTIONAL,\r
	89	OUT VOID **Result\r
a9090a94 AP	90	);\r
	91	\r
	92	/**\r
	93	Write to a single file.\r
	94	\r
	95	@param Transaction The XenStore transaction covering this request.\r
	96	@param DirectoryPath The dirname of the file to write.\r
	97	@param Node The basename of the file to write.\r
	98	@param Str The NUL terminated string of data to write.\r
	99	\r
	100	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	101	indicating the type of failure.\r
	102	**/\r
	103	XENSTORE_STATUS\r
	104	XenStoreWrite (\r
ac0a286f MK	105	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	106	IN CONST CHAR8 *DirectoryPath,\r
	107	IN CONST CHAR8 *Node,\r
	108	IN CONST CHAR8 *Str\r
a9090a94 AP	109	);\r
	110	\r
	111	/**\r
	112	Remove a file or directory (directories must be empty).\r
	113	\r
	114	@param Transaction The XenStore transaction covering this request.\r
	115	@param DirectoryPath The dirname of the directory to remove.\r
	116	@param Node The basename of the directory to remove.\r
	117	\r
	118	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	119	indicating the type of failure.\r
	120	**/\r
	121	XENSTORE_STATUS\r
	122	XenStoreRemove (\r
ac0a286f MK	123	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	124	IN CONST CHAR8 *DirectoryPath,\r
	125	IN CONST CHAR8 *Node\r
a9090a94 AP	126	);\r
	127	\r
	128	/**\r
	129	Start a transaction.\r
	130	\r
	131	Changes by others will not be seen during the lifetime of this\r
	132	transaction, and changes will not be visible to others until it\r
	133	is committed (XenStoreTransactionEnd).\r
	134	\r
	135	@param Transaction The returned transaction.\r
	136	\r
	137	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	138	indicating the type of failure.\r
	139	**/\r
	140	XENSTORE_STATUS\r
	141	XenStoreTransactionStart (\r
ac0a286f	142	OUT XENSTORE_TRANSACTION *Transaction\r
a9090a94 AP	143	);\r
	144	\r
	145	/**\r
	146	End a transaction.\r
	147	\r
	148	@param Transaction The transaction to end/commit.\r
	149	@param Abort If TRUE, the transaction is discarded\r
	150	instead of committed.\r
	151	\r
	152	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	153	indicating the type of failure.\r
	154	**/\r
	155	XENSTORE_STATUS\r
	156	XenStoreTransactionEnd (\r
ac0a286f MK	157	IN CONST XENSTORE_TRANSACTION *Transaction,\r
ac0a286f MK	158	IN BOOLEAN Abort\r
a9090a94 AP	159	);\r
	160	\r
	161	/**\r
	162	Printf formatted write to a XenStore file.\r
	163	\r
	164	@param Transaction The XenStore transaction covering this request.\r
	165	@param DirectoryPath The dirname of the path to read.\r
	166	@param Node The basename of the path to read.\r
	167	@param FormatString AsciiSPrint format string followed by a variable number\r
	168	of arguments.\r
	169	\r
	170	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	171	indicating the type of write failure.\r
	172	**/\r
	173	XENSTORE_STATUS\r
	174	EFIAPI\r
	175	XenStoreSPrint (\r
ac0a286f MK	176	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	177	IN CONST CHAR8 *DirectoryPath,\r
	178	IN CONST CHAR8 *Node,\r
	179	IN CONST CHAR8 *FormatString,\r
a9090a94 AP	180	...\r
	181	);\r
	182	\r
	183	/**\r
	184	VA_LIST version of XenStoreSPrint().\r
	185	\r
	186	@param Transaction The XenStore transaction covering this request.\r
	187	@param DirectoryPath The dirname of the path to read.\r
	188	@param Node The basename of the path to read.\r
	189	@param FormatString Printf format string.\r
	190	@param Marker VA_LIST of printf arguments.\r
	191	\r
	192	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	193	indicating the type of write failure.\r
	194	**/\r
	195	XENSTORE_STATUS\r
c5c9e7e2	196	EFIAPI\r
a9090a94	197	XenStoreVSPrint (\r
ac0a286f MK	198	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	199	IN CONST CHAR8 *DirectoryPath,\r
	200	IN CONST CHAR8 *Node,\r
	201	IN CONST CHAR8 *FormatString,\r
	202	IN VA_LIST Marker\r
a9090a94 AP	203	);\r
	204	\r
	205	/**\r
	206	Register a XenStore watch.\r
	207	\r
	208	XenStore watches allow a client to be notified via a callback (embedded\r
	209	within the watch object) of changes to an object in the XenStore.\r
	210	\r
	211	@param DirectoryPath The dirname of the path to watch.\r
	212	@param Node The basename of the path to watch.\r
	213	@param WatchPtr A returned XENSTORE_WATCH pointer.\r
	214	\r
	215	@return On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
	216	indicating the type of write failure. EEXIST errors from the\r
b6b33f67	217	XenStore are suppressed, allowing multiple, physically different,\r
a9090a94 AP	218	xenbus_watch objects, to watch the same path in the XenStore.\r
	219	**/\r
	220	XENSTORE_STATUS\r
	221	XenStoreRegisterWatch (\r
	222	IN CONST CHAR8 *DirectoryPath,\r
	223	IN CONST CHAR8 *Node,\r
	224	OUT XENSTORE_WATCH **WatchPtr\r
	225	);\r
	226	\r
	227	/**\r
	228	Unregister a XenStore watch.\r
	229	\r
	230	@param Watch An XENSTORE_WATCH object previously returned by a successful\r
	231	call to XenStoreRegisterWatch ().\r
	232	**/\r
	233	VOID\r
	234	XenStoreUnregisterWatch (\r
ac0a286f	235	IN XENSTORE_WATCH *Watch\r
a9090a94 AP	236	);\r
	237	\r
	238	/**\r
	239	Allocate and return the XenStore path string <DirectoryPath>/<Node>. If name\r
	240	is the NUL string, the returned value contains the path string\r
	241	<DirectoryPath>.\r
	242	\r
ac0a286f	243	@param DirectoryPath The NUL terminated directory prefix for new path.\r
a9090a94 AP	244	@param Node The NUL terminated basename for the new path.\r
	245	\r
	246	@return A buffer containing the joined path.\r
	247	*/\r
	248	CHAR8 *\r
	249	XenStoreJoin (\r
ac0a286f MK	250	IN CONST CHAR8 *DirectoryPath,\r
ac0a286f MK	251	IN CONST CHAR8 *Node\r
a9090a94 AP	252	);\r
a9090a94 AP	253	\r
a9090a94 AP	254	/**\r
	255	Initialize the XenStore states and rings.\r
	256	\r
	257	@param Dev A pointer to a XENBUS_DEVICE instance.\r
	258	\r
	259	@return EFI_SUCCESS if everything went smoothly.\r
	260	**/\r
	261	EFI_STATUS\r
	262	XenStoreInit (\r
ac0a286f	263	XENBUS_DEVICE *Dev\r
a9090a94 AP	264	);\r
	265	\r
	266	/**\r
	267	Deinitialize the XenStore states and rings.\r
	268	\r
	269	@param Dev A pointer to a XENBUS_DEVICE instance.\r
	270	**/\r
	271	VOID\r
	272	XenStoreDeinit (\r
ac0a286f	273	IN XENBUS_DEVICE *Dev\r
a9090a94 AP	274	);\r
a9090a94 AP	275	\r
c23c037f AP	276	//\r
	277	// XENBUS protocol\r
	278	//\r
	279	\r
	280	XENSTORE_STATUS\r
	281	EFIAPI\r
	282	XenBusWaitForWatch (\r
ac0a286f MK	283	IN XENBUS_PROTOCOL *This,\r
ac0a286f MK	284	IN VOID *Token\r
c23c037f AP	285	);\r
	286	\r
	287	XENSTORE_STATUS\r
	288	EFIAPI\r
	289	XenBusXenStoreRead (\r
ac0a286f MK	290	IN XENBUS_PROTOCOL *This,\r
	291	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	292	IN CONST CHAR8 *Node,\r
	293	OUT VOID **Value\r
c23c037f AP	294	);\r
	295	\r
	296	XENSTORE_STATUS\r
	297	EFIAPI\r
	298	XenBusXenStoreBackendRead (\r
ac0a286f MK	299	IN XENBUS_PROTOCOL *This,\r
	300	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	301	IN CONST CHAR8 *Node,\r
	302	OUT VOID **Value\r
c23c037f AP	303	);\r
	304	\r
	305	XENSTORE_STATUS\r
	306	EFIAPI\r
	307	XenBusXenStoreRemove (\r
ac0a286f MK	308	IN XENBUS_PROTOCOL *This,\r
	309	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	310	IN CONST CHAR8 *Node\r
c23c037f AP	311	);\r
	312	\r
	313	XENSTORE_STATUS\r
	314	EFIAPI\r
	315	XenBusXenStoreTransactionStart (\r
	316	IN XENBUS_PROTOCOL *This,\r
	317	OUT XENSTORE_TRANSACTION *Transaction\r
	318	);\r
	319	\r
	320	XENSTORE_STATUS\r
	321	EFIAPI\r
	322	XenBusXenStoreTransactionEnd (\r
ac0a286f MK	323	IN XENBUS_PROTOCOL *This,\r
	324	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	325	IN BOOLEAN Abort\r
c23c037f AP	326	);\r
	327	\r
	328	XENSTORE_STATUS\r
	329	EFIAPI\r
	330	XenBusXenStoreSPrint (\r
ac0a286f MK	331	IN XENBUS_PROTOCOL *This,\r
	332	IN CONST XENSTORE_TRANSACTION *Transaction,\r
	333	IN CONST CHAR8 *DirectoryPath,\r
	334	IN CONST CHAR8 *Node,\r
	335	IN CONST CHAR8 *FormatString,\r
c23c037f AP	336	...\r
	337	);\r
	338	\r
	339	XENSTORE_STATUS\r
	340	EFIAPI\r
	341	XenBusRegisterWatch (\r
ac0a286f MK	342	IN XENBUS_PROTOCOL *This,\r
	343	IN CONST CHAR8 *Node,\r
	344	OUT VOID **Token\r
c23c037f AP	345	);\r
	346	\r
	347	XENSTORE_STATUS\r
	348	EFIAPI\r
	349	XenBusRegisterWatchBackend (\r
ac0a286f MK	350	IN XENBUS_PROTOCOL *This,\r
	351	IN CONST CHAR8 *Node,\r
	352	OUT VOID **Token\r
c23c037f AP	353	);\r
	354	\r
	355	VOID\r
	356	EFIAPI\r
	357	XenBusUnregisterWatch (\r
	358	IN XENBUS_PROTOCOL *This,\r
	359	IN VOID *Token\r
	360	);\r
	361	\r
a9090a94	362	#endif /* _XEN_XENSTORE_XENSTOREVAR_H */\r