Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
0002 /*
0003  * Copyright (C) 2012-2014, 2018-2020 Intel Corporation
0004  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
0005  * Copyright (C) 2016-2017 Intel Deutschland GmbH
0006  */
0007 #ifndef __iwl_fw_api_datapath_h__
0008 #define __iwl_fw_api_datapath_h__
0009 
0010 /**
0011  * enum iwl_data_path_subcmd_ids - data path group commands
0012  */
0013 enum iwl_data_path_subcmd_ids {
0014     /**
0015      * @DQA_ENABLE_CMD: &struct iwl_dqa_enable_cmd
0016      */
0017     DQA_ENABLE_CMD = 0x0,
0018 
0019     /**
0020      * @UPDATE_MU_GROUPS_CMD: &struct iwl_mu_group_mgmt_cmd
0021      */
0022     UPDATE_MU_GROUPS_CMD = 0x1,
0023 
0024     /**
0025      * @TRIGGER_RX_QUEUES_NOTIF_CMD: &struct iwl_rxq_sync_cmd
0026      */
0027     TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
0028 
0029     /**
0030      * @STA_HE_CTXT_CMD: &struct iwl_he_sta_context_cmd
0031      */
0032     STA_HE_CTXT_CMD = 0x7,
0033 
0034     /**
0035      * @RLC_CONFIG_CMD: &struct iwl_rlc_config_cmd
0036      */
0037     RLC_CONFIG_CMD = 0x8,
0038 
0039     /**
0040      * @RFH_QUEUE_CONFIG_CMD: &struct iwl_rfh_queue_config
0041      */
0042     RFH_QUEUE_CONFIG_CMD = 0xD,
0043 
0044     /**
0045      * @TLC_MNG_CONFIG_CMD: &struct iwl_tlc_config_cmd_v4
0046      */
0047     TLC_MNG_CONFIG_CMD = 0xF,
0048 
0049     /**
0050      * @HE_AIR_SNIFFER_CONFIG_CMD: &struct iwl_he_monitor_cmd
0051      */
0052     HE_AIR_SNIFFER_CONFIG_CMD = 0x13,
0053 
0054     /**
0055      * @CHEST_COLLECTOR_FILTER_CONFIG_CMD: Configure the CSI
0056      *  matrix collection, uses &struct iwl_channel_estimation_cfg
0057      */
0058     CHEST_COLLECTOR_FILTER_CONFIG_CMD = 0x14,
0059 
0060     /**
0061      * @RX_BAID_ALLOCATION_CONFIG_CMD: Allocate/deallocate a BAID for an RX
0062      *  blockack session, uses &struct iwl_rx_baid_cfg_cmd for the
0063      *  command, and &struct iwl_rx_baid_cfg_resp as a response.
0064      */
0065     RX_BAID_ALLOCATION_CONFIG_CMD = 0x16,
0066 
0067     /**
0068      * @SCD_QUEUE_CONFIG_CMD: new scheduler queue allocation/config/removal
0069      *  command, uses &struct iwl_scd_queue_cfg_cmd and the response
0070      *  is (same as before) &struct iwl_tx_queue_cfg_rsp.
0071      */
0072     SCD_QUEUE_CONFIG_CMD = 0x17,
0073 
0074     /**
0075      * @MONITOR_NOTIF: Datapath monitoring notification, using
0076      *  &struct iwl_datapath_monitor_notif
0077      */
0078     MONITOR_NOTIF = 0xF4,
0079 
0080     /**
0081      * @RX_NO_DATA_NOTIF: &struct iwl_rx_no_data
0082      */
0083     RX_NO_DATA_NOTIF = 0xF5,
0084 
0085     /**
0086      * @THERMAL_DUAL_CHAIN_DISABLE_REQ: firmware request for SMPS mode,
0087      *  &struct iwl_thermal_dual_chain_request
0088      */
0089     THERMAL_DUAL_CHAIN_REQUEST = 0xF6,
0090 
0091     /**
0092      * @TLC_MNG_UPDATE_NOTIF: &struct iwl_tlc_update_notif
0093      */
0094     TLC_MNG_UPDATE_NOTIF = 0xF7,
0095 
0096     /**
0097      * @STA_PM_NOTIF: &struct iwl_mvm_pm_state_notification
0098      */
0099     STA_PM_NOTIF = 0xFD,
0100 
0101     /**
0102      * @MU_GROUP_MGMT_NOTIF: &struct iwl_mu_group_mgmt_notif
0103      */
0104     MU_GROUP_MGMT_NOTIF = 0xFE,
0105 
0106     /**
0107      * @RX_QUEUES_NOTIFICATION: &struct iwl_rxq_sync_notification
0108      */
0109     RX_QUEUES_NOTIFICATION = 0xFF,
0110 };
0111 
0112 /**
0113  * struct iwl_mu_group_mgmt_cmd - VHT MU-MIMO group configuration
0114  *
0115  * @reserved: reserved
0116  * @membership_status: a bitmap of MU groups
0117  * @user_position:the position of station in a group. If the station is in the
0118  *  group then bits (group * 2) is the position -1
0119  */
0120 struct iwl_mu_group_mgmt_cmd {
0121     __le32 reserved;
0122     __le32 membership_status[2];
0123     __le32 user_position[4];
0124 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
0125 
0126 /**
0127  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
0128  *
0129  * @membership_status: a bitmap of MU groups
0130  * @user_position: the position of station in a group. If the station is in the
0131  *  group then bits (group * 2) is the position -1
0132  */
0133 struct iwl_mu_group_mgmt_notif {
0134     __le32 membership_status[2];
0135     __le32 user_position[4];
0136 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
0137 
0138 enum iwl_channel_estimation_flags {
0139     IWL_CHANNEL_ESTIMATION_ENABLE   = BIT(0),
0140     IWL_CHANNEL_ESTIMATION_TIMER    = BIT(1),
0141     IWL_CHANNEL_ESTIMATION_COUNTER  = BIT(2),
0142 };
0143 
0144 /**
0145  * struct iwl_channel_estimation_cfg - channel estimation reporting config
0146  */
0147 struct iwl_channel_estimation_cfg {
0148     /**
0149      * @flags: flags, see &enum iwl_channel_estimation_flags
0150      */
0151     __le32 flags;
0152     /**
0153      * @timer: if enabled via flags, automatically disable after this many
0154      *  microseconds
0155      */
0156     __le32 timer;
0157     /**
0158      * @count: if enabled via flags, automatically disable after this many
0159      *  frames with channel estimation matrix were captured
0160      */
0161     __le32 count;
0162     /**
0163      * @rate_n_flags_mask: only try to record the channel estimation matrix
0164      *  if the rate_n_flags value for the received frame (let's call
0165      *  that rx_rnf) matches the mask/value given here like this:
0166      *  (rx_rnf & rate_n_flags_mask) == rate_n_flags_val.
0167      */
0168     __le32 rate_n_flags_mask;
0169     /**
0170      * @rate_n_flags_val: see @rate_n_flags_mask
0171      */
0172     __le32 rate_n_flags_val;
0173     /**
0174      * @reserved: reserved (for alignment)
0175      */
0176     __le32 reserved;
0177     /**
0178      * @frame_types: bitmap of frame types to capture, the received frame's
0179      *  subtype|type takes 6 bits in the frame and the corresponding bit
0180      *  in this field must be set to 1 to capture channel estimation for
0181      *  that frame type. Set to all-ones to enable capturing for all
0182      *  frame types.
0183      */
0184     __le64 frame_types;
0185 } __packed; /* CHEST_COLLECTOR_FILTER_CMD_API_S_VER_1 */
0186 
0187 enum iwl_datapath_monitor_notif_type {
0188     IWL_DP_MON_NOTIF_TYPE_EXT_CCA,
0189 };
0190 
0191 struct iwl_datapath_monitor_notif {
0192     __le32 type;
0193     u8 mac_id;
0194     u8 reserved[3];
0195 } __packed; /* MONITOR_NTF_API_S_VER_1 */
0196 
0197 /**
0198  * enum iwl_thermal_dual_chain_req_events - firmware SMPS request event
0199  * @THERMAL_DUAL_CHAIN_REQ_ENABLE: (re-)enable dual-chain operation
0200  *  (subject to other constraints)
0201  * @THERMAL_DUAL_CHAIN_REQ_DISABLE: disable dual-chain operation
0202  *  (static SMPS)
0203  */
0204 enum iwl_thermal_dual_chain_req_events {
0205     THERMAL_DUAL_CHAIN_REQ_ENABLE,
0206     THERMAL_DUAL_CHAIN_REQ_DISABLE,
0207 }; /* THERMAL_DUAL_CHAIN_DISABLE_STATE_API_E_VER_1 */
0208 
0209 /**
0210  * struct iwl_thermal_dual_chain_request - SMPS request
0211  * @event: the type of request, see &enum iwl_thermal_dual_chain_req_events
0212  */
0213 struct iwl_thermal_dual_chain_request {
0214     __le32 event;
0215 } __packed; /* THERMAL_DUAL_CHAIN_DISABLE_REQ_NTFY_API_S_VER_1 */
0216 
0217 enum iwl_rlc_chain_info {
0218     IWL_RLC_CHAIN_INFO_DRIVER_FORCE     = BIT(0),
0219     IWL_RLC_CHAIN_INFO_VALID        = 0x000e,
0220     IWL_RLC_CHAIN_INFO_FORCE        = 0x0070,
0221     IWL_RLC_CHAIN_INFO_FORCE_MIMO       = 0x0380,
0222     IWL_RLC_CHAIN_INFO_COUNT        = 0x0c00,
0223     IWL_RLC_CHAIN_INFO_MIMO_COUNT       = 0x3000,
0224 };
0225 
0226 /**
0227  * struct iwl_rlc_properties - RLC properties
0228  * @rx_chain_info: RX chain info, &enum iwl_rlc_chain_info
0229  * @reserved: reserved
0230  */
0231 struct iwl_rlc_properties {
0232     __le32 rx_chain_info;
0233     __le32 reserved;
0234 } __packed; /* RLC_PROPERTIES_S_VER_1 */
0235 
0236 enum iwl_sad_mode {
0237     IWL_SAD_MODE_ENABLED        = BIT(0),
0238     IWL_SAD_MODE_DEFAULT_ANT_MSK    = 0x6,
0239     IWL_SAD_MODE_DEFAULT_ANT_FW = 0x0,
0240     IWL_SAD_MODE_DEFAULT_ANT_A  = 0x2,
0241     IWL_SAD_MODE_DEFAULT_ANT_B  = 0x4,
0242 };
0243 
0244 /**
0245  * struct iwl_sad_properties - SAD properties
0246  * @chain_a_sad_mode: chain A SAD mode, &enum iwl_sad_mode
0247  * @chain_b_sad_mode: chain B SAD mode, &enum iwl_sad_mode
0248  * @mac_id: MAC index
0249  * @reserved: reserved
0250  */
0251 struct iwl_sad_properties {
0252     __le32 chain_a_sad_mode;
0253     __le32 chain_b_sad_mode;
0254     __le32 mac_id;
0255     __le32 reserved;
0256 } __packed;
0257 
0258 /**
0259  * struct iwl_rlc_config_cmd - RLC configuration
0260  * @phy_id: PHY index
0261  * @rlc: RLC properties, &struct iwl_rlc_properties
0262  * @sad: SAD (single antenna diversity) options, &struct iwl_sad_properties
0263  * @flags: flags, &enum iwl_rlc_flags
0264  * @reserved: reserved
0265  */
0266 struct iwl_rlc_config_cmd {
0267     __le32 phy_id;
0268     struct iwl_rlc_properties rlc;
0269     struct iwl_sad_properties sad;
0270     u8 flags;
0271     u8 reserved[3];
0272 } __packed; /* RLC_CONFIG_CMD_API_S_VER_2 */
0273 
0274 #define IWL_MAX_BAID_OLD    16 /* MAX_IMMEDIATE_BA_API_D_VER_2 */
0275 #define IWL_MAX_BAID        32 /* MAX_IMMEDIATE_BA_API_D_VER_3 */
0276 
0277 /**
0278  * enum iwl_rx_baid_action - BAID allocation/config action
0279  * @IWL_RX_BAID_ACTION_ADD: add a new BAID session
0280  * @IWL_RX_BAID_ACTION_MODIFY: modify the BAID session
0281  * @IWL_RX_BAID_ACTION_REMOVE: remove the BAID session
0282  */
0283 enum iwl_rx_baid_action {
0284     IWL_RX_BAID_ACTION_ADD,
0285     IWL_RX_BAID_ACTION_MODIFY,
0286     IWL_RX_BAID_ACTION_REMOVE,
0287 }; /*  RX_BAID_ALLOCATION_ACTION_E_VER_1 */
0288 
0289 /**
0290  * struct iwl_rx_baid_cfg_cmd_alloc - BAID allocation data
0291  * @sta_id_mask: station ID mask
0292  * @tid: the TID for this session
0293  * @reserved: reserved
0294  * @ssn: the starting sequence number
0295  * @win_size: RX BA session window size
0296  */
0297 struct iwl_rx_baid_cfg_cmd_alloc {
0298     __le32 sta_id_mask;
0299     u8 tid;
0300     u8 reserved[3];
0301     __le16 ssn;
0302     __le16 win_size;
0303 } __packed; /* RX_BAID_ALLOCATION_ADD_CMD_API_S_VER_1 */
0304 
0305 /**
0306  * struct iwl_rx_baid_cfg_cmd_modify - BAID modification data
0307  * @old_sta_id_mask: old station ID mask
0308  * @new_sta_id_mask: new station ID mask
0309  * @tid: TID of the BAID
0310  */
0311 struct iwl_rx_baid_cfg_cmd_modify {
0312     __le32 old_sta_id_mask;
0313     __le32 new_sta_id_mask;
0314     __le32 tid;
0315 } __packed; /* RX_BAID_ALLOCATION_MODIFY_CMD_API_S_VER_2 */
0316 
0317 /**
0318  * struct iwl_rx_baid_cfg_cmd_remove_v1 - BAID removal data
0319  * @baid: the BAID to remove
0320  */
0321 struct iwl_rx_baid_cfg_cmd_remove_v1 {
0322     __le32 baid;
0323 } __packed; /* RX_BAID_ALLOCATION_REMOVE_CMD_API_S_VER_1 */
0324 
0325 /**
0326  * struct iwl_rx_baid_cfg_cmd_remove - BAID removal data
0327  * @sta_id_mask: the station mask of the BAID to remove
0328  * @tid: the TID of the BAID to remove
0329  */
0330 struct iwl_rx_baid_cfg_cmd_remove {
0331     __le32 sta_id_mask;
0332     __le32 tid;
0333 } __packed; /* RX_BAID_ALLOCATION_REMOVE_CMD_API_S_VER_2 */
0334 
0335 /**
0336  * struct iwl_rx_baid_cfg_cmd - BAID allocation/config command
0337  * @action: the action, from &enum iwl_rx_baid_action
0338  */
0339 struct iwl_rx_baid_cfg_cmd {
0340     __le32 action;
0341     union {
0342         struct iwl_rx_baid_cfg_cmd_alloc alloc;
0343         struct iwl_rx_baid_cfg_cmd_modify modify;
0344         struct iwl_rx_baid_cfg_cmd_remove_v1 remove_v1;
0345         struct iwl_rx_baid_cfg_cmd_remove remove;
0346     }; /* RX_BAID_ALLOCATION_OPERATION_API_U_VER_2 */
0347 } __packed; /* RX_BAID_ALLOCATION_CONFIG_CMD_API_S_VER_2 */
0348 
0349 /**
0350  * struct iwl_rx_baid_cfg_resp - BAID allocation response
0351  * @baid: the allocated BAID
0352  */
0353 struct iwl_rx_baid_cfg_resp {
0354     __le32 baid;
0355 }; /* RX_BAID_ALLOCATION_RESPONSE_API_S_VER_1 */
0356 
0357 /**
0358  * enum iwl_scd_queue_cfg_operation - scheduler queue operation
0359  * @IWL_SCD_QUEUE_ADD: allocate a new queue
0360  * @IWL_SCD_QUEUE_REMOVE: remove a queue
0361  * @IWL_SCD_QUEUE_MODIFY: modify a queue
0362  */
0363 enum iwl_scd_queue_cfg_operation {
0364     IWL_SCD_QUEUE_ADD = 0,
0365     IWL_SCD_QUEUE_REMOVE = 1,
0366     IWL_SCD_QUEUE_MODIFY = 2,
0367 };
0368 
0369 /**
0370  * struct iwl_scd_queue_cfg_cmd - scheduler queue allocation command
0371  * @operation: the operation, see &enum iwl_scd_queue_cfg_operation
0372  * @u.add.sta_mask: station mask
0373  * @u.add.tid: TID
0374  * @u.add.reserved: reserved
0375  * @u.add.flags: flags from &enum iwl_tx_queue_cfg_actions, except
0376  *  %TX_QUEUE_CFG_ENABLE_QUEUE is not valid
0377  * @u.add.cb_size: size code
0378  * @u.add.bc_dram_addr: byte-count table IOVA
0379  * @u.add.tfdq_dram_addr: TFD queue IOVA
0380  * @u.remove.queue: queue ID for removal
0381  * @u.modify.sta_mask: new station mask for modify
0382  * @u.modify.queue: queue ID to modify
0383  */
0384 struct iwl_scd_queue_cfg_cmd {
0385     __le32 operation;
0386     union {
0387         struct {
0388             __le32 sta_mask;
0389             u8 tid;
0390             u8 reserved[3];
0391             __le32 flags;
0392             __le32 cb_size;
0393             __le64 bc_dram_addr;
0394             __le64 tfdq_dram_addr;
0395         } __packed add; /* TX_QUEUE_CFG_CMD_ADD_API_S_VER_1 */
0396         struct {
0397             __le32 queue;
0398         } __packed remove; /* TX_QUEUE_CFG_CMD_REMOVE_API_S_VER_1 */
0399         struct {
0400             __le32 sta_mask;
0401             __le32 queue;
0402         } __packed modify; /* TX_QUEUE_CFG_CMD_MODIFY_API_S_VER_1 */
0403     } __packed u; /* TX_QUEUE_CFG_CMD_OPERATION_API_U_VER_1 */
0404 } __packed; /* TX_QUEUE_CFG_CMD_API_S_VER_3 */
0405 
0406 #endif /* __iwl_fw_api_datapath_h__ */