| 1 | /* $Id: USBGetDevices.h 36993 2011-05-06 21:53:21Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VirtualBox Linux host USB device enumeration.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2010 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 | * @note this duplicates a USBProxyService method which we needed access too
|
|---|
| 28 | * without pulling in the rest of the proxy service code.
|
|---|
| 29 | *
|
|---|
| 30 | * @param pDevice Pointer to the device.
|
|---|
| 31 | */
|
|---|
| 32 | static inline void deviceFreeMembers(PUSBDEVICE pDevice)
|
|---|
| 33 | {
|
|---|
| 34 | RTStrFree((char *)pDevice->pszManufacturer);
|
|---|
| 35 | pDevice->pszManufacturer = NULL;
|
|---|
| 36 | RTStrFree((char *)pDevice->pszProduct);
|
|---|
| 37 | pDevice->pszProduct = NULL;
|
|---|
| 38 | RTStrFree((char *)pDevice->pszSerialNumber);
|
|---|
| 39 | pDevice->pszSerialNumber = NULL;
|
|---|
| 40 |
|
|---|
| 41 | RTStrFree((char *)pDevice->pszAddress);
|
|---|
| 42 | pDevice->pszAddress = NULL;
|
|---|
| 43 | }
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * Free one USB device created by the Linux enumeration code.
|
|---|
| 47 | * @note this duplicates a USBProxyService method which we needed access too
|
|---|
| 48 | * without pulling in the rest of the proxy service code.
|
|---|
| 49 | *
|
|---|
| 50 | * @param pDevice Pointer to the device.
|
|---|
| 51 | */
|
|---|
| 52 | static inline void deviceFree(PUSBDEVICE pDevice)
|
|---|
| 53 | {
|
|---|
| 54 | deviceFreeMembers(pDevice);
|
|---|
| 55 | RTMemFree(pDevice);
|
|---|
| 56 | }
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Free a linked list of USB devices created by the Linux enumeration code.
|
|---|
| 60 | * @param pHead Pointer to the first device in the linked list
|
|---|
| 61 | */
|
|---|
| 62 | static inline void deviceListFree(PUSBDEVICE *ppHead)
|
|---|
| 63 | {
|
|---|
| 64 | PUSBDEVICE pHead, pNext;
|
|---|
| 65 | pHead = *ppHead;
|
|---|
| 66 | while (pHead)
|
|---|
| 67 | {
|
|---|
| 68 | pNext = pHead->pNext;
|
|---|
| 69 | deviceFree(pHead);
|
|---|
| 70 | pHead = pNext;
|
|---|
| 71 | }
|
|---|
| 72 | *ppHead = NULL;
|
|---|
| 73 | }
|
|---|
| 74 |
|
|---|
| 75 | RT_C_DECLS_BEGIN
|
|---|
| 76 |
|
|---|
| 77 | /**
|
|---|
| 78 | * Check whether a USB device tree root is usable
|
|---|
| 79 | * @param pcszRoot the path to the root of the device tree
|
|---|
| 80 | * @param fIsDeviceNodes whether this is a device node (or usbfs) tree
|
|---|
| 81 | * @note returns a pointer into a static array so it will stay valid
|
|---|
| 82 | */
|
|---|
| 83 | extern bool USBProxyLinuxCheckDeviceRoot(const char *pcszRoot,
|
|---|
| 84 | bool fIsDeviceNodes);
|
|---|
| 85 |
|
|---|
| 86 | #ifdef UNIT_TEST
|
|---|
| 87 | /**
|
|---|
| 88 | * Specify the list of devices that will appear to be available through
|
|---|
| 89 | * usbfs during unit testing (of USBProxyLinuxGetDevices)
|
|---|
| 90 | * @param pacszDeviceAddresses NULL terminated array of usbfs device addresses
|
|---|
| 91 | */
|
|---|
| 92 | extern void TestUSBSetAvailableUsbfsDevices(const char **pacszDeviceAddresses);
|
|---|
| 93 | /**
|
|---|
| 94 | * Specify the list of files that access will report as accessible (at present
|
|---|
| 95 | * we only do accessible or not accessible) during unit testing (of
|
|---|
| 96 | * USBProxyLinuxGetDevices)
|
|---|
| 97 | * @param pacszAccessibleFiles NULL terminated array of file paths to be
|
|---|
| 98 | * reported accessible
|
|---|
| 99 | */
|
|---|
| 100 | extern void TestUSBSetAccessibleFiles(const char **pacszAccessibleFiles);
|
|---|
| 101 | #endif
|
|---|
| 102 |
|
|---|
| 103 | /**
|
|---|
| 104 | * Get the list of USB devices supported by the system. Should be freed using
|
|---|
| 105 | * @a deviceFree or something equivalent.
|
|---|
| 106 | * @param pcszDevicesRoot the path to the root of the device tree
|
|---|
| 107 | * @param fUseSysfs whether to use sysfs (or usbfs) for enumeration
|
|---|
| 108 | */
|
|---|
| 109 | extern PUSBDEVICE USBProxyLinuxGetDevices(const char *pcszDevicesRoot,
|
|---|
| 110 | bool fUseSysfs);
|
|---|
| 111 |
|
|---|
| 112 | RT_C_DECLS_END
|
|---|
| 113 |
|
|---|
| 114 | #endif /* ___USBGetDevices_h */
|
|---|
