VBoxUsbIdc.h revision 97b634ea021fd984782256de4ba4ff31cdb96c47
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync/* $Id$ */
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync/** @file
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * Windows USB Proxy - Monitor Driver communication interface.
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync */
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync/*
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * Copyright (C) 2011 Oracle Corporation
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync *
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * available from http://www.virtualbox.org. This file is free software;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * you can redistribute it and/or modify it under the terms of the GNU
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * General Public License (GPL) as published by the Free Software
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync */
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#ifndef ___VBoxUsbIdc_h___
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define ___VBoxUsbIdc_h___
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_VERSION_MAJOR 1
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_VERSION_MINOR 0
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_INTERNAL_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x618, METHOD_NEITHER, FILE_WRITE_ACCESS)
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_INTERNAL_IOCTL_PROXY_STARTUP CTL_CODE(FILE_DEVICE_UNKNOWN, 0x619, METHOD_NEITHER, FILE_WRITE_ACCESS)
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_INTERNAL_IOCTL_PROXY_TEARDOWN CTL_CODE(FILE_DEVICE_UNKNOWN, 0x61A, METHOD_NEITHER, FILE_WRITE_ACCESS)
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync#define VBOXUSBIDC_INTERNAL_IOCTL_PROXY_STATE_CHANGE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x61B, METHOD_NEITHER, FILE_WRITE_ACCESS)
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsynctypedef struct
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync{
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync uint32_t u32Major;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync uint32_t u32Minor;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync} VBOXUSBIDC_VERSION, *PVBOXUSBIDC_VERSION;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsynctypedef void *HVBOXUSBIDCDEV;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync/* the initial device state is USBDEVICESTATE_HELD_BY_PROXY */
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsynctypedef struct VBOXUSBIDC_PROXY_STARTUP
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync{
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync union
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync {
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync /* in: device PDO */
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync PDEVICE_OBJECT pPDO;
907ba2c9b3d1821f95be17115ecad9fe8a2cae02vboxsync /* out: device handle to be used for subsequent USBSUP_PROXY_XXX calls */
HVBOXUSBIDCDEV hDev;
} u;
} VBOXUSBIDC_PROXY_STARTUP, *PVBOXUSBIDC_PROXY_STARTUP;
typedef struct VBOXUSBIDC_PROXY_TEARDOWN
{
HVBOXUSBIDCDEV hDev;
} VBOXUSBIDC_PROXY_TEARDOWN, *PVBOXUSBIDC_PROXY_TEARDOWN;
typedef enum
{
VBOXUSBIDC_PROXY_STATE_UNKNOWN = 0,
VBOXUSBIDC_PROXY_STATE_IDLE,
VBOXUSBIDC_PROXY_STATE_INITIAL = VBOXUSBIDC_PROXY_STATE_IDLE,
VBOXUSBIDC_PROXY_STATE_USED_BY_GUEST
} VBOXUSBIDC_PROXY_STATE;
typedef struct VBOXUSBIDC_PROXY_STATE_CHANGE
{
HVBOXUSBIDCDEV hDev;
VBOXUSBIDC_PROXY_STATE enmState;
} VBOXUSBIDC_PROXY_STATE_CHANGE, *PVBOXUSBIDC_PROXY_STATE_CHANGE;
NTSTATUS VBoxUsbIdcInit();
VOID VBoxUsbIdcTerm();
NTSTATUS VBoxUsbIdcProxyStarted(PDEVICE_OBJECT pPDO, HVBOXUSBIDCDEV *phDev);
NTSTATUS VBoxUsbIdcProxyStopped(HVBOXUSBIDCDEV hDev);
#endif /* #ifndef ___VBoxUsbIdc_h___ */