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