GNU Linux-libre 4.14.251-gnu1
[releases.git] / 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  *
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_datapath_h__
64 #define __iwl_fw_api_datapath_h__
65
66 /**
67  * enum iwl_data_path_subcmd_ids - data path group commands
68  */
69 enum iwl_data_path_subcmd_ids {
70         /**
71          * @DQA_ENABLE_CMD: &struct iwl_dqa_enable_cmd
72          */
73         DQA_ENABLE_CMD = 0x0,
74
75         /**
76          * @UPDATE_MU_GROUPS_CMD: &struct iwl_mu_group_mgmt_cmd
77          */
78         UPDATE_MU_GROUPS_CMD = 0x1,
79
80         /**
81          * @TRIGGER_RX_QUEUES_NOTIF_CMD: &struct iwl_rxq_sync_cmd
82          */
83         TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
84
85         /**
86          * @STA_PM_NOTIF: &struct iwl_mvm_pm_state_notification
87          */
88         STA_PM_NOTIF = 0xFD,
89
90         /**
91          * @MU_GROUP_MGMT_NOTIF: &struct iwl_mu_group_mgmt_notif
92          */
93         MU_GROUP_MGMT_NOTIF = 0xFE,
94
95         /**
96          * @RX_QUEUES_NOTIFICATION: &struct iwl_rxq_sync_notification
97          */
98         RX_QUEUES_NOTIFICATION = 0xFF,
99 };
100
101 /**
102  * struct iwl_mu_group_mgmt_cmd - VHT MU-MIMO group configuration
103  *
104  * @reserved: reserved
105  * @membership_status: a bitmap of MU groups
106  * @user_position:the position of station in a group. If the station is in the
107  *      group then bits (group * 2) is the position -1
108  */
109 struct iwl_mu_group_mgmt_cmd {
110         __le32 reserved;
111         __le32 membership_status[2];
112         __le32 user_position[4];
113 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
114
115 /**
116  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
117  *
118  * @membership_status: a bitmap of MU groups
119  * @user_position: the position of station in a group. If the station is in the
120  *      group then bits (group * 2) is the position -1
121  */
122 struct iwl_mu_group_mgmt_notif {
123         __le32 membership_status[2];
124         __le32 user_position[4];
125 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
126
127 #endif /* __iwl_fw_api_datapath_h__ */