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