VBoxGuestLib.h revision 852759c8c9cdfc94a57cec49653901fab3bf261c
236b2935f217749893b7034e59da3e3568928acevboxsync/** @file
236b2935f217749893b7034e59da3e3568928acevboxsync * VBoxGuestLib - VirtualBox Guest Additions Library.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/*
236b2935f217749893b7034e59da3e3568928acevboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
236b2935f217749893b7034e59da3e3568928acevboxsync * available from http://www.virtualbox.org. This file is free software;
236b2935f217749893b7034e59da3e3568928acevboxsync * you can redistribute it and/or modify it under the terms of the GNU
236b2935f217749893b7034e59da3e3568928acevboxsync * General Public License (GPL) as published by the Free Software
236b2935f217749893b7034e59da3e3568928acevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
236b2935f217749893b7034e59da3e3568928acevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
236b2935f217749893b7034e59da3e3568928acevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * The contents of this file may alternatively be used under the terms
236b2935f217749893b7034e59da3e3568928acevboxsync * of the Common Development and Distribution License Version 1.0
236b2935f217749893b7034e59da3e3568928acevboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
236b2935f217749893b7034e59da3e3568928acevboxsync * VirtualBox OSE distribution, in which case the provisions of the
236b2935f217749893b7034e59da3e3568928acevboxsync * CDDL are applicable instead of those of the GPL.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * You may elect to license modified versions of this file under the
236b2935f217749893b7034e59da3e3568928acevboxsync * terms and conditions of either the GPL or the CDDL or both.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
236b2935f217749893b7034e59da3e3568928acevboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
236b2935f217749893b7034e59da3e3568928acevboxsync * additional information or have any questions.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#ifndef ___VBox_VBoxGuestLib_h
236b2935f217749893b7034e59da3e3568928acevboxsync#define ___VBox_VBoxGuestLib_h
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#include <VBox/types.h>
157093a77f2752732368338110cb50fa6cd7717fvboxsync#include <VBox/VMMDev2.h>
157093a77f2752732368338110cb50fa6cd7717fvboxsync#ifdef IN_RING0
236b2935f217749893b7034e59da3e3568928acevboxsync# include <VBox/VMMDev.h> /* grumble */
157093a77f2752732368338110cb50fa6cd7717fvboxsync# include <VBox/VBoxGuest2.h>
157093a77f2752732368338110cb50fa6cd7717fvboxsync#endif
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @defgroup grp_guest_lib VirtualBox Guest Additions Library
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{
236b2935f217749893b7034e59da3e3568928acevboxsync */
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync/** @page pg_guest_lib VirtualBox Guest Library
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * This is a library for abstracting the additions driver interface. There are
236b2935f217749893b7034e59da3e3568928acevboxsync * multiple versions of the library depending on the context. The main
236b2935f217749893b7034e59da3e3568928acevboxsync * distinction is between kernel and user mode where the interfaces are very
236b2935f217749893b7034e59da3e3568928acevboxsync * different.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @section sec_guest_lib_ring0 Ring-0
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * In ring-0 there are two version:
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBOX_LIB_VBGL_R0_BASE / VBoxGuestR0LibBase for the VBoxGuest main driver,
157093a77f2752732368338110cb50fa6cd7717fvboxsync * who is responsible for managing the VMMDev virtual hardware.
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBOX_LIB_VBGL_R0 / VBoxGuestR0Lib for other (client) guest drivers.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * The library source code and the header have a define VBGL_VBOXGUEST, which is
236b2935f217749893b7034e59da3e3568928acevboxsync * defined for VBoxGuest and undefined for other drivers. Drivers must choose
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * right library in their makefiles and set VBGL_VBOXGUEST accordingly.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * The libraries consists of:
236b2935f217749893b7034e59da3e3568928acevboxsync * - common code to be used by both VBoxGuest and other drivers;
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBoxGuest specific code;
236b2935f217749893b7034e59da3e3568928acevboxsync * - code for other drivers which communicate with VBoxGuest via an IOCTL.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @section sec_guest_lib_ring3 Ring-3
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * There are more variants of the library here:
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBOX_LIB_VBGL_R3 / VBoxGuestR3Lib for programs.
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBOX_LIB_VBGL_R3_XFREE86 / VBoxGuestR3LibXFree86 for old style XFree
236b2935f217749893b7034e59da3e3568928acevboxsync * drivers which uses special loader and or symbol resolving strategy.
236b2935f217749893b7034e59da3e3568928acevboxsync * - VBOX_LIB_VBGL_R3_SHARED / VBoxGuestR3LibShared for shared objects / DLLs /
236b2935f217749893b7034e59da3e3568928acevboxsync * Dylibs.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsyncRT_C_DECLS_BEGIN
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/** @defgroup grp_guest_lib_r0 Ring-0 interface.
236b2935f217749893b7034e59da3e3568928acevboxsync * @{
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync#if defined(IN_RING0) && !defined(IN_RING0_AGNOSTIC)
236b2935f217749893b7034e59da3e3568928acevboxsync/** @def DECLR0VBGL
236b2935f217749893b7034e59da3e3568928acevboxsync * Declare a VBGL ring-0 API with the right calling convention and visibilitiy.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param type Return type. */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# define DECLR0VBGL(type) type VBOXCALL
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# define DECLVBGL(type) DECLR0VBGL(type)
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsynctypedef uint32_t VBGLIOPORT; /**< @todo r=bird: We have RTIOPORT (uint16_t) for this. */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync# ifdef VBGL_VBOXGUEST
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * The library initialization function to be used by the main
236b2935f217749893b7034e59da3e3568928acevboxsync * VBoxGuest system driver.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(int) VbglInit (VBGLIOPORT portVMMDev, struct VMMDevMemory *pVMMDevMemory);
4ab1e1de561327173718600b82c542cbe1cc878cvboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync# else
236b2935f217749893b7034e59da3e3568928acevboxsync
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync/**
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * The library initialization function to be used by all drivers
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * other than the main VBoxGuest system driver.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync *
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @return VBox status code.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync */
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsyncDECLVBGL(int) VbglInit (void);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync# endif
236b2935f217749893b7034e59da3e3568928acevboxsync
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync/**
4ab1e1de561327173718600b82c542cbe1cc878cvboxsync * The library termination function.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(void) VbglTerminate (void);
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/** @name Generic request functions.
236b2935f217749893b7034e59da3e3568928acevboxsync * @{
236b2935f217749893b7034e59da3e3568928acevboxsync */
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync/**
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * Allocate memory for generic request and initialize the request header.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync *
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param ppReq pointer to resulting memory address.
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param cbSize size of memory block required for the request.
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param reqType the generic request type.
236b2935f217749893b7034e59da3e3568928acevboxsync *
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(int) VbglGRAlloc (VMMDevRequestHeader **ppReq, uint32_t cbSize, VMMDevRequestType reqType);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Perform the generic request.
236b2935f217749893b7034e59da3e3568928acevboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param pReq pointer the request structure.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(int) VbglGRPerform (VMMDevRequestHeader *pReq);
236b2935f217749893b7034e59da3e3568928acevboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/**
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Free the generic request memory.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param pReq pointer the request structure.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @return VBox status code.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncDECLVBGL(void) VbglGRFree (VMMDevRequestHeader *pReq);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync# ifdef VBOX_WITH_HGCM
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync# ifdef VBGL_VBOXGUEST
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/**
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Callback function called from HGCM helpers when a wait for request
157093a77f2752732368338110cb50fa6cd7717fvboxsync * completion IRQ is required.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @returns VINF_SUCCESS, VERR_INTERRUPT or VERR_TIMEOUT.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param pvData VBoxGuest pointer to be passed to callback.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param u32Data VBoxGuest 32 bit value to be passed to callback.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef DECLVBGL(int) FNVBGLHGCMCALLBACK(VMMDevHGCMRequestHeader *pHeader, void *pvData, uint32_t u32Data);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** Pointer to a FNVBGLHGCMCALLBACK. */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef FNVBGLHGCMCALLBACK *PFNVBGLHGCMCALLBACK;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/**
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Perform a connect request. That is locate required service and
157093a77f2752732368338110cb50fa6cd7717fvboxsync * obtain a client identifier for future access.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @note This function can NOT handle cancelled requests!
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pConnectInfo The request data.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pfnAsyncCallback Required pointer to function that is calledwhen
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * implements waiting for an IRQ in this function.
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
236b2935f217749893b7034e59da3e3568928acevboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Perform a disconnect request. That is tell the host that
236b2935f217749893b7034e59da3e3568928acevboxsync * the client will not call the service anymore.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @note This function can NOT handle cancelled requests!
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pDisconnectInfo The request data.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pfnAsyncCallback Required pointer to function that is called when
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * implements waiting for an IRQ in this function.
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to
3357df142080b5abd7a5da3358371ce0bff34e91vboxsync * callback.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
236b2935f217749893b7034e59da3e3568928acevboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/** Call a HGCM service.
236b2935f217749893b7034e59da3e3568928acevboxsync *
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @note This function can deal with cancelled requests.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pCallInfo The request data.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pfnAsyncCallback Required pointer to function that is called when
236b2935f217749893b7034e59da3e3568928acevboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
236b2935f217749893b7034e59da3e3568928acevboxsync * implements waiting for an IRQ in this function.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
236b2935f217749893b7034e59da3e3568928acevboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @note This function can deal with cancelled requests.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pCallInfo The request data.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param fFlags Flags, see VBGLR0_HGCMCALL_F_XXX.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pfnAsyncCallback Required pointer to function that is called when
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * host returns VINF_HGCM_ASYNC_EXECUTE. VBoxGuest
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * implements waiting for an IRQ in this function.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pvAsyncData An arbitrary VBoxGuest pointer to be passed to callback.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param u32AsyncData An arbitrary VBoxGuest 32 bit value to be passed to callback.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @return VBox status code.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncDECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @name VbglR0HGCMInternalCall flags
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @{ */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** User mode request.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Indicates that only user mode addresses are permitted as parameters. */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync#define VBGLR0_HGCMCALL_F_USER UINT32_C(0)
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** Kernel mode request.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Indicates that kernel mode addresses are permitted as parameters. Whether or
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * not user mode addresses are permitted is, unfortunately, OS specific. The
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * following OSes allows user mode addresses: Windows, TODO.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync#define VBGLR0_HGCMCALL_F_KERNEL UINT32_C(1)
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** Mode mask. */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync#define VBGLR0_HGCMCALL_F_MODE_MASK UINT32_C(1)
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @} */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# else /* !VBGL_VBOXGUEST */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncstruct VBGLHGCMHANDLEDATA;
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsynctypedef struct VBGLHGCMHANDLEDATA *VBGLHGCMHANDLE;
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @name HGCM functions
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @{
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Connect to a service.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pHandle Pointer to variable that will hold a handle to be used
236b2935f217749893b7034e59da3e3568928acevboxsync * further in VbglHGCMCall and VbglHGCMClose.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param pData Connection information structure.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox status code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Connect to a service.
236b2935f217749893b7034e59da3e3568928acevboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param handle Handle of the connection.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pData Disconnect request information structure.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @return VBox status code.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncDECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/**
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Call to a service.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param handle Handle of the connection.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pData Call request information structure, including function parameters.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param cbData Length in bytes of data.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @return VBox status code.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncDECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/**
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Call to a service with timeout.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param handle Handle of the connection.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param pData Call request information structure, including function parameters.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param cbData Length in bytes of data.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param cMillies Timeout in milliseconds. Use RT_INDEFINITE_WAIT to wait forever.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @return VBox status code.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncDECLVBGL(int) VbglHGCMCallTimed (VBGLHGCMHANDLE handle,
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @} */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# endif /* !VBGL_VBOXGUEST */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# endif /* VBOX_WITH_HGCM */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/**
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Initialize the heap.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @return VBox error code.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(int) VbglPhysHeapInit (void);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Shutdown the heap.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsyncDECLVBGL(void) VbglPhysHeapTerminate (void);
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/**
236b2935f217749893b7034e59da3e3568928acevboxsync * Allocate a memory block.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * @param cbSize Size of block to be allocated.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @return Virtual address of allocated memory block.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncDECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/**
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * Get physical address of memory block pointed by
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * the virtual address.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync *
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @note WARNING!
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * The function does not acquire the Heap mutex!
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * When calling the function make sure that
236b2935f217749893b7034e59da3e3568928acevboxsync * the pointer is a valid one and is not being
236b2935f217749893b7034e59da3e3568928acevboxsync * deallocated.
236b2935f217749893b7034e59da3e3568928acevboxsync * This function can NOT be used for verifying
157093a77f2752732368338110cb50fa6cd7717fvboxsync * if the given pointer is a valid one allocated
157093a77f2752732368338110cb50fa6cd7717fvboxsync * from the heap.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param p Virtual address of memory block.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @return Physical memory block.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncDECLVBGL(RTCCPHYS) VbglPhysHeapGetPhysAddr (void *p);
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/**
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Free a memory block.
157093a77f2752732368338110cb50fa6cd7717fvboxsync *
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param p Virtual address of memory block.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncDECLVBGL(void) VbglPhysHeapFree (void *p);
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsyncDECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncDECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#endif /* IN_RING0 && !IN_RING0_AGNOSTIC */
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @defgroup grp_guest_lib_r3 Ring-3 interface.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync#ifdef IN_RING3
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @def VBGLR3DECL
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Ring 3 VBGL declaration.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param type The return type of the function declaration.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync# define VBGLR3DECL(type) type VBOXCALL
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name General-purpose functions
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3Init(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3InitUser(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(void) VbglR3Term(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsync# ifdef ___iprt_time_h
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
157093a77f2752732368338110cb50fa6cd7717fvboxsync# endif
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3InterruptEventWaits(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cb);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3Daemonize(bool fNoChDir, bool fNoClose);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3PidFile(const char *pszPath, PRTFILE phFile);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(void) VbglR3ClosePidFile(const char *pszPath, RTFILE hFile);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GetAdditionsVersion(char **ppszVer, char **ppszRev);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Shared clipboard
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Seamless mode
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SeamlessSetCap(bool fState);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Mouse
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Video
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3VideoAccelFlush(void);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Display
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay, bool fAck);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3SaveVideoMode(const char *pszName, uint32_t cx, uint32_t cy, uint32_t cBits);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3RetrieveVideoMode(const char *pszName, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @} */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync# ifdef VBOX_WITH_GUEST_PROPS
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/** @name Guest properties
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @{ */
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @todo Docs. */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef struct VBGLR3GUESTPROPENUM VBGLR3GUESTPROPENUM;
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @todo Docs. */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropConnect(uint32_t *pu32ClientId);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropDisconnect(uint32_t u32ClientId);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropWrite(uint32_t u32ClientId, const char *pszName, const char *pszValue, const char *pszFlags);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValue(uint32_t u32ClientId, const char *pszName, const char *pszValue);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValueV(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, va_list va);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropWriteValueF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3GuestPropRead(uint32_t u32ClientId, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue, uint32_t *pcchValueActual);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3GuestPropReadValueAlloc(uint32_t u32ClientId, const char *pszName, char **ppszValue);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(void) VbglR3GuestPropReadValueFree(char *pszValue);
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnumRaw(uint32_t u32ClientId, const char *paszPatterns, char *pcBuf, uint32_t cbBuf, uint32_t *pcbBufActual);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId, char const * const *ppaszPatterns, uint32_t cPatterns, PVBGLR3GUESTPROPENUM *ppHandle,
157093a77f2752732368338110cb50fa6cd7717fvboxsync char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp, char const **ppszFlags);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp,
157093a77f2752732368338110cb50fa6cd7717fvboxsync char const **ppszFlags);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(void) VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t u32ClientId, char const * const *papszPatterns, uint32_t cPatterns);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3GuestPropWait(uint32_t u32ClientId, const char *pszPatterns, void *pvBuf, uint32_t cbBuf, uint64_t u64Timestamp, uint32_t cMillies, char ** ppszName, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @name Host version handling
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @{ */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsyncVBGLR3DECL(int) VbglR3HostVersionCompare(const char *pszVer1, const char *pszVer2);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3HostVersionCheckForUpdate(uint32_t u32ClientId, bool *bUpdate, char **ppszHostVersion, char **ppszGuestVersion);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3HostVersionLastCheckedLoad(uint32_t u32ClientId, char **ppszVer);
157093a77f2752732368338110cb50fa6cd7717fvboxsyncVBGLR3DECL(int) VbglR3HostVersionLastCheckedStore(uint32_t u32ClientId, const char *pszVer);
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync# endif /* VBOX_WITH_GUEST_PROPS defined */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#endif /* IN_RING3 */
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsyncRT_C_DECLS_END
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/** @} */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#endif
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync