sys/dev/netif/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/param.h>
 106 #include <sys/bus.h>
 107 #include <sys/conf.h>
 108 #include <sys/endian.h>
 109 #include <sys/firmware.h>
 110 #include <sys/kernel.h>
 111 #include <sys/malloc.h>
 112 #include <sys/mbuf.h>
 113 #include <sys/rman.h>
 114 #include <sys/sysctl.h>
 115 #include <sys/linker.h>
 116
 117 #include <machine/endian.h>
 118
 119 #include <bus/pci/pcivar.h>
 120 #include <bus/pci/pcireg.h>
 121
 122 #include <net/bpf.h>
 123
 124 #include <net/if.h>
 125 #include <net/if_var.h>
 126 #include <net/if_arp.h>
 127 #include <net/if_dl.h>
 128 #include <net/if_media.h>
 129 #include <net/if_types.h>
 130
 131 #include <netinet/in.h>
 132 #include <netinet/in_systm.h>
 133 #include <netinet/if_ether.h>
 134 #include <netinet/ip.h>
 135
 136 #include <netproto/802_11/ieee80211_var.h>
 137 #include <netproto/802_11/ieee80211_regdomain.h>
 138 #include <netproto/802_11/ieee80211_ratectl.h>
 139 #include <netproto/802_11/ieee80211_radiotap.h>
 140
 141 #include "if_iwmreg.h"
 142 #include "if_iwmvar.h"
 143 #include "if_iwm_debug.h"
 144 #include "if_iwm_util.h"
 145 #include "if_iwm_phy_db.h"
 146
 147 #define CHANNEL_NUM_SIZE        4       /* num of channels in calib_ch size */
 148
 149 struct iwm_phy_db_entry {
 150         uint16_t        size;
 151         uint8_t         *data;
 152 };
 153
 154 /**
 155  * struct iwm_phy_db - stores phy configuration and calibration data.
 156  *
 157  * @cfg: phy configuration.
 158  * @calib_nch: non channel specific calibration data.
 159  * @calib_ch: channel specific calibration data.
 160  * @n_group_papd: number of entries in papd channel group.
 161  * @calib_ch_group_papd: calibration data related to papd channel group.
 162  * @n_group_txp: number of entries in tx power channel group.
 163  * @calib_ch_group_txp: calibration data related to tx power chanel group.
 164  */
 165 struct iwm_phy_db {
 166         struct iwm_phy_db_entry cfg;
 167         struct iwm_phy_db_entry calib_nch;
 168         int n_group_papd;
 169         struct iwm_phy_db_entry *calib_ch_group_papd;
 170         int n_group_txp;
 171         struct iwm_phy_db_entry *calib_ch_group_txp;
 172
 173         struct iwm_softc *sc;
 174 };
 175
 176 struct iwm_phy_db *
 177 iwm_phy_db_init(struct iwm_softc *sc)
 178 {
 179         struct iwm_phy_db *phy_db = kmalloc(sizeof(struct iwm_phy_db),
 180             M_DEVBUF, M_WAITOK | M_ZERO);
 181
 182         if (!phy_db)
 183                 return phy_db;
 184
 185         phy_db->sc = sc;
 186
 187         phy_db->n_group_txp = -1;
 188         phy_db->n_group_papd = -1;
 189
 190         /* TODO: add default values of the phy db. */
 191         return phy_db;
 192 }
 193
 194 /*
 195  * get phy db section: returns a pointer to a phy db section specified by
 196  * type and channel group id.
 197  */
 198 static struct iwm_phy_db_entry *
 199 iwm_phy_db_get_section(struct iwm_phy_db *phy_db,
 200                        enum iwm_phy_db_section_type type,
 201                        uint16_t chg_id)
 202 {
 203         if (!phy_db || type >= IWM_PHY_DB_MAX)
 204                 return NULL;
 205
 206         switch (type) {
 207         case IWM_PHY_DB_CFG:
 208                 return &phy_db->cfg;
 209         case IWM_PHY_DB_CALIB_NCH:
 210                 return &phy_db->calib_nch;
 211         case IWM_PHY_DB_CALIB_CHG_PAPD:
 212                 if (chg_id >= phy_db->n_group_papd)
 213                         return NULL;
 214                 return &phy_db->calib_ch_group_papd[chg_id];
 215         case IWM_PHY_DB_CALIB_CHG_TXP:
 216                 if (chg_id >= phy_db->n_group_txp)
 217                         return NULL;
 218                 return &phy_db->calib_ch_group_txp[chg_id];
 219         default:
 220                 return NULL;
 221         }
 222         return NULL;
 223 }
 224
 225 static void
 226 iwm_phy_db_free_section(struct iwm_phy_db *phy_db,
 227                         enum iwm_phy_db_section_type type, uint16_t chg_id)
 228 {
 229         struct iwm_phy_db_entry *entry =
 230                                 iwm_phy_db_get_section(phy_db, type, chg_id);
 231         if (!entry)
 232                 return;
 233
 234         if (entry->data != NULL)
 235                 kfree(entry->data, M_DEVBUF);
 236         entry->data = NULL;
 237         entry->size = 0;
 238 }
 239
 240 void
 241 iwm_phy_db_free(struct iwm_phy_db *phy_db)
 242 {
 243         int i;
 244
 245         if (!phy_db)
 246                 return;
 247
 248         iwm_phy_db_free_section(phy_db, IWM_PHY_DB_CFG, 0);
 249         iwm_phy_db_free_section(phy_db, IWM_PHY_DB_CALIB_NCH, 0);
 250
 251         for (i = 0; i < phy_db->n_group_papd; i++)
 252                 iwm_phy_db_free_section(phy_db, IWM_PHY_DB_CALIB_CHG_PAPD, i);
 253         if (phy_db->calib_ch_group_papd != NULL)
 254                 kfree(phy_db->calib_ch_group_papd, M_DEVBUF);
 255
 256         for (i = 0; i < phy_db->n_group_txp; i++)
 257                 iwm_phy_db_free_section(phy_db, IWM_PHY_DB_CALIB_CHG_TXP, i);
 258         if (phy_db->calib_ch_group_txp != NULL)
 259                 kfree(phy_db->calib_ch_group_txp, M_DEVBUF);
 260
 261         kfree(phy_db, M_DEVBUF);
 262 }
 263
 264 int
 265 iwm_phy_db_set_section(struct iwm_phy_db *phy_db,
 266                        struct iwm_rx_packet *pkt)
 267 {
 268         struct iwm_calib_res_notif_phy_db *phy_db_notif =
 269                         (struct iwm_calib_res_notif_phy_db *)pkt->data;
 270         enum iwm_phy_db_section_type type = le16toh(phy_db_notif->type);
 271         uint16_t size  = le16toh(phy_db_notif->length);
 272         struct iwm_phy_db_entry *entry;
 273         uint16_t chg_id = 0;
 274
 275         if (!phy_db)
 276                 return EINVAL;
 277
 278         if (type == IWM_PHY_DB_CALIB_CHG_PAPD) {
 279                 chg_id = le16toh(*(uint16_t *)phy_db_notif->data);
 280                 if (phy_db && !phy_db->calib_ch_group_papd) {
 281                         /*
 282                          * Firmware sends the largest index first, so we can use
 283                          * it to know how much we should allocate.
 284                          */
 285                         phy_db->calib_ch_group_papd = kmalloc(
 286                             (chg_id + 1) * sizeof(struct iwm_phy_db_entry),
 287                             M_DEVBUF, M_WAITOK | M_ZERO);
 288                         if (!phy_db->calib_ch_group_papd)
 289                                 return ENOMEM;
 290                         phy_db->n_group_papd = chg_id + 1;
 291                 }
 292         } else if (type == IWM_PHY_DB_CALIB_CHG_TXP) {
 293                 chg_id = le16toh(*(uint16_t *)phy_db_notif->data);
 294                 if (phy_db && !phy_db->calib_ch_group_txp) {
 295                         /*
 296                          * Firmware sends the largest index first, so we can use
 297                          * it to know how much we should allocate.
 298                          */
 299                         phy_db->calib_ch_group_txp = kmalloc(
 300                             (chg_id + 1) * sizeof(struct iwm_phy_db_entry),
 301                             M_DEVBUF, M_WAITOK | M_ZERO);
 302                         if (!phy_db->calib_ch_group_txp)
 303                                 return ENOMEM;
 304                         phy_db->n_group_txp = chg_id + 1;
 305                 }
 306         }
 307
 308         entry = iwm_phy_db_get_section(phy_db, type, chg_id);
 309         if (!entry)
 310                 return EINVAL;
 311
 312         if (entry->data != NULL)
 313                 kfree(entry->data, M_DEVBUF);
 314         entry->data = kmalloc(size, M_DEVBUF, M_WAITOK);
 315         if (!entry->data) {
 316                 entry->size = 0;
 317                 return ENOMEM;
 318         }
 319         memcpy(entry->data, phy_db_notif->data, size);
 320
 321         entry->size = size;
 322
 323         IWM_DPRINTF(phy_db->sc, IWM_DEBUG_RESET,
 324                     "%s(%d): [PHYDB]SET: Type %d , Size: %d\n",
 325                     __func__, __LINE__, type, size);
 326
 327         return 0;
 328 }
 329
 330 static int
 331 is_valid_channel(uint16_t ch_id)
 332 {
 333         if (ch_id <= 14 ||
 334             (36 <= ch_id && ch_id <= 64 && ch_id % 4 == 0) ||
 335             (100 <= ch_id && ch_id <= 140 && ch_id % 4 == 0) ||
 336             (145 <= ch_id && ch_id <= 165 && ch_id % 4 == 1))
 337                 return 1;
 338         return 0;
 339 }
 340
 341 static uint8_t
 342 ch_id_to_ch_index(uint16_t ch_id)
 343 {
 344         if (!is_valid_channel(ch_id))
 345                 return 0xff;
 346
 347         if (ch_id <= 14)
 348                 return ch_id - 1;
 349         if (ch_id <= 64)
 350                 return (ch_id + 20) / 4;
 351         if (ch_id <= 140)
 352                 return (ch_id - 12) / 4;
 353         return (ch_id - 13) / 4;
 354 }
 355
 356
 357 static uint16_t
 358 channel_id_to_papd(uint16_t ch_id)
 359 {
 360         if (!is_valid_channel(ch_id))
 361                 return 0xff;
 362
 363         if (1 <= ch_id && ch_id <= 14)
 364                 return 0;
 365         if (36 <= ch_id && ch_id <= 64)
 366                 return 1;
 367         if (100 <= ch_id && ch_id <= 140)
 368                 return 2;
 369         return 3;
 370 }
 371
 372 static uint16_t
 373 channel_id_to_txp(struct iwm_phy_db *phy_db, uint16_t ch_id)
 374 {
 375         struct iwm_phy_db_chg_txp *txp_chg;
 376         int i;
 377         uint8_t ch_index = ch_id_to_ch_index(ch_id);
 378         if (ch_index == 0xff)
 379                 return 0xff;
 380
 381         for (i = 0; i < phy_db->n_group_txp; i++) {
 382                 txp_chg = (void *)phy_db->calib_ch_group_txp[i].data;
 383                 if (!txp_chg)
 384                         return 0xff;
 385                 /*
 386                  * Looking for the first channel group that its max channel is
 387                  * higher then wanted channel.
 388                  */
 389                 if (le16toh(txp_chg->max_channel_idx) >= ch_index)
 390                         return i;
 391         }
 392         return 0xff;
 393 }
 394
 395 static int
 396 iwm_phy_db_get_section_data(struct iwm_phy_db *phy_db,
 397                            uint32_t type, uint8_t **data, uint16_t *size,
 398                            uint16_t ch_id)
 399 {
 400         struct iwm_phy_db_entry *entry;
 401         uint16_t ch_group_id = 0;
 402
 403         if (!phy_db)
 404                 return EINVAL;
 405
 406         /* find wanted channel group */
 407         if (type == IWM_PHY_DB_CALIB_CHG_PAPD)
 408                 ch_group_id = channel_id_to_papd(ch_id);
 409         else if (type == IWM_PHY_DB_CALIB_CHG_TXP)
 410                 ch_group_id = channel_id_to_txp(phy_db, ch_id);
 411
 412         entry = iwm_phy_db_get_section(phy_db, type, ch_group_id);
 413         if (!entry)
 414                 return EINVAL;
 415
 416         *data = entry->data;
 417         *size = entry->size;
 418
 419         IWM_DPRINTF(phy_db->sc, IWM_DEBUG_RESET,
 420                    "%s(%d): [PHYDB] GET: Type %d , Size: %d\n",
 421                    __func__, __LINE__, type, *size);
 422
 423         return 0;
 424 }
 425
 426 static int
 427 iwm_send_phy_db_cmd(struct iwm_phy_db *phy_db, uint16_t type,
 428                     uint16_t length, void *data)
 429 {
 430         struct iwm_phy_db_cmd phy_db_cmd;
 431         struct iwm_host_cmd cmd = {
 432                 .id = IWM_PHY_DB_CMD,
 433         };
 434
 435         IWM_DPRINTF(phy_db->sc, IWM_DEBUG_RESET,
 436                    "Sending PHY-DB hcmd of type %d, of length %d\n",
 437                    type, length);
 438
 439         /* Set phy db cmd variables */
 440         phy_db_cmd.type = htole16(type);
 441         phy_db_cmd.length = htole16(length);
 442
 443         /* Set hcmd variables */
 444         cmd.data[0] = &phy_db_cmd;
 445         cmd.len[0] = sizeof(struct iwm_phy_db_cmd);
 446         cmd.data[1] = data;
 447         cmd.len[1] = length;
 448 #ifdef notyet
 449         cmd.dataflags[1] = IWM_HCMD_DFL_NOCOPY;
 450 #endif
 451
 452         return iwm_send_cmd(phy_db->sc, &cmd);
 453 }
 454
 455 static int
 456 iwm_phy_db_send_all_channel_groups(struct iwm_phy_db *phy_db,
 457                                    enum iwm_phy_db_section_type type,
 458                                    uint8_t max_ch_groups)
 459 {
 460         uint16_t i;
 461         int err;
 462         struct iwm_phy_db_entry *entry;
 463
 464         /* Send all the channel specific groups to operational fw */
 465         for (i = 0; i < max_ch_groups; i++) {
 466                 entry = iwm_phy_db_get_section(phy_db,
 467                                                type,
 468                                                i);
 469                 if (!entry)
 470                         return EINVAL;
 471
 472                 if (!entry->size)
 473                         continue;
 474
 475                 /* Send the requested PHY DB section */
 476                 err = iwm_send_phy_db_cmd(phy_db,
 477                                           type,
 478                                           entry->size,
 479                                           entry->data);
 480                 if (err) {
 481                         device_printf(phy_db->sc->sc_dev,
 482                                 "Can't SEND phy_db section %d (%d), err %d\n",
 483                                 type, i, err);
 484                         return err;
 485                 }
 486
 487                 IWM_DPRINTF(phy_db->sc, IWM_DEBUG_CMD,
 488                     "Sent PHY_DB HCMD, type = %d num = %d\n", type, i);
 489         }
 490
 491         return 0;
 492 }
 493
 494 int
 495 iwm_send_phy_db_data(struct iwm_phy_db *phy_db)
 496 {
 497         uint8_t *data = NULL;
 498         uint16_t size = 0;
 499         int err;
 500
 501         IWM_DPRINTF(phy_db->sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 502             "%s: Sending phy db data and configuration to runtime image\n",
 503             __func__);
 504
 505         /* Send PHY DB CFG section */
 506         err = iwm_phy_db_get_section_data(phy_db, IWM_PHY_DB_CFG,
 507                                           &data, &size, 0);
 508         if (err) {
 509                 device_printf(phy_db->sc->sc_dev,
 510                     "%s: Cannot get Phy DB cfg section, %d\n",
 511                     __func__, err);
 512                 return err;
 513         }
 514
 515         err = iwm_send_phy_db_cmd(phy_db, IWM_PHY_DB_CFG, size, data);
 516         if (err) {
 517                 device_printf(phy_db->sc->sc_dev,
 518                     "%s: Cannot send HCMD of Phy DB cfg section, %d\n",
 519                     __func__, err);
 520                 return err;
 521         }
 522
 523         err = iwm_phy_db_get_section_data(phy_db, IWM_PHY_DB_CALIB_NCH,
 524             &data, &size, 0);
 525         if (err) {
 526                 device_printf(phy_db->sc->sc_dev,
 527                     "%s: Cannot get Phy DB non specific channel section, "
 528                     "%d\n", __func__, err);
 529                 return err;
 530         }
 531
 532         err = iwm_send_phy_db_cmd(phy_db, IWM_PHY_DB_CALIB_NCH, size, data);
 533         if (err) {
 534                 device_printf(phy_db->sc->sc_dev,
 535                     "%s: Cannot send HCMD of Phy DB non specific channel "
 536                     "sect, %d\n", __func__, err);
 537                 return err;
 538         }
 539
 540         /* Send all the TXP channel specific data */
 541         err = iwm_phy_db_send_all_channel_groups(phy_db,
 542             IWM_PHY_DB_CALIB_CHG_PAPD, phy_db->n_group_papd);
 543         if (err) {
 544                 device_printf(phy_db->sc->sc_dev,
 545                     "%s: Cannot send channel specific PAPD groups, %d\n",
 546                     __func__, err);
 547                 return err;
 548         }
 549
 550         /* Send all the TXP channel specific data */
 551         err = iwm_phy_db_send_all_channel_groups(phy_db,
 552             IWM_PHY_DB_CALIB_CHG_TXP, phy_db->n_group_txp);
 553         if (err) {
 554                 device_printf(phy_db->sc->sc_dev,
 555                     "%s: Cannot send channel specific TX power groups, "
 556                     "%d\n", __func__, err);
 557                 return err;
 558         }
 559
 560         IWM_DPRINTF(phy_db->sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
 561             "%s: Finished sending phy db non channel data\n",
 562             __func__);
 563         return 0;
 564 }