diff --git a/docs/driver/win/pikvm-rndis5.inf b/docs/driver/win/pikvm-rndis5.inf new file mode 100644 index 0000000..4727cf4 --- /dev/null +++ b/docs/driver/win/pikvm-rndis5.inf @@ -0,0 +1,45 @@ +; Remote NDIS device setup file for PIKVM + +[Version] +Signature = "$Windows NT$" +Class = Net +ClassGUID = {4d36e972-e325-11ce-bfc1-08002be10318} +Provider = "PIKVM" +DriverVer =01/17/2021,6.0.6000.16385 + +[Manufacturer] +"PIKVM" = RndisDevices,NTx86,NTamd64,NTia64 + +[RndisDevices.NTx86] +%RndisDevice% = RNDIS.NT.5.1, USB\VID_1D6B&PID_0104&MI_00 + +[RndisDevices.NTamd64] +%RndisDevice% = RNDIS.NT.5.1, USB\VID_1D6B&PID_0104&MI_00 + +[RndisDevices.NTia64] +%RndisDevice% = RNDIS.NT.5.1, USB\VID_1D6B&PID_0104&MI_00 + +[ControlFlags] +ExcludeFromSelect=* + +[RNDIS.NT.5.1] +Characteristics = 0x84 ; NCF_PHYSICAL + NCF_HAS_UI +BusType = 15 +include = netrndis.inf +needs = Usb_Rndis.ndi +AddReg = Rndis_AddReg_Vista + +[RNDIS.NT.5.1.Services] +include = netrndis.inf +needs = Usb_Rndis.ndi.Services + +[RNDIS_AddReg_Vista] +HKR, NDI\params\VistaProperty, ParamDesc, 0, "PIKVM" +HKR, NDI\params\VistaProperty, type, 0, "edit" +HKR, NDI\params\VistaProperty, LimitText, 0, "12" +HKR, NDI\params\VistaProperty, UpperCase, 0, "1" +HKR, NDI\params\VistaProperty, default, 0, " " +HKR, NDI\params\VistaProperty, optional, 0, "1" + +[Strings] +RndisDevice = "PIKVM RNDIS Ethernet" diff --git a/docs/usb_ethernet.md b/docs/usb_ethernet.md index 9f6da6d..c2d819a 100644 --- a/docs/usb_ethernet.md +++ b/docs/usb_ethernet.md @@ -16,7 +16,20 @@ Specifically to v2+. When combined with configuring a DNS server, FTP, or SMB (f kvm_mac: 42:61:64:55:53:42 ``` - The `host_mac` address will be used on the server's network interface. The `kvm_mac` means the address that will be assigned to the local interface on the PiKVM. The KVM interface will be called `usb0`network interface. If the `host_mac` or `kvm_mac` is not specified, a random value will be used. The `driver` parameter means the protocol that will be used for the USB network. The default value is `ecm` so it can be passed it this example. Other possible values are `eem`, `ncm` and `rndis`. + The `host_mac` address will be used on the server's network interface. The `kvm_mac` means the address that will be assigned to the local interface on the PiKVM. The KVM interface will be called `usb0`network interface. If the `host_mac` or `kvm_mac` is not specified, a random value will be used. The `driver` parameter means the protocol that will be used for the USB network. The default value is `ecm` so it can be passed it this example. Other possible values are `eem`, `ncm`, `rndis` and `rndis5`. + + **Driver compatibility:** + + | Driver | Operating System| + |--------|-------| + | ecm | Linux | + | eem | Linux | + | rndis5 | Windows XP to Windows 7[1](#rndis5)
Linux > 2.6.13 | + | rndis | Windows 7 and later[2](#rndis)
Linux > 2.6.13 | + | ncm | Windows 10 and later
Linux > 2.6.37 | + + 1: Manual driver installation is required. [Download RNDIS 5 Windows](driver/win/pikvm-rndis5.inf)
+ 2: Automatic driver installation since kvmd-3.53 2. To automatically configure the USB network on the server recommended using the service `kvmd-otgnet`. It configures the firewall, assigns an address to the local PiKVM interface `usb0` and starts DHCP so the managed server can get the IPv4 address. By default, the address `169.254.0.1/28` to interface `usb0` will be assigned. One of the other addresses from the network `169.254.0.0./28` will be assigned to the server when it requests it via DHCP. For security reasons, all incoming connections from the server to the PiKVM side are blocked (except for ICMP and UDP port 67 which is used for DHCP). If you want to allow access from the server to the PiKVM interface, then you need to add ports 80 and 443 to the whitelist using `/etc/kvmd/override.yaml` file like this: