1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
5 #ifndef _ICE_CONTROLQ_H_
6 #define _ICE_CONTROLQ_H_
8 #include "ice_adminq_cmd.h"
11 /* Maximum buffer lengths for all control queue types */
12 #define ICE_AQ_MAX_BUF_LEN 4096
13 #define ICE_MBXQ_MAX_BUF_LEN 4096
15 #define ICE_CTL_Q_DESC(R, i) \
16 (&(((struct ice_aq_desc *)((R).desc_buf.va))[i]))
18 #define ICE_CTL_Q_DESC_UNUSED(R) \
19 (u16)((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
20 (R)->next_to_clean - (R)->next_to_use - 1)
22 /* Defines that help manage the driver vs FW API checks.
23 * Take a look at ice_aq_ver_check in ice_controlq.c for actual usage.
25 #define EXP_FW_API_VER_BRANCH 0x00
26 #define EXP_FW_API_VER_MAJOR 0x01
27 #define EXP_FW_API_VER_MINOR 0x03
29 /* Different control queue types: These are mainly for SW consumption. */
31 ICE_CTL_Q_UNKNOWN = 0,
36 /* Control Queue default settings */
37 #define ICE_CTL_Q_SQ_CMD_TIMEOUT 250 /* msecs */
39 struct ice_ctl_q_ring {
40 void *dma_head; /* Virtual address to dma head */
41 struct ice_dma_mem desc_buf; /* descriptor ring memory */
42 void *cmd_buf; /* command buffer memory */
45 struct ice_dma_mem *sq_bi;
46 struct ice_dma_mem *rq_bi;
49 u16 count; /* Number of descriptors */
51 /* used for interrupt processing */
55 /* used for queue tracking */
66 /* sq transaction details */
68 struct ice_aq_desc *wb_desc;
71 #define ICE_CTL_Q_DETAILS(R, i) (&(((struct ice_sq_cd *)((R).cmd_buf))[i]))
73 /* rq event information */
74 struct ice_rq_event_info {
75 struct ice_aq_desc desc;
81 /* Control Queue information */
82 struct ice_ctl_q_info {
84 enum ice_aq_err rq_last_status; /* last status on receive queue */
85 struct ice_ctl_q_ring rq; /* receive queue */
86 struct ice_ctl_q_ring sq; /* send queue */
87 u32 sq_cmd_timeout; /* send queue cmd write back timeout */
88 u16 num_rq_entries; /* receive queue depth */
89 u16 num_sq_entries; /* send queue depth */
90 u16 rq_buf_size; /* receive queue buffer size */
91 u16 sq_buf_size; /* send queue buffer size */
92 enum ice_aq_err sq_last_status; /* last status on send queue */
93 struct ice_lock sq_lock; /* Send queue lock */
94 struct ice_lock rq_lock; /* Receive queue lock */
97 #endif /* _ICE_CONTROLQ_H_ */