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