[deliverable/linux.git] / drivers / net / ethernet / intel / i40e / i40e_adminq.h

/*******************************************************************************
 *
 * Intel Ethernet Controller XL710 Family Linux Driver
 * Copyright(c) 2013 - 2014 Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The full GNU General Public License is included in this distribution in
 * the file called "COPYING".
 *
 * Contact Information:
 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 ******************************************************************************/

#ifndef _I40E_ADMINQ_H_
#define _I40E_ADMINQ_H_

#include "i40e_osdep.h"
#include "i40e_status.h"
#include "i40e_adminq_cmd.h"

#define I40E_ADMINQ_DESC(R, i)   \
	(&(((struct i40e_aq_desc *)((R).desc_buf.va))[i]))

#define I40E_ADMINQ_DESC_ALIGNMENT 4096

struct i40e_adminq_ring {
	struct i40e_virt_mem dma_head;	/* space for dma structures */
	struct i40e_dma_mem desc_buf;	/* descriptor ring memory */
	struct i40e_virt_mem cmd_buf;	/* command buffer memory */

	union {
		struct i40e_dma_mem *asq_bi;
		struct i40e_dma_mem *arq_bi;
	} r;

	u16 count;		/* Number of descriptors */
	u16 rx_buf_len;		/* Admin Receive Queue buffer length */

	/* used for interrupt processing */
	u16 next_to_use;
	u16 next_to_clean;

	/* used for queue tracking */
	u32 head;
	u32 tail;
	u32 len;
	u32 bah;
	u32 bal;
};

/* ASQ transaction details */
struct i40e_asq_cmd_details {
	void *callback; /* cast from type I40E_ADMINQ_CALLBACK */
	u64 cookie;
	u16 flags_ena;
	u16 flags_dis;
	bool async;
	bool postpone;
};

#define I40E_ADMINQ_DETAILS(R, i)   \
	(&(((struct i40e_asq_cmd_details *)((R).cmd_buf.va))[i]))

/* ARQ event information */
struct i40e_arq_event_info {
	struct i40e_aq_desc desc;
	u16 msg_len;
	u16 buf_len;
	u8 *msg_buf;
};

/* Admin Queue information */
struct i40e_adminq_info {
	struct i40e_adminq_ring arq;    /* receive queue */
	struct i40e_adminq_ring asq;    /* send queue */
	u32 asq_cmd_timeout;            /* send queue cmd write back timeout*/
	u16 num_arq_entries;            /* receive queue depth */
	u16 num_asq_entries;            /* send queue depth */
	u16 arq_buf_size;               /* receive queue buffer size */
	u16 asq_buf_size;               /* send queue buffer size */
	u16 fw_maj_ver;                 /* firmware major version */
	u16 fw_min_ver;                 /* firmware minor version */
	u32 fw_build;                   /* firmware build number */
	u16 api_maj_ver;                /* api major version */
	u16 api_min_ver;                /* api minor version */
	bool nvm_release_on_done;

	struct mutex asq_mutex; /* Send queue lock */
	struct mutex arq_mutex; /* Receive queue lock */

	/* last status values on send and receive queues */
	enum i40e_admin_queue_err asq_last_status;
	enum i40e_admin_queue_err arq_last_status;
};

/**
 * i40e_aq_rc_to_posix - convert errors to user-land codes
 * aq_rc: AdminQ error code to convert
 **/
static inline int i40e_aq_rc_to_posix(u32 aq_ret, u16 aq_rc)
{
	int aq_to_posix[] = {
		0,           /* I40E_AQ_RC_OK */
		-EPERM,      /* I40E_AQ_RC_EPERM */
		-ENOENT,     /* I40E_AQ_RC_ENOENT */
		-ESRCH,      /* I40E_AQ_RC_ESRCH */
		-EINTR,      /* I40E_AQ_RC_EINTR */
		-EIO,        /* I40E_AQ_RC_EIO */
		-ENXIO,      /* I40E_AQ_RC_ENXIO */
		-E2BIG,      /* I40E_AQ_RC_E2BIG */
		-EAGAIN,     /* I40E_AQ_RC_EAGAIN */
		-ENOMEM,     /* I40E_AQ_RC_ENOMEM */
		-EACCES,     /* I40E_AQ_RC_EACCES */
		-EFAULT,     /* I40E_AQ_RC_EFAULT */
		-EBUSY,      /* I40E_AQ_RC_EBUSY */
		-EEXIST,     /* I40E_AQ_RC_EEXIST */
		-EINVAL,     /* I40E_AQ_RC_EINVAL */
		-ENOTTY,     /* I40E_AQ_RC_ENOTTY */
		-ENOSPC,     /* I40E_AQ_RC_ENOSPC */
		-ENOSYS,     /* I40E_AQ_RC_ENOSYS */
		-ERANGE,     /* I40E_AQ_RC_ERANGE */
		-EPIPE,      /* I40E_AQ_RC_EFLUSHED */
		-ESPIPE,     /* I40E_AQ_RC_BAD_ADDR */
		-EROFS,      /* I40E_AQ_RC_EMODE */
		-EFBIG,      /* I40E_AQ_RC_EFBIG */
	};

	/* aq_rc is invalid if AQ timed out */
	if (aq_ret == I40E_ERR_ADMIN_QUEUE_TIMEOUT)
		return -EAGAIN;

	if (aq_rc >= ARRAY_SIZE(aq_to_posix))
		return -ERANGE;
	return aq_to_posix[aq_rc];
}

/* general information */
#define I40E_AQ_LARGE_BUF	512
#define I40E_ASQ_CMD_TIMEOUT	250  /* msecs */

void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
				       u16 opcode);

#endif /* _I40E_ADMINQ_H_ */
Commit	Line	Data
56a62fc8 JB	1	/*******************************************************************************
	2	*
	3	* Intel Ethernet Controller XL710 Family Linux Driver
dc641b73	4	* Copyright(c) 2013 - 2014 Intel Corporation.
56a62fc8 JB	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms and conditions of the GNU General Public License,
	8	* version 2, as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
dc641b73 GR	15	* You should have received a copy of the GNU General Public License along
dc641b73 GR	16	* with this program. If not, see <http://www.gnu.org/licenses/>.
56a62fc8 JB	17	*
	18	* The full GNU General Public License is included in this distribution in
	19	* the file called "COPYING".
	20	*
	21	* Contact Information:
	22	* e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
	23	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	24	*
	25	******************************************************************************/
	26
	27	#ifndef _I40E_ADMINQ_H_
	28	#define _I40E_ADMINQ_H_
	29
	30	#include "i40e_osdep.h"
bf848f32	31	#include "i40e_status.h"
56a62fc8 JB	32	#include "i40e_adminq_cmd.h"
	33
	34	#define I40E_ADMINQ_DESC(R, i) \
90bb776a	35	(&(((struct i40e_aq_desc *)((R).desc_buf.va))[i]))
56a62fc8 JB	36
	37	#define I40E_ADMINQ_DESC_ALIGNMENT 4096
	38
	39	struct i40e_adminq_ring {
90bb776a DC	40	struct i40e_virt_mem dma_head; /* space for dma structures */
	41	struct i40e_dma_mem desc_buf; /* descriptor ring memory */
	42	struct i40e_virt_mem cmd_buf; /* command buffer memory */
56a62fc8 JB	43
	44	union {
	45	struct i40e_dma_mem *asq_bi;
	46	struct i40e_dma_mem *arq_bi;
	47	} r;
	48
56a62fc8 JB	49	u16 count; /* Number of descriptors */
	50	u16 rx_buf_len; /* Admin Receive Queue buffer length */
	51
	52	/* used for interrupt processing */
	53	u16 next_to_use;
	54	u16 next_to_clean;
	55
	56	/* used for queue tracking */
	57	u32 head;
	58	u32 tail;
17e6a845	59	u32 len;
87dc3464 SN	60	u32 bah;
87dc3464 SN	61	u32 bal;
56a62fc8 JB	62	};
	63
	64	/* ASQ transaction details */
	65	struct i40e_asq_cmd_details {
	66	void callback; / cast from type I40E_ADMINQ_CALLBACK */
	67	u64 cookie;
	68	u16 flags_ena;
	69	u16 flags_dis;
	70	bool async;
	71	bool postpone;
	72	};
	73
	74	#define I40E_ADMINQ_DETAILS(R, i) \
90bb776a	75	(&(((struct i40e_asq_cmd_details *)((R).cmd_buf.va))[i]))
56a62fc8 JB	76
	77	/* ARQ event information */
	78	struct i40e_arq_event_info {
	79	struct i40e_aq_desc desc;
1001dc37 MW	80	u16 msg_len;
1001dc37 MW	81	u16 buf_len;
56a62fc8 JB	82	u8 *msg_buf;
	83	};
	84
	85	/* Admin Queue information */
	86	struct i40e_adminq_info {
	87	struct i40e_adminq_ring arq; /* receive queue */
	88	struct i40e_adminq_ring asq; /* send queue */
09c4e56b	89	u32 asq_cmd_timeout; /* send queue cmd write back timeout*/
56a62fc8 JB	90	u16 num_arq_entries; /* receive queue depth */
	91	u16 num_asq_entries; /* send queue depth */
	92	u16 arq_buf_size; /* receive queue buffer size */
	93	u16 asq_buf_size; /* send queue buffer size */
	94	u16 fw_maj_ver; /* firmware major version */
	95	u16 fw_min_ver; /* firmware minor version */
7edf810c	96	u32 fw_build; /* firmware build number */
56a62fc8 JB	97	u16 api_maj_ver; /* api major version */
56a62fc8 JB	98	u16 api_min_ver; /* api minor version */
cd552cb4	99	bool nvm_release_on_done;
56a62fc8 JB	100
	101	struct mutex asq_mutex; /* Send queue lock */
	102	struct mutex arq_mutex; /* Receive queue lock */
	103
56a62fc8 JB	104	/* last status values on send and receive queues */
	105	enum i40e_admin_queue_err asq_last_status;
	106	enum i40e_admin_queue_err arq_last_status;
	107	};
	108
cd552cb4 SN	109	/**
	110	* i40e_aq_rc_to_posix - convert errors to user-land codes
	111	* aq_rc: AdminQ error code to convert
	112	**/
bf848f32	113	static inline int i40e_aq_rc_to_posix(u32 aq_ret, u16 aq_rc)
cd552cb4 SN	114	{
	115	int aq_to_posix[] = {
	116	0, /* I40E_AQ_RC_OK */
	117	-EPERM, /* I40E_AQ_RC_EPERM */
	118	-ENOENT, /* I40E_AQ_RC_ENOENT */
	119	-ESRCH, /* I40E_AQ_RC_ESRCH */
	120	-EINTR, /* I40E_AQ_RC_EINTR */
	121	-EIO, /* I40E_AQ_RC_EIO */
	122	-ENXIO, /* I40E_AQ_RC_ENXIO */
	123	-E2BIG, /* I40E_AQ_RC_E2BIG */
	124	-EAGAIN, /* I40E_AQ_RC_EAGAIN */
	125	-ENOMEM, /* I40E_AQ_RC_ENOMEM */
	126	-EACCES, /* I40E_AQ_RC_EACCES */
	127	-EFAULT, /* I40E_AQ_RC_EFAULT */
	128	-EBUSY, /* I40E_AQ_RC_EBUSY */
	129	-EEXIST, /* I40E_AQ_RC_EEXIST */
	130	-EINVAL, /* I40E_AQ_RC_EINVAL */
	131	-ENOTTY, /* I40E_AQ_RC_ENOTTY */
	132	-ENOSPC, /* I40E_AQ_RC_ENOSPC */
	133	-ENOSYS, /* I40E_AQ_RC_ENOSYS */
	134	-ERANGE, /* I40E_AQ_RC_ERANGE */
	135	-EPIPE, /* I40E_AQ_RC_EFLUSHED */
	136	-ESPIPE, /* I40E_AQ_RC_BAD_ADDR */
	137	-EROFS, /* I40E_AQ_RC_EMODE */
	138	-EFBIG, /* I40E_AQ_RC_EFBIG */
	139	};
	140
bf848f32 SN	141	/* aq_rc is invalid if AQ timed out */
	142	if (aq_ret == I40E_ERR_ADMIN_QUEUE_TIMEOUT)
	143	return -EAGAIN;
	144
43477d2b SN	145	if (aq_rc >= ARRAY_SIZE(aq_to_posix))
43477d2b SN	146	return -ERANGE;
cd552cb4 SN	147	return aq_to_posix[aq_rc];
	148	}
	149
56a62fc8 JB	150	/* general information */
56a62fc8 JB	151	#define I40E_AQ_LARGE_BUF 512
83c5fe77	152	#define I40E_ASQ_CMD_TIMEOUT 250 /* msecs */
56a62fc8 JB	153
	154	void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
	155	u16 opcode);
	156
	157	#endif /* _I40E_ADMINQ_H_ */