Registered User Tag: 2017 source edit |
Registered User mNo edit summary Tag: 2017 source edit |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|MPUs checklist=STM32MP13x, STM32MP15x, STM32MP25x | |MPUs checklist=STM32MP13x, STM32MP15x, STM32MP25x | ||
}}</noinclude> | }}</noinclude> | ||
{{FlowCompatibility/Android}} | |||
This article describes how to obtain and use the '''Distribution Package for Android''' of the '''STM32MPU Embedded Software''' for the '''STM32MP2 family''' ([[:Category:STM32_MPU_boards#More_about_STM32MP25_boards|STM32MP25 boards]]) development platform, in order to modify or add pieces of software, and to create the right Android distribution for the targeted product. <br> | This article describes how to obtain and use the '''Distribution Package for Android''' of the '''STM32MPU Embedded Software''' for the '''STM32MP2 family''' ([[:Category:STM32_MPU_boards#More_about_STM32MP25_boards|STM32MP25 boards]]) development platform, in order to modify or add pieces of software, and to create the right Android distribution for the targeted product. <br> | ||
It lists some '''prerequisites''' in terms of knowledge and development environment | It lists some '''prerequisites''' in terms of knowledge and development environment and gives '''step-by-step''' instructions to download and install the STM32MPU Embedded Software packages for this package. | ||
[[File:Android_distribution_package.png|right|x400px|link=]] | |||
==Distribution Package content== | ==Distribution Package content== | ||
If you are not familiar with the '''STM32MPU Embedded Software for Android''' distribution and its ''' | If you are not familiar with the '''STM32MPU Embedded Software for Android''' distribution and its '''packages''', read the following article: | ||
* [[:Category:STM32MPU Embedded Software distribution for Android|STM32MPU Embedded Software distribution for Android]] | *[[:Category:STM32MPU Embedded Software distribution for Android|STM32MPU Embedded Software distribution for Android]] | ||
In summary, this '''Distribution Package''' provides: | In summary, this '''Distribution Package''' provides: | ||
* An '''Android build framework''' ( | *An '''Android build framework''' (also known as a distribution builder) | ||
* For the '''OpenSTDroid distribution''' (development on Arm Cortex-A processor): | *For the '''OpenSTDroid distribution''' (development on Arm<sup>®</sup> Cortex-A processor): | ||
** | ** The BSP (Linux kernel, U-Boot, TF-A, OP-TEE) pieces in '''binary''' (prebuilt). Several scripts are provided to load source code and re-build them. | ||
** | ** The application frameworks (including hardware abstraction code) pieces in '''source code.''' | ||
* For the '''STM32Cube MPU Package''' (development on Arm Cortex-M processor), all pieces of software in '''source code''': BSP, HAL, middlewares and applications | *For the '''STM32Cube MPU Package''' (development on Arm Cortex-M processor), all pieces of software in '''source code''': BSP, HAL, middlewares and applications. | ||
* A toolset to tune the system for your needs | *A toolset to tune the system for your needs and to handle the built image (for example STM32CubeProgrammer to install the built image on the board). | ||
==Prerequisites== | ==Prerequisites== | ||
| Line 31: | Line 32: | ||
{{:Development setup for STM32MPU Embedded Software}} | {{:Development setup for STM32MPU Embedded Software}} | ||
== Installing the STM32MPU distribution for Android == | == Installing the STM32MPU distribution for Android== | ||
{{Warning|{{SoftwareLicenseAgreement | distribution=Android}}}} | {{Warning|{{SoftwareLicenseAgreement | distribution=Android}}}} | ||
| Line 37: | Line 38: | ||
Create a working directory for the distribution (we recommended using the distribution name): | Create a working directory for the distribution (we recommended using the distribution name): | ||
{{PC$}} mkdir {{HighlightParam|<working directory>}} | {{PC$}}mkdir {{HighlightParam|<working directory>}} | ||
{{PC$}} cd {{HighlightParam|<working directory>}} | {{PC$}}cd {{HighlightParam|<working directory>}} | ||
1- Initialize repo in the working directory: | 1- Initialize repo in the working directory: | ||
{{PC$}} repo init -u https://github.com/STMicroelectronics/android-manifest -b refs/tags/{{HighlightParam|<Tag>}} -m stm32mp2droid.xml | {{PC$}}repo init -u https://github.com/STMicroelectronics/android-manifest -b refs/tags/{{HighlightParam|<Tag>}} -m stm32mp2droid.xml | ||
With | With | ||
* {{HighlightParam|<Tag>}} = '''tag''' selecting the required version of the STM32MPU distribution for Android™ (see following table) | *{{HighlightParam|<Tag>}} = '''tag''' selecting the required version of the STM32MPU distribution for Android™ (see following table) | ||
{|class="st-table" | {| class="st-table" | ||
|- | |- | ||
| colspan="3" | '''OpenSTDroid distribution''' | | colspan="3" |'''OpenSTDroid distribution''' | ||
|- | |- | ||
| style="width:30%; | | style="text-align:center;width:30%;" |Tag | ||
| style="width:20%; | | style="text-align:center;width:20%;" |android-<version> | ||
| style="width:50%; | | style="text-align:center;width:50%;" |Release note | ||
|- | |- | ||
| style="text-align:center" | st-android-13.0.0-2024-07-31 | | style="text-align:center;" |st-android-13.0.0-2024-07-31 | ||
| style="text-align:center" | android-13.0.0_r82 | | style="text-align:center;" |android-13.0.0_r82 | ||
| style="text-align:center" | [[STM32 MPU OpenSTDroid release note - v5.1.0 | st-android-13.0.0-2024-07-31 release note (v5.1.0)]] | | style="text-align:center;" |[[STM32 MPU OpenSTDroid release note - v5.1.0 | st-android-13.0.0-2024-07-31 release note (v5.1.0)]] | ||
|} | |} | ||
2- Synchronize the local project directories with the remote repositories specified in the manifest: | 2- Synchronize the local project directories with the remote repositories specified in the manifest: | ||
{{PC$}} repo sync | {{PC$}}repo sync | ||
This may take time to | This may take time to retrieve all sources. | ||
== Local mirror == | ==Local mirror == | ||
It can be of interest to create a local mirror of the different repositories used. | It can be of interest to create a local mirror of the different repositories used. | ||
There are two possible kinds of cache: | There are two possible kinds of cache: | ||
* REPO mirror: mirror of list of modules in repositories based on provided manifest (for example Android AOSP) | *REPO mirror: mirror of list of modules in repositories based on the provided manifest (for example: Android AOSP) | ||
* GIT mirror: mirror of one module (for example Linux kernel) | *GIT mirror: mirror of one module (for example: Linux kernel) | ||
=== REPO mirror === | ===REPO mirror=== | ||
The REPO mirror is mainly used to mirror the Android AOSP sources. | |||
1- Create and go to the cache directory | 1- Create and go to the cache directory | ||
{{PC$}} mkdir {{HighlightParam|<PathToRepoCacheDir>}} | {{PC$}}mkdir {{HighlightParam|<PathToRepoCacheDir>}} | ||
{{PC$}} cd {{HighlightParam|<PathToRepoCacheDir>}} | {{PC$}}cd {{HighlightParam|<PathToRepoCacheDir>}} | ||
2- Mirror the required sources | 2- Mirror the required sources | ||
case AOSP sources needed for the required version (recommended) | case AOSP sources needed for the required version (recommended) | ||
{{PC$}} repo init -u https://android.googlesource.com/platform/manifest -b {{HighlightParam|<Tag>}} --mirror | {{PC$}}repo init -u https://android.googlesource.com/platform/manifest -b {{HighlightParam|<Tag>}} --mirror | ||
{{PC$}} repo sync -q | {{PC$}}repo sync -q | ||
case full AOSP sources | case full AOSP sources | ||
{{PC$}} repo init -u https://android.googlesource.com/platform/manifest --mirror | {{PC$}}repo init -u https://android.googlesource.com/platform/manifest --mirror | ||
{{PC$}} repo sync -q | {{PC$}}repo sync -q | ||
3- Create environment variable for this cache directory | 3- Create environment variable for this cache directory | ||
{{PC$}} export CACHE_DIR={{HighlightParam|<PathToRepoCacheDir>}} | {{PC$}}export CACHE_DIR={{HighlightParam|<PathToRepoCacheDir>}} | ||
{{Info|It | {{Info|It is recommended to add this line in your <code>.bashrc</code> file available in your HOME directory}} | ||
4- Use the cache directory | 4- Use the cache directory | ||
Add {{HighlightParam|--reference{{=}}$CACHE_DIR}} option to your <code>repo init</code> command. | Add {{HighlightParam|--reference{{=}}$CACHE_DIR}} option to your <code>repo init</code> command. | ||
{{PC$}} repo init {{HighlightParam|--reference{{=}}$CACHE_DIR}} -u https://github.com/ | {{PC$}}repo init {{HighlightParam|--reference{{=}}$CACHE_DIR}} -u https://github.com/STMicroelectronics/android-manifest -b refs/tags/{{HighlightParam|<Tag>}} -m stm32mp2droid.xml | ||
=== GIT mirror === | === GIT mirror=== | ||
While the distribution has been installed, a helper script <code>cachesetup</code> is available for this purpose, which creates / updates the mirrors based on the configuration file <code>device/stm/<STM32Series>/scripts/cache/android_cache.config</code>. | While the distribution has been installed, a helper script <code>cachesetup</code> is available for this purpose, which creates / updates the mirrors based on the configuration file <code>device/stm/<STM32Series>/scripts/cache/android_cache.config</code>. | ||
Make sure that if you change the environment variable name, you also update the associated <code>load_xxxx</code> scripts available in <code>device/stm/<STM32Series>-xxxx/source</code> directory. | |||
Create the mirrors by executing the following commands: | Create the mirrors by executing the following commands: | ||
{{PC$}} source build/envsetup.sh | {{PC$}}source build/envsetup.sh | ||
{{PC$}} cachesetup --new | {{PC$}}cachesetup --new | ||
Regular updating of your mirror is recommended by executing: | Regular updating of your mirror is recommended by executing: | ||
{{PC$}} cachesetup | {{PC$}}cachesetup | ||
For more information on how to use this command, | For more information on how to use this command, refer to the cache setup usage (execute <code>cachesetup -h</code>). | ||
{{Info|It | {{Info|It is possible to update the AOSP or the Android REPO mirror using the command <code>cachesetup aosp</code> or <code>cachesetup android</code>}} | ||
== Building the OpenSTDroid distribution == | ==Building the OpenSTDroid distribution == | ||
When the installation is complete, | When the installation is complete, refer to the [[How to build OpenSTDroid distribution]] page to learn how to build it. | ||
== Flashing the built image== | == Flashing the built image== | ||
When the distribution has been built, | When the distribution has been built, refer to the [[How to populate boards for Android]] page to learn how to flash your device. | ||
==References== | ==References== | ||
| Line 128: | Line 128: | ||
<noinclude> | <noinclude> | ||
[[Category: | [[Category:OpenSTDroid_distribution_packages]] | ||
[[Category:Distribution Package]] | [[Category:Distribution Package]] | ||
[[Category:Android]] | [[Category:Android]] | ||
{{PublicationRequestId | | {{PublicationRequestId | 33623 | 2025-01-13 | }} | ||
</noinclude> | </noinclude> | ||
Latest revision as of 14:52, 18 March 2025
This article describes how to obtain and use the Distribution Package for Android of the STM32MPU Embedded Software for the STM32MP2 family (STM32MP25 boards) development platform, in order to modify or add pieces of software, and to create the right Android distribution for the targeted product.
It lists some prerequisites in terms of knowledge and development environment and gives step-by-step instructions to download and install the STM32MPU Embedded Software packages for this package.
1. Distribution Package content[edit | edit source]
If you are not familiar with the STM32MPU Embedded Software for Android distribution and its packages, read the following article:
In summary, this Distribution Package provides:
- An Android build framework (also known as a distribution builder)
- For the OpenSTDroid distribution (development on Arm® Cortex-A processor):
- The BSP (Linux kernel, U-Boot, TF-A, OP-TEE) pieces in binary (prebuilt). Several scripts are provided to load source code and re-build them.
- The application frameworks (including hardware abstraction code) pieces in source code.
- For the STM32Cube MPU Package (development on Arm Cortex-M processor), all pieces of software in source code: BSP, HAL, middlewares and applications.
- A toolset to tune the system for your needs and to handle the built image (for example STM32CubeProgrammer to install the built image on the board).
2. Prerequisites[edit | edit source]
2.1. Knowledge[edit | edit source]
The STM32MPU Distribution Package aims to create an Android distribution for the targeted product: solid knowledge of Linux and Android are recommended to make the most of this Package.
The STM32MPU distribution for Android is an Android distribution based on the Android build framework: a short introduction about Android is available in AOSP[1].
Reading the STM32MPU Embedded Software for Android architecture overview is also highly recommended.
2.2. Development setup[edit | edit source]
The recommended setup for the development PC (host) is specified in the following article: PC prerequisites.
Whatever the development platform (board) and development PC (host) used, the range of possible development setups is illustrated by the picture below.
The following components are mandatory:
- Host PC for cross-compilation and cross-debugging, installed as specified above
- Board assembled and configured as specified in the associated Starter Package article
- Mass storage device (for example, microSD card) to load and update the software images (binaries)
The following components are optional, but recommended:
- A serial link between the host PC (through Terminal program) and the board for traces (even early boot traces), and access to the board from the remote PC (command lines)
- An Ethernet link between the host PC and the board for cross-development and cross-debugging through a local network. This is an alternative or a complement to the serial (or USB) link
- A display connected to the board, depending on the technologies available on the board: DSI LCD display, HDMI monitor (or TV) and so on
- A mouse and a keyboard connected through USB ports
Additional optional components can be added by means of the connectivity capabilities of the board: cameras, displays, JTAG, sensors, actuators, and much more.
3. Installing the STM32MPU distribution for Android[edit | edit source]
The installation relies on the repo command. If the Repo tool (a Google-built repository management tool that runs on top of Git) is not already installed and configured on the host PC, refer to the PC prerequisites article.
Create a working directory for the distribution (we recommended using the distribution name):
mkdir <working directory> cd <working directory>
1- Initialize repo in the working directory:
repo init -u https://github.com/STMicroelectronics/android-manifest -b refs/tags/<Tag> -m stm32mp2droid.xml
With
- <Tag> = tag selecting the required version of the STM32MPU distribution for Android™ (see following table)
| OpenSTDroid distribution | ||
| Tag | android-<version> | Release note |
| st-android-13.0.0-2024-07-31 | android-13.0.0_r82 | st-android-13.0.0-2024-07-31 release note (v5.1.0) |
2- Synchronize the local project directories with the remote repositories specified in the manifest:
repo sync
This may take time to retrieve all sources.
4. Local mirror[edit | edit source]
It can be of interest to create a local mirror of the different repositories used.
There are two possible kinds of cache:
- REPO mirror: mirror of list of modules in repositories based on the provided manifest (for example: Android AOSP)
- GIT mirror: mirror of one module (for example: Linux kernel)
4.1. REPO mirror[edit | edit source]
The REPO mirror is mainly used to mirror the Android AOSP sources.
1- Create and go to the cache directory
mkdir <PathToRepoCacheDir> cd <PathToRepoCacheDir>
2- Mirror the required sources
case AOSP sources needed for the required version (recommended)
repo init -u https://android.googlesource.com/platform/manifest -b <Tag> --mirror repo sync -q
case full AOSP sources
repo init -u https://android.googlesource.com/platform/manifest --mirror repo sync -q
3- Create environment variable for this cache directory
export CACHE_DIR=<PathToRepoCacheDir>
4- Use the cache directory
Add --reference=$CACHE_DIR option to your repo init command.
repo init --reference=$CACHE_DIR -u https://github.com/STMicroelectronics/android-manifest -b refs/tags/<Tag> -m stm32mp2droid.xml
4.2. GIT mirror[edit | edit source]
While the distribution has been installed, a helper script cachesetup is available for this purpose, which creates / updates the mirrors based on the configuration file device/stm/<STM32Series>/scripts/cache/android_cache.config.
Make sure that if you change the environment variable name, you also update the associated load_xxxx scripts available in device/stm/<STM32Series>-xxxx/source directory.
Create the mirrors by executing the following commands:
source build/envsetup.sh
cachesetup --new
Regular updating of your mirror is recommended by executing:
cachesetup
For more information on how to use this command, refer to the cache setup usage (execute cachesetup -h).
5. Building the OpenSTDroid distribution[edit | edit source]
When the installation is complete, refer to the How to build OpenSTDroid distribution page to learn how to build it.
6. Flashing the built image[edit | edit source]
When the distribution has been built, refer to the How to populate boards for Android page to learn how to flash your device.
7. References[edit | edit source]
Arm® is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere. 