drivers/net/wireless/intel/iwlwifi/fw/api/mac-cfg.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  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called COPYING.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <linuxwifi@intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  * BSD LICENSE
  29  *
  30  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  31  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  32  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  *
  39  *  * Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  *  * Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in
  43  *    the documentation and/or other materials provided with the
  44  *    distribution.
  45  *  * Neither the name Intel Corporation nor the names of its
  46  *    contributors may be used to endorse or promote products derived
  47  *    from this software without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  50  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  51  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  52  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  53  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  55  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  59  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  *
  61  *****************************************************************************/
  62
  63 #ifndef __iwl_fw_api_mac_cfg_h__
  64 #define __iwl_fw_api_mac_cfg_h__
  65
  66 /**
  67  * enum iwl_mac_conf_subcmd_ids - mac configuration command IDs
  68  */
  69 enum iwl_mac_conf_subcmd_ids {
  70         /**
  71          * @LINK_QUALITY_MEASUREMENT_CMD: &struct iwl_link_qual_msrmnt_cmd
  72          */
  73         LINK_QUALITY_MEASUREMENT_CMD = 0x1,
  74
  75         /**
  76          * @LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF:
  77          * &struct iwl_link_qual_msrmnt_notif
  78          */
  79         LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF = 0xFE,
  80
  81         /**
  82          * @CHANNEL_SWITCH_NOA_NOTIF: &struct iwl_channel_switch_noa_notif
  83          */
  84         CHANNEL_SWITCH_NOA_NOTIF = 0xFF,
  85 };
  86
  87 #define LQM_NUMBER_OF_STATIONS_IN_REPORT 16
  88
  89 enum iwl_lqm_cmd_operatrions {
  90         LQM_CMD_OPERATION_START_MEASUREMENT = 0x01,
  91         LQM_CMD_OPERATION_STOP_MEASUREMENT = 0x02,
  92 };
  93
  94 enum iwl_lqm_status {
  95         LQM_STATUS_SUCCESS = 0,
  96         LQM_STATUS_TIMEOUT = 1,
  97         LQM_STATUS_ABORT = 2,
  98 };
  99
 100 /**
 101  * struct iwl_link_qual_msrmnt_cmd - Link Quality Measurement command
 102  * @cmd_operation: command operation to be performed (start or stop)
 103  *      as defined above.
 104  * @mac_id: MAC ID the measurement applies to.
 105  * @measurement_time: time of the total measurement to be performed, in uSec.
 106  * @timeout: maximum time allowed until a response is sent, in uSec.
 107  */
 108 struct iwl_link_qual_msrmnt_cmd {
 109         __le32 cmd_operation;
 110         __le32 mac_id;
 111         __le32 measurement_time;
 112         __le32 timeout;
 113 } __packed /* LQM_CMD_API_S_VER_1 */;
 114
 115 /**
 116  * struct iwl_link_qual_msrmnt_notif - Link Quality Measurement notification
 117  *
 118  * @frequent_stations_air_time: an array containing the total air time
 119  *      (in uSec) used by the most frequently transmitting stations.
 120  * @number_of_stations: the number of uniqe stations included in the array
 121  *      (a number between 0 to 16)
 122  * @total_air_time_other_stations: the total air time (uSec) used by all the
 123  *      stations which are not included in the above report.
 124  * @time_in_measurement_window: the total time in uSec in which a measurement
 125  *      took place.
 126  * @tx_frame_dropped: the number of TX frames dropped due to retry limit during
 127  *      measurement
 128  * @mac_id: MAC ID the measurement applies to.
 129  * @status: return status. may be one of the LQM_STATUS_* defined above.
 130  * @reserved: reserved.
 131  */
 132 struct iwl_link_qual_msrmnt_notif {
 133         __le32 frequent_stations_air_time[LQM_NUMBER_OF_STATIONS_IN_REPORT];
 134         __le32 number_of_stations;
 135         __le32 total_air_time_other_stations;
 136         __le32 time_in_measurement_window;
 137         __le32 tx_frame_dropped;
 138         __le32 mac_id;
 139         __le32 status;
 140         u8 reserved[12];
 141 } __packed; /* LQM_MEASUREMENT_COMPLETE_NTF_API_S_VER1 */
 142
 143 /**
 144  * struct iwl_channel_switch_noa_notif - Channel switch NOA notification
 145  *
 146  * @id_and_color: ID and color of the MAC
 147  */
 148 struct iwl_channel_switch_noa_notif {
 149         __le32 id_and_color;
 150 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_1 */
 151
 152 #endif /* __iwl_fw_api_mac_cfg_h__ */