lib/librte_pmd_ixgbe/ixgbe/ixgbe_mbx.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2001-2012, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in the
  14     documentation and/or other materials provided with the distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 #ifndef _IXGBE_MBX_H_
  35 #define _IXGBE_MBX_H_
  36
  37 #include "ixgbe_type.h"
  38
  39 #define IXGBE_VFMAILBOX_SIZE        16 /* 16 32 bit words - 64 bytes */
  40 #define IXGBE_ERR_MBX               -100
  41
  42 #define IXGBE_VFMAILBOX             0x002FC
  43 #define IXGBE_VFMBMEM               0x00200
  44
  45 /* Define mailbox register bits */
  46 #define IXGBE_VFMAILBOX_REQ      0x00000001 /* Request for PF Ready bit */
  47 #define IXGBE_VFMAILBOX_ACK      0x00000002 /* Ack PF message received */
  48 #define IXGBE_VFMAILBOX_VFU      0x00000004 /* VF owns the mailbox buffer */
  49 #define IXGBE_VFMAILBOX_PFU      0x00000008 /* PF owns the mailbox buffer */
  50 #define IXGBE_VFMAILBOX_PFSTS    0x00000010 /* PF wrote a message in the MB */
  51 #define IXGBE_VFMAILBOX_PFACK    0x00000020 /* PF ack the previous VF msg */
  52 #define IXGBE_VFMAILBOX_RSTI     0x00000040 /* PF has reset indication */
  53 #define IXGBE_VFMAILBOX_RSTD     0x00000080 /* PF has indicated reset done */
  54 #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
  55
  56 #define IXGBE_PFMAILBOX_STS   0x00000001 /* Initiate message send to VF */
  57 #define IXGBE_PFMAILBOX_ACK   0x00000002 /* Ack message recv'd from VF */
  58 #define IXGBE_PFMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
  59 #define IXGBE_PFMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
  60 #define IXGBE_PFMAILBOX_RVFU  0x00000010 /* Reset VFU - used when VF stuck */
  61
  62 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
  63 #define IXGBE_MBVFICR_VFREQ_VF1  0x00000001 /* bit for VF 1 message */
  64 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
  65 #define IXGBE_MBVFICR_VFACK_VF1  0x00010000 /* bit for VF 1 ack */
  66
  67
  68 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
  69  * PF.  The reverse is true if it is IXGBE_PF_*.
  70  * Message ACK's are the value or'd with 0xF0000000
  71  */
  72 #define IXGBE_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
  73                                                * this are the ACK */
  74 #define IXGBE_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
  75                                                * this are the NACK */
  76 #define IXGBE_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
  77                                             * clear to send requests */
  78 #define IXGBE_VT_MSGINFO_SHIFT    16
  79 /* bits 23:16 are used for extra info for certain messages */
  80 #define IXGBE_VT_MSGINFO_MASK     (0xFF << IXGBE_VT_MSGINFO_SHIFT)
  81
  82 /* definitions to support mailbox API version negotiation */
  83
  84 /*
  85  * each element denotes a version of the API; existing numbers may not
  86  * change; any additions must go at the end
  87  */
  88 enum ixgbe_pfvf_api_rev {
  89         ixgbe_mbox_api_10,      /* API version 1.0, linux/freebsd VF driver */
  90         ixgbe_mbox_api_20,      /* API version 2.0, solaris Phase1 VF driver */
  91         ixgbe_mbox_api_11,      /* API version 1.1, linux/freebsd VF driver */
  92         /* This value should always be last */
  93         ixgbe_mbox_api_unknown, /* indicates that API version is not known */
  94 };
  95
  96 /* mailbox API, legacy requests */
  97 #define IXGBE_VF_RESET            0x01 /* VF requests reset */
  98 #define IXGBE_VF_SET_MAC_ADDR     0x02 /* VF requests PF to set MAC addr */
  99 #define IXGBE_VF_SET_MULTICAST    0x03 /* VF requests PF to set MC addr */
 100 #define IXGBE_VF_SET_VLAN         0x04 /* VF requests PF to set VLAN */
 101
 102 /* mailbox API, version 1.0 VF requests */
 103 #define IXGBE_VF_SET_LPE          0x05 /* VF requests PF to set VMOLR.LPE */
 104 #define IXGBE_VF_SET_MACVLAN      0x06 /* VF requests PF for unicast filter */
 105 #define IXGBE_VF_API_NEGOTIATE  0x08 /* negotiate API version */
 106
 107 /* mailbox API, version 1.1 VF requests */
 108 #define IXGBE_VF_GET_QUEUES     0x09 /* get queue configuration */
 109
 110 /* GET_QUEUES return data indices within the mailbox */
 111 #define IXGBE_VF_TX_QUEUES      1       /* number of Tx queues supported */
 112 #define IXGBE_VF_RX_QUEUES      2       /* number of Rx queues supported */
 113 #define IXGBE_VF_TRANS_VLAN     3       /* Indication of port vlan */
 114 #define IXGBE_VF_DEF_QUEUE      4       /* Default queue offset */
 115
 116 /* length of permanent address message returned from PF */
 117 #define IXGBE_VF_PERMADDR_MSG_LEN 4
 118 /* word in permanent address message with the current multicast type */
 119 #define IXGBE_VF_MC_TYPE_WORD     3
 120
 121 #define IXGBE_PF_CONTROL_MSG      0x0100 /* PF control message */
 122
 123 /* mailbox API, version 2.0 VF requests */
 124 #define IXGBE_VF_API_NEGOTIATE          0x08 /* negotiate API version */
 125 #define IXGBE_VF_GET_QUEUES             0x09 /* get queue configuration */
 126 #define IXGBE_VF_ENABLE_MACADDR         0x0A /* enable MAC address */
 127 #define IXGBE_VF_DISABLE_MACADDR        0x0B /* disable MAC address */
 128 #define IXGBE_VF_GET_MACADDRS           0x0C /* get all configured MAC addrs */
 129 #define IXGBE_VF_SET_MCAST_PROMISC      0x0D /* enable multicast promiscuous */
 130 #define IXGBE_VF_GET_MTU                0x0E /* get bounds on MTU */
 131 #define IXGBE_VF_SET_MTU                0x0F /* set a specific MTU */
 132
 133 /* mailbox API, version 2.0 PF requests */
 134 #define IXGBE_PF_TRANSPARENT_VLAN       0x0101 /* enable transparent vlan */
 135
 136 #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
 137 #define IXGBE_VF_MBX_INIT_DELAY   500  /* microseconds between retries */
 138
 139 s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16);
 140 s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16);
 141 s32 ixgbe_read_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16);
 142 s32 ixgbe_write_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16);
 143 s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16);
 144 s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16);
 145 s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16);
 146 void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw);
 147 void ixgbe_init_mbx_params_vf(struct ixgbe_hw *);
 148 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *);
 149
 150 #endif /* _IXGBE_MBX_H_ */