1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
10  * Copyright(c) 2016        Intel Deutschland GmbH
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of version 2 of the GNU General Public License as
14  * published by the Free Software Foundation.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24  * USA
25  *
26  * The full GNU General Public License is included in this distribution
27  * in the file called COPYING.
28  *
29  * Contact Information:
30  *  Intel Linux Wireless <linuxwifi@intel.com>
31  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
32  *
33  * BSD LICENSE
34  *
35  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
36  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
37  * Copyright(c) 2016        Intel Deutschland GmbH
38  * All rights reserved.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  *
44  *  * Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  *  * Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in
48  *    the documentation and/or other materials provided with the
49  *    distribution.
50  *  * Neither the name Intel Corporation nor the names of its
51  *    contributors may be used to endorse or promote products derived
52  *    from this software without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65  *
66  *****************************************************************************/
67 
68 #include <net/mac80211.h>
69 #include "fw-api.h"
70 #include "mvm.h"
71 
72 #define QUOTA_100	IWL_MVM_MAX_QUOTA
73 #define QUOTA_LOWLAT_MIN ((QUOTA_100 * IWL_MVM_LOWLAT_QUOTA_MIN_PERCENT) / 100)
74 
75 struct iwl_mvm_quota_iterator_data {
76 	int n_interfaces[MAX_BINDINGS];
77 	int colors[MAX_BINDINGS];
78 	int low_latency[MAX_BINDINGS];
79 #ifdef CONFIG_IWLWIFI_DEBUGFS
80 	int dbgfs_min[MAX_BINDINGS];
81 #endif
82 	int n_low_latency_bindings;
83 	struct ieee80211_vif *disabled_vif;
84 };
85 
86 static void iwl_mvm_quota_iterator(void *_data, u8 *mac,
87 				   struct ieee80211_vif *vif)
88 {
89 	struct iwl_mvm_quota_iterator_data *data = _data;
90 	struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
91 	u16 id;
92 
93 	/* skip disabled interfaces here immediately */
94 	if (vif == data->disabled_vif)
95 		return;
96 
97 	if (!mvmvif->phy_ctxt)
98 		return;
99 
100 	/* currently, PHY ID == binding ID */
101 	id = mvmvif->phy_ctxt->id;
102 
103 	/* need at least one binding per PHY */
104 	BUILD_BUG_ON(NUM_PHY_CTX > MAX_BINDINGS);
105 
106 	if (WARN_ON_ONCE(id >= MAX_BINDINGS))
107 		return;
108 
109 	switch (vif->type) {
110 	case NL80211_IFTYPE_STATION:
111 		if (vif->bss_conf.assoc)
112 			break;
113 		return;
114 	case NL80211_IFTYPE_AP:
115 	case NL80211_IFTYPE_ADHOC:
116 		if (mvmvif->ap_ibss_active)
117 			break;
118 		return;
119 	case NL80211_IFTYPE_MONITOR:
120 		if (mvmvif->monitor_active)
121 			break;
122 		return;
123 	case NL80211_IFTYPE_P2P_DEVICE:
124 		return;
125 	default:
126 		WARN_ON_ONCE(1);
127 		return;
128 	}
129 
130 	if (data->colors[id] < 0)
131 		data->colors[id] = mvmvif->phy_ctxt->color;
132 	else
133 		WARN_ON_ONCE(data->colors[id] != mvmvif->phy_ctxt->color);
134 
135 	data->n_interfaces[id]++;
136 
137 #ifdef CONFIG_IWLWIFI_DEBUGFS
138 	if (mvmvif->dbgfs_quota_min)
139 		data->dbgfs_min[id] = max(data->dbgfs_min[id],
140 					  mvmvif->dbgfs_quota_min);
141 #endif
142 
143 	if (iwl_mvm_vif_low_latency(mvmvif) && !data->low_latency[id]) {
144 		data->n_low_latency_bindings++;
145 		data->low_latency[id] = true;
146 	}
147 }
148 
149 static void iwl_mvm_adjust_quota_for_noa(struct iwl_mvm *mvm,
150 					 struct iwl_time_quota_cmd *cmd)
151 {
152 #ifdef CONFIG_NL80211_TESTMODE
153 	struct iwl_mvm_vif *mvmvif;
154 	int i, phy_id = -1, beacon_int = 0;
155 
156 	if (!mvm->noa_duration || !mvm->noa_vif)
157 		return;
158 
159 	mvmvif = iwl_mvm_vif_from_mac80211(mvm->noa_vif);
160 	if (!mvmvif->ap_ibss_active)
161 		return;
162 
163 	phy_id = mvmvif->phy_ctxt->id;
164 	beacon_int = mvm->noa_vif->bss_conf.beacon_int;
165 
166 	for (i = 0; i < MAX_BINDINGS; i++) {
167 		u32 id_n_c = le32_to_cpu(cmd->quotas[i].id_and_color);
168 		u32 id = (id_n_c & FW_CTXT_ID_MSK) >> FW_CTXT_ID_POS;
169 		u32 quota = le32_to_cpu(cmd->quotas[i].quota);
170 
171 		if (id != phy_id)
172 			continue;
173 
174 		quota *= (beacon_int - mvm->noa_duration);
175 		quota /= beacon_int;
176 
177 		IWL_DEBUG_QUOTA(mvm, "quota: adjust for NoA from %d to %d\n",
178 				le32_to_cpu(cmd->quotas[i].quota), quota);
179 
180 		cmd->quotas[i].quota = cpu_to_le32(quota);
181 	}
182 #endif
183 }
184 
185 int iwl_mvm_update_quotas(struct iwl_mvm *mvm,
186 			  bool force_update,
187 			  struct ieee80211_vif *disabled_vif)
188 {
189 	struct iwl_time_quota_cmd cmd = {};
190 	int i, idx, err, num_active_macs, quota, quota_rem, n_non_lowlat;
191 	struct iwl_mvm_quota_iterator_data data = {
192 		.n_interfaces = {},
193 		.colors = { -1, -1, -1, -1 },
194 		.disabled_vif = disabled_vif,
195 	};
196 	struct iwl_time_quota_cmd *last = &mvm->last_quota_cmd;
197 	bool send = false;
198 
199 	lockdep_assert_held(&mvm->mutex);
200 
201 	/* update all upon completion */
202 	if (test_bit(IWL_MVM_STATUS_IN_HW_RESTART, &mvm->status))
203 		return 0;
204 
205 	/* iterator data above must match */
206 	BUILD_BUG_ON(MAX_BINDINGS != 4);
207 
208 	ieee80211_iterate_active_interfaces_atomic(
209 		mvm->hw, IEEE80211_IFACE_ITER_NORMAL,
210 		iwl_mvm_quota_iterator, &data);
211 
212 	/*
213 	 * The FW's scheduling session consists of
214 	 * IWL_MVM_MAX_QUOTA fragments. Divide these fragments
215 	 * equally between all the bindings that require quota
216 	 */
217 	num_active_macs = 0;
218 	for (i = 0; i < MAX_BINDINGS; i++) {
219 		cmd.quotas[i].id_and_color = cpu_to_le32(FW_CTXT_INVALID);
220 		num_active_macs += data.n_interfaces[i];
221 	}
222 
223 	n_non_lowlat = num_active_macs;
224 
225 	if (data.n_low_latency_bindings == 1) {
226 		for (i = 0; i < MAX_BINDINGS; i++) {
227 			if (data.low_latency[i]) {
228 				n_non_lowlat -= data.n_interfaces[i];
229 				break;
230 			}
231 		}
232 	}
233 
234 	if (data.n_low_latency_bindings == 1 && n_non_lowlat) {
235 		/*
236 		 * Reserve quota for the low latency binding in case that
237 		 * there are several data bindings but only a single
238 		 * low latency one. Split the rest of the quota equally
239 		 * between the other data interfaces.
240 		 */
241 		quota = (QUOTA_100 - QUOTA_LOWLAT_MIN) / n_non_lowlat;
242 		quota_rem = QUOTA_100 - n_non_lowlat * quota -
243 			    QUOTA_LOWLAT_MIN;
244 		IWL_DEBUG_QUOTA(mvm,
245 				"quota: low-latency binding active, remaining quota per other binding: %d\n",
246 				quota);
247 	} else if (num_active_macs) {
248 		/*
249 		 * There are 0 or more than 1 low latency bindings, or all the
250 		 * data interfaces belong to the single low latency binding.
251 		 * Split the quota equally between the data interfaces.
252 		 */
253 		quota = QUOTA_100 / num_active_macs;
254 		quota_rem = QUOTA_100 % num_active_macs;
255 		IWL_DEBUG_QUOTA(mvm,
256 				"quota: splitting evenly per binding: %d\n",
257 				quota);
258 	} else {
259 		/* values don't really matter - won't be used */
260 		quota = 0;
261 		quota_rem = 0;
262 	}
263 
264 	for (idx = 0, i = 0; i < MAX_BINDINGS; i++) {
265 		if (data.colors[i] < 0)
266 			continue;
267 
268 		cmd.quotas[idx].id_and_color =
269 			cpu_to_le32(FW_CMD_ID_AND_COLOR(i, data.colors[i]));
270 
271 		if (data.n_interfaces[i] <= 0)
272 			cmd.quotas[idx].quota = cpu_to_le32(0);
273 #ifdef CONFIG_IWLWIFI_DEBUGFS
274 		else if (data.dbgfs_min[i])
275 			cmd.quotas[idx].quota =
276 				cpu_to_le32(data.dbgfs_min[i] * QUOTA_100 / 100);
277 #endif
278 		else if (data.n_low_latency_bindings == 1 && n_non_lowlat &&
279 			 data.low_latency[i])
280 			/*
281 			 * There is more than one binding, but only one of the
282 			 * bindings is in low latency. For this case, allocate
283 			 * the minimal required quota for the low latency
284 			 * binding.
285 			 */
286 			cmd.quotas[idx].quota = cpu_to_le32(QUOTA_LOWLAT_MIN);
287 		else
288 			cmd.quotas[idx].quota =
289 				cpu_to_le32(quota * data.n_interfaces[i]);
290 
291 		WARN_ONCE(le32_to_cpu(cmd.quotas[idx].quota) > QUOTA_100,
292 			  "Binding=%d, quota=%u > max=%u\n",
293 			  idx, le32_to_cpu(cmd.quotas[idx].quota), QUOTA_100);
294 
295 		cmd.quotas[idx].max_duration = cpu_to_le32(0);
296 
297 		idx++;
298 	}
299 
300 	/* Give the remainder of the session to the first data binding */
301 	for (i = 0; i < MAX_BINDINGS; i++) {
302 		if (le32_to_cpu(cmd.quotas[i].quota) != 0) {
303 			le32_add_cpu(&cmd.quotas[i].quota, quota_rem);
304 			IWL_DEBUG_QUOTA(mvm,
305 					"quota: giving remainder of %d to binding %d\n",
306 					quota_rem, i);
307 			break;
308 		}
309 	}
310 
311 	iwl_mvm_adjust_quota_for_noa(mvm, &cmd);
312 
313 	/* check that we have non-zero quota for all valid bindings */
314 	for (i = 0; i < MAX_BINDINGS; i++) {
315 		if (cmd.quotas[i].id_and_color != last->quotas[i].id_and_color)
316 			send = true;
317 		if (cmd.quotas[i].max_duration != last->quotas[i].max_duration)
318 			send = true;
319 		if (abs((int)le32_to_cpu(cmd.quotas[i].quota) -
320 			(int)le32_to_cpu(last->quotas[i].quota))
321 						> IWL_MVM_QUOTA_THRESHOLD)
322 			send = true;
323 		if (cmd.quotas[i].id_and_color == cpu_to_le32(FW_CTXT_INVALID))
324 			continue;
325 		WARN_ONCE(cmd.quotas[i].quota == 0,
326 			  "zero quota on binding %d\n", i);
327 	}
328 
329 	if (!send && !force_update) {
330 		/* don't send a practically unchanged command, the firmware has
331 		 * to re-initialize a lot of state and that can have an adverse
332 		 * impact on it
333 		 */
334 		return 0;
335 	}
336 
337 	err = iwl_mvm_send_cmd_pdu(mvm, TIME_QUOTA_CMD, 0, sizeof(cmd), &cmd);
338 
339 	if (err)
340 		IWL_ERR(mvm, "Failed to send quota: %d\n", err);
341 	else
342 		mvm->last_quota_cmd = cmd;
343 	return err;
344 }
345