Template:Asic: Difference between revisions
TheRealSteve (talk | contribs) |
TheRealSteve (talk | contribs) |
||
Line 55: | Line 55: | ||
<td>Name of the primary developer. Can be a <nowiki>[[wiki link]]</nowiki> if the company has a page on the wiki.<br /> | <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 &#44;<br />'''required''' string</td></tr> | Note that if the name contains any commas, these should be replaced with the HTML encoded version &#44;<br />'''required''' string</td></tr> | ||
<tr style="vertical-align:top;"> | |||
<td>'''dev'''.''logo''</td> | |||
<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 <code>filename.extension</code><br />'''optional''' wiki picture filename</td></tr> | |||
<tr style="vertical-align:top;"> | <tr style="vertical-align:top;"> | ||
<td>'''dev'''.''web''</td> | <td>'''dev'''.''web''</td> | ||
Line 86: | Line 89: | ||
<td>BitcoinTalk thread/post with information and/or discussion about the chip.<br />'''optional''' non-wiki link string to the BitcoinTalk forum.</td></tr> | <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;"> | <tr style="vertical-align:top;"> | ||
<td>''' | <td>'''chip.pics'''</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 /> | <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> | '''optional''' comma separated list of up to four media structures</td></tr> |
Revision as of 18:53, 18 February 2015
Extremely preliminary ASIC chip details template.
NOTE: There is nothing actually here yet. Do not use this template.
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.media][dev.name][[dev.web]|www] [codevs] | [chip.name][[chip.web]|www] [[chip.bct]|BCT] Introduced: [chip.date] |
[chip.media](1) [chip.media](2) [chip.media](3) [chip.media](4) |
[mining] | Foundry: [die.foundry] Die: [die.size] @ [die.node]nm Package: [package.type] [package.size] Markings: [package.markings] Known date codes: [package.datecodes] |
|
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 ,. E.g. dev=Company, Inc.,http://www.example.com/
.
Parameter | Description |
---|---|
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 , required string |
dev.logo | 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 optional wiki picture filename |
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=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. |
chip.pics | 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:
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 ( 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
|
die | Technical data about the chip die itself. optional multiple value parameter
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 may include the 'nm' suffix for clarity. Sizes should not be specified in µm. 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'. 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 |