sys/dev/iwm/if_iwm_phy_db.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/conf.h>
 111 #include <sys/endian.h>
 112 #include <sys/firmware.h>
 113 #include <sys/kernel.h>
 114 #include <sys/malloc.h>
 115 #include <sys/mbuf.h>
 116 #include <sys/mutex.h>
 117 #include <sys/module.h>
 118 #include <sys/proc.h>
 119 #include <sys/rman.h>
 120 #include <sys/socket.h>
 121 #include <sys/sockio.h>
 122 #include <sys/sysctl.h>
 123 #include <sys/linker.h>
 124
 125 #include <machine/bus.h>
 126 #include <machine/endian.h>
 127 #include <machine/resource.h>
 128
 129 #include <dev/pci/pcivar.h>
 130 #include <dev/pci/pcireg.h>
 131
 132 #include <net/bpf.h>
 133
 134 #include <net/if.h>
 135 #include <net/if_var.h>
 136 #include <net/if_arp.h>
 137 #include <net/if_dl.h>
 138 #include <net/if_media.h>
 139 #include <net/if_types.h>
 140
 141 #include <netinet/in.h>
 142 #include <netinet/in_systm.h>
 143 #include <netinet/if_ether.h>
 144 #include <netinet/ip.h>
 145
 146 #include <net80211/ieee80211_var.h>
 147 #include <net80211/ieee80211_regdomain.h>
 148 #include <net80211/ieee80211_ratectl.h>
 149 #include <net80211/ieee80211_radiotap.h>
 150
 151 #include <dev/iwm/if_iwmreg.h>
 152 #include <dev/iwm/if_iwmvar.h>
 153 #include <dev/iwm/if_iwm_debug.h>
 154 #include <dev/iwm/if_iwm_util.h>
 155 #include <dev/iwm/if_iwm_phy_db.h>
 156
 157 /*
 158  * BEGIN iwl-phy-db.c
 159  */
 160 /*
 161  * get phy db section: returns a pointer to a phy db section specified by
 162  * type and channel group id.
 163  */
 164 static struct iwm_phy_db_entry *
 165 iwm_phy_db_get_section(struct iwm_softc *sc,
 166         enum iwm_phy_db_section_type type, uint16_t chg_id)
 167 {
 168         struct iwm_phy_db *phy_db = &sc->sc_phy_db;
 169
 170         if (type >= IWM_PHY_DB_MAX)
 171                 return NULL;
 172
 173         switch (type) {
 174         case IWM_PHY_DB_CFG:
 175                 return &phy_db->cfg;
 176         case IWM_PHY_DB_CALIB_NCH:
 177                 return &phy_db->calib_nch;
 178         case IWM_PHY_DB_CALIB_CHG_PAPD:
 179                 if (chg_id >= IWM_NUM_PAPD_CH_GROUPS)
 180                         return NULL;
 181                 return &phy_db->calib_ch_group_papd[chg_id];
 182         case IWM_PHY_DB_CALIB_CHG_TXP:
 183                 if (chg_id >= IWM_NUM_TXP_CH_GROUPS)
 184                         return NULL;
 185                 return &phy_db->calib_ch_group_txp[chg_id];
 186         default:
 187                 return NULL;
 188         }
 189         return NULL;
 190 }
 191
 192 int
 193 iwm_phy_db_set_section(struct iwm_softc *sc,
 194         struct iwm_calib_res_notif_phy_db *phy_db_notif)
 195 {
 196         enum iwm_phy_db_section_type type = le16toh(phy_db_notif->type);
 197         uint16_t size  = le16toh(phy_db_notif->length);
 198         struct iwm_phy_db_entry *entry;
 199         uint16_t chg_id = 0;
 200
 201         if (type == IWM_PHY_DB_CALIB_CHG_PAPD ||
 202             type == IWM_PHY_DB_CALIB_CHG_TXP)
 203                 chg_id = le16toh(*(uint16_t *)phy_db_notif->data);
 204
 205         entry = iwm_phy_db_get_section(sc, type, chg_id);
 206         if (!entry)
 207                 return EINVAL;
 208
 209         if (entry->data)
 210                 free(entry->data, M_DEVBUF);
 211         entry->data = malloc(size, M_DEVBUF, M_NOWAIT);
 212         if (!entry->data) {
 213                 entry->size = 0;
 214                 return ENOMEM;
 215         }
 216         memcpy(entry->data, phy_db_notif->data, size);
 217         entry->size = size;
 218
 219         IWM_DPRINTF(sc, IWM_DEBUG_RESET,
 220             "%s(%d): [PHYDB]SET: Type %d , Size: %d, data: %p\n",
 221             __func__, __LINE__, type, size, entry->data);
 222
 223         return 0;
 224 }
 225
 226 static int
 227 iwm_is_valid_channel(uint16_t ch_id)
 228 {
 229         if (ch_id <= 14 ||
 230             (36 <= ch_id && ch_id <= 64 && ch_id % 4 == 0) ||
 231             (100 <= ch_id && ch_id <= 140 && ch_id % 4 == 0) ||
 232             (145 <= ch_id && ch_id <= 165 && ch_id % 4 == 1))
 233                 return 1;
 234         return 0;
 235 }
 236
 237 static uint8_t
 238 iwm_ch_id_to_ch_index(uint16_t ch_id)
 239 {
 240         if (!iwm_is_valid_channel(ch_id))
 241                 return 0xff;
 242
 243         if (ch_id <= 14)
 244                 return ch_id - 1;
 245         if (ch_id <= 64)
 246                 return (ch_id + 20) / 4;
 247         if (ch_id <= 140)
 248                 return (ch_id - 12) / 4;
 249         return (ch_id - 13) / 4;
 250 }
 251
 252
 253 static uint16_t
 254 iwm_channel_id_to_papd(uint16_t ch_id)
 255 {
 256         if (!iwm_is_valid_channel(ch_id))
 257                 return 0xff;
 258
 259         if (1 <= ch_id && ch_id <= 14)
 260                 return 0;
 261         if (36 <= ch_id && ch_id <= 64)
 262                 return 1;
 263         if (100 <= ch_id && ch_id <= 140)
 264                 return 2;
 265         return 3;
 266 }
 267
 268 static uint16_t
 269 iwm_channel_id_to_txp(struct iwm_softc *sc, uint16_t ch_id)
 270 {
 271         struct iwm_phy_db *phy_db = &sc->sc_phy_db;
 272         struct iwm_phy_db_chg_txp *txp_chg;
 273         int i;
 274         uint8_t ch_index = iwm_ch_id_to_ch_index(ch_id);
 275
 276         if (ch_index == 0xff)
 277                 return 0xff;
 278
 279         for (i = 0; i < IWM_NUM_TXP_CH_GROUPS; i++) {
 280                 txp_chg = (void *)phy_db->calib_ch_group_txp[i].data;
 281                 if (!txp_chg)
 282                         return 0xff;
 283                 /*
 284                  * Looking for the first channel group that its max channel is
 285                  * higher then wanted channel.
 286                  */
 287                 if (le16toh(txp_chg->max_channel_idx) >= ch_index)
 288                         return i;
 289         }
 290         return 0xff;
 291 }
 292
 293 static int
 294 iwm_phy_db_get_section_data(struct iwm_softc *sc,
 295         uint32_t type, uint8_t **data, uint16_t *size, uint16_t ch_id)
 296 {
 297         struct iwm_phy_db_entry *entry;
 298         uint16_t ch_group_id = 0;
 299
 300         IWM_DPRINTF(sc, IWM_DEBUG_RESET, "->%s\n", __func__);
 301         /* find wanted channel group */
 302         if (type == IWM_PHY_DB_CALIB_CHG_PAPD)
 303                 ch_group_id = iwm_channel_id_to_papd(ch_id);
 304         else if (type == IWM_PHY_DB_CALIB_CHG_TXP)
 305                 ch_group_id = iwm_channel_id_to_txp(sc, ch_id);
 306
 307         entry = iwm_phy_db_get_section(sc, type, ch_group_id);
 308         if (!entry)
 309                 return EINVAL;
 310
 311         *data = entry->data;
 312         *size = entry->size;
 313
 314         IWM_DPRINTF(sc, IWM_DEBUG_RESET,
 315             "%s(%d): [PHYDB] GET: Type %d , Size: %d\n",
 316             __func__, __LINE__, type, *size);
 317
 318         return 0;
 319 }
 320
 321 static int
 322 iwm_send_phy_db_cmd(struct iwm_softc *sc, uint16_t type,
 323         uint16_t length, void *data)
 324 {
 325         struct iwm_phy_db_cmd phy_db_cmd;
 326         struct iwm_host_cmd cmd = {
 327                 .id = IWM_PHY_DB_CMD,
 328                 .flags = IWM_CMD_SYNC,
 329         };
 330
 331         IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 332             "Sending PHY-DB hcmd of type %d, of length %d\n",
 333             type, length);
 334
 335         /* Set phy db cmd variables */
 336         phy_db_cmd.type = le16toh(type);
 337         phy_db_cmd.length = le16toh(length);
 338
 339         /* Set hcmd variables */
 340         cmd.data[0] = &phy_db_cmd;
 341         cmd.len[0] = sizeof(struct iwm_phy_db_cmd);
 342         cmd.data[1] = data;
 343         cmd.len[1] = length;
 344         cmd.dataflags[1] = IWM_HCMD_DFL_NOCOPY;
 345
 346         return iwm_send_cmd(sc, &cmd);
 347 }
 348
 349 static int
 350 iwm_phy_db_send_all_channel_groups(struct iwm_softc *sc,
 351         enum iwm_phy_db_section_type type, uint8_t max_ch_groups)
 352 {
 353         uint16_t i;
 354         int err;
 355         struct iwm_phy_db_entry *entry;
 356
 357         /* Send all the channel-specific groups to operational fw */
 358         for (i = 0; i < max_ch_groups; i++) {
 359                 entry = iwm_phy_db_get_section(sc, type, i);
 360                 if (!entry)
 361                         return EINVAL;
 362
 363                 if (!entry->size)
 364                         continue;
 365
 366                 /* Send the requested PHY DB section */
 367                 err = iwm_send_phy_db_cmd(sc, type, entry->size, entry->data);
 368                 if (err) {
 369                         IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 370                             "%s: Can't SEND phy_db section %d (%d), "
 371                             "err %d\n", __func__, type, i, err);
 372                         return err;
 373                 }
 374
 375                 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
 376                     "Sent PHY_DB HCMD, type = %d num = %d\n", type, i);
 377         }
 378
 379         return 0;
 380 }
 381
 382 int
 383 iwm_send_phy_db_data(struct iwm_softc *sc)
 384 {
 385         uint8_t *data = NULL;
 386         uint16_t size = 0;
 387         int err;
 388
 389         IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 390             "%s: Sending phy db data and configuration to runtime image\n",
 391             __func__);
 392
 393         /* Send PHY DB CFG section */
 394         err = iwm_phy_db_get_section_data(sc, IWM_PHY_DB_CFG, &data, &size, 0);
 395         if (err) {
 396                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 397                     "%s: Cannot get Phy DB cfg section, %d\n",
 398                     __func__, err);
 399                 return err;
 400         }
 401
 402         err = iwm_send_phy_db_cmd(sc, IWM_PHY_DB_CFG, size, data);
 403         if (err) {
 404                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 405                     "%s: Cannot send HCMD of Phy DB cfg section, %d\n",
 406                     __func__, err);
 407                 return err;
 408         }
 409
 410         err = iwm_phy_db_get_section_data(sc, IWM_PHY_DB_CALIB_NCH,
 411             &data, &size, 0);
 412         if (err) {
 413                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 414                     "%s: Cannot get Phy DB non specific channel section, "
 415                     "%d\n", __func__, err);
 416                 return err;
 417         }
 418
 419         err = iwm_send_phy_db_cmd(sc, IWM_PHY_DB_CALIB_NCH, size, data);
 420         if (err) {
 421                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 422                     "%s: Cannot send HCMD of Phy DB non specific channel "
 423                     "sect, %d\n", __func__, err);
 424                 return err;
 425         }
 426
 427         /* Send all the TXP channel specific data */
 428         err = iwm_phy_db_send_all_channel_groups(sc,
 429             IWM_PHY_DB_CALIB_CHG_PAPD, IWM_NUM_PAPD_CH_GROUPS);
 430         if (err) {
 431                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 432                     "%s: Cannot send channel specific PAPD groups, %d\n",
 433                     __func__, err);
 434                 return err;
 435         }
 436
 437         /* Send all the TXP channel specific data */
 438         err = iwm_phy_db_send_all_channel_groups(sc,
 439             IWM_PHY_DB_CALIB_CHG_TXP, IWM_NUM_TXP_CH_GROUPS);
 440         if (err) {
 441                 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 442                     "%s: Cannot send channel specific TX power groups, "
 443                     "%d\n", __func__, err);
 444                 return err;
 445         }
 446
 447         IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 448             "%s: Finished sending phy db non channel data\n",
 449             __func__);
 450         return 0;
 451 }