2014-01-21 14:28:43 +00:00
|
|
|
# Kernels
|
|
|
|
|
|
|
|
|
|
## Available OpenCL kernels
|
|
|
|
|
|
|
|
|
|
See directory `kernel`.
|
|
|
|
|
|
2014-01-23 16:25:12 +00:00
|
|
|
## Parameter configuration
|
|
|
|
|
|
|
|
|
|
### Common
|
|
|
|
|
|
|
|
|
|
In general, switching kernels requires reconfiguring mining parameters,
|
|
|
|
|
such as (but not necessarily limited to) `thread-concurrency`, `intensity`,
|
|
|
|
|
`gpu-engine` and `gpu-memclock`.
|
|
|
|
|
|
2014-03-17 20:06:11 +00:00
|
|
|
A description of how to do this is available in `doc/MINING.md`.
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
### Scrypt kernels
|
|
|
|
|
|
|
|
|
|
#### alexkarnew
|
2014-01-23 16:25:12 +00:00
|
|
|
|
2014-01-27 23:00:21 +00:00
|
|
|
Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst >=13.4.
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
Only supports `vectors=1`.
|
|
|
|
|
|
|
|
|
|
[Announcement](https://litecointalk.org/index.php?topic=4082.0).
|
|
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
#### alexkarold
|
2014-01-23 16:25:12 +00:00
|
|
|
|
2014-01-27 23:00:21 +00:00
|
|
|
Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst <13.4.
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
Only supports `vectors=1`.
|
|
|
|
|
|
|
|
|
|
[Announcement](https://litecointalk.org/index.php?topic=4082.0).
|
|
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
#### bufius
|
2014-05-20 16:08:09 +00:00
|
|
|
|
|
|
|
|
Bufius' optimised kernel, based on `ckolivas`. Merged from vertminer.
|
|
|
|
|
|
|
|
|
|
Only supports `vectors=1` and `lookup-gap` 2, 4 or 8.
|
|
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
#### ckolivas
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
The original Colin Percival `scrypt` kernel, maintained for a long time by
|
|
|
|
|
Con Kolivas in `cgminer` and renamed to reflect the fact.
|
|
|
|
|
|
|
|
|
|
Only supports `vectors=1`.
|
|
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
#### psw
|
2014-02-01 13:57:26 +00:00
|
|
|
|
|
|
|
|
Pavel Semjanov optimised kernel, SHA256 speedups.
|
|
|
|
|
|
|
|
|
|
[Announcement](https://bitcointalk.org/index.php?topic=369858.0).
|
|
|
|
|
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
#### zuikkis
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
Zuikkis' optimised kernel, based on `ckolivas`.
|
|
|
|
|
|
2014-03-17 20:06:11 +00:00
|
|
|
Only supports `vectors=1` and `lookup-gap=2`.
|
2014-01-23 16:25:12 +00:00
|
|
|
|
|
|
|
|
[Announcement](https://litecointalk.org/index.php?topic=6058.msg90873#msg90873).
|
|
|
|
|
|
2014-05-29 00:13:41 +00:00
|
|
|
### Other kernels
|
|
|
|
|
|
|
|
|
|
#### darkcoin
|
|
|
|
|
#### darkcoin-mod
|
|
|
|
|
#### animecoin
|
|
|
|
|
#### fuguecoin
|
|
|
|
|
#### groestlcoin
|
|
|
|
|
#### inkcoin
|
|
|
|
|
#### marucoin
|
2014-06-02 23:32:54 +00:00
|
|
|
#### marucoin-mod
|
2014-05-29 00:13:41 +00:00
|
|
|
#### myriadcoin-groestl
|
|
|
|
|
#### quarkcoin
|
|
|
|
|
#### qubitcoin
|
|
|
|
|
#### sifcoin
|
|
|
|
|
#### twecoin
|
|
|
|
|
#### maxcoin
|
2014-01-23 16:25:12 +00:00
|
|
|
|
2014-01-21 14:28:43 +00:00
|
|
|
## Submitting new kernels
|
|
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
2014-01-23 16:25:12 +00:00
|
|
|
* OpenCL source code only, licenced under GPLv3 (or later).
|
|
|
|
|
* Not hard-coded for a specific GPU model or manufacturer.
|
2014-02-06 12:54:08 +00:00
|
|
|
* Known limitations and any specific configuration quirks must be
|
|
|
|
|
mentioned.
|
2014-01-21 14:28:43 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### Procedure
|
|
|
|
|
|
2014-03-17 20:06:11 +00:00
|
|
|
* Copy the kernel you wish to modify, make sure the character encoding is
|
|
|
|
|
UTF-8 and commit it without any further modifications.
|
2014-01-21 14:28:43 +00:00
|
|
|
|
|
|
|
|
This way, it is easy to verify that there are no hidden changes. Note in
|
|
|
|
|
the commit message which kernel is used as a base.
|
|
|
|
|
|
2014-02-06 12:54:08 +00:00
|
|
|
* Make changes to the kernel. Commit them.
|
2014-01-21 14:28:43 +00:00
|
|
|
|
2014-01-23 16:25:12 +00:00
|
|
|
This allows to produce a diff that makes sense.
|
2014-01-21 14:28:43 +00:00
|
|
|
|
2014-02-06 12:54:08 +00:00
|
|
|
* Recompile and test that the kernel actually works.
|
2014-01-21 14:28:43 +00:00
|
|
|
|
2014-02-06 12:54:08 +00:00
|
|
|
* Add yourself to the "kernels" section in `AUTHORS.md`. Keep it short.
|
2014-02-01 14:19:04 +00:00
|
|
|
|
2014-02-06 12:54:08 +00:00
|
|
|
* Submit a pull request on GitHub, file it at the issue tracker, or mail
|
|
|
|
|
it.
|
|
|
|
|
|
|
|
|
|
Outline the changes made, known limitations, and tested GPUs. List
|
2014-01-23 16:25:12 +00:00
|
|
|
your git repository and branch name. The current repository and issue
|
|
|
|
|
tracker links should be in `README.md`.
|
