-
Notifications
You must be signed in to change notification settings - Fork 647
/
main.py
1507 lines (1254 loc) · 53.4 KB
/
main.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
#
# main.py
#
# Command-line utility for interacting with SFP transceivers within SONiC
#
import os
import sys
import natsort
import ast
import time
import datetime
import subprocess
import click
import sonic_platform
import sonic_platform_base.sonic_sfp.sfputilhelper
from sonic_platform_base.sfp_base import SfpBase
from swsscommon.swsscommon import SonicV2Connector
from natsort import natsorted
from sonic_py_common import device_info, logger, multi_asic
from tabulate import tabulate
VERSION = '3.0'
SYSLOG_IDENTIFIER = "sfputil"
PLATFORM_JSON = 'platform.json'
PORT_CONFIG_INI = 'port_config.ini'
EXIT_FAIL = -1
EXIT_SUCCESS = 0
ERROR_PERMISSIONS = 1
ERROR_CHASSIS_LOAD = 2
ERROR_SFPUTILHELPER_LOAD = 3
ERROR_PORT_CONFIG_LOAD = 4
ERROR_NOT_IMPLEMENTED = 5
ERROR_INVALID_PORT = 6
SMBUS_BLOCK_WRITE_SIZE = 32
# Default host password as per CMIS spec:
# http://www.qsfp-dd.com/wp-content/uploads/2021/05/CMIS5p0.pdf
CDB_DEFAULT_HOST_PASSWORD = 0x00001011
MAX_LPL_FIRMWARE_BLOCK_SIZE = 116 #Bytes
PAGE_SIZE = 128
PAGE_OFFSET = 128
SFF8472_A0_SIZE = 256
# TODO: We should share these maps and the formatting functions between sfputil and sfpshow
QSFP_DATA_MAP = {
'model': 'Vendor PN',
'vendor_oui': 'Vendor OUI',
'vendor_date': 'Vendor Date Code(YYYY-MM-DD Lot)',
'manufacturer': 'Vendor Name',
'vendor_rev': 'Vendor Rev',
'serial': 'Vendor SN',
'type': 'Identifier',
'ext_identifier': 'Extended Identifier',
'ext_rateselect_compliance': 'Extended RateSelect Compliance',
'cable_length': 'cable_length',
'cable_type': 'Length',
'nominal_bit_rate': 'Nominal Bit Rate(100Mbs)',
'specification_compliance': 'Specification compliance',
'encoding': 'Encoding',
'connector': 'Connector',
'application_advertisement': 'Application Advertisement'
}
QSFP_DD_DATA_MAP = {
'model': 'Vendor PN',
'vendor_oui': 'Vendor OUI',
'vendor_date': 'Vendor Date Code(YYYY-MM-DD Lot)',
'manufacturer': 'Vendor Name',
'vendor_rev': 'Vendor Rev',
'serial': 'Vendor SN',
'type': 'Identifier',
'ext_identifier': 'Extended Identifier',
'ext_rateselect_compliance': 'Extended RateSelect Compliance',
'cable_length': 'cable_length',
'cable_type': 'Length',
'nominal_bit_rate': 'Nominal Bit Rate(100Mbs)',
'specification_compliance': 'Specification compliance',
'encoding': 'Encoding',
'connector': 'Connector',
'application_advertisement': 'Application Advertisement',
'active_firmware': 'Active Firmware Version',
'inactive_firmware': 'Inactive Firmware Version',
'hardware_rev': 'Hardware Revision',
'media_interface_code': 'Media Interface Code',
'host_electrical_interface': 'Host Electrical Interface',
'host_lane_count': 'Host Lane Count',
'media_lane_count': 'Media Lane Count',
'host_lane_assignment_option': 'Host Lane Assignment Options',
'media_lane_assignment_option': 'Media Lane Assignment Options',
'active_apsel_hostlane1': 'Active App Selection Host Lane 1',
'active_apsel_hostlane2': 'Active App Selection Host Lane 2',
'active_apsel_hostlane3': 'Active App Selection Host Lane 3',
'active_apsel_hostlane4': 'Active App Selection Host Lane 4',
'active_apsel_hostlane5': 'Active App Selection Host Lane 5',
'active_apsel_hostlane6': 'Active App Selection Host Lane 6',
'active_apsel_hostlane7': 'Active App Selection Host Lane 7',
'active_apsel_hostlane8': 'Active App Selection Host Lane 8',
'media_interface_technology': 'Media Interface Technology',
'cmis_rev': 'CMIS Revision',
'supported_max_tx_power': 'Supported Max TX Power',
'supported_min_tx_power': 'Supported Min TX Power',
'supported_max_laser_freq': 'Supported Max Laser Frequency',
'supported_min_laser_freq': 'Supported Min Laser Frequency'
}
SFP_DOM_CHANNEL_MONITOR_MAP = {
'rx1power': 'RXPower',
'tx1bias': 'TXBias',
'tx1power': 'TXPower'
}
SFP_DOM_CHANNEL_THRESHOLD_MAP = {
'txpowerhighalarm': 'TxPowerHighAlarm',
'txpowerlowalarm': 'TxPowerLowAlarm',
'txpowerhighwarning': 'TxPowerHighWarning',
'txpowerlowwarning': 'TxPowerLowWarning',
'rxpowerhighalarm': 'RxPowerHighAlarm',
'rxpowerlowalarm': 'RxPowerLowAlarm',
'rxpowerhighwarning': 'RxPowerHighWarning',
'rxpowerlowwarning': 'RxPowerLowWarning',
'txbiashighalarm': 'TxBiasHighAlarm',
'txbiaslowalarm': 'TxBiasLowAlarm',
'txbiashighwarning': 'TxBiasHighWarning',
'txbiaslowwarning': 'TxBiasLowWarning'
}
QSFP_DOM_CHANNEL_THRESHOLD_MAP = {
'rxpowerhighalarm': 'RxPowerHighAlarm',
'rxpowerlowalarm': 'RxPowerLowAlarm',
'rxpowerhighwarning': 'RxPowerHighWarning',
'rxpowerlowwarning': 'RxPowerLowWarning',
'txbiashighalarm': 'TxBiasHighAlarm',
'txbiaslowalarm': 'TxBiasLowAlarm',
'txbiashighwarning': 'TxBiasHighWarning',
'txbiaslowwarning': 'TxBiasLowWarning'
}
DOM_MODULE_THRESHOLD_MAP = {
'temphighalarm': 'TempHighAlarm',
'templowalarm': 'TempLowAlarm',
'temphighwarning': 'TempHighWarning',
'templowwarning': 'TempLowWarning',
'vcchighalarm': 'VccHighAlarm',
'vcclowalarm': 'VccLowAlarm',
'vcchighwarning': 'VccHighWarning',
'vcclowwarning': 'VccLowWarning'
}
QSFP_DOM_CHANNEL_MONITOR_MAP = {
'rx1power': 'RX1Power',
'rx2power': 'RX2Power',
'rx3power': 'RX3Power',
'rx4power': 'RX4Power',
'tx1bias': 'TX1Bias',
'tx2bias': 'TX2Bias',
'tx3bias': 'TX3Bias',
'tx4bias': 'TX4Bias',
'tx1power': 'TX1Power',
'tx2power': 'TX2Power',
'tx3power': 'TX3Power',
'tx4power': 'TX4Power'
}
QSFP_DD_DOM_CHANNEL_MONITOR_MAP = {
'rx1power': 'RX1Power',
'rx2power': 'RX2Power',
'rx3power': 'RX3Power',
'rx4power': 'RX4Power',
'rx5power': 'RX5Power',
'rx6power': 'RX6Power',
'rx7power': 'RX7Power',
'rx8power': 'RX8Power',
'tx1bias': 'TX1Bias',
'tx2bias': 'TX2Bias',
'tx3bias': 'TX3Bias',
'tx4bias': 'TX4Bias',
'tx5bias': 'TX5Bias',
'tx6bias': 'TX6Bias',
'tx7bias': 'TX7Bias',
'tx8bias': 'TX8Bias',
'tx1power': 'TX1Power',
'tx2power': 'TX2Power',
'tx3power': 'TX3Power',
'tx4power': 'TX4Power',
'tx5power': 'TX5Power',
'tx6power': 'TX6Power',
'tx7power': 'TX7Power',
'tx8power': 'TX8Power'
}
DOM_MODULE_MONITOR_MAP = {
'temperature': 'Temperature',
'voltage': 'Vcc'
}
DOM_CHANNEL_THRESHOLD_UNIT_MAP = {
'txpowerhighalarm': 'dBm',
'txpowerlowalarm': 'dBm',
'txpowerhighwarning': 'dBm',
'txpowerlowwarning': 'dBm',
'rxpowerhighalarm': 'dBm',
'rxpowerlowalarm': 'dBm',
'rxpowerhighwarning': 'dBm',
'rxpowerlowwarning': 'dBm',
'txbiashighalarm': 'mA',
'txbiaslowalarm': 'mA',
'txbiashighwarning': 'mA',
'txbiaslowwarning': 'mA'
}
DOM_MODULE_THRESHOLD_UNIT_MAP = {
'temphighalarm': 'C',
'templowalarm': 'C',
'temphighwarning': 'C',
'templowwarning': 'C',
'vcchighalarm': 'Volts',
'vcclowalarm': 'Volts',
'vcchighwarning': 'Volts',
'vcclowwarning': 'Volts'
}
DOM_VALUE_UNIT_MAP = {
'rx1power': 'dBm',
'rx2power': 'dBm',
'rx3power': 'dBm',
'rx4power': 'dBm',
'tx1bias': 'mA',
'tx2bias': 'mA',
'tx3bias': 'mA',
'tx4bias': 'mA',
'tx1power': 'dBm',
'tx2power': 'dBm',
'tx3power': 'dBm',
'tx4power': 'dBm',
'temperature': 'C',
'voltage': 'Volts'
}
QSFP_DD_DOM_VALUE_UNIT_MAP = {
'rx1power': 'dBm',
'rx2power': 'dBm',
'rx3power': 'dBm',
'rx4power': 'dBm',
'rx5power': 'dBm',
'rx6power': 'dBm',
'rx7power': 'dBm',
'rx8power': 'dBm',
'tx1bias': 'mA',
'tx2bias': 'mA',
'tx3bias': 'mA',
'tx4bias': 'mA',
'tx5bias': 'mA',
'tx6bias': 'mA',
'tx7bias': 'mA',
'tx8bias': 'mA',
'tx1power': 'dBm',
'tx2power': 'dBm',
'tx3power': 'dBm',
'tx4power': 'dBm',
'tx5power': 'dBm',
'tx6power': 'dBm',
'tx7power': 'dBm',
'tx8power': 'dBm',
'temperature': 'C',
'voltage': 'Volts'
}
RJ45_PORT_TYPE = 'RJ45'
# Global platform-specific Chassis class instance
platform_chassis = None
# Global platform-specific sfputil class instance
platform_sfputil = None
# Global logger instance
log = logger.Logger(SYSLOG_IDENTIFIER)
def is_sfp_present(port_name):
physical_port = logical_port_to_physical_port_index(port_name)
sfp = platform_chassis.get_sfp(physical_port)
try:
presence = sfp.get_presence()
except NotImplementedError:
click.echo("sfp get_presence() NOT implemented!", err=True)
sys.exit(ERROR_NOT_IMPLEMENTED)
return bool(presence)
def is_port_type_rj45(port_name):
physical_port = logical_port_to_physical_port_index(port_name)
try:
port_types = platform_chassis.get_port_or_cage_type(physical_port)
return SfpBase.SFP_PORT_TYPE_BIT_RJ45 == port_types
except NotImplementedError:
pass
return False
# ========================== Methods for formatting output ==========================
# Convert dict values to cli output string
def format_dict_value_to_string(sorted_key_table,
dom_info_dict, dom_value_map,
dom_unit_map, alignment=0):
output = ''
indent = ' ' * 8
separator = ": "
for key in sorted_key_table:
if dom_info_dict is not None and key in dom_info_dict and dom_info_dict[key] != 'N/A':
value = dom_info_dict[key]
units = ''
if type(value) != str or (value != 'Unknown' and not value.endswith(dom_unit_map[key])):
units = dom_unit_map[key]
output += '{}{}{}{}{}\n'.format((indent * 2),
dom_value_map[key],
separator.rjust(len(separator) + alignment - len(dom_value_map[key])),
value,
units)
return output
def convert_sfp_info_to_output_string(sfp_info_dict):
indent = ' ' * 8
output = ''
sfp_type = sfp_info_dict['type']
# CMIS supported module types include QSFP-DD and OSFP
if sfp_type.startswith('QSFP-DD') or sfp_type.startswith('OSFP'):
sorted_qsfp_data_map_keys = sorted(QSFP_DD_DATA_MAP, key=QSFP_DD_DATA_MAP.get)
for key in sorted_qsfp_data_map_keys:
if key == 'cable_type':
output += '{}{}: {}\n'.format(indent, sfp_info_dict['cable_type'], sfp_info_dict['cable_length'])
elif key == 'cable_length':
pass
elif key == 'specification_compliance':
output += '{}{}: {}\n'.format(indent, QSFP_DD_DATA_MAP[key], sfp_info_dict[key])
elif key == 'supported_max_tx_power' or key == 'supported_min_tx_power':
if key in sfp_info_dict: # C-CMIS compliant / coherent modules
output += '{}{}: {}dBm\n'.format(indent, QSFP_DD_DATA_MAP[key], sfp_info_dict[key])
elif key == 'supported_max_laser_freq' or key == 'supported_min_laser_freq':
if key in sfp_info_dict: # C-CMIS compliant / coherent modules
output += '{}{}: {}GHz\n'.format(indent, QSFP_DD_DATA_MAP[key], sfp_info_dict[key])
else:
try:
output += '{}{}: {}\n'.format(indent, QSFP_DD_DATA_MAP[key], sfp_info_dict[key])
except (KeyError, ValueError) as e:
output += '{}{}: N/A\n'.format(indent, QSFP_DD_DATA_MAP[key])
else:
sorted_qsfp_data_map_keys = sorted(QSFP_DATA_MAP, key=QSFP_DATA_MAP.get)
for key in sorted_qsfp_data_map_keys:
if key == 'cable_type':
output += '{}{}: {}\n'.format(indent, sfp_info_dict['cable_type'], sfp_info_dict['cable_length'])
elif key == 'cable_length':
pass
elif key == 'specification_compliance':
output += '{}{}:\n'.format(indent, QSFP_DATA_MAP['specification_compliance'])
spec_compliance_dict = {}
try:
spec_compliance_dict = ast.literal_eval(sfp_info_dict['specification_compliance'])
sorted_compliance_key_table = natsorted(spec_compliance_dict)
for compliance_key in sorted_compliance_key_table:
output += '{}{}: {}\n'.format((indent * 2), compliance_key, spec_compliance_dict[compliance_key])
except ValueError as e:
output += '{}N/A\n'.format((indent * 2))
else:
output += '{}{}: {}\n'.format(indent, QSFP_DATA_MAP[key], sfp_info_dict[key])
return output
# Convert DOM sensor info in DB to CLI output string
def convert_dom_to_output_string(sfp_type, dom_info_dict):
indent = ' ' * 8
output_dom = ''
channel_threshold_align = 18
module_threshold_align = 15
if sfp_type.startswith('QSFP'):
# Channel Monitor
if sfp_type.startswith('QSFP-DD'):
output_dom += (indent + 'ChannelMonitorValues:\n')
sorted_key_table = natsorted(QSFP_DD_DOM_CHANNEL_MONITOR_MAP)
output_channel = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
QSFP_DD_DOM_CHANNEL_MONITOR_MAP,
QSFP_DD_DOM_VALUE_UNIT_MAP)
output_dom += output_channel
else:
output_dom += (indent + 'ChannelMonitorValues:\n')
sorted_key_table = natsorted(QSFP_DOM_CHANNEL_MONITOR_MAP)
output_channel = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
QSFP_DOM_CHANNEL_MONITOR_MAP,
DOM_VALUE_UNIT_MAP)
output_dom += output_channel
# Channel Threshold
if sfp_type.startswith('QSFP-DD'):
dom_map = SFP_DOM_CHANNEL_THRESHOLD_MAP
else:
dom_map = QSFP_DOM_CHANNEL_THRESHOLD_MAP
output_dom += (indent + 'ChannelThresholdValues:\n')
sorted_key_table = natsorted(dom_map)
output_channel_threshold = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
dom_map,
DOM_CHANNEL_THRESHOLD_UNIT_MAP,
channel_threshold_align)
output_dom += output_channel_threshold
# Module Monitor
output_dom += (indent + 'ModuleMonitorValues:\n')
sorted_key_table = natsorted(DOM_MODULE_MONITOR_MAP)
output_module = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
DOM_MODULE_MONITOR_MAP,
DOM_VALUE_UNIT_MAP)
output_dom += output_module
# Module Threshold
output_dom += (indent + 'ModuleThresholdValues:\n')
sorted_key_table = natsorted(DOM_MODULE_THRESHOLD_MAP)
output_module_threshold = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
DOM_MODULE_THRESHOLD_MAP,
DOM_MODULE_THRESHOLD_UNIT_MAP,
module_threshold_align)
output_dom += output_module_threshold
else:
output_dom += (indent + 'MonitorData:\n')
sorted_key_table = natsorted(SFP_DOM_CHANNEL_MONITOR_MAP)
output_channel = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
SFP_DOM_CHANNEL_MONITOR_MAP,
DOM_VALUE_UNIT_MAP)
output_dom += output_channel
sorted_key_table = natsorted(DOM_MODULE_MONITOR_MAP)
output_module = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
DOM_MODULE_MONITOR_MAP,
DOM_VALUE_UNIT_MAP)
output_dom += output_module
output_dom += (indent + 'ThresholdData:\n')
# Module Threshold
sorted_key_table = natsorted(DOM_MODULE_THRESHOLD_MAP)
output_module_threshold = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
DOM_MODULE_THRESHOLD_MAP,
DOM_MODULE_THRESHOLD_UNIT_MAP,
module_threshold_align)
output_dom += output_module_threshold
# Channel Threshold
sorted_key_table = natsorted(SFP_DOM_CHANNEL_THRESHOLD_MAP)
output_channel_threshold = format_dict_value_to_string(
sorted_key_table, dom_info_dict,
SFP_DOM_CHANNEL_THRESHOLD_MAP,
DOM_CHANNEL_THRESHOLD_UNIT_MAP,
channel_threshold_align)
output_dom += output_channel_threshold
return output_dom
# =============== Getting and printing SFP data ===============
#
def get_physical_port_name(logical_port, physical_port, ganged):
"""
Returns:
port_num if physical
logical_port:port_num if logical port and is a ganged port
logical_port if logical and not ganged
"""
if logical_port == physical_port:
return str(logical_port)
elif ganged:
return "{}:{} (ganged)".format(logical_port, physical_port)
else:
return logical_port
def logical_port_name_to_physical_port_list(port_name):
if port_name.startswith("Ethernet"):
if platform_sfputil.is_logical_port(port_name):
return platform_sfputil.get_logical_to_physical(port_name)
else:
click.echo("Error: Invalid port '{}'".format(port_name))
return None
else:
return [int(port_name)]
def logical_port_to_physical_port_index(port_name):
if not platform_sfputil.is_logical_port(port_name):
click.echo("Error: invalid port '{}'\n".format(port_name))
print_all_valid_port_values()
sys.exit(ERROR_INVALID_PORT)
physical_port = logical_port_name_to_physical_port_list(port_name)[0]
if physical_port is None:
click.echo("Error: No physical port found for logical port '{}'".format(port_name))
sys.exit(EXIT_FAIL)
return physical_port
def print_all_valid_port_values():
click.echo("Valid values for port: {}\n".format(str(platform_sfputil.logical)))
# ==================== Methods for initialization ====================
# Instantiate platform-specific Chassis class
def load_platform_chassis():
global platform_chassis
# Load new platform api class
try:
platform_chassis = sonic_platform.platform.Platform().get_chassis()
except Exception as e:
log.log_error("Failed to instantiate Chassis due to {}".format(repr(e)))
if not platform_chassis:
return False
return True
# Instantiate SfpUtilHelper class
def load_sfputilhelper():
global platform_sfputil
# we have to make use of sfputil for some features
# even though when new platform api is used for all vendors.
# in this sense, we treat it as a part of new platform api.
# we have already moved sfputil to sonic_platform_base
# which is the root of new platform api.
platform_sfputil = sonic_platform_base.sonic_sfp.sfputilhelper.SfpUtilHelper()
if not platform_sfputil:
return False
return True
def load_port_config():
try:
if multi_asic.is_multi_asic():
# For multi ASIC platforms we pass DIR of port_config_file_path and the number of asics
(platform_path, hwsku_path) = device_info.get_paths_to_platform_and_hwsku_dirs()
# Load platform module from source
platform_sfputil.read_all_porttab_mappings(hwsku_path, multi_asic.get_num_asics())
else:
# For single ASIC platforms we pass port_config_file_path and the asic_inst as 0
port_config_file_path = device_info.get_path_to_port_config_file()
platform_sfputil.read_porttab_mappings(port_config_file_path, 0)
except Exception as e:
log.log_error("Error reading port info ({})".format(str(e)), True)
return False
return True
# ==================== CLI commands and groups ====================
# This is our main entrypoint - the main 'sfputil' command
@click.group()
def cli():
"""sfputil - Command line utility for managing SFP transceivers"""
if os.geteuid() != 0:
click.echo("Root privileges are required for this operation")
sys.exit(ERROR_PERMISSIONS)
# Load platform-specific Chassis class
if not load_platform_chassis():
sys.exit(ERROR_CHASSIS_LOAD)
# Load SfpUtilHelper class
if not load_sfputilhelper():
sys.exit(ERROR_SFPUTILHELPER_LOAD)
# Load port info
if not load_port_config():
sys.exit(ERROR_PORT_CONFIG_LOAD)
# 'show' subgroup
@cli.group()
def show():
"""Display status of SFP transceivers"""
pass
# 'eeprom' subcommand
@show.command()
@click.option('-p', '--port', metavar='<port_name>', help="Display SFP EEPROM data for port <port_name> only")
@click.option('-d', '--dom', 'dump_dom', is_flag=True, help="Also display Digital Optical Monitoring (DOM) data")
@click.option('-n', '--namespace', default=None, help="Display interfaces for specific namespace")
def eeprom(port, dump_dom, namespace):
"""Display EEPROM data of SFP transceiver(s)"""
logical_port_list = []
output = ""
# Create a list containing the logical port names of all ports we're interested in
if port is None:
logical_port_list = platform_sfputil.logical
else:
if platform_sfputil.is_logical_port(port) == 0:
click.echo("Error: invalid port '{}'\n".format(port))
print_all_valid_port_values()
sys.exit(ERROR_INVALID_PORT)
logical_port_list = [port]
for logical_port_name in logical_port_list:
ganged = False
i = 1
physical_port_list = logical_port_name_to_physical_port_list(logical_port_name)
if physical_port_list is None:
click.echo("Error: No physical ports found for logical port '{}'".format(logical_port_name))
return
if len(physical_port_list) > 1:
ganged = True
for physical_port in physical_port_list:
port_name = get_physical_port_name(logical_port_name, i, ganged)
if is_port_type_rj45(port_name):
output += "{}: SFP EEPROM is not applicable for RJ45 port\n".format(port_name)
output += '\n'
continue
try:
presence = platform_chassis.get_sfp(physical_port).get_presence()
except NotImplementedError:
click.echo("Sfp.get_presence() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
if not presence:
output += "{}: SFP EEPROM not detected\n".format(port_name)
else:
output += "{}: SFP EEPROM detected\n".format(port_name)
try:
xcvr_info = platform_chassis.get_sfp(physical_port).get_transceiver_info()
except NotImplementedError:
click.echo("Sfp.get_transceiver_info() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
output += convert_sfp_info_to_output_string(xcvr_info)
if dump_dom:
try:
xcvr_dom_info = platform_chassis.get_sfp(physical_port).get_transceiver_bulk_status()
except NotImplementedError:
click.echo("Sfp.get_transceiver_bulk_status() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
try:
xcvr_dom_threshold_info = platform_chassis.get_sfp(physical_port).get_transceiver_threshold_info()
if xcvr_dom_threshold_info:
xcvr_dom_info.update(xcvr_dom_threshold_info)
except NotImplementedError:
click.echo("Sfp.get_transceiver_threshold_info() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
output += convert_dom_to_output_string(xcvr_info['type'], xcvr_dom_info)
output += '\n'
click.echo(output)
# 'eeprom-hexdump' subcommand
@show.command()
@click.option('-p', '--port', metavar='<port_name>', required=True, help="Display SFP EEPROM hexdump for port <port_name>")
@click.option('-n', '--page', metavar='<page_number>', help="Display SFP EEEPROM hexdump for <page_number_in_hex>")
def eeprom_hexdump(port, page):
"""Display EEPROM hexdump of SFP transceiver(s) for a given port name and page number"""
output = ""
if platform_sfputil.is_logical_port(port) == 0:
click.echo("Error: invalid port {}".format(port))
print_all_valid_port_values()
sys.exit(ERROR_INVALID_PORT)
if page is None:
page = '0'
logical_port_name = port
physical_port = logical_port_to_physical_port_index(logical_port_name)
if is_port_type_rj45(logical_port_name):
click.echo("{}: SFP EEPROM Hexdump is not applicable for RJ45 port".format(port))
sys.exit(ERROR_INVALID_PORT)
try:
presence = platform_chassis.get_sfp(physical_port).get_presence()
except NotImplementedError:
click.echo("Sfp.get_presence() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
if not presence:
click.echo("SFP EEPROM not detected")
sys.exit(ERROR_NOT_IMPLEMENTED)
else:
try:
id = platform_chassis.get_sfp(physical_port).read_eeprom(0, 1)
if id is None:
click.echo("Error: Failed to read EEPROM for offset 0!")
sys.exit(ERROR_NOT_IMPLEMENTED)
except NotImplementedError:
click.echo("Sfp.read_eeprom() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
if id[0] == 0x3:
output = eeprom_hexdump_sff8472(port, physical_port, page)
else:
output = eeprom_hexdump_sff8636(port, physical_port, page)
output += '\n'
click.echo(output)
def eeprom_hexdump_sff8472(port, physical_port, page):
try:
output = ""
indent = ' ' * 8
output += 'EEPROM hexdump for port {} page {}h'.format(port, page)
output += '\n{}A0h dump'.format(indent)
page_dump = platform_chassis.get_sfp(physical_port).read_eeprom(0, SFF8472_A0_SIZE)
if page_dump is None:
click.echo("Error: Failed to read EEPROM for A0h!")
sys.exit(ERROR_NOT_IMPLEMENTED)
output += hexdump(indent, page_dump, 0)
page_dump = platform_chassis.get_sfp(physical_port).read_eeprom(SFF8472_A0_SIZE, PAGE_SIZE)
if page_dump is None:
click.echo("Error: Failed to read EEPROM for A2h!")
sys.exit(ERROR_NOT_IMPLEMENTED)
else:
output += '\n\n{}A2h dump (lower 128 bytes)'.format(indent)
output += hexdump(indent, page_dump, 0)
page_dump = platform_chassis.get_sfp(physical_port).read_eeprom(SFF8472_A0_SIZE + PAGE_OFFSET + (int(page, base=16) * PAGE_SIZE), PAGE_SIZE)
if page_dump is None:
click.echo("Error: Failed to read EEPROM for A2h upper page!")
sys.exit(ERROR_NOT_IMPLEMENTED)
else:
output += '\n\n{}A2h dump (upper 128 bytes) page {}h'.format(indent, page)
output += hexdump(indent, page_dump, PAGE_OFFSET)
except NotImplementedError:
click.echo("Sfp.read_eeprom() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
except ValueError:
click.echo("Please enter a numeric page number")
sys.exit(ERROR_NOT_IMPLEMENTED)
return output
def eeprom_hexdump_sff8636(port, physical_port, page):
try:
output = ""
indent = ' ' * 8
output += 'EEPROM hexdump for port {} page {}h'.format(port, page)
output += '\n{}Lower page 0h'.format(indent)
page_dump = platform_chassis.get_sfp(physical_port).read_eeprom(0, PAGE_SIZE)
if page_dump is None:
click.echo("Error: Failed to read EEPROM for page 0!")
sys.exit(ERROR_NOT_IMPLEMENTED)
output += hexdump(indent, page_dump, 0)
page_dump = platform_chassis.get_sfp(physical_port).read_eeprom(int(page, base=16) * PAGE_SIZE + PAGE_OFFSET, PAGE_SIZE)
if page_dump is None:
click.echo("Error: Failed to read EEPROM!")
sys.exit(ERROR_NOT_IMPLEMENTED)
else:
output += '\n\n{}Upper page {}h'.format(indent, page)
output += hexdump(indent, page_dump, PAGE_OFFSET)
except NotImplementedError:
click.echo("Sfp.read_eeprom() is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
except ValueError:
click.echo("Please enter a numeric page number")
sys.exit(ERROR_NOT_IMPLEMENTED)
return output
def convert_byte_to_valid_ascii_char(byte):
if byte < 32 or 126 < byte:
return '.'
else:
return chr(byte)
def hexdump(indent, data, mem_address):
ascii_string = ''
result = ''
for byte in data:
ascii_string = ascii_string + convert_byte_to_valid_ascii_char(byte)
byte_string = "{:02x}".format(byte)
if mem_address % 16 == 0:
mem_address_string = "{:08x}".format(mem_address)
result += '\n{}{} '.format(indent, mem_address_string)
result += '{} '.format(byte_string)
elif mem_address % 16 == 15:
result += '{} '.format(byte_string)
result += '|{}|'.format(ascii_string)
ascii_string = ""
elif mem_address % 16 == 7:
result += ' {} '.format(byte_string)
else:
result += '{} '.format(byte_string)
mem_address += 1
return result
# 'presence' subcommand
@show.command()
@click.option('-p', '--port', metavar='<port_name>', help="Display SFP presence for port <port_name> only")
def presence(port):
"""Display presence of SFP transceiver(s)"""
logical_port_list = []
output_table = []
table_header = ["Port", "Presence"]
# Create a list containing the logical port names of all ports we're interested in
if port is None:
logical_port_list = platform_sfputil.logical
else:
if platform_sfputil.is_logical_port(port) == 0:
click.echo("Error: invalid port '{}'\n".format(port))
print_all_valid_port_values()
sys.exit(ERROR_INVALID_PORT)
logical_port_list = [port]
logical_port_list = natsort.natsorted(logical_port_list)
for logical_port_name in logical_port_list:
ganged = False
i = 1
physical_port_list = logical_port_name_to_physical_port_list(logical_port_name)
if physical_port_list is None:
click.echo("Error: No physical ports found for logical port '{}'".format(logical_port_name))
return
if len(physical_port_list) > 1:
ganged = True
for physical_port in physical_port_list:
port_name = get_physical_port_name(logical_port_name, i, ganged)
try:
presence = platform_chassis.get_sfp(physical_port).get_presence()
except NotImplementedError:
click.echo("This functionality is currently not implemented for this platform")
sys.exit(ERROR_NOT_IMPLEMENTED)
status_string = "Present" if presence else "Not present"
output_table.append([port_name, status_string])
i += 1
click.echo(tabulate(output_table, table_header, tablefmt="simple"))
# 'error-status' subcommand
def fetch_error_status_from_platform_api(port):
"""Fetch the error status from platform API and return the output as a string
Args:
port: the port whose error status will be fetched.
None represents for all ports.
Returns:
A string consisting of the error status of each port.
"""
if port is None:
logical_port_list = natsort.natsorted(platform_sfputil.logical)
# Create a list containing the logical port names of all ports we're interested in
generate_sfp_list_code = \
"sfp_list = chassis.get_all_sfps()\n"
else:
physical_port_list = logical_port_name_to_physical_port_list(port)
logical_port_list = [port]
# Create a list containing the logical port names of all ports we're interested in
generate_sfp_list_code = \
"sfp_list = [chassis.get_sfp(x) for x in {}]\n".format(physical_port_list)
# Code to initialize chassis object
init_chassis_code = \
"import sonic_platform.platform\n" \
"platform = sonic_platform.platform.Platform()\n" \
"chassis = platform.get_chassis()\n"
# Code to fetch the error status
get_error_status_code = \
"try:\n"\
" errors=['{}:{}'.format(sfp.index, sfp.get_error_description()) for sfp in sfp_list]\n" \
"except NotImplementedError as e:\n"\
" errors=['{}:{}'.format(sfp.index, 'OK (Not implemented)') for sfp in sfp_list]\n" \
"print(errors)\n"
get_error_status_command = "docker exec pmon python3 -c \"{}{}{}\"".format(
init_chassis_code, generate_sfp_list_code, get_error_status_code)
# Fetch error status from pmon docker
try:
output = subprocess.check_output(get_error_status_command, shell=True, universal_newlines=True)
except subprocess.CalledProcessError as e:
click.Abort("Error! Unable to fetch error status for SPF modules. Error code = {}, error messages: {}".format(e.returncode, e.output))
return None
output_list = output.split('\n')
for output_str in output_list:
# The output of all SFP error status are a list consisting of element with convention of '<sfp no>:<error status>'
# Besides, there can be some logs captured during the platform API executing
# So, first of all, we need to skip all the logs until find the output list of SFP error status
if output_str[0] == '[' and output_str[-1] == ']':
output_list = ast.literal_eval(output_str)
break
output_dict = {}
for output in output_list:
sfp_index, error_status = output.split(':')
output_dict[int(sfp_index)] = error_status
output = []
for logical_port_name in logical_port_list:
physical_port_list = logical_port_name_to_physical_port_list(logical_port_name)
port_name = get_physical_port_name(logical_port_name, 1, False)
if is_port_type_rj45(logical_port_name):
output.append([port_name, "N/A"])
else:
output.append([port_name, output_dict.get(physical_port_list[0])])
return output
def fetch_error_status_from_state_db(port, state_db):
"""Fetch the error status from STATE_DB and return them in a list.
Args:
port: the port whose error status will be fetched.
None represents for all ports.
Returns:
A list consisting of tuples (port, description) and sorted by port.
"""
status = {}
if port:
status[port] = state_db.get_all(state_db.STATE_DB, 'TRANSCEIVER_STATUS|{}'.format(port))
else:
ports = state_db.keys(state_db.STATE_DB, 'TRANSCEIVER_STATUS|*')
for key in ports:
status[key.split('|')[1]] = state_db.get_all(state_db.STATE_DB, key)
sorted_ports = natsort.natsorted(status)
output = []
for port in sorted_ports:
if is_port_type_rj45(port):
description = "N/A"
else:
statestring = status[port].get('status')
description = status[port].get('error')
if statestring == '1':
description = 'OK'
elif statestring == '0':
description = 'Unplugged'
elif description == 'N/A':
log.log_error("Inconsistent state found for port {}: state is {} but error description is N/A".format(port, statestring))
description = 'Unknown state: {}'.format(statestring)
output.append([port, description])
return output
@show.command()
@click.option('-p', '--port', metavar='<port_name>', help="Display SFP error status for port <port_name> only")
@click.option('-hw', '--fetch-from-hardware', 'fetch_from_hardware', is_flag=True, default=False, help="Fetch the error status from hardware directly")
def error_status(port, fetch_from_hardware):
"""Display error status of SFP transceiver(s)"""
output_table = []