VirtualBox

source: vbox/trunk/src/VBox/Main/include/USBGetDevices.h@ 67954

Last change on this file since 67954 was 65088, checked in by vboxsync, 8 years ago

Main: doxygen fixes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.9 KB
Line 
1/* $Id: USBGetDevices.h 65088 2017-01-03 20:52:49Z vboxsync $ */
2/** @file
3 * VirtualBox Linux host USB device enumeration.
4 */
5
6/*
7 * Copyright (C) 2006-2016 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 ___USBGetDevices_h
19#define ___USBGetDevices_h
20
21#include <VBox/usb.h>
22#include <iprt/mem.h>
23#include <iprt/string.h>
24
25/**
26 * Free all the members of a USB device created by the Linux enumeration code.
27 *
28 * @note This duplicates a USBProxyService method which we needed access too
29 * without pulling in the rest of the proxy service code.
30 *
31 * @param pDevice Pointer to the device.
32 */
33DECLINLINE(void) deviceFreeMembers(PUSBDEVICE pDevice)
34{
35 RTStrFree((char *)pDevice->pszManufacturer);
36 pDevice->pszManufacturer = NULL;
37 RTStrFree((char *)pDevice->pszProduct);
38 pDevice->pszProduct = NULL;
39 RTStrFree((char *)pDevice->pszSerialNumber);
40 pDevice->pszSerialNumber = NULL;
41
42 RTStrFree((char *)pDevice->pszAddress);
43 pDevice->pszAddress = NULL;
44}
45
46/**
47 * Free one USB device created by the Linux enumeration code.
48 *
49 * @note This duplicates a USBProxyService method which we needed access too
50 * without pulling in the rest of the proxy service code.
51 *
52 * @param pDevice Pointer to the device. NULL is OK.
53 */
54DECLINLINE(void) deviceFree(PUSBDEVICE pDevice)
55{
56 if (pDevice)
57 {
58 deviceFreeMembers(pDevice);
59 RTMemFree(pDevice);
60 }
61}
62
63/**
64 * Free a linked list of USB devices created by the Linux enumeration code.
65 * @param ppHead Pointer to the first device in the linked list
66 */
67DECLINLINE(void) deviceListFree(PUSBDEVICE *ppHead)
68{
69 PUSBDEVICE pHead = *ppHead;
70 while (pHead)
71 {
72 PUSBDEVICE pNext = pHead->pNext;
73 deviceFree(pHead);
74 pHead = pNext;
75 }
76 *ppHead = NULL;
77}
78
79RT_C_DECLS_BEGIN
80
81extern bool USBProxyLinuxCheckDeviceRoot(const char *pcszRoot, bool fIsDeviceNodes);
82
83#ifdef UNIT_TEST
84void TestUSBSetupInit(const char *pcszUsbfsRoot, bool fUsbfsAccessible,
85 const char *pcszDevicesRoot, bool fDevicesAccessible,
86 int rcMethodInitResult);
87void TestUSBSetEnv(const char *pcszEnvUsb, const char *pcszEnvUsbRoot);
88#endif
89
90extern int USBProxyLinuxChooseMethod(bool *pfUsingUsbfsDevices, const char **ppcszDevicesRoot);
91#ifdef UNIT_TEST
92extern void TestUSBSetAvailableUsbfsDevices(const char **pacszDeviceAddresses);
93extern void TestUSBSetAccessibleFiles(const char **pacszAccessibleFiles);
94#endif
95
96extern PUSBDEVICE USBProxyLinuxGetDevices(const char *pcszDevicesRoot, bool fUseSysfs);
97
98RT_C_DECLS_END
99
100#endif /* !___USBGetDevices_h */
101
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette