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