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