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