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