xref: /wlan-driver/fw-api/hw/kiwi/v1/rx_flow_search_entry.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name 
2*5113495bSYour Name /*
3*5113495bSYour Name  * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name #ifndef _RX_FLOW_SEARCH_ENTRY_H_
31*5113495bSYour Name #define _RX_FLOW_SEARCH_ENTRY_H_
32*5113495bSYour Name #if !defined(__ASSEMBLER__)
33*5113495bSYour Name #endif
34*5113495bSYour Name 
35*5113495bSYour Name #define NUM_OF_DWORDS_RX_FLOW_SEARCH_ENTRY 16
36*5113495bSYour Name 
37*5113495bSYour Name 
38*5113495bSYour Name struct rx_flow_search_entry {
39*5113495bSYour Name 	     uint32_t src_ip_127_96                                           : 32;
40*5113495bSYour Name 	     uint32_t src_ip_95_64                                            : 32;
41*5113495bSYour Name 	     uint32_t src_ip_63_32                                            : 32;
42*5113495bSYour Name 	     uint32_t src_ip_31_0                                             : 32;
43*5113495bSYour Name 	     uint32_t dest_ip_127_96                                          : 32;
44*5113495bSYour Name 	     uint32_t dest_ip_95_64                                           : 32;
45*5113495bSYour Name 	     uint32_t dest_ip_63_32                                           : 32;
46*5113495bSYour Name 	     uint32_t dest_ip_31_0                                            : 32;
47*5113495bSYour Name 	     uint32_t src_port                                                : 16,
48*5113495bSYour Name 		      dest_port                                               : 16;
49*5113495bSYour Name 	     uint32_t l4_protocol                                             :  8,
50*5113495bSYour Name 		      valid                                                   :  1,
51*5113495bSYour Name 		      reserved_9                                              : 14,
52*5113495bSYour Name 		      use_ppe                                                 :  1,
53*5113495bSYour Name 		      reo_destination_indication                              :  5,
54*5113495bSYour Name 		      msdu_drop                                               :  1,
55*5113495bSYour Name 		      reo_destination_handler                                 :  2;
56*5113495bSYour Name 	     uint32_t metadata                                                : 32;
57*5113495bSYour Name 	     uint32_t aggregation_count                                       :  7,
58*5113495bSYour Name 		      lro_eligible                                            :  1,
59*5113495bSYour Name 		      msdu_count                                              : 24;
60*5113495bSYour Name 	     uint32_t msdu_byte_count                                         : 32;
61*5113495bSYour Name 	     uint32_t timestamp                                               : 32;
62*5113495bSYour Name 	     uint32_t cumulative_l4_checksum                                  : 16,
63*5113495bSYour Name 		      cumulative_ip_length                                    : 16;
64*5113495bSYour Name 	     uint32_t tcp_sequence_number                                     : 32;
65*5113495bSYour Name };
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_127_96_OFFSET                                   0x00000000
71*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_127_96_LSB                                      0
72*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_127_96_MSB                                      31
73*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_127_96_MASK                                     0xffffffff
74*5113495bSYour Name 
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_95_64_OFFSET                                    0x00000004
79*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_95_64_LSB                                       0
80*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_95_64_MSB                                       31
81*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_95_64_MASK                                      0xffffffff
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 
86*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_63_32_OFFSET                                    0x00000008
87*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_63_32_LSB                                       0
88*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_63_32_MSB                                       31
89*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_63_32_MASK                                      0xffffffff
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_31_0_OFFSET                                     0x0000000c
95*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_31_0_LSB                                        0
96*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_31_0_MSB                                        31
97*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_IP_31_0_MASK                                       0xffffffff
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_127_96_OFFSET                                  0x00000010
103*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_127_96_LSB                                     0
104*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_127_96_MSB                                     31
105*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_127_96_MASK                                    0xffffffff
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_95_64_OFFSET                                   0x00000014
111*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_95_64_LSB                                      0
112*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_95_64_MSB                                      31
113*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_95_64_MASK                                     0xffffffff
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_63_32_OFFSET                                   0x00000018
119*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_63_32_LSB                                      0
120*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_63_32_MSB                                      31
121*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_63_32_MASK                                     0xffffffff
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_31_0_OFFSET                                    0x0000001c
127*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_31_0_LSB                                       0
128*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_31_0_MSB                                       31
129*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_IP_31_0_MASK                                      0xffffffff
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_PORT_OFFSET                                        0x00000020
135*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_PORT_LSB                                           0
136*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_PORT_MSB                                           15
137*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_SRC_PORT_MASK                                          0x0000ffff
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_PORT_OFFSET                                       0x00000020
143*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_PORT_LSB                                          16
144*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_PORT_MSB                                          31
145*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_DEST_PORT_MASK                                         0xffff0000
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name 
150*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_L4_PROTOCOL_OFFSET                                     0x00000024
151*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_L4_PROTOCOL_LSB                                        0
152*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_L4_PROTOCOL_MSB                                        7
153*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_L4_PROTOCOL_MASK                                       0x000000ff
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_VALID_OFFSET                                           0x00000024
159*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_VALID_LSB                                              8
160*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_VALID_MSB                                              8
161*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_VALID_MASK                                             0x00000100
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_RESERVED_9_OFFSET                                      0x00000024
167*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_RESERVED_9_LSB                                         9
168*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_RESERVED_9_MSB                                         22
169*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_RESERVED_9_MASK                                        0x007ffe00
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name 
174*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_USE_PPE_OFFSET                                         0x00000024
175*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_USE_PPE_LSB                                            23
176*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_USE_PPE_MSB                                            23
177*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_USE_PPE_MASK                                           0x00800000
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_INDICATION_OFFSET                      0x00000024
183*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_INDICATION_LSB                         24
184*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_INDICATION_MSB                         28
185*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_INDICATION_MASK                        0x1f000000
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_DROP_OFFSET                                       0x00000024
191*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_DROP_LSB                                          29
192*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_DROP_MSB                                          29
193*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_DROP_MASK                                         0x20000000
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_HANDLER_OFFSET                         0x00000024
199*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_HANDLER_LSB                            30
200*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_HANDLER_MSB                            31
201*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_REO_DESTINATION_HANDLER_MASK                           0xc0000000
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_METADATA_OFFSET                                        0x00000028
207*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_METADATA_LSB                                           0
208*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_METADATA_MSB                                           31
209*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_METADATA_MASK                                          0xffffffff
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name 
214*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_AGGREGATION_COUNT_OFFSET                               0x0000002c
215*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_AGGREGATION_COUNT_LSB                                  0
216*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_AGGREGATION_COUNT_MSB                                  6
217*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_AGGREGATION_COUNT_MASK                                 0x0000007f
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_LRO_ELIGIBLE_OFFSET                                    0x0000002c
223*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_LRO_ELIGIBLE_LSB                                       7
224*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_LRO_ELIGIBLE_MSB                                       7
225*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_LRO_ELIGIBLE_MASK                                      0x00000080
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 
229*5113495bSYour Name 
230*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_COUNT_OFFSET                                      0x0000002c
231*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_COUNT_LSB                                         8
232*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_COUNT_MSB                                         31
233*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_COUNT_MASK                                        0xffffff00
234*5113495bSYour Name 
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_BYTE_COUNT_OFFSET                                 0x00000030
239*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_BYTE_COUNT_LSB                                    0
240*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_BYTE_COUNT_MSB                                    31
241*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_MSDU_BYTE_COUNT_MASK                                   0xffffffff
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TIMESTAMP_OFFSET                                       0x00000034
247*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TIMESTAMP_LSB                                          0
248*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TIMESTAMP_MSB                                          31
249*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TIMESTAMP_MASK                                         0xffffffff
250*5113495bSYour Name 
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 
254*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_L4_CHECKSUM_OFFSET                          0x00000038
255*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_L4_CHECKSUM_LSB                             0
256*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_L4_CHECKSUM_MSB                             15
257*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_L4_CHECKSUM_MASK                            0x0000ffff
258*5113495bSYour Name 
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 
262*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_IP_LENGTH_OFFSET                            0x00000038
263*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_IP_LENGTH_LSB                               16
264*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_IP_LENGTH_MSB                               31
265*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_CUMULATIVE_IP_LENGTH_MASK                              0xffff0000
266*5113495bSYour Name 
267*5113495bSYour Name 
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TCP_SEQUENCE_NUMBER_OFFSET                             0x0000003c
271*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TCP_SEQUENCE_NUMBER_LSB                                0
272*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TCP_SEQUENCE_NUMBER_MSB                                31
273*5113495bSYour Name #define RX_FLOW_SEARCH_ENTRY_TCP_SEQUENCE_NUMBER_MASK                               0xffffffff
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name #endif
278