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 "opt_wlan.h" 109 110 #include <sys/param.h> 111 #include <sys/bus.h> 112 #include <sys/conf.h> 113 #include <sys/endian.h> 114 #include <sys/firmware.h> 115 #include <sys/kernel.h> 116 #include <sys/malloc.h> 117 #include <sys/mbuf.h> 118 #include <sys/mutex.h> 119 #include <sys/module.h> 120 #include <sys/proc.h> 121 #include <sys/rman.h> 122 #include <sys/socket.h> 123 #include <sys/sockio.h> 124 #include <sys/sysctl.h> 125 #include <sys/linker.h> 126 127 #include <machine/bus.h> 128 #include <machine/endian.h> 129 #include <machine/resource.h> 130 131 #include <dev/pci/pcivar.h> 132 #include <dev/pci/pcireg.h> 133 134 #include <net/bpf.h> 135 136 #include <net/if.h> 137 #include <net/if_var.h> 138 #include <net/if_arp.h> 139 #include <net/if_dl.h> 140 #include <net/if_media.h> 141 #include <net/if_types.h> 142 143 #include <netinet/in.h> 144 #include <netinet/in_systm.h> 145 #include <netinet/if_ether.h> 146 #include <netinet/ip.h> 147 148 #include <net80211/ieee80211_var.h> 149 #include <net80211/ieee80211_regdomain.h> 150 #include <net80211/ieee80211_ratectl.h> 151 #include <net80211/ieee80211_radiotap.h> 152 153 #include <dev/iwm/if_iwmreg.h> 154 #include <dev/iwm/if_iwmvar.h> 155 #include <dev/iwm/if_iwm_debug.h> 156 #include <dev/iwm/if_iwm_binding.h> 157 #include <dev/iwm/if_iwm_util.h> 158 #include <dev/iwm/if_iwm_pcie_trans.h> 159 160 static void 161 iwm_dma_map_mem(void *arg, bus_dma_segment_t *segs, int nsegs, int error) 162 { 163 if (error != 0) 164 return; 165 KASSERT(nsegs <= 2, ("too many DMA segments, %d should be <= 2", 166 nsegs)); 167 if (nsegs > 1) 168 KASSERT(segs[1].ds_addr == segs[0].ds_addr + segs[0].ds_len, 169 ("fragmented DMA memory")); 170 *(bus_addr_t *)arg = segs[0].ds_addr; 171 } 172 173 /* 174 * Send a command to the firmware. We try to implement the Linux 175 * driver interface for the routine. 176 * mostly from if_iwn (iwn_cmd()). 177 * 178 * For now, we always copy the first part and map the second one (if it exists). 179 */ 180 int 181 iwm_send_cmd(struct iwm_softc *sc, struct iwm_host_cmd *hcmd) 182 { 183 struct iwm_tx_ring *ring = &sc->txq[IWM_MVM_CMD_QUEUE]; 184 struct iwm_tfd *desc; 185 struct iwm_tx_data *data; 186 struct iwm_device_cmd *cmd = NULL; 187 bus_addr_t paddr; 188 uint32_t addr_lo; 189 int error = 0, i, paylen, off; 190 int code; 191 int async, wantresp; 192 193 code = hcmd->id; 194 async = hcmd->flags & IWM_CMD_ASYNC; 195 wantresp = hcmd->flags & IWM_CMD_WANT_SKB; 196 197 for (i = 0, paylen = 0; i < nitems(hcmd->len); i++) { 198 paylen += hcmd->len[i]; 199 } 200 201 /* if the command wants an answer, busy sc_cmd_resp */ 202 if (wantresp) { 203 KASSERT(!async, ("invalid async parameter")); 204 while (sc->sc_wantresp != -1) 205 msleep(&sc->sc_wantresp, &sc->sc_mtx, 0, "iwmcmdsl", 0); 206 sc->sc_wantresp = ring->qid << 16 | ring->cur; 207 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 208 "wantresp is %x\n", sc->sc_wantresp); 209 } 210 211 /* 212 * Is the hardware still available? (after e.g. above wait). 213 */ 214 if (sc->sc_flags & IWM_FLAG_STOPPED) { 215 error = ENXIO; 216 goto out; 217 } 218 219 desc = &ring->desc[ring->cur]; 220 data = &ring->data[ring->cur]; 221 222 if (paylen > sizeof(cmd->data)) { 223 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 224 "large command paylen=%u len0=%u\n", 225 paylen, hcmd->len[0]); 226 /* Command is too large */ 227 if (paylen > IWM_MAX_CMD_PAYLOAD_SIZE) { 228 device_printf(sc->sc_dev, 229 "firmware command too long (%zd bytes)\n", 230 paylen + sizeof(cmd->hdr)); 231 error = EINVAL; 232 goto out; 233 } 234 error = bus_dmamem_alloc(ring->data_dmat, (void **)&cmd, 235 BUS_DMA_NOWAIT | BUS_DMA_COHERENT, &data->map); 236 if (error != 0) 237 goto out; 238 error = bus_dmamap_load(ring->data_dmat, data->map, 239 cmd, paylen + sizeof(cmd->hdr), iwm_dma_map_mem, 240 &paddr, BUS_DMA_NOWAIT); 241 if (error != 0) 242 goto out; 243 } else { 244 cmd = &ring->cmd[ring->cur]; 245 paddr = data->cmd_paddr; 246 } 247 248 cmd->hdr.code = code; 249 cmd->hdr.flags = 0; 250 cmd->hdr.qid = ring->qid; 251 cmd->hdr.idx = ring->cur; 252 253 for (i = 0, off = 0; i < nitems(hcmd->data); i++) { 254 if (hcmd->len[i] == 0) 255 continue; 256 memcpy(cmd->data + off, hcmd->data[i], hcmd->len[i]); 257 off += hcmd->len[i]; 258 } 259 KASSERT(off == paylen, ("off %d != paylen %d", off, paylen)); 260 261 /* lo field is not aligned */ 262 addr_lo = htole32((uint32_t)paddr); 263 memcpy(&desc->tbs[0].lo, &addr_lo, sizeof(uint32_t)); 264 desc->tbs[0].hi_n_len = htole16(iwm_get_dma_hi_addr(paddr) 265 | ((sizeof(cmd->hdr) + paylen) << 4)); 266 desc->num_tbs = 1; 267 268 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 269 "%s: iwm_send_cmd 0x%x size=%lu %s\n", 270 __func__, 271 code, 272 (unsigned long) (hcmd->len[0] + hcmd->len[1] + sizeof(cmd->hdr)), 273 async ? " (async)" : ""); 274 275 if (paylen > sizeof(cmd->data)) { 276 bus_dmamap_sync(ring->data_dmat, data->map, 277 BUS_DMASYNC_PREWRITE); 278 } else { 279 bus_dmamap_sync(ring->cmd_dma.tag, ring->cmd_dma.map, 280 BUS_DMASYNC_PREWRITE); 281 } 282 bus_dmamap_sync(ring->desc_dma.tag, ring->desc_dma.map, 283 BUS_DMASYNC_PREWRITE); 284 285 IWM_SETBITS(sc, IWM_CSR_GP_CNTRL, 286 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ); 287 if (!iwm_poll_bit(sc, IWM_CSR_GP_CNTRL, 288 IWM_CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN, 289 (IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY | 290 IWM_CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP), 15000)) { 291 device_printf(sc->sc_dev, 292 "%s: acquiring device failed\n", __func__); 293 error = EBUSY; 294 goto out; 295 } 296 297 #if 0 298 iwm_update_sched(sc, ring->qid, ring->cur, 0, 0); 299 #endif 300 IWM_DPRINTF(sc, IWM_DEBUG_CMD, 301 "sending command 0x%x qid %d, idx %d\n", 302 code, ring->qid, ring->cur); 303 304 /* Kick command ring. */ 305 ring->cur = (ring->cur + 1) % IWM_TX_RING_COUNT; 306 IWM_WRITE(sc, IWM_HBUS_TARG_WRPTR, ring->qid << 8 | ring->cur); 307 308 if (!async) { 309 /* m..m-mmyy-mmyyyy-mym-ym m-my generation */ 310 int generation = sc->sc_generation; 311 error = msleep(desc, &sc->sc_mtx, PCATCH, "iwmcmd", hz); 312 if (error == 0) { 313 /* if hardware is no longer up, return error */ 314 if (generation != sc->sc_generation) { 315 error = ENXIO; 316 } else { 317 hcmd->resp_pkt = (void *)sc->sc_cmd_resp; 318 } 319 } 320 } 321 out: 322 if (cmd && paylen > sizeof(cmd->data)) 323 bus_dmamem_free(ring->data_dmat, cmd, data->map); 324 if (wantresp && error != 0) { 325 iwm_free_resp(sc, hcmd); 326 } 327 328 return error; 329 } 330 331 /* iwlwifi: mvm/utils.c */ 332 int 333 iwm_mvm_send_cmd_pdu(struct iwm_softc *sc, uint8_t id, 334 uint32_t flags, uint16_t len, const void *data) 335 { 336 struct iwm_host_cmd cmd = { 337 .id = id, 338 .len = { len, }, 339 .data = { data, }, 340 .flags = flags, 341 }; 342 343 return iwm_send_cmd(sc, &cmd); 344 } 345 346 /* iwlwifi: mvm/utils.c */ 347 int 348 iwm_mvm_send_cmd_status(struct iwm_softc *sc, 349 struct iwm_host_cmd *cmd, uint32_t *status) 350 { 351 struct iwm_rx_packet *pkt; 352 struct iwm_cmd_response *resp; 353 int error, resp_len; 354 355 KASSERT((cmd->flags & IWM_CMD_WANT_SKB) == 0, 356 ("invalid command")); 357 cmd->flags |= IWM_CMD_SYNC | IWM_CMD_WANT_SKB; 358 359 if ((error = iwm_send_cmd(sc, cmd)) != 0) 360 return error; 361 pkt = cmd->resp_pkt; 362 363 /* Can happen if RFKILL is asserted */ 364 if (!pkt) { 365 error = 0; 366 goto out_free_resp; 367 } 368 369 if (pkt->hdr.flags & IWM_CMD_FAILED_MSK) { 370 error = EIO; 371 goto out_free_resp; 372 } 373 374 resp_len = iwm_rx_packet_payload_len(pkt); 375 if (resp_len != sizeof(*resp)) { 376 error = EIO; 377 goto out_free_resp; 378 } 379 380 resp = (void *)pkt->data; 381 *status = le32toh(resp->status); 382 out_free_resp: 383 iwm_free_resp(sc, cmd); 384 return error; 385 } 386 387 /* iwlwifi/mvm/utils.c */ 388 int 389 iwm_mvm_send_cmd_pdu_status(struct iwm_softc *sc, uint8_t id, 390 uint16_t len, const void *data, uint32_t *status) 391 { 392 struct iwm_host_cmd cmd = { 393 .id = id, 394 .len = { len, }, 395 .data = { data, }, 396 }; 397 398 return iwm_mvm_send_cmd_status(sc, &cmd, status); 399 } 400 401 void 402 iwm_free_resp(struct iwm_softc *sc, struct iwm_host_cmd *hcmd) 403 { 404 KASSERT(sc->sc_wantresp != -1, ("already freed")); 405 KASSERT((hcmd->flags & (IWM_CMD_WANT_SKB|IWM_CMD_SYNC)) 406 == (IWM_CMD_WANT_SKB|IWM_CMD_SYNC), ("invalid flags")); 407 sc->sc_wantresp = -1; 408 wakeup(&sc->sc_wantresp); 409 } 410