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

/* SPDX-License-Identifier: GPL-2.0-only */
/****************************************************************************
 * Driver for Solarflare network controllers and boards
 * Copyright 2008-2013 Solarflare Communications Inc.
 */

#ifndef EFX_MCDI_H
#define EFX_MCDI_H

/**
 * enum efx_mcdi_state - MCDI request handling state
 * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
 *	mcdi @iface_lock then they are able to move to %MCDI_STATE_RUNNING
 * @MCDI_STATE_RUNNING_SYNC: There is a synchronous MCDI request pending.
 *	Only the thread that moved into this state is allowed to move out of it.
 * @MCDI_STATE_RUNNING_ASYNC: There is an asynchronous MCDI request pending.
 * @MCDI_STATE_PROXY_WAIT: An MCDI request has completed with a response that
 *	indicates we must wait for a proxy try again message.
 * @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_SYNC,
	MCDI_STATE_RUNNING_ASYNC,
	MCDI_STATE_PROXY_WAIT,
	MCDI_STATE_COMPLETED,
};

/**
 * enum efx_mcdi_mode - MCDI transaction mode
 * @MCDI_MODE_POLL: poll for MCDI completion, until timeout
 * @MCDI_MODE_EVENTS: wait for an mcdi_event.  On timeout, poll once
 * @MCDI_MODE_FAIL: we think MCDI is dead, so fail-fast all calls
 */
enum efx_mcdi_mode {
	MCDI_MODE_POLL,
	MCDI_MODE_EVENTS,
	MCDI_MODE_FAIL,
};

/**
 * struct efx_mcdi_iface - MCDI protocol context
 * @efx: The associated NIC.
 * @state: Request handling state. Waited for by @wq.
 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
 * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
 * @new_epoch: Indicates start of day or start of MC reboot recovery
 * @iface_lock: Serialises access to @seqno, @credits and response metadata
 * @seqno: The next sequence number to use for mcdi requests.
 * @credits: Number of spurious MCDI completion events allowed before we
 *     trigger a fatal error
 * @resprc: Response error/success code (Linux numbering)
 * @resp_hdr_len: Response header length
 * @resp_data_len: Response data (SDU or error) length
 * @async_lock: Serialises access to @async_list while event processing is
 *	enabled
 * @async_list: Queue of asynchronous requests
 * @async_timer: Timer for asynchronous request timeout
 * @logging_buffer: buffer that may be used to build MCDI tracing messages
 * @logging_enabled: whether to trace MCDI
 * @proxy_rx_handle: Most recently received proxy authorisation handle
 * @proxy_rx_status: Status of most recent proxy authorisation
 * @proxy_rx_wq: Wait queue for updates to proxy_rx_handle
 */
struct efx_mcdi_iface {
	struct efx_nic *efx;
	enum efx_mcdi_state state;
	enum efx_mcdi_mode mode;
	wait_queue_head_t wq;
	spinlock_t iface_lock;
	bool new_epoch;
	unsigned int credits;
	unsigned int seqno;
	int resprc;
	int resprc_raw;
	size_t resp_hdr_len;
	size_t resp_data_len;
	spinlock_t async_lock;
	struct list_head async_list;
	struct timer_list async_timer;
#ifdef CONFIG_SFC_MCDI_LOGGING
	char *logging_buffer;
	bool logging_enabled;
#endif
	unsigned int proxy_rx_handle;
	int proxy_rx_status;
	wait_queue_head_t proxy_rx_wq;
};

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;
	struct attribute_group group;
	const struct attribute_group *groups[2];
	unsigned int n_attrs;
};

struct efx_mcdi_mtd_partition {
	struct efx_mtd_partition common;
	bool updating;
	u16 nvram_type;
	u16 fw_subtype;
};

#define to_efx_mcdi_mtd_partition(mtd)				\
	container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)

/**
 * struct efx_mcdi_data - extra state for NICs that implement MCDI
 * @iface: Interface/protocol state
 * @hwmon: Hardware monitor state
 * @fn_flags: Flags for this function, as returned by %MC_CMD_DRV_ATTACH.
 */
struct efx_mcdi_data {
	struct efx_mcdi_iface iface;
#ifdef CONFIG_SFC_MCDI_MON
	struct efx_mcdi_mon hwmon;
#endif
	u32 fn_flags;
};

static inline struct efx_mcdi_iface *efx_mcdi(struct efx_nic *efx)
{
	EFX_WARN_ON_PARANOID(!efx->mcdi);
	return &efx->mcdi->iface;
}

#ifdef CONFIG_SFC_MCDI_MON
static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
{
	EFX_WARN_ON_PARANOID(!efx->mcdi);
	return &efx->mcdi->hwmon;
}
#endif

int efx_mcdi_init(struct efx_nic *efx);
void efx_mcdi_detach(struct efx_nic *efx);
void efx_mcdi_fini(struct efx_nic *efx);

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);
int efx_mcdi_rpc_quiet(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);

int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
		       const efx_dword_t *inbuf, size_t inlen);
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);
int efx_mcdi_rpc_finish_quiet(struct efx_nic *efx, unsigned cmd,
			      size_t inlen, efx_dword_t *outbuf,
			      size_t outlen, size_t *outlen_actual);

typedef void efx_mcdi_async_completer(struct efx_nic *efx,
				      unsigned long cookie, int rc,
				      efx_dword_t *outbuf,
				      size_t outlen_actual);
int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
		       const efx_dword_t *inbuf, size_t inlen, size_t outlen,
		       efx_mcdi_async_completer *complete,
		       unsigned long cookie);
int efx_mcdi_rpc_async_quiet(struct efx_nic *efx, unsigned int cmd,
			     const efx_dword_t *inbuf, size_t inlen,
			     size_t outlen,
			     efx_mcdi_async_completer *complete,
			     unsigned long cookie);

void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
			    size_t inlen, efx_dword_t *outbuf,
			    size_t outlen, int rc);

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

void efx_mcdi_process_event(struct efx_channel *channel, efx_qword_t *event);
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, but 64-bit fields are only
 * 32-bit-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_TX_BUF_LEN(_len) DIV_ROUND_UP((_len), 4)
#define _MCDI_DECLARE_BUF(_name, _len)					\
	efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
#define MCDI_DECLARE_BUF(_name, _len)					\
	_MCDI_DECLARE_BUF(_name, _len) = {{{0}}}
#define MCDI_DECLARE_BUF_ERR(_name)					\
	MCDI_DECLARE_BUF(_name, 8)
#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_BYTE(_buf, _field)						\
	((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 1),	\
	 *MCDI_PTR(_buf, _field))
#define MCDI_WORD(_buf, _field)						\
	((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +	\
	 le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
#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_POPULATE_DWORD_1(_buf, _field, _name1, _value1)		\
	EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1)
#define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1,		\
			      _name2, _value2)				\
	EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2)
#define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1,		\
			      _name2, _value2, _name3, _value3)		\
	EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2,		\
			     MC_CMD_ ## _name3, _value3)
#define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1,		\
			      _name2, _value2, _name3, _value3,		\
			      _name4, _value4)				\
	EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2,		\
			     MC_CMD_ ## _name3, _value3,		\
			     MC_CMD_ ## _name4, _value4)
#define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1,		\
			      _name2, _value2, _name3, _value3,		\
			      _name4, _value4, _name5, _value5)		\
	EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2,		\
			     MC_CMD_ ## _name3, _value3,		\
			     MC_CMD_ ## _name4, _value4,		\
			     MC_CMD_ ## _name5, _value5)
#define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1,		\
			      _name2, _value2, _name3, _value3,		\
			      _name4, _value4, _name5, _value5,		\
			      _name6, _value6)				\
	EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2,		\
			     MC_CMD_ ## _name3, _value3,		\
			     MC_CMD_ ## _name4, _value4,		\
			     MC_CMD_ ## _name5, _value5,		\
			     MC_CMD_ ## _name6, _value6)
#define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1,		\
			      _name2, _value2, _name3, _value3,		\
			      _name4, _value4, _name5, _value5,		\
			      _name6, _value6, _name7, _value7)		\
	EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field),		\
			     MC_CMD_ ## _name1, _value1,		\
			     MC_CMD_ ## _name2, _value2,		\
			     MC_CMD_ ## _name3, _value3,		\
			     MC_CMD_ ## _name4, _value4,		\
			     MC_CMD_ ## _name5, _value5,		\
			     MC_CMD_ ## _name6, _value6,		\
			     MC_CMD_ ## _name7, _value7)
#define MCDI_SET_QWORD(_buf, _field, _value)				\
	do {								\
		EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0],	\
				     EFX_DWORD_0, (u32)(_value));	\
		EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1],	\
				     EFX_DWORD_0, (u64)(_value) >> 32);	\
	} while (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_QWORD(_buf, _field, _index)				\
	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) +		\
	 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value)		\
	do {								\
		EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
				    EFX_DWORD_0, (u32)(_value));	\
		EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
				    EFX_DWORD_0, (u64)(_value) >> 32);	\
	} while (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)

#define MCDI_CAPABILITY(field)						\
	MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _LBN

#define MCDI_CAPABILITY_OFST(field) \
	MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _OFST

#define efx_has_cap(efx, field) \
	efx->type->check_caps(efx, \
			      MCDI_CAPABILITY(field), \
			      MCDI_CAPABILITY_OFST(field))

void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
			   u16 *fw_subtype_list, u32 *capabilities);
int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq);
int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
			size_t *size_out, size_t *erase_size_out,
			bool *protected_out);
int efx_new_mcdi_nvram_test_all(struct efx_nic *efx);
int efx_mcdi_nvram_test_all(struct efx_nic *efx);
int efx_mcdi_handle_assertion(struct efx_nic *efx);
int efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx, const u8 *mac,
				  int *id_out);
int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
int efx_mcdi_flush_rxqs(struct efx_nic *efx);
void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
void efx_mcdi_mac_start_stats(struct efx_nic *efx);
void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
void efx_mcdi_mac_pull_stats(struct efx_nic *efx);
enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
			    unsigned int *flags);
int efx_mcdi_get_workarounds(struct efx_nic *efx, unsigned int *impl_out,
			     unsigned int *enabled_out);

#ifdef CONFIG_SFC_MCDI_MON
int efx_mcdi_mon_probe(struct efx_nic *efx);
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

#ifdef CONFIG_SFC_MTD
int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len,
		      size_t *retlen, u8 *buffer);
int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len,
		       size_t *retlen, const u8 *buffer);
int efx_mcdi_mtd_sync(struct mtd_info *mtd);
void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
#endif

#endif /* EFX_MCDI_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
afd4aea0	2	/****************************************************************************
f7a6d2c4 BH	3	* Driver for Solarflare network controllers and boards
f7a6d2c4 BH	4	* Copyright 2008-2013 Solarflare Communications Inc.
afd4aea0 BH	5	*/
	6
	7	#ifndef EFX_MCDI_H
	8	#define EFX_MCDI_H
	9
	10	/**
f76fe120	11	* enum efx_mcdi_state - MCDI request handling state
afd4aea0	12	* @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
f76fe120	13	* mcdi @iface_lock then they are able to move to %MCDI_STATE_RUNNING
cade715f BH	14	* @MCDI_STATE_RUNNING_SYNC: There is a synchronous MCDI request pending.
	15	* Only the thread that moved into this state is allowed to move out of it.
	16	* @MCDI_STATE_RUNNING_ASYNC: There is an asynchronous MCDI request pending.
acd43a90 BK	17	* @MCDI_STATE_PROXY_WAIT: An MCDI request has completed with a response that
acd43a90 BK	18	* indicates we must wait for a proxy try again message.
afd4aea0 BH	19	* @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread
afd4aea0 BH	20	* has not yet consumed the result. For all other threads, equivalent to
f76fe120	21	* %MCDI_STATE_RUNNING.
afd4aea0 BH	22	*/
	23	enum efx_mcdi_state {
	24	MCDI_STATE_QUIESCENT,
cade715f BH	25	MCDI_STATE_RUNNING_SYNC,
cade715f BH	26	MCDI_STATE_RUNNING_ASYNC,
acd43a90	27	MCDI_STATE_PROXY_WAIT,
afd4aea0 BH	28	MCDI_STATE_COMPLETED,
	29	};
	30
e283546c EC	31	/**
	32	* enum efx_mcdi_mode - MCDI transaction mode
	33	* @MCDI_MODE_POLL: poll for MCDI completion, until timeout
	34	* @MCDI_MODE_EVENTS: wait for an mcdi_event. On timeout, poll once
	35	* @MCDI_MODE_FAIL: we think MCDI is dead, so fail-fast all calls
	36	*/
afd4aea0 BH	37	enum efx_mcdi_mode {
	38	MCDI_MODE_POLL,
	39	MCDI_MODE_EVENTS,
e283546c	40	MCDI_MODE_FAIL,
afd4aea0 BH	41	};
	42
	43	/**
f76fe120	44	* struct efx_mcdi_iface - MCDI protocol context
cade715f	45	* @efx: The associated NIC.
f76fe120	46	* @state: Request handling state. Waited for by @wq.
afd4aea0	47	* @mode: Poll for mcdi completion, or wait for an mcdi_event.
f76fe120	48	* @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
d36a08b4	49	* @new_epoch: Indicates start of day or start of MC reboot recovery
cade715f	50	* @iface_lock: Serialises access to @seqno, @credits and response metadata
afd4aea0	51	* @seqno: The next sequence number to use for mcdi requests.
afd4aea0	52	* @credits: Number of spurious MCDI completion events allowed before we
f76fe120	53	* trigger a fatal error
5bc283e5	54	* @resprc: Response error/success code (Linux numbering)
df2cd8af BH	55	* @resp_hdr_len: Response header length
df2cd8af BH	56	* @resp_data_len: Response data (SDU or error) length
cade715f BH	57	* @async_lock: Serialises access to @async_list while event processing is
	58	* enabled
	59	* @async_list: Queue of asynchronous requests
	60	* @async_timer: Timer for asynchronous request timeout
75aba2a5	61	* @logging_buffer: buffer that may be used to build MCDI tracing messages
e7fef9b4	62	* @logging_enabled: whether to trace MCDI
acd43a90 BK	63	* @proxy_rx_handle: Most recently received proxy authorisation handle
	64	* @proxy_rx_status: Status of most recent proxy authorisation
	65	* @proxy_rx_wq: Wait queue for updates to proxy_rx_handle
afd4aea0 BH	66	*/
afd4aea0 BH	67	struct efx_mcdi_iface {
cade715f	68	struct efx_nic *efx;
251111d9	69	enum efx_mcdi_state state;
f76fe120	70	enum efx_mcdi_mode mode;
afd4aea0 BH	71	wait_queue_head_t wq;
afd4aea0 BH	72	spinlock_t iface_lock;
d36a08b4	73	bool new_epoch;
afd4aea0 BH	74	unsigned int credits;
afd4aea0 BH	75	unsigned int seqno;
5bc283e5	76	int resprc;
ac28d179	77	int resprc_raw;
df2cd8af BH	78	size_t resp_hdr_len;
df2cd8af BH	79	size_t resp_data_len;
cade715f BH	80	spinlock_t async_lock;
	81	struct list_head async_list;
	82	struct timer_list async_timer;
75aba2a5 EC	83	#ifdef CONFIG_SFC_MCDI_LOGGING
75aba2a5 EC	84	char *logging_buffer;
e7fef9b4	85	bool logging_enabled;
75aba2a5	86	#endif
acd43a90 BK	87	unsigned int proxy_rx_handle;
	88	int proxy_rx_status;
	89	wait_queue_head_t proxy_rx_wq;
afd4aea0 BH	90	};
afd4aea0 BH	91
55c5e0f8 BH	92	struct efx_mcdi_mon {
	93	struct efx_buffer dma_buf;
	94	struct mutex update_lock;
	95	unsigned long last_update;
	96	struct device *device;
	97	struct efx_mcdi_mon_attribute *attrs;
85493e6d GR	98	struct attribute_group group;
85493e6d GR	99	const struct attribute_group *groups[2];
55c5e0f8 BH	100	unsigned int n_attrs;
	101	};
	102
45a3fd55 BH	103	struct efx_mcdi_mtd_partition {
	104	struct efx_mtd_partition common;
	105	bool updating;
8127d661	106	u16 nvram_type;
45a3fd55 BH	107	u16 fw_subtype;
	108	};
	109
	110	#define to_efx_mcdi_mtd_partition(mtd) \
	111	container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)
	112
f3ad5003 BH	113	/**
	114	* struct efx_mcdi_data - extra state for NICs that implement MCDI
	115	* @iface: Interface/protocol state
	116	* @hwmon: Hardware monitor state
8349f7f6	117	* @fn_flags: Flags for this function, as returned by %MC_CMD_DRV_ATTACH.
f3ad5003 BH	118	*/
	119	struct efx_mcdi_data {
	120	struct efx_mcdi_iface iface;
	121	#ifdef CONFIG_SFC_MCDI_MON
	122	struct efx_mcdi_mon hwmon;
	123	#endif
8349f7f6	124	u32 fn_flags;
f3ad5003 BH	125	};
f3ad5003 BH	126
e283546c EC	127	static inline struct efx_mcdi_iface efx_mcdi(struct efx_nic efx)
e283546c EC	128	{
e01b16a7	129	EFX_WARN_ON_PARANOID(!efx->mcdi);
e283546c EC	130	return &efx->mcdi->iface;
	131	}
	132
f3ad5003 BH	133	#ifdef CONFIG_SFC_MCDI_MON
	134	static inline struct efx_mcdi_mon efx_mcdi_mon(struct efx_nic efx)
	135	{
e01b16a7	136	EFX_WARN_ON_PARANOID(!efx->mcdi);
f3ad5003 BH	137	return &efx->mcdi->hwmon;
	138	}
	139	#endif
	140
00aef986	141	int efx_mcdi_init(struct efx_nic *efx);
e5fbd977	142	void efx_mcdi_detach(struct efx_nic *efx);
00aef986	143	void efx_mcdi_fini(struct efx_nic *efx);
afd4aea0	144
00aef986 JP	145	int efx_mcdi_rpc(struct efx_nic efx, unsigned cmd, const efx_dword_t inbuf,
	146	size_t inlen, efx_dword_t *outbuf, size_t outlen,
	147	size_t *outlen_actual);
1e0b8120 EC	148	int efx_mcdi_rpc_quiet(struct efx_nic *efx, unsigned cmd,
	149	const efx_dword_t *inbuf, size_t inlen,
	150	efx_dword_t *outbuf, size_t outlen,
	151	size_t *outlen_actual);
00aef986 JP	152
	153	int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
	154	const efx_dword_t *inbuf, size_t inlen);
	155	int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
9528b921	156	efx_dword_t *outbuf, size_t outlen,
afd4aea0	157	size_t *outlen_actual);
1e0b8120 EC	158	int efx_mcdi_rpc_finish_quiet(struct efx_nic *efx, unsigned cmd,
	159	size_t inlen, efx_dword_t *outbuf,
	160	size_t outlen, size_t *outlen_actual);
afd4aea0	161
cade715f BH	162	typedef void efx_mcdi_async_completer(struct efx_nic *efx,
	163	unsigned long cookie, int rc,
	164	efx_dword_t *outbuf,
	165	size_t outlen_actual);
00aef986 JP	166	int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
	167	const efx_dword_t *inbuf, size_t inlen, size_t outlen,
	168	efx_mcdi_async_completer *complete,
	169	unsigned long cookie);
1e0b8120 EC	170	int efx_mcdi_rpc_async_quiet(struct efx_nic *efx, unsigned int cmd,
	171	const efx_dword_t *inbuf, size_t inlen,
	172	size_t outlen,
	173	efx_mcdi_async_completer *complete,
	174	unsigned long cookie);
	175
	176	void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
	177	size_t inlen, efx_dword_t *outbuf,
	178	size_t outlen, int rc);
9528b921	179
00aef986 JP	180	int efx_mcdi_poll_reboot(struct efx_nic *efx);
	181	void efx_mcdi_mode_poll(struct efx_nic *efx);
	182	void efx_mcdi_mode_event(struct efx_nic *efx);
	183	void efx_mcdi_flush_async(struct efx_nic *efx);
afd4aea0	184
00aef986 JP	185	void efx_mcdi_process_event(struct efx_channel channel, efx_qword_t event);
00aef986 JP	186	void efx_mcdi_sensor_event(struct efx_nic efx, efx_qword_t ev);
afd4aea0	187
9528b921	188	/* We expect that 16- and 32-bit fields in MCDI requests and responses
338f74df BH	189	* are appropriately aligned, but 64-bit fields are only
	190	* 32-bit-aligned. Also, on Siena we must copy to the MC shared
	191	* memory strictly 32 bits at a time, so add any necessary padding.
9528b921	192	*/
add3c86a	193	#define MCDI_TX_BUF_LEN(_len) DIV_ROUND_UP((_len), 4)
aa09a3da	194	#define _MCDI_DECLARE_BUF(_name, _len) \
9528b921	195	efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
aa09a3da JC	196	#define MCDI_DECLARE_BUF(_name, _len) \
	197	_MCDI_DECLARE_BUF(_name, _len) = {{{0}}}
	198	#define MCDI_DECLARE_BUF_ERR(_name) \
	199	MCDI_DECLARE_BUF(_name, 8)
a649dfcb BH	200	#define _MCDI_PTR(_buf, _offset) \
a649dfcb BH	201	((u8 *)(_buf) + (_offset))
30af6910	202	#define MCDI_PTR(_buf, _field) \
a649dfcb	203	_MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
9528b921 BH	204	#define _MCDI_CHECK_ALIGN(_ofst, _align) \
9528b921 BH	205	((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
30af6910	206	#define _MCDI_DWORD(_buf, _field) \
9528b921	207	((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
59cfc479	208
71827443 EC	209	#define MCDI_BYTE(_buf, _field) \
	210	((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 1), \
	211	*MCDI_PTR(_buf, _field))
8127d661 BH	212	#define MCDI_WORD(_buf, _field) \
	213	((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
	214	le16_to_cpu((__force const __le16 )MCDI_PTR(_buf, _field)))
30af6910 BH	215	#define MCDI_SET_DWORD(_buf, _field, _value) \
	216	EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
	217	#define MCDI_DWORD(_buf, _field) \
	218	EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
f5253d92 BH	219	#define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1) \
	220	EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), \
	221	MC_CMD_ ## _name1, _value1)
	222	#define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1, \
	223	_name2, _value2) \
	224	EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field), \
	225	MC_CMD_ ## _name1, _value1, \
	226	MC_CMD_ ## _name2, _value2)
	227	#define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1, \
	228	_name2, _value2, _name3, _value3) \
	229	EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field), \
	230	MC_CMD_ ## _name1, _value1, \
	231	MC_CMD_ ## _name2, _value2, \
	232	MC_CMD_ ## _name3, _value3)
	233	#define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1, \
	234	_name2, _value2, _name3, _value3, \
	235	_name4, _value4) \
	236	EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field), \
	237	MC_CMD_ ## _name1, _value1, \
	238	MC_CMD_ ## _name2, _value2, \
	239	MC_CMD_ ## _name3, _value3, \
	240	MC_CMD_ ## _name4, _value4)
	241	#define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1, \
	242	_name2, _value2, _name3, _value3, \
	243	_name4, _value4, _name5, _value5) \
	244	EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field), \
	245	MC_CMD_ ## _name1, _value1, \
	246	MC_CMD_ ## _name2, _value2, \
	247	MC_CMD_ ## _name3, _value3, \
	248	MC_CMD_ ## _name4, _value4, \
	249	MC_CMD_ ## _name5, _value5)
	250	#define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1, \
	251	_name2, _value2, _name3, _value3, \
	252	_name4, _value4, _name5, _value5, \
	253	_name6, _value6) \
	254	EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field), \
	255	MC_CMD_ ## _name1, _value1, \
	256	MC_CMD_ ## _name2, _value2, \
	257	MC_CMD_ ## _name3, _value3, \
	258	MC_CMD_ ## _name4, _value4, \
	259	MC_CMD_ ## _name5, _value5, \
	260	MC_CMD_ ## _name6, _value6)
	261	#define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1, \
	262	_name2, _value2, _name3, _value3, \
	263	_name4, _value4, _name5, _value5, \
	264	_name6, _value6, _name7, _value7) \
	265	EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field), \
	266	MC_CMD_ ## _name1, _value1, \
	267	MC_CMD_ ## _name2, _value2, \
	268	MC_CMD_ ## _name3, _value3, \
	269	MC_CMD_ ## _name4, _value4, \
	270	MC_CMD_ ## _name5, _value5, \
	271	MC_CMD_ ## _name6, _value6, \
	272	MC_CMD_ ## _name7, _value7)
338f74df BH	273	#define MCDI_SET_QWORD(_buf, _field, _value) \
	274	do { \
	275	EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \
	276	EFX_DWORD_0, (u32)(_value)); \
	277	EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \
	278	EFX_DWORD_0, (u64)(_value) >> 32); \
	279	} while (0)
30af6910 BH	280	#define MCDI_QWORD(_buf, _field) \
	281	(EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) \| \
	282	(u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
a649dfcb BH	283	#define MCDI_FIELD(_ptr, _type, _field) \
	284	EFX_EXTRACT_DWORD( \
	285	(efx_dword_t ) \
	286	_MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
	287	MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
	288	(MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
	289	MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
30af6910	290
9528b921 BH	291	#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
	292	(_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
	293	+ (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
a649dfcb	294	#define MCDI_DECLARE_STRUCT_PTR(_name) \
9528b921 BH	295	efx_dword_t *_name
	296	#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
	297	((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb BH	298	#define MCDI_VAR_ARRAY_LEN(_len, _field) \
	299	min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
	300	((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
	301	#define MCDI_ARRAY_WORD(_buf, _field, _index) \
	302	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
	303	le16_to_cpu((__force const __le16 ) \
9528b921	304	_MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
a649dfcb BH	305	#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
a649dfcb BH	306	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
9528b921	307	(efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb BH	308	#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
	309	EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
	310	EFX_DWORD_0, _value)
	311	#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
	312	EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
338f74df BH	313	#define _MCDI_ARRAY_QWORD(_buf, _field, _index) \
	314	(BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \
	315	(efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
	316	#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \
	317	do { \
	318	EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
	319	EFX_DWORD_0, (u32)(_value)); \
	320	EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
	321	EFX_DWORD_0, (u64)(_value) >> 32); \
	322	} while (0)
55c5e0f8	323	#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
a649dfcb BH	324	MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
a649dfcb BH	325	_type ## _TYPEDEF, _field2)
afd4aea0	326
30af6910 BH	327	#define MCDI_EVENT_FIELD(_ev, _field) \
	328	EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
	329
be904b85	330	#define MCDI_CAPABILITY(field) \
d802b0ae	331	MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _LBN
be904b85 TZ	332
be904b85 TZ	333	#define MCDI_CAPABILITY_OFST(field) \
d802b0ae	334	MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _OFST
be904b85	335
6d9b5dcd	336	#define efx_has_cap(efx, field) \
be904b85	337	efx->type->check_caps(efx, \
6d9b5dcd	338	MCDI_CAPABILITY(field), \
be904b85 TZ	339	MCDI_CAPABILITY_OFST(field))
be904b85 TZ	340
00aef986 JP	341	void efx_mcdi_print_fwver(struct efx_nic efx, char buf, size_t len);
	342	int efx_mcdi_get_board_cfg(struct efx_nic efx, u8 mac_address,
	343	u16 fw_subtype_list, u32 capabilities);
	344	int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq);
	345	int efx_mcdi_nvram_types(struct efx_nic efx, u32 nvram_types_out);
	346	int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
	347	size_t size_out, size_t erase_size_out,
	348	bool *protected_out);
b3007dfd	349	int efx_new_mcdi_nvram_test_all(struct efx_nic *efx);
00aef986 JP	350	int efx_mcdi_nvram_test_all(struct efx_nic *efx);
00aef986 JP	351	int efx_mcdi_handle_assertion(struct efx_nic *efx);
f2ed621f	352	int efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
00aef986 JP	353	int efx_mcdi_wol_filter_set_magic(struct efx_nic efx, const u8 mac,
	354	int *id_out);
	355	int efx_mcdi_wol_filter_get_magic(struct efx_nic efx, int id_out);
	356	int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
	357	int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
	358	int efx_mcdi_flush_rxqs(struct efx_nic *efx);
00aef986	359	void efx_mcdi_process_link_change(struct efx_nic efx, efx_qword_t ev);
00aef986 JP	360	void efx_mcdi_mac_start_stats(struct efx_nic *efx);
00aef986 JP	361	void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
f8f3b5ae	362	void efx_mcdi_mac_pull_stats(struct efx_nic *efx);
00aef986 JP	363	enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
00aef986 JP	364	int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
34ccfe6f DP	365	int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
34ccfe6f DP	366	unsigned int *flags);
267d9d73 EC	367	int efx_mcdi_get_workarounds(struct efx_nic efx, unsigned int impl_out,
267d9d73 EC	368	unsigned int *enabled_out);
afd4aea0	369
55c5e0f8	370	#ifdef CONFIG_SFC_MCDI_MON
00aef986 JP	371	int efx_mcdi_mon_probe(struct efx_nic *efx);
00aef986 JP	372	void efx_mcdi_mon_remove(struct efx_nic *efx);
55c5e0f8 BH	373	#else
	374	static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
	375	static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
	376	#endif
	377
45a3fd55	378	#ifdef CONFIG_SFC_MTD
00aef986 JP	379	int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len,
	380	size_t retlen, u8 buffer);
	381	int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
	382	int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len,
	383	size_t retlen, const u8 buffer);
	384	int efx_mcdi_mtd_sync(struct mtd_info *mtd);
	385	void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
45a3fd55 BH	386	#endif
45a3fd55 BH	387
afd4aea0	388	#endif /* EFX_MCDI_H */