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