Commit | Line | Data |
---|---|---|
2b3d942c DB |
1 | /* |
2 | * u_ether.h -- interface to USB gadget "ethernet link" utilities | |
3 | * | |
4 | * Copyright (C) 2003-2005,2008 David Brownell | |
5 | * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger | |
6 | * Copyright (C) 2008 Nokia Corporation | |
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 __U_ETHER_H | |
24 | #define __U_ETHER_H | |
25 | ||
26 | #include <linux/err.h> | |
27 | #include <linux/if_ether.h> | |
28 | #include <linux/usb/composite.h> | |
29 | #include <linux/usb/cdc.h> | |
30 | ||
da741b8c DB |
31 | #include "gadget_chips.h" |
32 | ||
33 | ||
2b3d942c DB |
34 | /* |
35 | * This represents the USB side of an "ethernet" link, managed by a USB | |
36 | * function which provides control and (maybe) framing. Two functions | |
45fe3b8e DB |
37 | * in different configurations could share the same ethernet link/netdev, |
38 | * using different host interaction models. | |
2b3d942c | 39 | * |
45fe3b8e DB |
40 | * There is a current limitation that only one instance of this link may |
41 | * be present in any given configuration. When that's a problem, network | |
42 | * layer facilities can be used to package multiple logical links on this | |
43 | * single "physical" one. | |
2b3d942c DB |
44 | */ |
45 | struct gether { | |
46 | struct usb_function func; | |
47 | ||
48 | /* updated by gether_{connect,disconnect} */ | |
49 | struct eth_dev *ioport; | |
50 | ||
51 | /* endpoints handle full and/or high speeds */ | |
52 | struct usb_ep *in_ep; | |
53 | struct usb_ep *out_ep; | |
54 | ||
55 | /* descriptors match device speed at gether_connect() time */ | |
56 | struct usb_endpoint_descriptor *in; | |
57 | struct usb_endpoint_descriptor *out; | |
58 | ||
59 | bool is_zlp_ok; | |
60 | ||
61 | u16 cdc_filter; | |
62 | ||
9b39e9dd | 63 | /* hooks for added framing, as needed for RNDIS and EEM. */ |
2b3d942c | 64 | u32 header_len; |
5c1168db YK |
65 | /* NCM requires fixed size bundles */ |
66 | bool is_fixed; | |
67 | u32 fixed_out_len; | |
68 | u32 fixed_in_len; | |
9b39e9dd BN |
69 | struct sk_buff *(*wrap)(struct gether *port, |
70 | struct sk_buff *skb); | |
71 | int (*unwrap)(struct gether *port, | |
72 | struct sk_buff *skb, | |
73 | struct sk_buff_head *list); | |
2b3d942c DB |
74 | |
75 | /* called on network open/close */ | |
76 | void (*open)(struct gether *); | |
77 | void (*close)(struct gether *); | |
78 | }; | |
79 | ||
80 | #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \ | |
81 | |USB_CDC_PACKET_TYPE_ALL_MULTICAST \ | |
82 | |USB_CDC_PACKET_TYPE_PROMISCUOUS \ | |
83 | |USB_CDC_PACKET_TYPE_DIRECTED) | |
84 | ||
85 | ||
86 | /* netdev setup/teardown as directed by the gadget driver */ | |
87 | int gether_setup(struct usb_gadget *g, u8 ethaddr[ETH_ALEN]); | |
88 | void gether_cleanup(void); | |
89 | ||
90 | /* connect/disconnect is handled by individual functions */ | |
91 | struct net_device *gether_connect(struct gether *); | |
92 | void gether_disconnect(struct gether *); | |
93 | ||
da741b8c DB |
94 | /* Some controllers can't support CDC Ethernet (ECM) ... */ |
95 | static inline bool can_support_ecm(struct usb_gadget *gadget) | |
96 | { | |
97 | if (!gadget_supports_altsettings(gadget)) | |
98 | return false; | |
99 | ||
da741b8c DB |
100 | /* Everything else is *presumably* fine ... but this is a bit |
101 | * chancy, so be **CERTAIN** there are no hardware issues with | |
102 | * your controller. Add it above if it can't handle CDC. | |
103 | */ | |
104 | return true; | |
105 | } | |
106 | ||
8a40819e DB |
107 | /* each configuration may bind one instance of an ethernet link */ |
108 | int geth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]); | |
da741b8c | 109 | int ecm_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]); |
9f6ce424 | 110 | int ncm_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]); |
9b39e9dd | 111 | int eem_bind_config(struct usb_configuration *c); |
8a40819e | 112 | |
396cda90 | 113 | #ifdef USB_ETH_RNDIS |
45fe3b8e DB |
114 | |
115 | int rndis_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]); | |
116 | ||
117 | #else | |
118 | ||
119 | static inline int | |
120 | rndis_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]) | |
121 | { | |
122 | return 0; | |
123 | } | |
124 | ||
125 | #endif | |
126 | ||
2b3d942c | 127 | #endif /* __U_ETHER_H */ |