[net-next-2.6.git] / drivers / net / sfc / nic.h

/****************************************************************************
 * Driver for Solarflare Solarstorm network controllers and boards
 * Copyright 2005-2006 Fen Systems Ltd.
 * Copyright 2006-2008 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_NIC_H
#define EFX_NIC_H

#include <linux/i2c-algo-bit.h>
#include "net_driver.h"
#include "efx.h"
#include "mcdi.h"

/*
 * Falcon hardware control
 */

enum {
	EFX_REV_FALCON_A0 = 0,
	EFX_REV_FALCON_A1 = 1,
	EFX_REV_FALCON_B0 = 2,
	EFX_REV_SIENA_A0 = 3,
};

static inline int efx_nic_rev(struct efx_nic *efx)
{
	return efx->type->revision;
}

extern u32 efx_nic_fpga_ver(struct efx_nic *efx);

static inline bool efx_nic_has_mc(struct efx_nic *efx)
{
	return efx_nic_rev(efx) >= EFX_REV_SIENA_A0;
}
/* NIC has two interlinked PCI functions for the same port. */
static inline bool efx_nic_is_dual_func(struct efx_nic *efx)
{
	return efx_nic_rev(efx) < EFX_REV_FALCON_B0;
}

enum {
	PHY_TYPE_NONE = 0,
	PHY_TYPE_TXC43128 = 1,
	PHY_TYPE_88E1111 = 2,
	PHY_TYPE_SFX7101 = 3,
	PHY_TYPE_QT2022C2 = 4,
	PHY_TYPE_PM8358 = 6,
	PHY_TYPE_SFT9001A = 8,
	PHY_TYPE_QT2025C = 9,
	PHY_TYPE_SFT9001B = 10,
};

#define FALCON_XMAC_LOOPBACKS			\
	((1 << LOOPBACK_XGMII) |		\
	 (1 << LOOPBACK_XGXS) |			\
	 (1 << LOOPBACK_XAUI))

#define FALCON_GMAC_LOOPBACKS			\
	(1 << LOOPBACK_GMAC)

/**
 * struct falcon_board_type - board operations and type information
 * @id: Board type id, as found in NVRAM
 * @ref_model: Model number of Solarflare reference design
 * @gen_type: Generic board type description
 * @init: Allocate resources and initialise peripheral hardware
 * @init_phy: Do board-specific PHY initialisation
 * @fini: Shut down hardware and free resources
 * @set_id_led: Set state of identifying LED or revert to automatic function
 * @monitor: Board-specific health check function
 */
struct falcon_board_type {
	u8 id;
	const char *ref_model;
	const char *gen_type;
	int (*init) (struct efx_nic *nic);
	void (*init_phy) (struct efx_nic *efx);
	void (*fini) (struct efx_nic *nic);
	void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
	int (*monitor) (struct efx_nic *nic);
};

/**
 * struct falcon_board - board information
 * @type: Type of board
 * @major: Major rev. ('A', 'B' ...)
 * @minor: Minor rev. (0, 1, ...)
 * @i2c_adap: I2C adapter for on-board peripherals
 * @i2c_data: Data for bit-banging algorithm
 * @hwmon_client: I2C client for hardware monitor
 * @ioexp_client: I2C client for power/port control
 */
struct falcon_board {
	const struct falcon_board_type *type;
	int major;
	int minor;
	struct i2c_adapter i2c_adap;
	struct i2c_algo_bit_data i2c_data;
	struct i2c_client *hwmon_client, *ioexp_client;
};

/**
 * struct falcon_nic_data - Falcon NIC state
 * @pci_dev2: Secondary function of Falcon A
 * @board: Board state and functions
 * @stats_disable_count: Nest count for disabling statistics fetches
 * @stats_pending: Is there a pending DMA of MAC statistics.
 * @stats_timer: A timer for regularly fetching MAC statistics.
 * @stats_dma_done: Pointer to the flag which indicates DMA completion.
 */
struct falcon_nic_data {
	struct pci_dev *pci_dev2;
	struct falcon_board board;
	unsigned int stats_disable_count;
	bool stats_pending;
	struct timer_list stats_timer;
	u32 *stats_dma_done;
};

static inline struct falcon_board *falcon_board(struct efx_nic *efx)
{
	struct falcon_nic_data *data = efx->nic_data;
	return &data->board;
}

/**
 * struct siena_nic_data - Siena NIC state
 * @fw_version: Management controller firmware version
 * @fw_build: Firmware build number
 * @mcdi: Management-Controller-to-Driver Interface
 * @wol_filter_id: Wake-on-LAN packet filter id
 */
struct siena_nic_data {
	u64 fw_version;
	u32 fw_build;
	struct efx_mcdi_iface mcdi;
	int wol_filter_id;
};

extern void siena_print_fwver(struct efx_nic *efx, char *buf, size_t len);

extern struct efx_nic_type falcon_a1_nic_type;
extern struct efx_nic_type falcon_b0_nic_type;
extern struct efx_nic_type siena_a0_nic_type;

/**************************************************************************
 *
 * Externs
 *
 **************************************************************************
 */

extern void falcon_probe_board(struct efx_nic *efx, u16 revision_info);

/* TX data path */
extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);

/* RX data path */
extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);

/* Event data path */
extern int efx_nic_probe_eventq(struct efx_channel *channel);
extern void efx_nic_init_eventq(struct efx_channel *channel);
extern void efx_nic_fini_eventq(struct efx_channel *channel);
extern void efx_nic_remove_eventq(struct efx_channel *channel);
extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
extern void efx_nic_eventq_read_ack(struct efx_channel *channel);

/* MAC/PHY */
extern void falcon_drain_tx_fifo(struct efx_nic *efx);
extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
extern int efx_nic_rx_xoff_thresh, efx_nic_rx_xon_thresh;

/* Interrupts and test events */
extern int efx_nic_init_interrupt(struct efx_nic *efx);
extern void efx_nic_enable_interrupts(struct efx_nic *efx);
extern void efx_nic_generate_test_event(struct efx_channel *channel,
					unsigned int magic);
extern void efx_nic_generate_interrupt(struct efx_nic *efx);
extern void efx_nic_disable_interrupts(struct efx_nic *efx);
extern void efx_nic_fini_interrupt(struct efx_nic *efx);
extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
extern void falcon_irq_ack_a1(struct efx_nic *efx);

#define EFX_IRQ_MOD_RESOLUTION 5

/* Global Resources */
extern int efx_nic_flush_queues(struct efx_nic *efx);
extern void falcon_start_nic_stats(struct efx_nic *efx);
extern void falcon_stop_nic_stats(struct efx_nic *efx);
extern int falcon_reset_xaui(struct efx_nic *efx);
extern void efx_nic_init_common(struct efx_nic *efx);

int efx_nic_alloc_buffer(struct efx_nic *efx, struct efx_buffer *buffer,
			 unsigned int len);
void efx_nic_free_buffer(struct efx_nic *efx, struct efx_buffer *buffer);

/* Tests */
struct efx_nic_register_test {
	unsigned address;
	efx_oword_t mask;
};
extern int efx_nic_test_registers(struct efx_nic *efx,
				  const struct efx_nic_register_test *regs,
				  size_t n_regs);

/**************************************************************************
 *
 * Falcon MAC stats
 *
 **************************************************************************
 */

#define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
#define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)

/* Retrieve statistic from statistics block */
#define FALCON_STAT(efx, falcon_stat, efx_stat) do {		\
	if (FALCON_STAT_WIDTH(falcon_stat) == 16)		\
		(efx)->mac_stats.efx_stat += le16_to_cpu(	\
			*((__force __le16 *)				\
			  (efx->stats_buffer.addr +		\
			   FALCON_STAT_OFFSET(falcon_stat))));	\
	else if (FALCON_STAT_WIDTH(falcon_stat) == 32)		\
		(efx)->mac_stats.efx_stat += le32_to_cpu(	\
			*((__force __le32 *)				\
			  (efx->stats_buffer.addr +		\
			   FALCON_STAT_OFFSET(falcon_stat))));	\
	else							\
		(efx)->mac_stats.efx_stat += le64_to_cpu(	\
			*((__force __le64 *)				\
			  (efx->stats_buffer.addr +		\
			   FALCON_STAT_OFFSET(falcon_stat))));	\
	} while (0)

#define FALCON_MAC_STATS_SIZE 0x100

#define MAC_DATA_LBN 0
#define MAC_DATA_WIDTH 32

extern void efx_nic_generate_event(struct efx_channel *channel,
				   efx_qword_t *event);

extern void falcon_poll_xmac(struct efx_nic *efx);

#endif /* EFX_NIC_H */
Commit	Line	Data
8ceee660 BH	1	/****************************************************************************
	2	* Driver for Solarflare Solarstorm network controllers and boards
	3	* Copyright 2005-2006 Fen Systems Ltd.
	4	* Copyright 2006-2008 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
744093c9 BH	11	#ifndef EFX_NIC_H
744093c9 BH	12	#define EFX_NIC_H
8ceee660	13
5c16a96c	14	#include <linux/i2c-algo-bit.h>
8ceee660	15	#include "net_driver.h"
177dfcd8	16	#include "efx.h"
8880f4ec	17	#include "mcdi.h"
8ceee660 BH	18
	19	/*
	20	* Falcon hardware control
	21	*/
	22
daeda630 BH	23	enum {
	24	EFX_REV_FALCON_A0 = 0,
	25	EFX_REV_FALCON_A1 = 1,
	26	EFX_REV_FALCON_B0 = 2,
8880f4ec	27	EFX_REV_SIENA_A0 = 3,
8ceee660 BH	28	};
8ceee660 BH	29
daeda630	30	static inline int efx_nic_rev(struct efx_nic *efx)
55668611	31	{
daeda630	32	return efx->type->revision;
55668611	33	}
8ceee660	34
152b6a62 BH	35	extern u32 efx_nic_fpga_ver(struct efx_nic *efx);
152b6a62 BH	36
8880f4ec BH	37	static inline bool efx_nic_has_mc(struct efx_nic *efx)
	38	{
	39	return efx_nic_rev(efx) >= EFX_REV_SIENA_A0;
	40	}
152b6a62 BH	41	/* NIC has two interlinked PCI functions for the same port. */
	42	static inline bool efx_nic_is_dual_func(struct efx_nic *efx)
	43	{
	44	return efx_nic_rev(efx) < EFX_REV_FALCON_B0;
	45	}
	46
c1c4f453 BH	47	enum {
	48	PHY_TYPE_NONE = 0,
	49	PHY_TYPE_TXC43128 = 1,
	50	PHY_TYPE_88E1111 = 2,
	51	PHY_TYPE_SFX7101 = 3,
	52	PHY_TYPE_QT2022C2 = 4,
	53	PHY_TYPE_PM8358 = 6,
	54	PHY_TYPE_SFT9001A = 8,
	55	PHY_TYPE_QT2025C = 9,
	56	PHY_TYPE_SFT9001B = 10,
	57	};
	58
	59	#define FALCON_XMAC_LOOPBACKS \
	60	((1 << LOOPBACK_XGMII) \| \
	61	(1 << LOOPBACK_XGXS) \| \
	62	(1 << LOOPBACK_XAUI))
	63
	64	#define FALCON_GMAC_LOOPBACKS \
	65	(1 << LOOPBACK_GMAC)
	66
3759433d	67	/**
44838a44 BH	68	* struct falcon_board_type - board operations and type information
	69	* @id: Board type id, as found in NVRAM
	70	* @ref_model: Model number of Solarflare reference design
	71	* @gen_type: Generic board type description
3759433d BH	72	* @init: Allocate resources and initialise peripheral hardware
3759433d BH	73	* @init_phy: Do board-specific PHY initialisation
44838a44	74	* @fini: Shut down hardware and free resources
3759433d BH	75	* @set_id_led: Set state of identifying LED or revert to automatic function
3759433d BH	76	* @monitor: Board-specific health check function
44838a44 BH	77	*/
	78	struct falcon_board_type {
	79	u8 id;
	80	const char *ref_model;
	81	const char *gen_type;
	82	int (init) (struct efx_nic nic);
	83	void (init_phy) (struct efx_nic efx);
	84	void (fini) (struct efx_nic nic);
	85	void (set_id_led) (struct efx_nic efx, enum efx_led_mode mode);
	86	int (monitor) (struct efx_nic nic);
	87	};
	88
	89	/**
	90	* struct falcon_board - board information
	91	* @type: Type of board
	92	* @major: Major rev. ('A', 'B' ...)
	93	* @minor: Minor rev. (0, 1, ...)
e775fb93 BH	94	* @i2c_adap: I2C adapter for on-board peripherals
e775fb93 BH	95	* @i2c_data: Data for bit-banging algorithm
3759433d BH	96	* @hwmon_client: I2C client for hardware monitor
	97	* @ioexp_client: I2C client for power/port control
	98	*/
	99	struct falcon_board {
44838a44	100	const struct falcon_board_type *type;
3759433d BH	101	int major;
3759433d BH	102	int minor;
e775fb93 BH	103	struct i2c_adapter i2c_adap;
e775fb93 BH	104	struct i2c_algo_bit_data i2c_data;
3759433d BH	105	struct i2c_client hwmon_client, ioexp_client;
	106	};
	107
5c16a96c BH	108	/**
5c16a96c BH	109	* struct falcon_nic_data - Falcon NIC state
8986352a	110	* @pci_dev2: Secondary function of Falcon A
3759433d	111	* @board: Board state and functions
55edc6e6 BH	112	* @stats_disable_count: Nest count for disabling statistics fetches
	113	* @stats_pending: Is there a pending DMA of MAC statistics.
	114	* @stats_timer: A timer for regularly fetching MAC statistics.
	115	* @stats_dma_done: Pointer to the flag which indicates DMA completion.
5c16a96c BH	116	*/
	117	struct falcon_nic_data {
	118	struct pci_dev *pci_dev2;
3759433d	119	struct falcon_board board;
55edc6e6 BH	120	unsigned int stats_disable_count;
	121	bool stats_pending;
	122	struct timer_list stats_timer;
	123	u32 *stats_dma_done;
5c16a96c BH	124	};
5c16a96c BH	125
278c0621 BH	126	static inline struct falcon_board falcon_board(struct efx_nic efx)
278c0621 BH	127	{
3759433d BH	128	struct falcon_nic_data *data = efx->nic_data;
3759433d BH	129	return &data->board;
278c0621 BH	130	}
278c0621 BH	131
8880f4ec BH	132	/**
	133	* struct siena_nic_data - Siena NIC state
	134	* @fw_version: Management controller firmware version
	135	* @fw_build: Firmware build number
	136	* @mcdi: Management-Controller-to-Driver Interface
	137	* @wol_filter_id: Wake-on-LAN packet filter id
	138	*/
	139	struct siena_nic_data {
	140	u64 fw_version;
	141	u32 fw_build;
	142	struct efx_mcdi_iface mcdi;
	143	int wol_filter_id;
	144	};
	145
	146	extern void siena_print_fwver(struct efx_nic efx, char buf, size_t len);
	147
daeda630 BH	148	extern struct efx_nic_type falcon_a1_nic_type;
daeda630 BH	149	extern struct efx_nic_type falcon_b0_nic_type;
8880f4ec	150	extern struct efx_nic_type siena_a0_nic_type;
8ceee660 BH	151
	152	/**************************************************************************
	153	*
	154	* Externs
	155	*
	156	**************************************************************************
	157	*/
	158
5087b54d BH	159	extern void falcon_probe_board(struct efx_nic *efx, u16 revision_info);
5087b54d BH	160
8ceee660	161	/* TX data path */
152b6a62 BH	162	extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
	163	extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
	164	extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
	165	extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
	166	extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);
8ceee660 BH	167
8ceee660 BH	168	/* RX data path */
152b6a62 BH	169	extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
	170	extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
	171	extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
	172	extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
	173	extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);
8ceee660 BH	174
8ceee660 BH	175	/* Event data path */
152b6a62 BH	176	extern int efx_nic_probe_eventq(struct efx_channel *channel);
	177	extern void efx_nic_init_eventq(struct efx_channel *channel);
	178	extern void efx_nic_fini_eventq(struct efx_channel *channel);
	179	extern void efx_nic_remove_eventq(struct efx_channel *channel);
	180	extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
	181	extern void efx_nic_eventq_read_ack(struct efx_channel *channel);
8ceee660	182
8ceee660	183	/* MAC/PHY */
8ceee660	184	extern void falcon_drain_tx_fifo(struct efx_nic *efx);
8ceee660	185	extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
152b6a62	186	extern int efx_nic_rx_xoff_thresh, efx_nic_rx_xon_thresh;
8ceee660 BH	187
8ceee660 BH	188	/* Interrupts and test events */
152b6a62 BH	189	extern int efx_nic_init_interrupt(struct efx_nic *efx);
	190	extern void efx_nic_enable_interrupts(struct efx_nic *efx);
	191	extern void efx_nic_generate_test_event(struct efx_channel *channel,
	192	unsigned int magic);
	193	extern void efx_nic_generate_interrupt(struct efx_nic *efx);
	194	extern void efx_nic_disable_interrupts(struct efx_nic *efx);
	195	extern void efx_nic_fini_interrupt(struct efx_nic *efx);
	196	extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
	197	extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
	198	extern void falcon_irq_ack_a1(struct efx_nic *efx);
	199
	200	#define EFX_IRQ_MOD_RESOLUTION 5
6fb70fd1	201
8ceee660	202	/* Global Resources */
152b6a62	203	extern int efx_nic_flush_queues(struct efx_nic *efx);
55edc6e6 BH	204	extern void falcon_start_nic_stats(struct efx_nic *efx);
55edc6e6 BH	205	extern void falcon_stop_nic_stats(struct efx_nic *efx);
8ceee660	206	extern int falcon_reset_xaui(struct efx_nic *efx);
152b6a62 BH	207	extern void efx_nic_init_common(struct efx_nic *efx);
	208
	209	int efx_nic_alloc_buffer(struct efx_nic efx, struct efx_buffer buffer,
	210	unsigned int len);
	211	void efx_nic_free_buffer(struct efx_nic efx, struct efx_buffer buffer);
8ceee660	212
8c8661e4	213	/* Tests */
152b6a62 BH	214	struct efx_nic_register_test {
	215	unsigned address;
	216	efx_oword_t mask;
	217	};
	218	extern int efx_nic_test_registers(struct efx_nic *efx,
	219	const struct efx_nic_register_test *regs,
	220	size_t n_regs);
8c8661e4	221
8ceee660 BH	222	/**************************************************************************
	223	*
	224	* Falcon MAC stats
	225	*
	226	**************************************************************************
	227	*/
	228
	229	#define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
	230	#define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
	231
	232	/* Retrieve statistic from statistics block */
	233	#define FALCON_STAT(efx, falcon_stat, efx_stat) do { \
	234	if (FALCON_STAT_WIDTH(falcon_stat) == 16) \
	235	(efx)->mac_stats.efx_stat += le16_to_cpu( \
	236	((__force __le16 ) \
	237	(efx->stats_buffer.addr + \
	238	FALCON_STAT_OFFSET(falcon_stat)))); \
	239	else if (FALCON_STAT_WIDTH(falcon_stat) == 32) \
	240	(efx)->mac_stats.efx_stat += le32_to_cpu( \
	241	((__force __le32 ) \
	242	(efx->stats_buffer.addr + \
	243	FALCON_STAT_OFFSET(falcon_stat)))); \
	244	else \
	245	(efx)->mac_stats.efx_stat += le64_to_cpu( \
	246	((__force __le64 ) \
	247	(efx->stats_buffer.addr + \
	248	FALCON_STAT_OFFSET(falcon_stat)))); \
	249	} while (0)
	250
	251	#define FALCON_MAC_STATS_SIZE 0x100
	252
	253	#define MAC_DATA_LBN 0
	254	#define MAC_DATA_WIDTH 32
	255
152b6a62 BH	256	extern void efx_nic_generate_event(struct efx_channel *channel,
152b6a62 BH	257	efx_qword_t *event);
8ceee660	258
9007b9fa BH	259	extern void falcon_poll_xmac(struct efx_nic *efx);
9007b9fa BH	260
744093c9	261	#endif /* EFX_NIC_H */