USB Passthrough: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
m (Léo moved page USB HID Passthrough to USB Passthrough: To prepare for a future, more complete USB passthrough support. USB_HID will have its own section, since it's just a particular USB passthrough implementation.)
(→‎List of Wii Devices and IDs: add Speed Force Wireless)
(39 intermediate revisions by 9 users not shown)
Line 1: Line 1:
Since {{revision|4.0.2}}, Dolphin has the ability to passthrough USB HID devices designed for use with Wii software. This gives emulated Wii software full control of a hardware device connected to your PC.  This is very useful for devices not currently emulated by Dolphin and games that highly depend on extra hardware.
Since {{revision|4.0.2}}, Dolphin has the ability to passthrough USB HID devices designed for use with Wii software. {{revision|5.0-2352}} enables USB passthrough for all devices. This gives emulated Wii software full control of a hardware device connected to your PC.  This is very useful for devices not currently emulated by Dolphin and games that highly depend on extra hardware.
 
== List of Devices and IDs ==


== List of Wii Devices and IDs ==
{|class="wikitable sortable width=100%"
{|class="wikitable sortable width=100%"
! Device !! VID !! PID !! Compatibility
! Device !! VID !! PID !! Type !! Compatibility
|-
|-
|EA Active Dongle
|[[Disney Infinity]] Reader (Portal Device)
|?
|0E6F
|?
|0129
|Supported
| rowspan="2" | HID
| rowspan="17" | Supported
|-
|-
|EA Active NFL Training Camp Dongle
|[[:Category:Active Heart Rate Monitor (Input supported)|EA Active NFL Training Camp Dongle]]
|?
|21A4
|?
|AC40
|Supported
|-
|-
|Karaoke Joysound Wii Microphone
|[[:Category:USB Microphone (Input supported)|Logitech Vantage USB Microphone]]
|?
|?
|Not Supported
|-
|Logitech Vantage USB Microphone
|046D
|046D
|0A03
|0A03
|Not Supported
|OH0/VEN
|-
|-
|Rock Band 3 Guitar Dongle
|[[:Category:Speed Force Wireless (Input supported)|Logitech Speed Force Wireless]]
|046D
|C29C
|?
|?
|?
|-
|Supported
|Harmonix Guitar Controller for Nintendo Wii
| rowspan="7" | 1BAD
|0004
| rowspan="11" | HID
|-
|-
|Rock Band Drum Set
|Rock Band Drum Set
|?
|3110
|?
|-
|Supported
|Harmonix Drum Controller for Nintendo Wii
|3138
|-
|Harmonix RB3 Keyboard for Nintendo Wii
|3330
|-
|Harmonix RB3 MIDI Keyboard Interface for Nintendo Wii
|3338
|-
|Harmonix RB3 Mustang Guitar for Nintendo Wii
|3430
|-
|Harmonix RB3 MIDI Guitar Interface for Nintendo Wii
|3538
|-
|-
|Skylanders Giants Portal
|Skylanders Giants Portal
| rowspan="4" | 1430
| rowspan="4" | 1430
| rowspan="3" | 0150
| rowspan="3" | 0150
| Supported
|-
|-
|Skylanders Swap Force Portal
|Skylanders Swap Force Portal
| Supported
|-
|-
|Skylanders Wireless Receiver for Wii
|Skylanders Wireless Receiver for Wii
|?
|-
|-
|Tony Hawk Ride Skateboard
|[[:Category:Ride Controller (Input supported)|Tony Hawk Ride Skateboard]]
|0100
|0100
| Supported
|-
|-
|Ubisoft Motion Tracking Camera
|[[:Category:Wii Speak (Input supported)|Wii Speak Module]]
|?
| rowspan="3" | 057E
|?
|0308
|Not Supported
|OH0
|-
|-
|USB Microphone for Wii
|[[:Category:Ubisoft Camera (Input supported)|Ubisoft Camera]]
|?
|030A
|?
|VEN
|Not Supported
|-
|-
|Wii Speak Module
|Internal Bluetooth dongle
|057E
|0305
|0308
|OH1
|Not Supported
|See [[Bluetooth Passthrough]]
|-
|-
|}
|}


== Setting up ==
== Setting up ==
=== Linux ===
Linux support does not require any special drivers. However, a udev rule must be created to allow access to the devices.  Note, the Vendor ID and Product ID SHOULD be verified from the device itself before creating the rule.


== Linux ==
1. Paste the following into '''/etc/udev/rules.d/52-dolphin.rules''' (/lib/udev/rules.d/52-dolphin.rules if making a package). Do not forget to replace the XXXX with the appropriate Vendor and Product IDs.


Linux support does not require any special drivers. However, a udev rule must be created to allow access to the devices.  Note, the Vender ID and Product ID SHOULD be verified from the device itself before creating the rule.
<code>SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTRS{idVendor}=="XXXX", ATTRS{idProduct}=="XXXX", MODE="0666"</code>


Paste the following in the '''/etc/udev/rules.d/52-dolphin.rules''' file (/lib/udev/rules.d/52-dolphin.rules if making a package):
2. Reload udev rules with:
<code>sudo udevadm control --reload-rules</code>


<code>SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTRS{idVendor}=="XXXX", ATTRS{idProduct}=="XXXX", MODE="0666"</code>
3. Reinsert the accessory.


Replace the XXXX with the appropriate Vendor and Product IDs.
=== Windows ===


Reload udev rules with:
For users wishing to use the USB Microphone, USB Camera, or Wii Speak, it is highly recommended to use {{revision|5.0-10617}} or newer.  It contains important fixes to both libusb and Dolphin that fix crashes and fix support in devices across many games.
<code>sudo udevadm control --reload-rules</code>


Then reinsert the accessory. When the game is booted it should be able to access the accessory as if it were plugged into a Wii.
==== Install Dedicated Driver ====


If you want to change the rule, links for instructions are available on the [https://github.com/libusb/libusb/wiki/FAQ#Can_I_run_libusb_applications_on_Linux_without_root_privilege libusb FAQ].
===== Single Interface Devices =====


=== Windows ===
Download and open [http://zadig.akeo.ie/ Zadig], then:
Download and open [http://zadig.akeo.ie/ Zadig], then:


1. In the "Options" menu in Zadig, make sure "List All Devices" is enabled.
1. In the "Options" menu in Zadig, make sure "List All Devices" is enabled.


2. Look through the devices and find the devic
2. Look through the devices for the device to passthrough.


3. On the right column, select "WinUSB" then click "Replace Driver". Select "Yes" to modify the system driver.
3. On the right column, select "libusbk" then click "Replace Driver". Select "Yes" to modify the system driver.


The game will then be able to detect the device on next boot.
===== Multi Interface Devices =====
 
For Microphone, Wii Speak, and USB Camera Passthrough, installing over the composite parent device is required.
 
Download and open [http://zadig.akeo.ie/ Zadig], then:
 
1. In the "Options" menu in Zadig, make sure "List All Devices" is enabled and "Ignore Hubs or Composite Parents" is disabled.
 
2. Look through the composite parent of the device you wish to passthrough.
 
3. On the right column, select "libusbk" then click "Replace Driver". It may warn you that you're modifying a kernel driver, but, this is normal.  Select "Yes" to modify the kernel driver.
 
==== Uninstalling Dedicated Driver ====
 
If for some reason you wish to restore the default driver to the device, open up "Device Manager."  In the last, expand "libusbK devices" and find the device you wish to restore.  Uninstall the device, then unplug the device and plug it back in.  It will now be restored to its original state.
 
If you were using the WinUSB driver, the device will be located under "Universal Serial Bus Devices" instead, but the instructions are identical otherwise.
 
==== usbdk driver ====
 
usbdk is no longer supported nor recommended. While it provides the ability to simply install a driver without any further instructions, usbdk suffers severe instability issues.  For legacy purposes, you can still use the [https://github.com/daynix/UsbDk/releases x64 usbdk driver] in older builds.


=== macOS ===
=== macOS ===
Line 103: Line 131:
=== Android ===
=== Android ===
This feature is not supported on Android.
This feature is not supported on Android.
== Configuring Dolphin ==
In {{revision|5.0-2352}}, an additional step was added for USB Passthrough.  Because some devices being plugged into your computer can potentially hang or crash a game, you now must whitelist the emulated Wii so it can access this device.  This is not required for Bluetooth Passthrough.
=== Guide to Whitelist a USB Device in Dolphin ===
1. Open Dolphin's configuration dialog.
2. Click on the Wii tab.
3. In the "Whitelisted USB passthrough devices", click on the "Add..." button.
4. Select the device you wish to passthrough.
[[Category: Tutorials]]

Revision as of 04:03, 10 July 2022

Since 4.0.2, Dolphin has the ability to passthrough USB HID devices designed for use with Wii software. 5.0-2352 enables USB passthrough for all devices. This gives emulated Wii software full control of a hardware device connected to your PC. This is very useful for devices not currently emulated by Dolphin and games that highly depend on extra hardware.

List of Wii Devices and IDs

Device VID PID Type Compatibility
Disney Infinity Reader (Portal Device) 0E6F 0129 HID Supported
EA Active NFL Training Camp Dongle 21A4 AC40
Logitech Vantage USB Microphone 046D 0A03 OH0/VEN
Logitech Speed Force Wireless 046D C29C ?
Harmonix Guitar Controller for Nintendo Wii 1BAD 0004 HID
Rock Band Drum Set 3110
Harmonix Drum Controller for Nintendo Wii 3138
Harmonix RB3 Keyboard for Nintendo Wii 3330
Harmonix RB3 MIDI Keyboard Interface for Nintendo Wii 3338
Harmonix RB3 Mustang Guitar for Nintendo Wii 3430
Harmonix RB3 MIDI Guitar Interface for Nintendo Wii 3538
Skylanders Giants Portal 1430 0150
Skylanders Swap Force Portal
Skylanders Wireless Receiver for Wii
Tony Hawk Ride Skateboard 0100
Wii Speak Module 057E 0308 OH0
Ubisoft Camera 030A VEN
Internal Bluetooth dongle 0305 OH1 See Bluetooth Passthrough

Setting up

Linux

Linux support does not require any special drivers. However, a udev rule must be created to allow access to the devices. Note, the Vendor ID and Product ID SHOULD be verified from the device itself before creating the rule.

1. Paste the following into /etc/udev/rules.d/52-dolphin.rules (/lib/udev/rules.d/52-dolphin.rules if making a package). Do not forget to replace the XXXX with the appropriate Vendor and Product IDs.

SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTRS{idVendor}=="XXXX", ATTRS{idProduct}=="XXXX", MODE="0666"

2. Reload udev rules with: sudo udevadm control --reload-rules

3. Reinsert the accessory.

Windows

For users wishing to use the USB Microphone, USB Camera, or Wii Speak, it is highly recommended to use 5.0-10617 or newer. It contains important fixes to both libusb and Dolphin that fix crashes and fix support in devices across many games.

Install Dedicated Driver

Single Interface Devices

Download and open Zadig, then:

1. In the "Options" menu in Zadig, make sure "List All Devices" is enabled.

2. Look through the devices for the device to passthrough.

3. On the right column, select "libusbk" then click "Replace Driver". Select "Yes" to modify the system driver.

Multi Interface Devices

For Microphone, Wii Speak, and USB Camera Passthrough, installing over the composite parent device is required.

Download and open Zadig, then:

1. In the "Options" menu in Zadig, make sure "List All Devices" is enabled and "Ignore Hubs or Composite Parents" is disabled.

2. Look through the composite parent of the device you wish to passthrough.

3. On the right column, select "libusbk" then click "Replace Driver". It may warn you that you're modifying a kernel driver, but, this is normal. Select "Yes" to modify the kernel driver.

Uninstalling Dedicated Driver

If for some reason you wish to restore the default driver to the device, open up "Device Manager." In the last, expand "libusbK devices" and find the device you wish to restore. Uninstall the device, then unplug the device and plug it back in. It will now be restored to its original state.

If you were using the WinUSB driver, the device will be located under "Universal Serial Bus Devices" instead, but the instructions are identical otherwise.

usbdk driver

usbdk is no longer supported nor recommended. While it provides the ability to simply install a driver without any further instructions, usbdk suffers severe instability issues. For legacy purposes, you can still use the x64 usbdk driver in older builds.

macOS

While this can be done in macOS, there is currently no easy to use guide for it. A modified variant of the Native GameCube Adapter for Wii U guide should work, but what needs to be changed is not immediately apparent.

Android

This feature is not supported on Android.

Configuring Dolphin

In 5.0-2352, an additional step was added for USB Passthrough. Because some devices being plugged into your computer can potentially hang or crash a game, you now must whitelist the emulated Wii so it can access this device. This is not required for Bluetooth Passthrough.

Guide to Whitelist a USB Device in Dolphin

1. Open Dolphin's configuration dialog.

2. Click on the Wii tab.

3. In the "Whitelisted USB passthrough devices", click on the "Add..." button.

4. Select the device you wish to passthrough.