Difference between revisions of "Template:Asic"

From Bitcoin Wiki
Jump to: navigation, search
(Preliminary template work, messy notes throughout, calling it a day, but welcoming feedback - please use the Discussion page :))
 
(+parameters, -specs headers - will have to re-work the table for parameter changes, then on to the actual logic.)
Line 10: Line 10:
 
The reason for using a template rather than a whole bunch of copy/paste scenarios is that it makes it easier to use it across different pages - e.g. entries in a list of ASICs, summary/sidebar entries on a developer's page, full entries on the page for the chip itself (if applicable - currently only Avalon seem to be using this) - and to vary presentation/update to more standards-compliant output as time goes along.
 
The reason for using a template rather than a whole bunch of copy/paste scenarios is that it makes it easier to use it across different pages - e.g. entries in a list of ASICs, summary/sidebar entries on a developer's page, full entries on the page for the chip itself (if applicable - currently only Avalon seem to be using this) - and to vary presentation/update to more standards-compliant output as time goes along.
  
This template will likely make a bit of use of the #explode stringfunction in order to easily pass multiple anonymous parameters as a single named parameter.  I.e. dev=[[Bitmain]],https://bitmaintech.com/ creating an internal wiki link for Bitmain, but also adding an external link to https://bitmaintech.com/, whereas dev=[[Bitmain]] does not include the external link.  This helps cut down on having to do things like dev=Name|devlink=somesite|devlogo=somemedia, when these can - for the purposes of a template - easily be grouped together without much confusion in use.  Unfortunately the comma separator does mean that things like "Company, Inc." will need to have their comma encoded or wrapped such that the template won't see that as a separator.  That or think of a different delimiter to use.  Anything but resorting to the pipe template/magic word <nowiki>{{!}}</nowiki> which makes my eyes hurt.
+
This template will likely make a bit of use of the #explode stringfunction in order to easily pass multiple anonymous parameters as a single named parameter.  I.e. <nowiki>dev=[[Bitmain]],https://bitmaintech.com/</nowiki> creating an internal wiki link for Bitmain, but also adding an external link to https://bitmaintech.com/, whereas <nowiki>dev=[[Bitmain]]</nowiki> does not include the external link.  This helps cut down on having to do things like dev=Name|devlink=somesite|devlogo=somemedia, when these can - for the purposes of a template - easily be grouped together without much confusion in use.  Unfortunately the comma separator does mean that things like "Company, Inc." will need to have their comma encoded or wrapped such that the template won't see that as a separator.  That or think of a different delimiter to use.  Anything but resorting to the pipe template/magic word <nowiki>{{!}}</nowiki> which makes my eyes hurt.
  
 
== To do ==
 
== To do ==
Basically all the things, including what details to include:
 
* Developer details
 
** Main developer (may include external link, name may be wikilink (will not create red links))
 
*** dev=name,website
 
** Secondary developers (i.e. chip facilitators, design bureaus, etc. - may include external link, no internal wiki links)
 
*** codevs=name1,name2,...
 
* Chip details
 
** (code) name, default to "unknown" (may include external link, may include BCT link)
 
*** chip=name,website,bct
 
** picture(s) - top/bottom maybe die (design) shot if available, with captions.  Currently inserting as a gallery, though apparently widths is broken.  Images should (preferably) be square (chips be square, yo).
 
*** chipmedia=media1,media1caption,media2,media2caption,...
 
** Introduction date (tape-out / market introduction / first known date code, preferably using #time)
 
*** chipdate=August 2014,1339 (Date template missing?)
 
** Mining Specifications.  Typical or min-max, as these can vary wildly depending on implementation and voltage/frequency modifications.  Additionally, at the moment the test table below contains a #expr to calculate Gh/J.  This only works if the input J/Gh is a single number, rather than a range.  If ranges are to be allowed, those ranges would have to be split first.  Additionally, because of the two variables, one could have 'Gh/s @ V @ Hz' and additional matching 'J/Gh @ V @ Hz' where the J/Gh does not necessarily carry through in all the variations.  Will have to think on this one a bit.  If allowing that format, then mods.volt, mods.freq and possible btcspecs.energy and btcspecs.hashrate can go, leaving essentially btcspecs=J@Gh@V@Hz,J2@Gh2@V2@Hz2,..., with #expr used to do any further calculations.  However, I feel that this overcomplicates matters, and allowing min-max for both figures is sufficient for an overall overview - leaving the details of how to achieve those figures to the source citation or the reader's own research.
 
*** Ghash/s
 
*** J/Ghash
 
**** btcspecs=hashrate,energy
 
** Tech that modifies mining specs
 
*** Core voltage (typical or min-max)
 
*** Core frequency (typical or min-max)
 
**** mods=volt,freq
 
** Technical specifications ( in smaller type? )
 
*** foundry (TSMC, UMC, Global Foundries, SMIC, etc.)
 
*** node size (nm)
 
*** node process (hardcopy / full custom / gate array / standard cell / ?, rolled (sometimes called 'folded') cores / unrolled cores)
 
*** die size (mm x mm)
 
*** package specs (QFN, BGA, etc. mm x mm)
 
*** package markings in plaintext ( logo/name / part code / date code indication )
 
**** techspecs=foundry,nodesize,process,diesize,package,markings
 
*** list of date codes found in the wild.
 
**** datecodes=code1,code2,...
 
* Additional notes - trivia, additional details, pretty much anything, including whether or not the chip being referred was every actually real.
 
** notes=Additional notes here
 
* Use details, i.e. a non-exhaustive list of miners this chip is used in.  I'm pretty sure mediawiki ''can'' do a two-way relationship, but I think that would require every single miner to also have a wiki page...somehow.  Stick to this, manually update as miners are listed.
 
** miners=minerA,minerB,minerC,etc.
 
* Sources.  Where possible, give source for any parameter.  Rather than making a link cloud of sources in the template (output), accept arbitrary data here, e.g. [http://etc/ foundry & node size & die size],[http://etc2/ codevs].  Anybody with a citation needed itch can then check the source or (temporarily) set showsource=1
 
** sources=string1,string2,...
 
* Optional feedback
 
** For missing parameters - i.e. those inserting the template should have an easy way to figure out which parameters are missing without having to refer back to the documentation.
 
*** showmissing=0|1
 
** For sources - additionally outputs sources
 
*** showsources=0|1
 
 
 
Formatting:
 
Formatting:
 
* (wiki)table that structures the information
 
* (wiki)table that structures the information
 
<table class="wikitable" style="font-size:80%; width:100%;">
 
<table class="wikitable" style="font-size:80%; width:100%;">
<tr style="font-size:125%;"><td>'''[dev.name]'''<sup>[[dev.website]|www]</sup> [codevs]</td><td>'''[chip.name]'''<sup>[[chip.website]|www]</sup> <sup>[[chip.bct]|BCT]</sup></td><td style="width:30%;" rowspan="6">
+
<tr style="font-size:125%;"><td>'''[dev.name]'''<sup>[[dev.web]|www]</sup> [codevs]</td><td>'''[chip.name]'''<sup>[[chip.web]|www]</sup> <sup>[[chip.bct]|BCT]</sup></td><td style="width:30%;" rowspan="5">
 
<gallery mode="packed" heights="48px">
 
<gallery mode="packed" heights="48px">
 
BC_Rnd_64px.png‎|Top
 
BC_Rnd_64px.png‎|Top
Line 67: Line 24:
 
</gallery>
 
</gallery>
 
</td></tr>
 
</td></tr>
<tr><td>''Bitcoin mining specs''</td><td>
 
''Technical specs''</td></tr>
 
 
<tr style="vertical-align:top;">
 
<tr style="vertical-align:top;">
 
<td style="width:35%;">'''Hash rate:''' [btcspecs.hashrate]Gh/s<br />'''Power consumption:''' [btcspecs.energy]J/Gh ({{#expr: 1/[btcspecs.energy]}}Gh/J)</td>
 
<td style="width:35%;">'''Hash rate:''' [btcspecs.hashrate]Gh/s<br />'''Power consumption:''' [btcspecs.energy]J/Gh ({{#expr: 1/[btcspecs.energy]}}Gh/J)</td>
Line 74: Line 29:
 
</tr>
 
</tr>
 
<tr><td>'''Core voltage''': [mods.volt]<br />'''Core frequency''': [mods.freq]</td></tr>
 
<tr><td>'''Core voltage''': [mods.volt]<br />'''Core frequency''': [mods.freq]</td></tr>
<tr><td colspan="2">Additional notes: [notes]/td></tr>
+
<tr><td colspan="2">Additional notes: [notes]</td></tr>
 
<tr><td colspan="2">Miners using this chip: [miners]</td></tr>
 
<tr><td colspan="2">Miners using this chip: [miners]</td></tr>
 
<tr><td colspan="3">Sources: [sources]</td></tr>
 
<tr><td colspan="3">Sources: [sources]</td></tr>
Line 80: Line 35:
  
 
All the logic that actually outputs the above based on provided parameters
 
All the logic that actually outputs the above based on provided parameters
* Should have a boolean toggle that outputs all parameters and shows which ones are missing.
 
  
 
Proper documentation:
 
Proper documentation:
 
* The style of the preliminary table above can show where provided info goes as a visual reminder
 
* The style of the preliminary table above can show where provided info goes as a visual reminder
* Make a table of parameters, listing:
 
** required yes/no
 
** format (string (arbitrary, link, etc.), integer, boolean, whatever)
 
** default value (only applicable to chip name so far: ''unknown'')
 
** description of parameter and parameter use.  E.g. if a derived value is to be used, use #expr so that original source values can be looked up.  Things like the hash rate should be explained in terms of typical vs min-max values.  With adequate cooling a chip can be overclocked quite a bit, and with extreme undervolting a chip can easily be very power-efficient.  The ASICs page will end up making note of this as well.  As a result, these values can be gamed to fit an agenda, which leads to:
 
** explain source citation.  Although most of the values should be readily found via google/bing/whatever, and I'm far from a [citation needed] kinda person as a consequence, ''adding sources doesn't hurt''.
 
  
 
== Not to do ==
 
== Not to do ==
Line 96: Line 44:
 
* temperature specs.  Drop the chips in liquid nitrogen and hey presto - i.e. temperature is fluff for asic specs and should be reserved for miners.
 
* temperature specs.  Drop the chips in liquid nitrogen and hey presto - i.e. temperature is fluff for asic specs and should be reserved for miners.
 
* Cores count.  The number of cores is moot unless each manufacturer uses the exact same design, number of stages per core, etc.  Despite plenty of commonality, implementations do differ enough that the concept of a 'core' is difficult at best to use as a distinguishing feature.
 
* Cores count.  The number of cores is moot unless each manufacturer uses the exact same design, number of stages per core, etc.  Despite plenty of commonality, implementations do differ enough that the concept of a 'core' is difficult at best to use as a distinguishing feature.
 +
 +
== Parameters ==
 +
This template only uses ''named'' parameters.  Some of these parameters take multiple values, delimited by a comma, which should be treated as ''anonymous'' parameters - i.e. the order in which you specify them determines which sub-parameter you specify a value for.
 +
 +
As an example, the named parameter '''dev''' takes two values, ''name'' and ''web'', in that order; <code>'''dev'''=name,web</code>.  These sub-parameters are referenced as ''''dev'''.''name'' and '''dev'''.''web'' in this documentation.
 +
 +
''Note:'' Whenever an arbitrary string contains a comma, you ''must'' encode it as &amp;#44;.  E.g. <code>'''dev'''=Company&amp;#44; Inc.,http://www.example.com/</code>.
 +
 +
<table class="wikitable" style="font-size:80%">
 +
<tr><th>Parameter</th><th>Description</th></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''dev'''</td>
 +
<td>Details about the primary developer of the ASIC.<br />'''required''' multiple value parameter<br /><code>dev=name,web</code><br /><code>dev=[[Company&#44; Inc.]],http://www.example.com/</code></td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''dev'''.''name''</td>
 +
<td>Name of the primary developer.  Can be a <nowiki>[[wiki link]]</nowiki> if the company has a page on the wiki.<br />
 +
Note that if the name contains any commas, these should be replaced with the HTML encoded version &amp;#44;<br />'''required''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''dev'''.''web''</td>
 +
<td>Website of the primary developer.<br />'''optional''' non-wiki link string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''codevs'''</td>
 +
<td>Names of co-developers.  An example of a co-developer is an ASIC design/finishing/proofing house or a facilitator between the primary developer and the foundry.<br />'''optional''' comma separated list of strings<br />
 +
<code>codevs=Company A,Company B,Company C</code></td></tr>
 +
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''</td>
 +
<td>Non-technical details of the chip<br />'''required''' multiple value parameter<br />
 +
<code>chip=name,web,date,datasheet,bct</code><br />
 +
<code>chip=Blockerator 2000,http://www.example.com/destructor2k/,<nowiki>{{#time: Y-M-d|June 20th, 2014}}</nowiki>,,https://bitcointalk.org/index.php?topic=1.msg2#msg2</code></td></tr>
 +
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''.''name''</td>
 +
<td>(Code) Name of the chip.  Many developers will name their chip or use a part code as a reference.  If no such name can be found, the chip may be used exclusively in a particular line of miners, which do have a name, and that name can be used instead.  Otherwise, leave blank.<br />'''optional''', string, defaults to '''unknown'''</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''.''web''</td>
 +
<td>Website with information about the chip.  This can be a forum thread/post but should ''not'' be a BitcoinTalk thread.  See '''chip'''.''bct'' instead.<br />'''optional''' non-wiki link string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''.''date''</td>
 +
<td>Introduction date of the chip.  This can often be difficult to assess as the chip goes through various stages of development before it goes to market.  If possible, find the ''tape-out date''.  If this can't be found, try to find when it was first introduced to market, e.g. in an announcement, press coverage, etc.  Alternatively, if the chip package has a date code that precedes that introduction, use the date code as a basis instead.<br />
 +
If specified, this should use the [http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23time #time parser function] for automatic formatting purposes.  If no exact date is known, year/month will suffice.<br />'''optional''' <nowiki>{{#time: Y-M date}}</nowiki> or <nowiki>{{#time: Y-M-d date}}</nowiki></td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''.''datasheet''</td>
 +
<td>Links to the chip's datasheet(s) and/or significant resource(s) of technical information, if available.<br />'''optional''' comma separated list of link strings.</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''chip'''.''bct''</td>
 +
<td>BitcoinTalk thread/post with information and/or discussion about the chip.<br />'''optional''' non-wiki link string to the BitcoinTalk forum.</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''media'''</td>
 +
<td>Pictures to be included in the template, typically of the top and bottom of the chip and optionally die and/or design photos (up to 4 pictures total) along with simple captions that may include links to further media along the same lines (e.g. ''Top'', ''[http://www.example.com/media/destructor2k Die shots]'') in the following structure: <code>filename.extension:caption</code><br />
 +
'''optional''' comma separated list of up to four media structures</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''mining'''</td>
 +
<td>Specifications of the chip's Bitcoin hashing performance.  Hashing performance of a typical chip is a complex issue with multiple variables.  The most common two variables are ''core voltage'' and ''core frequency''.  Combined, these affect both the hash rate and the power consumption.  To enforce per-setting parity for these values, they must be specified as any permutation of the following structure:<br />
 +
<code>mining=<Gh:J@V:Hz</code><br />
 +
Where '''Gh''' is the hash rate, '''J''' is Joules/Ghash, '''V''' is the core voltage and '''Hz''' is the core frequency.
 +
 +
The leading '''<''' can be used if a J/Gh rating is derived from at-the-wall power consumption of a miner in case there is no information on the chip.  At-the-wall power consumption is always greater than that of the chip due to losses in the power supply, voltage regulators on the board, and losses in auxiliary circuitry.<br />
 +
 +
Trailing units may be specified for clarity but will not be used to determine how to interpret the data.
 +
 +
For example, you could specify only the hash rate (<code>mining=200</code>) or the power consumption at a given hash rate (<code>mining=200Gh:0.82J</code>) or the hash rate at a given core voltage (<code>mining=200@0.7</code>).<br />
 +
The template will automatically insert derived values (W, Gh/J, etc.) where sufficient values are given.<br />
 +
 +
If more than one structure is provided, each will be included in the template separately up to a maximum of 4.  This allows for minimum and maximum power consumption figures, and minimum and maximum hash rates (if not coinciding with the power consumption figures).  Further values, e.g. to demonstrate non-linearity, are outside the scope of this template and should ideally be noted in a chip's datasheet.
 +
 +
''Important'': If you do not have exact figures but have values from which to roughly calculate them, such as from a complete miner's specification, you can enter a mathematical expression.  For example, if you know that a miner is advertised as being 800Ghash/s, and a picture tells you that it has 12 chips, you can use <code>mining=800/12</code> and the template will calculate the hash rate.  The main reason for entering these values directly has to do with sourcing, such that others can verify the values entered.  In this example, a hash rate of ''66.67'' is unlikely to be found through a search or through checking sources.  Similarly, if only a miner's at-the-wall power consumption and the power supply's efficiency is known, you can use <code><br />'''optional''' comma separated list of up to four mining structures<br />
 +
<code>mining=0.82:200,0.78:175</code>
 +
</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''die'''</td>
 +
<td>Technical data about the chip [http://en.wikipedia.org/wiki/Die_(integrated_circuit) die] itself.<br />'''optional''' multiple value parameter<br />
 +
<code>die=foundry,node,topology,size</code><br />
 +
<code>die=TSMC,28nm,full custom,3.5x3.5</code></td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''die'''.''foundry''</td>
 +
<td>The foundry that produced the [http://en.wikipedia.org/wiki/Wafer_%28electronics%29 chip wafers].  Typically this will be one of ''TSMC'', ''Global Foundries'', ''UMC'', or ''SMIC'', but there are other foundries especially for older node sizes.<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''die'''.''node''</td>
 +
<td>[http://en.wikipedia.org/wiki/Template:Semiconductor_manufacturing_processes Node size].  This should be specified in nanometers (nm) and include the 'nm' suffix for clarity.<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''die'''.''topology''</td>
 +
<td>The topology of the chip.  This can be difficult to ascertain as many manufacturers won't say, or rely on multiple technologies.  This value will typically be one of ''hard copy'', ''full custom'' or ''gate array''.  ''hard copy'' generally refers to an FPGA design that was turned into an ASIC by path of least resistance; letting software solve it.  ''full custom'' may include a custom designed core but with placing and routing automated.<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''die'''.''size''</td>
 +
<td>Physical size of the die, expressed in millimeters ''length'x''width'' and may include the 'mm' suffix for clarity, e.g. ''4x4mm''<br />'''optional''' dimensions string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''package'''</td>
 +
<td>Details of the [http://en.wikipedia.org/wiki/List_of_integrated_circuit_packaging_types package] used for the chip.<br />'''optional''' multiple value parameter</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''package'''.''type''</td>
 +
<td>The package type and pin count used for the chip.  This will typically be one of QFN, BGA or FCBGA, followed by the number of pins.  The number of pins on some packages can be difficult to determine.  For example, a BGA may exist of 32 rows and 32 columns, but have its corner pins removed, or the shadow area under the die may not have any pins at all.  When the pin count varies wildly from what a simple rows * columns calculation would provide, use the rows * columns calculation, append an asterisk (in this example, ''BGA1024*'', and if possible supply media showing the pins on the chip more clearly in the '''media''' parameter if not already specified.<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''package'''.''size''</td>
 +
<td>Physical size of the package's board presence without any leads - i.e. just the dimensions of the (plastic / ceramic) package - expressed in millimeters ''length'x''width'' and may include the 'mm' suffix for clarity, e.g. ''9x9mm''<br />'''optional''' dimensions string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''package'''.''markings''</td>
 +
<td>Plaintext transcription of the markings on the package, excluding pin 1 indication markers.  New lines should be substituted by '' / '' (space before and after the slash character).<br />
 +
Bare packages should have their markings specified as 'none'.<br />
 +
If the markings include a logo, the logo may simply be described as ''company logo'' or ''device logo'', though in the case of logos that incorporate text this text should be noted.<br />
 +
Special markings may be indicated by place holders, e.g. [lot #] and [date code].<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''package'''.''datecodes''</td>
 +
<td>A list of date codes found in the wild.  These may be <nowiki>[wiki linked]</nowiki> to media where the date code is evident.  Date codes can help establish manufacturing runs.  Typical date codes exist of a week number and a year, both as two digits, together.  However, more complex date codes exist and if in use may not be easy to decipher without a datasheet.<br />'''optional''' comma separated list of strings</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''notes'''</td>
 +
<td>Any additional notes that should be added.  This may include trivia (back story behind a name, for example), specifications not yet addressed in the template, or anything else you feel may be of interest.<br />'''optional''' string</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''miners'''</td>
 +
<td>A (non-exhaustive) list of miners that use this particular chip.  These miners may be <nowiki>[wiki linked]</nowiki> or plain linked if there is information on the particular miner available.  However, this should absolutely not be used to refer to miners that do not (yet) exist.  As with the entirety of the wiki, it is not advertising space.<br />'''optional''' list of comma separated strings</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''sources'''</td>
 +
<td>A list of sources.  In order to prevent a link cloud or link clutter, while acknowledging the need to prevent <nowiki>[citation needed]</nowiki>, this parameter should be used to list your sources.  Anybody interested in checking where information came from can then put in the small effort to find it.<br />'''optional''' list of comma separated [http://www.mediawiki.org/wiki/Extension:Cite source citations].</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''showmissing'''</td>
 +
<td>Highlights missing data.  If you're working on a page that includes this template and aren't sure which pieces of information you may still have to find, setting this parameter to ''1'' will highlight them in the output.<br />'''optional''' boolean 0|1</td></tr>
 +
<tr style="vertical-align:top;">
 +
<td>'''showsources'''</td>
 +
<td>Adds the citations below the template output.  If the page has a <nowiki><references /></nowiki> tag, they will then be listed there.<br />'''optional''' boolean 0|1</td></tr>
 +
</table>
 
</noinclude>
 
</noinclude>

Revision as of 20:46, 16 February 2015

Extremely preliminary ASIC chip details template.

NOTE: There is nothing actually here yet. Do not use this template.


Template:Asic/doc

Preliminary overview

Template to be used for ASIC chip details - e.g. developer, hashing specs, process, media.

The reason for using a template rather than a whole bunch of copy/paste scenarios is that it makes it easier to use it across different pages - e.g. entries in a list of ASICs, summary/sidebar entries on a developer's page, full entries on the page for the chip itself (if applicable - currently only Avalon seem to be using this) - and to vary presentation/update to more standards-compliant output as time goes along.

This template will likely make a bit of use of the #explode stringfunction in order to easily pass multiple anonymous parameters as a single named parameter. I.e. dev=[[Bitmain]],https://bitmaintech.com/ creating an internal wiki link for Bitmain, but also adding an external link to https://bitmaintech.com/, whereas dev=[[Bitmain]] does not include the external link. This helps cut down on having to do things like dev=Name|devlink=somesite|devlogo=somemedia, when these can - for the purposes of a template - easily be grouped together without much confusion in use. Unfortunately the comma separator does mean that things like "Company, Inc." will need to have their comma encoded or wrapped such that the template won't see that as a separator. That or think of a different delimiter to use. Anything but resorting to the pipe template/magic word {{!}} which makes my eyes hurt.

To do

Formatting:

  • (wiki)table that structures the information
[dev.name][[dev.web]|www] [codevs][chip.name][[chip.web]|www] [[chip.bct]|BCT]
Hash rate: [btcspecs.hashrate]Gh/s
Power consumption: [btcspecs.energy]J/Gh (Expression error: Unrecognized punctuation character "[".Gh/J)
Foundry: [techspecs.foundry]
Die: [techspecs.diesize] @ [techspecs.nodesize]nm
Package: [techspecs.package]
Markings: [techspecs.markings]
Known date codes: [datecodes]
Core voltage: [mods.volt]
Core frequency: [mods.freq]
Additional notes: [notes]
Miners using this chip: [miners]
Sources: [sources]

All the logic that actually outputs the above based on provided parameters

Proper documentation:

  • The style of the preliminary table above can show where provided info goes as a visual reminder

Not to do

Things that shouldn't be included in this template (and should be noted on the ASICs page instead):

  • Gen / Generation labels. These mean different things to different people and is ultimately fluff.
  • temperature specs. Drop the chips in liquid nitrogen and hey presto - i.e. temperature is fluff for asic specs and should be reserved for miners.
  • Cores count. The number of cores is moot unless each manufacturer uses the exact same design, number of stages per core, etc. Despite plenty of commonality, implementations do differ enough that the concept of a 'core' is difficult at best to use as a distinguishing feature.

Parameters

This template only uses named parameters. Some of these parameters take multiple values, delimited by a comma, which should be treated as anonymous parameters - i.e. the order in which you specify them determines which sub-parameter you specify a value for.

As an example, the named parameter dev takes two values, name and web, in that order; dev=name,web. These sub-parameters are referenced as 'dev.name and dev.web in this documentation.

Note: Whenever an arbitrary string contains a comma, you must encode it as &#44;. E.g. dev=Company&#44; Inc.,http://www.example.com/.

ParameterDescription
dev Details about the primary developer of the ASIC.
required multiple value parameter
dev=name,web
dev=Company, Inc.,http://www.example.com/
dev.name Name of the primary developer. Can be a [[wiki link]] if the company has a page on the wiki.
Note that if the name contains any commas, these should be replaced with the HTML encoded version &#44;
required string
dev.web Website of the primary developer.
optional non-wiki link string
codevs Names of co-developers. An example of a co-developer is an ASIC design/finishing/proofing house or a facilitator between the primary developer and the foundry.
optional comma separated list of strings
codevs=Company A,Company B,Company C
chip Non-technical details of the chip
required multiple value parameter

chip=name,web,date,datasheet,bct

chip=Blockerator 2000,http://www.example.com/destructor2k/,{{#time: Y-M-d|June 20th, 2014}},,https://bitcointalk.org/index.php?topic=1.msg2#msg2
chip.name (Code) Name of the chip. Many developers will name their chip or use a part code as a reference. If no such name can be found, the chip may be used exclusively in a particular line of miners, which do have a name, and that name can be used instead. Otherwise, leave blank.
optional, string, defaults to unknown
chip.web Website with information about the chip. This can be a forum thread/post but should not be a BitcoinTalk thread. See chip.bct instead.
optional non-wiki link string
chip.date Introduction date of the chip. This can often be difficult to assess as the chip goes through various stages of development before it goes to market. If possible, find the tape-out date. If this can't be found, try to find when it was first introduced to market, e.g. in an announcement, press coverage, etc. Alternatively, if the chip package has a date code that precedes that introduction, use the date code as a basis instead.
If specified, this should use the #time parser function for automatic formatting purposes. If no exact date is known, year/month will suffice.
optional {{#time: Y-M date}} or {{#time: Y-M-d date}}
chip.datasheet Links to the chip's datasheet(s) and/or significant resource(s) of technical information, if available.
optional comma separated list of link strings.
chip.bct BitcoinTalk thread/post with information and/or discussion about the chip.
optional non-wiki link string to the BitcoinTalk forum.
media Pictures to be included in the template, typically of the top and bottom of the chip and optionally die and/or design photos (up to 4 pictures total) along with simple captions that may include links to further media along the same lines (e.g. Top, Die shots) in the following structure: filename.extension:caption
optional comma separated list of up to four media structures
mining Specifications of the chip's Bitcoin hashing performance. Hashing performance of a typical chip is a complex issue with multiple variables. The most common two variables are core voltage and core frequency. Combined, these affect both the hash rate and the power consumption. To enforce per-setting parity for these values, they must be specified as any permutation of the following structure:

mining=<Gh:J@V:Hz
Where Gh is the hash rate, J is Joules/Ghash, V is the core voltage and Hz is the core frequency.

The leading < can be used if a J/Gh rating is derived from at-the-wall power consumption of a miner in case there is no information on the chip. At-the-wall power consumption is always greater than that of the chip due to losses in the power supply, voltage regulators on the board, and losses in auxiliary circuitry.

Trailing units may be specified for clarity but will not be used to determine how to interpret the data.

For example, you could specify only the hash rate (mining=200) or the power consumption at a given hash rate (mining=200Gh:0.82J) or the hash rate at a given core voltage (mining=200@0.7).
The template will automatically insert derived values (W, Gh/J, etc.) where sufficient values are given.

If more than one structure is provided, each will be included in the template separately up to a maximum of 4. This allows for minimum and maximum power consumption figures, and minimum and maximum hash rates (if not coinciding with the power consumption figures). Further values, e.g. to demonstrate non-linearity, are outside the scope of this template and should ideally be noted in a chip's datasheet.

Important: If you do not have exact figures but have values from which to roughly calculate them, such as from a complete miner's specification, you can enter a mathematical expression. For example, if you know that a miner is advertised as being 800Ghash/s, and a picture tells you that it has 12 chips, you can use mining=800/12 and the template will calculate the hash rate. The main reason for entering these values directly has to do with sourcing, such that others can verify the values entered. In this example, a hash rate of 66.67 is unlikely to be found through a search or through checking sources. Similarly, if only a miner's at-the-wall power consumption and the power supply's efficiency is known, you can use
optional comma separated list of up to four mining structures
<code>mining=0.82:200,0.78:175

die Technical data about the chip die itself.
optional multiple value parameter

die=foundry,node,topology,size

die=TSMC,28nm,full custom,3.5x3.5
die.foundry The foundry that produced the chip wafers. Typically this will be one of TSMC, Global Foundries, UMC, or SMIC, but there are other foundries especially for older node sizes.
optional string
die.node Node size. This should be specified in nanometers (nm) and include the 'nm' suffix for clarity.
optional string
die.topology The topology of the chip. This can be difficult to ascertain as many manufacturers won't say, or rely on multiple technologies. This value will typically be one of hard copy, full custom or gate array. hard copy generally refers to an FPGA design that was turned into an ASIC by path of least resistance; letting software solve it. full custom may include a custom designed core but with placing and routing automated.
optional string
die.size Physical size of the die, expressed in millimeters length'xwidth and may include the 'mm' suffix for clarity, e.g. 4x4mm
optional dimensions string
package Details of the package used for the chip.
optional multiple value parameter
package.type The package type and pin count used for the chip. This will typically be one of QFN, BGA or FCBGA, followed by the number of pins. The number of pins on some packages can be difficult to determine. For example, a BGA may exist of 32 rows and 32 columns, but have its corner pins removed, or the shadow area under the die may not have any pins at all. When the pin count varies wildly from what a simple rows * columns calculation would provide, use the rows * columns calculation, append an asterisk (in this example, BGA1024*, and if possible supply media showing the pins on the chip more clearly in the media parameter if not already specified.
optional string
package.size Physical size of the package's board presence without any leads - i.e. just the dimensions of the (plastic / ceramic) package - expressed in millimeters length'xwidth and may include the 'mm' suffix for clarity, e.g. 9x9mm
optional dimensions string
package.markings Plaintext transcription of the markings on the package, excluding pin 1 indication markers. New lines should be substituted by / (space before and after the slash character).

Bare packages should have their markings specified as 'none'.
If the markings include a logo, the logo may simply be described as company logo or device logo, though in the case of logos that incorporate text this text should be noted.

Special markings may be indicated by place holders, e.g. [lot #] and [date code].
optional string
package.datecodes A list of date codes found in the wild. These may be [wiki linked] to media where the date code is evident. Date codes can help establish manufacturing runs. Typical date codes exist of a week number and a year, both as two digits, together. However, more complex date codes exist and if in use may not be easy to decipher without a datasheet.
optional comma separated list of strings
notes Any additional notes that should be added. This may include trivia (back story behind a name, for example), specifications not yet addressed in the template, or anything else you feel may be of interest.
optional string
miners A (non-exhaustive) list of miners that use this particular chip. These miners may be [wiki linked] or plain linked if there is information on the particular miner available. However, this should absolutely not be used to refer to miners that do not (yet) exist. As with the entirety of the wiki, it is not advertising space.
optional list of comma separated strings
sources A list of sources. In order to prevent a link cloud or link clutter, while acknowledging the need to prevent [citation needed], this parameter should be used to list your sources. Anybody interested in checking where information came from can then put in the small effort to find it.
optional list of comma separated source citations.
showmissing Highlights missing data. If you're working on a page that includes this template and aren't sure which pieces of information you may still have to find, setting this parameter to 1 will highlight them in the output.
optional boolean 0|1
showsources Adds the citations below the template output. If the page has a <references /> tag, they will then be listed there.
optional boolean 0|1