Last edited 4 years ago

OpenSTLinux distribution: Difference between revisions

Registered User
mNo edit summary
Registered User
mNo edit summary
 
(18 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<noinclude>
{{ArticleMainWriter|DenisH}}
{{ArticleApprovedVersion|DenisH| NathalieS, ChristopheM | RomualdJ - 27Feb'18  | Philip S. - 28Jun'18 - 8358| 28Jun'18 }}
[[Category:OpenSTLinux distribution|00]]
</noinclude>
==What is the OpenSTLinux distribution?==
==What is the OpenSTLinux distribution?==
The OpenSTLinux distribution, running on the Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A processor(s), is a sub-part of the [[STM32MPU Embedded Software distribution]].
The OpenSTLinux distribution, running on the Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A processor(s), is a sub-part of the [[STM32MPU Embedded Software distribution]].
Line 22: Line 14:
As explained in the [[OpenEmbedded]] article, the files used to build an image are stored in layers that come from different sources, and that are configured for this image. <br>
As explained in the [[OpenEmbedded]] article, the files used to build an image are stored in layers that come from different sources, and that are configured for this image. <br>
Only layers specific to the OpenSTLinux distribution (for example the OpenSTLinux Board Support Package layer) are detailed in the [[#Layers|Layers]]  chapter below. Community layers referenced in this article are not listed.
Only layers specific to the OpenSTLinux distribution (for example the OpenSTLinux Board Support Package layer) are detailed in the [[#Layers|Layers]]  chapter below. Community layers referenced in this article are not listed.
{{ProductMarketingReviewsComments| JLD : today:The diagram inludes Yocto while not described into the above comment. That might drive some confusion..Is Yocto included into the distro or not??}}
{{ReviewsComments| JLD (product maketing): today:The diagram inludes Yocto while not described into the above comment. That might drive some confusion..Is Yocto included into the distro or not??}}




Line 28: Line 20:


==Software architecture overview==
==Software architecture overview==
The figure below gives an overview of the [[OpenSTLinux architecture overview|OpenSTLinux architecture]]. This figure is clickable so that you can directly jump to one of the sub-levels.<br>
The figure below gives an overview of the [[OpenSTLinux architecture overview|OpenSTLinux architecture]]. You can obtain more details by clicking on one of the sub-levels.<br>
{{ProductMarketingReviewsComments| JLD: Today:The reader can obtain more deatils by clicking on figures below instead of this figure is clickable..}}


The '''Linux application frameworks''' (or Linux user space components) that rely on the [[OpenSTLinux BSP architecture overview|OpenSTLinux BSP]], mainly come from open-source communities.
The '''Linux application frameworks''' (or Linux user space components) that rely on the [[OpenSTLinux BSP architecture overview|OpenSTLinux BSP]], mainly come from open-source communities.


OpenEmbedded core components (community layers) are thus completed with STMicroelectronics-specifc layers (for example the BSP layer). This gives a coherent basis for customers, who can then start their application developments easily, based on standard interfaces such as the Wayland display protocol.
OpenEmbedded core components (community layers) combined with STMicroelectronics-specific layers (for example the BSP layer) give a consistent starting point to develop customer applications based on a standardized interface.
{{ProductMarketingReviewsComments| JLD: today:OpenEmbedded core components combined withSTMicroelectronics-specifc layers give a consistent starting point to start customer application developments based on standardized interface }}


{{:OpenSTLinux architecture overview}}
{{:OpenSTLinux architecture overview}}
Line 40: Line 30:
==OpenSTLinux concept==
==OpenSTLinux concept==


To build software based on an OpenSTLinux release, you must select a combination of machine, image and distro.<br>
To build an OpenSTLinux based software, a combination of machine, image and distro must be selected.<br>
{{ProductMarketingReviewsComments| JLD : Today:To buid an OpenSTLinux based software, a combination of machine, image and distro must be selected}}
Available machines, images and distros are listed below.
Available machines, images and distros are listed below.


More information on how to compile and use an OpenSTLinux distribution can be found in the '''Distribution Package''' articles available in [[:category:Distribution Package]]. It is up to you to select the one corresponding to the STM32 MPU used.
More information on how to compile and use an OpenSTLinux distribution can be found in the '''Distribution Package''' articles available in [[:category:Distribution Package]].
{{ProductMarketingReviewsComments| JLD : today:I would discard "it is up to you to select the ...}}


===Layers===
===Layers===
This chapter describes the layers developed by STMicroelectonics.
This chapter describes the layers developed by STMicroelectonics.
{{ProductMarketingReviewsComments| JLD : Today: I think there is a different hirarchy to take into account between Layers / machine & image & distro... Machine should not be 3.1.1, image 3.1.2 etc..}}
{{ReviewsComments| JLD (product marketing): Today: I think there is a different hirarchy to take into account between Layers / machine & image & distro... Machine should not be 3.1.1, image 3.1.2 etc..}}


STMicroelectronics' strategy is to organize the layers in order to split BSP descriptions from applications and frameworks.<br>
STMicroelectronics' strategy is to organize the layers in order to split BSP descriptions from applications and frameworks.<br>
By doing this, any BSP can be combined with any framework, or no framework at all.
By doing this, any BSP can be combined with any framework, or no framework at all.
   
   
{| class="wikitable" style="text-align: left; border-style: solid; border-width: 3px; border-color:#00C0FF"
{| class="st-table" style="text-align: left; "
|-
|-
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center"| Layer
!   align="center" valign="center"| Layer
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center"| Description
!   align="center" valign="center"| Description
|-
|-
| meta-st-stm32mp || BSP Layer for stm32mp
| meta-st-stm32mp || BSP Layer for stm32mp
Line 69: Line 57:
If necessary, you can also create your own layer. The procedure to do so is explained in [[How_to_create_a_new_open_embedded_layer]].
If necessary, you can also create your own layer. The procedure to do so is explained in [[How_to_create_a_new_open_embedded_layer]].


{| class="wikitable" style="text-align: left; border-style: solid; border-width: 3px; border-color:#00C0FF"
{| class="st-table" style="text-align: left; "
|-
|-
! style="border-style: solid; border-width: 3px; border-color:#00C0FF" align="center" valign="center"| Layer
!  align="center" valign="center"| Layer
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center"| Description
! align="center" valign="center"| Description
|-
|-
| meta-st-stm32mp-addons || BSP Layer addons for stm32mp (CubeMX Machine)
| meta-st-stm32mp-addons || BSP Layer addons for stm32mp (CubeMX Machine)
Line 80: Line 68:


===Machines===
===Machines===
{| class="wikitable" style="text-align: left; border-style: solid; border-width: 3px; border-color:#00C0FF"
{| class="st-table" style="text-align: left; "
|-
|-
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center"| Machine
! align="center" valign="center"| Machine
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center"| Description
! align="center" valign="center"| Description
|-
|-
| stm32mp1 || Machine configuration for STM32MP1 microprocessor device boards
| stm32mp1 || Machine configuration for STM32MP1 microprocessor device boards
Line 93: Line 81:


===Images===
===Images===
{| class="wikitable" style="text-align: left; border-style: solid; border-width: 3px; border-color:#00C0FF"
{| class="st-table" style="text-align: left; "
|-
|-
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center "| Image
! align="center" valign="center "| Image
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center "| Description
! align="center" valign="center "| Description
|-
|-
!! colspan="2" style="background-color: Grey;"| Official images
!! colspan="2" | '''Official images'''
|-
|-
| st-image-weston || OpenSTLinux weston image with basic Wayland support (if enabled in distro)
| st-image-weston || OpenSTLinux weston image with basic Wayland support (if enabled in distro)
|-
|-
!! colspan="2" style="background-color: Grey;"| Supported images
!! colspan="2" | '''Supported images'''
|-
|-
| st-image-core || OpenSTLinux core image
| st-image-core || OpenSTLinux core image
|-
|-
!! colspan="2" style="background-color: Grey;"| Proposed images as example only
!! colspan="2" | '''Images, proposed as example only'''
|-
|-
| st-example-image-qt || ST example of image based on QT framework
| st-example-image-qt || ST example of image based on QT framework
|-
|-
| st-example-image-x11 || ST example of image based on X11
| st-example-image-qtwayland || ST example of image based on QT framework (available for {{EcosystemRelease | revision=2.1.0 | range=and after}})
|-
| st-example-image-xfce || ST example of image based on XFCE framework
|-
| st-example-image-gtk || ST example of image based on GTK framework
|}
|}


===Distros===
===Distros===


For further details on distributions (distros), read "Creating a distribution"  <ref> http://www.yoctoproject.org/docs/2.4/mega-manual/mega-manual.html#creating-your-own-distribution Creating a distribution </ref>
For further details on distributions (distros), read "Creating a distribution"  <ref>{{DocSource | domain=Yocto Project | path=mega-manual/mega-manual.html#creating-your-own-distribution | text=Creating a distribution}}</ref>


{| class="wikitable" style="text-align: left; border-style: solid; border-width: 3px; border-color:#00C0FF"
{| class="st-table" style="text-align: left;"
|-
|-
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center "| Distro
! align="center" valign="center "| Distro
! style="border-style: solid; border-width: 3px; border-color:#00C0FF"  align="center" valign="center "| Description
! align="center" valign="center "| Description
|-
|-
| openstlinux-eglfs || OpenSTLinux featuring eglfs - no X11, no Wayland
| openstlinux-eglfs || OpenSTLinux featuring eglfs - no X11, no Wayland
|-
|-
| openstlinux-weston || OpenSTLinux featuring Weston/Wayland
| openstlinux-weston || OpenSTLinux featuring Weston/Wayland
|-
| openstlinux-x11 || OpenSTLinux featuring X11
|-
|-
| nodistro || *** DEFAULT OPENEMBEDDED SETTING : DISTRO is not defined ***  
| nodistro || *** DEFAULT OPENEMBEDDED SETTING : DISTRO is not defined ***  
|}
|}
===Reference source code===
The TF-A, U-Boot, OP-TEE and kernel components have been configured by default to use '''tarball + patches''' for source code.
If you prefer to use '''github'''<sup>&reg;</sup> as a source code reference, you need to update your local.conf file
Refer to the section ‘Configure STM32MP default version to github’ in local.conf :
# =========================================================================
# Configure STM32MP default version to github
# =========================================================================
#STM32MP_SOURCE_SELECTION_pn-linux-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-optee-os-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-tf-a-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-u-boot-stm32mp = "github"
Then just uncomment the line to switch the component to github<sup>&reg;</sup> for source code.


==How to get the software for this distribution==
==How to get the software for this distribution==
The OpenSTLinux distribution is available through the three Packages (Starter, Developer, and Distribution) of the [[STM32MPU Embedded Software distribution|STM32MPU Embedded Software ecosystem]].
The OpenSTLinux distribution is available through the three Packages (Starter, Developer, and Distribution) of the [[STM32MPU Embedded Software distribution|STM32MPU Embedded Software distribution]].


==References==
==References==
<references/>
<references/>
<noinclude>
[[Category:OpenSTLinux distribution|00]]
{{PublicationRequestId | 8358 | 2018-06-18 | PhilipS}}
</noinclude>

Latest revision as of 20:42, 25 March 2021

1. What is the OpenSTLinux distribution?[edit source]

The OpenSTLinux distribution, running on the Arm® Cortex®-A processor(s), is a sub-part of the STM32MPU Embedded Software distribution.

OpenSTLinux distribution.png

OpenSTLinux is a Linux® distribution based on the OpenEmbedded build framework.

It includes the following collection of software components:

As explained in the OpenEmbedded article, the files used to build an image are stored in layers that come from different sources, and that are configured for this image.
Only layers specific to the OpenSTLinux distribution (for example the OpenSTLinux Board Support Package layer) are detailed in the Layers chapter below. Community layers referenced in this article are not listed.


The Machines chapter introduces the machine metadata (the information needed to build a kernel for specific target boards), while the Images chapter specifies the images that contain the information needed to build the user space. The Distros chapter describes the available distros configurations.

2. Software architecture overview[edit source]

The figure below gives an overview of the OpenSTLinux architecture. You can obtain more details by clicking on one of the sub-levels.

The Linux application frameworks (or Linux user space components) that rely on the OpenSTLinux BSP, mainly come from open-source communities.

OpenEmbedded core components (community layers) combined with STMicroelectronics-specific layers (for example the BSP layer) give a consistent starting point to develop customer applications based on a standardized interface.


Template:ImageMap


3. OpenSTLinux concept[edit source]

To build an OpenSTLinux based software, a combination of machine, image and distro must be selected.
Available machines, images and distros are listed below.

More information on how to compile and use an OpenSTLinux distribution can be found in the Distribution Package articles available in category:Distribution Package.

3.1. Layers[edit source]

This chapter describes the layers developed by STMicroelectonics.


STMicroelectronics' strategy is to organize the layers in order to split BSP descriptions from applications and frameworks.
By doing this, any BSP can be combined with any framework, or no framework at all.

Layer Description
meta-st-stm32mp BSP Layer for stm32mp
meta-st-openstlinux OpenSTLinux layer - framework/image settings

For the detailed content of the layers, please check STM32MP15_OpenSTLinux_release_note#Detailed delivery content

In addition, in OpenSTLinux distribution, a layer (meta-st-stm32mp-addons) has been created to manage STM32CubeMX integration.
If necessary, you can also create your own layer. The procedure to do so is explained in How_to_create_a_new_open_embedded_layer.

Layer Description
meta-st-stm32mp-addons BSP Layer addons for stm32mp (CubeMX Machine)
meta-my-custo-layer framework addons/customization

3.2. Machines[edit source]

Machine Description
stm32mp1 Machine configuration for STM32MP1 microprocessor device boards
stm32mp1-eval Machine configuration for STM32MP1 evaluation board
stm32mp1-disco Machine configuration for STM32MP1 disco board

3.3. Images[edit source]

Image Description
Official images
st-image-weston OpenSTLinux weston image with basic Wayland support (if enabled in distro)
Supported images
st-image-core OpenSTLinux core image
Images, proposed as example only
st-example-image-qt ST example of image based on QT framework
st-example-image-qtwayland ST example of image based on QT framework (available for ecosystem release ≥ v2.1.0 More info.png )

3.4. Distros[edit source]

For further details on distributions (distros), read "Creating a distribution" [1]

Distro Description
openstlinux-eglfs OpenSTLinux featuring eglfs - no X11, no Wayland
openstlinux-weston OpenSTLinux featuring Weston/Wayland
nodistro *** DEFAULT OPENEMBEDDED SETTING : DISTRO is not defined ***

3.5. Reference source code[edit source]

The TF-A, U-Boot, OP-TEE and kernel components have been configured by default to use tarball + patches for source code.

If you prefer to use github® as a source code reference, you need to update your local.conf file

Refer to the section ‘Configure STM32MP default version to github’ in local.conf :

# =========================================================================
# Configure STM32MP default version to github
# =========================================================================
#STM32MP_SOURCE_SELECTION_pn-linux-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-optee-os-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-tf-a-stm32mp = "github"
#STM32MP_SOURCE_SELECTION_pn-u-boot-stm32mp = "github"

Then just uncomment the line to switch the component to github® for source code.

4. How to get the software for this distribution[edit source]

The OpenSTLinux distribution is available through the three Packages (Starter, Developer, and Distribution) of the STM32MPU Embedded Software distribution.

5. References[edit source]