2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/* $Id$ */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** @file
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Virtual USB - Sniffer facility.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/*
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Copyright (C) 2014 Oracle Corporation
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * available from http://www.virtualbox.org. This file is free software;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * General Public License (GPL) as published by the Free Software
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#ifndef ___VUSBSniffer_h
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#define ___VUSBSniffer_h
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#include <VBox/cdefs.h>
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#include <VBox/types.h>
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#include <VBox/vusb.h>
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncRT_C_DECLS_BEGIN
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** Opauqe VUSB sniffer handle. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsynctypedef struct VUSBSNIFFERINT *VUSBSNIFFER;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** Pointer to a VUSB sniffer handle. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsynctypedef VUSBSNIFFER *PVUSBSNIFFER;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/** NIL sniffer instance handle. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#define VUSBSNIFFER_NIL ((VUSBSNIFFER)0)
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/**
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * VUSB Sniffer event types.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsynctypedef enum VUSBSNIFFEREVENT
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync{
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** Invalid event. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_INVALID = 0,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** URB submit event. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_SUBMIT,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** URB complete event. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_COMPLETE,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** URB submit failed event. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_ERROR_SUBMIT,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** URB completed with error event. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_ERROR_COMPLETE,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync /** 32bit hack. */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync VUSBSNIFFEREVENT_32BIT_HACK = 0x7fffffff
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync} VUSBSNIFFEREVENT;
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/**
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Create a new VUSB sniffer instance dumping to the given capture file.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @returns VBox status code.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param phSniffer Where to store the handle to the sniffer instance on success.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param fFlags Flags, reserved, must be 0.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param pszCaptureFilename The filename to use for capturing the sniffed data.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param pszDesc Optional description for the dump.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncDECLHIDDEN(int) VUSBSnifferCreate(PVUSBSNIFFER phSniffer, uint32_t fFlags,
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync const char *pszCaptureFilename, const char *pszDesc);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/**
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Destroys the given VUSB sniffer instance.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @returns nothing.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param hSniffer The sniffer instance to destroy.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncDECLHIDDEN(void) VUSBSnifferDestroy(VUSBSNIFFER hSniffer);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync/**
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * Records an VUSB event.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync *
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @returns VBox status code.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param hSniffer The sniffer instance.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param pUrb The URB triggering the event.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync * @param enmEvent The type of event to record.
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync */
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncDECLHIDDEN(int) VUSBSnifferRecordEvent(VUSBSNIFFER hSniffer, PVUSBURB pUrb, VUSBSNIFFEREVENT enmEvent);
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsyncRT_C_DECLS_END
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync#endif
2b73ea648457a8fb1ec027d1eeea63f879dad507vboxsync