Skip to content

Commit 09282bc

Browse files
paresh-bhagat12jeevantelukula
authored andcommitted
feat(linux): Update docs for AM62D 11.1 release
Update Foundation Components Kernel, UBoot, How to Guides, Overview etc. for AM62D 11.1 release. Signed-off-by: Paresh Bhagat <[email protected]>
1 parent c537252 commit 09282bc

File tree

10 files changed

+98
-25
lines changed

10 files changed

+98
-25
lines changed

configs/AM62DX/AM62DX_linux_toc.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD
3838
linux/Foundational_Components_Kernel
3939
linux/Foundational_Components_Kernel_Drivers
4040
linux/Foundational_Components/Kernel/Kernel_Drivers/Audio
41-
linux/Foundational_Components/Kernel/Kernel_Drivers/EQEP
41+
#linux/Foundational_Components/Kernel/Kernel_Drivers/EQEP
4242
linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO
4343
linux/Foundational_Components/Kernel/Kernel_Drivers/I2C
4444
#linux/Foundational_Components/Kernel/Kernel_Drivers/MCAN
4545
linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-Ethernet
46-
linux/Foundational_Components/Kernel/Kernel_Drivers/PWM
46+
#linux/Foundational_Components/Kernel/Kernel_Drivers/PWM
4747
#linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
4848
#linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI
4949
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
@@ -57,13 +57,15 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Watchdog
5757

5858
linux/Foundational_Components_Kernel_Users_Guide
5959
linux/Foundational_Components_Kernel_LTP-DDT_Validation
60-
linux/Foundational_Components_Security
60+
#linux/Foundational_Components_Security
61+
#linux/Foundational_Components/System_Security/Auth_boot
6162
linux/Foundational_Components_Filesystem
6263
linux/Foundational_Components_Tools
6364
linux/Foundational_Components/Tools/Development_Tools
6465
linux/Foundational_Components/Tools/Pin_Mux_Tools
6566
linux/Foundational_Components/Tools/Flash_via_Fastboot
6667
linux/Foundational_Components_ATF
68+
linux/Foundational_Components_OPTEE
6769

6870
linux/How_to_Guides
6971
linux/How_to_Guides_Developer_Notes

source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ by double clicking on it within your Linux host PC.
8383
**MCU+ SDK for RTOS/NO-RTOS**
8484

8585
.. note::
86-
AM62D Linux SDK contains only the Linux specific source and application intended
87-
to run on A53/Linux core. For A53 based FreeRTOS side source and applications, refer **MCU+ SDK**
88-
86+
Processor SDK Linux AM62Dx has only the Linux specific source and application intended
87+
to run on A53 or Linux core. For R5F and RTOS or NO-RTOS side source and applications, refer **MCU+ SDK**
88+
package.
8989

9090
**Instructions to set-up CCS**
9191

92-
92+
- Refer MCU+SDK Installer `doc <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62DX/11_01_00_16/exports/docs/api_guide_am62dx/GETTING_STARTED_BUILD.html>`__.

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -886,7 +886,7 @@ Additional Information
886886
#. `Interfacing DRA7xx Audio to Analog Codecs
887887
<http://www.ti.com/lit/an/sprac09a/sprac09a.pdf>`__
888888

889-
.. ifconfig:: CONFIG_part_family in ('J7_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
889+
.. ifconfig:: CONFIG_part_family in ('J7_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family', 'AM62LX_family')
890890

891891
#. `Tools and Techniques for Audio Debugging
892892
<https://www.ti.com/lit/an/sprac10/sprac10.pdf>`__
@@ -911,3 +911,7 @@ Additional Information
911911
Differential Input/Output
912912
<http://www.ti.com/lit/ds/symlink/pcm3168a.pdf>`__
913913

914+
.. ifconfig:: CONFIG_part_variant in ('AM62DX')
915+
916+
#. `TAD52512 - High-performance stereo audio DAC
917+
<https://www.ti.com/lit/ds/symlink/tad5212.pdf>`__

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-Ethernet.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ of the CPSW Ethernet Subsystem:
4141

4242
For further details regarding the CPSWng instance, refer :ref:`cpswng`
4343

44-
.. ifconfig:: CONFIG_part_family in ('AM62X_family','AM62AX_family','AM64X_family','AM62LX_family')
44+
.. ifconfig:: CONFIG_part_family in ('AM62X_family','AM62AX_family','AM62DX_family','AM64X_family','AM62LX_family')
4545

4646
CPSW3g
4747

@@ -74,7 +74,7 @@ The CPSW Ethernet Subsystem supports TSN features in the following configuration
7474
2. The CPSWng Native Ethernet configuration of the CPSWng instance supports both MAC mode
7575
and Switch mode TSN features with Linux.
7676

77-
.. ifconfig:: CONFIG_part_family in ('AM62X_family','AM62AX_family','AM64X_family','AM62PX_family','AM62LX_family')
77+
.. ifconfig:: CONFIG_part_family in ('AM62X_family','AM62AX_family','AM62DX_family','AM64X_family','AM62PX_family','AM62LX_family')
7878

7979
The CPSW3g instance supports MAC mode and Switch mode TSN features with Linux.
8080

source/linux/Foundational_Components/Kernel/_Users_Guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,8 @@ Compiling the Device Tree Binaries
387387
+-------------------------------------------+--------------------------------------+
388388
| AM62Ax SK | k3-am62a7-sk.dts |
389389
+-------------------------------------------+--------------------------------------+
390+
| AM62Dx EVM | k3-am62d2-evm.dts |
391+
+-------------------------------------------+--------------------------------------+
390392
| AM62x LP SK | k3-am62-lp-sk.dts |
391393
+-------------------------------------------+--------------------------------------+
392394
| Beagle Play | k3-am625-beagleplay.dts |

source/linux/Foundational_Components/U-Boot/UG-DFU.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,12 @@ platform that support USB Peripheral boot mode.
244244
- Connect USB Type C DRD Port (J15) on SK board to PC through USB cable
245245
- Power on the board
246246

247+
.. ifconfig:: CONFIG_part_family in ('AM62DX_family')
248+
249+
- Set SYSBOOT switches to USB DFU boot mode (Refer to **Initialization** chapter of AM62D TRM for boot switch details)
250+
- Connect USB Type C DRD Port (J25) on EVM board to PC through USB cable
251+
- Power on the board
252+
247253
.. ifconfig:: CONFIG_part_family in ('AM62LX_family')
248254

249255
- Set SYSBOOT switches to USB DFU boot mode (Refer to **Initialization** chapter of AM62L TRM for boot switch details)
@@ -256,7 +262,7 @@ platform that support USB Peripheral boot mode.
256262
- Connect USB Type C DRD Port (J19) on SK board to PC through USB cable
257263
- Power on the board
258264

259-
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
265+
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family', 'AM62LX_family')
260266

261267
.. rubric:: On Linux host
262268

@@ -320,7 +326,7 @@ platform that support USB Peripheral boot mode.
320326

321327
Send boot images in this order: tiboot3.bin -> tispl.bin -> u-boot.img
322328

323-
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
329+
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family', 'AM62LX_family')
324330

325331
.. code-block:: text
326332
@@ -331,7 +337,7 @@ platform that support USB Peripheral boot mode.
331337

332338
.. note:: On Windows, if you face any issues while listing the available DFU Interfaces, try installing/updating the Generic USB DFU Drivers using `Zadig <https://zadig.akeo.ie/>`_.
333339

334-
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
340+
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family', 'AM62LX_family')
335341

336342
Move to directory containing the images and give the following commands
337343

@@ -402,7 +408,7 @@ platform that support USB Peripheral boot mode.
402408
host$ sudo dfu-util -R -a tispl.bin -D tispl.bin
403409
host$ sudo dfu-util -R -a u-boot.img -D u-boot.img
404410

405-
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family')
411+
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family')
406412

407413
.. rubric:: On Linux host
408414

@@ -458,7 +464,7 @@ platform that support USB Peripheral boot mode.
458464
459465
.. note:: On Windows host, if `name` of the DFU Interface doesn't work, use `alt` number instead.
460466

461-
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
467+
.. ifconfig:: CONFIG_part_family in ('AM64X_family', 'J7_family', 'AM62X_family', 'AM62AX_family', 'AM62DX_family', 'AM62PX_family', 'AM62LX_family')
462468

463469
At this point, the board should boot to the U-Boot prompt.
464470

source/linux/Foundational_Components/U-Boot/UG-General-Info.rst

Lines changed: 63 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,53 @@ Build U-Boot
552552
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" am62ax_evm_a53_defconfig O=$UBOOT_DIR/out/a53
553553
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" CC="$CC_64" BL31=$TFA_DIR/build/k3/lite/release/bl31.bin TEE=$OPTEE_DIR/out/arm-plat-k3/core/tee-pager_v2.bin O=$UBOOT_DIR/out/a53 BINMAN_INDIRS=$TI_LINUX_FW_DIR
554554
555+
.. ifconfig:: CONFIG_part_variant in ('AM62DX')
556+
557+
+-------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------------+
558+
| Board | SD Boot | USB DFU | USB MSC |
559+
+=============+==================================+========================================================+========================================================+
560+
| AM62DX EVM | | ``am62dx_evm_r5_defconfig`` | | ``am62dx_evm_r5_defconfig am62x_r5_usbdfu.config`` | | ``am62dx_evm_r5_defconfig am62x_r5_usbmsc.config`` |
561+
| | | ``am62dx_evm_a53_defconfig`` | | ``am62dx_evm_a53_defconfig`` | | ``am62dx_evm_a53_defconfig`` |
562+
+-------------+----------------------------------+--------------------------------------------------------+--------------------------------------------------------+
563+
564+
.. note::
565+
566+
Where to get the sources:
567+
568+
- ti-u-boot version: :ref:`u-boot-release-notes`
569+
- ti-linux-firmware version: :ref:`ti-linux-fw-release-notes`
570+
- TF-A version: :ref:`tf-a-release-notes`
571+
- OP-TEE version: :ref:`optee-release-notes`
572+
573+
.. code-block:: console
574+
575+
$ export UBOOT_DIR=<path-to-ti-u-boot>
576+
$ export TI_LINUX_FW_DIR=<path-to-ti-linux-firmware>
577+
$ export TFA_DIR=<path-to-arm-trusted-firmware>
578+
$ export OPTEE_DIR=<path-to-ti-optee-os>
579+
580+
.. note::
581+
582+
The instructions below assume all binaries are built manually. For instructions to build bl31.bin go to: :ref:`foundational-components-optee`.
583+
For instructions to build tee-pager_v2.bin (bl32.bin) go to: :ref:`foundational-components-atf`. BINMAN_INDIRS can point to
584+
:file:`<path-to-tisdk>/board-support/prebuilt-images` to use the pre-built binaries that come in the pre-built SDK (bl31.bin for BL31, bl32.bin for TEE).
585+
586+
.. code-block:: console
587+
588+
$ cd $UBOOT_DIR
589+
590+
R5
591+
To build tiboot3.bin. Saved in $UBOOT_DIR/out/r5.
592+
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_32" am62dx_evm_r5_defconfig O=$UBOOT_DIR/out/r5
593+
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_32" O=$UBOOT_DIR/out/r5 BINMAN_INDIRS=$TI_LINUX_FW_DIR
594+
595+
A53
596+
To build tispl.bin and u-boot.img. Saved in $UBOOT_DIR/out/a53. Requires bl31.bin, tee-pager_v2.bin.
597+
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" am62dx_evm_a53_defconfig O=$UBOOT_DIR/out/a53
598+
$ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" CC="$CC_64" BL31=$TFA_DIR/build/k3/lite/release/bl31.bin TEE=$OPTEE_DIR/out/arm-plat-k3/core/tee-pager_v2.bin O=$UBOOT_DIR/out/a53 BINMAN_INDIRS=$TI_LINUX_FW_DIR
599+
600+
601+
555602
.. ifconfig:: CONFIG_part_variant in ('AM62PX')
556603

557604
+-------------+----------------------------------+----------------------------------------------------------+--------------------------------------------------------+
@@ -659,13 +706,13 @@ Build U-Boot
659706
:file:`<path to folder>/ti-sysfw/` can be used. Please make sure
660707
to use the absolute path.
661708

662-
.. ifconfig:: CONFIG_part_variant in ('J721E', 'J7200', 'AM62X', 'AM62AX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S')
709+
.. ifconfig:: CONFIG_part_variant in ('J721E', 'J7200', 'AM62X', 'AM62AX', 'AM62DX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S')
663710

664711
.. note::
665712

666713
It is also possible to pick up a custom DM binary by adding TI_DM argument pointing to the file. If not provided, it defaults to picking up the DM binary from BINMAN_INDIRS. This is only applicable to devices that utilize split firmware.
667714

668-
.. ifconfig:: CONFIG_part_variant in ('AM65X', 'J721E', 'J7200', 'AM64X', 'AM62X', 'AM62AX', 'AM62LX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S')
715+
.. ifconfig:: CONFIG_part_variant in ('AM65X', 'J721E', 'J7200', 'AM64X', 'AM62X', 'AM62AX', 'AM62DX', 'AM62LX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S')
669716

670717
.. rubric:: Target Images
671718
:name: target-images
@@ -821,6 +868,18 @@ Build U-Boot
821868
* tiboot3-am62ax-hs-evm.bin from <output directory>/r5
822869
* tispl.bin, u-boot.img from <output directory>/a53
823870

871+
.. ifconfig:: CONFIG_part_variant in ('AM62DX')
872+
873+
* HS-FS
874+
875+
* :file:`tiboot3-am62dx-hs-fs-evm.bin` from :file:`<output directory>/r5`
876+
* :file:`tispl.bin, u-boot.img` from :file:`<output directory>/a53`
877+
878+
* HS-SE
879+
880+
* :file:`tiboot3-am62dx-hs-evm.bin` from :file:`<output directory>/r5`
881+
* :file:`tispl.bin, u-boot.img` from :file:`<output directory>/a53`
882+
824883
.. ifconfig:: CONFIG_part_variant in ('AM62PX')
825884

826885
* HS-FS
@@ -853,7 +912,7 @@ Build U-Boot
853912
* tispl.bin
854913
* u-boot.img
855914

856-
.. ifconfig:: CONFIG_part_variant in ('AM65X', 'J721E', 'J7200', 'AM64X', 'AM62X', 'AM62AX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S', 'AM62LX')
915+
.. ifconfig:: CONFIG_part_variant in ('AM65X', 'J721E', 'J7200', 'AM64X', 'AM62X', 'AM62AX', 'AM62DX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S', 'AM62LX')
857916

858917
.. warning::
859918

@@ -2079,7 +2138,7 @@ The SRAM memory layout explains the memory used for Bootloader's operation.
20792138
│ │
20802139
└──────────────────────────────────────┘0x43c3ffff
20812140
2082-
.. ifconfig:: CONFIG_part_variant in ('AM62AX','AM62PX')
2141+
.. ifconfig:: CONFIG_part_variant in ('AM62AX','AM62PX','AM62DX')
20832142

20842143
.. code-block:: console
20852144

source/linux/Foundational_Components/U-Boot/UG-UART.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ is installed
6767
$ sb --ymodem $OUT_AXX/tispl.bin > $UART_BOOT_MAIN_UART < $UART_BOOT_MAIN_UART
6868
$ sb --ymodem $OUT_AXX/u-boot.img > $UART_BOOT_MAIN_UART < $UART_BOOT_MAIN_UART
6969
70-
.. ifconfig:: CONFIG_part_variant in ('AM64X', 'AM62X', 'J722S', 'AM62PX')
70+
.. ifconfig:: CONFIG_part_variant in ('AM64X', 'AM62X', 'J722S', 'AM62PX', 'AM62DX')
7171

7272
ROM supports booting from MAIN_UART0 via X-Modem protocol. R5 SPL, A53
7373
SPL and U-Boot use Y-MODEM Protocol for downloading next stages over

source/linux/How_to_Guides/Target/How_to_emmc_boot.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ eMMC layout
3737
+----------------------------------+0x3A00 +-------------------------+
3838
Boot0 (8 MB) UDA
3939
40-
.. ifconfig:: CONFIG_part_variant in ('J721S2', 'AM62X', 'AM62PX', 'AM62AX', 'AM62LX')
40+
.. ifconfig:: CONFIG_part_variant in ('J721S2', 'AM62X', 'AM62PX', 'AM62AX', 'AM62DX', 'AM62LX')
4141

4242
.. code-block:: text
4343
@@ -54,7 +54,7 @@ eMMC layout
5454
+----------------------------------+0x3600 +-------------------------+
5555
Boot0 (8 MB) UDA
5656
57-
.. ifconfig:: CONFIG_part_variant not in ('AM64X', 'J7200', 'J721S2', 'AM62X', 'AM62PX', 'AM62AX', 'AM62LX')
57+
.. ifconfig:: CONFIG_part_variant not in ('AM64X', 'J7200', 'J721S2', 'AM62X', 'AM62PX', 'AM62AX', 'AM62DX', 'AM62LX')
5858

5959
.. code-block:: text
6060
@@ -145,7 +145,7 @@ In this example, eMMC device is ``dev 0``, to find which device is eMMC, refer t
145145
=> fatload mmc 1 ${loadaddr} emmc/u-boot.img
146146
=> mmc write ${loadaddr} 0x1800 0x2000
147147
148-
.. ifconfig:: CONFIG_part_variant in ('J721S2', 'AM62X', 'J784S4','J742S2', 'J722S', 'AM62PX', 'AM62AX', 'AM62LX')
148+
.. ifconfig:: CONFIG_part_variant in ('J721S2', 'AM62X', 'J784S4','J742S2', 'J722S', 'AM62PX', 'AM62AX', 'AM62DX','AM62LX')
149149

150150
.. code-block:: console
151151
@@ -157,7 +157,7 @@ In this example, eMMC device is ``dev 0``, to find which device is eMMC, refer t
157157
=> fatload mmc 1 ${loadaddr} emmc/u-boot.img
158158
=> mmc write ${loadaddr} 0x1400 0x2000
159159
160-
.. ifconfig:: CONFIG_part_variant not in ('AM64X', 'J7200', 'J721S2', 'AM62X', 'J784S4','J742S2', 'J722S', 'AM62PX', 'AM62AX', 'AM62LX')
160+
.. ifconfig:: CONFIG_part_variant not in ('AM64X', 'J7200', 'J721S2', 'AM62X', 'J784S4','J742S2', 'J722S', 'AM62PX', 'AM62AX', 'AM62DX', 'AM62LX')
161161

162162
.. code-block:: console
163163

source/linux/Overview/_Processor_SDK_Building_The_SDK.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Your newly built wic image will be generated in deploy-ti directory. Use :ref:`L
228228

229229
.. note:: If trying to build tisdk-display-cluster image, add ``DISPLAY_CLUSTER_ENABLE="1"`` at the end of :file:`conf/local.conf` file before running bitbake.
230230

231-
.. ifconfig:: CONFIG_part_variant in ('AM64X', 'AM65X', 'AM335X', 'AM437X')
231+
.. ifconfig:: CONFIG_part_variant in ('AM64X', 'AM62DX', 'AM65X', 'AM335X', 'AM437X')
232232

233233
.. important::
234234

0 commit comments

Comments
 (0)