1/* SPDX-License-Identifier: BSD-3-Clause */
2/*  Copyright (c) 2024, Intel Corporation
3 *  All rights reserved.
4 *
5 *  Redistribution and use in source and binary forms, with or without
6 *  modification, are permitted provided that the following conditions are met:
7 *
8 *   1. Redistributions of source code must retain the above copyright notice,
9 *      this list of conditions and the following disclaimer.
10 *
11 *   2. Redistributions in binary form must reproduce the above copyright
12 *      notice, this list of conditions and the following disclaimer in the
13 *      documentation and/or other materials provided with the distribution.
14 *
15 *   3. Neither the name of the Intel Corporation nor the names of its
16 *      contributors may be used to endorse or promote products derived from
17 *      this software without specific prior written permission.
18 *
19 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 *  POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _ICE_CONTROLQ_H_
33#define _ICE_CONTROLQ_H_
34
35#include "ice_adminq_cmd.h"
36
37/* Maximum buffer lengths for all control queue types */
38#define ICE_AQ_MAX_BUF_LEN 4096
39#define ICE_MBXQ_MAX_BUF_LEN 4096
40
41#define ICE_CTL_Q_DESC(R, i) \
42	(&(((struct ice_aq_desc *)((R).desc_buf.va))[i]))
43
44#define ICE_CTL_Q_DESC_UNUSED(R) \
45	((u16)((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
46	       (R)->next_to_clean - (R)->next_to_use - 1))
47
48/* Defines that help manage the driver vs FW API checks.
49 * Take a look at ice_aq_ver_check in ice_controlq.c for actual usage.
50 */
51#define EXP_FW_API_VER_BRANCH		0x00
52#define EXP_FW_API_VER_MAJOR		0x01
53#define EXP_FW_API_VER_MINOR		0x05
54
55/* Different control queue types: These are mainly for SW consumption. */
56enum ice_ctl_q {
57	ICE_CTL_Q_UNKNOWN = 0,
58	ICE_CTL_Q_ADMIN,
59	ICE_CTL_Q_MAILBOX,
60};
61
62/* Control Queue timeout settings - max delay 1s */
63#define ICE_CTL_Q_SQ_CMD_TIMEOUT	100000	/* Count 100000 times */
64#define ICE_CTL_Q_ADMIN_INIT_TIMEOUT	10    /* Count 10 times */
65#define ICE_CTL_Q_ADMIN_INIT_MSEC	100   /* Check every 100msec */
66
67struct ice_ctl_q_ring {
68	void *dma_head;			/* Virtual address to DMA head */
69	struct ice_dma_mem desc_buf;	/* descriptor ring memory */
70
71	union {
72		struct ice_dma_mem *sq_bi;
73		struct ice_dma_mem *rq_bi;
74	} r;
75
76	u16 count;		/* Number of descriptors */
77
78	/* used for interrupt processing */
79	u16 next_to_use;
80	u16 next_to_clean;
81
82	/* used for queue tracking */
83	u32 head;
84	u32 tail;
85	u32 len;
86	u32 bah;
87	u32 bal;
88	u32 len_mask;
89	u32 len_ena_mask;
90	u32 len_crit_mask;
91	u32 head_mask;
92};
93
94/* sq transaction details */
95struct ice_sq_cd {
96	struct ice_aq_desc *wb_desc;
97};
98
99/* rq event information */
100struct ice_rq_event_info {
101	struct ice_aq_desc desc;
102	u16 msg_len;
103	u16 buf_len;
104	u8 *msg_buf;
105};
106
107/* Control Queue information */
108struct ice_ctl_q_info {
109	enum ice_ctl_q qtype;
110	struct ice_ctl_q_ring rq;	/* receive queue */
111	struct ice_ctl_q_ring sq;	/* send queue */
112	u32 sq_cmd_timeout;		/* send queue cmd write back timeout */
113	u16 num_rq_entries;		/* receive queue depth */
114	u16 num_sq_entries;		/* send queue depth */
115	u16 rq_buf_size;		/* receive queue buffer size */
116	u16 sq_buf_size;		/* send queue buffer size */
117	enum ice_aq_err sq_last_status;	/* last status on send queue */
118	struct ice_lock sq_lock;		/* Send queue lock */
119	struct ice_lock rq_lock;		/* Receive queue lock */
120};
121
122#endif /* _ICE_CONTROLQ_H_ */
123