xref: /wlan-driver/qca-wifi-host-cmn/qdf/inc/qdf_net_if.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2014-2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2022-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 /**
21*5113495bSYour Name  * DOC: qdf_net_if
22*5113495bSYour Name  * QCA driver framework (QDF) network interface management APIs
23*5113495bSYour Name  */
24*5113495bSYour Name 
25*5113495bSYour Name #if !defined(__QDF_NET_IF_H)
26*5113495bSYour Name #define __QDF_NET_IF_H
27*5113495bSYour Name 
28*5113495bSYour Name /* Include Files */
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include <i_qdf_net_if.h>
31*5113495bSYour Name 
32*5113495bSYour Name struct qdf_net_if;
33*5113495bSYour Name 
34*5113495bSYour Name #ifdef ENHANCED_OS_ABSTRACTION
35*5113495bSYour Name /**
36*5113495bSYour Name  * qdf_net_if_create_dummy_if() - create dummy interface
37*5113495bSYour Name  * @nif: interface handle
38*5113495bSYour Name  *
39*5113495bSYour Name  * This function will create a dummy network interface
40*5113495bSYour Name  *
41*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
42*5113495bSYour Name  */
43*5113495bSYour Name QDF_STATUS
44*5113495bSYour Name qdf_net_if_create_dummy_if(struct qdf_net_if *nif);
45*5113495bSYour Name 
46*5113495bSYour Name /**
47*5113495bSYour Name  * qdf_net_if_get_dev_by_name() - Find a network device by its name
48*5113495bSYour Name  * @nif_name: network device name
49*5113495bSYour Name  *
50*5113495bSYour Name  * This function retrieves the network device by its name
51*5113495bSYour Name  *
52*5113495bSYour Name  * Return: qdf network device
53*5113495bSYour Name  */
54*5113495bSYour Name struct qdf_net_if *
55*5113495bSYour Name qdf_net_if_get_dev_by_name(char *nif_name);
56*5113495bSYour Name 
57*5113495bSYour Name /**
58*5113495bSYour Name  * qdf_net_if_release_dev() - Release reference to network device
59*5113495bSYour Name  * @nif: network device
60*5113495bSYour Name  *
61*5113495bSYour Name  * This function releases reference to the network device
62*5113495bSYour Name  *
63*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
64*5113495bSYour Name  */
65*5113495bSYour Name QDF_STATUS
66*5113495bSYour Name qdf_net_if_release_dev(struct qdf_net_if *nif);
67*5113495bSYour Name 
68*5113495bSYour Name /**
69*5113495bSYour Name  * qdf_net_if_hold_dev() - Hold reference to network device
70*5113495bSYour Name  * @nif: network device
71*5113495bSYour Name  *
72*5113495bSYour Name  * This function holds reference to the network device
73*5113495bSYour Name  *
74*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success
75*5113495bSYour Name  */
76*5113495bSYour Name QDF_STATUS
77*5113495bSYour Name qdf_net_if_hold_dev(struct qdf_net_if *nif);
78*5113495bSYour Name 
79*5113495bSYour Name /**
80*5113495bSYour Name  * qdf_napi_enable() - Enable the napi schedule
81*5113495bSYour Name  * @napi: NAPI context
82*5113495bSYour Name  *
83*5113495bSYour Name  * This function resume NAPI from being scheduled on this context
84*5113495bSYour Name  *
85*5113495bSYour Name  * Return: NONE
86*5113495bSYour Name  */
87*5113495bSYour Name void qdf_napi_enable(struct napi_struct *napi);
88*5113495bSYour Name 
89*5113495bSYour Name /**
90*5113495bSYour Name  * qdf_napi_disable() - Disable the napi schedule
91*5113495bSYour Name  * @napi: NAPI context
92*5113495bSYour Name  *
93*5113495bSYour Name  * This function suspends NAPI from being scheduled on this context
94*5113495bSYour Name  *
95*5113495bSYour Name  * Return: NONE
96*5113495bSYour Name  */
97*5113495bSYour Name void qdf_napi_disable(struct napi_struct *napi);
98*5113495bSYour Name 
99*5113495bSYour Name /**
100*5113495bSYour Name  * qdf_netif_napi_add - initialize a NAPI context
101*5113495bSYour Name  * @netdev:  network device
102*5113495bSYour Name  * @napi: NAPI context
103*5113495bSYour Name  * @poll: polling function
104*5113495bSYour Name  * @weight: default weight
105*5113495bSYour Name  *
106*5113495bSYour Name  * Return: NONE
107*5113495bSYour Name  */
108*5113495bSYour Name void qdf_netif_napi_add(struct net_device *netdev, struct napi_struct *napi,
109*5113495bSYour Name 			int (*poll)(struct napi_struct *, int), int weight);
110*5113495bSYour Name 
111*5113495bSYour Name /**
112*5113495bSYour Name  *  qdf_netif_napi_del - remove a NAPI context
113*5113495bSYour Name  *  @napi: NAPI context
114*5113495bSYour Name  *
115*5113495bSYour Name  *  Return: NONE
116*5113495bSYour Name  */
117*5113495bSYour Name void qdf_netif_napi_del(struct napi_struct *napi);
118*5113495bSYour Name 
119*5113495bSYour Name /**
120*5113495bSYour Name  * qdf_net_update_net_device_dev_addr() - update net_device dev_addr
121*5113495bSYour Name  * @ndev: net_device
122*5113495bSYour Name  * @src_addr: source mac address
123*5113495bSYour Name  * @len: length
124*5113495bSYour Name  *
125*5113495bSYour Name  * This function updates dev_addr in net_device
126*5113495bSYour Name  *
127*5113495bSYour Name  * Return: void
128*5113495bSYour Name  */
129*5113495bSYour Name void
130*5113495bSYour Name qdf_net_update_net_device_dev_addr(struct net_device *ndev,
131*5113495bSYour Name 				   const void *src_addr,
132*5113495bSYour Name 				   size_t len);
133*5113495bSYour Name #else /* ENHANCED_OS_ABSTRACTION */
134*5113495bSYour Name static inline QDF_STATUS
qdf_net_if_create_dummy_if(struct qdf_net_if * nif)135*5113495bSYour Name qdf_net_if_create_dummy_if(struct qdf_net_if *nif)
136*5113495bSYour Name {
137*5113495bSYour Name 	return __qdf_net_if_create_dummy_if(nif);
138*5113495bSYour Name }
139*5113495bSYour Name 
140*5113495bSYour Name static inline struct qdf_net_if *
qdf_net_if_get_dev_by_name(char * nif_name)141*5113495bSYour Name qdf_net_if_get_dev_by_name(char *nif_name)
142*5113495bSYour Name {
143*5113495bSYour Name 	return __qdf_net_if_get_dev_by_name(nif_name);
144*5113495bSYour Name }
145*5113495bSYour Name 
146*5113495bSYour Name static inline QDF_STATUS
qdf_net_if_release_dev(struct qdf_net_if * nif)147*5113495bSYour Name qdf_net_if_release_dev(struct qdf_net_if *nif)
148*5113495bSYour Name {
149*5113495bSYour Name 	return __qdf_net_if_release_dev(nif);
150*5113495bSYour Name }
151*5113495bSYour Name 
152*5113495bSYour Name static inline QDF_STATUS
qdf_net_if_hold_dev(struct qdf_net_if * nif)153*5113495bSYour Name qdf_net_if_hold_dev(struct qdf_net_if *nif)
154*5113495bSYour Name {
155*5113495bSYour Name 	return __qdf_net_if_hold_dev(nif);
156*5113495bSYour Name }
157*5113495bSYour Name 
158*5113495bSYour Name /**
159*5113495bSYour Name  * qdf_net_update_net_device_dev_addr() - update net_device dev_addr
160*5113495bSYour Name  * @ndev: net_device
161*5113495bSYour Name  * @src_addr: source mac address
162*5113495bSYour Name  * @len: length
163*5113495bSYour Name  *
164*5113495bSYour Name  * This function updates dev_addr in net_device
165*5113495bSYour Name  *
166*5113495bSYour Name  * Return: void
167*5113495bSYour Name  */
168*5113495bSYour Name static inline void
qdf_net_update_net_device_dev_addr(struct net_device * ndev,const void * src_addr,size_t len)169*5113495bSYour Name qdf_net_update_net_device_dev_addr(struct net_device *ndev,
170*5113495bSYour Name 				   const void *src_addr,
171*5113495bSYour Name 				   size_t len)
172*5113495bSYour Name {
173*5113495bSYour Name 	__qdf_net_update_net_device_dev_addr(ndev, src_addr, len);
174*5113495bSYour Name }
175*5113495bSYour Name 
176*5113495bSYour Name static inline void
qdf_napi_enable(struct napi_struct * napi)177*5113495bSYour Name qdf_napi_enable(struct napi_struct *napi)
178*5113495bSYour Name {
179*5113495bSYour Name 	__qdf_napi_enable(napi);
180*5113495bSYour Name }
181*5113495bSYour Name 
182*5113495bSYour Name static inline void
qdf_napi_disable(struct napi_struct * napi)183*5113495bSYour Name qdf_napi_disable(struct napi_struct *napi)
184*5113495bSYour Name {
185*5113495bSYour Name 	__qdf_napi_disable(napi);
186*5113495bSYour Name }
187*5113495bSYour Name 
188*5113495bSYour Name static inline void
qdf_netif_napi_add(struct net_device * netdev,struct napi_struct * napi,int (* poll)(struct napi_struct *,int),int weight)189*5113495bSYour Name qdf_netif_napi_add(struct net_device *netdev, struct napi_struct *napi,
190*5113495bSYour Name 		   int (*poll)(struct napi_struct *, int), int weight)
191*5113495bSYour Name {
192*5113495bSYour Name 	__qdf_netif_napi_add(netdev, napi, poll, weight);
193*5113495bSYour Name }
194*5113495bSYour Name 
195*5113495bSYour Name static inline void
qdf_netif_napi_del(struct napi_struct * napi)196*5113495bSYour Name qdf_netif_napi_del(struct napi_struct *napi)
197*5113495bSYour Name {
198*5113495bSYour Name 	__qdf_netif_napi_del(napi);
199*5113495bSYour Name }
200*5113495bSYour Name #endif /* ENHANCED_OS_ABSTRACTION */
201*5113495bSYour Name 
202*5113495bSYour Name /**
203*5113495bSYour Name  * qdf_net_if_get_devname() - Retrieve netdevice name
204*5113495bSYour Name  * @nif: Abstraction of netdevice
205*5113495bSYour Name  *
206*5113495bSYour Name  * Return: netdevice name
207*5113495bSYour Name  */
208*5113495bSYour Name char *qdf_net_if_get_devname(struct qdf_net_if *nif);
209*5113495bSYour Name #endif /* __QDF_NET_IF_H */
210