Merge tag 'v3.10-rc1' into patchwork
[deliverable/linux.git] / drivers / net / ethernet / intel / ixgbevf / mbx.h
CommitLineData
cbf698db
GR
1/*******************************************************************************
2
3 Intel 82599 Virtual Function driver
5c47a2b6 4 Copyright(c) 1999 - 2012 Intel Corporation.
cbf698db
GR
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 _IXGBE_MBX_H_
29#define _IXGBE_MBX_H_
30
31#include "vf.h"
32
33#define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */
34#define IXGBE_ERR_MBX -100
35
36#define IXGBE_VFMAILBOX 0x002FC
37#define IXGBE_VFMBMEM 0x00200
38
39/* Define mailbox register bits */
40#define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */
41#define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */
42#define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
43#define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
44#define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */
45#define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */
46#define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */
47#define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */
48#define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
49
f131a6c0
AD
50#define IXGBE_PFMAILBOX(x) (0x04B00 + (4 * (x)))
51#define IXGBE_PFMBMEM(vfn) (0x13000 + (64 * (vfn)))
cbf698db
GR
52
53#define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */
54#define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */
55#define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
56#define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
57#define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */
58
59#define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
60#define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
61#define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
62#define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
63
64
65/* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
66 * PF. The reverse is true if it is IXGBE_PF_*.
67 * Message ACK's are the value or'd with 0xF0000000
68 */
69#define IXGBE_VT_MSGTYPE_ACK 0x80000000 /* Messages below or'd with
70 * this are the ACK */
71#define IXGBE_VT_MSGTYPE_NACK 0x40000000 /* Messages below or'd with
72 * this are the NACK */
73#define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still
74 * clear to send requests */
75#define IXGBE_VT_MSGINFO_SHIFT 16
76/* bits 23:16 are used for exra info for certain messages */
77#define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT)
78
31186785
AD
79/* definitions to support mailbox API version negotiation */
80
81/*
82 * each element denotes a version of the API; existing numbers may not
83 * change; any additions must go at the end
84 */
85enum ixgbe_pfvf_api_rev {
86 ixgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */
87 ixgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */
56e94095 88 ixgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */
31186785
AD
89 /* This value should always be last */
90 ixgbe_mbox_api_unknown, /* indicates that API version is not known */
91};
92
93/* mailbox API, legacy requests */
cbf698db
GR
94#define IXGBE_VF_RESET 0x01 /* VF requests reset */
95#define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */
96#define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */
97#define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */
31186785
AD
98
99/* mailbox API, version 1.0 VF requests */
100#define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */
101#define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */
102#define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */
cbf698db 103
56e94095
AD
104/* mailbox API, version 1.1 VF requests */
105#define IXGBE_VF_GET_QUEUE 0x09 /* get queue configuration */
106
107/* GET_QUEUES return data indices within the mailbox */
108#define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */
109#define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */
110#define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */
111#define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */
112
cbf698db
GR
113/* length of permanent address message returned from PF */
114#define IXGBE_VF_PERMADDR_MSG_LEN 4
115/* word in permanent address message with the current multicast type */
116#define IXGBE_VF_MC_TYPE_WORD 3
117
118#define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */
119
120#define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
121#define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */
122
123/* forward declaration of the HW struct */
124struct ixgbe_hw;
125
cbf698db 126#endif /* _IXGBE_MBX_H_ */
This page took 3.054393 seconds and 5 git commands to generate.