Registered User mNo edit summary |
Registered User mNo edit summary |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
It outputs a "standardized" string that might be used to name an article part. | It outputs a "standardized" string that might be used to name an article part. | ||
Usage: <nowiki>{{</nowiki>Board | type={{HighlightParam|<type>}}}} | Usage: <nowiki>{{</nowiki>Board | type={{HighlightParam|<type>}} | name={{HighlightParam|<name>}}}} | ||
:Where: | :Where: | ||
* {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|part number codification]] for the STM32MP15 MPUs): | * {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|part number codification]] for the STM32MP15 MPUs): | ||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board | ** '''157A-EV1''': STM32MP157A-EV1 Evaluation board | ||
** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | ** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | ||
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board | ** '''157C-EV1''': STM32MP157C-EV1 Evaluation board | ||
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ||
Line 16: | Line 16: | ||
** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU | ** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU | ||
** '''157A-DK1''': STM32MP157A-DK1 Discovery kit | ** '''157A-DK1''': STM32MP157A-DK1 Discovery kit | ||
** '''157D-DK1''': STM32MP157A-DK1 Discovery kit | ** '''157D-DK1''': STM32MP157A-DK1 Discovery kit | ||
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit | ** '''157C-DK2''': STM32MP157C-DK2 Discovery kit | ||
** '''157F-DK2''': STM32MP157F-DK2 Discovery kit | ** '''157F-DK2''': STM32MP157F-DK2 Discovery kit | ||
** ''' | ** '''157x-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit | ||
** ''' | ** '''157x-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit | ||
** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU | ** '''157x-DKx''': any Discovery kit with a STM32MP157 MPU | ||
* {{HighlightParam|<name>}} is the '''optional''' parameter that allows to select the way the board name is displayed. Per default (if {{HighlightParam|<name>}} is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for {{HighlightParam|<name>}} is: | |||
** '''short''': the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed | |||
The <sup>[[File:More_info_green.png|15px|link=]]</sup> icon indicates that the board is already available, and clicking on this icon links to '''the article about the boards hardware description''' (e.g. [[STM32MP157x-DKx - hardware description]]). | |||
The <sup>[[File:Warning.png|15px|link=]]</sup> icon indicates that the board is currently not available. | |||
==Basic examples== | ==Basic examples== | ||
Line 36: | Line 40: | ||
{{Board | type=157F-EV1}} | {{Board | type=157F-EV1}} | ||
|- | |- | ||
| | | STM32MP157C-DK2 Discovery kit | ||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=157C-DK2}} | |||
</pre> | |||
| | |||
{{Board | type=157C-DK2}} | |||
|- | |||
| STM32MP157C-EV1 | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=157C-EV1 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=157C-EV1 | name=short}} | |||
|- | |||
| STM32MP157A-DK1 | |||
<pre style="white-space: pre-wrap;"> | <pre style="white-space: pre-wrap;"> | ||
{{Board | type= | {{Board | type=157A-DK1 | name=short}} | ||
</pre> | </pre> | ||
| | | | ||
{{Board | type= | {{Board | type=157A-DK1 | name=short}} | ||
|} | |} | ||
Line 73: | Line 91: | ||
{{Board | type=157C-DK2}}<br> | {{Board | type=157C-DK2}}<br> | ||
{{Board | type=157F-DK2}}<br> | {{Board | type=157F-DK2}}<br> | ||
{{Board | type= | {{Board | type=157x-DK1}}<br> | ||
{{Board | type= | {{Board | type=157x-DK2}}<br> | ||
{{Board | type=157x-DKx}} | {{Board | type=157x-DKx}} | ||
</pre> | </pre> | ||
Line 82: | Line 100: | ||
{{Board | type=157C-DK2}}<br> | {{Board | type=157C-DK2}}<br> | ||
{{Board | type=157F-DK2}}<br> | {{Board | type=157F-DK2}}<br> | ||
{{Board | type= | {{Board | type=157x-DK1}}<br> | ||
{{Board | type= | {{Board | type=157x-DK2}}<br> | ||
{{Board | type=157x-DKx}} | {{Board | type=157x-DKx}} | ||
|- | |||
| Evaluation boards with a STM32MP157 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=157A-EV1 | name=short}}<br> | |||
{{Board | type=157D-EV1 | name=short}}<br> | |||
{{Board | type=157C-EV1 | name=short}}<br> | |||
{{Board | type=157F-EV1 | name=short}}<br> | |||
{{Board | type=157A/D-EV1 | name=short}}<br> | |||
{{Board | type=157C/F-EV1 | name=short}}<br> | |||
{{Board | type=157x-EV1 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=157A-EV1 | name=short}}<br> | |||
{{Board | type=157D-EV1 | name=short}}<br> | |||
{{Board | type=157C-EV1 | name=short}}<br> | |||
{{Board | type=157F-EV1 | name=short}}<br> | |||
{{Board | type=157A/D-EV1 | name=short}}<br> | |||
{{Board | type=157C/F-EV1 | name=short}}<br> | |||
{{Board | type=157x-EV1 | name=short}} | |||
|- | |||
| Discovery kits with a STM32MP157 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=157A-DK1 | name=short}}<br> | |||
{{Board | type=157D-DK1 | name=short}}<br> | |||
{{Board | type=157C-DK2 | name=short}}<br> | |||
{{Board | type=157F-DK2 | name=short}}<br> | |||
{{Board | type=157x-DK1 | name=short}}<br> | |||
{{Board | type=157x-DK2 | name=short}}<br> | |||
{{Board | type=157x-DKx | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=157A-DK1 | name=short}}<br> | |||
{{Board | type=157D-DK1 | name=short}}<br> | |||
{{Board | type=157C-DK2 | name=short}}<br> | |||
{{Board | type=157F-DK2 | name=short}}<br> | |||
{{Board | type=157x-DK1 | name=short}}<br> | |||
{{Board | type=157x-DK2 | name=short}}<br> | |||
{{Board | type=157x-DKx | name=short}} | |||
|- | |- | ||
| Unspecified board | | Unspecified board | ||
Line 101: | Line 157: | ||
{{Board | type=153C-EV1}}<br> | {{Board | type=153C-EV1}}<br> | ||
{{Board | type=157C-DK3}} | {{Board | type=157C-DK3}} | ||
|- | |||
| Unknown value for {{HighlightParam|<name>}} | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=157C-EV1 | name=long}}<br> | |||
{{Board | type=157C-EV1 | name=}} | |||
</pre> | |||
| | |||
{{Board | type=157C-EV1 | name=long}}<br> | |||
{{Board | type=157C-EV1 | name=}} | |||
|- | |- | ||
| Check that there's no space before and after the text | | Check that there's no space before and after the text | ||
Line 113: | Line 178: | ||
==Code== | ==Code== | ||
{{UpdateNeededForNewBoard| Add the new board in the code below and in the list of the possible values above.Make sure that the [[Contributors:Formatting#Lead_section|Lead section]] | {{UpdateNeededForNewBoard| Add the new board in the code below and in the list of the possible values above.Make sure that the [[Contributors:Formatting#Lead_section|Lead section]] is available for all referenced articles }} | ||
< | Example : | ||
| 157A-EV1 | 157D-EV1 | | <pre> | ||
| 157A-DK1 | 157D-DK1 | 157C-DK2 | 157F-DK2 | | {{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} | ||
| #default = {{#vardefine:typ|{{Highlight|unknown board type identifier}}}} | | 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1= {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} | ||
}}STM32MP{{{type|}}} {{#var:typ}} {{#var:info}} | | 157D-EV1 | 157A/D-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<span title="STM32MP157D-EV1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}} | ||
[[File:Warning.png|15px|link=]]</sup></span>}} | |||
</pre> | |||
</noinclude>{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}} | |||
| 157A-EV1 | 157D-EV1 | 157A/D-EV1 | 157C-EV1 | 157F-EV1 |157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}} | |||
| 157A-DK1 | 157D-DK1 | 157C-DK2 | 157F-DK2 | 157x-DK2 | 157x-DK1 | 157x-DKx = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Discovery kit}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-DKx - hardware description]]</sup>}} | |||
| #default = {{#vardefine:typ|{{Highlight| unknown board type identifier}}}} | |||
}}STM32MP{{{type|}}}{{#var:typ}} {{#var:info}} |
Latest revision as of 12:21, 10 November 2020
1. Usage[edit source]
The Board template is used to indicate for which board(s), an article part (chapter, paragraph, table...) is valid. Per default (i.e. if this template is not used), any part of an article is valid for all boards for which the entire article is valid.
It outputs a "standardized" string that might be used to name an article part.
<type> | name=<name>}}Usage: {{Board | type=
- Where:
- <type> is the mandatory identifier of the board type. The possible values are (see also the part number codification for the STM32MP15 MPUs):
- 157A-EV1: STM32MP157A-EV1 Evaluation board
- 157D-EV1: STM32MP157D-EV1 Evaluation board
- 157C-EV1: STM32MP157C-EV1 Evaluation board
- 157F-EV1: STM32MP157F-EV1 Evaluation board
- 157A/D-EV1: STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board
- 157C/F-EV1: STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board
- 157x-EV1: any Evaluation board with a STM32MP157 MPU
- 157A-DK1: STM32MP157A-DK1 Discovery kit
- 157D-DK1: STM32MP157A-DK1 Discovery kit
- 157C-DK2: STM32MP157C-DK2 Discovery kit
- 157F-DK2: STM32MP157F-DK2 Discovery kit
- 157x-DK1: STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit
- 157x-DK2: STM32MP157C-DK2 or STM32MP157F-DK2 Discovery kit
- 157x-DKx: any Discovery kit with a STM32MP157 MPU
- <name> is the optional parameter that allows to select the way the board name is displayed. Per default (if <name> is not set), the full board name (i.e. including "Evaluation board" or "Discovery kit") is displayed. The possible value for <name> is:
- short: the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed
The icon indicates that the board is already available, and clicking on this icon links to the article about the boards hardware description (e.g. STM32MP157x-DKx - hardware description).
The icon indicates that the board is currently not available.
2. Basic examples[edit source]
You type | You get |
---|---|
STM32MP157F-EV1 Evaluation board
{{Board | type=157F-EV1}}
|
|
STM32MP157C-DK2 Discovery kit
{{Board | type=157C-DK2}}
|
|
STM32MP157C-EV1
{{Board | type=157C-EV1 | name=short}}
|
|
STM32MP157A-DK1
{{Board | type=157A-DK1 | name=short}}
|
3. More examples[edit source]
4. Code[edit source]
Example :
{{#vardefine:info|}}{{#vardefine:typ|}}{{#switch:{{{type|}}}
| 157A-EV1 | 157C-EV1 | 157F-EV1 | 157C/F-EV1 | 157x-EV1= {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|15px|link=STM32MP157x-EV1 - hardware description]]</sup>}}
| 157D-EV1 | 157A/D-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:typ| Evaluation board}}}}{{#vardefine:info|<span title="STM32MP157D-EV1 not available"><sup>[[File:Warning.png|15px|link=]]</sup></span>}}
[[File:Warning.png|15px|link=]]</sup></span>}}
STM32MP unknown board type identifier