sys/dev/netif/iwm/if_iwm_util.c

   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 /*
 156  * Send a command to the firmware.  We try to implement the Linux
 157  * driver interface for the routine.
 158  * mostly from if_iwn (iwn_cmd()).
 159  *
 160  * For now, we always copy the first part and map the second one (if it exists).
 161  */
 162 int
 163 iwm_send_cmd(struct iwm_softc *sc, struct iwm_host_cmd *hcmd)
 164 {
 165         struct iwm_tx_ring *ring = &sc->txq[IWM_MVM_CMD_QUEUE];
 166         struct iwm_tfd *desc;
 167         struct iwm_tx_data *txdata = NULL;
 168         struct iwm_device_cmd *cmd;
 169         struct mbuf *m;
 170         bus_dma_segment_t seg;
 171         bus_addr_t paddr;
 172         uint32_t addr_lo;
 173         int error = 0, i, paylen, off;
 174         int code;
 175         int async, wantresp;
 176         int group_id;
 177         int nsegs;
 178         size_t hdrlen, datasz;
 179         uint8_t *data;
 180
 181         code = hcmd->id;
 182         async = hcmd->flags & IWM_CMD_ASYNC;
 183         wantresp = hcmd->flags & IWM_CMD_WANT_SKB;
 184         data = NULL;
 185
 186         for (i = 0, paylen = 0; i < nitems(hcmd->len); i++) {
 187                 paylen += hcmd->len[i];
 188         }
 189
 190         /* if the command wants an answer, busy sc_cmd_resp */
 191         if (wantresp) {
 192                 KASSERT(!async, ("invalid async parameter"));
 193                 while (sc->sc_wantresp != -1) {
 194 #if defined(__DragonFly__)
 195                         lksleep(&sc->sc_wantresp, &sc->sc_lk, 0, "iwmcmdsl", 0);
 196 #else
 197                         msleep(&sc->sc_wantresp, &sc->sc_mtx, 0, "iwmcmdsl", 0);
 198 #endif
 199                 }
 200                 sc->sc_wantresp = ring->qid << 16 | ring->cur;
 201                 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 202                     "wantresp is %x\n", sc->sc_wantresp);
 203         }
 204
 205         /*
 206          * Is the hardware still available?  (after e.g. above wait).
 207          */
 208         if (sc->sc_flags & IWM_FLAG_STOPPED) {
 209                 error = ENXIO;
 210                 goto out;
 211         }
 212
 213         desc = &ring->desc[ring->cur];
 214         txdata = &ring->data[ring->cur];
 215
 216         group_id = iwm_cmd_groupid(code);
 217         if (group_id != 0) {
 218                 hdrlen = sizeof(cmd->hdr_wide);
 219                 datasz = sizeof(cmd->data_wide);
 220         } else {
 221                 hdrlen = sizeof(cmd->hdr);
 222                 datasz = sizeof(cmd->data);
 223         }
 224
 225         if (paylen > datasz) {
 226                 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 227                     "large command paylen=%u len0=%u\n",
 228                         paylen, hcmd->len[0]);
 229                 /* Command is too large */
 230                 size_t totlen = hdrlen + paylen;
 231                 if (paylen > IWM_MAX_CMD_PAYLOAD_SIZE) {
 232                         device_printf(sc->sc_dev,
 233                             "firmware command too long (%zd bytes)\n",
 234                             totlen);
 235                         error = EINVAL;
 236                         goto out;
 237                 }
 238                 m = m_getjcl(M_NOWAIT, MT_DATA, M_PKTHDR, IWM_RBUF_SIZE);
 239                 if (m == NULL) {
 240                         error = ENOBUFS;
 241                         goto out;
 242                 }
 243
 244                 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
 245 #if defined(__DragonFly__)
 246                 error = bus_dmamap_load_mbuf_segment(ring->data_dmat,
 247                     txdata->map, m, &seg, 1, &nsegs, BUS_DMA_NOWAIT);
 248 #else
 249                 error = bus_dmamap_load_mbuf_sg(ring->data_dmat,
 250                     txdata->map, m, &seg, &nsegs, BUS_DMA_NOWAIT);
 251 #endif
 252                 if (error != 0) {
 253                         device_printf(sc->sc_dev,
 254                             "%s: can't map mbuf, error %d\n", __func__, error);
 255                         m_freem(m);
 256                         goto out;
 257                 }
 258                 txdata->m = m; /* mbuf will be freed in iwm_cmd_done() */
 259                 cmd = mtod(m, struct iwm_device_cmd *);
 260                 paddr = seg.ds_addr;
 261         } else {
 262                 cmd = &ring->cmd[ring->cur];
 263                 paddr = txdata->cmd_paddr;
 264         }
 265
 266         if (group_id != 0) {
 267                 cmd->hdr_wide.opcode = iwm_cmd_opcode(code);
 268                 cmd->hdr_wide.group_id = group_id;
 269                 cmd->hdr_wide.qid = ring->qid;
 270                 cmd->hdr_wide.idx = ring->cur;
 271                 cmd->hdr_wide.length = htole16(paylen);
 272                 cmd->hdr_wide.version = iwm_cmd_version(code);
 273                 data = cmd->data_wide;
 274         } else {
 275                 cmd->hdr.code = iwm_cmd_opcode(code);
 276                 cmd->hdr.flags = 0;
 277                 cmd->hdr.qid = ring->qid;
 278                 cmd->hdr.idx = ring->cur;
 279                 data = cmd->data;
 280         }
 281
 282         for (i = 0, off = 0; i < nitems(hcmd->data); i++) {
 283                 if (hcmd->len[i] == 0)
 284                         continue;
 285                 memcpy(data + off, hcmd->data[i], hcmd->len[i]);
 286                 off += hcmd->len[i];
 287         }
 288         KASSERT(off == paylen, ("off %d != paylen %d", off, paylen));
 289
 290         /* lo field is not aligned */
 291         addr_lo = htole32((uint32_t)paddr);
 292         memcpy(&desc->tbs[0].lo, &addr_lo, sizeof(uint32_t));
 293         desc->tbs[0].hi_n_len  = htole16(iwm_get_dma_hi_addr(paddr)
 294             | ((hdrlen + paylen) << 4));
 295         desc->num_tbs = 1;
 296
 297         IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 298             "iwm_send_cmd 0x%x size=%lu %s\n",
 299             code,
 300             (unsigned long) (hcmd->len[0] + hcmd->len[1] + hdrlen),
 301             async ? " (async)" : "");
 302
 303         if (paylen > datasz) {
 304                 bus_dmamap_sync(ring->data_dmat, txdata->map,
 305                     BUS_DMASYNC_PREWRITE);
 306         } else {
 307                 bus_dmamap_sync(ring->cmd_dma.tag, ring->cmd_dma.map,
 308                     BUS_DMASYNC_PREWRITE);
 309         }
 310         bus_dmamap_sync(ring->desc_dma.tag, ring->desc_dma.map,
 311             BUS_DMASYNC_PREWRITE);
 312
 313         IWM_SETBITS(sc, IWM_CSR_GP_CNTRL,
 314             IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
 315         if (!iwm_poll_bit(sc, IWM_CSR_GP_CNTRL,
 316             IWM_CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN,
 317             (IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY |
 318              IWM_CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP), 15000)) {
 319                 device_printf(sc->sc_dev,
 320                     "%s: acquiring device failed\n", __func__);
 321                 error = EBUSY;
 322                 goto out;
 323         }
 324
 325 #if 0
 326         iwm_update_sched(sc, ring->qid, ring->cur, 0, 0);
 327 #endif
 328         IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 329             "sending command 0x%x qid %d, idx %d\n",
 330             code, ring->qid, ring->cur);
 331
 332         /* Kick command ring. */
 333         ring->cur = (ring->cur + 1) % IWM_TX_RING_COUNT;
 334         IWM_WRITE(sc, IWM_HBUS_TARG_WRPTR, ring->qid << 8 | ring->cur);
 335
 336         if (!async) {
 337                 /* m..m-mmyy-mmyyyy-mym-ym m-my generation */
 338                 int generation = sc->sc_generation;
 339 #if defined(__DragonFly__)
 340                 error = lksleep(desc, &sc->sc_lk, PCATCH, "iwmcmd", hz);
 341 #else
 342                 error = msleep(desc, &sc->sc_mtx, PCATCH, "iwmcmd", hz);
 343 #endif
 344                 if (error == 0) {
 345                         /* if hardware is no longer up, return error */
 346                         if (generation != sc->sc_generation) {
 347                                 error = ENXIO;
 348                         } else {
 349                                 hcmd->resp_pkt = (void *)sc->sc_cmd_resp;
 350                         }
 351                 }
 352         }
 353  out:
 354         if (wantresp && error != 0) {
 355                 iwm_free_resp(sc, hcmd);
 356         }
 357
 358         return error;
 359 }
 360
 361 int
 362 iwm_mvm_send_cmd_pdu(struct iwm_softc *sc, uint8_t id,
 363         uint32_t flags, uint16_t len, const void *data)
 364 {
 365         struct iwm_host_cmd cmd = {
 366                 .id = id,
 367                 .len = { len, },
 368                 .data = { data, },
 369                 .flags = flags,
 370         };
 371
 372         return iwm_send_cmd(sc, &cmd);
 373 }
 374
 375 int
 376 iwm_mvm_send_cmd_status(struct iwm_softc *sc,
 377         struct iwm_host_cmd *cmd, uint32_t *status)
 378 {
 379         struct iwm_rx_packet *pkt;
 380         struct iwm_cmd_response *resp;
 381         int error, resp_len;
 382
 383         KASSERT((cmd->flags & IWM_CMD_WANT_SKB) == 0,
 384             ("invalid command"));
 385         cmd->flags |= IWM_CMD_SYNC | IWM_CMD_WANT_SKB;
 386
 387         if ((error = iwm_send_cmd(sc, cmd)) != 0)
 388                 return error;
 389         pkt = cmd->resp_pkt;
 390
 391         /* Can happen if RFKILL is asserted */
 392         if (!pkt) {
 393                 error = 0;
 394                 goto out_free_resp;
 395         }
 396
 397         if (pkt->hdr.flags & IWM_CMD_FAILED_MSK) {
 398                 error = EIO;
 399                 goto out_free_resp;
 400         }
 401
 402         resp_len = iwm_rx_packet_payload_len(pkt);
 403         if (resp_len != sizeof(*resp)) {
 404                 error = EIO;
 405                 goto out_free_resp;
 406         }
 407
 408         resp = (void *)pkt->data;
 409         *status = le32toh(resp->status);
 410  out_free_resp:
 411         iwm_free_resp(sc, cmd);
 412         return error;
 413 }
 414
 415 int
 416 iwm_mvm_send_cmd_pdu_status(struct iwm_softc *sc, uint8_t id,
 417         uint16_t len, const void *data, uint32_t *status)
 418 {
 419         struct iwm_host_cmd cmd = {
 420                 .id = id,
 421                 .len = { len, },
 422                 .data = { data, },
 423         };
 424
 425         return iwm_mvm_send_cmd_status(sc, &cmd, status);
 426 }
 427
 428 void
 429 iwm_free_resp(struct iwm_softc *sc, struct iwm_host_cmd *hcmd)
 430 {
 431         KASSERT(sc->sc_wantresp != -1, ("already freed"));
 432         KASSERT((hcmd->flags & (IWM_CMD_WANT_SKB|IWM_CMD_SYNC))
 433             == (IWM_CMD_WANT_SKB|IWM_CMD_SYNC), ("invalid flags"));
 434         sc->sc_wantresp = -1;
 435         wakeup(&sc->sc_wantresp);
 436 }
 437
 438 uint8_t
 439 iwm_fw_valid_tx_ant(struct iwm_softc *sc)
 440 {
 441         uint8_t tx_ant;
 442
 443         tx_ant = ((sc->sc_fw_phy_config & IWM_FW_PHY_CFG_TX_CHAIN)
 444             >> IWM_FW_PHY_CFG_TX_CHAIN_POS);
 445
 446         if (sc->sc_nvm.valid_tx_ant)
 447                 tx_ant &= sc->sc_nvm.valid_tx_ant;
 448
 449         return tx_ant;
 450 }
 451
 452 uint8_t
 453 iwm_fw_valid_rx_ant(struct iwm_softc *sc)
 454 {
 455         uint8_t rx_ant;
 456
 457         rx_ant = ((sc->sc_fw_phy_config & IWM_FW_PHY_CFG_RX_CHAIN)
 458             >> IWM_FW_PHY_CFG_RX_CHAIN_POS);
 459
 460         if (sc->sc_nvm.valid_rx_ant)
 461                 rx_ant &= sc->sc_nvm.valid_rx_ant;
 462
 463         return rx_ant;
 464 }