1/****************************************************************************
  2 * Driver for Solarflare Solarstorm network controllers and boards
  3 * Copyright 2008-2010 Solarflare Communications Inc.
  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 */
 23enum efx_mcdi_state {
 24	MCDI_STATE_QUIESCENT,
 25	MCDI_STATE_RUNNING,
 26	MCDI_STATE_COMPLETED,
 27};
 28
 29enum 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 */
 48struct 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
 59extern void efx_mcdi_init(struct efx_nic *efx);
 60
 61extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const u8 *inbuf,
 62			size_t inlen, u8 *outbuf, size_t outlen,
 63			size_t *outlen_actual);
 64
 65extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
 66extern void efx_mcdi_mode_poll(struct efx_nic *efx);
 67extern void efx_mcdi_mode_event(struct efx_nic *efx);
 68
 69extern void efx_mcdi_process_event(struct efx_channel *channel,
 70				   efx_qword_t *event);
 71
 72#define MCDI_PTR2(_buf, _ofst)						\
 73	(((u8 *)_buf) + _ofst)
 74#define MCDI_SET_DWORD2(_buf, _ofst, _value)				\
 75	EFX_POPULATE_DWORD_1(*((efx_dword_t *)MCDI_PTR2(_buf, _ofst)),	\
 76			     EFX_DWORD_0, _value)
 77#define MCDI_DWORD2(_buf, _ofst)					\
 78	EFX_DWORD_FIELD(*((efx_dword_t *)MCDI_PTR2(_buf, _ofst)),	\
 79			EFX_DWORD_0)
 80#define MCDI_QWORD2(_buf, _ofst)					\
 81	EFX_QWORD_FIELD64(*((efx_qword_t *)MCDI_PTR2(_buf, _ofst)),	\
 82			  EFX_QWORD_0)
 83
 84#define MCDI_PTR(_buf, _ofst)						\
 85	MCDI_PTR2(_buf, MC_CMD_ ## _ofst ## _OFST)
 86#define MCDI_SET_DWORD(_buf, _ofst, _value)				\
 87	MCDI_SET_DWORD2(_buf, MC_CMD_ ## _ofst ## _OFST, _value)
 88#define MCDI_DWORD(_buf, _ofst)						\
 89	MCDI_DWORD2(_buf, MC_CMD_ ## _ofst ## _OFST)
 90#define MCDI_QWORD(_buf, _ofst)						\
 91	MCDI_QWORD2(_buf, MC_CMD_ ## _ofst ## _OFST)
 92
 93#define MCDI_EVENT_FIELD(_ev, _field)			\
 94	EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
 95
 96extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
 97extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
 98			       bool *was_attached_out);
 99extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
100				  u16 *fw_subtype_list);
101extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
102			     u32 dest_evq);
103extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
104extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
105			       size_t *size_out, size_t *erase_size_out,
106			       bool *protected_out);
107extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
108				       unsigned int type);
109extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
110			       loff_t offset, u8 *buffer, size_t length);
111extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
112				loff_t offset, const u8 *buffer,
113				size_t length);
114#define EFX_MCDI_NVRAM_LEN_MAX 128
115extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
116				loff_t offset, size_t length);
117extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
118					unsigned int type);
119extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
120extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
121extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
122extern int efx_mcdi_reset_port(struct efx_nic *efx);
123extern int efx_mcdi_reset_mc(struct efx_nic *efx);
124extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
125					 const u8 *mac, int *id_out);
126extern int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
127extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
128extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
129
130#endif /* EFX_MCDI_H */