License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[linux-block.git] / drivers / net / ethernet / sun / sunvnet_common.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _SUNVNETCOMMON_H
3 #define _SUNVNETCOMMON_H
4
5 #include <linux/interrupt.h>
6
7 /* length of time (or less) we expect pending descriptors to be marked
8  * as VIO_DESC_DONE and skbs ready to be freed
9  */
10 #define VNET_CLEAN_TIMEOUT              ((HZ / 100) + 1)
11
12 #define VNET_MAXPACKET                  (65535ULL + ETH_HLEN + VLAN_HLEN)
13 #define VNET_TX_RING_SIZE               512
14 #define VNET_TX_WAKEUP_THRESH(dr)       ((dr)->pending / 4)
15
16 #define VNET_MINTSO      2048   /* VIO protocol's minimum TSO len */
17 #define VNET_MAXTSO     65535   /* VIO protocol's maximum TSO len */
18
19 #define VNET_MAX_MTU    65535
20
21 /* VNET packets are sent in buffers with the first 6 bytes skipped
22  * so that after the ethernet header the IPv4/IPv6 headers are aligned
23  * properly.
24  */
25 #define VNET_PACKET_SKIP                6
26
27 #define VNET_MAXCOOKIES                 (VNET_MAXPACKET / PAGE_SIZE + 1)
28
29 #define VNET_MAX_TXQS           16
30
31 struct vnet_tx_entry {
32         struct sk_buff          *skb;
33         unsigned int            ncookies;
34         struct ldc_trans_cookie cookies[VNET_MAXCOOKIES];
35 };
36
37 struct vnet;
38
39 struct vnet_port_stats {
40         /* keep them all the same size */
41         u32 rx_bytes;
42         u32 tx_bytes;
43         u32 rx_packets;
44         u32 tx_packets;
45         u32 event_up;
46         u32 event_reset;
47         u32 q_placeholder;
48 };
49
50 #define NUM_VNET_PORT_STATS  (sizeof(struct vnet_port_stats) / sizeof(u32))
51
52 /* Structure to describe a vnet-port or vsw-port in the MD.
53  * If the vsw bit is set, this structure represents a vswitch
54  * port, and the net_device can be found from ->dev. If the
55  * vsw bit is not set, the net_device is available from ->vp->dev.
56  * See the VNET_PORT_TO_NET_DEVICE macro below.
57  */
58 struct vnet_port {
59         struct vio_driver_state vio;
60
61         struct vnet_port_stats stats;
62
63         struct hlist_node       hash;
64         u8                      raddr[ETH_ALEN];
65         unsigned                switch_port:1;
66         unsigned                tso:1;
67         unsigned                vsw:1;
68         unsigned                __pad:13;
69
70         struct vnet             *vp;
71         struct net_device       *dev;
72
73         struct vnet_tx_entry    tx_bufs[VNET_TX_RING_SIZE];
74
75         struct list_head        list;
76
77         u32                     stop_rx_idx;
78         bool                    stop_rx;
79         bool                    start_cons;
80
81         struct timer_list       clean_timer;
82
83         u64                     rmtu;
84         u16                     tsolen;
85
86         struct napi_struct      napi;
87         u32                     napi_stop_idx;
88         bool                    napi_resume;
89         int                     rx_event;
90         u16                     q_index;
91 };
92
93 static inline struct vnet_port *to_vnet_port(struct vio_driver_state *vio)
94 {
95         return container_of(vio, struct vnet_port, vio);
96 }
97
98 #define VNET_PORT_HASH_SIZE     16
99 #define VNET_PORT_HASH_MASK     (VNET_PORT_HASH_SIZE - 1)
100
101 static inline unsigned int vnet_hashfn(u8 *mac)
102 {
103         unsigned int val = mac[4] ^ mac[5];
104
105         return val & (VNET_PORT_HASH_MASK);
106 }
107
108 struct vnet_mcast_entry {
109         u8                      addr[ETH_ALEN];
110         u8                      sent;
111         u8                      hit;
112         struct vnet_mcast_entry *next;
113 };
114
115 struct vnet {
116         spinlock_t              lock; /* Protects port_list and port_hash.  */
117         struct net_device       *dev;
118         u32                     msg_enable;
119         u8                      q_used[VNET_MAX_TXQS];
120         struct list_head        port_list;
121         struct hlist_head       port_hash[VNET_PORT_HASH_SIZE];
122         struct vnet_mcast_entry *mcast_list;
123         struct list_head        list;
124         u64                     local_mac;
125         int                     nports;
126 };
127
128 /* Def used by common code to get the net_device from the proper location */
129 #define VNET_PORT_TO_NET_DEVICE(__port) \
130         ((__port)->vsw ? (__port)->dev : (__port)->vp->dev)
131
132 /* Common funcs */
133 void sunvnet_clean_timer_expire_common(unsigned long port0);
134 int sunvnet_open_common(struct net_device *dev);
135 int sunvnet_close_common(struct net_device *dev);
136 void sunvnet_set_rx_mode_common(struct net_device *dev, struct vnet *vp);
137 int sunvnet_set_mac_addr_common(struct net_device *dev, void *p);
138 void sunvnet_tx_timeout_common(struct net_device *dev);
139 int sunvnet_start_xmit_common(struct sk_buff *skb, struct net_device *dev,
140                            struct vnet_port *(*vnet_tx_port)
141                            (struct sk_buff *, struct net_device *));
142 #ifdef CONFIG_NET_POLL_CONTROLLER
143 void sunvnet_poll_controller_common(struct net_device *dev, struct vnet *vp);
144 #endif
145 void sunvnet_event_common(void *arg, int event);
146 int sunvnet_send_attr_common(struct vio_driver_state *vio);
147 int sunvnet_handle_attr_common(struct vio_driver_state *vio, void *arg);
148 void sunvnet_handshake_complete_common(struct vio_driver_state *vio);
149 int sunvnet_poll_common(struct napi_struct *napi, int budget);
150 void sunvnet_port_free_tx_bufs_common(struct vnet_port *port);
151 void vnet_port_reset(struct vnet_port *port);
152 bool sunvnet_port_is_up_common(struct vnet_port *vnet);
153 void sunvnet_port_add_txq_common(struct vnet_port *port);
154 void sunvnet_port_rm_txq_common(struct vnet_port *port);
155
156 #endif /* _SUNVNETCOMMON_H */