xref: /openbmc/linux/include/linux/netpoll.h (revision a8da474e)
1 /*
2  * Common code for low-level network console, dump, and debugger code
3  *
4  * Derived from netconsole, kgdb-over-ethernet, and netdump patches
5  */
6 
7 #ifndef _LINUX_NETPOLL_H
8 #define _LINUX_NETPOLL_H
9 
10 #include <linux/netdevice.h>
11 #include <linux/interrupt.h>
12 #include <linux/rcupdate.h>
13 #include <linux/list.h>
14 
15 union inet_addr {
16 	__u32		all[4];
17 	__be32		ip;
18 	__be32		ip6[4];
19 	struct in_addr	in;
20 	struct in6_addr	in6;
21 };
22 
23 struct netpoll {
24 	struct net_device *dev;
25 	char dev_name[IFNAMSIZ];
26 	const char *name;
27 
28 	union inet_addr local_ip, remote_ip;
29 	bool ipv6;
30 	u16 local_port, remote_port;
31 	u8 remote_mac[ETH_ALEN];
32 
33 	struct work_struct cleanup_work;
34 };
35 
36 struct netpoll_info {
37 	atomic_t refcnt;
38 
39 	struct semaphore dev_lock;
40 
41 	struct sk_buff_head txq;
42 
43 	struct delayed_work tx_work;
44 
45 	struct netpoll *netpoll;
46 	struct rcu_head rcu;
47 };
48 
49 #ifdef CONFIG_NETPOLL
50 extern void netpoll_poll_disable(struct net_device *dev);
51 extern void netpoll_poll_enable(struct net_device *dev);
52 #else
53 static inline void netpoll_poll_disable(struct net_device *dev) { return; }
54 static inline void netpoll_poll_enable(struct net_device *dev) { return; }
55 #endif
56 
57 void netpoll_send_udp(struct netpoll *np, const char *msg, int len);
58 void netpoll_print_options(struct netpoll *np);
59 int netpoll_parse_options(struct netpoll *np, char *opt);
60 int __netpoll_setup(struct netpoll *np, struct net_device *ndev);
61 int netpoll_setup(struct netpoll *np);
62 void __netpoll_cleanup(struct netpoll *np);
63 void __netpoll_free_async(struct netpoll *np);
64 void netpoll_cleanup(struct netpoll *np);
65 void netpoll_send_skb_on_dev(struct netpoll *np, struct sk_buff *skb,
66 			     struct net_device *dev);
67 static inline void netpoll_send_skb(struct netpoll *np, struct sk_buff *skb)
68 {
69 	unsigned long flags;
70 	local_irq_save(flags);
71 	netpoll_send_skb_on_dev(np, skb, np->dev);
72 	local_irq_restore(flags);
73 }
74 
75 #ifdef CONFIG_NETPOLL
76 static inline void *netpoll_poll_lock(struct napi_struct *napi)
77 {
78 	struct net_device *dev = napi->dev;
79 
80 	if (dev && dev->npinfo) {
81 		spin_lock(&napi->poll_lock);
82 		napi->poll_owner = smp_processor_id();
83 		return napi;
84 	}
85 	return NULL;
86 }
87 
88 static inline void netpoll_poll_unlock(void *have)
89 {
90 	struct napi_struct *napi = have;
91 
92 	if (napi) {
93 		napi->poll_owner = -1;
94 		spin_unlock(&napi->poll_lock);
95 	}
96 }
97 
98 static inline bool netpoll_tx_running(struct net_device *dev)
99 {
100 	return irqs_disabled();
101 }
102 
103 #else
104 static inline void *netpoll_poll_lock(struct napi_struct *napi)
105 {
106 	return NULL;
107 }
108 static inline void netpoll_poll_unlock(void *have)
109 {
110 }
111 static inline void netpoll_netdev_init(struct net_device *dev)
112 {
113 }
114 static inline bool netpoll_tx_running(struct net_device *dev)
115 {
116 	return false;
117 }
118 #endif
119 
120 #endif
121