intel/ixgbevf/mbx.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright(c) 1999 - 2018 Intel Corporation. */
0003
0004 #ifndef _IXGBE_MBX_H_
0005 #define _IXGBE_MBX_H_
0006
0007 #include "vf.h"
0008
0009 #define IXGBE_VFMAILBOX_SIZE    16 /* 16 32 bit words - 64 bytes */
0010
0011 #define IXGBE_VFMAILBOX     0x002FC
0012 #define IXGBE_VFMBMEM       0x00200
0013
0014 /* Define mailbox register bits */
0015 #define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */
0016 #define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */
0017 #define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
0018 #define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
0019 #define IXGBE_VFMAILBOX_PFSTS   0x00000010 /* PF wrote a message in the MB */
0020 #define IXGBE_VFMAILBOX_PFACK   0x00000020 /* PF ack the previous VF msg */
0021 #define IXGBE_VFMAILBOX_RSTI    0x00000040 /* PF has reset indication */
0022 #define IXGBE_VFMAILBOX_RSTD    0x00000080 /* PF has indicated reset done */
0023 #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
0024
0025 #define IXGBE_PFMAILBOX(x)  (0x04B00 + (4 * (x)))
0026 #define IXGBE_PFMBMEM(vfn)  (0x13000 + (64 * (vfn)))
0027
0028 #define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */
0029 #define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */
0030 #define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
0031 #define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
0032 #define IXGBE_PFMAILBOX_RVFU    0x00000010 /* Reset VFU - used when VF stuck */
0033
0034 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
0035 #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
0036 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
0037 #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
0038
0039 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
0040  * PF.  The reverse is true if it is IXGBE_PF_*.
0041  * Message results are the value or'd with 0xF0000000
0042  */
0043 #define IXGBE_VT_MSGTYPE_SUCCESS    0x80000000 /* Messages or'd with this
0044                             * have succeeded
0045                             */
0046 #define IXGBE_VT_MSGTYPE_FAILURE    0x40000000 /* Messages or'd with this
0047                             * have failed
0048                             */
0049 #define IXGBE_VT_MSGTYPE_CTS        0x20000000 /* Indicates that VF is still
0050                             * clear to send requests
0051                             */
0052 #define IXGBE_VT_MSGINFO_SHIFT  16
0053 /* bits 23:16 are used for exra info for certain messages */
0054 #define IXGBE_VT_MSGINFO_MASK   (0xFF << IXGBE_VT_MSGINFO_SHIFT)
0055
0056 /* definitions to support mailbox API version negotiation */
0057
0058 /* each element denotes a version of the API; existing numbers may not
0059  * change; any additions must go at the end
0060  */
0061 enum ixgbe_pfvf_api_rev {
0062     ixgbe_mbox_api_10,  /* API version 1.0, linux/freebsd VF driver */
0063     ixgbe_mbox_api_20,  /* API version 2.0, solaris Phase1 VF driver */
0064     ixgbe_mbox_api_11,  /* API version 1.1, linux/freebsd VF driver */
0065     ixgbe_mbox_api_12,  /* API version 1.2, linux/freebsd VF driver */
0066     ixgbe_mbox_api_13,  /* API version 1.3, linux/freebsd VF driver */
0067     ixgbe_mbox_api_14,  /* API version 1.4, linux/freebsd VF driver */
0068     ixgbe_mbox_api_15,  /* API version 1.5, linux/freebsd VF driver */
0069     /* This value should always be last */
0070     ixgbe_mbox_api_unknown, /* indicates that API version is not known */
0071 };
0072
0073 /* mailbox API, legacy requests */
0074 #define IXGBE_VF_RESET      0x01 /* VF requests reset */
0075 #define IXGBE_VF_SET_MAC_ADDR   0x02 /* VF requests PF to set MAC addr */
0076 #define IXGBE_VF_SET_MULTICAST  0x03 /* VF requests PF to set MC addr */
0077 #define IXGBE_VF_SET_VLAN   0x04 /* VF requests PF to set VLAN */
0078
0079 /* mailbox API, version 1.0 VF requests */
0080 #define IXGBE_VF_SET_LPE    0x05 /* VF requests PF to set VMOLR.LPE */
0081 #define IXGBE_VF_SET_MACVLAN    0x06 /* VF requests PF for unicast filter */
0082 #define IXGBE_VF_API_NEGOTIATE  0x08 /* negotiate API version */
0083
0084 /* mailbox API, version 1.1 VF requests */
0085 #define IXGBE_VF_GET_QUEUE  0x09 /* get queue configuration */
0086
0087 /* GET_QUEUES return data indices within the mailbox */
0088 #define IXGBE_VF_TX_QUEUES  1 /* number of Tx queues supported */
0089 #define IXGBE_VF_RX_QUEUES  2 /* number of Rx queues supported */
0090 #define IXGBE_VF_TRANS_VLAN 3 /* Indication of port VLAN */
0091 #define IXGBE_VF_DEF_QUEUE  4 /* Default queue offset */
0092
0093 /* mailbox API, version 1.2 VF requests */
0094 #define IXGBE_VF_GET_RETA   0x0a    /* VF request for RETA */
0095 #define IXGBE_VF_GET_RSS_KEY    0x0b    /* get RSS hash key */
0096
0097 #define IXGBE_VF_UPDATE_XCAST_MODE  0x0c
0098
0099 /* mailbox API, version 1.4 VF requests */
0100 #define IXGBE_VF_IPSEC_ADD  0x0d
0101 #define IXGBE_VF_IPSEC_DEL  0x0e
0102
0103 #define IXGBE_VF_GET_LINK_STATE 0x10 /* get vf link state */
0104
0105 /* length of permanent address message returned from PF */
0106 #define IXGBE_VF_PERMADDR_MSG_LEN   4
0107 /* word in permanent address message with the current multicast type */
0108 #define IXGBE_VF_MC_TYPE_WORD       3
0109
0110 #define IXGBE_PF_CONTROL_MSG        0x0100 /* PF control message */
0111
0112 #define IXGBE_VF_MBX_INIT_TIMEOUT   2000 /* number of retries on mailbox */
0113 #define IXGBE_VF_MBX_INIT_DELAY     500  /* microseconds between retries */
0114
0115 /* forward declaration of the HW struct */
0116 struct ixgbe_hw;
0117
0118 #endif /* _IXGBE_MBX_H_ */