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