xref: /openbmc/linux/drivers/net/ethernet/sfc/efx.h (revision d7a3d85e)
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 #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, bool atomic);
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 #define EFX_TXQ_MAX_ENT(efx)	(EFX_WORKAROUND_35388(efx) ? \
70 				 EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)
71 
72 /* Filters */
73 
74 /**
75  * efx_filter_insert_filter - add or replace a filter
76  * @efx: NIC in which to insert the filter
77  * @spec: Specification for the filter
78  * @replace_equal: Flag for whether the specified filter may replace an
79  *	existing filter with equal priority
80  *
81  * On success, return the filter ID.
82  * On failure, return a negative error code.
83  *
84  * If existing filters have equal match values to the new filter spec,
85  * then the new filter might replace them or the function might fail,
86  * as follows.
87  *
88  * 1. If the existing filters have lower priority, or @replace_equal
89  *    is set and they have equal priority, replace them.
90  *
91  * 2. If the existing filters have higher priority, return -%EPERM.
92  *
93  * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
94  *    support delivery to multiple recipients, return -%EEXIST.
95  *
96  * This implies that filters for multiple multicast recipients must
97  * all be inserted with the same priority and @replace_equal = %false.
98  */
99 static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
100 					   struct efx_filter_spec *spec,
101 					   bool replace_equal)
102 {
103 	return efx->type->filter_insert(efx, spec, replace_equal);
104 }
105 
106 /**
107  * efx_filter_remove_id_safe - remove a filter by ID, carefully
108  * @efx: NIC from which to remove the filter
109  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
110  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
111  *
112  * This function will range-check @filter_id, so it is safe to call
113  * with a value passed from userland.
114  */
115 static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
116 					    enum efx_filter_priority priority,
117 					    u32 filter_id)
118 {
119 	return efx->type->filter_remove_safe(efx, priority, filter_id);
120 }
121 
122 /**
123  * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
124  * @efx: NIC from which to remove the filter
125  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
126  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
127  * @spec: Buffer in which to store filter specification
128  *
129  * This function will range-check @filter_id, so it is safe to call
130  * with a value passed from userland.
131  */
132 static inline int
133 efx_filter_get_filter_safe(struct efx_nic *efx,
134 			   enum efx_filter_priority priority,
135 			   u32 filter_id, struct efx_filter_spec *spec)
136 {
137 	return efx->type->filter_get_safe(efx, priority, filter_id, spec);
138 }
139 
140 static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
141 					   enum efx_filter_priority priority)
142 {
143 	return efx->type->filter_count_rx_used(efx, priority);
144 }
145 static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
146 {
147 	return efx->type->filter_get_rx_id_limit(efx);
148 }
149 static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
150 					enum efx_filter_priority priority,
151 					u32 *buf, u32 size)
152 {
153 	return efx->type->filter_get_rx_ids(efx, priority, buf, size);
154 }
155 #ifdef CONFIG_RFS_ACCEL
156 int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
157 		   u16 rxq_index, u32 flow_id);
158 bool __efx_filter_rfs_expire(struct efx_nic *efx, unsigned quota);
159 static inline void efx_filter_rfs_expire(struct efx_channel *channel)
160 {
161 	if (channel->rfs_filters_added >= 60 &&
162 	    __efx_filter_rfs_expire(channel->efx, 100))
163 		channel->rfs_filters_added -= 60;
164 }
165 #define efx_filter_rfs_enabled() 1
166 #else
167 static inline void efx_filter_rfs_expire(struct efx_channel *channel) {}
168 #define efx_filter_rfs_enabled() 0
169 #endif
170 bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);
171 
172 /* Channels */
173 int efx_channel_dummy_op_int(struct efx_channel *channel);
174 void efx_channel_dummy_op_void(struct efx_channel *channel);
175 int efx_realloc_channels(struct efx_nic *efx, u32 rxq_entries, u32 txq_entries);
176 
177 /* Ports */
178 int efx_reconfigure_port(struct efx_nic *efx);
179 int __efx_reconfigure_port(struct efx_nic *efx);
180 
181 /* Ethtool support */
182 extern const struct ethtool_ops efx_ethtool_ops;
183 
184 /* Reset handling */
185 int efx_reset(struct efx_nic *efx, enum reset_type method);
186 void efx_reset_down(struct efx_nic *efx, enum reset_type method);
187 int efx_reset_up(struct efx_nic *efx, enum reset_type method, bool ok);
188 int efx_try_recovery(struct efx_nic *efx);
189 
190 /* Global */
191 void efx_schedule_reset(struct efx_nic *efx, enum reset_type type);
192 int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
193 			    unsigned int rx_usecs, bool rx_adaptive,
194 			    bool rx_may_override_tx);
195 void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
196 			    unsigned int *rx_usecs, bool *rx_adaptive);
197 void efx_stop_eventq(struct efx_channel *channel);
198 void efx_start_eventq(struct efx_channel *channel);
199 
200 /* Dummy PHY ops for PHY drivers */
201 int efx_port_dummy_op_int(struct efx_nic *efx);
202 void efx_port_dummy_op_void(struct efx_nic *efx);
203 
204 /* Update the generic software stats in the passed stats array */
205 void efx_update_sw_stats(struct efx_nic *efx, u64 *stats);
206 
207 /* MTD */
208 #ifdef CONFIG_SFC_MTD
209 int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
210 		size_t n_parts, size_t sizeof_part);
211 static inline int efx_mtd_probe(struct efx_nic *efx)
212 {
213 	return efx->type->mtd_probe(efx);
214 }
215 void efx_mtd_rename(struct efx_nic *efx);
216 void efx_mtd_remove(struct efx_nic *efx);
217 #else
218 static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
219 static inline void efx_mtd_rename(struct efx_nic *efx) {}
220 static inline void efx_mtd_remove(struct efx_nic *efx) {}
221 #endif
222 
223 static inline void efx_schedule_channel(struct efx_channel *channel)
224 {
225 	netif_vdbg(channel->efx, intr, channel->efx->net_dev,
226 		   "channel %d scheduling NAPI poll on CPU%d\n",
227 		   channel->channel, raw_smp_processor_id());
228 
229 	napi_schedule(&channel->napi_str);
230 }
231 
232 static inline void efx_schedule_channel_irq(struct efx_channel *channel)
233 {
234 	channel->event_test_cpu = raw_smp_processor_id();
235 	efx_schedule_channel(channel);
236 }
237 
238 void efx_link_status_changed(struct efx_nic *efx);
239 void efx_link_set_advertising(struct efx_nic *efx, u32);
240 void efx_link_set_wanted_fc(struct efx_nic *efx, u8);
241 
242 static inline void efx_device_detach_sync(struct efx_nic *efx)
243 {
244 	struct net_device *dev = efx->net_dev;
245 
246 	/* Lock/freeze all TX queues so that we can be sure the
247 	 * TX scheduler is stopped when we're done and before
248 	 * netif_device_present() becomes false.
249 	 */
250 	netif_tx_lock_bh(dev);
251 	netif_device_detach(dev);
252 	netif_tx_unlock_bh(dev);
253 }
254 
255 #endif /* EFX_EFX_H */
256