1 /*
2  * This file is part of the Chelsio T4 PCI-E SR-IOV Virtual Function Ethernet
3  * driver for Linux.
4  *
5  * Copyright (c) 2009-2010 Chelsio Communications, Inc. All rights reserved.
6  *
7  * This software is available to you under a choice of one of two
8  * licenses.  You may choose to be licensed under the terms of the GNU
9  * General Public License (GPL) Version 2, available from the file
10  * COPYING in the main directory of this source tree, or the
11  * OpenIB.org BSD license below:
12  *
13  *     Redistribution and use in source and binary forms, with or
14  *     without modification, are permitted provided that the following
15  *     conditions are met:
16  *
17  *      - Redistributions of source code must retain the above
18  *        copyright notice, this list of conditions and the following
19  *        disclaimer.
20  *
21  *      - Redistributions in binary form must reproduce the above
22  *        copyright notice, this list of conditions and the following
23  *        disclaimer in the documentation and/or other materials
24  *        provided with the distribution.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  */
35 
36 #ifndef __T4VF_COMMON_H__
37 #define __T4VF_COMMON_H__
38 
39 #include "../cxgb4/t4fw_api.h"
40 
41 #define CHELSIO_CHIP_CODE(version, revision) (((version) << 4) | (revision))
42 #define CHELSIO_CHIP_VERSION(code) ((code) >> 4)
43 #define CHELSIO_CHIP_RELEASE(code) ((code) & 0xf)
44 
45 #define CHELSIO_T4		0x4
46 #define CHELSIO_T5		0x5
47 
48 enum chip_type {
49 	T4_A1 = CHELSIO_CHIP_CODE(CHELSIO_T4, 0),
50 	T4_A2 = CHELSIO_CHIP_CODE(CHELSIO_T4, 1),
51 	T4_A3 = CHELSIO_CHIP_CODE(CHELSIO_T4, 2),
52 	T4_FIRST_REV	= T4_A1,
53 	T4_LAST_REV	= T4_A3,
54 
55 	T5_A1 = CHELSIO_CHIP_CODE(CHELSIO_T5, 0),
56 	T5_FIRST_REV	= T5_A1,
57 	T5_LAST_REV	= T5_A1,
58 };
59 
60 /*
61  * The "len16" field of a Firmware Command Structure ...
62  */
63 #define FW_LEN16(fw_struct) FW_CMD_LEN16(sizeof(fw_struct) / 16)
64 
65 /*
66  * Per-VF statistics.
67  */
68 struct t4vf_port_stats {
69 	/*
70 	 * TX statistics.
71 	 */
72 	u64 tx_bcast_bytes;		/* broadcast */
73 	u64 tx_bcast_frames;
74 	u64 tx_mcast_bytes;		/* multicast */
75 	u64 tx_mcast_frames;
76 	u64 tx_ucast_bytes;		/* unicast */
77 	u64 tx_ucast_frames;
78 	u64 tx_drop_frames;		/* TX dropped frames */
79 	u64 tx_offload_bytes;		/* offload */
80 	u64 tx_offload_frames;
81 
82 	/*
83 	 * RX statistics.
84 	 */
85 	u64 rx_bcast_bytes;		/* broadcast */
86 	u64 rx_bcast_frames;
87 	u64 rx_mcast_bytes;		/* multicast */
88 	u64 rx_mcast_frames;
89 	u64 rx_ucast_bytes;
90 	u64 rx_ucast_frames;		/* unicast */
91 
92 	u64 rx_err_frames;		/* RX error frames */
93 };
94 
95 /*
96  * Per-"port" (Virtual Interface) link configuration ...
97  */
98 struct link_config {
99 	unsigned int   supported;        /* link capabilities */
100 	unsigned int   advertising;      /* advertised capabilities */
101 	unsigned short requested_speed;  /* speed user has requested */
102 	unsigned short speed;            /* actual link speed */
103 	unsigned char  requested_fc;     /* flow control user has requested */
104 	unsigned char  fc;               /* actual link flow control */
105 	unsigned char  autoneg;          /* autonegotiating? */
106 	unsigned char  link_ok;          /* link up? */
107 };
108 
109 enum {
110 	PAUSE_RX      = 1 << 0,
111 	PAUSE_TX      = 1 << 1,
112 	PAUSE_AUTONEG = 1 << 2
113 };
114 
115 /*
116  * General device parameters ...
117  */
118 struct dev_params {
119 	u32 fwrev;			/* firmware version */
120 	u32 tprev;			/* TP Microcode Version */
121 };
122 
123 /*
124  * Scatter Gather Engine parameters.  These are almost all determined by the
125  * Physical Function Driver.  We just need to grab them to see within which
126  * environment we're playing ...
127  */
128 struct sge_params {
129 	u32 sge_control;		/* padding, boundaries, lengths, etc. */
130 	u32 sge_host_page_size;		/* RDMA page sizes */
131 	u32 sge_queues_per_page;	/* RDMA queues/page */
132 	u32 sge_user_mode_limits;	/* limits for BAR2 user mode accesses */
133 	u32 sge_fl_buffer_size[16];	/* free list buffer sizes */
134 	u32 sge_ingress_rx_threshold;	/* RX counter interrupt threshold[4] */
135 	u32 sge_timer_value_0_and_1;	/* interrupt coalescing timer values */
136 	u32 sge_timer_value_2_and_3;
137 	u32 sge_timer_value_4_and_5;
138 };
139 
140 /*
141  * Vital Product Data parameters.
142  */
143 struct vpd_params {
144 	u32 cclk;			/* Core Clock (KHz) */
145 };
146 
147 /*
148  * Global Receive Side Scaling (RSS) parameters in host-native format.
149  */
150 struct rss_params {
151 	unsigned int mode;		/* RSS mode */
152 	union {
153 	    struct {
154 		unsigned int synmapen:1;	/* SYN Map Enable */
155 		unsigned int syn4tupenipv6:1;	/* enable hashing 4-tuple IPv6 SYNs */
156 		unsigned int syn2tupenipv6:1;	/* enable hashing 2-tuple IPv6 SYNs */
157 		unsigned int syn4tupenipv4:1;	/* enable hashing 4-tuple IPv4 SYNs */
158 		unsigned int syn2tupenipv4:1;	/* enable hashing 2-tuple IPv4 SYNs */
159 		unsigned int ofdmapen:1;	/* Offload Map Enable */
160 		unsigned int tnlmapen:1;	/* Tunnel Map Enable */
161 		unsigned int tnlalllookup:1;	/* Tunnel All Lookup */
162 		unsigned int hashtoeplitz:1;	/* use Toeplitz hash */
163 	    } basicvirtual;
164 	} u;
165 };
166 
167 /*
168  * Virtual Interface RSS Configuration in host-native format.
169  */
170 union rss_vi_config {
171     struct {
172 	u16 defaultq;			/* Ingress Queue ID for !tnlalllookup */
173 	unsigned int ip6fourtupen:1;	/* hash 4-tuple IPv6 ingress packets */
174 	unsigned int ip6twotupen:1;	/* hash 2-tuple IPv6 ingress packets */
175 	unsigned int ip4fourtupen:1;	/* hash 4-tuple IPv4 ingress packets */
176 	unsigned int ip4twotupen:1;	/* hash 2-tuple IPv4 ingress packets */
177 	int udpen;			/* hash 4-tuple UDP ingress packets */
178     } basicvirtual;
179 };
180 
181 /*
182  * Maximum resources provisioned for a PCI VF.
183  */
184 struct vf_resources {
185 	unsigned int nvi;		/* N virtual interfaces */
186 	unsigned int neq;		/* N egress Qs */
187 	unsigned int nethctrl;		/* N egress ETH or CTRL Qs */
188 	unsigned int niqflint;		/* N ingress Qs/w free list(s) & intr */
189 	unsigned int niq;		/* N ingress Qs */
190 	unsigned int tc;		/* PCI-E traffic class */
191 	unsigned int pmask;		/* port access rights mask */
192 	unsigned int nexactf;		/* N exact MPS filters */
193 	unsigned int r_caps;		/* read capabilities */
194 	unsigned int wx_caps;		/* write/execute capabilities */
195 };
196 
197 /*
198  * Per-"adapter" (Virtual Function) parameters.
199  */
200 struct adapter_params {
201 	struct dev_params dev;		/* general device parameters */
202 	struct sge_params sge;		/* Scatter Gather Engine */
203 	struct vpd_params vpd;		/* Vital Product Data */
204 	struct rss_params rss;		/* Receive Side Scaling */
205 	struct vf_resources vfres;	/* Virtual Function Resource limits */
206 	u8 nports;			/* # of Ethernet "ports" */
207 };
208 
209 #include "adapter.h"
210 
211 #ifndef PCI_VENDOR_ID_CHELSIO
212 # define PCI_VENDOR_ID_CHELSIO 0x1425
213 #endif
214 
215 #define for_each_port(adapter, iter) \
216 	for (iter = 0; iter < (adapter)->params.nports; iter++)
217 
218 static inline bool is_10g_port(const struct link_config *lc)
219 {
220 	return (lc->supported & SUPPORTED_10000baseT_Full) != 0;
221 }
222 
223 static inline unsigned int core_ticks_per_usec(const struct adapter *adapter)
224 {
225 	return adapter->params.vpd.cclk / 1000;
226 }
227 
228 static inline unsigned int us_to_core_ticks(const struct adapter *adapter,
229 					    unsigned int us)
230 {
231 	return (us * adapter->params.vpd.cclk) / 1000;
232 }
233 
234 static inline unsigned int core_ticks_to_us(const struct adapter *adapter,
235 					    unsigned int ticks)
236 {
237 	return (ticks * 1000) / adapter->params.vpd.cclk;
238 }
239 
240 int t4vf_wr_mbox_core(struct adapter *, const void *, int, void *, bool);
241 
242 static inline int t4vf_wr_mbox(struct adapter *adapter, const void *cmd,
243 			       int size, void *rpl)
244 {
245 	return t4vf_wr_mbox_core(adapter, cmd, size, rpl, true);
246 }
247 
248 static inline int t4vf_wr_mbox_ns(struct adapter *adapter, const void *cmd,
249 				  int size, void *rpl)
250 {
251 	return t4vf_wr_mbox_core(adapter, cmd, size, rpl, false);
252 }
253 
254 static inline int is_t4(enum chip_type chip)
255 {
256 	return (chip >= T4_FIRST_REV && chip <= T4_LAST_REV);
257 }
258 
259 int t4vf_wait_dev_ready(struct adapter *);
260 int t4vf_port_init(struct adapter *, int);
261 
262 int t4vf_fw_reset(struct adapter *);
263 int t4vf_query_params(struct adapter *, unsigned int, const u32 *, u32 *);
264 int t4vf_set_params(struct adapter *, unsigned int, const u32 *, const u32 *);
265 
266 int t4vf_get_sge_params(struct adapter *);
267 int t4vf_get_vpd_params(struct adapter *);
268 int t4vf_get_dev_params(struct adapter *);
269 int t4vf_get_rss_glb_config(struct adapter *);
270 int t4vf_get_vfres(struct adapter *);
271 
272 int t4vf_read_rss_vi_config(struct adapter *, unsigned int,
273 			    union rss_vi_config *);
274 int t4vf_write_rss_vi_config(struct adapter *, unsigned int,
275 			     union rss_vi_config *);
276 int t4vf_config_rss_range(struct adapter *, unsigned int, int, int,
277 			  const u16 *, int);
278 
279 int t4vf_alloc_vi(struct adapter *, int);
280 int t4vf_free_vi(struct adapter *, int);
281 int t4vf_enable_vi(struct adapter *, unsigned int, bool, bool);
282 int t4vf_identify_port(struct adapter *, unsigned int, unsigned int);
283 
284 int t4vf_set_rxmode(struct adapter *, unsigned int, int, int, int, int, int,
285 		    bool);
286 int t4vf_alloc_mac_filt(struct adapter *, unsigned int, bool, unsigned int,
287 			const u8 **, u16 *, u64 *, bool);
288 int t4vf_change_mac(struct adapter *, unsigned int, int, const u8 *, bool);
289 int t4vf_set_addr_hash(struct adapter *, unsigned int, bool, u64, bool);
290 int t4vf_get_port_stats(struct adapter *, int, struct t4vf_port_stats *);
291 
292 int t4vf_iq_free(struct adapter *, unsigned int, unsigned int, unsigned int,
293 		 unsigned int);
294 int t4vf_eth_eq_free(struct adapter *, unsigned int);
295 
296 int t4vf_handle_fw_rpl(struct adapter *, const __be64 *);
297 
298 #endif /* __T4VF_COMMON_H__ */
299