/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* * Copyright (C) 2012-2014, 2018-2025 Intel Corporation * Copyright (C) 2013-2014 Intel Mobile Communications GmbH * Copyright (C) 2015-2017 Intel Deutschland GmbH */ #ifndef __iwl_fw_api_d3_h__ #define __iwl_fw_api_d3_h__ #include <iwl-trans.h> /** * enum iwl_d0i3_flags - d0i3 flags * @IWL_D0I3_RESET_REQUIRE: FW require reset upon resume */ enum iwl_d0i3_flags { IWL_D0I3_RESET_REQUIRE = BIT(0), }; /** * enum iwl_d3_wakeup_flags - D3 manager wakeup flags * @IWL_WAKEUP_D3_CONFIG_FW_ERROR: wake up on firmware sysassert * @IWL_WAKEUP_D3_HOST_TIMER: wake up on host timer expiry */ enum iwl_d3_wakeup_flags { IWL_WAKEUP_D3_CONFIG_FW_ERROR = BIT(0), IWL_WAKEUP_D3_HOST_TIMER = BIT(1), }; /* D3_MANAGER_WAKEUP_CONFIG_API_E_VER_3 */ /** * struct iwl_d3_manager_config - D3 manager configuration command * @min_sleep_time: minimum sleep time (in usec) * @wakeup_flags: wakeup flags, see &enum iwl_d3_wakeup_flags * @wakeup_host_timer: force wakeup after this many seconds * * The structure is used for the D3_CONFIG_CMD command. */ struct iwl_d3_manager_config { __le32 min_sleep_time; __le32 wakeup_flags; __le32 wakeup_host_timer; } __packed; /* D3_MANAGER_CONFIG_CMD_S_VER_4 */ /* TODO: OFFLOADS_QUERY_API_S_VER_1 */ /** * enum iwl_proto_offloads - enabled protocol offloads * @IWL_D3_PROTO_OFFLOAD_ARP: ARP data is enabled * @IWL_D3_PROTO_OFFLOAD_NS: NS (Neighbor Solicitation) is enabled * @IWL_D3_PROTO_IPV4_VALID: IPv4 data is valid * @IWL_D3_PROTO_IPV6_VALID: IPv6 data is valid * @IWL_D3_PROTO_OFFLOAD_BTM: BTM offload is enabled */ enum iwl_proto_offloads { IWL_D3_PROTO_OFFLOAD_ARP = BIT(0), IWL_D3_PROTO_OFFLOAD_NS = BIT(1), IWL_D3_PROTO_IPV4_VALID = BIT(2), IWL_D3_PROTO_IPV6_VALID = BIT(3), IWL_D3_PROTO_OFFLOAD_BTM = BIT(4), }; #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V1 2 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V2 6 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3L 12 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3S 4 #define IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_MAX 12 #define IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3L 4 #define IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3S 2 /** * struct iwl_proto_offload_cmd_common - ARP/NS offload common part * @enabled: enable flags * @remote_ipv4_addr: remote address to answer to (or zero if all) * @host_ipv4_addr: our IPv4 address to respond to queries for * @arp_mac_addr: our MAC address for ARP responses * @reserved: unused */ struct iwl_proto_offload_cmd_common { __le32 enabled; __be32 remote_ipv4_addr; __be32 host_ipv4_addr; u8 arp_mac_addr[ETH_ALEN]; __le16 reserved; } __packed; /** * struct iwl_proto_offload_cmd_v1 - ARP/NS offload configuration * @common: common/IPv4 configuration * @remote_ipv6_addr: remote address to answer to (or zero if all) * @solicited_node_ipv6_addr: broken -- solicited node address exists * for each target address * @target_ipv6_addr: our target addresses * @ndp_mac_addr: neighbor solicitation response MAC address * @reserved2: reserved */ struct iwl_proto_offload_cmd_v1 { struct iwl_proto_offload_cmd_common common; u8 remote_ipv6_addr[16]; u8 solicited_node_ipv6_addr[16]; u8 target_ipv6_addr[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V1][16]; u8 ndp_mac_addr[ETH_ALEN]; __le16 reserved2; } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_1 */ /** * struct iwl_proto_offload_cmd_v2 - ARP/NS offload configuration * @common: common/IPv4 configuration * @remote_ipv6_addr: remote address to answer to (or zero if all) * @solicited_node_ipv6_addr: broken -- solicited node address exists * for each target address * @target_ipv6_addr: our target addresses * @ndp_mac_addr: neighbor solicitation response MAC address * @num_valid_ipv6_addrs: number of valid IPv6 addresses * @reserved2: reserved */ struct iwl_proto_offload_cmd_v2 { struct iwl_proto_offload_cmd_common common; u8 remote_ipv6_addr[16]; u8 solicited_node_ipv6_addr[16]; u8 target_ipv6_addr[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V2][16]; u8 ndp_mac_addr[ETH_ALEN]; u8 num_valid_ipv6_addrs; u8 reserved2[3]; } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_2 */ struct iwl_ns_config { struct in6_addr source_ipv6_addr; struct in6_addr dest_ipv6_addr; u8 target_mac_addr[ETH_ALEN]; __le16 reserved; } __packed; /* NS_OFFLOAD_CONFIG */ struct iwl_targ_addr { struct in6_addr addr; __le32 config_num; } __packed; /* TARGET_IPV6_ADDRESS */ /** * struct iwl_proto_offload_cmd_v3_small - ARP/NS offload configuration * @common: common/IPv4 configuration * @num_valid_ipv6_addrs: number of valid IPv6 addresses * @targ_addrs: target IPv6 addresses * @ns_config: NS offload configurations */ struct iwl_proto_offload_cmd_v3_small { struct iwl_proto_offload_cmd_common common; __le32 num_valid_ipv6_addrs; struct iwl_targ_addr targ_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3S]; struct iwl_ns_config ns_config[IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3S]; } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_3 */ /** * struct iwl_proto_offload_cmd_v3_large - ARP/NS offload configuration * @common: common/IPv4 configuration * @num_valid_ipv6_addrs: number of valid IPv6 addresses * @targ_addrs: target IPv6 addresses * @ns_config: NS offload configurations */ struct iwl_proto_offload_cmd_v3_large { struct iwl_proto_offload_cmd_common common; __le32 num_valid_ipv6_addrs; struct iwl_targ_addr targ_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3L]; struct iwl_ns_config ns_config[IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3L]; } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_3 */ /** * struct iwl_proto_offload_cmd_v4 - ARP/NS offload configuration * @sta_id: station id * @common: common/IPv4 configuration * @num_valid_ipv6_addrs: number of valid IPv6 addresses * @targ_addrs: target IPv6 addresses * @ns_config: NS offload configurations */ struct iwl_proto_offload_cmd_v4 { __le32 sta_id; struct iwl_proto_offload_cmd_common common; __le32 num_valid_ipv6_addrs; struct iwl_targ_addr targ_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_V3L]; struct iwl_ns_config ns_config[IWL_PROTO_OFFLOAD_NUM_NS_CONFIG_V3L]; } __packed; /* PROT_OFFLOAD_CONFIG_CMD_DB_S_VER_4 */ /* * WOWLAN_PATTERNS */ #define IWL_WOWLAN_MIN_PATTERN_LEN 16 #define IWL_WOWLAN_MAX_PATTERN_LEN 128 struct iwl_wowlan_pattern_v1 { u8 mask[IWL_WOWLAN_MAX_PATTERN_LEN / 8]; u8 pattern[IWL_WOWLAN_MAX_PATTERN_LEN]; u8 mask_size; u8 pattern_size; __le16 reserved; } __packed; /* WOWLAN_PATTERN_API_S_VER_1 */ #define IWL_WOWLAN_MAX_PATTERNS 20 /** * struct iwl_wowlan_patterns_cmd_v1 - WoWLAN wakeup patterns */ struct iwl_wowlan_patterns_cmd_v1 { /** * @n_patterns: number of patterns */ __le32 n_patterns; /** * @patterns: the patterns, array length in @n_patterns */ struct iwl_wowlan_pattern_v1 patterns[]; } __packed; /* WOWLAN_PATTERN_ARRAY_API_S_VER_1 */ #define IPV4_ADDR_SIZE 4 #define IPV6_ADDR_SIZE 16 enum iwl_wowlan_pattern_type { WOWLAN_PATTERN_TYPE_BITMASK, WOWLAN_PATTERN_TYPE_IPV4_TCP_SYN, WOWLAN_PATTERN_TYPE_IPV6_TCP_SYN, WOWLAN_PATTERN_TYPE_IPV4_TCP_SYN_WILDCARD, WOWLAN_PATTERN_TYPE_IPV6_TCP_SYN_WILDCARD, }; /* WOWLAN_PATTERN_TYPE_API_E_VER_1 */ /** * struct iwl_wowlan_ipv4_tcp_syn - WoWLAN IPv4 TCP SYN pattern data */ struct iwl_wowlan_ipv4_tcp_syn { /** * @src_addr: source IP address to match */ u8 src_addr[IPV4_ADDR_SIZE]; /** * @dst_addr: destination IP address to match */ u8 dst_addr[IPV4_ADDR_SIZE]; /** * @src_port: source TCP port to match */ __le16 src_port; /** * @dst_port: destination TCP port to match */ __le16 dst_port; } __packed; /* WOWLAN_IPV4_TCP_SYN_API_S_VER_1 */ /** * struct iwl_wowlan_ipv6_tcp_syn - WoWLAN Ipv6 TCP SYN pattern data */ struct iwl_wowlan_ipv6_tcp_syn { /** * @src_addr: source IP address to match */ u8 src_addr[IPV6_ADDR_SIZE]; /** * @dst_addr: destination IP address to match */ u8 dst_addr[IPV6_ADDR_SIZE]; /** * @src_port: source TCP port to match */ __le16 src_port; /** * @dst_port: destination TCP port to match */ __le16 dst_port; } __packed; /* WOWLAN_IPV6_TCP_SYN_API_S_VER_1 */ /** * union iwl_wowlan_pattern_data - Data for the different pattern types * * If wildcard addresses/ports are to be used, the union can be left * undefined. */ union iwl_wowlan_pattern_data { /** * @bitmask: bitmask pattern data */ struct iwl_wowlan_pattern_v1 bitmask; /** * @ipv4_tcp_syn: IPv4 TCP SYN pattern data */ struct iwl_wowlan_ipv4_tcp_syn ipv4_tcp_syn; /** * @ipv6_tcp_syn: IPv6 TCP SYN pattern data */ struct iwl_wowlan_ipv6_tcp_syn ipv6_tcp_syn; }; /* WOWLAN_PATTERN_API_U_VER_1 */ /** * struct iwl_wowlan_pattern_v2 - Pattern entry for the WoWLAN wakeup patterns */ struct iwl_wowlan_pattern_v2 { /** * @pattern_type: defines the struct type to be used in the union */ u8 pattern_type; /** * @reserved: reserved for alignment */ u8 reserved[3]; /** * @u: the union containing the match data, or undefined for * wildcard matches */ union iwl_wowlan_pattern_data u; } __packed; /* WOWLAN_PATTERN_API_S_VER_2 */ /** * struct iwl_wowlan_patterns_cmd - WoWLAN wakeup patterns command */ struct iwl_wowlan_patterns_cmd { /** * @n_patterns: number of patterns */ u8 n_patterns; /** * @sta_id: sta_id */ u8 sta_id; /** * @reserved: reserved for alignment */ __le16 reserved; /** * @patterns: the patterns, array length in @n_patterns */ struct iwl_wowlan_pattern_v2 patterns[]; } __packed; /* WOWLAN_PATTERN_ARRAY_API_S_VER_3 */ enum iwl_wowlan_wakeup_filters { IWL_WOWLAN_WAKEUP_MAGIC_PACKET = BIT(0), IWL_WOWLAN_WAKEUP_PATTERN_MATCH = BIT(1), IWL_WOWLAN_WAKEUP_BEACON_MISS = BIT(2), IWL_WOWLAN_WAKEUP_LINK_CHANGE = BIT(3), IWL_WOWLAN_WAKEUP_GTK_REKEY_FAIL = BIT(4), IWL_WOWLAN_WAKEUP_EAP_IDENT_REQ = BIT(5), IWL_WOWLAN_WAKEUP_4WAY_HANDSHAKE = BIT(6), IWL_WOWLAN_WAKEUP_ENABLE_NET_DETECT = BIT(7), IWL_WOWLAN_WAKEUP_RF_KILL_DEASSERT = BIT(8), IWL_WOWLAN_WAKEUP_REMOTE_LINK_LOSS = BIT(9), IWL_WOWLAN_WAKEUP_REMOTE_SIGNATURE_TABLE = BIT(10), IWL_WOWLAN_WAKEUP_REMOTE_TCP_EXTERNAL = BIT(11), IWL_WOWLAN_WAKEUP_REMOTE_WAKEUP_PACKET = BIT(12), IWL_WOWLAN_WAKEUP_IOAC_MAGIC_PACKET = BIT(13), IWL_WOWLAN_WAKEUP_HOST_TIMER = BIT(14), IWL_WOWLAN_WAKEUP_RX_FRAME = BIT(15), IWL_WOWLAN_WAKEUP_BCN_FILTERING = BIT(16), }; /* WOWLAN_WAKEUP_FILTER_API_E_VER_4 */ enum iwl_wowlan_flags { IS_11W_ASSOC = BIT(0), ENABLE_L3_FILTERING = BIT(1), ENABLE_NBNS_FILTERING = BIT(2), ENABLE_DHCP_FILTERING = BIT(3), ENABLE_STORE_BEACON = BIT(4), HAS_BEACON_PROTECTION = BIT(5), }; /** * struct iwl_wowlan_config_cmd_v6 - WoWLAN configuration (versions 5 and 6) * @wakeup_filter: filter from &enum iwl_wowlan_wakeup_filters * @non_qos_seq: non-QoS sequence counter to use next. * Reserved if the struct has version >= 6. * @qos_seq: QoS sequence counters to use next * @wowlan_ba_teardown_tids: bitmap of BA sessions to tear down * @is_11n_connection: indicates HT connection * @offloading_tid: TID reserved for firmware use * @flags: extra flags, see &enum iwl_wowlan_flags * @sta_id: station ID for wowlan. * @reserved: reserved */ struct iwl_wowlan_config_cmd_v6 { __le32 wakeup_filter; __le16 non_qos_seq; __le16 qos_seq[8]; u8 wowlan_ba_teardown_tids; u8 is_11n_connection; u8 offloading_tid; u8 flags; u8 sta_id; u8 reserved; } __packed; /* WOWLAN_CONFIG_API_S_VER_6 */ /** * struct iwl_wowlan_config_cmd - WoWLAN configuration * @wakeup_filter: filter from &enum iwl_wowlan_wakeup_filters * @wowlan_ba_teardown_tids: bitmap of BA sessions to tear down * @is_11n_connection: indicates HT connection * @offloading_tid: TID reserved for firmware use * @flags: extra flags, see &enum iwl_wowlan_flags * @sta_id: station ID for wowlan. * @reserved: reserved */ struct iwl_wowlan_config_cmd { __le32 wakeup_filter; u8 wowlan_ba_teardown_tids; u8 is_11n_connection; u8 offloading_tid; u8 flags; u8 sta_id; u8 reserved[3]; } __packed; /* WOWLAN_CONFIG_API_S_VER_7 */ #define IWL_NUM_RSC 16 #define WOWLAN_KEY_MAX_SIZE 32 #define WOWLAN_GTK_KEYS_NUM 2 #define WOWLAN_IGTK_KEYS_NUM 2 #define WOWLAN_IGTK_MIN_INDEX 4 #define WOWLAN_BIGTK_KEYS_NUM 2 #define WOWLAN_BIGTK_MIN_INDEX 6 /* * WOWLAN_TSC_RSC_PARAMS */ struct tkip_sc { __le16 iv16; __le16 pad; __le32 iv32; } __packed; /* TKIP_SC_API_U_VER_1 */ struct iwl_tkip_rsc_tsc { struct tkip_sc unicast_rsc[IWL_NUM_RSC]; struct tkip_sc multicast_rsc[IWL_NUM_RSC]; struct tkip_sc tsc; } __packed; /* TKIP_TSC_RSC_API_S_VER_1 */ struct aes_sc { __le64 pn; } __packed; /* TKIP_AES_SC_API_U_VER_1 */ struct iwl_aes_rsc_tsc { struct aes_sc unicast_rsc[IWL_NUM_RSC]; struct aes_sc multicast_rsc[IWL_NUM_RSC]; struct aes_sc tsc; } __packed; /* AES_TSC_RSC_API_S_VER_1 */ union iwl_all_tsc_rsc { struct iwl_tkip_rsc_tsc tkip; struct iwl_aes_rsc_tsc aes; }; /* ALL_TSC_RSC_API_S_VER_2 */ struct iwl_wowlan_rsc_tsc_params_cmd_ver_2 { union iwl_all_tsc_rsc all_tsc_rsc; } __packed; /* ALL_TSC_RSC_API_S_VER_2 */ struct iwl_wowlan_rsc_tsc_params_cmd { __le64 ucast_rsc[IWL_MAX_TID_COUNT]; __le64 mcast_rsc[WOWLAN_GTK_KEYS_NUM][IWL_MAX_TID_COUNT]; __le32 sta_id; #define IWL_MCAST_KEY_MAP_INVALID 0xff u8 mcast_key_id_map[4]; } __packed; /* ALL_TSC_RSC_API_S_VER_5 */ #define IWL_MIC_KEY_SIZE 8 struct iwl_mic_keys { u8 tx[IWL_MIC_KEY_SIZE]; u8 rx_unicast[IWL_MIC_KEY_SIZE]; u8 rx_mcast[IWL_MIC_KEY_SIZE]; } __packed; /* MIC_KEYS_API_S_VER_1 */ #define IWL_P1K_SIZE 5 struct iwl_p1k_cache { __le16 p1k[IWL_P1K_SIZE]; } __packed; #define IWL_NUM_RX_P1K_CACHE 2 struct iwl_wowlan_tkip_params_cmd_ver_1 { struct iwl_mic_keys mic_keys; struct iwl_p1k_cache tx; struct iwl_p1k_cache rx_uni[IWL_NUM_RX_P1K_CACHE]; struct iwl_p1k_cache rx_multi[IWL_NUM_RX_P1K_CACHE]; } __packed; /* WOWLAN_TKIP_SETTING_API_S_VER_1 */ struct iwl_wowlan_tkip_params_cmd { struct iwl_mic_keys mic_keys; struct iwl_p1k_cache tx; struct iwl_p1k_cache rx_uni[IWL_NUM_RX_P1K_CACHE]; struct iwl_p1k_cache rx_multi[IWL_NUM_RX_P1K_CACHE]; u8 reversed[2]; __le32 sta_id; } __packed; /* WOWLAN_TKIP_SETTING_API_S_VER_2 */ #define IWL_KCK_MAX_SIZE 32 #define IWL_KEK_MAX_SIZE 32 struct iwl_wowlan_kek_kck_material_cmd_v2 { u8 kck[IWL_KCK_MAX_SIZE]; u8 kek[IWL_KEK_MAX_SIZE]; __le16 kck_len; __le16 kek_len; __le64 replay_ctr; } __packed; /* KEK_KCK_MATERIAL_API_S_VER_2 */ struct iwl_wowlan_kek_kck_material_cmd_v3 { u8 kck[IWL_KCK_MAX_SIZE]; u8 kek[IWL_KEK_MAX_SIZE]; __le16 kck_len; __le16 kek_len; __le64 replay_ctr; __le32 akm; __le32 gtk_cipher; __le32 igtk_cipher; __le32 bigtk_cipher; } __packed; /* KEK_KCK_MATERIAL_API_S_VER_3 */ struct iwl_wowlan_kek_kck_material_cmd_v4 { __le32 sta_id; u8 kck[IWL_KCK_MAX_SIZE]; u8 kek[IWL_KEK_MAX_SIZE]; __le16 kck_len; __le16 kek_len; __le64 replay_ctr; __le32 akm; __le32 gtk_cipher; __le32 igtk_cipher; __le32 bigtk_cipher; } __packed; /* KEK_KCK_MATERIAL_API_S_VER_4 */ struct iwl_wowlan_get_status_cmd { __le32 sta_id; } __packed; /* WOWLAN_GET_STATUSES_CMD_API_S_VER_1 */ #define RF_KILL_INDICATOR_FOR_WOWLAN 0x87 enum iwl_wowlan_rekey_status { IWL_WOWLAN_REKEY_POST_REKEY = 0, IWL_WOWLAN_REKEY_WHILE_REKEY = 1, }; /* WOWLAN_REKEY_STATUS_API_E_VER_1 */ enum iwl_wowlan_wakeup_reason { IWL_WOWLAN_WAKEUP_BY_NON_WIRELESS = 0, IWL_WOWLAN_WAKEUP_BY_MAGIC_PACKET = BIT(0), IWL_WOWLAN_WAKEUP_BY_PATTERN = BIT(1), IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_MISSED_BEACON = BIT(2), IWL_WOWLAN_WAKEUP_BY_DISCONNECTION_ON_DEAUTH = BIT(3), IWL_WOWLAN_WAKEUP_BY_GTK_REKEY_FAILURE = BIT(4), IWL_WOWLAN_WAKEUP_BY_RFKILL_DEASSERTED = BIT(5), IWL_WOWLAN_WAKEUP_BY_UCODE_ERROR = BIT(6), IWL_WOWLAN_WAKEUP_BY_EAPOL_REQUEST = BIT(7), IWL_WOWLAN_WAKEUP_BY_FOUR_WAY_HANDSHAKE = BIT(8), IWL_WOWLAN_WAKEUP_BY_REM_WAKE_LINK_LOSS = BIT(9), IWL_WOWLAN_WAKEUP_BY_REM_WAKE_SIGNATURE_TABLE = BIT(10), IWL_WOWLAN_WAKEUP_BY_REM_WAKE_TCP_EXTERNAL = BIT(11), IWL_WOWLAN_WAKEUP_BY_REM_WAKE_WAKEUP_PACKET = BIT(12), IWL_WOWLAN_WAKEUP_BY_IOAC_MAGIC_PACKET = BIT(13), IWL_WOWLAN_WAKEUP_BY_D3_WAKEUP_HOST_TIMER = BIT(14), IWL_WOWLAN_WAKEUP_BY_RXFRAME_FILTERED_IN = BIT(15), IWL_WOWLAN_WAKEUP_BY_BEACON_FILTERED_IN = BIT(16), IWL_WAKEUP_BY_11W_UNPROTECTED_DEAUTH_OR_DISASSOC = BIT(17), IWL_WAKEUP_BY_PATTERN_IPV4_TCP_SYN = BIT(18), IWL_WAKEUP_BY_PATTERN_IPV4_TCP_SYN_WILDCARD = BIT(19), IWL_WAKEUP_BY_PATTERN_IPV6_TCP_SYN = BIT(20), IWL_WAKEUP_BY_PATTERN_IPV6_TCP_SYN_WILDCARD = BIT(21), }; /* WOWLAN_WAKE_UP_REASON_API_E_VER_2 */ struct iwl_wowlan_gtk_status_v1 { u8 key_index; u8 reserved[3]; u8 decrypt_key[16]; u8 tkip_mic_key[8]; struct iwl_wowlan_rsc_tsc_params_cmd_ver_2 rsc; } __packed; /* WOWLAN_GTK_MATERIAL_VER_1 */ /** * struct iwl_wowlan_gtk_status_v2 - GTK status * @key: GTK material * @key_len: GTK legth, if set to 0, the key is not available * @key_flags: information about the key: * bits[0:1]: key index assigned by the AP * bits[2:6]: GTK index of the key in the internal DB * bit[7]: Set iff this is the currently used GTK * @reserved: padding * @tkip_mic_key: TKIP RX MIC key * @rsc: TSC RSC counters */ struct iwl_wowlan_gtk_status_v2 { u8 key[WOWLAN_KEY_MAX_SIZE]; u8 key_len; u8 key_flags; u8 reserved[2]; u8 tkip_mic_key[8]; struct iwl_wowlan_rsc_tsc_params_cmd_ver_2 rsc; } __packed; /* WOWLAN_GTK_MATERIAL_VER_2 */ /** * struct iwl_wowlan_all_rsc_tsc_v5 - key counters * @ucast_rsc: unicast RSC values * @mcast_rsc: multicast RSC values (per key map value) * @sta_id: station ID * @mcast_key_id_map: map of key id to @mcast_rsc entry */ struct iwl_wowlan_all_rsc_tsc_v5 { __le64 ucast_rsc[IWL_MAX_TID_COUNT]; __le64 mcast_rsc[2][IWL_MAX_TID_COUNT]; __le32 sta_id; u8 mcast_key_id_map[4]; } __packed; /* ALL_TSC_RSC_API_S_VER_5 */ /** * struct iwl_wowlan_gtk_status_v3 - GTK status * @key: GTK material * @key_len: GTK length, if set to 0, the key is not available * @key_flags: information about the key: * bits[0:1]: key index assigned by the AP * bits[2:6]: GTK index of the key in the internal DB * bit[7]: Set iff this is the currently used GTK * @reserved: padding * @tkip_mic_key: TKIP RX MIC key * @sc: RSC/TSC counters */ struct iwl_wowlan_gtk_status_v3 { u8 key[WOWLAN_KEY_MAX_SIZE]; u8 key_len; u8 key_flags; u8 reserved[2]; u8 tkip_mic_key[IWL_MIC_KEY_SIZE]; struct iwl_wowlan_all_rsc_tsc_v5 sc; } __packed; /* WOWLAN_GTK_MATERIAL_VER_3 */ /** * enum iwl_wowlan_key_status - Status of security keys in WoWLAN notifications * @IWL_WOWLAN_NOTIF_NO_KEY: No key is present; this entry should be ignored. * @IWL_WOWLAN_STATUS_OLD_KEY: old key exists; no rekey occurred, and only * metadata is available. * @IWL_WOWLAN_STATUS_NEW_KEY: A new key was created after a rekey; new key * material is available. */ enum iwl_wowlan_key_status { IWL_WOWLAN_NOTIF_NO_KEY = 0, IWL_WOWLAN_STATUS_OLD_KEY = 1, IWL_WOWLAN_STATUS_NEW_KEY = 2 }; /** * struct iwl_wowlan_gtk_status - GTK status * @key: GTK material * @key_len: GTK length, if set to 0, the key is not available * @key_flags: information about the key: * bits[0:1]: key index assigned by the AP * bits[2:6]: GTK index of the key in the internal DB * bit[7]: Set iff this is the currently used GTK * @key_status: key status, see &enum iwl_wowlan_key_status * @reserved: padding * @tkip_mic_key: TKIP RX MIC key * @sc: RSC/TSC counters */ struct iwl_wowlan_gtk_status { u8 key[WOWLAN_KEY_MAX_SIZE]; u8 key_len; u8 key_flags; u8 key_status; u8 reserved; u8 tkip_mic_key[IWL_MIC_KEY_SIZE]; struct iwl_wowlan_all_rsc_tsc_v5 sc; } __packed; /* WOWLAN_GTK_MATERIAL_VER_4 */ #define IWL_WOWLAN_GTK_IDX_MASK (BIT(0) | BIT(1)) #define IWL_WOWLAN_IGTK_BIGTK_IDX_MASK (BIT(0)) /** * struct iwl_wowlan_igtk_status_v1 - IGTK status * @key: IGTK material * @ipn: the IGTK packet number (replay counter) * @key_len: IGTK length, if set to 0, the key is not available * @key_flags: information about the key: * bits[0]: key index assigned by the AP (0: index 4, 1: index 5) * (0: index 6, 1: index 7 with bigtk) * bits[1:5]: IGTK index of the key in the internal DB * bit[6]: Set iff this is the currently used IGTK */ struct iwl_wowlan_igtk_status_v1 { u8 key[WOWLAN_KEY_MAX_SIZE]; u8 ipn[6]; u8 key_len; u8 key_flags; } __packed; /* WOWLAN_IGTK_MATERIAL_VER_1 */ /** * struct iwl_wowlan_igtk_status - IGTK status * @key: IGTK material * @ipn: the IGTK packet number (replay counter) * @key_len: IGTK length, if set to 0, the key is not available * @key_flags: information about the key: * bits[0]: key index assigned by the AP (0: index 4, 1: index 5) * (0: index 6, 1: index 7 with bigtk) * bits[1:5]: IGTK index of the key in the internal DB * bit[6]: Set iff this is the currently used IGTK * @key_status: key status, see &enum iwl_wowlan_key_status * @reserved: padding */ struct iwl_wowlan_igtk_status { u8 key[WOWLAN_KEY_MAX_SIZE]; u8 ipn[6]; u8 key_len; u8 key_flags; u8 key_status; u8 reserved[3]; } __packed; /* WOWLAN_IGTK_MATERIAL_VER_2 */ /** * struct iwl_wowlan_status_v6 - WoWLAN status * @gtk: GTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched pattern * @non_qos_seq_ctr: non-QoS sequence counter to use next * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @wake_packet_length: wakeup packet length * @wake_packet_bufsize: wakeup packet buffer size * @wake_packet: wakeup packet */ struct iwl_wowlan_status_v6 { struct iwl_wowlan_gtk_status_v1 gtk; __le64 replay_ctr; __le16 pattern_number; __le16 non_qos_seq_ctr; __le16 qos_seq_ctr[8]; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; __le32 wake_packet_length; __le32 wake_packet_bufsize; u8 wake_packet[]; /* can be truncated from _length to _bufsize */ } __packed; /* WOWLAN_STATUSES_API_S_VER_6 */ /** * struct iwl_wowlan_status_v7 - WoWLAN status * @gtk: GTK data * @igtk: IGTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched pattern * @non_qos_seq_ctr: non-QoS sequence counter to use next * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @wake_packet_length: wakeup packet length * @wake_packet_bufsize: wakeup packet buffer size * @wake_packet: wakeup packet */ struct iwl_wowlan_status_v7 { struct iwl_wowlan_gtk_status_v2 gtk[WOWLAN_GTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 igtk[WOWLAN_IGTK_KEYS_NUM]; __le64 replay_ctr; __le16 pattern_number; __le16 non_qos_seq_ctr; __le16 qos_seq_ctr[8]; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; __le32 wake_packet_length; __le32 wake_packet_bufsize; u8 wake_packet[]; /* can be truncated from _length to _bufsize */ } __packed; /* WOWLAN_STATUSES_API_S_VER_7 */ /** * struct iwl_wowlan_info_notif_v1 - WoWLAN information notification * @gtk: GTK data * @igtk: IGTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched patterns * @reserved1: reserved * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @wake_packet_length: wakeup packet length * @wake_packet_bufsize: wakeup packet buffer size * @tid_tear_down: bit mask of tids whose BA sessions were closed * in suspend state * @station_id: station id * @reserved2: reserved */ struct iwl_wowlan_info_notif_v1 { struct iwl_wowlan_gtk_status_v3 gtk[WOWLAN_GTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 igtk[WOWLAN_IGTK_KEYS_NUM]; __le64 replay_ctr; __le16 pattern_number; __le16 reserved1; __le16 qos_seq_ctr[8]; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; __le32 wake_packet_length; __le32 wake_packet_bufsize; u8 tid_tear_down; u8 station_id; u8 reserved2[2]; } __packed; /* WOWLAN_INFO_NTFY_API_S_VER_1 */ /* MAX MLO keys of non-active links that can arrive in the notification */ #define WOWLAN_MAX_MLO_KEYS 18 /** * enum iwl_wowlan_mlo_gtk_type - GTK types * @WOWLAN_MLO_GTK_KEY_TYPE_GTK: GTK * @WOWLAN_MLO_GTK_KEY_TYPE_IGTK: IGTK * @WOWLAN_MLO_GTK_KEY_TYPE_BIGTK: BIGTK * @WOWLAN_MLO_GTK_KEY_NUM_TYPES: number of key types */ enum iwl_wowlan_mlo_gtk_type { WOWLAN_MLO_GTK_KEY_TYPE_GTK, WOWLAN_MLO_GTK_KEY_TYPE_IGTK, WOWLAN_MLO_GTK_KEY_TYPE_BIGTK, WOWLAN_MLO_GTK_KEY_NUM_TYPES }; /* WOWLAN_MLO_GTK_KEY_TYPE_API_E_VER_1 */ /** * enum iwl_wowlan_mlo_gtk_flag - MLO GTK flags * @WOWLAN_MLO_GTK_FLAG_KEY_LEN_MSK: 0 for len 16, 1 for len 32 * @WOWLAN_MLO_GTK_FLAG_KEY_ID_MSK: key id (ranges from 0 to 7) * @WOWLAN_MLO_GTK_FLAG_LINK_ID_MSK: spec link id of the key * @WOWLAN_MLO_GTK_FLAG_KEY_TYPE_MSK: &enum iwl_wowlan_mlo_gtk_type * @WOWLAN_MLO_GTK_FLAG_LAST_KEY_MSK: is this the last given key per * key-type / link-id - the currently used key */ enum iwl_wowlan_mlo_gtk_flag { WOWLAN_MLO_GTK_FLAG_KEY_LEN_MSK = 0x0001, WOWLAN_MLO_GTK_FLAG_KEY_ID_MSK = 0x000E, WOWLAN_MLO_GTK_FLAG_LINK_ID_MSK = 0x00F0, WOWLAN_MLO_GTK_FLAG_KEY_TYPE_MSK = 0x0300, WOWLAN_MLO_GTK_FLAG_LAST_KEY_MSK = 0x0400 }; /* WOWLAN_MLO_GTK_FLAG_API_E_VER_1 */ /** * struct iwl_wowlan_mlo_gtk - MLO GTK info * @key: key material * @flags: &enum iwl_wowlan_mlo_gtk_flag * @pn: packet number */ struct iwl_wowlan_mlo_gtk { u8 key[WOWLAN_KEY_MAX_SIZE]; __le16 flags; u8 pn[6]; } __packed; /* WOWLAN_MLO_GTK_KEY_API_S_VER_1 */ /** * struct iwl_wowlan_info_notif_v3 - WoWLAN information notification * @gtk: GTK data * @igtk: IGTK data * @bigtk: BIGTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched patterns * @reserved1: reserved * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @tid_tear_down: bit mask of tids whose BA sessions were closed * in suspend state * @station_id: station id * @reserved2: reserved */ struct iwl_wowlan_info_notif_v3 { struct iwl_wowlan_gtk_status_v3 gtk[WOWLAN_GTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 igtk[WOWLAN_IGTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 bigtk[WOWLAN_BIGTK_KEYS_NUM]; __le64 replay_ctr; __le16 pattern_number; __le16 reserved1; __le16 qos_seq_ctr[8]; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; u8 tid_tear_down; u8 station_id; u8 reserved2[2]; } __packed; /* WOWLAN_INFO_NTFY_API_S_VER_3 */ /** * struct iwl_wowlan_info_notif_v5 - WoWLAN information notification * @gtk: GTK data * @igtk: IGTK data * @bigtk: BIGTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched patterns * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @tid_tear_down: bit mask of tids whose BA sessions were closed * in suspend state * @station_id: station id * @num_mlo_link_keys: number of &struct iwl_wowlan_mlo_gtk structs * following this notif * @tid_offloaded_tx: tid used by the firmware to transmit data packets * while in wowlan * @mlo_gtks: array of GTKs of size num_mlo_link_keys */ struct iwl_wowlan_info_notif_v5 { struct iwl_wowlan_gtk_status_v3 gtk[WOWLAN_GTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 igtk[WOWLAN_IGTK_KEYS_NUM]; struct iwl_wowlan_igtk_status_v1 bigtk[WOWLAN_BIGTK_KEYS_NUM]; __le64 replay_ctr; __le16 pattern_number; __le16 qos_seq_ctr; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; u8 tid_tear_down; u8 station_id; u8 num_mlo_link_keys; u8 tid_offloaded_tx; struct iwl_wowlan_mlo_gtk mlo_gtks[]; } __packed; /* WOWLAN_INFO_NTFY_API_S_VER_5 */ /** * struct iwl_wowlan_info_notif - WoWLAN information notification * @gtk: GTK data * @igtk: IGTK data * @bigtk: BIGTK data * @replay_ctr: GTK rekey replay counter * @pattern_number: number of the matched patterns * @qos_seq_ctr: QoS sequence counters to use next * @wakeup_reasons: wakeup reasons, see &enum iwl_wowlan_wakeup_reason * @num_of_gtk_rekeys: number of GTK rekeys * @transmitted_ndps: number of transmitted neighbor discovery packets * @received_beacons: number of received beacons * @tid_tear_down: bit mask of tids whose BA sessions were closed * in suspend state * @station_id: station id * @num_mlo_link_keys: number of &struct iwl_wowlan_mlo_gtk structs * following this notif * @tid_offloaded_tx: tid used by the firmware to transmit data packets * while in wowlan * @mlo_gtks: array of GTKs of size num_mlo_link_keys */ struct iwl_wowlan_info_notif { struct iwl_wowlan_gtk_status gtk[WOWLAN_GTK_KEYS_NUM]; struct iwl_wowlan_igtk_status igtk[WOWLAN_IGTK_KEYS_NUM]; struct iwl_wowlan_igtk_status bigtk[WOWLAN_BIGTK_KEYS_NUM]; __le64 replay_ctr; __le16 pattern_number; __le16 qos_seq_ctr; __le32 wakeup_reasons; __le32 num_of_gtk_rekeys; __le32 transmitted_ndps; __le32 received_beacons; u8 tid_tear_down; u8 station_id; u8 num_mlo_link_keys; u8 tid_offloaded_tx; struct iwl_wowlan_mlo_gtk mlo_gtks[]; } __packed; /* WOWLAN_INFO_NTFY_API_S_VER_6 */ /** * struct iwl_wowlan_wake_pkt_notif - WoWLAN wake packet notification * @wake_packet_length: wakeup packet length * @station_id: station id * @reserved: unused * @wake_packet: wakeup packet */ struct iwl_wowlan_wake_pkt_notif { __le32 wake_packet_length; u8 station_id; u8 reserved[3]; u8 wake_packet[1]; } __packed; /* WOWLAN_WAKE_PKT_NTFY_API_S_VER_1 */ /** * struct iwl_mvm_d3_end_notif - d3 end notification * @flags: See &enum iwl_d0i3_flags */ struct iwl_d3_end_notif { __le32 flags; } __packed; /* TODO: NetDetect API */ #endif /* __iwl_fw_api_d3_h__ */
