xref: /wlan-driver/fw-api/hw/qcn9000/rx_ppdu_start.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 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 _RX_PPDU_START_H_
18*5113495bSYour Name #define _RX_PPDU_START_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name // ################ START SUMMARY #################
24*5113495bSYour Name //
25*5113495bSYour Name //	Dword	Fields
26*5113495bSYour Name //	0	phy_ppdu_id[15:0], reserved_15[31:16]
27*5113495bSYour Name //	1	sw_phy_meta_data[31:0]
28*5113495bSYour Name //	2	ppdu_start_timestamp[31:0]
29*5113495bSYour Name //
30*5113495bSYour Name // ################ END SUMMARY #################
31*5113495bSYour Name 
32*5113495bSYour Name #define NUM_OF_DWORDS_RX_PPDU_START 3
33*5113495bSYour Name 
34*5113495bSYour Name struct rx_ppdu_start {
35*5113495bSYour Name              uint32_t phy_ppdu_id                     : 16, //[15:0]
36*5113495bSYour Name                       reserved_15                     : 16; //[31:16]
37*5113495bSYour Name              uint32_t sw_phy_meta_data                : 32; //[31:0]
38*5113495bSYour Name              uint32_t ppdu_start_timestamp            : 32; //[31:0]
39*5113495bSYour Name };
40*5113495bSYour Name 
41*5113495bSYour Name /*
42*5113495bSYour Name 
43*5113495bSYour Name phy_ppdu_id
44*5113495bSYour Name 
45*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
46*5113495bSYour Name 			received. The counter value wraps around
47*5113495bSYour Name 
48*5113495bSYour Name 			<legal all>
49*5113495bSYour Name 
50*5113495bSYour Name reserved_15
51*5113495bSYour Name 
52*5113495bSYour Name 			Reserved
53*5113495bSYour Name 
54*5113495bSYour Name 			<legal 0>
55*5113495bSYour Name 
56*5113495bSYour Name sw_phy_meta_data
57*5113495bSYour Name 
58*5113495bSYour Name 			SW programmed Meta data provided by the PHY.
59*5113495bSYour Name 
60*5113495bSYour Name 
61*5113495bSYour Name 
62*5113495bSYour Name 			Can be used for SW to indicate the channel the device is
63*5113495bSYour Name 			on.
64*5113495bSYour Name 
65*5113495bSYour Name ppdu_start_timestamp
66*5113495bSYour Name 
67*5113495bSYour Name 			Timestamp that indicates when the PPDU that contained
68*5113495bSYour Name 			this MPDU started on the medium.
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name 
72*5113495bSYour Name 			The timestamp is captured by the PHY and given to the
73*5113495bSYour Name 			MAC in PHYRX_RSSI_LEGACY.ppdu_start_timestamp
74*5113495bSYour Name 
75*5113495bSYour Name 			<legal all>
76*5113495bSYour Name */
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name /* Description		RX_PPDU_START_0_PHY_PPDU_ID
80*5113495bSYour Name 
81*5113495bSYour Name 			A ppdu counter value that PHY increments for every PPDU
82*5113495bSYour Name 			received. The counter value wraps around
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal all>
85*5113495bSYour Name */
86*5113495bSYour Name #define RX_PPDU_START_0_PHY_PPDU_ID_OFFSET                           0x00000000
87*5113495bSYour Name #define RX_PPDU_START_0_PHY_PPDU_ID_LSB                              0
88*5113495bSYour Name #define RX_PPDU_START_0_PHY_PPDU_ID_MASK                             0x0000ffff
89*5113495bSYour Name 
90*5113495bSYour Name /* Description		RX_PPDU_START_0_RESERVED_15
91*5113495bSYour Name 
92*5113495bSYour Name 			Reserved
93*5113495bSYour Name 
94*5113495bSYour Name 			<legal 0>
95*5113495bSYour Name */
96*5113495bSYour Name #define RX_PPDU_START_0_RESERVED_15_OFFSET                           0x00000000
97*5113495bSYour Name #define RX_PPDU_START_0_RESERVED_15_LSB                              16
98*5113495bSYour Name #define RX_PPDU_START_0_RESERVED_15_MASK                             0xffff0000
99*5113495bSYour Name 
100*5113495bSYour Name /* Description		RX_PPDU_START_1_SW_PHY_META_DATA
101*5113495bSYour Name 
102*5113495bSYour Name 			SW programmed Meta data provided by the PHY.
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 			Can be used for SW to indicate the channel the device is
107*5113495bSYour Name 			on.
108*5113495bSYour Name */
109*5113495bSYour Name #define RX_PPDU_START_1_SW_PHY_META_DATA_OFFSET                      0x00000004
110*5113495bSYour Name #define RX_PPDU_START_1_SW_PHY_META_DATA_LSB                         0
111*5113495bSYour Name #define RX_PPDU_START_1_SW_PHY_META_DATA_MASK                        0xffffffff
112*5113495bSYour Name 
113*5113495bSYour Name /* Description		RX_PPDU_START_2_PPDU_START_TIMESTAMP
114*5113495bSYour Name 
115*5113495bSYour Name 			Timestamp that indicates when the PPDU that contained
116*5113495bSYour Name 			this MPDU started on the medium.
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			The timestamp is captured by the PHY and given to the
121*5113495bSYour Name 			MAC in PHYRX_RSSI_LEGACY.ppdu_start_timestamp
122*5113495bSYour Name 
123*5113495bSYour Name 			<legal all>
124*5113495bSYour Name */
125*5113495bSYour Name #define RX_PPDU_START_2_PPDU_START_TIMESTAMP_OFFSET                  0x00000008
126*5113495bSYour Name #define RX_PPDU_START_2_PPDU_START_TIMESTAMP_LSB                     0
127*5113495bSYour Name #define RX_PPDU_START_2_PPDU_START_TIMESTAMP_MASK                    0xffffffff
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name #endif // _RX_PPDU_START_H_
131