2 * Copyright (c) 2006 QLogic, Inc. All rights reserved.
3 * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
34 #ifndef _IPATH_COMMON_H
35 #define _IPATH_COMMON_H
38 * This file contains defines, structures, etc. that are used
39 * to communicate between kernel and user code.
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
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.
52 #define IPS_PROTO_VERSION 2
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
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
63 * _IPATH_DEBUGGING define as 0 if you want to remove debug prints
67 * The value in the BTH QP field that InfiniPath uses to differentiate
68 * an infinipath protocol IB packet vs standard IB transport
70 #define IPATH_KD_QP 0x656b79
73 * valid states passed to ipath_set_linkstate() user call
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
83 * stats maintained by the driver. For now, at least, this is global
84 * to all minor devices.
86 struct infinipath_stats {
87 /* number of interrupts taken */
89 /* number of interrupts for errors */
91 /* number of errors from chip (not incl. packet errors or CRC) */
93 /* number of packet errors from chip other than CRC */
95 /* number of packets with CRC errors (ICRC and VCRC) */
97 /* number of hardware errors reported (parity, etc.) */
99 /* number of times IB link changed state unexpectedly */
101 /* kernel receive interrupts that didn't read intstat */
102 __u64 sps_fastrcvint;
103 /* number of kernel (port0) packets received */
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. Obsolete. */
111 /* number of SMA packets received by driver. Obsolete. */
113 /* number of times all ports rcvhdrq was full and packet dropped */
115 /* number of times all ports egrtid was full and packet dropped */
118 * number of times we tried to send from driver, but no pio buffers
122 /* number of ports currently open */
124 /* list of pkeys (other than default) accepted (0 means not set) */
126 __u16 sps_unused16[4]; /* available; maintaining compatible layout */
127 /* number of user ports per chip (not IB ports) */
129 /* not our interrupt, or already handled */
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 */
137 /* total number of pages unlocked */
138 __u64 sps_pageunlocks;
140 * Number of packets dropped in kernel other than errors (ether
141 * packets if ipath not configured, etc.)
144 /* pad for future growth */
149 * These are the status bits readable (in ascii form, 64bit value)
150 * from the "status" sysfs file.
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 /* Chip has been found and initted */
157 #define IPATH_STATUS_CHIP_PRESENT 0x20
158 /* IB link is at ACTIVE, usable for data traffic */
159 #define IPATH_STATUS_IB_READY 0x40
160 /* link is configured, LID, MTU, etc. have been set */
161 #define IPATH_STATUS_IB_CONF 0x80
162 /* no link established, probably no cable */
163 #define IPATH_STATUS_IB_NOCABLE 0x100
164 /* A Fatal hardware error has occurred. */
165 #define IPATH_STATUS_HWERROR 0x200
168 * The list of usermode accessible registers. Also see Reg_* later in file.
170 typedef enum _ipath_ureg {
171 /* (RO) DMA RcvHdr to be used next. */
173 /* (RW) RcvHdr entry to be processed next by host. */
175 /* (RO) Index of next Eager index to use. */
176 ur_rcvegrindextail = 2,
177 /* (RW) Eager TID to be processed next */
178 ur_rcvegrindexhead = 3,
179 /* For internal use only; max register number. */
183 /* bit values for spi_runtime_flags */
184 #define IPATH_RUNTIME_HT 0x1
185 #define IPATH_RUNTIME_PCIE 0x2
186 #define IPATH_RUNTIME_FORCE_WC_ORDER 0x4
187 #define IPATH_RUNTIME_RCVHDR_COPY 0x8
188 #define IPATH_RUNTIME_MASTER 0x10
191 * This structure is returned by ipath_userinit() immediately after
192 * open to get implementation-specific info, and info specific to this
195 * This struct must have explict pad fields where type sizes
196 * may result in different alignments between 32 and 64 bit
197 * programs, since the 64 bit * bit kernel requires the user code
198 * to have matching offsets
200 struct ipath_base_info {
201 /* version of hardware, for feature checking. */
202 __u32 spi_hw_version;
203 /* version of software, for feature checking. */
204 __u32 spi_sw_version;
205 /* InfiniPath port assigned, goes into sent packets */
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.
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.
219 /* size of the TID cache in infinipath, in entries */
221 /* size of the TID Eager list in infinipath, in entries */
223 /* size of a single receive header queue entry in words. */
224 __u32 spi_rcvhdrent_size;
226 * Count of receive header queue entries allocated.
227 * This may be less than the spu_rcvhdrcnt passed in!.
229 __u32 spi_rcvhdr_cnt;
231 /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
232 __u32 spi_runtime_flags;
234 /* address where receive buffer queue is mapped into */
235 __u64 spi_rcvhdr_base;
239 /* base address of eager TID receive buffers. */
240 __u64 spi_rcv_egrbufs;
242 /* Allocated by initialization code, not by protocol. */
245 * Size of each TID buffer in host memory, starting at
246 * spi_rcv_egrbufs. The buffers are virtually contiguous.
248 __u32 spi_rcv_egrbufsize;
250 * The special QP (queue pair) value that identifies an infinipath
251 * protocol packet from standard IB packets. More, probably much
257 * User register base for init code, not to be used directly by
258 * protocol or applications.
260 __u64 __spi_uregbase;
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.
267 __u32 spi_tid_maxsize;
269 * alignment of each pio send buffer (byte count
270 * to add to spi_piobufbase to get to second buffer)
274 * The index of the first pio buffer available to this process;
275 * needed to do lookup in spi_pioavailaddr; not added to
279 /* number of buffers mapped for this process */
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
287 __u64 spi_piobufbase;
290 * Base address of readonly memory copy of the pioavail registers.
291 * There are 2 bits for each buffer.
293 __u64 spi_pioavailaddr;
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.
302 /* number of chip ports available to user processes */
304 /* unit number of chip we are using */
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;
316 /* shared memory pages for subports if IPATH_RUNTIME_MASTER is set */
317 __u64 spi_subport_uregbase;
318 __u64 spi_subport_rcvegrbuf;
319 __u64 spi_subport_rcvhdr_base;
321 } __attribute__ ((aligned(8)));
325 * This version number is given to the driver by the user code during
326 * initialization in the spu_userversion field of ipath_user_info, so
327 * the driver can check for compatibility with user code.
329 * The major version changes when data structures
330 * change in an incompatible way. The driver must be the same or higher
331 * for initialization to succeed. In some cases, a higher version
332 * driver will not interoperate with older software, and initialization
333 * will return an error.
335 #define IPATH_USER_SWMAJOR 1
338 * Minor version differences are always compatible
339 * a within a major version, however if user software is larger
340 * than driver software, some new features and/or structure fields
341 * may not be implemented; the user code must deal with this if it
342 * cares, or it must abort after initialization reports the difference.
344 #define IPATH_USER_SWMINOR 3
346 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
348 #define IPATH_KERN_TYPE 0
351 * Similarly, this is the kernel version going back to the user. It's
352 * slightly different, in that we want to tell if the driver was built as
353 * part of a QLogic release, or from the driver from openfabrics.org,
354 * kernel.org, or a standard distribution, for support reasons.
355 * The high bit is 0 for non-QLogic and 1 for QLogic-built/supplied.
357 * It's returned by the driver to the user code during initialization in the
358 * spi_sw_version field of ipath_base_info, so the user code can in turn
359 * check for compatibility with the kernel.
361 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
364 * This structure is passed to ipath_userinit() to tell the driver where
365 * user code buffers are, sizes, etc. The offsets and sizes of the
366 * fields must remain unchanged, for binary compatibility. It can
367 * be extended, if userversion is changed so user code can tell, if needed
369 struct ipath_user_info {
371 * version of user software, to detect compatibility issues.
372 * Should be set to IPATH_USER_SWVERSION.
374 __u32 spu_userversion;
376 /* desired number of receive header queue entries */
379 /* size of struct base_info to write to */
380 __u32 spu_base_info_size;
383 * number of words in KD protocol header
384 * This tells InfiniPath how many words to copy to rcvhdrq. If 0,
385 * kernel uses a default. Once set, attempts to set any other value
386 * are an error (EAGAIN) until driver is reloaded.
388 __u32 spu_rcvhdrsize;
391 * If two or more processes wish to share a port, each process
392 * must set the spu_subport_cnt and spu_subport_id to the same
393 * values. The only restriction on the spu_subport_id is that
394 * it be unique for a given node.
396 __u16 spu_subport_cnt;
397 __u16 spu_subport_id;
399 __u32 spu_unused; /* kept for compatible layout */
402 * address of struct base_info to write to
406 } __attribute__ ((aligned(8)));
410 #define IPATH_CMD_MIN 16
412 #define IPATH_CMD_USER_INIT 16 /* set up userspace */
413 #define IPATH_CMD_PORT_INFO 17 /* find out what resources we got */
414 #define IPATH_CMD_RECV_CTRL 18 /* control receipt of packets */
415 #define IPATH_CMD_TID_UPDATE 19 /* update expected TID entries */
416 #define IPATH_CMD_TID_FREE 20 /* free expected TID entries */
417 #define IPATH_CMD_SET_PART_KEY 21 /* add partition key */
418 #define IPATH_CMD_SLAVE_INFO 22 /* return info on slave processes */
420 #define IPATH_CMD_MAX 22
422 struct ipath_port_info {
423 __u32 num_active; /* number of active units */
424 __u32 unit; /* unit (chip) assigned to caller */
425 __u16 port; /* port on unit assigned to caller */
426 __u16 subport; /* subport on unit assigned to caller */
427 __u16 num_ports; /* number of ports available on unit */
428 __u16 num_subports; /* number of subport slaves opened on port */
431 struct ipath_tid_info {
433 /* make structure same size in 32 and 64 bit */
435 /* virtual address of first page in transfer */
437 /* pointer (same size 32/64 bit) to __u16 tid array */
441 * pointer (same size 32/64 bit) to bitmap of TIDs used
442 * for this call; checked for being large enough at open
448 __u32 type; /* command type */
450 struct ipath_tid_info tid_info;
451 struct ipath_user_info user_info;
452 /* address in userspace of struct ipath_port_info to
455 /* enable/disable receipt of packets */
457 /* partition key to set */
459 /* user address of __u32 bitmask of active slaves */
460 __u64 slave_mask_addr;
465 /* Pointer to data, but same size 32 and 64 bit */
469 * Length of data; don't need 64 bits, but want
470 * ipath_sendpkt to remain same size as before 32 bit changes, so...
476 * Describes a single packet for send. Each packet can have one or more
477 * buffers, but the total length (exclusive of IB headers) must be less
478 * than the MTU, and if using the PIO method, entire packet length,
479 * including IB headers, must be less than the ipath_piosize value (words).
480 * Use of this necessitates including sys/uio.h
482 struct __ipath_sendpkt {
483 __u32 sps_flags; /* flags for packet (TBD) */
484 __u32 sps_cnt; /* number of entries to use in sps_iov */
485 /* array of iov's describing packet. TEMPORARY */
486 struct ipath_iovec sps_iov[4];
489 /* Passed into diag data special file's ->write method. */
490 struct ipath_diag_pkt {
497 * Data layout in I2C flash (for GUID, etc.)
498 * All fields are little-endian binary unless otherwise stated
500 #define IPATH_FLASH_VERSION 2
502 /* flash layout version (IPATH_FLASH_VERSION) */
504 /* checksum protecting if_length bytes */
507 * valid length (in use, protected by if_csum), including
508 * if_fversion and if_csum themselves)
511 /* the GUID, in network order */
513 /* number of GUIDs to use, starting from if_guid */
515 /* the (last 10 characters of) board serial number, in ASCII */
517 /* board mfg date (YYYYMMDD ASCII) */
519 /* last board rework/test date (YYYYMMDD ASCII) */
521 /* logging of error counts, TBD */
523 /* powered on hours, updated at driver unload */
524 __u8 if_powerhour[2];
525 /* ASCII free-form comment field */
527 /* Backwards compatible prefix for longer QLogic Serial Numbers */
529 /* 82 bytes used, min flash size is 128 bytes */
534 * These are the counters implemented in the chip, and are listed in order.
535 * The InterCaps naming is taken straight from the chip spec.
537 struct infinipath_counters {
539 __u64 LBFlowStallCnt;
541 __u64 TxUnsupVLErrCnt;
546 __u64 TxMaxMinLenErrCnt;
548 __u64 TxFlowStallCnt;
549 __u64 TxDroppedPktCnt;
550 __u64 RxDroppedPktCnt;
555 __u64 RxMaxMinLenErrCnt;
558 __u64 RxFlowCtrlErrCnt;
559 __u64 RxBadFormatCnt;
560 __u64 RxLinkProblemCnt;
564 __u64 RxTIDFullErrCnt;
565 __u64 RxTIDValidErrCnt;
566 __u64 RxPKeyMismatchCnt;
567 __u64 RxP0HdrEgrOvflCnt;
568 __u64 RxP1HdrEgrOvflCnt;
569 __u64 RxP2HdrEgrOvflCnt;
570 __u64 RxP3HdrEgrOvflCnt;
571 __u64 RxP4HdrEgrOvflCnt;
572 __u64 RxP5HdrEgrOvflCnt;
573 __u64 RxP6HdrEgrOvflCnt;
574 __u64 RxP7HdrEgrOvflCnt;
575 __u64 RxP8HdrEgrOvflCnt;
578 __u64 IBStatusChangeCnt;
579 __u64 IBLinkErrRecoveryCnt;
580 __u64 IBLinkDownedCnt;
581 __u64 IBSymbolErrCnt;
585 * The next set of defines are for packet headers, and chip register
586 * and memory bits that are visible to and/or used by user-mode software
587 * The other bits that are used only by the driver or diags are in
591 /* RcvHdrFlags bits */
592 #define INFINIPATH_RHF_LENGTH_MASK 0x7FF
593 #define INFINIPATH_RHF_LENGTH_SHIFT 0
594 #define INFINIPATH_RHF_RCVTYPE_MASK 0x7
595 #define INFINIPATH_RHF_RCVTYPE_SHIFT 11
596 #define INFINIPATH_RHF_EGRINDEX_MASK 0x7FF
597 #define INFINIPATH_RHF_EGRINDEX_SHIFT 16
598 #define INFINIPATH_RHF_H_ICRCERR 0x80000000
599 #define INFINIPATH_RHF_H_VCRCERR 0x40000000
600 #define INFINIPATH_RHF_H_PARITYERR 0x20000000
601 #define INFINIPATH_RHF_H_LENERR 0x10000000
602 #define INFINIPATH_RHF_H_MTUERR 0x08000000
603 #define INFINIPATH_RHF_H_IHDRERR 0x04000000
604 #define INFINIPATH_RHF_H_TIDERR 0x02000000
605 #define INFINIPATH_RHF_H_MKERR 0x01000000
606 #define INFINIPATH_RHF_H_IBERR 0x00800000
607 #define INFINIPATH_RHF_L_SWA 0x00008000
608 #define INFINIPATH_RHF_L_SWB 0x00004000
610 /* infinipath header fields */
611 #define INFINIPATH_I_VERS_MASK 0xF
612 #define INFINIPATH_I_VERS_SHIFT 28
613 #define INFINIPATH_I_PORT_MASK 0xF
614 #define INFINIPATH_I_PORT_SHIFT 24
615 #define INFINIPATH_I_TID_MASK 0x7FF
616 #define INFINIPATH_I_TID_SHIFT 13
617 #define INFINIPATH_I_OFFSET_MASK 0x1FFF
618 #define INFINIPATH_I_OFFSET_SHIFT 0
620 /* K_PktFlags bits */
621 #define INFINIPATH_KPF_INTR 0x1
622 #define INFINIPATH_KPF_SUBPORT_MASK 0x3
623 #define INFINIPATH_KPF_SUBPORT_SHIFT 1
625 #define INFINIPATH_MAX_SUBPORT 4
627 /* SendPIO per-buffer control */
628 #define INFINIPATH_SP_TEST 0x40
629 #define INFINIPATH_SP_TESTEBP 0x20
631 /* SendPIOAvail bits */
632 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
633 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
635 /* infinipath header format */
636 struct ipath_header {
638 * Version - 4 bits, Port - 4 bits, TID - 10 bits and Offset -
639 * 14 bits before ECO change ~28 Dec 03. After that, Vers 4,
640 * Port 4, TID 11, offset 13.
642 __le32 ver_port_tid_offset;
647 /* infinipath user message header format.
648 * This structure contains the first 4 fields common to all protocols
649 * that employ infinipath.
651 struct ipath_message_header {
654 /* fields below this point are in host byte order */
655 struct ipath_header iph;
659 /* infinipath ethernet header format */
660 struct ether_header {
663 struct ipath_header iph;
671 /* MUST be of word size due to PIO write requirements */
676 __u8 unused[2]; /* currently unused */
680 /* IB - LRH header consts */
681 #define IPATH_LRH_GRH 0x0003 /* 1. word of IB LRH - next header: GRH */
682 #define IPATH_LRH_BTH 0x0002 /* 1. word of IB LRH - next header: BTH */
685 #define SIZE_OF_CRC 1
687 #define IPATH_DEFAULT_P_KEY 0xFFFF
688 #define IPATH_PERMISSIVE_LID 0xFFFF
689 #define IPATH_AETH_CREDIT_SHIFT 24
690 #define IPATH_AETH_CREDIT_MASK 0x1F
691 #define IPATH_AETH_CREDIT_INVAL 0x1F
692 #define IPATH_PSN_MASK 0xFFFFFF
693 #define IPATH_MSN_MASK 0xFFFFFF
694 #define IPATH_QPN_MASK 0xFFFFFF
695 #define IPATH_MULTICAST_LID_BASE 0xC000
696 #define IPATH_MULTICAST_QPN 0xFFFFFF
698 /* Receive Header Queue: receive type (from infinipath) */
699 #define RCVHQ_RCV_TYPE_EXPECTED 0
700 #define RCVHQ_RCV_TYPE_EAGER 1
701 #define RCVHQ_RCV_TYPE_NON_KD 2
702 #define RCVHQ_RCV_TYPE_ERROR 3
705 /* sub OpCodes - ith4x */
706 #define IPATH_ITH4X_OPCODE_ENCAP 0x81
707 #define IPATH_ITH4X_OPCODE_LID_ARP 0x82
709 #define IPATH_HEADER_QUEUE_WORDS 9
711 /* functions for extracting fields from rcvhdrq entries for the driver.
713 static inline __u32 ipath_hdrget_err_flags(const __le32 * rbuf)
715 return __le32_to_cpu(rbuf[1]);
718 static inline __u32 ipath_hdrget_rcv_type(const __le32 * rbuf)
720 return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_RCVTYPE_SHIFT)
721 & INFINIPATH_RHF_RCVTYPE_MASK;
724 static inline __u32 ipath_hdrget_length_in_bytes(const __le32 * rbuf)
726 return ((__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_LENGTH_SHIFT)
727 & INFINIPATH_RHF_LENGTH_MASK) << 2;
730 static inline __u32 ipath_hdrget_index(const __le32 * rbuf)
732 return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_EGRINDEX_SHIFT)
733 & INFINIPATH_RHF_EGRINDEX_MASK;
736 static inline __u32 ipath_hdrget_ipath_ver(__le32 hdrword)
738 return (__le32_to_cpu(hdrword) >> INFINIPATH_I_VERS_SHIFT)
739 & INFINIPATH_I_VERS_MASK;
742 #endif /* _IPATH_COMMON_H */