169b5a878SDan McDonald /****************************************************************************** 2*48ed61a7SRobert Mustacchi SPDX-License-Identifier: BSD-3-Clause 369b5a878SDan McDonald 4*48ed61a7SRobert Mustacchi Copyright (c) 2001-2017, Intel Corporation 569b5a878SDan McDonald All rights reserved. 6*48ed61a7SRobert Mustacchi 7*48ed61a7SRobert Mustacchi Redistribution and use in source and binary forms, with or without 869b5a878SDan McDonald modification, are permitted provided that the following conditions are met: 9*48ed61a7SRobert Mustacchi 10*48ed61a7SRobert Mustacchi 1. Redistributions of source code must retain the above copyright notice, 1169b5a878SDan McDonald this list of conditions and the following disclaimer. 12*48ed61a7SRobert Mustacchi 13*48ed61a7SRobert Mustacchi 2. Redistributions in binary form must reproduce the above copyright 14*48ed61a7SRobert Mustacchi notice, this list of conditions and the following disclaimer in the 1569b5a878SDan McDonald documentation and/or other materials provided with the distribution. 16*48ed61a7SRobert Mustacchi 17*48ed61a7SRobert Mustacchi 3. Neither the name of the Intel Corporation nor the names of its 18*48ed61a7SRobert Mustacchi contributors may be used to endorse or promote products derived from 1969b5a878SDan McDonald this software without specific prior written permission. 20*48ed61a7SRobert Mustacchi 2169b5a878SDan McDonald THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22*48ed61a7SRobert Mustacchi AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23*48ed61a7SRobert Mustacchi IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24*48ed61a7SRobert Mustacchi ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25*48ed61a7SRobert Mustacchi LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26*48ed61a7SRobert Mustacchi CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27*48ed61a7SRobert Mustacchi SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28*48ed61a7SRobert Mustacchi INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29*48ed61a7SRobert Mustacchi CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 3069b5a878SDan McDonald ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3169b5a878SDan McDonald POSSIBILITY OF SUCH DAMAGE. 3269b5a878SDan McDonald 3369b5a878SDan McDonald ******************************************************************************/ 3469b5a878SDan McDonald /*$FreeBSD$*/ 3569b5a878SDan McDonald 3669b5a878SDan McDonald #ifndef _IXGBE_MBX_H_ 3769b5a878SDan McDonald #define _IXGBE_MBX_H_ 3869b5a878SDan McDonald 3969b5a878SDan McDonald #include "ixgbe_type.h" 4069b5a878SDan McDonald 4169b5a878SDan McDonald #define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ 4269b5a878SDan McDonald #define IXGBE_ERR_MBX -100 4369b5a878SDan McDonald 4469b5a878SDan McDonald #define IXGBE_VFMAILBOX 0x002FC 4569b5a878SDan McDonald #define IXGBE_VFMBMEM 0x00200 4669b5a878SDan McDonald 4769b5a878SDan McDonald /* Define mailbox register bits */ 4869b5a878SDan McDonald #define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ 4969b5a878SDan McDonald #define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */ 5069b5a878SDan McDonald #define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 5169b5a878SDan McDonald #define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 5269b5a878SDan McDonald #define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ 5369b5a878SDan McDonald #define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ 5469b5a878SDan McDonald #define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */ 5569b5a878SDan McDonald #define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ 5669b5a878SDan McDonald #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ 5769b5a878SDan McDonald 5869b5a878SDan McDonald #define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */ 5969b5a878SDan McDonald #define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ 6069b5a878SDan McDonald #define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 6169b5a878SDan McDonald #define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 6269b5a878SDan McDonald #define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ 6369b5a878SDan McDonald 6469b5a878SDan McDonald #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */ 6569b5a878SDan McDonald #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ 6669b5a878SDan McDonald #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */ 6769b5a878SDan McDonald #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ 6869b5a878SDan McDonald 6969b5a878SDan McDonald 7069b5a878SDan McDonald /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the 7169b5a878SDan McDonald * PF. The reverse is TRUE if it is IXGBE_PF_*. 7269b5a878SDan McDonald * Message ACK's are the value or'd with 0xF0000000 7369b5a878SDan McDonald */ 7469b5a878SDan McDonald #define IXGBE_VT_MSGTYPE_ACK 0x80000000 /* Messages below or'd with 7569b5a878SDan McDonald * this are the ACK */ 7669b5a878SDan McDonald #define IXGBE_VT_MSGTYPE_NACK 0x40000000 /* Messages below or'd with 7769b5a878SDan McDonald * this are the NACK */ 7869b5a878SDan McDonald #define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still 7969b5a878SDan McDonald * clear to send requests */ 8069b5a878SDan McDonald #define IXGBE_VT_MSGINFO_SHIFT 16 8169b5a878SDan McDonald /* bits 23:16 are used for extra info for certain messages */ 8269b5a878SDan McDonald #define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT) 8369b5a878SDan McDonald 84dc0cb1cdSDale Ghent /* definitions to support mailbox API version negotiation */ 85dc0cb1cdSDale Ghent 86dc0cb1cdSDale Ghent /* 87dc0cb1cdSDale Ghent * each element denotes a version of the API; existing numbers may not 88dc0cb1cdSDale Ghent * change; any additions must go at the end 89dc0cb1cdSDale Ghent */ 90dc0cb1cdSDale Ghent enum ixgbe_pfvf_api_rev { 91dc0cb1cdSDale Ghent ixgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */ 92dc0cb1cdSDale Ghent ixgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */ 93dc0cb1cdSDale Ghent ixgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */ 94*48ed61a7SRobert Mustacchi ixgbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */ 95*48ed61a7SRobert Mustacchi ixgbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */ 96dc0cb1cdSDale Ghent /* This value should always be last */ 97dc0cb1cdSDale Ghent ixgbe_mbox_api_unknown, /* indicates that API version is not known */ 98dc0cb1cdSDale Ghent }; 99dc0cb1cdSDale Ghent 100dc0cb1cdSDale Ghent /* mailbox API, legacy requests */ 10169b5a878SDan McDonald #define IXGBE_VF_RESET 0x01 /* VF requests reset */ 10269b5a878SDan McDonald #define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ 10369b5a878SDan McDonald #define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ 10469b5a878SDan McDonald #define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ 105dc0cb1cdSDale Ghent 106dc0cb1cdSDale Ghent /* mailbox API, version 1.0 VF requests */ 10769b5a878SDan McDonald #define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ 10869b5a878SDan McDonald #define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ 109dc0cb1cdSDale Ghent #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 110dc0cb1cdSDale Ghent 111dc0cb1cdSDale Ghent /* mailbox API, version 1.1 VF requests */ 112dc0cb1cdSDale Ghent #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 113dc0cb1cdSDale Ghent 114*48ed61a7SRobert Mustacchi /* mailbox API, version 1.2 VF requests */ 115*48ed61a7SRobert Mustacchi #define IXGBE_VF_GET_RETA 0x0a /* VF request for RETA */ 116*48ed61a7SRobert Mustacchi #define IXGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */ 117*48ed61a7SRobert Mustacchi #define IXGBE_VF_UPDATE_XCAST_MODE 0x0c 118*48ed61a7SRobert Mustacchi 119*48ed61a7SRobert Mustacchi /* mode choices for IXGBE_VF_UPDATE_XCAST_MODE */ 120*48ed61a7SRobert Mustacchi enum ixgbevf_xcast_modes { 121*48ed61a7SRobert Mustacchi IXGBEVF_XCAST_MODE_NONE = 0, 122*48ed61a7SRobert Mustacchi IXGBEVF_XCAST_MODE_MULTI, 123*48ed61a7SRobert Mustacchi IXGBEVF_XCAST_MODE_ALLMULTI, 124*48ed61a7SRobert Mustacchi IXGBEVF_XCAST_MODE_PROMISC, 125*48ed61a7SRobert Mustacchi }; 126*48ed61a7SRobert Mustacchi 127dc0cb1cdSDale Ghent /* GET_QUEUES return data indices within the mailbox */ 128dc0cb1cdSDale Ghent #define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ 129dc0cb1cdSDale Ghent #define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ 130dc0cb1cdSDale Ghent #define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ 131dc0cb1cdSDale Ghent #define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ 13269b5a878SDan McDonald 13369b5a878SDan McDonald /* length of permanent address message returned from PF */ 13469b5a878SDan McDonald #define IXGBE_VF_PERMADDR_MSG_LEN 4 13569b5a878SDan McDonald /* word in permanent address message with the current multicast type */ 13669b5a878SDan McDonald #define IXGBE_VF_MC_TYPE_WORD 3 13769b5a878SDan McDonald 13869b5a878SDan McDonald #define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */ 13969b5a878SDan McDonald 140dc0cb1cdSDale Ghent /* mailbox API, version 2.0 VF requests */ 141dc0cb1cdSDale Ghent #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 142dc0cb1cdSDale Ghent #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 143dc0cb1cdSDale Ghent #define IXGBE_VF_ENABLE_MACADDR 0x0A /* enable MAC address */ 144dc0cb1cdSDale Ghent #define IXGBE_VF_DISABLE_MACADDR 0x0B /* disable MAC address */ 145dc0cb1cdSDale Ghent #define IXGBE_VF_GET_MACADDRS 0x0C /* get all configured MAC addrs */ 146dc0cb1cdSDale Ghent #define IXGBE_VF_SET_MCAST_PROMISC 0x0D /* enable multicast promiscuous */ 147dc0cb1cdSDale Ghent #define IXGBE_VF_GET_MTU 0x0E /* get bounds on MTU */ 148dc0cb1cdSDale Ghent #define IXGBE_VF_SET_MTU 0x0F /* set a specific MTU */ 149dc0cb1cdSDale Ghent 150dc0cb1cdSDale Ghent /* mailbox API, version 2.0 PF requests */ 151dc0cb1cdSDale Ghent #define IXGBE_PF_TRANSPARENT_VLAN 0x0101 /* enable transparent vlan */ 15269b5a878SDan McDonald 15369b5a878SDan McDonald #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ 15469b5a878SDan McDonald #define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ 15569b5a878SDan McDonald 15669b5a878SDan McDonald void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw); 15769b5a878SDan McDonald void ixgbe_init_mbx_params_vf(struct ixgbe_hw *); 15869b5a878SDan McDonald void ixgbe_init_mbx_params_pf(struct ixgbe_hw *); 15969b5a878SDan McDonald 16069b5a878SDan McDonald #endif /* _IXGBE_MBX_H_ */ 161