[deliverable/linux.git] / drivers / usb / net / 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	__USBNET_H
#define	__USBNET_H


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

	/* 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;
	struct net_device_stats	stats;
	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 urb		*interrupt;
	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
};

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 */

	/* 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 *);

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

	/* 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);

	/* 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 void usbnet_cdc_unbind (struct usbnet *, struct usb_interface *);

/* 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
};

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_get_endpoints(struct usbnet *, struct usb_interface *);
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 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);

/* messaging support includes the interface name, so it must not be
 * used before it has one ... notably, in minidriver bind() calls.
 */
#ifdef DEBUG
#define devdbg(usbnet, fmt, arg...) \
	printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
#else
#define devdbg(usbnet, fmt, arg...) do {} while(0)
#endif

#define deverr(usbnet, fmt, arg...) \
	printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
#define devwarn(usbnet, fmt, arg...) \
	printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)

#define devinfo(usbnet, fmt, arg...) \
	printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \


#endif	/* __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
	22
	23	#ifndef __USBNET_H
	24	#define __USBNET_H
	25
	26
38bde1d4	27	/* interface from usbnet core to each USB networking link we handle */
f29fc259 DB	28	struct usbnet {
	29	/* housekeeping */
	30	struct usb_device *udev;
	31	struct driver_info *driver_info;
296c0242	32	const char *driver_name;
f29fc259	33	wait_queue_head_t *wait;
a9fc6338	34	struct mutex phy_mutex;
f29fc259 DB	35
	36	/* i/o info: pipes etc */
	37	unsigned in, out;
	38	struct usb_host_endpoint *status;
	39	unsigned maxpacket;
	40	struct timer_list delay;
	41
	42	/* protocol/interface state */
	43	struct net_device *net;
	44	struct net_device_stats stats;
	45	int msg_enable;
	46	unsigned long data [5];
	47	u32 xid;
	48	u32 hard_mtu; /* count any extra framing */
2e55cc72	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;
	56	struct urb *interrupt;
	57	struct tasklet_struct bh;
	58
	59	struct work_struct kevent;
	60	unsigned long flags;
	61	# define EVENT_TX_HALT 0
	62	# define EVENT_RX_HALT 1
	63	# define EVENT_RX_MEMORY 2
	64	# define EVENT_STS_SPLIT 3
	65	# define EVENT_LINK_RESET 4
	66	};
	67
38bde1d4 DB	68	static inline struct usb_driver driver_of(struct usb_interface intf)
	69	{
	70	return to_usb_driver(intf->dev.driver);
	71	}
f29fc259 DB	72
	73	/* interface from the device/framing level "minidriver" to core */
	74	struct driver_info {
	75	char *description;
	76
	77	int flags;
	78	/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
	79	#define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
	80	#define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
	81	#define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
	82	#define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
	83
	84	#define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
	85	#define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
	86
	87	#define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
	88
	89	/* init device ... can sleep, or cause probe() failure */
	90	int (bind)(struct usbnet , struct usb_interface *);
	91
	92	/* cleanup device ... can sleep, but can't fail */
	93	void (unbind)(struct usbnet , struct usb_interface *);
	94
	95	/* reset device ... can sleep */
	96	int (reset)(struct usbnet );
	97
	98	/* see if peer is connected ... can sleep */
	99	int (check_connect)(struct usbnet );
	100
	101	/* for status polling */
	102	void (status)(struct usbnet , struct urb *);
	103
	104	/* link reset handling, called from defer_kevent */
	105	int (link_reset)(struct usbnet );
	106
	107	/* fixup rx packet (strip framing) */
	108	int (rx_fixup)(struct usbnet dev, struct sk_buff *skb);
	109
	110	/* fixup tx packet (add framing) */
	111	struct sk_buff (tx_fixup)(struct usbnet *dev,
55016f10	112	struct sk_buff *skb, gfp_t flags);
f29fc259 DB	113
	114	/* for new devices, use the descriptor-reading code instead */
	115	int in; /* rx endpoint */
	116	int out; /* tx endpoint */
	117
	118	unsigned long data; /* Misc driver specific data */
	119	};
	120
38bde1d4 DB	121	/* Minidrivers are just drivers using the "usbnet" core as a powerful
	122	* network-specific subroutine library ... that happens to do pretty
	123	* much everything except custom framing and chip-specific stuff.
	124	*/
	125	extern int usbnet_probe(struct usb_interface , const struct usb_device_id );
	126	extern int usbnet_suspend (struct usb_interface *, pm_message_t );
	127	extern int usbnet_resume (struct usb_interface *);
	128	extern void usbnet_disconnect(struct usb_interface *);
	129
f29fc259	130
0aa599c5	131	/* Drivers that reuse some of the standard USB CDC infrastructure
59c51591	132	* (notably, using multiple interfaces according to the CDC
0aa599c5 DB	133	* union descriptor) get some helper code.
	134	*/
	135	struct cdc_state {
	136	struct usb_cdc_header_desc *header;
	137	struct usb_cdc_union_desc *u;
	138	struct usb_cdc_ether_desc *ether;
	139	struct usb_interface *control;
	140	struct usb_interface *data;
	141	};
	142
	143	extern int usbnet_generic_cdc_bind (struct usbnet , struct usb_interface );
	144	extern void usbnet_cdc_unbind (struct usbnet , struct usb_interface );
	145
	146	/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
	147	#define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
	148	\|USB_CDC_PACKET_TYPE_ALL_MULTICAST \
	149	\|USB_CDC_PACKET_TYPE_PROMISCUOUS \
	150	\|USB_CDC_PACKET_TYPE_DIRECTED)
	151
	152
f29fc259 DB	153	/* we record the state for each of our queued skbs */
	154	enum skb_state {
	155	illegal = 0,
	156	tx_start, tx_done,
	157	rx_start, rx_done, rx_cleanup
	158	};
	159
	160	struct skb_data { /* skb->cb is one of these */
	161	struct urb *urb;
	162	struct usbnet *dev;
	163	enum skb_state state;
	164	size_t length;
	165	};
	166
	167
2e55cc72 DB	168	extern int usbnet_get_endpoints(struct usbnet , struct usb_interface );
	169	extern void usbnet_defer_kevent (struct usbnet *, int);
	170	extern void usbnet_skb_return (struct usbnet , struct sk_buff );
a99c1949	171	extern void usbnet_unlink_rx_urbs(struct usbnet *);
2e55cc72	172
c41286fd AB	173	extern int usbnet_get_settings (struct net_device net, struct ethtool_cmd cmd);
	174	extern int usbnet_set_settings (struct net_device net, struct ethtool_cmd cmd);
	175	extern u32 usbnet_get_link (struct net_device *net);
2e55cc72 DB	176	extern u32 usbnet_get_msglevel (struct net_device *);
	177	extern void usbnet_set_msglevel (struct net_device *, u32);
	178	extern void usbnet_get_drvinfo (struct net_device , struct ethtool_drvinfo );
c41286fd	179	extern int usbnet_nway_reset(struct net_device *net);
f29fc259 DB	180
	181	/* messaging support includes the interface name, so it must not be
	182	* used before it has one ... notably, in minidriver bind() calls.
	183	*/
	184	#ifdef DEBUG
	185	#define devdbg(usbnet, fmt, arg...) \
	186	printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
	187	#else
	188	#define devdbg(usbnet, fmt, arg...) do {} while(0)
	189	#endif
	190
	191	#define deverr(usbnet, fmt, arg...) \
	192	printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
	193	#define devwarn(usbnet, fmt, arg...) \
	194	printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
	195
	196	#define devinfo(usbnet, fmt, arg...) \
	197	printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
	198
	199
	200	#endif /* __USBNET_H */