Commit | Line | Data |
---|---|---|
5b435de0 AS |
1 | /* |
2 | * Copyright (c) 2010 Broadcom Corporation | |
3 | * | |
4 | * Permission to use, copy, modify, and/or distribute this software for any | |
5 | * purpose with or without fee is hereby granted, provided that the above | |
6 | * copyright notice and this permission notice appear in all copies. | |
7 | * | |
8 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
9 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
10 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY | |
11 | * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
12 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION | |
13 | * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN | |
14 | * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
15 | */ | |
16 | ||
17 | /******************************************************************************* | |
18 | * Communicates with the dongle by using dcmd codes. | |
19 | * For certain dcmd codes, the dongle interprets string data from the host. | |
20 | ******************************************************************************/ | |
21 | ||
22 | #include <linux/types.h> | |
23 | #include <linux/netdevice.h> | |
5b435de0 AS |
24 | |
25 | #include <brcmu_utils.h> | |
26 | #include <brcmu_wifi.h> | |
27 | ||
28 | #include "dhd.h" | |
5b435de0 | 29 | #include "dhd_bus.h" |
349e7104 | 30 | #include "fwsignal.h" |
5b435de0 | 31 | #include "dhd_dbg.h" |
ea0737d6 | 32 | #include "tracepoint.h" |
85b84133 HM |
33 | #include "proto.h" |
34 | #include "bcdc.h" | |
5b435de0 | 35 | |
aec87ce2 | 36 | struct brcmf_proto_bcdc_dcmd { |
5b435de0 AS |
37 | __le32 cmd; /* dongle command value */ |
38 | __le32 len; /* lower 16: output buflen; | |
39 | * upper 16: input buflen (excludes header) */ | |
40 | __le32 flags; /* flag defns given below */ | |
41 | __le32 status; /* status code returned from the device */ | |
42 | }; | |
43 | ||
aec87ce2 HM |
44 | /* BCDC flag definitions */ |
45 | #define BCDC_DCMD_ERROR 0x01 /* 1=cmd failed */ | |
46 | #define BCDC_DCMD_SET 0x02 /* 0=get, 1=set cmd */ | |
47 | #define BCDC_DCMD_IF_MASK 0xF000 /* I/F index */ | |
48 | #define BCDC_DCMD_IF_SHIFT 12 | |
49 | #define BCDC_DCMD_ID_MASK 0xFFFF0000 /* id an cmd pairing */ | |
50 | #define BCDC_DCMD_ID_SHIFT 16 /* ID Mask shift bits */ | |
51 | #define BCDC_DCMD_ID(flags) \ | |
52 | (((flags) & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT) | |
5b435de0 AS |
53 | |
54 | /* | |
aec87ce2 | 55 | * BCDC header - Broadcom specific extension of CDC. |
5b435de0 AS |
56 | * Used on data packets to convey priority across USB. |
57 | */ | |
aec87ce2 HM |
58 | #define BCDC_HEADER_LEN 4 |
59 | #define BCDC_PROTO_VER 2 /* Protocol version */ | |
60 | #define BCDC_FLAG_VER_MASK 0xf0 /* Protocol version mask */ | |
61 | #define BCDC_FLAG_VER_SHIFT 4 /* Protocol version shift */ | |
62 | #define BCDC_FLAG_SUM_GOOD 0x04 /* Good RX checksums */ | |
63 | #define BCDC_FLAG_SUM_NEEDED 0x08 /* Dongle needs to do TX checksums */ | |
64 | #define BCDC_PRIORITY_MASK 0x7 | |
65 | #define BCDC_FLAG2_IF_MASK 0x0f /* packet rx interface in APSTA */ | |
66 | #define BCDC_FLAG2_IF_SHIFT 0 | |
67 | ||
68 | #define BCDC_GET_IF_IDX(hdr) \ | |
69 | ((int)((((hdr)->flags2) & BCDC_FLAG2_IF_MASK) >> BCDC_FLAG2_IF_SHIFT)) | |
70 | #define BCDC_SET_IF_IDX(hdr, idx) \ | |
71 | ((hdr)->flags2 = (((hdr)->flags2 & ~BCDC_FLAG2_IF_MASK) | \ | |
72 | ((idx) << BCDC_FLAG2_IF_SHIFT))) | |
5b435de0 | 73 | |
bee1b848 | 74 | /** |
aec87ce2 | 75 | * struct brcmf_proto_bcdc_header - BCDC header format |
bee1b848 AS |
76 | * |
77 | * @flags: flags contain protocol and checksum info. | |
78 | * @priority: 802.1d priority and USB flow control info (bit 4:7). | |
79 | * @flags2: additional flags containing dongle interface index. | |
80 | * @data_offset: start of packet data. header is following by firmware signals. | |
81 | */ | |
aec87ce2 | 82 | struct brcmf_proto_bcdc_header { |
5b435de0 | 83 | u8 flags; |
bee1b848 | 84 | u8 priority; |
5b435de0 | 85 | u8 flags2; |
e40aed06 | 86 | u8 data_offset; |
5b435de0 AS |
87 | }; |
88 | ||
bee1b848 AS |
89 | /* |
90 | * maximum length of firmware signal data between | |
aec87ce2 | 91 | * the BCDC header and packet data in the tx path. |
bee1b848 AS |
92 | */ |
93 | #define BRCMF_PROT_FW_SIGNAL_MAX_TXBYTES 12 | |
5b435de0 AS |
94 | |
95 | #define RETRIES 2 /* # of retries to retrieve matching dcmd response */ | |
6e3c7128 | 96 | #define BUS_HEADER_LEN (16+64) /* Must be atleast SDPCM_RESERVE |
5b435de0 AS |
97 | * (amount of header tha might be added) |
98 | * plus any space that might be needed | |
6e3c7128 | 99 | * for bus alignment padding. |
5b435de0 | 100 | */ |
85b84133 | 101 | struct brcmf_bcdc { |
5b435de0 | 102 | u16 reqid; |
5b435de0 | 103 | u8 bus_header[BUS_HEADER_LEN]; |
aec87ce2 | 104 | struct brcmf_proto_bcdc_dcmd msg; |
8141083c | 105 | unsigned char buf[BRCMF_DCMD_MAXLEN]; |
5b435de0 AS |
106 | }; |
107 | ||
8141083c HM |
108 | |
109 | static int | |
110 | brcmf_proto_bcdc_msg(struct brcmf_pub *drvr, int ifidx, uint cmd, void *buf, | |
111 | uint len, bool set) | |
5b435de0 | 112 | { |
85b84133 | 113 | struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd; |
8141083c HM |
114 | struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg; |
115 | u32 flags; | |
5b435de0 | 116 | |
aec87ce2 | 117 | brcmf_dbg(BCDC, "Enter\n"); |
5b435de0 | 118 | |
8141083c HM |
119 | memset(msg, 0, sizeof(struct brcmf_proto_bcdc_dcmd)); |
120 | ||
121 | msg->cmd = cpu_to_le32(cmd); | |
122 | msg->len = cpu_to_le32(len); | |
123 | flags = (++bcdc->reqid << BCDC_DCMD_ID_SHIFT); | |
124 | if (set) | |
125 | flags |= BCDC_DCMD_SET; | |
126 | flags = (flags & ~BCDC_DCMD_IF_MASK) | | |
127 | (ifidx << BCDC_DCMD_IF_SHIFT); | |
128 | msg->flags = cpu_to_le32(flags); | |
129 | ||
130 | if (buf) | |
131 | memcpy(bcdc->buf, buf, len); | |
5b435de0 | 132 | |
d4533992 HM |
133 | len += sizeof(*msg); |
134 | if (len > BRCMF_TX_IOCTL_MAX_MSG_SIZE) | |
135 | len = BRCMF_TX_IOCTL_MAX_MSG_SIZE; | |
136 | ||
5b435de0 | 137 | /* Send request */ |
d4533992 | 138 | return brcmf_bus_txctl(drvr->bus_if, (unsigned char *)&bcdc->msg, len); |
5b435de0 AS |
139 | } |
140 | ||
aec87ce2 | 141 | static int brcmf_proto_bcdc_cmplt(struct brcmf_pub *drvr, u32 id, u32 len) |
5b435de0 AS |
142 | { |
143 | int ret; | |
85b84133 | 144 | struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd; |
5b435de0 | 145 | |
aec87ce2 HM |
146 | brcmf_dbg(BCDC, "Enter\n"); |
147 | len += sizeof(struct brcmf_proto_bcdc_dcmd); | |
5b435de0 | 148 | do { |
85b84133 | 149 | ret = brcmf_bus_rxctl(drvr->bus_if, (unsigned char *)&bcdc->msg, |
d9cb2596 | 150 | len); |
5b435de0 AS |
151 | if (ret < 0) |
152 | break; | |
aec87ce2 | 153 | } while (BCDC_DCMD_ID(le32_to_cpu(bcdc->msg.flags)) != id); |
5b435de0 AS |
154 | |
155 | return ret; | |
156 | } | |
157 | ||
85b84133 HM |
158 | static int |
159 | brcmf_proto_bcdc_query_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd, | |
160 | void *buf, uint len) | |
5b435de0 | 161 | { |
85b84133 | 162 | struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd; |
aec87ce2 | 163 | struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg; |
5b435de0 AS |
164 | void *info; |
165 | int ret = 0, retries = 0; | |
166 | u32 id, flags; | |
167 | ||
aec87ce2 | 168 | brcmf_dbg(BCDC, "Enter, cmd %d len %d\n", cmd, len); |
5b435de0 | 169 | |
8141083c | 170 | ret = brcmf_proto_bcdc_msg(drvr, ifidx, cmd, buf, len, false); |
5b435de0 | 171 | if (ret < 0) { |
aec87ce2 | 172 | brcmf_err("brcmf_proto_bcdc_msg failed w/status %d\n", |
5b435de0 AS |
173 | ret); |
174 | goto done; | |
175 | } | |
176 | ||
177 | retry: | |
178 | /* wait for interrupt and get first fragment */ | |
aec87ce2 | 179 | ret = brcmf_proto_bcdc_cmplt(drvr, bcdc->reqid, len); |
5b435de0 AS |
180 | if (ret < 0) |
181 | goto done; | |
182 | ||
183 | flags = le32_to_cpu(msg->flags); | |
aec87ce2 | 184 | id = (flags & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT; |
5b435de0 | 185 | |
85b84133 | 186 | if ((id < bcdc->reqid) && (++retries < RETRIES)) |
5b435de0 | 187 | goto retry; |
85b84133 | 188 | if (id != bcdc->reqid) { |
5e8149f5 | 189 | brcmf_err("%s: unexpected request id %d (expected %d)\n", |
85b84133 | 190 | brcmf_ifname(drvr, ifidx), id, bcdc->reqid); |
5b435de0 AS |
191 | ret = -EINVAL; |
192 | goto done; | |
193 | } | |
194 | ||
195 | /* Check info buffer */ | |
196 | info = (void *)&msg[1]; | |
197 | ||
198 | /* Copy info buffer */ | |
199 | if (buf) { | |
200 | if (ret < (int)len) | |
201 | len = ret; | |
202 | memcpy(buf, info, len); | |
203 | } | |
204 | ||
205 | /* Check the ERROR flag */ | |
aec87ce2 | 206 | if (flags & BCDC_DCMD_ERROR) |
5b435de0 | 207 | ret = le32_to_cpu(msg->status); |
5b435de0 AS |
208 | |
209 | done: | |
210 | return ret; | |
211 | } | |
212 | ||
85b84133 HM |
213 | static int |
214 | brcmf_proto_bcdc_set_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd, | |
215 | void *buf, uint len) | |
5b435de0 | 216 | { |
85b84133 | 217 | struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd; |
aec87ce2 | 218 | struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg; |
5b435de0 AS |
219 | int ret = 0; |
220 | u32 flags, id; | |
221 | ||
aec87ce2 | 222 | brcmf_dbg(BCDC, "Enter, cmd %d len %d\n", cmd, len); |
5b435de0 | 223 | |
8141083c | 224 | ret = brcmf_proto_bcdc_msg(drvr, ifidx, cmd, buf, len, true); |
5b435de0 AS |
225 | if (ret < 0) |
226 | goto done; | |
227 | ||
aec87ce2 | 228 | ret = brcmf_proto_bcdc_cmplt(drvr, bcdc->reqid, len); |
5b435de0 AS |
229 | if (ret < 0) |
230 | goto done; | |
231 | ||
232 | flags = le32_to_cpu(msg->flags); | |
aec87ce2 | 233 | id = (flags & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT; |
5b435de0 | 234 | |
85b84133 | 235 | if (id != bcdc->reqid) { |
5e8149f5 | 236 | brcmf_err("%s: unexpected request id %d (expected %d)\n", |
85b84133 | 237 | brcmf_ifname(drvr, ifidx), id, bcdc->reqid); |
5b435de0 AS |
238 | ret = -EINVAL; |
239 | goto done; | |
240 | } | |
241 | ||
242 | /* Check the ERROR flag */ | |
aec87ce2 | 243 | if (flags & BCDC_DCMD_ERROR) |
5b435de0 | 244 | ret = le32_to_cpu(msg->status); |
5b435de0 AS |
245 | |
246 | done: | |
247 | return ret; | |
248 | } | |
249 | ||
85b84133 HM |
250 | static void |
251 | brcmf_proto_bcdc_hdrpush(struct brcmf_pub *drvr, int ifidx, u8 offset, | |
5b435de0 AS |
252 | struct sk_buff *pktbuf) |
253 | { | |
aec87ce2 | 254 | struct brcmf_proto_bcdc_header *h; |
5b435de0 | 255 | |
aec87ce2 | 256 | brcmf_dbg(BCDC, "Enter\n"); |
5b435de0 AS |
257 | |
258 | /* Push BDC header used to convey priority for buses that don't */ | |
aec87ce2 | 259 | skb_push(pktbuf, BCDC_HEADER_LEN); |
5b435de0 | 260 | |
aec87ce2 | 261 | h = (struct brcmf_proto_bcdc_header *)(pktbuf->data); |
5b435de0 | 262 | |
aec87ce2 HM |
263 | h->flags = (BCDC_PROTO_VER << BCDC_FLAG_VER_SHIFT); |
264 | if (pktbuf->ip_summed == CHECKSUM_PARTIAL) | |
265 | h->flags |= BCDC_FLAG_SUM_NEEDED; | |
5b435de0 | 266 | |
aec87ce2 | 267 | h->priority = (pktbuf->priority & BCDC_PRIORITY_MASK); |
5b435de0 | 268 | h->flags2 = 0; |
8f0c3b6d | 269 | h->data_offset = offset; |
aec87ce2 HM |
270 | BCDC_SET_IF_IDX(h, ifidx); |
271 | trace_brcmf_bcdchdr(pktbuf->data); | |
5b435de0 AS |
272 | } |
273 | ||
85b84133 HM |
274 | static int |
275 | brcmf_proto_bcdc_hdrpull(struct brcmf_pub *drvr, bool do_fws, u8 *ifidx, | |
276 | struct sk_buff *pktbuf) | |
5b435de0 | 277 | { |
aec87ce2 | 278 | struct brcmf_proto_bcdc_header *h; |
5b435de0 | 279 | |
aec87ce2 | 280 | brcmf_dbg(BCDC, "Enter\n"); |
5b435de0 | 281 | |
aec87ce2 HM |
282 | /* Pop BCDC header used to convey priority for buses that don't */ |
283 | if (pktbuf->len <= BCDC_HEADER_LEN) { | |
5cd02c77 | 284 | brcmf_dbg(INFO, "rx data too short (%d <= %d)\n", |
aec87ce2 | 285 | pktbuf->len, BCDC_HEADER_LEN); |
5b435de0 AS |
286 | return -EBADE; |
287 | } | |
288 | ||
aec87ce2 HM |
289 | trace_brcmf_bcdchdr(pktbuf->data); |
290 | h = (struct brcmf_proto_bcdc_header *)(pktbuf->data); | |
5b435de0 | 291 | |
aec87ce2 | 292 | *ifidx = BCDC_GET_IF_IDX(h); |
5b435de0 | 293 | if (*ifidx >= BRCMF_MAX_IFS) { |
5e8149f5 | 294 | brcmf_err("rx data ifnum out of range (%d)\n", *ifidx); |
5b435de0 AS |
295 | return -EBADE; |
296 | } | |
2880b868 HM |
297 | /* The ifidx is the idx to map to matching netdev/ifp. When receiving |
298 | * events this is easy because it contains the bssidx which maps | |
299 | * 1-on-1 to the netdev/ifp. But for data frames the ifidx is rcvd. | |
300 | * bssidx 1 is used for p2p0 and no data can be received or | |
301 | * transmitted on it. Therefor bssidx is ifidx + 1 if ifidx > 0 | |
302 | */ | |
303 | if (*ifidx) | |
304 | (*ifidx)++; | |
5b435de0 | 305 | |
aec87ce2 HM |
306 | if (((h->flags & BCDC_FLAG_VER_MASK) >> BCDC_FLAG_VER_SHIFT) != |
307 | BCDC_PROTO_VER) { | |
308 | brcmf_err("%s: non-BCDC packet received, flags 0x%x\n", | |
5b435de0 AS |
309 | brcmf_ifname(drvr, *ifidx), h->flags); |
310 | return -EBADE; | |
311 | } | |
312 | ||
aec87ce2 HM |
313 | if (h->flags & BCDC_FLAG_SUM_GOOD) { |
314 | brcmf_dbg(BCDC, "%s: BDC rcv, good checksum, flags 0x%x\n", | |
5b435de0 | 315 | brcmf_ifname(drvr, *ifidx), h->flags); |
aec87ce2 | 316 | pktbuf->ip_summed = CHECKSUM_UNNECESSARY; |
5b435de0 AS |
317 | } |
318 | ||
aec87ce2 | 319 | pktbuf->priority = h->priority & BCDC_PRIORITY_MASK; |
5b435de0 | 320 | |
aec87ce2 | 321 | skb_pull(pktbuf, BCDC_HEADER_LEN); |
349e7104 AS |
322 | if (do_fws) |
323 | brcmf_fws_hdrpull(drvr, *ifidx, h->data_offset << 2, pktbuf); | |
324 | else | |
325 | skb_pull(pktbuf, h->data_offset << 2); | |
5b435de0 | 326 | |
a43af515 AS |
327 | if (pktbuf->len == 0) |
328 | return -ENODATA; | |
5b435de0 AS |
329 | return 0; |
330 | } | |
331 | ||
7b8a466e HM |
332 | static int |
333 | brcmf_proto_bcdc_txdata(struct brcmf_pub *drvr, int ifidx, u8 offset, | |
334 | struct sk_buff *pktbuf) | |
335 | { | |
336 | brcmf_proto_bcdc_hdrpush(drvr, ifidx, offset, pktbuf); | |
337 | return brcmf_bus_txdata(drvr->bus_if, pktbuf); | |
338 | } | |
339 | ||
8851cce0 HM |
340 | static void |
341 | brcmf_proto_bcdc_configure_addr_mode(struct brcmf_pub *drvr, int ifidx, | |
342 | enum proto_addr_mode addr_mode) | |
343 | { | |
344 | } | |
345 | ||
346 | static void | |
347 | brcmf_proto_bcdc_delete_peer(struct brcmf_pub *drvr, int ifidx, | |
348 | u8 peer[ETH_ALEN]) | |
349 | { | |
350 | } | |
7b8a466e | 351 | |
85b84133 | 352 | int brcmf_proto_bcdc_attach(struct brcmf_pub *drvr) |
5b435de0 | 353 | { |
85b84133 | 354 | struct brcmf_bcdc *bcdc; |
5b435de0 | 355 | |
85b84133 HM |
356 | bcdc = kzalloc(sizeof(*bcdc), GFP_ATOMIC); |
357 | if (!bcdc) | |
5b435de0 AS |
358 | goto fail; |
359 | ||
360 | /* ensure that the msg buf directly follows the cdc msg struct */ | |
85b84133 HM |
361 | if ((unsigned long)(&bcdc->msg + 1) != (unsigned long)bcdc->buf) { |
362 | brcmf_err("struct brcmf_proto_bcdc is not correctly defined\n"); | |
5b435de0 AS |
363 | goto fail; |
364 | } | |
365 | ||
85b84133 HM |
366 | drvr->proto->hdrpull = brcmf_proto_bcdc_hdrpull; |
367 | drvr->proto->query_dcmd = brcmf_proto_bcdc_query_dcmd; | |
368 | drvr->proto->set_dcmd = brcmf_proto_bcdc_set_dcmd; | |
7b8a466e | 369 | drvr->proto->txdata = brcmf_proto_bcdc_txdata; |
8851cce0 HM |
370 | drvr->proto->configure_addr_mode = brcmf_proto_bcdc_configure_addr_mode; |
371 | drvr->proto->delete_peer = brcmf_proto_bcdc_delete_peer; | |
85b84133 HM |
372 | drvr->proto->pd = bcdc; |
373 | ||
aec87ce2 | 374 | drvr->hdrlen += BCDC_HEADER_LEN + BRCMF_PROT_FW_SIGNAL_MAX_TXBYTES; |
b01a6b3c | 375 | drvr->bus_if->maxctl = BRCMF_DCMD_MAXLEN + |
8141083c | 376 | sizeof(struct brcmf_proto_bcdc_dcmd); |
5b435de0 AS |
377 | return 0; |
378 | ||
379 | fail: | |
85b84133 | 380 | kfree(bcdc); |
5b435de0 AS |
381 | return -ENOMEM; |
382 | } | |
383 | ||
85b84133 | 384 | void brcmf_proto_bcdc_detach(struct brcmf_pub *drvr) |
5b435de0 | 385 | { |
85b84133 HM |
386 | kfree(drvr->proto->pd); |
387 | drvr->proto->pd = NULL; | |
5b435de0 | 388 | } |