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.
42 /* This is the IEEE-assigned OUI for QLogic, Inc. InfiniPath */
43 #define IPATH_SRC_OUI_1 0x00
44 #define IPATH_SRC_OUI_2 0x11
45 #define IPATH_SRC_OUI_3 0x75
47 /* version of protocol header (known to chip also). In the long run,
48 * we should be able to generate and accept a range of version numbers;
49 * for now we only accept one, and it's compiled in.
51 #define IPS_PROTO_VERSION 2
54 * These are compile time constants that you may want to enable or disable
55 * if you are trying to debug problems with code or performance.
56 * IPATH_VERBOSE_TRACING define as 1 if you want additional tracing in
58 * IPATH_TRACE_REGWRITES define as 1 if you want register writes to be
59 * traced in faspath code
60 * _IPATH_TRACING define as 0 if you want to remove all tracing in a
62 * _IPATH_DEBUGGING define as 0 if you want to remove debug prints
66 * The value in the BTH QP field that InfiniPath uses to differentiate
67 * an infinipath protocol IB packet vs standard IB transport
69 #define IPATH_KD_QP 0x656b79
72 * valid states passed to ipath_set_linkstate() user call
74 #define IPATH_IB_LINKDOWN 0
75 #define IPATH_IB_LINKARM 1
76 #define IPATH_IB_LINKACTIVE 2
77 #define IPATH_IB_LINKINIT 3
78 #define IPATH_IB_LINKDOWN_SLEEP 4
79 #define IPATH_IB_LINKDOWN_DISABLE 5
82 * stats maintained by the driver. For now, at least, this is global
83 * to all minor devices.
85 struct infinipath_stats {
86 /* number of interrupts taken */
88 /* number of interrupts for errors */
90 /* number of errors from chip (not incl. packet errors or CRC) */
92 /* number of packet errors from chip other than CRC */
94 /* number of packets with CRC errors (ICRC and VCRC) */
96 /* number of hardware errors reported (parity, etc.) */
98 /* number of times IB link changed state unexpectedly */
100 /* kernel receive interrupts that didn't read intstat */
101 __u64 sps_fastrcvint;
102 /* number of kernel (port0) packets received */
104 /* number of "ethernet" packets sent by driver */
105 __u64 sps_ether_spkts;
106 /* number of "ethernet" packets received by driver */
107 __u64 sps_ether_rpkts;
108 /* number of SMA packets sent by driver */
110 /* number of SMA packets received by driver */
112 /* number of times all ports rcvhdrq was full and packet dropped */
114 /* number of times all ports egrtid was full and packet dropped */
117 * number of times we tried to send from driver, but no pio buffers
121 /* number of ports currently open */
123 /* list of pkeys (other than default) accepted (0 means not set) */
125 /* lids for up to 4 infinipaths, indexed by infinipath # */
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, sma/mad, etc.)
144 /* mlids for up to 4 infinipaths, indexed by infinipath # */
146 /* pad for future growth */
151 * These are the status bits readable (in ascii form, 64bit value)
152 * from the "status" sysfs file.
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 #define IPATH_STATUS_OIB_SMA 0x8 /* ipath_mad kernel SMA running */
159 #define IPATH_STATUS_SMA 0x10 /* user SMA running */
160 /* Chip has been found and initted */
161 #define IPATH_STATUS_CHIP_PRESENT 0x20
162 /* IB link is at ACTIVE, usable for data traffic */
163 #define IPATH_STATUS_IB_READY 0x40
164 /* link is configured, LID, MTU, etc. have been set */
165 #define IPATH_STATUS_IB_CONF 0x80
166 /* no link established, probably no cable */
167 #define IPATH_STATUS_IB_NOCABLE 0x100
168 /* A Fatal hardware error has occurred. */
169 #define IPATH_STATUS_HWERROR 0x200
172 * The list of usermode accessible registers. Also see Reg_* later in file.
174 typedef enum _ipath_ureg {
175 /* (RO) DMA RcvHdr to be used next. */
177 /* (RW) RcvHdr entry to be processed next by host. */
179 /* (RO) Index of next Eager index to use. */
180 ur_rcvegrindextail = 2,
181 /* (RW) Eager TID to be processed next */
182 ur_rcvegrindexhead = 3,
183 /* For internal use only; max register number. */
187 /* bit values for spi_runtime_flags */
188 #define IPATH_RUNTIME_HT 0x1
189 #define IPATH_RUNTIME_PCIE 0x2
190 #define IPATH_RUNTIME_FORCE_WC_ORDER 0x4
191 #define IPATH_RUNTIME_RCVHDR_COPY 0x8
194 * This structure is returned by ipath_userinit() immediately after
195 * open to get implementation-specific info, and info specific to this
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
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 */
211 * IB MTU, packets IB data must be less than this.
212 * The MTU is in bytes, and will be a multiple of 4 bytes.
216 * Size of a PIO buffer. Any given packet's total size must be less
217 * than this (in words). Included is the starting control word, so
218 * if 513 is returned, then total pkt size is 512 words or less.
221 /* size of the TID cache in infinipath, in entries */
223 /* size of the TID Eager list in infinipath, in entries */
225 /* size of a single receive header queue entry. */
226 __u32 spi_rcvhdrent_size;
228 * Count of receive header queue entries allocated.
229 * This may be less than the spu_rcvhdrcnt passed in!.
231 __u32 spi_rcvhdr_cnt;
233 /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
234 __u32 spi_runtime_flags;
236 /* address where receive buffer queue is mapped into */
237 __u64 spi_rcvhdr_base;
241 /* base address of eager TID receive buffers. */
242 __u64 spi_rcv_egrbufs;
244 /* Allocated by initialization code, not by protocol. */
247 * Size of each TID buffer in host memory, starting at
248 * spi_rcv_egrbufs. The buffers are virtually contiguous.
250 __u32 spi_rcv_egrbufsize;
252 * The special QP (queue pair) value that identifies an infinipath
253 * protocol packet from standard IB packets. More, probably much
259 * User register base for init code, not to be used directly by
260 * protocol or applications.
262 __u64 __spi_uregbase;
264 * Maximum buffer size in bytes that can be used in a single TID
265 * entry (assuming the buffer is aligned to this boundary). This is
266 * the minimum of what the hardware and software support Guaranteed
267 * to be a power of 2.
269 __u32 spi_tid_maxsize;
271 * alignment of each pio send buffer (byte count
272 * to add to spi_piobufbase to get to second buffer)
276 * The index of the first pio buffer available to this process;
277 * needed to do lookup in spi_pioavailaddr; not added to
281 /* number of buffers mapped for this process */
285 * Base address of writeonly pio buffers for this process.
286 * Each buffer has spi_piosize words, and is aligned on spi_pioalign
287 * boundaries. spi_piocnt buffers are mapped from this address
289 __u64 spi_piobufbase;
292 * Base address of readonly memory copy of the pioavail registers.
293 * There are 2 bits for each buffer.
295 __u64 spi_pioavailaddr;
298 * Address where driver updates a copy of the interface and driver
299 * status (IPATH_STATUS_*) as a 64 bit value. It's followed by a
300 * string indicating hardware error, if there was one.
304 /* number of chip ports available to user processes */
306 /* unit number of chip we are using */
308 /* num bufs in each contiguous set */
309 __u32 spi_rcv_egrperchunk;
310 /* size in bytes of each contiguous set */
311 __u32 spi_rcv_egrchunksize;
312 /* total size of mmap to cover full rcvegrbuffers */
313 __u32 spi_rcv_egrbuftotlen;
314 __u32 spi_filler_for_align;
315 /* address of readonly memory copy of the rcvhdrq tail register. */
316 __u64 spi_rcvhdr_tailaddr;
317 } __attribute__ ((aligned(8)));
321 * This version number is given to the driver by the user code during
322 * initialization in the spu_userversion field of ipath_user_info, so
323 * the driver can check for compatibility with user code.
325 * The major version changes when data structures
326 * change in an incompatible way. The driver must be the same or higher
327 * for initialization to succeed. In some cases, a higher version
328 * driver will not interoperate with older software, and initialization
329 * will return an error.
331 #define IPATH_USER_SWMAJOR 1
334 * Minor version differences are always compatible
335 * a within a major version, however if if user software is larger
336 * than driver software, some new features and/or structure fields
337 * may not be implemented; the user code must deal with this if it
338 * cares, or it must abort after initialization reports the difference
340 #define IPATH_USER_SWMINOR 2
342 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
344 #define IPATH_KERN_TYPE 0
347 * Similarly, this is the kernel version going back to the user. It's
348 * slightly different, in that we want to tell if the driver was built as
349 * part of a QLogic release, or from the driver from OpenIB, kernel.org,
350 * or a standard distribution, for support reasons. The high bit is 0 for
351 * non-QLogic, and 1 for QLogic-built/supplied.
353 * It's returned by the driver to the user code during initialization in the
354 * spi_sw_version field of ipath_base_info, so the user code can in turn
355 * check for compatibility with the kernel.
357 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
360 * This structure is passed to ipath_userinit() to tell the driver where
361 * user code buffers are, sizes, etc. The offsets and sizes of the
362 * fields must remain unchanged, for binary compatibility. It can
363 * be extended, if userversion is changed so user code can tell, if needed
365 struct ipath_user_info {
367 * version of user software, to detect compatibility issues.
368 * Should be set to IPATH_USER_SWVERSION.
370 __u32 spu_userversion;
372 /* desired number of receive header queue entries */
375 /* size of struct base_info to write to */
376 __u32 spu_base_info_size;
379 * number of words in KD protocol header
380 * This tells InfiniPath how many words to copy to rcvhdrq. If 0,
381 * kernel uses a default. Once set, attempts to set any other value
382 * are an error (EAGAIN) until driver is reloaded.
384 __u32 spu_rcvhdrsize;
386 __u64 spu_unused; /* kept for compatible layout */
389 * address of struct base_info to write to
393 } __attribute__ ((aligned(8)));
397 #define IPATH_CMD_MIN 16
399 #define IPATH_CMD_USER_INIT 16 /* set up userspace */
400 #define IPATH_CMD_PORT_INFO 17 /* find out what resources we got */
401 #define IPATH_CMD_RECV_CTRL 18 /* control receipt of packets */
402 #define IPATH_CMD_TID_UPDATE 19 /* update expected TID entries */
403 #define IPATH_CMD_TID_FREE 20 /* free expected TID entries */
404 #define IPATH_CMD_SET_PART_KEY 21 /* add partition key */
406 #define IPATH_CMD_MAX 21
408 struct ipath_port_info {
409 __u32 num_active; /* number of active units */
410 __u32 unit; /* unit (chip) assigned to caller */
411 __u32 port; /* port on unit assigned to caller */
414 struct ipath_tid_info {
416 /* make structure same size in 32 and 64 bit */
418 /* virtual address of first page in transfer */
420 /* pointer (same size 32/64 bit) to __u16 tid array */
424 * pointer (same size 32/64 bit) to bitmap of TIDs used
425 * for this call; checked for being large enough at open
431 __u32 type; /* command type */
433 struct ipath_tid_info tid_info;
434 struct ipath_user_info user_info;
435 /* address in userspace of struct ipath_port_info to
438 /* enable/disable receipt of packets */
440 /* partition key to set */
446 /* Pointer to data, but same size 32 and 64 bit */
450 * Length of data; don't need 64 bits, but want
451 * ipath_sendpkt to remain same size as before 32 bit changes, so...
457 * Describes a single packet for send. Each packet can have one or more
458 * buffers, but the total length (exclusive of IB headers) must be less
459 * than the MTU, and if using the PIO method, entire packet length,
460 * including IB headers, must be less than the ipath_piosize value (words).
461 * Use of this necessitates including sys/uio.h
463 struct __ipath_sendpkt {
464 __u32 sps_flags; /* flags for packet (TBD) */
465 __u32 sps_cnt; /* number of entries to use in sps_iov */
466 /* array of iov's describing packet. TEMPORARY */
467 struct ipath_iovec sps_iov[4];
470 /* Passed into SMA special file's ->read and ->write methods. */
473 __u32 unit; /* unit on which to send packet */
474 __u64 data; /* address of payload in userspace */
475 __u32 len; /* length of payload */
479 * Data layout in I2C flash (for GUID, etc.)
480 * All fields are little-endian binary unless otherwise stated
482 #define IPATH_FLASH_VERSION 1
484 /* flash layout version (IPATH_FLASH_VERSION) */
486 /* checksum protecting if_length bytes */
489 * valid length (in use, protected by if_csum), including
490 * if_fversion and if_sum themselves)
493 /* the GUID, in network order */
495 /* number of GUIDs to use, starting from if_guid */
497 /* the board serial number, in ASCII */
499 /* board mfg date (YYYYMMDD ASCII) */
501 /* last board rework/test date (YYYYMMDD ASCII) */
503 /* logging of error counts, TBD */
505 /* powered on hours, updated at driver unload */
506 __u8 if_powerhour[2];
507 /* ASCII free-form comment field */
509 /* 78 bytes used, min flash size is 128 bytes */
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.
517 struct infinipath_counters {
519 __u64 LBFlowStallCnt;
521 __u64 TxUnsupVLErrCnt;
526 __u64 TxMaxMinLenErrCnt;
528 __u64 TxFlowStallCnt;
529 __u64 TxDroppedPktCnt;
530 __u64 RxDroppedPktCnt;
535 __u64 RxMaxMinLenErrCnt;
538 __u64 RxFlowCtrlErrCnt;
539 __u64 RxBadFormatCnt;
540 __u64 RxLinkProblemCnt;
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;
558 __u64 IBStatusChangeCnt;
559 __u64 IBLinkErrRecoveryCnt;
560 __u64 IBLinkDownedCnt;
561 __u64 IBSymbolErrCnt;
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
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
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
600 /* K_PktFlags bits */
601 #define INFINIPATH_KPF_INTR 0x1
603 /* SendPIO per-buffer control */
604 #define INFINIPATH_SP_LENGTHP1_MASK 0x3FF
605 #define INFINIPATH_SP_LENGTHP1_SHIFT 0
606 #define INFINIPATH_SP_INTR 0x80000000
607 #define INFINIPATH_SP_TEST 0x40000000
608 #define INFINIPATH_SP_TESTEBP 0x20000000
610 /* SendPIOAvail bits */
611 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
612 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
614 #endif /* _IPATH_COMMON_H */