xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/api/d3.h (revision 1f2367a39f17bd553a75e179a747f9b257bc9478)
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) 2015 - 2017 Intel Deutschland GmbH
11  * Copyright(c) 2018        Intel Corporation
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of version 2 of the GNU General Public License as
15  * published by the Free Software Foundation.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * General Public License for more details.
21  *
22  * The full GNU General Public License is included in this distribution
23  * in the file called COPYING.
24  *
25  * Contact Information:
26  *  Intel Linux Wireless <linuxwifi@intel.com>
27  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
28  *
29  * BSD LICENSE
30  *
31  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
32  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
33  * Copyright(c) 2015 - 2017 Intel Deutschland GmbH
34  * Copyright(c) 2018        Intel Corporation
35  * All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  *
41  *  * Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  *  * Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in
45  *    the documentation and/or other materials provided with the
46  *    distribution.
47  *  * Neither the name Intel Corporation nor the names of its
48  *    contributors may be used to endorse or promote products derived
49  *    from this software without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  *****************************************************************************/
63 
64 #ifndef __iwl_fw_api_d3_h__
65 #define __iwl_fw_api_d3_h__
66 
67 /**
68  * enum iwl_d3_wakeup_flags - D3 manager wakeup flags
69  * @IWL_WAKEUP_D3_CONFIG_FW_ERROR: wake up on firmware sysassert
70  */
71 enum iwl_d3_wakeup_flags {
72 	IWL_WAKEUP_D3_CONFIG_FW_ERROR = BIT(0),
73 }; /* D3_MANAGER_WAKEUP_CONFIG_API_E_VER_3 */
74 
75 /**
76  * struct iwl_d3_manager_config - D3 manager configuration command
77  * @min_sleep_time: minimum sleep time (in usec)
78  * @wakeup_flags: wakeup flags, see &enum iwl_d3_wakeup_flags
79  * @wakeup_host_timer: force wakeup after this many seconds
80  *
81  * The structure is used for the D3_CONFIG_CMD command.
82  */
83 struct iwl_d3_manager_config {
84 	__le32 min_sleep_time;
85 	__le32 wakeup_flags;
86 	__le32 wakeup_host_timer;
87 } __packed; /* D3_MANAGER_CONFIG_CMD_S_VER_4 */
88 
89 
90 /* TODO: OFFLOADS_QUERY_API_S_VER_1 */
91 
92 /**
93  * enum iwl_d3_proto_offloads - enabled protocol offloads
94  * @IWL_D3_PROTO_OFFLOAD_ARP: ARP data is enabled
95  * @IWL_D3_PROTO_OFFLOAD_NS: NS (Neighbor Solicitation) is enabled
96  * @IWL_D3_PROTO_IPV4_VALID: IPv4 data is valid
97  * @IWL_D3_PROTO_IPV6_VALID: IPv6 data is valid
98  */
99 enum iwl_proto_offloads {
100 	IWL_D3_PROTO_OFFLOAD_ARP = BIT(0),
101 	IWL_D3_PROTO_OFFLOAD_NS = BIT(1),
102 	IWL_D3_PROTO_IPV4_VALID = BIT(2),
103 	IWL_D3_PROTO_IPV6_VALID = BIT(3),
104 };
105 
106 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V1	2
107 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V2	6
108 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3L	12
109 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3S	4
110 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_MAX	12
111 
112 #define IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3L	4
113 #define IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3S	2
114 
115 /**
116  * struct iwl_proto_offload_cmd_common - ARP/NS offload common part
117  * @enabled: enable flags
118  * @remote_ipv4_addr: remote address to answer to (or zero if all)
119  * @host_ipv4_addr: our IPv4 address to respond to queries for
120  * @arp_mac_addr: our MAC address for ARP responses
121  * @reserved: unused
122  */
123 struct iwl_proto_offload_cmd_common {
124 	__le32 enabled;
125 	__be32 remote_ipv4_addr;
126 	__be32 host_ipv4_addr;
127 	u8 arp_mac_addr[ETH_ALEN];
128 	__le16 reserved;
129 } __packed;
130 
131 /**
132  * struct iwl_proto_offload_cmd_v1 - ARP/NS offload configuration
133  * @common: common/IPv4 configuration
134  * @remote_ipv6_addr: remote address to answer to (or zero if all)
135  * @solicited_node_ipv6_addr: broken -- solicited node address exists
136  *	for each target address
137  * @target_ipv6_addr: our target addresses
138  * @ndp_mac_addr: neighbor solicitation response MAC address
139  * @reserved2: reserved
140  */
141 struct iwl_proto_offload_cmd_v1 {
142 	struct iwl_proto_offload_cmd_common common;
143 	u8 remote_ipv6_addr[16];
144 	u8 solicited_node_ipv6_addr[16];
145 	u8 target_ipv6_addr[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V1][16];
146 	u8 ndp_mac_addr[ETH_ALEN];
147 	__le16 reserved2;
148 } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_1 */
149 
150 /**
151  * struct iwl_proto_offload_cmd_v2 - ARP/NS offload configuration
152  * @common: common/IPv4 configuration
153  * @remote_ipv6_addr: remote address to answer to (or zero if all)
154  * @solicited_node_ipv6_addr: broken -- solicited node address exists
155  *	for each target address
156  * @target_ipv6_addr: our target addresses
157  * @ndp_mac_addr: neighbor solicitation response MAC address
158  * @num_valid_ipv6_addrs: number of valid IPv6 addresses
159  * @reserved2: reserved
160  */
161 struct iwl_proto_offload_cmd_v2 {
162 	struct iwl_proto_offload_cmd_common common;
163 	u8 remote_ipv6_addr[16];
164 	u8 solicited_node_ipv6_addr[16];
165 	u8 target_ipv6_addr[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V2][16];
166 	u8 ndp_mac_addr[ETH_ALEN];
167 	u8 num_valid_ipv6_addrs;
168 	u8 reserved2[3];
169 } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_2 */
170 
171 struct iwl_ns_config {
172 	struct in6_addr source_ipv6_addr;
173 	struct in6_addr dest_ipv6_addr;
174 	u8 target_mac_addr[ETH_ALEN];
175 	__le16 reserved;
176 } __packed; /* NS_OFFLOAD_CONFIG */
177 
178 struct iwl_targ_addr {
179 	struct in6_addr addr;
180 	__le32 config_num;
181 } __packed; /* TARGET_IPV6_ADDRESS */
182 
183 /**
184  * struct iwl_proto_offload_cmd_v3_small - ARP/NS offload configuration
185  * @common: common/IPv4 configuration
186  * @num_valid_ipv6_addrs: number of valid IPv6 addresses
187  * @targ_addrs: target IPv6 addresses
188  * @ns_config: NS offload configurations
189  */
190 struct iwl_proto_offload_cmd_v3_small {
191 	struct iwl_proto_offload_cmd_common common;
192 	__le32 num_valid_ipv6_addrs;
193 	struct iwl_targ_addr targ_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3S];
194 	struct iwl_ns_config ns_config[IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3S];
195 } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_3 */
196 
197 /**
198  * struct iwl_proto_offload_cmd_v3_large - ARP/NS offload configuration
199  * @common: common/IPv4 configuration
200  * @num_valid_ipv6_addrs: number of valid IPv6 addresses
201  * @targ_addrs: target IPv6 addresses
202  * @ns_config: NS offload configurations
203  */
204 struct iwl_proto_offload_cmd_v3_large {
205 	struct iwl_proto_offload_cmd_common common;
206 	__le32 num_valid_ipv6_addrs;
207 	struct iwl_targ_addr targ_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3L];
208 	struct iwl_ns_config ns_config[IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3L];
209 } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_3 */
210 
211 /*
212  * WOWLAN_PATTERNS
213  */
214 #define IWL_WOWLAN_MIN_PATTERN_LEN	16
215 #define IWL_WOWLAN_MAX_PATTERN_LEN	128
216 
217 struct iwl_wowlan_pattern {
218 	u8 mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8];
219 	u8 pattern[IWL_WOWLAN_MAX_PATTERN_LEN];
220 	u8 mask_size;
221 	u8 pattern_size;
222 	__le16 reserved;
223 } __packed; /* WOWLAN_PATTERN_API_S_VER_1 */
224 
225 #define IWL_WOWLAN_MAX_PATTERNS	20
226 
227 /**
228  * struct iwl_wowlan_patterns_cmd - WoWLAN wakeup patterns
229  */
230 struct iwl_wowlan_patterns_cmd {
231 	/**
232 	 * @n_patterns: number of patterns
233 	 */
234 	__le32 n_patterns;
235 
236 	/**
237 	 * @patterns: the patterns, array length in @n_patterns
238 	 */
239 	struct iwl_wowlan_pattern patterns[];
240 } __packed; /* WOWLAN_PATTERN_ARRAY_API_S_VER_1 */
241 
242 enum iwl_wowlan_wakeup_filters {
243 	IWL_WOWLAN_WAKEUP_MAGIC_PACKET			= BIT(0),
244 	IWL_WOWLAN_WAKEUP_PATTERN_MATCH			= BIT(1),
245 	IWL_WOWLAN_WAKEUP_BEACON_MISS			= BIT(2),
246 	IWL_WOWLAN_WAKEUP_LINK_CHANGE			= BIT(3),
247 	IWL_WOWLAN_WAKEUP_GTK_REKEY_FAIL		= BIT(4),
248 	IWL_WOWLAN_WAKEUP_EAP_IDENT_REQ			= BIT(5),
249 	IWL_WOWLAN_WAKEUP_4WAY_HANDSHAKE		= BIT(6),
250 	IWL_WOWLAN_WAKEUP_ENABLE_NET_DETECT		= BIT(7),
251 	IWL_WOWLAN_WAKEUP_RF_KILL_DEASSERT		= BIT(8),
252 	IWL_WOWLAN_WAKEUP_REMOTE_LINK_LOSS		= BIT(9),
253 	IWL_WOWLAN_WAKEUP_REMOTE_SIGNATURE_TABLE	= BIT(10),
254 	IWL_WOWLAN_WAKEUP_REMOTE_TCP_EXTERNAL		= BIT(11),
255 	IWL_WOWLAN_WAKEUP_REMOTE_WAKEUP_PACKET		= BIT(12),
256 	IWL_WOWLAN_WAKEUP_IOAC_MAGIC_PACKET		= BIT(13),
257 	IWL_WOWLAN_WAKEUP_HOST_TIMER			= BIT(14),
258 	IWL_WOWLAN_WAKEUP_RX_FRAME			= BIT(15),
259 	IWL_WOWLAN_WAKEUP_BCN_FILTERING			= BIT(16),
260 }; /* WOWLAN_WAKEUP_FILTER_API_E_VER_4 */
261 
262 enum iwl_wowlan_flags {
263 	IS_11W_ASSOC		= BIT(0),
264 	ENABLE_L3_FILTERING	= BIT(1),
265 	ENABLE_NBNS_FILTERING	= BIT(2),
266 	ENABLE_DHCP_FILTERING	= BIT(3),
267 	ENABLE_STORE_BEACON	= BIT(4),
268 };
269 
270 /**
271  * struct iwl_wowlan_config_cmd - WoWLAN configuration
272  * @wakeup_filter: filter from &enum iwl_wowlan_wakeup_filters
273  * @non_qos_seq: non-QoS sequence counter to use next
274  * @qos_seq: QoS sequence counters to use next
275  * @wowlan_ba_teardown_tids: bitmap of BA sessions to tear down
276  * @is_11n_connection: indicates HT connection
277  * @offloading_tid: TID reserved for firmware use
278  * @flags: extra flags, see &enum iwl_wowlan_flags
279  * @reserved: reserved
280  */
281 struct iwl_wowlan_config_cmd {
282 	__le32 wakeup_filter;
283 	__le16 non_qos_seq;
284 	__le16 qos_seq[8];
285 	u8 wowlan_ba_teardown_tids;
286 	u8 is_11n_connection;
287 	u8 offloading_tid;
288 	u8 flags;
289 	u8 reserved[2];
290 } __packed; /* WOWLAN_CONFIG_API_S_VER_4 */
291 
292 /*
293  * WOWLAN_TSC_RSC_PARAMS
294  */
295 #define IWL_NUM_RSC	16
296 
297 struct tkip_sc {
298 	__le16 iv16;
299 	__le16 pad;
300 	__le32 iv32;
301 } __packed; /* TKIP_SC_API_U_VER_1 */
302 
303 struct iwl_tkip_rsc_tsc {
304 	struct tkip_sc unicast_rsc[IWL_NUM_RSC];
305 	struct tkip_sc multicast_rsc[IWL_NUM_RSC];
306 	struct tkip_sc tsc;
307 } __packed; /* TKIP_TSC_RSC_API_S_VER_1 */
308 
309 struct aes_sc {
310 	__le64 pn;
311 } __packed; /* TKIP_AES_SC_API_U_VER_1 */
312 
313 struct iwl_aes_rsc_tsc {
314 	struct aes_sc unicast_rsc[IWL_NUM_RSC];
315 	struct aes_sc multicast_rsc[IWL_NUM_RSC];
316 	struct aes_sc tsc;
317 } __packed; /* AES_TSC_RSC_API_S_VER_1 */
318 
319 union iwl_all_tsc_rsc {
320 	struct iwl_tkip_rsc_tsc tkip;
321 	struct iwl_aes_rsc_tsc aes;
322 }; /* ALL_TSC_RSC_API_S_VER_2 */
323 
324 struct iwl_wowlan_rsc_tsc_params_cmd {
325 	union iwl_all_tsc_rsc all_tsc_rsc;
326 } __packed; /* ALL_TSC_RSC_API_S_VER_2 */
327 
328 #define IWL_MIC_KEY_SIZE	8
329 struct iwl_mic_keys {
330 	u8 tx[IWL_MIC_KEY_SIZE];
331 	u8 rx_unicast[IWL_MIC_KEY_SIZE];
332 	u8 rx_mcast[IWL_MIC_KEY_SIZE];
333 } __packed; /* MIC_KEYS_API_S_VER_1 */
334 
335 #define IWL_P1K_SIZE		5
336 struct iwl_p1k_cache {
337 	__le16 p1k[IWL_P1K_SIZE];
338 } __packed;
339 
340 #define IWL_NUM_RX_P1K_CACHE	2
341 
342 struct iwl_wowlan_tkip_params_cmd {
343 	struct iwl_mic_keys mic_keys;
344 	struct iwl_p1k_cache tx;
345 	struct iwl_p1k_cache rx_uni[IWL_NUM_RX_P1K_CACHE];
346 	struct iwl_p1k_cache rx_multi[IWL_NUM_RX_P1K_CACHE];
347 } __packed; /* WOWLAN_TKIP_SETTING_API_S_VER_1 */
348 
349 #define IWL_KCK_MAX_SIZE	32
350 #define IWL_KEK_MAX_SIZE	32
351 
352 struct iwl_wowlan_kek_kck_material_cmd {
353 	u8	kck[IWL_KCK_MAX_SIZE];
354 	u8	kek[IWL_KEK_MAX_SIZE];
355 	__le16	kck_len;
356 	__le16	kek_len;
357 	__le64	replay_ctr;
358 } __packed; /* KEK_KCK_MATERIAL_API_S_VER_2 */
359 
360 #define RF_KILL_INDICATOR_FOR_WOWLAN	0x87
361 
362 enum iwl_wowlan_rekey_status {
363 	IWL_WOWLAN_REKEY_POST_REKEY = 0,
364 	IWL_WOWLAN_REKEY_WHILE_REKEY = 1,
365 }; /* WOWLAN_REKEY_STATUS_API_E_VER_1 */
366 
367 enum iwl_wowlan_wakeup_reason {
368 	IWL_WOWLAN_WAKEUP_BY_NON_WIRELESS			= 0,
369 	IWL_WOWLAN_WAKEUP_BY_MAGIC_PACKET			= BIT(0),
370 	IWL_WOWLAN_WAKEUP_BY_PATTERN				= BIT(1),
371 	IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_MISSED_BEACON	= BIT(2),
372 	IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_DEAUTH		= BIT(3),
373 	IWL_WOWLAN_WAKEUP_BY_GTK_REKEY_FAILURE			= BIT(4),
374 	IWL_WOWLAN_WAKEUP_BY_RFKILL_DEASSERTED			= BIT(5),
375 	IWL_WOWLAN_WAKEUP_BY_UCODE_ERROR			= BIT(6),
376 	IWL_WOWLAN_WAKEUP_BY_EAPOL_REQUEST			= BIT(7),
377 	IWL_WOWLAN_WAKEUP_BY_FOUR_WAY_HANDSHAKE			= BIT(8),
378 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_LINK_LOSS			= BIT(9),
379 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_SIGNATURE_TABLE		= BIT(10),
380 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_TCP_EXTERNAL		= BIT(11),
381 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_WAKEUP_PACKET		= BIT(12),
382 	IWL_WOWLAN_WAKEUP_BY_IOAC_MAGIC_PACKET			= BIT(13),
383 	IWL_WOWLAN_WAKEUP_BY_D3_WAKEUP_HOST_TIMER		= BIT(14),
384 	IWL_WOWLAN_WAKEUP_BY_RXFRAME_FILTERED_IN		= BIT(15),
385 	IWL_WOWLAN_WAKEUP_BY_BEACON_FILTERED_IN			= BIT(16),
386 
387 }; /* WOWLAN_WAKE_UP_REASON_API_E_VER_2 */
388 
389 struct iwl_wowlan_gtk_status_v1 {
390 	u8 key_index;
391 	u8 reserved[3];
392 	u8 decrypt_key[16];
393 	u8 tkip_mic_key[8];
394 	struct iwl_wowlan_rsc_tsc_params_cmd rsc;
395 } __packed; /* WOWLAN_GTK_MATERIAL_VER_1 */
396 
397 #define WOWLAN_KEY_MAX_SIZE	32
398 #define WOWLAN_GTK_KEYS_NUM     2
399 #define WOWLAN_IGTK_KEYS_NUM	2
400 
401 /**
402  * struct iwl_wowlan_gtk_status - GTK status
403  * @key: GTK material
404  * @key_len: GTK legth, if set to 0, the key is not available
405  * @key_flags: information about the key:
406  *	bits[0:1]:  key index assigned by the AP
407  *	bits[2:6]:  GTK index of the key in the internal DB
408  *	bit[7]:     Set iff this is the currently used GTK
409  * @reserved: padding
410  * @tkip_mic_key: TKIP RX MIC key
411  * @rsc: TSC RSC counters
412  */
413 struct iwl_wowlan_gtk_status {
414 	u8 key[WOWLAN_KEY_MAX_SIZE];
415 	u8 key_len;
416 	u8 key_flags;
417 	u8 reserved[2];
418 	u8 tkip_mic_key[8];
419 	struct iwl_wowlan_rsc_tsc_params_cmd rsc;
420 } __packed; /* WOWLAN_GTK_MATERIAL_VER_2 */
421 
422 #define IWL_WOWLAN_GTK_IDX_MASK		(BIT(0) | BIT(1))
423 
424 /**
425  * struct iwl_wowlan_igtk_status - IGTK status
426  * @key: IGTK material
427  * @ipn: the IGTK packet number (replay counter)
428  * @key_len: IGTK length, if set to 0, the key is not available
429  * @key_flags: information about the key:
430  *	bits[0]:    key index assigned by the AP (0: index 4, 1: index 5)
431  *	bits[1:5]:  IGTK index of the key in the internal DB
432  *	bit[6]:     Set iff this is the currently used IGTK
433  */
434 struct iwl_wowlan_igtk_status {
435 	u8 key[WOWLAN_KEY_MAX_SIZE];
436 	u8 ipn[6];
437 	u8 key_len;
438 	u8 key_flags;
439 } __packed; /* WOWLAN_IGTK_MATERIAL_VER_1 */
440 
441 /**
442  * struct iwl_wowlan_status_v6 - WoWLAN status
443  * @gtk: GTK data
444  * @replay_ctr: GTK rekey replay counter
445  * @pattern_number: number of the matched pattern
446  * @non_qos_seq_ctr: non-QoS sequence counter to use next
447  * @qos_seq_ctr: QoS sequence counters to use next
448  * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason
449  * @num_of_gtk_rekeys: number of GTK rekeys
450  * @transmitted_ndps: number of transmitted neighbor discovery packets
451  * @received_beacons: number of received beacons
452  * @wake_packet_length: wakeup packet length
453  * @wake_packet_bufsize: wakeup packet buffer size
454  * @wake_packet: wakeup packet
455  */
456 struct iwl_wowlan_status_v6 {
457 	struct iwl_wowlan_gtk_status_v1 gtk;
458 	__le64 replay_ctr;
459 	__le16 pattern_number;
460 	__le16 non_qos_seq_ctr;
461 	__le16 qos_seq_ctr[8];
462 	__le32 wakeup_reasons;
463 	__le32 num_of_gtk_rekeys;
464 	__le32 transmitted_ndps;
465 	__le32 received_beacons;
466 	__le32 wake_packet_length;
467 	__le32 wake_packet_bufsize;
468 	u8 wake_packet[]; /* can be truncated from _length to _bufsize */
469 } __packed; /* WOWLAN_STATUSES_API_S_VER_6 */
470 
471 /**
472  * struct iwl_wowlan_status - WoWLAN status
473  * @gtk: GTK data
474  * @igtk: IGTK data
475  * @replay_ctr: GTK rekey replay counter
476  * @pattern_number: number of the matched pattern
477  * @non_qos_seq_ctr: non-QoS sequence counter to use next
478  * @qos_seq_ctr: QoS sequence counters to use next
479  * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason
480  * @num_of_gtk_rekeys: number of GTK rekeys
481  * @transmitted_ndps: number of transmitted neighbor discovery packets
482  * @received_beacons: number of received beacons
483  * @wake_packet_length: wakeup packet length
484  * @wake_packet_bufsize: wakeup packet buffer size
485  * @wake_packet: wakeup packet
486  */
487 struct iwl_wowlan_status {
488 	struct iwl_wowlan_gtk_status gtk[WOWLAN_GTK_KEYS_NUM];
489 	struct iwl_wowlan_igtk_status igtk[WOWLAN_IGTK_KEYS_NUM];
490 	__le64 replay_ctr;
491 	__le16 pattern_number;
492 	__le16 non_qos_seq_ctr;
493 	__le16 qos_seq_ctr[8];
494 	__le32 wakeup_reasons;
495 	__le32 num_of_gtk_rekeys;
496 	__le32 transmitted_ndps;
497 	__le32 received_beacons;
498 	__le32 wake_packet_length;
499 	__le32 wake_packet_bufsize;
500 	u8 wake_packet[]; /* can be truncated from _length to _bufsize */
501 } __packed; /* WOWLAN_STATUSES_API_S_VER_7 */
502 
503 static inline u8 iwlmvm_wowlan_gtk_idx(struct iwl_wowlan_gtk_status *gtk)
504 {
505 	return gtk->key_flags & IWL_WOWLAN_GTK_IDX_MASK;
506 }
507 
508 #define IWL_WOWLAN_TCP_MAX_PACKET_LEN		64
509 #define IWL_WOWLAN_REMOTE_WAKE_MAX_PACKET_LEN	128
510 #define IWL_WOWLAN_REMOTE_WAKE_MAX_TOKENS	2048
511 
512 struct iwl_tcp_packet_info {
513 	__le16 tcp_pseudo_header_checksum;
514 	__le16 tcp_payload_length;
515 } __packed; /* TCP_PACKET_INFO_API_S_VER_2 */
516 
517 struct iwl_tcp_packet {
518 	struct iwl_tcp_packet_info info;
519 	u8 rx_mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8];
520 	u8 data[IWL_WOWLAN_TCP_MAX_PACKET_LEN];
521 } __packed; /* TCP_PROTOCOL_PACKET_API_S_VER_1 */
522 
523 struct iwl_remote_wake_packet {
524 	struct iwl_tcp_packet_info info;
525 	u8 rx_mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8];
526 	u8 data[IWL_WOWLAN_REMOTE_WAKE_MAX_PACKET_LEN];
527 } __packed; /* TCP_PROTOCOL_PACKET_API_S_VER_1 */
528 
529 struct iwl_wowlan_remote_wake_config {
530 	__le32 connection_max_time; /* unused */
531 	/* TCP_PROTOCOL_CONFIG_API_S_VER_1 */
532 	u8 max_syn_retries;
533 	u8 max_data_retries;
534 	u8 tcp_syn_ack_timeout;
535 	u8 tcp_ack_timeout;
536 
537 	struct iwl_tcp_packet syn_tx;
538 	struct iwl_tcp_packet synack_rx;
539 	struct iwl_tcp_packet keepalive_ack_rx;
540 	struct iwl_tcp_packet fin_tx;
541 
542 	struct iwl_remote_wake_packet keepalive_tx;
543 	struct iwl_remote_wake_packet wake_rx;
544 
545 	/* REMOTE_WAKE_OFFSET_INFO_API_S_VER_1 */
546 	u8 sequence_number_offset;
547 	u8 sequence_number_length;
548 	u8 token_offset;
549 	u8 token_length;
550 	/* REMOTE_WAKE_PROTOCOL_PARAMS_API_S_VER_1 */
551 	__le32 initial_sequence_number;
552 	__le16 keepalive_interval;
553 	__le16 num_tokens;
554 	u8 tokens[IWL_WOWLAN_REMOTE_WAKE_MAX_TOKENS];
555 } __packed; /* REMOTE_WAKE_CONFIG_API_S_VER_2 */
556 
557 /* TODO: NetDetect API */
558 
559 #endif /* __iwl_fw_api_d3_h__ */
560