include/linux/usb/usbnet.h

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * USB Networking Link Interface
   4  *
   5  * Copyright (C) 2000-2005 by David Brownell <[email protected]>
   6  * Copyright (C) 2003-2005 David Hollis <[email protected]>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __LINUX_USB_USBNET_H
  24 #define __LINUX_USB_USBNET_H
  25
  26 /* interface from usbnet core to each USB networking link we handle */
  27 struct usbnet {
  28         /* housekeeping */
  29         struct usb_device       *udev;
  30         struct usb_interface    *intf;
  31         const struct driver_info *driver_info;
  32         const char              *driver_name;
  33         void                    *driver_priv;
  34         wait_queue_head_t       wait;
  35         struct mutex            phy_mutex;
  36         unsigned char           suspend_count;
  37         unsigned char           pkt_cnt, pkt_err;
  38         unsigned short          rx_qlen, tx_qlen;
  39         unsigned                can_dma_sg:1;
  40
  41         /* i/o info: pipes etc */
  42         unsigned                in, out;
  43         struct usb_host_endpoint *status;
  44         unsigned                maxpacket;
  45         struct timer_list       delay;
  46         const char              *padding_pkt;
  47
  48         /* protocol/interface state */
  49         struct net_device       *net;
  50         int                     msg_enable;
  51         unsigned long           data[5];
  52         u32                     xid;
  53         u32                     hard_mtu;       /* count any extra framing */
  54         size_t                  rx_urb_size;    /* size for rx urbs */
  55         struct mii_if_info      mii;
  56
  57         /* various kinds of pending driver work */
  58         struct sk_buff_head     rxq;
  59         struct sk_buff_head     txq;
  60         struct sk_buff_head     done;
  61         struct sk_buff_head     rxq_pause;
  62         struct urb              *interrupt;
  63         unsigned                interrupt_count;
  64         struct mutex            interrupt_mutex;
  65         struct usb_anchor       deferred;
  66         struct tasklet_struct   bh;
  67
  68         struct work_struct      kevent;
  69         unsigned long           flags;
  70 #               define EVENT_TX_HALT    0
  71 #               define EVENT_RX_HALT    1
  72 #               define EVENT_RX_MEMORY  2
  73 #               define EVENT_STS_SPLIT  3
  74 #               define EVENT_LINK_RESET 4
  75 #               define EVENT_RX_PAUSED  5
  76 #               define EVENT_DEV_ASLEEP 6
  77 #               define EVENT_DEV_OPEN   7
  78 #               define EVENT_DEVICE_REPORT_IDLE 8
  79 #               define EVENT_NO_RUNTIME_PM      9
  80 #               define EVENT_RX_KILL    10
  81 #               define EVENT_LINK_CHANGE        11
  82 #               define EVENT_SET_RX_MODE        12
  83 #               define EVENT_NO_IP_ALIGN        13
  84 };
  85
  86 static inline struct usb_driver *driver_of(struct usb_interface *intf)
  87 {
  88         return to_usb_driver(intf->dev.driver);
  89 }
  90
  91 /* interface from the device/framing level "minidriver" to core */
  92 struct driver_info {
  93         char            *description;
  94
  95         int             flags;
  96 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
  97 #define FLAG_FRAMING_NC 0x0001          /* guard against device dropouts */
  98 #define FLAG_FRAMING_GL 0x0002          /* genelink batches packets */
  99 #define FLAG_FRAMING_Z  0x0004          /* zaurus adds a trailer */
 100 #define FLAG_FRAMING_RN 0x0008          /* RNDIS batches, plus huge header */
 101
 102 #define FLAG_NO_SETINT  0x0010          /* device can't set_interface() */
 103 #define FLAG_ETHER      0x0020          /* maybe use "eth%d" names */
 104
 105 #define FLAG_FRAMING_AX 0x0040          /* AX88772/178 packets */
 106 #define FLAG_WLAN       0x0080          /* use "wlan%d" names */
 107 #define FLAG_AVOID_UNLINK_URBS 0x0100   /* don't unlink urbs at usbnet_stop() */
 108 #define FLAG_SEND_ZLP   0x0200          /* hw requires ZLPs are sent */
 109 #define FLAG_WWAN       0x0400          /* use "wwan%d" names */
 110
 111 #define FLAG_LINK_INTR  0x0800          /* updates link (carrier) status */
 112
 113 #define FLAG_POINTTOPOINT 0x1000        /* possibly use "usb%d" names */
 114
 115 /*
 116  * Indicates to usbnet, that USB driver accumulates multiple IP packets.
 117  * Affects statistic (counters) and short packet handling.
 118  */
 119 #define FLAG_MULTI_PACKET       0x2000
 120 #define FLAG_RX_ASSEMBLE        0x4000  /* rx packets may span >1 frames */
 121 #define FLAG_NOARP              0x8000  /* device can't do ARP */
 122
 123         /* init device ... can sleep, or cause probe() failure */
 124         int     (*bind)(struct usbnet *, struct usb_interface *);
 125
 126         /* cleanup device ... can sleep, but can't fail */
 127         void    (*unbind)(struct usbnet *, struct usb_interface *);
 128
 129         /* reset device ... can sleep */
 130         int     (*reset)(struct usbnet *);
 131
 132         /* stop device ... can sleep */
 133         int     (*stop)(struct usbnet *);
 134
 135         /* see if peer is connected ... can sleep */
 136         int     (*check_connect)(struct usbnet *);
 137
 138         /* (dis)activate runtime power management */
 139         int     (*manage_power)(struct usbnet *, int);
 140
 141         /* for status polling */
 142         void    (*status)(struct usbnet *, struct urb *);
 143
 144         /* link reset handling, called from defer_kevent */
 145         int     (*link_reset)(struct usbnet *);
 146
 147         /* fixup rx packet (strip framing) */
 148         int     (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
 149
 150         /* fixup tx packet (add framing) */
 151         struct sk_buff  *(*tx_fixup)(struct usbnet *dev,
 152                                 struct sk_buff *skb, gfp_t flags);
 153
 154         /* recover from timeout */
 155         void    (*recover)(struct usbnet *dev);
 156
 157         /* early initialization code, can sleep. This is for minidrivers
 158          * having 'subminidrivers' that need to do extra initialization
 159          * right after minidriver have initialized hardware. */
 160         int     (*early_init)(struct usbnet *dev);
 161
 162         /* called by minidriver when receiving indication */
 163         void    (*indication)(struct usbnet *dev, void *ind, int indlen);
 164
 165         /* rx mode change (device changes address list filtering) */
 166         void    (*set_rx_mode)(struct usbnet *dev);
 167
 168         /* for new devices, use the descriptor-reading code instead */
 169         int             in;             /* rx endpoint */
 170         int             out;            /* tx endpoint */
 171
 172         unsigned long   data;           /* Misc driver specific data */
 173 };
 174
 175 /* Minidrivers are just drivers using the "usbnet" core as a powerful
 176  * network-specific subroutine library ... that happens to do pretty
 177  * much everything except custom framing and chip-specific stuff.
 178  */
 179 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
 180 extern int usbnet_suspend(struct usb_interface *, pm_message_t);
 181 extern int usbnet_resume(struct usb_interface *);
 182 extern void usbnet_disconnect(struct usb_interface *);
 183 extern void usbnet_device_suggests_idle(struct usbnet *dev);
 184
 185 extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
 186                     u16 value, u16 index, void *data, u16 size);
 187 extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
 188                     u16 value, u16 index, const void *data, u16 size);
 189 extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
 190                     u16 value, u16 index, void *data, u16 size);
 191 extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
 192                     u16 value, u16 index, const void *data, u16 size);
 193 extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
 194                     u16 value, u16 index, const void *data, u16 size);
 195
 196 /* Drivers that reuse some of the standard USB CDC infrastructure
 197  * (notably, using multiple interfaces according to the CDC
 198  * union descriptor) get some helper code.
 199  */
 200 struct cdc_state {
 201         struct usb_cdc_header_desc      *header;
 202         struct usb_cdc_union_desc       *u;
 203         struct usb_cdc_ether_desc       *ether;
 204         struct usb_interface            *control;
 205         struct usb_interface            *data;
 206 };
 207
 208 extern void usbnet_cdc_update_filter(struct usbnet *dev);
 209 extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *);
 210 extern int usbnet_ether_cdc_bind(struct usbnet *dev, struct usb_interface *intf);
 211 extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *);
 212 extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *);
 213 extern void usbnet_cdc_status(struct usbnet *, struct urb *);
 214
 215 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
 216 #define DEFAULT_FILTER  (USB_CDC_PACKET_TYPE_BROADCAST \
 217                         |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
 218                         |USB_CDC_PACKET_TYPE_PROMISCUOUS \
 219                         |USB_CDC_PACKET_TYPE_DIRECTED)
 220
 221
 222 /* we record the state for each of our queued skbs */
 223 enum skb_state {
 224         illegal = 0,
 225         tx_start, tx_done,
 226         rx_start, rx_done, rx_cleanup,
 227         unlink_start
 228 };
 229
 230 struct skb_data {       /* skb->cb is one of these */
 231         struct urb              *urb;
 232         struct usbnet           *dev;
 233         enum skb_state          state;
 234         long                    length;
 235         unsigned long           packets;
 236 };
 237
 238 /* Drivers that set FLAG_MULTI_PACKET must call this in their
 239  * tx_fixup method before returning an skb.
 240  */
 241 static inline void
 242 usbnet_set_skb_tx_stats(struct sk_buff *skb,
 243                         unsigned long packets, long bytes_delta)
 244 {
 245         struct skb_data *entry = (struct skb_data *) skb->cb;
 246
 247         entry->packets = packets;
 248         entry->length = bytes_delta;
 249 }
 250
 251 extern int usbnet_open(struct net_device *net);
 252 extern int usbnet_stop(struct net_device *net);
 253 extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
 254                                      struct net_device *net);
 255 extern void usbnet_tx_timeout(struct net_device *net, unsigned int txqueue);
 256 extern int usbnet_change_mtu(struct net_device *net, int new_mtu);
 257
 258 extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
 259 extern int usbnet_get_ethernet_addr(struct usbnet *, int);
 260 extern void usbnet_defer_kevent(struct usbnet *, int);
 261 extern void usbnet_skb_return(struct usbnet *, struct sk_buff *);
 262 extern void usbnet_unlink_rx_urbs(struct usbnet *);
 263
 264 extern void usbnet_pause_rx(struct usbnet *);
 265 extern void usbnet_resume_rx(struct usbnet *);
 266 extern void usbnet_purge_paused_rxq(struct usbnet *);
 267
 268 extern int usbnet_get_link_ksettings(struct net_device *net,
 269                                      struct ethtool_link_ksettings *cmd);
 270 extern int usbnet_set_link_ksettings(struct net_device *net,
 271                                      const struct ethtool_link_ksettings *cmd);
 272 extern u32 usbnet_get_link(struct net_device *net);
 273 extern u32 usbnet_get_msglevel(struct net_device *);
 274 extern void usbnet_set_msglevel(struct net_device *, u32);
 275 extern void usbnet_set_rx_mode(struct net_device *net);
 276 extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
 277 extern int usbnet_nway_reset(struct net_device *net);
 278
 279 extern int usbnet_manage_power(struct usbnet *, int);
 280 extern void usbnet_link_change(struct usbnet *, bool, bool);
 281
 282 extern int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags);
 283 extern void usbnet_status_stop(struct usbnet *dev);
 284
 285 extern void usbnet_update_max_qlen(struct usbnet *dev);
 286
 287 #endif /* __LINUX_USB_USBNET_H */