1 /* $OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $ */ 2 3 /* 4 * Copyright (c) 2014 genua mbh <info@genua.de> 5 * Copyright (c) 2014 Fixup Software Ltd. 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /*- 21 * Based on BSD-licensed source modules in the Linux iwlwifi driver, 22 * which were used as the reference documentation for this implementation. 23 * 24 * Driver version we are currently based off of is 25 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd) 26 * 27 *********************************************************************** 28 * 29 * This file is provided under a dual BSD/GPLv2 license. When using or 30 * redistributing this file, you may do so under either license. 31 * 32 * GPL LICENSE SUMMARY 33 * 34 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved. 35 * 36 * This program is free software; you can redistribute it and/or modify 37 * it under the terms of version 2 of the GNU General Public License as 38 * published by the Free Software Foundation. 39 * 40 * This program is distributed in the hope that it will be useful, but 41 * WITHOUT ANY WARRANTY; without even the implied warranty of 42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 43 * General Public License for more details. 44 * 45 * You should have received a copy of the GNU General Public License 46 * along with this program; if not, write to the Free Software 47 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 48 * USA 49 * 50 * The full GNU General Public License is included in this distribution 51 * in the file called COPYING. 52 * 53 * Contact Information: 54 * Intel Linux Wireless <ilw@linux.intel.com> 55 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 56 * 57 * 58 * BSD LICENSE 59 * 60 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved. 61 * All rights reserved. 62 * 63 * Redistribution and use in source and binary forms, with or without 64 * modification, are permitted provided that the following conditions 65 * are met: 66 * 67 * * Redistributions of source code must retain the above copyright 68 * notice, this list of conditions and the following disclaimer. 69 * * Redistributions in binary form must reproduce the above copyright 70 * notice, this list of conditions and the following disclaimer in 71 * the documentation and/or other materials provided with the 72 * distribution. 73 * * Neither the name Intel Corporation nor the names of its 74 * contributors may be used to endorse or promote products derived 75 * from this software without specific prior written permission. 76 * 77 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 78 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 79 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 80 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 81 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 82 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 83 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 84 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 85 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 86 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 87 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 88 */ 89 90 /*- 91 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr> 92 * 93 * Permission to use, copy, modify, and distribute this software for any 94 * purpose with or without fee is hereby granted, provided that the above 95 * copyright notice and this permission notice appear in all copies. 96 * 97 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 98 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 99 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 100 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 101 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 102 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 103 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 104 */ 105 #include <sys/cdefs.h> 106 __FBSDID("$FreeBSD$"); 107 108 #include <sys/param.h> 109 #include <sys/bus.h> 110 #include <sys/endian.h> 111 #include <sys/firmware.h> 112 #include <sys/kernel.h> 113 #include <sys/malloc.h> 114 #include <sys/mbuf.h> 115 #include <sys/rman.h> 116 #include <sys/sysctl.h> 117 #include <sys/linker.h> 118 119 #include <machine/endian.h> 120 121 #include <bus/pci/pcivar.h> 122 #include <bus/pci/pcireg.h> 123 124 #include <net/bpf.h> 125 126 #include <net/if.h> 127 #include <net/if_var.h> 128 #include <net/if_arp.h> 129 #include <net/if_dl.h> 130 #include <net/if_media.h> 131 #include <net/if_types.h> 132 133 #include <netinet/in.h> 134 #include <netinet/in_systm.h> 135 #include <netinet/if_ether.h> 136 #include <netinet/ip.h> 137 138 #include <netproto/802_11/ieee80211_var.h> 139 #include <netproto/802_11/ieee80211_regdomain.h> 140 #include <netproto/802_11/ieee80211_ratectl.h> 141 #include <netproto/802_11/ieee80211_radiotap.h> 142 143 #include "if_iwmreg.h" 144 #include "if_iwmvar.h" 145 #include "if_iwm_debug.h" 146 #include "if_iwm_binding.h" 147 #include "if_iwm_util.h" 148 #include "if_iwm_pcie_trans.h" 149 150 /* 151 * Send a command to the firmware. We try to implement the Linux 152 * driver interface for the routine. 153 * mostly from if_iwn (iwn_cmd()). 154 * 155 * For now, we always copy the first part and map the second one (if it exists). 156 */ 157 int 158 iwm_send_cmd(struct iwm_softc *sc, struct iwm_host_cmd *hcmd) 159 { 160 struct iwm_tx_ring *ring = &sc->txq[IWM_MVM_CMD_QUEUE]; 161 struct iwm_tfd *desc; 162 struct iwm_tx_data *txdata = NULL; 163 struct iwm_device_cmd *cmd; 164 struct mbuf *m; 165 bus_dma_segment_t seg; 166 bus_addr_t paddr; 167 uint32_t addr_lo; 168 int error = 0, i, paylen, off; 169 int code; 170 int async, wantresp; 171 int group_id; 172 int nsegs; 173 size_t hdrlen, datasz; 174 uint8_t *data; 175 176 code = hcmd->id; 177 async = hcmd->flags & IWM_CMD_ASYNC; 178 wantresp = hcmd->flags & IWM_CMD_WANT_SKB; 179 data = NULL; 180 181 for (i = 0, paylen = 0; i < nitems(hcmd->len); i++) { 182 paylen += hcmd->len[i]; 183 } 184 185 /* if the command wants an answer, busy sc_cmd_resp */ 186 if (wantresp) { 187 KASSERT(!async, ("invalid async parameter")); 188 while (sc->sc_wantresp != -1) { 189 #if defined(__DragonFly__) 190 lksleep(&sc->sc_wantresp, &sc->sc_lk, 0, "iwmcmdsl", 0); 191 #else 192 msleep(&sc->sc_wantresp, &sc->sc_mtx, 0, "iwmcmdsl", 0); 193 #endif 194 } 195 sc->sc_wantresp = ring->qid << 16 | ring->cur; 196 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 197 "wantresp is %x\n", sc->sc_wantresp); 198 } 199 200 /* 201 * Is the hardware still available? (after e.g. above wait). 202 */ 203 if (sc->sc_flags & IWM_FLAG_STOPPED) { 204 error = ENXIO; 205 goto out; 206 } 207 208 desc = &ring->desc[ring->cur]; 209 txdata = &ring->data[ring->cur]; 210 211 group_id = iwm_cmd_groupid(code); 212 if (group_id != 0) { 213 hdrlen = sizeof(cmd->hdr_wide); 214 datasz = sizeof(cmd->data_wide); 215 } else { 216 hdrlen = sizeof(cmd->hdr); 217 datasz = sizeof(cmd->data); 218 } 219 220 if (paylen > datasz) { 221 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 222 "large command paylen=%u len0=%u\n", 223 paylen, hcmd->len[0]); 224 /* Command is too large */ 225 size_t totlen = hdrlen + paylen; 226 if (paylen > IWM_MAX_CMD_PAYLOAD_SIZE) { 227 device_printf(sc->sc_dev, 228 "firmware command too long (%zd bytes)\n", 229 totlen); 230 error = EINVAL; 231 goto out; 232 } 233 m = m_getjcl(M_NOWAIT, MT_DATA, M_PKTHDR, IWM_RBUF_SIZE); 234 if (m == NULL) { 235 error = ENOBUFS; 236 goto out; 237 } 238 239 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size; 240 #if defined(__DragonFly__) 241 error = bus_dmamap_load_mbuf_segment(ring->data_dmat, 242 txdata->map, m, &seg, 1, &nsegs, BUS_DMA_NOWAIT); 243 #else 244 error = bus_dmamap_load_mbuf_sg(ring->data_dmat, 245 txdata->map, m, &seg, &nsegs, BUS_DMA_NOWAIT); 246 #endif 247 if (error != 0) { 248 device_printf(sc->sc_dev, 249 "%s: can't map mbuf, error %d\n", __func__, error); 250 m_freem(m); 251 goto out; 252 } 253 txdata->m = m; /* mbuf will be freed in iwm_cmd_done() */ 254 cmd = mtod(m, struct iwm_device_cmd *); 255 paddr = seg.ds_addr; 256 } else { 257 cmd = &ring->cmd[ring->cur]; 258 paddr = txdata->cmd_paddr; 259 } 260 261 if (group_id != 0) { 262 cmd->hdr_wide.opcode = iwm_cmd_opcode(code); 263 cmd->hdr_wide.group_id = group_id; 264 cmd->hdr_wide.qid = ring->qid; 265 cmd->hdr_wide.idx = ring->cur; 266 cmd->hdr_wide.length = htole16(paylen); 267 cmd->hdr_wide.version = iwm_cmd_version(code); 268 data = cmd->data_wide; 269 } else { 270 cmd->hdr.code = iwm_cmd_opcode(code); 271 cmd->hdr.flags = 0; 272 cmd->hdr.qid = ring->qid; 273 cmd->hdr.idx = ring->cur; 274 data = cmd->data; 275 } 276 277 for (i = 0, off = 0; i < nitems(hcmd->data); i++) { 278 if (hcmd->len[i] == 0) 279 continue; 280 memcpy(data + off, hcmd->data[i], hcmd->len[i]); 281 off += hcmd->len[i]; 282 } 283 KASSERT(off == paylen, ("off %d != paylen %d", off, paylen)); 284 285 /* lo field is not aligned */ 286 addr_lo = htole32((uint32_t)paddr); 287 memcpy(&desc->tbs[0].lo, &addr_lo, sizeof(uint32_t)); 288 desc->tbs[0].hi_n_len = htole16(iwm_get_dma_hi_addr(paddr) 289 | ((hdrlen + paylen) << 4)); 290 desc->num_tbs = 1; 291 292 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 293 "iwm_send_cmd 0x%x size=%lu %s\n", 294 code, 295 (unsigned long) (hcmd->len[0] + hcmd->len[1] + hdrlen), 296 async ? " (async)" : ""); 297 298 if (paylen > datasz) { 299 bus_dmamap_sync(ring->data_dmat, txdata->map, 300 BUS_DMASYNC_PREWRITE); 301 } else { 302 bus_dmamap_sync(ring->cmd_dma.tag, ring->cmd_dma.map, 303 BUS_DMASYNC_PREWRITE); 304 } 305 bus_dmamap_sync(ring->desc_dma.tag, ring->desc_dma.map, 306 BUS_DMASYNC_PREWRITE); 307 308 error = iwm_pcie_set_cmd_in_flight(sc); 309 if (error) 310 goto out; 311 ring->queued++; 312 313 #if 0 314 iwm_update_sched(sc, ring->qid, ring->cur, 0, 0); 315 #endif 316 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 317 "sending command 0x%x qid %d, idx %d\n", 318 code, ring->qid, ring->cur); 319 320 /* Kick command ring. */ 321 ring->cur = (ring->cur + 1) % IWM_TX_RING_COUNT; 322 IWM_WRITE(sc, IWM_HBUS_TARG_WRPTR, ring->qid << 8 | ring->cur); 323 324 if (!async) { 325 /* m..m-mmyy-mmyyyy-mym-ym m-my generation */ 326 int generation = sc->sc_generation; 327 #if defined(__DragonFly__) 328 error = lksleep(desc, &sc->sc_lk, PCATCH, "iwmcmd", hz); 329 #else 330 error = msleep(desc, &sc->sc_mtx, PCATCH, "iwmcmd", hz); 331 #endif 332 if (error == 0) { 333 /* if hardware is no longer up, return error */ 334 if (generation != sc->sc_generation) { 335 error = ENXIO; 336 } else { 337 hcmd->resp_pkt = (void *)sc->sc_cmd_resp; 338 } 339 } 340 } 341 out: 342 if (wantresp && error != 0) { 343 iwm_free_resp(sc, hcmd); 344 } 345 346 return error; 347 } 348 349 int 350 iwm_mvm_send_cmd_pdu(struct iwm_softc *sc, uint8_t id, 351 uint32_t flags, uint16_t len, const void *data) 352 { 353 struct iwm_host_cmd cmd = { 354 .id = id, 355 .len = { len, }, 356 .data = { data, }, 357 .flags = flags, 358 }; 359 360 return iwm_send_cmd(sc, &cmd); 361 } 362 363 int 364 iwm_mvm_send_cmd_status(struct iwm_softc *sc, 365 struct iwm_host_cmd *cmd, uint32_t *status) 366 { 367 struct iwm_rx_packet *pkt; 368 struct iwm_cmd_response *resp; 369 int error, resp_len; 370 371 KASSERT((cmd->flags & IWM_CMD_WANT_SKB) == 0, 372 ("invalid command")); 373 cmd->flags |= IWM_CMD_SYNC | IWM_CMD_WANT_SKB; 374 375 if ((error = iwm_send_cmd(sc, cmd)) != 0) 376 return error; 377 pkt = cmd->resp_pkt; 378 379 /* Can happen if RFKILL is asserted */ 380 if (!pkt) { 381 error = 0; 382 goto out_free_resp; 383 } 384 385 if (pkt->hdr.flags & IWM_CMD_FAILED_MSK) { 386 error = EIO; 387 goto out_free_resp; 388 } 389 390 resp_len = iwm_rx_packet_payload_len(pkt); 391 if (resp_len != sizeof(*resp)) { 392 error = EIO; 393 goto out_free_resp; 394 } 395 396 resp = (void *)pkt->data; 397 *status = le32toh(resp->status); 398 out_free_resp: 399 iwm_free_resp(sc, cmd); 400 return error; 401 } 402 403 int 404 iwm_mvm_send_cmd_pdu_status(struct iwm_softc *sc, uint8_t id, 405 uint16_t len, const void *data, uint32_t *status) 406 { 407 struct iwm_host_cmd cmd = { 408 .id = id, 409 .len = { len, }, 410 .data = { data, }, 411 }; 412 413 return iwm_mvm_send_cmd_status(sc, &cmd, status); 414 } 415 416 void 417 iwm_free_resp(struct iwm_softc *sc, struct iwm_host_cmd *hcmd) 418 { 419 KASSERT(sc->sc_wantresp != -1, ("already freed")); 420 KASSERT((hcmd->flags & (IWM_CMD_WANT_SKB|IWM_CMD_SYNC)) 421 == (IWM_CMD_WANT_SKB|IWM_CMD_SYNC), ("invalid flags")); 422 sc->sc_wantresp = -1; 423 wakeup(&sc->sc_wantresp); 424 } 425