1/*******************************************************************************
2
3  Intel 82599 Virtual Function driver
4  Copyright(c) 1999 - 2015 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, see <http://www.gnu.org/licenses/>.
17
18  The full GNU General Public License is included in this distribution in
19  the file called "COPYING".
20
21  Contact Information:
22  e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24
25*******************************************************************************/
26
27#ifndef __IXGBE_VF_H__
28#define __IXGBE_VF_H__
29
30#include <linux/pci.h>
31#include <linux/delay.h>
32#include <linux/interrupt.h>
33#include <linux/if_ether.h>
34#include <linux/netdevice.h>
35
36#include "defines.h"
37#include "regs.h"
38#include "mbx.h"
39
40struct ixgbe_hw;
41
42/* iterator type for walking multicast address lists */
43typedef u8* (*ixgbe_mc_addr_itr) (struct ixgbe_hw *hw, u8 **mc_addr_ptr,
44				  u32 *vmdq);
45struct ixgbe_mac_operations {
46	s32 (*init_hw)(struct ixgbe_hw *);
47	s32 (*reset_hw)(struct ixgbe_hw *);
48	s32 (*start_hw)(struct ixgbe_hw *);
49	s32 (*clear_hw_cntrs)(struct ixgbe_hw *);
50	enum ixgbe_media_type (*get_media_type)(struct ixgbe_hw *);
51	s32 (*get_mac_addr)(struct ixgbe_hw *, u8 *);
52	s32 (*stop_adapter)(struct ixgbe_hw *);
53	s32 (*get_bus_info)(struct ixgbe_hw *);
54
55	/* Link */
56	s32 (*setup_link)(struct ixgbe_hw *, ixgbe_link_speed, bool, bool);
57	s32 (*check_link)(struct ixgbe_hw *, ixgbe_link_speed *, bool *, bool);
58	s32 (*get_link_capabilities)(struct ixgbe_hw *, ixgbe_link_speed *,
59				     bool *);
60
61	/* RAR, Multicast, VLAN */
62	s32 (*set_rar)(struct ixgbe_hw *, u32, u8 *, u32);
63	s32 (*set_uc_addr)(struct ixgbe_hw *, u32, u8 *);
64	s32 (*init_rx_addrs)(struct ixgbe_hw *);
65	s32 (*update_mc_addr_list)(struct ixgbe_hw *, struct net_device *);
66	s32 (*enable_mc)(struct ixgbe_hw *);
67	s32 (*disable_mc)(struct ixgbe_hw *);
68	s32 (*clear_vfta)(struct ixgbe_hw *);
69	s32 (*set_vfta)(struct ixgbe_hw *, u32, u32, bool);
70};
71
72enum ixgbe_mac_type {
73	ixgbe_mac_unknown = 0,
74	ixgbe_mac_82599_vf,
75	ixgbe_mac_X540_vf,
76	ixgbe_mac_X550_vf,
77	ixgbe_mac_X550EM_x_vf,
78	ixgbe_num_macs
79};
80
81struct ixgbe_mac_info {
82	struct ixgbe_mac_operations ops;
83	u8 addr[6];
84	u8 perm_addr[6];
85
86	enum ixgbe_mac_type type;
87
88	s32  mc_filter_type;
89
90	bool get_link_status;
91	u32  max_tx_queues;
92	u32  max_rx_queues;
93	u32  max_msix_vectors;
94};
95
96struct ixgbe_mbx_operations {
97	s32 (*init_params)(struct ixgbe_hw *hw);
98	s32 (*read)(struct ixgbe_hw *, u32 *, u16);
99	s32 (*write)(struct ixgbe_hw *, u32 *, u16);
100	s32 (*read_posted)(struct ixgbe_hw *, u32 *, u16);
101	s32 (*write_posted)(struct ixgbe_hw *, u32 *, u16);
102	s32 (*check_for_msg)(struct ixgbe_hw *);
103	s32 (*check_for_ack)(struct ixgbe_hw *);
104	s32 (*check_for_rst)(struct ixgbe_hw *);
105};
106
107struct ixgbe_mbx_stats {
108	u32 msgs_tx;
109	u32 msgs_rx;
110
111	u32 acks;
112	u32 reqs;
113	u32 rsts;
114};
115
116struct ixgbe_mbx_info {
117	struct ixgbe_mbx_operations ops;
118	struct ixgbe_mbx_stats stats;
119	u32 timeout;
120	u32 udelay;
121	u32 v2p_mailbox;
122	u16 size;
123};
124
125struct ixgbe_hw {
126	void *back;
127
128	u8 __iomem *hw_addr;
129
130	struct ixgbe_mac_info mac;
131	struct ixgbe_mbx_info mbx;
132
133	u16 device_id;
134	u16 subsystem_vendor_id;
135	u16 subsystem_device_id;
136	u16 vendor_id;
137
138	u8  revision_id;
139	bool adapter_stopped;
140
141	int api_version;
142};
143
144struct ixgbevf_hw_stats {
145	u64 base_vfgprc;
146	u64 base_vfgptc;
147	u64 base_vfgorc;
148	u64 base_vfgotc;
149	u64 base_vfmprc;
150
151	u64 last_vfgprc;
152	u64 last_vfgptc;
153	u64 last_vfgorc;
154	u64 last_vfgotc;
155	u64 last_vfmprc;
156
157	u64 vfgprc;
158	u64 vfgptc;
159	u64 vfgorc;
160	u64 vfgotc;
161	u64 vfmprc;
162
163	u64 saved_reset_vfgprc;
164	u64 saved_reset_vfgptc;
165	u64 saved_reset_vfgorc;
166	u64 saved_reset_vfgotc;
167	u64 saved_reset_vfmprc;
168};
169
170struct ixgbevf_info {
171	enum ixgbe_mac_type mac;
172	const struct ixgbe_mac_operations *mac_ops;
173};
174
175#define IXGBE_FAILED_READ_REG 0xffffffffU
176
177#define IXGBE_REMOVED(a) unlikely(!(a))
178
179static inline void ixgbe_write_reg(struct ixgbe_hw *hw, u32 reg, u32 value)
180{
181	u8 __iomem *reg_addr = ACCESS_ONCE(hw->hw_addr);
182
183	if (IXGBE_REMOVED(reg_addr))
184		return;
185	writel(value, reg_addr + reg);
186}
187
188#define IXGBE_WRITE_REG(h, r, v) ixgbe_write_reg(h, r, v)
189
190u32 ixgbevf_read_reg(struct ixgbe_hw *hw, u32 reg);
191#define IXGBE_READ_REG(h, r) ixgbevf_read_reg(h, r)
192
193static inline void ixgbe_write_reg_array(struct ixgbe_hw *hw, u32 reg,
194					 u32 offset, u32 value)
195{
196	ixgbe_write_reg(hw, reg + (offset << 2), value);
197}
198
199#define IXGBE_WRITE_REG_ARRAY(h, r, o, v) ixgbe_write_reg_array(h, r, o, v)
200
201static inline u32 ixgbe_read_reg_array(struct ixgbe_hw *hw, u32 reg,
202				       u32 offset)
203{
204	return ixgbevf_read_reg(hw, reg + (offset << 2));
205}
206
207#define IXGBE_READ_REG_ARRAY(h, r, o) ixgbe_read_reg_array(h, r, o)
208
209void ixgbevf_rlpml_set_vf(struct ixgbe_hw *hw, u16 max_size);
210int ixgbevf_negotiate_api_version(struct ixgbe_hw *hw, int api);
211int ixgbevf_get_queues(struct ixgbe_hw *hw, unsigned int *num_tcs,
212		       unsigned int *default_tc);
213int ixgbevf_get_reta_locked(struct ixgbe_hw *hw, u32 *reta, int num_rx_queues);
214int ixgbevf_get_rss_key_locked(struct ixgbe_hw *hw, u8 *rss_key);
215#endif /* __IXGBE_VF_H__ */
216