xref: /openbmc/linux/drivers/net/ethernet/sfc/efx.h (revision a06c488d)
1 /****************************************************************************
2  * Driver for Solarflare network controllers and boards
3  * Copyright 2005-2006 Fen Systems Ltd.
4  * Copyright 2006-2013 Solarflare Communications Inc.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License version 2 as published
8  * by the Free Software Foundation, incorporated herein by reference.
9  */
10 
11 #ifndef EFX_EFX_H
12 #define EFX_EFX_H
13 
14 #include "net_driver.h"
15 #include "filter.h"
16 
17 /* All controllers use BAR 0 for I/O space and BAR 2(&3) for memory */
18 /* All VFs use BAR 0/1 for memory */
19 #define EFX_MEM_BAR 2
20 #define EFX_MEM_VF_BAR 0
21 
22 int efx_net_open(struct net_device *net_dev);
23 int efx_net_stop(struct net_device *net_dev);
24 
25 /* TX */
26 int efx_probe_tx_queue(struct efx_tx_queue *tx_queue);
27 void efx_remove_tx_queue(struct efx_tx_queue *tx_queue);
28 void efx_init_tx_queue(struct efx_tx_queue *tx_queue);
29 void efx_init_tx_queue_core_txq(struct efx_tx_queue *tx_queue);
30 void efx_fini_tx_queue(struct efx_tx_queue *tx_queue);
31 netdev_tx_t efx_hard_start_xmit(struct sk_buff *skb,
32 				struct net_device *net_dev);
33 netdev_tx_t efx_enqueue_skb(struct efx_tx_queue *tx_queue, struct sk_buff *skb);
34 void efx_xmit_done(struct efx_tx_queue *tx_queue, unsigned int index);
35 int efx_setup_tc(struct net_device *net_dev, u8 num_tc);
36 unsigned int efx_tx_max_skb_descs(struct efx_nic *efx);
37 extern unsigned int efx_piobuf_size;
38 extern bool efx_separate_tx_channels;
39 
40 /* RX */
41 void efx_set_default_rx_indir_table(struct efx_nic *efx);
42 void efx_rx_config_page_split(struct efx_nic *efx);
43 int efx_probe_rx_queue(struct efx_rx_queue *rx_queue);
44 void efx_remove_rx_queue(struct efx_rx_queue *rx_queue);
45 void efx_init_rx_queue(struct efx_rx_queue *rx_queue);
46 void efx_fini_rx_queue(struct efx_rx_queue *rx_queue);
47 void efx_fast_push_rx_descriptors(struct efx_rx_queue *rx_queue, bool atomic);
48 void efx_rx_slow_fill(unsigned long context);
49 void __efx_rx_packet(struct efx_channel *channel);
50 void efx_rx_packet(struct efx_rx_queue *rx_queue, unsigned int index,
51 		   unsigned int n_frags, unsigned int len, u16 flags);
52 static inline void efx_rx_flush_packet(struct efx_channel *channel)
53 {
54 	if (channel->rx_pkt_n_frags)
55 		__efx_rx_packet(channel);
56 }
57 void efx_schedule_slow_fill(struct efx_rx_queue *rx_queue);
58 
59 #define EFX_MAX_DMAQ_SIZE 4096UL
60 #define EFX_DEFAULT_DMAQ_SIZE 1024UL
61 #define EFX_MIN_DMAQ_SIZE 512UL
62 
63 #define EFX_MAX_EVQ_SIZE 16384UL
64 #define EFX_MIN_EVQ_SIZE 512UL
65 
66 /* Maximum number of TCP segments we support for soft-TSO */
67 #define EFX_TSO_MAX_SEGS	100
68 
69 /* The smallest [rt]xq_entries that the driver supports.  RX minimum
70  * is a bit arbitrary.  For TX, we must have space for at least 2
71  * TSO skbs.
72  */
73 #define EFX_RXQ_MIN_ENT		128U
74 #define EFX_TXQ_MIN_ENT(efx)	(2 * efx_tx_max_skb_descs(efx))
75 
76 #define EFX_TXQ_MAX_ENT(efx)	(EFX_WORKAROUND_35388(efx) ? \
77 				 EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)
78 
79 static inline bool efx_rss_enabled(struct efx_nic *efx)
80 {
81 	return efx->rss_spread > 1;
82 }
83 
84 /* Filters */
85 
86 void efx_mac_reconfigure(struct efx_nic *efx);
87 
88 /**
89  * efx_filter_insert_filter - add or replace a filter
90  * @efx: NIC in which to insert the filter
91  * @spec: Specification for the filter
92  * @replace_equal: Flag for whether the specified filter may replace an
93  *	existing filter with equal priority
94  *
95  * On success, return the filter ID.
96  * On failure, return a negative error code.
97  *
98  * If existing filters have equal match values to the new filter spec,
99  * then the new filter might replace them or the function might fail,
100  * as follows.
101  *
102  * 1. If the existing filters have lower priority, or @replace_equal
103  *    is set and they have equal priority, replace them.
104  *
105  * 2. If the existing filters have higher priority, return -%EPERM.
106  *
107  * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
108  *    support delivery to multiple recipients, return -%EEXIST.
109  *
110  * This implies that filters for multiple multicast recipients must
111  * all be inserted with the same priority and @replace_equal = %false.
112  */
113 static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
114 					   struct efx_filter_spec *spec,
115 					   bool replace_equal)
116 {
117 	return efx->type->filter_insert(efx, spec, replace_equal);
118 }
119 
120 /**
121  * efx_filter_remove_id_safe - remove a filter by ID, carefully
122  * @efx: NIC from which to remove the filter
123  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
124  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
125  *
126  * This function will range-check @filter_id, so it is safe to call
127  * with a value passed from userland.
128  */
129 static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
130 					    enum efx_filter_priority priority,
131 					    u32 filter_id)
132 {
133 	return efx->type->filter_remove_safe(efx, priority, filter_id);
134 }
135 
136 /**
137  * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
138  * @efx: NIC from which to remove the filter
139  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
140  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
141  * @spec: Buffer in which to store filter specification
142  *
143  * This function will range-check @filter_id, so it is safe to call
144  * with a value passed from userland.
145  */
146 static inline int
147 efx_filter_get_filter_safe(struct efx_nic *efx,
148 			   enum efx_filter_priority priority,
149 			   u32 filter_id, struct efx_filter_spec *spec)
150 {
151 	return efx->type->filter_get_safe(efx, priority, filter_id, spec);
152 }
153 
154 static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
155 					   enum efx_filter_priority priority)
156 {
157 	return efx->type->filter_count_rx_used(efx, priority);
158 }
159 static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
160 {
161 	return efx->type->filter_get_rx_id_limit(efx);
162 }
163 static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
164 					enum efx_filter_priority priority,
165 					u32 *buf, u32 size)
166 {
167 	return efx->type->filter_get_rx_ids(efx, priority, buf, size);
168 }
169 #ifdef CONFIG_RFS_ACCEL
170 int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
171 		   u16 rxq_index, u32 flow_id);
172 bool __efx_filter_rfs_expire(struct efx_nic *efx, unsigned quota);
173 static inline void efx_filter_rfs_expire(struct efx_channel *channel)
174 {
175 	if (channel->rfs_filters_added >= 60 &&
176 	    __efx_filter_rfs_expire(channel->efx, 100))
177 		channel->rfs_filters_added -= 60;
178 }
179 #define efx_filter_rfs_enabled() 1
180 #else
181 static inline void efx_filter_rfs_expire(struct efx_channel *channel) {}
182 #define efx_filter_rfs_enabled() 0
183 #endif
184 bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);
185 
186 /* Channels */
187 int efx_channel_dummy_op_int(struct efx_channel *channel);
188 void efx_channel_dummy_op_void(struct efx_channel *channel);
189 int efx_realloc_channels(struct efx_nic *efx, u32 rxq_entries, u32 txq_entries);
190 
191 /* Ports */
192 int efx_reconfigure_port(struct efx_nic *efx);
193 int __efx_reconfigure_port(struct efx_nic *efx);
194 
195 /* Ethtool support */
196 extern const struct ethtool_ops efx_ethtool_ops;
197 
198 /* Reset handling */
199 int efx_reset(struct efx_nic *efx, enum reset_type method);
200 void efx_reset_down(struct efx_nic *efx, enum reset_type method);
201 int efx_reset_up(struct efx_nic *efx, enum reset_type method, bool ok);
202 int efx_try_recovery(struct efx_nic *efx);
203 
204 /* Global */
205 void efx_schedule_reset(struct efx_nic *efx, enum reset_type type);
206 int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
207 			    unsigned int rx_usecs, bool rx_adaptive,
208 			    bool rx_may_override_tx);
209 void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
210 			    unsigned int *rx_usecs, bool *rx_adaptive);
211 void efx_stop_eventq(struct efx_channel *channel);
212 void efx_start_eventq(struct efx_channel *channel);
213 
214 /* Dummy PHY ops for PHY drivers */
215 int efx_port_dummy_op_int(struct efx_nic *efx);
216 void efx_port_dummy_op_void(struct efx_nic *efx);
217 
218 /* Update the generic software stats in the passed stats array */
219 void efx_update_sw_stats(struct efx_nic *efx, u64 *stats);
220 
221 /* MTD */
222 #ifdef CONFIG_SFC_MTD
223 int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
224 		size_t n_parts, size_t sizeof_part);
225 static inline int efx_mtd_probe(struct efx_nic *efx)
226 {
227 	return efx->type->mtd_probe(efx);
228 }
229 void efx_mtd_rename(struct efx_nic *efx);
230 void efx_mtd_remove(struct efx_nic *efx);
231 #else
232 static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
233 static inline void efx_mtd_rename(struct efx_nic *efx) {}
234 static inline void efx_mtd_remove(struct efx_nic *efx) {}
235 #endif
236 
237 #ifdef CONFIG_SFC_SRIOV
238 static inline unsigned int efx_vf_size(struct efx_nic *efx)
239 {
240 	return 1 << efx->vi_scale;
241 }
242 #endif
243 
244 static inline void efx_schedule_channel(struct efx_channel *channel)
245 {
246 	netif_vdbg(channel->efx, intr, channel->efx->net_dev,
247 		   "channel %d scheduling NAPI poll on CPU%d\n",
248 		   channel->channel, raw_smp_processor_id());
249 
250 	napi_schedule(&channel->napi_str);
251 }
252 
253 static inline void efx_schedule_channel_irq(struct efx_channel *channel)
254 {
255 	channel->event_test_cpu = raw_smp_processor_id();
256 	efx_schedule_channel(channel);
257 }
258 
259 void efx_link_status_changed(struct efx_nic *efx);
260 void efx_link_set_advertising(struct efx_nic *efx, u32);
261 void efx_link_set_wanted_fc(struct efx_nic *efx, u8);
262 
263 static inline void efx_device_detach_sync(struct efx_nic *efx)
264 {
265 	struct net_device *dev = efx->net_dev;
266 
267 	/* Lock/freeze all TX queues so that we can be sure the
268 	 * TX scheduler is stopped when we're done and before
269 	 * netif_device_present() becomes false.
270 	 */
271 	netif_tx_lock_bh(dev);
272 	netif_device_detach(dev);
273 	netif_tx_unlock_bh(dev);
274 }
275 
276 #endif /* EFX_EFX_H */
277