kernel/linux/kni/ethtool/igb/e1000_mbx.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*******************************************************************************
   3
   4   Intel(R) Gigabit Ethernet Linux driver
   5   Copyright(c) 2007-2013 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 _E1000_MBX_H_
  14 #define _E1000_MBX_H_
  15
  16 #include "e1000_api.h"
  17
  18 #define E1000_P2VMAILBOX_STS    0x00000001 /* Initiate message send to VF */
  19 #define E1000_P2VMAILBOX_ACK    0x00000002 /* Ack message recv'd from VF */
  20 #define E1000_P2VMAILBOX_VFU    0x00000004 /* VF owns the mailbox buffer */
  21 #define E1000_P2VMAILBOX_PFU    0x00000008 /* PF owns the mailbox buffer */
  22 #define E1000_P2VMAILBOX_RVFU   0x00000010 /* Reset VFU - used when VF stuck */
  23
  24 #define E1000_MBVFICR_VFREQ_MASK 0x000000FF /* bits for VF messages */
  25 #define E1000_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
  26 #define E1000_MBVFICR_VFACK_MASK 0x00FF0000 /* bits for VF acks */
  27 #define E1000_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
  28
  29 #define E1000_VFMAILBOX_SIZE    16 /* 16 32 bit words - 64 bytes */
  30
  31 /* If it's a E1000_VF_* msg then it originates in the VF and is sent to the
  32  * PF.  The reverse is true if it is E1000_PF_*.
  33  * Message ACK's are the value or'd with 0xF0000000
  34  */
  35 /* Msgs below or'd with this are the ACK */
  36 #define E1000_VT_MSGTYPE_ACK    0x80000000
  37 /* Msgs below or'd with this are the NACK */
  38 #define E1000_VT_MSGTYPE_NACK   0x40000000
  39 /* Indicates that VF is still clear to send requests */
  40 #define E1000_VT_MSGTYPE_CTS    0x20000000
  41 #define E1000_VT_MSGINFO_SHIFT  16
  42 /* bits 23:16 are used for extra info for certain messages */
  43 #define E1000_VT_MSGINFO_MASK   (0xFF << E1000_VT_MSGINFO_SHIFT)
  44
  45 #define E1000_VF_RESET                  0x01 /* VF requests reset */
  46 #define E1000_VF_SET_MAC_ADDR           0x02 /* VF requests to set MAC addr */
  47 #define E1000_VF_SET_MULTICAST          0x03 /* VF requests to set MC addr */
  48 #define E1000_VF_SET_MULTICAST_COUNT_MASK (0x1F << E1000_VT_MSGINFO_SHIFT)
  49 #define E1000_VF_SET_MULTICAST_OVERFLOW (0x80 << E1000_VT_MSGINFO_SHIFT)
  50 #define E1000_VF_SET_VLAN               0x04 /* VF requests to set VLAN */
  51 #define E1000_VF_SET_VLAN_ADD           (0x01 << E1000_VT_MSGINFO_SHIFT)
  52 #define E1000_VF_SET_LPE                0x05 /* reqs to set VMOLR.LPE */
  53 #define E1000_VF_SET_PROMISC            0x06 /* reqs to clear VMOLR.ROPE/MPME*/
  54 #define E1000_VF_SET_PROMISC_UNICAST    (0x01 << E1000_VT_MSGINFO_SHIFT)
  55 #define E1000_VF_SET_PROMISC_MULTICAST  (0x02 << E1000_VT_MSGINFO_SHIFT)
  56
  57 #define E1000_PF_CONTROL_MSG            0x0100 /* PF control message */
  58
  59 #define E1000_VF_MBX_INIT_TIMEOUT       2000 /* number of retries on mailbox */
  60 #define E1000_VF_MBX_INIT_DELAY         500  /* microseconds between retries */
  61
  62 s32 e1000_read_mbx(struct e1000_hw *, u32 *, u16, u16);
  63 s32 e1000_write_mbx(struct e1000_hw *, u32 *, u16, u16);
  64 s32 e1000_read_posted_mbx(struct e1000_hw *, u32 *, u16, u16);
  65 s32 e1000_write_posted_mbx(struct e1000_hw *, u32 *, u16, u16);
  66 s32 e1000_check_for_msg(struct e1000_hw *, u16);
  67 s32 e1000_check_for_ack(struct e1000_hw *, u16);
  68 s32 e1000_check_for_rst(struct e1000_hw *, u16);
  69 void e1000_init_mbx_ops_generic(struct e1000_hw *hw);
  70 s32 e1000_init_mbx_params_pf(struct e1000_hw *);
  71
  72 #endif /* _E1000_MBX_H_ */