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. Obsolete. */
 110         __u64 sps_sma_spkts;
 111         /* number of SMA packets received by driver. Obsolete. */
 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, 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 /* 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
 166
 167 /*
 168  * The list of usermode accessible registers.  Also see Reg_* later in file.
 169  */
 170 typedef enum _ipath_ureg {
 171         /* (RO)  DMA RcvHdr to be used next. */
 172         ur_rcvhdrtail = 0,
 173         /* (RW)  RcvHdr entry to be processed next by host. */
 174         ur_rcvhdrhead = 1,
 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. */
 180         _IPATH_UregMax
 181 } ipath_ureg;
 182
 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
 189 #define IPATH_RUNTIME_PBC_REWRITE 0x20
 190 #define IPATH_RUNTIME_LOOSE_DMA_ALIGN 0x40
 191
 192 /*
 193  * This structure is returned by ipath_userinit() immediately after
 194  * open to get implementation-specific info, and info specific to this
 195  * instance.
 196  *
 197  * This struct must have explict pad fields where type sizes
 198  * may result in different alignments between 32 and 64 bit
 199  * programs, since the 64 bit * bit kernel requires the user code
 200  * to have matching offsets
 201  */
 202 struct ipath_base_info {
 203         /* version of hardware, for feature checking. */
 204         __u32 spi_hw_version;
 205         /* version of software, for feature checking. */
 206         __u32 spi_sw_version;
 207         /* InfiniPath port assigned, goes into sent packets */
 208         __u16 spi_port;
 209         __u16 spi_subport;
 210         /*
 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.
 213          */
 214         __u32 spi_mtu;
 215         /*
 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.
 219          */
 220         __u32 spi_piosize;
 221         /* size of the TID cache in infinipath, in entries */
 222         __u32 spi_tidcnt;
 223         /* size of the TID Eager list in infinipath, in entries */
 224         __u32 spi_tidegrcnt;
 225         /* size of a single receive header queue entry in words. */
 226         __u32 spi_rcvhdrent_size;
 227         /*
 228          * Count of receive header queue entries allocated.
 229          * This may be less than the spu_rcvhdrcnt passed in!.
 230          */
 231         __u32 spi_rcvhdr_cnt;
 232
 233         /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
 234         __u32 spi_runtime_flags;
 235
 236         /* address where receive buffer queue is mapped into */
 237         __u64 spi_rcvhdr_base;
 238
 239         /* user program. */
 240
 241         /* base address of eager TID receive buffers. */
 242         __u64 spi_rcv_egrbufs;
 243
 244         /* Allocated by initialization code, not by protocol. */
 245
 246         /*
 247          * Size of each TID buffer in host memory, starting at
 248          * spi_rcv_egrbufs.  The buffers are virtually contiguous.
 249          */
 250         __u32 spi_rcv_egrbufsize;
 251         /*
 252          * The special QP (queue pair) value that identifies an infinipath
 253          * protocol packet from standard IB packets.  More, probably much
 254          * more, to be added.
 255          */
 256         __u32 spi_qpair;
 257
 258         /*
 259          * User register base for init code, not to be used directly by
 260          * protocol or applications.
 261          */
 262         __u64 __spi_uregbase;
 263         /*
 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.
 268          */
 269         __u32 spi_tid_maxsize;
 270         /*
 271          * alignment of each pio send buffer (byte count
 272          * to add to spi_piobufbase to get to second buffer)
 273          */
 274         __u32 spi_pioalign;
 275         /*
 276          * The index of the first pio buffer available to this process;
 277          * needed to do lookup in spi_pioavailaddr; not added to
 278          * spi_piobufbase.
 279          */
 280         __u32 spi_pioindex;
 281          /* number of buffers mapped for this process */
 282         __u32 spi_piocnt;
 283
 284         /*
 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
 288          */
 289         __u64 spi_piobufbase;
 290
 291         /*
 292          * Base address of readonly memory copy of the pioavail registers.
 293          * There are 2 bits for each buffer.
 294          */
 295         __u64 spi_pioavailaddr;
 296
 297         /*
 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.
 301          */
 302         __u64 spi_status;
 303
 304         /* number of chip ports available to user processes */
 305         __u32 spi_nports;
 306         /* unit number of chip we are using */
 307         __u32 spi_unit;
 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
 318         /* shared memory pages for subports if IPATH_RUNTIME_MASTER is set */
 319         __u64 spi_subport_uregbase;
 320         __u64 spi_subport_rcvegrbuf;
 321         __u64 spi_subport_rcvhdr_base;
 322
 323 } __attribute__ ((aligned(8)));
 324
 325
 326 /*
 327  * This version number is given to the driver by the user code during
 328  * initialization in the spu_userversion field of ipath_user_info, so
 329  * the driver can check for compatibility with user code.
 330  *
 331  * The major version changes when data structures
 332  * change in an incompatible way.  The driver must be the same or higher
 333  * for initialization to succeed.  In some cases, a higher version
 334  * driver will not interoperate with older software, and initialization
 335  * will return an error.
 336  */
 337 #define IPATH_USER_SWMAJOR 1
 338
 339 /*
 340  * Minor version differences are always compatible
 341  * a within a major version, however if user software is larger
 342  * than driver software, some new features and/or structure fields
 343  * may not be implemented; the user code must deal with this if it
 344  * cares, or it must abort after initialization reports the difference.
 345  */
 346 #define IPATH_USER_SWMINOR 3
 347
 348 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
 349
 350 #define IPATH_KERN_TYPE 0
 351
 352 /*
 353  * Similarly, this is the kernel version going back to the user.  It's
 354  * slightly different, in that we want to tell if the driver was built as
 355  * part of a QLogic release, or from the driver from openfabrics.org,
 356  * kernel.org, or a standard distribution, for support reasons.
 357  * The high bit is 0 for non-QLogic and 1 for QLogic-built/supplied.
 358  *
 359  * It's returned by the driver to the user code during initialization in the
 360  * spi_sw_version field of ipath_base_info, so the user code can in turn
 361  * check for compatibility with the kernel.
 362 */
 363 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
 364
 365 /*
 366  * This structure is passed to ipath_userinit() to tell the driver where
 367  * user code buffers are, sizes, etc.   The offsets and sizes of the
 368  * fields must remain unchanged, for binary compatibility.  It can
 369  * be extended, if userversion is changed so user code can tell, if needed
 370  */
 371 struct ipath_user_info {
 372         /*
 373          * version of user software, to detect compatibility issues.
 374          * Should be set to IPATH_USER_SWVERSION.
 375          */
 376         __u32 spu_userversion;
 377
 378         /* desired number of receive header queue entries */
 379         __u32 spu_rcvhdrcnt;
 380
 381         /* size of struct base_info to write to */
 382         __u32 spu_base_info_size;
 383
 384         /*
 385          * number of words in KD protocol header
 386          * This tells InfiniPath how many words to copy to rcvhdrq.  If 0,
 387          * kernel uses a default.  Once set, attempts to set any other value
 388          * are an error (EAGAIN) until driver is reloaded.
 389          */
 390         __u32 spu_rcvhdrsize;
 391
 392         /*
 393          * If two or more processes wish to share a port, each process
 394          * must set the spu_subport_cnt and spu_subport_id to the same
 395          * values.  The only restriction on the spu_subport_id is that
 396          * it be unique for a given node.
 397          */
 398         __u16 spu_subport_cnt;
 399         __u16 spu_subport_id;
 400
 401         __u32 spu_unused; /* kept for compatible layout */
 402
 403         /*
 404          * address of struct base_info to write to
 405          */
 406         __u64 spu_base_info;
 407
 408 } __attribute__ ((aligned(8)));
 409
 410 /* User commands. */
 411
 412 #define IPATH_CMD_MIN           16
 413
 414 #define IPATH_CMD_USER_INIT     16      /* set up userspace */
 415 #define IPATH_CMD_PORT_INFO     17      /* find out what resources we got */
 416 #define IPATH_CMD_RECV_CTRL     18      /* control receipt of packets */
 417 #define IPATH_CMD_TID_UPDATE    19      /* update expected TID entries */
 418 #define IPATH_CMD_TID_FREE      20      /* free expected TID entries */
 419 #define IPATH_CMD_SET_PART_KEY  21      /* add partition key */
 420 #define IPATH_CMD_SLAVE_INFO    22      /* return info on slave processes */
 421
 422 #define IPATH_CMD_MAX           22
 423
 424 struct ipath_port_info {
 425         __u32 num_active;       /* number of active units */
 426         __u32 unit;             /* unit (chip) assigned to caller */
 427         __u16 port;             /* port on unit assigned to caller */
 428         __u16 subport;          /* subport on unit assigned to caller */
 429         __u16 num_ports;        /* number of ports available on unit */
 430         __u16 num_subports;     /* number of subport slaves opened on port */
 431 };
 432
 433 struct ipath_tid_info {
 434         __u32 tidcnt;
 435         /* make structure same size in 32 and 64 bit */
 436         __u32 tid__unused;
 437         /* virtual address of first page in transfer */
 438         __u64 tidvaddr;
 439         /* pointer (same size 32/64 bit) to __u16 tid array */
 440         __u64 tidlist;
 441
 442         /*
 443          * pointer (same size 32/64 bit) to bitmap of TIDs used
 444          * for this call; checked for being large enough at open
 445          */
 446         __u64 tidmap;
 447 };
 448
 449 struct ipath_cmd {
 450         __u32 type;                     /* command type */
 451         union {
 452                 struct ipath_tid_info tid_info;
 453                 struct ipath_user_info user_info;
 454                 /* address in userspace of struct ipath_port_info to
 455                    write result to */
 456                 __u64 port_info;
 457                 /* enable/disable receipt of packets */
 458                 __u32 recv_ctrl;
 459                 /* partition key to set */
 460                 __u16 part_key;
 461                 /* user address of __u32 bitmask of active slaves */
 462                 __u64 slave_mask_addr;
 463         } cmd;
 464 };
 465
 466 struct ipath_iovec {
 467         /* Pointer to data, but same size 32 and 64 bit */
 468         __u64 iov_base;
 469
 470         /*
 471          * Length of data; don't need 64 bits, but want
 472          * ipath_sendpkt to remain same size as before 32 bit changes, so...
 473          */
 474         __u64 iov_len;
 475 };
 476
 477 /*
 478  * Describes a single packet for send.  Each packet can have one or more
 479  * buffers, but the total length (exclusive of IB headers) must be less
 480  * than the MTU, and if using the PIO method, entire packet length,
 481  * including IB headers, must be less than the ipath_piosize value (words).
 482  * Use of this necessitates including sys/uio.h
 483  */
 484 struct __ipath_sendpkt {
 485         __u32 sps_flags;        /* flags for packet (TBD) */
 486         __u32 sps_cnt;          /* number of entries to use in sps_iov */
 487         /* array of iov's describing packet. TEMPORARY */
 488         struct ipath_iovec sps_iov[4];
 489 };
 490
 491 /* Passed into diag data special file's ->write method. */
 492 struct ipath_diag_pkt {
 493         __u32 unit;
 494         __u64 data;
 495         __u32 len;
 496 };
 497
 498 /*
 499  * Data layout in I2C flash (for GUID, etc.)
 500  * All fields are little-endian binary unless otherwise stated
 501  */
 502 #define IPATH_FLASH_VERSION 2
 503 struct ipath_flash {
 504         /* flash layout version (IPATH_FLASH_VERSION) */
 505         __u8 if_fversion;
 506         /* checksum protecting if_length bytes */
 507         __u8 if_csum;
 508         /*
 509          * valid length (in use, protected by if_csum), including
 510          * if_fversion and if_csum themselves)
 511          */
 512         __u8 if_length;
 513         /* the GUID, in network order */
 514         __u8 if_guid[8];
 515         /* number of GUIDs to use, starting from if_guid */
 516         __u8 if_numguid;
 517         /* the (last 10 characters of) board serial number, in ASCII */
 518         char if_serial[12];
 519         /* board mfg date (YYYYMMDD ASCII) */
 520         char if_mfgdate[8];
 521         /* last board rework/test date (YYYYMMDD ASCII) */
 522         char if_testdate[8];
 523         /* logging of error counts, TBD */
 524         __u8 if_errcntp[4];
 525         /* powered on hours, updated at driver unload */
 526         __u8 if_powerhour[2];
 527         /* ASCII free-form comment field */
 528         char if_comment[32];
 529         /* Backwards compatible prefix for longer QLogic Serial Numbers */
 530         char if_sprefix[4];
 531         /* 82 bytes used, min flash size is 128 bytes */
 532         __u8 if_future[46];
 533 };
 534
 535 /*
 536  * These are the counters implemented in the chip, and are listed in order.
 537  * The InterCaps naming is taken straight from the chip spec.
 538  */
 539 struct infinipath_counters {
 540         __u64 LBIntCnt;
 541         __u64 LBFlowStallCnt;
 542         __u64 Reserved1;
 543         __u64 TxUnsupVLErrCnt;
 544         __u64 TxDataPktCnt;
 545         __u64 TxFlowPktCnt;
 546         __u64 TxDwordCnt;
 547         __u64 TxLenErrCnt;
 548         __u64 TxMaxMinLenErrCnt;
 549         __u64 TxUnderrunCnt;
 550         __u64 TxFlowStallCnt;
 551         __u64 TxDroppedPktCnt;
 552         __u64 RxDroppedPktCnt;
 553         __u64 RxDataPktCnt;
 554         __u64 RxFlowPktCnt;
 555         __u64 RxDwordCnt;
 556         __u64 RxLenErrCnt;
 557         __u64 RxMaxMinLenErrCnt;
 558         __u64 RxICRCErrCnt;
 559         __u64 RxVCRCErrCnt;
 560         __u64 RxFlowCtrlErrCnt;
 561         __u64 RxBadFormatCnt;
 562         __u64 RxLinkProblemCnt;
 563         __u64 RxEBPCnt;
 564         __u64 RxLPCRCErrCnt;
 565         __u64 RxBufOvflCnt;
 566         __u64 RxTIDFullErrCnt;
 567         __u64 RxTIDValidErrCnt;
 568         __u64 RxPKeyMismatchCnt;
 569         __u64 RxP0HdrEgrOvflCnt;
 570         __u64 RxP1HdrEgrOvflCnt;
 571         __u64 RxP2HdrEgrOvflCnt;
 572         __u64 RxP3HdrEgrOvflCnt;
 573         __u64 RxP4HdrEgrOvflCnt;
 574         __u64 RxP5HdrEgrOvflCnt;
 575         __u64 RxP6HdrEgrOvflCnt;
 576         __u64 RxP7HdrEgrOvflCnt;
 577         __u64 RxP8HdrEgrOvflCnt;
 578         __u64 Reserved6;
 579         __u64 Reserved7;
 580         __u64 IBStatusChangeCnt;
 581         __u64 IBLinkErrRecoveryCnt;
 582         __u64 IBLinkDownedCnt;
 583         __u64 IBSymbolErrCnt;
 584 };
 585
 586 /*
 587  * The next set of defines are for packet headers, and chip register
 588  * and memory bits that are visible to and/or used by user-mode software
 589  * The other bits that are used only by the driver or diags are in
 590  * ipath_registers.h
 591  */
 592
 593 /* RcvHdrFlags bits */
 594 #define INFINIPATH_RHF_LENGTH_MASK 0x7FF
 595 #define INFINIPATH_RHF_LENGTH_SHIFT 0
 596 #define INFINIPATH_RHF_RCVTYPE_MASK 0x7
 597 #define INFINIPATH_RHF_RCVTYPE_SHIFT 11
 598 #define INFINIPATH_RHF_EGRINDEX_MASK 0x7FF
 599 #define INFINIPATH_RHF_EGRINDEX_SHIFT 16
 600 #define INFINIPATH_RHF_H_ICRCERR   0x80000000
 601 #define INFINIPATH_RHF_H_VCRCERR   0x40000000
 602 #define INFINIPATH_RHF_H_PARITYERR 0x20000000
 603 #define INFINIPATH_RHF_H_LENERR    0x10000000
 604 #define INFINIPATH_RHF_H_MTUERR    0x08000000
 605 #define INFINIPATH_RHF_H_IHDRERR   0x04000000
 606 #define INFINIPATH_RHF_H_TIDERR    0x02000000
 607 #define INFINIPATH_RHF_H_MKERR     0x01000000
 608 #define INFINIPATH_RHF_H_IBERR     0x00800000
 609 #define INFINIPATH_RHF_L_SWA       0x00008000
 610 #define INFINIPATH_RHF_L_SWB       0x00004000
 611
 612 /* infinipath header fields */
 613 #define INFINIPATH_I_VERS_MASK 0xF
 614 #define INFINIPATH_I_VERS_SHIFT 28
 615 #define INFINIPATH_I_PORT_MASK 0xF
 616 #define INFINIPATH_I_PORT_SHIFT 24
 617 #define INFINIPATH_I_TID_MASK 0x7FF
 618 #define INFINIPATH_I_TID_SHIFT 13
 619 #define INFINIPATH_I_OFFSET_MASK 0x1FFF
 620 #define INFINIPATH_I_OFFSET_SHIFT 0
 621
 622 /* K_PktFlags bits */
 623 #define INFINIPATH_KPF_INTR 0x1
 624 #define INFINIPATH_KPF_SUBPORT_MASK 0x3
 625 #define INFINIPATH_KPF_SUBPORT_SHIFT 1
 626
 627 #define INFINIPATH_MAX_SUBPORT  4
 628
 629 /* SendPIO per-buffer control */
 630 #define INFINIPATH_SP_TEST    0x40
 631 #define INFINIPATH_SP_TESTEBP 0x20
 632
 633 /* SendPIOAvail bits */
 634 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
 635 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
 636
 637 /* infinipath header format */
 638 struct ipath_header {
 639         /*
 640          * Version - 4 bits, Port - 4 bits, TID - 10 bits and Offset -
 641          * 14 bits before ECO change ~28 Dec 03.  After that, Vers 4,
 642          * Port 4, TID 11, offset 13.
 643          */
 644         __le32 ver_port_tid_offset;
 645         __le16 chksum;
 646         __le16 pkt_flags;
 647 };
 648
 649 /* infinipath user message header format.
 650  * This structure contains the first 4 fields common to all protocols
 651  * that employ infinipath.
 652  */
 653 struct ipath_message_header {
 654         __be16 lrh[4];
 655         __be32 bth[3];
 656         /* fields below this point are in host byte order */
 657         struct ipath_header iph;
 658         __u8 sub_opcode;
 659 };
 660
 661 /* infinipath ethernet header format */
 662 struct ether_header {
 663         __be16 lrh[4];
 664         __be32 bth[3];
 665         struct ipath_header iph;
 666         __u8 sub_opcode;
 667         __u8 cmd;
 668         __be16 lid;
 669         __u16 mac[3];
 670         __u8 frag_num;
 671         __u8 seq_num;
 672         __le32 len;
 673         /* MUST be of word size due to PIO write requirements */
 674         __le32 csum;
 675         __le16 csum_offset;
 676         __le16 flags;
 677         __u16 first_2_bytes;
 678         __u8 unused[2];         /* currently unused */
 679 };
 680
 681
 682 /* IB - LRH header consts */
 683 #define IPATH_LRH_GRH 0x0003    /* 1. word of IB LRH - next header: GRH */
 684 #define IPATH_LRH_BTH 0x0002    /* 1. word of IB LRH - next header: BTH */
 685
 686 /* misc. */
 687 #define SIZE_OF_CRC 1
 688
 689 #define IPATH_DEFAULT_P_KEY 0xFFFF
 690 #define IPATH_PERMISSIVE_LID 0xFFFF
 691 #define IPATH_AETH_CREDIT_SHIFT 24
 692 #define IPATH_AETH_CREDIT_MASK 0x1F
 693 #define IPATH_AETH_CREDIT_INVAL 0x1F
 694 #define IPATH_PSN_MASK 0xFFFFFF
 695 #define IPATH_MSN_MASK 0xFFFFFF
 696 #define IPATH_QPN_MASK 0xFFFFFF
 697 #define IPATH_MULTICAST_LID_BASE 0xC000
 698 #define IPATH_MULTICAST_QPN 0xFFFFFF
 699
 700 /* Receive Header Queue: receive type (from infinipath) */
 701 #define RCVHQ_RCV_TYPE_EXPECTED  0
 702 #define RCVHQ_RCV_TYPE_EAGER     1
 703 #define RCVHQ_RCV_TYPE_NON_KD    2
 704 #define RCVHQ_RCV_TYPE_ERROR     3
 705
 706
 707 /* sub OpCodes - ith4x  */
 708 #define IPATH_ITH4X_OPCODE_ENCAP 0x81
 709 #define IPATH_ITH4X_OPCODE_LID_ARP 0x82
 710
 711 #define IPATH_HEADER_QUEUE_WORDS 9
 712
 713 /* functions for extracting fields from rcvhdrq entries for the driver.
 714  */
 715 static inline __u32 ipath_hdrget_err_flags(const __le32 * rbuf)
 716 {
 717         return __le32_to_cpu(rbuf[1]);
 718 }
 719
 720 static inline __u32 ipath_hdrget_rcv_type(const __le32 * rbuf)
 721 {
 722         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_RCVTYPE_SHIFT)
 723             & INFINIPATH_RHF_RCVTYPE_MASK;
 724 }
 725
 726 static inline __u32 ipath_hdrget_length_in_bytes(const __le32 * rbuf)
 727 {
 728         return ((__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_LENGTH_SHIFT)
 729                 & INFINIPATH_RHF_LENGTH_MASK) << 2;
 730 }
 731
 732 static inline __u32 ipath_hdrget_index(const __le32 * rbuf)
 733 {
 734         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_EGRINDEX_SHIFT)
 735             & INFINIPATH_RHF_EGRINDEX_MASK;
 736 }
 737
 738 static inline __u32 ipath_hdrget_ipath_ver(__le32 hdrword)
 739 {
 740         return (__le32_to_cpu(hdrword) >> INFINIPATH_I_VERS_SHIFT)
 741             & INFINIPATH_I_VERS_MASK;
 742 }
 743
 744 #endif                          /* _IPATH_COMMON_H */