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