IPoIB: Make sure no receives are handled when stopping device
[linux-2.6] / drivers / infiniband / hw / ipath / ipath_common.h
1 /*
2  * Copyright (c) 2006, 2007 QLogic Corporation. All rights reserved.
3  * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33
34 #ifndef _IPATH_COMMON_H
35 #define _IPATH_COMMON_H
36
37 /*
38  * This file contains defines, structures, etc. that are used
39  * to communicate between kernel and user code.
40  */
41
42
43 /* This is the IEEE-assigned OUI for QLogic Inc. InfiniPath */
44 #define IPATH_SRC_OUI_1 0x00
45 #define IPATH_SRC_OUI_2 0x11
46 #define IPATH_SRC_OUI_3 0x75
47
48 /* version of protocol header (known to chip also). In the long run,
49  * we should be able to generate and accept a range of version numbers;
50  * for now we only accept one, and it's compiled in.
51  */
52 #define IPS_PROTO_VERSION 2
53
54 /*
55  * These are compile time constants that you may want to enable or disable
56  * if you are trying to debug problems with code or performance.
57  * IPATH_VERBOSE_TRACING define as 1 if you want additional tracing in
58  * fastpath code
59  * IPATH_TRACE_REGWRITES define as 1 if you want register writes to be
60  * traced in faspath code
61  * _IPATH_TRACING define as 0 if you want to remove all tracing in a
62  * compilation unit
63  * _IPATH_DEBUGGING define as 0 if you want to remove debug prints
64  */
65
66 /*
67  * The value in the BTH QP field that InfiniPath uses to differentiate
68  * an infinipath protocol IB packet vs standard IB transport
69  */
70 #define IPATH_KD_QP 0x656b79
71
72 /*
73  * valid states passed to ipath_set_linkstate() user call
74  */
75 #define IPATH_IB_LINKDOWN               0
76 #define IPATH_IB_LINKARM                1
77 #define IPATH_IB_LINKACTIVE             2
78 #define IPATH_IB_LINKINIT               3
79 #define IPATH_IB_LINKDOWN_SLEEP         4
80 #define IPATH_IB_LINKDOWN_DISABLE       5
81 #define IPATH_IB_LINK_LOOPBACK  6 /* enable local loopback */
82 #define IPATH_IB_LINK_EXTERNAL  7 /* normal, disable local loopback */
83
84 /*
85  * stats maintained by the driver.  For now, at least, this is global
86  * to all minor devices.
87  */
88 struct infinipath_stats {
89         /* number of interrupts taken */
90         __u64 sps_ints;
91         /* number of interrupts for errors */
92         __u64 sps_errints;
93         /* number of errors from chip (not incl. packet errors or CRC) */
94         __u64 sps_errs;
95         /* number of packet errors from chip other than CRC */
96         __u64 sps_pkterrs;
97         /* number of packets with CRC errors (ICRC and VCRC) */
98         __u64 sps_crcerrs;
99         /* number of hardware errors reported (parity, etc.) */
100         __u64 sps_hwerrs;
101         /* number of times IB link changed state unexpectedly */
102         __u64 sps_iblink;
103         __u64 sps_unused; /* was fastrcvint, no longer implemented */
104         /* number of kernel (port0) packets received */
105         __u64 sps_port0pkts;
106         /* number of "ethernet" packets sent by driver */
107         __u64 sps_ether_spkts;
108         /* number of "ethernet" packets received by driver */
109         __u64 sps_ether_rpkts;
110         /* number of SMA packets sent by driver. Obsolete. */
111         __u64 sps_sma_spkts;
112         /* number of SMA packets received by driver. Obsolete. */
113         __u64 sps_sma_rpkts;
114         /* number of times all ports rcvhdrq was full and packet dropped */
115         __u64 sps_hdrqfull;
116         /* number of times all ports egrtid was full and packet dropped */
117         __u64 sps_etidfull;
118         /*
119          * number of times we tried to send from driver, but no pio buffers
120          * avail
121          */
122         __u64 sps_nopiobufs;
123         /* number of ports currently open */
124         __u64 sps_ports;
125         /* list of pkeys (other than default) accepted (0 means not set) */
126         __u16 sps_pkeys[4];
127         __u16 sps_unused16[4]; /* available; maintaining compatible layout */
128         /* number of user ports per chip (not IB ports) */
129         __u32 sps_nports;
130         /* not our interrupt, or already handled */
131         __u32 sps_nullintr;
132         /* max number of packets handled per receive call */
133         __u32 sps_maxpkts_call;
134         /* avg number of packets handled per receive call */
135         __u32 sps_avgpkts_call;
136         /* total number of pages locked */
137         __u64 sps_pagelocks;
138         /* total number of pages unlocked */
139         __u64 sps_pageunlocks;
140         /*
141          * Number of packets dropped in kernel other than errors (ether
142          * packets if ipath not configured, etc.)
143          */
144         __u64 sps_krdrops;
145         __u64 sps_txeparity; /* PIO buffer parity error, recovered */
146         /* pad for future growth */
147         __u64 __sps_pad[45];
148 };
149
150 /*
151  * These are the status bits readable (in ascii form, 64bit value)
152  * from the "status" sysfs file.
153  */
154 #define IPATH_STATUS_INITTED       0x1  /* basic initialization done */
155 #define IPATH_STATUS_DISABLED      0x2  /* hardware disabled */
156 /* Device has been disabled via admin request */
157 #define IPATH_STATUS_ADMIN_DISABLED    0x4
158 /* Chip has been found and initted */
159 #define IPATH_STATUS_CHIP_PRESENT 0x20
160 /* IB link is at ACTIVE, usable for data traffic */
161 #define IPATH_STATUS_IB_READY     0x40
162 /* link is configured, LID, MTU, etc. have been set */
163 #define IPATH_STATUS_IB_CONF      0x80
164 /* no link established, probably no cable */
165 #define IPATH_STATUS_IB_NOCABLE  0x100
166 /* A Fatal hardware error has occurred. */
167 #define IPATH_STATUS_HWERROR     0x200
168
169 /*
170  * The list of usermode accessible registers.  Also see Reg_* later in file.
171  */
172 typedef enum _ipath_ureg {
173         /* (RO)  DMA RcvHdr to be used next. */
174         ur_rcvhdrtail = 0,
175         /* (RW)  RcvHdr entry to be processed next by host. */
176         ur_rcvhdrhead = 1,
177         /* (RO)  Index of next Eager index to use. */
178         ur_rcvegrindextail = 2,
179         /* (RW)  Eager TID to be processed next */
180         ur_rcvegrindexhead = 3,
181         /* For internal use only; max register number. */
182         _IPATH_UregMax
183 } ipath_ureg;
184
185 /* bit values for spi_runtime_flags */
186 #define IPATH_RUNTIME_HT        0x1
187 #define IPATH_RUNTIME_PCIE      0x2
188 #define IPATH_RUNTIME_FORCE_WC_ORDER    0x4
189 #define IPATH_RUNTIME_RCVHDR_COPY       0x8
190 #define IPATH_RUNTIME_MASTER    0x10
191 /* 0x20 and 0x40 are no longer used, but are reserved for ABI compatibility */
192
193 /*
194  * This structure is returned by ipath_userinit() immediately after
195  * open to get implementation-specific info, and info specific to this
196  * instance.
197  *
198  * This struct must have explict pad fields where type sizes
199  * may result in different alignments between 32 and 64 bit
200  * programs, since the 64 bit * bit kernel requires the user code
201  * to have matching offsets
202  */
203 struct ipath_base_info {
204         /* version of hardware, for feature checking. */
205         __u32 spi_hw_version;
206         /* version of software, for feature checking. */
207         __u32 spi_sw_version;
208         /* InfiniPath port assigned, goes into sent packets */
209         __u16 spi_port;
210         __u16 spi_subport;
211         /*
212          * IB MTU, packets IB data must be less than this.
213          * The MTU is in bytes, and will be a multiple of 4 bytes.
214          */
215         __u32 spi_mtu;
216         /*
217          * Size of a PIO buffer.  Any given packet's total size must be less
218          * than this (in words).  Included is the starting control word, so
219          * if 513 is returned, then total pkt size is 512 words or less.
220          */
221         __u32 spi_piosize;
222         /* size of the TID cache in infinipath, in entries */
223         __u32 spi_tidcnt;
224         /* size of the TID Eager list in infinipath, in entries */
225         __u32 spi_tidegrcnt;
226         /* size of a single receive header queue entry in words. */
227         __u32 spi_rcvhdrent_size;
228         /*
229          * Count of receive header queue entries allocated.
230          * This may be less than the spu_rcvhdrcnt passed in!.
231          */
232         __u32 spi_rcvhdr_cnt;
233
234         /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
235         __u32 spi_runtime_flags;
236
237         /* address where receive buffer queue is mapped into */
238         __u64 spi_rcvhdr_base;
239
240         /* user program. */
241
242         /* base address of eager TID receive buffers. */
243         __u64 spi_rcv_egrbufs;
244
245         /* Allocated by initialization code, not by protocol. */
246
247         /*
248          * Size of each TID buffer in host memory, starting at
249          * spi_rcv_egrbufs.  The buffers are virtually contiguous.
250          */
251         __u32 spi_rcv_egrbufsize;
252         /*
253          * The special QP (queue pair) value that identifies an infinipath
254          * protocol packet from standard IB packets.  More, probably much
255          * more, to be added.
256          */
257         __u32 spi_qpair;
258
259         /*
260          * User register base for init code, not to be used directly by
261          * protocol or applications.
262          */
263         __u64 __spi_uregbase;
264         /*
265          * Maximum buffer size in bytes that can be used in a single TID
266          * entry (assuming the buffer is aligned to this boundary).  This is
267          * the minimum of what the hardware and software support Guaranteed
268          * to be a power of 2.
269          */
270         __u32 spi_tid_maxsize;
271         /*
272          * alignment of each pio send buffer (byte count
273          * to add to spi_piobufbase to get to second buffer)
274          */
275         __u32 spi_pioalign;
276         /*
277          * The index of the first pio buffer available to this process;
278          * needed to do lookup in spi_pioavailaddr; not added to
279          * spi_piobufbase.
280          */
281         __u32 spi_pioindex;
282          /* number of buffers mapped for this process */
283         __u32 spi_piocnt;
284
285         /*
286          * Base address of writeonly pio buffers for this process.
287          * Each buffer has spi_piosize words, and is aligned on spi_pioalign
288          * boundaries.  spi_piocnt buffers are mapped from this address
289          */
290         __u64 spi_piobufbase;
291
292         /*
293          * Base address of readonly memory copy of the pioavail registers.
294          * There are 2 bits for each buffer.
295          */
296         __u64 spi_pioavailaddr;
297
298         /*
299          * Address where driver updates a copy of the interface and driver
300          * status (IPATH_STATUS_*) as a 64 bit value.  It's followed by a
301          * string indicating hardware error, if there was one.
302          */
303         __u64 spi_status;
304
305         /* number of chip ports available to user processes */
306         __u32 spi_nports;
307         /* unit number of chip we are using */
308         __u32 spi_unit;
309         /* num bufs in each contiguous set */
310         __u32 spi_rcv_egrperchunk;
311         /* size in bytes of each contiguous set */
312         __u32 spi_rcv_egrchunksize;
313         /* total size of mmap to cover full rcvegrbuffers */
314         __u32 spi_rcv_egrbuftotlen;
315         __u32 spi_filler_for_align;
316         /* address of readonly memory copy of the rcvhdrq tail register. */
317         __u64 spi_rcvhdr_tailaddr;
318
319         /* shared memory pages for subports if port is shared */
320         __u64 spi_subport_uregbase;
321         __u64 spi_subport_rcvegrbuf;
322         __u64 spi_subport_rcvhdr_base;
323
324         /* shared memory page for hardware port if it is shared */
325         __u64 spi_port_uregbase;
326         __u64 spi_port_rcvegrbuf;
327         __u64 spi_port_rcvhdr_base;
328         __u64 spi_port_rcvhdr_tailaddr;
329
330 } __attribute__ ((aligned(8)));
331
332
333 /*
334  * This version number is given to the driver by the user code during
335  * initialization in the spu_userversion field of ipath_user_info, so
336  * the driver can check for compatibility with user code.
337  *
338  * The major version changes when data structures
339  * change in an incompatible way.  The driver must be the same or higher
340  * for initialization to succeed.  In some cases, a higher version
341  * driver will not interoperate with older software, and initialization
342  * will return an error.
343  */
344 #define IPATH_USER_SWMAJOR 1
345
346 /*
347  * Minor version differences are always compatible
348  * a within a major version, however if user software is larger
349  * than driver software, some new features and/or structure fields
350  * may not be implemented; the user code must deal with this if it
351  * cares, or it must abort after initialization reports the difference.
352  */
353 #define IPATH_USER_SWMINOR 5
354
355 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
356
357 #define IPATH_KERN_TYPE 0
358
359 /*
360  * Similarly, this is the kernel version going back to the user.  It's
361  * slightly different, in that we want to tell if the driver was built as
362  * part of a QLogic release, or from the driver from openfabrics.org,
363  * kernel.org, or a standard distribution, for support reasons.
364  * The high bit is 0 for non-QLogic and 1 for QLogic-built/supplied.
365  *
366  * It's returned by the driver to the user code during initialization in the
367  * spi_sw_version field of ipath_base_info, so the user code can in turn
368  * check for compatibility with the kernel.
369 */
370 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
371
372 /*
373  * This structure is passed to ipath_userinit() to tell the driver where
374  * user code buffers are, sizes, etc.   The offsets and sizes of the
375  * fields must remain unchanged, for binary compatibility.  It can
376  * be extended, if userversion is changed so user code can tell, if needed
377  */
378 struct ipath_user_info {
379         /*
380          * version of user software, to detect compatibility issues.
381          * Should be set to IPATH_USER_SWVERSION.
382          */
383         __u32 spu_userversion;
384
385         /* desired number of receive header queue entries */
386         __u32 spu_rcvhdrcnt;
387
388         /* size of struct base_info to write to */
389         __u32 spu_base_info_size;
390
391         /*
392          * number of words in KD protocol header
393          * This tells InfiniPath how many words to copy to rcvhdrq.  If 0,
394          * kernel uses a default.  Once set, attempts to set any other value
395          * are an error (EAGAIN) until driver is reloaded.
396          */
397         __u32 spu_rcvhdrsize;
398
399         /*
400          * If two or more processes wish to share a port, each process
401          * must set the spu_subport_cnt and spu_subport_id to the same
402          * values.  The only restriction on the spu_subport_id is that
403          * it be unique for a given node.
404          */
405         __u16 spu_subport_cnt;
406         __u16 spu_subport_id;
407
408         __u32 spu_unused; /* kept for compatible layout */
409
410         /*
411          * address of struct base_info to write to
412          */
413         __u64 spu_base_info;
414
415 } __attribute__ ((aligned(8)));
416
417 /* User commands. */
418
419 #define IPATH_CMD_MIN           16
420
421 #define __IPATH_CMD_USER_INIT   16      /* old set up userspace (for old user code) */
422 #define IPATH_CMD_PORT_INFO     17      /* find out what resources we got */
423 #define IPATH_CMD_RECV_CTRL     18      /* control receipt of packets */
424 #define IPATH_CMD_TID_UPDATE    19      /* update expected TID entries */
425 #define IPATH_CMD_TID_FREE      20      /* free expected TID entries */
426 #define IPATH_CMD_SET_PART_KEY  21      /* add partition key */
427 #define __IPATH_CMD_SLAVE_INFO  22      /* return info on slave processes (for old user code) */
428 #define IPATH_CMD_ASSIGN_PORT   23      /* allocate HCA and port */
429 #define IPATH_CMD_USER_INIT     24      /* set up userspace */
430 #define IPATH_CMD_UNUSED_1      25
431 #define IPATH_CMD_UNUSED_2      26
432 #define IPATH_CMD_PIOAVAILUPD   27      /* force an update of PIOAvail reg */
433 #define IPATH_CMD_POLL_TYPE     28      /* set the kind of polling we want */
434
435 #define IPATH_CMD_MAX           28
436
437 /*
438  * Poll types
439  */
440 #define IPATH_POLL_TYPE_URGENT   0x01
441 #define IPATH_POLL_TYPE_OVERFLOW 0x02
442
443 struct ipath_port_info {
444         __u32 num_active;       /* number of active units */
445         __u32 unit;             /* unit (chip) assigned to caller */
446         __u16 port;             /* port on unit assigned to caller */
447         __u16 subport;          /* subport on unit assigned to caller */
448         __u16 num_ports;        /* number of ports available on unit */
449         __u16 num_subports;     /* number of subports opened on port */
450 };
451
452 struct ipath_tid_info {
453         __u32 tidcnt;
454         /* make structure same size in 32 and 64 bit */
455         __u32 tid__unused;
456         /* virtual address of first page in transfer */
457         __u64 tidvaddr;
458         /* pointer (same size 32/64 bit) to __u16 tid array */
459         __u64 tidlist;
460
461         /*
462          * pointer (same size 32/64 bit) to bitmap of TIDs used
463          * for this call; checked for being large enough at open
464          */
465         __u64 tidmap;
466 };
467
468 struct ipath_cmd {
469         __u32 type;                     /* command type */
470         union {
471                 struct ipath_tid_info tid_info;
472                 struct ipath_user_info user_info;
473                 /* address in userspace of struct ipath_port_info to
474                    write result to */
475                 __u64 port_info;
476                 /* enable/disable receipt of packets */
477                 __u32 recv_ctrl;
478                 /* partition key to set */
479                 __u16 part_key;
480                 /* user address of __u32 bitmask of active slaves */
481                 __u64 slave_mask_addr;
482                 /* type of polling we want */
483                 __u16 poll_type;
484         } cmd;
485 };
486
487 struct ipath_iovec {
488         /* Pointer to data, but same size 32 and 64 bit */
489         __u64 iov_base;
490
491         /*
492          * Length of data; don't need 64 bits, but want
493          * ipath_sendpkt to remain same size as before 32 bit changes, so...
494          */
495         __u64 iov_len;
496 };
497
498 /*
499  * Describes a single packet for send.  Each packet can have one or more
500  * buffers, but the total length (exclusive of IB headers) must be less
501  * than the MTU, and if using the PIO method, entire packet length,
502  * including IB headers, must be less than the ipath_piosize value (words).
503  * Use of this necessitates including sys/uio.h
504  */
505 struct __ipath_sendpkt {
506         __u32 sps_flags;        /* flags for packet (TBD) */
507         __u32 sps_cnt;          /* number of entries to use in sps_iov */
508         /* array of iov's describing packet. TEMPORARY */
509         struct ipath_iovec sps_iov[4];
510 };
511
512 /*
513  * diagnostics can send a packet by "writing" one of the following
514  * two structs to diag data special file
515  * The first is the legacy version for backward compatibility
516  */
517 struct ipath_diag_pkt {
518         __u32 unit;
519         __u64 data;
520         __u32 len;
521 };
522
523 /* The second diag_pkt struct is the expanded version that allows
524  * more control over the packet, specifically, by allowing a custom
525  * pbc (+ extra) qword, so that special modes and deliberate
526  * changes to CRCs can be used. The elements were also re-ordered
527  * for better alignment and to avoid padding issues.
528  */
529 struct ipath_diag_xpkt {
530         __u64 data;
531         __u64 pbc_wd;
532         __u32 unit;
533         __u32 len;
534 };
535
536 /*
537  * Data layout in I2C flash (for GUID, etc.)
538  * All fields are little-endian binary unless otherwise stated
539  */
540 #define IPATH_FLASH_VERSION 2
541 struct ipath_flash {
542         /* flash layout version (IPATH_FLASH_VERSION) */
543         __u8 if_fversion;
544         /* checksum protecting if_length bytes */
545         __u8 if_csum;
546         /*
547          * valid length (in use, protected by if_csum), including
548          * if_fversion and if_csum themselves)
549          */
550         __u8 if_length;
551         /* the GUID, in network order */
552         __u8 if_guid[8];
553         /* number of GUIDs to use, starting from if_guid */
554         __u8 if_numguid;
555         /* the (last 10 characters of) board serial number, in ASCII */
556         char if_serial[12];
557         /* board mfg date (YYYYMMDD ASCII) */
558         char if_mfgdate[8];
559         /* last board rework/test date (YYYYMMDD ASCII) */
560         char if_testdate[8];
561         /* logging of error counts, TBD */
562         __u8 if_errcntp[4];
563         /* powered on hours, updated at driver unload */
564         __u8 if_powerhour[2];
565         /* ASCII free-form comment field */
566         char if_comment[32];
567         /* Backwards compatible prefix for longer QLogic Serial Numbers */
568         char if_sprefix[4];
569         /* 82 bytes used, min flash size is 128 bytes */
570         __u8 if_future[46];
571 };
572
573 /*
574  * These are the counters implemented in the chip, and are listed in order.
575  * The InterCaps naming is taken straight from the chip spec.
576  */
577 struct infinipath_counters {
578         __u64 LBIntCnt;
579         __u64 LBFlowStallCnt;
580         __u64 Reserved1;
581         __u64 TxUnsupVLErrCnt;
582         __u64 TxDataPktCnt;
583         __u64 TxFlowPktCnt;
584         __u64 TxDwordCnt;
585         __u64 TxLenErrCnt;
586         __u64 TxMaxMinLenErrCnt;
587         __u64 TxUnderrunCnt;
588         __u64 TxFlowStallCnt;
589         __u64 TxDroppedPktCnt;
590         __u64 RxDroppedPktCnt;
591         __u64 RxDataPktCnt;
592         __u64 RxFlowPktCnt;
593         __u64 RxDwordCnt;
594         __u64 RxLenErrCnt;
595         __u64 RxMaxMinLenErrCnt;
596         __u64 RxICRCErrCnt;
597         __u64 RxVCRCErrCnt;
598         __u64 RxFlowCtrlErrCnt;
599         __u64 RxBadFormatCnt;
600         __u64 RxLinkProblemCnt;
601         __u64 RxEBPCnt;
602         __u64 RxLPCRCErrCnt;
603         __u64 RxBufOvflCnt;
604         __u64 RxTIDFullErrCnt;
605         __u64 RxTIDValidErrCnt;
606         __u64 RxPKeyMismatchCnt;
607         __u64 RxP0HdrEgrOvflCnt;
608         __u64 RxP1HdrEgrOvflCnt;
609         __u64 RxP2HdrEgrOvflCnt;
610         __u64 RxP3HdrEgrOvflCnt;
611         __u64 RxP4HdrEgrOvflCnt;
612         __u64 RxP5HdrEgrOvflCnt;
613         __u64 RxP6HdrEgrOvflCnt;
614         __u64 RxP7HdrEgrOvflCnt;
615         __u64 RxP8HdrEgrOvflCnt;
616         __u64 Reserved6;
617         __u64 Reserved7;
618         __u64 IBStatusChangeCnt;
619         __u64 IBLinkErrRecoveryCnt;
620         __u64 IBLinkDownedCnt;
621         __u64 IBSymbolErrCnt;
622 };
623
624 /*
625  * The next set of defines are for packet headers, and chip register
626  * and memory bits that are visible to and/or used by user-mode software
627  * The other bits that are used only by the driver or diags are in
628  * ipath_registers.h
629  */
630
631 /* RcvHdrFlags bits */
632 #define INFINIPATH_RHF_LENGTH_MASK 0x7FF
633 #define INFINIPATH_RHF_LENGTH_SHIFT 0
634 #define INFINIPATH_RHF_RCVTYPE_MASK 0x7
635 #define INFINIPATH_RHF_RCVTYPE_SHIFT 11
636 #define INFINIPATH_RHF_EGRINDEX_MASK 0x7FF
637 #define INFINIPATH_RHF_EGRINDEX_SHIFT 16
638 #define INFINIPATH_RHF_H_ICRCERR   0x80000000
639 #define INFINIPATH_RHF_H_VCRCERR   0x40000000
640 #define INFINIPATH_RHF_H_PARITYERR 0x20000000
641 #define INFINIPATH_RHF_H_LENERR    0x10000000
642 #define INFINIPATH_RHF_H_MTUERR    0x08000000
643 #define INFINIPATH_RHF_H_IHDRERR   0x04000000
644 #define INFINIPATH_RHF_H_TIDERR    0x02000000
645 #define INFINIPATH_RHF_H_MKERR     0x01000000
646 #define INFINIPATH_RHF_H_IBERR     0x00800000
647 #define INFINIPATH_RHF_L_SWA       0x00008000
648 #define INFINIPATH_RHF_L_SWB       0x00004000
649
650 /* infinipath header fields */
651 #define INFINIPATH_I_VERS_MASK 0xF
652 #define INFINIPATH_I_VERS_SHIFT 28
653 #define INFINIPATH_I_PORT_MASK 0xF
654 #define INFINIPATH_I_PORT_SHIFT 24
655 #define INFINIPATH_I_TID_MASK 0x7FF
656 #define INFINIPATH_I_TID_SHIFT 13
657 #define INFINIPATH_I_OFFSET_MASK 0x1FFF
658 #define INFINIPATH_I_OFFSET_SHIFT 0
659
660 /* K_PktFlags bits */
661 #define INFINIPATH_KPF_INTR 0x1
662 #define INFINIPATH_KPF_SUBPORT_MASK 0x3
663 #define INFINIPATH_KPF_SUBPORT_SHIFT 1
664
665 #define INFINIPATH_MAX_SUBPORT  4
666
667 /* SendPIO per-buffer control */
668 #define INFINIPATH_SP_TEST    0x40
669 #define INFINIPATH_SP_TESTEBP 0x20
670
671 /* SendPIOAvail bits */
672 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
673 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
674
675 /* infinipath header format */
676 struct ipath_header {
677         /*
678          * Version - 4 bits, Port - 4 bits, TID - 10 bits and Offset -
679          * 14 bits before ECO change ~28 Dec 03.  After that, Vers 4,
680          * Port 4, TID 11, offset 13.
681          */
682         __le32 ver_port_tid_offset;
683         __le16 chksum;
684         __le16 pkt_flags;
685 };
686
687 /* infinipath user message header format.
688  * This structure contains the first 4 fields common to all protocols
689  * that employ infinipath.
690  */
691 struct ipath_message_header {
692         __be16 lrh[4];
693         __be32 bth[3];
694         /* fields below this point are in host byte order */
695         struct ipath_header iph;
696         __u8 sub_opcode;
697 };
698
699 /* infinipath ethernet header format */
700 struct ether_header {
701         __be16 lrh[4];
702         __be32 bth[3];
703         struct ipath_header iph;
704         __u8 sub_opcode;
705         __u8 cmd;
706         __be16 lid;
707         __u16 mac[3];
708         __u8 frag_num;
709         __u8 seq_num;
710         __le32 len;
711         /* MUST be of word size due to PIO write requirements */
712         __le32 csum;
713         __le16 csum_offset;
714         __le16 flags;
715         __u16 first_2_bytes;
716         __u8 unused[2];         /* currently unused */
717 };
718
719
720 /* IB - LRH header consts */
721 #define IPATH_LRH_GRH 0x0003    /* 1. word of IB LRH - next header: GRH */
722 #define IPATH_LRH_BTH 0x0002    /* 1. word of IB LRH - next header: BTH */
723
724 /* misc. */
725 #define SIZE_OF_CRC 1
726
727 #define IPATH_DEFAULT_P_KEY 0xFFFF
728 #define IPATH_PERMISSIVE_LID 0xFFFF
729 #define IPATH_AETH_CREDIT_SHIFT 24
730 #define IPATH_AETH_CREDIT_MASK 0x1F
731 #define IPATH_AETH_CREDIT_INVAL 0x1F
732 #define IPATH_PSN_MASK 0xFFFFFF
733 #define IPATH_MSN_MASK 0xFFFFFF
734 #define IPATH_QPN_MASK 0xFFFFFF
735 #define IPATH_MULTICAST_LID_BASE 0xC000
736 #define IPATH_MULTICAST_QPN 0xFFFFFF
737
738 /* Receive Header Queue: receive type (from infinipath) */
739 #define RCVHQ_RCV_TYPE_EXPECTED  0
740 #define RCVHQ_RCV_TYPE_EAGER     1
741 #define RCVHQ_RCV_TYPE_NON_KD    2
742 #define RCVHQ_RCV_TYPE_ERROR     3
743
744
745 /* sub OpCodes - ith4x  */
746 #define IPATH_ITH4X_OPCODE_ENCAP 0x81
747 #define IPATH_ITH4X_OPCODE_LID_ARP 0x82
748
749 #define IPATH_HEADER_QUEUE_WORDS 9
750
751 /* functions for extracting fields from rcvhdrq entries for the driver.
752  */
753 static inline __u32 ipath_hdrget_err_flags(const __le32 * rbuf)
754 {
755         return __le32_to_cpu(rbuf[1]);
756 }
757
758 static inline __u32 ipath_hdrget_rcv_type(const __le32 * rbuf)
759 {
760         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_RCVTYPE_SHIFT)
761             & INFINIPATH_RHF_RCVTYPE_MASK;
762 }
763
764 static inline __u32 ipath_hdrget_length_in_bytes(const __le32 * rbuf)
765 {
766         return ((__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_LENGTH_SHIFT)
767                 & INFINIPATH_RHF_LENGTH_MASK) << 2;
768 }
769
770 static inline __u32 ipath_hdrget_index(const __le32 * rbuf)
771 {
772         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_EGRINDEX_SHIFT)
773             & INFINIPATH_RHF_EGRINDEX_MASK;
774 }
775
776 static inline __u32 ipath_hdrget_ipath_ver(__le32 hdrword)
777 {
778         return (__le32_to_cpu(hdrword) >> INFINIPATH_I_VERS_SHIFT)
779             & INFINIPATH_I_VERS_MASK;
780 }
781
782 #endif                          /* _IPATH_COMMON_H */