xref: /wlan-dirver/qca-wifi-host-cmn/target_if/direct_buf_rx/inc/target_if_direct_buf_rx_api.h (revision 1b9674e21e24478fba4530f5ae7396b9555e9c6a)
1 /*
2  * Copyright (c) 2017-2018 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 #ifndef _TARGET_IF_DIRECT_BUF_RX_API_H_
20 #define _TARGET_IF_DIRECT_BUF_RX_API_H_
21 
22 #include "qdf_nbuf.h"
23 #include "qdf_atomic.h"
24 
25 #define direct_buf_rx_alert(params...) \
26 	QDF_TRACE_FATAL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
27 #define direct_buf_rx_err(params...) \
28 	QDF_TRACE_ERROR(QDF_MODULE_ID_DIRECT_BUF_RX, params)
29 #define direct_buf_rx_warn(params...) \
30 	QDF_TRACE_WARN(QDF_MODULE_ID_DIRECT_BUF_RX, params)
31 #define direct_buf_rx_notice(params...) \
32 	QDF_TRACE_INFO(QDF_MODULE_ID_DIRECT_BUF_RX, params)
33 #define direct_buf_rx_info(params...) \
34 	QDF_TRACE_INFO(QDF_MODULE_ID_DIRECT_BUF_RX, params)
35 #define direct_buf_rx_debug(params...) \
36 	QDF_TRACE_DEBUG(QDF_MODULE_ID_DIRECT_BUF_RX, params)
37 #define direct_buf_rx_enter() \
38 	QDF_TRACE_ENTER(QDF_MODULE_ID_DIRECT_BUF_RX, "enter")
39 #define direct_buf_rx_exit() \
40 	QDF_TRACE_EXIT(QDF_MODULE_ID_DIRECT_BUF_RX, "exit")
41 
42 #define directbuf_nofl_alert(params...) \
43 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
44 #define directbuf_nofl_err(params...) \
45 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
46 #define directbuf_nofl_warn(params...) \
47 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
48 #define directbuf_nofl_info(params...) \
49 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
50 #define directbuf_nofl_debug(params...) \
51 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_DIRECT_BUF_RX, params)
52 
53 #define DBR_MAX_CHAINS      (8)
54 
55 struct wlan_objmgr_psoc;
56 struct wlan_lmac_if_tx_ops;
57 
58 /**
59  * struct direct_buf_rx_data - direct buffer rx data
60  * @dbr_len: Length of the buffer DMAed
61  * @vaddr: Virtual address of the buffer that has DMAed data
62  * @meta_data_valid: Indicates that metadata is valid
63  * @meta_data: Meta data
64  */
65 struct direct_buf_rx_data {
66 	size_t dbr_len;
67 	void *vaddr;
68 	bool meta_data_valid;
69 	struct direct_buf_rx_metadata meta_data;
70 };
71 
72 /**
73  * direct_buf_rx_init() - Function to initialize direct buf rx module
74  *
75  * Return: QDF status of operation
76  */
77 QDF_STATUS direct_buf_rx_init(void);
78 
79 /**
80  * direct_buf_rx_deinit() - Function to deinitialize direct buf rx module
81  *
82  * Return: QDF status of operation
83  */
84 QDF_STATUS direct_buf_rx_deinit(void);
85 
86 /**
87  * direct_buf_rx_target_attach() - Attach hal_soc,osdev in direct buf rx psoc obj
88  * @psoc: pointer to psoc object
89  * @hal_soc: Opaque HAL SOC handle
90  * @osdev: QDF os device handle
91  *
92  * Return: QDF status of operation
93  */
94 QDF_STATUS direct_buf_rx_target_attach(struct wlan_objmgr_psoc *psoc,
95 				void *hal_soc, qdf_device_t osdev);
96 
97 /**
98  * target_if_direct_buf_rx_register_tx_ops() - Register tx ops for direct buffer
99  *                                             rx module
100  * @tx_ops: pointer to lmac interface tx ops
101  *
102  * Return: None
103  */
104 void target_if_direct_buf_rx_register_tx_ops(
105 				struct wlan_lmac_if_tx_ops *tx_ops);
106 
107 #endif /* _TARGET_IF_DIRECT_BUF_RX_API_H_ */
108