xref: /wlan-driver/fw-api/hw/peach/v2/tx_msdu_start.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023-2024 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 _TX_MSDU_START_H_
19*5113495bSYour Name #define _TX_MSDU_START_H_
20*5113495bSYour Name 
21*5113495bSYour Name #define NUM_OF_DWORDS_TX_MSDU_START 7
22*5113495bSYour Name 
23*5113495bSYour Name struct tx_msdu_start {
24*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25*5113495bSYour Name              uint32_t msdu_len                                                : 14,
26*5113495bSYour Name                       first_msdu                                              :  1,
27*5113495bSYour Name                       last_msdu                                               :  1,
28*5113495bSYour Name                       encap_type                                              :  2,
29*5113495bSYour Name                       epd_en                                                  :  1,
30*5113495bSYour Name                       da_sa_present                                           :  2,
31*5113495bSYour Name                       ipv4_checksum_en                                        :  1,
32*5113495bSYour Name                       udp_over_ipv4_checksum_en                               :  1,
33*5113495bSYour Name                       udp_over_ipv6_checksum_en                               :  1,
34*5113495bSYour Name                       tcp_over_ipv4_checksum_en                               :  1,
35*5113495bSYour Name                       tcp_over_ipv6_checksum_en                               :  1,
36*5113495bSYour Name                       dummy_msdu_delimitation                                 :  1,
37*5113495bSYour Name                       reserved_0a                                             :  5;
38*5113495bSYour Name              uint32_t tso_enable                                              :  1,
39*5113495bSYour Name                       reserved_1a                                             :  6,
40*5113495bSYour Name                       tcp_flag                                                :  9,
41*5113495bSYour Name                       tcp_flag_mask                                           :  9,
42*5113495bSYour Name                       mesh_enable                                             :  1,
43*5113495bSYour Name                       reserved_1b                                             :  6;
44*5113495bSYour Name              uint32_t l2_length                                               : 16,
45*5113495bSYour Name                       ip_length                                               : 16;
46*5113495bSYour Name              uint32_t tcp_seq_number                                          : 32;
47*5113495bSYour Name              uint32_t ip_identification                                       : 16,
48*5113495bSYour Name                       checksum_offset                                         : 13,
49*5113495bSYour Name                       partial_checksum_en                                     :  1,
50*5113495bSYour Name                       reserved_4                                              :  2;
51*5113495bSYour Name              uint32_t payload_start_offset                                    : 14,
52*5113495bSYour Name                       reserved_5a                                             :  2,
53*5113495bSYour Name                       payload_end_offset                                      : 14,
54*5113495bSYour Name                       reserved_5b                                             :  2;
55*5113495bSYour Name              uint32_t udp_length                                              : 16,
56*5113495bSYour Name                       reserved_6                                              : 16;
57*5113495bSYour Name #else
58*5113495bSYour Name              uint32_t reserved_0a                                             :  5,
59*5113495bSYour Name                       dummy_msdu_delimitation                                 :  1,
60*5113495bSYour Name                       tcp_over_ipv6_checksum_en                               :  1,
61*5113495bSYour Name                       tcp_over_ipv4_checksum_en                               :  1,
62*5113495bSYour Name                       udp_over_ipv6_checksum_en                               :  1,
63*5113495bSYour Name                       udp_over_ipv4_checksum_en                               :  1,
64*5113495bSYour Name                       ipv4_checksum_en                                        :  1,
65*5113495bSYour Name                       da_sa_present                                           :  2,
66*5113495bSYour Name                       epd_en                                                  :  1,
67*5113495bSYour Name                       encap_type                                              :  2,
68*5113495bSYour Name                       last_msdu                                               :  1,
69*5113495bSYour Name                       first_msdu                                              :  1,
70*5113495bSYour Name                       msdu_len                                                : 14;
71*5113495bSYour Name              uint32_t reserved_1b                                             :  6,
72*5113495bSYour Name                       mesh_enable                                             :  1,
73*5113495bSYour Name                       tcp_flag_mask                                           :  9,
74*5113495bSYour Name                       tcp_flag                                                :  9,
75*5113495bSYour Name                       reserved_1a                                             :  6,
76*5113495bSYour Name                       tso_enable                                              :  1;
77*5113495bSYour Name              uint32_t ip_length                                               : 16,
78*5113495bSYour Name                       l2_length                                               : 16;
79*5113495bSYour Name              uint32_t tcp_seq_number                                          : 32;
80*5113495bSYour Name              uint32_t reserved_4                                              :  2,
81*5113495bSYour Name                       partial_checksum_en                                     :  1,
82*5113495bSYour Name                       checksum_offset                                         : 13,
83*5113495bSYour Name                       ip_identification                                       : 16;
84*5113495bSYour Name              uint32_t reserved_5b                                             :  2,
85*5113495bSYour Name                       payload_end_offset                                      : 14,
86*5113495bSYour Name                       reserved_5a                                             :  2,
87*5113495bSYour Name                       payload_start_offset                                    : 14;
88*5113495bSYour Name              uint32_t reserved_6                                              : 16,
89*5113495bSYour Name                       udp_length                                              : 16;
90*5113495bSYour Name #endif
91*5113495bSYour Name };
92*5113495bSYour Name 
93*5113495bSYour Name #define TX_MSDU_START_MSDU_LEN_OFFSET                                               0x00000000
94*5113495bSYour Name #define TX_MSDU_START_MSDU_LEN_LSB                                                  0
95*5113495bSYour Name #define TX_MSDU_START_MSDU_LEN_MSB                                                  13
96*5113495bSYour Name #define TX_MSDU_START_MSDU_LEN_MASK                                                 0x00003fff
97*5113495bSYour Name 
98*5113495bSYour Name #define TX_MSDU_START_FIRST_MSDU_OFFSET                                             0x00000000
99*5113495bSYour Name #define TX_MSDU_START_FIRST_MSDU_LSB                                                14
100*5113495bSYour Name #define TX_MSDU_START_FIRST_MSDU_MSB                                                14
101*5113495bSYour Name #define TX_MSDU_START_FIRST_MSDU_MASK                                               0x00004000
102*5113495bSYour Name 
103*5113495bSYour Name #define TX_MSDU_START_LAST_MSDU_OFFSET                                              0x00000000
104*5113495bSYour Name #define TX_MSDU_START_LAST_MSDU_LSB                                                 15
105*5113495bSYour Name #define TX_MSDU_START_LAST_MSDU_MSB                                                 15
106*5113495bSYour Name #define TX_MSDU_START_LAST_MSDU_MASK                                                0x00008000
107*5113495bSYour Name 
108*5113495bSYour Name #define TX_MSDU_START_ENCAP_TYPE_OFFSET                                             0x00000000
109*5113495bSYour Name #define TX_MSDU_START_ENCAP_TYPE_LSB                                                16
110*5113495bSYour Name #define TX_MSDU_START_ENCAP_TYPE_MSB                                                17
111*5113495bSYour Name #define TX_MSDU_START_ENCAP_TYPE_MASK                                               0x00030000
112*5113495bSYour Name 
113*5113495bSYour Name #define TX_MSDU_START_EPD_EN_OFFSET                                                 0x00000000
114*5113495bSYour Name #define TX_MSDU_START_EPD_EN_LSB                                                    18
115*5113495bSYour Name #define TX_MSDU_START_EPD_EN_MSB                                                    18
116*5113495bSYour Name #define TX_MSDU_START_EPD_EN_MASK                                                   0x00040000
117*5113495bSYour Name 
118*5113495bSYour Name #define TX_MSDU_START_DA_SA_PRESENT_OFFSET                                          0x00000000
119*5113495bSYour Name #define TX_MSDU_START_DA_SA_PRESENT_LSB                                             19
120*5113495bSYour Name #define TX_MSDU_START_DA_SA_PRESENT_MSB                                             20
121*5113495bSYour Name #define TX_MSDU_START_DA_SA_PRESENT_MASK                                            0x00180000
122*5113495bSYour Name 
123*5113495bSYour Name #define TX_MSDU_START_IPV4_CHECKSUM_EN_OFFSET                                       0x00000000
124*5113495bSYour Name #define TX_MSDU_START_IPV4_CHECKSUM_EN_LSB                                          21
125*5113495bSYour Name #define TX_MSDU_START_IPV4_CHECKSUM_EN_MSB                                          21
126*5113495bSYour Name #define TX_MSDU_START_IPV4_CHECKSUM_EN_MASK                                         0x00200000
127*5113495bSYour Name 
128*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV4_CHECKSUM_EN_OFFSET                              0x00000000
129*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV4_CHECKSUM_EN_LSB                                 22
130*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV4_CHECKSUM_EN_MSB                                 22
131*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV4_CHECKSUM_EN_MASK                                0x00400000
132*5113495bSYour Name 
133*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV6_CHECKSUM_EN_OFFSET                              0x00000000
134*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV6_CHECKSUM_EN_LSB                                 23
135*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV6_CHECKSUM_EN_MSB                                 23
136*5113495bSYour Name #define TX_MSDU_START_UDP_OVER_IPV6_CHECKSUM_EN_MASK                                0x00800000
137*5113495bSYour Name 
138*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV4_CHECKSUM_EN_OFFSET                              0x00000000
139*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV4_CHECKSUM_EN_LSB                                 24
140*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV4_CHECKSUM_EN_MSB                                 24
141*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV4_CHECKSUM_EN_MASK                                0x01000000
142*5113495bSYour Name 
143*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV6_CHECKSUM_EN_OFFSET                              0x00000000
144*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV6_CHECKSUM_EN_LSB                                 25
145*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV6_CHECKSUM_EN_MSB                                 25
146*5113495bSYour Name #define TX_MSDU_START_TCP_OVER_IPV6_CHECKSUM_EN_MASK                                0x02000000
147*5113495bSYour Name 
148*5113495bSYour Name #define TX_MSDU_START_DUMMY_MSDU_DELIMITATION_OFFSET                                0x00000000
149*5113495bSYour Name #define TX_MSDU_START_DUMMY_MSDU_DELIMITATION_LSB                                   26
150*5113495bSYour Name #define TX_MSDU_START_DUMMY_MSDU_DELIMITATION_MSB                                   26
151*5113495bSYour Name #define TX_MSDU_START_DUMMY_MSDU_DELIMITATION_MASK                                  0x04000000
152*5113495bSYour Name 
153*5113495bSYour Name #define TX_MSDU_START_RESERVED_0A_OFFSET                                            0x00000000
154*5113495bSYour Name #define TX_MSDU_START_RESERVED_0A_LSB                                               27
155*5113495bSYour Name #define TX_MSDU_START_RESERVED_0A_MSB                                               31
156*5113495bSYour Name #define TX_MSDU_START_RESERVED_0A_MASK                                              0xf8000000
157*5113495bSYour Name 
158*5113495bSYour Name #define TX_MSDU_START_TSO_ENABLE_OFFSET                                             0x00000004
159*5113495bSYour Name #define TX_MSDU_START_TSO_ENABLE_LSB                                                0
160*5113495bSYour Name #define TX_MSDU_START_TSO_ENABLE_MSB                                                0
161*5113495bSYour Name #define TX_MSDU_START_TSO_ENABLE_MASK                                               0x00000001
162*5113495bSYour Name 
163*5113495bSYour Name #define TX_MSDU_START_RESERVED_1A_OFFSET                                            0x00000004
164*5113495bSYour Name #define TX_MSDU_START_RESERVED_1A_LSB                                               1
165*5113495bSYour Name #define TX_MSDU_START_RESERVED_1A_MSB                                               6
166*5113495bSYour Name #define TX_MSDU_START_RESERVED_1A_MASK                                              0x0000007e
167*5113495bSYour Name 
168*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_OFFSET                                               0x00000004
169*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_LSB                                                  7
170*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MSB                                                  15
171*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MASK                                                 0x0000ff80
172*5113495bSYour Name 
173*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MASK_OFFSET                                          0x00000004
174*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MASK_LSB                                             16
175*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MASK_MSB                                             24
176*5113495bSYour Name #define TX_MSDU_START_TCP_FLAG_MASK_MASK                                            0x01ff0000
177*5113495bSYour Name 
178*5113495bSYour Name #define TX_MSDU_START_MESH_ENABLE_OFFSET                                            0x00000004
179*5113495bSYour Name #define TX_MSDU_START_MESH_ENABLE_LSB                                               25
180*5113495bSYour Name #define TX_MSDU_START_MESH_ENABLE_MSB                                               25
181*5113495bSYour Name #define TX_MSDU_START_MESH_ENABLE_MASK                                              0x02000000
182*5113495bSYour Name 
183*5113495bSYour Name #define TX_MSDU_START_RESERVED_1B_OFFSET                                            0x00000004
184*5113495bSYour Name #define TX_MSDU_START_RESERVED_1B_LSB                                               26
185*5113495bSYour Name #define TX_MSDU_START_RESERVED_1B_MSB                                               31
186*5113495bSYour Name #define TX_MSDU_START_RESERVED_1B_MASK                                              0xfc000000
187*5113495bSYour Name 
188*5113495bSYour Name #define TX_MSDU_START_L2_LENGTH_OFFSET                                              0x00000008
189*5113495bSYour Name #define TX_MSDU_START_L2_LENGTH_LSB                                                 0
190*5113495bSYour Name #define TX_MSDU_START_L2_LENGTH_MSB                                                 15
191*5113495bSYour Name #define TX_MSDU_START_L2_LENGTH_MASK                                                0x0000ffff
192*5113495bSYour Name 
193*5113495bSYour Name #define TX_MSDU_START_IP_LENGTH_OFFSET                                              0x00000008
194*5113495bSYour Name #define TX_MSDU_START_IP_LENGTH_LSB                                                 16
195*5113495bSYour Name #define TX_MSDU_START_IP_LENGTH_MSB                                                 31
196*5113495bSYour Name #define TX_MSDU_START_IP_LENGTH_MASK                                                0xffff0000
197*5113495bSYour Name 
198*5113495bSYour Name #define TX_MSDU_START_TCP_SEQ_NUMBER_OFFSET                                         0x0000000c
199*5113495bSYour Name #define TX_MSDU_START_TCP_SEQ_NUMBER_LSB                                            0
200*5113495bSYour Name #define TX_MSDU_START_TCP_SEQ_NUMBER_MSB                                            31
201*5113495bSYour Name #define TX_MSDU_START_TCP_SEQ_NUMBER_MASK                                           0xffffffff
202*5113495bSYour Name 
203*5113495bSYour Name #define TX_MSDU_START_IP_IDENTIFICATION_OFFSET                                      0x00000010
204*5113495bSYour Name #define TX_MSDU_START_IP_IDENTIFICATION_LSB                                         0
205*5113495bSYour Name #define TX_MSDU_START_IP_IDENTIFICATION_MSB                                         15
206*5113495bSYour Name #define TX_MSDU_START_IP_IDENTIFICATION_MASK                                        0x0000ffff
207*5113495bSYour Name 
208*5113495bSYour Name #define TX_MSDU_START_CHECKSUM_OFFSET_OFFSET                                        0x00000010
209*5113495bSYour Name #define TX_MSDU_START_CHECKSUM_OFFSET_LSB                                           16
210*5113495bSYour Name #define TX_MSDU_START_CHECKSUM_OFFSET_MSB                                           28
211*5113495bSYour Name #define TX_MSDU_START_CHECKSUM_OFFSET_MASK                                          0x1fff0000
212*5113495bSYour Name 
213*5113495bSYour Name #define TX_MSDU_START_PARTIAL_CHECKSUM_EN_OFFSET                                    0x00000010
214*5113495bSYour Name #define TX_MSDU_START_PARTIAL_CHECKSUM_EN_LSB                                       29
215*5113495bSYour Name #define TX_MSDU_START_PARTIAL_CHECKSUM_EN_MSB                                       29
216*5113495bSYour Name #define TX_MSDU_START_PARTIAL_CHECKSUM_EN_MASK                                      0x20000000
217*5113495bSYour Name 
218*5113495bSYour Name #define TX_MSDU_START_RESERVED_4_OFFSET                                             0x00000010
219*5113495bSYour Name #define TX_MSDU_START_RESERVED_4_LSB                                                30
220*5113495bSYour Name #define TX_MSDU_START_RESERVED_4_MSB                                                31
221*5113495bSYour Name #define TX_MSDU_START_RESERVED_4_MASK                                               0xc0000000
222*5113495bSYour Name 
223*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_START_OFFSET_OFFSET                                   0x00000014
224*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_START_OFFSET_LSB                                      0
225*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_START_OFFSET_MSB                                      13
226*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_START_OFFSET_MASK                                     0x00003fff
227*5113495bSYour Name 
228*5113495bSYour Name #define TX_MSDU_START_RESERVED_5A_OFFSET                                            0x00000014
229*5113495bSYour Name #define TX_MSDU_START_RESERVED_5A_LSB                                               14
230*5113495bSYour Name #define TX_MSDU_START_RESERVED_5A_MSB                                               15
231*5113495bSYour Name #define TX_MSDU_START_RESERVED_5A_MASK                                              0x0000c000
232*5113495bSYour Name 
233*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_END_OFFSET_OFFSET                                     0x00000014
234*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_END_OFFSET_LSB                                        16
235*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_END_OFFSET_MSB                                        29
236*5113495bSYour Name #define TX_MSDU_START_PAYLOAD_END_OFFSET_MASK                                       0x3fff0000
237*5113495bSYour Name 
238*5113495bSYour Name #define TX_MSDU_START_RESERVED_5B_OFFSET                                            0x00000014
239*5113495bSYour Name #define TX_MSDU_START_RESERVED_5B_LSB                                               30
240*5113495bSYour Name #define TX_MSDU_START_RESERVED_5B_MSB                                               31
241*5113495bSYour Name #define TX_MSDU_START_RESERVED_5B_MASK                                              0xc0000000
242*5113495bSYour Name 
243*5113495bSYour Name #define TX_MSDU_START_UDP_LENGTH_OFFSET                                             0x00000018
244*5113495bSYour Name #define TX_MSDU_START_UDP_LENGTH_LSB                                                0
245*5113495bSYour Name #define TX_MSDU_START_UDP_LENGTH_MSB                                                15
246*5113495bSYour Name #define TX_MSDU_START_UDP_LENGTH_MASK                                               0x0000ffff
247*5113495bSYour Name 
248*5113495bSYour Name #define TX_MSDU_START_RESERVED_6_OFFSET                                             0x00000018
249*5113495bSYour Name #define TX_MSDU_START_RESERVED_6_LSB                                                16
250*5113495bSYour Name #define TX_MSDU_START_RESERVED_6_MSB                                                31
251*5113495bSYour Name #define TX_MSDU_START_RESERVED_6_MASK                                               0xffff0000
252*5113495bSYour Name 
253*5113495bSYour Name #endif
254