xref: /wlan-driver/fw-api/hw/peach/v1/expected_response.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 _EXPECTED_RESPONSE_H_
19*5113495bSYour Name #define _EXPECTED_RESPONSE_H_
20*5113495bSYour Name 
21*5113495bSYour Name #define NUM_OF_DWORDS_EXPECTED_RESPONSE 5
22*5113495bSYour Name 
23*5113495bSYour Name struct expected_response {
24*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25*5113495bSYour Name              uint32_t tx_ad2_31_0                                             : 32;
26*5113495bSYour Name              uint32_t tx_ad2_47_32                                            : 16,
27*5113495bSYour Name                       expected_response_type                                  :  5,
28*5113495bSYour Name                       response_to_response                                    :  3,
29*5113495bSYour Name                       su_ba_user_number                                       :  1,
30*5113495bSYour Name                       response_info_part2_required                            :  1,
31*5113495bSYour Name                       transmitted_bssid_check_en                              :  1,
32*5113495bSYour Name                       reserved_1                                              :  5;
33*5113495bSYour Name              uint32_t ndp_sta_partial_aid_2_8_0                               : 11,
34*5113495bSYour Name                       reserved_2                                              : 10,
35*5113495bSYour Name                       ndp_sta_partial_aid1_8_0                                : 11;
36*5113495bSYour Name              uint32_t ast_index                                               : 16,
37*5113495bSYour Name                       capture_ack_ba_sounding                                 :  1,
38*5113495bSYour Name                       capture_sounding_1str_20mhz                             :  1,
39*5113495bSYour Name                       capture_sounding_1str_40mhz                             :  1,
40*5113495bSYour Name                       capture_sounding_1str_80mhz                             :  1,
41*5113495bSYour Name                       capture_sounding_1str_160mhz                            :  1,
42*5113495bSYour Name                       capture_sounding_1str_240mhz                            :  1,
43*5113495bSYour Name                       capture_sounding_1str_320mhz                            :  1,
44*5113495bSYour Name                       reserved_3a                                             :  9;
45*5113495bSYour Name              uint32_t fcs                                                     :  9,
46*5113495bSYour Name                       reserved_4a                                             :  1,
47*5113495bSYour Name                       crc                                                     :  4,
48*5113495bSYour Name                       scrambler_seed                                          :  7,
49*5113495bSYour Name                       reserved_4b                                             : 11;
50*5113495bSYour Name #else
51*5113495bSYour Name              uint32_t tx_ad2_31_0                                             : 32;
52*5113495bSYour Name              uint32_t reserved_1                                              :  5,
53*5113495bSYour Name                       transmitted_bssid_check_en                              :  1,
54*5113495bSYour Name                       response_info_part2_required                            :  1,
55*5113495bSYour Name                       su_ba_user_number                                       :  1,
56*5113495bSYour Name                       response_to_response                                    :  3,
57*5113495bSYour Name                       expected_response_type                                  :  5,
58*5113495bSYour Name                       tx_ad2_47_32                                            : 16;
59*5113495bSYour Name              uint32_t ndp_sta_partial_aid1_8_0                                : 11,
60*5113495bSYour Name                       reserved_2                                              : 10,
61*5113495bSYour Name                       ndp_sta_partial_aid_2_8_0                               : 11;
62*5113495bSYour Name              uint32_t reserved_3a                                             :  9,
63*5113495bSYour Name                       capture_sounding_1str_320mhz                            :  1,
64*5113495bSYour Name                       capture_sounding_1str_240mhz                            :  1,
65*5113495bSYour Name                       capture_sounding_1str_160mhz                            :  1,
66*5113495bSYour Name                       capture_sounding_1str_80mhz                             :  1,
67*5113495bSYour Name                       capture_sounding_1str_40mhz                             :  1,
68*5113495bSYour Name                       capture_sounding_1str_20mhz                             :  1,
69*5113495bSYour Name                       capture_ack_ba_sounding                                 :  1,
70*5113495bSYour Name                       ast_index                                               : 16;
71*5113495bSYour Name              uint32_t reserved_4b                                             : 11,
72*5113495bSYour Name                       scrambler_seed                                          :  7,
73*5113495bSYour Name                       crc                                                     :  4,
74*5113495bSYour Name                       reserved_4a                                             :  1,
75*5113495bSYour Name                       fcs                                                     :  9;
76*5113495bSYour Name #endif
77*5113495bSYour Name };
78*5113495bSYour Name 
79*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_31_0_OFFSET                                        0x00000000
80*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_31_0_LSB                                           0
81*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_31_0_MSB                                           31
82*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_31_0_MASK                                          0xffffffff
83*5113495bSYour Name 
84*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_47_32_OFFSET                                       0x00000004
85*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_47_32_LSB                                          0
86*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_47_32_MSB                                          15
87*5113495bSYour Name #define EXPECTED_RESPONSE_TX_AD2_47_32_MASK                                         0x0000ffff
88*5113495bSYour Name 
89*5113495bSYour Name #define EXPECTED_RESPONSE_EXPECTED_RESPONSE_TYPE_OFFSET                             0x00000004
90*5113495bSYour Name #define EXPECTED_RESPONSE_EXPECTED_RESPONSE_TYPE_LSB                                16
91*5113495bSYour Name #define EXPECTED_RESPONSE_EXPECTED_RESPONSE_TYPE_MSB                                20
92*5113495bSYour Name #define EXPECTED_RESPONSE_EXPECTED_RESPONSE_TYPE_MASK                               0x001f0000
93*5113495bSYour Name 
94*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_TO_RESPONSE_OFFSET                               0x00000004
95*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_TO_RESPONSE_LSB                                  21
96*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_TO_RESPONSE_MSB                                  23
97*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_TO_RESPONSE_MASK                                 0x00e00000
98*5113495bSYour Name 
99*5113495bSYour Name #define EXPECTED_RESPONSE_SU_BA_USER_NUMBER_OFFSET                                  0x00000004
100*5113495bSYour Name #define EXPECTED_RESPONSE_SU_BA_USER_NUMBER_LSB                                     24
101*5113495bSYour Name #define EXPECTED_RESPONSE_SU_BA_USER_NUMBER_MSB                                     24
102*5113495bSYour Name #define EXPECTED_RESPONSE_SU_BA_USER_NUMBER_MASK                                    0x01000000
103*5113495bSYour Name 
104*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_INFO_PART2_REQUIRED_OFFSET                       0x00000004
105*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_INFO_PART2_REQUIRED_LSB                          25
106*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_INFO_PART2_REQUIRED_MSB                          25
107*5113495bSYour Name #define EXPECTED_RESPONSE_RESPONSE_INFO_PART2_REQUIRED_MASK                         0x02000000
108*5113495bSYour Name 
109*5113495bSYour Name #define EXPECTED_RESPONSE_TRANSMITTED_BSSID_CHECK_EN_OFFSET                         0x00000004
110*5113495bSYour Name #define EXPECTED_RESPONSE_TRANSMITTED_BSSID_CHECK_EN_LSB                            26
111*5113495bSYour Name #define EXPECTED_RESPONSE_TRANSMITTED_BSSID_CHECK_EN_MSB                            26
112*5113495bSYour Name #define EXPECTED_RESPONSE_TRANSMITTED_BSSID_CHECK_EN_MASK                           0x04000000
113*5113495bSYour Name 
114*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_1_OFFSET                                         0x00000004
115*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_1_LSB                                            27
116*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_1_MSB                                            31
117*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_1_MASK                                           0xf8000000
118*5113495bSYour Name 
119*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID_2_8_0_OFFSET                          0x00000008
120*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID_2_8_0_LSB                             0
121*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID_2_8_0_MSB                             10
122*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID_2_8_0_MASK                            0x000007ff
123*5113495bSYour Name 
124*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_2_OFFSET                                         0x00000008
125*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_2_LSB                                            11
126*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_2_MSB                                            20
127*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_2_MASK                                           0x001ff800
128*5113495bSYour Name 
129*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID1_8_0_OFFSET                           0x00000008
130*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID1_8_0_LSB                              21
131*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID1_8_0_MSB                              31
132*5113495bSYour Name #define EXPECTED_RESPONSE_NDP_STA_PARTIAL_AID1_8_0_MASK                             0xffe00000
133*5113495bSYour Name 
134*5113495bSYour Name #define EXPECTED_RESPONSE_AST_INDEX_OFFSET                                          0x0000000c
135*5113495bSYour Name #define EXPECTED_RESPONSE_AST_INDEX_LSB                                             0
136*5113495bSYour Name #define EXPECTED_RESPONSE_AST_INDEX_MSB                                             15
137*5113495bSYour Name #define EXPECTED_RESPONSE_AST_INDEX_MASK                                            0x0000ffff
138*5113495bSYour Name 
139*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_ACK_BA_SOUNDING_OFFSET                            0x0000000c
140*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_ACK_BA_SOUNDING_LSB                               16
141*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_ACK_BA_SOUNDING_MSB                               16
142*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_ACK_BA_SOUNDING_MASK                              0x00010000
143*5113495bSYour Name 
144*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_20MHZ_OFFSET                        0x0000000c
145*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_20MHZ_LSB                           17
146*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_20MHZ_MSB                           17
147*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_20MHZ_MASK                          0x00020000
148*5113495bSYour Name 
149*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_40MHZ_OFFSET                        0x0000000c
150*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_40MHZ_LSB                           18
151*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_40MHZ_MSB                           18
152*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_40MHZ_MASK                          0x00040000
153*5113495bSYour Name 
154*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_80MHZ_OFFSET                        0x0000000c
155*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_80MHZ_LSB                           19
156*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_80MHZ_MSB                           19
157*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_80MHZ_MASK                          0x00080000
158*5113495bSYour Name 
159*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_160MHZ_OFFSET                       0x0000000c
160*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_160MHZ_LSB                          20
161*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_160MHZ_MSB                          20
162*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_160MHZ_MASK                         0x00100000
163*5113495bSYour Name 
164*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_240MHZ_OFFSET                       0x0000000c
165*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_240MHZ_LSB                          21
166*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_240MHZ_MSB                          21
167*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_240MHZ_MASK                         0x00200000
168*5113495bSYour Name 
169*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_320MHZ_OFFSET                       0x0000000c
170*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_320MHZ_LSB                          22
171*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_320MHZ_MSB                          22
172*5113495bSYour Name #define EXPECTED_RESPONSE_CAPTURE_SOUNDING_1STR_320MHZ_MASK                         0x00400000
173*5113495bSYour Name 
174*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_3A_OFFSET                                        0x0000000c
175*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_3A_LSB                                           23
176*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_3A_MSB                                           31
177*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_3A_MASK                                          0xff800000
178*5113495bSYour Name 
179*5113495bSYour Name #define EXPECTED_RESPONSE_FCS_OFFSET                                                0x00000010
180*5113495bSYour Name #define EXPECTED_RESPONSE_FCS_LSB                                                   0
181*5113495bSYour Name #define EXPECTED_RESPONSE_FCS_MSB                                                   8
182*5113495bSYour Name #define EXPECTED_RESPONSE_FCS_MASK                                                  0x000001ff
183*5113495bSYour Name 
184*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4A_OFFSET                                        0x00000010
185*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4A_LSB                                           9
186*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4A_MSB                                           9
187*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4A_MASK                                          0x00000200
188*5113495bSYour Name 
189*5113495bSYour Name #define EXPECTED_RESPONSE_CRC_OFFSET                                                0x00000010
190*5113495bSYour Name #define EXPECTED_RESPONSE_CRC_LSB                                                   10
191*5113495bSYour Name #define EXPECTED_RESPONSE_CRC_MSB                                                   13
192*5113495bSYour Name #define EXPECTED_RESPONSE_CRC_MASK                                                  0x00003c00
193*5113495bSYour Name 
194*5113495bSYour Name #define EXPECTED_RESPONSE_SCRAMBLER_SEED_OFFSET                                     0x00000010
195*5113495bSYour Name #define EXPECTED_RESPONSE_SCRAMBLER_SEED_LSB                                        14
196*5113495bSYour Name #define EXPECTED_RESPONSE_SCRAMBLER_SEED_MSB                                        20
197*5113495bSYour Name #define EXPECTED_RESPONSE_SCRAMBLER_SEED_MASK                                       0x001fc000
198*5113495bSYour Name 
199*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4B_OFFSET                                        0x00000010
200*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4B_LSB                                           21
201*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4B_MSB                                           31
202*5113495bSYour Name #define EXPECTED_RESPONSE_RESERVED_4B_MASK                                          0xffe00000
203*5113495bSYour Name 
204*5113495bSYour Name #endif
205