xref: /openbmc/linux/drivers/net/ethernet/sfc/falcon/efx.h (revision 82e6fdd6)
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 EF4_EFX_H
12 #define EF4_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 EF4_MEM_BAR 2
20 #define EF4_MEM_VF_BAR 0
21 
22 int ef4_net_open(struct net_device *net_dev);
23 int ef4_net_stop(struct net_device *net_dev);
24 
25 /* TX */
26 int ef4_probe_tx_queue(struct ef4_tx_queue *tx_queue);
27 void ef4_remove_tx_queue(struct ef4_tx_queue *tx_queue);
28 void ef4_init_tx_queue(struct ef4_tx_queue *tx_queue);
29 void ef4_init_tx_queue_core_txq(struct ef4_tx_queue *tx_queue);
30 void ef4_fini_tx_queue(struct ef4_tx_queue *tx_queue);
31 netdev_tx_t ef4_hard_start_xmit(struct sk_buff *skb,
32 				struct net_device *net_dev);
33 netdev_tx_t ef4_enqueue_skb(struct ef4_tx_queue *tx_queue, struct sk_buff *skb);
34 void ef4_xmit_done(struct ef4_tx_queue *tx_queue, unsigned int index);
35 int ef4_setup_tc(struct net_device *net_dev, enum tc_setup_type type,
36 		 void *type_data);
37 unsigned int ef4_tx_max_skb_descs(struct ef4_nic *efx);
38 extern bool ef4_separate_tx_channels;
39 
40 /* RX */
41 void ef4_set_default_rx_indir_table(struct ef4_nic *efx);
42 void ef4_rx_config_page_split(struct ef4_nic *efx);
43 int ef4_probe_rx_queue(struct ef4_rx_queue *rx_queue);
44 void ef4_remove_rx_queue(struct ef4_rx_queue *rx_queue);
45 void ef4_init_rx_queue(struct ef4_rx_queue *rx_queue);
46 void ef4_fini_rx_queue(struct ef4_rx_queue *rx_queue);
47 void ef4_fast_push_rx_descriptors(struct ef4_rx_queue *rx_queue, bool atomic);
48 void ef4_rx_slow_fill(struct timer_list *t);
49 void __ef4_rx_packet(struct ef4_channel *channel);
50 void ef4_rx_packet(struct ef4_rx_queue *rx_queue, unsigned int index,
51 		   unsigned int n_frags, unsigned int len, u16 flags);
52 static inline void ef4_rx_flush_packet(struct ef4_channel *channel)
53 {
54 	if (channel->rx_pkt_n_frags)
55 		__ef4_rx_packet(channel);
56 }
57 void ef4_schedule_slow_fill(struct ef4_rx_queue *rx_queue);
58 
59 #define EF4_MAX_DMAQ_SIZE 4096UL
60 #define EF4_DEFAULT_DMAQ_SIZE 1024UL
61 #define EF4_MIN_DMAQ_SIZE 512UL
62 
63 #define EF4_MAX_EVQ_SIZE 16384UL
64 #define EF4_MIN_EVQ_SIZE 512UL
65 
66 /* Maximum number of TCP segments we support for soft-TSO */
67 #define EF4_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 EF4_RXQ_MIN_ENT		128U
74 #define EF4_TXQ_MIN_ENT(efx)	(2 * ef4_tx_max_skb_descs(efx))
75 
76 static inline bool ef4_rss_enabled(struct ef4_nic *efx)
77 {
78 	return efx->rss_spread > 1;
79 }
80 
81 /* Filters */
82 
83 void ef4_mac_reconfigure(struct ef4_nic *efx);
84 
85 /**
86  * ef4_filter_insert_filter - add or replace a filter
87  * @efx: NIC in which to insert the filter
88  * @spec: Specification for the filter
89  * @replace_equal: Flag for whether the specified filter may replace an
90  *	existing filter with equal priority
91  *
92  * On success, return the filter ID.
93  * On failure, return a negative error code.
94  *
95  * If existing filters have equal match values to the new filter spec,
96  * then the new filter might replace them or the function might fail,
97  * as follows.
98  *
99  * 1. If the existing filters have lower priority, or @replace_equal
100  *    is set and they have equal priority, replace them.
101  *
102  * 2. If the existing filters have higher priority, return -%EPERM.
103  *
104  * 3. If !ef4_filter_is_mc_recipient(@spec), or the NIC does not
105  *    support delivery to multiple recipients, return -%EEXIST.
106  *
107  * This implies that filters for multiple multicast recipients must
108  * all be inserted with the same priority and @replace_equal = %false.
109  */
110 static inline s32 ef4_filter_insert_filter(struct ef4_nic *efx,
111 					   struct ef4_filter_spec *spec,
112 					   bool replace_equal)
113 {
114 	return efx->type->filter_insert(efx, spec, replace_equal);
115 }
116 
117 /**
118  * ef4_filter_remove_id_safe - remove a filter by ID, carefully
119  * @efx: NIC from which to remove the filter
120  * @priority: Priority of filter, as passed to @ef4_filter_insert_filter
121  * @filter_id: ID of filter, as returned by @ef4_filter_insert_filter
122  *
123  * This function will range-check @filter_id, so it is safe to call
124  * with a value passed from userland.
125  */
126 static inline int ef4_filter_remove_id_safe(struct ef4_nic *efx,
127 					    enum ef4_filter_priority priority,
128 					    u32 filter_id)
129 {
130 	return efx->type->filter_remove_safe(efx, priority, filter_id);
131 }
132 
133 /**
134  * ef4_filter_get_filter_safe - retrieve a filter by ID, carefully
135  * @efx: NIC from which to remove the filter
136  * @priority: Priority of filter, as passed to @ef4_filter_insert_filter
137  * @filter_id: ID of filter, as returned by @ef4_filter_insert_filter
138  * @spec: Buffer in which to store filter specification
139  *
140  * This function will range-check @filter_id, so it is safe to call
141  * with a value passed from userland.
142  */
143 static inline int
144 ef4_filter_get_filter_safe(struct ef4_nic *efx,
145 			   enum ef4_filter_priority priority,
146 			   u32 filter_id, struct ef4_filter_spec *spec)
147 {
148 	return efx->type->filter_get_safe(efx, priority, filter_id, spec);
149 }
150 
151 static inline u32 ef4_filter_count_rx_used(struct ef4_nic *efx,
152 					   enum ef4_filter_priority priority)
153 {
154 	return efx->type->filter_count_rx_used(efx, priority);
155 }
156 static inline u32 ef4_filter_get_rx_id_limit(struct ef4_nic *efx)
157 {
158 	return efx->type->filter_get_rx_id_limit(efx);
159 }
160 static inline s32 ef4_filter_get_rx_ids(struct ef4_nic *efx,
161 					enum ef4_filter_priority priority,
162 					u32 *buf, u32 size)
163 {
164 	return efx->type->filter_get_rx_ids(efx, priority, buf, size);
165 }
166 #ifdef CONFIG_RFS_ACCEL
167 int ef4_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
168 		   u16 rxq_index, u32 flow_id);
169 bool __ef4_filter_rfs_expire(struct ef4_nic *efx, unsigned quota);
170 static inline void ef4_filter_rfs_expire(struct ef4_channel *channel)
171 {
172 	if (channel->rfs_filters_added >= 60 &&
173 	    __ef4_filter_rfs_expire(channel->efx, 100))
174 		channel->rfs_filters_added -= 60;
175 }
176 #define ef4_filter_rfs_enabled() 1
177 #else
178 static inline void ef4_filter_rfs_expire(struct ef4_channel *channel) {}
179 #define ef4_filter_rfs_enabled() 0
180 #endif
181 bool ef4_filter_is_mc_recipient(const struct ef4_filter_spec *spec);
182 
183 /* Channels */
184 int ef4_channel_dummy_op_int(struct ef4_channel *channel);
185 void ef4_channel_dummy_op_void(struct ef4_channel *channel);
186 int ef4_realloc_channels(struct ef4_nic *efx, u32 rxq_entries, u32 txq_entries);
187 
188 /* Ports */
189 int ef4_reconfigure_port(struct ef4_nic *efx);
190 int __ef4_reconfigure_port(struct ef4_nic *efx);
191 
192 /* Ethtool support */
193 extern const struct ethtool_ops ef4_ethtool_ops;
194 
195 /* Reset handling */
196 int ef4_reset(struct ef4_nic *efx, enum reset_type method);
197 void ef4_reset_down(struct ef4_nic *efx, enum reset_type method);
198 int ef4_reset_up(struct ef4_nic *efx, enum reset_type method, bool ok);
199 int ef4_try_recovery(struct ef4_nic *efx);
200 
201 /* Global */
202 void ef4_schedule_reset(struct ef4_nic *efx, enum reset_type type);
203 unsigned int ef4_usecs_to_ticks(struct ef4_nic *efx, unsigned int usecs);
204 unsigned int ef4_ticks_to_usecs(struct ef4_nic *efx, unsigned int ticks);
205 int ef4_init_irq_moderation(struct ef4_nic *efx, unsigned int tx_usecs,
206 			    unsigned int rx_usecs, bool rx_adaptive,
207 			    bool rx_may_override_tx);
208 void ef4_get_irq_moderation(struct ef4_nic *efx, unsigned int *tx_usecs,
209 			    unsigned int *rx_usecs, bool *rx_adaptive);
210 void ef4_stop_eventq(struct ef4_channel *channel);
211 void ef4_start_eventq(struct ef4_channel *channel);
212 
213 /* Dummy PHY ops for PHY drivers */
214 int ef4_port_dummy_op_int(struct ef4_nic *efx);
215 void ef4_port_dummy_op_void(struct ef4_nic *efx);
216 
217 /* Update the generic software stats in the passed stats array */
218 void ef4_update_sw_stats(struct ef4_nic *efx, u64 *stats);
219 
220 /* MTD */
221 #ifdef CONFIG_SFC_FALCON_MTD
222 int ef4_mtd_add(struct ef4_nic *efx, struct ef4_mtd_partition *parts,
223 		size_t n_parts, size_t sizeof_part);
224 static inline int ef4_mtd_probe(struct ef4_nic *efx)
225 {
226 	return efx->type->mtd_probe(efx);
227 }
228 void ef4_mtd_rename(struct ef4_nic *efx);
229 void ef4_mtd_remove(struct ef4_nic *efx);
230 #else
231 static inline int ef4_mtd_probe(struct ef4_nic *efx) { return 0; }
232 static inline void ef4_mtd_rename(struct ef4_nic *efx) {}
233 static inline void ef4_mtd_remove(struct ef4_nic *efx) {}
234 #endif
235 
236 static inline void ef4_schedule_channel(struct ef4_channel *channel)
237 {
238 	netif_vdbg(channel->efx, intr, channel->efx->net_dev,
239 		   "channel %d scheduling NAPI poll on CPU%d\n",
240 		   channel->channel, raw_smp_processor_id());
241 
242 	napi_schedule(&channel->napi_str);
243 }
244 
245 static inline void ef4_schedule_channel_irq(struct ef4_channel *channel)
246 {
247 	channel->event_test_cpu = raw_smp_processor_id();
248 	ef4_schedule_channel(channel);
249 }
250 
251 void ef4_link_status_changed(struct ef4_nic *efx);
252 void ef4_link_set_advertising(struct ef4_nic *efx, u32);
253 void ef4_link_set_wanted_fc(struct ef4_nic *efx, u8);
254 
255 static inline void ef4_device_detach_sync(struct ef4_nic *efx)
256 {
257 	struct net_device *dev = efx->net_dev;
258 
259 	/* Lock/freeze all TX queues so that we can be sure the
260 	 * TX scheduler is stopped when we're done and before
261 	 * netif_device_present() becomes false.
262 	 */
263 	netif_tx_lock_bh(dev);
264 	netif_device_detach(dev);
265 	netif_tx_unlock_bh(dev);
266 }
267 
268 static inline bool ef4_rwsem_assert_write_locked(struct rw_semaphore *sem)
269 {
270 	if (WARN_ON(down_read_trylock(sem))) {
271 		up_read(sem);
272 		return false;
273 	}
274 	return true;
275 }
276 
277 #endif /* EF4_EFX_H */
278