062bd392e7e55d22e8d5bf95d057e8af2eb68c78
[linux-2.6.git] / drivers / infiniband / hw / ipath / ipath_common.h
1 /*
2  * Copyright (c) 2006 QLogic, Inc. 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
82 /*
83  * stats maintained by the driver.  For now, at least, this is global
84  * to all minor devices.
85  */
86 struct infinipath_stats {
87         /* number of interrupts taken */
88         __u64 sps_ints;
89         /* number of interrupts for errors */
90         __u64 sps_errints;
91         /* number of errors from chip (not incl. packet errors or CRC) */
92         __u64 sps_errs;
93         /* number of packet errors from chip other than CRC */
94         __u64 sps_pkterrs;
95         /* number of packets with CRC errors (ICRC and VCRC) */
96         __u64 sps_crcerrs;
97         /* number of hardware errors reported (parity, etc.) */
98         __u64 sps_hwerrs;
99         /* number of times IB link changed state unexpectedly */
100         __u64 sps_iblink;
101         /* kernel receive interrupts that didn't read intstat */
102         __u64 sps_fastrcvint;
103         /* number of kernel (port0) packets received */
104         __u64 sps_port0pkts;
105         /* number of "ethernet" packets sent by driver */
106         __u64 sps_ether_spkts;
107         /* number of "ethernet" packets received by driver */
108         __u64 sps_ether_rpkts;
109         /* number of SMA packets sent by driver */
110         __u64 sps_sma_spkts;
111         /* number of SMA packets received by driver */
112         __u64 sps_sma_rpkts;
113         /* number of times all ports rcvhdrq was full and packet dropped */
114         __u64 sps_hdrqfull;
115         /* number of times all ports egrtid was full and packet dropped */
116         __u64 sps_etidfull;
117         /*
118          * number of times we tried to send from driver, but no pio buffers
119          * avail
120          */
121         __u64 sps_nopiobufs;
122         /* number of ports currently open */
123         __u64 sps_ports;
124         /* list of pkeys (other than default) accepted (0 means not set) */
125         __u16 sps_pkeys[4];
126         __u16 sps_unused16[4]; /* available; maintaining compatible layout */
127         /* number of user ports per chip (not IB ports) */
128         __u32 sps_nports;
129         /* not our interrupt, or already handled */
130         __u32 sps_nullintr;
131         /* max number of packets handled per receive call */
132         __u32 sps_maxpkts_call;
133         /* avg number of packets handled per receive call */
134         __u32 sps_avgpkts_call;
135         /* total number of pages locked */
136         __u64 sps_pagelocks;
137         /* total number of pages unlocked */
138         __u64 sps_pageunlocks;
139         /*
140          * Number of packets dropped in kernel other than errors (ether
141          * packets if ipath not configured, sma/mad, etc.)
142          */
143         __u64 sps_krdrops;
144         /* pad for future growth */
145         __u64 __sps_pad[46];
146 };
147
148 /*
149  * These are the status bits readable (in ascii form, 64bit value)
150  * from the "status" sysfs file.
151  */
152 #define IPATH_STATUS_INITTED       0x1  /* basic initialization done */
153 #define IPATH_STATUS_DISABLED      0x2  /* hardware disabled */
154 /* Device has been disabled via admin request */
155 #define IPATH_STATUS_ADMIN_DISABLED    0x4
156 #define IPATH_STATUS_OIB_SMA       0x8  /* ipath_mad kernel SMA running */
157 #define IPATH_STATUS_SMA          0x10  /* user SMA running */
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
191 /*
192  * This structure is returned by ipath_userinit() immediately after
193  * open to get implementation-specific info, and info specific to this
194  * instance.
195  *
196  * This struct must have explict pad fields where type sizes
197  * may result in different alignments between 32 and 64 bit
198  * programs, since the 64 bit * bit kernel requires the user code
199  * to have matching offsets
200  */
201 struct ipath_base_info {
202         /* version of hardware, for feature checking. */
203         __u32 spi_hw_version;
204         /* version of software, for feature checking. */
205         __u32 spi_sw_version;
206         /* InfiniPath port assigned, goes into sent packets */
207         __u32 spi_port;
208         /*
209          * IB MTU, packets IB data must be less than this.
210          * The MTU is in bytes, and will be a multiple of 4 bytes.
211          */
212         __u32 spi_mtu;
213         /*
214          * Size of a PIO buffer.  Any given packet's total size must be less
215          * than this (in words).  Included is the starting control word, so
216          * if 513 is returned, then total pkt size is 512 words or less.
217          */
218         __u32 spi_piosize;
219         /* size of the TID cache in infinipath, in entries */
220         __u32 spi_tidcnt;
221         /* size of the TID Eager list in infinipath, in entries */
222         __u32 spi_tidegrcnt;
223         /* size of a single receive header queue entry. */
224         __u32 spi_rcvhdrent_size;
225         /*
226          * Count of receive header queue entries allocated.
227          * This may be less than the spu_rcvhdrcnt passed in!.
228          */
229         __u32 spi_rcvhdr_cnt;
230
231         /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
232         __u32 spi_runtime_flags;
233
234         /* address where receive buffer queue is mapped into */
235         __u64 spi_rcvhdr_base;
236
237         /* user program. */
238
239         /* base address of eager TID receive buffers. */
240         __u64 spi_rcv_egrbufs;
241
242         /* Allocated by initialization code, not by protocol. */
243
244         /*
245          * Size of each TID buffer in host memory, starting at
246          * spi_rcv_egrbufs.  The buffers are virtually contiguous.
247          */
248         __u32 spi_rcv_egrbufsize;
249         /*
250          * The special QP (queue pair) value that identifies an infinipath
251          * protocol packet from standard IB packets.  More, probably much
252          * more, to be added.
253          */
254         __u32 spi_qpair;
255
256         /*
257          * User register base for init code, not to be used directly by
258          * protocol or applications.
259          */
260         __u64 __spi_uregbase;
261         /*
262          * Maximum buffer size in bytes that can be used in a single TID
263          * entry (assuming the buffer is aligned to this boundary).  This is
264          * the minimum of what the hardware and software support Guaranteed
265          * to be a power of 2.
266          */
267         __u32 spi_tid_maxsize;
268         /*
269          * alignment of each pio send buffer (byte count
270          * to add to spi_piobufbase to get to second buffer)
271          */
272         __u32 spi_pioalign;
273         /*
274          * The index of the first pio buffer available to this process;
275          * needed to do lookup in spi_pioavailaddr; not added to
276          * spi_piobufbase.
277          */
278         __u32 spi_pioindex;
279          /* number of buffers mapped for this process */
280         __u32 spi_piocnt;
281
282         /*
283          * Base address of writeonly pio buffers for this process.
284          * Each buffer has spi_piosize words, and is aligned on spi_pioalign
285          * boundaries.  spi_piocnt buffers are mapped from this address
286          */
287         __u64 spi_piobufbase;
288
289         /*
290          * Base address of readonly memory copy of the pioavail registers.
291          * There are 2 bits for each buffer.
292          */
293         __u64 spi_pioavailaddr;
294
295         /*
296          * Address where driver updates a copy of the interface and driver
297          * status (IPATH_STATUS_*) as a 64 bit value.  It's followed by a
298          * string indicating hardware error, if there was one.
299          */
300         __u64 spi_status;
301
302         /* number of chip ports available to user processes */
303         __u32 spi_nports;
304         /* unit number of chip we are using */
305         __u32 spi_unit;
306         /* num bufs in each contiguous set */
307         __u32 spi_rcv_egrperchunk;
308         /* size in bytes of each contiguous set */
309         __u32 spi_rcv_egrchunksize;
310         /* total size of mmap to cover full rcvegrbuffers */
311         __u32 spi_rcv_egrbuftotlen;
312         __u32 spi_filler_for_align;
313         /* address of readonly memory copy of the rcvhdrq tail register. */
314         __u64 spi_rcvhdr_tailaddr;
315 } __attribute__ ((aligned(8)));
316
317
318 /*
319  * This version number is given to the driver by the user code during
320  * initialization in the spu_userversion field of ipath_user_info, so
321  * the driver can check for compatibility with user code.
322  *
323  * The major version changes when data structures
324  * change in an incompatible way.  The driver must be the same or higher
325  * for initialization to succeed.  In some cases, a higher version
326  * driver will not interoperate with older software, and initialization
327  * will return an error.
328  */
329 #define IPATH_USER_SWMAJOR 1
330
331 /*
332  * Minor version differences are always compatible
333  * a within a major version, however if if user software is larger
334  * than driver software, some new features and/or structure fields
335  * may not be implemented; the user code must deal with this if it
336  * cares, or it must abort after initialization reports the difference
337  */
338 #define IPATH_USER_SWMINOR 2
339
340 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
341
342 #define IPATH_KERN_TYPE 0
343
344 /*
345  * Similarly, this is the kernel version going back to the user.  It's
346  * slightly different, in that we want to tell if the driver was built as
347  * part of a QLogic release, or from the driver from openfabrics.org,
348  * kernel.org, or a standard distribution, for support reasons.
349  * The high bit is 0 for non-QLogic and 1 for QLogic-built/supplied.
350  *
351  * It's returned by the driver to the user code during initialization in the
352  * spi_sw_version field of ipath_base_info, so the user code can in turn
353  * check for compatibility with the kernel.
354 */
355 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
356
357 /*
358  * This structure is passed to ipath_userinit() to tell the driver where
359  * user code buffers are, sizes, etc.   The offsets and sizes of the
360  * fields must remain unchanged, for binary compatibility.  It can
361  * be extended, if userversion is changed so user code can tell, if needed
362  */
363 struct ipath_user_info {
364         /*
365          * version of user software, to detect compatibility issues.
366          * Should be set to IPATH_USER_SWVERSION.
367          */
368         __u32 spu_userversion;
369
370         /* desired number of receive header queue entries */
371         __u32 spu_rcvhdrcnt;
372
373         /* size of struct base_info to write to */
374         __u32 spu_base_info_size;
375
376         /*
377          * number of words in KD protocol header
378          * This tells InfiniPath how many words to copy to rcvhdrq.  If 0,
379          * kernel uses a default.  Once set, attempts to set any other value
380          * are an error (EAGAIN) until driver is reloaded.
381          */
382         __u32 spu_rcvhdrsize;
383
384         __u64 spu_unused; /* kept for compatible layout */
385
386         /*
387          * address of struct base_info to write to
388          */
389         __u64 spu_base_info;
390
391 } __attribute__ ((aligned(8)));
392
393 /* User commands. */
394
395 #define IPATH_CMD_MIN           16
396
397 #define IPATH_CMD_USER_INIT     16      /* set up userspace */
398 #define IPATH_CMD_PORT_INFO     17      /* find out what resources we got */
399 #define IPATH_CMD_RECV_CTRL     18      /* control receipt of packets */
400 #define IPATH_CMD_TID_UPDATE    19      /* update expected TID entries */
401 #define IPATH_CMD_TID_FREE      20      /* free expected TID entries */
402 #define IPATH_CMD_SET_PART_KEY  21      /* add partition key */
403
404 #define IPATH_CMD_MAX           21
405
406 struct ipath_port_info {
407         __u32 num_active;       /* number of active units */
408         __u32 unit;             /* unit (chip) assigned to caller */
409         __u32 port;             /* port on unit assigned to caller */
410 };
411
412 struct ipath_tid_info {
413         __u32 tidcnt;
414         /* make structure same size in 32 and 64 bit */
415         __u32 tid__unused;
416         /* virtual address of first page in transfer */
417         __u64 tidvaddr;
418         /* pointer (same size 32/64 bit) to __u16 tid array */
419         __u64 tidlist;
420
421         /*
422          * pointer (same size 32/64 bit) to bitmap of TIDs used
423          * for this call; checked for being large enough at open
424          */
425         __u64 tidmap;
426 };
427
428 struct ipath_cmd {
429         __u32 type;                     /* command type */
430         union {
431                 struct ipath_tid_info tid_info;
432                 struct ipath_user_info user_info;
433                 /* address in userspace of struct ipath_port_info to
434                    write result to */
435                 __u64 port_info;
436                 /* enable/disable receipt of packets */
437                 __u32 recv_ctrl;
438                 /* partition key to set */
439                 __u16 part_key;
440         } cmd;
441 };
442
443 struct ipath_iovec {
444         /* Pointer to data, but same size 32 and 64 bit */
445         __u64 iov_base;
446
447         /*
448          * Length of data; don't need 64 bits, but want
449          * ipath_sendpkt to remain same size as before 32 bit changes, so...
450          */
451         __u64 iov_len;
452 };
453
454 /*
455  * Describes a single packet for send.  Each packet can have one or more
456  * buffers, but the total length (exclusive of IB headers) must be less
457  * than the MTU, and if using the PIO method, entire packet length,
458  * including IB headers, must be less than the ipath_piosize value (words).
459  * Use of this necessitates including sys/uio.h
460  */
461 struct __ipath_sendpkt {
462         __u32 sps_flags;        /* flags for packet (TBD) */
463         __u32 sps_cnt;          /* number of entries to use in sps_iov */
464         /* array of iov's describing packet. TEMPORARY */
465         struct ipath_iovec sps_iov[4];
466 };
467
468 /* Passed into SMA special file's ->read and ->write methods. */
469 struct ipath_sma_pkt
470 {
471         __u32 unit;     /* unit on which to send packet */
472         __u64 data;     /* address of payload in userspace */
473         __u32 len;      /* length of payload */
474 };
475
476 /*
477  * Data layout in I2C flash (for GUID, etc.)
478  * All fields are little-endian binary unless otherwise stated
479  */
480 #define IPATH_FLASH_VERSION 2
481 struct ipath_flash {
482         /* flash layout version (IPATH_FLASH_VERSION) */
483         __u8 if_fversion;
484         /* checksum protecting if_length bytes */
485         __u8 if_csum;
486         /*
487          * valid length (in use, protected by if_csum), including
488          * if_fversion and if_csum themselves)
489          */
490         __u8 if_length;
491         /* the GUID, in network order */
492         __u8 if_guid[8];
493         /* number of GUIDs to use, starting from if_guid */
494         __u8 if_numguid;
495         /* the (last 10 characters of) board serial number, in ASCII */
496         char if_serial[12];
497         /* board mfg date (YYYYMMDD ASCII) */
498         char if_mfgdate[8];
499         /* last board rework/test date (YYYYMMDD ASCII) */
500         char if_testdate[8];
501         /* logging of error counts, TBD */
502         __u8 if_errcntp[4];
503         /* powered on hours, updated at driver unload */
504         __u8 if_powerhour[2];
505         /* ASCII free-form comment field */
506         char if_comment[32];
507         /* Backwards compatible prefix for longer QLogic Serial Numbers */
508         char if_sprefix[4];
509         /* 82 bytes used, min flash size is 128 bytes */
510         __u8 if_future[46];
511 };
512
513 /*
514  * These are the counters implemented in the chip, and are listed in order.
515  * The InterCaps naming is taken straight from the chip spec.
516  */
517 struct infinipath_counters {
518         __u64 LBIntCnt;
519         __u64 LBFlowStallCnt;
520         __u64 Reserved1;
521         __u64 TxUnsupVLErrCnt;
522         __u64 TxDataPktCnt;
523         __u64 TxFlowPktCnt;
524         __u64 TxDwordCnt;
525         __u64 TxLenErrCnt;
526         __u64 TxMaxMinLenErrCnt;
527         __u64 TxUnderrunCnt;
528         __u64 TxFlowStallCnt;
529         __u64 TxDroppedPktCnt;
530         __u64 RxDroppedPktCnt;
531         __u64 RxDataPktCnt;
532         __u64 RxFlowPktCnt;
533         __u64 RxDwordCnt;
534         __u64 RxLenErrCnt;
535         __u64 RxMaxMinLenErrCnt;
536         __u64 RxICRCErrCnt;
537         __u64 RxVCRCErrCnt;
538         __u64 RxFlowCtrlErrCnt;
539         __u64 RxBadFormatCnt;
540         __u64 RxLinkProblemCnt;
541         __u64 RxEBPCnt;
542         __u64 RxLPCRCErrCnt;
543         __u64 RxBufOvflCnt;
544         __u64 RxTIDFullErrCnt;
545         __u64 RxTIDValidErrCnt;
546         __u64 RxPKeyMismatchCnt;
547         __u64 RxP0HdrEgrOvflCnt;
548         __u64 RxP1HdrEgrOvflCnt;
549         __u64 RxP2HdrEgrOvflCnt;
550         __u64 RxP3HdrEgrOvflCnt;
551         __u64 RxP4HdrEgrOvflCnt;
552         __u64 RxP5HdrEgrOvflCnt;
553         __u64 RxP6HdrEgrOvflCnt;
554         __u64 RxP7HdrEgrOvflCnt;
555         __u64 RxP8HdrEgrOvflCnt;
556         __u64 Reserved6;
557         __u64 Reserved7;
558         __u64 IBStatusChangeCnt;
559         __u64 IBLinkErrRecoveryCnt;
560         __u64 IBLinkDownedCnt;
561         __u64 IBSymbolErrCnt;
562 };
563
564 /*
565  * The next set of defines are for packet headers, and chip register
566  * and memory bits that are visible to and/or used by user-mode software
567  * The other bits that are used only by the driver or diags are in
568  * ipath_registers.h
569  */
570
571 /* RcvHdrFlags bits */
572 #define INFINIPATH_RHF_LENGTH_MASK 0x7FF
573 #define INFINIPATH_RHF_LENGTH_SHIFT 0
574 #define INFINIPATH_RHF_RCVTYPE_MASK 0x7
575 #define INFINIPATH_RHF_RCVTYPE_SHIFT 11
576 #define INFINIPATH_RHF_EGRINDEX_MASK 0x7FF
577 #define INFINIPATH_RHF_EGRINDEX_SHIFT 16
578 #define INFINIPATH_RHF_H_ICRCERR   0x80000000
579 #define INFINIPATH_RHF_H_VCRCERR   0x40000000
580 #define INFINIPATH_RHF_H_PARITYERR 0x20000000
581 #define INFINIPATH_RHF_H_LENERR    0x10000000
582 #define INFINIPATH_RHF_H_MTUERR    0x08000000
583 #define INFINIPATH_RHF_H_IHDRERR   0x04000000
584 #define INFINIPATH_RHF_H_TIDERR    0x02000000
585 #define INFINIPATH_RHF_H_MKERR     0x01000000
586 #define INFINIPATH_RHF_H_IBERR     0x00800000
587 #define INFINIPATH_RHF_L_SWA       0x00008000
588 #define INFINIPATH_RHF_L_SWB       0x00004000
589
590 /* infinipath header fields */
591 #define INFINIPATH_I_VERS_MASK 0xF
592 #define INFINIPATH_I_VERS_SHIFT 28
593 #define INFINIPATH_I_PORT_MASK 0xF
594 #define INFINIPATH_I_PORT_SHIFT 24
595 #define INFINIPATH_I_TID_MASK 0x7FF
596 #define INFINIPATH_I_TID_SHIFT 13
597 #define INFINIPATH_I_OFFSET_MASK 0x1FFF
598 #define INFINIPATH_I_OFFSET_SHIFT 0
599
600 /* K_PktFlags bits */
601 #define INFINIPATH_KPF_INTR 0x1
602
603 /* SendPIO per-buffer control */
604 #define INFINIPATH_SP_TEST    0x40
605 #define INFINIPATH_SP_TESTEBP 0x20
606
607 /* SendPIOAvail bits */
608 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
609 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
610
611 /* infinipath header format */
612 struct ipath_header {
613         /*
614          * Version - 4 bits, Port - 4 bits, TID - 10 bits and Offset -
615          * 14 bits before ECO change ~28 Dec 03.  After that, Vers 4,
616          * Port 3, TID 11, offset 14.
617          */
618         __le32 ver_port_tid_offset;
619         __le16 chksum;
620         __le16 pkt_flags;
621 };
622
623 /* infinipath user message header format.
624  * This structure contains the first 4 fields common to all protocols
625  * that employ infinipath.
626  */
627 struct ipath_message_header {
628         __be16 lrh[4];
629         __be32 bth[3];
630         /* fields below this point are in host byte order */
631         struct ipath_header iph;
632         __u8 sub_opcode;
633 };
634
635 /* infinipath ethernet header format */
636 struct ether_header {
637         __be16 lrh[4];
638         __be32 bth[3];
639         struct ipath_header iph;
640         __u8 sub_opcode;
641         __u8 cmd;
642         __be16 lid;
643         __u16 mac[3];
644         __u8 frag_num;
645         __u8 seq_num;
646         __le32 len;
647         /* MUST be of word size due to PIO write requirements */
648         __le32 csum;
649         __le16 csum_offset;
650         __le16 flags;
651         __u16 first_2_bytes;
652         __u8 unused[2];         /* currently unused */
653 };
654
655
656 /* IB - LRH header consts */
657 #define IPATH_LRH_GRH 0x0003    /* 1. word of IB LRH - next header: GRH */
658 #define IPATH_LRH_BTH 0x0002    /* 1. word of IB LRH - next header: BTH */
659
660 /* misc. */
661 #define SIZE_OF_CRC 1
662
663 #define IPATH_DEFAULT_P_KEY 0xFFFF
664 #define IPATH_PERMISSIVE_LID 0xFFFF
665 #define IPATH_AETH_CREDIT_SHIFT 24
666 #define IPATH_AETH_CREDIT_MASK 0x1F
667 #define IPATH_AETH_CREDIT_INVAL 0x1F
668 #define IPATH_PSN_MASK 0xFFFFFF
669 #define IPATH_MSN_MASK 0xFFFFFF
670 #define IPATH_QPN_MASK 0xFFFFFF
671 #define IPATH_MULTICAST_LID_BASE 0xC000
672 #define IPATH_MULTICAST_QPN 0xFFFFFF
673
674 /* Receive Header Queue: receive type (from infinipath) */
675 #define RCVHQ_RCV_TYPE_EXPECTED  0
676 #define RCVHQ_RCV_TYPE_EAGER     1
677 #define RCVHQ_RCV_TYPE_NON_KD    2
678 #define RCVHQ_RCV_TYPE_ERROR     3
679
680
681 /* sub OpCodes - ith4x  */
682 #define IPATH_ITH4X_OPCODE_ENCAP 0x81
683 #define IPATH_ITH4X_OPCODE_LID_ARP 0x82
684
685 #define IPATH_HEADER_QUEUE_WORDS 9
686
687 /* functions for extracting fields from rcvhdrq entries for the driver.
688  */
689 static inline __u32 ipath_hdrget_err_flags(const __le32 * rbuf)
690 {
691         return __le32_to_cpu(rbuf[1]);
692 }
693
694 static inline __u32 ipath_hdrget_rcv_type(const __le32 * rbuf)
695 {
696         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_RCVTYPE_SHIFT)
697             & INFINIPATH_RHF_RCVTYPE_MASK;
698 }
699
700 static inline __u32 ipath_hdrget_length_in_bytes(const __le32 * rbuf)
701 {
702         return ((__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_LENGTH_SHIFT)
703                 & INFINIPATH_RHF_LENGTH_MASK) << 2;
704 }
705
706 static inline __u32 ipath_hdrget_index(const __le32 * rbuf)
707 {
708         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_EGRINDEX_SHIFT)
709             & INFINIPATH_RHF_EGRINDEX_MASK;
710 }
711
712 static inline __u32 ipath_hdrget_ipath_ver(__le32 hdrword)
713 {
714         return (__le32_to_cpu(hdrword) >> INFINIPATH_I_VERS_SHIFT)
715             & INFINIPATH_I_VERS_MASK;
716 }
717
718 #endif                          /* _IPATH_COMMON_H */