1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* Copyright (c) 2023, 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. */ 56 enum 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 10000 /* Count 10000 times */ 64 #define ICE_CTL_Q_SQ_CMD_USEC 100 /* Check every 100usec */ 65 #define ICE_CTL_Q_ADMIN_INIT_TIMEOUT 10 /* Count 10 times */ 66 #define ICE_CTL_Q_ADMIN_INIT_MSEC 100 /* Check every 100msec */ 67 68 struct ice_ctl_q_ring { 69 void *dma_head; /* Virtual address to DMA head */ 70 struct ice_dma_mem desc_buf; /* descriptor ring memory */ 71 void *cmd_buf; /* command buffer memory */ 72 73 union { 74 struct ice_dma_mem *sq_bi; 75 struct ice_dma_mem *rq_bi; 76 } r; 77 78 u16 count; /* Number of descriptors */ 79 80 /* used for interrupt processing */ 81 u16 next_to_use; 82 u16 next_to_clean; 83 84 /* used for queue tracking */ 85 u32 head; 86 u32 tail; 87 u32 len; 88 u32 bah; 89 u32 bal; 90 u32 len_mask; 91 u32 len_ena_mask; 92 u32 len_crit_mask; 93 u32 head_mask; 94 }; 95 96 /* sq transaction details */ 97 struct ice_sq_cd { 98 struct ice_aq_desc *wb_desc; 99 }; 100 101 #define ICE_CTL_Q_DETAILS(R, i) (&(((struct ice_sq_cd *)((R).cmd_buf))[i])) 102 103 /* rq event information */ 104 struct ice_rq_event_info { 105 struct ice_aq_desc desc; 106 u16 msg_len; 107 u16 buf_len; 108 u8 *msg_buf; 109 }; 110 111 /* Control Queue information */ 112 struct ice_ctl_q_info { 113 enum ice_ctl_q qtype; 114 struct ice_ctl_q_ring rq; /* receive queue */ 115 struct ice_ctl_q_ring sq; /* send queue */ 116 u32 sq_cmd_timeout; /* send queue cmd write back timeout */ 117 u16 num_rq_entries; /* receive queue depth */ 118 u16 num_sq_entries; /* send queue depth */ 119 u16 rq_buf_size; /* receive queue buffer size */ 120 u16 sq_buf_size; /* send queue buffer size */ 121 enum ice_aq_err sq_last_status; /* last status on send queue */ 122 struct ice_lock sq_lock; /* Send queue lock */ 123 struct ice_lock rq_lock; /* Receive queue lock */ 124 }; 125 126 #endif /* _ICE_CONTROLQ_H_ */ 127