libusb_filter.h

一个在Windows环境下允许用户程序访问USB设备的接口库的源代码.

/* LIBUSB-WIN32, Generic Windows USB Driver
 * Copyright (C) 2002-2003 Stephan Meyer, <[e-mail]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#ifndef __LIBUSB_FILTER_H__
#define __LIBUSB_FILTER_H__


#include <wdm.h>
#include <usbdi.h>
#include <usbdlib.h>

#include "filter_api.h"

#define USB_RECIP_DEVICE		0x00
#define USB_RECIP_INTERFACE		0x01
#define USB_RECIP_ENDPOINT		0x02
#define USB_RECIP_OTHER			0x03


#define LIBUSB_NT_DEVICE_NAME L"\\Device\\libusb0"
#define LIBUSB_SYMBOLIC_LINK_NAME L"\\DosDevices\\libusb0-"

#define LIBUSB_MAX_NUMBER_OF_ENDPOINTS  32
#define LIBUSB_MAX_NUMBER_OF_INTERFACES 32

#define LIBUSB_DEFAULT_TIMEOUT  5000   


typedef struct
{
  long usage_count;
  int remove_pending;
  KEVENT event;
} libusb_remove_lock;

typedef struct
{
  UCHAR endpoint_address;
  USBD_PIPE_HANDLE pipe_handle;
} libusb_pipe_info;

typedef struct
{
  DEVICE_OBJECT	*self;
  DEVICE_OBJECT	*physical_device_object;
  DEVICE_OBJECT	*next_stack_device;
  DEVICE_OBJECT *control_device_object;
  DEVICE_OBJECT *main_device_object;
  DRIVER_OBJECT *driver_object;
  LONG is_control_object;
  LONG ref_count;
  libusb_remove_lock remove_lock; 
  USBD_CONFIGURATION_HANDLE configuration_handle;
  int current_configuration;
  int device_id;
  libusb_pipe_info pipe_info[LIBUSB_MAX_NUMBER_OF_INTERFACES]
  [LIBUSB_MAX_NUMBER_OF_ENDPOINTS];
} libusb_device_extension;


void __stdcall unload(DRIVER_OBJECT *driver_object);
NTSTATUS __stdcall add_device(DRIVER_OBJECT *driver_object, 
			      DEVICE_OBJECT *physical_device_object);
NTSTATUS dispatch(DEVICE_OBJECT *device_object, IRP *irp);
NTSTATUS dispatch_control(DEVICE_OBJECT *device_object, IRP *irp);
NTSTATUS dispatch_pnp(libusb_device_extension *device_extension, IRP *irp);
NTSTATUS dispatch_ioctl(libusb_device_extension *device_extension, IRP *irp);
NTSTATUS complete_irp(IRP *irp, NTSTATUS status, ULONG info);

NTSTATUS call_usbd(libusb_device_extension *device_extension, void *urb,
		   ULONG control_code, int timeout);

int get_pipe_handle(libusb_device_extension *device_extension, 
		    int endpoint_address, USBD_PIPE_HANDLE *pipe_handle);
void clear_pipe_info(libusb_device_extension *device_extension);
int update_pipe_info(libusb_device_extension *device_extension, 
		     int interface,
		     USBD_INTERFACE_INFORMATION *interface_info);

NTSTATUS control_object_create(libusb_device_extension *device_extension);
void control_object_delete(libusb_device_extension *device_extension);

void remove_lock_initialize(libusb_remove_lock *remove_lock);
NTSTATUS remove_lock_acquire(libusb_remove_lock *remove_lock);
void remove_lock_release(libusb_remove_lock *remove_lock);
void remove_lock_release_and_wait(libusb_remove_lock *remove_lock);

int get_device_id(libusb_device_extension *device_extension);
void release_device_id(libusb_device_extension *device_extension);


NTSTATUS set_configuration(libusb_device_extension *device_extension,
			   int configuration, int timeout);
NTSTATUS get_configuration(libusb_device_extension *device_extension,
			   int *configuration, int timeout);
NTSTATUS set_interface(libusb_device_extension *device_extension,
		       int interface, int altsetting, int timeout);
NTSTATUS get_interface(libusb_device_extension *device_extension,
		       int interface, int *altsetting, int timeout);
NTSTATUS set_feature(libusb_device_extension *device_extension,
		     int recipient, int index, int feature, int timeout);
NTSTATUS clear_feature(libusb_device_extension *device_extension,
		       int recipient, int index, int feature, int timeout);
NTSTATUS get_status(libusb_device_extension *device_extension, int recipient,
		    int index, int *status, int timeout);
NTSTATUS set_descriptor(libusb_device_extension *device_extension,
			void *buffer, MDL *mdl_buffer, int size, 
			int type, int index, int language_id, 
			int *sent, int timeout);
NTSTATUS get_descriptor(libusb_device_extension *device_extension,
			void *buffer, int size, int type, 
			int index, int language_id, int *sent, int timeout);
NTSTATUS bulk_transfer(IRP *irp, libusb_device_extension *device_extension,
		       int endpoint, MDL *buffer,
		       int size, int direction);
NTSTATUS vendor_request(libusb_device_extension *device_extension,
			int request, int value, int index,
			MDL *buffer, int size, int direction,
			int *sent, int timeout);
NTSTATUS abort_endpoint(libusb_device_extension *device_extension,
			int endpoint, int timeout);
NTSTATUS reset_endpoint(libusb_device_extension *device_extension,
			int endpoint, int timeout);
NTSTATUS reset_device(libusb_device_extension *device_extension, int timeout);

NTSTATUS on_internal_ioctl_complete(DEVICE_OBJECT *device_object, IRP *irp,
				    void *context);
NTSTATUS on_device_usage_notification_complete(DEVICE_OBJECT *device_object,
					       IRP *irp,
					       void *context);
NTSTATUS on_start_complete(DEVICE_OBJECT *device_object, IRP *irp, 
			   void *context);

void debug_print_nl(void);
void debug_set_level(int level);
void debug_printf(int level, char *format, ...);


#endif