xref: /wlan-driver/qcacld-3.0/components/wmi/inc/wmi_unified_coap_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2022 Qualcomm Innovation Center, Inc. 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 /**
18*5113495bSYour Name  * DOC: Implement API's specific to CoAP component.
19*5113495bSYour Name  */
20*5113495bSYour Name 
21*5113495bSYour Name #ifndef _WMI_UNIFIED_COAP_API_H_
22*5113495bSYour Name #define _WMI_UNIFIED_COAP_API_H_
23*5113495bSYour Name 
24*5113495bSYour Name #include <wmi_unified_priv.h>
25*5113495bSYour Name 
26*5113495bSYour Name #ifdef WLAN_FEATURE_COAP
27*5113495bSYour Name /**
28*5113495bSYour Name  * wmi_unified_coap_add_pattern_cmd() - Add pattern for CoAP offload reply
29*5113495bSYour Name  * @wmi_handle: wmi handle
30*5113495bSYour Name  * @param: parameters for CoAP offload reply
31*5113495bSYour Name  *
32*5113495bSYour Name  * Return: status of operation
33*5113495bSYour Name  */
34*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_add_pattern_cmd(wmi_unified_t wmi_handle,struct coap_offload_reply_param * param)35*5113495bSYour Name wmi_unified_coap_add_pattern_cmd(wmi_unified_t wmi_handle,
36*5113495bSYour Name 				 struct coap_offload_reply_param *param)
37*5113495bSYour Name {
38*5113495bSYour Name 	if (wmi_handle->ops->send_coap_add_pattern_cmd)
39*5113495bSYour Name 		return wmi_handle->ops->send_coap_add_pattern_cmd(wmi_handle,
40*5113495bSYour Name 								  param);
41*5113495bSYour Name 
42*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
43*5113495bSYour Name }
44*5113495bSYour Name 
45*5113495bSYour Name /**
46*5113495bSYour Name  * wmi_unified_coap_del_pattern_cmd() - Delete pattern for CoAP offload reply
47*5113495bSYour Name  * @wmi_handle: wmi handle
48*5113495bSYour Name  * @vdev_id: vdev id
49*5113495bSYour Name  * @pattern_id: pattern id
50*5113495bSYour Name  *
51*5113495bSYour Name  * Return: status of operation
52*5113495bSYour Name  */
53*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_del_pattern_cmd(wmi_unified_t wmi_handle,uint8_t vdev_id,uint32_t pattern_id)54*5113495bSYour Name wmi_unified_coap_del_pattern_cmd(wmi_unified_t wmi_handle,
55*5113495bSYour Name 				 uint8_t vdev_id, uint32_t pattern_id)
56*5113495bSYour Name {
57*5113495bSYour Name 	if (wmi_handle->ops->send_coap_del_pattern_cmd)
58*5113495bSYour Name 		return wmi_handle->ops->send_coap_del_pattern_cmd(wmi_handle,
59*5113495bSYour Name 		vdev_id, pattern_id);
60*5113495bSYour Name 
61*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
62*5113495bSYour Name }
63*5113495bSYour Name 
64*5113495bSYour Name /**
65*5113495bSYour Name  * wmi_unified_coap_add_keepalive_pattern_cmd() - Add pattern for CoAP offload
66*5113495bSYour Name  * periodic transmitting
67*5113495bSYour Name  * @wmi_handle: wmi handle
68*5113495bSYour Name  * @param: parameters for CoAP offload periodic transmitting
69*5113495bSYour Name  *
70*5113495bSYour Name  * Return: status of operation
71*5113495bSYour Name  */
72*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_add_keepalive_pattern_cmd(wmi_unified_t wmi_handle,struct coap_offload_periodic_tx_param * param)73*5113495bSYour Name wmi_unified_coap_add_keepalive_pattern_cmd(wmi_unified_t wmi_handle,
74*5113495bSYour Name 			struct coap_offload_periodic_tx_param *param)
75*5113495bSYour Name {
76*5113495bSYour Name 	if (wmi_handle->ops->send_coap_add_keepalive_pattern_cmd)
77*5113495bSYour Name 		return wmi_handle->ops->send_coap_add_keepalive_pattern_cmd(
78*5113495bSYour Name 					wmi_handle, param);
79*5113495bSYour Name 
80*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
81*5113495bSYour Name }
82*5113495bSYour Name 
83*5113495bSYour Name /**
84*5113495bSYour Name  * wmi_unified_coap_del_keepalive_pattern_cmd() - Delete pattern for CoAP
85*5113495bSYour Name  *                                                offload periodic transmitting
86*5113495bSYour Name  * @wmi_handle: wmi handle
87*5113495bSYour Name  * @vdev_id: vdev id
88*5113495bSYour Name  * @pattern_id: pattern id
89*5113495bSYour Name  *
90*5113495bSYour Name  * Return: status of operation
91*5113495bSYour Name  */
92*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_del_keepalive_pattern_cmd(wmi_unified_t wmi_handle,uint8_t vdev_id,uint32_t pattern_id)93*5113495bSYour Name wmi_unified_coap_del_keepalive_pattern_cmd(wmi_unified_t wmi_handle,
94*5113495bSYour Name 					   uint8_t vdev_id,
95*5113495bSYour Name 					   uint32_t pattern_id)
96*5113495bSYour Name {
97*5113495bSYour Name 	if (wmi_handle->ops->send_coap_del_keepalive_pattern_cmd)
98*5113495bSYour Name 		return wmi_handle->ops->send_coap_del_keepalive_pattern_cmd(
99*5113495bSYour Name 					wmi_handle, vdev_id, pattern_id);
100*5113495bSYour Name 
101*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
102*5113495bSYour Name }
103*5113495bSYour Name 
104*5113495bSYour Name /**
105*5113495bSYour Name  * wmi_unified_coap_cache_get() - Get cached CoAP messages
106*5113495bSYour Name  * @wmi_handle: wmi handle
107*5113495bSYour Name  * @vdev_id: vdev id
108*5113495bSYour Name  * @pattern_id: pattern id
109*5113495bSYour Name  *
110*5113495bSYour Name  * Return: status of operation
111*5113495bSYour Name  */
112*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_cache_get(wmi_unified_t wmi_handle,uint8_t vdev_id,uint32_t pattern_id)113*5113495bSYour Name wmi_unified_coap_cache_get(wmi_unified_t wmi_handle,
114*5113495bSYour Name 			   uint8_t vdev_id, uint32_t pattern_id)
115*5113495bSYour Name {
116*5113495bSYour Name 	if (wmi_handle->ops->send_coap_cache_get_cmd)
117*5113495bSYour Name 		return wmi_handle->ops->send_coap_cache_get_cmd(wmi_handle,
118*5113495bSYour Name 		vdev_id, pattern_id);
119*5113495bSYour Name 
120*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
121*5113495bSYour Name }
122*5113495bSYour Name 
123*5113495bSYour Name /**
124*5113495bSYour Name  * wmi_unified_coap_extract_buf_info() - extract CoAP buf info from event
125*5113495bSYour Name  * @wmi_handle: wmi handle
126*5113495bSYour Name  * @evt_buf: pointer to event buffer
127*5113495bSYour Name  * @info: Pointer to hold CoAP buf info
128*5113495bSYour Name  *
129*5113495bSYour Name  * The caller needs to free any possible nodes in info->info_list
130*5113495bSYour Name  * regardless of failure or success.
131*5113495bSYour Name  *
132*5113495bSYour Name  * Return: status of operation
133*5113495bSYour Name  */
134*5113495bSYour Name static inline QDF_STATUS
wmi_unified_coap_extract_buf_info(wmi_unified_t wmi_handle,void * evt_buf,struct coap_buf_info * info)135*5113495bSYour Name wmi_unified_coap_extract_buf_info(wmi_unified_t wmi_handle, void *evt_buf,
136*5113495bSYour Name 				  struct coap_buf_info *info)
137*5113495bSYour Name {
138*5113495bSYour Name 	if (wmi_handle->ops->extract_coap_buf_info) {
139*5113495bSYour Name 		return wmi_handle->ops->extract_coap_buf_info(wmi_handle,
140*5113495bSYour Name 							      evt_buf,
141*5113495bSYour Name 							      info);
142*5113495bSYour Name 	}
143*5113495bSYour Name 
144*5113495bSYour Name 	return QDF_STATUS_E_NOSUPPORT;
145*5113495bSYour Name }
146*5113495bSYour Name #endif
147*5113495bSYour Name #endif /* _WMI_UNIFIED_ROAM_API_H_ */
148