Registered User mNo edit summary |
Registered User mNo edit summary Tag: 2017 source edit |
||
(16 intermediate revisions by 3 users not shown) | |||
Line 8: | Line 8: | ||
:Where: | :Where: | ||
* {{HighlightParam|<type>}} is the '''mandatory''' identifier of the board type. The possible values are (see also the [[STM32MP15 microprocessor#Part number codification|STM32MP15 part number codification]] for the STM32MP15 MPUs | * {{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): | ||
** '''MPU''': any board with a STM32 MPU microprocessor device | ** '''MPU''': any board with a STM32 MPU microprocessor device | ||
** '''MP1''': any board with a STM32MP1 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 | ** '''135x-DK''': any Discovery kit with a STM32MP135 MPU | ||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board - {{Highlight|Obsolete - This board is out of production}} | |||
** '''157A-EV1''': STM32MP157A-EV1 Evaluation board - Obsolete - This board is out of production | |||
** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | ** '''157D-EV1''': STM32MP157D-EV1 Evaluation board | ||
** '''157C-EV1''': STM32MP157C-EV1 Evaluation board - Obsolete - This board is out of production | ** '''157C-EV1''': STM32MP157C-EV1 Evaluation board - {{Highlight|Obsolete - This board is out of production}} | ||
** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ** '''157F-EV1''': STM32MP157F-EV1 Evaluation board | ||
** '''157A/D-EV1''': | ** '''157A/D-EV1''': STM32MP157A-EV1 or STM32MP157D-EV1 Evaluation board | ||
** '''157C/F-EV1''': | ** '''157C/F-EV1''': STM32MP157C-EV1 or STM32MP157F-EV1 Evaluation board | ||
** '''157x-EV1''': | ** '''157x-EV1''': any Evaluation board with a STM32MP157 MPU | ||
** '''157A-DK1''': STM32MP157A-DK1 Discovery kit - Obsolete - This board is out of production | ** '''157A-DK1''': STM32MP157A-DK1 Discovery kit - {{Highlight|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 - Obsolete - This board is out of production | ** '''157C-DK2''': STM32MP157C-DK2 Discovery kit - {{Highlight|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-DK1''': STM32MP157A-DK1 or STM32MP157D-DK1 Discovery kit | ||
** '''157x-DK2''': STM32MP157C-DK2 or STM32MP157F-DK2 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 | |||
** '''235F-DK''': STM32MP257F-DK Discovery kit supplemented by the following message: {{STM32MP23Message}} | |||
** '''257x-DK''': any Discovery kit with a STM32MP257 MPU - {{Highlight|Not recommended, use 257F-DK instead}} | |||
** '''257F-DK''': STM32MP257F-DK Discovery kit | |||
** '''257x-EV1''': any Evaluation board with a STM32MP257 MPU - {{Highlight|Not recommended, use 257F-EV1 instead}} | |||
** '''257F-EV1''': STM32MP257F-EV Evaluation board | |||
{{ReviewsComments|-- [[User:Gerald Baeza|Gerald Baeza]] ([[User talk:Gerald Baeza|talk]]) 15:08, 6 November 2024 (CET)<br />1) 257x-DK is useless: NSA : used in 11 articles<br /> | |||
2) 257x-EV1 is useless: NSA : used in 19 articles<br> | |||
I will keep them for the lrease no time to change that, but need to be done later}} | |||
* {{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: | * {{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 | ** '''short''': the short board name (i.e without "Evaluation board" and "Discovery kit") is displayed | ||
Line 33: | Line 42: | ||
The <sup>[[File:Warning.png|15px|link=]]</sup> icon indicates that the board is currently not available. | The <sup>[[File:Warning.png|15px|link=]]</sup> icon indicates that the board is currently not available. | ||
The <sup>[[File:Info.png|15px|link=]]</sup> icon indicates that there's a custom message associated with the board. | |||
==Basic examples== | ==Basic examples== | ||
Line 55: | Line 66: | ||
{{Board | type=MP1}}<br /> | {{Board | type=MP1}}<br /> | ||
{{Board | type=MP1 | name=short}} | {{Board | type=MP1 | name=short}} | ||
|- | |||
| STM32MP135F-DK | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=135F-DK | name=short}} | |||
</pre> | |||
| | |||
{{Board | type=135F-DK | name=short}} | |||
|- | |- | ||
| STM32MP135x-DK Discovery kit | | STM32MP135x-DK Discovery kit | ||
Line 98: | Line 116: | ||
{{Board | type=157A-DK1 | name=short}} | {{Board | type=157A-DK1 | 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}} | |||
|- | |||
| Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=235F-DK}}<br> | |||
</pre> | |||
| | |||
{{Board | type=235F-DK}}<br> | |||
|- | |||
| Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU: short name | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=235F-DK}|name=short}<br> | |||
</pre> | |||
| | |||
{{Board | type=235F-DK|name=short}}<br> | |||
|- | |||
| STM32MP257F-EV1 Evaluation board | |||
<pre style="white-space: pre-wrap;"> | |||
{{Board | type=257F-EV1}} | |||
</pre> | |||
| | |||
{{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;"> | <pre style="white-space: pre-wrap;"> | ||
{{Board | type= | {{Board | type=257x-DK}} | ||
</pre> | </pre> | ||
| | | | ||
{{Board | type= | {{Board | type=257x-DK}} | ||
|} | |} | ||
Line 200: | Line 262: | ||
{{Board | type=157x-DK2 | name=short}}<br> | {{Board | type=157x-DK2 | name=short}}<br> | ||
{{Board | type=157x-DKx | name=short}} | {{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 237: | Line 327: | ||
==Code== | ==Code== | ||
{{UpdateNeededForNewBoard| | {{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|}}{{#vardefine:board|STM32MP{{{type|}}}}}{{#switch:{{{type|}}} | </noinclude>{{#vardefine:info|}}{{#vardefine:board|STM32MP{{{type|}}}}}{{#switch:{{{type|}}} | ||
| MPU = {{#vardefine:board|STM32 MPU boards}}{{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=Category:STM32_MPU_boards]]</sup>}} | | 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>}} | | 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 | | 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 | | 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 | | 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 | | 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:More_info_green.png|13px|link=STM32MP257x-DKx - hardware description]]</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>}} | |||
| 235F-DK = {{#vardefine:board|STM32MP257F-DK}} {{#ifeq: {{{name}}} | short | | {{#vardefine:board|{{#var:board}} Discovery kit}}}} {{#vardefine:info|<sup>[[File:More_info_green.png|13px|link=STM32MP257x-DKx - hardware description]]</sup> for STM32MP23x lines evaluation <span title{{=}}"{{STM32MP23Message}}"><sup>[[File:Info.png|13px|link=]]</sup></span>}} | |||
| #default = {{#vardefine:board|{{Highlight| unknown board type identifier}}}} | | #default = {{#vardefine:board|{{Highlight| unknown board type identifier}}}} | ||
}}{{#var:board}} {{#var:info}} | }}{{#var:board}} {{#var:info}} |
Latest revision as of 18:40, 12 November 2024
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
- 235F-DK: STM32MP257F-DK Discovery kit supplemented by the following message: To help you get started with STM32MP23x product lines evaluation, you can rely on the STM32MP257F-DK Discovery kit and applicable piece of STM32 MPU embedded software to run with STM32MP23 characteristics (peripherals, features, and performances).
- 257x-DK: any Discovery kit with a STM32MP257 MPU - Not recommended, use 257F-DK instead
- 257F-DK: STM32MP257F-DK Discovery kit
- 257x-EV1: any Evaluation board with a STM32MP257 MPU - Not recommended, use 257F-EV1 instead
- 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.
The icon indicates that there's a custom message associated with the board.
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= |
|
All boards with a STM32MP1 microprocessor device
{{Board | type=MP1}}<br />
{{Board | type=MP1 | name=short}}
|
|
STM32MP135F-DK
{{Board | type=135F-DK | name=short}}
|
|
STM32MP135x-DK Discovery kit
{{Board | type=135x-DK}}
|
|
STM32MP135F-DK Discovery kit
{{Board | type=135F-DK}}
|
|
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}}
|
|
All boards with a STM32MP2 microprocessor device
{{Board | type=MP2}}<br />
{{Board | type=MP2 | name=short}}
|
unknown board type identifier |
Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU
{{Board | type=235F-DK}}<br>
|
unknown board type identifier |
Discovery kits with a STM32MP235 MPU which are actually Discovery kits with a STM32MP257 MPU: short name
{{Board | type=235F-DK}|name=short}<br>
|
unknown board type identifier |
STM32MP257F-EV1 Evaluation board
{{Board | type=257F-EV1}}
|
unknown board type identifier |
STM32MP257x-EV1 Evaluation board
{{Board | type=257x-EV1}}
|
unknown board type identifier |
STM32MP257F-DK Discovery kit
{{Board | type=257F-DK}}
|
unknown board type identifier |
STM32MP257x-DK Discovery kit
{{Board | type=257x-DK}}
|
unknown board type identifier |
3. More examples[edit source]
4. Code[edit source]
unknown board type identifier