1/* SPDX-License-Identifier: GPL-2.0 */
 2/* Copyright (c) 2018, Intel Corporation. */
 3
 4#ifndef _ICE_CONTROLQ_H_
 5#define _ICE_CONTROLQ_H_
 6
 7#include "ice_adminq_cmd.h"
 8
 9/* Maximum buffer lengths for all control queue types */
10#define ICE_AQ_MAX_BUF_LEN 4096
11
12#define ICE_CTL_Q_DESC(R, i) \
13	(&(((struct ice_aq_desc *)((R).desc_buf.va))[i]))
14
15#define ICE_CTL_Q_DESC_UNUSED(R) \
16	(u16)((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
17	      (R)->next_to_clean - (R)->next_to_use - 1)
18
19/* Defines that help manage the driver vs FW API checks.
20 * Take a look at ice_aq_ver_check in ice_controlq.c for actual usage.
21 *
22 */
23#define EXP_FW_API_VER_BRANCH		0x00
24#define EXP_FW_API_VER_MAJOR		0x00
25#define EXP_FW_API_VER_MINOR		0x01
26
27/* Different control queue types: These are mainly for SW consumption. */
28enum ice_ctl_q {
29	ICE_CTL_Q_UNKNOWN = 0,
30	ICE_CTL_Q_ADMIN,
31};
32
33/* Control Queue default settings */
34#define ICE_CTL_Q_SQ_CMD_TIMEOUT	250  /* msecs */
35
36struct ice_ctl_q_ring {
37	void *dma_head;			/* Virtual address to dma head */
38	struct ice_dma_mem desc_buf;	/* descriptor ring memory */
39	void *cmd_buf;			/* command buffer memory */
40
41	union {
42		struct ice_dma_mem *sq_bi;
43		struct ice_dma_mem *rq_bi;
44	} r;
45
46	u16 count;		/* Number of descriptors */
47
48	/* used for interrupt processing */
49	u16 next_to_use;
50	u16 next_to_clean;
51
52	/* used for queue tracking */
53	u32 head;
54	u32 tail;
55	u32 len;
56	u32 bah;
57	u32 bal;
58	u32 len_mask;
59	u32 len_ena_mask;
60	u32 head_mask;
61};
62
63/* sq transaction details */
64struct ice_sq_cd {
65	struct ice_aq_desc *wb_desc;
66};
67
68#define ICE_CTL_Q_DETAILS(R, i) (&(((struct ice_sq_cd *)((R).cmd_buf))[i]))
69
70/* rq event information */
71struct ice_rq_event_info {
72	struct ice_aq_desc desc;
73	u16 msg_len;
74	u16 buf_len;
75	u8 *msg_buf;
76};
77
78/* Control Queue information */
79struct ice_ctl_q_info {
80	enum ice_ctl_q qtype;
81	struct ice_ctl_q_ring rq;	/* receive queue */
82	struct ice_ctl_q_ring sq;	/* send queue */
83	u32 sq_cmd_timeout;		/* send queue cmd write back timeout */
84	u16 num_rq_entries;		/* receive queue depth */
85	u16 num_sq_entries;		/* send queue depth */
86	u16 rq_buf_size;		/* receive queue buffer size */
87	u16 sq_buf_size;		/* send queue buffer size */
88	struct mutex sq_lock;		/* Send queue lock */
89	struct mutex rq_lock;		/* Receive queue lock */
90	enum ice_aq_err sq_last_status;	/* last status on send queue */
91	enum ice_aq_err rq_last_status;	/* last status on receive queue */
92};
93
94#endif /* _ICE_CONTROLQ_H_ */