[deliverable/linux.git] / include / linux / usbdevice_fs.h

/*****************************************************************************/

/*
 *	usbdevice_fs.h  --  USB device file system.
 *
 *	Copyright (C) 2000
 *          Thomas Sailer (sailer@ife.ee.ethz.ch)
 *
 *	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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  History:
 *   0.1  04.01.2000  Created
 */

/*****************************************************************************/

#ifndef _LINUX_USBDEVICE_FS_H
#define _LINUX_USBDEVICE_FS_H

#include <linux/types.h>
#include <linux/magic.h>

/* --------------------------------------------------------------------- */

/* usbdevfs ioctl codes */

struct usbdevfs_ctrltransfer {
	__u8 bRequestType;
	__u8 bRequest;
	__u16 wValue;
	__u16 wIndex;
	__u16 wLength;
	__u32 timeout;  /* in milliseconds */
 	void __user *data;
};

struct usbdevfs_bulktransfer {
	unsigned int ep;
	unsigned int len;
	unsigned int timeout; /* in milliseconds */
	void __user *data;
};

struct usbdevfs_setinterface {
	unsigned int interface;
	unsigned int altsetting;
};

struct usbdevfs_disconnectsignal {
	unsigned int signr;
	void __user *context;
};

#define USBDEVFS_MAXDRIVERNAME 255

struct usbdevfs_getdriver {
	unsigned int interface;
	char driver[USBDEVFS_MAXDRIVERNAME + 1];
};

struct usbdevfs_connectinfo {
	unsigned int devnum;
	unsigned char slow;
};

#define USBDEVFS_URB_SHORT_NOT_OK	0x01
#define USBDEVFS_URB_ISO_ASAP		0x02
#define USBDEVFS_URB_BULK_CONTINUATION	0x04
#define USBDEVFS_URB_NO_FSBR		0x20
#define USBDEVFS_URB_ZERO_PACKET	0x40
#define USBDEVFS_URB_NO_INTERRUPT	0x80

#define USBDEVFS_URB_TYPE_ISO		   0
#define USBDEVFS_URB_TYPE_INTERRUPT	   1
#define USBDEVFS_URB_TYPE_CONTROL	   2
#define USBDEVFS_URB_TYPE_BULK		   3

struct usbdevfs_iso_packet_desc {
	unsigned int length;
	unsigned int actual_length;
	unsigned int status;
};

struct usbdevfs_urb {
	unsigned char type;
	unsigned char endpoint;
	int status;
	unsigned int flags;
	void __user *buffer;
	int buffer_length;
	int actual_length;
	int start_frame;
	int number_of_packets;
	int error_count;
	unsigned int signr;	/* signal to be sent on completion,
				  or 0 if none should be sent. */
	void __user *usercontext;
	struct usbdevfs_iso_packet_desc iso_frame_desc[0];
};

/* ioctls for talking directly to drivers */
struct usbdevfs_ioctl {
	int	ifno;		/* interface 0..N ; negative numbers reserved */
	int	ioctl_code;	/* MUST encode size + direction of data so the
				 * macros in <asm/ioctl.h> give correct values */
	void __user *data;	/* param buffer (in, or out) */
};

/* You can do most things with hubs just through control messages,
 * except find out what device connects to what port. */
struct usbdevfs_hub_portinfo {
	char nports;		/* number of downstream ports in this hub */
	char port [127];	/* e.g. port 3 connects to device 27 */
};

/* Device capability flags */
#define USBDEVFS_CAP_ZERO_PACKET		0x01
#define USBDEVFS_CAP_BULK_CONTINUATION		0x02
#define USBDEVFS_CAP_NO_PACKET_SIZE_LIM		0x04
#define USBDEVFS_CAP_BULK_SCATTER_GATHER	0x08

#ifdef __KERNEL__
#ifdef CONFIG_COMPAT
#include <linux/compat.h>

struct usbdevfs_ctrltransfer32 {
        u8 bRequestType;
        u8 bRequest;
        u16 wValue;
        u16 wIndex;
        u16 wLength;
        u32 timeout;  /* in milliseconds */
        compat_caddr_t data;
};

struct usbdevfs_bulktransfer32 {
        compat_uint_t ep;
        compat_uint_t len;
        compat_uint_t timeout; /* in milliseconds */
        compat_caddr_t data;
};

struct usbdevfs_disconnectsignal32 {
        compat_int_t signr;
        compat_caddr_t context;
};

struct usbdevfs_urb32 {
	unsigned char type;
	unsigned char endpoint;
	compat_int_t status;
	compat_uint_t flags;
	compat_caddr_t buffer;
	compat_int_t buffer_length;
	compat_int_t actual_length;
	compat_int_t start_frame;
	compat_int_t number_of_packets;
	compat_int_t error_count;
	compat_uint_t signr;
	compat_caddr_t usercontext; /* unused */
	struct usbdevfs_iso_packet_desc iso_frame_desc[0];
};

struct usbdevfs_ioctl32 {
	s32 ifno;
	s32 ioctl_code;
	compat_caddr_t data;
};
#endif
#endif /* __KERNEL__ */

#define USBDEVFS_CONTROL           _IOWR('U', 0, struct usbdevfs_ctrltransfer)
#define USBDEVFS_CONTROL32           _IOWR('U', 0, struct usbdevfs_ctrltransfer32)
#define USBDEVFS_BULK              _IOWR('U', 2, struct usbdevfs_bulktransfer)
#define USBDEVFS_BULK32              _IOWR('U', 2, struct usbdevfs_bulktransfer32)
#define USBDEVFS_RESETEP           _IOR('U', 3, unsigned int)
#define USBDEVFS_SETINTERFACE      _IOR('U', 4, struct usbdevfs_setinterface)
#define USBDEVFS_SETCONFIGURATION  _IOR('U', 5, unsigned int)
#define USBDEVFS_GETDRIVER         _IOW('U', 8, struct usbdevfs_getdriver)
#define USBDEVFS_SUBMITURB         _IOR('U', 10, struct usbdevfs_urb)
#define USBDEVFS_SUBMITURB32       _IOR('U', 10, struct usbdevfs_urb32)
#define USBDEVFS_DISCARDURB        _IO('U', 11)
#define USBDEVFS_REAPURB           _IOW('U', 12, void *)
#define USBDEVFS_REAPURB32         _IOW('U', 12, __u32)
#define USBDEVFS_REAPURBNDELAY     _IOW('U', 13, void *)
#define USBDEVFS_REAPURBNDELAY32   _IOW('U', 13, __u32)
#define USBDEVFS_DISCSIGNAL        _IOR('U', 14, struct usbdevfs_disconnectsignal)
#define USBDEVFS_DISCSIGNAL32      _IOR('U', 14, struct usbdevfs_disconnectsignal32)
#define USBDEVFS_CLAIMINTERFACE    _IOR('U', 15, unsigned int)
#define USBDEVFS_RELEASEINTERFACE  _IOR('U', 16, unsigned int)
#define USBDEVFS_CONNECTINFO       _IOW('U', 17, struct usbdevfs_connectinfo)
#define USBDEVFS_IOCTL             _IOWR('U', 18, struct usbdevfs_ioctl)
#define USBDEVFS_IOCTL32           _IOWR('U', 18, struct usbdevfs_ioctl32)
#define USBDEVFS_HUB_PORTINFO      _IOR('U', 19, struct usbdevfs_hub_portinfo)
#define USBDEVFS_RESET             _IO('U', 20)
#define USBDEVFS_CLEAR_HALT        _IOR('U', 21, unsigned int)
#define USBDEVFS_DISCONNECT        _IO('U', 22)
#define USBDEVFS_CONNECT           _IO('U', 23)
#define USBDEVFS_CLAIM_PORT        _IOR('U', 24, unsigned int)
#define USBDEVFS_RELEASE_PORT      _IOR('U', 25, unsigned int)
#define USBDEVFS_GET_CAPABILITIES  _IOR('U', 26, __u32)

#endif /* _LINUX_USBDEVICE_FS_H */
Commit	Line	Data
1da177e4 LT	1	/*****************************************************************************/
	2
	3	/*
	4	* usbdevice_fs.h -- USB device file system.
	5	*
	6	* Copyright (C) 2000
	7	* Thomas Sailer (sailer@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
1da177e4 LT	25	*/
	26
	27	/*****************************************************************************/
	28
	29	#ifndef _LINUX_USBDEVICE_FS_H
	30	#define _LINUX_USBDEVICE_FS_H
	31
	32	#include <linux/types.h>
e18fa700	33	#include <linux/magic.h>
1da177e4 LT	34
	35	/* --------------------------------------------------------------------- */
	36
1da177e4 LT	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
14722ef4 AS	78	#define USBDEVFS_URB_SHORT_NOT_OK 0x01
14722ef4 AS	79	#define USBDEVFS_URB_ISO_ASAP 0x02
01c6460f	80	#define USBDEVFS_URB_BULK_CONTINUATION 0x04
14722ef4 AS	81	#define USBDEVFS_URB_NO_FSBR 0x20
	82	#define USBDEVFS_URB_ZERO_PACKET 0x40
	83	#define USBDEVFS_URB_NO_INTERRUPT 0x80
1da177e4 LT	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	int number_of_packets;
	106	int error_count;
bc59462b PE	107	unsigned int signr; /* signal to be sent on completion,
bc59462b PE	108	or 0 if none should be sent. */
7f9705b0	109	void __user *usercontext;
1da177e4 LT	110	struct usbdevfs_iso_packet_desc iso_frame_desc[0];
	111	};
	112
	113	/* ioctls for talking directly to drivers */
	114	struct usbdevfs_ioctl {
	115	int ifno; /* interface 0..N ; negative numbers reserved */
	116	int ioctl_code; /* MUST encode size + direction of data so the
	117	* macros in <asm/ioctl.h> give correct values */
	118	void __user data; / param buffer (in, or out) */
	119	};
	120
	121	/* You can do most things with hubs just through control messages,
	122	* except find out what device connects to what port. */
	123	struct usbdevfs_hub_portinfo {
	124	char nports; /* number of downstream ports in this hub */
	125	char port [127]; /* e.g. port 3 connects to device 27 */
	126	};
	127
19181bc5 HG	128	/* Device capability flags */
	129	#define USBDEVFS_CAP_ZERO_PACKET 0x01
	130	#define USBDEVFS_CAP_BULK_CONTINUATION 0x02
	131	#define USBDEVFS_CAP_NO_PACKET_SIZE_LIM 0x04
3d97ff63	132	#define USBDEVFS_CAP_BULK_SCATTER_GATHER 0x08
19181bc5	133
eae19a76	134	#ifdef __KERNEL__
1da177e4	135	#ifdef CONFIG_COMPAT
ce441594	136	#include <linux/compat.h>
637e8a60 AB	137
	138	struct usbdevfs_ctrltransfer32 {
	139	u8 bRequestType;
	140	u8 bRequest;
	141	u16 wValue;
	142	u16 wIndex;
	143	u16 wLength;
	144	u32 timeout; /* in milliseconds */
	145	compat_caddr_t data;
	146	};
	147
	148	struct usbdevfs_bulktransfer32 {
	149	compat_uint_t ep;
	150	compat_uint_t len;
	151	compat_uint_t timeout; /* in milliseconds */
	152	compat_caddr_t data;
	153	};
	154
	155	struct usbdevfs_disconnectsignal32 {
	156	compat_int_t signr;
	157	compat_caddr_t context;
	158	};
	159
1da177e4 LT	160	struct usbdevfs_urb32 {
	161	unsigned char type;
	162	unsigned char endpoint;
	163	compat_int_t status;
	164	compat_uint_t flags;
	165	compat_caddr_t buffer;
	166	compat_int_t buffer_length;
	167	compat_int_t actual_length;
	168	compat_int_t start_frame;
	169	compat_int_t number_of_packets;
	170	compat_int_t error_count;
	171	compat_uint_t signr;
	172	compat_caddr_t usercontext; /* unused */
	173	struct usbdevfs_iso_packet_desc iso_frame_desc[0];
	174	};
c36fc889 PZ	175
	176	struct usbdevfs_ioctl32 {
	177	s32 ifno;
	178	s32 ioctl_code;
	179	compat_caddr_t data;
	180	};
1da177e4	181	#endif
eae19a76	182	#endif /* __KERNEL__ */
1da177e4 LT	183
1da177e4 LT	184	#define USBDEVFS_CONTROL _IOWR('U', 0, struct usbdevfs_ctrltransfer)
637e8a60	185	#define USBDEVFS_CONTROL32 _IOWR('U', 0, struct usbdevfs_ctrltransfer32)
1da177e4	186	#define USBDEVFS_BULK _IOWR('U', 2, struct usbdevfs_bulktransfer)
637e8a60	187	#define USBDEVFS_BULK32 _IOWR('U', 2, struct usbdevfs_bulktransfer32)
1da177e4 LT	188	#define USBDEVFS_RESETEP _IOR('U', 3, unsigned int)
	189	#define USBDEVFS_SETINTERFACE _IOR('U', 4, struct usbdevfs_setinterface)
	190	#define USBDEVFS_SETCONFIGURATION _IOR('U', 5, unsigned int)
	191	#define USBDEVFS_GETDRIVER _IOW('U', 8, struct usbdevfs_getdriver)
	192	#define USBDEVFS_SUBMITURB _IOR('U', 10, struct usbdevfs_urb)
	193	#define USBDEVFS_SUBMITURB32 _IOR('U', 10, struct usbdevfs_urb32)
	194	#define USBDEVFS_DISCARDURB _IO('U', 11)
	195	#define USBDEVFS_REAPURB _IOW('U', 12, void *)
fc8d9191	196	#define USBDEVFS_REAPURB32 _IOW('U', 12, __u32)
1da177e4	197	#define USBDEVFS_REAPURBNDELAY _IOW('U', 13, void *)
fc8d9191	198	#define USBDEVFS_REAPURBNDELAY32 _IOW('U', 13, __u32)
1da177e4	199	#define USBDEVFS_DISCSIGNAL _IOR('U', 14, struct usbdevfs_disconnectsignal)
637e8a60	200	#define USBDEVFS_DISCSIGNAL32 _IOR('U', 14, struct usbdevfs_disconnectsignal32)
1da177e4 LT	201	#define USBDEVFS_CLAIMINTERFACE _IOR('U', 15, unsigned int)
	202	#define USBDEVFS_RELEASEINTERFACE _IOR('U', 16, unsigned int)
	203	#define USBDEVFS_CONNECTINFO _IOW('U', 17, struct usbdevfs_connectinfo)
	204	#define USBDEVFS_IOCTL _IOWR('U', 18, struct usbdevfs_ioctl)
c36fc889	205	#define USBDEVFS_IOCTL32 _IOWR('U', 18, struct usbdevfs_ioctl32)
1da177e4 LT	206	#define USBDEVFS_HUB_PORTINFO _IOR('U', 19, struct usbdevfs_hub_portinfo)
	207	#define USBDEVFS_RESET _IO('U', 20)
	208	#define USBDEVFS_CLEAR_HALT _IOR('U', 21, unsigned int)
	209	#define USBDEVFS_DISCONNECT _IO('U', 22)
	210	#define USBDEVFS_CONNECT _IO('U', 23)
7cbe5dca AS	211	#define USBDEVFS_CLAIM_PORT _IOR('U', 24, unsigned int)
7cbe5dca AS	212	#define USBDEVFS_RELEASE_PORT _IOR('U', 25, unsigned int)
19181bc5 HG	213	#define USBDEVFS_GET_CAPABILITIES _IOR('U', 26, __u32)
19181bc5 HG	214
1da177e4	215	#endif /* _LINUX_USBDEVICE_FS_H */