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

/****************************************************************************
 * Driver for Solarflare Solarstorm network controllers and boards
 * Copyright 2008-2010 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_MCDI_H
#define EFX_MCDI_H

/**
 * enum efx_mcdi_state
 * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
 *	mcdi_lock then they are able to move to MCDI_STATE_RUNNING
 * @MCDI_STATE_RUNNING: There is an MCDI request pending. Only the thread that
 *	moved into this state is allowed to move out of it.
 * @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread
 *	has not yet consumed the result. For all other threads, equivalent to
 *	MCDI_STATE_RUNNING.
 */
enum efx_mcdi_state {
	MCDI_STATE_QUIESCENT,
	MCDI_STATE_RUNNING,
	MCDI_STATE_COMPLETED,
};

enum efx_mcdi_mode {
	MCDI_MODE_POLL,
	MCDI_MODE_EVENTS,
};

/**
 * struct efx_mcdi_iface
 * @state: Interface state. Waited for by mcdi_wq.
 * @wq: Wait queue for threads waiting for state != STATE_RUNNING
 * @iface_lock: Protects @credits, @seqno, @resprc, @resplen
 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
 *	Serialised by @lock
 * @seqno: The next sequence number to use for mcdi requests.
 *	Serialised by @lock
 * @credits: Number of spurious MCDI completion events allowed before we
 *	trigger a fatal error. Protected by @lock
 * @resprc: Returned MCDI completion
 * @resplen: Returned payload length
 */
struct efx_mcdi_iface {
	atomic_t state;
	wait_queue_head_t wq;
	spinlock_t iface_lock;
	enum efx_mcdi_mode mode;
	unsigned int credits;
	unsigned int seqno;
	unsigned int resprc;
	size_t resplen;
};

struct efx_mcdi_mon {
	struct efx_buffer dma_buf;
	struct mutex update_lock;
	unsigned long last_update;
	struct device *device;
	struct efx_mcdi_mon_attribute *attrs;
	unsigned int n_attrs;
};

extern void efx_mcdi_init(struct efx_nic *efx);

extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd,
			const efx_dword_t *inbuf, size_t inlen,
			efx_dword_t *outbuf, size_t outlen,
			size_t *outlen_actual);

extern void efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
			       const efx_dword_t *inbuf, size_t inlen);
extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
			       efx_dword_t *outbuf, size_t outlen,
			       size_t *outlen_actual);


extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
extern void efx_mcdi_mode_poll(struct efx_nic *efx);
extern void efx_mcdi_mode_event(struct efx_nic *efx);

extern void efx_mcdi_process_event(struct efx_channel *channel,
				   efx_qword_t *event);
extern void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);

/* We expect that 16- and 32-bit fields in MCDI requests and responses
 * are appropriately aligned.  Also, on Siena we must copy to the MC
 * shared memory strictly 32 bits at a time, so add any necessary
 * padding.
 */
#define MCDI_DECLARE_BUF(_name, _len)					\
	efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
#define _MCDI_PTR(_buf, _offset)					\
	((u8 *)(_buf) + (_offset))
#define MCDI_PTR(_buf, _field)						\
	_MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
#define _MCDI_CHECK_ALIGN(_ofst, _align)				\
	((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
#define _MCDI_DWORD(_buf, _field)					\
	((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))

#define MCDI_SET_DWORD(_buf, _field, _value)				\
	EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
#define MCDI_DWORD(_buf, _field)					\
	EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
#define MCDI_QWORD(_buf, _field)					\
	(EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) |	\
	(u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
#define MCDI_FIELD(_ptr, _type, _field)					\
	EFX_EXTRACT_DWORD(						\
		*(efx_dword_t *)					\
		_MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
		MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f,	\
		(MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) +	\
		MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)

#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align)			\
	(_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
	 + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
#define MCDI_DECLARE_STRUCT_PTR(_name)					\
	efx_dword_t *_name
#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index)			\
	((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
#define MCDI_VAR_ARRAY_LEN(_len, _field)				\
	min_t(size_t, MC_CMD_ ## _field ## _MAXNUM,			\
	      ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
#define MCDI_ARRAY_WORD(_buf, _field, _index)				\
	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +		\
	 le16_to_cpu(*(__force const __le16 *)				\
		     _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
#define _MCDI_ARRAY_DWORD(_buf, _field, _index)				\
	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) +		\
	 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value)		\
	EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index),	\
			    EFX_DWORD_0, _value)
#define MCDI_ARRAY_DWORD(_buf, _field, _index)				\
	EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2)		\
	MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index),	\
		   _type ## _TYPEDEF, _field2)

#define MCDI_EVENT_FIELD(_ev, _field)			\
	EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)

extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
			       bool *was_attached_out);
extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
				  u16 *fw_subtype_list, u32 *capabilities);
extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
			     u32 dest_evq);
extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
			       size_t *size_out, size_t *erase_size_out,
			       bool *protected_out);
extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
				       unsigned int type);
extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
			       loff_t offset, u8 *buffer, size_t length);
extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
				loff_t offset, const u8 *buffer,
				size_t length);
#define EFX_MCDI_NVRAM_LEN_MAX 128
extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
				loff_t offset, size_t length);
extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
					unsigned int type);
extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
extern int efx_mcdi_reset_port(struct efx_nic *efx);
extern int efx_mcdi_reset_mc(struct efx_nic *efx);
extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
					 const u8 *mac, int *id_out);
extern int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
extern int efx_mcdi_flush_rxqs(struct efx_nic *efx);
extern int efx_mcdi_set_mac(struct efx_nic *efx);
extern int efx_mcdi_mac_stats(struct efx_nic *efx, dma_addr_t dma_addr,
			      u32 dma_len, int enable, int clear);
extern int efx_mcdi_mac_reconfigure(struct efx_nic *efx);
extern bool efx_mcdi_mac_check_fault(struct efx_nic *efx);

#ifdef CONFIG_SFC_MCDI_MON
extern int efx_mcdi_mon_probe(struct efx_nic *efx);
extern void efx_mcdi_mon_remove(struct efx_nic *efx);
#else
static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
#endif

#endif /* EFX_MCDI_H */
Commit	Line	Data
afd4aea0 BH	1	/****************************************************************************
afd4aea0 BH	2	* Driver for Solarflare Solarstorm network controllers and boards
0a6f40c6	3	* Copyright 2008-2010 Solarflare Communications Inc.
afd4aea0 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_MCDI_H
	11	#define EFX_MCDI_H
	12
	13	/**
	14	* enum efx_mcdi_state
	15	* @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
	16	* mcdi_lock then they are able to move to MCDI_STATE_RUNNING
	17	* @MCDI_STATE_RUNNING: There is an MCDI request pending. Only the thread that
	18	* moved into this state is allowed to move out of it.
	19	* @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread
	20	* has not yet consumed the result. For all other threads, equivalent to
	21	* MCDI_STATE_RUNNING.
	22	*/
	23	enum efx_mcdi_state {
	24	MCDI_STATE_QUIESCENT,
	25	MCDI_STATE_RUNNING,
	26	MCDI_STATE_COMPLETED,
	27	};
	28
	29	enum efx_mcdi_mode {
	30	MCDI_MODE_POLL,
	31	MCDI_MODE_EVENTS,
	32	};
	33
	34	/**
	35	* struct efx_mcdi_iface
	36	* @state: Interface state. Waited for by mcdi_wq.
	37	* @wq: Wait queue for threads waiting for state != STATE_RUNNING
	38	* @iface_lock: Protects @credits, @seqno, @resprc, @resplen
	39	* @mode: Poll for mcdi completion, or wait for an mcdi_event.
	40	* Serialised by @lock
	41	* @seqno: The next sequence number to use for mcdi requests.
	42	* Serialised by @lock
	43	* @credits: Number of spurious MCDI completion events allowed before we
	44	* trigger a fatal error. Protected by @lock
	45	* @resprc: Returned MCDI completion
	46	* @resplen: Returned payload length
	47	*/
	48	struct efx_mcdi_iface {
	49	atomic_t state;
	50	wait_queue_head_t wq;
	51	spinlock_t iface_lock;
	52	enum efx_mcdi_mode mode;
	53	unsigned int credits;
	54	unsigned int seqno;
	55	unsigned int resprc;
	56	size_t resplen;
	57	};
	58
55c5e0f8 BH	59	struct efx_mcdi_mon {
	60	struct efx_buffer dma_buf;
	61	struct mutex update_lock;
	62	unsigned long last_update;
	63	struct device *device;
	64	struct efx_mcdi_mon_attribute *attrs;
	65	unsigned int n_attrs;
	66	};
	67
afd4aea0 BH	68	extern void efx_mcdi_init(struct efx_nic *efx);
afd4aea0 BH	69
9528b921 BH	70	extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd,
	71	const efx_dword_t *inbuf, size_t inlen,
	72	efx_dword_t *outbuf, size_t outlen,
afd4aea0 BH	73	size_t *outlen_actual);
afd4aea0 BH	74
c3cba721	75	extern void efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
9528b921	76	const efx_dword_t *inbuf, size_t inlen);
c3cba721	77	extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
9528b921	78	efx_dword_t *outbuf, size_t outlen,
c3cba721 SH	79	size_t *outlen_actual);
c3cba721 SH	80
9528b921	81
afd4aea0 BH	82	extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
	83	extern void efx_mcdi_mode_poll(struct efx_nic *efx);
	84	extern void efx_mcdi_mode_event(struct efx_nic *efx);
	85
	86	extern void efx_mcdi_process_event(struct efx_channel *channel,
	87	efx_qword_t *event);
55c5e0f8	88	extern void efx_mcdi_sensor_event(struct efx_nic efx, efx_qword_t ev);
afd4aea0	89
9528b921 BH	90	/* We expect that 16- and 32-bit fields in MCDI requests and responses
	91	* are appropriately aligned. Also, on Siena we must copy to the MC
	92	* shared memory strictly 32 bits at a time, so add any necessary
	93	* padding.
	94	*/
59cfc479	95	#define MCDI_DECLARE_BUF(_name, _len) \
9528b921	96	efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
a649dfcb BH	97	#define _MCDI_PTR(_buf, _offset) \
a649dfcb BH	98	((u8 *)(_buf) + (_offset))
30af6910	99	#define MCDI_PTR(_buf, _field) \
a649dfcb	100	_MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
9528b921 BH	101	#define _MCDI_CHECK_ALIGN(_ofst, _align) \
9528b921 BH	102	((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
30af6910	103	#define _MCDI_DWORD(_buf, _field) \
9528b921	104	((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
59cfc479	105
30af6910 BH	106	#define MCDI_SET_DWORD(_buf, _field, _value) \
	107	EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
	108	#define MCDI_DWORD(_buf, _field) \
	109	EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
	110	#define MCDI_QWORD(_buf, _field) \
	111	(EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) \| \
	112	(u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
a649dfcb BH	113	#define MCDI_FIELD(_ptr, _type, _field) \
	114	EFX_EXTRACT_DWORD( \
	115	(efx_dword_t ) \
	116	_MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
	117	MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
	118	(MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
	119	MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
30af6910	120
9528b921 BH	121	#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
	122	(_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
	123	+ (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
a649dfcb	124	#define MCDI_DECLARE_STRUCT_PTR(_name) \
9528b921 BH	125	efx_dword_t *_name
	126	#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
	127	((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb BH	128	#define MCDI_VAR_ARRAY_LEN(_len, _field) \
	129	min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
	130	((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
	131	#define MCDI_ARRAY_WORD(_buf, _field, _index) \
	132	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
	133	le16_to_cpu((__force const __le16 ) \
9528b921	134	_MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
a649dfcb BH	135	#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
a649dfcb BH	136	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
9528b921	137	(efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb BH	138	#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
	139	EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
	140	EFX_DWORD_0, _value)
	141	#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
	142	EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
55c5e0f8	143	#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
a649dfcb BH	144	MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
a649dfcb BH	145	_type ## _TYPEDEF, _field2)
afd4aea0	146
30af6910 BH	147	#define MCDI_EVENT_FIELD(_ev, _field) \
	148	EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
	149
e5f0fd27	150	extern void efx_mcdi_print_fwver(struct efx_nic efx, char buf, size_t len);
afd4aea0 BH	151	extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
	152	bool *was_attached_out);
	153	extern int efx_mcdi_get_board_cfg(struct efx_nic efx, u8 mac_address,
6aa9c7f6	154	u16 fw_subtype_list, u32 capabilities);
afd4aea0 BH	155	extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
	156	u32 dest_evq);
	157	extern int efx_mcdi_nvram_types(struct efx_nic efx, u32 nvram_types_out);
	158	extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
	159	size_t size_out, size_t erase_size_out,
	160	bool *protected_out);
	161	extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
	162	unsigned int type);
	163	extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
	164	loff_t offset, u8 *buffer, size_t length);
	165	extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
	166	loff_t offset, const u8 *buffer,
	167	size_t length);
5a27e86b	168	#define EFX_MCDI_NVRAM_LEN_MAX 128
afd4aea0 BH	169	extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
	170	loff_t offset, size_t length);
	171	extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
	172	unsigned int type);
2e803407	173	extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
afd4aea0 BH	174	extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
	175	extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
	176	extern int efx_mcdi_reset_port(struct efx_nic *efx);
	177	extern int efx_mcdi_reset_mc(struct efx_nic *efx);
afd4aea0 BH	178	extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
	179	const u8 mac, int id_out);
	180	extern int efx_mcdi_wol_filter_get_magic(struct efx_nic efx, int id_out);
	181	extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
	182	extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
cd2d5b52 BH	183	extern int efx_mcdi_flush_rxqs(struct efx_nic *efx);
cd2d5b52 BH	184	extern int efx_mcdi_set_mac(struct efx_nic *efx);
710b208d BH	185	extern int efx_mcdi_mac_stats(struct efx_nic *efx, dma_addr_t dma_addr,
	186	u32 dma_len, int enable, int clear);
	187	extern int efx_mcdi_mac_reconfigure(struct efx_nic *efx);
	188	extern bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
afd4aea0	189
55c5e0f8 BH	190	#ifdef CONFIG_SFC_MCDI_MON
	191	extern int efx_mcdi_mon_probe(struct efx_nic *efx);
	192	extern void efx_mcdi_mon_remove(struct efx_nic *efx);
	193	#else
	194	static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
	195	static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
	196	#endif
	197
afd4aea0	198	#endif /* EFX_MCDI_H */