intel/ixgbe/ixgbe_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 "ixgbe_type.h"
0008
0009 #define IXGBE_VFMAILBOX_SIZE        16 /* 16 32 bit words - 64 bytes */
0010 #define IXGBE_ERR_MBX               -100
0011
0012 #define IXGBE_VFMAILBOX             0x002FC
0013 #define IXGBE_VFMBMEM               0x00200
0014
0015 #define IXGBE_PFMAILBOX_STS   0x00000001 /* Initiate message send to VF */
0016 #define IXGBE_PFMAILBOX_ACK   0x00000002 /* Ack message recv'd from VF */
0017 #define IXGBE_PFMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
0018 #define IXGBE_PFMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
0019 #define IXGBE_PFMAILBOX_RVFU  0x00000010 /* Reset VFU - used when VF stuck */
0020
0021 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
0022 #define IXGBE_MBVFICR_VFREQ_VF1  0x00000001 /* bit for VF 1 message */
0023 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
0024 #define IXGBE_MBVFICR_VFACK_VF1  0x00010000 /* bit for VF 1 ack */
0025
0026
0027 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
0028  * PF.  The reverse is true if it is IXGBE_PF_*.
0029  * Message ACK's are the value or'd with 0xF0000000
0030  */
0031 #define IXGBE_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
0032                            * this are the ACK */
0033 #define IXGBE_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
0034                            * this are the NACK */
0035 #define IXGBE_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
0036                          clear to send requests */
0037 #define IXGBE_VT_MSGINFO_SHIFT    16
0038 /* bits 23:16 are used for exra info for certain messages */
0039 #define IXGBE_VT_MSGINFO_MASK     (0xFF << IXGBE_VT_MSGINFO_SHIFT)
0040
0041 /* definitions to support mailbox API version negotiation */
0042
0043 /*
0044  * Each element denotes a version of the API; existing numbers may not
0045  * change; any additions must go at the end
0046  */
0047 enum ixgbe_pfvf_api_rev {
0048     ixgbe_mbox_api_10,  /* API version 1.0, linux/freebsd VF driver */
0049     ixgbe_mbox_api_20,  /* API version 2.0, solaris Phase1 VF driver */
0050     ixgbe_mbox_api_11,  /* API version 1.1, linux/freebsd VF driver */
0051     ixgbe_mbox_api_12,  /* API version 1.2, linux/freebsd VF driver */
0052     ixgbe_mbox_api_13,  /* API version 1.3, linux/freebsd VF driver */
0053     ixgbe_mbox_api_14,  /* API version 1.4, linux/freebsd VF driver */
0054     /* This value should always be last */
0055     ixgbe_mbox_api_unknown, /* indicates that API version is not known */
0056 };
0057
0058 /* mailbox API, legacy requests */
0059 #define IXGBE_VF_RESET            0x01 /* VF requests reset */
0060 #define IXGBE_VF_SET_MAC_ADDR     0x02 /* VF requests PF to set MAC addr */
0061 #define IXGBE_VF_SET_MULTICAST    0x03 /* VF requests PF to set MC addr */
0062 #define IXGBE_VF_SET_VLAN         0x04 /* VF requests PF to set VLAN */
0063
0064 /* mailbox API, version 1.0 VF requests */
0065 #define IXGBE_VF_SET_LPE    0x05 /* VF requests PF to set VMOLR.LPE */
0066 #define IXGBE_VF_SET_MACVLAN    0x06 /* VF requests PF for unicast filter */
0067 #define IXGBE_VF_API_NEGOTIATE  0x08 /* negotiate API version */
0068
0069 /* mailbox API, version 1.1 VF requests */
0070 #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */
0071
0072 /* GET_QUEUES return data indices within the mailbox */
0073 #define IXGBE_VF_TX_QUEUES  1   /* number of Tx queues supported */
0074 #define IXGBE_VF_RX_QUEUES  2   /* number of Rx queues supported */
0075 #define IXGBE_VF_TRANS_VLAN 3   /* Indication of port vlan */
0076 #define IXGBE_VF_DEF_QUEUE  4   /* Default queue offset */
0077
0078 /* mailbox API, version 1.2 VF requests */
0079 #define IXGBE_VF_GET_RETA   0x0a    /* VF request for RETA */
0080 #define IXGBE_VF_GET_RSS_KEY    0x0b    /* get RSS key */
0081
0082 #define IXGBE_VF_UPDATE_XCAST_MODE  0x0c
0083
0084 /* mailbox API, version 1.4 VF requests */
0085 #define IXGBE_VF_IPSEC_ADD  0x0d
0086 #define IXGBE_VF_IPSEC_DEL  0x0e
0087
0088 #define IXGBE_VF_GET_LINK_STATE 0x10 /* get vf link state */
0089
0090 /* length of permanent address message returned from PF */
0091 #define IXGBE_VF_PERMADDR_MSG_LEN 4
0092 /* word in permanent address message with the current multicast type */
0093 #define IXGBE_VF_MC_TYPE_WORD     3
0094
0095 #define IXGBE_PF_CONTROL_MSG      0x0100 /* PF control message */
0096
0097 #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
0098 #define IXGBE_VF_MBX_INIT_DELAY   500  /* microseconds between retries */
0099
0100 s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16);
0101 s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16);
0102 s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16);
0103 s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16);
0104 s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16);
0105 #ifdef CONFIG_PCI_IOV
0106 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *);
0107 #endif /* CONFIG_PCI_IOV */
0108
0109 extern const struct ixgbe_mbx_operations mbx_ops_generic;
0110
0111 #endif /* _IXGBE_MBX_H_ */