xref: /wlan-driver/fw-api/hw/wcn6450/v1/receive_user_info.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
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 
21 
22 #ifndef _RECEIVE_USER_INFO_H_
23 #define _RECEIVE_USER_INFO_H_
24 #if !defined(__ASSEMBLER__)
25 #endif
26 
27 #define NUM_OF_DWORDS_RECEIVE_USER_INFO 3
28 
29 struct receive_user_info {
30              uint32_t phy_ppdu_id                     : 16,
31                       user_rssi                       :  8,
32                       pkt_type                        :  4,
33                       stbc                            :  1,
34                       reception_type                  :  3;
35              uint32_t rate_mcs                        :  4,
36                       sgi                             :  2,
37                       receive_bandwidth               :  2,
38                       mimo_ss_bitmap                  :  8,
39                       ofdma_ru_allocation             :  8,
40                       ofdma_user_index                :  7,
41                       ofdma_content_channel           :  1;
42              uint32_t ldpc                            :  1,
43                       ru_width                        :  7,
44                       reserved_2a                     : 24;
45 };
46 
47 #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_OFFSET                       0x00000000
48 #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_LSB                          0
49 #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_MASK                         0x0000ffff
50 
51 #define RECEIVE_USER_INFO_0_USER_RSSI_OFFSET                         0x00000000
52 #define RECEIVE_USER_INFO_0_USER_RSSI_LSB                            16
53 #define RECEIVE_USER_INFO_0_USER_RSSI_MASK                           0x00ff0000
54 
55 #define RECEIVE_USER_INFO_0_PKT_TYPE_OFFSET                          0x00000000
56 #define RECEIVE_USER_INFO_0_PKT_TYPE_LSB                             24
57 #define RECEIVE_USER_INFO_0_PKT_TYPE_MASK                            0x0f000000
58 
59 #define RECEIVE_USER_INFO_0_STBC_OFFSET                              0x00000000
60 #define RECEIVE_USER_INFO_0_STBC_LSB                                 28
61 #define RECEIVE_USER_INFO_0_STBC_MASK                                0x10000000
62 
63 #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_OFFSET                    0x00000000
64 #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_LSB                       29
65 #define RECEIVE_USER_INFO_0_RECEPTION_TYPE_MASK                      0xe0000000
66 
67 #define RECEIVE_USER_INFO_1_RATE_MCS_OFFSET                          0x00000004
68 #define RECEIVE_USER_INFO_1_RATE_MCS_LSB                             0
69 #define RECEIVE_USER_INFO_1_RATE_MCS_MASK                            0x0000000f
70 
71 #define RECEIVE_USER_INFO_1_SGI_OFFSET                               0x00000004
72 #define RECEIVE_USER_INFO_1_SGI_LSB                                  4
73 #define RECEIVE_USER_INFO_1_SGI_MASK                                 0x00000030
74 
75 #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_OFFSET                 0x00000004
76 #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_LSB                    6
77 #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_MASK                   0x000000c0
78 
79 #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_OFFSET                    0x00000004
80 #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_LSB                       8
81 #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_MASK                      0x0000ff00
82 
83 #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_OFFSET               0x00000004
84 #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_LSB                  16
85 #define RECEIVE_USER_INFO_1_OFDMA_RU_ALLOCATION_MASK                 0x00ff0000
86 
87 #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_OFFSET                  0x00000004
88 #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_LSB                     24
89 #define RECEIVE_USER_INFO_1_OFDMA_USER_INDEX_MASK                    0x7f000000
90 
91 #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_OFFSET             0x00000004
92 #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_LSB                31
93 #define RECEIVE_USER_INFO_1_OFDMA_CONTENT_CHANNEL_MASK               0x80000000
94 
95 #define RECEIVE_USER_INFO_2_LDPC_OFFSET                              0x00000008
96 #define RECEIVE_USER_INFO_2_LDPC_LSB                                 0
97 #define RECEIVE_USER_INFO_2_LDPC_MASK                                0x00000001
98 
99 #define RECEIVE_USER_INFO_2_RU_WIDTH_OFFSET                          0x00000008
100 #define RECEIVE_USER_INFO_2_RU_WIDTH_LSB                             1
101 #define RECEIVE_USER_INFO_2_RU_WIDTH_MASK                            0x000000fe
102 
103 #define RECEIVE_USER_INFO_2_RESERVED_2A_OFFSET                       0x00000008
104 #define RECEIVE_USER_INFO_2_RESERVED_2A_LSB                          8
105 #define RECEIVE_USER_INFO_2_RESERVED_2A_MASK                         0xffffff00
106 
107 #endif
108