[deliverable/linux.git] / drivers / net / ethernet / sfc / efx.h

/****************************************************************************
 * Driver for Solarflare network controllers and boards
 * Copyright 2005-2006 Fen Systems Ltd.
 * Copyright 2006-2013 Solarflare Communications Inc.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation, incorporated herein by reference.
 */

#ifndef EFX_EFX_H
#define EFX_EFX_H

#include "net_driver.h"
#include "filter.h"

/* All controllers use BAR 0 for I/O space and BAR 2(&3) for memory */
#define EFX_MEM_BAR 2

/* TX */
int efx_probe_tx_queue(struct efx_tx_queue *tx_queue);
void efx_remove_tx_queue(struct efx_tx_queue *tx_queue);
void efx_init_tx_queue(struct efx_tx_queue *tx_queue);
void efx_init_tx_queue_core_txq(struct efx_tx_queue *tx_queue);
void efx_fini_tx_queue(struct efx_tx_queue *tx_queue);
netdev_tx_t efx_hard_start_xmit(struct sk_buff *skb,
				struct net_device *net_dev);
netdev_tx_t efx_enqueue_skb(struct efx_tx_queue *tx_queue, struct sk_buff *skb);
void efx_xmit_done(struct efx_tx_queue *tx_queue, unsigned int index);
int efx_setup_tc(struct net_device *net_dev, u8 num_tc);
unsigned int efx_tx_max_skb_descs(struct efx_nic *efx);
extern unsigned int efx_piobuf_size;

/* RX */
void efx_rx_config_page_split(struct efx_nic *efx);
int efx_probe_rx_queue(struct efx_rx_queue *rx_queue);
void efx_remove_rx_queue(struct efx_rx_queue *rx_queue);
void efx_init_rx_queue(struct efx_rx_queue *rx_queue);
void efx_fini_rx_queue(struct efx_rx_queue *rx_queue);
void efx_fast_push_rx_descriptors(struct efx_rx_queue *rx_queue, bool atomic);
void efx_rx_slow_fill(unsigned long context);
void __efx_rx_packet(struct efx_channel *channel);
void efx_rx_packet(struct efx_rx_queue *rx_queue, unsigned int index,
		   unsigned int n_frags, unsigned int len, u16 flags);
static inline void efx_rx_flush_packet(struct efx_channel *channel)
{
	if (channel->rx_pkt_n_frags)
		__efx_rx_packet(channel);
}
void efx_schedule_slow_fill(struct efx_rx_queue *rx_queue);

#define EFX_MAX_DMAQ_SIZE 4096UL
#define EFX_DEFAULT_DMAQ_SIZE 1024UL
#define EFX_MIN_DMAQ_SIZE 512UL

#define EFX_MAX_EVQ_SIZE 16384UL
#define EFX_MIN_EVQ_SIZE 512UL

/* Maximum number of TCP segments we support for soft-TSO */
#define EFX_TSO_MAX_SEGS	100

/* The smallest [rt]xq_entries that the driver supports.  RX minimum
 * is a bit arbitrary.  For TX, we must have space for at least 2
 * TSO skbs.
 */
#define EFX_RXQ_MIN_ENT		128U
#define EFX_TXQ_MIN_ENT(efx)	(2 * efx_tx_max_skb_descs(efx))

#define EFX_TXQ_MAX_ENT(efx)	(EFX_WORKAROUND_35388(efx) ? \
				 EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)

/* Filters */

/**
 * efx_filter_insert_filter - add or replace a filter
 * @efx: NIC in which to insert the filter
 * @spec: Specification for the filter
 * @replace_equal: Flag for whether the specified filter may replace an
 *	existing filter with equal priority
 *
 * On success, return the filter ID.
 * On failure, return a negative error code.
 *
 * If existing filters have equal match values to the new filter spec,
 * then the new filter might replace them or the function might fail,
 * as follows.
 *
 * 1. If the existing filters have lower priority, or @replace_equal
 *    is set and they have equal priority, replace them.
 *
 * 2. If the existing filters have higher priority, return -%EPERM.
 *
 * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
 *    support delivery to multiple recipients, return -%EEXIST.
 *
 * This implies that filters for multiple multicast recipients must
 * all be inserted with the same priority and @replace_equal = %false.
 */
static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
					   struct efx_filter_spec *spec,
					   bool replace_equal)
{
	return efx->type->filter_insert(efx, spec, replace_equal);
}

/**
 * efx_filter_remove_id_safe - remove a filter by ID, carefully
 * @efx: NIC from which to remove the filter
 * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 *
 * This function will range-check @filter_id, so it is safe to call
 * with a value passed from userland.
 */
static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
					    enum efx_filter_priority priority,
					    u32 filter_id)
{
	return efx->type->filter_remove_safe(efx, priority, filter_id);
}

/**
 * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
 * @efx: NIC from which to remove the filter
 * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 * @spec: Buffer in which to store filter specification
 *
 * This function will range-check @filter_id, so it is safe to call
 * with a value passed from userland.
 */
static inline int
efx_filter_get_filter_safe(struct efx_nic *efx,
			   enum efx_filter_priority priority,
			   u32 filter_id, struct efx_filter_spec *spec)
{
	return efx->type->filter_get_safe(efx, priority, filter_id, spec);
}

static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
					   enum efx_filter_priority priority)
{
	return efx->type->filter_count_rx_used(efx, priority);
}
static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
{
	return efx->type->filter_get_rx_id_limit(efx);
}
static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
					enum efx_filter_priority priority,
					u32 *buf, u32 size)
{
	return efx->type->filter_get_rx_ids(efx, priority, buf, size);
}
#ifdef CONFIG_RFS_ACCEL
int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
		   u16 rxq_index, u32 flow_id);
bool __efx_filter_rfs_expire(struct efx_nic *efx, unsigned quota);
static inline void efx_filter_rfs_expire(struct efx_channel *channel)
{
	if (channel->rfs_filters_added >= 60 &&
	    __efx_filter_rfs_expire(channel->efx, 100))
		channel->rfs_filters_added -= 60;
}
#define efx_filter_rfs_enabled() 1
#else
static inline void efx_filter_rfs_expire(struct efx_channel *channel) {}
#define efx_filter_rfs_enabled() 0
#endif
bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);

/* Channels */
int efx_channel_dummy_op_int(struct efx_channel *channel);
void efx_channel_dummy_op_void(struct efx_channel *channel);
int efx_realloc_channels(struct efx_nic *efx, u32 rxq_entries, u32 txq_entries);

/* Ports */
int efx_reconfigure_port(struct efx_nic *efx);
int __efx_reconfigure_port(struct efx_nic *efx);

/* Ethtool support */
extern const struct ethtool_ops efx_ethtool_ops;

/* Reset handling */
int efx_reset(struct efx_nic *efx, enum reset_type method);
void efx_reset_down(struct efx_nic *efx, enum reset_type method);
int efx_reset_up(struct efx_nic *efx, enum reset_type method, bool ok);
int efx_try_recovery(struct efx_nic *efx);

/* Global */
void efx_schedule_reset(struct efx_nic *efx, enum reset_type type);
int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
			    unsigned int rx_usecs, bool rx_adaptive,
			    bool rx_may_override_tx);
void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
			    unsigned int *rx_usecs, bool *rx_adaptive);
void efx_stop_eventq(struct efx_channel *channel);
void efx_start_eventq(struct efx_channel *channel);

/* Dummy PHY ops for PHY drivers */
int efx_port_dummy_op_int(struct efx_nic *efx);
void efx_port_dummy_op_void(struct efx_nic *efx);

/* Update the generic software stats in the passed stats array */
void efx_update_sw_stats(struct efx_nic *efx, u64 *stats);

/* MTD */
#ifdef CONFIG_SFC_MTD
int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
		size_t n_parts, size_t sizeof_part);
static inline int efx_mtd_probe(struct efx_nic *efx)
{
	return efx->type->mtd_probe(efx);
}
void efx_mtd_rename(struct efx_nic *efx);
void efx_mtd_remove(struct efx_nic *efx);
#else
static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
static inline void efx_mtd_rename(struct efx_nic *efx) {}
static inline void efx_mtd_remove(struct efx_nic *efx) {}
#endif

static inline void efx_schedule_channel(struct efx_channel *channel)
{
	netif_vdbg(channel->efx, intr, channel->efx->net_dev,
		   "channel %d scheduling NAPI poll on CPU%d\n",
		   channel->channel, raw_smp_processor_id());

	napi_schedule(&channel->napi_str);
}

static inline void efx_schedule_channel_irq(struct efx_channel *channel)
{
	channel->event_test_cpu = raw_smp_processor_id();
	efx_schedule_channel(channel);
}

void efx_link_status_changed(struct efx_nic *efx);
void efx_link_set_advertising(struct efx_nic *efx, u32);
void efx_link_set_wanted_fc(struct efx_nic *efx, u8);

static inline void efx_device_detach_sync(struct efx_nic *efx)
{
	struct net_device *dev = efx->net_dev;

	/* Lock/freeze all TX queues so that we can be sure the
	 * TX scheduler is stopped when we're done and before
	 * netif_device_present() becomes false.
	 */
	netif_tx_lock_bh(dev);
	netif_device_detach(dev);
	netif_tx_unlock_bh(dev);
}

#endif /* EFX_EFX_H */
Commit	Line	Data
8ceee660	1	/****************************************************************************
f7a6d2c4	2	* Driver for Solarflare network controllers and boards
8ceee660	3	* Copyright 2005-2006 Fen Systems Ltd.
f7a6d2c4	4	* Copyright 2006-2013 Solarflare Communications Inc.
8ceee660 BH	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"
64eebcfd	15	#include "filter.h"
8ceee660	16
6a350fdb	17	/* All controllers use BAR 0 for I/O space and BAR 2(&3) for memory */
dc803df8 BH	18	#define EFX_MEM_BAR 2
dc803df8 BH	19
8ceee660	20	/* TX */
00aef986 JP	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);
183233be	32	extern unsigned int efx_piobuf_size;
8ceee660 BH	33
8ceee660 BH	34	/* RX */
00aef986 JP	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);
cce28794	40	void efx_fast_push_rx_descriptors(struct efx_rx_queue *rx_queue, bool atomic);
00aef986 JP	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);
ff734ef4 BH	45	static inline void efx_rx_flush_packet(struct efx_channel *channel)
ff734ef4 BH	46	{
85740cdf BH	47	if (channel->rx_pkt_n_frags)
85740cdf BH	48	__efx_rx_packet(channel);
ff734ef4	49	}
00aef986	50	void efx_schedule_slow_fill(struct efx_rx_queue *rx_queue);
ecc910f5 SH	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
8ceee660	58
7e6d06f0 BH	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))
4642610c	68
d9317aea BH	69	#define EFX_TXQ_MAX_ENT(efx) (EFX_WORKAROUND_35388(efx) ? \
	70	EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)
	71
64eebcfd	72	/* Filters */
add72477 BH	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	*
b883d0bd BH	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.
add72477 BH	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
add72477 BH	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	}
64d8ad6d	155	#ifdef CONFIG_RFS_ACCEL
00aef986 JP	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);
64d8ad6d BH	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
00aef986	170	bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);
64eebcfd	171
8ceee660	172	/* Channels */
00aef986 JP	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);
8ceee660 BH	176
8ceee660 BH	177	/* Ports */
00aef986 JP	178	int efx_reconfigure_port(struct efx_nic *efx);
00aef986 JP	179	int __efx_reconfigure_port(struct efx_nic *efx);
8c8661e4	180
f5e7adc3	181	/* Ethtool support */
f5e7adc3 BH	182	extern const struct ethtool_ops efx_ethtool_ops;
f5e7adc3 BH	183
8c8661e4	184	/* Reset handling */
00aef986 JP	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);
8ceee660 BH	189
8ceee660 BH	190	/* Global */
00aef986 JP	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);
36763266 AR	197	void efx_stop_eventq(struct efx_channel *channel);
36763266 AR	198	void efx_start_eventq(struct efx_channel *channel);
8ceee660 BH	199
8ceee660 BH	200	/* Dummy PHY ops for PHY drivers */
00aef986 JP	201	int efx_port_dummy_op_int(struct efx_nic *efx);
00aef986 JP	202	void efx_port_dummy_op_void(struct efx_nic *efx);
8ceee660	203
e4d112e4 EC	204	/* Update the generic software stats in the passed stats array */
	205	void efx_update_sw_stats(struct efx_nic efx, u64 stats);
	206
f4150724 BH	207	/* MTD */
f4150724 BH	208	#ifdef CONFIG_SFC_MTD
00aef986 JP	209	int efx_mtd_add(struct efx_nic efx, struct efx_mtd_partition parts,
00aef986 JP	210	size_t n_parts, size_t sizeof_part);
45a3fd55 BH	211	static inline int efx_mtd_probe(struct efx_nic *efx)
	212	{
	213	return efx->type->mtd_probe(efx);
	214	}
00aef986 JP	215	void efx_mtd_rename(struct efx_nic *efx);
00aef986 JP	216	void efx_mtd_remove(struct efx_nic *efx);
f4150724 BH	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
8ceee660	222
8ceee660 BH	223	static inline void efx_schedule_channel(struct efx_channel *channel)
8ceee660 BH	224	{
62776d03 BH	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());
8ceee660	228
288379f0	229	napi_schedule(&channel->napi_str);
8ceee660 BH	230	}
8ceee660 BH	231
1646a6f3 BH	232	static inline void efx_schedule_channel_irq(struct efx_channel *channel)
1646a6f3 BH	233	{
dd40781e	234	channel->event_test_cpu = raw_smp_processor_id();
1646a6f3 BH	235	efx_schedule_channel(channel);
	236	}
	237
00aef986 JP	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);
fdaa9aed	241
c2f3b8e3 DP	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	*/
35205b21	250	netif_tx_lock_bh(dev);
c2f3b8e3	251	netif_device_detach(dev);
35205b21	252	netif_tx_unlock_bh(dev);
c2f3b8e3 DP	253	}
c2f3b8e3 DP	254
8ceee660	255	#endif /* EFX_EFX_H */