xref: /wlan-driver/qcacld-3.0/components/pmo/dispatcher/inc/wlan_pmo_ns_public_struct.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2017-2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name /**
20*5113495bSYour Name  * DOC: Declare various struct, macros which shall be used in
21*5113495bSYour Name  * pmo ns offload feature.
22*5113495bSYour Name  *
23*5113495bSYour Name  * Note: This file shall not contain public API's prototype/declarations.
24*5113495bSYour Name  *
25*5113495bSYour Name  */
26*5113495bSYour Name 
27*5113495bSYour Name #ifndef _WLAN_PMO_NS_PUBLIC_STRUCT_H_
28*5113495bSYour Name #define _WLAN_PMO_NS_PUBLIC_STRUCT_H_
29*5113495bSYour Name 
30*5113495bSYour Name #include "wlan_pmo_common_public_struct.h"
31*5113495bSYour Name 
32*5113495bSYour Name /**
33*5113495bSYour Name  * enum pmo_ns_addr_scope - Internal identification of IPv6 addr scope
34*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_INVALID: invalid scope
35*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_NODELOCAL: node local scope
36*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_LINKLOCAL: link local scope
37*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_SITELOCAL: site local scope
38*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_ORGLOCAL: org local scope
39*5113495bSYour Name  * @PMO_NS_ADDR_SCOPE_GLOBAL: global scope
40*5113495bSYour Name  */
41*5113495bSYour Name enum pmo_ns_addr_scope {
42*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_INVALID = 0,
43*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_NODELOCAL = 1,
44*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_LINKLOCAL = 2,
45*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_SITELOCAL = 3,
46*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_ORGLOCAL = 4,
47*5113495bSYour Name 	PMO_NS_ADDR_SCOPE_GLOBAL = 5
48*5113495bSYour Name };
49*5113495bSYour Name 
50*5113495bSYour Name /**
51*5113495bSYour Name  * struct pmo_ns_offload_params - pmo ns offload parameters
52*5113495bSYour Name  * @enable: true when ns offload enable
53*5113495bSYour Name  * @num_ns_offload_count: total ns entries
54*5113495bSYour Name  * @src_ipv6_addr: in request source ipv 6 address
55*5113495bSYour Name  * @self_ipv6_addr: self ipv6 address
56*5113495bSYour Name  * @target_ipv6_addr: target ipv6 address
57*5113495bSYour Name  * @self_macaddr: self mac address
58*5113495bSYour Name  * @src_ipv6_addr_valid: true if source ipv6 address is valid else false
59*5113495bSYour Name  * @target_ipv6_addr_valid: target ipv6 address are valid or not
60*5113495bSYour Name  * @target_ipv6_addr_ac_type: target ipv6 address type (unicast or anycast)
61*5113495bSYour Name  * @slot_idx: slot index
62*5113495bSYour Name  * @bssid: BSSID
63*5113495bSYour Name  * @scope: scope
64*5113495bSYour Name  * @is_offload_applied: has the offload been applied to firmware
65*5113495bSYour Name  */
66*5113495bSYour Name struct pmo_ns_offload_params {
67*5113495bSYour Name 	uint8_t enable;
68*5113495bSYour Name 	uint32_t num_ns_offload_count;
69*5113495bSYour Name 	uint8_t src_ipv6_addr[QDF_IPV6_ADDR_SIZE];
70*5113495bSYour Name 	uint8_t self_ipv6_addr[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA]
71*5113495bSYour Name 		[QDF_IPV6_ADDR_SIZE];
72*5113495bSYour Name 	uint8_t target_ipv6_addr[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA]
73*5113495bSYour Name 		[QDF_IPV6_ADDR_SIZE];
74*5113495bSYour Name 	struct qdf_mac_addr self_macaddr;
75*5113495bSYour Name 	uint8_t src_ipv6_addr_valid;
76*5113495bSYour Name 	uint8_t target_ipv6_addr_valid[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA];
77*5113495bSYour Name 	uint8_t target_ipv6_addr_ac_type[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA];
78*5113495bSYour Name 	uint8_t slot_idx;
79*5113495bSYour Name 	struct qdf_mac_addr bssid;
80*5113495bSYour Name 	enum pmo_ns_addr_scope scope[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA];
81*5113495bSYour Name 	bool is_offload_applied;
82*5113495bSYour Name };
83*5113495bSYour Name 
84*5113495bSYour Name /**
85*5113495bSYour Name  * struct pmo_ns_req - pmo ns request
86*5113495bSYour Name  * @psoc: objmgr psoc
87*5113495bSYour Name  * @vdev_id: vdev id on which arp offload needed
88*5113495bSYour Name  * @trigger: context from where arp offload triggered
89*5113495bSYour Name  * @count: ns entries count
90*5113495bSYour Name  * @ipv6_addr: ipv6 address array
91*5113495bSYour Name  * @ipv6_addr_type: ipv6 address type (unicast/anycast) array
92*5113495bSYour Name  * @scope: scope
93*5113495bSYour Name  */
94*5113495bSYour Name struct pmo_ns_req {
95*5113495bSYour Name 	struct wlan_objmgr_psoc *psoc;
96*5113495bSYour Name 	uint8_t vdev_id;
97*5113495bSYour Name 	enum pmo_offload_trigger trigger;
98*5113495bSYour Name 	uint32_t count;
99*5113495bSYour Name 	uint8_t ipv6_addr[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA]
100*5113495bSYour Name 				[QDF_IPV6_ADDR_SIZE];
101*5113495bSYour Name 	uint8_t ipv6_addr_type[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA];
102*5113495bSYour Name 	enum pmo_ns_addr_scope scope[PMO_MAC_NUM_TARGET_IPV6_NS_OFFLOAD_NA];
103*5113495bSYour Name };
104*5113495bSYour Name #endif /* end  of _WLAN_PMO_NS_PUBLIC_STRUCT_H_ */
105