docs: added notes on sfp module and how to configure it

This commit is contained in:
Michele Cereda
2023-03-18 14:58:04 +01:00
parent 72ad95650e
commit 6f7a18f954
2 changed files with 91 additions and 7 deletions

View File

@@ -8,6 +8,8 @@
1. [Containerized pi-hole](#containerized-pi-hole)
1. [Factory reset](#factory-reset)
1. [Hardware upgrades](#hardware-upgrades)
1. [The SFP+ caged module](#the-sfp-caged-module)
1. [Use the SFP module as a LAN port](#use-the-sfp-module-as-a-lan-port)
1. [Further readings](#further-readings)
1. [Sources](#sources)
@@ -37,6 +39,7 @@ uci commit 'dhcp'
# Reload the configuration.
# Necessary to reflect changes to the settings.
reload_config
luci-reload
# Get LEDs intensity.
@@ -196,6 +199,70 @@ Most compatible upgrades are available on [Discomp].
| SFP module | [Turris RTROM01-RTSF-10G SFP+ copper module] |
| WiFi | [Turris Omnia WiFi 6 upgrade kit] |
## The SFP+ caged module
> The physical WAN port and the SFP module cage are wired to a single controller; when a SFP module is inserted, the physical WAN **port** **will be disabled**, and the virtual WAN interface will automatically be switched to the SFP module.
When the OS is installed, it will probably miss the SFP kernel modules.<br/>
Check the module is recognized by the system like so:
1. Insert the module in the cage.
1. Check the module has been recognized automatically:
```sh
dmesg | grep 'sfp'
```
1. If the `grep` returned results:
```text
[ 7.823007] sfp sfp: Host maximum power 3.0W
[ 8.167128] sfp sfp: Turris RTSFP-10G rev A sn 1234567890 dc 123456
```
the SFP module is recognized and probably started working already right away.<br/>
If, instead, no result has been returned:
1. Make sure the SFP kernel modules are installed:
```sh
opkg install 'kmod-spf'
```
1. Reboot (for safety).
1. Check the module has been recognized (see point 2 in this list).
### Use the SFP module as a LAN port
To use the SFP module as a LAN port, assign any other physical switch port to the virtual WAN interface to use that as the WAN connection and the SFP module in the LAN.
In the Foris web interface:
1. Go to _Network Settings_ > _Interfaces_.
1. Select the WAN interface.
1. In the dropdown _Network_ menu, change _WAN_ to _LAN_.
1. Select the LAN4 interface.
1. In the dropdown _Network_ menu, change _LAN_ to _WAN_.
1. Hit _Save_.
In the LuCI web interface:
1. Go to _Network_ > _Interfaces_.
1. In the _Interfaces_ tab, edit the WAN interface and assign the _lan4_ port to it.
1. In the _Devices_ tab, edit the _br-lan_ bridge device to include the port used by the SFP module (on mine, it was `eth2`).
1. Hit _Save & Apply_.
Using the CLI (yet to be tested):
```sh
uci set network.wan.device='lan4'
uci del_list network.br_lan.ports='lan4'
uci add_list network.br_lan.ports='eth2'
uci commit 'network'
reload_config
luci-reload
```
## Further readings
- [Led settings][wiki led settings] on the [wiki][turris wiki]

View File

@@ -9,6 +9,17 @@ Command line utility for OpenWrt's UCI system.
uci show
uci show 'dhcp'
# Show changes to the settings.
uci changes
uci changes 'dhcp'
# Commit changes.
uci commit
uci commit 'dhcp'
# Reload the configuration
reload_config
# Show what interface is the WAN.
uci show network.wan.device | cut -d "'" -f 2
@@ -17,14 +28,15 @@ uci add dhcp host
uci set dhcp.@host[-1].name='hostname'
uci set dhcp.@host[-1].mac='11:22:33:44:55:66'
uci set dhcp.@host[-1].ip='192.168.1.2'
# Show changes to the settings.
uci changes
uci changes 'dhcp'
# Commit changes.
uci commit
uci commit 'dhcp'
reload_config
# Use a different port as WAN switching it with one in LAN.
uci set network.wan.device='lan4'
uci del_list network.br_lan.ports='lan4'
uci add_list network.br_lan.ports='eth2'
uci commit 'network'
reload_config
```
## Further readings
@@ -33,8 +45,13 @@ uci commit 'dhcp'
## Sources
- [The UCI system]
- [Turris Omnia]
<!-- project's references -->
[the uci system]: https://openwrt.org/docs/guide-user/base-system/uci
<!-- internal references -->
[Turris Omnia]: turris.md
<!-- external references -->