Browse Source

README updates.

nfactor-troky
Con Kolivas 11 years ago
parent
commit
a4fa9051bd
  1. 15
      ASIC-README
  2. 97
      README

15
ASIC-README

@ -1,7 +1,11 @@
SUPPORTED DEVICES SUPPORTED DEVICES
Currently supported devices include the Avalon, the Butterfly Labs SC range Currently supported devices include the Avalon (including BitBurner), the
of devices and the ASICMINER block erupters. Butterfly Labs SC range of devices and the ASICMINER block erupters. 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 be
disconnected when cgminer is running.
The BFL devices should come up as one of the following: The BFL devices should come up as one of the following:
@ -82,6 +86,7 @@ ASIC SPECIFIC COMMANDS
--avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq --avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq
--avalon-temp <arg> Set avalon target temperature (default: 50) --avalon-temp <arg> Set avalon target temperature (default: 50)
--bflsc-overheat <arg> Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 90) --bflsc-overheat <arg> Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 90)
--bitburner-voltage <arg> Set BitBurner core voltage, in millivolts
AVALON DEVICES AVALON DEVICES
@ -104,6 +109,7 @@ Avalon commands:
--avalon-freq <arg> Set frequency range for avalon-auto, single value or range --avalon-freq <arg> Set frequency range for avalon-auto, single value or range
--avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq --avalon-options <arg> Set avalon options baud:miners:asic:timeout:freq
--avalon-temp <arg> Set avalon target temperature (default: 50) --avalon-temp <arg> Set avalon target temperature (default: 50)
--bitburner-voltage <arg> Set BitBurner core voltage, in millivolts
Avalon auto will enable dynamic overclocking gradually increasing and Avalon auto will enable dynamic overclocking gradually increasing and
@ -180,6 +186,11 @@ This is the clock speed of the devices. Only specific values work, 256, 270,
Note that setting a value with an asterisk next to it will be using your Note that setting a value with an asterisk next to it will be using your
avalon outside its spec and you do so at your own risk. avalon outside its spec and you do so at your own risk.
eg:
--bitburner-voltage <arg> Set BitBurner core voltage, in millivolts
Self evident.
If you use the full curses based interface with Avalons you will get this If you use the full curses based interface with Avalons you will get this
information: information:
AVA 0: 22/ 46C 2400R AVA 0: 22/ 46C 2400R

97
README

@ -78,17 +78,18 @@ If you specify the --socks-proxy option to cgminer, it will only be applied to a
that don't specify their own proxy setting like above that don't specify their own proxy setting like above
--- ---
BUILDING CGMINER BUILDING CGMINER FOR YOURSELF
Dependencies: DEPENDENCIES:
Mandatory:
curl dev library http://curl.haxx.se/libcurl/ curl dev library http://curl.haxx.se/libcurl/
(libcurl4-openssl-dev) (libcurl4-openssl-dev)
curses dev library
(libncurses5-dev or libpdcurses on WIN32)
pkg-config http://www.freedesktop.org/wiki/Software/pkg-config pkg-config http://www.freedesktop.org/wiki/Software/pkg-config
libtool http://www.gnu.org/software/libtool/ libtool http://www.gnu.org/software/libtool/
Optional:
curses dev library
(libncurses5-dev or libpdcurses on WIN32)
jansson http://www.digip.org/jansson/ jansson http://www.digip.org/jansson/
(jansson is included in-tree and not necessary) (jansson is included in-tree and not necessary)
@ -99,53 +100,56 @@ Dependencies:
AMD ADL SDK http://developer.amd.com/sdks/ADLSDK AMD ADL SDK http://developer.amd.com/sdks/ADLSDK
(This sdk is mandatory for ATI GPU monitoring & clocking) (This sdk is mandatory for ATI GPU monitoring & clocking)
libudev headers libudev dev library (libudev-dev)
(This is only required for ASIC+FPGA auto-detection and is linux only) (This is only required for ASIC+FPGA auto-detection and is linux only)
libusb headers libusb dev library (libusb-dev)
(This is only required for ASIC+FPGA support) (This is only required for ASIC+FPGA support)
If building from git:
autoconf
automake
Before compiling cgminer, if you are using any USB devices you may need to
build libusb yourself if you have an older version of libusb-dev that has a bug.
This usually shows up with a combination of USB1.1 devices (all Icarus) with
USB3 ports/hubs. If you do not have this hardware, most versions of libusb will
work fine.
Before compiling cgminer, if you are using any USB devices you need to build libusb
Some versions of libsub have a timeout bug.
This shows up mostly with the ICA and AMU USB1.1 devices.
To compile cgminer with a known working version of libusb To compile cgminer with a known working version of libusb
First install udev-dev via one of: First install udev-dev via one of:
Ubuntu derivatives: apt-get install libudev-dev Ubuntu derivatives: apt-get install libudev-dev
Arch: it should be installed by default as part of systemd Arch: it should be installed by default as part of systemd
Fedora: yum install libgudev1 Fedora: yum install libgudev1
Mingw: not required Mingw: not required
In the cgminer folder create a subfolder called libusb In the cgminer folder create a subfolder called libusb
mkdir libusb mkdir libusb
cd libusb cd libusb
Now, in that folder get and extract the known working libusb Now, in that folder get and extract the known working libusb
libusb-1.0.16-rc10.tar.bz2 libusb-1.0.16-rc10.tar.bz2
It is available here: It is available here:
http://sourceforge.net/projects/libusb/files/libusb-1.0/libusb-1.0.16-rc10/ http://sourceforge.net/projects/libusb/files/libusb-1.0/libusb-1.0.16-rc10/
In linux and mingw you extract with: In linux and mingw you extract with:
tar -xvf libusb-1.0.16-rc10.tar.bz2 tar -xvf libusb-1.0.16-rc10.tar.bz2
Then to build it: Then to build it:
cd libusb-1.0.16-rc10 cd libusb-1.0.16-rc10
./configure ./configure
make make
cd ../.. cd ../..
Now when you configure cgminer as listed further below in the build Now when you configure cgminer as listed further below in the build
instructions, for all the USB devices you must add libusb as follows: instructions, for all the USB devices you must add libusb as follows:
LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.a -ludev" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.a -ludev" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon
On Fedora18 you need -lrt also: On Fedora18 you need -lrt also:
LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.a -ludev -lrt" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.a -ludev -lrt" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon
On Windows mingw: On Windows mingw:
LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.dll.a" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon LIBUSB_CFLAGS="-I./libusb/libusb-1.0.16-rc10/libusb" LIBUSB_LIBS="./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.dll.a" ./configure --enable-bflsc --enable-icarus --enable-bitforce --enable-modminer --enable-ztex --enable-avalon
After compiling on windows you need to copy After compiling on windows you need to copy
./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.dll ./libusb/libusb-1.0.16-rc10/libusb/.libs/libusb-1.0.dll
into the current cgminer folder before running cgminer into the current cgminer folder before running cgminer
@ -170,7 +174,8 @@ Basic *nix build instructions:
CFLAGS="-O2 -Wall -march=native" ./configure <options> CFLAGS="-O2 -Wall -march=native" ./configure <options>
No installation is necessary. You may run cgminer from the build No installation is necessary. You may run cgminer from the build
directory directly. directory directly, but you may do make install if you wish to install
cgminer to a system location or location you specified.
Native WIN32 build instructions: see windows-build.txt Native WIN32 build instructions: see windows-build.txt
@ -240,6 +245,37 @@ See example.conf for an example configuration.
--version|-V Display version and exit --version|-V Display version and exit
USB device (ASIC and FPGA) options:
--icarus-options <arg> Set specific FPGA board configurations - one set of values for all or comma separated
--icarus-timing <arg> Set how the Icarus timing is calculated - one setting/value for all or comma separated
--usb <arg> USB device selection (See below)
--usb-dump (See FPGA-README)
See FGPA-README or ASIC-README for more information regarding these.
ASIC only options:
--avalon-auto Adjust avalon overclock frequency dynamically for best hashrate
--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
--avalon-temp <arg> Set avalon target temperature (default: 50)
--bflsc-overheat <arg> Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 90)
--bitburner-voltage <arg> Set BitBurner core voltage, in millivolts
See ASIC-README for more information regarding these.
FPGA only options:
--bfl-range Use nonce range on bitforce devices if supported
See FGPA-README for more information regarding this.
GPU only options: GPU only options:
--auto-fan Automatically adjust all GPU fan speeds to maintain a target temperature --auto-fan Automatically adjust all GPU fan speeds to maintain a target temperature
@ -267,6 +303,7 @@ GPU only options:
See GPU-README for more information regarding GPU mining. See GPU-README for more information regarding GPU mining.
SCRYPT only options: SCRYPT only options:
--lookup-gap <arg> Set GPU lookup gap for scrypt mining, comma separated --lookup-gap <arg> Set GPU lookup gap for scrypt mining, comma separated
@ -275,22 +312,6 @@ SCRYPT only options:
See SCRYPT-README for more information regarding litecoin mining. See SCRYPT-README for more information regarding litecoin mining.
ASIC and FPGA mining boards (BFL ASIC, BitForce, Icarus, ModMiner, Ztex)
only options:
--avalon-auto Adjust avalon overclock frequency dynamically for best hashrate
--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
--avalon-temp <arg> Set avalon target temperature (default: 50)
--bfl-range Use nonce range on bitforce devices if supported
--icarus-options <arg> Set specific FPGA board configurations - one set of values for all or comma separated
--icarus-timing <arg> Set how the Icarus timing is calculated - one setting/value for all or comma separated
--usb <arg> USB device selection (See below)
--usb-dump (See FPGA-README)
See FGPA-README and ASIC-README for more information regarding these.
Cgminer should automatically find all of your Avalon ASIC, BFL ASIC, BitForce Cgminer should automatically find all of your Avalon ASIC, BFL ASIC, BitForce
FPGAs, Icarus bitstream FPGAs, ASICMINER usb block erupters, ModMiner FPGAs, FPGAs, Icarus bitstream FPGAs, ASICMINER usb block erupters, ModMiner FPGAs,
@ -298,7 +319,7 @@ or Ztex FPGAs
--- ---
USB DEVICES SETTING UP USB DEVICES
WINDOWS: WINDOWS:

Loading…
Cancel
Save