Difference between revisions of "Template:Asic"

From Bitcoin Wiki
Jump to: navigation, search
m (dragon slain (mayhaps))
Line 60: Line 60:
     multiply the Gh/A by (node/2)³ to get the η-factor ( https://bitcointalk.org/index.php?topic=119668 )
     multiply the Gh/A by (node/2)³ to get the η-factor ( https://bitcointalk.org/index.php?topic=119668 )
== Parameter debug information (debug=1) ==
== Parameter debug information (debug=1) ==
Line 149: Line 149:
showsources = {{{showsources}}}}}}}<noinclude>{{documentation}}
showsources = {{{showsources}}}}}}}<noinclude>{{documentation}}
== 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.
== Not included in this template ==
The following items are not included in this template, for the reasons specified:
* ''Gen / Generation labels''.  These mean different things to different people and ultimately have no bearing on a chip's specifications.
* ''Temperature specifications''.  Appropriate TDP information is rarely available for mining chips, with some manufacturers instead referring to how hot a chip gets in a given miner at a given temperature.  However, as this temperature is highly dependent on the specific configuration of the miner (single fan / double fan / water cooling / immersion cooling), this once again has no bearing on a chip's specifications.
* ''Cores count''  The number of cores stated for a mining chip 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.
== Usage ==
This is a relatively straight forward [http://www.mediawiki.org/wiki/Help:Templates wiki template] and many of the notes about using templates apply here.
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 three values, ''name'', ''web'' and ''logo'', in that order; <code>'''dev'''=name,web,logo</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.,<nowiki>http://www.example.com/</nowiki></code>.
=== Visual guide ===
The following table serves as a visual guide, showing which parameter is inserted at which location in the output.
<table class="wikitable" style="width:100%; font-size:80%;">
<tr style="vertical-align:top;">
<td style="width:auto; height:1px;">[dev.logo]'''<br />[dev.name]'''<sup>[dev.web]</sup><br />'''Facilitators''': [codevs]</td>
<td style="width:612px;" rowspan="2"><div style="font-size:80%; text-align:center; padding:0; margin:0;"><div style="float:left; width:98px; height:116px; margin:2px; background-color:#eee;"><div style="vertical-align:middle; width:96px; height:96px; line-height:96px; border:1px solid #ddd;">[pics(n):file]</div><div>[pics(n):caption]</div></div><div style="clear:both;"></div></div></td></tr>
<tr style="vertical-align:top;">
<td><span style="font-size:125%;">'''[chip.name]'''</span><sup>[chip.web]</sup> <sup>[chip.bct]</sup><br />'''Introduced/Planned''': [chip.date]<br />'''Datasheet''': [chip.datasheet]<br /><br />[warning]</td>
<tr style="vertical-align:top;">
<td>'''''Technical specifications''''':<br />'''Foundry''': [die.foundry]<br />'''Die''': [die.size]mm @ [die.node]nm ([die.topology])<br />'''Package''': [package.type] [package.size]mm<br />'''Markings''': [package.markings]<br />'''Known codes''': [codes]</td>
<td><table class="wikitable" style="margin:0; padding:0; width:100%;">
<tr style="text-align:right;"><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Ghash per second">Gh/s</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Joules per Gh (equivalent to Watt per Gh/s)">J/Gh</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Mhash/Joule (derived value)">Mh/J</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Core voltage">V</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Core frequency">Hz</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Total chip wattage (derived value)">W</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="hashes per clock cycle (derived value)">h/Hz</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help;" title="Gh per square mm, an indication of relative mining performance (derived value)">Gh/mm²</span></th><th style="width:11.11%;"><span style="border-bottom:1px dotted #000; cursor:help; white-space:nowrap;" title="η-factor, a '' 'process-invariant hardware metric' (derived value)">η-factor</span></th></tr>
<tr style="text-align:right;"><td>mining(n):Gh</td><td>mining(n):J</td><td></td><td>mining(n):V</td><td>mining(n):Hz</td><td></td><td></td><td></td><td></td></tr>
<tr><td colspan="2">Notes: [notes]</td></tr>
<tr><td colspan="2">Used on: [miners]</td></tr>
<tr><td colspan="2">Sources: [sources] (only shown if showsources=1 is set)</td></tr>
=== Template template ===
Although straight forward, this template does have quite a few parameters.  If you've already familiarized yourself with the parameters and their meaning, the following template template can help; just copy/paste and adjust values as appropriate.
{{asic | dev=name,web!,logo | codevs=list | chip=name,web,date,bct | datasheet=list | pics=list(6) | mining=Gh:J@V:Hz list(4) | die=foundry,node,topology,size | package=type,size,markings | codes=list | notes=string | sources=string | showsources=0/1 | warning=future|canceled|needinfo|vaporware|scam | debug=0/1 }}
=== Sandbox ===
Before using this template in a page, consider using the [[Template:Asic/sandbox|sandbox]].  Not only does this allow you to test the output of your parameters, it also provides debug information on each of the provided parameters and several of the derived values, making it easier to fix any problems with the values you provide.
=== Parameters ===
<table class="wikitable" style="font-size:80%">
<tr style="vertical-align:top;">
<td>Output style.  Defaults to the above visual guide.  The three other options at this time are:
* '''compact''' presents a more compact version that does not include pictures (pictures are presented as links instead), and only the most basic mining information; Gh/s and J/Gh
* '''infobox''' inserts the information as an infobox style display
* '''miningtable''' inserts only the mining data table rows with leading [dev] and [chip.name] cells, for use in comparison tables.
'''optional''' string<br />
syntax: <code>style=default/compact/infobox/miningtable</code><br />
example: <code>style=infobox</code></td>
<tr style="vertical-align:top;">
<td>Details about the primary developer of the ASIC.<br />'''required''' multiple value parameter<br />
syntax: <code>dev=name,web</code><br />
example: <code>dev=[Company&#44; Inc.],<nowiki>http://www.example.com/</nowiki>,logo-company_inc.png</code></td>
<tr style="vertical-align:top;">
<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>Website of the primary developer.<br />''Important'': This should only be specified if ''dev.name'' does not resolve to a wiki page (either automatically or because it is specified explicitly as a wiki link).<br />'''optional''' non-wiki link string</td></tr>
<tr style="vertical-align:top;">
<td>Developer's logo.  If possible, source this from the company's wiki page.  If they don't have one, this would be a good excuse to make one!  Otherwise, upload an image and reference simply as ''filename.extension''<br />'''optional''' wiki picture filename</td></tr>
<tr style="vertical-align:top;">
<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 />
syntax: <code>codevs=Company A,Company B,Company C</code><br />
example: <code>codevs=A6 LLC</code></td></tr>
<tr style="vertical-align:top;">
<td>Non-technical details of the chip<br />'''required''' multiple value parameter<br />
syntax: <code>chip=name,web,date,bct</code><br />
example: <code>chip=Blockerator 2000,<nowiki>http://www.example.com/destructor2k/</nowiki>,June 20th 2014,<nowiki>https://bitcointalk.org/index.php?topic=1.msg2#msg2</nowiki></code></td></tr>
<tr style="vertical-align:top;">
<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>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>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 no exact date is known, year/month will suffice  .<br />'''optional''' date string (no commas)</td></tr>
<tr style="vertical-align:top;">
<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>Links to the chip's datasheet(s) and/or significant resource(s) of technical information, if available.<br />'''optional''' list of comma separated <nowiki>[wiki links]</nowiki><br />
syntax: <code>datasheet=<nowiki>[wiki link1],[wiki link 2],...</nowiki></code><br />
example: <code>datasheet=<nowiki>http://www.example.com/destructor2k/</nowiki></code></td></tr>
<tr style="vertical-align:top;">
<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 6 pictures total) along with simple captions that may include links to further media along the same lines (e.g. ''Top'', ''<nowiki>[http://www.example.com/media/destructor2k Die shots]</nowiki>'') in the following structure: ''filename.extension:caption''<br />
''Important:'' If the display style is ''infobox'', only the first picture specified is used.  Thus, the first picture should generally be a 'top' picture for identification.<br />
'''optional''' comma separated list of up to six media structures</td></tr>
<tr style="vertical-align:top;">
<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: ''mining=<Gh:J@V:Hz''<br />
Where '''Gh''' is the hash rate, '''J''' is Joules/Ghash, '''V''' is the core voltage and '''Hz''' is the core frequency (in MHz).
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 (800Ghash/s) at-the-wall power consumption (400Watt) and the power supply's efficiency (83%) is known, you can use <code>mining=800/12:400/12*0.83</code><br />'''optional''' comma separated list of up to four mining structures<br />
syntax: <code>mining=Gh:J,V:Hz</code><br />
example (no suffixes): <code>mining=200:0.82,0.78:175</code><br />
example (suffixes for clarity) <code>mining=200Gh:0.82J,0.78V:175Hz</code>
<tr style="vertical-align:top;">
<td>Technical data about the chip [http://en.wikipedia.org/wiki/Die_(integrated_circuit) die] itself.<br />'''optional''' multiple value parameter<br />
''Note:'' The Gh/mm² and η-factor values are automatically derived from the die size and node process sizes if the hash rate is also known.<br />
syntax: <code>die=foundry,node,topology,size</code><br />
example: <code>die=TSMC,28nm,full custom,3.5x3.5</code></td></tr>
<tr style="vertical-align:top;">
<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>[http://en.wikipedia.org/wiki/Template:Semiconductor_manufacturing_processes Node size].  This should be specified in nanometers (nm) and may include the 'nm' suffix for clarity.  Sizes should ''not'' be specified in µm.<br />'''optional''' string</td></tr>
<tr style="vertical-align:top;">
<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>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>Details of the [http://en.wikipedia.org/wiki/List_of_integrated_circuit_packaging_types package] used for the chip.<br />'''optional''' multiple value parameter<br />
syntax: <code>package=type,size,markings</code><br />
example: <code>package=QFN,8x8mm,BTC2000 / [date] / [lot]</code></td></tr>
<tr style="vertical-align:top;">
<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 consist 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 '''pics''' parameter if not already specified.<br />'''optional''' string</td></tr>
<tr style="vertical-align:top;">
<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>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].<br />'''optional''' string</td></tr>
<tr style="vertical-align:top;">
<td>A list of codes found in the wild.  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<br />
syntax: <code>codes=code1,code2,...</code><br />
example: <code>3913,4013,4113</code></td></tr>
<tr style="vertical-align:top;">
<td>Warning information.<br />
'''optional''' multiple value parameter<br />
syntax: <code>warning=type,details</code><br />
example: <code>warning=vaporware,This chip does not actually exist</code></td>
<tr style="vertical-align:top;">
<td>A warning type, where applicable.  The only four warning types currently recognized are:<br />
* '''canceled''' Inserts a text noting that the chip was cancelled.<br />
* '''needinfo''' Inserts a text noting that more information on this chip is desired.<br />
* '''vaporware''' Inserts a text noting that the chip may not actually exist.<br />
* '''scam''' Inserts a text noting that the chip is the subject of a scam accusation.<br />
These warnings should not be used lightly.  Lack of information on a chip does not necessarily imply a scam, and should instead be set to ''needinfo''.  When there are strong indications that the chip simply doesn't exist ''vaporware'' is an appropriate state.  Only when there are strong scam accusations should the ''scam'' state be used.  If it is known that a chip never reached production because it was canceled, use the ''canceled'' state.<br />
There are no 'warnings' for chips that are legitimate, currently available or currently under production.  Simply leave out this parameter, and no warning will be inserted.<br />
This parameter affects the 'date' label if ''chip.date'' is set.  If set to one of canceled|vaporware|scam, the label will be ''Planned'', otherwise it will read ''Introduced''
<tr style="vertical-align:top;">
<td>Details on the warning type, if warranted. This is inserted into the [notes] section.<br />
''Note:'' Details may contain commas.</td>
<tr style="vertical-align:top;">
<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<br />
syntax: <code>notes=arbitrary string</code><br />
example: <code>notes=The Blockerator 2000 doesn't actually exist.</code></td></tr>
<tr style="vertical-align:top;">
<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<br />
syntax: <code>miners=miner1,miner2,...</code><br />
example: <code>miners=Blockerator 2K,Blockerator2K1</code></td></tr>
<tr style="vertical-align:top;">
<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 />''Note'': If you are uploading media, consider putting the source citation in the media's description instead, and make sure to choose an appropriate license.  For company logos this is usually because it will be a wordmark, simple geometric shapes argument, or just 'fair use' based on being illustrative.  The latter argument also tends to apply to chip shots.  However, if you can provide your own original photos, that would be preferred.<br />'''optional''' list of comma separated [http://www.mediawiki.org/wiki/Extension:Cite source citations].<br />
syntax: <code>sources=data1<nowiki><ref>source1</ref></nowiki>,data2 & data 3<nowiki><ref>source2&3</ref></nowiki>,...</code>
example: <code>sources=all the things: thin air (original research)</code></td></tr>
<tr style="vertical-align:top;">
<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<br />
syntax: <code>showsources=0|1</code><br />
example: <code>showsources=1</code></td></tr>
<tr style="vertical-align:top;">
<td>Adds debug output below the template output, but only if used on the [[Template:Asic/sandbox]] page to prevent accidental clutter.<br />'''optional''' boolean 0|1<br />
syntax: <code>debug=0|1</code><br />
example: <code>debug=1</code></td></tr>
== References ==
<references />

Revision as of 14:30, 2 April 2015


Edit this section to edit the template. Template:Asic/doc