xref: /wlan-driver/fw-api/hw/peach/v2/rx_frame_bitmap_ack.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2023-2024 Qualcomm Innovation Center, Inc. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 
18 #ifndef _RX_FRAME_BITMAP_ACK_H_
19 #define _RX_FRAME_BITMAP_ACK_H_
20 
21 #define NUM_OF_DWORDS_RX_FRAME_BITMAP_ACK 13
22 
23 struct rx_frame_bitmap_ack {
24 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25              uint32_t no_bitmap_available                                     :  1,
26                       explicit_ack                                            :  1,
27                       explict_ack_type                                        :  3,
28                       ba_bitmap_size                                          :  2,
29                       reserved_0a                                             :  3,
30                       ba_tid                                                  :  4,
31                       sta_full_aid                                            : 13,
32                       reserved_0b                                             :  5;
33              uint32_t addr1_31_0                                              : 32;
34              uint32_t addr1_47_32                                             : 16,
35                       addr2_15_0                                              : 16;
36              uint32_t addr2_47_16                                             : 32;
37              uint32_t ba_ts_ctrl                                              : 16,
38                       ba_ts_seq                                               : 16;
39              uint32_t ba_ts_bitmap_31_0                                       : 32;
40              uint32_t ba_ts_bitmap_63_32                                      : 32;
41              uint32_t ba_ts_bitmap_95_64                                      : 32;
42              uint32_t ba_ts_bitmap_127_96                                     : 32;
43              uint32_t ba_ts_bitmap_159_128                                    : 32;
44              uint32_t ba_ts_bitmap_191_160                                    : 32;
45              uint32_t ba_ts_bitmap_223_192                                    : 32;
46              uint32_t ba_ts_bitmap_255_224                                    : 32;
47 #else
48              uint32_t reserved_0b                                             :  5,
49                       sta_full_aid                                            : 13,
50                       ba_tid                                                  :  4,
51                       reserved_0a                                             :  3,
52                       ba_bitmap_size                                          :  2,
53                       explict_ack_type                                        :  3,
54                       explicit_ack                                            :  1,
55                       no_bitmap_available                                     :  1;
56              uint32_t addr1_31_0                                              : 32;
57              uint32_t addr2_15_0                                              : 16,
58                       addr1_47_32                                             : 16;
59              uint32_t addr2_47_16                                             : 32;
60              uint32_t ba_ts_seq                                               : 16,
61                       ba_ts_ctrl                                              : 16;
62              uint32_t ba_ts_bitmap_31_0                                       : 32;
63              uint32_t ba_ts_bitmap_63_32                                      : 32;
64              uint32_t ba_ts_bitmap_95_64                                      : 32;
65              uint32_t ba_ts_bitmap_127_96                                     : 32;
66              uint32_t ba_ts_bitmap_159_128                                    : 32;
67              uint32_t ba_ts_bitmap_191_160                                    : 32;
68              uint32_t ba_ts_bitmap_223_192                                    : 32;
69              uint32_t ba_ts_bitmap_255_224                                    : 32;
70 #endif
71 };
72 
73 #define RX_FRAME_BITMAP_ACK_NO_BITMAP_AVAILABLE_OFFSET                              0x00000000
74 #define RX_FRAME_BITMAP_ACK_NO_BITMAP_AVAILABLE_LSB                                 0
75 #define RX_FRAME_BITMAP_ACK_NO_BITMAP_AVAILABLE_MSB                                 0
76 #define RX_FRAME_BITMAP_ACK_NO_BITMAP_AVAILABLE_MASK                                0x00000001
77 
78 #define RX_FRAME_BITMAP_ACK_EXPLICIT_ACK_OFFSET                                     0x00000000
79 #define RX_FRAME_BITMAP_ACK_EXPLICIT_ACK_LSB                                        1
80 #define RX_FRAME_BITMAP_ACK_EXPLICIT_ACK_MSB                                        1
81 #define RX_FRAME_BITMAP_ACK_EXPLICIT_ACK_MASK                                       0x00000002
82 
83 #define RX_FRAME_BITMAP_ACK_EXPLICT_ACK_TYPE_OFFSET                                 0x00000000
84 #define RX_FRAME_BITMAP_ACK_EXPLICT_ACK_TYPE_LSB                                    2
85 #define RX_FRAME_BITMAP_ACK_EXPLICT_ACK_TYPE_MSB                                    4
86 #define RX_FRAME_BITMAP_ACK_EXPLICT_ACK_TYPE_MASK                                   0x0000001c
87 
88 #define RX_FRAME_BITMAP_ACK_BA_BITMAP_SIZE_OFFSET                                   0x00000000
89 #define RX_FRAME_BITMAP_ACK_BA_BITMAP_SIZE_LSB                                      5
90 #define RX_FRAME_BITMAP_ACK_BA_BITMAP_SIZE_MSB                                      6
91 #define RX_FRAME_BITMAP_ACK_BA_BITMAP_SIZE_MASK                                     0x00000060
92 
93 #define RX_FRAME_BITMAP_ACK_RESERVED_0A_OFFSET                                      0x00000000
94 #define RX_FRAME_BITMAP_ACK_RESERVED_0A_LSB                                         7
95 #define RX_FRAME_BITMAP_ACK_RESERVED_0A_MSB                                         9
96 #define RX_FRAME_BITMAP_ACK_RESERVED_0A_MASK                                        0x00000380
97 
98 #define RX_FRAME_BITMAP_ACK_BA_TID_OFFSET                                           0x00000000
99 #define RX_FRAME_BITMAP_ACK_BA_TID_LSB                                              10
100 #define RX_FRAME_BITMAP_ACK_BA_TID_MSB                                              13
101 #define RX_FRAME_BITMAP_ACK_BA_TID_MASK                                             0x00003c00
102 
103 #define RX_FRAME_BITMAP_ACK_STA_FULL_AID_OFFSET                                     0x00000000
104 #define RX_FRAME_BITMAP_ACK_STA_FULL_AID_LSB                                        14
105 #define RX_FRAME_BITMAP_ACK_STA_FULL_AID_MSB                                        26
106 #define RX_FRAME_BITMAP_ACK_STA_FULL_AID_MASK                                       0x07ffc000
107 
108 #define RX_FRAME_BITMAP_ACK_RESERVED_0B_OFFSET                                      0x00000000
109 #define RX_FRAME_BITMAP_ACK_RESERVED_0B_LSB                                         27
110 #define RX_FRAME_BITMAP_ACK_RESERVED_0B_MSB                                         31
111 #define RX_FRAME_BITMAP_ACK_RESERVED_0B_MASK                                        0xf8000000
112 
113 #define RX_FRAME_BITMAP_ACK_ADDR1_31_0_OFFSET                                       0x00000004
114 #define RX_FRAME_BITMAP_ACK_ADDR1_31_0_LSB                                          0
115 #define RX_FRAME_BITMAP_ACK_ADDR1_31_0_MSB                                          31
116 #define RX_FRAME_BITMAP_ACK_ADDR1_31_0_MASK                                         0xffffffff
117 
118 #define RX_FRAME_BITMAP_ACK_ADDR1_47_32_OFFSET                                      0x00000008
119 #define RX_FRAME_BITMAP_ACK_ADDR1_47_32_LSB                                         0
120 #define RX_FRAME_BITMAP_ACK_ADDR1_47_32_MSB                                         15
121 #define RX_FRAME_BITMAP_ACK_ADDR1_47_32_MASK                                        0x0000ffff
122 
123 #define RX_FRAME_BITMAP_ACK_ADDR2_15_0_OFFSET                                       0x00000008
124 #define RX_FRAME_BITMAP_ACK_ADDR2_15_0_LSB                                          16
125 #define RX_FRAME_BITMAP_ACK_ADDR2_15_0_MSB                                          31
126 #define RX_FRAME_BITMAP_ACK_ADDR2_15_0_MASK                                         0xffff0000
127 
128 #define RX_FRAME_BITMAP_ACK_ADDR2_47_16_OFFSET                                      0x0000000c
129 #define RX_FRAME_BITMAP_ACK_ADDR2_47_16_LSB                                         0
130 #define RX_FRAME_BITMAP_ACK_ADDR2_47_16_MSB                                         31
131 #define RX_FRAME_BITMAP_ACK_ADDR2_47_16_MASK                                        0xffffffff
132 
133 #define RX_FRAME_BITMAP_ACK_BA_TS_CTRL_OFFSET                                       0x00000010
134 #define RX_FRAME_BITMAP_ACK_BA_TS_CTRL_LSB                                          0
135 #define RX_FRAME_BITMAP_ACK_BA_TS_CTRL_MSB                                          15
136 #define RX_FRAME_BITMAP_ACK_BA_TS_CTRL_MASK                                         0x0000ffff
137 
138 #define RX_FRAME_BITMAP_ACK_BA_TS_SEQ_OFFSET                                        0x00000010
139 #define RX_FRAME_BITMAP_ACK_BA_TS_SEQ_LSB                                           16
140 #define RX_FRAME_BITMAP_ACK_BA_TS_SEQ_MSB                                           31
141 #define RX_FRAME_BITMAP_ACK_BA_TS_SEQ_MASK                                          0xffff0000
142 
143 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_31_0_OFFSET                                0x00000014
144 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_31_0_LSB                                   0
145 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_31_0_MSB                                   31
146 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_31_0_MASK                                  0xffffffff
147 
148 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_63_32_OFFSET                               0x00000018
149 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_63_32_LSB                                  0
150 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_63_32_MSB                                  31
151 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_63_32_MASK                                 0xffffffff
152 
153 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_95_64_OFFSET                               0x0000001c
154 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_95_64_LSB                                  0
155 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_95_64_MSB                                  31
156 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_95_64_MASK                                 0xffffffff
157 
158 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_127_96_OFFSET                              0x00000020
159 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_127_96_LSB                                 0
160 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_127_96_MSB                                 31
161 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_127_96_MASK                                0xffffffff
162 
163 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_159_128_OFFSET                             0x00000024
164 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_159_128_LSB                                0
165 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_159_128_MSB                                31
166 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_159_128_MASK                               0xffffffff
167 
168 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_191_160_OFFSET                             0x00000028
169 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_191_160_LSB                                0
170 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_191_160_MSB                                31
171 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_191_160_MASK                               0xffffffff
172 
173 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_223_192_OFFSET                             0x0000002c
174 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_223_192_LSB                                0
175 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_223_192_MSB                                31
176 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_223_192_MASK                               0xffffffff
177 
178 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_255_224_OFFSET                             0x00000030
179 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_255_224_LSB                                0
180 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_255_224_MSB                                31
181 #define RX_FRAME_BITMAP_ACK_BA_TS_BITMAP_255_224_MASK                               0xffffffff
182 
183 #endif
184