[mirror_edk2.git] / OvmfPkg / Include / Library / XenIoMmioLib.h

/** @file\r
*  Manage XenBus device path and I/O handles\r
*\r
*  Copyright (c) 2015, Linaro Ltd. All rights reserved.<BR>\r
*\r
*  This program and the accompanying materials are\r
*  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 _XENIO_MMIO_DEVICE_LIB_H_\r
#define _XENIO_MMIO_DEVICE_LIB_H_\r
\r
/**\r
\r
  Install the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols on\r
  the handle pointed to by @Handle, or on a new handle if it points to\r
  NULL\r
\r
  @param  Handle                Pointer to the handle to install the protocols\r
                                on, may point to a NULL handle.\r
\r
  @param  GrantTableAddress     The address of the Xen grant table\r
\r
  @retval EFI_SUCCESS           Protocols were installed successfully\r
\r
  @retval EFI_OUT_OF_RESOURCES  The function failed to allocate memory required\r
                                by the XenIo MMIO and device path protocols\r
\r
  @return                       Status code returned by the boot service\r
                                InstallMultipleProtocolInterfaces ()\r
\r
**/\r
EFI_STATUS\r
XenIoMmioInstall (\r
  IN OUT   EFI_HANDLE              *Handle,\r
  IN       EFI_PHYSICAL_ADDRESS    GrantTableAddress\r
  );\r
\r
\r
/**\r
\r
  Uninstall the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols\r
\r
  @param  Handle          Handle onto which the protocols have been installed\r
                          earlier by XenIoMmioInstall ()\r
\r
  @retval EFI_SUCCESS     Protocols were uninstalled successfully\r
\r
  @return                 Status code returned by the boot service\r
                          UninstallMultipleProtocolInterfaces ()\r
\r
**/\r
EFI_STATUS\r
XenIoMmioUninstall (\r
  IN       EFI_HANDLE              Handle\r
  );\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	* Manage XenBus device path and I/O handles\r
	3	*\r
	4	* Copyright (c) 2015, Linaro Ltd. All rights reserved.<BR>\r
	5	*\r
	6	* This program and the accompanying materials are\r
	7	* licensed and made available under the terms and conditions of the BSD License\r
	8	* which accompanies this distribution. The full text of the license may be found at\r
	9	* http://opensource.org/licenses/bsd-license.php\r
	10	*\r
	11	* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	*\r
	14	**/\r
	15	\r
	16	#ifndef _XENIO_MMIO_DEVICE_LIB_H_\r
	17	#define _XENIO_MMIO_DEVICE_LIB_H_\r
	18	\r
	19	/**\r
	20	\r
	21	Install the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols on\r
	22	the handle pointed to by @Handle, or on a new handle if it points to\r
	23	NULL\r
	24	\r
	25	@param Handle Pointer to the handle to install the protocols\r
	26	on, may point to a NULL handle.\r
	27	\r
	28	@param GrantTableAddress The address of the Xen grant table\r
	29	\r
	30	@retval EFI_SUCCESS Protocols were installed successfully\r
	31	\r
	32	@retval EFI_OUT_OF_RESOURCES The function failed to allocate memory required\r
	33	by the XenIo MMIO and device path protocols\r
	34	\r
	35	@return Status code returned by the boot service\r
	36	InstallMultipleProtocolInterfaces ()\r
	37	\r
	38	**/\r
	39	EFI_STATUS\r
	40	XenIoMmioInstall (\r
	41	IN OUT EFI_HANDLE *Handle,\r
	42	IN EFI_PHYSICAL_ADDRESS GrantTableAddress\r
	43	);\r
	44	\r
	45	\r
	46	/**\r
	47	\r
	48	Uninstall the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols\r
	49	\r
	50	@param Handle Handle onto which the protocols have been installed\r
	51	earlier by XenIoMmioInstall ()\r
	52	\r
	53	@retval EFI_SUCCESS Protocols were uninstalled successfully\r
	54	\r
	55	@return Status code returned by the boot service\r
	56	UninstallMultipleProtocolInterfaces ()\r
	57	\r
	58	**/\r
	59	EFI_STATUS\r
	60	XenIoMmioUninstall (\r
	61	IN EFI_HANDLE Handle\r
	62	);\r
	63	\r
	64	#endif\r