xref: /wlan-driver/fw-api/hw/qcn6122/phyrx_he_sig_b2_mu.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, The Linux Foundation. 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 #ifndef _PHYRX_HE_SIG_B2_MU_H_
18*5113495bSYour Name #define _PHYRX_HE_SIG_B2_MU_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "he_sig_b2_mu_info.h"
23*5113495bSYour Name 
24*5113495bSYour Name // ################ START SUMMARY #################
25*5113495bSYour Name //
26*5113495bSYour Name //	Dword	Fields
27*5113495bSYour Name //	0	struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details;
28*5113495bSYour Name //
29*5113495bSYour Name // ################ END SUMMARY #################
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_HE_SIG_B2_MU 1
32*5113495bSYour Name 
33*5113495bSYour Name struct phyrx_he_sig_b2_mu {
34*5113495bSYour Name     struct            he_sig_b2_mu_info                       phyrx_he_sig_b2_mu_info_details;
35*5113495bSYour Name };
36*5113495bSYour Name 
37*5113495bSYour Name /*
38*5113495bSYour Name 
39*5113495bSYour Name struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details
40*5113495bSYour Name 
41*5113495bSYour Name 			See detailed description of the STRUCT
42*5113495bSYour Name */
43*5113495bSYour Name 
44*5113495bSYour Name 
45*5113495bSYour Name  /* EXTERNAL REFERENCE : struct he_sig_b2_mu_info phyrx_he_sig_b2_mu_info_details */
46*5113495bSYour Name 
47*5113495bSYour Name 
48*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID
49*5113495bSYour Name 
50*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
51*5113495bSYour Name 			are TBD
52*5113495bSYour Name */
53*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_OFFSET 0x00000000
54*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_LSB 0
55*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_MASK 0x000007ff
56*5113495bSYour Name 
57*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG
58*5113495bSYour Name 
59*5113495bSYour Name 			Number of assigned spatial streams and their
60*5113495bSYour Name 			corresponding index.
61*5113495bSYour Name 
62*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
63*5113495bSYour Name 			allocation is also signaled.
64*5113495bSYour Name */
65*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_OFFSET 0x00000000
66*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_LSB 11
67*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_MASK 0x00007800
68*5113495bSYour Name 
69*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS
70*5113495bSYour Name 
71*5113495bSYour Name 			Indicates the data MCS
72*5113495bSYour Name */
73*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_OFFSET 0x00000000
74*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_LSB 15
75*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_MASK 0x00078000
76*5113495bSYour Name 
77*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1
78*5113495bSYour Name 
79*5113495bSYour Name 			<legal 1>
80*5113495bSYour Name */
81*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_OFFSET 0x00000000
82*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_LSB 19
83*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_MASK 0x00080000
84*5113495bSYour Name 
85*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING
86*5113495bSYour Name 
87*5113495bSYour Name 			Distinguishes between BCC/LDPC
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 			0: BCC
92*5113495bSYour Name 
93*5113495bSYour Name 			1: LDPC
94*5113495bSYour Name 
95*5113495bSYour Name 			<legal all>
96*5113495bSYour Name */
97*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_OFFSET 0x00000000
98*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_LSB 20
99*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_MASK 0x00100000
100*5113495bSYour Name 
101*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A
102*5113495bSYour Name 
103*5113495bSYour Name 			<legal 0>
104*5113495bSYour Name */
105*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_OFFSET 0x00000000
106*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_LSB 21
107*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_MASK 0x1fe00000
108*5113495bSYour Name 
109*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS
110*5113495bSYour Name 
111*5113495bSYour Name 			MAC RX side usage only:
112*5113495bSYour Name 
113*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
114*5113495bSYour Name 			need to have the RU number decoding logic.
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 			Number of spatial streams for this user
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
123*5113495bSYour Name 
124*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
125*5113495bSYour Name 
126*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
127*5113495bSYour Name 
128*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
129*5113495bSYour Name 
130*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
137*5113495bSYour Name */
138*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_OFFSET 0x00000000
139*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_LSB 29
140*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_0_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_MASK 0xe0000000
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name #endif // _PHYRX_HE_SIG_B2_MU_H_
144