xref: /openbmc/linux/drivers/net/wireless/intel/iwlwifi/fw/api/d3.h (revision 05cf4fe738242183f1237f1b3a28b4479348c0a1)
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 struct iwl_wowlan_patterns_cmd {
228 	__le32 n_patterns;
229 	struct iwl_wowlan_pattern patterns[];
230 } __packed; /* WOWLAN_PATTERN_ARRAY_API_S_VER_1 */
231 
232 enum iwl_wowlan_wakeup_filters {
233 	IWL_WOWLAN_WAKEUP_MAGIC_PACKET			= BIT(0),
234 	IWL_WOWLAN_WAKEUP_PATTERN_MATCH			= BIT(1),
235 	IWL_WOWLAN_WAKEUP_BEACON_MISS			= BIT(2),
236 	IWL_WOWLAN_WAKEUP_LINK_CHANGE			= BIT(3),
237 	IWL_WOWLAN_WAKEUP_GTK_REKEY_FAIL		= BIT(4),
238 	IWL_WOWLAN_WAKEUP_EAP_IDENT_REQ			= BIT(5),
239 	IWL_WOWLAN_WAKEUP_4WAY_HANDSHAKE		= BIT(6),
240 	IWL_WOWLAN_WAKEUP_ENABLE_NET_DETECT		= BIT(7),
241 	IWL_WOWLAN_WAKEUP_RF_KILL_DEASSERT		= BIT(8),
242 	IWL_WOWLAN_WAKEUP_REMOTE_LINK_LOSS		= BIT(9),
243 	IWL_WOWLAN_WAKEUP_REMOTE_SIGNATURE_TABLE	= BIT(10),
244 	IWL_WOWLAN_WAKEUP_REMOTE_TCP_EXTERNAL		= BIT(11),
245 	IWL_WOWLAN_WAKEUP_REMOTE_WAKEUP_PACKET		= BIT(12),
246 	IWL_WOWLAN_WAKEUP_IOAC_MAGIC_PACKET		= BIT(13),
247 	IWL_WOWLAN_WAKEUP_HOST_TIMER			= BIT(14),
248 	IWL_WOWLAN_WAKEUP_RX_FRAME			= BIT(15),
249 	IWL_WOWLAN_WAKEUP_BCN_FILTERING			= BIT(16),
250 }; /* WOWLAN_WAKEUP_FILTER_API_E_VER_4 */
251 
252 enum iwl_wowlan_flags {
253 	IS_11W_ASSOC		= BIT(0),
254 	ENABLE_L3_FILTERING	= BIT(1),
255 	ENABLE_NBNS_FILTERING	= BIT(2),
256 	ENABLE_DHCP_FILTERING	= BIT(3),
257 	ENABLE_STORE_BEACON	= BIT(4),
258 };
259 
260 /**
261  * struct iwl_wowlan_config_cmd - WoWLAN configuration
262  * @wakeup_filter: filter from &enum iwl_wowlan_wakeup_filters
263  * @non_qos_seq: non-QoS sequence counter to use next
264  * @qos_seq: QoS sequence counters to use next
265  * @wowlan_ba_teardown_tids: bitmap of BA sessions to tear down
266  * @is_11n_connection: indicates HT connection
267  * @offloading_tid: TID reserved for firmware use
268  * @flags: extra flags, see &enum iwl_wowlan_flags
269  * @reserved: reserved
270  */
271 struct iwl_wowlan_config_cmd {
272 	__le32 wakeup_filter;
273 	__le16 non_qos_seq;
274 	__le16 qos_seq[8];
275 	u8 wowlan_ba_teardown_tids;
276 	u8 is_11n_connection;
277 	u8 offloading_tid;
278 	u8 flags;
279 	u8 reserved[2];
280 } __packed; /* WOWLAN_CONFIG_API_S_VER_4 */
281 
282 /*
283  * WOWLAN_TSC_RSC_PARAMS
284  */
285 #define IWL_NUM_RSC	16
286 
287 struct tkip_sc {
288 	__le16 iv16;
289 	__le16 pad;
290 	__le32 iv32;
291 } __packed; /* TKIP_SC_API_U_VER_1 */
292 
293 struct iwl_tkip_rsc_tsc {
294 	struct tkip_sc unicast_rsc[IWL_NUM_RSC];
295 	struct tkip_sc multicast_rsc[IWL_NUM_RSC];
296 	struct tkip_sc tsc;
297 } __packed; /* TKIP_TSC_RSC_API_S_VER_1 */
298 
299 struct aes_sc {
300 	__le64 pn;
301 } __packed; /* TKIP_AES_SC_API_U_VER_1 */
302 
303 struct iwl_aes_rsc_tsc {
304 	struct aes_sc unicast_rsc[IWL_NUM_RSC];
305 	struct aes_sc multicast_rsc[IWL_NUM_RSC];
306 	struct aes_sc tsc;
307 } __packed; /* AES_TSC_RSC_API_S_VER_1 */
308 
309 union iwl_all_tsc_rsc {
310 	struct iwl_tkip_rsc_tsc tkip;
311 	struct iwl_aes_rsc_tsc aes;
312 }; /* ALL_TSC_RSC_API_S_VER_2 */
313 
314 struct iwl_wowlan_rsc_tsc_params_cmd {
315 	union iwl_all_tsc_rsc all_tsc_rsc;
316 } __packed; /* ALL_TSC_RSC_API_S_VER_2 */
317 
318 #define IWL_MIC_KEY_SIZE	8
319 struct iwl_mic_keys {
320 	u8 tx[IWL_MIC_KEY_SIZE];
321 	u8 rx_unicast[IWL_MIC_KEY_SIZE];
322 	u8 rx_mcast[IWL_MIC_KEY_SIZE];
323 } __packed; /* MIC_KEYS_API_S_VER_1 */
324 
325 #define IWL_P1K_SIZE		5
326 struct iwl_p1k_cache {
327 	__le16 p1k[IWL_P1K_SIZE];
328 } __packed;
329 
330 #define IWL_NUM_RX_P1K_CACHE	2
331 
332 struct iwl_wowlan_tkip_params_cmd {
333 	struct iwl_mic_keys mic_keys;
334 	struct iwl_p1k_cache tx;
335 	struct iwl_p1k_cache rx_uni[IWL_NUM_RX_P1K_CACHE];
336 	struct iwl_p1k_cache rx_multi[IWL_NUM_RX_P1K_CACHE];
337 } __packed; /* WOWLAN_TKIP_SETTING_API_S_VER_1 */
338 
339 #define IWL_KCK_MAX_SIZE	32
340 #define IWL_KEK_MAX_SIZE	32
341 
342 struct iwl_wowlan_kek_kck_material_cmd {
343 	u8	kck[IWL_KCK_MAX_SIZE];
344 	u8	kek[IWL_KEK_MAX_SIZE];
345 	__le16	kck_len;
346 	__le16	kek_len;
347 	__le64	replay_ctr;
348 } __packed; /* KEK_KCK_MATERIAL_API_S_VER_2 */
349 
350 #define RF_KILL_INDICATOR_FOR_WOWLAN	0x87
351 
352 enum iwl_wowlan_rekey_status {
353 	IWL_WOWLAN_REKEY_POST_REKEY = 0,
354 	IWL_WOWLAN_REKEY_WHILE_REKEY = 1,
355 }; /* WOWLAN_REKEY_STATUS_API_E_VER_1 */
356 
357 enum iwl_wowlan_wakeup_reason {
358 	IWL_WOWLAN_WAKEUP_BY_NON_WIRELESS			= 0,
359 	IWL_WOWLAN_WAKEUP_BY_MAGIC_PACKET			= BIT(0),
360 	IWL_WOWLAN_WAKEUP_BY_PATTERN				= BIT(1),
361 	IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_MISSED_BEACON	= BIT(2),
362 	IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_DEAUTH		= BIT(3),
363 	IWL_WOWLAN_WAKEUP_BY_GTK_REKEY_FAILURE			= BIT(4),
364 	IWL_WOWLAN_WAKEUP_BY_RFKILL_DEASSERTED			= BIT(5),
365 	IWL_WOWLAN_WAKEUP_BY_UCODE_ERROR			= BIT(6),
366 	IWL_WOWLAN_WAKEUP_BY_EAPOL_REQUEST			= BIT(7),
367 	IWL_WOWLAN_WAKEUP_BY_FOUR_WAY_HANDSHAKE			= BIT(8),
368 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_LINK_LOSS			= BIT(9),
369 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_SIGNATURE_TABLE		= BIT(10),
370 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_TCP_EXTERNAL		= BIT(11),
371 	IWL_WOWLAN_WAKEUP_BY_REM_WAKE_WAKEUP_PACKET		= BIT(12),
372 	IWL_WOWLAN_WAKEUP_BY_IOAC_MAGIC_PACKET			= BIT(13),
373 	IWL_WOWLAN_WAKEUP_BY_D3_WAKEUP_HOST_TIMER		= BIT(14),
374 	IWL_WOWLAN_WAKEUP_BY_RXFRAME_FILTERED_IN		= BIT(15),
375 	IWL_WOWLAN_WAKEUP_BY_BEACON_FILTERED_IN			= BIT(16),
376 
377 }; /* WOWLAN_WAKE_UP_REASON_API_E_VER_2 */
378 
379 struct iwl_wowlan_gtk_status_v1 {
380 	u8 key_index;
381 	u8 reserved[3];
382 	u8 decrypt_key[16];
383 	u8 tkip_mic_key[8];
384 	struct iwl_wowlan_rsc_tsc_params_cmd rsc;
385 } __packed; /* WOWLAN_GTK_MATERIAL_VER_1 */
386 
387 #define WOWLAN_KEY_MAX_SIZE	32
388 #define WOWLAN_GTK_KEYS_NUM     2
389 #define WOWLAN_IGTK_KEYS_NUM	2
390 
391 /**
392  * struct iwl_wowlan_gtk_status - GTK status
393  * @key: GTK material
394  * @key_len: GTK legth, if set to 0, the key is not available
395  * @key_flags: information about the key:
396  *	bits[0:1]:  key index assigned by the AP
397  *	bits[2:6]:  GTK index of the key in the internal DB
398  *	bit[7]:     Set iff this is the currently used GTK
399  * @reserved: padding
400  * @tkip_mic_key: TKIP RX MIC key
401  * @rsc: TSC RSC counters
402  */
403 struct iwl_wowlan_gtk_status {
404 	u8 key[WOWLAN_KEY_MAX_SIZE];
405 	u8 key_len;
406 	u8 key_flags;
407 	u8 reserved[2];
408 	u8 tkip_mic_key[8];
409 	struct iwl_wowlan_rsc_tsc_params_cmd rsc;
410 } __packed; /* WOWLAN_GTK_MATERIAL_VER_2 */
411 
412 #define IWL_WOWLAN_GTK_IDX_MASK		(BIT(0) | BIT(1))
413 
414 /**
415  * struct iwl_wowlan_igtk_status - IGTK status
416  * @key: IGTK material
417  * @ipn: the IGTK packet number (replay counter)
418  * @key_len: IGTK length, if set to 0, the key is not available
419  * @key_flags: information about the key:
420  *	bits[0]:    key index assigned by the AP (0: index 4, 1: index 5)
421  *	bits[1:5]:  IGTK index of the key in the internal DB
422  *	bit[6]:     Set iff this is the currently used IGTK
423  */
424 struct iwl_wowlan_igtk_status {
425 	u8 key[WOWLAN_KEY_MAX_SIZE];
426 	u8 ipn[6];
427 	u8 key_len;
428 	u8 key_flags;
429 } __packed; /* WOWLAN_IGTK_MATERIAL_VER_1 */
430 
431 /**
432  * struct iwl_wowlan_status_v6 - WoWLAN status
433  * @gtk: GTK data
434  * @replay_ctr: GTK rekey replay counter
435  * @pattern_number: number of the matched pattern
436  * @non_qos_seq_ctr: non-QoS sequence counter to use next
437  * @qos_seq_ctr: QoS sequence counters to use next
438  * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason
439  * @num_of_gtk_rekeys: number of GTK rekeys
440  * @transmitted_ndps: number of transmitted neighbor discovery packets
441  * @received_beacons: number of received beacons
442  * @wake_packet_length: wakeup packet length
443  * @wake_packet_bufsize: wakeup packet buffer size
444  * @wake_packet: wakeup packet
445  */
446 struct iwl_wowlan_status_v6 {
447 	struct iwl_wowlan_gtk_status_v1 gtk;
448 	__le64 replay_ctr;
449 	__le16 pattern_number;
450 	__le16 non_qos_seq_ctr;
451 	__le16 qos_seq_ctr[8];
452 	__le32 wakeup_reasons;
453 	__le32 num_of_gtk_rekeys;
454 	__le32 transmitted_ndps;
455 	__le32 received_beacons;
456 	__le32 wake_packet_length;
457 	__le32 wake_packet_bufsize;
458 	u8 wake_packet[]; /* can be truncated from _length to _bufsize */
459 } __packed; /* WOWLAN_STATUSES_API_S_VER_6 */
460 
461 /**
462  * struct iwl_wowlan_status - WoWLAN status
463  * @gtk: GTK data
464  * @igtk: IGTK data
465  * @replay_ctr: GTK rekey replay counter
466  * @pattern_number: number of the matched pattern
467  * @non_qos_seq_ctr: non-QoS sequence counter to use next
468  * @qos_seq_ctr: QoS sequence counters to use next
469  * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason
470  * @num_of_gtk_rekeys: number of GTK rekeys
471  * @transmitted_ndps: number of transmitted neighbor discovery packets
472  * @received_beacons: number of received beacons
473  * @wake_packet_length: wakeup packet length
474  * @wake_packet_bufsize: wakeup packet buffer size
475  * @wake_packet: wakeup packet
476  */
477 struct iwl_wowlan_status {
478 	struct iwl_wowlan_gtk_status gtk[WOWLAN_GTK_KEYS_NUM];
479 	struct iwl_wowlan_igtk_status igtk[WOWLAN_IGTK_KEYS_NUM];
480 	__le64 replay_ctr;
481 	__le16 pattern_number;
482 	__le16 non_qos_seq_ctr;
483 	__le16 qos_seq_ctr[8];
484 	__le32 wakeup_reasons;
485 	__le32 num_of_gtk_rekeys;
486 	__le32 transmitted_ndps;
487 	__le32 received_beacons;
488 	__le32 wake_packet_length;
489 	__le32 wake_packet_bufsize;
490 	u8 wake_packet[]; /* can be truncated from _length to _bufsize */
491 } __packed; /* WOWLAN_STATUSES_API_S_VER_7 */
492 
493 static inline u8 iwlmvm_wowlan_gtk_idx(struct iwl_wowlan_gtk_status *gtk)
494 {
495 	return gtk->key_flags & IWL_WOWLAN_GTK_IDX_MASK;
496 }
497 
498 #define IWL_WOWLAN_TCP_MAX_PACKET_LEN		64
499 #define IWL_WOWLAN_REMOTE_WAKE_MAX_PACKET_LEN	128
500 #define IWL_WOWLAN_REMOTE_WAKE_MAX_TOKENS	2048
501 
502 struct iwl_tcp_packet_info {
503 	__le16 tcp_pseudo_header_checksum;
504 	__le16 tcp_payload_length;
505 } __packed; /* TCP_PACKET_INFO_API_S_VER_2 */
506 
507 struct iwl_tcp_packet {
508 	struct iwl_tcp_packet_info info;
509 	u8 rx_mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8];
510 	u8 data[IWL_WOWLAN_TCP_MAX_PACKET_LEN];
511 } __packed; /* TCP_PROTOCOL_PACKET_API_S_VER_1 */
512 
513 struct iwl_remote_wake_packet {
514 	struct iwl_tcp_packet_info info;
515 	u8 rx_mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8];
516 	u8 data[IWL_WOWLAN_REMOTE_WAKE_MAX_PACKET_LEN];
517 } __packed; /* TCP_PROTOCOL_PACKET_API_S_VER_1 */
518 
519 struct iwl_wowlan_remote_wake_config {
520 	__le32 connection_max_time; /* unused */
521 	/* TCP_PROTOCOL_CONFIG_API_S_VER_1 */
522 	u8 max_syn_retries;
523 	u8 max_data_retries;
524 	u8 tcp_syn_ack_timeout;
525 	u8 tcp_ack_timeout;
526 
527 	struct iwl_tcp_packet syn_tx;
528 	struct iwl_tcp_packet synack_rx;
529 	struct iwl_tcp_packet keepalive_ack_rx;
530 	struct iwl_tcp_packet fin_tx;
531 
532 	struct iwl_remote_wake_packet keepalive_tx;
533 	struct iwl_remote_wake_packet wake_rx;
534 
535 	/* REMOTE_WAKE_OFFSET_INFO_API_S_VER_1 */
536 	u8 sequence_number_offset;
537 	u8 sequence_number_length;
538 	u8 token_offset;
539 	u8 token_length;
540 	/* REMOTE_WAKE_PROTOCOL_PARAMS_API_S_VER_1 */
541 	__le32 initial_sequence_number;
542 	__le16 keepalive_interval;
543 	__le16 num_tokens;
544 	u8 tokens[IWL_WOWLAN_REMOTE_WAKE_MAX_TOKENS];
545 } __packed; /* REMOTE_WAKE_CONFIG_API_S_VER_2 */
546 
547 /* TODO: NetDetect API */
548 
549 #endif /* __iwl_fw_api_d3_h__ */
550