tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
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
20#ifndef __LINUX_USB_RNDIS_HOST_H
21#define __LINUX_USB_RNDIS_HOST_H
22
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;
37 // followed by data that varies between messages
38 __le32 request_id;
39 __le32 status;
40 // ... and more
41} __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
52#define RNDIS_MSG_COMPLETION cpu_to_le32(0x80000000)
53
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 */
58#define RNDIS_MSG_PACKET cpu_to_le32(0x00000001) /* 1-N packets */
59#define RNDIS_MSG_INIT cpu_to_le32(0x00000002)
60#define RNDIS_MSG_INIT_C (RNDIS_MSG_INIT|RNDIS_MSG_COMPLETION)
61#define RNDIS_MSG_HALT cpu_to_le32(0x00000003)
62#define RNDIS_MSG_QUERY cpu_to_le32(0x00000004)
63#define RNDIS_MSG_QUERY_C (RNDIS_MSG_QUERY|RNDIS_MSG_COMPLETION)
64#define RNDIS_MSG_SET cpu_to_le32(0x00000005)
65#define RNDIS_MSG_SET_C (RNDIS_MSG_SET|RNDIS_MSG_COMPLETION)
66#define RNDIS_MSG_RESET cpu_to_le32(0x00000006)
67#define RNDIS_MSG_RESET_C (RNDIS_MSG_RESET|RNDIS_MSG_COMPLETION)
68#define RNDIS_MSG_INDICATE cpu_to_le32(0x00000007)
69#define RNDIS_MSG_KEEPALIVE cpu_to_le32(0x00000008)
70#define RNDIS_MSG_KEEPALIVE_C (RNDIS_MSG_KEEPALIVE|RNDIS_MSG_COMPLETION)
71
72/* codes for "status" field of completion messages */
73#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
80/* codes for OID_GEN_PHYSICAL_MEDIUM */
81#define RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED cpu_to_le32(0x00000000)
82#define RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN cpu_to_le32(0x00000001)
83#define RNDIS_PHYSICAL_MEDIUM_CABLE_MODEM cpu_to_le32(0x00000002)
84#define RNDIS_PHYSICAL_MEDIUM_PHONE_LINE cpu_to_le32(0x00000003)
85#define RNDIS_PHYSICAL_MEDIUM_POWER_LINE cpu_to_le32(0x00000004)
86#define RNDIS_PHYSICAL_MEDIUM_DSL cpu_to_le32(0x00000005)
87#define RNDIS_PHYSICAL_MEDIUM_FIBRE_CHANNEL cpu_to_le32(0x00000006)
88#define RNDIS_PHYSICAL_MEDIUM_1394 cpu_to_le32(0x00000007)
89#define RNDIS_PHYSICAL_MEDIUM_WIRELESS_WAN cpu_to_le32(0x00000008)
90#define RNDIS_PHYSICAL_MEDIUM_MAX cpu_to_le32(0x00000009)
91
92struct rndis_data_hdr {
93 __le32 msg_type; /* RNDIS_MSG_PACKET */
94 __le32 msg_len; // rndis_data_hdr + data_len + pad
95 __le32 data_offset; // 36 -- right after header
96 __le32 data_len; // ... real packet size
97
98 __le32 oob_data_offset; // zero
99 __le32 oob_data_len; // zero
100 __le32 num_oob; // zero
101 __le32 packet_data_offset; // zero
102
103 __le32 packet_data_len; // zero
104 __le32 vc_handle; // zero
105 __le32 reserved; // zero
106} __attribute__ ((packed));
107
108struct rndis_init { /* OUT */
109 // header and:
110 __le32 msg_type; /* RNDIS_MSG_INIT */
111 __le32 msg_len; // 24
112 __le32 request_id;
113 __le32 major_version; // of rndis (1.0)
114 __le32 minor_version;
115 __le32 max_transfer_size;
116} __attribute__ ((packed));
117
118struct rndis_init_c { /* IN */
119 // header and:
120 __le32 msg_type; /* RNDIS_MSG_INIT_C */
121 __le32 msg_len;
122 __le32 request_id;
123 __le32 status;
124 __le32 major_version; // of rndis (1.0)
125 __le32 minor_version;
126 __le32 device_flags;
127 __le32 medium; // zero == 802.3
128 __le32 max_packets_per_message;
129 __le32 max_transfer_size;
130 __le32 packet_alignment; // max 7; (1<<n) bytes
131 __le32 af_list_offset; // zero
132 __le32 af_list_size; // zero
133} __attribute__ ((packed));
134
135struct rndis_halt { /* OUT (no reply) */
136 // header and:
137 __le32 msg_type; /* RNDIS_MSG_HALT */
138 __le32 msg_len;
139 __le32 request_id;
140} __attribute__ ((packed));
141
142struct rndis_query { /* OUT */
143 // header and:
144 __le32 msg_type; /* RNDIS_MSG_QUERY */
145 __le32 msg_len;
146 __le32 request_id;
147 __le32 oid;
148 __le32 len;
149 __le32 offset;
150/*?*/ __le32 handle; // zero
151} __attribute__ ((packed));
152
153struct rndis_query_c { /* IN */
154 // header and:
155 __le32 msg_type; /* RNDIS_MSG_QUERY_C */
156 __le32 msg_len;
157 __le32 request_id;
158 __le32 status;
159 __le32 len;
160 __le32 offset;
161} __attribute__ ((packed));
162
163struct rndis_set { /* OUT */
164 // header and:
165 __le32 msg_type; /* RNDIS_MSG_SET */
166 __le32 msg_len;
167 __le32 request_id;
168 __le32 oid;
169 __le32 len;
170 __le32 offset;
171/*?*/ __le32 handle; // zero
172} __attribute__ ((packed));
173
174struct rndis_set_c { /* IN */
175 // header and:
176 __le32 msg_type; /* RNDIS_MSG_SET_C */
177 __le32 msg_len;
178 __le32 request_id;
179 __le32 status;
180} __attribute__ ((packed));
181
182struct rndis_reset { /* IN */
183 // header and:
184 __le32 msg_type; /* RNDIS_MSG_RESET */
185 __le32 msg_len;
186 __le32 reserved;
187} __attribute__ ((packed));
188
189struct rndis_reset_c { /* OUT */
190 // header and:
191 __le32 msg_type; /* RNDIS_MSG_RESET_C */
192 __le32 msg_len;
193 __le32 status;
194 __le32 addressing_lost;
195} __attribute__ ((packed));
196
197struct rndis_indicate { /* IN (unrequested) */
198 // header and:
199 __le32 msg_type; /* RNDIS_MSG_INDICATE */
200 __le32 msg_len;
201 __le32 status;
202 __le32 length;
203 __le32 offset;
204/**/ __le32 diag_status;
205 __le32 error_offset;
206/**/ __le32 message;
207} __attribute__ ((packed));
208
209struct rndis_keepalive { /* OUT (optionally IN) */
210 // header and:
211 __le32 msg_type; /* RNDIS_MSG_KEEPALIVE */
212 __le32 msg_len;
213 __le32 request_id;
214} __attribute__ ((packed));
215
216struct rndis_keepalive_c { /* IN (optionally OUT) */
217 // header and:
218 __le32 msg_type; /* RNDIS_MSG_KEEPALIVE_C */
219 __le32 msg_len;
220 __le32 request_id;
221 __le32 status;
222} __attribute__ ((packed));
223
224/* NOTE: about 30 OIDs are "mandatory" for peripherals to support ... and
225 * there are gobs more that may optionally be supported. We'll avoid as much
226 * of that mess as possible.
227 */
228#define OID_802_3_PERMANENT_ADDRESS cpu_to_le32(0x01010101)
229#define OID_GEN_MAXIMUM_FRAME_SIZE cpu_to_le32(0x00010106)
230#define OID_GEN_CURRENT_PACKET_FILTER cpu_to_le32(0x0001010e)
231#define OID_GEN_PHYSICAL_MEDIUM cpu_to_le32(0x00010202)
232
233/* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */
234#define RNDIS_PACKET_TYPE_DIRECTED cpu_to_le32(0x00000001)
235#define RNDIS_PACKET_TYPE_MULTICAST cpu_to_le32(0x00000002)
236#define RNDIS_PACKET_TYPE_ALL_MULTICAST cpu_to_le32(0x00000004)
237#define RNDIS_PACKET_TYPE_BROADCAST cpu_to_le32(0x00000008)
238#define RNDIS_PACKET_TYPE_SOURCE_ROUTING cpu_to_le32(0x00000010)
239#define RNDIS_PACKET_TYPE_PROMISCUOUS cpu_to_le32(0x00000020)
240#define RNDIS_PACKET_TYPE_SMT cpu_to_le32(0x00000040)
241#define RNDIS_PACKET_TYPE_ALL_LOCAL cpu_to_le32(0x00000080)
242#define RNDIS_PACKET_TYPE_GROUP cpu_to_le32(0x00001000)
243#define RNDIS_PACKET_TYPE_ALL_FUNCTIONAL cpu_to_le32(0x00002000)
244#define RNDIS_PACKET_TYPE_FUNCTIONAL cpu_to_le32(0x00004000)
245#define RNDIS_PACKET_TYPE_MAC_FRAME cpu_to_le32(0x00008000)
246
247/* default filter used with RNDIS devices */
248#define RNDIS_DEFAULT_FILTER ( \
249 RNDIS_PACKET_TYPE_DIRECTED | \
250 RNDIS_PACKET_TYPE_BROADCAST | \
251 RNDIS_PACKET_TYPE_ALL_MULTICAST | \
252 RNDIS_PACKET_TYPE_PROMISCUOUS)
253
254/* Flags to require specific physical medium type for generic_rndis_bind() */
255#define FLAG_RNDIS_PHYM_NOT_WIRELESS 0x0001
256#define FLAG_RNDIS_PHYM_WIRELESS 0x0002
257
258
259extern void rndis_status(struct usbnet *dev, struct urb *urb);
260extern int
261rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen);
262extern int
263generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags);
264extern void rndis_unbind(struct usbnet *dev, struct usb_interface *intf);
265extern int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb);
266extern struct sk_buff *
267rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags);
268
269#endif /* __LINUX_USB_RNDIS_HOST_H */