xref: /wlan-driver/qcacld-3.0/components/coap/dispatcher/inc/wlan_coap_tgt_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: contains CoAP south bound interface definitions
19*5113495bSYour Name  */
20*5113495bSYour Name 
21*5113495bSYour Name #ifndef _WLAN_COAP_TGT_API_H_
22*5113495bSYour Name #define _WLAN_COAP_TGT_API_H_
23*5113495bSYour Name 
24*5113495bSYour Name #ifdef WLAN_FEATURE_COAP
25*5113495bSYour Name #include <qdf_types.h>
26*5113495bSYour Name #include <wlan_objmgr_psoc_obj.h>
27*5113495bSYour Name #include <wlan_objmgr_vdev_obj.h>
28*5113495bSYour Name 
29*5113495bSYour Name /**
30*5113495bSYour Name  * tgt_coap_attach(): attach CoAP component
31*5113495bSYour Name  * @psoc: pointer to psoc
32*5113495bSYour Name  *
33*5113495bSYour Name  * This API will register CoAP related WMI event handlers.
34*5113495bSYour Name  *
35*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
36*5113495bSYour Name  */
37*5113495bSYour Name QDF_STATUS tgt_coap_attach(struct wlan_objmgr_psoc *psoc);
38*5113495bSYour Name 
39*5113495bSYour Name /**
40*5113495bSYour Name  * tgt_coap_detach(): detach CoAP component
41*5113495bSYour Name  * @psoc: pointer to psoc
42*5113495bSYour Name  *
43*5113495bSYour Name  * This API will unregister CoAP related WMI event handlers.
44*5113495bSYour Name  *
45*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
46*5113495bSYour Name  */
47*5113495bSYour Name QDF_STATUS tgt_coap_detach(struct wlan_objmgr_psoc *psoc);
48*5113495bSYour Name 
49*5113495bSYour Name /**
50*5113495bSYour Name  * tgt_send_coap_offload_reply_enable() - enable CoAP offload reply
51*5113495bSYour Name  * @vdev: pointer to vdev object
52*5113495bSYour Name  * @param: parameters for CoAP offload reply
53*5113495bSYour Name  *
54*5113495bSYour Name  * Return: status of operation
55*5113495bSYour Name  */
56*5113495bSYour Name QDF_STATUS
57*5113495bSYour Name tgt_send_coap_offload_reply_enable(struct wlan_objmgr_vdev *vdev,
58*5113495bSYour Name 				   struct coap_offload_reply_param *param);
59*5113495bSYour Name 
60*5113495bSYour Name /**
61*5113495bSYour Name  * tgt_send_coap_offload_reply_disable() - disable CoAP offload reply
62*5113495bSYour Name  * @vdev: pointer to vdev object
63*5113495bSYour Name  * @req_id: request id
64*5113495bSYour Name  *
65*5113495bSYour Name  * Return: status of operation
66*5113495bSYour Name  */
67*5113495bSYour Name QDF_STATUS
68*5113495bSYour Name tgt_send_coap_offload_reply_disable(struct wlan_objmgr_vdev *vdev,
69*5113495bSYour Name 				    uint32_t req_id);
70*5113495bSYour Name 
71*5113495bSYour Name /**
72*5113495bSYour Name  * tgt_send_coap_offload_periodic_tx_enable() - enable CoAP offload
73*5113495bSYour Name  * periodic transmitting
74*5113495bSYour Name  * @vdev: pointer to vdev object
75*5113495bSYour Name  * @param: parameters for CoAP periodic transmitting
76*5113495bSYour Name  *
77*5113495bSYour Name  * Return: status of operation
78*5113495bSYour Name  */
79*5113495bSYour Name QDF_STATUS
80*5113495bSYour Name tgt_send_coap_offload_periodic_tx_enable(struct wlan_objmgr_vdev *vdev,
81*5113495bSYour Name 			struct coap_offload_periodic_tx_param *param);
82*5113495bSYour Name 
83*5113495bSYour Name /**
84*5113495bSYour Name  * tgt_send_coap_offload_periodic_tx_disable() - disable CoAP offload
85*5113495bSYour Name  * periodic transmitting
86*5113495bSYour Name  * @vdev: pointer to vdev object
87*5113495bSYour Name  * @req_id: request id
88*5113495bSYour Name  *
89*5113495bSYour Name  * Return: status of operation
90*5113495bSYour Name  */
91*5113495bSYour Name QDF_STATUS
92*5113495bSYour Name tgt_send_coap_offload_periodic_tx_disable(struct wlan_objmgr_vdev *vdev,
93*5113495bSYour Name 					  uint32_t req_id);
94*5113495bSYour Name 
95*5113495bSYour Name /**
96*5113495bSYour Name  * tgt_send_coap_offload_cache_get() - get cached CoAP messages
97*5113495bSYour Name  * @vdev: pointer to vdev object
98*5113495bSYour Name  * @req_id: request id
99*5113495bSYour Name  *
100*5113495bSYour Name  * Return: status of operation
101*5113495bSYour Name  */
102*5113495bSYour Name QDF_STATUS
103*5113495bSYour Name tgt_send_coap_offload_cache_get(struct wlan_objmgr_vdev *vdev,
104*5113495bSYour Name 				uint32_t req_id);
105*5113495bSYour Name #endif
106*5113495bSYour Name #endif
107