IB/ipath: Generalize some xxx_SHIFT macros
[pandora-kernel.git] / drivers / infiniband / hw / ipath / ipath_kernel.h
1 #ifndef _IPATH_KERNEL_H
2 #define _IPATH_KERNEL_H
3 /*
4  * Copyright (c) 2006, 2007 QLogic Corporation. All rights reserved.
5  * Copyright (c) 2003, 2004, 2005, 2006 PathScale, 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 /*
37  * This header file is the base header file for infinipath kernel code
38  * ipath_user.h serves a similar purpose for user code.
39  */
40
41 #include <linux/interrupt.h>
42 #include <linux/pci.h>
43 #include <linux/dma-mapping.h>
44 #include <linux/mutex.h>
45 #include <asm/io.h>
46 #include <rdma/ib_verbs.h>
47
48 #include "ipath_common.h"
49 #include "ipath_debug.h"
50 #include "ipath_registers.h"
51
52 /* only s/w major version of InfiniPath we can handle */
53 #define IPATH_CHIP_VERS_MAJ 2U
54
55 /* don't care about this except printing */
56 #define IPATH_CHIP_VERS_MIN 0U
57
58 /* temporary, maybe always */
59 extern struct infinipath_stats ipath_stats;
60
61 #define IPATH_CHIP_SWVERSION IPATH_CHIP_VERS_MAJ
62 /*
63  * First-cut critierion for "device is active" is
64  * two thousand dwords combined Tx, Rx traffic per
65  * 5-second interval. SMA packets are 64 dwords,
66  * and occur "a few per second", presumably each way.
67  */
68 #define IPATH_TRAFFIC_ACTIVE_THRESHOLD (2000)
69 /*
70  * Struct used to indicate which errors are logged in each of the
71  * error-counters that are logged to EEPROM. A counter is incremented
72  * _once_ (saturating at 255) for each event with any bits set in
73  * the error or hwerror register masks below.
74  */
75 #define IPATH_EEP_LOG_CNT (4)
76 struct ipath_eep_log_mask {
77         u64 errs_to_log;
78         u64 hwerrs_to_log;
79 };
80
81 struct ipath_portdata {
82         void **port_rcvegrbuf;
83         dma_addr_t *port_rcvegrbuf_phys;
84         /* rcvhdrq base, needs mmap before useful */
85         void *port_rcvhdrq;
86         /* kernel virtual address where hdrqtail is updated */
87         void *port_rcvhdrtail_kvaddr;
88         /*
89          * temp buffer for expected send setup, allocated at open, instead
90          * of each setup call
91          */
92         void *port_tid_pg_list;
93         /* when waiting for rcv or pioavail */
94         wait_queue_head_t port_wait;
95         /*
96          * rcvegr bufs base, physical, must fit
97          * in 44 bits so 32 bit programs mmap64 44 bit works)
98          */
99         dma_addr_t port_rcvegr_phys;
100         /* mmap of hdrq, must fit in 44 bits */
101         dma_addr_t port_rcvhdrq_phys;
102         dma_addr_t port_rcvhdrqtailaddr_phys;
103         /*
104          * number of opens (including slave subports) on this instance
105          * (ignoring forks, dup, etc. for now)
106          */
107         int port_cnt;
108         /*
109          * how much space to leave at start of eager TID entries for
110          * protocol use, on each TID
111          */
112         /* instead of calculating it */
113         unsigned port_port;
114         /* non-zero if port is being shared. */
115         u16 port_subport_cnt;
116         /* non-zero if port is being shared. */
117         u16 port_subport_id;
118         /* chip offset of PIO buffers for this port */
119         u32 port_piobufs;
120         /* how many alloc_pages() chunks in port_rcvegrbuf_pages */
121         u32 port_rcvegrbuf_chunks;
122         /* how many egrbufs per chunk */
123         u32 port_rcvegrbufs_perchunk;
124         /* order for port_rcvegrbuf_pages */
125         size_t port_rcvegrbuf_size;
126         /* rcvhdrq size (for freeing) */
127         size_t port_rcvhdrq_size;
128         /* next expected TID to check when looking for free */
129         u32 port_tidcursor;
130         /* next expected TID to check */
131         unsigned long port_flag;
132         /* what happened */
133         unsigned long int_flag;
134         /* WAIT_RCV that timed out, no interrupt */
135         u32 port_rcvwait_to;
136         /* WAIT_PIO that timed out, no interrupt */
137         u32 port_piowait_to;
138         /* WAIT_RCV already happened, no wait */
139         u32 port_rcvnowait;
140         /* WAIT_PIO already happened, no wait */
141         u32 port_pionowait;
142         /* total number of rcvhdrqfull errors */
143         u32 port_hdrqfull;
144         /* saved total number of rcvhdrqfull errors for poll edge trigger */
145         u32 port_hdrqfull_poll;
146         /* total number of polled urgent packets */
147         u32 port_urgent;
148         /* saved total number of polled urgent packets for poll edge trigger */
149         u32 port_urgent_poll;
150         /* pid of process using this port */
151         pid_t port_pid;
152         /* same size as task_struct .comm[] */
153         char port_comm[16];
154         /* pkeys set by this use of this port */
155         u16 port_pkeys[4];
156         /* so file ops can get at unit */
157         struct ipath_devdata *port_dd;
158         /* A page of memory for rcvhdrhead, rcvegrhead, rcvegrtail * N */
159         void *subport_uregbase;
160         /* An array of pages for the eager receive buffers * N */
161         void *subport_rcvegrbuf;
162         /* An array of pages for the eager header queue entries * N */
163         void *subport_rcvhdr_base;
164         /* The version of the library which opened this port */
165         u32 userversion;
166         /* Bitmask of active slaves */
167         u32 active_slaves;
168         /* Type of packets or conditions we want to poll for */
169         u16 poll_type;
170         /* port rcvhdrq head offset */
171         u32 port_head;
172 };
173
174 struct sk_buff;
175
176 /*
177  * control information for layered drivers
178  */
179 struct _ipath_layer {
180         void *l_arg;
181 };
182
183 struct ipath_skbinfo {
184         struct sk_buff *skb;
185         dma_addr_t phys;
186 };
187
188 struct ipath_devdata {
189         struct list_head ipath_list;
190
191         struct ipath_kregs const *ipath_kregs;
192         struct ipath_cregs const *ipath_cregs;
193
194         /* mem-mapped pointer to base of chip regs */
195         u64 __iomem *ipath_kregbase;
196         /* end of mem-mapped chip space; range checking */
197         u64 __iomem *ipath_kregend;
198         /* physical address of chip for io_remap, etc. */
199         unsigned long ipath_physaddr;
200         /* base of memory alloced for ipath_kregbase, for free */
201         u64 *ipath_kregalloc;
202         /*
203          * virtual address where port0 rcvhdrqtail updated for this unit.
204          * only written to by the chip, not the driver.
205          */
206         volatile __le64 *ipath_hdrqtailptr;
207         /* ipath_cfgports pointers */
208         struct ipath_portdata **ipath_pd;
209         /* sk_buffs used by port 0 eager receive queue */
210         struct ipath_skbinfo *ipath_port0_skbinfo;
211         /* kvirt address of 1st 2k pio buffer */
212         void __iomem *ipath_pio2kbase;
213         /* kvirt address of 1st 4k pio buffer */
214         void __iomem *ipath_pio4kbase;
215         /*
216          * points to area where PIOavail registers will be DMA'ed.
217          * Has to be on a page of it's own, because the page will be
218          * mapped into user program space.  This copy is *ONLY* ever
219          * written by DMA, not by the driver!  Need a copy per device
220          * when we get to multiple devices
221          */
222         volatile __le64 *ipath_pioavailregs_dma;
223         /* physical address where updates occur */
224         dma_addr_t ipath_pioavailregs_phys;
225         struct _ipath_layer ipath_layer;
226         /* setup intr */
227         int (*ipath_f_intrsetup)(struct ipath_devdata *);
228         /* setup on-chip bus config */
229         int (*ipath_f_bus)(struct ipath_devdata *, struct pci_dev *);
230         /* hard reset chip */
231         int (*ipath_f_reset)(struct ipath_devdata *);
232         int (*ipath_f_get_boardname)(struct ipath_devdata *, char *,
233                                      size_t);
234         void (*ipath_f_init_hwerrors)(struct ipath_devdata *);
235         void (*ipath_f_handle_hwerrors)(struct ipath_devdata *, char *,
236                                         size_t);
237         void (*ipath_f_quiet_serdes)(struct ipath_devdata *);
238         int (*ipath_f_bringup_serdes)(struct ipath_devdata *);
239         int (*ipath_f_early_init)(struct ipath_devdata *);
240         void (*ipath_f_clear_tids)(struct ipath_devdata *, unsigned);
241         void (*ipath_f_put_tid)(struct ipath_devdata *, u64 __iomem*,
242                                 u32, unsigned long);
243         void (*ipath_f_tidtemplate)(struct ipath_devdata *);
244         void (*ipath_f_cleanup)(struct ipath_devdata *);
245         void (*ipath_f_setextled)(struct ipath_devdata *, u64, u64);
246         /* fill out chip-specific fields */
247         int (*ipath_f_get_base_info)(struct ipath_portdata *, void *);
248         /* free irq */
249         void (*ipath_f_free_irq)(struct ipath_devdata *);
250         struct ipath_ibdev *verbs_dev;
251         struct timer_list verbs_timer;
252         /* total dwords sent (summed from counter) */
253         u64 ipath_sword;
254         /* total dwords rcvd (summed from counter) */
255         u64 ipath_rword;
256         /* total packets sent (summed from counter) */
257         u64 ipath_spkts;
258         /* total packets rcvd (summed from counter) */
259         u64 ipath_rpkts;
260         /* ipath_statusp initially points to this. */
261         u64 _ipath_status;
262         /* GUID for this interface, in network order */
263         __be64 ipath_guid;
264         /*
265          * aggregrate of error bits reported since last cleared, for
266          * limiting of error reporting
267          */
268         ipath_err_t ipath_lasterror;
269         /*
270          * aggregrate of error bits reported since last cleared, for
271          * limiting of hwerror reporting
272          */
273         ipath_err_t ipath_lasthwerror;
274         /* errors masked because they occur too fast */
275         ipath_err_t ipath_maskederrs;
276         /* time in jiffies at which to re-enable maskederrs */
277         unsigned long ipath_unmasktime;
278         /* count of egrfull errors, combined for all ports */
279         u64 ipath_last_tidfull;
280         /* for ipath_qcheck() */
281         u64 ipath_lastport0rcv_cnt;
282         /* template for writing TIDs  */
283         u64 ipath_tidtemplate;
284         /* value to write to free TIDs */
285         u64 ipath_tidinvalid;
286         /* IBA6120 rcv interrupt setup */
287         u64 ipath_rhdrhead_intr_off;
288
289         /* size of memory at ipath_kregbase */
290         u32 ipath_kregsize;
291         /* number of registers used for pioavail */
292         u32 ipath_pioavregs;
293         /* IPATH_POLL, etc. */
294         u32 ipath_flags;
295         /* ipath_flags driver is waiting for */
296         u32 ipath_state_wanted;
297         /* last buffer for user use, first buf for kernel use is this
298          * index. */
299         u32 ipath_lastport_piobuf;
300         /* is a stats timer active */
301         u32 ipath_stats_timer_active;
302         /* number of interrupts for this device -- saturates... */
303         u32 ipath_int_counter;
304         /* dwords sent read from counter */
305         u32 ipath_lastsword;
306         /* dwords received read from counter */
307         u32 ipath_lastrword;
308         /* sent packets read from counter */
309         u32 ipath_lastspkts;
310         /* received packets read from counter */
311         u32 ipath_lastrpkts;
312         /* pio bufs allocated per port */
313         u32 ipath_pbufsport;
314         /*
315          * number of ports configured as max; zero is set to number chip
316          * supports, less gives more pio bufs/port, etc.
317          */
318         u32 ipath_cfgports;
319         /* count of port 0 hdrqfull errors */
320         u32 ipath_p0_hdrqfull;
321
322         /*
323          * (*cfgports) used to suppress multiple instances of same
324          * port staying stuck at same point
325          */
326         u32 *ipath_lastrcvhdrqtails;
327         /*
328          * (*cfgports) used to suppress multiple instances of same
329          * port staying stuck at same point
330          */
331         u32 *ipath_lastegrheads;
332         /*
333          * index of last piobuffer we used.  Speeds up searching, by
334          * starting at this point.  Doesn't matter if multiple cpu's use and
335          * update, last updater is only write that matters.  Whenever it
336          * wraps, we update shadow copies.  Need a copy per device when we
337          * get to multiple devices
338          */
339         u32 ipath_lastpioindex;
340         /* max length of freezemsg */
341         u32 ipath_freezelen;
342         /*
343          * consecutive times we wanted a PIO buffer but were unable to
344          * get one
345          */
346         u32 ipath_consec_nopiobuf;
347         /*
348          * hint that we should update ipath_pioavailshadow before
349          * looking for a PIO buffer
350          */
351         u32 ipath_upd_pio_shadow;
352         /* so we can rewrite it after a chip reset */
353         u32 ipath_pcibar0;
354         /* so we can rewrite it after a chip reset */
355         u32 ipath_pcibar1;
356
357         /* interrupt number */
358         int ipath_irq;
359         /* HT/PCI Vendor ID (here for NodeInfo) */
360         u16 ipath_vendorid;
361         /* HT/PCI Device ID (here for NodeInfo) */
362         u16 ipath_deviceid;
363         /* offset in HT config space of slave/primary interface block */
364         u8 ipath_ht_slave_off;
365         /* for write combining settings */
366         unsigned long ipath_wc_cookie;
367         unsigned long ipath_wc_base;
368         unsigned long ipath_wc_len;
369         /* ref count for each pkey */
370         atomic_t ipath_pkeyrefs[4];
371         /* shadow copy of all exptids physaddr; used only by funcsim */
372         u64 *ipath_tidsimshadow;
373         /* shadow copy of struct page *'s for exp tid pages */
374         struct page **ipath_pageshadow;
375         /* shadow copy of dma handles for exp tid pages */
376         dma_addr_t *ipath_physshadow;
377         /* lock to workaround chip bug 9437 */
378         spinlock_t ipath_tid_lock;
379         spinlock_t ipath_sendctrl_lock;
380
381         /*
382          * IPATH_STATUS_*,
383          * this address is mapped readonly into user processes so they can
384          * get status cheaply, whenever they want.
385          */
386         u64 *ipath_statusp;
387         /* freeze msg if hw error put chip in freeze */
388         char *ipath_freezemsg;
389         /* pci access data structure */
390         struct pci_dev *pcidev;
391         struct cdev *user_cdev;
392         struct cdev *diag_cdev;
393         struct class_device *user_class_dev;
394         struct class_device *diag_class_dev;
395         /* timer used to prevent stats overflow, error throttling, etc. */
396         struct timer_list ipath_stats_timer;
397         void *ipath_dummy_hdrq; /* used after port close */
398         dma_addr_t ipath_dummy_hdrq_phys;
399
400         /*
401          * Shadow copies of registers; size indicates read access size.
402          * Most of them are readonly, but some are write-only register,
403          * where we manipulate the bits in the shadow copy, and then write
404          * the shadow copy to infinipath.
405          *
406          * We deliberately make most of these 32 bits, since they have
407          * restricted range.  For any that we read, we won't to generate 32
408          * bit accesses, since Opteron will generate 2 separate 32 bit HT
409          * transactions for a 64 bit read, and we want to avoid unnecessary
410          * HT transactions.
411          */
412
413         /* This is the 64 bit group */
414
415         /*
416          * shadow of pioavail, check to be sure it's large enough at
417          * init time.
418          */
419         unsigned long ipath_pioavailshadow[8];
420         /* shadow of kr_gpio_out, for rmw ops */
421         u64 ipath_gpio_out;
422         /* shadow the gpio mask register */
423         u64 ipath_gpio_mask;
424         /* shadow the gpio output enable, etc... */
425         u64 ipath_extctrl;
426         /* kr_revision shadow */
427         u64 ipath_revision;
428         /*
429          * shadow of ibcctrl, for interrupt handling of link changes,
430          * etc.
431          */
432         u64 ipath_ibcctrl;
433         /*
434          * last ibcstatus, to suppress "duplicate" status change messages,
435          * mostly from 2 to 3
436          */
437         u64 ipath_lastibcstat;
438         /* hwerrmask shadow */
439         ipath_err_t ipath_hwerrmask;
440         ipath_err_t ipath_errormask; /* errormask shadow */
441         /* interrupt config reg shadow */
442         u64 ipath_intconfig;
443         /* kr_sendpiobufbase value */
444         u64 ipath_piobufbase;
445
446         /* these are the "32 bit" regs */
447
448         /*
449          * number of GUIDs in the flash for this interface; may need some
450          * rethinking for setting on other ifaces
451          */
452         u32 ipath_nguid;
453         /*
454          * the following two are 32-bit bitmasks, but {test,clear,set}_bit
455          * all expect bit fields to be "unsigned long"
456          */
457         /* shadow kr_rcvctrl */
458         unsigned long ipath_rcvctrl;
459         /* shadow kr_sendctrl */
460         unsigned long ipath_sendctrl;
461         unsigned long ipath_lastcancel; /* to not count armlaunch after cancel */
462
463         /* value we put in kr_rcvhdrcnt */
464         u32 ipath_rcvhdrcnt;
465         /* value we put in kr_rcvhdrsize */
466         u32 ipath_rcvhdrsize;
467         /* value we put in kr_rcvhdrentsize */
468         u32 ipath_rcvhdrentsize;
469         /* offset of last entry in rcvhdrq */
470         u32 ipath_hdrqlast;
471         /* kr_portcnt value */
472         u32 ipath_portcnt;
473         /* kr_pagealign value */
474         u32 ipath_palign;
475         /* number of "2KB" PIO buffers */
476         u32 ipath_piobcnt2k;
477         /* size in bytes of "2KB" PIO buffers */
478         u32 ipath_piosize2k;
479         /* number of "4KB" PIO buffers */
480         u32 ipath_piobcnt4k;
481         /* size in bytes of "4KB" PIO buffers */
482         u32 ipath_piosize4k;
483         /* kr_rcvegrbase value */
484         u32 ipath_rcvegrbase;
485         /* kr_rcvegrcnt value */
486         u32 ipath_rcvegrcnt;
487         /* kr_rcvtidbase value */
488         u32 ipath_rcvtidbase;
489         /* kr_rcvtidcnt value */
490         u32 ipath_rcvtidcnt;
491         /* kr_sendregbase */
492         u32 ipath_sregbase;
493         /* kr_userregbase */
494         u32 ipath_uregbase;
495         /* kr_counterregbase */
496         u32 ipath_cregbase;
497         /* shadow the control register contents */
498         u32 ipath_control;
499         /* PCI revision register (HTC rev on FPGA) */
500         u32 ipath_pcirev;
501
502         /* chip address space used by 4k pio buffers */
503         u32 ipath_4kalign;
504         /* The MTU programmed for this unit */
505         u32 ipath_ibmtu;
506         /*
507          * The max size IB packet, included IB headers that we can send.
508          * Starts same as ipath_piosize, but is affected when ibmtu is
509          * changed, or by size of eager buffers
510          */
511         u32 ipath_ibmaxlen;
512         /*
513          * ibmaxlen at init time, limited by chip and by receive buffer
514          * size.  Not changed after init.
515          */
516         u32 ipath_init_ibmaxlen;
517         /* size of each rcvegrbuffer */
518         u32 ipath_rcvegrbufsize;
519         /* width (2,4,8,16,32) from HT config reg */
520         u32 ipath_htwidth;
521         /* HT speed (200,400,800,1000) from HT config */
522         u32 ipath_htspeed;
523         /*
524          * number of sequential ibcstatus change for polling active/quiet
525          * (i.e., link not coming up).
526          */
527         u32 ipath_ibpollcnt;
528         /* low and high portions of MSI capability/vector */
529         u32 ipath_msi_lo;
530         /* saved after PCIe init for restore after reset */
531         u32 ipath_msi_hi;
532         /* MSI data (vector) saved for restore */
533         u16 ipath_msi_data;
534         /* MLID programmed for this instance */
535         u16 ipath_mlid;
536         /* LID programmed for this instance */
537         u16 ipath_lid;
538         /* list of pkeys programmed; 0 if not set */
539         u16 ipath_pkeys[4];
540         /*
541          * ASCII serial number, from flash, large enough for original
542          * all digit strings, and longer QLogic serial number format
543          */
544         u8 ipath_serial[16];
545         /* human readable board version */
546         u8 ipath_boardversion[80];
547         /* chip major rev, from ipath_revision */
548         u8 ipath_majrev;
549         /* chip minor rev, from ipath_revision */
550         u8 ipath_minrev;
551         /* board rev, from ipath_revision */
552         u8 ipath_boardrev;
553
554         u8 ipath_r_portenable_shift;
555         u8 ipath_r_intravail_shift;
556         u8 ipath_r_tailupd_shift;
557         u8 ipath_r_portcfg_shift;
558
559         /* unit # of this chip, if present */
560         int ipath_unit;
561         /* saved for restore after reset */
562         u8 ipath_pci_cacheline;
563         /* LID mask control */
564         u8 ipath_lmc;
565         /* Rx Polarity inversion (compensate for ~tx on partner) */
566         u8 ipath_rx_pol_inv;
567
568         /* local link integrity counter */
569         u32 ipath_lli_counter;
570         /* local link integrity errors */
571         u32 ipath_lli_errors;
572         /*
573          * Above counts only cases where _successive_ LocalLinkIntegrity
574          * errors were seen in the receive headers of kern-packets.
575          * Below are the three (monotonically increasing) counters
576          * maintained via GPIO interrupts on iba6120-rev2.
577          */
578         u32 ipath_rxfc_unsupvl_errs;
579         u32 ipath_overrun_thresh_errs;
580         u32 ipath_lli_errs;
581
582         /* status check work */
583         struct delayed_work status_work;
584
585         /*
586          * Not all devices managed by a driver instance are the same
587          * type, so these fields must be per-device.
588          */
589         u64 ipath_i_bitsextant;
590         ipath_err_t ipath_e_bitsextant;
591         ipath_err_t ipath_hwe_bitsextant;
592
593         /*
594          * Below should be computable from number of ports,
595          * since they are never modified.
596          */
597         u32 ipath_i_rcvavail_mask;
598         u32 ipath_i_rcvurg_mask;
599
600         /*
601          * Register bits for selecting i2c direction and values, used for
602          * I2C serial flash.
603          */
604         u16 ipath_gpio_sda_num;
605         u16 ipath_gpio_scl_num;
606         u64 ipath_gpio_sda;
607         u64 ipath_gpio_scl;
608
609         /* lock for doing RMW of shadows/regs for ExtCtrl and GPIO */
610         spinlock_t ipath_gpio_lock;
611
612         /* used to override LED behavior */
613         u8 ipath_led_override;  /* Substituted for normal value, if non-zero */
614         u16 ipath_led_override_timeoff; /* delta to next timer event */
615         u8 ipath_led_override_vals[2]; /* Alternates per blink-frame */
616         u8 ipath_led_override_phase; /* Just counts, LSB picks from vals[] */
617         atomic_t ipath_led_override_timer_active;
618         /* Used to flash LEDs in override mode */
619         struct timer_list ipath_led_override_timer;
620
621         /* Support (including locks) for EEPROM logging of errors and time */
622         /* control access to actual counters, timer */
623         spinlock_t ipath_eep_st_lock;
624         /* control high-level access to EEPROM */
625         struct mutex ipath_eep_lock;
626         /* Below inc'd by ipath_snap_cntrs(), locked by ipath_eep_st_lock */
627         uint64_t ipath_traffic_wds;
628         /* active time is kept in seconds, but logged in hours */
629         atomic_t ipath_active_time;
630         /* Below are nominal shadow of EEPROM, new since last EEPROM update */
631         uint8_t ipath_eep_st_errs[IPATH_EEP_LOG_CNT];
632         uint8_t ipath_eep_st_new_errs[IPATH_EEP_LOG_CNT];
633         uint16_t ipath_eep_hrs;
634         /*
635          * masks for which bits of errs, hwerrs that cause
636          * each of the counters to increment.
637          */
638         struct ipath_eep_log_mask ipath_eep_st_masks[IPATH_EEP_LOG_CNT];
639 };
640
641 /* Private data for file operations */
642 struct ipath_filedata {
643         struct ipath_portdata *pd;
644         unsigned subport;
645         unsigned tidcursor;
646 };
647 extern struct list_head ipath_dev_list;
648 extern spinlock_t ipath_devs_lock;
649 extern struct ipath_devdata *ipath_lookup(int unit);
650
651 int ipath_init_chip(struct ipath_devdata *, int);
652 int ipath_enable_wc(struct ipath_devdata *dd);
653 void ipath_disable_wc(struct ipath_devdata *dd);
654 int ipath_count_units(int *npresentp, int *nupp, u32 *maxportsp);
655 void ipath_shutdown_device(struct ipath_devdata *);
656 void ipath_clear_freeze(struct ipath_devdata *);
657
658 struct file_operations;
659 int ipath_cdev_init(int minor, char *name, const struct file_operations *fops,
660                     struct cdev **cdevp, struct class_device **class_devp);
661 void ipath_cdev_cleanup(struct cdev **cdevp,
662                         struct class_device **class_devp);
663
664 int ipath_diag_add(struct ipath_devdata *);
665 void ipath_diag_remove(struct ipath_devdata *);
666
667 extern wait_queue_head_t ipath_state_wait;
668
669 int ipath_user_add(struct ipath_devdata *dd);
670 void ipath_user_remove(struct ipath_devdata *dd);
671
672 struct sk_buff *ipath_alloc_skb(struct ipath_devdata *dd, gfp_t);
673
674 extern int ipath_diag_inuse;
675
676 irqreturn_t ipath_intr(int irq, void *devid);
677 int ipath_decode_err(char *buf, size_t blen, ipath_err_t err);
678 #if __IPATH_INFO || __IPATH_DBG
679 extern const char *ipath_ibcstatus_str[];
680 #endif
681
682 /* clean up any per-chip chip-specific stuff */
683 void ipath_chip_cleanup(struct ipath_devdata *);
684 /* clean up any chip type-specific stuff */
685 void ipath_chip_done(void);
686
687 /* check to see if we have to force ordering for write combining */
688 int ipath_unordered_wc(void);
689
690 void ipath_disarm_piobufs(struct ipath_devdata *, unsigned first,
691                           unsigned cnt);
692 void ipath_cancel_sends(struct ipath_devdata *, int);
693
694 int ipath_create_rcvhdrq(struct ipath_devdata *, struct ipath_portdata *);
695 void ipath_free_pddata(struct ipath_devdata *, struct ipath_portdata *);
696
697 int ipath_parse_ushort(const char *str, unsigned short *valp);
698
699 void ipath_kreceive(struct ipath_portdata *);
700 int ipath_setrcvhdrsize(struct ipath_devdata *, unsigned);
701 int ipath_reset_device(int);
702 void ipath_get_faststats(unsigned long);
703 int ipath_set_linkstate(struct ipath_devdata *, u8);
704 int ipath_set_mtu(struct ipath_devdata *, u16);
705 int ipath_set_lid(struct ipath_devdata *, u32, u8);
706 int ipath_set_rx_pol_inv(struct ipath_devdata *dd, u8 new_pol_inv);
707
708 /* for use in system calls, where we want to know device type, etc. */
709 #define port_fp(fp) ((struct ipath_filedata *)(fp)->private_data)->pd
710 #define subport_fp(fp) \
711         ((struct ipath_filedata *)(fp)->private_data)->subport
712 #define tidcursor_fp(fp) \
713         ((struct ipath_filedata *)(fp)->private_data)->tidcursor
714
715 /*
716  * values for ipath_flags
717  */
718 /* The chip is up and initted */
719 #define IPATH_INITTED       0x2
720                 /* set if any user code has set kr_rcvhdrsize */
721 #define IPATH_RCVHDRSZ_SET  0x4
722                 /* The chip is present and valid for accesses */
723 #define IPATH_PRESENT       0x8
724                 /* HT link0 is only 8 bits wide, ignore upper byte crc
725                  * errors, etc. */
726 #define IPATH_8BIT_IN_HT0   0x10
727                 /* HT link1 is only 8 bits wide, ignore upper byte crc
728                  * errors, etc. */
729 #define IPATH_8BIT_IN_HT1   0x20
730                 /* The link is down */
731 #define IPATH_LINKDOWN      0x40
732                 /* The link level is up (0x11) */
733 #define IPATH_LINKINIT      0x80
734                 /* The link is in the armed (0x21) state */
735 #define IPATH_LINKARMED     0x100
736                 /* The link is in the active (0x31) state */
737 #define IPATH_LINKACTIVE    0x200
738                 /* link current state is unknown */
739 #define IPATH_LINKUNK       0x400
740                 /* Write combining flush needed for PIO */
741 #define IPATH_PIO_FLUSH_WC  0x1000
742                 /* no IB cable, or no device on IB cable */
743 #define IPATH_NOCABLE       0x4000
744                 /* Supports port zero per packet receive interrupts via
745                  * GPIO */
746 #define IPATH_GPIO_INTR     0x8000
747                 /* uses the coded 4byte TID, not 8 byte */
748 #define IPATH_4BYTE_TID     0x10000
749                 /* packet/word counters are 32 bit, else those 4 counters
750                  * are 64bit */
751 #define IPATH_32BITCOUNTERS 0x20000
752                 /* can miss port0 rx interrupts */
753 #define IPATH_DISABLED      0x80000 /* administratively disabled */
754                 /* Use GPIO interrupts for new counters */
755 #define IPATH_GPIO_ERRINTRS 0x100000
756
757 /* Bits in GPIO for the added interrupts */
758 #define IPATH_GPIO_PORT0_BIT 2
759 #define IPATH_GPIO_RXUVL_BIT 3
760 #define IPATH_GPIO_OVRUN_BIT 4
761 #define IPATH_GPIO_LLI_BIT 5
762 #define IPATH_GPIO_ERRINTR_MASK 0x38
763
764 /* portdata flag bit offsets */
765                 /* waiting for a packet to arrive */
766 #define IPATH_PORT_WAITING_RCV   2
767                 /* master has not finished initializing */
768 #define IPATH_PORT_MASTER_UNINIT 4
769                 /* waiting for an urgent packet to arrive */
770 #define IPATH_PORT_WAITING_URG 5
771
772 /* free up any allocated data at closes */
773 void ipath_free_data(struct ipath_portdata *dd);
774 int ipath_waitfor_mdio_cmdready(struct ipath_devdata *);
775 int ipath_waitfor_complete(struct ipath_devdata *, ipath_kreg, u64, u64 *);
776 u32 __iomem *ipath_getpiobuf(struct ipath_devdata *, u32 *);
777 void ipath_init_iba6120_funcs(struct ipath_devdata *);
778 void ipath_init_iba6110_funcs(struct ipath_devdata *);
779 void ipath_get_eeprom_info(struct ipath_devdata *);
780 int ipath_update_eeprom_log(struct ipath_devdata *dd);
781 void ipath_inc_eeprom_err(struct ipath_devdata *dd, u32 eidx, u32 incr);
782 u64 ipath_snap_cntr(struct ipath_devdata *, ipath_creg);
783 void signal_ib_event(struct ipath_devdata *dd, enum ib_event_type ev);
784
785 /*
786  * Set LED override, only the two LSBs have "public" meaning, but
787  * any non-zero value substitutes them for the Link and LinkTrain
788  * LED states.
789  */
790 #define IPATH_LED_PHYS 1 /* Physical (linktraining) GREEN LED */
791 #define IPATH_LED_LOG 2  /* Logical (link) YELLOW LED */
792 void ipath_set_led_override(struct ipath_devdata *dd, unsigned int val);
793
794 /*
795  * number of words used for protocol header if not set by ipath_userinit();
796  */
797 #define IPATH_DFLT_RCVHDRSIZE 9
798
799 #define IPATH_MDIO_CMD_WRITE   1
800 #define IPATH_MDIO_CMD_READ    2
801 #define IPATH_MDIO_CLD_DIV     25       /* to get 2.5 Mhz mdio clock */
802 #define IPATH_MDIO_CMDVALID    0x40000000       /* bit 30 */
803 #define IPATH_MDIO_DATAVALID   0x80000000       /* bit 31 */
804 #define IPATH_MDIO_CTRL_STD    0x0
805
806 static inline u64 ipath_mdio_req(int cmd, int dev, int reg, int data)
807 {
808         return (((u64) IPATH_MDIO_CLD_DIV) << 32) |
809                 (cmd << 26) |
810                 (dev << 21) |
811                 (reg << 16) |
812                 (data & 0xFFFF);
813 }
814
815                 /* signal and fifo status, in bank 31 */
816 #define IPATH_MDIO_CTRL_XGXS_REG_8  0x8
817                 /* controls loopback, redundancy */
818 #define IPATH_MDIO_CTRL_8355_REG_1  0x10
819                 /* premph, encdec, etc. */
820 #define IPATH_MDIO_CTRL_8355_REG_2  0x11
821                 /* Kchars, etc. */
822 #define IPATH_MDIO_CTRL_8355_REG_6  0x15
823 #define IPATH_MDIO_CTRL_8355_REG_9  0x18
824 #define IPATH_MDIO_CTRL_8355_REG_10 0x1D
825
826 int ipath_get_user_pages(unsigned long, size_t, struct page **);
827 void ipath_release_user_pages(struct page **, size_t);
828 void ipath_release_user_pages_on_close(struct page **, size_t);
829 int ipath_eeprom_read(struct ipath_devdata *, u8, void *, int);
830 int ipath_eeprom_write(struct ipath_devdata *, u8, const void *, int);
831
832 /* these are used for the registers that vary with port */
833 void ipath_write_kreg_port(const struct ipath_devdata *, ipath_kreg,
834                            unsigned, u64);
835
836 /*
837  * We could have a single register get/put routine, that takes a group type,
838  * but this is somewhat clearer and cleaner.  It also gives us some error
839  * checking.  64 bit register reads should always work, but are inefficient
840  * on opteron (the northbridge always generates 2 separate HT 32 bit reads),
841  * so we use kreg32 wherever possible.  User register and counter register
842  * reads are always 32 bit reads, so only one form of those routines.
843  */
844
845 /*
846  * At the moment, none of the s-registers are writable, so no
847  * ipath_write_sreg(), and none of the c-registers are writable, so no
848  * ipath_write_creg().
849  */
850
851 /**
852  * ipath_read_ureg32 - read 32-bit virtualized per-port register
853  * @dd: device
854  * @regno: register number
855  * @port: port number
856  *
857  * Return the contents of a register that is virtualized to be per port.
858  * Returns -1 on errors (not distinguishable from valid contents at
859  * runtime; we may add a separate error variable at some point).
860  */
861 static inline u32 ipath_read_ureg32(const struct ipath_devdata *dd,
862                                     ipath_ureg regno, int port)
863 {
864         if (!dd->ipath_kregbase || !(dd->ipath_flags & IPATH_PRESENT))
865                 return 0;
866
867         return readl(regno + (u64 __iomem *)
868                      (dd->ipath_uregbase +
869                       (char __iomem *)dd->ipath_kregbase +
870                       dd->ipath_palign * port));
871 }
872
873 /**
874  * ipath_write_ureg - write 32-bit virtualized per-port register
875  * @dd: device
876  * @regno: register number
877  * @value: value
878  * @port: port
879  *
880  * Write the contents of a register that is virtualized to be per port.
881  */
882 static inline void ipath_write_ureg(const struct ipath_devdata *dd,
883                                     ipath_ureg regno, u64 value, int port)
884 {
885         u64 __iomem *ubase = (u64 __iomem *)
886                 (dd->ipath_uregbase + (char __iomem *) dd->ipath_kregbase +
887                  dd->ipath_palign * port);
888         if (dd->ipath_kregbase)
889                 writeq(value, &ubase[regno]);
890 }
891
892 static inline u32 ipath_read_kreg32(const struct ipath_devdata *dd,
893                                     ipath_kreg regno)
894 {
895         if (!dd->ipath_kregbase || !(dd->ipath_flags & IPATH_PRESENT))
896                 return -1;
897         return readl((u32 __iomem *) & dd->ipath_kregbase[regno]);
898 }
899
900 static inline u64 ipath_read_kreg64(const struct ipath_devdata *dd,
901                                     ipath_kreg regno)
902 {
903         if (!dd->ipath_kregbase || !(dd->ipath_flags & IPATH_PRESENT))
904                 return -1;
905
906         return readq(&dd->ipath_kregbase[regno]);
907 }
908
909 static inline void ipath_write_kreg(const struct ipath_devdata *dd,
910                                     ipath_kreg regno, u64 value)
911 {
912         if (dd->ipath_kregbase)
913                 writeq(value, &dd->ipath_kregbase[regno]);
914 }
915
916 static inline u64 ipath_read_creg(const struct ipath_devdata *dd,
917                                   ipath_sreg regno)
918 {
919         if (!dd->ipath_kregbase || !(dd->ipath_flags & IPATH_PRESENT))
920                 return 0;
921
922         return readq(regno + (u64 __iomem *)
923                      (dd->ipath_cregbase +
924                       (char __iomem *)dd->ipath_kregbase));
925 }
926
927 static inline u32 ipath_read_creg32(const struct ipath_devdata *dd,
928                                          ipath_sreg regno)
929 {
930         if (!dd->ipath_kregbase || !(dd->ipath_flags & IPATH_PRESENT))
931                 return 0;
932         return readl(regno + (u64 __iomem *)
933                      (dd->ipath_cregbase +
934                       (char __iomem *)dd->ipath_kregbase));
935 }
936
937 static inline void ipath_clear_rcvhdrtail(const struct ipath_portdata *pd)
938 {
939         *((u64 *) pd->port_rcvhdrtail_kvaddr) = 0ULL;
940 }
941
942 static inline u32 ipath_get_rcvhdrtail(const struct ipath_portdata *pd)
943 {
944         return (u32) le64_to_cpu(*((volatile __le64 *)
945                                 pd->port_rcvhdrtail_kvaddr));
946 }
947
948 /*
949  * sysfs interface.
950  */
951
952 struct device_driver;
953
954 extern const char ib_ipath_version[];
955
956 extern struct attribute_group *ipath_driver_attr_groups[];
957
958 int ipath_device_create_group(struct device *, struct ipath_devdata *);
959 void ipath_device_remove_group(struct device *, struct ipath_devdata *);
960 int ipath_expose_reset(struct device *);
961
962 int ipath_init_ipathfs(void);
963 void ipath_exit_ipathfs(void);
964 int ipathfs_add_device(struct ipath_devdata *);
965 int ipathfs_remove_device(struct ipath_devdata *);
966
967 /*
968  * dma_addr wrappers - all 0's invalid for hw
969  */
970 dma_addr_t ipath_map_page(struct pci_dev *, struct page *, unsigned long,
971                           size_t, int);
972 dma_addr_t ipath_map_single(struct pci_dev *, void *, size_t, int);
973
974 /*
975  * Flush write combining store buffers (if present) and perform a write
976  * barrier.
977  */
978 #if defined(CONFIG_X86_64)
979 #define ipath_flush_wc() asm volatile("sfence" ::: "memory")
980 #else
981 #define ipath_flush_wc() wmb()
982 #endif
983
984 extern unsigned ipath_debug; /* debugging bit mask */
985
986 #define IPATH_MAX_PARITY_ATTEMPTS 10000 /* max times to try recovery */
987
988 const char *ipath_get_unit_name(int unit);
989
990 extern struct mutex ipath_mutex;
991
992 #define IPATH_DRV_NAME          "ib_ipath"
993 #define IPATH_MAJOR             233
994 #define IPATH_USER_MINOR_BASE   0
995 #define IPATH_DIAGPKT_MINOR     127
996 #define IPATH_DIAG_MINOR_BASE   129
997 #define IPATH_NMINORS           255
998
999 #define ipath_dev_err(dd,fmt,...) \
1000         do { \
1001                 const struct ipath_devdata *__dd = (dd); \
1002                 if (__dd->pcidev) \
1003                         dev_err(&__dd->pcidev->dev, "%s: " fmt, \
1004                                 ipath_get_unit_name(__dd->ipath_unit), \
1005                                 ##__VA_ARGS__); \
1006                 else \
1007                         printk(KERN_ERR IPATH_DRV_NAME ": %s: " fmt, \
1008                                ipath_get_unit_name(__dd->ipath_unit), \
1009                                ##__VA_ARGS__); \
1010         } while (0)
1011
1012 #if _IPATH_DEBUGGING
1013
1014 # define __IPATH_DBG_WHICH(which,fmt,...) \
1015         do { \
1016                 if(unlikely(ipath_debug&(which))) \
1017                         printk(KERN_DEBUG IPATH_DRV_NAME ": %s: " fmt, \
1018                                __func__,##__VA_ARGS__); \
1019         } while(0)
1020
1021 # define ipath_dbg(fmt,...) \
1022         __IPATH_DBG_WHICH(__IPATH_DBG,fmt,##__VA_ARGS__)
1023 # define ipath_cdbg(which,fmt,...) \
1024         __IPATH_DBG_WHICH(__IPATH_##which##DBG,fmt,##__VA_ARGS__)
1025
1026 #else /* ! _IPATH_DEBUGGING */
1027
1028 # define ipath_dbg(fmt,...)
1029 # define ipath_cdbg(which,fmt,...)
1030
1031 #endif /* _IPATH_DEBUGGING */
1032
1033 /*
1034  * this is used for formatting hw error messages...
1035  */
1036 struct ipath_hwerror_msgs {
1037         u64 mask;
1038         const char *msg;
1039 };
1040
1041 #define INFINIPATH_HWE_MSG(a, b) { .mask = INFINIPATH_HWE_##a, .msg = b }
1042
1043 /* in ipath_intr.c... */
1044 void ipath_format_hwerrors(u64 hwerrs,
1045                            const struct ipath_hwerror_msgs *hwerrmsgs,
1046                            size_t nhwerrmsgs,
1047                            char *msg, size_t lmsg);
1048
1049 #endif                          /* _IPATH_KERNEL_H */