1 /* $OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $ */
4 * Copyright (c) 2014 genua mbh <info@genua.de>
5 * Copyright (c) 2014 Fixup Software Ltd.
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.
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.
21 * Based on BSD-licensed source modules in the Linux iwlwifi driver,
22 * which were used as the reference documentation for this implementation.
24 * Driver version we are currently based off of is
25 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd)
27 ***********************************************************************
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.
34 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
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.
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.
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,
50 * The full GNU General Public License is included in this distribution
51 * in the file called COPYING.
53 * Contact Information:
54 * Intel Linux Wireless <ilw@linux.intel.com>
55 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
60 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
61 * All rights reserved.
63 * Redistribution and use in source and binary forms, with or without
64 * modification, are permitted provided that the following conditions
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
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.
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.
91 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
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.
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.
105 #include <sys/cdefs.h>
106 __FBSDID("$FreeBSD$");
108 #include "opt_wlan.h"
110 #include <sys/param.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>
127 #include <machine/bus.h>
128 #include <machine/endian.h>
129 #include <machine/resource.h>
131 #include <dev/pci/pcivar.h>
132 #include <dev/pci/pcireg.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>
143 #include <netinet/in.h>
144 #include <netinet/in_systm.h>
145 #include <netinet/if_ether.h>
146 #include <netinet/ip.h>
148 #include <net80211/ieee80211_var.h>
149 #include <net80211/ieee80211_regdomain.h>
150 #include <net80211/ieee80211_ratectl.h>
151 #include <net80211/ieee80211_radiotap.h>
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_util.h>
157 #include <dev/iwm/if_iwm_phy_db.h>
163 * get phy db section: returns a pointer to a phy db section specified by
164 * type and channel group id.
166 static struct iwm_phy_db_entry *
167 iwm_phy_db_get_section(struct iwm_softc *sc,
168 enum iwm_phy_db_section_type type, uint16_t chg_id)
170 struct iwm_phy_db *phy_db = &sc->sc_phy_db;
172 if (type >= IWM_PHY_DB_MAX)
178 case IWM_PHY_DB_CALIB_NCH:
179 return &phy_db->calib_nch;
180 case IWM_PHY_DB_CALIB_CHG_PAPD:
181 if (chg_id >= IWM_NUM_PAPD_CH_GROUPS)
183 return &phy_db->calib_ch_group_papd[chg_id];
184 case IWM_PHY_DB_CALIB_CHG_TXP:
185 if (chg_id >= IWM_NUM_TXP_CH_GROUPS)
187 return &phy_db->calib_ch_group_txp[chg_id];
195 iwm_phy_db_set_section(struct iwm_softc *sc,
196 struct iwm_calib_res_notif_phy_db *phy_db_notif)
198 enum iwm_phy_db_section_type type = le16toh(phy_db_notif->type);
199 uint16_t size = le16toh(phy_db_notif->length);
200 struct iwm_phy_db_entry *entry;
203 if (type == IWM_PHY_DB_CALIB_CHG_PAPD ||
204 type == IWM_PHY_DB_CALIB_CHG_TXP)
205 chg_id = le16toh(*(uint16_t *)phy_db_notif->data);
207 entry = iwm_phy_db_get_section(sc, type, chg_id);
212 free(entry->data, M_DEVBUF);
213 entry->data = malloc(size, M_DEVBUF, M_NOWAIT);
218 memcpy(entry->data, phy_db_notif->data, size);
221 IWM_DPRINTF(sc, IWM_DEBUG_RESET,
222 "%s(%d): [PHYDB]SET: Type %d , Size: %d, data: %p\n",
223 __func__, __LINE__, type, size, entry->data);
229 iwm_is_valid_channel(uint16_t ch_id)
232 (36 <= ch_id && ch_id <= 64 && ch_id % 4 == 0) ||
233 (100 <= ch_id && ch_id <= 140 && ch_id % 4 == 0) ||
234 (145 <= ch_id && ch_id <= 165 && ch_id % 4 == 1))
240 iwm_ch_id_to_ch_index(uint16_t ch_id)
242 if (!iwm_is_valid_channel(ch_id))
248 return (ch_id + 20) / 4;
250 return (ch_id - 12) / 4;
251 return (ch_id - 13) / 4;
256 iwm_channel_id_to_papd(uint16_t ch_id)
258 if (!iwm_is_valid_channel(ch_id))
261 if (1 <= ch_id && ch_id <= 14)
263 if (36 <= ch_id && ch_id <= 64)
265 if (100 <= ch_id && ch_id <= 140)
271 iwm_channel_id_to_txp(struct iwm_softc *sc, uint16_t ch_id)
273 struct iwm_phy_db *phy_db = &sc->sc_phy_db;
274 struct iwm_phy_db_chg_txp *txp_chg;
276 uint8_t ch_index = iwm_ch_id_to_ch_index(ch_id);
278 if (ch_index == 0xff)
281 for (i = 0; i < IWM_NUM_TXP_CH_GROUPS; i++) {
282 txp_chg = (void *)phy_db->calib_ch_group_txp[i].data;
286 * Looking for the first channel group that its max channel is
287 * higher then wanted channel.
289 if (le16toh(txp_chg->max_channel_idx) >= ch_index)
296 iwm_phy_db_get_section_data(struct iwm_softc *sc,
297 uint32_t type, uint8_t **data, uint16_t *size, uint16_t ch_id)
299 struct iwm_phy_db_entry *entry;
300 uint16_t ch_group_id = 0;
302 IWM_DPRINTF(sc, IWM_DEBUG_RESET, "->%s\n", __func__);
303 /* find wanted channel group */
304 if (type == IWM_PHY_DB_CALIB_CHG_PAPD)
305 ch_group_id = iwm_channel_id_to_papd(ch_id);
306 else if (type == IWM_PHY_DB_CALIB_CHG_TXP)
307 ch_group_id = iwm_channel_id_to_txp(sc, ch_id);
309 entry = iwm_phy_db_get_section(sc, type, ch_group_id);
316 IWM_DPRINTF(sc, IWM_DEBUG_RESET,
317 "%s(%d): [PHYDB] GET: Type %d , Size: %d\n",
318 __func__, __LINE__, type, *size);
324 iwm_send_phy_db_cmd(struct iwm_softc *sc, uint16_t type,
325 uint16_t length, void *data)
327 struct iwm_phy_db_cmd phy_db_cmd;
328 struct iwm_host_cmd cmd = {
329 .id = IWM_PHY_DB_CMD,
330 .flags = IWM_CMD_SYNC,
333 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
334 "Sending PHY-DB hcmd of type %d, of length %d\n",
337 /* Set phy db cmd variables */
338 phy_db_cmd.type = le16toh(type);
339 phy_db_cmd.length = le16toh(length);
341 /* Set hcmd variables */
342 cmd.data[0] = &phy_db_cmd;
343 cmd.len[0] = sizeof(struct iwm_phy_db_cmd);
347 return iwm_send_cmd(sc, &cmd);
351 iwm_phy_db_send_all_channel_groups(struct iwm_softc *sc,
352 enum iwm_phy_db_section_type type, uint8_t max_ch_groups)
356 struct iwm_phy_db_entry *entry;
358 /* Send all the channel-specific groups to operational fw */
359 for (i = 0; i < max_ch_groups; i++) {
360 entry = iwm_phy_db_get_section(sc, type, i);
367 /* Send the requested PHY DB section */
368 err = iwm_send_phy_db_cmd(sc, type, entry->size, entry->data);
370 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
371 "%s: Can't SEND phy_db section %d (%d), "
372 "err %d\n", __func__, type, i, err);
377 IWM_DPRINTF(sc, IWM_DEBUG_CMD,
378 "Sent PHY_DB HCMD, type = %d num = %d\n", type, i);
385 iwm_send_phy_db_data(struct iwm_softc *sc)
387 uint8_t *data = NULL;
391 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
392 "%s: Sending phy db data and configuration to runtime image\n",
395 /* Send PHY DB CFG section */
396 err = iwm_phy_db_get_section_data(sc, IWM_PHY_DB_CFG, &data, &size, 0);
398 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
399 "%s: Cannot get Phy DB cfg section, %d\n",
404 err = iwm_send_phy_db_cmd(sc, IWM_PHY_DB_CFG, size, data);
406 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
407 "%s: Cannot send HCMD of Phy DB cfg section, %d\n",
412 err = iwm_phy_db_get_section_data(sc, IWM_PHY_DB_CALIB_NCH,
415 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
416 "%s: Cannot get Phy DB non specific channel section, "
417 "%d\n", __func__, err);
421 err = iwm_send_phy_db_cmd(sc, IWM_PHY_DB_CALIB_NCH, size, data);
423 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
424 "%s: Cannot send HCMD of Phy DB non specific channel "
425 "sect, %d\n", __func__, err);
429 /* Send all the TXP channel specific data */
430 err = iwm_phy_db_send_all_channel_groups(sc,
431 IWM_PHY_DB_CALIB_CHG_PAPD, IWM_NUM_PAPD_CH_GROUPS);
433 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
434 "%s: Cannot send channel specific PAPD groups, %d\n",
439 /* Send all the TXP channel specific data */
440 err = iwm_phy_db_send_all_channel_groups(sc,
441 IWM_PHY_DB_CALIB_CHG_TXP, IWM_NUM_TXP_CH_GROUPS);
443 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
444 "%s: Cannot send channel specific TX power groups, "
445 "%d\n", __func__, err);
449 IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
450 "%s: Finished sending phy db non channel data\n",
456 iwm_phy_db_free_section(struct iwm_softc *sc,
457 enum iwm_phy_db_section_type type, uint16_t chg_id)
459 struct iwm_phy_db_entry *entry =
460 iwm_phy_db_get_section(sc, type, chg_id);
464 if (entry->data != NULL)
465 free(entry->data, M_DEVBUF);
471 iwm_phy_db_free(struct iwm_softc *sc)
475 iwm_phy_db_free_section(sc, IWM_PHY_DB_CFG, 0);
476 iwm_phy_db_free_section(sc, IWM_PHY_DB_CALIB_NCH, 0);
478 for (i = 0; i < IWM_NUM_PAPD_CH_GROUPS; i++)
479 iwm_phy_db_free_section(sc, IWM_PHY_DB_CALIB_CHG_PAPD, i);
481 for (i = 0; i < IWM_NUM_TXP_CH_GROUPS; i++)
482 iwm_phy_db_free_section(sc, IWM_PHY_DB_CALIB_CHG_TXP, i);