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