xref: /freebsd/sys/dev/iwm/if_iwm_time_event.c (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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_pcie_trans.h>
156 #include <dev/iwm/if_iwm_time_event.h>
157 
158 /*
159  * For the high priority TE use a time event type that has similar priority to
160  * the FW's action scan priority.
161  */
162 #define IWM_MVM_ROC_TE_TYPE_NORMAL IWM_TE_P2P_DEVICE_DISCOVERABLE
163 #define IWM_MVM_ROC_TE_TYPE_MGMT_TX IWM_TE_P2P_CLIENT_ASSOC
164 
165 /* used to convert from time event API v2 to v1 */
166 #define IWM_TE_V2_DEP_POLICY_MSK (IWM_TE_V2_DEP_OTHER | IWM_TE_V2_DEP_TSF |\
167 			     IWM_TE_V2_EVENT_SOCIOPATHIC)
168 static inline uint16_t
169 iwm_te_v2_get_notify(uint16_t policy)
170 {
171 	return le16toh(policy) & IWM_TE_V2_NOTIF_MSK;
172 }
173 
174 static inline uint16_t
175 iwm_te_v2_get_dep_policy(uint16_t policy)
176 {
177 	return (le16toh(policy) & IWM_TE_V2_DEP_POLICY_MSK) >>
178 		IWM_TE_V2_PLACEMENT_POS;
179 }
180 
181 static inline uint16_t
182 iwm_te_v2_get_absence(uint16_t policy)
183 {
184 	return (le16toh(policy) & IWM_TE_V2_ABSENCE) >> IWM_TE_V2_ABSENCE_POS;
185 }
186 
187 static void
188 iwm_mvm_te_v2_to_v1(const struct iwm_time_event_cmd_v2 *cmd_v2,
189 	struct iwm_time_event_cmd_v1 *cmd_v1)
190 {
191 	cmd_v1->id_and_color = cmd_v2->id_and_color;
192 	cmd_v1->action = cmd_v2->action;
193 	cmd_v1->id = cmd_v2->id;
194 	cmd_v1->apply_time = cmd_v2->apply_time;
195 	cmd_v1->max_delay = cmd_v2->max_delay;
196 	cmd_v1->depends_on = cmd_v2->depends_on;
197 	cmd_v1->interval = cmd_v2->interval;
198 	cmd_v1->duration = cmd_v2->duration;
199 	if (cmd_v2->repeat == IWM_TE_V2_REPEAT_ENDLESS)
200 		cmd_v1->repeat = htole32(IWM_TE_V1_REPEAT_ENDLESS);
201 	else
202 		cmd_v1->repeat = htole32(cmd_v2->repeat);
203 	cmd_v1->max_frags = htole32(cmd_v2->max_frags);
204 	cmd_v1->interval_reciprocal = 0; /* unused */
205 
206 	cmd_v1->dep_policy = htole32(iwm_te_v2_get_dep_policy(cmd_v2->policy));
207 	cmd_v1->is_present = htole32(!iwm_te_v2_get_absence(cmd_v2->policy));
208 	cmd_v1->notify = htole32(iwm_te_v2_get_notify(cmd_v2->policy));
209 }
210 
211 static int
212 iwm_mvm_send_time_event_cmd(struct iwm_softc *sc,
213 	const struct iwm_time_event_cmd_v2 *cmd)
214 {
215 	struct iwm_time_event_cmd_v1 cmd_v1;
216 
217 	if (sc->sc_capaflags & IWM_UCODE_TLV_FLAGS_TIME_EVENT_API_V2)
218 		return iwm_mvm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD,
219 		    IWM_CMD_SYNC, sizeof(*cmd), cmd);
220 
221 	iwm_mvm_te_v2_to_v1(cmd, &cmd_v1);
222 	return iwm_mvm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, IWM_CMD_SYNC,
223 	    sizeof(cmd_v1), &cmd_v1);
224 }
225 
226 static int
227 iwm_mvm_time_event_send_add(struct iwm_softc *sc, struct iwm_node *in,
228 	void *te_data, struct iwm_time_event_cmd_v2 *te_cmd)
229 {
230 	int ret;
231 
232 	IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
233 	    "Add new TE, duration %d TU\n", le32toh(te_cmd->duration));
234 
235 	ret = iwm_mvm_send_time_event_cmd(sc, te_cmd);
236 	if (ret) {
237 		IWM_DPRINTF(sc, IWM_DEBUG_CMD | IWM_DEBUG_RESET,
238 		    "%s: Couldn't send IWM_TIME_EVENT_CMD: %d\n",
239 		    __func__, ret);
240 	}
241 
242 	return ret;
243 }
244 
245 void
246 iwm_mvm_protect_session(struct iwm_softc *sc, struct iwm_node *in,
247 	uint32_t duration, uint32_t min_duration, uint32_t max_delay)
248 {
249 	struct iwm_time_event_cmd_v2 time_cmd;
250 
251 	memset(&time_cmd, 0, sizeof(time_cmd));
252 
253 	time_cmd.action = htole32(IWM_FW_CTXT_ACTION_ADD);
254 	time_cmd.id_and_color =
255 	    htole32(IWM_FW_CMD_ID_AND_COLOR(IWM_DEFAULT_MACID, IWM_DEFAULT_COLOR));
256 	time_cmd.id = htole32(IWM_TE_BSS_STA_AGGRESSIVE_ASSOC);
257 
258 	time_cmd.apply_time = htole32(iwm_read_prph(sc,
259 	    IWM_DEVICE_SYSTEM_TIME_REG));
260 
261 	time_cmd.max_frags = IWM_TE_V2_FRAG_NONE;
262 	time_cmd.max_delay = htole32(max_delay);
263 	/* TODO: why do we need to interval = bi if it is not periodic? */
264 	time_cmd.interval = htole32(1);
265 	time_cmd.duration = htole32(duration);
266 	time_cmd.repeat = 1;
267 	time_cmd.policy
268 	    = htole32(IWM_TE_V2_NOTIF_HOST_EVENT_START |
269 	        IWM_TE_V2_NOTIF_HOST_EVENT_END);
270 
271 	iwm_mvm_time_event_send_add(sc, in, /*te_data*/NULL, &time_cmd);
272 }
273