Differences

This shows you the differences between two versions of the page.

--- manual:demos:usb_driver_install [2014/05/27 09:48]
voorburg [USB driver VID/PID]
+++ manual:demos:usb_driver_install [2023/06/27 10:02] (current)
voorburg
@@ Line 1: / Line 1: @@
 ====== OpenBLT USB Driver Installation Instructions ======
-Upon first connection to your PC's USB port, Windows will prompt you to install the USB driver for the OpenBLT/USB bootloader device. This page contains step-by-step instructions for the USB driver installation and additional background information regarding the USB driver.
+This page contains step-by-step instructions for the USB driver installation and additional background information regarding the USB driver.
-===== Step-by-step Installation =====
+===== USB Driver Installation on Windows =====
-The following illustrates the driver installation in Windows XP. The procedure on Windows Vista and 7 is quite similar.
-When prompted by Windows to install the driver, hit cancel and go to the Device Manager instead. Right-click the entry "**WinUSB Bulk Device**" and select "**Update Driver...**" from the popup menu:
+----
+**New**: Starting with OpenBLT version 1.16, you no longer need to install the USB driver. This applies to all demo programs that are configured to support firmware updates via USB. Therefore, you can skip the information in this section.
+Here's how it works: During USB enumeration, a Microsoft 2.0 descriptor set is now sent to the PC, which automatically enters the WinUSB Device Interface GUID into the registry and links it to OpenBLT's VID/PID.
+----
-{{:manual:demos:dev_mngr_update_driver.gif?|}}
+Before installing the USB driver, make sure the USB device that runs the OpenBLT USB bootloader is not connected to your PC. If a prior version of the USB driver was installed, it is recommended to first uninstall this driver.
-By default, Windows want to search for the driver online, which can be a length process and it won't find it anyways. Instead, select "**No, not this time**" and click "**Next >**":
+The installation of the USB driver is performed using the Zadig tool. You can download the necessary files here: {{:manual:openblt_usb_driver.zip?linkonly|OpenBLT USB Driver Package}}. After downloading the OpenBLT USB Driver Package, unzip the archive to **c:\openblt_usb_driver\** and start the program **zadig_2.2.exe**. Note that users reported issues with the USB driver, if they used a different directory to unzip to, so make sure to use the c:\openblt_usb_driver\ directory.
-{{:manual:demos:update_driver_not_online.gif?|}}
+From the program menu, select **Device -> Load Preset Device** and select the file **openblt.cfg**, which is found in the same directory as where **zadig_2.2.exe** is located. Next, click the **Install Driver** button to install the USB driver for the OpenBLT bootloader:
-On the next screen, select "**Install from a list or specific location (Advanced)**" and click "**Next >**":
+{{:manual:openblt_usb_driver_install.png?|}}
-{{:manual:demos:update_driver_specific_location.gif?|}}
+After successfully completion of the USB driver installation, you can plug in the USB device that runs the OpenBLT USB bootloader. Windows will automatically detect the USB device and map it to the newly installed USB driver. You can verify the correct USB driver installation and USB device detection using the Device Manager in Windows. You should see an entry for **WinUSB Bulk Device**, without a yellow exclamation mark in the icon:
-Select "**Include this location in the search:**", browse and select the folder "**<OpenBLT path>\Host\Drivers\USB**" and click "**Next >**":
+{{:manual:openblt_usb_device_manager.png?|}}
-{{:manual:demos:update_driver_select_folder.gif?|}}
-Windows now installs the driver. When ready, the following screen is presented. Click "**Finish**" to conclude the driver installation.
+==== Troubleshooting ====
-{{:manual:demos:update_driver_finish.gif?|}}
+If for some reason, the USB driver installation fails and the **WinUSB Bulk Device** still shows up with a yellow exclamation mark in the Device Manager, try the following:
-===== Windows Compatibility =====
+  - Right-click the **WinUSB Bulk Device** entry in the Windows Device Manager and select "Uninstall Device" from the pop-up menu. If the confirmation dialog offers a checkbox to also uninstall the driver, go ahead and check that one as well.
+  - Unplug the USB device and then plug it back into your PC. Attempt the USB driver installation again, if it does not yet support the automatic WinUSB driver install (OpenBLT >= 1.16).
-The USB driver makes use of the WinUSB user mode driver. Support for WinUSB is available in versions starting with Windows XP. The USB driver for OpenBLT is configured to run on Windows Vista, 7 and 8. Both 32- and 64-bit operating system versions are supported.
+If it still doesn't work, repeat steps one and two, but before moving on to step two, do this:
+  * Using the Window Registry Editor, locate the key: ''HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\usbflags\'' and remove all entries that start with OpenBLT's VID/PID: ''1D5060AC''.
+  * Using the Window Registry Editor, locate the key: ''HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\'' and remove the OpenBLT VID/PID entry: ''VID_1D50&PID_60AC''.
-===== USB driver VID/PID =====
-Note that the USB driver's vendor ID (VID) and product ID (PID) are randomly selected and meant for demonstration purposes only. When using OpenBLT/USB in a product, please be so kind and obtain your own VID and PID from [[http://www.usb.org/developers/vendor/]]. Once obtained, you can modify the USB driver's VID and PID by editing the file ".\Host\Drivers\USB\WinUSB_Bulk_Device.inf":
-<code>
+==== Windows Compatibility ====
-; Modify VID_0145 to change the Vendor ID and modify PID_0023 to change the Product ID
-[MyDevice_WinUSB.NTx86]
-%USB\MyDevice.DeviceDesc% =USB_Install, USB\VID_0145&PID_0023
-[MyDevice_WinUSB.NTamd64]
+The USB driver makes use of the WinUSB user mode driver. Support for WinUSB is available in versions starting with Windows XP. The USB driver for OpenBLT is configured to run on Windows Vista, 7, 8 and 10. Both 32- and 64-bit operating system versions are supported.
-%USB\MyDevice.DeviceDesc% =USB_Install, USB\VID_0145&PID_0023
-</code>
+===== USB Driver Installation on Linux =====
+On Linux, all that has to be done is install the libusb-1.0 package. Example for Ubuntu based distributions:
+<code>sudo apt-get install libusb-1.0-0</code>
+To verify that the OpenBLT USB device is recognized by the system, run the following command:
+<code>lsusb</code>
+{{:manual:demos:openblt_usb_device_linux.png?nolink&|}}
+Typically only the super user has access to the OpenBLT USB device. To give all users access, create the following UDEV rules file and store it in **/etc/udev/rules.d/60-openblt.rules**. After a re-boot all users will have access:
+<code>ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="1d50", ATTR{idProduct}=="60ac", MODE="0666"</code>
+===== USB driver VID/PID =====
+Note that the USB driver's vendor ID $1D50 (VID) and product ID $60AC (PID) are officially registered as can be seen on the following website: http://wiki.openmoko.org/wiki/USB_Product_IDs.

OpenBLT Bootloader

User Tools

Site Tools

Differences

Page Tools