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