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