Skip to content

Commit f462d72

Browse files
jeevantelukulacshilwant
authored andcommitted
fix: AM335x/AM437x/AM57x: Update Directory Structure and ARM architectural references
Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
1 parent 87aca91 commit f462d72

File tree

3 files changed

+103
-50
lines changed

3 files changed

+103
-50
lines changed

source/linux/Foundational_Components/Kernel/_Users_Guide.rst

Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Overview
55

66
This document will cover the basic steps for building the Linux kernel.
77

8-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
8+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
99

1010
.. rubric:: Install host dependencies
1111

@@ -56,7 +56,7 @@ Compiler
5656

5757
..
5858
[comment] instructions for 32 bit processors
59-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
59+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
6060

6161
Before compiling the kernel or kernel modules the SDK's toolchain needs
6262
to be added to the PATH environment variable
@@ -67,7 +67,7 @@ Compiler
6767
6868
..
6969
[comment] instructions for 64 bit processors
70-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
70+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
7171

7272
.. include:: Overview/GCC_ToolChain.rst
7373
:start-after: .. start_include_yocto_toolchain_host_setup
@@ -94,15 +94,15 @@ The command to clean the kernel is:
9494

9595
..
9696
[comment] instructions for 32 bit processors
97-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
97+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
9898

9999
.. code-block:: console
100100
101101
make ARCH=arm CROSS_COMPILE=arm-none-linux-gnueabihf- distclean
102102
103103
..
104104
[comment] instructions for 64 bit processors
105-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
105+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
106106

107107
.. code-block:: console
108108
@@ -127,15 +127,15 @@ a command of the form:
127127

128128
..
129129
[comment] instructions for 32 bit processors
130-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
130+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
131131

132132
.. code-block:: console
133133
134134
make ARCH=arm CROSS_COMPILE=arm-none-linux-gnueabihf- <defconfig>
135135
136136
..
137137
[comment] instructions for 64 bit processors
138-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
138+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
139139

140140
.. code-block:: console
141141
@@ -150,7 +150,7 @@ as a starting point).
150150

151151
..
152152
[comment] instructions for 32 bit processors
153-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
153+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
154154

155155
platformName is am335x-evm for AM335x, am437x-evm for AM437x, am57xx-evm for
156156
AM57xx, k2hk-evm for K2H/K2K, k2e-evm for K2E, k2l-evm for K2L, k2g-evm for
@@ -173,7 +173,7 @@ as a starting point).
173173
174174
..
175175
[comment] instructions for 64 bit processors
176-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
176+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
177177

178178
For example, to apply the recommended kernel configuration for K3 devices, use:
179179

@@ -209,7 +209,7 @@ To invoke the kernel configuration you simply use a command like:
209209

210210
..
211211
[comment] instructions for 32 bit processors
212-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
212+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
213213

214214
.. code-block:: console
215215
@@ -223,7 +223,7 @@ To invoke the kernel configuration you simply use a command like:
223223
224224
..
225225
[comment] instructions for 64 bit processors
226-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
226+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
227227

228228
.. code-block:: console
229229
@@ -250,7 +250,7 @@ Compiling the Kernel
250250

251251
..
252252
[comment] instructions for 32 bit processors
253-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
253+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
254254

255255
Once the kernel has been configured it must be compiled to generate the
256256
bootable kernel image as well as any dynamic kernel modules that were
@@ -269,7 +269,7 @@ Compiling the Kernel
269269

270270
..
271271
[comment] instructions for 64 bit processors
272-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
272+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
273273

274274
By default U-boot expects to boot kernel `Image`, DTB, and DTOs found in root/boot of the
275275
SD card if using SD/MMC boot. The exception is for HS-SE (High Security - Security Enforced)
@@ -297,7 +297,7 @@ Compiling the Device Tree Binaries
297297

298298
..
299299
[comment] instructions for 32 bit processors
300-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
300+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
301301

302302
Starting with the 3.8 kernel each TI evm has an unique device tree
303303
binary file required by the kernel. Therefore, you will need to build
@@ -370,7 +370,7 @@ Compiling the Device Tree Binaries
370370
371371
..
372372
[comment] instructions for 64 bit processors
373-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
373+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
374374

375375
Each TI evm has an unique device tree
376376
binary file required by the kernel. Therefore, you will need to build
@@ -439,7 +439,7 @@ Compiling the Kernel Modules
439439

440440
..
441441
[comment] instructions for 32 bit processors
442-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
442+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
443443

444444
By default the majority of the Linux drivers used in the sdk are not
445445
integrated into the kernel image file (zImage). These drivers are built as
@@ -451,7 +451,7 @@ Compiling the Kernel Modules
451451
452452
..
453453
[comment] instructions for 64 bit processors
454-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
454+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
455455

456456
By default the majority of the Linux drivers used in the sdk are not
457457
integrated into the kernel image file (Image). These drivers are built as
@@ -483,10 +483,19 @@ But developers may want to deploy and test new Kernel and DTB without going
483483
through the standard build system. For the specific purpose, board specific
484484
fitImage.its will be present in the prebuilt-images directory.
485485

486-
Pre-requisites ( Already part of SDK installations ):
486+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
487487

488-
- Uboot build directory for ARMV8
489-
- Linux Image and DTB
488+
Pre-requisites ( Already part of SDK installations ):
489+
490+
- Uboot build directory for ARMV7
491+
- Linux Image and DTB
492+
493+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
494+
495+
Pre-requisites ( Already part of SDK installations ):
496+
497+
- Uboot build directory for ARMV8
498+
- Linux Image and DTB
490499

491500
.. note::
492501

@@ -626,9 +635,17 @@ Generating the fitImage
626635
This step will embed the public key in the u-boot.dtb file that was already
627636
built during the initial u-boot build.
628637

629-
.. code-block:: console
638+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
639+
640+
.. code-block:: console
641+
642+
mkimage -r -f fitImage.its -k $UBOOT_PATH/board/ti/keys -K $UBOOT_PATH/build/$ARMV7/dts/dt.dtb fitImage
630643
631-
mkimage -r -f fitImage.its -k $UBOOT_PATH/arch/arm/mach-k3/keys -K $UBOOT_PATH/build/$ARMV8/dts/dt.dtb fitImage
644+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
645+
646+
.. code-block:: console
647+
648+
mkimage -r -f fitImage.its -k $UBOOT_PATH/arch/arm/mach-k3/keys -K $UBOOT_PATH/build/$ARMV8/dts/dt.dtb fitImage
632649
633650
.. note::
634651

@@ -639,8 +656,15 @@ built during the initial u-boot build.
639656
Build uboot again
640657
^^^^^^^^^^^^^^^^^
641658

642-
The updated u-boot.dtb needs to be packed in u-boot.img for authentication
643-
so rebuild uboot ARMV8 without changing any parameters.
659+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
660+
661+
The updated u-boot.dtb needs to be packed in u-boot.img for authentication
662+
so rebuild uboot ARMV7 without changing any parameters.
663+
664+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
665+
666+
The updated u-boot.dtb needs to be packed in u-boot.img for authentication
667+
so rebuild uboot ARMV8 without changing any parameters.
644668

645669
Refer to :ref:`top-level-makefile`
646670

@@ -658,7 +682,7 @@ Installing the Kernel Image and Device Tree Binaries
658682

659683
..
660684
[comment] instructions for 32 bit processors
661-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
685+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
662686

663687
.. code-block:: console
664688
@@ -678,7 +702,7 @@ Installing the Kernel Image and Device Tree Binaries
678702
679703
..
680704
[comment] instructions for 64 bit processors
681-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
705+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
682706

683707
.. code-block:: console
684708
@@ -714,7 +738,7 @@ file system. The general format of the command is:
714738

715739
..
716740
[comment] instructions for 32 bit processors
717-
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
741+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
718742

719743
.. code-block:: console
720744
@@ -729,7 +753,7 @@ file system. The general format of the command is:
729753
730754
..
731755
[comment] instructions for 64 bit processors
732-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family')
756+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM335X_family', 'AM437X_family', 'AM57X_family')
733757

734758
.. code-block:: console
735759

source/linux/Overview/GCC_ToolChain.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,7 @@ yourself.
111111

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

114-
These libraries include packages from alsa to zlib.
115-
or a list of the
114+
These libraries include packages from ALSA to zlib, for a list of the
116115
libraries you can refer to the software manifest found in the **<SDK
117116
INSTALL DIR>/manifest** directory or look at the list of libraries
118117
available in the **<SYSROOT_32>/usr/lib** directory. You will
@@ -127,8 +126,7 @@ yourself.
127126
128127
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')
129128

130-
These libraries include packages from alsa to zlib.
131-
or a list of the
129+
These libraries include packages from ALSA to zlib, for a list of the
132130
libraries you can refer to the software manifest found in the **<SDK
133131
INSTALL DIR>/manifest** directory or look at the list of libraries
134132
available in the **<SYSROOT_64>/usr/lib** directory. You will

source/linux/Overview/_Processor_SDK_Linux_Directory_Structure.rst

Lines changed: 49 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,41 @@ directories and files
99

1010
.. ifconfig:: CONFIG_sdk in ('SITARA')
1111

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

14-
./
15-
├── bin/
16-
├── board-support/
17-
├── example-applications/
18-
├── filesystem/
19-
├── k3r5-devkit/
20-
├── licenses/
21-
├── linux-devkit/
22-
├── Makefile
23-
├── makerules/
24-
├── manifest/
25-
├── Rules.make
26-
└── setup.sh*
14+
.. code-block:: console
15+
16+
./
17+
├── bin/
18+
├── board-support/
19+
├── example-applications/
20+
├── external-toolchain-dir/
21+
├── filesystem/
22+
├── licenses/
23+
├── linux-devkit/
24+
├── Makefile
25+
├── makerules/
26+
├── manifest/
27+
├── Rules.make
28+
└── setup.sh*
29+
30+
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')
31+
32+
.. code-block:: console
33+
34+
./
35+
├── bin/
36+
├── board-support/
37+
├── example-applications/
38+
├── filesystem/
39+
├── k3r5-devkit/
40+
├── licenses/
41+
├── linux-devkit/
42+
├── Makefile
43+
├── makerules/
44+
├── manifest/
45+
├── Rules.make
46+
└── setup.sh*
2747
2848
.. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
2949

@@ -61,10 +81,21 @@ Processor SDK devices.
6181
- **filesystem** - Contains the reference file systems. These include
6282
the smaller base file system as well as the full-featured SDK file
6383
system.
64-
- **linux-devkit** - Contains the tools and libraries to speed
65-
development for the target device for the ARMV8 architechture
66-
- **k3r5-devkit** - Contains the tools and libraries to speed
67-
development for the target device for the ARMV7 architechture
84+
85+
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57X')
86+
87+
- **linux-devkit** - Contains the tools and libraries to speed
88+
development for the target device for the ARMV7 architechture
89+
- **external-toolchain-dir** - Contains the external ARM GNU toolchain
90+
to speed development for the target device for the ARMV7 architechture
91+
92+
.. ifconfig:: CONFIG_part_variant not in ('AM335X', 'AM437X', 'AM57X')
93+
94+
- **linux-devkit** - Contains the tools and libraries to speed
95+
development for the target device for the ARMV8 architechture
96+
- **k3r5-devkit** - Contains the tools and libraries to speed
97+
development for the target device for the ARMV7 architechture
98+
6899
- **Makefile** - Provides build targets for many of the SDK components
69100
from the top-level of the SDK.
70101
- **makerules** - Make rules for all the topLevel Makefile build targets

0 commit comments

Comments
 (0)