drivers/net/ethernet/intel/ixgbevf/mbx.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright(c) 1999 - 2018 Intel Corporation. */
   3
   4 #ifndef _IXGBE_MBX_H_
   5 #define _IXGBE_MBX_H_
   6
   7 #include "vf.h"
   8
   9 #define IXGBE_VFMAILBOX_SIZE    16 /* 16 32 bit words - 64 bytes */
  10
  11 #define IXGBE_VFMAILBOX         0x002FC
  12 #define IXGBE_VFMBMEM           0x00200
  13
  14 /* Define mailbox register bits */
  15 #define IXGBE_VFMAILBOX_REQ     0x00000001 /* Request for PF Ready bit */
  16 #define IXGBE_VFMAILBOX_ACK     0x00000002 /* Ack PF message received */
  17 #define IXGBE_VFMAILBOX_VFU     0x00000004 /* VF owns the mailbox buffer */
  18 #define IXGBE_VFMAILBOX_PFU     0x00000008 /* PF owns the mailbox buffer */
  19 #define IXGBE_VFMAILBOX_PFSTS   0x00000010 /* PF wrote a message in the MB */
  20 #define IXGBE_VFMAILBOX_PFACK   0x00000020 /* PF ack the previous VF msg */
  21 #define IXGBE_VFMAILBOX_RSTI    0x00000040 /* PF has reset indication */
  22 #define IXGBE_VFMAILBOX_RSTD    0x00000080 /* PF has indicated reset done */
  23 #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
  24
  25 #define IXGBE_PFMAILBOX(x)      (0x04B00 + (4 * (x)))
  26 #define IXGBE_PFMBMEM(vfn)      (0x13000 + (64 * (vfn)))
  27
  28 #define IXGBE_PFMAILBOX_STS     0x00000001 /* Initiate message send to VF */
  29 #define IXGBE_PFMAILBOX_ACK     0x00000002 /* Ack message recv'd from VF */
  30 #define IXGBE_PFMAILBOX_VFU     0x00000004 /* VF owns the mailbox buffer */
  31 #define IXGBE_PFMAILBOX_PFU     0x00000008 /* PF owns the mailbox buffer */
  32 #define IXGBE_PFMAILBOX_RVFU    0x00000010 /* Reset VFU - used when VF stuck */
  33
  34 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
  35 #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
  36 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
  37 #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
  38
  39 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
  40  * PF.  The reverse is true if it is IXGBE_PF_*.
  41  * Message results are the value or'd with 0xF0000000
  42  */
  43 #define IXGBE_VT_MSGTYPE_SUCCESS        0x80000000 /* Messages or'd with this
  44                                                     * have succeeded
  45                                                     */
  46 #define IXGBE_VT_MSGTYPE_FAILURE        0x40000000 /* Messages or'd with this
  47                                                     * have failed
  48                                                     */
  49 #define IXGBE_VT_MSGTYPE_CTS            0x20000000 /* Indicates that VF is still
  50                                                     * clear to send requests
  51                                                     */
  52 #define IXGBE_VT_MSGINFO_SHIFT  16
  53 /* bits 23:16 are used for exra info for certain messages */
  54 #define IXGBE_VT_MSGINFO_MASK   (0xFF << IXGBE_VT_MSGINFO_SHIFT)
  55
  56 /* definitions to support mailbox API version negotiation */
  57
  58 /* each element denotes a version of the API; existing numbers may not
  59  * change; any additions must go at the end
  60  */
  61 enum ixgbe_pfvf_api_rev {
  62         ixgbe_mbox_api_10,      /* API version 1.0, linux/freebsd VF driver */
  63         ixgbe_mbox_api_20,      /* API version 2.0, solaris Phase1 VF driver */
  64         ixgbe_mbox_api_11,      /* API version 1.1, linux/freebsd VF driver */
  65         ixgbe_mbox_api_12,      /* API version 1.2, linux/freebsd VF driver */
  66         ixgbe_mbox_api_13,      /* API version 1.3, linux/freebsd VF driver */
  67         ixgbe_mbox_api_14,      /* API version 1.4, linux/freebsd VF driver */
  68         ixgbe_mbox_api_15,      /* API version 1.5, linux/freebsd VF driver */
  69         /* This value should always be last */
  70         ixgbe_mbox_api_unknown, /* indicates that API version is not known */
  71 };
  72
  73 /* mailbox API, legacy requests */
  74 #define IXGBE_VF_RESET          0x01 /* VF requests reset */
  75 #define IXGBE_VF_SET_MAC_ADDR   0x02 /* VF requests PF to set MAC addr */
  76 #define IXGBE_VF_SET_MULTICAST  0x03 /* VF requests PF to set MC addr */
  77 #define IXGBE_VF_SET_VLAN       0x04 /* VF requests PF to set VLAN */
  78
  79 /* mailbox API, version 1.0 VF requests */
  80 #define IXGBE_VF_SET_LPE        0x05 /* VF requests PF to set VMOLR.LPE */
  81 #define IXGBE_VF_SET_MACVLAN    0x06 /* VF requests PF for unicast filter */
  82 #define IXGBE_VF_API_NEGOTIATE  0x08 /* negotiate API version */
  83
  84 /* mailbox API, version 1.1 VF requests */
  85 #define IXGBE_VF_GET_QUEUE      0x09 /* get queue configuration */
  86
  87 /* GET_QUEUES return data indices within the mailbox */
  88 #define IXGBE_VF_TX_QUEUES      1 /* number of Tx queues supported */
  89 #define IXGBE_VF_RX_QUEUES      2 /* number of Rx queues supported */
  90 #define IXGBE_VF_TRANS_VLAN     3 /* Indication of port VLAN */
  91 #define IXGBE_VF_DEF_QUEUE      4 /* Default queue offset */
  92
  93 /* mailbox API, version 1.2 VF requests */
  94 #define IXGBE_VF_GET_RETA       0x0a    /* VF request for RETA */
  95 #define IXGBE_VF_GET_RSS_KEY    0x0b    /* get RSS hash key */
  96
  97 #define IXGBE_VF_UPDATE_XCAST_MODE      0x0c
  98
  99 /* mailbox API, version 1.4 VF requests */
 100 #define IXGBE_VF_IPSEC_ADD      0x0d
 101 #define IXGBE_VF_IPSEC_DEL      0x0e
 102
 103 #define IXGBE_VF_GET_LINK_STATE 0x10 /* get vf link state */
 104
 105 /* length of permanent address message returned from PF */
 106 #define IXGBE_VF_PERMADDR_MSG_LEN       4
 107 /* word in permanent address message with the current multicast type */
 108 #define IXGBE_VF_MC_TYPE_WORD           3
 109
 110 #define IXGBE_PF_CONTROL_MSG            0x0100 /* PF control message */
 111
 112 #define IXGBE_VF_MBX_INIT_TIMEOUT       2000 /* number of retries on mailbox */
 113 #define IXGBE_VF_MBX_INIT_DELAY         500  /* microseconds between retries */
 114
 115 /* forward declaration of the HW struct */
 116 struct ixgbe_hw;
 117
 118 #endif /* _IXGBE_MBX_H_ */