1/* SPDX-License-Identifier: GPL-2.0 */
  2/*******************************************************************************
  3
  4  Intel 82599 Virtual Function driver
  5  Copyright(c) 1999 - 2015 Intel Corporation.
  6
  7  This program is free software; you can redistribute it and/or modify it
  8  under the terms and conditions of the GNU General Public License,
  9  version 2, as published by the Free Software Foundation.
 10
 11  This program is distributed in the hope it will be useful, but WITHOUT
 12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 13  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 14  more details.
 15
 16  You should have received a copy of the GNU General Public License along with
 17  this program; if not, see <http://www.gnu.org/licenses/>.
 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_VF_H__
 29#define __IXGBE_VF_H__
 30
 31#include <linux/pci.h>
 32#include <linux/delay.h>
 33#include <linux/interrupt.h>
 34#include <linux/if_ether.h>
 35#include <linux/netdevice.h>
 36
 37#include "defines.h"
 38#include "regs.h"
 39#include "mbx.h"
 40
 41struct ixgbe_hw;
 42
 43/* iterator type for walking multicast address lists */
 44typedef u8* (*ixgbe_mc_addr_itr) (struct ixgbe_hw *hw, u8 **mc_addr_ptr,
 45				  u32 *vmdq);
 46struct ixgbe_mac_operations {
 47	s32 (*init_hw)(struct ixgbe_hw *);
 48	s32 (*reset_hw)(struct ixgbe_hw *);
 49	s32 (*start_hw)(struct ixgbe_hw *);
 50	s32 (*clear_hw_cntrs)(struct ixgbe_hw *);
 51	enum ixgbe_media_type (*get_media_type)(struct ixgbe_hw *);
 52	s32 (*get_mac_addr)(struct ixgbe_hw *, u8 *);
 53	s32 (*stop_adapter)(struct ixgbe_hw *);
 54	s32 (*get_bus_info)(struct ixgbe_hw *);
 55	s32 (*negotiate_api_version)(struct ixgbe_hw *hw, int api);
 56
 57	/* Link */
 58	s32 (*setup_link)(struct ixgbe_hw *, ixgbe_link_speed, bool, bool);
 59	s32 (*check_link)(struct ixgbe_hw *, ixgbe_link_speed *, bool *, bool);
 60	s32 (*get_link_capabilities)(struct ixgbe_hw *, ixgbe_link_speed *,
 61				     bool *);
 62
 63	/* RAR, Multicast, VLAN */
 64	s32 (*set_rar)(struct ixgbe_hw *, u32, u8 *, u32);
 65	s32 (*set_uc_addr)(struct ixgbe_hw *, u32, u8 *);
 66	s32 (*init_rx_addrs)(struct ixgbe_hw *);
 67	s32 (*update_mc_addr_list)(struct ixgbe_hw *, struct net_device *);
 68	s32 (*update_xcast_mode)(struct ixgbe_hw *, int);
 69	s32 (*enable_mc)(struct ixgbe_hw *);
 70	s32 (*disable_mc)(struct ixgbe_hw *);
 71	s32 (*clear_vfta)(struct ixgbe_hw *);
 72	s32 (*set_vfta)(struct ixgbe_hw *, u32, u32, bool);
 73	s32 (*set_rlpml)(struct ixgbe_hw *, u16);
 74};
 75
 76enum ixgbe_mac_type {
 77	ixgbe_mac_unknown = 0,
 78	ixgbe_mac_82599_vf,
 79	ixgbe_mac_X540_vf,
 80	ixgbe_mac_X550_vf,
 81	ixgbe_mac_X550EM_x_vf,
 82	ixgbe_mac_x550em_a_vf,
 83	ixgbe_num_macs
 84};
 85
 86struct ixgbe_mac_info {
 87	struct ixgbe_mac_operations ops;
 88	u8 addr[6];
 89	u8 perm_addr[6];
 90
 91	enum ixgbe_mac_type type;
 92
 93	s32  mc_filter_type;
 94
 95	bool get_link_status;
 96	u32  max_tx_queues;
 97	u32  max_rx_queues;
 98	u32  max_msix_vectors;
 99};
100
101struct ixgbe_mbx_operations {
102	s32 (*init_params)(struct ixgbe_hw *hw);
103	s32 (*read)(struct ixgbe_hw *, u32 *, u16);
104	s32 (*write)(struct ixgbe_hw *, u32 *, u16);
105	s32 (*read_posted)(struct ixgbe_hw *, u32 *, u16);
106	s32 (*write_posted)(struct ixgbe_hw *, u32 *, u16);
107	s32 (*check_for_msg)(struct ixgbe_hw *);
108	s32 (*check_for_ack)(struct ixgbe_hw *);
109	s32 (*check_for_rst)(struct ixgbe_hw *);
110};
111
112struct ixgbe_mbx_stats {
113	u32 msgs_tx;
114	u32 msgs_rx;
115
116	u32 acks;
117	u32 reqs;
118	u32 rsts;
119};
120
121struct ixgbe_mbx_info {
122	struct ixgbe_mbx_operations ops;
123	struct ixgbe_mbx_stats stats;
124	u32 timeout;
125	u32 udelay;
126	u32 v2p_mailbox;
127	u16 size;
128};
129
130struct ixgbe_hw {
131	void *back;
132
133	u8 __iomem *hw_addr;
134
135	struct ixgbe_mac_info mac;
136	struct ixgbe_mbx_info mbx;
137
138	u16 device_id;
139	u16 subsystem_vendor_id;
140	u16 subsystem_device_id;
141	u16 vendor_id;
142
143	u8  revision_id;
144	bool adapter_stopped;
145
146	int api_version;
147};
148
149struct ixgbevf_hw_stats {
150	u64 base_vfgprc;
151	u64 base_vfgptc;
152	u64 base_vfgorc;
153	u64 base_vfgotc;
154	u64 base_vfmprc;
155
156	u64 last_vfgprc;
157	u64 last_vfgptc;
158	u64 last_vfgorc;
159	u64 last_vfgotc;
160	u64 last_vfmprc;
161
162	u64 vfgprc;
163	u64 vfgptc;
164	u64 vfgorc;
165	u64 vfgotc;
166	u64 vfmprc;
167
168	u64 saved_reset_vfgprc;
169	u64 saved_reset_vfgptc;
170	u64 saved_reset_vfgorc;
171	u64 saved_reset_vfgotc;
172	u64 saved_reset_vfmprc;
173};
174
175struct ixgbevf_info {
176	enum ixgbe_mac_type mac;
177	const struct ixgbe_mac_operations *mac_ops;
178};
179
180#define IXGBE_FAILED_READ_REG 0xffffffffU
181
182#define IXGBE_REMOVED(a) unlikely(!(a))
183
184static inline void ixgbe_write_reg(struct ixgbe_hw *hw, u32 reg, u32 value)
185{
186	u8 __iomem *reg_addr = READ_ONCE(hw->hw_addr);
187
188	if (IXGBE_REMOVED(reg_addr))
189		return;
190	writel(value, reg_addr + reg);
191}
192
193#define IXGBE_WRITE_REG(h, r, v) ixgbe_write_reg(h, r, v)
194
195u32 ixgbevf_read_reg(struct ixgbe_hw *hw, u32 reg);
196#define IXGBE_READ_REG(h, r) ixgbevf_read_reg(h, r)
197
198static inline void ixgbe_write_reg_array(struct ixgbe_hw *hw, u32 reg,
199					 u32 offset, u32 value)
200{
201	ixgbe_write_reg(hw, reg + (offset << 2), value);
202}
203
204#define IXGBE_WRITE_REG_ARRAY(h, r, o, v) ixgbe_write_reg_array(h, r, o, v)
205
206static inline u32 ixgbe_read_reg_array(struct ixgbe_hw *hw, u32 reg,
207				       u32 offset)
208{
209	return ixgbevf_read_reg(hw, reg + (offset << 2));
210}
211
212#define IXGBE_READ_REG_ARRAY(h, r, o) ixgbe_read_reg_array(h, r, o)
213
214int ixgbevf_get_queues(struct ixgbe_hw *hw, unsigned int *num_tcs,
215		       unsigned int *default_tc);
216int ixgbevf_get_reta_locked(struct ixgbe_hw *hw, u32 *reta, int num_rx_queues);
217int ixgbevf_get_rss_key_locked(struct ixgbe_hw *hw, u8 *rss_key);
218#endif /* __IXGBE_VF_H__ */