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

/****************************************************************************
 * Driver for Solarflare Solarstorm network controllers and boards
 * Copyright 2007-2009 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_ENUM_H
#define EFX_ENUM_H

/**
 * enum efx_loopback_mode - loopback modes
 * @LOOPBACK_NONE: no loopback
 * @LOOPBACK_DATA: data path loopback
 * @LOOPBACK_GMAC: loopback within GMAC
 * @LOOPBACK_XGMII: loopback after XMAC
 * @LOOPBACK_XGXS: loopback within BPX after XGXS
 * @LOOPBACK_XAUI: loopback within BPX before XAUI serdes
 * @LOOPBACK_GMII: loopback within BPX after GMAC
 * @LOOPBACK_SGMII: loopback within BPX within SGMII
 * @LOOPBACK_XGBR: loopback within BPX within XGBR
 * @LOOPBACK_XFI: loopback within BPX before XFI serdes
 * @LOOPBACK_XAUI_FAR: loopback within BPX after XAUI serdes
 * @LOOPBACK_GMII_FAR: loopback within BPX before SGMII
 * @LOOPBACK_SGMII_FAR: loopback within BPX after SGMII
 * @LOOPBACK_XFI_FAR: loopback after XFI serdes
 * @LOOPBACK_GPHY: loopback within 1G PHY at unspecified level
 * @LOOPBACK_PHYXS: loopback within 10G PHY at PHYXS level
 * @LOOPBACK_PCS: loopback within 10G PHY at PCS level
 * @LOOPBACK_PMAPMD: loopback within 10G PHY at PMAPMD level
 * @LOOPBACK_XPORT: cross port loopback
 * @LOOPBACK_XGMII_WS: wireside loopback excluding XMAC
 * @LOOPBACK_XAUI_WS: wireside loopback within BPX within XAUI serdes
 * @LOOPBACK_XAUI_WS_FAR: wireside loopback within BPX including XAUI serdes
 * @LOOPBACK_XAUI_WS_NEAR: wireside loopback within BPX excluding XAUI serdes
 * @LOOPBACK_GMII_WS: wireside loopback excluding GMAC
 * @LOOPBACK_XFI_WS: wireside loopback excluding XFI serdes
 * @LOOPBACK_XFI_WS_FAR: wireside loopback including XFI serdes
 * @LOOPBACK_PHYXS_WS: wireside loopback within 10G PHY at PHYXS level
 */
/* Please keep up-to-date w.r.t the following two #defines */
enum efx_loopback_mode {
	LOOPBACK_NONE = 0,
	LOOPBACK_DATA = 1,
	LOOPBACK_GMAC = 2,
	LOOPBACK_XGMII = 3,
	LOOPBACK_XGXS = 4,
	LOOPBACK_XAUI = 5,
	LOOPBACK_GMII = 6,
	LOOPBACK_SGMII = 7,
	LOOPBACK_XGBR = 8,
	LOOPBACK_XFI = 9,
	LOOPBACK_XAUI_FAR = 10,
	LOOPBACK_GMII_FAR = 11,
	LOOPBACK_SGMII_FAR = 12,
	LOOPBACK_XFI_FAR = 13,
	LOOPBACK_GPHY = 14,
	LOOPBACK_PHYXS = 15,
	LOOPBACK_PCS = 16,
	LOOPBACK_PMAPMD = 17,
	LOOPBACK_XPORT = 18,
	LOOPBACK_XGMII_WS = 19,
	LOOPBACK_XAUI_WS = 20,
	LOOPBACK_XAUI_WS_FAR = 21,
	LOOPBACK_XAUI_WS_NEAR = 22,
	LOOPBACK_GMII_WS = 23,
	LOOPBACK_XFI_WS = 24,
	LOOPBACK_XFI_WS_FAR = 25,
	LOOPBACK_PHYXS_WS = 26,
	LOOPBACK_MAX
};
#define LOOPBACK_TEST_MAX LOOPBACK_PMAPMD

/* These loopbacks occur within the controller */
#define LOOPBACKS_INTERNAL ((1 << LOOPBACK_DATA) |		\
			    (1 << LOOPBACK_GMAC) |		\
			    (1 << LOOPBACK_XGMII)|		\
			    (1 << LOOPBACK_XGXS) |		\
			    (1 << LOOPBACK_XAUI) |		\
			    (1 << LOOPBACK_GMII) |		\
			    (1 << LOOPBACK_SGMII) |		\
			    (1 << LOOPBACK_SGMII) |		\
			    (1 << LOOPBACK_XGBR) |		\
			    (1 << LOOPBACK_XFI) |		\
			    (1 << LOOPBACK_XAUI_FAR) |		\
			    (1 << LOOPBACK_GMII_FAR) |		\
			    (1 << LOOPBACK_SGMII_FAR) |		\
			    (1 << LOOPBACK_XFI_FAR) |		\
			    (1 << LOOPBACK_XGMII_WS) |		\
			    (1 << LOOPBACK_XAUI_WS) |		\
			    (1 << LOOPBACK_XAUI_WS_FAR) |	\
			    (1 << LOOPBACK_XAUI_WS_NEAR) |	\
			    (1 << LOOPBACK_GMII_WS) |		\
			    (1 << LOOPBACK_XFI_WS) |		\
			    (1 << LOOPBACK_XFI_WS_FAR))

#define LOOPBACKS_WS ((1 << LOOPBACK_XGMII_WS) |		\
		      (1 << LOOPBACK_XAUI_WS) |			\
		      (1 << LOOPBACK_XAUI_WS_FAR) |		\
		      (1 << LOOPBACK_XAUI_WS_NEAR) |		\
		      (1 << LOOPBACK_GMII_WS) |			\
		      (1 << LOOPBACK_XFI_WS) |			\
		      (1 << LOOPBACK_XFI_WS_FAR) |		\
		      (1 << LOOPBACK_PHYXS_WS))

#define LOOPBACKS_EXTERNAL(_efx)					\
	((_efx)->loopback_modes & ~LOOPBACKS_INTERNAL &			\
	 ~(1 << LOOPBACK_NONE))

#define LOOPBACK_MASK(_efx)			\
	(1 << (_efx)->loopback_mode)

#define LOOPBACK_INTERNAL(_efx)				\
	(!!(LOOPBACKS_INTERNAL & LOOPBACK_MASK(_efx)))

#define LOOPBACK_EXTERNAL(_efx)				\
	(!!(LOOPBACK_MASK(_efx) & LOOPBACKS_EXTERNAL(_efx)))

#define LOOPBACK_CHANGED(_from, _to, _mask)				\
	(!!((LOOPBACK_MASK(_from) ^ LOOPBACK_MASK(_to)) & (_mask)))

#define LOOPBACK_OUT_OF(_from, _to, _mask)				\
	((LOOPBACK_MASK(_from) & (_mask)) && !(LOOPBACK_MASK(_to) & (_mask)))

/*****************************************************************************/

/**
 * enum reset_type - reset types
 *
 * %RESET_TYPE_INVSIBLE, %RESET_TYPE_ALL, %RESET_TYPE_WORLD and
 * %RESET_TYPE_DISABLE specify the method/scope of the reset.  The
 * other valuesspecify reasons, which efx_schedule_reset() will choose
 * a method for.
 *
 * @RESET_TYPE_INVISIBLE: don't reset the PHYs or interrupts
 * @RESET_TYPE_ALL: reset everything but PCI core blocks
 * @RESET_TYPE_WORLD: reset everything, save & restore PCI config
 * @RESET_TYPE_DISABLE: disable NIC
 * @RESET_TYPE_TX_WATCHDOG: reset due to TX watchdog
 * @RESET_TYPE_INT_ERROR: reset due to internal error
 * @RESET_TYPE_RX_RECOVERY: reset to recover from RX datapath errors
 * @RESET_TYPE_RX_DESC_FETCH: pcie error during rx descriptor fetch
 * @RESET_TYPE_TX_DESC_FETCH: pcie error during tx descriptor fetch
 * @RESET_TYPE_TX_SKIP: hardware completed empty tx descriptors
 * @RESET_TYPE_MC_FAILURE: MC reboot/assertion
 */
enum reset_type {
	RESET_TYPE_NONE = -1,
	RESET_TYPE_INVISIBLE = 0,
	RESET_TYPE_ALL = 1,
	RESET_TYPE_WORLD = 2,
	RESET_TYPE_DISABLE = 3,
	RESET_TYPE_MAX_METHOD,
	RESET_TYPE_TX_WATCHDOG,
	RESET_TYPE_INT_ERROR,
	RESET_TYPE_RX_RECOVERY,
	RESET_TYPE_RX_DESC_FETCH,
	RESET_TYPE_TX_DESC_FETCH,
	RESET_TYPE_TX_SKIP,
	RESET_TYPE_MC_FAILURE,
	RESET_TYPE_MAX,
};

#endif /* EFX_ENUM_H */
Commit	Line	Data
8ceee660 BH	1	/****************************************************************************
8ceee660 BH	2	* Driver for Solarflare Solarstorm network controllers and boards
906bb26c	3	* Copyright 2007-2009 Solarflare Communications Inc.
8ceee660 BH	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License version 2 as published
	7	* by the Free Software Foundation, incorporated herein by reference.
	8	*/
	9
	10	#ifndef EFX_ENUM_H
	11	#define EFX_ENUM_H
	12
3273c2e8 BH	13	/**
	14	* enum efx_loopback_mode - loopback modes
	15	* @LOOPBACK_NONE: no loopback
e58f69f4 BH	16	* @LOOPBACK_DATA: data path loopback
	17	* @LOOPBACK_GMAC: loopback within GMAC
	18	* @LOOPBACK_XGMII: loopback after XMAC
	19	* @LOOPBACK_XGXS: loopback within BPX after XGXS
	20	* @LOOPBACK_XAUI: loopback within BPX before XAUI serdes
	21	* @LOOPBACK_GMII: loopback within BPX after GMAC
	22	* @LOOPBACK_SGMII: loopback within BPX within SGMII
	23	* @LOOPBACK_XGBR: loopback within BPX within XGBR
	24	* @LOOPBACK_XFI: loopback within BPX before XFI serdes
	25	* @LOOPBACK_XAUI_FAR: loopback within BPX after XAUI serdes
	26	* @LOOPBACK_GMII_FAR: loopback within BPX before SGMII
	27	* @LOOPBACK_SGMII_FAR: loopback within BPX after SGMII
	28	* @LOOPBACK_XFI_FAR: loopback after XFI serdes
177dfcd8 BH	29	* @LOOPBACK_GPHY: loopback within 1G PHY at unspecified level
	30	* @LOOPBACK_PHYXS: loopback within 10G PHY at PHYXS level
	31	* @LOOPBACK_PCS: loopback within 10G PHY at PCS level
	32	* @LOOPBACK_PMAPMD: loopback within 10G PHY at PMAPMD level
e58f69f4 BH	33	* @LOOPBACK_XPORT: cross port loopback
	34	* @LOOPBACK_XGMII_WS: wireside loopback excluding XMAC
	35	* @LOOPBACK_XAUI_WS: wireside loopback within BPX within XAUI serdes
	36	* @LOOPBACK_XAUI_WS_FAR: wireside loopback within BPX including XAUI serdes
	37	* @LOOPBACK_XAUI_WS_NEAR: wireside loopback within BPX excluding XAUI serdes
	38	* @LOOPBACK_GMII_WS: wireside loopback excluding GMAC
	39	* @LOOPBACK_XFI_WS: wireside loopback excluding XFI serdes
	40	* @LOOPBACK_XFI_WS_FAR: wireside loopback including XFI serdes
	41	* @LOOPBACK_PHYXS_WS: wireside loopback within 10G PHY at PHYXS level
3273c2e8	42	*/
e58f69f4	43	/* Please keep up-to-date w.r.t the following two #defines */
3273c2e8 BH	44	enum efx_loopback_mode {
3273c2e8 BH	45	LOOPBACK_NONE = 0,
e58f69f4 BH	46	LOOPBACK_DATA = 1,
	47	LOOPBACK_GMAC = 2,
	48	LOOPBACK_XGMII = 3,
	49	LOOPBACK_XGXS = 4,
	50	LOOPBACK_XAUI = 5,
	51	LOOPBACK_GMII = 6,
	52	LOOPBACK_SGMII = 7,
	53	LOOPBACK_XGBR = 8,
	54	LOOPBACK_XFI = 9,
	55	LOOPBACK_XAUI_FAR = 10,
	56	LOOPBACK_GMII_FAR = 11,
	57	LOOPBACK_SGMII_FAR = 12,
	58	LOOPBACK_XFI_FAR = 13,
	59	LOOPBACK_GPHY = 14,
	60	LOOPBACK_PHYXS = 15,
	61	LOOPBACK_PCS = 16,
	62	LOOPBACK_PMAPMD = 17,
	63	LOOPBACK_XPORT = 18,
	64	LOOPBACK_XGMII_WS = 19,
	65	LOOPBACK_XAUI_WS = 20,
	66	LOOPBACK_XAUI_WS_FAR = 21,
	67	LOOPBACK_XAUI_WS_NEAR = 22,
	68	LOOPBACK_GMII_WS = 23,
	69	LOOPBACK_XFI_WS = 24,
	70	LOOPBACK_XFI_WS_FAR = 25,
	71	LOOPBACK_PHYXS_WS = 26,
3273c2e8 BH	72	LOOPBACK_MAX
3273c2e8 BH	73	};
3273c2e8 BH	74	#define LOOPBACK_TEST_MAX LOOPBACK_PMAPMD
3273c2e8 BH	75
3273c2e8	76	/* These loopbacks occur within the controller */
e58f69f4 BH	77	#define LOOPBACKS_INTERNAL ((1 << LOOPBACK_DATA) \| \
	78	(1 << LOOPBACK_GMAC) \| \
	79	(1 << LOOPBACK_XGMII)\| \
	80	(1 << LOOPBACK_XGXS) \| \
	81	(1 << LOOPBACK_XAUI) \| \
	82	(1 << LOOPBACK_GMII) \| \
	83	(1 << LOOPBACK_SGMII) \| \
	84	(1 << LOOPBACK_SGMII) \| \
	85	(1 << LOOPBACK_XGBR) \| \
	86	(1 << LOOPBACK_XFI) \| \
	87	(1 << LOOPBACK_XAUI_FAR) \| \
	88	(1 << LOOPBACK_GMII_FAR) \| \
	89	(1 << LOOPBACK_SGMII_FAR) \| \
	90	(1 << LOOPBACK_XFI_FAR) \| \
	91	(1 << LOOPBACK_XGMII_WS) \| \
	92	(1 << LOOPBACK_XAUI_WS) \| \
	93	(1 << LOOPBACK_XAUI_WS_FAR) \| \
	94	(1 << LOOPBACK_XAUI_WS_NEAR) \| \
	95	(1 << LOOPBACK_GMII_WS) \| \
	96	(1 << LOOPBACK_XFI_WS) \| \
	97	(1 << LOOPBACK_XFI_WS_FAR))
	98
	99	#define LOOPBACKS_WS ((1 << LOOPBACK_XGMII_WS) \| \
	100	(1 << LOOPBACK_XAUI_WS) \| \
	101	(1 << LOOPBACK_XAUI_WS_FAR) \| \
	102	(1 << LOOPBACK_XAUI_WS_NEAR) \| \
	103	(1 << LOOPBACK_GMII_WS) \| \
	104	(1 << LOOPBACK_XFI_WS) \| \
	105	(1 << LOOPBACK_XFI_WS_FAR) \| \
	106	(1 << LOOPBACK_PHYXS_WS))
	107
	108	#define LOOPBACKS_EXTERNAL(_efx) \
	109	((_efx)->loopback_modes & ~LOOPBACKS_INTERNAL & \
	110	~(1 << LOOPBACK_NONE))
3273c2e8 BH	111
	112	#define LOOPBACK_MASK(_efx) \
	113	(1 << (_efx)->loopback_mode)
	114
dc8cfa55	115	#define LOOPBACK_INTERNAL(_efx) \
177dfcd8	116	(!!(LOOPBACKS_INTERNAL & LOOPBACK_MASK(_efx)))
3273c2e8	117
e58f69f4 BH	118	#define LOOPBACK_EXTERNAL(_efx) \
	119	(!!(LOOPBACK_MASK(_efx) & LOOPBACKS_EXTERNAL(_efx)))
	120
e6fa2eb7 BH	121	#define LOOPBACK_CHANGED(_from, _to, _mask) \
	122	(!!((LOOPBACK_MASK(_from) ^ LOOPBACK_MASK(_to)) & (_mask)))
	123
dc8cfa55 BH	124	#define LOOPBACK_OUT_OF(_from, _to, _mask) \
dc8cfa55 BH	125	((LOOPBACK_MASK(_from) & (_mask)) && !(LOOPBACK_MASK(_to) & (_mask)))
3273c2e8	126
8ceee660 BH	127	/*****************************************************************************/
	128
	129	/**
	130	* enum reset_type - reset types
	131	*
	132	* %RESET_TYPE_INVSIBLE, %RESET_TYPE_ALL, %RESET_TYPE_WORLD and
	133	* %RESET_TYPE_DISABLE specify the method/scope of the reset. The
	134	* other valuesspecify reasons, which efx_schedule_reset() will choose
	135	* a method for.
	136	*
	137	* @RESET_TYPE_INVISIBLE: don't reset the PHYs or interrupts
	138	* @RESET_TYPE_ALL: reset everything but PCI core blocks
	139	* @RESET_TYPE_WORLD: reset everything, save & restore PCI config
	140	* @RESET_TYPE_DISABLE: disable NIC
739bb23d	141	* @RESET_TYPE_TX_WATCHDOG: reset due to TX watchdog
8ceee660 BH	142	* @RESET_TYPE_INT_ERROR: reset due to internal error
	143	* @RESET_TYPE_RX_RECOVERY: reset to recover from RX datapath errors
	144	* @RESET_TYPE_RX_DESC_FETCH: pcie error during rx descriptor fetch
	145	* @RESET_TYPE_TX_DESC_FETCH: pcie error during tx descriptor fetch
	146	* @RESET_TYPE_TX_SKIP: hardware completed empty tx descriptors
8880f4ec	147	* @RESET_TYPE_MC_FAILURE: MC reboot/assertion
8ceee660 BH	148	*/
	149	enum reset_type {
	150	RESET_TYPE_NONE = -1,
	151	RESET_TYPE_INVISIBLE = 0,
	152	RESET_TYPE_ALL = 1,
	153	RESET_TYPE_WORLD = 2,
	154	RESET_TYPE_DISABLE = 3,
	155	RESET_TYPE_MAX_METHOD,
739bb23d	156	RESET_TYPE_TX_WATCHDOG,
8ceee660 BH	157	RESET_TYPE_INT_ERROR,
	158	RESET_TYPE_RX_RECOVERY,
	159	RESET_TYPE_RX_DESC_FETCH,
	160	RESET_TYPE_TX_DESC_FETCH,
	161	RESET_TYPE_TX_SKIP,
8880f4ec	162	RESET_TYPE_MC_FAILURE,
8ceee660 BH	163	RESET_TYPE_MAX,
	164	};
	165
	166	#endif /* EFX_ENUM_H */