xref: /dragonfly/sys/dev/netif/iwm/if_iwm_phy_ctxt.c (revision 6ca88057)
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/ethernet.h>
135 #include <net/if_dl.h>
136 #include <net/if_media.h>
137 #include <net/if_types.h>
138 #include <net/ifq_var.h>
139 
140 #include <netinet/in.h>
141 #include <netinet/in_systm.h>
142 #include <netinet/if_ether.h>
143 #include <netinet/ip.h>
144 
145 #include <netproto/802_11/ieee80211_var.h>
146 #include <netproto/802_11/ieee80211_regdomain.h>
147 #include <netproto/802_11/ieee80211_ratectl.h>
148 #include <netproto/802_11/ieee80211_radiotap.h>
149 
150 #include "if_iwmreg.h"
151 #include "if_iwmvar.h"
152 #include "if_iwm_debug.h"
153 #include "if_iwm_util.h"
154 #include "if_iwm_phy_ctxt.h"
155 
156 /*
157  * Construct the generic fields of the PHY context command
158  */
159 static void
160 iwm_mvm_phy_ctxt_cmd_hdr(struct iwm_softc *sc, struct iwm_mvm_phy_ctxt *ctxt,
161 	struct iwm_phy_context_cmd *cmd, uint32_t action, uint32_t apply_time)
162 {
163 	memset(cmd, 0, sizeof(struct iwm_phy_context_cmd));
164 
165 	IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD,
166 	    "%s: id=%d, colour=%d, action=%d, apply_time=%d\n",
167 	    __func__,
168 	    ctxt->id,
169 	    ctxt->color,
170 	    action,
171 	    apply_time);
172 
173 	cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(ctxt->id,
174 	    ctxt->color));
175 	cmd->action = htole32(action);
176 	cmd->apply_time = htole32(apply_time);
177 }
178 
179 /*
180  * Add the phy configuration to the PHY context command
181  */
182 static void
183 iwm_mvm_phy_ctxt_cmd_data(struct iwm_softc *sc,
184 	struct iwm_phy_context_cmd *cmd, struct ieee80211_channel *chan,
185 	uint8_t chains_static, uint8_t chains_dynamic)
186 {
187 	struct ieee80211com *ic = sc->sc_ic;
188 	uint8_t active_cnt, idle_cnt;
189 
190 	IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD,
191 	    "%s: 2ghz=%d, channel=%d, chains static=0x%x, dynamic=0x%x, "
192 	    "rx_ant=0x%x, tx_ant=0x%x\n",
193 	    __func__,
194 	    !! IEEE80211_IS_CHAN_2GHZ(chan),
195 	    ieee80211_chan2ieee(ic, chan),
196 	    chains_static,
197 	    chains_dynamic,
198 	    IWM_FW_VALID_RX_ANT(sc),
199 	    IWM_FW_VALID_TX_ANT(sc));
200 
201 
202 	cmd->ci.band = IEEE80211_IS_CHAN_2GHZ(chan) ?
203 	    IWM_PHY_BAND_24 : IWM_PHY_BAND_5;
204 
205 	cmd->ci.channel = ieee80211_chan2ieee(ic, chan);
206 	cmd->ci.width = IWM_PHY_VHT_CHANNEL_MODE20;
207 	cmd->ci.ctrl_pos = IWM_PHY_VHT_CTRL_POS_1_BELOW;
208 
209 	/* Set rx the chains */
210 	idle_cnt = chains_static;
211 	active_cnt = chains_dynamic;
212 
213 	cmd->rxchain_info = htole32(IWM_FW_VALID_RX_ANT(sc) <<
214 					IWM_PHY_RX_CHAIN_VALID_POS);
215 	cmd->rxchain_info |= htole32(idle_cnt << IWM_PHY_RX_CHAIN_CNT_POS);
216 	cmd->rxchain_info |= htole32(active_cnt <<
217 	    IWM_PHY_RX_CHAIN_MIMO_CNT_POS);
218 
219 	cmd->txchain_info = htole32(IWM_FW_VALID_TX_ANT(sc));
220 }
221 
222 /*
223  * Send a command
224  * only if something in the configuration changed: in case that this is the
225  * first time that the phy configuration is applied or in case that the phy
226  * configuration changed from the previous apply.
227  */
228 static int
229 iwm_mvm_phy_ctxt_apply(struct iwm_softc *sc,
230 	struct iwm_mvm_phy_ctxt *ctxt,
231 	uint8_t chains_static, uint8_t chains_dynamic,
232 	uint32_t action, uint32_t apply_time)
233 {
234 	struct iwm_phy_context_cmd cmd;
235 	int ret;
236 
237 	IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD,
238 	    "%s: called; channel=%p\n",
239 	    __func__,
240 	    ctxt->channel);
241 
242 	/* Set the command header fields */
243 	iwm_mvm_phy_ctxt_cmd_hdr(sc, ctxt, &cmd, action, apply_time);
244 
245 	/* Set the command data */
246 	iwm_mvm_phy_ctxt_cmd_data(sc, &cmd, ctxt->channel,
247 	    chains_static, chains_dynamic);
248 
249 	ret = iwm_mvm_send_cmd_pdu(sc, IWM_PHY_CONTEXT_CMD, IWM_CMD_SYNC,
250 	    sizeof(struct iwm_phy_context_cmd), &cmd);
251 	if (ret) {
252 		device_printf(sc->sc_dev,
253 		    "PHY ctxt cmd error. ret=%d\n", ret);
254 	}
255 	return ret;
256 }
257 
258 /*
259  * Send a command to add a PHY context based on the current HW configuration.
260  */
261 int
262 iwm_mvm_phy_ctxt_add(struct iwm_softc *sc, struct iwm_mvm_phy_ctxt *ctxt,
263 	struct ieee80211_channel *chan,
264 	uint8_t chains_static, uint8_t chains_dynamic)
265 {
266 	ctxt->channel = chan;
267 
268 	IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD,
269 	    "%s: called; channel=%d\n",
270 	    __func__,
271 	    ieee80211_chan2ieee(sc->sc_ic, chan));
272 
273 	return iwm_mvm_phy_ctxt_apply(sc, ctxt,
274 	    chains_static, chains_dynamic, IWM_FW_CTXT_ACTION_ADD, 0);
275 }
276 
277 /*
278  * Send a command to modify the PHY context based on the current HW
279  * configuration. Note that the function does not check that the configuration
280  * changed.
281  */
282 int
283 iwm_mvm_phy_ctxt_changed(struct iwm_softc *sc,
284 	struct iwm_mvm_phy_ctxt *ctxt, struct ieee80211_channel *chan,
285 	uint8_t chains_static, uint8_t chains_dynamic)
286 {
287 	ctxt->channel = chan;
288 
289 	IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD,
290 	    "%s: called; channel=%d\n",
291 	    __func__,
292 	    ieee80211_chan2ieee(sc->sc_ic, chan));
293 
294 	return iwm_mvm_phy_ctxt_apply(sc, ctxt,
295 	    chains_static, chains_dynamic, IWM_FW_CTXT_ACTION_MODIFY, 0);
296 }
297