drivers/net/wireless/intel/iwlwifi/fw/api/datapath.h

   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 - 2015 Intel Mobile Communications GmbH
  10  * Copyright(c) 2016 - 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 - 2015 Intel Mobile Communications GmbH
  33  * Copyright(c) 2016 - 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
  65 #ifndef __iwl_fw_api_datapath_h__
  66 #define __iwl_fw_api_datapath_h__
  67
  68 /**
  69  * enum iwl_data_path_subcmd_ids - data path group commands
  70  */
  71 enum iwl_data_path_subcmd_ids {
  72         /**
  73          * @DQA_ENABLE_CMD: &struct iwl_dqa_enable_cmd
  74          */
  75         DQA_ENABLE_CMD = 0x0,
  76
  77         /**
  78          * @UPDATE_MU_GROUPS_CMD: &struct iwl_mu_group_mgmt_cmd
  79          */
  80         UPDATE_MU_GROUPS_CMD = 0x1,
  81
  82         /**
  83          * @TRIGGER_RX_QUEUES_NOTIF_CMD: &struct iwl_rxq_sync_cmd
  84          */
  85         TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
  86
  87         /**
  88          * @STA_HE_CTXT_CMD: &struct iwl_he_sta_context_cmd
  89          */
  90         STA_HE_CTXT_CMD = 0x7,
  91
  92         /**
  93          * @RFH_QUEUE_CONFIG_CMD: &struct iwl_rfh_queue_config
  94          */
  95         RFH_QUEUE_CONFIG_CMD = 0xD,
  96
  97         /**
  98          * @TLC_MNG_CONFIG_CMD: &struct iwl_tlc_config_cmd
  99          */
 100         TLC_MNG_CONFIG_CMD = 0xF,
 101
 102         /**
 103          * @HE_AIR_SNIFFER_CONFIG_CMD: &struct iwl_he_monitor_cmd
 104          */
 105         HE_AIR_SNIFFER_CONFIG_CMD = 0x13,
 106
 107         /**
 108          * @CHEST_COLLECTOR_FILTER_CONFIG_CMD: Configure the CSI
 109          *      matrix collection, uses &struct iwl_channel_estimation_cfg
 110          */
 111         CHEST_COLLECTOR_FILTER_CONFIG_CMD = 0x14,
 112
 113         /**
 114          * @RX_NO_DATA_NOTIF: &struct iwl_rx_no_data
 115          */
 116         RX_NO_DATA_NOTIF = 0xF5,
 117
 118         /**
 119          * @TLC_MNG_UPDATE_NOTIF: &struct iwl_tlc_update_notif
 120          */
 121         TLC_MNG_UPDATE_NOTIF = 0xF7,
 122
 123         /**
 124          * @STA_PM_NOTIF: &struct iwl_mvm_pm_state_notification
 125          */
 126         STA_PM_NOTIF = 0xFD,
 127
 128         /**
 129          * @MU_GROUP_MGMT_NOTIF: &struct iwl_mu_group_mgmt_notif
 130          */
 131         MU_GROUP_MGMT_NOTIF = 0xFE,
 132
 133         /**
 134          * @RX_QUEUES_NOTIFICATION: &struct iwl_rxq_sync_notification
 135          */
 136         RX_QUEUES_NOTIFICATION = 0xFF,
 137 };
 138
 139 /**
 140  * struct iwl_mu_group_mgmt_cmd - VHT MU-MIMO group configuration
 141  *
 142  * @reserved: reserved
 143  * @membership_status: a bitmap of MU groups
 144  * @user_position:the position of station in a group. If the station is in the
 145  *      group then bits (group * 2) is the position -1
 146  */
 147 struct iwl_mu_group_mgmt_cmd {
 148         __le32 reserved;
 149         __le32 membership_status[2];
 150         __le32 user_position[4];
 151 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
 152
 153 /**
 154  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
 155  *
 156  * @membership_status: a bitmap of MU groups
 157  * @user_position: the position of station in a group. If the station is in the
 158  *      group then bits (group * 2) is the position -1
 159  */
 160 struct iwl_mu_group_mgmt_notif {
 161         __le32 membership_status[2];
 162         __le32 user_position[4];
 163 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
 164
 165 enum iwl_channel_estimation_flags {
 166         IWL_CHANNEL_ESTIMATION_ENABLE   = BIT(0),
 167         IWL_CHANNEL_ESTIMATION_TIMER    = BIT(1),
 168         IWL_CHANNEL_ESTIMATION_COUNTER  = BIT(2),
 169 };
 170
 171 /**
 172  * struct iwl_channel_estimation_cfg - channel estimation reporting config
 173  */
 174 struct iwl_channel_estimation_cfg {
 175         /**
 176          * @flags: flags, see &enum iwl_channel_estimation_flags
 177          */
 178         __le32 flags;
 179         /**
 180          * @timer: if enabled via flags, automatically disable after this many
 181          *      microseconds
 182          */
 183         __le32 timer;
 184         /**
 185          * @count: if enabled via flags, automatically disable after this many
 186          *      frames with channel estimation matrix were captured
 187          */
 188         __le32 count;
 189         /**
 190          * @rate_n_flags_mask: only try to record the channel estimation matrix
 191          *      if the rate_n_flags value for the received frame (let's call
 192          *      that rx_rnf) matches the mask/value given here like this:
 193          *      (rx_rnf & rate_n_flags_mask) == rate_n_flags_val.
 194          */
 195         __le32 rate_n_flags_mask;
 196         /**
 197          * @rate_n_flags_val: see @rate_n_flags_mask
 198          */
 199         __le32 rate_n_flags_val;
 200         /**
 201          * @reserved: reserved (for alignment)
 202          */
 203         __le32 reserved;
 204         /**
 205          * @frame_types: bitmap of frame types to capture, the received frame's
 206          *      subtype|type takes 6 bits in the frame and the corresponding bit
 207          *      in this field must be set to 1 to capture channel estimation for
 208          *      that frame type. Set to all-ones to enable capturing for all
 209          *      frame types.
 210          */
 211         __le64 frame_types;
 212 } __packed; /* CHEST_COLLECTOR_FILTER_CMD_API_S_VER_1 */
 213
 214 #endif /* __iwl_fw_api_datapath_h__ */