drivers/net/ethernet/intel/igb/e1000_mbx.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Intel(R) Gigabit Ethernet Linux driver
   3  * Copyright(c) 2007-2014 Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * The full GNU General Public License is included in this distribution in
  18  * the file called "COPYING".
  19  *
  20  * Contact Information:
  21  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  22  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  23  */
  24
  25 #ifndef _E1000_MBX_H_
  26 #define _E1000_MBX_H_
  27
  28 #include "e1000_hw.h"
  29
  30 #define E1000_P2VMAILBOX_STS    0x00000001 /* Initiate message send to VF */
  31 #define E1000_P2VMAILBOX_ACK    0x00000002 /* Ack message recv'd from VF */
  32 #define E1000_P2VMAILBOX_VFU    0x00000004 /* VF owns the mailbox buffer */
  33 #define E1000_P2VMAILBOX_PFU    0x00000008 /* PF owns the mailbox buffer */
  34 #define E1000_P2VMAILBOX_RVFU   0x00000010 /* Reset VFU - used when VF stuck */
  35
  36 #define E1000_MBVFICR_VFREQ_MASK        0x000000FF /* bits for VF messages */
  37 #define E1000_MBVFICR_VFREQ_VF1         0x00000001 /* bit for VF 1 message */
  38 #define E1000_MBVFICR_VFACK_MASK        0x00FF0000 /* bits for VF acks */
  39 #define E1000_MBVFICR_VFACK_VF1         0x00010000 /* bit for VF 1 ack */
  40
  41 #define E1000_VFMAILBOX_SIZE    16 /* 16 32 bit words - 64 bytes */
  42
  43 /* If it's a E1000_VF_* msg then it originates in the VF and is sent to the
  44  * PF.  The reverse is true if it is E1000_PF_*.
  45  * Message ACK's are the value or'd with 0xF0000000
  46  */
  47 /* Messages below or'd with this are the ACK */
  48 #define E1000_VT_MSGTYPE_ACK    0x80000000
  49 /* Messages below or'd with this are the NACK */
  50 #define E1000_VT_MSGTYPE_NACK   0x40000000
  51 /* Indicates that VF is still clear to send requests */
  52 #define E1000_VT_MSGTYPE_CTS    0x20000000
  53 #define E1000_VT_MSGINFO_SHIFT  16
  54 /* bits 23:16 are used for exra info for certain messages */
  55 #define E1000_VT_MSGINFO_MASK   (0xFF << E1000_VT_MSGINFO_SHIFT)
  56
  57 #define E1000_VF_RESET          0x01 /* VF requests reset */
  58 #define E1000_VF_SET_MAC_ADDR   0x02 /* VF requests to set MAC addr */
  59 /* VF requests to clear all unicast MAC filters */
  60 #define E1000_VF_MAC_FILTER_CLR (0x01 << E1000_VT_MSGINFO_SHIFT)
  61 /* VF requests to add unicast MAC filter */
  62 #define E1000_VF_MAC_FILTER_ADD (0x02 << E1000_VT_MSGINFO_SHIFT)
  63 #define E1000_VF_SET_MULTICAST  0x03 /* VF requests to set MC addr */
  64 #define E1000_VF_SET_VLAN       0x04 /* VF requests to set VLAN */
  65 #define E1000_VF_SET_LPE        0x05 /* VF requests to set VMOLR.LPE */
  66 #define E1000_VF_SET_PROMISC    0x06 /*VF requests to clear VMOLR.ROPE/MPME*/
  67 #define E1000_VF_SET_PROMISC_MULTICAST  (0x02 << E1000_VT_MSGINFO_SHIFT)
  68
  69 #define E1000_PF_CONTROL_MSG    0x0100 /* PF control message */
  70
  71 s32 igb_read_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id,
  72                  bool unlock);
  73 s32 igb_write_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id);
  74 s32 igb_check_for_msg(struct e1000_hw *hw, u16 mbx_id);
  75 s32 igb_check_for_ack(struct e1000_hw *hw, u16 mbx_id);
  76 s32 igb_check_for_rst(struct e1000_hw *hw, u16 mbx_id);
  77 s32 igb_unlock_mbx(struct e1000_hw *hw, u16 mbx_id);
  78 s32 igb_init_mbx_params_pf(struct e1000_hw *hw);
  79
  80 #endif /* _E1000_MBX_H_ */