lib/librte_eal/linuxapp/kni/ethtool/ixgbe/ixgbe_mbx.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*******************************************************************************
   3
   4   Intel 10 Gigabit PCI Express Linux driver
   5   Copyright(c) 1999 - 2012 Intel Corporation.
   6
   7   Contact Information:
   8   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
   9   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  10
  11 *******************************************************************************/
  12
  13 #ifndef _IXGBE_MBX_H_
  14 #define _IXGBE_MBX_H_
  15
  16 #include "ixgbe_type.h"
  17
  18 #define IXGBE_VFMAILBOX_SIZE    16 /* 16 32 bit words - 64 bytes */
  19 #define IXGBE_ERR_MBX           -100
  20
  21 #define IXGBE_VFMAILBOX         0x002FC
  22 #define IXGBE_VFMBMEM           0x00200
  23
  24 /* Define mailbox register bits */
  25 #define IXGBE_VFMAILBOX_REQ     0x00000001 /* Request for PF Ready bit */
  26 #define IXGBE_VFMAILBOX_ACK     0x00000002 /* Ack PF message received */
  27 #define IXGBE_VFMAILBOX_VFU     0x00000004 /* VF owns the mailbox buffer */
  28 #define IXGBE_VFMAILBOX_PFU     0x00000008 /* PF owns the mailbox buffer */
  29 #define IXGBE_VFMAILBOX_PFSTS   0x00000010 /* PF wrote a message in the MB */
  30 #define IXGBE_VFMAILBOX_PFACK   0x00000020 /* PF ack the previous VF msg */
  31 #define IXGBE_VFMAILBOX_RSTI    0x00000040 /* PF has reset indication */
  32 #define IXGBE_VFMAILBOX_RSTD    0x00000080 /* PF has indicated reset done */
  33 #define IXGBE_VFMAILBOX_R2C_BITS        0x000000B0 /* All read to clear bits */
  34
  35 #define IXGBE_PFMAILBOX_STS     0x00000001 /* Initiate message send to VF */
  36 #define IXGBE_PFMAILBOX_ACK     0x00000002 /* Ack message recv'd from VF */
  37 #define IXGBE_PFMAILBOX_VFU     0x00000004 /* VF owns the mailbox buffer */
  38 #define IXGBE_PFMAILBOX_PFU     0x00000008 /* PF owns the mailbox buffer */
  39 #define IXGBE_PFMAILBOX_RVFU    0x00000010 /* Reset VFU - used when VF stuck */
  40
  41 #define IXGBE_MBVFICR_VFREQ_MASK        0x0000FFFF /* bits for VF messages */
  42 #define IXGBE_MBVFICR_VFREQ_VF1         0x00000001 /* bit for VF 1 message */
  43 #define IXGBE_MBVFICR_VFACK_MASK        0xFFFF0000 /* bits for VF acks */
  44 #define IXGBE_MBVFICR_VFACK_VF1         0x00010000 /* bit for VF 1 ack */
  45
  46
  47 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
  48  * PF.  The reverse is true if it is IXGBE_PF_*.
  49  * Message ACK's are the value or'd with 0xF0000000
  50  */
  51 #define IXGBE_VT_MSGTYPE_ACK    0x80000000 /* Messages below or'd with
  52                                             * this are the ACK */
  53 #define IXGBE_VT_MSGTYPE_NACK   0x40000000 /* Messages below or'd with
  54                                             * this are the NACK */
  55 #define IXGBE_VT_MSGTYPE_CTS    0x20000000 /* Indicates that VF is still
  56                                             * clear to send requests */
  57 #define IXGBE_VT_MSGINFO_SHIFT  16
  58 /* bits 23:16 are used for extra info for certain messages */
  59 #define IXGBE_VT_MSGINFO_MASK   (0xFF << IXGBE_VT_MSGINFO_SHIFT)
  60
  61 #define IXGBE_VF_RESET          0x01 /* VF requests reset */
  62 #define IXGBE_VF_SET_MAC_ADDR   0x02 /* VF requests PF to set MAC addr */
  63 #define IXGBE_VF_SET_MULTICAST  0x03 /* VF requests PF to set MC addr */
  64 #define IXGBE_VF_SET_VLAN       0x04 /* VF requests PF to set VLAN */
  65 #define IXGBE_VF_SET_LPE        0x05 /* VF requests PF to set VMOLR.LPE */
  66 #define IXGBE_VF_SET_MACVLAN    0x06 /* VF requests PF for unicast filter */
  67
  68 /* length of permanent address message returned from PF */
  69 #define IXGBE_VF_PERMADDR_MSG_LEN       4
  70 /* word in permanent address message with the current multicast type */
  71 #define IXGBE_VF_MC_TYPE_WORD           3
  72
  73 #define IXGBE_PF_CONTROL_MSG            0x0100 /* PF control message */
  74
  75
  76 #define IXGBE_VF_MBX_INIT_TIMEOUT       2000 /* number of retries on mailbox */
  77 #define IXGBE_VF_MBX_INIT_DELAY         500  /* microseconds between retries */
  78
  79 s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16);
  80 s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16);
  81 s32 ixgbe_read_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16);
  82 s32 ixgbe_write_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16);
  83 s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16);
  84 s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16);
  85 s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16);
  86 void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw);
  87 void ixgbe_init_mbx_params_vf(struct ixgbe_hw *);
  88 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *);
  89
  90 #endif /* _IXGBE_MBX_H_ */