2 * This file is part of the Chelsio T4 PCI-E SR-IOV Virtual Function Ethernet
5 * Copyright (c) 2009-2010 Chelsio Communications, Inc. All rights reserved.
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:
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
17 * - Redistributions of source code must retain the above
18 * copyright notice, this list of conditions and the following
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.
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
37 * This file should not be included directly. Include t4vf_common.h instead.
40 #ifndef __CXGB4VF_ADAPTER_H__
41 #define __CXGB4VF_ADAPTER_H__
43 #include <linux/interrupt.h>
44 #include <linux/pci.h>
45 #include <linux/spinlock.h>
46 #include <linux/skbuff.h>
47 #include <linux/if_ether.h>
48 #include <linux/netdevice.h>
50 #include "../cxgb4/t4_hw.h"
53 * Constants of the implementation.
56 MAX_NPORTS
= 1, /* max # of "ports" */
57 MAX_PORT_QSETS
= 8, /* max # of Queue Sets / "port" */
58 MAX_ETH_QSETS
= MAX_NPORTS
*MAX_PORT_QSETS
,
61 * MSI-X interrupt index usage.
63 MSIX_FW
= 0, /* MSI-X index for firmware Q */
64 MSIX_IQFLINT
= 1, /* MSI-X index base for Ingress Qs */
66 MSIX_ENTRIES
= MAX_ETH_QSETS
+ MSIX_EXTRAS
,
69 * The maximum number of Ingress and Egress Queues is determined by
70 * the maximum number of "Queue Sets" which we support plus any
71 * ancillary queues. Each "Queue Set" requires one Ingress Queue
72 * for RX Packet Ingress Event notifications and two Egress Queues for
73 * a Free List and an Ethernet TX list.
75 INGQ_EXTRAS
= 2, /* firmware event queue and */
76 /* forwarded interrupts */
77 MAX_INGQ
= MAX_ETH_QSETS
+INGQ_EXTRAS
,
78 MAX_EGRQ
= MAX_ETH_QSETS
*2,
82 * Forward structure definition references.
89 * Per-"port" information. This is really per-Virtual Interface information
90 * but the use of the "port" nomanclature makes it easier to go back and forth
91 * between the PF and VF drivers ...
94 struct adapter
*adapter
; /* our adapter */
95 u16 viid
; /* virtual interface ID */
96 s16 xact_addr_filt
; /* index of our MAC address filter */
97 u16 rss_size
; /* size of VI's RSS table slice */
98 u8 pidx
; /* index into adapter port[] */
99 u8 port_id
; /* physical port ID */
100 u8 nqsets
; /* # of "Queue Sets" */
101 u8 first_qset
; /* index of first "Queue Set" */
102 struct link_config link_cfg
; /* physical port configuration */
106 * Scatter Gather Engine resources for the "adapter". Our ingress and egress
107 * queues are organized into "Queue Sets" with one ingress and one egress
108 * queue per Queue Set. These Queue Sets are aportionable between the "ports"
109 * (Virtual Interfaces). One extra ingress queue is used to receive
110 * asynchronous messages from the firmware. Note that the "Queue IDs" that we
111 * use here are really "Relative Queue IDs" which are returned as part of the
112 * firmware command to allocate queues. These queue IDs are relative to the
113 * absolute Queue ID base of the section of the Queue ID space allocated to
118 * SGE free-list queue state.
122 unsigned int avail
; /* # of available RX buffers */
123 unsigned int pend_cred
; /* new buffers since last FL DB ring */
124 unsigned int cidx
; /* consumer index */
125 unsigned int pidx
; /* producer index */
126 unsigned long alloc_failed
; /* # of buffer allocation failures */
127 unsigned long large_alloc_failed
;
128 unsigned long starving
; /* # of times FL was found starving */
131 * Write-once/infrequently fields.
132 * -------------------------------
135 unsigned int cntxt_id
; /* SGE relative QID for the free list */
136 unsigned int abs_id
; /* SGE absolute QID for the free list */
137 unsigned int size
; /* capacity of free list */
138 struct rx_sw_desc
*sdesc
; /* address of SW RX descriptor ring */
139 __be64
*desc
; /* address of HW RX descriptor ring */
140 dma_addr_t addr
; /* PCI bus address of hardware ring */
141 void __iomem
*bar2_addr
; /* address of BAR2 Queue registers */
142 unsigned int bar2_qid
; /* Queue ID for BAR2 Queue registers */
146 * An ingress packet gather list.
149 struct page_frag frags
[MAX_SKB_FRAGS
];
150 void *va
; /* virtual address of first byte */
151 unsigned int nfrags
; /* # of fragments */
152 unsigned int tot_len
; /* total length of fragments */
155 typedef int (*rspq_handler_t
)(struct sge_rspq
*, const __be64
*,
156 const struct pkt_gl
*);
159 * State for an SGE Response Queue.
162 struct napi_struct napi
; /* NAPI scheduling control */
163 const __be64
*cur_desc
; /* current descriptor in queue */
164 unsigned int cidx
; /* consumer index */
165 u8 gen
; /* current generation bit */
166 u8 next_intr_params
; /* holdoff params for next interrupt */
167 int offset
; /* offset into current FL buffer */
169 unsigned int unhandled_irqs
; /* bogus interrupts */
172 * Write-once/infrequently fields.
173 * -------------------------------
176 u8 intr_params
; /* interrupt holdoff parameters */
177 u8 pktcnt_idx
; /* interrupt packet threshold */
178 u8 idx
; /* queue index within its group */
179 u16 cntxt_id
; /* SGE rel QID for the response Q */
180 u16 abs_id
; /* SGE abs QID for the response Q */
181 __be64
*desc
; /* address of hardware response ring */
182 dma_addr_t phys_addr
; /* PCI bus address of ring */
183 void __iomem
*bar2_addr
; /* address of BAR2 Queue registers */
184 unsigned int bar2_qid
; /* Queue ID for BAR2 Queue registers */
185 unsigned int iqe_len
; /* entry size */
186 unsigned int size
; /* capcity of response Q */
187 struct adapter
*adapter
; /* our adapter */
188 struct net_device
*netdev
; /* associated net device */
189 rspq_handler_t handler
; /* the handler for this response Q */
193 * Ethernet queue statistics
195 struct sge_eth_stats
{
196 unsigned long pkts
; /* # of ethernet packets */
197 unsigned long lro_pkts
; /* # of LRO super packets */
198 unsigned long lro_merged
; /* # of wire packets merged by LRO */
199 unsigned long rx_cso
; /* # of Rx checksum offloads */
200 unsigned long vlan_ex
; /* # of Rx VLAN extractions */
201 unsigned long rx_drops
; /* # of packets dropped due to no mem */
205 * State for an Ethernet Receive Queue.
208 struct sge_rspq rspq
; /* Response Queue */
209 struct sge_fl fl
; /* Free List */
210 struct sge_eth_stats stats
; /* receive statistics */
214 * SGE Transmit Queue state. This contains all of the resources associated
215 * with the hardware status of a TX Queue which is a circular ring of hardware
216 * TX Descriptors. For convenience, it also contains a pointer to a parallel
217 * "Software Descriptor" array but we don't know anything about it here other
218 * than its type name.
222 * Egress Queues are measured in units of SGE_EQ_IDXSIZE by the
223 * hardware: Sizes, Producer and Consumer indices, etc.
225 __be64 flit
[SGE_EQ_IDXSIZE
/sizeof(__be64
)];
229 unsigned int in_use
; /* # of in-use TX descriptors */
230 unsigned int size
; /* # of descriptors */
231 unsigned int cidx
; /* SW consumer index */
232 unsigned int pidx
; /* producer index */
233 unsigned long stops
; /* # of times queue has been stopped */
234 unsigned long restarts
; /* # of queue restarts */
237 * Write-once/infrequently fields.
238 * -------------------------------
241 unsigned int cntxt_id
; /* SGE relative QID for the TX Q */
242 unsigned int abs_id
; /* SGE absolute QID for the TX Q */
243 struct tx_desc
*desc
; /* address of HW TX descriptor ring */
244 struct tx_sw_desc
*sdesc
; /* address of SW TX descriptor ring */
245 struct sge_qstat
*stat
; /* queue status entry */
246 dma_addr_t phys_addr
; /* PCI bus address of hardware ring */
247 void __iomem
*bar2_addr
; /* address of BAR2 Queue registers */
248 unsigned int bar2_qid
; /* Queue ID for BAR2 Queue registers */
252 * State for an Ethernet Transmit Queue.
255 struct sge_txq q
; /* SGE TX Queue */
256 struct netdev_queue
*txq
; /* associated netdev TX queue */
257 unsigned long tso
; /* # of TSO requests */
258 unsigned long tx_cso
; /* # of TX checksum offloads */
259 unsigned long vlan_ins
; /* # of TX VLAN insertions */
260 unsigned long mapping_err
; /* # of I/O MMU packet mapping errors */
264 * The complete set of Scatter/Gather Engine resources.
268 * Our "Queue Sets" ...
270 struct sge_eth_txq ethtxq
[MAX_ETH_QSETS
];
271 struct sge_eth_rxq ethrxq
[MAX_ETH_QSETS
];
274 * Extra ingress queues for asynchronous firmware events and
275 * forwarded interrupts (when in MSI mode).
277 struct sge_rspq fw_evtq ____cacheline_aligned_in_smp
;
279 struct sge_rspq intrq ____cacheline_aligned_in_smp
;
280 spinlock_t intrq_lock
;
283 * State for managing "starving Free Lists" -- Free Lists which have
284 * fallen below a certain threshold of buffers available to the
285 * hardware and attempts to refill them up to that threshold have
286 * failed. We have a regular "slow tick" timer process which will
287 * make periodic attempts to refill these starving Free Lists ...
289 DECLARE_BITMAP(starving_fl
, MAX_EGRQ
);
290 struct timer_list rx_timer
;
293 * State for cleaning up completed TX descriptors.
295 struct timer_list tx_timer
;
298 * Write-once/infrequently fields.
299 * -------------------------------
302 u16 max_ethqsets
; /* # of available Ethernet queue sets */
303 u16 ethqsets
; /* # of active Ethernet queue sets */
304 u16 ethtxq_rover
; /* Tx queue to clean up next */
305 u16 timer_val
[SGE_NTIMERS
]; /* interrupt holdoff timer array */
306 u8 counter_val
[SGE_NCOUNTERS
]; /* interrupt RX threshold array */
308 /* Decoded Adapter Parameters.
310 u32 fl_pg_order
; /* large page allocation size */
311 u32 stat_len
; /* length of status page at ring end */
312 u32 pktshift
; /* padding between CPL & packet data */
313 u32 fl_align
; /* response queue message alignment */
314 u32 fl_starve_thres
; /* Free List starvation threshold */
317 * Reverse maps from Absolute Queue IDs to associated queue pointers.
318 * The absolute Queue IDs are in a compact range which start at a
319 * [potentially large] Base Queue ID. We perform the reverse map by
320 * first converting the Absolute Queue ID into a Relative Queue ID by
321 * subtracting off the Base Queue ID and then use a Relative Queue ID
322 * indexed table to get the pointer to the corresponding software
325 unsigned int egr_base
;
326 unsigned int ingr_base
;
327 void *egr_map
[MAX_EGRQ
];
328 struct sge_rspq
*ingr_map
[MAX_INGQ
];
332 * Utility macros to convert Absolute- to Relative-Queue indices and Egress-
333 * and Ingress-Queues. The EQ_MAP() and IQ_MAP() macros which provide
334 * pointers to Ingress- and Egress-Queues can be used as both L- and R-values
336 #define EQ_IDX(s, abs_id) ((unsigned int)((abs_id) - (s)->egr_base))
337 #define IQ_IDX(s, abs_id) ((unsigned int)((abs_id) - (s)->ingr_base))
339 #define EQ_MAP(s, abs_id) ((s)->egr_map[EQ_IDX(s, abs_id)])
340 #define IQ_MAP(s, abs_id) ((s)->ingr_map[IQ_IDX(s, abs_id)])
343 * Macro to iterate across Queue Sets ("rxq" is a historic misnomer).
345 #define for_each_ethrxq(sge, iter) \
346 for (iter = 0; iter < (sge)->ethqsets; iter++)
349 * Per-"adapter" (Virtual Function) information.
355 struct pci_dev
*pdev
;
356 struct device
*pdev_dev
;
358 /* "adapter" resources */
359 unsigned long registered_device_map
;
360 unsigned long open_device_map
;
362 struct adapter_params params
;
364 /* queue and interrupt resources */
368 } msix_info
[MSIX_ENTRIES
];
371 /* Linux network device resources */
372 struct net_device
*port
[MAX_NPORTS
];
374 unsigned int msg_enable
;
376 /* debugfs resources */
377 struct dentry
*debugfs_root
;
380 spinlock_t stats_lock
;
383 enum { /* adapter flags */
384 FULL_INIT_DONE
= (1UL << 0),
385 USING_MSI
= (1UL << 1),
386 USING_MSIX
= (1UL << 2),
387 QUEUES_BOUND
= (1UL << 3),
391 * The following register read/write routine definitions are required by
396 * t4_read_reg - read a HW register
397 * @adapter: the adapter
398 * @reg_addr: the register address
400 * Returns the 32-bit value of the given HW register.
402 static inline u32
t4_read_reg(struct adapter
*adapter
, u32 reg_addr
)
404 return readl(adapter
->regs
+ reg_addr
);
408 * t4_write_reg - write a HW register
409 * @adapter: the adapter
410 * @reg_addr: the register address
411 * @val: the value to write
413 * Write a 32-bit value into the given HW register.
415 static inline void t4_write_reg(struct adapter
*adapter
, u32 reg_addr
, u32 val
)
417 writel(val
, adapter
->regs
+ reg_addr
);
421 static inline u64
readq(const volatile void __iomem
*addr
)
423 return readl(addr
) + ((u64
)readl(addr
+ 4) << 32);
426 static inline void writeq(u64 val
, volatile void __iomem
*addr
)
429 writel(val
>> 32, addr
+ 4);
434 * t4_read_reg64 - read a 64-bit HW register
435 * @adapter: the adapter
436 * @reg_addr: the register address
438 * Returns the 64-bit value of the given HW register.
440 static inline u64
t4_read_reg64(struct adapter
*adapter
, u32 reg_addr
)
442 return readq(adapter
->regs
+ reg_addr
);
446 * t4_write_reg64 - write a 64-bit HW register
447 * @adapter: the adapter
448 * @reg_addr: the register address
449 * @val: the value to write
451 * Write a 64-bit value into the given HW register.
453 static inline void t4_write_reg64(struct adapter
*adapter
, u32 reg_addr
,
456 writeq(val
, adapter
->regs
+ reg_addr
);
460 * port_name - return the string name of a port
461 * @adapter: the adapter
462 * @pidx: the port index
464 * Return the string name of the selected port.
466 static inline const char *port_name(struct adapter
*adapter
, int pidx
)
468 return adapter
->port
[pidx
]->name
;
472 * t4_os_set_hw_addr - store a port's MAC address in SW
473 * @adapter: the adapter
474 * @pidx: the port index
475 * @hw_addr: the Ethernet address
477 * Store the Ethernet address of the given port in SW. Called by the common
478 * code when it retrieves a port's Ethernet address from EEPROM.
480 static inline void t4_os_set_hw_addr(struct adapter
*adapter
, int pidx
,
483 memcpy(adapter
->port
[pidx
]->dev_addr
, hw_addr
, ETH_ALEN
);
487 * netdev2pinfo - return the port_info structure associated with a net_device
490 * Return the struct port_info associated with a net_device
492 static inline struct port_info
*netdev2pinfo(const struct net_device
*dev
)
494 return netdev_priv(dev
);
498 * adap2pinfo - return the port_info of a port
500 * @pidx: the port index
502 * Return the port_info structure for the adapter.
504 static inline struct port_info
*adap2pinfo(struct adapter
*adapter
, int pidx
)
506 return netdev_priv(adapter
->port
[pidx
]);
510 * netdev2adap - return the adapter structure associated with a net_device
513 * Return the struct adapter associated with a net_device
515 static inline struct adapter
*netdev2adap(const struct net_device
*dev
)
517 return netdev2pinfo(dev
)->adapter
;
521 * OS "Callback" function declarations. These are functions that the OS code
522 * is "contracted" to provide for the common code.
524 void t4vf_os_link_changed(struct adapter
*, int, int);
527 * SGE function prototype declarations.
529 int t4vf_sge_alloc_rxq(struct adapter
*, struct sge_rspq
*, bool,
530 struct net_device
*, int,
531 struct sge_fl
*, rspq_handler_t
);
532 int t4vf_sge_alloc_eth_txq(struct adapter
*, struct sge_eth_txq
*,
533 struct net_device
*, struct netdev_queue
*,
535 void t4vf_free_sge_resources(struct adapter
*);
537 int t4vf_eth_xmit(struct sk_buff
*, struct net_device
*);
538 int t4vf_ethrx_handler(struct sge_rspq
*, const __be64
*,
539 const struct pkt_gl
*);
541 irq_handler_t
t4vf_intr_handler(struct adapter
*);
542 irqreturn_t
t4vf_sge_intr_msix(int, void *);
544 int t4vf_sge_init(struct adapter
*);
545 void t4vf_sge_start(struct adapter
*);
546 void t4vf_sge_stop(struct adapter
*);
548 #endif /* __CXGB4VF_ADAPTER_H__ */