1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2022 Intel Corporation 3 * 4 * Implements SFF-8024 Rev 4.0 of pluggable I/O configuration and some 5 * common utilities for SFF-8436/8636 and SFF-8472/8079 6 */ 7 8 #ifndef _SFF_COMMON_H_ 9 #define _SFF_COMMON_H_ 10 11 #include <stdio.h> 12 13 #include "rte_ethdev.h" 14 #include "sff_telemetry.h" 15 16 #define SFF_8024_ID_OFFSET 0x00 17 #define SFF_8024_ID_UNKNOWN 0x00 18 #define SFF_8024_ID_GBIC 0x01 19 #define SFF_8024_ID_SOLDERED_MODULE 0x02 20 #define SFF_8024_ID_SFP 0x03 21 #define SFF_8024_ID_300_PIN_XBI 0x04 22 #define SFF_8024_ID_XENPAK 0x05 23 #define SFF_8024_ID_XFP 0x06 24 #define SFF_8024_ID_XFF 0x07 25 #define SFF_8024_ID_XFP_E 0x08 26 #define SFF_8024_ID_XPAK 0x09 27 #define SFF_8024_ID_X2 0x0A 28 #define SFF_8024_ID_DWDM_SFP 0x0B 29 #define SFF_8024_ID_QSFP 0x0C 30 #define SFF_8024_ID_QSFP_PLUS 0x0D 31 #define SFF_8024_ID_CXP 0x0E 32 #define SFF_8024_ID_HD4X 0x0F 33 #define SFF_8024_ID_HD8X 0x10 34 #define SFF_8024_ID_QSFP28 0x11 35 #define SFF_8024_ID_CXP2 0x12 36 #define SFF_8024_ID_CDFP 0x13 37 #define SFF_8024_ID_HD4X_FANOUT 0x14 38 #define SFF_8024_ID_HD8X_FANOUT 0x15 39 #define SFF_8024_ID_CDFP_S3 0x16 40 #define SFF_8024_ID_MICRO_QSFP 0x17 41 #define SFF_8024_ID_LAST SFF_8024_ID_MICRO_QSFP 42 #define SFF_8024_ID_UNALLOCATED_LAST 0x7F 43 #define SFF_8024_ID_VENDOR_START 0x80 44 #define SFF_8024_ID_VENDOR_LAST 0xFF 45 46 #define SFF_8024_CTOR_UNKNOWN 0x00 47 #define SFF_8024_CTOR_SC 0x01 48 #define SFF_8024_CTOR_FC_STYLE_1 0x02 49 #define SFF_8024_CTOR_FC_STYLE_2 0x03 50 #define SFF_8024_CTOR_BNC_TNC 0x04 51 #define SFF_8024_CTOR_FC_COAX 0x05 52 #define SFF_8024_CTOR_FIBER_JACK 0x06 53 #define SFF_8024_CTOR_LC 0x07 54 #define SFF_8024_CTOR_MT_RJ 0x08 55 #define SFF_8024_CTOR_MU 0x09 56 #define SFF_8024_CTOR_SG 0x0A 57 #define SFF_8024_CTOR_OPT_PT 0x0B 58 #define SFF_8024_CTOR_MPO 0x0C 59 #define SFF_8024_CTOR_MPO_2 0x0D 60 /* 0E-1Fh --- Reserved */ 61 #define SFF_8024_CTOR_HSDC_II 0x20 62 #define SFF_8024_CTOR_COPPER_PT 0x21 63 #define SFF_8024_CTOR_RJ45 0x22 64 #define SFF_8024_CTOR_NO_SEPARABLE 0x23 65 #define SFF_8024_CTOR_MXC_2x16 0x24 66 #define SFF_8024_CTOR_LAST SFF_8024_CTOR_MXC_2x16 67 #define SFF_8024_CTOR_UNALLOCATED_LAST 0x7F 68 #define SFF_8024_CTOR_VENDOR_START 0x80 69 #define SFF_8024_CTOR_VENDOR_LAST 0xFF 70 71 /* ENCODING Values */ 72 #define SFF_8024_ENCODING_UNSPEC 0x00 73 #define SFF_8024_ENCODING_8B10B 0x01 74 #define SFF_8024_ENCODING_4B5B 0x02 75 #define SFF_8024_ENCODING_NRZ 0x03 76 /* 77 * Value: 04h 78 * SFF-8472 - Manchester 79 * SFF-8436/8636 - SONET Scrambled 80 */ 81 #define SFF_8024_ENCODING_4h 0x04 82 /* 83 * Value: 05h 84 * SFF-8472 - SONET Scrambled 85 * SFF-8436/8636 - 64B/66B 86 */ 87 #define SFF_8024_ENCODING_5h 0x05 88 /* 89 * Value: 06h 90 * SFF-8472 - 64B/66B 91 * SFF-8436/8636 - Manchester 92 */ 93 #define SFF_8024_ENCODING_6h 0x06 94 #define SFF_8024_ENCODING_256B 0x07 95 #define SFF_8024_ENCODING_PAM4 0x08 96 97 /* Most common case: 16-bit unsigned integer in a certain unit */ 98 #define SFF_OFFSET_TO_U16(offset) \ 99 (data[offset] << 8 | data[(offset) + 1]) 100 101 #define SFF_SPRINT_xX_PWR(str, var) \ 102 snprintf(str, sizeof(str), "%.4f mW / %.2f dBm", \ 103 (double)((var) / 10000.), \ 104 sff_convert_mw_to_dbm((double)((var) / 10000.))) 105 106 #define SFF_SPRINT_BIAS(str, bias_cur) \ 107 snprintf(str, sizeof(str), "%.3f mA", (double)(bias_cur / 500.)) 108 109 #define SFF_SPRINT_TEMP(str, temp) \ 110 snprintf(str, sizeof(str), "%.2f degrees C / %.2f degrees F", \ 111 (double)(temp / 256.), \ 112 (double)(temp / 256. * 1.8 + 32.)) 113 114 #define SFF_SPRINT_VCC(str, sfp_voltage) \ 115 snprintf(str, sizeof(str), "%.4f V", (double)(sfp_voltage / 10000.)) 116 117 /* Channel Monitoring Fields */ 118 struct sff_channel_diags { 119 uint16_t bias_cur; /* Measured bias current in 2uA units */ 120 uint16_t rx_power; /* Measured RX Power */ 121 uint16_t tx_power; /* Measured TX Power */ 122 }; 123 124 /* Module Monitoring Fields */ 125 struct sff_diags { 126 127 #define SFF_MAX_CHANNEL_NUM 4 128 #define SFF_LWARN 0 129 #define SFF_HWARN 1 130 #define SFF_LALRM 2 131 #define SFF_HALRM 3 132 #define SFF_MCURR 4 133 134 /* Supports DOM */ 135 uint8_t supports_dom; 136 /* Supports alarm/warning thold */ 137 uint8_t supports_alarms; 138 /* RX Power: 0 = OMA, 1 = Average power */ 139 uint8_t rx_power_type; 140 /* TX Power: 0 = Not supported, 1 = Average power */ 141 uint8_t tx_power_type; 142 143 uint8_t calibrated_ext; /* Is externally calibrated */ 144 /* [5] tables are low/high warn, low/high alarm, current */ 145 /* SFP voltage in 0.1mV units */ 146 uint16_t sfp_voltage[5]; 147 /* SFP Temp in 16-bit signed 1/256 Celsius */ 148 int16_t sfp_temp[5]; 149 /* Measured bias current in 2uA units */ 150 uint16_t bias_cur[5]; 151 /* Measured TX Power */ 152 uint16_t tx_power[5]; 153 /* Measured RX Power */ 154 uint16_t rx_power[5]; 155 struct sff_channel_diags scd[SFF_MAX_CHANNEL_NUM]; 156 }; 157 158 double sff_convert_mw_to_dbm(double mw); 159 void sff_show_value_with_unit(const uint8_t *data, unsigned int reg, 160 const char *name, unsigned int mult, 161 const char *unit, struct rte_tel_data *d); 162 void sff_show_ascii(const uint8_t *data, unsigned int first_reg, 163 unsigned int last_reg, const char *name, struct rte_tel_data *d); 164 void sff_show_thresholds(struct sff_diags sd, struct rte_tel_data *d); 165 166 void sff_8024_show_oui(const uint8_t *data, int id_offset, struct rte_tel_data *d); 167 void sff_8024_show_identifier(const uint8_t *data, int id_offset, struct rte_tel_data *d); 168 void sff_8024_show_connector(const uint8_t *data, int ctor_offset, struct rte_tel_data *d); 169 void sff_8024_show_encoding(const uint8_t *data, int encoding_offset, 170 int sff_type, struct rte_tel_data *d); 171 172 #endif /* _SFF_COMMON_H_ */ 173