[linux-2.6-block.git] / include / linux / usb / usbnet.h

/*
 * USB Networking Link Interface
 *
 * Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net>
 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
 *
 * 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	__LINUX_USB_USBNET_H
#define	__LINUX_USB_USBNET_H

/* interface from usbnet core to each USB networking link we handle */
struct usbnet {
	/* housekeeping */
	struct usb_device	*udev;
	struct usb_interface	*intf;
	struct driver_info	*driver_info;
	const char		*driver_name;
	void			*driver_priv;
	wait_queue_head_t	*wait;
	struct mutex		phy_mutex;
	unsigned char		suspend_count;

	/* i/o info: pipes etc */
	unsigned		in, out;
	struct usb_host_endpoint *status;
	unsigned		maxpacket;
	struct timer_list	delay;

	/* protocol/interface state */
	struct net_device	*net;
	int			msg_enable;
	unsigned long		data[5];
	u32			xid;
	u32			hard_mtu;	/* count any extra framing */
	size_t			rx_urb_size;	/* size for rx urbs */
	struct mii_if_info	mii;

	/* various kinds of pending driver work */
	struct sk_buff_head	rxq;
	struct sk_buff_head	txq;
	struct sk_buff_head	done;
	struct sk_buff_head	rxq_pause;
	struct urb		*interrupt;
	struct usb_anchor	deferred;
	struct tasklet_struct	bh;

	struct work_struct	kevent;
	unsigned long		flags;
#		define EVENT_TX_HALT	0
#		define EVENT_RX_HALT	1
#		define EVENT_RX_MEMORY	2
#		define EVENT_STS_SPLIT	3
#		define EVENT_LINK_RESET	4
#		define EVENT_RX_PAUSED	5
#		define EVENT_DEV_ASLEEP 6
#		define EVENT_DEV_OPEN	7
};

static inline struct usb_driver *driver_of(struct usb_interface *intf)
{
	return to_usb_driver(intf->dev.driver);
}

/* interface from the device/framing level "minidriver" to core */
struct driver_info {
	char		*description;

	int		flags;
/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
#define FLAG_FRAMING_NC	0x0001		/* guard against device dropouts */
#define FLAG_FRAMING_GL	0x0002		/* genelink batches packets */
#define FLAG_FRAMING_Z	0x0004		/* zaurus adds a trailer */
#define FLAG_FRAMING_RN	0x0008		/* RNDIS batches, plus huge header */

#define FLAG_NO_SETINT	0x0010		/* device can't set_interface() */
#define FLAG_ETHER	0x0020		/* maybe use "eth%d" names */

#define FLAG_FRAMING_AX 0x0040		/* AX88772/178 packets */
#define FLAG_WLAN	0x0080		/* use "wlan%d" names */
#define FLAG_AVOID_UNLINK_URBS 0x0100	/* don't unlink urbs at usbnet_stop() */
#define FLAG_SEND_ZLP	0x0200		/* hw requires ZLPs are sent */
#define FLAG_WWAN	0x0400		/* use "wwan%d" names */

#define FLAG_LINK_INTR	0x0800		/* updates link (carrier) status */

#define FLAG_POINTTOPOINT 0x1000	/* possibly use "usb%d" names */

/*
 * Indicates to usbnet, that USB driver accumulates multiple IP packets.
 * Affects statistic (counters) and short packet handling.
 */
#define FLAG_MULTI_PACKET	0x2000
#define FLAG_RX_ASSEMBLE	0x4000	/* rx packets may span >1 frames */

	/* init device ... can sleep, or cause probe() failure */
	int	(*bind)(struct usbnet *, struct usb_interface *);

	/* cleanup device ... can sleep, but can't fail */
	void	(*unbind)(struct usbnet *, struct usb_interface *);

	/* reset device ... can sleep */
	int	(*reset)(struct usbnet *);

	/* stop device ... can sleep */
	int	(*stop)(struct usbnet *);

	/* see if peer is connected ... can sleep */
	int	(*check_connect)(struct usbnet *);

	/* (dis)activate runtime power management */
	int	(*manage_power)(struct usbnet *, int);

	/* for status polling */
	void	(*status)(struct usbnet *, struct urb *);

	/* link reset handling, called from defer_kevent */
	int	(*link_reset)(struct usbnet *);

	/* fixup rx packet (strip framing) */
	int	(*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);

	/* fixup tx packet (add framing) */
	struct sk_buff	*(*tx_fixup)(struct usbnet *dev,
				struct sk_buff *skb, gfp_t flags);

	/* early initialization code, can sleep. This is for minidrivers
	 * having 'subminidrivers' that need to do extra initialization
	 * right after minidriver have initialized hardware. */
	int	(*early_init)(struct usbnet *dev);

	/* called by minidriver when receiving indication */
	void	(*indication)(struct usbnet *dev, void *ind, int indlen);

	/* for new devices, use the descriptor-reading code instead */
	int		in;		/* rx endpoint */
	int		out;		/* tx endpoint */

	unsigned long	data;		/* Misc driver specific data */
};

/* Minidrivers are just drivers using the "usbnet" core as a powerful
 * network-specific subroutine library ... that happens to do pretty
 * much everything except custom framing and chip-specific stuff.
 */
extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
extern int usbnet_suspend(struct usb_interface *, pm_message_t);
extern int usbnet_resume(struct usb_interface *);
extern void usbnet_disconnect(struct usb_interface *);


/* Drivers that reuse some of the standard USB CDC infrastructure
 * (notably, using multiple interfaces according to the CDC
 * union descriptor) get some helper code.
 */
struct cdc_state {
	struct usb_cdc_header_desc	*header;
	struct usb_cdc_union_desc	*u;
	struct usb_cdc_ether_desc	*ether;
	struct usb_interface		*control;
	struct usb_interface		*data;
};

extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *);
extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *);
extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *);
extern void usbnet_cdc_status(struct usbnet *, struct urb *);

/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
#define	DEFAULT_FILTER	(USB_CDC_PACKET_TYPE_BROADCAST \
			|USB_CDC_PACKET_TYPE_ALL_MULTICAST \
			|USB_CDC_PACKET_TYPE_PROMISCUOUS \
			|USB_CDC_PACKET_TYPE_DIRECTED)


/* we record the state for each of our queued skbs */
enum skb_state {
	illegal = 0,
	tx_start, tx_done,
	rx_start, rx_done, rx_cleanup,
	unlink_start
};

struct skb_data {	/* skb->cb is one of these */
	struct urb		*urb;
	struct usbnet		*dev;
	enum skb_state		state;
	size_t			length;
};

extern int usbnet_open(struct net_device *net);
extern int usbnet_stop(struct net_device *net);
extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
				     struct net_device *net);
extern void usbnet_tx_timeout(struct net_device *net);
extern int usbnet_change_mtu(struct net_device *net, int new_mtu);

extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
extern int usbnet_get_ethernet_addr(struct usbnet *, int);
extern void usbnet_defer_kevent(struct usbnet *, int);
extern void usbnet_skb_return(struct usbnet *, struct sk_buff *);
extern void usbnet_unlink_rx_urbs(struct usbnet *);

extern void usbnet_pause_rx(struct usbnet *);
extern void usbnet_resume_rx(struct usbnet *);
extern void usbnet_purge_paused_rxq(struct usbnet *);

extern int usbnet_get_settings(struct net_device *net,
			       struct ethtool_cmd *cmd);
extern int usbnet_set_settings(struct net_device *net,
			       struct ethtool_cmd *cmd);
extern u32 usbnet_get_link(struct net_device *net);
extern u32 usbnet_get_msglevel(struct net_device *);
extern void usbnet_set_msglevel(struct net_device *, u32);
extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
extern int usbnet_nway_reset(struct net_device *net);

#endif /* __LINUX_USB_USBNET_H */
Commit	Line	Data
f29fc259 DB	1	/*
	2	* USB Networking Link Interface
	3	*
	4	* Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net>
	5	* Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*/
	21
dda43a0e RD	22	#ifndef __LINUX_USB_USBNET_H
dda43a0e RD	23	#define __LINUX_USB_USBNET_H
f29fc259	24
38bde1d4	25	/* interface from usbnet core to each USB networking link we handle */
f29fc259 DB	26	struct usbnet {
	27	/* housekeeping */
	28	struct usb_device *udev;
a11a6544	29	struct usb_interface *intf;
f29fc259	30	struct driver_info *driver_info;
296c0242	31	const char *driver_name;
476842b1	32	void *driver_priv;
f29fc259	33	wait_queue_head_t *wait;
a9fc6338	34	struct mutex phy_mutex;
36433127	35	unsigned char suspend_count;
f29fc259 DB	36
	37	/* i/o info: pipes etc */
	38	unsigned in, out;
	39	struct usb_host_endpoint *status;
	40	unsigned maxpacket;
	41	struct timer_list delay;
	42
	43	/* protocol/interface state */
	44	struct net_device *net;
f29fc259	45	int msg_enable;
0858a3a5	46	unsigned long data[5];
f29fc259 DB	47	u32 xid;
f29fc259 DB	48	u32 hard_mtu; /* count any extra framing */
18ab458f	49	size_t rx_urb_size; /* size for rx urbs */
f29fc259 DB	50	struct mii_if_info mii;
	51
	52	/* various kinds of pending driver work */
	53	struct sk_buff_head rxq;
	54	struct sk_buff_head txq;
	55	struct sk_buff_head done;
7834ddbc	56	struct sk_buff_head rxq_pause;
f29fc259	57	struct urb *interrupt;
69ee472f	58	struct usb_anchor deferred;
f29fc259 DB	59	struct tasklet_struct bh;
	60
	61	struct work_struct kevent;
	62	unsigned long flags;
	63	# define EVENT_TX_HALT 0
	64	# define EVENT_RX_HALT 1
	65	# define EVENT_RX_MEMORY 2
	66	# define EVENT_STS_SPLIT 3
	67	# define EVENT_LINK_RESET 4
7834ddbc	68	# define EVENT_RX_PAUSED 5
4a5a14d3	69	# define EVENT_DEV_ASLEEP 6
4a5a14d3	70	# define EVENT_DEV_OPEN 7
f29fc259 DB	71	};
f29fc259 DB	72
38bde1d4 DB	73	static inline struct usb_driver driver_of(struct usb_interface intf)
	74	{
	75	return to_usb_driver(intf->dev.driver);
	76	}
f29fc259 DB	77
	78	/* interface from the device/framing level "minidriver" to core */
	79	struct driver_info {
	80	char *description;
	81
	82	int flags;
	83	/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
	84	#define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
	85	#define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
	86	#define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
	87	#define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
	88
	89	#define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
	90	#define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
	91
18ab458f	92	#define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
6e3bbcc5	93	#define FLAG_WLAN 0x0080 /* use "wlan%d" names */
1487cd5e	94	#define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */
ec475623	95	#define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */
e1e499ee	96	#define FLAG_WWAN 0x0400 /* use "wwan%d" names */
6e3bbcc5	97
37e8273c	98	#define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */
f29fc259	99
c261344d AB	100	#define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */
c261344d AB	101
073285fd AO	102	/*
	103	* Indicates to usbnet, that USB driver accumulates multiple IP packets.
	104	* Affects statistic (counters) and short packet handling.
	105	*/
38a2f372	106	#define FLAG_MULTI_PACKET 0x2000
38a2f372	107	#define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */
073285fd	108
f29fc259 DB	109	/* init device ... can sleep, or cause probe() failure */
	110	int (bind)(struct usbnet , struct usb_interface *);
	111
	112	/* cleanup device ... can sleep, but can't fail */
	113	void (unbind)(struct usbnet , struct usb_interface *);
	114
	115	/* reset device ... can sleep */
	116	int (reset)(struct usbnet );
	117
a33e9e7f JK	118	/* stop device ... can sleep */
	119	int (stop)(struct usbnet );
	120
f29fc259 DB	121	/* see if peer is connected ... can sleep */
	122	int (check_connect)(struct usbnet );
	123
69ee472f ON	124	/* (dis)activate runtime power management */
	125	int (manage_power)(struct usbnet , int);
	126
f29fc259 DB	127	/* for status polling */
	128	void (status)(struct usbnet , struct urb *);
	129
	130	/* link reset handling, called from defer_kevent */
	131	int (link_reset)(struct usbnet );
	132
	133	/* fixup rx packet (strip framing) */
	134	int (rx_fixup)(struct usbnet dev, struct sk_buff *skb);
	135
	136	/* fixup tx packet (add framing) */
	137	struct sk_buff (tx_fixup)(struct usbnet *dev,
55016f10	138	struct sk_buff *skb, gfp_t flags);
7c39e038 JK	139
	140	/* early initialization code, can sleep. This is for minidrivers
	141	* having 'subminidrivers' that need to do extra initialization
	142	* right after minidriver have initialized hardware. */
	143	int (early_init)(struct usbnet dev);
5d6ecf6c	144
2a4901bc JK	145	/* called by minidriver when receiving indication */
2a4901bc JK	146	void (indication)(struct usbnet dev, void *ind, int indlen);
f29fc259 DB	147
	148	/* for new devices, use the descriptor-reading code instead */
	149	int in; /* rx endpoint */
	150	int out; /* tx endpoint */
	151
	152	unsigned long data; /* Misc driver specific data */
	153	};
	154
38bde1d4 DB	155	/* Minidrivers are just drivers using the "usbnet" core as a powerful
	156	* network-specific subroutine library ... that happens to do pretty
	157	* much everything except custom framing and chip-specific stuff.
	158	*/
	159	extern int usbnet_probe(struct usb_interface , const struct usb_device_id );
0858a3a5 GKH	160	extern int usbnet_suspend(struct usb_interface *, pm_message_t);
0858a3a5 GKH	161	extern int usbnet_resume(struct usb_interface *);
38bde1d4 DB	162	extern void usbnet_disconnect(struct usb_interface *);
38bde1d4 DB	163
f29fc259	164
0aa599c5	165	/* Drivers that reuse some of the standard USB CDC infrastructure
59c51591	166	* (notably, using multiple interfaces according to the CDC
0aa599c5 DB	167	* union descriptor) get some helper code.
	168	*/
	169	struct cdc_state {
	170	struct usb_cdc_header_desc *header;
	171	struct usb_cdc_union_desc *u;
	172	struct usb_cdc_ether_desc *ether;
	173	struct usb_interface *control;
	174	struct usb_interface *data;
	175	};
	176
0858a3a5	177	extern int usbnet_generic_cdc_bind(struct usbnet , struct usb_interface );
7a635ea9	178	extern int usbnet_cdc_bind(struct usbnet , struct usb_interface );
0858a3a5	179	extern void usbnet_cdc_unbind(struct usbnet , struct usb_interface );
7a635ea9	180	extern void usbnet_cdc_status(struct usbnet , struct urb );
0aa599c5 DB	181
	182	/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
	183	#define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
18ab458f DB	184	\|USB_CDC_PACKET_TYPE_ALL_MULTICAST \
	185	\|USB_CDC_PACKET_TYPE_PROMISCUOUS \
	186	\|USB_CDC_PACKET_TYPE_DIRECTED)
0aa599c5 DB	187
0aa599c5 DB	188
f29fc259 DB	189	/* we record the state for each of our queued skbs */
	190	enum skb_state {
	191	illegal = 0,
	192	tx_start, tx_done,
5b6e9bcd ML	193	rx_start, rx_done, rx_cleanup,
5b6e9bcd ML	194	unlink_start
f29fc259 DB	195	};
	196
	197	struct skb_data { /* skb->cb is one of these */
	198	struct urb *urb;
	199	struct usbnet *dev;
	200	enum skb_state state;
	201	size_t length;
	202	};
	203
0858a3a5 GKH	204	extern int usbnet_open(struct net_device *net);
	205	extern int usbnet_stop(struct net_device *net);
	206	extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
	207	struct net_device *net);
	208	extern void usbnet_tx_timeout(struct net_device *net);
	209	extern int usbnet_change_mtu(struct net_device *net, int new_mtu);
f29fc259	210
2e55cc72	211	extern int usbnet_get_endpoints(struct usbnet , struct usb_interface );
03ad032b	212	extern int usbnet_get_ethernet_addr(struct usbnet *, int);
0858a3a5 GKH	213	extern void usbnet_defer_kevent(struct usbnet *, int);
0858a3a5 GKH	214	extern void usbnet_skb_return(struct usbnet , struct sk_buff );
a99c1949	215	extern void usbnet_unlink_rx_urbs(struct usbnet *);
2e55cc72	216
7834ddbc JK	217	extern void usbnet_pause_rx(struct usbnet *);
	218	extern void usbnet_resume_rx(struct usbnet *);
	219	extern void usbnet_purge_paused_rxq(struct usbnet *);
	220
0858a3a5 GKH	221	extern int usbnet_get_settings(struct net_device *net,
	222	struct ethtool_cmd *cmd);
	223	extern int usbnet_set_settings(struct net_device *net,
	224	struct ethtool_cmd *cmd);
	225	extern u32 usbnet_get_link(struct net_device *net);
	226	extern u32 usbnet_get_msglevel(struct net_device *);
	227	extern void usbnet_set_msglevel(struct net_device *, u32);
	228	extern void usbnet_get_drvinfo(struct net_device , struct ethtool_drvinfo );
c41286fd	229	extern int usbnet_nway_reset(struct net_device *net);
f29fc259	230
dda43a0e	231	#endif /* __LINUX_USB_USBNET_H */