search

jimdigriz / mt5311

Utilities for working with Metanoia/Proscend VDSL2 SFP Modems
GNU Affero General Public License v3.0
12 stars 3 forks source link
agentx lua snmp vdsl wireshark-dissector

readme

Utilities for working with Metanoia/Proscend VDSL2 SFP Modems.

Review

I personally am happy with the two 180-T's I purchased; one plugged into a Mikrotik hAP ac and the other into a Cisco WS-C3560X-24P. I received very similar VDSL2 sync speeds to a 'regular' router on both lines (70Mbps and 40Mbps respectively) even on the original firmware supplied.

Unfortunately since obtaining FTTP, BT Openreach will no longer allow me to continue any FTTC service and so it is difficult for me to significantly continue development of this project. I do welcome contributions from others and even bug reports.

Related Links

Utilities

I have used Lua (compatible with version 5.1) in the hope this work may be found to be useful to the OpenWRT community, a group that benefits from software with low disk space usage dependencies.

To set up your OS to run any of the utilities below, run:

Now run:

luarocks install lua-struct     # (*with* hyphen)

Now fetch the project using:

git clone https://github.com/jimdigriz/mt5311.git /opt/mt5311

EBM Read

A one shot utility to query the SFP for information.

To use it, run as root:

# lua /opt/mt5311/ebm-read.lua eth1 00:11:22:33:44:55 xdsl2LineStatusAttainableRateUs xdsl2LineStatusAttainableRateDs xdsl2LineStatusElectricalLength
reg hex int str
xdsl2LineStatusAttainableRateUs 001a19  6681    ...
xdsl2LineStatusAttainableRateDs 00af60  44896   ..`
xdsl2LineStatusElectricalLength 0000b8  184 ...

The output is in TSV (tab separated variable) format.

You should look at the register.map file for other registers that you can read, but as well as the names you can provide the register address (integer or hexadecimal) directly.

Scanning

You can use this tool to scan all the register space:

seq 0x7000 0x7fff | xargs -n1 printf "0x%x\n" | sudo xargs -n 20 lua /opt/mt5311/ebm-read.lua eth1 00:11:22:33:44:55

N.B. this may brick your device, I have no idea what all the registers do, so I suggest you stick to ranges covered in register.map

SNMP

N.B. WORK IN PROGRESS AND NOT COMPLETE

An AgentX subagent that where possible implements the following MIBs:

To set up your OS, in additional to the steps above, run:

Check the install was correctly done by running the following as root:

lua /opt/mt5311/snmp-agentx.lua IFACE MACADDR

Where:

If there is no error it means everything is are working, otherwise recheck that you followed the installation instructions so far correctly.

...

TODO include systemd/service integration

SNMP Client

Assuming that you have your SNMP client and MIBs correctly set up on your workstation (apt get install --no-install-recommends snmp snmp-mibs-downloader), you should be able to see the EBM 'interface' appear using something like the following commands (you may need to adjust your authentication settings):

snmptable -m ALL -Ci -Cw ${COLUMNS:-80} -v 2c -c public 192.0.2.1 IF-MIB::ifTable
snmptable -m ALL -Ci -Cw ${COLUMNS:-80} -v 2c -c public 192.0.2.1 IF-MIB::ifXTable
snmpwalk  -m ALL                        -v 2c -c public 192.0.2.1 VDSL2-LINE-MIB::xdsl2LineTable
snmptable -m ALL -Ci -Cw ${COLUMNS:-80} -v 2c -c public 192.0.2.1 VDSL2-LINE-MIB::xdsl2LineBandTable
snmpwalk  -m ALL                        -v 2c -c public 192.0.2.1 VDSL2-LINE-MIB::xdsl2ChannelStatusTable
snmpwalk  -m ALL                        -v 2c -c public 192.0.2.1 VDSL2-LINE-MIB::xdsl2LineInventoryTable
snmpwalk  -m ALL                        -v 2c -c public 192.0.2.1 VDSL2-LINE-MIB::xdsl2PMLineCurrTable

N.B. you may need to adjust your /etc/snmp/snmpd.conf on your router for this to work, in particularly the parameters agentaddress and rocommunity/rouser

N.B. ignore the warnings Wrong Type (should be BITS): Opaque: 1234

LibreNMS

To use this you will need to enable the 'xDSL' module for both 'Discovery' and 'Poller' in the 'Global Settings' menu.

As a recommendation, you should also index your interfaces based on ifName which is stable, and not ifIndex.

Wireshark

To use a basic Ethernet Boot & Management (EBM) protocol dissector:

sudo tcpdump -n -i eth0 'ether proto 0x6120' -w - -U | tee dump.pcap | tcpdump -r - -n -v
wireshark -X lua_script:dissector.lua dump.pcap

N.B. dissector.lua contains my notes on the protocol

If it works, it looks like:

Screenshot of Wireshark having opened dump-soc.pcap.gz using the EBM dissector

Sample Data

Included are several PCAPs capturing interactions with the SFP using DSLmonitor:

Acronyms

Official

You can see a video of the official tools in use, but below explains how to use the tools.

N.B. below worked fine for me on a Windows 10 VM running under QEMU (using the install media Win10_22H2_English_x64.iso)

DSLmonitor

  1. click on 'Connect' (second icon down on the left)
  2. use only 'Port 1'
  3. Local MAC: set to MAC address of your local NIC
    • ipconfig /all from the command prompt to obtain this
  4. Device MAC: set to the MAC address printed on your SFP
  5. click on 'OK'
    • if it errors claiming 'DSLAK.dll not found' I was able to resolve the problem by running DSLmanager first (this may have due to running the installer for WinPCAP)
  6. select the statistics window (third icon down on the left)

DSLmanager

To flash your SFP you follow the process:

  1. install both x64 and x86 version of VS C++
  2. run WinPcap_4_1_3.exe
  3. run DSLmanager.exe
  4. select the NIC that the SFP is plugged into
  5. set the 'Device MAC' to the MAC address printed on your SFP
  6. click on the 'EBM' button
  7. you will be asked to select a .b binary firmware file
    • firmwares I have used:
      • SFP_180-T_SOS_ROC.b (aka version 8570) with the SHA256 00c5b9a93d2ef09b19470a53cb8eb4f390f51bc8264fbb761e5dc9853dd4e699
      • 180T-L4TA-8463.b with the SHA256 2e7a927d4d545c029510522dde6f6e27a047cd494295899cb3b8d43ed6baa9fb
    • 8463 refers to the version number, bigger is (usually) better
  8. now wait as the flashing takes place
    • this will not take long (a minute or so) but do not worry as the window remains unresponsive for the duration
    • scroll to the bottom of the log window and wait for it to display a "Upgrade Flash Success"
      • if it fails, I have seen this once and your mileage may vary, unplug the SFP and reseat it, close DSLmanager.exe and repeat the process
  9. close DSLmanager
  10. after upgrade, power cycle SFP (unplug, put it back in)
    • shutdown and no shutdowning the switch interface is not enough to power cycle it