1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2019-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(__I_QDF_NET_IF_H)
26*5113495bSYour Name #define __I_QDF_NET_IF_H
27*5113495bSYour Name
28*5113495bSYour Name /* Include Files */
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include <qdf_util.h>
31*5113495bSYour Name #include <linux/netdevice.h>
32*5113495bSYour Name
33*5113495bSYour Name struct qdf_net_if;
34*5113495bSYour Name
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 static inline QDF_STATUS
__qdf_net_if_create_dummy_if(struct qdf_net_if * nif)44*5113495bSYour Name __qdf_net_if_create_dummy_if(struct qdf_net_if *nif)
45*5113495bSYour Name {
46*5113495bSYour Name int ret;
47*5113495bSYour Name
48*5113495bSYour Name ret = init_dummy_netdev((struct net_device *)nif);
49*5113495bSYour Name
50*5113495bSYour Name return qdf_status_from_os_return(ret);
51*5113495bSYour Name }
52*5113495bSYour Name
53*5113495bSYour Name /**
54*5113495bSYour Name * __qdf_net_if_get_dev_by_name() - Find a network device by its name
55*5113495bSYour Name * @nif_name: network device name
56*5113495bSYour Name *
57*5113495bSYour Name * This function retrieves the network device by its name
58*5113495bSYour Name *
59*5113495bSYour Name * Return: qdf network device
60*5113495bSYour Name */
61*5113495bSYour Name static inline struct qdf_net_if *
__qdf_net_if_get_dev_by_name(char * nif_name)62*5113495bSYour Name __qdf_net_if_get_dev_by_name(char *nif_name)
63*5113495bSYour Name {
64*5113495bSYour Name if (!nif_name)
65*5113495bSYour Name return NULL;
66*5113495bSYour Name
67*5113495bSYour Name return ((struct qdf_net_if *)dev_get_by_name(&init_net, nif_name));
68*5113495bSYour Name }
69*5113495bSYour Name
70*5113495bSYour Name /**
71*5113495bSYour Name * __qdf_net_if_release_dev() - Release reference to network device
72*5113495bSYour Name * @nif: network device
73*5113495bSYour Name *
74*5113495bSYour Name * This function releases reference to the network device
75*5113495bSYour Name *
76*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
77*5113495bSYour Name */
78*5113495bSYour Name static inline QDF_STATUS
__qdf_net_if_release_dev(struct qdf_net_if * nif)79*5113495bSYour Name __qdf_net_if_release_dev(struct qdf_net_if *nif)
80*5113495bSYour Name {
81*5113495bSYour Name if (!nif)
82*5113495bSYour Name return QDF_STATUS_E_INVAL;
83*5113495bSYour Name
84*5113495bSYour Name dev_put((struct net_device *)nif);
85*5113495bSYour Name
86*5113495bSYour Name return QDF_STATUS_SUCCESS;
87*5113495bSYour Name }
88*5113495bSYour Name
89*5113495bSYour Name /**
90*5113495bSYour Name * __qdf_net_if_hold_dev() - hold reference to network device
91*5113495bSYour Name * @nif: network device
92*5113495bSYour Name *
93*5113495bSYour Name * This function holds reference to the network device
94*5113495bSYour Name *
95*5113495bSYour Name * Return: QDF_STATUS_SUCCESS on success
96*5113495bSYour Name */
97*5113495bSYour Name static inline QDF_STATUS
__qdf_net_if_hold_dev(struct qdf_net_if * nif)98*5113495bSYour Name __qdf_net_if_hold_dev(struct qdf_net_if *nif)
99*5113495bSYour Name {
100*5113495bSYour Name if (!nif)
101*5113495bSYour Name return QDF_STATUS_E_INVAL;
102*5113495bSYour Name
103*5113495bSYour Name dev_hold((struct net_device *)nif);
104*5113495bSYour Name
105*5113495bSYour Name return QDF_STATUS_SUCCESS;
106*5113495bSYour Name }
107*5113495bSYour Name
108*5113495bSYour Name #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 17, 0))
109*5113495bSYour Name /**
110*5113495bSYour Name * __qdf_net_update_net_device_dev_addr() - update net_device dev_addr
111*5113495bSYour Name * @ndev: net_device
112*5113495bSYour Name * @src_addr: source mac address
113*5113495bSYour Name * @len: length
114*5113495bSYour Name *
115*5113495bSYour Name * kernel version 5.17 onwards made net_device->dev_addr as const unsigned char*
116*5113495bSYour Name * so to update dev_addr, this function calls kernel api dev_addr_mod.
117*5113495bSYour Name *
118*5113495bSYour Name * Return: void
119*5113495bSYour Name */
120*5113495bSYour Name static inline void
__qdf_net_update_net_device_dev_addr(struct net_device * ndev,const void * src_addr,size_t len)121*5113495bSYour Name __qdf_net_update_net_device_dev_addr(struct net_device *ndev,
122*5113495bSYour Name const void *src_addr,
123*5113495bSYour Name size_t len)
124*5113495bSYour Name {
125*5113495bSYour Name dev_addr_mod(ndev, 0, src_addr, len);
126*5113495bSYour Name }
127*5113495bSYour Name #else /* (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 17, 0)) */
128*5113495bSYour Name /**
129*5113495bSYour Name * __qdf_net_update_net_device_dev_addr() - update net_device dev_addr
130*5113495bSYour Name * @ndev: net_device
131*5113495bSYour Name * @src_addr: source mac address
132*5113495bSYour Name * @len: length
133*5113495bSYour Name *
134*5113495bSYour Name * This function updates dev_addr in net_device using mem copy.
135*5113495bSYour Name *
136*5113495bSYour Name * Return: void
137*5113495bSYour Name */
138*5113495bSYour Name static inline void
__qdf_net_update_net_device_dev_addr(struct net_device * ndev,const void * src_addr,size_t len)139*5113495bSYour Name __qdf_net_update_net_device_dev_addr(struct net_device *ndev,
140*5113495bSYour Name const void *src_addr,
141*5113495bSYour Name size_t len)
142*5113495bSYour Name {
143*5113495bSYour Name memcpy(ndev->dev_addr, src_addr, len);
144*5113495bSYour Name }
145*5113495bSYour Name #endif /* (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 17, 0)) */
146*5113495bSYour Name
147*5113495bSYour Name /**
148*5113495bSYour Name * __qdf_napi_enable() - Enable the napi schedule
149*5113495bSYour Name * @napi: NAPI context
150*5113495bSYour Name *
151*5113495bSYour Name * This function resume NAPI from being scheduled on this context
152*5113495bSYour Name *
153*5113495bSYour Name * Return: NONE
154*5113495bSYour Name */
155*5113495bSYour Name static inline void
__qdf_napi_enable(struct napi_struct * napi)156*5113495bSYour Name __qdf_napi_enable(struct napi_struct *napi)
157*5113495bSYour Name {
158*5113495bSYour Name napi_enable(napi);
159*5113495bSYour Name }
160*5113495bSYour Name
161*5113495bSYour Name /**
162*5113495bSYour Name * __qdf_napi_disable() - Disable the napi schedule
163*5113495bSYour Name * @napi: NAPI context
164*5113495bSYour Name *
165*5113495bSYour Name * This function suspends NAPI from being scheduled on this context
166*5113495bSYour Name *
167*5113495bSYour Name * Return: NONE
168*5113495bSYour Name */
169*5113495bSYour Name static inline void
__qdf_napi_disable(struct napi_struct * napi)170*5113495bSYour Name __qdf_napi_disable(struct napi_struct *napi)
171*5113495bSYour Name {
172*5113495bSYour Name napi_disable(napi);
173*5113495bSYour Name }
174*5113495bSYour Name
175*5113495bSYour Name #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 19, 0))
176*5113495bSYour Name /**
177*5113495bSYour Name * __qdf_netif_napi_add - initialize a NAPI context
178*5113495bSYour Name * @netdev: network device
179*5113495bSYour Name * @napi: NAPI context
180*5113495bSYour Name * @poll: polling function
181*5113495bSYour Name * @weight: default weight
182*5113495bSYour Name *
183*5113495bSYour Name * Upstream commit b48b89f9c189 ("net: drop the weight argument from
184*5113495bSYour Name * netif_napi_add") was introduced in Linux 6.1. As described by the
185*5113495bSYour Name * subject, this removes the weight argument from netif_napi_add().
186*5113495bSYour Name *
187*5113495bSYour Name * This was preceded by commit 58caed3dacb4 ("netdev: reshuffle
188*5113495bSYour Name * netif_napi_add() APIs to allow dropping weight") in Linux 5.19
189*5113495bSYour Name * which added new APIs to call when a non-default weight wishes to be
190*5113495bSYour Name * sent.
191*5113495bSYour Name *
192*5113495bSYour Name * Return: NONE
193*5113495bSYour Name */
194*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)195*5113495bSYour Name __qdf_netif_napi_add(struct net_device *netdev, struct napi_struct *napi,
196*5113495bSYour Name int (*poll)(struct napi_struct *, int), int weight)
197*5113495bSYour Name {
198*5113495bSYour Name netif_napi_add_weight(netdev, napi, poll, weight);
199*5113495bSYour Name }
200*5113495bSYour Name #else
201*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)202*5113495bSYour Name __qdf_netif_napi_add(struct net_device *netdev, struct napi_struct *napi,
203*5113495bSYour Name int (*poll)(struct napi_struct *, int), int weight)
204*5113495bSYour Name {
205*5113495bSYour Name netif_napi_add(netdev, napi, poll, weight);
206*5113495bSYour Name }
207*5113495bSYour Name #endif
208*5113495bSYour Name
209*5113495bSYour Name /**
210*5113495bSYour Name * __qdf_netif_napi_del: remove a NAPI context
211*5113495bSYour Name * @napi: NAPI context
212*5113495bSYour Name *
213*5113495bSYour Name * Return: NONE
214*5113495bSYour Name */
215*5113495bSYour Name static inline void
__qdf_netif_napi_del(struct napi_struct * napi)216*5113495bSYour Name __qdf_netif_napi_del(struct napi_struct *napi)
217*5113495bSYour Name {
218*5113495bSYour Name netif_napi_del(napi);
219*5113495bSYour Name }
220*5113495bSYour Name
221*5113495bSYour Name #endif /*__I_QDF_NET_IF_H */
222