blob: 88fceb718c779273ce4cf82ffc1faed95c762745 [file] [log] [blame]
Jussi Kivilinna75175792008-01-26 00:51:12 +02001/*
2 * Host Side support for RNDIS Networking Links
3 * Copyright (C) 2005 by David Brownell
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
Robert P. J. Daydda43a02008-03-07 13:45:32 -050020#ifndef __LINUX_USB_RNDIS_HOST_H
21#define __LINUX_USB_RNDIS_HOST_H
Jussi Kivilinna75175792008-01-26 00:51:12 +020022
23/*
24 * CONTROL uses CDC "encapsulated commands" with funky notifications.
25 * - control-out: SEND_ENCAPSULATED
26 * - interrupt-in: RESPONSE_AVAILABLE
27 * - control-in: GET_ENCAPSULATED
28 *
29 * We'll try to ignore the RESPONSE_AVAILABLE notifications.
30 *
31 * REVISIT some RNDIS implementations seem to have curious issues still
32 * to be resolved.
33 */
34struct rndis_msg_hdr {
35 __le32 msg_type; /* RNDIS_MSG_* */
36 __le32 msg_len;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -070037 /* followed by data that varies between messages */
Jussi Kivilinna75175792008-01-26 00:51:12 +020038 __le32 request_id;
39 __le32 status;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -070040 /* ... and more */
Jussi Kivilinna75175792008-01-26 00:51:12 +020041} __attribute__ ((packed));
42
43/* MS-Windows uses this strange size, but RNDIS spec says 1024 minimum */
44#define CONTROL_BUFFER_SIZE 1025
45
46/* RNDIS defines an (absurdly huge) 10 second control timeout,
47 * but ActiveSync seems to use a more usual 5 second timeout
48 * (which matches the USB 2.0 spec).
49 */
50#define RNDIS_CONTROL_TIMEOUT_MS (5 * 1000)
51
Harvey Harrison35c26c22009-02-14 22:56:56 -080052#define RNDIS_MSG_COMPLETION cpu_to_le32(0x80000000)
Jussi Kivilinna75175792008-01-26 00:51:12 +020053
54/* codes for "msg_type" field of rndis messages;
55 * only the data channel uses packet messages (maybe batched);
56 * everything else goes on the control channel.
57 */
Harvey Harrison35c26c22009-02-14 22:56:56 -080058#define RNDIS_MSG_PACKET cpu_to_le32(0x00000001) /* 1-N packets */
59#define RNDIS_MSG_INIT cpu_to_le32(0x00000002)
Jussi Kivilinna75175792008-01-26 00:51:12 +020060#define RNDIS_MSG_INIT_C (RNDIS_MSG_INIT|RNDIS_MSG_COMPLETION)
Harvey Harrison35c26c22009-02-14 22:56:56 -080061#define RNDIS_MSG_HALT cpu_to_le32(0x00000003)
62#define RNDIS_MSG_QUERY cpu_to_le32(0x00000004)
Jussi Kivilinna75175792008-01-26 00:51:12 +020063#define RNDIS_MSG_QUERY_C (RNDIS_MSG_QUERY|RNDIS_MSG_COMPLETION)
Harvey Harrison35c26c22009-02-14 22:56:56 -080064#define RNDIS_MSG_SET cpu_to_le32(0x00000005)
Jussi Kivilinna75175792008-01-26 00:51:12 +020065#define RNDIS_MSG_SET_C (RNDIS_MSG_SET|RNDIS_MSG_COMPLETION)
Harvey Harrison35c26c22009-02-14 22:56:56 -080066#define RNDIS_MSG_RESET cpu_to_le32(0x00000006)
Jussi Kivilinna75175792008-01-26 00:51:12 +020067#define RNDIS_MSG_RESET_C (RNDIS_MSG_RESET|RNDIS_MSG_COMPLETION)
Harvey Harrison35c26c22009-02-14 22:56:56 -080068#define RNDIS_MSG_INDICATE cpu_to_le32(0x00000007)
69#define RNDIS_MSG_KEEPALIVE cpu_to_le32(0x00000008)
Jussi Kivilinna75175792008-01-26 00:51:12 +020070#define RNDIS_MSG_KEEPALIVE_C (RNDIS_MSG_KEEPALIVE|RNDIS_MSG_COMPLETION)
71
72/* codes for "status" field of completion messages */
Jussi Kivilinna030645a2009-07-30 19:41:58 +030073#define RNDIS_STATUS_SUCCESS cpu_to_le32(0x00000000)
74#define RNDIS_STATUS_FAILURE cpu_to_le32(0xc0000001)
75#define RNDIS_STATUS_INVALID_DATA cpu_to_le32(0xc0010015)
76#define RNDIS_STATUS_NOT_SUPPORTED cpu_to_le32(0xc00000bb)
77#define RNDIS_STATUS_MEDIA_CONNECT cpu_to_le32(0x4001000b)
78#define RNDIS_STATUS_MEDIA_DISCONNECT cpu_to_le32(0x4001000c)
79#define RNDIS_STATUS_MEDIA_SPECIFIC_INDICATION cpu_to_le32(0x40010012)
Jussi Kivilinna75175792008-01-26 00:51:12 +020080
Jussi Kivilinna039ee172008-01-27 23:34:33 +020081/* codes for OID_GEN_PHYSICAL_MEDIUM */
Harvey Harrison35c26c22009-02-14 22:56:56 -080082#define RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED cpu_to_le32(0x00000000)
83#define RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN cpu_to_le32(0x00000001)
84#define RNDIS_PHYSICAL_MEDIUM_CABLE_MODEM cpu_to_le32(0x00000002)
85#define RNDIS_PHYSICAL_MEDIUM_PHONE_LINE cpu_to_le32(0x00000003)
86#define RNDIS_PHYSICAL_MEDIUM_POWER_LINE cpu_to_le32(0x00000004)
87#define RNDIS_PHYSICAL_MEDIUM_DSL cpu_to_le32(0x00000005)
88#define RNDIS_PHYSICAL_MEDIUM_FIBRE_CHANNEL cpu_to_le32(0x00000006)
89#define RNDIS_PHYSICAL_MEDIUM_1394 cpu_to_le32(0x00000007)
90#define RNDIS_PHYSICAL_MEDIUM_WIRELESS_WAN cpu_to_le32(0x00000008)
91#define RNDIS_PHYSICAL_MEDIUM_MAX cpu_to_le32(0x00000009)
Jussi Kivilinna75175792008-01-26 00:51:12 +020092
93struct rndis_data_hdr {
94 __le32 msg_type; /* RNDIS_MSG_PACKET */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -070095 __le32 msg_len; /* rndis_data_hdr + data_len + pad */
96 __le32 data_offset; /* 36 -- right after header */
97 __le32 data_len; /* ... real packet size */
Jussi Kivilinna75175792008-01-26 00:51:12 +020098
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -070099 __le32 oob_data_offset; /* zero */
100 __le32 oob_data_len; /* zero */
101 __le32 num_oob; /* zero */
102 __le32 packet_data_offset; /* zero */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200103
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700104 __le32 packet_data_len; /* zero */
105 __le32 vc_handle; /* zero */
106 __le32 reserved; /* zero */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200107} __attribute__ ((packed));
108
109struct rndis_init { /* OUT */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700110 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200111 __le32 msg_type; /* RNDIS_MSG_INIT */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700112 __le32 msg_len; /* 24 */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200113 __le32 request_id;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700114 __le32 major_version; /* of rndis (1.0) */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200115 __le32 minor_version;
116 __le32 max_transfer_size;
117} __attribute__ ((packed));
118
119struct rndis_init_c { /* IN */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700120 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200121 __le32 msg_type; /* RNDIS_MSG_INIT_C */
122 __le32 msg_len;
123 __le32 request_id;
124 __le32 status;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700125 __le32 major_version; /* of rndis (1.0) */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200126 __le32 minor_version;
127 __le32 device_flags;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700128 __le32 medium; /* zero == 802.3 */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200129 __le32 max_packets_per_message;
130 __le32 max_transfer_size;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700131 __le32 packet_alignment; /* max 7; (1<<n) bytes */
132 __le32 af_list_offset; /* zero */
133 __le32 af_list_size; /* zero */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200134} __attribute__ ((packed));
135
136struct rndis_halt { /* OUT (no reply) */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700137 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200138 __le32 msg_type; /* RNDIS_MSG_HALT */
139 __le32 msg_len;
140 __le32 request_id;
141} __attribute__ ((packed));
142
143struct rndis_query { /* OUT */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700144 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200145 __le32 msg_type; /* RNDIS_MSG_QUERY */
146 __le32 msg_len;
147 __le32 request_id;
148 __le32 oid;
149 __le32 len;
150 __le32 offset;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700151/*?*/ __le32 handle; /* zero */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200152} __attribute__ ((packed));
153
154struct rndis_query_c { /* IN */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700155 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200156 __le32 msg_type; /* RNDIS_MSG_QUERY_C */
157 __le32 msg_len;
158 __le32 request_id;
159 __le32 status;
160 __le32 len;
161 __le32 offset;
162} __attribute__ ((packed));
163
164struct rndis_set { /* OUT */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700165 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200166 __le32 msg_type; /* RNDIS_MSG_SET */
167 __le32 msg_len;
168 __le32 request_id;
169 __le32 oid;
170 __le32 len;
171 __le32 offset;
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700172/*?*/ __le32 handle; /* zero */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200173} __attribute__ ((packed));
174
175struct rndis_set_c { /* IN */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700176 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200177 __le32 msg_type; /* RNDIS_MSG_SET_C */
178 __le32 msg_len;
179 __le32 request_id;
180 __le32 status;
181} __attribute__ ((packed));
182
183struct rndis_reset { /* IN */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700184 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200185 __le32 msg_type; /* RNDIS_MSG_RESET */
186 __le32 msg_len;
187 __le32 reserved;
188} __attribute__ ((packed));
189
190struct rndis_reset_c { /* OUT */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700191 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200192 __le32 msg_type; /* RNDIS_MSG_RESET_C */
193 __le32 msg_len;
194 __le32 status;
195 __le32 addressing_lost;
196} __attribute__ ((packed));
197
198struct rndis_indicate { /* IN (unrequested) */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700199 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200200 __le32 msg_type; /* RNDIS_MSG_INDICATE */
201 __le32 msg_len;
202 __le32 status;
203 __le32 length;
204 __le32 offset;
205/**/ __le32 diag_status;
206 __le32 error_offset;
207/**/ __le32 message;
208} __attribute__ ((packed));
209
210struct rndis_keepalive { /* OUT (optionally IN) */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700211 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200212 __le32 msg_type; /* RNDIS_MSG_KEEPALIVE */
213 __le32 msg_len;
214 __le32 request_id;
215} __attribute__ ((packed));
216
217struct rndis_keepalive_c { /* IN (optionally OUT) */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700218 /* header and: */
Jussi Kivilinna75175792008-01-26 00:51:12 +0200219 __le32 msg_type; /* RNDIS_MSG_KEEPALIVE_C */
220 __le32 msg_len;
221 __le32 request_id;
222 __le32 status;
223} __attribute__ ((packed));
224
225/* NOTE: about 30 OIDs are "mandatory" for peripherals to support ... and
226 * there are gobs more that may optionally be supported. We'll avoid as much
227 * of that mess as possible.
228 */
Harvey Harrison35c26c22009-02-14 22:56:56 -0800229#define OID_802_3_PERMANENT_ADDRESS cpu_to_le32(0x01010101)
230#define OID_GEN_MAXIMUM_FRAME_SIZE cpu_to_le32(0x00010106)
231#define OID_GEN_CURRENT_PACKET_FILTER cpu_to_le32(0x0001010e)
232#define OID_GEN_PHYSICAL_MEDIUM cpu_to_le32(0x00010202)
Jussi Kivilinna75175792008-01-26 00:51:12 +0200233
234/* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */
Harvey Harrison35c26c22009-02-14 22:56:56 -0800235#define RNDIS_PACKET_TYPE_DIRECTED cpu_to_le32(0x00000001)
236#define RNDIS_PACKET_TYPE_MULTICAST cpu_to_le32(0x00000002)
237#define RNDIS_PACKET_TYPE_ALL_MULTICAST cpu_to_le32(0x00000004)
238#define RNDIS_PACKET_TYPE_BROADCAST cpu_to_le32(0x00000008)
239#define RNDIS_PACKET_TYPE_SOURCE_ROUTING cpu_to_le32(0x00000010)
240#define RNDIS_PACKET_TYPE_PROMISCUOUS cpu_to_le32(0x00000020)
241#define RNDIS_PACKET_TYPE_SMT cpu_to_le32(0x00000040)
242#define RNDIS_PACKET_TYPE_ALL_LOCAL cpu_to_le32(0x00000080)
243#define RNDIS_PACKET_TYPE_GROUP cpu_to_le32(0x00001000)
244#define RNDIS_PACKET_TYPE_ALL_FUNCTIONAL cpu_to_le32(0x00002000)
245#define RNDIS_PACKET_TYPE_FUNCTIONAL cpu_to_le32(0x00004000)
246#define RNDIS_PACKET_TYPE_MAC_FRAME cpu_to_le32(0x00008000)
Jussi Kivilinna75175792008-01-26 00:51:12 +0200247
248/* default filter used with RNDIS devices */
249#define RNDIS_DEFAULT_FILTER ( \
250 RNDIS_PACKET_TYPE_DIRECTED | \
251 RNDIS_PACKET_TYPE_BROADCAST | \
252 RNDIS_PACKET_TYPE_ALL_MULTICAST | \
253 RNDIS_PACKET_TYPE_PROMISCUOUS)
254
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200255/* Flags to require specific physical medium type for generic_rndis_bind() */
256#define FLAG_RNDIS_PHYM_NOT_WIRELESS 0x0001
257#define FLAG_RNDIS_PHYM_WIRELESS 0x0002
258
Ben Hutchings4d42d412011-04-13 14:48:55 -0700259/* Flags for driver_info::data */
260#define RNDIS_DRIVER_DATA_POLL_STATUS 1 /* poll status before control */
Jussi Kivilinna56659982008-01-26 00:51:17 +0200261
262extern void rndis_status(struct usbnet *dev, struct urb *urb);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300263extern int
264rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen);
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200265extern int
266generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags);
Jussi Kivilinna56659982008-01-26 00:51:17 +0200267extern void rndis_unbind(struct usbnet *dev, struct usb_interface *intf);
268extern int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb);
269extern struct sk_buff *
270rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags);
271
Robert P. J. Daydda43a02008-03-07 13:45:32 -0500272#endif /* __LINUX_USB_RNDIS_HOST_H */