1 | /* $Id: VUSBSniffer.h 76553 2019-01-01 01:45:53Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * Virtual USB - Sniffer facility.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2014-2019 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | */
|
---|
17 |
|
---|
18 | #ifndef ___VUSBSniffer_h
|
---|
19 | #define ___VUSBSniffer_h
|
---|
20 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
---|
21 | # pragma once
|
---|
22 | #endif
|
---|
23 |
|
---|
24 | #include <VBox/cdefs.h>
|
---|
25 | #include <VBox/types.h>
|
---|
26 | #include <VBox/vusb.h>
|
---|
27 |
|
---|
28 | RT_C_DECLS_BEGIN
|
---|
29 |
|
---|
30 | /** Opaque VUSB sniffer handle. */
|
---|
31 | typedef struct VUSBSNIFFERINT *VUSBSNIFFER;
|
---|
32 | /** Pointer to a VUSB sniffer handle. */
|
---|
33 | typedef VUSBSNIFFER *PVUSBSNIFFER;
|
---|
34 |
|
---|
35 | /** NIL sniffer instance handle. */
|
---|
36 | #define VUSBSNIFFER_NIL ((VUSBSNIFFER)0)
|
---|
37 |
|
---|
38 | /**
|
---|
39 | * VUSB Sniffer event types.
|
---|
40 | */
|
---|
41 | typedef enum VUSBSNIFFEREVENT
|
---|
42 | {
|
---|
43 | /** Invalid event. */
|
---|
44 | VUSBSNIFFEREVENT_INVALID = 0,
|
---|
45 | /** URB submit event. */
|
---|
46 | VUSBSNIFFEREVENT_SUBMIT,
|
---|
47 | /** URB complete event. */
|
---|
48 | VUSBSNIFFEREVENT_COMPLETE,
|
---|
49 | /** URB submit failed event. */
|
---|
50 | VUSBSNIFFEREVENT_ERROR_SUBMIT,
|
---|
51 | /** URB completed with error event. */
|
---|
52 | VUSBSNIFFEREVENT_ERROR_COMPLETE,
|
---|
53 | /** 32bit hack. */
|
---|
54 | VUSBSNIFFEREVENT_32BIT_HACK = 0x7fffffff
|
---|
55 | } VUSBSNIFFEREVENT;
|
---|
56 |
|
---|
57 | /** VUSB Sniffer creation flags.
|
---|
58 | * @{ */
|
---|
59 | /** Default flags. */
|
---|
60 | #define VUSBSNIFFER_F_DEFAULT 0
|
---|
61 | /** Don't overwrite any existing capture file. */
|
---|
62 | #define VUSBSNIFFER_F_NO_REPLACE RT_BIT_32(0)
|
---|
63 | /** @} */
|
---|
64 |
|
---|
65 | /**
|
---|
66 | * Create a new VUSB sniffer instance dumping to the given capture file.
|
---|
67 | *
|
---|
68 | * @returns VBox status code.
|
---|
69 | * @param phSniffer Where to store the handle to the sniffer instance on success.
|
---|
70 | * @param fFlags Flags, combination of VUSBSNIFFER_F_*
|
---|
71 | * @param pszCaptureFilename The filename to use for capturing the sniffed data.
|
---|
72 | * @param pszFmt The format of the dump, NULL to select one based on the filename
|
---|
73 | * extension.
|
---|
74 | * @param pszDesc Optional description for the dump.
|
---|
75 | */
|
---|
76 | DECLHIDDEN(int) VUSBSnifferCreate(PVUSBSNIFFER phSniffer, uint32_t fFlags,
|
---|
77 | const char *pszCaptureFilename, const char *pszFmt,
|
---|
78 | const char *pszDesc);
|
---|
79 |
|
---|
80 | /**
|
---|
81 | * Destroys the given VUSB sniffer instance.
|
---|
82 | *
|
---|
83 | * @returns nothing.
|
---|
84 | * @param hSniffer The sniffer instance to destroy.
|
---|
85 | */
|
---|
86 | DECLHIDDEN(void) VUSBSnifferDestroy(VUSBSNIFFER hSniffer);
|
---|
87 |
|
---|
88 | /**
|
---|
89 | * Records an VUSB event.
|
---|
90 | *
|
---|
91 | * @returns VBox status code.
|
---|
92 | * @param hSniffer The sniffer instance.
|
---|
93 | * @param pUrb The URB triggering the event.
|
---|
94 | * @param enmEvent The type of event to record.
|
---|
95 | */
|
---|
96 | DECLHIDDEN(int) VUSBSnifferRecordEvent(VUSBSNIFFER hSniffer, PVUSBURB pUrb, VUSBSNIFFEREVENT enmEvent);
|
---|
97 |
|
---|
98 |
|
---|
99 | RT_C_DECLS_END
|
---|
100 | #endif
|
---|
101 |
|
---|