David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 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 | |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 22 | #ifndef __LINUX_USB_USBNET_H |
| 23 | #define __LINUX_USB_USBNET_H |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 24 | |
David Brownell | 38bde1d | 2005-08-31 09:52:45 -0700 | [diff] [blame] | 25 | /* interface from usbnet core to each USB networking link we handle */ |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 26 | struct usbnet { |
| 27 | /* housekeeping */ |
| 28 | struct usb_device *udev; |
Oliver Neukum | a11a654 | 2007-08-03 13:52:19 +0200 | [diff] [blame] | 29 | struct usb_interface *intf; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 30 | struct driver_info *driver_info; |
David Brownell | 296c024 | 2007-04-17 16:10:10 -0700 | [diff] [blame] | 31 | const char *driver_name; |
Jussi Kivilinna | 476842b | 2008-01-26 00:51:23 +0200 | [diff] [blame] | 32 | void *driver_priv; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 33 | wait_queue_head_t *wait; |
Arnd Bergmann | a9fc633 | 2006-10-09 00:08:02 +0200 | [diff] [blame] | 34 | struct mutex phy_mutex; |
Oliver Neukum | 3643312 | 2007-04-30 01:37:44 -0700 | [diff] [blame] | 35 | unsigned char suspend_count; |
Bjørn Mork | 70c37bf | 2013-01-28 23:51:28 +0000 | [diff] [blame] | 36 | unsigned char pkt_cnt, pkt_err; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 37 | |
| 38 | /* i/o info: pipes etc */ |
| 39 | unsigned in, out; |
| 40 | struct usb_host_endpoint *status; |
| 41 | unsigned maxpacket; |
| 42 | struct timer_list delay; |
| 43 | |
| 44 | /* protocol/interface state */ |
| 45 | struct net_device *net; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 46 | int msg_enable; |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 47 | unsigned long data[5]; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 48 | u32 xid; |
| 49 | u32 hard_mtu; /* count any extra framing */ |
David Brownell | 18ab458 | 2007-05-25 12:31:32 -0700 | [diff] [blame] | 50 | size_t rx_urb_size; /* size for rx urbs */ |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 51 | struct mii_if_info mii; |
| 52 | |
| 53 | /* various kinds of pending driver work */ |
| 54 | struct sk_buff_head rxq; |
| 55 | struct sk_buff_head txq; |
| 56 | struct sk_buff_head done; |
Jussi Kivilinna | 7834ddb | 2009-08-11 22:57:16 +0300 | [diff] [blame] | 57 | struct sk_buff_head rxq_pause; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 58 | struct urb *interrupt; |
Oliver Neukum | 69ee472f | 2009-12-03 15:31:18 -0800 | [diff] [blame] | 59 | struct usb_anchor deferred; |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 60 | struct tasklet_struct bh; |
| 61 | |
| 62 | struct work_struct kevent; |
| 63 | unsigned long flags; |
| 64 | # define EVENT_TX_HALT 0 |
| 65 | # define EVENT_RX_HALT 1 |
| 66 | # define EVENT_RX_MEMORY 2 |
| 67 | # define EVENT_STS_SPLIT 3 |
| 68 | # define EVENT_LINK_RESET 4 |
Jussi Kivilinna | 7834ddb | 2009-08-11 22:57:16 +0300 | [diff] [blame] | 69 | # define EVENT_RX_PAUSED 5 |
tom.leiming@gmail.com | 4a5a14d | 2012-06-11 15:19:43 +0000 | [diff] [blame] | 70 | # define EVENT_DEV_ASLEEP 6 |
| 71 | # define EVENT_DEV_OPEN 7 |
Oliver Neukum | 5d9d01a3 | 2012-10-11 02:50:10 +0000 | [diff] [blame] | 72 | # define EVENT_DEVICE_REPORT_IDLE 8 |
Oliver Neukum | a1c088e | 2012-12-18 04:45:29 +0000 | [diff] [blame] | 73 | # define EVENT_NO_RUNTIME_PM 9 |
Bjørn Mork | 70c37bf | 2013-01-28 23:51:28 +0000 | [diff] [blame] | 74 | # define EVENT_RX_KILL 10 |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 75 | }; |
| 76 | |
David Brownell | 38bde1d | 2005-08-31 09:52:45 -0700 | [diff] [blame] | 77 | static inline struct usb_driver *driver_of(struct usb_interface *intf) |
| 78 | { |
| 79 | return to_usb_driver(intf->dev.driver); |
| 80 | } |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 81 | |
| 82 | /* interface from the device/framing level "minidriver" to core */ |
| 83 | struct driver_info { |
| 84 | char *description; |
| 85 | |
| 86 | int flags; |
| 87 | /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */ |
| 88 | #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */ |
| 89 | #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */ |
| 90 | #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */ |
| 91 | #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */ |
| 92 | |
| 93 | #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */ |
| 94 | #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */ |
| 95 | |
David Brownell | 18ab458 | 2007-05-25 12:31:32 -0700 | [diff] [blame] | 96 | #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */ |
Jussi Kivilinna | 6e3bbcc | 2008-01-26 00:51:06 +0200 | [diff] [blame] | 97 | #define FLAG_WLAN 0x0080 /* use "wlan%d" names */ |
Jussi Kivilinna | 1487cd5 | 2009-07-30 19:41:20 +0300 | [diff] [blame] | 98 | #define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */ |
Steve Glendinning | ec47562 | 2009-09-22 04:00:27 +0000 | [diff] [blame] | 99 | #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */ |
Marcel Holtmann | e1e499e | 2009-10-02 05:15:25 +0000 | [diff] [blame] | 100 | #define FLAG_WWAN 0x0400 /* use "wwan%d" names */ |
Jussi Kivilinna | 6e3bbcc | 2008-01-26 00:51:06 +0200 | [diff] [blame] | 101 | |
Ben Hutchings | 37e8273 | 2009-11-04 15:29:52 +0000 | [diff] [blame] | 102 | #define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */ |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 103 | |
Arnd Bergmann | c261344 | 2011-04-01 20:12:02 -0700 | [diff] [blame] | 104 | #define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */ |
| 105 | |
Alexey Orishko | 073285f | 2010-11-29 23:23:27 +0000 | [diff] [blame] | 106 | /* |
| 107 | * Indicates to usbnet, that USB driver accumulates multiple IP packets. |
| 108 | * Affects statistic (counters) and short packet handling. |
| 109 | */ |
huajun li | 38a2f37 | 2011-04-13 15:43:32 +0000 | [diff] [blame] | 110 | #define FLAG_MULTI_PACKET 0x2000 |
| 111 | #define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */ |
Lucas Stach | 9c79330 | 2013-02-07 16:18:39 +0000 | [diff] [blame] | 112 | #define FLAG_NOARP 0x8000 /* device can't do ARP */ |
Alexey Orishko | 073285f | 2010-11-29 23:23:27 +0000 | [diff] [blame] | 113 | |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 114 | /* init device ... can sleep, or cause probe() failure */ |
| 115 | int (*bind)(struct usbnet *, struct usb_interface *); |
| 116 | |
| 117 | /* cleanup device ... can sleep, but can't fail */ |
| 118 | void (*unbind)(struct usbnet *, struct usb_interface *); |
| 119 | |
| 120 | /* reset device ... can sleep */ |
| 121 | int (*reset)(struct usbnet *); |
| 122 | |
Jussi Kivilinna | a33e9e7 | 2009-06-16 17:17:27 +0300 | [diff] [blame] | 123 | /* stop device ... can sleep */ |
| 124 | int (*stop)(struct usbnet *); |
| 125 | |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 126 | /* see if peer is connected ... can sleep */ |
| 127 | int (*check_connect)(struct usbnet *); |
| 128 | |
Oliver Neukum | 69ee472f | 2009-12-03 15:31:18 -0800 | [diff] [blame] | 129 | /* (dis)activate runtime power management */ |
| 130 | int (*manage_power)(struct usbnet *, int); |
| 131 | |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 132 | /* for status polling */ |
| 133 | void (*status)(struct usbnet *, struct urb *); |
| 134 | |
| 135 | /* link reset handling, called from defer_kevent */ |
| 136 | int (*link_reset)(struct usbnet *); |
| 137 | |
| 138 | /* fixup rx packet (strip framing) */ |
| 139 | int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb); |
| 140 | |
| 141 | /* fixup tx packet (add framing) */ |
| 142 | struct sk_buff *(*tx_fixup)(struct usbnet *dev, |
Al Viro | 55016f1 | 2005-10-21 03:21:58 -0400 | [diff] [blame] | 143 | struct sk_buff *skb, gfp_t flags); |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 144 | |
Jussi Kivilinna | 7c39e03 | 2008-01-26 00:51:28 +0200 | [diff] [blame] | 145 | /* early initialization code, can sleep. This is for minidrivers |
| 146 | * having 'subminidrivers' that need to do extra initialization |
| 147 | * right after minidriver have initialized hardware. */ |
| 148 | int (*early_init)(struct usbnet *dev); |
| 149 | |
Jussi Kivilinna | 2a4901b | 2009-07-30 19:41:52 +0300 | [diff] [blame] | 150 | /* called by minidriver when receiving indication */ |
| 151 | void (*indication)(struct usbnet *dev, void *ind, int indlen); |
Jussi Kivilinna | 5d6ecf6 | 2008-01-26 00:51:34 +0200 | [diff] [blame] | 152 | |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 153 | /* for new devices, use the descriptor-reading code instead */ |
| 154 | int in; /* rx endpoint */ |
| 155 | int out; /* tx endpoint */ |
| 156 | |
| 157 | unsigned long data; /* Misc driver specific data */ |
| 158 | }; |
| 159 | |
David Brownell | 38bde1d | 2005-08-31 09:52:45 -0700 | [diff] [blame] | 160 | /* Minidrivers are just drivers using the "usbnet" core as a powerful |
| 161 | * network-specific subroutine library ... that happens to do pretty |
| 162 | * much everything except custom framing and chip-specific stuff. |
| 163 | */ |
| 164 | extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *); |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 165 | extern int usbnet_suspend(struct usb_interface *, pm_message_t); |
| 166 | extern int usbnet_resume(struct usb_interface *); |
David Brownell | 38bde1d | 2005-08-31 09:52:45 -0700 | [diff] [blame] | 167 | extern void usbnet_disconnect(struct usb_interface *); |
Oliver Neukum | 5d9d01a3 | 2012-10-11 02:50:10 +0000 | [diff] [blame] | 168 | extern void usbnet_device_suggests_idle(struct usbnet *dev); |
David Brownell | 38bde1d | 2005-08-31 09:52:45 -0700 | [diff] [blame] | 169 | |
Ming Lei | 877bd86 | 2012-10-24 19:46:54 +0000 | [diff] [blame] | 170 | extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 171 | u16 value, u16 index, void *data, u16 size); |
| 172 | extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 173 | u16 value, u16 index, const void *data, u16 size); |
Ming Lei | 0547fad | 2012-11-06 04:53:04 +0000 | [diff] [blame] | 174 | extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 175 | u16 value, u16 index, void *data, u16 size); |
| 176 | extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 177 | u16 value, u16 index, const void *data, u16 size); |
Ming Lei | 877bd86 | 2012-10-24 19:46:54 +0000 | [diff] [blame] | 178 | extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 179 | u16 value, u16 index, const void *data, u16 size); |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 180 | |
David Brownell | 0aa599c | 2005-08-31 09:53:58 -0700 | [diff] [blame] | 181 | /* Drivers that reuse some of the standard USB CDC infrastructure |
Michael Opdenacker | 59c5159 | 2007-05-09 08:57:56 +0200 | [diff] [blame] | 182 | * (notably, using multiple interfaces according to the CDC |
David Brownell | 0aa599c | 2005-08-31 09:53:58 -0700 | [diff] [blame] | 183 | * union descriptor) get some helper code. |
| 184 | */ |
| 185 | struct cdc_state { |
| 186 | struct usb_cdc_header_desc *header; |
| 187 | struct usb_cdc_union_desc *u; |
| 188 | struct usb_cdc_ether_desc *ether; |
| 189 | struct usb_interface *control; |
| 190 | struct usb_interface *data; |
| 191 | }; |
| 192 | |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 193 | extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *); |
Andrzej Zaborowski | 7a635ea | 2011-03-28 12:56:33 +0000 | [diff] [blame] | 194 | extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *); |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 195 | extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *); |
Andrzej Zaborowski | 7a635ea | 2011-03-28 12:56:33 +0000 | [diff] [blame] | 196 | extern void usbnet_cdc_status(struct usbnet *, struct urb *); |
David Brownell | 0aa599c | 2005-08-31 09:53:58 -0700 | [diff] [blame] | 197 | |
| 198 | /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */ |
| 199 | #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \ |
David Brownell | 18ab458 | 2007-05-25 12:31:32 -0700 | [diff] [blame] | 200 | |USB_CDC_PACKET_TYPE_ALL_MULTICAST \ |
| 201 | |USB_CDC_PACKET_TYPE_PROMISCUOUS \ |
| 202 | |USB_CDC_PACKET_TYPE_DIRECTED) |
David Brownell | 0aa599c | 2005-08-31 09:53:58 -0700 | [diff] [blame] | 203 | |
| 204 | |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 205 | /* we record the state for each of our queued skbs */ |
| 206 | enum skb_state { |
| 207 | illegal = 0, |
| 208 | tx_start, tx_done, |
Ming Lei | 5b6e9bc | 2012-04-26 11:33:46 +0800 | [diff] [blame] | 209 | rx_start, rx_done, rx_cleanup, |
| 210 | unlink_start |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 211 | }; |
| 212 | |
| 213 | struct skb_data { /* skb->cb is one of these */ |
| 214 | struct urb *urb; |
| 215 | struct usbnet *dev; |
| 216 | enum skb_state state; |
| 217 | size_t length; |
| 218 | }; |
| 219 | |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 220 | extern int usbnet_open(struct net_device *net); |
| 221 | extern int usbnet_stop(struct net_device *net); |
| 222 | extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb, |
| 223 | struct net_device *net); |
| 224 | extern void usbnet_tx_timeout(struct net_device *net); |
| 225 | extern int usbnet_change_mtu(struct net_device *net, int new_mtu); |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 226 | |
David Brownell | 2e55cc7 | 2005-08-31 09:53:10 -0700 | [diff] [blame] | 227 | extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *); |
Peter Holik | 03ad032 | 2009-04-18 07:24:17 +0000 | [diff] [blame] | 228 | extern int usbnet_get_ethernet_addr(struct usbnet *, int); |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 229 | extern void usbnet_defer_kevent(struct usbnet *, int); |
| 230 | extern void usbnet_skb_return(struct usbnet *, struct sk_buff *); |
Jamie Painter | a99c194 | 2006-07-27 14:17:28 -0400 | [diff] [blame] | 231 | extern void usbnet_unlink_rx_urbs(struct usbnet *); |
David Brownell | 2e55cc7 | 2005-08-31 09:53:10 -0700 | [diff] [blame] | 232 | |
Jussi Kivilinna | 7834ddb | 2009-08-11 22:57:16 +0300 | [diff] [blame] | 233 | extern void usbnet_pause_rx(struct usbnet *); |
| 234 | extern void usbnet_resume_rx(struct usbnet *); |
| 235 | extern void usbnet_purge_paused_rxq(struct usbnet *); |
| 236 | |
Greg Kroah-Hartman | 0858a3a | 2010-05-17 10:58:12 -0700 | [diff] [blame] | 237 | extern int usbnet_get_settings(struct net_device *net, |
| 238 | struct ethtool_cmd *cmd); |
| 239 | extern int usbnet_set_settings(struct net_device *net, |
| 240 | struct ethtool_cmd *cmd); |
| 241 | extern u32 usbnet_get_link(struct net_device *net); |
| 242 | extern u32 usbnet_get_msglevel(struct net_device *); |
| 243 | extern void usbnet_set_msglevel(struct net_device *, u32); |
| 244 | extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *); |
Arnd Bergmann | c41286f | 2006-10-09 00:08:01 +0200 | [diff] [blame] | 245 | extern int usbnet_nway_reset(struct net_device *net); |
David Brownell | f29fc25 | 2005-08-31 09:52:31 -0700 | [diff] [blame] | 246 | |
Oliver Neukum | 2dd7c8c | 2012-12-18 04:45:52 +0000 | [diff] [blame] | 247 | extern int usbnet_manage_power(struct usbnet *, int); |
Ming Lei | ac64995 | 2013-04-11 04:40:30 +0000 | [diff] [blame^] | 248 | extern void usbnet_link_change(struct usbnet *, bool, bool); |
Oliver Neukum | 2dd7c8c | 2012-12-18 04:45:52 +0000 | [diff] [blame] | 249 | |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 250 | #endif /* __LINUX_USB_USBNET_H */ |