xref: /wlan-driver/qcacld-3.0/components/coap/dispatcher/inc/wlan_coap_public_structs.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 structure definitions
19*5113495bSYour Name  */
20*5113495bSYour Name 
21*5113495bSYour Name #ifndef _WLAN_COAP_PUBLIC_STRUCTS_H_
22*5113495bSYour Name #define _WLAN_COAP_PUBLIC_STRUCTS_H_
23*5113495bSYour Name #include <qdf_types.h>
24*5113495bSYour Name 
25*5113495bSYour Name /**
26*5113495bSYour Name  * struct coap_offload_reply_param - parameters to enable CoAP offload reply
27*5113495bSYour Name  * @vdev_id: vdev id
28*5113495bSYour Name  * @pattern_id: pattern id
29*5113495bSYour Name  * @cache_timeout: the cached packet expire timeout in ms
30*5113495bSYour Name  * @src_ip_v4: source IPv4 address for sending reply message
31*5113495bSYour Name  * @src_udp_port: source udp port for sending reply message
32*5113495bSYour Name  * @dest_ip_v4: destination IPv4 address to match received CoAP message
33*5113495bSYour Name  * @dest_ip_v4_is_bc: indicate whether the destination address is broadcast
34*5113495bSYour Name  * address or not
35*5113495bSYour Name  * @dest_udp_port: destination UDP port to match received CoAP message
36*5113495bSYour Name  * @verify_offset: UDP payload offset to match received CoAP message
37*5113495bSYour Name  * @verify_len: UDP payload length to match received CoAP message
38*5113495bSYour Name  * @verify: pointer to binary data to match received CoAP message
39*5113495bSYour Name  * @coapmsg_len: CoAP reply message length
40*5113495bSYour Name  * @coapmsg: pointer to CoAP reply message
41*5113495bSYour Name  */
42*5113495bSYour Name struct coap_offload_reply_param {
43*5113495bSYour Name 	uint32_t vdev_id;
44*5113495bSYour Name 	uint32_t pattern_id;
45*5113495bSYour Name 	uint32_t cache_timeout;
46*5113495bSYour Name 	uint32_t src_ip_v4;
47*5113495bSYour Name 	uint16_t src_udp_port;
48*5113495bSYour Name 	uint32_t dest_ip_v4;
49*5113495bSYour Name 	bool dest_ip_v4_is_bc;
50*5113495bSYour Name 	uint16_t dest_udp_port;
51*5113495bSYour Name 	uint32_t verify_offset;
52*5113495bSYour Name 	uint32_t verify_len;
53*5113495bSYour Name 	uint8_t *verify;
54*5113495bSYour Name 	uint32_t coapmsg_len;
55*5113495bSYour Name 	uint8_t *coapmsg;
56*5113495bSYour Name };
57*5113495bSYour Name 
58*5113495bSYour Name /**
59*5113495bSYour Name  * struct coap_offload_periodic_tx_param - parameters to enable CoAP offload
60*5113495bSYour Name  * periodic transmitting
61*5113495bSYour Name  * @vdev_id: vdev id
62*5113495bSYour Name  * @pattern_id: pattern id
63*5113495bSYour Name  * @src_ip_v4: IPv4 address for sending CoAP message
64*5113495bSYour Name  * @src_udp_port: source udp port for sending CoAP message
65*5113495bSYour Name  * @dest_ip_v4: destination IPv4 address for sending CoAP message
66*5113495bSYour Name  * @dest_ip_v4_is_bc: indicate whether the destination address is broadcast
67*5113495bSYour Name  * address or not
68*5113495bSYour Name  * @dest_udp_port: destination UDP port for sending CoAP message
69*5113495bSYour Name  * @timeout: the periorid to send keepalive message in ms
70*5113495bSYour Name  * @coapmsg_len: keeplive CoAP message length
71*5113495bSYour Name  * @coapmsg: pointer to keeplive CoAP message
72*5113495bSYour Name  */
73*5113495bSYour Name struct coap_offload_periodic_tx_param {
74*5113495bSYour Name 	uint32_t vdev_id;
75*5113495bSYour Name 	uint32_t pattern_id;
76*5113495bSYour Name 	uint32_t src_ip_v4;
77*5113495bSYour Name 	uint16_t src_udp_port;
78*5113495bSYour Name 	uint32_t dest_ip_v4;
79*5113495bSYour Name 	bool dest_ip_v4_is_bc;
80*5113495bSYour Name 	uint16_t dest_udp_port;
81*5113495bSYour Name 	uint32_t timeout;
82*5113495bSYour Name 	uint32_t coapmsg_len;
83*5113495bSYour Name 	uint8_t *coapmsg;
84*5113495bSYour Name };
85*5113495bSYour Name 
86*5113495bSYour Name /**
87*5113495bSYour Name  * struct coap_buf_node - CoAP message info entry
88*5113495bSYour Name  * @node: List entry element
89*5113495bSYour Name  * @tsf: TSF of the CoAP meesage
90*5113495bSYour Name  * @src_ip: source IPv4 address of the CoAP message
91*5113495bSYour Name  * @len: length of the payload
92*5113495bSYour Name  * @payload: pointer to buffer holding UDP payload of the CoAP message
93*5113495bSYour Name  */
94*5113495bSYour Name struct coap_buf_node {
95*5113495bSYour Name 	qdf_list_node_t node;
96*5113495bSYour Name 	uint64_t tsf;
97*5113495bSYour Name 	uint32_t src_ip;
98*5113495bSYour Name 	uint32_t len;
99*5113495bSYour Name 	uint8_t *payload;
100*5113495bSYour Name };
101*5113495bSYour Name 
102*5113495bSYour Name /**
103*5113495bSYour Name  * struct coap_buf_info - info of the cached CoAP messages
104*5113495bSYour Name  * @vdev_id: vdev id
105*5113495bSYour Name  * @req_id: request id
106*5113495bSYour Name  * @more_info: flag to indicate whether there are more cached messages
107*5113495bSYour Name  * @info_list: list to hold cached CoAP messages
108*5113495bSYour Name  */
109*5113495bSYour Name struct coap_buf_info {
110*5113495bSYour Name 	uint8_t vdev_id;
111*5113495bSYour Name 	uint32_t req_id;
112*5113495bSYour Name 	bool more_info;
113*5113495bSYour Name 	qdf_list_t info_list;
114*5113495bSYour Name };
115*5113495bSYour Name 
116*5113495bSYour Name /**
117*5113495bSYour Name  * typedef coap_cache_get_callback() - callback for getting cached CoAP messages
118*5113495bSYour Name  * @context: context for getting cached CoAP messages
119*5113495bSYour Name  * @info: pointer to info of the cached CoAP messages
120*5113495bSYour Name  */
121*5113495bSYour Name typedef void (*coap_cache_get_callback)(void *context,
122*5113495bSYour Name 					struct coap_buf_info *info);
123*5113495bSYour Name #endif
124