/** @file
* USBLib - Library for wrapping up the VBoxUSB functionality. (DEV,HDrv,Main)
*/
/*
* 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;
* 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE 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.
*/
#ifndef ___VBox_usblib_h
#define ___VBox_usblib_h
#include <VBox/usbfilter.h>
#ifdef RT_OS_WINDOWS
# include <VBox/usblib-win.h>
#endif
#ifdef RT_OS_SOLARIS
# include <VBox/usblib-solaris.h>
#endif
#ifdef RT_OS_DARWIN
# include <VBox/usblib-darwin.h>
#endif
/** @todo merge the usblib-win.h interface into the darwin and linux ports where suitable. */
/** @defgroup grp_USBLib USBLib - USB Support Library
* This module implements the basic low-level OS interfaces and common USB code.
* @{
*/
#ifdef IN_RING3
/**
* Initializes the USBLib component.
*
* The USBLib keeps a per process connection to the kernel driver
* and all USBLib users within a process will share the same
* connection. USBLib does reference counting to make sure that
* the connection remains open until all users has called USBLibTerm().
*
* @returns VBox status code.
*
* @remark The users within the process are responsible for not calling
* this function at the same time (because I'm lazy).
*/
USBLIB_DECL(int) USBLibInit(void);
/**
* Terminates the USBLib component.
*
* Must match successful USBLibInit calls.
*
* @returns VBox status code.
*/
USBLIB_DECL(int) USBLibTerm(void);
/**
* Adds a filter.
*
* This function will validate and transfer the specified filter
* to the kernel driver and make it start using it. The kernel
* driver will return a filter id that this function passes on
* to its caller.
*
* The kernel driver will associate the added filter with the
* calling process and automatically remove all filters when
* the process terminates the connection to it or dies.
*
* @returns Filter id for passing to USBLibRemoveFilter on success.
* @returns NULL on failure.
*
* @param pFilter The filter to add.
*/
/**
* Removes a filter.
*
* @param pvId The ID returned by USBLibAddFilter.
*/
/**
* Calculate the hash of the serial string.
*
* 64bit FNV1a, chosen because it is designed to hash in to a power of two
* space, and is much quicker and simpler than, say, a half MD4.
*
* @returns the hash.
* @param pszSerial The serial string.
*/
#endif /* IN_RING3 */
/** @} */
#endif