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