~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/usb/usbnet.h

Version: ~ [ linux-5.4-rc3 ] ~ [ linux-5.3.6 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.79 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.149 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.196 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.196 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.75 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp