xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/api/binding.h (revision a1ff5a7d78a036d6c2178ee5acd6ba4946243800)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2012-2014, 2020, 2022, 2024 Intel Corporation
4  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5  * Copyright (C) 2016-2017 Intel Deutschland GmbH
6  */
7 #ifndef __iwl_fw_api_binding_h__
8 #define __iwl_fw_api_binding_h__
9 
10 #include <fw/file.h>
11 #include <fw/img.h>
12 
13 #define MAX_MACS_IN_BINDING	(3)
14 #define MAX_BINDINGS		(4)
15 
16 /**
17  * struct iwl_binding_cmd_v1 - configuring bindings
18  * ( BINDING_CONTEXT_CMD = 0x2b )
19  * @id_and_color: ID and color of the relevant Binding,
20  *	&enum iwl_ctxt_id_and_color
21  * @action: action to perform, see &enum iwl_ctxt_action
22  * @macs: array of MAC id and colors which belong to the binding,
23  *	&enum iwl_ctxt_id_and_color
24  * @phy: PHY id and color which belongs to the binding,
25  *	&enum iwl_ctxt_id_and_color
26  */
27 struct iwl_binding_cmd_v1 {
28 	/* COMMON_INDEX_HDR_API_S_VER_1 */
29 	__le32 id_and_color;
30 	__le32 action;
31 	/* BINDING_DATA_API_S_VER_1 */
32 	__le32 macs[MAX_MACS_IN_BINDING];
33 	__le32 phy;
34 } __packed; /* BINDING_CMD_API_S_VER_1 */
35 
36 /**
37  * struct iwl_binding_cmd - configuring bindings
38  * ( BINDING_CONTEXT_CMD = 0x2b )
39  * @id_and_color: ID and color of the relevant Binding,
40  *	&enum iwl_ctxt_id_and_color
41  * @action: action to perform, see &enum iwl_ctxt_action
42  * @macs: array of MAC id and colors which belong to the binding
43  *	&enum iwl_ctxt_id_and_color
44  * @phy: PHY id and color which belongs to the binding
45  *	&enum iwl_ctxt_id_and_color
46  * @lmac_id: the lmac id the binding belongs to
47  */
48 struct iwl_binding_cmd {
49 	/* COMMON_INDEX_HDR_API_S_VER_1 */
50 	__le32 id_and_color;
51 	__le32 action;
52 	/* BINDING_DATA_API_S_VER_1 */
53 	__le32 macs[MAX_MACS_IN_BINDING];
54 	__le32 phy;
55 	__le32 lmac_id;
56 } __packed; /* BINDING_CMD_API_S_VER_2 */
57 
58 #define IWL_BINDING_CMD_SIZE_V1	sizeof(struct iwl_binding_cmd_v1)
59 #define IWL_LMAC_24G_INDEX		0
60 #define IWL_LMAC_5G_INDEX		1
61 
62 /* The maximal number of fragments in the FW's schedule session */
63 #define IWL_MVM_MAX_QUOTA 128
64 
65 /**
66  * struct iwl_time_quota_data_v1 - configuration of time quota per binding
67  * @id_and_color: ID and color of the relevant Binding,
68  *	&enum iwl_ctxt_id_and_color
69  * @quota: absolute time quota in TU. The scheduler will try to divide the
70  *	remainig quota (after Time Events) according to this quota.
71  * @max_duration: max uninterrupted context duration in TU
72  */
73 struct iwl_time_quota_data_v1 {
74 	__le32 id_and_color;
75 	__le32 quota;
76 	__le32 max_duration;
77 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
78 
79 /**
80  * struct iwl_time_quota_cmd_v1 - configuration of time quota between bindings
81  * ( TIME_QUOTA_CMD = 0x2c )
82  * @quotas: allocations per binding
83  * Note: on non-CDB the fourth one is the auxilary mac and is
84  *	essentially zero.
85  *	On CDB the fourth one is a regular binding.
86  */
87 struct iwl_time_quota_cmd_v1 {
88 	struct iwl_time_quota_data_v1 quotas[MAX_BINDINGS];
89 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
90 
91 enum iwl_quota_low_latency {
92 	IWL_QUOTA_LOW_LATENCY_NONE = 0,
93 	IWL_QUOTA_LOW_LATENCY_TX = BIT(0),
94 	IWL_QUOTA_LOW_LATENCY_RX = BIT(1),
95 	IWL_QUOTA_LOW_LATENCY_TX_RX =
96 		IWL_QUOTA_LOW_LATENCY_TX | IWL_QUOTA_LOW_LATENCY_RX,
97 };
98 
99 /**
100  * struct iwl_time_quota_data - configuration of time quota per binding
101  * @id_and_color: ID and color of the relevant Binding.
102  * @quota: absolute time quota in TU. The scheduler will try to divide the
103  *	remainig quota (after Time Events) according to this quota.
104  * @max_duration: max uninterrupted context duration in TU
105  * @low_latency: low latency status, &enum iwl_quota_low_latency
106  */
107 struct iwl_time_quota_data {
108 	__le32 id_and_color;
109 	__le32 quota;
110 	__le32 max_duration;
111 	__le32 low_latency;
112 } __packed; /* TIME_QUOTA_DATA_API_S_VER_2 */
113 
114 /**
115  * struct iwl_time_quota_cmd - configuration of time quota between bindings
116  * ( TIME_QUOTA_CMD = 0x2c )
117  * Note: on non-CDB the fourth one is the auxilary mac and is essentially zero.
118  * On CDB the fourth one is a regular binding.
119  *
120  * @quotas: allocations per binding
121  */
122 struct iwl_time_quota_cmd {
123 	struct iwl_time_quota_data quotas[MAX_BINDINGS];
124 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_2 */
125 
126 #endif /* __iwl_fw_api_binding_h__ */
127