1 | /****************************************************************************** |
2 | |
3 | Copyright (c) 2001-2013, Intel Corporation |
4 | All rights reserved. |
5 | |
6 | Redistribution and use in source and binary forms, with or without |
7 | modification, are permitted provided that the following conditions are met: |
8 | |
9 | 1. Redistributions of source code must retain the above copyright notice, |
10 | this list of conditions and the following disclaimer. |
11 | |
12 | 2. Redistributions in binary form must reproduce the above copyright |
13 | notice, this list of conditions and the following disclaimer in the |
14 | documentation and/or other materials provided with the distribution. |
15 | |
16 | 3. Neither the name of the Intel Corporation nor the names of its |
17 | contributors may be used to endorse or promote products derived from |
18 | this software without specific prior written permission. |
19 | |
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
23 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
24 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
25 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
26 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
27 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
28 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
29 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
30 | POSSIBILITY OF SUCH DAMAGE. |
31 | |
32 | ******************************************************************************/ |
33 | /*$FreeBSD: head/sys/dev/ixgbe/ixgbe_mbx.h 247822 2013-03-04 23:07:40Z jfv $*/ |
34 | /*$NetBSD: ixgbe_mbx.h,v 1.4 2015/04/24 07:00:51 msaitoh Exp $*/ |
35 | |
36 | #ifndef _IXGBE_MBX_H_ |
37 | #define _IXGBE_MBX_H_ |
38 | |
39 | #include "ixgbe_type.h" |
40 | |
41 | #define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ |
42 | #define IXGBE_ERR_MBX -100 |
43 | |
44 | #define IXGBE_VFMAILBOX 0x002FC |
45 | #define IXGBE_VFMBMEM 0x00200 |
46 | |
47 | /* Define mailbox register bits */ |
48 | #define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ |
49 | #define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */ |
50 | #define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ |
51 | #define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ |
52 | #define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ |
53 | #define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ |
54 | #define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */ |
55 | #define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ |
56 | #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ |
57 | |
58 | #define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */ |
59 | #define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ |
60 | #define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ |
61 | #define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ |
62 | #define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ |
63 | |
64 | #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */ |
65 | #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ |
66 | #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */ |
67 | #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ |
68 | |
69 | |
70 | /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the |
71 | * PF. The reverse is TRUE if it is IXGBE_PF_*. |
72 | * Message ACK's are the value or'd with 0xF0000000 |
73 | */ |
74 | #define IXGBE_VT_MSGTYPE_ACK 0x80000000 /* Messages below or'd with |
75 | * this are the ACK */ |
76 | #define IXGBE_VT_MSGTYPE_NACK 0x40000000 /* Messages below or'd with |
77 | * this are the NACK */ |
78 | #define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still |
79 | * clear to send requests */ |
80 | #define IXGBE_VT_MSGINFO_SHIFT 16 |
81 | /* bits 23:16 are used for extra info for certain messages */ |
82 | #define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT) |
83 | |
84 | #define IXGBE_VF_RESET 0x01 /* VF requests reset */ |
85 | #define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ |
86 | #define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ |
87 | #define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ |
88 | |
89 | /* mailbox API, version 1.0 VF requests */ |
90 | #define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ |
91 | #define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ |
92 | #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ |
93 | |
94 | /* mailbox API, version 1.1 VF requests */ |
95 | #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ |
96 | |
97 | /* GET_QUEUES return data indices within the mailbox */ |
98 | #define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ |
99 | #define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ |
100 | #define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ |
101 | #define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ |
102 | |
103 | /* length of permanent address message returned from PF */ |
104 | #define IXGBE_VF_PERMADDR_MSG_LEN 4 |
105 | /* word in permanent address message with the current multicast type */ |
106 | #define IXGBE_VF_MC_TYPE_WORD 3 |
107 | |
108 | #define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */ |
109 | |
110 | |
111 | #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ |
112 | #define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ |
113 | |
114 | s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16); |
115 | s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16); |
116 | s32 ixgbe_read_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16); |
117 | s32 ixgbe_write_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16); |
118 | s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16); |
119 | s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16); |
120 | s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16); |
121 | void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw); |
122 | void ixgbe_init_mbx_params_vf(struct ixgbe_hw *); |
123 | void ixgbe_init_mbx_params_pf(struct ixgbe_hw *); |
124 | |
125 | #endif /* _IXGBE_MBX_H_ */ |
126 | |