1#ifndef LINUX_SFP_H
2#define LINUX_SFP_H
3
4#include <linux/phy.h>
5
6struct 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
208struct 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
222
223
224
225
226
227
228
229struct sfp_eeprom_id {
230 struct sfp_eeprom_base base;
231 struct sfp_eeprom_ext ext;
232} __packed;
233
234struct sfp_diag {
235 __be16 temp_high_alarm;
236 __be16 temp_low_alarm;
237 __be16 temp_high_warn;
238 __be16 temp_low_warn;
239 __be16 volt_high_alarm;
240 __be16 volt_low_alarm;
241 __be16 volt_high_warn;
242 __be16 volt_low_warn;
243 __be16 bias_high_alarm;
244 __be16 bias_low_alarm;
245 __be16 bias_high_warn;
246 __be16 bias_low_warn;
247 __be16 txpwr_high_alarm;
248 __be16 txpwr_low_alarm;
249 __be16 txpwr_high_warn;
250 __be16 txpwr_low_warn;
251 __be16 rxpwr_high_alarm;
252 __be16 rxpwr_low_alarm;
253 __be16 rxpwr_high_warn;
254 __be16 rxpwr_low_warn;
255 __be16 laser_temp_high_alarm;
256 __be16 laser_temp_low_alarm;
257 __be16 laser_temp_high_warn;
258 __be16 laser_temp_low_warn;
259 __be16 tec_cur_high_alarm;
260 __be16 tec_cur_low_alarm;
261 __be16 tec_cur_high_warn;
262 __be16 tec_cur_low_warn;
263 __be32 cal_rxpwr4;
264 __be32 cal_rxpwr3;
265 __be32 cal_rxpwr2;
266 __be32 cal_rxpwr1;
267 __be32 cal_rxpwr0;
268 __be16 cal_txi_slope;
269 __be16 cal_txi_offset;
270 __be16 cal_txpwr_slope;
271 __be16 cal_txpwr_offset;
272 __be16 cal_t_slope;
273 __be16 cal_t_offset;
274 __be16 cal_v_slope;
275 __be16 cal_v_offset;
276} __packed;
277
278
279enum {
280 SFP_PHYS_ID = 0x00,
281 SFP_PHYS_EXT_ID = 0x01,
282 SFP_CONNECTOR = 0x02,
283 SFP_COMPLIANCE = 0x03,
284 SFP_ENCODING = 0x0b,
285 SFP_BR_NOMINAL = 0x0c,
286 SFP_RATE_ID = 0x0d,
287 SFP_LINK_LEN_SM_KM = 0x0e,
288 SFP_LINK_LEN_SM_100M = 0x0f,
289 SFP_LINK_LEN_50UM_OM2_10M = 0x10,
290 SFP_LINK_LEN_62_5UM_OM1_10M = 0x11,
291 SFP_LINK_LEN_COPPER_1M = 0x12,
292 SFP_LINK_LEN_50UM_OM4_10M = 0x12,
293 SFP_LINK_LEN_50UM_OM3_10M = 0x13,
294 SFP_VENDOR_NAME = 0x14,
295 SFP_VENDOR_OUI = 0x25,
296 SFP_VENDOR_PN = 0x28,
297 SFP_VENDOR_REV = 0x38,
298 SFP_OPTICAL_WAVELENGTH_MSB = 0x3c,
299 SFP_OPTICAL_WAVELENGTH_LSB = 0x3d,
300 SFP_CABLE_SPEC = 0x3c,
301 SFP_CC_BASE = 0x3f,
302 SFP_OPTIONS = 0x40,
303 SFP_BR_MAX = 0x42,
304 SFP_BR_MIN = 0x43,
305 SFP_VENDOR_SN = 0x44,
306 SFP_DATECODE = 0x54,
307 SFP_DIAGMON = 0x5c,
308 SFP_ENHOPTS = 0x5d,
309 SFP_SFF8472_COMPLIANCE = 0x5e,
310 SFP_CC_EXT = 0x5f,
311
312 SFP_PHYS_ID_SFF = 0x02,
313 SFP_PHYS_ID_SFP = 0x03,
314 SFP_PHYS_EXT_ID_SFP = 0x04,
315 SFP_CONNECTOR_UNSPEC = 0x00,
316
317 SFP_CONNECTOR_SC = 0x01,
318 SFP_CONNECTOR_FIBERJACK = 0x06,
319 SFP_CONNECTOR_LC = 0x07,
320 SFP_CONNECTOR_MT_RJ = 0x08,
321 SFP_CONNECTOR_MU = 0x09,
322 SFP_CONNECTOR_SG = 0x0a,
323 SFP_CONNECTOR_OPTICAL_PIGTAIL = 0x0b,
324 SFP_CONNECTOR_MPO_1X12 = 0x0c,
325 SFP_CONNECTOR_MPO_2X16 = 0x0d,
326 SFP_CONNECTOR_HSSDC_II = 0x20,
327 SFP_CONNECTOR_COPPER_PIGTAIL = 0x21,
328 SFP_CONNECTOR_RJ45 = 0x22,
329 SFP_CONNECTOR_NOSEPARATE = 0x23,
330 SFP_CONNECTOR_MXC_2X16 = 0x24,
331 SFP_ENCODING_UNSPEC = 0x00,
332 SFP_ENCODING_8B10B = 0x01,
333 SFP_ENCODING_4B5B = 0x02,
334 SFP_ENCODING_NRZ = 0x03,
335 SFP_ENCODING_8472_MANCHESTER = 0x04,
336 SFP_ENCODING_8472_SONET = 0x05,
337 SFP_ENCODING_8472_64B66B = 0x06,
338 SFP_ENCODING_256B257B = 0x07,
339 SFP_ENCODING_PAM4 = 0x08,
340 SFP_OPTIONS_HIGH_POWER_LEVEL = BIT(13),
341 SFP_OPTIONS_PAGING_A2 = BIT(12),
342 SFP_OPTIONS_RETIMER = BIT(11),
343 SFP_OPTIONS_COOLED_XCVR = BIT(10),
344 SFP_OPTIONS_POWER_DECL = BIT(9),
345 SFP_OPTIONS_RX_LINEAR_OUT = BIT(8),
346 SFP_OPTIONS_RX_DECISION_THRESH = BIT(7),
347 SFP_OPTIONS_TUNABLE_TX = BIT(6),
348 SFP_OPTIONS_RATE_SELECT = BIT(5),
349 SFP_OPTIONS_TX_DISABLE = BIT(4),
350 SFP_OPTIONS_TX_FAULT = BIT(3),
351 SFP_OPTIONS_LOS_INVERTED = BIT(2),
352 SFP_OPTIONS_LOS_NORMAL = BIT(1),
353 SFP_DIAGMON_DDM = BIT(6),
354 SFP_DIAGMON_INT_CAL = BIT(5),
355 SFP_DIAGMON_EXT_CAL = BIT(4),
356 SFP_DIAGMON_RXPWR_AVG = BIT(3),
357 SFP_DIAGMON_ADDRMODE = BIT(2),
358 SFP_ENHOPTS_ALARMWARN = BIT(7),
359 SFP_ENHOPTS_SOFT_TX_DISABLE = BIT(6),
360 SFP_ENHOPTS_SOFT_TX_FAULT = BIT(5),
361 SFP_ENHOPTS_SOFT_RX_LOS = BIT(4),
362 SFP_ENHOPTS_SOFT_RATE_SELECT = BIT(3),
363 SFP_ENHOPTS_APP_SELECT_SFF8079 = BIT(2),
364 SFP_ENHOPTS_SOFT_RATE_SFF8431 = BIT(1),
365 SFP_SFF8472_COMPLIANCE_NONE = 0x00,
366 SFP_SFF8472_COMPLIANCE_REV9_3 = 0x01,
367 SFP_SFF8472_COMPLIANCE_REV9_5 = 0x02,
368 SFP_SFF8472_COMPLIANCE_REV10_2 = 0x03,
369 SFP_SFF8472_COMPLIANCE_REV10_4 = 0x04,
370 SFP_SFF8472_COMPLIANCE_REV11_0 = 0x05,
371 SFP_SFF8472_COMPLIANCE_REV11_3 = 0x06,
372 SFP_SFF8472_COMPLIANCE_REV11_4 = 0x07,
373 SFP_SFF8472_COMPLIANCE_REV12_0 = 0x08,
374};
375
376
377enum {
378
379 SFP_TEMP_HIGH_ALARM = 0x00,
380 SFP_TEMP_LOW_ALARM = 0x02,
381 SFP_TEMP_HIGH_WARN = 0x04,
382 SFP_TEMP_LOW_WARN = 0x06,
383 SFP_VOLT_HIGH_ALARM = 0x08,
384 SFP_VOLT_LOW_ALARM = 0x0a,
385 SFP_VOLT_HIGH_WARN = 0x0c,
386 SFP_VOLT_LOW_WARN = 0x0e,
387 SFP_BIAS_HIGH_ALARM = 0x10,
388 SFP_BIAS_LOW_ALARM = 0x12,
389 SFP_BIAS_HIGH_WARN = 0x14,
390 SFP_BIAS_LOW_WARN = 0x16,
391 SFP_TXPWR_HIGH_ALARM = 0x18,
392 SFP_TXPWR_LOW_ALARM = 0x1a,
393 SFP_TXPWR_HIGH_WARN = 0x1c,
394 SFP_TXPWR_LOW_WARN = 0x1e,
395 SFP_RXPWR_HIGH_ALARM = 0x20,
396 SFP_RXPWR_LOW_ALARM = 0x22,
397 SFP_RXPWR_HIGH_WARN = 0x24,
398 SFP_RXPWR_LOW_WARN = 0x26,
399 SFP_LASER_TEMP_HIGH_ALARM = 0x28,
400 SFP_LASER_TEMP_LOW_ALARM = 0x2a,
401 SFP_LASER_TEMP_HIGH_WARN = 0x2c,
402 SFP_LASER_TEMP_LOW_WARN = 0x2e,
403 SFP_TEC_CUR_HIGH_ALARM = 0x30,
404 SFP_TEC_CUR_LOW_ALARM = 0x32,
405 SFP_TEC_CUR_HIGH_WARN = 0x34,
406 SFP_TEC_CUR_LOW_WARN = 0x36,
407 SFP_CAL_RXPWR4 = 0x38,
408 SFP_CAL_RXPWR3 = 0x3c,
409 SFP_CAL_RXPWR2 = 0x40,
410 SFP_CAL_RXPWR1 = 0x44,
411 SFP_CAL_RXPWR0 = 0x48,
412 SFP_CAL_TXI_SLOPE = 0x4c,
413 SFP_CAL_TXI_OFFSET = 0x4e,
414 SFP_CAL_TXPWR_SLOPE = 0x50,
415 SFP_CAL_TXPWR_OFFSET = 0x52,
416 SFP_CAL_T_SLOPE = 0x54,
417 SFP_CAL_T_OFFSET = 0x56,
418 SFP_CAL_V_SLOPE = 0x58,
419 SFP_CAL_V_OFFSET = 0x5a,
420 SFP_CHKSUM = 0x5f,
421
422 SFP_TEMP = 0x60,
423 SFP_VCC = 0x62,
424 SFP_TX_BIAS = 0x64,
425 SFP_TX_POWER = 0x66,
426 SFP_RX_POWER = 0x68,
427 SFP_LASER_TEMP = 0x6a,
428 SFP_TEC_CUR = 0x6c,
429
430 SFP_STATUS = 0x6e,
431 SFP_ALARM0 = 0x70,
432 SFP_ALARM0_TEMP_HIGH = BIT(7),
433 SFP_ALARM0_TEMP_LOW = BIT(6),
434 SFP_ALARM0_VCC_HIGH = BIT(5),
435 SFP_ALARM0_VCC_LOW = BIT(4),
436 SFP_ALARM0_TX_BIAS_HIGH = BIT(3),
437 SFP_ALARM0_TX_BIAS_LOW = BIT(2),
438 SFP_ALARM0_TXPWR_HIGH = BIT(1),
439 SFP_ALARM0_TXPWR_LOW = BIT(0),
440
441 SFP_ALARM1 = 0x71,
442 SFP_ALARM1_RXPWR_HIGH = BIT(7),
443 SFP_ALARM1_RXPWR_LOW = BIT(6),
444
445 SFP_WARN0 = 0x74,
446 SFP_WARN0_TEMP_HIGH = BIT(7),
447 SFP_WARN0_TEMP_LOW = BIT(6),
448 SFP_WARN0_VCC_HIGH = BIT(5),
449 SFP_WARN0_VCC_LOW = BIT(4),
450 SFP_WARN0_TX_BIAS_HIGH = BIT(3),
451 SFP_WARN0_TX_BIAS_LOW = BIT(2),
452 SFP_WARN0_TXPWR_HIGH = BIT(1),
453 SFP_WARN0_TXPWR_LOW = BIT(0),
454
455 SFP_WARN1 = 0x75,
456 SFP_WARN1_RXPWR_HIGH = BIT(7),
457 SFP_WARN1_RXPWR_LOW = BIT(6),
458
459 SFP_EXT_STATUS = 0x76,
460 SFP_VSL = 0x78,
461 SFP_PAGE = 0x7f,
462};
463
464struct fwnode_handle;
465struct ethtool_eeprom;
466struct ethtool_modinfo;
467struct net_device;
468struct sfp_bus;
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483struct sfp_upstream_ops {
484 int (*module_insert)(void *priv, const struct sfp_eeprom_id *id);
485 void (*module_remove)(void *priv);
486 void (*link_down)(void *priv);
487 void (*link_up)(void *priv);
488 int (*connect_phy)(void *priv, struct phy_device *);
489 void (*disconnect_phy)(void *priv);
490};
491
492#if IS_ENABLED(CONFIG_SFP)
493int sfp_parse_port(struct sfp_bus *bus, const struct sfp_eeprom_id *id,
494 unsigned long *support);
495void sfp_parse_support(struct sfp_bus *bus, const struct sfp_eeprom_id *id,
496 unsigned long *support);
497phy_interface_t sfp_select_interface(struct sfp_bus *bus,
498 const struct sfp_eeprom_id *id,
499 unsigned long *link_modes);
500
501int sfp_get_module_info(struct sfp_bus *bus, struct ethtool_modinfo *modinfo);
502int sfp_get_module_eeprom(struct sfp_bus *bus, struct ethtool_eeprom *ee,
503 u8 *data);
504void sfp_upstream_start(struct sfp_bus *bus);
505void sfp_upstream_stop(struct sfp_bus *bus);
506struct sfp_bus *sfp_register_upstream(struct fwnode_handle *fwnode,
507 struct net_device *ndev, void *upstream,
508 const struct sfp_upstream_ops *ops);
509void sfp_unregister_upstream(struct sfp_bus *bus);
510#else
511static inline int sfp_parse_port(struct sfp_bus *bus,
512 const struct sfp_eeprom_id *id,
513 unsigned long *support)
514{
515 return PORT_OTHER;
516}
517
518static inline void sfp_parse_support(struct sfp_bus *bus,
519 const struct sfp_eeprom_id *id,
520 unsigned long *support)
521{
522}
523
524static inline phy_interface_t sfp_select_interface(struct sfp_bus *bus,
525 const struct sfp_eeprom_id *id,
526 unsigned long *link_modes)
527{
528 return PHY_INTERFACE_MODE_NA;
529}
530
531static inline int sfp_get_module_info(struct sfp_bus *bus,
532 struct ethtool_modinfo *modinfo)
533{
534 return -EOPNOTSUPP;
535}
536
537static inline int sfp_get_module_eeprom(struct sfp_bus *bus,
538 struct ethtool_eeprom *ee, u8 *data)
539{
540 return -EOPNOTSUPP;
541}
542
543static inline void sfp_upstream_start(struct sfp_bus *bus)
544{
545}
546
547static inline void sfp_upstream_stop(struct sfp_bus *bus)
548{
549}
550
551static inline struct sfp_bus *sfp_register_upstream(
552 struct fwnode_handle *fwnode,
553 struct net_device *ndev, void *upstream,
554 const struct sfp_upstream_ops *ops)
555{
556 return (struct sfp_bus *)-1;
557}
558
559static inline void sfp_unregister_upstream(struct sfp_bus *bus)
560{
561}
562#endif
563
564#endif
565
