drivers/infiniband/hw/qib/qib_qsfp.h

   1 /*
   2  * Copyright (c) 2006, 2007, 2008, 2009 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 /* QSFP support common definitions, for ib_qib driver */
  34
  35 #define QSFP_DEV 0xA0
  36 #define QSFP_PWR_LAG_MSEC 2000
  37 #define QSFP_MODPRS_LAG_MSEC 20
  38
  39 /*
  40  * Below are masks for various QSFP signals, for Port 1.
  41  * Port2 equivalents are shifted by QSFP_GPIO_PORT2_SHIFT.
  42  * _N means asserted low
  43  */
  44 #define QSFP_GPIO_MOD_SEL_N (4)
  45 #define QSFP_GPIO_MOD_PRS_N (8)
  46 #define QSFP_GPIO_INT_N (0x10)
  47 #define QSFP_GPIO_MOD_RST_N (0x20)
  48 #define QSFP_GPIO_LP_MODE (0x40)
  49 #define QSFP_GPIO_PORT2_SHIFT 5
  50
  51 #define QSFP_PAGESIZE 128
  52 /* Defined fields that QLogic requires of qualified cables */
  53 /* Byte 0 is Identifier, not checked */
  54 /* Byte 1 is reserved "status MSB" */
  55 /* Byte 2 is "status LSB" We only care that D2 "Flat Mem" is set. */
  56 /*
  57  * Rest of first 128 not used, although 127 is reserved for page select
  58  * if module is not "Flat memory".
  59  */
  60 /* Byte 128 is Identifier: must be 0x0c for QSFP, or 0x0d for QSFP+ */
  61 #define QSFP_MOD_ID_OFFS 128
  62 /*
  63  * Byte 129 is "Extended Identifier". We only care about D7,D6: Power class
  64  *  0:1.5W, 1:2.0W, 2:2.5W, 3:3.5W
  65  */
  66 #define QSFP_MOD_PWR_OFFS 129
  67 /* Byte 130 is Connector type. Not QLogic req'd */
  68 /* Bytes 131..138 are Transceiver types, bit maps for various tech, none IB */
  69 /* Byte 139 is encoding. code 0x01 is 8b10b. Not QLogic req'd */
  70 /* byte 140 is nominal bit-rate, in units of 100Mbits/sec Not QLogic req'd */
  71 /* Byte 141 is Extended Rate Select. Not QLogic req'd */
  72 /* Bytes 142..145 are lengths for various fiber types. Not QLogic req'd */
  73 /* Byte 146 is length for Copper. Units of 1 meter */
  74 #define QSFP_MOD_LEN_OFFS 146
  75 /*
  76  * Byte 147 is Device technology. D0..3 not Qlogc req'd
  77  * D4..7 select from 15 choices, translated by table:
  78  */
  79 #define QSFP_MOD_TECH_OFFS 147
  80 extern const char *const qib_qsfp_devtech[16];
  81 /* Active Equalization includes fiber, copper full EQ, and copper near Eq */
  82 #define QSFP_IS_ACTIVE(tech) ((0xA2FF >> ((tech) >> 4)) & 1)
  83 /* Active Equalization includes fiber, copper full EQ, and copper far Eq */
  84 #define QSFP_IS_ACTIVE_FAR(tech) ((0x32FF >> ((tech) >> 4)) & 1)
  85 /* Attenuation should be valid for copper other than full/near Eq */
  86 #define QSFP_HAS_ATTEN(tech) ((0x4D00 >> ((tech) >> 4)) & 1)
  87 /* Length is only valid if technology is "copper" */
  88 #define QSFP_IS_CU(tech) ((0xED00 >> ((tech) >> 4)) & 1)
  89 #define QSFP_TECH_1490 9
  90
  91 #define QSFP_OUI(oui) (((unsigned)oui[0] << 16) | ((unsigned)oui[1] << 8) | \
  92                         oui[2])
  93 #define QSFP_OUI_AMPHENOL 0x415048
  94 #define QSFP_OUI_FINISAR  0x009065
  95 #define QSFP_OUI_GORE     0x002177
  96
  97 /* Bytes 148..163 are Vendor Name, Left-justified Blank-filled */
  98 #define QSFP_VEND_OFFS 148
  99 #define QSFP_VEND_LEN 16
 100 /* Byte 164 is IB Extended tranceiver codes Bits D0..3 are SDR,DDR,QDR,EDR */
 101 #define QSFP_IBXCV_OFFS 164
 102 /* Bytes 165..167 are Vendor OUI number */
 103 #define QSFP_VOUI_OFFS 165
 104 #define QSFP_VOUI_LEN 3
 105 /* Bytes 168..183 are Vendor Part Number, string */
 106 #define QSFP_PN_OFFS 168
 107 #define QSFP_PN_LEN 16
 108 /* Bytes 184,185 are Vendor Rev. Left Justified, Blank-filled */
 109 #define QSFP_REV_OFFS 184
 110 #define QSFP_REV_LEN 2
 111 /*
 112  * Bytes 186,187 are Wavelength, if Optical. Not Qlogic req'd
 113  *  If copper, they are attenuation in dB:
 114  * Byte 186 is at 2.5Gb/sec (SDR), Byte 187 at 5.0Gb/sec (DDR)
 115  */
 116 #define QSFP_ATTEN_OFFS 186
 117 #define QSFP_ATTEN_LEN 2
 118 /* Bytes 188,189 are Wavelength tolerance, not QLogic req'd */
 119 /* Byte 190 is Max Case Temp. Not QLogic req'd */
 120 /* Byte 191 is LSB of sum of bytes 128..190. Not QLogic req'd */
 121 #define QSFP_CC_OFFS 191
 122 /* Bytes 192..195 are Options implemented in qsfp. Not Qlogic req'd */
 123 /* Bytes 196..211 are Serial Number, String */
 124 #define QSFP_SN_OFFS 196
 125 #define QSFP_SN_LEN 16
 126 /* Bytes 212..219 are date-code YYMMDD (MM==1 for Jan) */
 127 #define QSFP_DATE_OFFS 212
 128 #define QSFP_DATE_LEN 6
 129 /* Bytes 218,219 are optional lot-code, string */
 130 #define QSFP_LOT_OFFS 218
 131 #define QSFP_LOT_LEN 2
 132 /* Bytes 220, 221 indicate monitoring options, Not QLogic req'd */
 133 /* Byte 223 is LSB of sum of bytes 192..222 */
 134 #define QSFP_CC_EXT_OFFS 223
 135
 136 /*
 137  * struct qib_qsfp_data encapsulates state of QSFP device for one port.
 138  * it will be part of port-chip-specific data if a board supports QSFP.
 139  *
 140  * Since multiple board-types use QSFP, and their pport_data structs
 141  * differ (in the chip-specific section), we need a pointer to its head.
 142  *
 143  * Avoiding premature optimization, we will have one work_struct per port,
 144  * and let the (increasingly inaccurately named) eep_lock arbitrate
 145  * access to common resources.
 146  *
 147  */
 148
 149 /*
 150  * Hold the parts of the onboard EEPROM that we care about, so we aren't
 151  * coonstantly bit-boffing
 152  */
 153 struct qib_qsfp_cache {
 154         u8 id;  /* must be 0x0C or 0x0D; 0 indicates invalid EEPROM read */
 155         u8 pwr; /* in D6,7 */
 156         u8 len; /* in meters, Cu only */
 157         u8 tech;
 158         char vendor[QSFP_VEND_LEN];
 159         u8 xt_xcv; /* Ext. tranceiver codes, 4 lsbs are IB speed supported */
 160         u8 oui[QSFP_VOUI_LEN];
 161         u8 partnum[QSFP_PN_LEN];
 162         u8 rev[QSFP_REV_LEN];
 163         u8 atten[QSFP_ATTEN_LEN];
 164         u8 cks1;        /* Checksum of bytes 128..190 */
 165         u8 serial[QSFP_SN_LEN];
 166         u8 date[QSFP_DATE_LEN];
 167         u8 lot[QSFP_LOT_LEN];
 168         u8 cks2;        /* Checsum of bytes 192..222 */
 169 };
 170
 171 #define QSFP_PWR(pbyte) (((pbyte) >> 6) & 3)
 172 #define QSFP_ATTEN_SDR(attenarray) (attenarray[0])
 173 #define QSFP_ATTEN_DDR(attenarray) (attenarray[1])
 174
 175 struct qib_qsfp_data {
 176         /* Helps to find our way */
 177         struct qib_pportdata *ppd;
 178         struct work_struct work;
 179         struct qib_qsfp_cache cache;
 180         unsigned long t_insert;
 181         u8 modpresent;
 182 };
 183
 184 extern int qib_refresh_qsfp_cache(struct qib_pportdata *ppd,
 185                                   struct qib_qsfp_cache *cp);
 186 extern int qib_qsfp_mod_present(struct qib_pportdata *ppd);
 187 extern void qib_qsfp_init(struct qib_qsfp_data *qd,
 188                           void (*fevent)(struct work_struct *));
 189 extern void qib_qsfp_deinit(struct qib_qsfp_data *qd);