xref: /wlan-driver/qcacld-3.0/components/coap/dispatcher/inc/wlan_coap_ucfg_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 north bound interface declarations
19*5113495bSYour Name  */
20*5113495bSYour Name 
21*5113495bSYour Name #ifndef _WLAN_COAP_UCFG_API_H_
22*5113495bSYour Name #define _WLAN_COAP_UCFG_API_H_
23*5113495bSYour Name 
24*5113495bSYour Name #include "qdf_status.h"
25*5113495bSYour Name #include <wlan_objmgr_vdev_obj.h>
26*5113495bSYour Name #include "wlan_coap_public_structs.h"
27*5113495bSYour Name 
28*5113495bSYour Name #ifdef WLAN_FEATURE_COAP
29*5113495bSYour Name /**
30*5113495bSYour Name  * ucfg_coap_offload_reply_enable() - API to enable CoAP offload reply
31*5113495bSYour Name  * @vdev: pointer to vdev object
32*5113495bSYour Name  * @param: parameters of CoAP offload reply
33*5113495bSYour Name  *
34*5113495bSYour Name  * Return: status of operation
35*5113495bSYour Name  */
36*5113495bSYour Name QDF_STATUS
37*5113495bSYour Name ucfg_coap_offload_reply_enable(struct wlan_objmgr_vdev *vdev,
38*5113495bSYour Name 			       struct coap_offload_reply_param *param);
39*5113495bSYour Name 
40*5113495bSYour Name /**
41*5113495bSYour Name  * ucfg_coap_offload_reply_disable() - API to disable CoAP offload reply
42*5113495bSYour Name  * @vdev: pointer to vdev object
43*5113495bSYour Name  * @req_id: request id
44*5113495bSYour Name  * @cbk: callback function to invoke with cached data
45*5113495bSYour Name  * @context: caller-supplied context
46*5113495bSYour Name  *
47*5113495bSYour Name  * Return: status of operation
48*5113495bSYour Name  */
49*5113495bSYour Name QDF_STATUS
50*5113495bSYour Name ucfg_coap_offload_reply_disable(struct wlan_objmgr_vdev *vdev, uint32_t req_id,
51*5113495bSYour Name 				coap_cache_get_callback cbk, void *context);
52*5113495bSYour Name 
53*5113495bSYour Name /**
54*5113495bSYour Name  * ucfg_coap_offload_periodic_tx_enable() - API to enable CoAP offload
55*5113495bSYour Name  * periodic transmit
56*5113495bSYour Name  * @vdev: pointer to vdev object
57*5113495bSYour Name  * @param: parameters of CoAP periodic transmit
58*5113495bSYour Name  *
59*5113495bSYour Name  * Return: status of operation
60*5113495bSYour Name  */
61*5113495bSYour Name QDF_STATUS
62*5113495bSYour Name ucfg_coap_offload_periodic_tx_enable(struct wlan_objmgr_vdev *vdev,
63*5113495bSYour Name 			struct coap_offload_periodic_tx_param *param);
64*5113495bSYour Name 
65*5113495bSYour Name /**
66*5113495bSYour Name  * ucfg_coap_offload_periodic_tx_disable() - API to disable CoAP offload
67*5113495bSYour Name  * periodic transmit
68*5113495bSYour Name  * @vdev: pointer to vdev object
69*5113495bSYour Name  * @req_id: request id
70*5113495bSYour Name  *
71*5113495bSYour Name  * Return: status of operation
72*5113495bSYour Name  */
73*5113495bSYour Name QDF_STATUS
74*5113495bSYour Name ucfg_coap_offload_periodic_tx_disable(struct wlan_objmgr_vdev *vdev,
75*5113495bSYour Name 				      uint32_t req_id);
76*5113495bSYour Name 
77*5113495bSYour Name /**
78*5113495bSYour Name  * ucfg_coap_offload_cache_get() - API to get CoAP offload cache
79*5113495bSYour Name  * @vdev: pointer to vdev object
80*5113495bSYour Name  * @req_id: request id
81*5113495bSYour Name  * @cbk: callback function to be called with the cache get result
82*5113495bSYour Name  * @context: context to be used by the caller to associate the get
83*5113495bSYour Name  * cache request with the response
84*5113495bSYour Name  *
85*5113495bSYour Name  * Return: status of operation
86*5113495bSYour Name  */
87*5113495bSYour Name QDF_STATUS
88*5113495bSYour Name ucfg_coap_offload_cache_get(struct wlan_objmgr_vdev *vdev, uint32_t req_id,
89*5113495bSYour Name 			    coap_cache_get_callback cbk, void *context);
90*5113495bSYour Name #endif
91*5113495bSYour Name #endif
92