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