Commit 5d86a4a0716e8ebe252789796f02d1810364434c

Con Kolivas 2013-11-16T14:55:26

Add more verbose documentation to the readme files for windows users.

diff --git a/ASIC-README b/ASIC-README
index bf83045..a535c2b 100644
--- a/ASIC-README
+++ b/ASIC-README
@@ -3,8 +3,8 @@ SUPPORTED DEVICES
 Currently supported devices include the Avalon (including BitBurner and
 Klondike), the Butterfly Labs SC range of devices, the ASICMINER block
 erupters, the BF1 (bitfury) USB (red and blue) devices, KnCminer Mercury,
-Saturn and Jupiter devices, BlackArrow Bitfury devices and upcoming
-Hashfast devices.
+Saturn and Jupiter devices, BlackArrow Bitfury devices, Bi*fury USB devices
+and upcoming Hashfast devices.
 
 No COM ports on windows or TTY devices will be used by cgminer as it
 communicates directly with them via USB so it is normal for them to not exist or
@@ -32,7 +32,7 @@ ASICMINER block erupters will come up as AMU.
 ASICMINER devices need the --enable-icarus option when compiling cgminer.
 Also note that the AMU is managed by the Icarus driver which is detailed
 in the FPGA-README. Configuring them uses the same mechanism as outlined
-below for getting started with butterfly labs ASICs.
+below for getting started with USB ASICs.
 
 
 BlackArrow Bitfury devices
@@ -47,13 +47,14 @@ BITFURY devices
 
 Bitfury devices need the --enable-bitfury option when compiling cgminer.
 
-Currently only the BPMC BF1 devices AKA redfury/bluefury are supported and
-come up as BF1. There are no options available for them. Bitfury device are
-also set up as per the butterfly labs ASICs below.
+Currently the BPMC/BGMC BF1 devices AKA redfury/bluefury are supported and
+come up as BF1, along with the Bi*fury USB devices which come up as BXF.
+There are no options available for them. Bitfury USB devices are also set up
+as per the USB ASICs below.
 
 
-
-GETTING STARTED WITH BUTTERFLY LABS ASICS
+---
+GETTING STARTED WITH USB ASICS
 
 Unlike other software, cgminer uses direct USB communication instead of the
 ancient serial USB communication to be much faster, more reliable and use a
@@ -64,9 +65,13 @@ devices requires different drivers.
 WINDOWS:
 
 On windows, the direct USB support requires the installation of a WinUSB
-driver (NOT the ftdi_sio driver), and attach it to the Butterfly labs device.
-The easiest way to do this is to use the zadig utility which will install the
-drivers for you and then once you plug in your device you can choose the
+driver (NOT the ftdi_sio driver), and attach it to the chosen USB device.
+When configuring your device, plug it in and wait for windows to attempt to
+install a driver on its own. It may think it has succeeded or failed but wait
+for it to finish regardless. This is NOT the driver you want installed. At this
+point you need to associate your device with the WinUSB driver. The easiest
+way to do this is to use the zadig utility which you must right click on and
+run as administrator. Then once you plug in your device you can choose the
 "list all devices" from the "option" menu and you should be able to see the
 device as something like: "BitFORCE SHA256 SC". Choose the install or replace
 driver option and select WinUSB. You can either google for zadig or download
@@ -103,6 +108,18 @@ After this you can either manually restart udev and re-login, or more easily
 just reboot.
 
 
+OSX:
+
+On OSX, like Linux, no drivers need to be installed. However some devices
+like the bitfury USB sticks automatically load a driver thinking they're a
+modem and the driver needs to be unloaded for cgminer to work:
+
+sudo kextunload -b com.apple.driver.AppleUSBCDC
+sudo kextunload -b com.apple.driver.AppleUSBCDCACMData
+
+
+---
+
 ASIC SPECIFIC COMMANDS
 
 --avalon-auto       Adjust avalon overclock frequency dynamically for best hashrate
diff --git a/README b/README
index 43d0f86..cf2420e 100644
--- a/README
+++ b/README
@@ -235,7 +235,8 @@ See FGPA-README for more information regarding this.
 
 Cgminer should automatically find all of your Avalon ASIC, BFL ASIC, BitForce
 FPGAs, Icarus bitstream FPGAs, Klondike ASIC, ASICMINER usb block erupters,
-KnC ASICs, BaB ASICs, Hashfast ASICs and ModMiner FPGAs.
+KnC ASICs, BaB ASICs, Hashfast ASICs, ModMiner FPGAs, BPMC/BGMC BF1 USB ASICs
+and Bi*fury USB ASICs.
 
 ---
 
@@ -244,14 +245,24 @@ SETTING UP USB DEVICES
 WINDOWS:
 
 On windows, the direct USB support requires the installation of a WinUSB
-driver (NOT the ftdi_sio driver), and attach it to your devices.
-The easiest way to do this is to use the zadig utility which will install the
-drivers for you and then once you plug in your device you can choose the
+driver (NOT the ftdi_sio driver), and attach it to the chosen USB device.
+When configuring your device, plug it in and wait for windows to attempt to
+install a driver on its own. It may think it has succeeded or failed but wait
+for it to finish regardless. This is NOT the driver you want installed. At this
+point you need to associate your device with the WinUSB driver. The easiest
+way to do this is to use the zadig utility which you must right click on and
+run as administrator. Then once you plug in your device you can choose the
 "list all devices" from the "option" menu and you should be able to see the
 device as something like: "BitFORCE SHA256 SC". Choose the install or replace
 driver option and select WinUSB. You can either google for zadig or download
 it from the cgminer directory in the DOWNLOADS link above.
 
+When you first switch a device over to WinUSB with zadig and it shows that
+correctly on the left of the zadig window, but it still gives permission
+errors, you may need to unplug the USB miner and then plug it back in. Some
+users may need to reboot at this point.
+
+
 LINUX:
 
 On linux, the direct USB support requires no drivers at all. However due to
@@ -276,6 +287,7 @@ directory with the following command:
 After this you can either manually restart udev and re-login, or more easily
 just reboot.
 
+
 OSX:
 
 On OSX, like Linux, no drivers need to be installed. However some devices