drivers/infiniband/hw/ipath/ipath_common.h

   1 /*
   2  * Copyright (c) 2006, 2007 QLogic Corporation. All rights reserved.
   3  * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 #ifndef _IPATH_COMMON_H
  35 #define _IPATH_COMMON_H
  36
  37 /*
  38  * This file contains defines, structures, etc. that are used
  39  * to communicate between kernel and user code.
  40  */
  41
  42
  43 /* This is the IEEE-assigned OUI for QLogic Inc. InfiniPath */
  44 #define IPATH_SRC_OUI_1 0x00
  45 #define IPATH_SRC_OUI_2 0x11
  46 #define IPATH_SRC_OUI_3 0x75
  47
  48 /* version of protocol header (known to chip also). In the long run,
  49  * we should be able to generate and accept a range of version numbers;
  50  * for now we only accept one, and it's compiled in.
  51  */
  52 #define IPS_PROTO_VERSION 2
  53
  54 /*
  55  * These are compile time constants that you may want to enable or disable
  56  * if you are trying to debug problems with code or performance.
  57  * IPATH_VERBOSE_TRACING define as 1 if you want additional tracing in
  58  * fastpath code
  59  * IPATH_TRACE_REGWRITES define as 1 if you want register writes to be
  60  * traced in faspath code
  61  * _IPATH_TRACING define as 0 if you want to remove all tracing in a
  62  * compilation unit
  63  * _IPATH_DEBUGGING define as 0 if you want to remove debug prints
  64  */
  65
  66 /*
  67  * The value in the BTH QP field that InfiniPath uses to differentiate
  68  * an infinipath protocol IB packet vs standard IB transport
  69  */
  70 #define IPATH_KD_QP 0x656b79
  71
  72 /*
  73  * valid states passed to ipath_set_linkstate() user call
  74  */
  75 #define IPATH_IB_LINKDOWN               0
  76 #define IPATH_IB_LINKARM                1
  77 #define IPATH_IB_LINKACTIVE             2
  78 #define IPATH_IB_LINKDOWN_ONLY          3
  79 #define IPATH_IB_LINKDOWN_SLEEP         4
  80 #define IPATH_IB_LINKDOWN_DISABLE       5
  81 #define IPATH_IB_LINK_LOOPBACK  6 /* enable local loopback */
  82 #define IPATH_IB_LINK_EXTERNAL  7 /* normal, disable local loopback */
  83 #define IPATH_IB_LINK_NO_HRTBT  8 /* disable Heartbeat, e.g. for loopback */
  84 #define IPATH_IB_LINK_HRTBT     9 /* enable heartbeat, normal, non-loopback */
  85
  86 /*
  87  * These 3 values (SDR and DDR may be ORed for auto-speed
  88  * negotiation) are used for the 3rd argument to path_f_set_ib_cfg
  89  * with cmd IPATH_IB_CFG_SPD_ENB, by direct calls or via sysfs.  They
  90  * are also the the possible values for ipath_link_speed_enabled and active
  91  * The values were chosen to match values used within the IB spec.
  92  */
  93 #define IPATH_IB_SDR 1
  94 #define IPATH_IB_DDR 2
  95
  96 /*
  97  * stats maintained by the driver.  For now, at least, this is global
  98  * to all minor devices.
  99  */
 100 struct infinipath_stats {
 101         /* number of interrupts taken */
 102         __u64 sps_ints;
 103         /* number of interrupts for errors */
 104         __u64 sps_errints;
 105         /* number of errors from chip (not incl. packet errors or CRC) */
 106         __u64 sps_errs;
 107         /* number of packet errors from chip other than CRC */
 108         __u64 sps_pkterrs;
 109         /* number of packets with CRC errors (ICRC and VCRC) */
 110         __u64 sps_crcerrs;
 111         /* number of hardware errors reported (parity, etc.) */
 112         __u64 sps_hwerrs;
 113         /* number of times IB link changed state unexpectedly */
 114         __u64 sps_iblink;
 115         __u64 sps_unused; /* was fastrcvint, no longer implemented */
 116         /* number of kernel (port0) packets received */
 117         __u64 sps_port0pkts;
 118         /* number of "ethernet" packets sent by driver */
 119         __u64 sps_ether_spkts;
 120         /* number of "ethernet" packets received by driver */
 121         __u64 sps_ether_rpkts;
 122         /* number of SMA packets sent by driver. Obsolete. */
 123         __u64 sps_sma_spkts;
 124         /* number of SMA packets received by driver. Obsolete. */
 125         __u64 sps_sma_rpkts;
 126         /* number of times all ports rcvhdrq was full and packet dropped */
 127         __u64 sps_hdrqfull;
 128         /* number of times all ports egrtid was full and packet dropped */
 129         __u64 sps_etidfull;
 130         /*
 131          * number of times we tried to send from driver, but no pio buffers
 132          * avail
 133          */
 134         __u64 sps_nopiobufs;
 135         /* number of ports currently open */
 136         __u64 sps_ports;
 137         /* list of pkeys (other than default) accepted (0 means not set) */
 138         __u16 sps_pkeys[4];
 139         __u16 sps_unused16[4]; /* available; maintaining compatible layout */
 140         /* number of user ports per chip (not IB ports) */
 141         __u32 sps_nports;
 142         /* not our interrupt, or already handled */
 143         __u32 sps_nullintr;
 144         /* max number of packets handled per receive call */
 145         __u32 sps_maxpkts_call;
 146         /* avg number of packets handled per receive call */
 147         __u32 sps_avgpkts_call;
 148         /* total number of pages locked */
 149         __u64 sps_pagelocks;
 150         /* total number of pages unlocked */
 151         __u64 sps_pageunlocks;
 152         /*
 153          * Number of packets dropped in kernel other than errors (ether
 154          * packets if ipath not configured, etc.)
 155          */
 156         __u64 sps_krdrops;
 157         __u64 sps_txeparity; /* PIO buffer parity error, recovered */
 158         /* pad for future growth */
 159         __u64 __sps_pad[45];
 160 };
 161
 162 /*
 163  * These are the status bits readable (in ascii form, 64bit value)
 164  * from the "status" sysfs file.
 165  */
 166 #define IPATH_STATUS_INITTED       0x1  /* basic initialization done */
 167 #define IPATH_STATUS_DISABLED      0x2  /* hardware disabled */
 168 /* Device has been disabled via admin request */
 169 #define IPATH_STATUS_ADMIN_DISABLED    0x4
 170 /* Chip has been found and initted */
 171 #define IPATH_STATUS_CHIP_PRESENT 0x20
 172 /* IB link is at ACTIVE, usable for data traffic */
 173 #define IPATH_STATUS_IB_READY     0x40
 174 /* link is configured, LID, MTU, etc. have been set */
 175 #define IPATH_STATUS_IB_CONF      0x80
 176 /* no link established, probably no cable */
 177 #define IPATH_STATUS_IB_NOCABLE  0x100
 178 /* A Fatal hardware error has occurred. */
 179 #define IPATH_STATUS_HWERROR     0x200
 180
 181 /*
 182  * The list of usermode accessible registers.  Also see Reg_* later in file.
 183  */
 184 typedef enum _ipath_ureg {
 185         /* (RO)  DMA RcvHdr to be used next. */
 186         ur_rcvhdrtail = 0,
 187         /* (RW)  RcvHdr entry to be processed next by host. */
 188         ur_rcvhdrhead = 1,
 189         /* (RO)  Index of next Eager index to use. */
 190         ur_rcvegrindextail = 2,
 191         /* (RW)  Eager TID to be processed next */
 192         ur_rcvegrindexhead = 3,
 193         /* For internal use only; max register number. */
 194         _IPATH_UregMax
 195 } ipath_ureg;
 196
 197 /* bit values for spi_runtime_flags */
 198 #define IPATH_RUNTIME_HT        0x1
 199 #define IPATH_RUNTIME_PCIE      0x2
 200 #define IPATH_RUNTIME_FORCE_WC_ORDER    0x4
 201 #define IPATH_RUNTIME_RCVHDR_COPY       0x8
 202 #define IPATH_RUNTIME_MASTER    0x10
 203 #define IPATH_RUNTIME_NODMA_RTAIL 0x80
 204 #define IPATH_RUNTIME_FORCE_PIOAVAIL 0x400
 205 #define IPATH_RUNTIME_PIO_REGSWAPPED 0x800
 206
 207 /*
 208  * This structure is returned by ipath_userinit() immediately after
 209  * open to get implementation-specific info, and info specific to this
 210  * instance.
 211  *
 212  * This struct must have explict pad fields where type sizes
 213  * may result in different alignments between 32 and 64 bit
 214  * programs, since the 64 bit * bit kernel requires the user code
 215  * to have matching offsets
 216  */
 217 struct ipath_base_info {
 218         /* version of hardware, for feature checking. */
 219         __u32 spi_hw_version;
 220         /* version of software, for feature checking. */
 221         __u32 spi_sw_version;
 222         /* InfiniPath port assigned, goes into sent packets */
 223         __u16 spi_port;
 224         __u16 spi_subport;
 225         /*
 226          * IB MTU, packets IB data must be less than this.
 227          * The MTU is in bytes, and will be a multiple of 4 bytes.
 228          */
 229         __u32 spi_mtu;
 230         /*
 231          * Size of a PIO buffer.  Any given packet's total size must be less
 232          * than this (in words).  Included is the starting control word, so
 233          * if 513 is returned, then total pkt size is 512 words or less.
 234          */
 235         __u32 spi_piosize;
 236         /* size of the TID cache in infinipath, in entries */
 237         __u32 spi_tidcnt;
 238         /* size of the TID Eager list in infinipath, in entries */
 239         __u32 spi_tidegrcnt;
 240         /* size of a single receive header queue entry in words. */
 241         __u32 spi_rcvhdrent_size;
 242         /*
 243          * Count of receive header queue entries allocated.
 244          * This may be less than the spu_rcvhdrcnt passed in!.
 245          */
 246         __u32 spi_rcvhdr_cnt;
 247
 248         /* per-chip and other runtime features bitmap (IPATH_RUNTIME_*) */
 249         __u32 spi_runtime_flags;
 250
 251         /* address where receive buffer queue is mapped into */
 252         __u64 spi_rcvhdr_base;
 253
 254         /* user program. */
 255
 256         /* base address of eager TID receive buffers. */
 257         __u64 spi_rcv_egrbufs;
 258
 259         /* Allocated by initialization code, not by protocol. */
 260
 261         /*
 262          * Size of each TID buffer in host memory, starting at
 263          * spi_rcv_egrbufs.  The buffers are virtually contiguous.
 264          */
 265         __u32 spi_rcv_egrbufsize;
 266         /*
 267          * The special QP (queue pair) value that identifies an infinipath
 268          * protocol packet from standard IB packets.  More, probably much
 269          * more, to be added.
 270          */
 271         __u32 spi_qpair;
 272
 273         /*
 274          * User register base for init code, not to be used directly by
 275          * protocol or applications.
 276          */
 277         __u64 __spi_uregbase;
 278         /*
 279          * Maximum buffer size in bytes that can be used in a single TID
 280          * entry (assuming the buffer is aligned to this boundary).  This is
 281          * the minimum of what the hardware and software support Guaranteed
 282          * to be a power of 2.
 283          */
 284         __u32 spi_tid_maxsize;
 285         /*
 286          * alignment of each pio send buffer (byte count
 287          * to add to spi_piobufbase to get to second buffer)
 288          */
 289         __u32 spi_pioalign;
 290         /*
 291          * The index of the first pio buffer available to this process;
 292          * needed to do lookup in spi_pioavailaddr; not added to
 293          * spi_piobufbase.
 294          */
 295         __u32 spi_pioindex;
 296          /* number of buffers mapped for this process */
 297         __u32 spi_piocnt;
 298
 299         /*
 300          * Base address of writeonly pio buffers for this process.
 301          * Each buffer has spi_piosize words, and is aligned on spi_pioalign
 302          * boundaries.  spi_piocnt buffers are mapped from this address
 303          */
 304         __u64 spi_piobufbase;
 305
 306         /*
 307          * Base address of readonly memory copy of the pioavail registers.
 308          * There are 2 bits for each buffer.
 309          */
 310         __u64 spi_pioavailaddr;
 311
 312         /*
 313          * Address where driver updates a copy of the interface and driver
 314          * status (IPATH_STATUS_*) as a 64 bit value.  It's followed by a
 315          * string indicating hardware error, if there was one.
 316          */
 317         __u64 spi_status;
 318
 319         /* number of chip ports available to user processes */
 320         __u32 spi_nports;
 321         /* unit number of chip we are using */
 322         __u32 spi_unit;
 323         /* num bufs in each contiguous set */
 324         __u32 spi_rcv_egrperchunk;
 325         /* size in bytes of each contiguous set */
 326         __u32 spi_rcv_egrchunksize;
 327         /* total size of mmap to cover full rcvegrbuffers */
 328         __u32 spi_rcv_egrbuftotlen;
 329         __u32 spi_filler_for_align;
 330         /* address of readonly memory copy of the rcvhdrq tail register. */
 331         __u64 spi_rcvhdr_tailaddr;
 332
 333         /* shared memory pages for subports if port is shared */
 334         __u64 spi_subport_uregbase;
 335         __u64 spi_subport_rcvegrbuf;
 336         __u64 spi_subport_rcvhdr_base;
 337
 338         /* shared memory page for hardware port if it is shared */
 339         __u64 spi_port_uregbase;
 340         __u64 spi_port_rcvegrbuf;
 341         __u64 spi_port_rcvhdr_base;
 342         __u64 spi_port_rcvhdr_tailaddr;
 343
 344 } __attribute__ ((aligned(8)));
 345
 346
 347 /*
 348  * This version number is given to the driver by the user code during
 349  * initialization in the spu_userversion field of ipath_user_info, so
 350  * the driver can check for compatibility with user code.
 351  *
 352  * The major version changes when data structures
 353  * change in an incompatible way.  The driver must be the same or higher
 354  * for initialization to succeed.  In some cases, a higher version
 355  * driver will not interoperate with older software, and initialization
 356  * will return an error.
 357  */
 358 #define IPATH_USER_SWMAJOR 1
 359
 360 /*
 361  * Minor version differences are always compatible
 362  * a within a major version, however if user software is larger
 363  * than driver software, some new features and/or structure fields
 364  * may not be implemented; the user code must deal with this if it
 365  * cares, or it must abort after initialization reports the difference.
 366  */
 367 #define IPATH_USER_SWMINOR 6
 368
 369 #define IPATH_USER_SWVERSION ((IPATH_USER_SWMAJOR<<16) | IPATH_USER_SWMINOR)
 370
 371 #define IPATH_KERN_TYPE 0
 372
 373 /*
 374  * Similarly, this is the kernel version going back to the user.  It's
 375  * slightly different, in that we want to tell if the driver was built as
 376  * part of a QLogic release, or from the driver from openfabrics.org,
 377  * kernel.org, or a standard distribution, for support reasons.
 378  * The high bit is 0 for non-QLogic and 1 for QLogic-built/supplied.
 379  *
 380  * It's returned by the driver to the user code during initialization in the
 381  * spi_sw_version field of ipath_base_info, so the user code can in turn
 382  * check for compatibility with the kernel.
 383 */
 384 #define IPATH_KERN_SWVERSION ((IPATH_KERN_TYPE<<31) | IPATH_USER_SWVERSION)
 385
 386 /*
 387  * This structure is passed to ipath_userinit() to tell the driver where
 388  * user code buffers are, sizes, etc.   The offsets and sizes of the
 389  * fields must remain unchanged, for binary compatibility.  It can
 390  * be extended, if userversion is changed so user code can tell, if needed
 391  */
 392 struct ipath_user_info {
 393         /*
 394          * version of user software, to detect compatibility issues.
 395          * Should be set to IPATH_USER_SWVERSION.
 396          */
 397         __u32 spu_userversion;
 398
 399         /* desired number of receive header queue entries */
 400         __u32 spu_rcvhdrcnt;
 401
 402         /* size of struct base_info to write to */
 403         __u32 spu_base_info_size;
 404
 405         /*
 406          * number of words in KD protocol header
 407          * This tells InfiniPath how many words to copy to rcvhdrq.  If 0,
 408          * kernel uses a default.  Once set, attempts to set any other value
 409          * are an error (EAGAIN) until driver is reloaded.
 410          */
 411         __u32 spu_rcvhdrsize;
 412
 413         /*
 414          * If two or more processes wish to share a port, each process
 415          * must set the spu_subport_cnt and spu_subport_id to the same
 416          * values.  The only restriction on the spu_subport_id is that
 417          * it be unique for a given node.
 418          */
 419         __u16 spu_subport_cnt;
 420         __u16 spu_subport_id;
 421
 422         __u32 spu_unused; /* kept for compatible layout */
 423
 424         /*
 425          * address of struct base_info to write to
 426          */
 427         __u64 spu_base_info;
 428
 429 } __attribute__ ((aligned(8)));
 430
 431 /* User commands. */
 432
 433 #define IPATH_CMD_MIN           16
 434
 435 #define __IPATH_CMD_USER_INIT   16      /* old set up userspace (for old user code) */
 436 #define IPATH_CMD_PORT_INFO     17      /* find out what resources we got */
 437 #define IPATH_CMD_RECV_CTRL     18      /* control receipt of packets */
 438 #define IPATH_CMD_TID_UPDATE    19      /* update expected TID entries */
 439 #define IPATH_CMD_TID_FREE      20      /* free expected TID entries */
 440 #define IPATH_CMD_SET_PART_KEY  21      /* add partition key */
 441 #define __IPATH_CMD_SLAVE_INFO  22      /* return info on slave processes (for old user code) */
 442 #define IPATH_CMD_ASSIGN_PORT   23      /* allocate HCA and port */
 443 #define IPATH_CMD_USER_INIT     24      /* set up userspace */
 444 #define IPATH_CMD_UNUSED_1      25
 445 #define IPATH_CMD_UNUSED_2      26
 446 #define IPATH_CMD_PIOAVAILUPD   27      /* force an update of PIOAvail reg */
 447 #define IPATH_CMD_POLL_TYPE     28      /* set the kind of polling we want */
 448 #define IPATH_CMD_ARMLAUNCH_CTRL        29 /* armlaunch detection control */
 449
 450 #define IPATH_CMD_MAX           29
 451
 452 /*
 453  * Poll types
 454  */
 455 #define IPATH_POLL_TYPE_URGENT   0x01
 456 #define IPATH_POLL_TYPE_OVERFLOW 0x02
 457
 458 struct ipath_port_info {
 459         __u32 num_active;       /* number of active units */
 460         __u32 unit;             /* unit (chip) assigned to caller */
 461         __u16 port;             /* port on unit assigned to caller */
 462         __u16 subport;          /* subport on unit assigned to caller */
 463         __u16 num_ports;        /* number of ports available on unit */
 464         __u16 num_subports;     /* number of subports opened on port */
 465 };
 466
 467 struct ipath_tid_info {
 468         __u32 tidcnt;
 469         /* make structure same size in 32 and 64 bit */
 470         __u32 tid__unused;
 471         /* virtual address of first page in transfer */
 472         __u64 tidvaddr;
 473         /* pointer (same size 32/64 bit) to __u16 tid array */
 474         __u64 tidlist;
 475
 476         /*
 477          * pointer (same size 32/64 bit) to bitmap of TIDs used
 478          * for this call; checked for being large enough at open
 479          */
 480         __u64 tidmap;
 481 };
 482
 483 struct ipath_cmd {
 484         __u32 type;                     /* command type */
 485         union {
 486                 struct ipath_tid_info tid_info;
 487                 struct ipath_user_info user_info;
 488                 /* address in userspace of struct ipath_port_info to
 489                    write result to */
 490                 __u64 port_info;
 491                 /* enable/disable receipt of packets */
 492                 __u32 recv_ctrl;
 493                 /* enable/disable armlaunch errors (non-zero to enable) */
 494                 __u32 armlaunch_ctrl;
 495                 /* partition key to set */
 496                 __u16 part_key;
 497                 /* user address of __u32 bitmask of active slaves */
 498                 __u64 slave_mask_addr;
 499                 /* type of polling we want */
 500                 __u16 poll_type;
 501         } cmd;
 502 };
 503
 504 struct ipath_iovec {
 505         /* Pointer to data, but same size 32 and 64 bit */
 506         __u64 iov_base;
 507
 508         /*
 509          * Length of data; don't need 64 bits, but want
 510          * ipath_sendpkt to remain same size as before 32 bit changes, so...
 511          */
 512         __u64 iov_len;
 513 };
 514
 515 /*
 516  * Describes a single packet for send.  Each packet can have one or more
 517  * buffers, but the total length (exclusive of IB headers) must be less
 518  * than the MTU, and if using the PIO method, entire packet length,
 519  * including IB headers, must be less than the ipath_piosize value (words).
 520  * Use of this necessitates including sys/uio.h
 521  */
 522 struct __ipath_sendpkt {
 523         __u32 sps_flags;        /* flags for packet (TBD) */
 524         __u32 sps_cnt;          /* number of entries to use in sps_iov */
 525         /* array of iov's describing packet. TEMPORARY */
 526         struct ipath_iovec sps_iov[4];
 527 };
 528
 529 /*
 530  * diagnostics can send a packet by "writing" one of the following
 531  * two structs to diag data special file
 532  * The first is the legacy version for backward compatibility
 533  */
 534 struct ipath_diag_pkt {
 535         __u32 unit;
 536         __u64 data;
 537         __u32 len;
 538 };
 539
 540 /* The second diag_pkt struct is the expanded version that allows
 541  * more control over the packet, specifically, by allowing a custom
 542  * pbc (+ extra) qword, so that special modes and deliberate
 543  * changes to CRCs can be used. The elements were also re-ordered
 544  * for better alignment and to avoid padding issues.
 545  */
 546 struct ipath_diag_xpkt {
 547         __u64 data;
 548         __u64 pbc_wd;
 549         __u32 unit;
 550         __u32 len;
 551 };
 552
 553 /*
 554  * Data layout in I2C flash (for GUID, etc.)
 555  * All fields are little-endian binary unless otherwise stated
 556  */
 557 #define IPATH_FLASH_VERSION 2
 558 struct ipath_flash {
 559         /* flash layout version (IPATH_FLASH_VERSION) */
 560         __u8 if_fversion;
 561         /* checksum protecting if_length bytes */
 562         __u8 if_csum;
 563         /*
 564          * valid length (in use, protected by if_csum), including
 565          * if_fversion and if_csum themselves)
 566          */
 567         __u8 if_length;
 568         /* the GUID, in network order */
 569         __u8 if_guid[8];
 570         /* number of GUIDs to use, starting from if_guid */
 571         __u8 if_numguid;
 572         /* the (last 10 characters of) board serial number, in ASCII */
 573         char if_serial[12];
 574         /* board mfg date (YYYYMMDD ASCII) */
 575         char if_mfgdate[8];
 576         /* last board rework/test date (YYYYMMDD ASCII) */
 577         char if_testdate[8];
 578         /* logging of error counts, TBD */
 579         __u8 if_errcntp[4];
 580         /* powered on hours, updated at driver unload */
 581         __u8 if_powerhour[2];
 582         /* ASCII free-form comment field */
 583         char if_comment[32];
 584         /* Backwards compatible prefix for longer QLogic Serial Numbers */
 585         char if_sprefix[4];
 586         /* 82 bytes used, min flash size is 128 bytes */
 587         __u8 if_future[46];
 588 };
 589
 590 /*
 591  * These are the counters implemented in the chip, and are listed in order.
 592  * The InterCaps naming is taken straight from the chip spec.
 593  */
 594 struct infinipath_counters {
 595         __u64 LBIntCnt;
 596         __u64 LBFlowStallCnt;
 597         __u64 TxSDmaDescCnt;    /* was Reserved1 */
 598         __u64 TxUnsupVLErrCnt;
 599         __u64 TxDataPktCnt;
 600         __u64 TxFlowPktCnt;
 601         __u64 TxDwordCnt;
 602         __u64 TxLenErrCnt;
 603         __u64 TxMaxMinLenErrCnt;
 604         __u64 TxUnderrunCnt;
 605         __u64 TxFlowStallCnt;
 606         __u64 TxDroppedPktCnt;
 607         __u64 RxDroppedPktCnt;
 608         __u64 RxDataPktCnt;
 609         __u64 RxFlowPktCnt;
 610         __u64 RxDwordCnt;
 611         __u64 RxLenErrCnt;
 612         __u64 RxMaxMinLenErrCnt;
 613         __u64 RxICRCErrCnt;
 614         __u64 RxVCRCErrCnt;
 615         __u64 RxFlowCtrlErrCnt;
 616         __u64 RxBadFormatCnt;
 617         __u64 RxLinkProblemCnt;
 618         __u64 RxEBPCnt;
 619         __u64 RxLPCRCErrCnt;
 620         __u64 RxBufOvflCnt;
 621         __u64 RxTIDFullErrCnt;
 622         __u64 RxTIDValidErrCnt;
 623         __u64 RxPKeyMismatchCnt;
 624         __u64 RxP0HdrEgrOvflCnt;
 625         __u64 RxP1HdrEgrOvflCnt;
 626         __u64 RxP2HdrEgrOvflCnt;
 627         __u64 RxP3HdrEgrOvflCnt;
 628         __u64 RxP4HdrEgrOvflCnt;
 629         __u64 RxP5HdrEgrOvflCnt;
 630         __u64 RxP6HdrEgrOvflCnt;
 631         __u64 RxP7HdrEgrOvflCnt;
 632         __u64 RxP8HdrEgrOvflCnt;
 633         __u64 RxP9HdrEgrOvflCnt;        /* was Reserved6 */
 634         __u64 RxP10HdrEgrOvflCnt;       /* was Reserved7 */
 635         __u64 RxP11HdrEgrOvflCnt;       /* new for IBA7220 */
 636         __u64 RxP12HdrEgrOvflCnt;       /* new for IBA7220 */
 637         __u64 RxP13HdrEgrOvflCnt;       /* new for IBA7220 */
 638         __u64 RxP14HdrEgrOvflCnt;       /* new for IBA7220 */
 639         __u64 RxP15HdrEgrOvflCnt;       /* new for IBA7220 */
 640         __u64 RxP16HdrEgrOvflCnt;       /* new for IBA7220 */
 641         __u64 IBStatusChangeCnt;
 642         __u64 IBLinkErrRecoveryCnt;
 643         __u64 IBLinkDownedCnt;
 644         __u64 IBSymbolErrCnt;
 645         /* The following are new for IBA7220 */
 646         __u64 RxVL15DroppedPktCnt;
 647         __u64 RxOtherLocalPhyErrCnt;
 648         __u64 PcieRetryBufDiagQwordCnt;
 649         __u64 ExcessBufferOvflCnt;
 650         __u64 LocalLinkIntegrityErrCnt;
 651         __u64 RxVlErrCnt;
 652         __u64 RxDlidFltrCnt;
 653 };
 654
 655 /*
 656  * The next set of defines are for packet headers, and chip register
 657  * and memory bits that are visible to and/or used by user-mode software
 658  * The other bits that are used only by the driver or diags are in
 659  * ipath_registers.h
 660  */
 661
 662 /* RcvHdrFlags bits */
 663 #define INFINIPATH_RHF_LENGTH_MASK 0x7FF
 664 #define INFINIPATH_RHF_LENGTH_SHIFT 0
 665 #define INFINIPATH_RHF_RCVTYPE_MASK 0x7
 666 #define INFINIPATH_RHF_RCVTYPE_SHIFT 11
 667 #define INFINIPATH_RHF_EGRINDEX_MASK 0xFFF
 668 #define INFINIPATH_RHF_EGRINDEX_SHIFT 16
 669 #define INFINIPATH_RHF_SEQ_MASK 0xF
 670 #define INFINIPATH_RHF_SEQ_SHIFT 0
 671 #define INFINIPATH_RHF_HDRQ_OFFSET_MASK 0x7FF
 672 #define INFINIPATH_RHF_HDRQ_OFFSET_SHIFT 4
 673 #define INFINIPATH_RHF_H_ICRCERR   0x80000000
 674 #define INFINIPATH_RHF_H_VCRCERR   0x40000000
 675 #define INFINIPATH_RHF_H_PARITYERR 0x20000000
 676 #define INFINIPATH_RHF_H_LENERR    0x10000000
 677 #define INFINIPATH_RHF_H_MTUERR    0x08000000
 678 #define INFINIPATH_RHF_H_IHDRERR   0x04000000
 679 #define INFINIPATH_RHF_H_TIDERR    0x02000000
 680 #define INFINIPATH_RHF_H_MKERR     0x01000000
 681 #define INFINIPATH_RHF_H_IBERR     0x00800000
 682 #define INFINIPATH_RHF_H_ERR_MASK  0xFF800000
 683 #define INFINIPATH_RHF_L_USE_EGR   0x80000000
 684 #define INFINIPATH_RHF_L_SWA       0x00008000
 685 #define INFINIPATH_RHF_L_SWB       0x00004000
 686
 687 /* infinipath header fields */
 688 #define INFINIPATH_I_VERS_MASK 0xF
 689 #define INFINIPATH_I_VERS_SHIFT 28
 690 #define INFINIPATH_I_PORT_MASK 0xF
 691 #define INFINIPATH_I_PORT_SHIFT 24
 692 #define INFINIPATH_I_TID_MASK 0x7FF
 693 #define INFINIPATH_I_TID_SHIFT 13
 694 #define INFINIPATH_I_OFFSET_MASK 0x1FFF
 695 #define INFINIPATH_I_OFFSET_SHIFT 0
 696
 697 /* K_PktFlags bits */
 698 #define INFINIPATH_KPF_INTR 0x1
 699 #define INFINIPATH_KPF_SUBPORT_MASK 0x3
 700 #define INFINIPATH_KPF_SUBPORT_SHIFT 1
 701
 702 #define INFINIPATH_MAX_SUBPORT  4
 703
 704 /* SendPIO per-buffer control */
 705 #define INFINIPATH_SP_TEST    0x40
 706 #define INFINIPATH_SP_TESTEBP 0x20
 707 #define INFINIPATH_SP_TRIGGER_SHIFT  15
 708
 709 /* SendPIOAvail bits */
 710 #define INFINIPATH_SENDPIOAVAIL_BUSY_SHIFT 1
 711 #define INFINIPATH_SENDPIOAVAIL_CHECK_SHIFT 0
 712
 713 /* infinipath header format */
 714 struct ipath_header {
 715         /*
 716          * Version - 4 bits, Port - 4 bits, TID - 10 bits and Offset -
 717          * 14 bits before ECO change ~28 Dec 03.  After that, Vers 4,
 718          * Port 4, TID 11, offset 13.
 719          */
 720         __le32 ver_port_tid_offset;
 721         __le16 chksum;
 722         __le16 pkt_flags;
 723 };
 724
 725 /* infinipath user message header format.
 726  * This structure contains the first 4 fields common to all protocols
 727  * that employ infinipath.
 728  */
 729 struct ipath_message_header {
 730         __be16 lrh[4];
 731         __be32 bth[3];
 732         /* fields below this point are in host byte order */
 733         struct ipath_header iph;
 734         __u8 sub_opcode;
 735 };
 736
 737 /* infinipath ethernet header format */
 738 struct ether_header {
 739         __be16 lrh[4];
 740         __be32 bth[3];
 741         struct ipath_header iph;
 742         __u8 sub_opcode;
 743         __u8 cmd;
 744         __be16 lid;
 745         __u16 mac[3];
 746         __u8 frag_num;
 747         __u8 seq_num;
 748         __le32 len;
 749         /* MUST be of word size due to PIO write requirements */
 750         __le32 csum;
 751         __le16 csum_offset;
 752         __le16 flags;
 753         __u16 first_2_bytes;
 754         __u8 unused[2];         /* currently unused */
 755 };
 756
 757
 758 /* IB - LRH header consts */
 759 #define IPATH_LRH_GRH 0x0003    /* 1. word of IB LRH - next header: GRH */
 760 #define IPATH_LRH_BTH 0x0002    /* 1. word of IB LRH - next header: BTH */
 761
 762 /* misc. */
 763 #define SIZE_OF_CRC 1
 764
 765 #define IPATH_DEFAULT_P_KEY 0xFFFF
 766 #define IPATH_PERMISSIVE_LID 0xFFFF
 767 #define IPATH_AETH_CREDIT_SHIFT 24
 768 #define IPATH_AETH_CREDIT_MASK 0x1F
 769 #define IPATH_AETH_CREDIT_INVAL 0x1F
 770 #define IPATH_PSN_MASK 0xFFFFFF
 771 #define IPATH_MSN_MASK 0xFFFFFF
 772 #define IPATH_QPN_MASK 0xFFFFFF
 773 #define IPATH_MULTICAST_LID_BASE 0xC000
 774 #define IPATH_EAGER_TID_ID INFINIPATH_I_TID_MASK
 775 #define IPATH_MULTICAST_QPN 0xFFFFFF
 776
 777 /* Receive Header Queue: receive type (from infinipath) */
 778 #define RCVHQ_RCV_TYPE_EXPECTED  0
 779 #define RCVHQ_RCV_TYPE_EAGER     1
 780 #define RCVHQ_RCV_TYPE_NON_KD    2
 781 #define RCVHQ_RCV_TYPE_ERROR     3
 782
 783
 784 /* sub OpCodes - ith4x  */
 785 #define IPATH_ITH4X_OPCODE_ENCAP 0x81
 786 #define IPATH_ITH4X_OPCODE_LID_ARP 0x82
 787
 788 #define IPATH_HEADER_QUEUE_WORDS 9
 789
 790 /* functions for extracting fields from rcvhdrq entries for the driver.
 791  */
 792 static inline __u32 ipath_hdrget_err_flags(const __le32 * rbuf)
 793 {
 794         return __le32_to_cpu(rbuf[1]) & INFINIPATH_RHF_H_ERR_MASK;
 795 }
 796
 797 static inline __u32 ipath_hdrget_rcv_type(const __le32 * rbuf)
 798 {
 799         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_RCVTYPE_SHIFT)
 800             & INFINIPATH_RHF_RCVTYPE_MASK;
 801 }
 802
 803 static inline __u32 ipath_hdrget_length_in_bytes(const __le32 * rbuf)
 804 {
 805         return ((__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_LENGTH_SHIFT)
 806                 & INFINIPATH_RHF_LENGTH_MASK) << 2;
 807 }
 808
 809 static inline __u32 ipath_hdrget_index(const __le32 * rbuf)
 810 {
 811         return (__le32_to_cpu(rbuf[0]) >> INFINIPATH_RHF_EGRINDEX_SHIFT)
 812             & INFINIPATH_RHF_EGRINDEX_MASK;
 813 }
 814
 815 static inline __u32 ipath_hdrget_seq(const __le32 *rbuf)
 816 {
 817         return (__le32_to_cpu(rbuf[1]) >> INFINIPATH_RHF_SEQ_SHIFT)
 818                 & INFINIPATH_RHF_SEQ_MASK;
 819 }
 820
 821 static inline __u32 ipath_hdrget_offset(const __le32 *rbuf)
 822 {
 823         return (__le32_to_cpu(rbuf[1]) >> INFINIPATH_RHF_HDRQ_OFFSET_SHIFT)
 824                 & INFINIPATH_RHF_HDRQ_OFFSET_MASK;
 825 }
 826
 827 static inline __u32 ipath_hdrget_use_egr_buf(const __le32 *rbuf)
 828 {
 829         return __le32_to_cpu(rbuf[0]) & INFINIPATH_RHF_L_USE_EGR;
 830 }
 831
 832 static inline __u32 ipath_hdrget_ipath_ver(__le32 hdrword)
 833 {
 834         return (__le32_to_cpu(hdrword) >> INFINIPATH_I_VERS_SHIFT)
 835             & INFINIPATH_I_VERS_MASK;
 836 }
 837
 838 #endif                          /* _IPATH_COMMON_H */