1 #ifndef LINUX_SFP_H 2 #define LINUX_SFP_H 3 4 #include <linux/phy.h> 5 6 struct sfp_eeprom_base { 7 u8 phys_id; 8 u8 phys_ext_id; 9 u8 connector; 10 #if defined __BIG_ENDIAN_BITFIELD 11 u8 e10g_base_er:1; 12 u8 e10g_base_lrm:1; 13 u8 e10g_base_lr:1; 14 u8 e10g_base_sr:1; 15 u8 if_1x_sx:1; 16 u8 if_1x_lx:1; 17 u8 if_1x_copper_active:1; 18 u8 if_1x_copper_passive:1; 19 20 u8 escon_mmf_1310_led:1; 21 u8 escon_smf_1310_laser:1; 22 u8 sonet_oc192_short_reach:1; 23 u8 sonet_reach_bit1:1; 24 u8 sonet_reach_bit2:1; 25 u8 sonet_oc48_long_reach:1; 26 u8 sonet_oc48_intermediate_reach:1; 27 u8 sonet_oc48_short_reach:1; 28 29 u8 unallocated_5_7:1; 30 u8 sonet_oc12_smf_long_reach:1; 31 u8 sonet_oc12_smf_intermediate_reach:1; 32 u8 sonet_oc12_short_reach:1; 33 u8 unallocated_5_3:1; 34 u8 sonet_oc3_smf_long_reach:1; 35 u8 sonet_oc3_smf_intermediate_reach:1; 36 u8 sonet_oc3_short_reach:1; 37 38 u8 e_base_px:1; 39 u8 e_base_bx10:1; 40 u8 e100_base_fx:1; 41 u8 e100_base_lx:1; 42 u8 e1000_base_t:1; 43 u8 e1000_base_cx:1; 44 u8 e1000_base_lx:1; 45 u8 e1000_base_sx:1; 46 47 u8 fc_ll_v:1; 48 u8 fc_ll_s:1; 49 u8 fc_ll_i:1; 50 u8 fc_ll_l:1; 51 u8 fc_ll_m:1; 52 u8 fc_tech_sa:1; 53 u8 fc_tech_lc:1; 54 u8 fc_tech_electrical_inter_enclosure:1; 55 56 u8 fc_tech_electrical_intra_enclosure:1; 57 u8 fc_tech_sn:1; 58 u8 fc_tech_sl:1; 59 u8 fc_tech_ll:1; 60 u8 sfp_ct_active:1; 61 u8 sfp_ct_passive:1; 62 u8 unallocated_8_1:1; 63 u8 unallocated_8_0:1; 64 65 u8 fc_media_tw:1; 66 u8 fc_media_tp:1; 67 u8 fc_media_mi:1; 68 u8 fc_media_tv:1; 69 u8 fc_media_m6:1; 70 u8 fc_media_m5:1; 71 u8 unallocated_9_1:1; 72 u8 fc_media_sm:1; 73 74 u8 fc_speed_1200:1; 75 u8 fc_speed_800:1; 76 u8 fc_speed_1600:1; 77 u8 fc_speed_400:1; 78 u8 fc_speed_3200:1; 79 u8 fc_speed_200:1; 80 u8 unallocated_10_1:1; 81 u8 fc_speed_100:1; 82 #elif defined __LITTLE_ENDIAN_BITFIELD 83 u8 if_1x_copper_passive:1; 84 u8 if_1x_copper_active:1; 85 u8 if_1x_lx:1; 86 u8 if_1x_sx:1; 87 u8 e10g_base_sr:1; 88 u8 e10g_base_lr:1; 89 u8 e10g_base_lrm:1; 90 u8 e10g_base_er:1; 91 92 u8 sonet_oc3_short_reach:1; 93 u8 sonet_oc3_smf_intermediate_reach:1; 94 u8 sonet_oc3_smf_long_reach:1; 95 u8 unallocated_5_3:1; 96 u8 sonet_oc12_short_reach:1; 97 u8 sonet_oc12_smf_intermediate_reach:1; 98 u8 sonet_oc12_smf_long_reach:1; 99 u8 unallocated_5_7:1; 100 101 u8 sonet_oc48_short_reach:1; 102 u8 sonet_oc48_intermediate_reach:1; 103 u8 sonet_oc48_long_reach:1; 104 u8 sonet_reach_bit2:1; 105 u8 sonet_reach_bit1:1; 106 u8 sonet_oc192_short_reach:1; 107 u8 escon_smf_1310_laser:1; 108 u8 escon_mmf_1310_led:1; 109 110 u8 e1000_base_sx:1; 111 u8 e1000_base_lx:1; 112 u8 e1000_base_cx:1; 113 u8 e1000_base_t:1; 114 u8 e100_base_lx:1; 115 u8 e100_base_fx:1; 116 u8 e_base_bx10:1; 117 u8 e_base_px:1; 118 119 u8 fc_tech_electrical_inter_enclosure:1; 120 u8 fc_tech_lc:1; 121 u8 fc_tech_sa:1; 122 u8 fc_ll_m:1; 123 u8 fc_ll_l:1; 124 u8 fc_ll_i:1; 125 u8 fc_ll_s:1; 126 u8 fc_ll_v:1; 127 128 u8 unallocated_8_0:1; 129 u8 unallocated_8_1:1; 130 u8 sfp_ct_passive:1; 131 u8 sfp_ct_active:1; 132 u8 fc_tech_ll:1; 133 u8 fc_tech_sl:1; 134 u8 fc_tech_sn:1; 135 u8 fc_tech_electrical_intra_enclosure:1; 136 137 u8 fc_media_sm:1; 138 u8 unallocated_9_1:1; 139 u8 fc_media_m5:1; 140 u8 fc_media_m6:1; 141 u8 fc_media_tv:1; 142 u8 fc_media_mi:1; 143 u8 fc_media_tp:1; 144 u8 fc_media_tw:1; 145 146 u8 fc_speed_100:1; 147 u8 unallocated_10_1:1; 148 u8 fc_speed_200:1; 149 u8 fc_speed_3200:1; 150 u8 fc_speed_400:1; 151 u8 fc_speed_1600:1; 152 u8 fc_speed_800:1; 153 u8 fc_speed_1200:1; 154 #else 155 #error Unknown Endian 156 #endif 157 u8 encoding; 158 u8 br_nominal; 159 u8 rate_id; 160 u8 link_len[6]; 161 char vendor_name[16]; 162 u8 extended_cc; 163 char vendor_oui[3]; 164 char vendor_pn[16]; 165 char vendor_rev[4]; 166 union { 167 __be16 optical_wavelength; 168 __be16 cable_compliance; 169 struct { 170 #if defined __BIG_ENDIAN_BITFIELD 171 u8 reserved60_2:6; 172 u8 fc_pi_4_app_h:1; 173 u8 sff8431_app_e:1; 174 u8 reserved61:8; 175 #elif defined __LITTLE_ENDIAN_BITFIELD 176 u8 sff8431_app_e:1; 177 u8 fc_pi_4_app_h:1; 178 u8 reserved60_2:6; 179 u8 reserved61:8; 180 #else 181 #error Unknown Endian 182 #endif 183 } __packed passive; 184 struct { 185 #if defined __BIG_ENDIAN_BITFIELD 186 u8 reserved60_4:4; 187 u8 fc_pi_4_lim:1; 188 u8 sff8431_lim:1; 189 u8 fc_pi_4_app_h:1; 190 u8 sff8431_app_e:1; 191 u8 reserved61:8; 192 #elif defined __LITTLE_ENDIAN_BITFIELD 193 u8 sff8431_app_e:1; 194 u8 fc_pi_4_app_h:1; 195 u8 sff8431_lim:1; 196 u8 fc_pi_4_lim:1; 197 u8 reserved60_4:4; 198 u8 reserved61:8; 199 #else 200 #error Unknown Endian 201 #endif 202 } __packed active; 203 } __packed; 204 u8 reserved62; 205 u8 cc_base; 206 } __packed; 207 208 struct sfp_eeprom_ext { 209 __be16 options; 210 u8 br_max; 211 u8 br_min; 212 char vendor_sn[16]; 213 char datecode[8]; 214 u8 diagmon; 215 u8 enhopts; 216 u8 sff8472_compliance; 217 u8 cc_ext; 218 } __packed; 219 220 /** 221 * struct sfp_eeprom_id - raw SFP module identification information 222 * @base: base SFP module identification structure 223 * @ext: extended SFP module identification structure 224 * 225 * See the SFF-8472 specification and related documents for the definition 226 * of these structure members. This can be obtained from 227 * ftp://ftp.seagate.com/sff 228 */ 229 struct sfp_eeprom_id { 230 struct sfp_eeprom_base base; 231 struct sfp_eeprom_ext ext; 232 } __packed; 233 234 /* SFP EEPROM registers */ 235 enum { 236 SFP_PHYS_ID = 0x00, 237 SFP_PHYS_EXT_ID = 0x01, 238 SFP_CONNECTOR = 0x02, 239 SFP_COMPLIANCE = 0x03, 240 SFP_ENCODING = 0x0b, 241 SFP_BR_NOMINAL = 0x0c, 242 SFP_RATE_ID = 0x0d, 243 SFP_LINK_LEN_SM_KM = 0x0e, 244 SFP_LINK_LEN_SM_100M = 0x0f, 245 SFP_LINK_LEN_50UM_OM2_10M = 0x10, 246 SFP_LINK_LEN_62_5UM_OM1_10M = 0x11, 247 SFP_LINK_LEN_COPPER_1M = 0x12, 248 SFP_LINK_LEN_50UM_OM4_10M = 0x12, 249 SFP_LINK_LEN_50UM_OM3_10M = 0x13, 250 SFP_VENDOR_NAME = 0x14, 251 SFP_VENDOR_OUI = 0x25, 252 SFP_VENDOR_PN = 0x28, 253 SFP_VENDOR_REV = 0x38, 254 SFP_OPTICAL_WAVELENGTH_MSB = 0x3c, 255 SFP_OPTICAL_WAVELENGTH_LSB = 0x3d, 256 SFP_CABLE_SPEC = 0x3c, 257 SFP_CC_BASE = 0x3f, 258 SFP_OPTIONS = 0x40, /* 2 bytes, MSB, LSB */ 259 SFP_BR_MAX = 0x42, 260 SFP_BR_MIN = 0x43, 261 SFP_VENDOR_SN = 0x44, 262 SFP_DATECODE = 0x54, 263 SFP_DIAGMON = 0x5c, 264 SFP_ENHOPTS = 0x5d, 265 SFP_SFF8472_COMPLIANCE = 0x5e, 266 SFP_CC_EXT = 0x5f, 267 268 SFP_PHYS_ID_SFF = 0x02, 269 SFP_PHYS_ID_SFP = 0x03, 270 SFP_PHYS_EXT_ID_SFP = 0x04, 271 SFP_CONNECTOR_UNSPEC = 0x00, 272 /* codes 01-05 not supportable on SFP, but some modules have single SC */ 273 SFP_CONNECTOR_SC = 0x01, 274 SFP_CONNECTOR_FIBERJACK = 0x06, 275 SFP_CONNECTOR_LC = 0x07, 276 SFP_CONNECTOR_MT_RJ = 0x08, 277 SFP_CONNECTOR_MU = 0x09, 278 SFP_CONNECTOR_SG = 0x0a, 279 SFP_CONNECTOR_OPTICAL_PIGTAIL = 0x0b, 280 SFP_CONNECTOR_MPO_1X12 = 0x0c, 281 SFP_CONNECTOR_MPO_2X16 = 0x0d, 282 SFP_CONNECTOR_HSSDC_II = 0x20, 283 SFP_CONNECTOR_COPPER_PIGTAIL = 0x21, 284 SFP_CONNECTOR_RJ45 = 0x22, 285 SFP_CONNECTOR_NOSEPARATE = 0x23, 286 SFP_CONNECTOR_MXC_2X16 = 0x24, 287 SFP_ENCODING_UNSPEC = 0x00, 288 SFP_ENCODING_8B10B = 0x01, 289 SFP_ENCODING_4B5B = 0x02, 290 SFP_ENCODING_NRZ = 0x03, 291 SFP_ENCODING_8472_MANCHESTER = 0x04, 292 SFP_ENCODING_8472_SONET = 0x05, 293 SFP_ENCODING_8472_64B66B = 0x06, 294 SFP_ENCODING_256B257B = 0x07, 295 SFP_ENCODING_PAM4 = 0x08, 296 SFP_OPTIONS_HIGH_POWER_LEVEL = BIT(13), 297 SFP_OPTIONS_PAGING_A2 = BIT(12), 298 SFP_OPTIONS_RETIMER = BIT(11), 299 SFP_OPTIONS_COOLED_XCVR = BIT(10), 300 SFP_OPTIONS_POWER_DECL = BIT(9), 301 SFP_OPTIONS_RX_LINEAR_OUT = BIT(8), 302 SFP_OPTIONS_RX_DECISION_THRESH = BIT(7), 303 SFP_OPTIONS_TUNABLE_TX = BIT(6), 304 SFP_OPTIONS_RATE_SELECT = BIT(5), 305 SFP_OPTIONS_TX_DISABLE = BIT(4), 306 SFP_OPTIONS_TX_FAULT = BIT(3), 307 SFP_OPTIONS_LOS_INVERTED = BIT(2), 308 SFP_OPTIONS_LOS_NORMAL = BIT(1), 309 SFP_DIAGMON_DDM = BIT(6), 310 SFP_DIAGMON_INT_CAL = BIT(5), 311 SFP_DIAGMON_EXT_CAL = BIT(4), 312 SFP_DIAGMON_RXPWR_AVG = BIT(3), 313 SFP_DIAGMON_ADDRMODE = BIT(2), 314 SFP_ENHOPTS_ALARMWARN = BIT(7), 315 SFP_ENHOPTS_SOFT_TX_DISABLE = BIT(6), 316 SFP_ENHOPTS_SOFT_TX_FAULT = BIT(5), 317 SFP_ENHOPTS_SOFT_RX_LOS = BIT(4), 318 SFP_ENHOPTS_SOFT_RATE_SELECT = BIT(3), 319 SFP_ENHOPTS_APP_SELECT_SFF8079 = BIT(2), 320 SFP_ENHOPTS_SOFT_RATE_SFF8431 = BIT(1), 321 SFP_SFF8472_COMPLIANCE_NONE = 0x00, 322 SFP_SFF8472_COMPLIANCE_REV9_3 = 0x01, 323 SFP_SFF8472_COMPLIANCE_REV9_5 = 0x02, 324 SFP_SFF8472_COMPLIANCE_REV10_2 = 0x03, 325 SFP_SFF8472_COMPLIANCE_REV10_4 = 0x04, 326 SFP_SFF8472_COMPLIANCE_REV11_0 = 0x05, 327 SFP_SFF8472_COMPLIANCE_REV11_3 = 0x06, 328 SFP_SFF8472_COMPLIANCE_REV11_4 = 0x07, 329 SFP_SFF8472_COMPLIANCE_REV12_0 = 0x08, 330 }; 331 332 /* SFP Diagnostics */ 333 enum { 334 /* Alarm and warnings stored MSB at lower address then LSB */ 335 SFP_TEMP_HIGH_ALARM = 0x00, 336 SFP_TEMP_LOW_ALARM = 0x02, 337 SFP_TEMP_HIGH_WARN = 0x04, 338 SFP_TEMP_LOW_WARN = 0x06, 339 SFP_VOLT_HIGH_ALARM = 0x08, 340 SFP_VOLT_LOW_ALARM = 0x0a, 341 SFP_VOLT_HIGH_WARN = 0x0c, 342 SFP_VOLT_LOW_WARN = 0x0e, 343 SFP_BIAS_HIGH_ALARM = 0x10, 344 SFP_BIAS_LOW_ALARM = 0x12, 345 SFP_BIAS_HIGH_WARN = 0x14, 346 SFP_BIAS_LOW_WARN = 0x16, 347 SFP_TXPWR_HIGH_ALARM = 0x18, 348 SFP_TXPWR_LOW_ALARM = 0x1a, 349 SFP_TXPWR_HIGH_WARN = 0x1c, 350 SFP_TXPWR_LOW_WARN = 0x1e, 351 SFP_RXPWR_HIGH_ALARM = 0x20, 352 SFP_RXPWR_LOW_ALARM = 0x22, 353 SFP_RXPWR_HIGH_WARN = 0x24, 354 SFP_RXPWR_LOW_WARN = 0x26, 355 SFP_LASER_TEMP_HIGH_ALARM = 0x28, 356 SFP_LASER_TEMP_LOW_ALARM = 0x2a, 357 SFP_LASER_TEMP_HIGH_WARN = 0x2c, 358 SFP_LASER_TEMP_LOW_WARN = 0x2e, 359 SFP_TEC_CUR_HIGH_ALARM = 0x30, 360 SFP_TEC_CUR_LOW_ALARM = 0x32, 361 SFP_TEC_CUR_HIGH_WARN = 0x34, 362 SFP_TEC_CUR_LOW_WARN = 0x36, 363 SFP_CAL_RXPWR4 = 0x38, 364 SFP_CAL_RXPWR3 = 0x3c, 365 SFP_CAL_RXPWR2 = 0x40, 366 SFP_CAL_RXPWR1 = 0x44, 367 SFP_CAL_RXPWR0 = 0x48, 368 SFP_CAL_TXI_SLOPE = 0x4c, 369 SFP_CAL_TXI_OFFSET = 0x4e, 370 SFP_CAL_TXPWR_SLOPE = 0x50, 371 SFP_CAL_TXPWR_OFFSET = 0x52, 372 SFP_CAL_T_SLOPE = 0x54, 373 SFP_CAL_T_OFFSET = 0x56, 374 SFP_CAL_V_SLOPE = 0x58, 375 SFP_CAL_V_OFFSET = 0x5a, 376 SFP_CHKSUM = 0x5f, 377 378 SFP_TEMP = 0x60, 379 SFP_VCC = 0x62, 380 SFP_TX_BIAS = 0x64, 381 SFP_TX_POWER = 0x66, 382 SFP_RX_POWER = 0x68, 383 SFP_LASER_TEMP = 0x6a, 384 SFP_TEC_CUR = 0x6c, 385 386 SFP_STATUS = 0x6e, 387 SFP_ALARM = 0x70, 388 389 SFP_EXT_STATUS = 0x76, 390 SFP_VSL = 0x78, 391 SFP_PAGE = 0x7f, 392 }; 393 394 struct fwnode_handle; 395 struct ethtool_eeprom; 396 struct ethtool_modinfo; 397 struct net_device; 398 struct sfp_bus; 399 400 /** 401 * struct sfp_upstream_ops - upstream operations structure 402 * @module_insert: called after a module has been detected to determine 403 * whether the module is supported for the upstream device. 404 * @module_remove: called after the module has been removed. 405 * @link_down: called when the link is non-operational for whatever 406 * reason. 407 * @link_up: called when the link is operational. 408 * @connect_phy: called when an I2C accessible PHY has been detected 409 * on the module. 410 * @disconnect_phy: called when a module with an I2C accessible PHY has 411 * been removed. 412 */ 413 struct sfp_upstream_ops { 414 int (*module_insert)(void *priv, const struct sfp_eeprom_id *id); 415 void (*module_remove)(void *priv); 416 void (*link_down)(void *priv); 417 void (*link_up)(void *priv); 418 int (*connect_phy)(void *priv, struct phy_device *); 419 void (*disconnect_phy)(void *priv); 420 }; 421 422 #if IS_ENABLED(CONFIG_SFP) 423 int sfp_parse_port(struct sfp_bus *bus, const struct sfp_eeprom_id *id, 424 unsigned long *support); 425 void sfp_parse_support(struct sfp_bus *bus, const struct sfp_eeprom_id *id, 426 unsigned long *support); 427 phy_interface_t sfp_select_interface(struct sfp_bus *bus, 428 const struct sfp_eeprom_id *id, 429 unsigned long *link_modes); 430 431 int sfp_get_module_info(struct sfp_bus *bus, struct ethtool_modinfo *modinfo); 432 int sfp_get_module_eeprom(struct sfp_bus *bus, struct ethtool_eeprom *ee, 433 u8 *data); 434 void sfp_upstream_start(struct sfp_bus *bus); 435 void sfp_upstream_stop(struct sfp_bus *bus); 436 struct sfp_bus *sfp_register_upstream(struct fwnode_handle *fwnode, 437 struct net_device *ndev, void *upstream, 438 const struct sfp_upstream_ops *ops); 439 void sfp_unregister_upstream(struct sfp_bus *bus); 440 #else 441 static inline int sfp_parse_port(struct sfp_bus *bus, 442 const struct sfp_eeprom_id *id, 443 unsigned long *support) 444 { 445 return PORT_OTHER; 446 } 447 448 static inline void sfp_parse_support(struct sfp_bus *bus, 449 const struct sfp_eeprom_id *id, 450 unsigned long *support) 451 { 452 } 453 454 static inline phy_interface_t sfp_select_interface(struct sfp_bus *bus, 455 const struct sfp_eeprom_id *id, 456 unsigned long *link_modes) 457 { 458 return PHY_INTERFACE_MODE_NA; 459 } 460 461 static inline int sfp_get_module_info(struct sfp_bus *bus, 462 struct ethtool_modinfo *modinfo) 463 { 464 return -EOPNOTSUPP; 465 } 466 467 static inline int sfp_get_module_eeprom(struct sfp_bus *bus, 468 struct ethtool_eeprom *ee, u8 *data) 469 { 470 return -EOPNOTSUPP; 471 } 472 473 static inline void sfp_upstream_start(struct sfp_bus *bus) 474 { 475 } 476 477 static inline void sfp_upstream_stop(struct sfp_bus *bus) 478 { 479 } 480 481 static inline struct sfp_bus *sfp_register_upstream( 482 struct fwnode_handle *fwnode, 483 struct net_device *ndev, void *upstream, 484 const struct sfp_upstream_ops *ops) 485 { 486 return (struct sfp_bus *)-1; 487 } 488 489 static inline void sfp_unregister_upstream(struct sfp_bus *bus) 490 { 491 } 492 #endif 493 494 #endif 495