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