v0.10.10 release.

README.md

@@ -1,4 +1,4 @@
-# teamredminer v0.10.9
+# teamredminer v0.10.10
 This is an optimized miner for AMD GPUs and Xilinx FPGAs created by todxx and kerney666.
 
 **Download is available in the [github releases section](https://github.com/todxx/teamredminer/releases).**
@@ -41,6 +41,7 @@ Supported GPU algorithms and their respective dev fees:
 | Autolykos2                | 2.0% |
 | Ton                       | 1.0% |
 | Kaspa                     | 1.0% |
+| Ironfish                  | 1.0% |
 | Nimiq                     | 2.5% |
 | Cryptonight R             | 2.5% |
 | Cryptonight v8 upx2       | 2.5% |
@@ -77,6 +78,7 @@ Some algorithms are not supported on some GPU architectures and/or drivers.  Bel
 | Firopow                  |   N    |  Y   |  Y   |   Y     |   Y  |   Y   |
 | Ton                      |   N    |  Y   |  Y   |   Y     |   Y  |   Y   |
 | Kaspa                    |   Y    |  Y   |  Y   |   Y     |   Y  |   Y   |
+| Ironfish                 |   Y    |  Y   |  Y   |   Y     |   Y  |   Y   |
 | Nimiq                    |   N    |  Y   |  Y   |   Y     |   Y  |   N   |
 | Cryptonight R            |   N    |  N   |  L   |   L     |   L  |   N   |
 | Cryptonight v8 upx2      |   N    |  N   |  L   |   L     |   L  |   N   |
@@ -114,10 +116,10 @@ FPGA Devices supported and tested in Linux (Windows is not currently supported):
 - SQRL Forest Kitten 33 - performance limited by product design, see guide for details
 - Xilinx/TUL/Osprey U50C/ECU50
 - TUL TH53/55
-- Osprey E300 (vu33p, vu33p_CIV, vu35p, vu35p_CIV, vu9p)
+- Osprey E300 (vu33p, vu33p_CIV, vu35p, vu35p_CIV, vu9p, vu13p)
 - Bittware CVP13
 - SQRL BCU1525/TUL BTU9P/Osprey ECU200/Aleo U200/VCU1525
-- SQRL JC33 and JC35 on JCC2L carriers
+- SQRL JC33, JC35, JC13 on JCC2L/F carriers
 
 Supported FPGA algorithms and their respective dev fees:
 
@@ -139,7 +141,7 @@ FPGA device/algo compatibility table:
 | E300 (others)               |   N    |   Y   |
 | CVP13                       |   N    |   Y   |
 | BCU1525/BTU9P/ECU200/U200   |   N    |   Y   |
-| JC33/JC35 on JCC2L          |   N    |   Y   |
+| JC33/JC35/JC13 on JCC2L/F   |   N    |   Y   |
 
 
 -----------
@@ -155,6 +157,16 @@ For example command lines please see the batch/shell scripts in the miner downlo
 For command line options see the [USAGE.txt](USAGE.txt) file that comes with the miner.
 
 ## Release Notes
+### v0.10.10
+#### Changes
+- GPU:  Added support for ironfish (-a ironfish, only the fast stratum protocol v2 supported).
+- GPU:  Dual mining support for ironfish with ERG and ethash (use --iron ... --iron_end).
+- GPU:  Addressed sluggish and lagging display with KAS solo mining (and ironfish).
+- GPU:  Added support for the ZIL ZMP protocol. Use zil:// in --zil .. --zil_end or normal pool configs.
+- GPU:  Added event script for calling external scripts on e.g. algo switching, see --event_script.
+- GPU:  Added support for switching between separate clocks/voltages on windows for zil switching.
+- FPGA: Added support for JC13s and JCC2F carriers.
+- FPGA: Added support for vu13ps on E300 boards.
 
 ### v0.10.9
 #### Changes

USAGE.txt

@@ -1,4 +1,4 @@
-          Team Red Miner version 0.10.9
+          Team Red Miner version 0.10.10
 Usage: teamredminer [OPTIONS]
 Options:
   -a, --algo=ALGORITHM      Selects the mining algorithm.  Currently available:
@@ -11,6 +11,7 @@ Options:
                               verthash          (vtc)
                               ton               (ton)
                               kas               (kaspa)
+                              ironfish          (ironfish)
                               nimiq             (nimiq)
                               lyra2z      
                               phi2              (lux, argoneum)
@@ -130,9 +131,15 @@ Options:
                               does not support sdma and needs --gpu_sdma=off. If you experience hangs directly at gpu
                               initialization, but other miners or older TRM versions work fine, try --gpu_sdma=off.
                               This setting is an environment setting and controls all gpus.
+      --event_script=X      Configures an event script that is executed on certain events taking place during miner execution.
+                              The script will be provided one or more arguments with the event name and possibly more data
+                              related to the event.  See the guide TRM_EVENT_SCRIPT.txt in the miner package for information
+                              on available events.  The provided parameter should be a path to an executable script, either an
+                              absolute path or relative to the miner working directory.
 
 Pool config options:
-  -o, --url=URL             Sets the pool URL.  Currently stratum+tcp and stratum+ssl URLs are supported.
+  -o, --url=URL             Sets the pool URL.  Currently stratum+tcp and stratum+ssl URLs are supported
+                              for normal pools.  For the ZIL ZMP protocol, use zmp, zmp+ssl, or zmp+tcp.
                               Each additional time this option is specified will start a new pool config.
                               Per-pool options (such as -u, -p) will need to be explicitly specified
                               again for each new pool.  (See the example start_multipool.sh/bat file)
@@ -667,6 +674,15 @@ Ethash dual mining options:
                               algo.  This argument isn't strictly necessary, but should be included for mining distros since
                               the user has no guarantee what arguments will be added automatically at the end of the command
                               line by the distro.
+      --iron_start or --iron Starts the Ironfish dual mining config.  Between this and the --iron_end marker, all arguments are
+                              applied to the Ironfish mining rather than the primary algo, typically ethash.  It's expected that
+                              ethash has been set up in earlier arguments.  The intention is that you can add a --iron ... 
+                              --iron_end configuration to any working TRM configuration algo and things will work out of the box.
+
+      --iron_end            Marks that we're done with the Ironfish mining config and all following arguments are for the primary
+                              algo.  This argument isn't strictly necessary, but should be included for mining distros since
+                              the user has no guarantee what arguments will be added automatically at the end of the command
+                              line by the distro.
       --dual_intensity=X,Y,Z,... This argument adjusts the intensity of the dual mining with a factor between 0.0 and 1.0, where 1.0
                               means running as much dual algo as possible.  This option is recommended for forcing down power draw
                               without lowering core clk, which will have an impact on the ethash hashrate as well. 
@@ -685,14 +701,14 @@ Ethash dual mining options:
                               and added, but as network hashrates and market prices move, new values may need to be provided. 
                               This argument provides three values, all expected to be positive numbers:
                                 X    Score for 1 MH/s of the primary algo (typically ethash). 
-                                Y    Score for 1 MH/s of the secondary algo (typically TON or Kaspa). 
+                                Y    Score for 1 MH/s of the secondary algo (typically TON/Kaspa/Ironfish). 
                                 Z    Cost per 1 W of measured power. We recommend setting this to zero for now. 
                               Example for ETH+TON: 
 
-                                Based on manual relative value: each MH/s of ETH is worth 100 MH/s of TON/Kaspa
+                                Based on manual relative value: each MH/s of ETH is worth 100 MH/s of TON/Kaspa/Ironfish
                                 --dual_tuner_weights=100:1:0
 
-                                Based on mining calculators: $0.0437 for 1 MH/s ETH, $0.0005476 for 1 MH/s TON/Kaspa
+                                Based on mining calculators: $0.0437 for 1 MH/s ETH, $0.0005476 for 1 MH/s TON/Kaspa/Ironfish
                                 --dual_tuner_weights=0.0437:0.0005476:0
 
 FPGA Options: 

doc/DUAL_ERGO_MINING.txt

@@ -1,11 +1,17 @@
 Team Red Miner Dual Coin ERGO Mining
 ====================================
 
+2023-04-19 Updated with ironfish info.
 2023-01-27 Updated with short note about triple mining with zil.
 2022-12-22 Initial version
 
 Overview
 --------
+Supported algos are kaspa and ironfish. To mine ironfish instead of
+kaspa, replace all --kas and --kas_end with --iron and --iron_end
+below. The guide itself is not updated after the initial version
+describing ERG+KAS.
+
 To mine using autolykos2+kaspa (which is the only supported dual
 algo), take a working TRM autolykos2 command line and add a KAS
 section in the middle or at the end:

doc/DUAL_ETH_MINING.txt

@@ -1,11 +1,17 @@
 Team Red Miner Dual Coin ETH Mining
 ===================================
 
+2023-04-19 Updated with ironfish info.
 2023-01-27 Updated with short note about triple mining with zil.
 2022-10-16 Updated for Kaspa dual mining.
 
 TL;DR
 -----
+Supported algos are kaspa and ironfish. To mine ironfish instead of
+kaspa, replace all --kas and --kas_end with --iron and --iron_end
+below. The guide itself is not updated after the initial version
+describing ETH+KAS.
+
 To mine Ethash+Kaspa (or TON, which is a dead algo at the time of writing),
 take a working TRM ethash command line and add a KAS section in the
 middle or at the end:

doc/DUAL_ZIL_MINING.txt

@@ -2,6 +2,7 @@ Team Red Miner Dual ZIL Mining
 ==============================
 
 
+2023-04-04 Added note regarding automatic clock switching on Windows.
 2023-01-27 Added short note around triple mining setups.
 2022-08-03 Updated with --zil ... --zil_end mechanism.
 2021-05-13 Initial version.
@@ -12,6 +13,13 @@ together with a range of other primary algos. It describes both the
 new mechanism introduced in v0.8.3 and the older variant that only can
 be used when the primary algo is ethash (including etchash).
 
+Clock switching
+---------------
+From v0.10.10, TRM supports switching automatically between clocks for the main
+algo and ZIL. This is only possible with the newer ZIL switching mechanism using
+--zil ... --zil_end arguments. You place one set of clk/voltage arguments for the
+primary algo outside the --zil ... ---zil_end arguments, and another set for the
+ZIL mining inside --zil ... ---zil_end.
 
 New mechanism from v0.8.3
 -------------------------

doc/FPGA_KASPA_GUIDE.txt

@@ -127,10 +127,12 @@ higher clock rates will come at the cost of efficiency.
 
 Tuning Osprey E300
 ===========================
-The Osprey E300 is rather overbuilt with VCCINT regulators rated to 420A.  Users
+The Osprey E300 is rather overbuilt with VCCINT regulators rated to 420A. Users
 with E300s can safely push higher clocks and should just keep an eye on
 temperatures.  For high efficiency, we find that most E300s run well at
-575MHz@600mV. 
+575MHz@600mV.  For vu13p boards we suggest starting tuning at 500MHz@600mV, and
+moving clock up as necessary while monitoring temperatures and regulator 
+currents.
 
 
 Bittware CVP13
@@ -174,4 +176,9 @@ approximately 200A of VCCINT current.  In general we suggest that users should
 monitor temperatures closely, especially when testing new settings.  We suggest
 not exceeding a core temperature of 60-65C on liquid cooled modules. 
 
+SQRL JC13
+===========================
+We have little experience with the JC13s, so we suggest starting tuning at
+400MHz@625mV and slowly increasing clock frequency while monitoring power
+usage and temperature.
 

doc/TRM_EVENT_SCRIPT.txt

@@ -0,0 +1,41 @@
+Team Red Miner Event Script
+===========================
+
+2023-04-04 Initial version.
+
+Overview
+--------
+This document describes the simple event script mechanism added in TRM
+v0.10.10. It addresses certain situations when you may want to reconfigure
+your setup using external scripts at specific triggers. The current list
+of events is short as this feature was mainly added to allow external shells
+scripts to reconfigure clocks during zil switch mining. Future requests might
+lead to more events being added.
+
+Setup
+-----
+Create a shell script (Linux) or .bat file (Windows). Add an argument with
+--event_script=my_event_script.sh or --event_script=my_event_script.bat. This
+script will now be called on certain events during the miner execution.
+
+Script Execution
+----------------
+When the script executes, it is always passed an event name, and possibly an
+additional argument. The script will execute synchronously, i.e. the miner will
+not continue to execute before the event script has completed.
+
+Events
+------
+These are the current events fired whenever an event script has been configured:
+
+MINER_START         Fires during the miner startup process. Good for testing
+                    your event script. This event has no argument.
+
+PRIMARY_ALGO        Fires when the miner switches to the primary algo. The script
+                    could e.g. configure clocks suitable for the main algo being
+                    mined.
+
+SECONDARY_ALGO      Fires when the miner switches to the secondary algo (ZIL).
+                    The script could e.g. configure clocks suitable for zil/ethash
+                    mining.
+