ixgbe_mbx.h revision 1.17
1 /* $NetBSD: ixgbe_mbx.h,v 1.17 2021/12/24 05:02:11 msaitoh Exp $ */ 2 3 /****************************************************************************** 4 SPDX-License-Identifier: BSD-3-Clause 5 6 Copyright (c) 2001-2020, Intel Corporation 7 All rights reserved. 8 9 Redistribution and use in source and binary forms, with or without 10 modification, are permitted provided that the following conditions are met: 11 12 1. Redistributions of source code must retain the above copyright notice, 13 this list of conditions and the following disclaimer. 14 15 2. Redistributions in binary form must reproduce the above copyright 16 notice, this list of conditions and the following disclaimer in the 17 documentation and/or other materials provided with the distribution. 18 19 3. Neither the name of the Intel Corporation nor the names of its 20 contributors may be used to endorse or promote products derived from 21 this software without specific prior written permission. 22 23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 POSSIBILITY OF SUCH DAMAGE. 34 35 ******************************************************************************/ 36 /*$FreeBSD: head/sys/dev/ixgbe/ixgbe_mbx.h 326022 2017-11-20 19:36:21Z pfg $*/ 37 38 #ifndef _IXGBE_MBX_H_ 39 #define _IXGBE_MBX_H_ 40 41 #include "ixgbe_type.h" 42 43 struct ixgbe_mbx_operations { 44 void (*init_params)(struct ixgbe_hw *hw); 45 s32 (*read)(struct ixgbe_hw *, u32 *, u16, u16); 46 s32 (*write)(struct ixgbe_hw *, u32 *, u16, u16); 47 s32 (*read_posted)(struct ixgbe_hw *, u32 *, u16, u16); 48 s32 (*write_posted)(struct ixgbe_hw *, u32 *, u16, u16); 49 s32 (*check_for_msg)(struct ixgbe_hw *, u16); 50 s32 (*check_for_ack)(struct ixgbe_hw *, u16); 51 s32 (*check_for_rst)(struct ixgbe_hw *, u16); 52 s32 (*clear)(struct ixgbe_hw *hw, u16 vf_number); 53 }; 54 55 struct ixgbe_mbx_stats { 56 struct evcnt msgs_tx; 57 struct evcnt msgs_rx; 58 59 struct evcnt acks; 60 struct evcnt reqs; 61 struct evcnt rsts; 62 }; 63 64 struct ixgbe_mbx_info { 65 struct ixgbe_mbx_operations ops; 66 struct ixgbe_mbx_stats stats; 67 u32 timeout; 68 u32 usec_delay; 69 u32 v2p_mailbox; 70 u16 size; 71 }; 72 73 #define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ 74 75 #define IXGBE_VFMAILBOX 0x002FC 76 #define IXGBE_VFMBMEM 0x00200 77 78 /* Define mailbox register bits */ 79 #define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ 80 #define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */ 81 #define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 82 #define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 83 #define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ 84 #define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ 85 #define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */ 86 #define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ 87 #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ 88 89 #define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */ 90 #define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ 91 #define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 92 #define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 93 #define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ 94 95 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */ 96 #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ 97 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */ 98 #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ 99 100 101 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the 102 * PF. The reverse is TRUE if it is IXGBE_PF_*. 103 * Message results are the value or'd with 0xF0000000 104 */ 105 #define IXGBE_VT_MSGTYPE_SUCCESS 0x80000000 /* Messages or'd with this 106 * have succeeded 107 */ 108 #define IXGBE_VT_MSGTYPE_FAILURE 0x40000000 /* Messages or'd with this 109 * have failed 110 */ 111 #define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still 112 * clear to send requests 113 */ 114 #define IXGBE_VT_MSGINFO_SHIFT 16 115 /* bits 23:16 are used for extra info for certain messages */ 116 #define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT) 117 118 /* definitions to support mailbox API version negotiation */ 119 120 /* 121 * each element denotes a version of the API; existing numbers may not 122 * change; any additions must go at the end 123 */ 124 enum ixgbe_pfvf_api_rev { 125 ixgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */ 126 ixgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */ 127 ixgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */ 128 ixgbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */ 129 ixgbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */ 130 /* This value should always be last */ 131 ixgbe_mbox_api_unknown, /* indicates that API version is not known */ 132 }; 133 134 /* mailbox API, legacy requests */ 135 #define IXGBE_VF_RESET 0x01 /* VF requests reset */ 136 #define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ 137 #define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ 138 #define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ 139 140 /* mailbox API, version 1.0 VF requests */ 141 #define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ 142 #define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ 143 #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 144 145 /* mailbox API, version 1.1 VF requests */ 146 #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 147 148 /* mailbox API, version 1.2 VF requests */ 149 #define IXGBE_VF_GET_RETA 0x0a /* VF request for RETA */ 150 #define IXGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */ 151 #define IXGBE_VF_UPDATE_XCAST_MODE 0x0c 152 153 /* mode choices for IXGBE_VF_UPDATE_XCAST_MODE */ 154 enum ixgbevf_xcast_modes { 155 IXGBEVF_XCAST_MODE_NONE = 0, 156 IXGBEVF_XCAST_MODE_MULTI, 157 IXGBEVF_XCAST_MODE_ALLMULTI, 158 IXGBEVF_XCAST_MODE_PROMISC, 159 }; 160 161 /* GET_QUEUES return data indices within the mailbox */ 162 #define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ 163 #define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ 164 #define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ 165 #define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ 166 167 /* length of permanent address message returned from PF */ 168 #define IXGBE_VF_PERMADDR_MSG_LEN 4 169 /* word in permanent address message with the current multicast type */ 170 #define IXGBE_VF_MC_TYPE_WORD 3 171 172 #define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */ 173 174 /* mailbox API, version 2.0 VF requests */ 175 #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 176 #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 177 #define IXGBE_VF_ENABLE_MACADDR 0x0A /* enable MAC address */ 178 #define IXGBE_VF_DISABLE_MACADDR 0x0B /* disable MAC address */ 179 #define IXGBE_VF_GET_MACADDRS 0x0C /* get all configured MAC addrs */ 180 #define IXGBE_VF_SET_MCAST_PROMISC 0x0D /* enable multicast promiscuous */ 181 #define IXGBE_VF_GET_MTU 0x0E /* get bounds on MTU */ 182 #define IXGBE_VF_SET_MTU 0x0F /* set a specific MTU */ 183 184 /* mailbox API, version 2.0 PF requests */ 185 #define IXGBE_PF_TRANSPARENT_VLAN 0x0101 /* enable transparent vlan */ 186 187 #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ 188 #define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ 189 190 s32 ixgbe_clear_mbx(struct ixgbe_hw *hw, u16 vf_number); 191 void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw); 192 void ixgbe_init_mbx_params_vf(struct ixgbe_hw *); 193 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *); 194 195 #endif /* _IXGBE_MBX_H_ */ 196
Indexes created Tue Sep 30 11:09:46 GMT 2025