blob: cf5eed26634709338bcbbcaa60d0796c5d3330ee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/* $Id: UsbTestServicePlatform.h $ */
/** @file
* UsbTestServ - Remote USB test configuration and execution server, Platform specific helpers.
*/
/*
* Copyright (C) 2016-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_SRC_usb_UsbTestServicePlatform_h
#define VBOX_INCLUDED_SRC_usb_UsbTestServicePlatform_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/**
* Initializes the platform specific structures for UTS.
*
* @returns IPRT status code.
*/
DECLHIDDEN(int) utsPlatformInit(void);
/**
* Frees all platform specific structures for UTS.
*/
DECLHIDDEN(void) utsPlatformTerm(void);
/**
* Loads the specified kernel module on the platform.
*
* @returns IPRT status code.
* @param pszModule The module to load.
* @param papszArgv Array of arguments to pass to the module.
* @param cArgv Number of argument array entries.
*/
DECLHIDDEN(int) utsPlatformModuleLoad(const char *pszModule, const char **papszArgv,
unsigned cArgv);
/**
* Unloads the specified kernel module on the platform.
*
* @returns IPRT status code.
* @param pszModule The module to unload.
*/
DECLHIDDEN(int) utsPlatformModuleUnload(const char *pszModule);
#ifdef RT_OS_LINUX
/**
* Acquires a free UDC to attach a gadget to.
*
* @returns IPRT status code.
* @param fSuperSpeed Flag whether a super speed bus is required.
* @param ppszUdc Where to store the pointer to the name of the UDC on success.
* Free with RTStrFree().
* @param puBusId Where to store the bus ID the UDC is attached to on the host side.
*/
DECLHIDDEN(int) utsPlatformLnxAcquireUDC(bool fSuperSpeed, char **ppszUdc, uint32_t *puBusId);
/**
* Releases the given UDC for other use.
*
* @returns IPRT status code.
* @param pszUdc The UDC to release.
*/
DECLHIDDEN(int) utsPlatformLnxReleaseUDC(const char *pszUdc);
#endif
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_SRC_usb_UsbTestServicePlatform_h */
|