1/*******************************************************************************
2
3  Intel(R) 82576 Virtual Function Linux driver
4  Copyright(c) 1999 - 2012 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 "vf.h"
32
33#define E1000_V2PMAILBOX_REQ   0x00000001 /* Request for PF Ready bit */
34#define E1000_V2PMAILBOX_ACK   0x00000002 /* Ack PF message received */
35#define E1000_V2PMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
36#define E1000_V2PMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
37#define E1000_V2PMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */
38#define E1000_V2PMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */
39#define E1000_V2PMAILBOX_RSTI  0x00000040 /* PF has reset indication */
40#define E1000_V2PMAILBOX_RSTD  0x00000080 /* PF has indicated reset done */
41#define E1000_V2PMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
42
43#define E1000_VFMAILBOX_SIZE   16 /* 16 32 bit words - 64 bytes */
44
45/* If it's a E1000_VF_* msg then it originates in the VF and is sent to the
46 * PF.  The reverse is true if it is E1000_PF_*.
47 * Message ACK's are the value or'd with 0xF0000000
48 */
49#define E1000_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
50                                               * this are the ACK */
51#define E1000_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
52                                               * this are the NACK */
53#define E1000_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
54                                                 clear to send requests */
55
56/* We have a total wait time of 1s for vf mailbox posted messages */
57#define E1000_VF_MBX_INIT_TIMEOUT 2000 /* retry count for mailbox timeout */
58#define E1000_VF_MBX_INIT_DELAY   500  /* usec delay between retries */
59
60#define E1000_VT_MSGINFO_SHIFT    16
61/* bits 23:16 are used for exra info for certain messages */
62#define E1000_VT_MSGINFO_MASK     (0xFF << E1000_VT_MSGINFO_SHIFT)
63
64#define E1000_VF_RESET            0x01 /* VF requests reset */
65#define E1000_VF_SET_MAC_ADDR     0x02 /* VF requests PF to set MAC addr */
66#define E1000_VF_SET_MULTICAST    0x03 /* VF requests PF to set MC addr */
67#define E1000_VF_SET_VLAN         0x04 /* VF requests PF to set VLAN */
68#define E1000_VF_SET_LPE          0x05 /* VF requests PF to set VMOLR.LPE */
69
70#define E1000_PF_CONTROL_MSG      0x0100 /* PF control message */
71
72void e1000_init_mbx_ops_generic(struct e1000_hw *hw);
73s32 e1000_init_mbx_params_vf(struct e1000_hw *);
74
75#endif /* _E1000_MBX_H_ */
76