[deliverable/linux.git] / drivers / net / sfc / falcon.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_FALCON_H
#define EFX_FALCON_H

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

/*
 * Falcon hardware control
 */

enum falcon_revision {
	FALCON_REV_A0 = 0,
	FALCON_REV_A1 = 1,
	FALCON_REV_B0 = 2,
};

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

/**
 * struct falcon_board - board information
 * @type: Board model type
 * @major: Major rev. ('A', 'B' ...)
 * @minor: Minor rev. (0, 1, ...)
 * @init: Allocate resources and initialise peripheral hardware
 * @init_phy: Do board-specific PHY initialisation
 * @set_id_led: Set state of identifying LED or revert to automatic function
 * @monitor: Board-specific health check function
 * @fini: Shut down hardware and free resources
 * @hwmon_client: I2C client for hardware monitor
 * @ioexp_client: I2C client for power/port control
 */
struct falcon_board {
	int type;
	int major;
	int minor;
	int (*init) (struct efx_nic *nic);
	void (*init_phy) (struct efx_nic *efx);
	void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
	int (*monitor) (struct efx_nic *nic);
	void (*fini) (struct efx_nic *nic);
	struct i2c_client *hwmon_client, *ioexp_client;
};

/**
 * struct falcon_nic_data - Falcon NIC state
 * @pci_dev2: The secondary PCI device if present
 * @i2c_data: Operations and state for I2C bit-bashing algorithm
 * @board: Board state and functions
 */
struct falcon_nic_data {
	struct pci_dev *pci_dev2;
	struct i2c_algo_bit_data i2c_data;
	struct falcon_board board;
};

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

extern struct efx_nic_type falcon_a_nic_type;
extern struct efx_nic_type falcon_b_nic_type;

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

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

/* TX data path */
extern int falcon_probe_tx(struct efx_tx_queue *tx_queue);
extern void falcon_init_tx(struct efx_tx_queue *tx_queue);
extern void falcon_fini_tx(struct efx_tx_queue *tx_queue);
extern void falcon_remove_tx(struct efx_tx_queue *tx_queue);
extern void falcon_push_buffers(struct efx_tx_queue *tx_queue);

/* RX data path */
extern int falcon_probe_rx(struct efx_rx_queue *rx_queue);
extern void falcon_init_rx(struct efx_rx_queue *rx_queue);
extern void falcon_fini_rx(struct efx_rx_queue *rx_queue);
extern void falcon_remove_rx(struct efx_rx_queue *rx_queue);
extern void falcon_notify_rx_desc(struct efx_rx_queue *rx_queue);

/* Event data path */
extern int falcon_probe_eventq(struct efx_channel *channel);
extern void falcon_init_eventq(struct efx_channel *channel);
extern void falcon_fini_eventq(struct efx_channel *channel);
extern void falcon_remove_eventq(struct efx_channel *channel);
extern int falcon_process_eventq(struct efx_channel *channel, int rx_quota);
extern void falcon_eventq_read_ack(struct efx_channel *channel);

/* Ports */
extern int falcon_probe_port(struct efx_nic *efx);
extern void falcon_remove_port(struct efx_nic *efx);

/* MAC/PHY */
extern int falcon_switch_mac(struct efx_nic *efx);
extern bool falcon_xaui_link_ok(struct efx_nic *efx);
extern int falcon_dma_stats(struct efx_nic *efx,
			    unsigned int done_offset);
extern void falcon_drain_tx_fifo(struct efx_nic *efx);
extern void falcon_deconfigure_mac_wrapper(struct efx_nic *efx);
extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);

/* Interrupts and test events */
extern int falcon_init_interrupt(struct efx_nic *efx);
extern void falcon_enable_interrupts(struct efx_nic *efx);
extern void falcon_generate_test_event(struct efx_channel *channel,
				       unsigned int magic);
extern void falcon_sim_phy_event(struct efx_nic *efx);
extern void falcon_generate_interrupt(struct efx_nic *efx);
extern void falcon_set_int_moderation(struct efx_channel *channel);
extern void falcon_disable_interrupts(struct efx_nic *efx);
extern void falcon_fini_interrupt(struct efx_nic *efx);

#define FALCON_IRQ_MOD_RESOLUTION 5

/* Global Resources */
extern int falcon_probe_nic(struct efx_nic *efx);
extern int falcon_init_nic(struct efx_nic *efx);
extern int falcon_flush_queues(struct efx_nic *efx);
extern int falcon_reset_hw(struct efx_nic *efx, enum reset_type method);
extern void falcon_remove_nic(struct efx_nic *efx);
extern void falcon_update_nic_stats(struct efx_nic *efx);
extern void falcon_set_multicast_hash(struct efx_nic *efx);
extern int falcon_reset_xaui(struct efx_nic *efx);

/* Tests */
struct falcon_nvconfig;
extern int falcon_read_nvram(struct efx_nic *efx,
			     struct falcon_nvconfig *nvconfig);
extern int falcon_test_registers(struct efx_nic *efx);

/**************************************************************************
 *
 * 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 falcon_generate_event(struct efx_channel *channel,
				  efx_qword_t *event);

#endif /* EFX_FALCON_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
	11	#ifndef EFX_FALCON_H
	12	#define EFX_FALCON_H
	13
5c16a96c	14	#include <linux/i2c-algo-bit.h>
8ceee660	15	#include "net_driver.h"
177dfcd8	16	#include "efx.h"
8ceee660 BH	17
	18	/*
	19	* Falcon hardware control
	20	*/
	21
	22	enum falcon_revision {
	23	FALCON_REV_A0 = 0,
	24	FALCON_REV_A1 = 1,
	25	FALCON_REV_B0 = 2,
	26	};
	27
55668611 BH	28	static inline int falcon_rev(struct efx_nic *efx)
	29	{
	30	return efx->pci_dev->revision;
	31	}
8ceee660	32
3759433d BH	33	/**
	34	* struct falcon_board - board information
	35	* @type: Board model type
	36	* @major: Major rev. ('A', 'B' ...)
	37	* @minor: Minor rev. (0, 1, ...)
	38	* @init: Allocate resources and initialise peripheral hardware
	39	* @init_phy: Do board-specific PHY initialisation
	40	* @set_id_led: Set state of identifying LED or revert to automatic function
	41	* @monitor: Board-specific health check function
	42	* @fini: Shut down hardware and free resources
	43	* @hwmon_client: I2C client for hardware monitor
	44	* @ioexp_client: I2C client for power/port control
	45	*/
	46	struct falcon_board {
	47	int type;
	48	int major;
	49	int minor;
	50	int (init) (struct efx_nic nic);
	51	void (init_phy) (struct efx_nic efx);
	52	void (set_id_led) (struct efx_nic efx, enum efx_led_mode mode);
	53	int (monitor) (struct efx_nic nic);
	54	void (fini) (struct efx_nic nic);
	55	struct i2c_client hwmon_client, ioexp_client;
	56	};
	57
5c16a96c BH	58	/**
	59	* struct falcon_nic_data - Falcon NIC state
	60	* @pci_dev2: The secondary PCI device if present
	61	* @i2c_data: Operations and state for I2C bit-bashing algorithm
3759433d	62	* @board: Board state and functions
5c16a96c BH	63	*/
	64	struct falcon_nic_data {
	65	struct pci_dev *pci_dev2;
	66	struct i2c_algo_bit_data i2c_data;
3759433d	67	struct falcon_board board;
5c16a96c BH	68	};
5c16a96c BH	69
278c0621 BH	70	static inline struct falcon_board falcon_board(struct efx_nic efx)
278c0621 BH	71	{
3759433d BH	72	struct falcon_nic_data *data = efx->nic_data;
3759433d BH	73	return &data->board;
278c0621 BH	74	}
278c0621 BH	75
8ceee660 BH	76	extern struct efx_nic_type falcon_a_nic_type;
	77	extern struct efx_nic_type falcon_b_nic_type;
	78
	79	/**************************************************************************
	80	*
	81	* Externs
	82	*
	83	**************************************************************************
	84	*/
	85
5087b54d BH	86	extern void falcon_probe_board(struct efx_nic *efx, u16 revision_info);
5087b54d BH	87
8ceee660 BH	88	/* TX data path */
8ceee660 BH	89	extern int falcon_probe_tx(struct efx_tx_queue *tx_queue);
bc3c90a2	90	extern void falcon_init_tx(struct efx_tx_queue *tx_queue);
8ceee660 BH	91	extern void falcon_fini_tx(struct efx_tx_queue *tx_queue);
	92	extern void falcon_remove_tx(struct efx_tx_queue *tx_queue);
	93	extern void falcon_push_buffers(struct efx_tx_queue *tx_queue);
	94
	95	/* RX data path */
	96	extern int falcon_probe_rx(struct efx_rx_queue *rx_queue);
bc3c90a2	97	extern void falcon_init_rx(struct efx_rx_queue *rx_queue);
8ceee660 BH	98	extern void falcon_fini_rx(struct efx_rx_queue *rx_queue);
	99	extern void falcon_remove_rx(struct efx_rx_queue *rx_queue);
	100	extern void falcon_notify_rx_desc(struct efx_rx_queue *rx_queue);
	101
	102	/* Event data path */
	103	extern int falcon_probe_eventq(struct efx_channel *channel);
bc3c90a2	104	extern void falcon_init_eventq(struct efx_channel *channel);
8ceee660 BH	105	extern void falcon_fini_eventq(struct efx_channel *channel);
8ceee660 BH	106	extern void falcon_remove_eventq(struct efx_channel *channel);
42cbe2d7	107	extern int falcon_process_eventq(struct efx_channel *channel, int rx_quota);
8ceee660 BH	108	extern void falcon_eventq_read_ack(struct efx_channel *channel);
	109
	110	/* Ports */
	111	extern int falcon_probe_port(struct efx_nic *efx);
	112	extern void falcon_remove_port(struct efx_nic *efx);
	113
	114	/* MAC/PHY */
177dfcd8	115	extern int falcon_switch_mac(struct efx_nic *efx);
dc8cfa55	116	extern bool falcon_xaui_link_ok(struct efx_nic *efx);
8ceee660 BH	117	extern int falcon_dma_stats(struct efx_nic *efx,
	118	unsigned int done_offset);
	119	extern void falcon_drain_tx_fifo(struct efx_nic *efx);
	120	extern void falcon_deconfigure_mac_wrapper(struct efx_nic *efx);
	121	extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
	122
	123	/* Interrupts and test events */
	124	extern int falcon_init_interrupt(struct efx_nic *efx);
	125	extern void falcon_enable_interrupts(struct efx_nic *efx);
	126	extern void falcon_generate_test_event(struct efx_channel *channel,
	127	unsigned int magic);
177dfcd8	128	extern void falcon_sim_phy_event(struct efx_nic *efx);
8ceee660 BH	129	extern void falcon_generate_interrupt(struct efx_nic *efx);
	130	extern void falcon_set_int_moderation(struct efx_channel *channel);
	131	extern void falcon_disable_interrupts(struct efx_nic *efx);
	132	extern void falcon_fini_interrupt(struct efx_nic *efx);
	133
6fb70fd1 BH	134	#define FALCON_IRQ_MOD_RESOLUTION 5
6fb70fd1 BH	135
8ceee660 BH	136	/* Global Resources */
8ceee660 BH	137	extern int falcon_probe_nic(struct efx_nic *efx);
8ceee660	138	extern int falcon_init_nic(struct efx_nic *efx);
6bc5d3a9	139	extern int falcon_flush_queues(struct efx_nic *efx);
8ceee660	140	extern int falcon_reset_hw(struct efx_nic *efx, enum reset_type method);
8ceee660 BH	141	extern void falcon_remove_nic(struct efx_nic *efx);
	142	extern void falcon_update_nic_stats(struct efx_nic *efx);
	143	extern void falcon_set_multicast_hash(struct efx_nic *efx);
	144	extern int falcon_reset_xaui(struct efx_nic *efx);
	145
8c8661e4 BH	146	/* Tests */
	147	struct falcon_nvconfig;
	148	extern int falcon_read_nvram(struct efx_nic *efx,
	149	struct falcon_nvconfig *nvconfig);
	150	extern int falcon_test_registers(struct efx_nic *efx);
	151
8ceee660 BH	152	/**************************************************************************
	153	*
	154	* Falcon MAC stats
	155	*
	156	**************************************************************************
	157	*/
	158
	159	#define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
	160	#define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
	161
	162	/* Retrieve statistic from statistics block */
	163	#define FALCON_STAT(efx, falcon_stat, efx_stat) do { \
	164	if (FALCON_STAT_WIDTH(falcon_stat) == 16) \
	165	(efx)->mac_stats.efx_stat += le16_to_cpu( \
	166	((__force __le16 ) \
	167	(efx->stats_buffer.addr + \
	168	FALCON_STAT_OFFSET(falcon_stat)))); \
	169	else if (FALCON_STAT_WIDTH(falcon_stat) == 32) \
	170	(efx)->mac_stats.efx_stat += le32_to_cpu( \
	171	((__force __le32 ) \
	172	(efx->stats_buffer.addr + \
	173	FALCON_STAT_OFFSET(falcon_stat)))); \
	174	else \
	175	(efx)->mac_stats.efx_stat += le64_to_cpu( \
	176	((__force __le64 ) \
	177	(efx->stats_buffer.addr + \
	178	FALCON_STAT_OFFSET(falcon_stat)))); \
	179	} while (0)
	180
	181	#define FALCON_MAC_STATS_SIZE 0x100
	182
	183	#define MAC_DATA_LBN 0
	184	#define MAC_DATA_WIDTH 32
	185
	186	extern void falcon_generate_event(struct efx_channel *channel,
	187	efx_qword_t *event);
	188
	189	#endif /* EFX_FALCON_H */