Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Update: Update the Top Level Makefile and cross-compile instructions #47

Merged
merged 2 commits into from
Nov 30, 2024
Merged

Docs Update: Update the Top Level Makefile and cross-compile instructions #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
415b292
docs(package update): Update the required host packages in Top Level …
jeevantelukula Nov 14, 2024
6260f8a
docs(GCC_Toolchain): Update the cross compile and sysroot paths for A…
jeevantelukula Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions configs/AM57X/AM57X_linux_config.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Replacement Variables
'__SDK_DOWNLOAD_URL__' : '`AM57X-Linux-SDK-Download-page <http://software-dl.ti.com/processor-sdk-linux/esd/AM57X/latest/index_FDS.html>`__'
'__LINUX_UBUNTU_VERSION_LONG__' : '18.04 (64-bit)'
'__LINUX_UBUNTU_VERSION_SHORT__' : '18.04'
'__OPTEE_PLATFORM_FLAVOR__' : 'am57xx'
'__RTOS_UBUNTU_VERSION_LONG__' : '18.04 (64-bit)'
'__WINDOWS_SUPPORTED_LONG__' : '7 (64-bit)'
'__FEATURINGMATRIX__' : \
Expand Down
174 changes: 122 additions & 52 deletions source/linux/Overview/GCC_ToolChain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,22 @@ GCC ToolChain Setup
Before compiling any of the sources referenced in this document, set the cross compiler paths to the toolchains packaged in the Processor SDK [Recommended] as shown below. Refer to :ref:`yocto-toolchain` section for more details on usage.

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# export CROSS_COMPILE_32="${SDK_INSTALL_DIR}/linux-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-linux-gnueabi/arm-oe-linux-gnueabi-"
host# export SYSROOT_32="${SDK_INSTALL_DIR}/linux-devkit/sysroots/armv7at2hf-neon-oe-linux-gnueabi"
host# export CC_32="${CROSS_COMPILE_32}gcc --sysroot=${SYSROOT_32}"
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

host# export CROSS_COMPILE_64="${SDK_INSTALL_DIR}/linux-devkit/sysroots/x86_64-arago-linux/usr/bin/aarch64-oe-linux/aarch64-oe-linux-"
host# export SYSROOT_64="${SDK_INSTALL_DIR}/linux-devkit/sysroots/aarch64-oe-linux"
host# export CC_64="${CROSS_COMPILE_64}gcc --sysroot=${SYSROOT_64}"
host# export CROSS_COMPILE_32="${SDK_INSTALL_DIR}/k3r5-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-eabi/arm-oe-eabi-"
.. code-block:: console
host# export CROSS_COMPILE_64="${SDK_INSTALL_DIR}/linux-devkit/sysroots/x86_64-arago-linux/usr/bin/aarch64-oe-linux/aarch64-oe-linux-"
host# export SYSROOT_64="${SDK_INSTALL_DIR}/linux-devkit/sysroots/aarch64-oe-linux"
host# export CC_64="${CROSS_COMPILE_64}gcc --sysroot=${SYSROOT_64}"
host# export CROSS_COMPILE_32="${SDK_INSTALL_DIR}/k3r5-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-eabi/arm-oe-eabi-"
If the Processor SDK is not installed, the Arm GNU toolchains can be downloaded and setup. Refer to :ref:`external-arm-toolchain` section for more details on usage.

Expand Down Expand Up @@ -46,22 +56,43 @@ The |__SDK_FULL_NAME__| package comes with this toolchain preinstalled at linux-
directory within the SDK. Below paths are relative to the <SDK_INSTALL_DIR> and will be
referred to using the first column in the following sections.

.. list-table:: Linux Devkit Contents
:widths: 20 30 50
:header-rows: 1

* - Variable
- Location
- Description
* - CROSS_COMPILE_64
- linux-devkit/sysroots/x86_64-arago-linux/usr/bin/aarch64-oe-linux/aarch64-oe-linux-
- Cross compiler toolchain for the ARMv8 architecture
* - SYSROOT_64
- linux-devkit/sysroots/aarch64-oe-linux/
- Sysroot with the cross compiled libraries and headers for the ARMv8 architecture with Linux OS
* - ENV_SETUP_64
- linux-devkit/environment-setup-aarch64-oe-linux
- Shell script that sets environment variables to compile binaries for the ARMv8 linux target
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

.. list-table:: Linux Devkit Contents
:widths: 20 30 50
:header-rows: 1

* - Variable
- Location
- Description
* - CROSS_COMPILE_32
- linux-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-linux-gnueabi/arm-oe-linux-gnueabi-
- Cross compiler toolchain for the ARMv8 architecture
* - SYSROOT_32
- linux-devkit/sysroots/armv7at2hf-neon-oe-linux-gnueabi/
- Sysroot with the cross compiled libraries and headers for the ARMv8 architecture with Linux OS
* - ENV_SETUP_32
- linux-devkit/environment-setup-armv7at2hf-neon-oe-linux-gnueabi
- Shell script that sets environment variables to compile binaries for the ARMv8 linux target

.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. list-table:: Linux Devkit Contents
:widths: 20 30 50
:header-rows: 1

* - Variable
- Location
- Description
* - CROSS_COMPILE_64
- linux-devkit/sysroots/x86_64-arago-linux/usr/bin/aarch64-oe-linux/aarch64-oe-linux-
- Cross compiler toolchain for the ARMv8 architecture
* - SYSROOT_64
- linux-devkit/sysroots/aarch64-oe-linux/
- Sysroot with the cross compiled libraries and headers for the ARMv8 architecture with Linux OS
* - ENV_SETUP_64
- linux-devkit/environment-setup-aarch64-oe-linux
- Shell script that sets environment variables to compile binaries for the ARMv8 linux target

.. rubric:: Target Sysroot
:name: cross-compiled-libraries
Expand All @@ -79,9 +110,17 @@ also find the header files corresponding to these libraries in the
an example if your application wants access to the alsa asound library
then you can now do the following command:

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# ${CROSS_COMPILE_64}gcc -lasound app.c -o app.out
host# ${CROSS_COMPILE_32}gcc -lasound app.c -o app.out
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# ${CROSS_COMPILE_64}gcc -lasound app.c -o app.out
.. rubric:: Environment-setup script
:name: environment-setup-script
Expand All @@ -101,9 +140,17 @@ for you. This script exports variables to perform actions such as:
To **use** the environment-setup script you only need to source it. This
is as simple as:

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

host# source ${ENV_SETUP_64}
.. code-block:: console
host# source ${ENV_SETUP_32}
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# source ${ENV_SETUP_64}
.. note::
:name: when-compiling-the-linux-kernel
Expand Down Expand Up @@ -133,7 +180,7 @@ libraries.
.. code-block:: c
#include <stdio.h>
int main() {
printf ("Hello World from TI!!!\n");
return 0;
Expand All @@ -145,20 +192,37 @@ libraries.
- **Compile Directly** : Cross-compile the **helloworld.c** file using the
cross-compile toolchain directly

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
cshilwant marked this conversation as resolved.
Show resolved Hide resolved
host# ${CROSS_COMPILE_32}gcc --sysroot=${SYSROOT_32} helloworld.c -o helloworld
host# ${CROSS_COMPILE_64}gcc --sysroot=${SYSROOT_64} helloworld.c -o helloworld
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# ${CROSS_COMPILE_64}gcc --sysroot=${SYSROOT_64} helloworld.c -o helloworld
Be sure to give the correct path to the gcc cross compiler and target
sysroot as listed earlier.

- **Using the environement setup script** : Cross-compile after sourcing
the setup script

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# source ${ENV_SETUP_32}
host# ${CC_32} helloworld.c -o helloworld
host# source ${ENV_SETUP_64}
host# ${CC} helloworld.c -o helloworld
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. code-block:: console
host# source ${ENV_SETUP_64}
host# ${CC} helloworld.c -o helloworld
3. After the above steps are run you should now have a **helloworld**
executable in your directory that has been compiled for the ARM. A
Expand All @@ -178,29 +242,35 @@ libraries.
k3r5-devkit
^^^^^^^^^^^

.. rubric:: Overview
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')

The |__SDK_FULL_NAME__| package comes with an ARMv7 toolchain preinstalled at k3r5-devkit/
directory within the SDK. Below paths are relative to the <SDK_INSTALL_DIR>.

.. list-table:: k3r5 Devkit Contents
:widths: 20 30 50
:header-rows: 1

* - Variable
- Location
- Description
* - CROSS_COMPILE_32
- k3r5-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-eabi/arm-oe-eabi-
- Cross compiler toolchain for the ARMv7 architecture
* - SYSROOT_32
- k3r5-devkit/sysroots/armv7at2hf-vfp-oe-eabi/
- Sysroot with the cross compiled libraries and headers for the ARMv7 architecture
* - ENV_SETUP_32
- k3r5-devkit/environment-setup-armv7at2hf-vfp-oe-eabi
- Shell script that sets environment variables to compile binaries for the target
.. attention::

|
The Processor SDK LINUX package for AM335x, AM437x and AM57X devices does not support k3r5-devkit toolchain.

.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')

.. rubric:: Overview

The |__SDK_FULL_NAME__| package comes with an ARMv7 toolchain preinstalled at k3r5-devkit/
directory within the SDK. Below paths are relative to the <SDK_INSTALL_DIR>.

.. list-table:: k3r5 Devkit Contents
:widths: 20 30 50
:header-rows: 1

* - Variable
- Location
- Description
* - CROSS_COMPILE_32
- k3r5-devkit/sysroots/x86_64-arago-linux/usr/bin/arm-oe-eabi/arm-oe-eabi-
- Cross compiler toolchain for the ARMv7 architecture
* - SYSROOT_32
- k3r5-devkit/sysroots/armv7at2hf-vfp-oe-eabi/
- Sysroot with the cross compiled libraries and headers for the ARMv7 architecture
* - ENV_SETUP_32
- k3r5-devkit/environment-setup-armv7at2hf-vfp-oe-eabi
- Shell script that sets environment variables to compile binaries for the target


.. _external-arm-toolchain:
Expand Down
8 changes: 4 additions & 4 deletions source/linux/Overview/Top_Level_Makefile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Steps to follow on Linux Host
.. rubric:: Required Host Packages
:name: makefile-required-packages

Please run the following command to install all packages required to by the
Please run the following command to install all packages required by the
makefile targets.

.. ifconfig:: CONFIG_part_variant in ('AM62X')
Expand All @@ -104,17 +104,17 @@ makefile targets.
* AM62x installer supports ``am62xx-evm`` and ``am62xx-lp-evm`` platforms. ``am62xx-evm`` is the default platform for the Toplevel Makefile. To build for ``am62xx-lp-evm``, pass ``PLATFORM=am62xx-lp-evm`` as argument to make.
* No special arguments are needed to build for ``am62xxsip-evm`` in AM62xSIP Installer.

.. ifconfig:: CONFIG_part_variant not in ('AM62X', 'AM64X', 'AM62PX')
.. ifconfig:: CONFIG_part_variant not in ('AM62X', 'AM64X', 'AM62PX', 'AM335X', 'AM437X', 'AM65X', 'AM57X')

jeevantelukula marked this conversation as resolved.
Show resolved Hide resolved
.. code-block:: console

host# sudo apt-get install build-essential autoconf automake bison flex libssl-dev bc u-boot-tools swig

.. ifconfig:: CONFIG_part_variant in ('AM62PX', 'AM62X', 'AM64X')
.. ifconfig:: CONFIG_part_variant in ('AM62PX', 'AM62X', 'AM64X', 'AM335X', 'AM437X', 'AM65X', 'AM57X')

.. code-block:: console

jeevantelukula marked this conversation as resolved.
Show resolved Hide resolved
host# sudo apt-get install build-essential autoconf automake bison flex libssl-dev bc u-boot-tools swig python3 python3-pip
host# sudo apt-get install build-essential autoconf automake bison flex libmpc-dev libmpcdec6 libmpc3 libmpcdec-dev libssl-dev bc u-boot-tools swig python3 python3-pip

Following pip packages are also needed for jailhouse & binman in u-boot targets

Expand Down
Loading