Registered User mNo edit summary |
Registered User mNo edit summary |
||
(39 intermediate revisions by 3 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): | |||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board | * {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP13 microprocessor#Part number codification|STM32MP13 part number codification]] for the STM32MP13 MPUs, the [[STM32MP15 microprocessor#Part number codification|STM32MP15 part number codification]] for the STM32MP15 MPUs and the [[STM32MP25 microprocessor#Part number codification|STM32MP25 part number codification]] for the STM32MP25 MPUs): | ||
** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | ** '''MPU''': any board with a STM32 MPU microprocessor device | ||
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board | ** '''MP1''': any board with a STM32MP1 microprocessor device | ||
** '''135F-DK''': STM32MP135F-DK Discovery kit | |||
** '''135x-DK''': any Discovery kit with a STM32MP135 MPU | |||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board - Obsolete - This board is out of production | |||
** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | |||
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board - Obsolete - This board is out of production | |||
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ||
** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board | ** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board | ||
** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board | ** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board | ||
** '''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 - Obsolete - This board is out of production | ||
** '''157D-DK1''': STM32MP157A-DK1 Discovery kit | ** '''157D-DK1''': STM32MP157A-DK1 Discovery kit | ||
** '''157C-DK2''': STM32MP157C-DK2 Discovery kit | ** '''157C-DK2''': STM32MP157C-DK2 Discovery kit - Obsolete - This board is out of production | ||
** '''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 | ||
** '''MP2''': any board with a STM32MP2 microprocessor device | |||
** '''257x-DK''': any Discovery kit with a STM32MP257 MPU | |||
** '''257F-DK''': STM32MP257F-DK Discovery kit | |||
** '''257x-EV1''': any Evaluation board with a STM32MP257 MPU | |||
** '''257F-EV1''': STM32MP257F-EV Evaluation board | |||
* {{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== | ||
{| class="st-table" | {| class="st-table" | ||
! style="width: 50%;" | You type !! You get | ! style="width: 50%;" | You type !! You get | ||
|- | |||
| All boards with a STM32 MPU microprocessor device | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=MPU}}<br /> | |||
{{Board | type=MPU | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=MPU}}<br /> | |||
{{Board | type=MPU | name=short}} | |||
|- | |||
| All boards with a STM32MP1 microprocessor device | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=MP1}}<br /> | |||
{{Board | type=MP1 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=MP1}}<br /> | |||
{{Board | type=MP1 | name=short}} | |||
|- | |||
| STM32MP135x-DK Discovery kit | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135x-DK}} | |||
</pre> | |||
| | |||
{{Board | type=135x-DK}} | |||
|- | |||
| STM32MP135F-DK Discovery kit | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135F-DK}} | |||
</pre> | |||
| | |||
{{Board | type=135F-DK}} | |||
|- | |- | ||
| STM32MP157F-EV1 Evaluation board | | STM32MP157F-EV1 Evaluation board | ||
Line 36: | Line 83: | ||
{{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;"> | |||
{{Board | type=157A-DK1 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=157A-DK1 | name=short}} | |||
|- | |||
| STM32MP135F-DK | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135F-DK | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=135F-DK | name=short}} | |||
|- | |||
| All boards with a STM32MP2 microprocessor device | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=MP2}}<br /> | |||
{{Board | type=MP2 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=MP2}}<br /> | |||
{{Board | type=MP2 | name=short}} | |||
|- | |||
| STM32MP257F-EV1 Evaluation board | |||
<pre style="white-space: pre-wrap;"> | <pre style="white-space: pre-wrap;"> | ||
{{Board | type= | {{Board | type=257F-EV1}} | ||
</pre> | </pre> | ||
| | | | ||
{{Board | type= | {{Board | type=257F-EV1}} | ||
|- | |||
| STM32MP257x-EV1 Evaluation board | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257x-EV1}} | |||
</pre> | |||
| | |||
{{Board | type=257x-EV1}} | |||
|- | |||
| STM32MP257F-DK Discovery kit | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-DK}} | |||
</pre> | |||
| | |||
{{Board | type=257F-DK}} | |||
|- | |||
| STM32MP257x-DK Discovery kit | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257x-DK}} | |||
</pre> | |||
| | |||
{{Board | type=257x-DK}} | |||
|} | |} | ||
Line 47: | Line 152: | ||
{| class="st-table" | {| class="st-table" | ||
! style="width: 50%;" | You type !! You get | ! style="width: 50%;" | You type !! You get | ||
|- | |||
| Discovery kits with a STM32MP135 MPU | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135F-DK}}<br> | |||
</pre> | |||
| | |||
{{Board | type=135F-DK}}<br> | |||
|- | |||
| | |||
Discovery kits with a STM32MP135 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135F-DK | name=short}}<br> | |||
</pre> | |||
| | |||
{{Board | type=135F-DK | name=short}}<br> | |||
|- | |- | ||
| Evaluation boards with a STM32MP157 MPU | | Evaluation boards with a STM32MP157 MPU | ||
Line 73: | Line 193: | ||
{{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 202: | ||
{{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}} | |||
|- | |||
| Evaluation boards with a STM32MP257 MPU | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-EV1}} | |||
</pre> | |||
| | |||
{{Board | type=257F-EV1}} | |||
|- | |||
| Discovery kits with a STM32MP257 MPU | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-DK}} | |||
</pre> | |||
| | |||
{{Board | type=257F-DK}} | |||
|- | |||
| Evaluation boards with a STM32MP257 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-EV1 | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=257F-EV1 | name=short}} | |||
|- | |||
| Discovery kits with a STM32MP257 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-DK | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=257F-DK | name=short}} | |||
|- | |- | ||
| Unspecified board | | Unspecified board | ||
Line 101: | Line 287: | ||
{{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 308: | ||
==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 }} | ||
</noinclude>{{#vardefine:info|}}{{#switch:{{{type|}}} | </noinclude>{{#vardefine:info|}}{{#vardefine:board|STM32MP{{{type|}}}}}{{#switch:{{{type|}}} | ||
| 157A- | | MPU = {{#vardefine:board|STM32 MPU boards}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=Category:STM32_MPU_boards]]</sup>}} | ||
| MP1 = {{#vardefine:board|STM32MP1 series' boards}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=Category:STM32_MPU_boards]]</sup>}} | |||
| # | | 157A-DK1 | 157C-DK2 = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Discovery kit}}}}{{#vardefine:info|<span title{{=}}"Obsolete - This board is out of production"><sup>[[File:Warning.png|13px]]</sup></span>}} | ||
}} | | 157A-EV1 | 157C-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Evaluation board}}}}{{#vardefine:info|<span title{{=}}"Obsolete - This board is out of production"><sup>[[File:Warning.png|13px]]</sup></span>}} | ||
| 157D-EV1 | 157A/D-EV1 | 157F-EV1 |157C/F-EV1 | 157x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=STM32MP157x-EV1 - hardware description]]</sup>}} | |||
| 157D-DK1 | 157F-DK2 | 157x-DK2 | 157x-DK1 | 157x-DKx = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Discovery kit}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=STM32MP157x-DKx - hardware description]]</sup>}} | |||
| 135F-DK | 135x-DK = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Discovery kit}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=STM32MP135x-DK - hardware description]]</sup>}} | |||
| MP2 = {{#vardefine:board|STM32MP2 series' boards}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=Category:STM32_MPU_boards]]</sup>}} | |||
| 257F-DK | 257x-DK = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Discovery kit}}}}{{#vardefine:info|<span title{{=}}"Coming soon"><sup>[[File:Warning.png|13px]]</sup></span>}} | |||
| 257F-EV1 | 257x-EV1 = {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Evaluation board}}}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=STM32MP257x-EV1 - hardware description]]</sup>}} | |||
| #default = {{#vardefine:board|{{Highlight| unknown board type identifier}}}} | |||
}}{{#var:board}} {{#var:info}} |
Revision as of 09:26, 25 September 2023
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 STM32MP13 part number codification for the STM32MP13 MPUs, the STM32MP15 part number codification for the STM32MP15 MPUs and the STM32MP25 part number codification for the STM32MP25 MPUs):
- MPU: any board with a STM32 MPU microprocessor device
- MP1: any board with a STM32MP1 microprocessor device
- 135F-DK: STM32MP135F-DK Discovery kit
- 135x-DK: any Discovery kit with a STM32MP135 MPU
- 157A-EV1: STM32MP157A-EV1 Evaluation board - Obsolete - This board is out of production
- 157D-EV1: STM32MP157D-EV1 Evaluation board
- 157C-EV1: STM32MP157C-EV1 Evaluation board - Obsolete - This board is out of production
- 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 - Obsolete - This board is out of production
- 157D-DK1: STM32MP157A-DK1 Discovery kit
- 157C-DK2: STM32MP157C-DK2 Discovery kit - Obsolete - This board is out of production
- 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
- MP2: any board with a STM32MP2 microprocessor device
- 257x-DK: any Discovery kit with a STM32MP257 MPU
- 257F-DK: STM32MP257F-DK Discovery kit
- 257x-EV1: any Evaluation board with a STM32MP257 MPU
- 257F-EV1: STM32MP257F-EV Evaluation board
- <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 |
---|---|
All boards with a STM32 MPU microprocessor device
MPU}}<br /> {{Board | type=MPU | name=short}}{{Board | type= |
STM32MPMPU unknown board type identifier |
All boards with a STM32MP1 microprocessor device
{{Board | type=MP1}}<br />
{{Board | type=MP1 | name=short}}
|
STM32MPMP1 unknown board type identifier |
STM32MP135x-DK Discovery kit
{{Board | type=135x-DK}}
|
STM32MP135x-DK unknown board type identifier |
STM32MP135F-DK Discovery kit
{{Board | type=135F-DK}}
|
STM32MP135F-DK unknown board type identifier |
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}}
|
|
STM32MP135F-DK
{{Board | type=135F-DK | name=short}}
|
STM32MP135F-DK unknown board type identifier |
All boards with a STM32MP2 microprocessor device
{{Board | type=MP2}}<br />
{{Board | type=MP2 | name=short}}
|
STM32MPMP2 unknown board type identifier |
STM32MP257F-EV1 Evaluation board
{{Board | type=257F-EV1}}
|
STM32MP257F-EV1 unknown board type identifier |
STM32MP257x-EV1 Evaluation board
{{Board | type=257x-EV1}}
|
STM32MP257x-EV1 unknown board type identifier |
STM32MP257F-DK Discovery kit
{{Board | type=257F-DK}}
|
STM32MP257F-DK unknown board type identifier |
STM32MP257x-DK Discovery kit
{{Board | type=257x-DK}}
|
STM32MP257x-DK unknown board type identifier |
3. More examples[edit source]
4. Code[edit source]
unknown board type identifier