xref: /wlan-driver/qca-wifi-host-cmn/qdf/inc/qdf_pkt_add_timestamp.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. 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 /**
20*5113495bSYour Name  * DOC: qdf_pkt_add_timestamp.h
21*5113495bSYour Name  * This file defines HLOS agnostic functions providing external interface
22*5113495bSYour Name  * for adding timestamp in packet payload.
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #if  !defined(_QDF_PKT_ADD_TS_H)
26*5113495bSYour Name #define _QDF_PKT_ADD_TS_H
27*5113495bSYour Name 
28*5113495bSYour Name #include  <qdf_nbuf.h>
29*5113495bSYour Name #include  <qdf_types.h>
30*5113495bSYour Name #include  <qdf_trace.h>
31*5113495bSYour Name 
32*5113495bSYour Name /**
33*5113495bSYour Name  * enum qdf_pkt_supported_proto - supported protocol for timestamp
34*5113495bSYour Name  * @QDF_PKT_PROTO_INVAL: invalid
35*5113495bSYour Name  * @QDF_PKT_PROTO_TCP: tcp protocol
36*5113495bSYour Name  * @QDF_PKT_PROTO_UDP: udp protocol
37*5113495bSYour Name  * @QDF_PKT_PROTO_MAX: max, keep it at last
38*5113495bSYour Name  */
39*5113495bSYour Name enum qdf_pkt_supported_proto {
40*5113495bSYour Name 	QDF_PKT_PROTO_INVAL,
41*5113495bSYour Name 	QDF_PKT_PROTO_TCP,
42*5113495bSYour Name 	QDF_PKT_PROTO_UDP,
43*5113495bSYour Name 	QDF_PKT_PROTO_MAX
44*5113495bSYour Name };
45*5113495bSYour Name 
46*5113495bSYour Name /**
47*5113495bSYour Name  * enum qdf_pkt_timestamp_index - index of different timestamp
48*5113495bSYour Name  * @QDF_PKT_TX_DRIVER_ENTRY: tx driver entry timestamp
49*5113495bSYour Name  * @QDF_PKT_TX_DRIVER_EXIT: tx driver exit timestamp
50*5113495bSYour Name  * @QDF_PKT_RX_DRIVER_ENTRY: rx driver entry timestamp
51*5113495bSYour Name  * @QDF_PKT_RX_DRIVER_EXIT: rx driver exit timestamp
52*5113495bSYour Name  * @QDF_PKT_TIMESTAMP_MAX: maximum index, keep it at last
53*5113495bSYour Name  */
54*5113495bSYour Name enum qdf_pkt_timestamp_index {
55*5113495bSYour Name 	QDF_PKT_TX_DRIVER_ENTRY,
56*5113495bSYour Name 	QDF_PKT_TX_DRIVER_EXIT,
57*5113495bSYour Name 	QDF_PKT_RX_DRIVER_ENTRY,
58*5113495bSYour Name 	QDF_PKT_RX_DRIVER_EXIT,
59*5113495bSYour Name 	QDF_PKT_TIMESTAMP_MAX
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name #ifdef CONFIG_DP_PKT_ADD_TIMESTAMP
63*5113495bSYour Name 
64*5113495bSYour Name #define NUM_DP_PKT_TIMESTAMP_SUPPORT 4
65*5113495bSYour Name 
66*5113495bSYour Name struct ts_info {
67*5113495bSYour Name 	uint64_t sec;
68*5113495bSYour Name 	uint64_t usec;
69*5113495bSYour Name } qdf_packed;
70*5113495bSYour Name 
71*5113495bSYour Name struct ts {
72*5113495bSYour Name 	struct ts_info ts_info[QDF_PKT_TIMESTAMP_MAX];
73*5113495bSYour Name } qdf_packed;
74*5113495bSYour Name 
75*5113495bSYour Name #define QDF_PKT_PROTO_TCP_BIT	(1 << QDF_PKT_PROTO_TCP)
76*5113495bSYour Name #define QDF_PKT_PROTO_UDP_BIT	(1 << QDF_PKT_PROTO_UDP)
77*5113495bSYour Name 
78*5113495bSYour Name struct dp_pkt_proto_info {
79*5113495bSYour Name 	enum qdf_pkt_supported_proto proto;
80*5113495bSYour Name 	uint16_t port;
81*5113495bSYour Name 	uint16_t offset;
82*5113495bSYour Name };
83*5113495bSYour Name 
84*5113495bSYour Name struct dp_pkt_add_ts_info {
85*5113495bSYour Name 	uint8_t current_index;
86*5113495bSYour Name 	uint16_t enable_protocol_bitmap;
87*5113495bSYour Name 	struct dp_pkt_proto_info proto_info[NUM_DP_PKT_TIMESTAMP_SUPPORT];
88*5113495bSYour Name };
89*5113495bSYour Name 
90*5113495bSYour Name /**
91*5113495bSYour Name  * qdf_set_dp_pkt_add_ts_info() - set protocol/port and offset info
92*5113495bSYour Name  *
93*5113495bSYour Name  * @proto: protocol to timestamp
94*5113495bSYour Name  * @port: destination port of protocol
95*5113495bSYour Name  * @offset: offset in payload
96*5113495bSYour Name  *
97*5113495bSYour Name  * Return: 0 for success
98*5113495bSYour Name  */
99*5113495bSYour Name int qdf_set_dp_pkt_add_ts_info(enum qdf_pkt_supported_proto proto,
100*5113495bSYour Name 			       uint16_t port, uint16_t offset);
101*5113495bSYour Name 
102*5113495bSYour Name /**
103*5113495bSYour Name  * qdf_clear_dp_pkt_add_ts_info() - clear all timestamp info
104*5113495bSYour Name  *
105*5113495bSYour Name  * Return: none
106*5113495bSYour Name  */
107*5113495bSYour Name void qdf_clear_dp_pkt_add_ts_info(void);
108*5113495bSYour Name 
109*5113495bSYour Name /**
110*5113495bSYour Name  * qdf_show_dp_pkt_add_ts_info() - Update buffer with configured information
111*5113495bSYour Name  *
112*5113495bSYour Name  * @buf: buffer pointer to get information
113*5113495bSYour Name  * @size: size of the buffer
114*5113495bSYour Name  *
115*5113495bSYour Name  * Return: number of bytes update in buffer
116*5113495bSYour Name  */
117*5113495bSYour Name int qdf_show_dp_pkt_add_ts_info(char *buf, size_t size);
118*5113495bSYour Name 
119*5113495bSYour Name /**
120*5113495bSYour Name  * qdf_add_dp_pkt_timestamp() - add timestamp in data payload
121*5113495bSYour Name  *
122*5113495bSYour Name  * @nbuf: network buffer
123*5113495bSYour Name  * @index: this decides offset in payload
124*5113495bSYour Name  * @time: timestamp to update
125*5113495bSYour Name  *
126*5113495bSYour Name  * Return: none
127*5113495bSYour Name  */
128*5113495bSYour Name void qdf_add_dp_pkt_timestamp(qdf_nbuf_t nbuf,
129*5113495bSYour Name 			      enum qdf_pkt_timestamp_index index,
130*5113495bSYour Name 			      uint64_t time);
131*5113495bSYour Name 
132*5113495bSYour Name /**
133*5113495bSYour Name  * qdf_is_dp_pkt_timestamp_enabled() - check if packet timestamping is enabled
134*5113495bSYour Name  *
135*5113495bSYour Name  * Return: true/false
136*5113495bSYour Name  */
137*5113495bSYour Name bool qdf_is_dp_pkt_timestamp_enabled(void);
138*5113495bSYour Name #else
139*5113495bSYour Name 
140*5113495bSYour Name static inline
qdf_set_dp_pkt_add_ts_info(enum qdf_pkt_supported_proto proto,uint16_t port,uint16_t offset)141*5113495bSYour Name int qdf_set_dp_pkt_add_ts_info(enum qdf_pkt_supported_proto proto,
142*5113495bSYour Name 			       uint16_t port, uint16_t offset)
143*5113495bSYour Name {
144*5113495bSYour Name 	return 0;
145*5113495bSYour Name }
146*5113495bSYour Name 
147*5113495bSYour Name static inline
qdf_clear_dp_pkt_add_ts_info(void)148*5113495bSYour Name void qdf_clear_dp_pkt_add_ts_info(void)
149*5113495bSYour Name {
150*5113495bSYour Name }
151*5113495bSYour Name 
152*5113495bSYour Name static inline
qdf_show_dp_pkt_add_ts_info(char * buf,size_t size)153*5113495bSYour Name int qdf_show_dp_pkt_add_ts_info(char *buf, size_t size)
154*5113495bSYour Name {
155*5113495bSYour Name 	return 0;
156*5113495bSYour Name }
157*5113495bSYour Name 
158*5113495bSYour Name static inline
qdf_add_dp_pkt_timestamp(qdf_nbuf_t nbuf,enum qdf_pkt_timestamp_index index,uint64_t time)159*5113495bSYour Name void qdf_add_dp_pkt_timestamp(qdf_nbuf_t nbuf,
160*5113495bSYour Name 			      enum qdf_pkt_timestamp_index index, uint64_t time)
161*5113495bSYour Name {
162*5113495bSYour Name }
163*5113495bSYour Name 
164*5113495bSYour Name static inline
qdf_is_dp_pkt_timestamp_enabled(void)165*5113495bSYour Name bool qdf_is_dp_pkt_timestamp_enabled(void)
166*5113495bSYour Name {
167*5113495bSYour Name 	return false;
168*5113495bSYour Name }
169*5113495bSYour Name 
170*5113495bSYour Name #endif
171*5113495bSYour Name #endif
172