View source for Which STM32MPU Embedded Software Package better suits your needs

The STM32MPU Embedded Software distribution for STM32 microprocessor platforms supports three software Packages:
* The '''Starter Package''' to quickly and easily start with any STM32MP microprocessor device. The Starter Package is generated from the Distribution Package.
* The '''Developer Package''' to add your own developments on top of the STM32MPU Embedded Software distribution, or to replace the Starter Package pre-built binaries. The Developer Package is generated from the Distribution Package.
* The '''Distribution Package''' to create your own Linux<sup>&reg;</sup> distribution, your own Starter Package and your own Developer Package.
<br />

[[File: STM32_MPU_Embedded_Software_Packages.png|thumb|upright=4|center|link=|STM32MPU Embedded Software distribution Packages]]
<br />

{{highlight|'''This article describes in details the above Packages ("ways of working") and helps finding the one that best fits your use case. Packages are standalone, but they are not isolated one from the others: there are gateways between them.'''}}

This article starts by an overview of the STM32MPU Embedded Software distribution components. <br>
It concludes by providing an example of production cycle based on the three Packages.

==Overview of STM32MPU Embedded Software distribution components==
The STM32MPU Embedded Software distribution includes the following components (as illustrated in the figure below):
* Binaries: software images
* [[SDK for OpenSTLinux distribution|Software development kit (SDK)]]:
** Cross-development toolchain
** Libraries, headers and symbols
** Environment setup scripts
* Source code for:
** The [[OpenSTLinux distribution]] (U-Boot, TF-A, OP-TEE, Linux<sup>&reg;</sup> kernel, application frameworks) running on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A processor(s)
** The [[STM32CubeMP1 Package]] running on Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor(s)
* Build framework for embedded Linux<sup>&reg;</sup> (based on [[OpenEmbedded]] that is the recommended build system of the Yocto Project):
** BitBake: a make-like build tool
** Recipes: a recipe specifies how a particular package is built
** Layers: a layer is a collection of recipes and/or configurations used on top of the OpenEmbedded core
* Documentation and tools such as:
** The present wiki
** The STM32CubeProgrammer 
** Integrated development environments (IDE)

<br>
[[File: STM32_MPU_Embedded_Software_components.png|thumb|upright=4|center|link=|STM32MPU Embedded Software distribution components <br> ''Nota: Documentation and tools are cross-Package components. They are not described in this article: consequently, they are implicitly present in all the figures of this article.'']]
<br>

Each of the three Packages described below is made of some of the above components. <br>

==Starter Package==
This Package allows to quickly and easily get any STM32 microprocessor development platform up and running. <br>
An STM32 microprocessor development platform (such as [[STM32MP157C-EV1 - hardware description|STM32MP157C-EV1 Evaluation board]]) and a microSD card (populated with the software image delivered for this platform) are all what is required to discover the platform capabilities.
No integrated development environment (IDE), no software development kit (SDK) are needed: just use the development platform as a "micro-PC" running Linux<sup>&reg;</sup>. <br>
The software image contains firmware delivered as examples with regards to the STM32Cube MPU Package (if the considered development platform includes an Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor).

<br>
[[File: STM32_MPU_Embedded_Software_Starter_Package.png|thumb|upright=4|center|link=|Starter Package components]]
<br>

'''What are the main use cases that can be covered with this Package?'''
* Evaluation of the STM32 microprocessor device and development platform (such as internal peripherals and performance)
* Execution of the Cube M4 firmware projects delivered within each STM32MPU Embedded Software distribution Starter Package (such as the firmware available on the Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor<br />
::Please read [[STM32CubeMP1 Package#Starter Package for STM32CubeMP1]] article to get started with running Cube M4 firmware
* Direct development on the development platform of simple user examples in different languages (Shell, Python...) 

<br>
For more information on the Starter Package depending on your development platform, refer to the corresponding Starter Package article named '''''Your_development_platform'' - Starter Package'''. <br>
Example: [[STM32MP15 Evaluation boards - Starter Package]] for the STM32MP15 Evaluation boards. <br>
All ''Starter Package'' articles belong to the [[:Category:Starter Package]]. <br> <br>


'''Switch to the next Package if you need to:'''
* modify or tune any piece of software of the STM32MPU Embedded Software distribution (e.g. Linux<sup>&reg;</sup> kernel)
* integrate pieces of software from open-source communities or third parties
* develop and integrate your own applications
* benefit from a software development kit (e.g. for powerful cross-development toolchain)
* take advantage of an integrated development environment (IDE).

==Developer Package==
This Package allows the modification of some pieces of software of the STM32MPU Embedded Software distribution, as well as the addition of your applications in your platform software image. <br>
The Developer Package provides on top of the Starter Package:
* a software development kit (SDK) for cross-development on an host PC
* the following pieces of software of the OpenSTLinux distribution in '''source code''':
** U-Boot
** Trusted Firmware-A (TF-A)
** Linux<sup>&reg;</sup> kernel
** Optionally, Open source Trusted Execution Environment (OP-TEE)
* The STM32Cube MPU Package in '''source code''' (if the considered development platform includes an Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor)
* Initialization code generator (STM32CubeMX). This tool makes it possible to 
** generate device tree for OpenSTLinux distribution
** generate the peripheral initialization C code and IDE project creation files for STM32Cube MPU package 
* An Eclipse-based integrated development environment (IDE) - [[STM32-CoPro-MPU plugin for SW4STM32]]
** STM32Cube firmware projects are supported by ''STM32-CoPro-MPU'' Eclipse plugin. 
** Projects files generated by STM32CubeMX can be directly opened by this IDE to continue Cube firmware development.
** IDE is '''''optional''''' for OpenSTLinux development since all actions can be achieved through a command line 

{{Info|The Developer Package doesn't include the '''application frameworks''' (Linux<sup>&reg;</sup> user space applications, U-Boot applications and OP-TEE user space applications) in '''source code'''.}}

<br>
[[File: STM32_MPU_Embedded_Software_Developer_Package.png|thumb|upright=4|center|link=|Developer Package components]]
<br>

'''What are the main use cases that can be covered with this Package?'''
* Modification and tuning of the pieces of software delivered as source code (see above list):
** Code modification
** Efficient development cycle (compile, push on target, debug)
** Tuning of the configuration options (e.g. for the Linux<sup>&reg;</sup> kernel)
** Adaptation of the device tree files for the microprocessor device and development platform
* Development of the firmware running on the Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-M processor
::Please read [[STM32CubeMP1 Package#Developer Package for STM32CubeMP1]] article to get started with building and running Cube M4 firmware
* Addition of your own Linux<sup>&reg;</sup> applications or Linux<sup>&reg;</sup> application frameworks
* Addition of your own trusted applications (TA) (if OP-TEE is part of the software release)
* Addition of your own U-Boot applications

<br>
For more information on the Developer Package for a given STM32 microprocessors Series, refer to the corresponding Developer Package article named '''''STM32_microprocessors_series'' Developer Package'''. <br>
Example: [[STM32MP1 Developer Package]] for the STM32MP1 microprocessors Series. <br>
All ''Developer Package'' articles belong to the [[:Category:Developer Package]]. <br><br>


'''Switch to the next Package if you need to:'''
* modify or tune the (U-Boot, OP-TEE and Linux<sup>&reg;</sup>) application frameworks of the OpenSTLinux distribution
* create your own distribution (e.g. to integrate and share pieces of software from open source communities or third parties)
* generate your own software development kit (SDK) and images

==Distribution Package==
This Package allows the creation of a new distribution with a final objective of productization. <br>
It includes the source code of all the pieces of software of the STM32MPU Embedded Software distribution (including the application frameworks), plus a build framework based on [[OpenEmbedded]] (aka distribution builder).
A host PC is required to operate this Package (a Linux<sup>&reg;</sup> host PC is even strongly recommended).

<br>
[[File: STM32_MPU_Embedded_Software_Distribution_Package.png|thumb|upright=4|center|link=|Distribution Package components]]
<br>

'''What are the main use cases that can be covered with this Package?'''
* Creation of your own Linux<sup>&reg;</sup> distribution
** to tune the system configuration options (such as memory sizes or debug options)
** to share all the developments within your team (software baseline)
** to prepare the final software for productization
* Integration of the following software in this distribution:
** your developments made thanks to the Developer Package
** pieces of software coming from open source communities or third parties
** Integrate your Cube M4 firmware projects in your own distribution (binary or source code)
::Please read [[STM32CubeMP1 Package#Distribution Package for STM32CubeMP1]] article to understand how Cube M4 firmware projects have been installed in STM32MPU Embedded software distribution
* Generation of your own Starter Package images
* Generation of your own Developer Package SDK
 
<br>
Generally speaking, few dedicated people from the project team use this Distribution Package to create and regularly enrich the project Linux<sup>&reg;</sup> distribution and generate the project Developer Package. Most of developers will use this Developer Package for their developments, since it is a light weighted and efficient (short development cycle) environment.

For more information on the Distribution Package for a given STM32 microprocessor Series, refer to the corresponding Distribution Package article named '''''STM32MP_microprocessors_series'' Distribution Package'''. <br>
Example: [[STM32MP1 Distribution Package]] for the STM32MP1 microprocessors Series.
All ''Distribution Package'' articles belong to the [[:Category:Distribution Package]].

==Example of production cycle==
The following figures give an '''example''' of gateways between the different Packages, that might be seen as a production cycle.

<br>
[[File: STM32_MPU_Embedded_Software_production_cycle_1.png|thumb|upright=5|center|link=|STM32MPU Embedded Software distribution: evaluation, development and integration]]
<br>

In the example given above, the developers use the Developer Package of the STM32MPU Embedded Software distribution to create an add-on piece of software (e.g. Linux<sup>&reg;</sup> application on top of the Linux<sup>&reg;</sup> application frameworks) and modify the Linux<sup>&reg;</sup> kernel. Their deliveries are integrated on top of the Distribution Package of the STM32MPU Embedded Software distribution, together with pieces of software from an open source community and a third party. The result is your own Distribution Package.

<br>
[[File: STM32_MPU_Embedded_Software_production_cycle_2.png|thumb|upright=5|center|link=|Your distribution: generating, improving and productizing]]
<br>

In the example given above, your new images (binaries) and your new Developer Package are generated from this new Distribution Package. The developers base their additional developments on this new Developer Package. The production cycle is then initiated.

<noinclude>
{{PublicationRequestId | 5952 | 2018-01-18}}
[[Category:Prerequisites]]
[[Category:STM32 MPU boards]]
</noinclude>