Add hashfast documentation to ASIC README
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
diff --git a/ASIC-README b/ASIC-README
index 923a0fb..fa2d60b 100644
--- a/ASIC-README
+++ b/ASIC-README
@@ -54,6 +54,18 @@ Nanofury devices come up as NF1.
Bitfury USB devices are also set up as per the USB ASICs below.
+HASHFAST devices
+
+Hashfast devices need the --enable-hashfast option when compiling cgminer.
+
+All current HFA devices are supported and are recognised with the name HFA
+in the --usb commands. After initialisation, cgminer will determine what type
+they are and give them the following names:
+
+HFB: Hashfast Babyjet
+HFS: Hashfast Sierra
+HFA: Hashfast non standard (eg. a Babyjet with an added board)
+
---
GETTING STARTED WITH USB ASICS
@@ -135,6 +147,8 @@ ASIC SPECIFIC COMMANDS
--bitburner-fury-voltage <arg> Set BitBurner Fury core voltage, in millivolts
--bitburner-voltage <arg> Set BitBurner (Avalon) core voltage, in millivolts
--bxf-temp-target <arg> Set target temperature for BXF devices (default: 82)
+--hfa-hash-clock <arg> Set hashfast clock speed (default: 550)
+--hfa-temp-overheat <arg> Set the hashfast overheat throttling temperature (default: 85)
--klondike-options <arg> Set klondike options clock:temptarget
@@ -373,6 +387,26 @@ Delay is the us delay used between bytes for the SPI I/O - default 0
Trf is the us delay used between sends for the SPI I/O - default 0
+
+Hashfast devices
+
+--hfa-hash-clock <arg> Set hashfast clock speed (default: 550)
+
+This will change the initialisation clock speed on all attached hfa devices.
+Note that if instability is detected by cgminer and the device has to undergo
+a reset, cgminer will lower the clockspeed on resetting it each time till the
+value returns to the default of 550.
+
+--hfa-temp-overheat <arg> Set the hashfast overheat throttling temperature (default: 85)
+
+Cgminer will temporarily stop sending hashfast devices work once this
+temperature is reached. Note that with the water cooling in these devices,
+temperature recovery is likely to be very quick and the device will start
+hashing again after only a very brief period.
+
+Other undocumented hashfast command line options are for development purposes
+only at this stage and serve no useful purpose to end users.
+
---
This code is provided entirely free of charge by the programmer in his spare