quantenna/qtnfmac/qlink.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /* Copyright (c) 2015-2016 Quantenna Communications. All rights reserved. */
31  * enum qlink_msg_type - QLINK message types
49  * struct qlink_msg_header - common QLINK protocol message header
65  * enum qlink_hw_capab - device capabilities.
68  * @QLINK_HW_CAPAB_STA_INACT_TIMEOUT: device implements a logic to kick-out
91  * enum qlink_driver_capab - host driver capabilities.
108  * struct qlink_intf_info - information on virtual interface.
147  * struct qlink_channel - qlink control channel definition
149  * @hw_value: hardware-specific value for the channel
177  * struct qlink_chandef - qlink channel definition
211  * struct qlink_sta_info_state - station flags mask/value
213  * @mask: STA flags mask, bitmap of &enum qlink_sta_flags
217 	__le32 mask;  member
222  * enum qlink_sr_ctrl_flags - control flags for spatial reuse parameter set
224  * @QLINK_SR_PSR_DISALLOWED: indicates whether or not PSR-based spatial reuse
227  * Non-SRG OBSS PD spatial reuse transmissions are allowed for STAs associated
229  * @NON_SRG_OFFSET_PRESENT: indicates whether or not Non-SRG OBSS PD Max offset
230  * field is valid in the element
232  * Min/Max offset fields ore valid in the element
242  * struct qlink_sr_params - spatial reuse parameters
246  * @non_srg_obss_pd_max: added to -82 dBm to generate the value of the
247  * Non-SRG OBSS PD Max parameter
248  * @srg_obss_pd_min_offset: added to -82 dBm to generate the value of the
250  * @srg_obss_pd_max_offset: added to -82 dBm to generate the value of the
264  * enum qlink_cmd_type - list of supported commands
329  * struct qlink_cmd - QLINK command message header
352  * struct qlink_cmd_init_fw - data for QLINK_CMD_FW_INIT
369  * struct qlink_cmd_manage_intf - interface management command
399  * struct qlink_cmd_mgmt_frame_register - data for QLINK_CMD_REGISTER_MGMT
403  * @do_register: 0 - unregister, otherwise register for reception of specified
425  * struct qlink_cmd_frame_tx - data for QLINK_CMD_SEND_FRAME command
441  * struct qlink_cmd_get_sta_info - data for QLINK_CMD_GET_STA_INFO command
452  * struct qlink_cmd_add_key - data for QLINK_CMD_ADD_KEY command.
473  * struct qlink_cmd_del_key_req - data for QLINK_CMD_DEL_KEY command
487  * struct qlink_cmd_set_def_key - data for QLINK_CMD_SET_DEFAULT_KEY command
502  * struct qlink_cmd_set_def_mgmt_key - data for QLINK_CMD_SET_DEFAULT_MGMT_KEY
513  * struct qlink_cmd_change_sta - data for QLINK_CMD_CHANGE_STA command
530  * struct qlink_cmd_del_sta - data for QLINK_CMD_DEL_STA command.
549  * struct qlink_cmd_connect - data for QLINK_CMD_CONNECT command
585  * struct qlink_cmd_external_auth - data for QLINK_CMD_EXTERNAL_AUTH command
599  * struct qlink_cmd_disconnect - data for QLINK_CMD_DISCONNECT command
610  * struct qlink_cmd_updown - data for QLINK_CMD_UPDOWN_INTF command
622  * enum qlink_band - a list of frequency bands
635  * struct qlink_cmd_band_info_get - data for QLINK_CMD_BAND_INFO_GET command
646  * struct qlink_cmd_get_chan_stats - data for QLINK_CMD_CHAN_STATS command
656  * enum qlink_reg_initiator - Indicates the initiator of a reg domain request
668  * enum qlink_user_reg_hint_type - type of user regulatory hint
679  * struct qlink_cmd_reg_notify - data for QLINK_CMD_REG_NOTIFY command
705  * enum qlink_chan_sw_flags - channel switch control flags
718  * struct qlink_cmd_chan_switch - data for QLINK_CMD_CHAN_SWITCH command
735  * enum qlink_hidden_ssid - values for %NL80211_ATTR_HIDDEN_SSID
746  * struct qlink_cmd_start_ap - data for QLINK_CMD_START_AP command
780  * struct qlink_cmd_start_cac - data for QLINK_CMD_START_CAC command
801  * struct qlink_acl_data - ACL data
814  * enum qlink_pm_mode - Power Management mode
825  * struct qlink_cmd_pm_set - data for QLINK_CMD_PM_SET command
839  * enum qlink_txpwr_op - transmit power operation type
849  * struct qlink_cmd_txpwr - get or set current transmit power
867  * @QLINK_WOWLAN_TRIG_DISCONNECT: wakeup on disconnect
868  * @QLINK_WOWLAN_TRIG_MAGIC_PKT: wakeup on magic packet
869  * @QLINK_WOWLAN_TRIG_PATTERN_PKT: wakeup on user-defined packet
878  * struct qlink_cmd_wowlan_set - data for QLINK_CMD_WOWLAN_SET command
893  * struct qlink_cmd_ndev_event - data for QLINK_CMD_NDEV_EVENT command
909  * struct qlink_cmd_ndev_changeupper - data for QLINK_NDEV_EVENT_CHANGEUPPER
925  * enum qlink_scan_flags -  scan request control flags
937  * struct qlink_cmd_scan - data for QLINK_CMD_SCAN command
946  *	including off-channel dwell time and operating channel time.
965  * struct qlink_cmd_update_owe - data for QLINK_CMD_UPDATE_OWE_INFO command
993  * struct qlink_resp - QLINK command response message header
1017  * struct qlink_resp_init_fw - response for QLINK_CMD_FW_INIT
1027  * enum qlink_dfs_regions - regulatory DFS regions
1039  * struct qlink_resp_get_mac_info - response for QLINK_CMD_MAC_INFO command
1048  * @vht_cap_mod_mask: mask specifying which VHT capabilities can be altered.
1049  * @ht_cap_mod_mask: mask specifying which HT capabilities can be altered.
1058  * @var_info: variable-length WMAC info data.
1113  * struct qlink_resp_get_hw_info - response for QLINK_CMD_GET_HW_INFO command
1122  * @info: variable-length HW info.
1138  * struct qlink_resp_manage_intf - response for interface management commands
1159  * struct qlink_resp_get_sta_info - response for QLINK_CMD_GET_STA_INFO command
1174  * struct qlink_resp_band_info_get - response for QLINK_CMD_BAND_INFO_GET cmd
1179  * @info: variable-length info portion.
1191  * struct qlink_resp_get_chan_stats - response for QLINK_CMD_CHAN_STATS cmd
1194  * @info: variable-length channel info.
1203  * struct qlink_resp_channel_get - response for QLINK_CMD_CHAN_GET command
1213  * struct qlink_resp_txpwr - response for QLINK_CMD_TXPWR command
1244  * struct qlink_event - QLINK event message header
1263  * struct qlink_event_sta_assoc - data for QLINK_EVENT_STA_ASSOCIATED event
1277  * struct qlink_event_sta_deauth - data for QLINK_EVENT_STA_DEAUTH event
1289  * struct qlink_event_bss_join - data for QLINK_EVENT_BSS_JOIN event
1304  * struct qlink_event_bss_leave - data for QLINK_EVENT_BSS_LEAVE event
1315  * struct qlink_event_freq_change - data for QLINK_EVENT_FREQ_CHANGE event
1329  * struct qlink_event_rxmgmt - data for QLINK_EVENT_MGMT_RECEIVED event
1346  * struct qlink_event_scan_result - data for QLINK_EVENT_SCAN_RESULTS event
1374  * enum qlink_scan_complete_flags - indicates result of scan request.
1385  * struct qlink_event_scan_complete - data for QLINK_EVENT_SCAN_COMPLETE event
1405  * struct qlink_event_radar - data for QLINK_EVENT_RADAR event
1418  * struct qlink_event_external_auth - data for QLINK_EVENT_EXTERNAL_AUTH event
1436  * struct qlink_event_mic_failure - data for QLINK_EVENT_MIC_FAILURE event
1450  * struct qlink_event_update_owe - data for QLINK_EVENT_UPDATE_OWE event
1462 /* QLINK TLVs (Type-Length Values) definitions
1466  * enum qlink_tlv_id - list of TLVs that Qlink messages can carry
1471  *	QTN_TLV_ID_STA_STATS is valid.
1475  *	QTN_TLV_ID_CHANNEL_STATS is valid.
1476  * @QTN_TLV_ID_STA_STATS: per-STA statistics as defined by
1477  *	&struct qlink_sta_stats. Valid values are marked as such in a bitmap
1533  * enum qlink_reg_rule_flags - regulatory rule flags
1555  * struct qlink_tlv_reg_rule - data for QTN_TLV_ID_REG_RULE TLV
1602  * struct qlink_tlv_channel - data for QTN_TLV_ID_CHANNEL TLV
1614  * struct qlink_tlv_chandef - data for QTN_TLV_ID_CHANDEF TLV
1639  * struct qlink_tlv_ie_set - data for QTN_TLV_ID_IE_SET
1654  * struct qlink_tlv_ext_ie - extension IE
1675  * struct qlink_tlv_iftype_data - data for QTN_TLV_ID_IFTYPE_DATA
1688  * enum qlink_chan_stat - channel statistics bitmap
1691  * are valid. Individual values are used to fill a bitmap carried in a
1694  * @QLINK_CHAN_STAT_TIME_ON: time_on value is valid.
1695  * @QLINK_CHAN_STAT_TIME_TX: time_tx value is valid.
1696  * @QLINK_CHAN_STAT_TIME_RX: time_rx value is valid.
1697  * @QLINK_CHAN_STAT_CCA_BUSY: cca_busy value is valid.
1698  * @QLINK_CHAN_STAT_CCA_BUSY_EXT: cca_busy_ext value is valid.
1699  * @QLINK_CHAN_STAT_TIME_SCAN: time_scan value is valid.
1700  * @QLINK_CHAN_STAT_CHAN_NOISE: chan_noise value is valid.
1714  * struct qlink_chan_stats - data for QTN_TLV_ID_CHANNEL_STATS
1716  * Carries a per-channel statistics. Not all fields may be filled with
1717  * valid values. Valid fields should be indicated as such using a bitmap of
1741  * enum qlink_sta_info - station information bitmap
1744  * are valid. Individual values are used to fill a bitmap carried in a
1747  * @QLINK_STA_INFO_CONNECTED_TIME: connected_time value is valid.
1748  * @QLINK_STA_INFO_INACTIVE_TIME: inactive_time value is valid.
1749  * @QLINK_STA_INFO_RX_BYTES: lower 32 bits of rx_bytes value are valid.
1750  * @QLINK_STA_INFO_TX_BYTES: lower 32 bits of tx_bytes value are valid.
1751  * @QLINK_STA_INFO_RX_BYTES64: rx_bytes value is valid.
1752  * @QLINK_STA_INFO_TX_BYTES64: tx_bytes value is valid.
1753  * @QLINK_STA_INFO_RX_DROP_MISC: rx_dropped_misc value is valid.
1754  * @QLINK_STA_INFO_BEACON_RX: rx_beacon value is valid.
1755  * @QLINK_STA_INFO_SIGNAL: signal value is valid.
1756  * @QLINK_STA_INFO_SIGNAL_AVG: signal_avg value is valid.
1757  * @QLINK_STA_INFO_RX_BITRATE: rxrate value is valid.
1758  * @QLINK_STA_INFO_TX_BITRATE: txrate value is valid.
1759  * @QLINK_STA_INFO_RX_PACKETS: rx_packets value is valid.
1760  * @QLINK_STA_INFO_TX_PACKETS: tx_packets value is valid.
1761  * @QLINK_STA_INFO_TX_RETRIES: tx_retries value is valid.
1762  * @QLINK_STA_INFO_TX_FAILED: tx_failed value is valid.
1763  * @QLINK_STA_INFO_STA_FLAGS: sta_flags value is valid.
1787  * struct qlink_sta_info_rate - STA rate statistics
1791  * @mcs: 802.11-defined MCS index.
1804  * struct qlink_sta_stats - data for QTN_TLV_ID_STA_STATS
1807  * valid values. Valid fields should be indicated as such using a bitmap of
1842  * struct qlink_random_mac_addr - data for QTN_TLV_ID_RANDOM_MAC_ADDR TLV
1844  * Specifies MAC address mask/value for generation random MAC address
1848  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1849  *	are 0 in the mask should be randomised, bits that are 1 should
1858  * struct qlink_wowlan_capab_data - data for QTN_TLV_ID_WOWLAN_CAPAB TLV
1874  * struct qlink_wowlan_support - supported WoWLAN capabilities
1876  * @n_patterns: number of supported wakeup patterns