drivers/net/e1000/base/e1000_mbx.h

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