Home | History | Annotate | Download | only in linux
      1 /*****************************************************************************/
      2 
      3 /*
      4  *	usbdevice_fs.h  --  USB device file system.
      5  *
      6  *	Copyright (C) 2000
      7  *          Thomas Sailer (sailer (at) ife.ee.ethz.ch)
      8  *
      9  *	This program is free software; you can redistribute it and/or modify
     10  *	it under the terms of the GNU General Public License as published by
     11  *	the Free Software Foundation; either version 2 of the License, or
     12  *	(at your option) any later version.
     13  *
     14  *	This program is distributed in the hope that it will be useful,
     15  *	but WITHOUT ANY WARRANTY; without even the implied warranty of
     16  *	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     17  *	GNU General Public License for more details.
     18  *
     19  *	You should have received a copy of the GNU General Public License
     20  *	along with this program; if not, write to the Free Software
     21  *	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
     22  *
     23  *  History:
     24  *   0.1  04.01.2000  Created
     25  */
     26 
     27 /*****************************************************************************/
     28 
     29 #ifndef _UAPI_LINUX_USBDEVICE_FS_H
     30 #define _UAPI_LINUX_USBDEVICE_FS_H
     31 
     32 #include <linux/types.h>
     33 #include <linux/magic.h>
     34 
     35 /* --------------------------------------------------------------------- */
     36 
     37 /* usbdevfs ioctl codes */
     38 
     39 struct usbdevfs_ctrltransfer {
     40 	__u8 bRequestType;
     41 	__u8 bRequest;
     42 	__u16 wValue;
     43 	__u16 wIndex;
     44 	__u16 wLength;
     45 	__u32 timeout;  /* in milliseconds */
     46  	void __user *data;
     47 };
     48 
     49 struct usbdevfs_bulktransfer {
     50 	unsigned int ep;
     51 	unsigned int len;
     52 	unsigned int timeout; /* in milliseconds */
     53 	void __user *data;
     54 };
     55 
     56 struct usbdevfs_setinterface {
     57 	unsigned int interface;
     58 	unsigned int altsetting;
     59 };
     60 
     61 struct usbdevfs_disconnectsignal {
     62 	unsigned int signr;
     63 	void __user *context;
     64 };
     65 
     66 #define USBDEVFS_MAXDRIVERNAME 255
     67 
     68 struct usbdevfs_getdriver {
     69 	unsigned int interface;
     70 	char driver[USBDEVFS_MAXDRIVERNAME + 1];
     71 };
     72 
     73 struct usbdevfs_connectinfo {
     74 	unsigned int devnum;
     75 	unsigned char slow;
     76 };
     77 
     78 #define USBDEVFS_URB_SHORT_NOT_OK	0x01
     79 #define USBDEVFS_URB_ISO_ASAP		0x02
     80 #define USBDEVFS_URB_BULK_CONTINUATION	0x04
     81 #define USBDEVFS_URB_NO_FSBR		0x20
     82 #define USBDEVFS_URB_ZERO_PACKET	0x40
     83 #define USBDEVFS_URB_NO_INTERRUPT	0x80
     84 
     85 #define USBDEVFS_URB_TYPE_ISO		   0
     86 #define USBDEVFS_URB_TYPE_INTERRUPT	   1
     87 #define USBDEVFS_URB_TYPE_CONTROL	   2
     88 #define USBDEVFS_URB_TYPE_BULK		   3
     89 
     90 struct usbdevfs_iso_packet_desc {
     91 	unsigned int length;
     92 	unsigned int actual_length;
     93 	unsigned int status;
     94 };
     95 
     96 struct usbdevfs_urb {
     97 	unsigned char type;
     98 	unsigned char endpoint;
     99 	int status;
    100 	unsigned int flags;
    101 	void __user *buffer;
    102 	int buffer_length;
    103 	int actual_length;
    104 	int start_frame;
    105 	union {
    106 		int number_of_packets;	/* Only used for isoc urbs */
    107 		unsigned int stream_id;	/* Only used with bulk streams */
    108 	};
    109 	int error_count;
    110 	unsigned int signr;	/* signal to be sent on completion,
    111 				  or 0 if none should be sent. */
    112 	void __user *usercontext;
    113 	struct usbdevfs_iso_packet_desc iso_frame_desc[0];
    114 };
    115 
    116 /* ioctls for talking directly to drivers */
    117 struct usbdevfs_ioctl {
    118 	int	ifno;		/* interface 0..N ; negative numbers reserved */
    119 	int	ioctl_code;	/* MUST encode size + direction of data so the
    120 				 * macros in <asm/ioctl.h> give correct values */
    121 	void __user *data;	/* param buffer (in, or out) */
    122 };
    123 
    124 /* You can do most things with hubs just through control messages,
    125  * except find out what device connects to what port. */
    126 struct usbdevfs_hub_portinfo {
    127 	char nports;		/* number of downstream ports in this hub */
    128 	char port [127];	/* e.g. port 3 connects to device 27 */
    129 };
    130 
    131 /* System and bus capability flags */
    132 #define USBDEVFS_CAP_ZERO_PACKET		0x01
    133 #define USBDEVFS_CAP_BULK_CONTINUATION		0x02
    134 #define USBDEVFS_CAP_NO_PACKET_SIZE_LIM		0x04
    135 #define USBDEVFS_CAP_BULK_SCATTER_GATHER	0x08
    136 #define USBDEVFS_CAP_REAP_AFTER_DISCONNECT	0x10
    137 #define USBDEVFS_CAP_MMAP			0x20
    138 #define USBDEVFS_CAP_DROP_PRIVILEGES		0x40
    139 
    140 /* USBDEVFS_DISCONNECT_CLAIM flags & struct */
    141 
    142 /* disconnect-and-claim if the driver matches the driver field */
    143 #define USBDEVFS_DISCONNECT_CLAIM_IF_DRIVER	0x01
    144 /* disconnect-and-claim except when the driver matches the driver field */
    145 #define USBDEVFS_DISCONNECT_CLAIM_EXCEPT_DRIVER	0x02
    146 
    147 struct usbdevfs_disconnect_claim {
    148 	unsigned int interface;
    149 	unsigned int flags;
    150 	char driver[USBDEVFS_MAXDRIVERNAME + 1];
    151 };
    152 
    153 struct usbdevfs_streams {
    154 	unsigned int num_streams; /* Not used by USBDEVFS_FREE_STREAMS */
    155 	unsigned int num_eps;
    156 	unsigned char eps[0];
    157 };
    158 
    159 #define USBDEVFS_CONTROL           _IOWR('U', 0, struct usbdevfs_ctrltransfer)
    160 #define USBDEVFS_CONTROL32           _IOWR('U', 0, struct usbdevfs_ctrltransfer32)
    161 #define USBDEVFS_BULK              _IOWR('U', 2, struct usbdevfs_bulktransfer)
    162 #define USBDEVFS_BULK32              _IOWR('U', 2, struct usbdevfs_bulktransfer32)
    163 #define USBDEVFS_RESETEP           _IOR('U', 3, unsigned int)
    164 #define USBDEVFS_SETINTERFACE      _IOR('U', 4, struct usbdevfs_setinterface)
    165 #define USBDEVFS_SETCONFIGURATION  _IOR('U', 5, unsigned int)
    166 #define USBDEVFS_GETDRIVER         _IOW('U', 8, struct usbdevfs_getdriver)
    167 #define USBDEVFS_SUBMITURB         _IOR('U', 10, struct usbdevfs_urb)
    168 #define USBDEVFS_SUBMITURB32       _IOR('U', 10, struct usbdevfs_urb32)
    169 #define USBDEVFS_DISCARDURB        _IO('U', 11)
    170 #define USBDEVFS_REAPURB           _IOW('U', 12, void *)
    171 #define USBDEVFS_REAPURB32         _IOW('U', 12, __u32)
    172 #define USBDEVFS_REAPURBNDELAY     _IOW('U', 13, void *)
    173 #define USBDEVFS_REAPURBNDELAY32   _IOW('U', 13, __u32)
    174 #define USBDEVFS_DISCSIGNAL        _IOR('U', 14, struct usbdevfs_disconnectsignal)
    175 #define USBDEVFS_DISCSIGNAL32      _IOR('U', 14, struct usbdevfs_disconnectsignal32)
    176 #define USBDEVFS_CLAIMINTERFACE    _IOR('U', 15, unsigned int)
    177 #define USBDEVFS_RELEASEINTERFACE  _IOR('U', 16, unsigned int)
    178 #define USBDEVFS_CONNECTINFO       _IOW('U', 17, struct usbdevfs_connectinfo)
    179 #define USBDEVFS_IOCTL             _IOWR('U', 18, struct usbdevfs_ioctl)
    180 #define USBDEVFS_IOCTL32           _IOWR('U', 18, struct usbdevfs_ioctl32)
    181 #define USBDEVFS_HUB_PORTINFO      _IOR('U', 19, struct usbdevfs_hub_portinfo)
    182 #define USBDEVFS_RESET             _IO('U', 20)
    183 #define USBDEVFS_CLEAR_HALT        _IOR('U', 21, unsigned int)
    184 #define USBDEVFS_DISCONNECT        _IO('U', 22)
    185 #define USBDEVFS_CONNECT           _IO('U', 23)
    186 #define USBDEVFS_CLAIM_PORT        _IOR('U', 24, unsigned int)
    187 #define USBDEVFS_RELEASE_PORT      _IOR('U', 25, unsigned int)
    188 #define USBDEVFS_GET_CAPABILITIES  _IOR('U', 26, __u32)
    189 #define USBDEVFS_DISCONNECT_CLAIM  _IOR('U', 27, struct usbdevfs_disconnect_claim)
    190 #define USBDEVFS_ALLOC_STREAMS     _IOR('U', 28, struct usbdevfs_streams)
    191 #define USBDEVFS_FREE_STREAMS      _IOR('U', 29, struct usbdevfs_streams)
    192 #define USBDEVFS_DROP_PRIVILEGES   _IOW('U', 30, __u32)
    193 
    194 #endif /* _UAPI_LINUX_USBDEVICE_FS_H */
    195