USBGetDevices.h revision dff7b61dd3fdc4026a02236298516db1d8ac6516
/* $Id$ */
/** @file
* VirtualBox Linux host USB device enumeration.
*/
/*
* Copyright (C) 2006-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef ___USBGetDevices_h
# define ___USBGetDevices_h
#include <VBox/usb.h>
#include <iprt/mem.h>
#include <iprt/string.h>
/**
* Free all the members of a USB device created by the Linux enumeration code.
* @note this duplicates a USBProxyService method which we needed access too
* without pulling in the rest of the proxy service code.
*
* @param pDevice Pointer to the device.
*/
static inline void deviceFreeMembers(PUSBDEVICE pDevice)
{
RTStrFree((char *)pDevice->pszManufacturer);
pDevice->pszManufacturer = NULL;
RTStrFree((char *)pDevice->pszProduct);
pDevice->pszProduct = NULL;
RTStrFree((char *)pDevice->pszSerialNumber);
pDevice->pszSerialNumber = NULL;
RTStrFree((char *)pDevice->pszAddress);
pDevice->pszAddress = NULL;
}
/**
* Free one USB device created by the Linux enumeration code.
* @note this duplicates a USBProxyService method which we needed access too
* without pulling in the rest of the proxy service code.
*
* @param pDevice Pointer to the device.
*/
static inline void deviceFree(PUSBDEVICE pDevice)
{
deviceFreeMembers(pDevice);
RTMemFree(pDevice);
}
/**
* Free a linked list of USB devices created by the Linux enumeration code.
* @param pHead Pointer to the first device in the linked list
*/
static inline void deviceListFree(PUSBDEVICE *ppHead)
{
PUSBDEVICE pHead, pNext;
pHead = *ppHead;
while (pHead)
{
pNext = pHead->pNext;
deviceFree(pHead);
pHead = pNext;
}
*ppHead = NULL;
}
RT_C_DECLS_BEGIN
/** List of well-known USB device tree locations */
typedef struct USBDEVTREELOCATION
{
/** The root of the device tree for this location. */
char szDevicesRoot[256];
/** Whether this location requires device enumeration using sysfs. */
bool fUseSysfs;
} USBDEVTREELOCATION, *PUSBDEVTREELOCATION;
typedef const USBDEVTREELOCATION *PCUSBDEVTREELOCATION;
/**
* Get the USB device tree root
* @param fPreferSysfs whether we wish to use sysfs over usbfs for
* enumeration if we have the choice
* @note returns a pointer into a static array so it will stay valid
*/
extern PCUSBDEVTREELOCATION USBProxyLinuxGetDeviceRoot(bool fPreferSysfs);
/**
* Get the list of USB devices supported by the system. Should be freed using
* @a deviceFree or something equivalent.
* @param pcszDevicesRoot the path to the root of the device tree
* @param fUseSysfs whether to use sysfs (or usbfs) for enumeration
*/
extern PUSBDEVICE USBProxyLinuxGetDevices(const char *pcszDevicesRoot,
bool fUseSysfs);
RT_C_DECLS_END
#endif /* ___USBGetDevices_h */