From 9c9d66e1989c3156a41628a5b87ee38496ca363a Mon Sep 17 00:00:00 2001 From: Aleksandr Prokudin Date: Sun, 23 Mar 2025 22:33:55 +0100 Subject: [PATCH] Separate USB 3.0 support doc into a separate file --- docs/usb3v4.md | 34 ++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 35 insertions(+) create mode 100644 docs/usb3v4.md diff --git a/docs/usb3v4.md b/docs/usb3v4.md new file mode 100644 index 00000000..78305f38 --- /dev/null +++ b/docs/usb3v4.md @@ -0,0 +1,34 @@ +--- +title: Configure USB 3.0 support +description: How to configure USB 3.0 support on PiKVM V4 Plus +--- + +# USB 3.0 support + +PiKVM V4 Plus has an internal USB port. It supports USB 3.0, but only works with USB 2.0 devices by default to minimize the power consumption. You need to flash the USB controller to enable USB 3.0. To do so, follow these steps: + +1. Open a terminal window and log into the PiKVM via SSH: + + ```console + $ ssh user@host + ``` + +2. Flash the USB controller using the built-in `flashrom` utility. Choose `usb3` for USB 3.0 support: + + ```console + [root@pikvm ~]# flashrom-vl805 usb3 + ``` + + If you need to disable USB 3.0 support at any time later, run the same command, but use `default` instead: + + ```console + [root@pikvm ~]# flashrom-vl805 default + ``` + +3. Perform the soft reboot: + + ```console + [root@pikvm ~]# reboot + ``` + +4. After the soft reboot, perform the **reboot by power**: unplug and plug again the power cable. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7ca4e5a7..73b09159 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,6 +116,7 @@ nav: - "Persistent storage": pst.md - "Prometheus monitoring": prometheus.md - "DIP switches": dip_switches.md + - "USB 3.0 support": usb3v4.md - "Development": - "HTTP API reference": api.md - "Building PiKVM OS": building_os.md