Commit d582f34eac5595dd0686a67def55e486818e252a

Con Kolivas 2014-02-07T14:50:11

Document new features for antminer U1 and hfa devices.

diff --git a/ASIC-README b/ASIC-README
index b146b6f..0da4336 100644
--- a/ASIC-README
+++ b/ASIC-README
@@ -144,6 +144,7 @@ sudo kextunload -b com.apple.driver.AppleUSBCDCACMData
 
 ASIC SPECIFIC COMMANDS
 
+--anu-freq <arg>    Set AntminerU1 frequency in hex, range 150-500 (default: 200)
 --avalon-auto       Adjust avalon overclock frequency dynamically for best hashrate
 --avalon-cutoff <arg> Set avalon overheat cut off temperature (default: 60)
 --avalon-fan <arg> Set fanspeed percentage for avalon, single value or range (default: 20-100)
@@ -157,10 +158,25 @@ ASIC SPECIFIC COMMANDS
 --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)
+--hfa-fan <arg>     Set fanspeed percentage for hashfast, single value or range (default: 10-85)
+--hfa-temp-overheat <arg> Set the hashfast overheat throttling temperature (default: 95)
+--hfa-temp-target <arg> Set the hashfast target temperature (0 to disable) (default: 88)
 --klondike-options <arg> Set klondike options clock:temptarget
 
 
+ANTMINER U1 DEVICES
+
+--anu-freq <arg>    Set AntminerU1 frequency in hex, range 150-500 (default: 200)
+
+By default, Antminer U1 devices run at a clockspeed of 200. This command allows
+you to specify a chosen frequency to attempt to run all ANU devices at and the
+value must be in increments of 25. Note that cgminer reports hashrate ONLY
+FROM VALID HASHES so if you increase the frequency but your hashrate does not
+increase or it decreases and hardware errors start showing up, you have
+overclocked it too much. In the worst case scenario it will fail to start at
+too high a speed.
+
+
 AVALON AND BITBURNER DEVICES
 
 Currently all known Avalon devices come with their own operating system and
@@ -406,13 +422,31 @@ 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)
+--hfa-fan <arg>     Set fanspeed percentage for hashfast, single value or range (default: 10-85)
+
+This changes the range of fanspeeds used on hashfast devices with firmware that
+supports it. Note that the fanspeed will dynamically change to try and maintain
+a target temperature with --hfa-temp-target but if the target temperature is
+disabled, the fanspeed will remain static.
+eg:
+--hfa-fan 25-100
+
+--hfa-temp-overheat <arg> Set the hashfast overheat throttling temperature (default: 95)
 
 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.
 
+--hfa-temp-target <arg> Set the hashfast target temperature (0 to disable) (default: 88)
+
+On hashfast devices with firmware that supports dynamic fanspeed and die speeds,
+cgminer will try to maintain temperature according to this target by adjusting
+fanspeed and then if need be, throttle speeds on a die-by-die basis. Disabling
+this feature will leave a constant fanspeed and die speed but will not disable
+the temp-overheat feature.
+
+
 Other undocumented hashfast command line options are for development purposes
 only at this stage and serve no useful purpose to end users.
 
diff --git a/README b/README
index 47909b4..d5cc977 100644
--- a/README
+++ b/README
@@ -138,65 +138,81 @@ Usage instructions:  Run "cgminer --help" to see options:
 Usage: cgminer [-DdElmpPQqUsTouOchnV]
 
 Options for both config file and command line:
---api-allow         Allow API access (if enabled) only to the given list of [W:]IP[/Prefix] address[/subnets]
-                    This overrides --api-network and you must specify 127.0.0.1 if it is required
-                    W: in front of the IP address gives that address privileged access to all api commands
---api-description   Description placed in the API status header (default: cgminer version)
---api-groups        API one letter groups G:cmd:cmd[,P:cmd:*...]
-                    See API-README for usage
---api-listen        Listen for API requests (default: disabled)
-                    By default any command that does not just display data returns access denied
-                    See --api-allow to overcome this
---api-network       Allow API (if enabled) to listen on/for any address (default: only 127.0.0.1)
---api-mcast         Enable API Multicast listener, (default: disabled)
-                    The listener will only run if the API is also enabled
---api-mcast-addr <arg> API Multicast listen address, (default: 224.0.0.75)
---api-mcast-code <arg> Code expected in the API Multicast message, don't use '-' (default: "FTW")
---api-mcast-port <arg> API Multicast listen port, (default: 4028)
---api-port          Port number of miner API (default: 4028)
+--anu-freq <arg>    Set AntminerU1 frequency in hex, range 150-500 (default: 200)
+--api-allow <arg>   Allow API access only to the given list of [G:]IP[/Prefix] addresses[/subnets]
+--api-description <arg> Description placed in the API status header, default: cgminer version
+--api-groups <arg>  API one letter groups G:cmd:cmd[,P:cmd:*...] defining the cmds a groups can use
+--api-listen        Enable API, default: disabled
+--api-mcast         Enable API Multicast listener, default: disabled
+--api-mcast-addr <arg> API Multicast listen address
+--api-mcast-code <arg> Code expected in the API Multicast message, don't use '-'
+--api-mcast-des <arg> Description appended to the API Multicast reply, default: ''
+--api-mcast-port <arg> API Multicast listen port (default: 4028)
+--api-network       Allow API (if enabled) to listen on/for any address, default: only 127.0.0.1
+--api-port <arg>    Port number of miner API (default: 4028)
+--avalon-auto       Adjust avalon overclock frequency dynamically for best hashrate
+--avalon-cutoff <arg> Set avalon overheat cut off temperature (default: 60)
+--avalon-fan <arg>  Set fanspeed percentage for avalon, single value or range (default: 20-100)
+--avalon-freq <arg> Set frequency range for avalon-auto, single value or range
+--avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq:tech
+--avalon-temp <arg> Set avalon target temperature (default: 50)
 --balance           Change multipool strategy from failover to even share balance
 --benchmark         Run cgminer in benchmark mode - produces no shares
+--bfl-range         Use nonce range on bitforce devices if supported
+--bflsc-overheat <arg> Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 85)
+--bitburner-voltage <arg> Set BitBurner (Avalon) core voltage, in millivolts
+--bitburner-fury-voltage <arg> Set BitBurner Fury core voltage, in millivolts
+--bitburner-fury-options <arg> Override avalon-options for BitBurner Fury boards baud:miners:asic:timeout:freq
+--bxf-temp-target <arg> Set target temperature for BXF devices (default: 82)
 --compact           Use compact display without per device statistics
 --debug|-D          Enable debug output
 --device|-d <arg>   Select device to use, one value, range and/or comma separated (e.g. 0-2,4) default: all
 --disable-rejecting Automatically disable pools that continually reject shares
+--drillbit-options <arg> Set drillbit options <int|ext>:clock[:clock_divider][:voltage]
 --expiry|-E <arg>   Upper bound on how many seconds after getting work we consider a share from it stale (default: 120)
 --failover-only     Don't leak work to backup pools when primary pool is lagging
 --fix-protocol      Do not redirect to a different getwork protocol (eg. stratum)
---hotplug <arg>     Set hotplug check time to <arg> seconds (0=never default: 5) - only with libusb
---kernel-path|-K <arg> Specify a path to where bitstream files are (default: "/usr/local/bin")
+--hotplug <arg>     Seconds between hotplug checks (0 means never check)
+--klondike-options <arg> Set klondike options clock:temptarget
 --load-balance      Change multipool strategy from failover to quota based balance
 --log|-l <arg>      Interval in seconds between log output (default: 5)
 --lowmem            Minimise caching of shares for low memory applications
 --monitor|-m <arg>  Use custom pipe cmd for output messages
+--nfu-bits <arg>    Set nanofury bits for overclocking, range 32-63 (default: 50)
 --net-delay         Impose small delays in networking to not overload slow routers
 --no-submit-stale   Don't submit shares if they are detected as stale
 --pass|-p <arg>     Password for bitcoin JSON-RPC server
 --per-device-stats  Force verbose mode and output per-device statistics
 --protocol-dump|-P  Verbose dump of protocol-level activities
---queue|-Q <arg>    Minimum number of work items to have queued (0 - 10) (default: 1)
+--queue|-Q <arg>    Minimum number of work items to have queued (0+) (default: 1)
 --quiet|-q          Disable logging output, display status and errors
+--quota|-U <arg>    quota;URL combination for server with load-balance strategy quotas
 --real-quiet        Disable all output
 --remove-disabled   Remove disabled devices entirely, as if they didn't exist
 --rotate <arg>      Change multipool strategy from failover to regularly rotate at N minutes (default: 0)
 --round-robin       Change multipool strategy from failover to round robin on failure
---scan-time|-s <arg> Upper bound on time spent scanning current work, in seconds (default: 60)
+--scan-time|-s <arg> Upper bound on time spent scanning current work, in seconds (default: -1)
 --sched-start <arg> Set a time of day in HH:MM to start mining (a once off without a stop time)
 --sched-stop <arg>  Set a time of day in HH:MM to stop mining (will quit without a start time)
 --sharelog <arg>    Append share log to file
 --shares <arg>      Quit after mining N shares (default: unlimited)
---socks-proxy <arg> Set socks4 proxy (host:port) for all pools without a proxy specified
+--socks-proxy <arg> Set socks4 proxy (host:port)
 --syslog            Use system log for output messages (default: standard error)
 --temp-cutoff <arg> Temperature where a device will be automatically disabled, one value or comma separated list (default: 95)
 --text-only|-T      Disable ncurses formatted screen output
 --url|-o <arg>      URL for bitcoin JSON-RPC server
+--usb <arg>         USB device selection
 --user|-u <arg>     Username for bitcoin JSON-RPC server
---verbose           Log verbose output to stderr as well as status output
 --userpass|-O <arg> Username:Password pair for bitcoin JSON-RPC server
+--verbose           Log verbose output to stderr as well as status output
+--worktime          Display extra work time debug information
 Options for command line only:
 --config|-c <arg>   Load a JSON-format configuration file
 See example.conf for an example configuration.
+--default-config <arg> Specify the filename of the default config file
+Loaded at start and used when saving without a name.
 --help|-h           Print this message
+--ndevs|-n          Display all USB devices and exit
 --version|-V        Display version and exit
 
 
@@ -212,10 +228,11 @@ See FGPA-README or ASIC-README for more information regarding these.
 
 ASIC only options:
 
+--anu-freq <arg>    Set AntminerU1 frequency in hex, range 150-500 (default: 200)
 --avalon-auto       Adjust avalon overclock frequency dynamically for best hashrate
+--avalon-cutoff <arg> Set avalon overheat cut off temperature (default: 60)
 --avalon-fan <arg> Set fanspeed percentage for avalon, single value or range (default: 20-100)
 --avalon-freq <arg> Set frequency range for avalon-auto, single value or range
---avalon-cutoff <arg> Set avalon overheat cut off temperature (default: 60)
 --avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq:tech
 --avalon-temp <arg> Set avalon target temperature (default: 50)
 --bab-options <arg> Set BaB options max:def:min:up:down:hz:delay:trf
@@ -223,7 +240,11 @@ ASIC only options:
 --bitburner-fury-options <arg> Override avalon-options for BitBurner Fury boards baud:miners:asic:timeout:freq
 --bitburner-fury-voltage <arg> Set BitBurner Fury core voltage, in millivolts
 --bitburner-voltage <arg> Set BitBurner (Avalon) core voltage, in millivolts
---drillbit-options <arg> Set drillbit options <int|ext>:clock[:clock_divider][:voltage]
+--bxf-temp-target <arg> Set target temperature for BXF devices (default: 82)
+--hfa-hash-clock <arg> Set hashfast clock speed (default: 550)
+--hfa-fan <arg>     Set fanspeed percentage for hashfast, single value or range (default: 10-85)
+--hfa-temp-overheat <arg> Set the hashfast overheat throttling temperature (default: 95)
+--hfa-temp-target <arg> Set the hashfast target temperature (0 to disable) (default: 88)
 --klondike-options <arg> Set klondike options clock:temptarget
 
 See ASIC-README for more information regarding these.