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