xref: /wlan-driver/fw-api/hw/kiwi/v2/rx_preamble.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 
19 
20 #ifndef _RX_PREAMBLE_H_
21 #define _RX_PREAMBLE_H_
22 #if !defined(__ASSEMBLER__)
23 #endif
24 
25 #define NUM_OF_DWORDS_RX_PREAMBLE 2
26 
27 #define NUM_OF_QWORDS_RX_PREAMBLE 1
28 
29 struct rx_preamble {
30 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
31              uint32_t num_users                                               :  6,
32                       pkt_type                                                :  4,
33                       direction                                               :  1,
34                       reserved_0a                                             : 21;
35              uint32_t tlv64_padding                                           : 32;
36 #else
37              uint32_t reserved_0a                                             : 21,
38                       direction                                               :  1,
39                       pkt_type                                                :  4,
40                       num_users                                               :  6;
41              uint32_t tlv64_padding                                           : 32;
42 #endif
43 };
44 
45 #define RX_PREAMBLE_NUM_USERS_OFFSET                                                0x0000000000000000
46 #define RX_PREAMBLE_NUM_USERS_LSB                                                   0
47 #define RX_PREAMBLE_NUM_USERS_MSB                                                   5
48 #define RX_PREAMBLE_NUM_USERS_MASK                                                  0x000000000000003f
49 
50 #define RX_PREAMBLE_PKT_TYPE_OFFSET                                                 0x0000000000000000
51 #define RX_PREAMBLE_PKT_TYPE_LSB                                                    6
52 #define RX_PREAMBLE_PKT_TYPE_MSB                                                    9
53 #define RX_PREAMBLE_PKT_TYPE_MASK                                                   0x00000000000003c0
54 
55 #define RX_PREAMBLE_DIRECTION_OFFSET                                                0x0000000000000000
56 #define RX_PREAMBLE_DIRECTION_LSB                                                   10
57 #define RX_PREAMBLE_DIRECTION_MSB                                                   10
58 #define RX_PREAMBLE_DIRECTION_MASK                                                  0x0000000000000400
59 
60 #define RX_PREAMBLE_RESERVED_0A_OFFSET                                              0x0000000000000000
61 #define RX_PREAMBLE_RESERVED_0A_LSB                                                 11
62 #define RX_PREAMBLE_RESERVED_0A_MSB                                                 31
63 #define RX_PREAMBLE_RESERVED_0A_MASK                                                0x00000000fffff800
64 
65 #define RX_PREAMBLE_TLV64_PADDING_OFFSET                                            0x0000000000000000
66 #define RX_PREAMBLE_TLV64_PADDING_LSB                                               32
67 #define RX_PREAMBLE_TLV64_PADDING_MSB                                               63
68 #define RX_PREAMBLE_TLV64_PADDING_MASK                                              0xffffffff00000000
69 
70 #endif
71