xref: /wlan-dirver/qca-wifi-host-cmn/utils/logging/inc/wlan_logging_sock_svc.h (revision 503663c6daafffe652fa360bde17243568cd6d2a)
1 /*
2  * Copyright (c) 2014-2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /******************************************************************************
20 * wlan_logging_sock_svc.h
21 *
22 ******************************************************************************/
23 
24 #ifndef WLAN_LOGGING_SOCK_SVC_H
25 #define WLAN_LOGGING_SOCK_SVC_H
26 
27 #include <wlan_nlink_srv.h>
28 #include <qdf_status.h>
29 #include <qdf_trace.h>
30 #include <wlan_nlink_common.h>
31 
32 int wlan_logging_sock_init_svc(void);
33 int wlan_logging_sock_deinit_svc(void);
34 int wlan_log_to_user(QDF_TRACE_LEVEL log_level, char *to_be_sent, int length);
35 
36 /**
37  * wlan_logging_set_flush_timer() - Sets the time period for log flush timer
38  * @milliseconds: Time period in milliseconds
39  *
40  * This function sets the time period interval during which the log buffers
41  * will be flushed out to user space. Setting this interval can set an
42  * approximate maximum delay after which any message logged through QDF_TRACE
43  * will appear at user-space
44  *
45  * Return: void
46  */
47 int wlan_logging_set_flush_timer(uint32_t milliseconds);
48 
49 #ifdef WLAN_LOGGING_SOCK_SVC_ENABLE
50 void wlan_logging_set_per_pkt_stats(void);
51 void wlan_logging_set_fw_flush_complete(void);
52 void wlan_flush_host_logs_for_fatal(void);
53 void wlan_logging_set_active(bool active);
54 void wlan_logging_set_log_to_console(bool log_to_console);
55 #else
56 static inline void wlan_flush_host_logs_for_fatal(void) {}
57 static inline void wlan_logging_set_per_pkt_stats(void) {}
58 static inline void wlan_logging_set_fw_flush_complete(void) {}
59 static inline void wlan_logging_set_active(bool active) {}
60 static inline void wlan_logging_set_log_to_console(bool log_to_console) {}
61 #endif /* WLAN_LOGGING_SOCK_SVC_ENABLE */
62 
63 #if defined(WLAN_LOGGING_SOCK_SVC_ENABLE) && \
64 	defined(FEATURE_PKTLOG) && !defined(REMOVE_PKT_LOG)
65 /**
66  * wlan_deregister_txrx_packetdump() - tx/rx packet dump
67  *  deregistration
68  * @pdev_id: id of the datapath pdev handle
69  *
70  * This function is used to deregister tx/rx packet dump callbacks
71  * with ol, pe and htt layers
72  *
73  * Return: None
74  *
75  */
76 void wlan_deregister_txrx_packetdump(uint8_t pdev_id);
77 
78 /**
79  * wlan_register_txrx_packetdump() - tx/rx packet dump
80  * registration
81  * @pdev_id: id of the datapath pdev handle
82  *
83  * This function is used to register tx/rx packet dump callbacks
84  * with ol, pe and htt layers
85  *
86  * Return: None
87  *
88  */
89 void wlan_register_txrx_packetdump(uint8_t pdev_id);
90 #else
91 static inline void wlan_deregister_txrx_packetdump(uint8_t pdev_id) {}
92 static inline void wlan_register_txrx_packetdump(uint8_t pdev_id) {}
93 #endif
94 
95 #if defined(WLAN_LOGGING_SOCK_SVC_ENABLE) && defined(FEATURE_WLAN_DIAG_SUPPORT)
96 void wlan_report_log_completion(uint32_t is_fatal,
97 		uint32_t indicator,
98 		uint32_t reason_code,
99 		uint8_t ring_id);
100 #else
101 static inline void wlan_report_log_completion(uint32_t is_fatal,
102 		uint32_t indicator,
103 		uint32_t reason_code,
104 		uint8_t ring_id)
105 {
106 	return;
107 }
108 
109 #endif /* FEATURE_WLAN_DIAG_SUPPORT */
110 
111 #if defined(WLAN_LOGGING_SOCK_SVC_ENABLE) && \
112 	defined(FEATURE_PKTLOG) && !defined(REMOVE_PKT_LOG)
113 void wlan_pkt_stats_to_logger_thread(void *pl_hdr, void *pkt_dump, void *data);
114 #else
115 static inline
116 void wlan_pkt_stats_to_logger_thread(void *pl_hdr, void *pkt_dump, void *data)
117 {
118 }
119 #endif
120 
121 /**
122  * enum tx_status - tx status
123  * @tx_status_ok: successfully sent + acked
124  * @tx_status_discard: discard - not sent (congestion control)
125  * @tx_status_no_ack: no_ack - sent, but no ack
126  * @tx_status_download_fail: download_fail -
127  * the host could not deliver the tx frame to the target
128  * @tx_status_peer_del: peer_del - tx completion for
129  * already deleted peer used for HL case
130  *
131  * This enum has tx status types
132  */
133 enum tx_status {
134 	tx_status_ok,
135 	tx_status_discard,
136 	tx_status_no_ack,
137 	tx_status_download_fail,
138 	tx_status_peer_del,
139 };
140 
141 #endif /* WLAN_LOGGING_SOCK_SVC_H */
142