xref: /wlan-driver/fw-api/hw/qca6490/v1/phyrx_he_sig_b2_mu.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _PHYRX_HE_SIG_B2_MU_H_
20*5113495bSYour Name #define _PHYRX_HE_SIG_B2_MU_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "he_sig_b2_mu_info.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0	struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details;
30*5113495bSYour Name //
31*5113495bSYour Name // ################ END SUMMARY #################
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_HE_SIG_B2_MU 1
34*5113495bSYour Name 
35*5113495bSYour Name struct phyrx_he_sig_b2_mu {
36*5113495bSYour Name     struct            he_sig_b2_mu_info                       phyrx_he_sig_b2_mu_info_details;
37*5113495bSYour Name };
38*5113495bSYour Name 
39*5113495bSYour Name /*
40*5113495bSYour Name 
41*5113495bSYour Name struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details
42*5113495bSYour Name 
43*5113495bSYour Name 			See detailed description of the STRUCT
44*5113495bSYour Name */
45*5113495bSYour Name 
46*5113495bSYour Name 
47*5113495bSYour Name  /* EXTERNAL REFERENCE : struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details */
48*5113495bSYour Name 
49*5113495bSYour Name 
50*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID
51*5113495bSYour Name 
52*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
53*5113495bSYour Name 			are TBD
54*5113495bSYour Name */
55*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_OFFSET 0x00000000
56*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_LSB 0
57*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_MASK 0x000007ff
58*5113495bSYour Name 
59*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG
60*5113495bSYour Name 
61*5113495bSYour Name 			Number of assigned spatial streams and their
62*5113495bSYour Name 			corresponding index.
63*5113495bSYour Name 
64*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
65*5113495bSYour Name 			allocation is also signaled.
66*5113495bSYour Name */
67*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_OFFSET 0x00000000
68*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_LSB 11
69*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_MASK 0x00007800
70*5113495bSYour Name 
71*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS
72*5113495bSYour Name 
73*5113495bSYour Name 			Indicates the data MCS
74*5113495bSYour Name */
75*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_OFFSET 0x00000000
76*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_LSB 15
77*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_MASK 0x00078000
78*5113495bSYour Name 
79*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1
80*5113495bSYour Name 
81*5113495bSYour Name 			<legal 1>
82*5113495bSYour Name */
83*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_OFFSET 0x00000000
84*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_LSB 19
85*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_MASK 0x00080000
86*5113495bSYour Name 
87*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING
88*5113495bSYour Name 
89*5113495bSYour Name 			Distinguishes between BCC/LDPC
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 			0: BCC
94*5113495bSYour Name 
95*5113495bSYour Name 			1: LDPC
96*5113495bSYour Name 
97*5113495bSYour Name 			<legal all>
98*5113495bSYour Name */
99*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_OFFSET 0x00000000
100*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_LSB 20
101*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_MASK 0x00100000
102*5113495bSYour Name 
103*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A
104*5113495bSYour Name 
105*5113495bSYour Name 			<legal 0>
106*5113495bSYour Name */
107*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_OFFSET 0x00000000
108*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_LSB 21
109*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_MASK 0x1fe00000
110*5113495bSYour Name 
111*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS
112*5113495bSYour Name 
113*5113495bSYour Name 			MAC RX side usage only:
114*5113495bSYour Name 
115*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
116*5113495bSYour Name 			need to have the RU number decoding logic.
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			Number of spatial streams for this user
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
125*5113495bSYour Name 
126*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
127*5113495bSYour Name 
128*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
129*5113495bSYour Name 
130*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
137*5113495bSYour Name 
138*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
139*5113495bSYour Name */
140*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_OFFSET 0x00000000
141*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_LSB 29
142*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_MASK 0xe0000000
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name #endif // _PHYRX_HE_SIG_B2_MU_H_
146