1215911Sjfv/****************************************************************************** 2215911Sjfv 3320897Serj Copyright (c) 2001-2017, Intel Corporation 4215911Sjfv All rights reserved. 5320897Serj 6320897Serj Redistribution and use in source and binary forms, with or without 7215911Sjfv modification, are permitted provided that the following conditions are met: 8320897Serj 9320897Serj 1. Redistributions of source code must retain the above copyright notice, 10215911Sjfv this list of conditions and the following disclaimer. 11320897Serj 12320897Serj 2. Redistributions in binary form must reproduce the above copyright 13320897Serj notice, this list of conditions and the following disclaimer in the 14215911Sjfv documentation and/or other materials provided with the distribution. 15320897Serj 16320897Serj 3. Neither the name of the Intel Corporation nor the names of its 17320897Serj contributors may be used to endorse or promote products derived from 18215911Sjfv this software without specific prior written permission. 19320897Serj 20215911Sjfv THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21320897Serj AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22320897Serj IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23320897Serj ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24320897Serj LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25320897Serj CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26320897Serj SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27320897Serj INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28320897Serj CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29215911Sjfv ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30215911Sjfv POSSIBILITY OF SUCH DAMAGE. 31215911Sjfv 32215911Sjfv******************************************************************************/ 33215911Sjfv/*$FreeBSD: stable/11/sys/dev/ixgbe/ixgbe_mbx.h 320897 2017-07-11 21:25:07Z erj $*/ 34215911Sjfv 35215911Sjfv#ifndef _IXGBE_MBX_H_ 36215911Sjfv#define _IXGBE_MBX_H_ 37215911Sjfv 38215911Sjfv#include "ixgbe_type.h" 39215911Sjfv 40230775Sjfv#define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ 41230775Sjfv#define IXGBE_ERR_MBX -100 42215911Sjfv 43230775Sjfv#define IXGBE_VFMAILBOX 0x002FC 44230775Sjfv#define IXGBE_VFMBMEM 0x00200 45215911Sjfv 46215911Sjfv/* Define mailbox register bits */ 47230775Sjfv#define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ 48230775Sjfv#define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */ 49230775Sjfv#define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 50230775Sjfv#define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 51230775Sjfv#define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ 52230775Sjfv#define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ 53230775Sjfv#define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */ 54230775Sjfv#define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ 55230775Sjfv#define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ 56215911Sjfv 57230775Sjfv#define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */ 58230775Sjfv#define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ 59230775Sjfv#define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 60230775Sjfv#define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 61230775Sjfv#define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ 62215911Sjfv 63230775Sjfv#define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */ 64230775Sjfv#define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ 65230775Sjfv#define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */ 66230775Sjfv#define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ 67215911Sjfv 68215911Sjfv 69215911Sjfv/* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the 70215911Sjfv * PF. The reverse is TRUE if it is IXGBE_PF_*. 71215911Sjfv * Message ACK's are the value or'd with 0xF0000000 72215911Sjfv */ 73230775Sjfv#define IXGBE_VT_MSGTYPE_ACK 0x80000000 /* Messages below or'd with 74230775Sjfv * this are the ACK */ 75230775Sjfv#define IXGBE_VT_MSGTYPE_NACK 0x40000000 /* Messages below or'd with 76230775Sjfv * this are the NACK */ 77230775Sjfv#define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still 78230775Sjfv * clear to send requests */ 79230775Sjfv#define IXGBE_VT_MSGINFO_SHIFT 16 80230775Sjfv/* bits 23:16 are used for extra info for certain messages */ 81230775Sjfv#define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT) 82215911Sjfv 83283883Sjfv/* definitions to support mailbox API version negotiation */ 84283883Sjfv 85283883Sjfv/* 86283883Sjfv * each element denotes a version of the API; existing numbers may not 87283883Sjfv * change; any additions must go at the end 88283883Sjfv */ 89283883Sjfvenum ixgbe_pfvf_api_rev { 90283883Sjfv ixgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */ 91283883Sjfv ixgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */ 92283883Sjfv ixgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */ 93320897Serj ixgbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */ 94320897Serj ixgbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */ 95283883Sjfv /* This value should always be last */ 96283883Sjfv ixgbe_mbox_api_unknown, /* indicates that API version is not known */ 97283883Sjfv}; 98283883Sjfv 99283883Sjfv/* mailbox API, legacy requests */ 100230775Sjfv#define IXGBE_VF_RESET 0x01 /* VF requests reset */ 101230775Sjfv#define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ 102230775Sjfv#define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ 103230775Sjfv#define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ 104247822Sjfv 105247822Sjfv/* mailbox API, version 1.0 VF requests */ 106230775Sjfv#define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ 107230775Sjfv#define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ 108247822Sjfv#define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 109215911Sjfv 110247822Sjfv/* mailbox API, version 1.1 VF requests */ 111247822Sjfv#define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 112247822Sjfv 113320897Serj/* mailbox API, version 1.2 VF requests */ 114320897Serj#define IXGBE_VF_GET_RETA 0x0a /* VF request for RETA */ 115320897Serj#define IXGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */ 116320897Serj#define IXGBE_VF_UPDATE_XCAST_MODE 0x0c 117320897Serj 118320897Serj/* mode choices for IXGBE_VF_UPDATE_XCAST_MODE */ 119320897Serjenum ixgbevf_xcast_modes { 120320897Serj IXGBEVF_XCAST_MODE_NONE = 0, 121320897Serj IXGBEVF_XCAST_MODE_MULTI, 122320897Serj IXGBEVF_XCAST_MODE_ALLMULTI, 123320897Serj IXGBEVF_XCAST_MODE_PROMISC, 124320897Serj}; 125320897Serj 126247822Sjfv/* GET_QUEUES return data indices within the mailbox */ 127247822Sjfv#define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ 128247822Sjfv#define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ 129247822Sjfv#define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ 130247822Sjfv#define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ 131247822Sjfv 132215911Sjfv/* length of permanent address message returned from PF */ 133230775Sjfv#define IXGBE_VF_PERMADDR_MSG_LEN 4 134215911Sjfv/* word in permanent address message with the current multicast type */ 135230775Sjfv#define IXGBE_VF_MC_TYPE_WORD 3 136215911Sjfv 137230775Sjfv#define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */ 138215911Sjfv 139283883Sjfv/* mailbox API, version 2.0 VF requests */ 140283883Sjfv#define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 141283883Sjfv#define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 142283883Sjfv#define IXGBE_VF_ENABLE_MACADDR 0x0A /* enable MAC address */ 143283883Sjfv#define IXGBE_VF_DISABLE_MACADDR 0x0B /* disable MAC address */ 144283883Sjfv#define IXGBE_VF_GET_MACADDRS 0x0C /* get all configured MAC addrs */ 145283883Sjfv#define IXGBE_VF_SET_MCAST_PROMISC 0x0D /* enable multicast promiscuous */ 146283883Sjfv#define IXGBE_VF_GET_MTU 0x0E /* get bounds on MTU */ 147283883Sjfv#define IXGBE_VF_SET_MTU 0x0F /* set a specific MTU */ 148215911Sjfv 149283883Sjfv/* mailbox API, version 2.0 PF requests */ 150283883Sjfv#define IXGBE_PF_TRANSPARENT_VLAN 0x0101 /* enable transparent vlan */ 151283883Sjfv 152230775Sjfv#define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ 153230775Sjfv#define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ 154230775Sjfv 155215911Sjfvvoid ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw); 156215911Sjfvvoid ixgbe_init_mbx_params_vf(struct ixgbe_hw *); 157215911Sjfvvoid ixgbe_init_mbx_params_pf(struct ixgbe_hw *); 158215911Sjfv 159215911Sjfv#endif /* _IXGBE_MBX_H_ */ 160