From 49f0f8327a442b7f4a54371bbd55a0fcea4f3f62 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 10:45:00 -0600 Subject: [PATCH 1/9] fix: remove all non-breaking spaces Found a lot of non-breaking spaces in places where they were not needed. Replace them with spaces and fix the resulting whitespace errors. Out of curiosity I was scanning the docs for any non-ascii characters to see if there is anything that could be breaking formatting that standard mechanisms wouldn't catch. Found all of this. Assume it was from the initial import from the processor wiki. Signed-off-by: Randolph Sapp --- source/buildroot/Overview.rst | 10 +- .../_66AK2G02_GP_EVM_Hardware_Setup.rst | 6 +- .../_66AK2G02_ICE_EVM_Hardware_setup.rst | 2 +- .../_AM572x_GP_EVM_Hardware_Setup.rst | 6 +- .../_AM62Px_EVM_Hardware_Setup.rst | 2 +- .../_AM62x_EVM_Hardware_Setup.rst | 2 +- .../_EVMK2H_Hardware_Setup.rst | 6 +- .../_J722S_EVM_Hardware_Setup.rst | 2 +- .../_OMAPL137_EVM_Hardware_Setup.rst | 2 +- .../_TMDSEVM6657L_EVM_Hardware_Setup.rst | 14 +- .../_TMDXEVM6670L_EVM_Hardware_Setup.rst | 8 +- .../_TMDXEVM6678L_EVM_Hardware_Setup.rst | 16 +- .../_TMDXIDK5728_Hardware_Setup.rst | 6 +- .../HSR_PRP/_Firmware.rst | 2 +- .../HSR_PRP/_Firmware_Features.rst | 10 +- source/common/PRU-ICSS/Header_Files.rst | 2 +- .../PRU-ICSS/PRU-Cape-Hardware-User-Guide.rst | 19 +- source/common/PRU-ICSS/PRU-Hands-on-Labs.rst | 2 +- .../_MCSDK_to_Processor_SDK_Migration.rst | 2 +- source/debian/Building_Debian_Image.rst | 30 +- .../linux/Release_Specific_Release_Notes.rst | 2 +- .../rtos/Release_Specific_Migration_Guide.rst | 2 +- .../linux/Release_Specific_Release_Notes.rst | 2 +- .../rtos/Release_Specific_Migration_Guide.rst | 2 +- .../linux/Release_Specific_Release_Notes.rst | 2 +- .../rtos/Release_Specific_Migration_Guide.rst | 2 +- .../linux/Overview/Run_Setup_Scripts.rst | 6 +- .../linux/Overview/Run_Setup_Scripts.rst | 6 +- .../linux/Overview/Run_Setup_Scripts.rst | 6 +- .../AM64X/linux/Overview/Create_SD_Card.rst | 2 +- .../linux/Release_Specific_Release_Notes.rst | 2 +- .../linux/Release_Specific_Release_Notes.rst | 2 +- .../Application_Demos/Video_Analytics.rst | 32 +- .../_AM335x_Power_Management_User_Guide.rst | 2 +- .../_ARM_Multimedia_Users_Guide.rst | 10 +- .../_Camera_Users_Guide.rst | 8 +- .../Examples_and_Demos/_Hands_on_with_QT.rst | 4 +- .../Examples_and_Demos/_Matrix_User_Guide.rst | 99 +++-- .../_WLAN_and_Bluetooth.rst | 2 +- .../Graphics/Rogue/Build_Guide.rst | 20 +- .../Graphics/SGX/Build_Guide.rst | 16 +- .../Graphics/SGX/SGX_Debug_Info.rst | 2 +- .../IPC/_IPC_for_AM57xx.rst | 124 +++---- .../IPC/_IPC_for_AM65xx.rst | 28 +- .../IPC/_Quick_Start_Guide.rst | 2 +- .../Kernel/Kernel_Drivers/ADC.rst | 2 +- .../Kernel/Kernel_Drivers/Audio.rst | 2 +- .../Kernel/Kernel_Drivers/Camera/VIP.rst | 2 +- .../Kernel/Kernel_Drivers/Crypto.rst | 2 +- .../Kernel/Kernel_Drivers/Network/CPSW.rst | 6 +- .../Kernel/Kernel_Drivers/Network/NetCP.rst | 46 +-- .../Kernel/Kernel_Drivers/Network/PRUSS.rst | 2 +- .../Kernel_Drivers/PCIe/PCIe_Root_Complex.rst | 2 +- .../Kernel/Kernel_Drivers/QSPI.rst | 4 +- .../Kernel/Kernel_Drivers/Storage/MMC-SD.rst | 2 +- .../Kernel/Kernel_Drivers/Storage/NAND.rst | 8 +- .../Kernel/Kernel_Drivers/USB/AM62_DWC3.rst | 6 +- .../Kernel/Kernel_Drivers/USB/DWC3.rst | 16 +- .../Kernel/Kernel_Drivers/USB/MUSB.rst | 2 +- .../Kernel/Kernel_Drivers/VPE.rst | 2 +- .../Kernel/_LTP-DDT_Validation.rst | 4 +- .../Power_Management/pm_suspend_resume.rst | 2 +- .../_GDB_Setup_with_CCS.rst | 48 +-- .../_Kernel_Debugging_with_CCS.rst | 14 +- .../_Remote_Explorer_Setup_with_CCS.rst | 8 +- .../U-Boot/Apps-Splash-Screen.rst | 8 +- .../linux/Foundational_Components/_CMEM.rst | 36 +- .../linux/Foundational_Components/_OpenCV.rst | 30 +- .../linux/Foundational_Components/_OpenVX.rst | 36 +- ...undational_Components_Multimedia_IVAHD.rst | 76 ++-- .../How_to_Integrate_Open_Source_Software.rst | 20 +- ...AM335x_AM437x_Hardware_Migration_Guide.rst | 32 +- .../Host/AM335x_ICEv2_flash_erase.rst | 4 +- .../How_to_Guides/Host/Boot_Sequence.rst | 72 ++-- .../Host/Connect_to_an_EVM_via_Telnet.rst | 4 +- ...Build_a_Ubuntu_Linux_host_under_VMware.rst | 104 +++--- .../How_to_Flash_Linux_System_from_U-boot.rst | 85 ++--- .../How_to_Setup_Ubuntu_1404_Network_Boot.rst | 8 +- .../Host/How_to_Setup_a_Samba_Server.rst | 16 +- .../Moving_Files_to_the_Target_System.rst | 20 +- .../HSR_PRP/_HSR_PRP_for_Linux.rst | 12 +- .../linux/Industrial_Protocols/PTP/_PTP.rst | 22 +- .../Overview/Download_and_Install_the_SDK.rst | 4 +- .../Processor_SDK_Linux_create_SD_card.rst | 4 +- ...cessor_SDK_Linux_create_SD_card_script.rst | 6 +- source/linux/Overview/Run_Setup_Scripts.rst | 8 +- .../_Processor_SDK_Linux_GPLv3_Disclaimer.rst | 10 +- .../Release_Specific_PLSDK_Release_Notes.rst | 2 +- .../DSP_Debug_and_Trace/_CToolsLib.rst | 10 +- .../DSP_Debug_and_Trace/_Fault_Management.rst | 2 +- .../DSP_Software/DSP_Debug_and_Trace/_UIA.rst | 4 +- .../_PSDK_RTOS_Top_level_Makefile.rst | 72 ++-- .../_Audio_Benchmark_Starterkit.rst | 14 +- .../_Bare_Metal_Examples.rst | 32 +- .../_Big_Data_IPC_Examples.rst | 2 +- .../_Jailhouse_Hypervisor.rst | 10 +- .../_Posix_SMP_Demo.rst | 8 +- .../_RTOS_Template_App.rst | 8 +- source/rtos/FAQ.rst | 10 +- .../_Flash_bootable_images.rst | 2 +- ..._Library_Target_to_PSDK_RTOS_makefiles.rst | 4 +- ..._Porting_Guide_for_AM57xx_Speed_Grades.rst | 6 +- .../Setup/_Update_ENV_for_a_Custom_Path.rst | 220 +++++------ ...ng_PDK_and_IPC_to_load_from_ARM_AM57xx.rst | 132 +++---- .../_BOOT_AM335x_AM437x.rst | 70 ++-- .../_BOOT_AM57x.rst | 46 +-- .../_BOOT_AM65x_J721E.rst | 34 +- .../_BOOT_C66x.rst | 24 +- .../_Board_Support.rst | 4 +- .../Device_Driver_Utilities/_OSAL.rst | 2 +- .../Device_Driver_Utilities/_Profiling.rst | 2 +- .../Device_Drivers/_CPPI.rst | 350 +++++++++--------- .../Device_Drivers/_CSL.rst | 2 +- .../Device_Drivers/_FATFS.rst | 4 +- .../Device_Drivers/_GPIO.rst | 30 +- .../Device_Drivers/_GPMC.rst | 6 +- .../Device_Drivers/_I2C.rst | 10 +- .../Device_Drivers/_ICSS_EMAC_LLD_FW.rst | 6 +- .../Device_Drivers/_IOLINK.rst | 2 +- .../Device_Drivers/_MMCSD.rst | 16 +- .../Device_Drivers/_PCIe.rst | 12 +- .../Device_Drivers/_PRUSS.rst | 6 +- .../Device_Drivers/_QMSS.rst | 320 ++++++++-------- .../Device_Drivers/_QSPI_McSPI.rst | 50 +-- .../Device_Drivers/_Serdes_Diag.rst | 2 +- .../Device_Drivers/_UART.rst | 6 +- .../Device_Drivers/_USB.rst | 2 +- .../Device_Drivers/_VPS_Drivers.rst | 4 +- .../IPC/_IPC_3.x_FAQ.rst | 2 +- .../IPC/_IPC_FAQ_for_Keystone_Devices.rst | 42 +-- .../IPC/_IPC_Install_Guide_Linux.rst | 2 +- .../IPC/_IPC_Install_Guide_QNX.rst | 4 +- .../IPC/_IPC_Resource_customTable.rst | 150 ++++---- .../IPC/_Optimizing_IPC_Applications.rst | 8 +- .../IPC/_The_ti.sdo.ipc_Package.rst | 10 +- .../_Debug_with_ICSS_EMAC_LLD.rst | 48 +-- .../_Develop_with_ICSS_EMAC_LLD.rst | 118 +++--- .../PRU_ICSS_Drivers/_I2C_FIRMWARE.rst | 2 +- .../PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst | 2 +- .../rtos/Release_Specific/_Build_the_SDK.rst | 4 +- .../Release_Specific/_Migration_Guide.rst | 2 +- .../_Multi_Core_System_Analyzer.rst | 4 +- .../_XDS100_Emulator_Info.rst | 74 ++-- .../_XDS560_Emulator_Info.rst | 2 +- source/rtos/index_faq.rst | 10 +- .../Benchmark_Demo_User_Guide.rst | 28 +- .../Servo_Drive_Demo_User_Guide.rst | 6 +- 147 files changed, 1684 insertions(+), 1713 deletions(-) diff --git a/source/buildroot/Overview.rst b/source/buildroot/Overview.rst index 9a6c3647f..021e6cb05 100644 --- a/source/buildroot/Overview.rst +++ b/source/buildroot/Overview.rst @@ -51,14 +51,14 @@ Repository structure ├── external.mk ├── Config.in ├── board - │   ├── ti - │   │   ├── am62x-sk - │   │   ├── common + │ ├── ti + │ │ ├── am62x-sk + │ │ ├── common ├── COPYING ├── README.md ├── configs - │   ├── ti_release_am62x_sk_defconfig - │   └── ti_release_am62x_sk_rt_defconfig + │ ├── ti_release_am62x_sk_defconfig + │ └── ti_release_am62x_sk_rt_defconfig :file:`external.desc`: contains name and description of br2-external tree. diff --git a/source/common/EVM_Hardware_Setup/_66AK2G02_GP_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_66AK2G02_GP_EVM_Hardware_Setup.rst index 1ffca7cb8..5ca7e701a 100644 --- a/source/common/EVM_Hardware_Setup/_66AK2G02_GP_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_66AK2G02_GP_EVM_Hardware_Setup.rst @@ -220,7 +220,7 @@ power supply connected to the DC power jack (J3). Internally, +12V input is converted into required voltage levels using local DC-DC converters Please note that a power supply is included with the 66AK2GX Evaluation -Module. The power supply has the following specs : +Module. The power supply has the following specs : - 12V DC output - 5A output @@ -234,7 +234,7 @@ Module. The power supply has the following specs : This section describes the setup to connect to 66AK2GX GP EVM using Code composer Studio environment and an emulator. -There are two scenarios while connecting to the EVM : +There are two scenarios while connecting to the EVM : - **Connect to EVM without a SD card boot image to boot the EVM** - **Connect to EVM after booting an image from the SD card**. @@ -330,7 +330,7 @@ provided below: .. rubric:: Connecting to target :name: connecting-to-target -**Step1 :** Download Code composer Studio v6.1.3 or for CCSv6.1.2 and +**Step1 :** Download Code composer Studio v6.1.3 or for CCSv6.1.2 and earlier, ensure it contains Keystone device support package version 1.1.5 as described in the how to guide diff --git a/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst b/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst index 00e40226f..b98f8bd8e 100644 --- a/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst +++ b/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst @@ -136,7 +136,7 @@ CCS Setup This section describes the setup to connect to 66AK2G02 ICE EVM using Code composer Studio environment and an emulator. -There are two scenarios while connecting to the EVM : +There are two scenarios while connecting to the EVM : - **Connect to EVM without a SD card boot image to boot the EVM** - **Connect to EVM after booting an image from the SD card**. diff --git a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst index 215c1c2a8..b2eb84f2c 100644 --- a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst @@ -160,7 +160,7 @@ scenario, the SBL component provides the same functionality .. rubric:: CCS Setup :name: ccs-setup -There are two scenarios while connecting to the EVM : +There are two scenarios while connecting to the EVM : - **Connect to EVM without a SD card boot image to boot the EVM** - **Connect to EVM after booting an image from the SD card**. @@ -207,7 +207,7 @@ provided below: .. rubric:: Connecting to target :name: connecting-to-target -**Step1 :** Download Code composer Studio and AM572x Sitara CSP package +**Step1 :** Download Code composer Studio and AM572x Sitara CSP package as described in the wiki article mentioned below: `Install Code composer Studio v6 for @@ -301,7 +301,7 @@ in the previous section. CortexA15_0: GEL Output: PHY_STATUSx registers CortexA15_0: GEL Output: Two EMIFs in interleaved mode - (2GB total) CortexA15_0: GEL Output: --->>> DDR3 Initialization is DONE! <<<--- - CortexA15_0: GEL Output: --->>> AM572x Target Connect Sequence DONE !!!!! <<<--- + CortexA15_0: GEL Output: --->>> AM572x Target Connect Sequence DONE !!!!! <<<--- CortexA15_0: GEL Output: --->>> IPU1SS Initialization is in progress ... <<<--- CortexA15_0: GEL Output: --->>> IPU1SS Initialization is DONE! <<<--- CortexA15_0: GEL Output: --->>> IPU2SS Initialization is in progress ... <<<--- diff --git a/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst index 30c8bc5b2..2ccd80bdf 100644 --- a/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst @@ -4,7 +4,7 @@ AM62Px SK EVM Hardware Setup .. rubric:: Description The AM62Px starter kit (SK) evaluation module (EVM) is a stand-alone test and development platform -built around the AM62Px system-on-a-chip (SoC). AM62Px processors are comprised of a quad-core 64-bit +built around the AM62Px system-on-a-chip (SoC). AM62Px processors are comprised of a quad-core 64-bit Arm®-Cortex®-A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). To know more on how to quickly start Linux on the AM62Px Starter Kit EVM (SK EVM) and run out-of-box demos, you can refer `AM62Px Starter Kit EVM Quick Start Guide. `__ diff --git a/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst index b7f6d27f1..2c1c7d921 100644 --- a/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst @@ -4,7 +4,7 @@ AM62x SK EVM Hardware Setup .. rubric:: Description The AM62x starter kit (SK) evaluation module (EVM) is a stand-alone test and development platform -built around the AM62x system-on-a-chip (SoC). AM62x processors are comprised of a quad-core 64-bit +built around the AM62x system-on-a-chip (SoC). AM62x processors are comprised of a quad-core 64-bit Arm®-Cortex®-A53 microprocessor, single-core Arm Cortex-R5F microcontroller (MCU) and an Arm Cortex-M4F MCU. diff --git a/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst index cbe554542..b76272afa 100644 --- a/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst @@ -18,7 +18,7 @@ of the emulator daughter card. The driver can be downloaded from here .. note:: Before testing the usb connection, make sure that the mini-usb cable is plugged into the port on the base board. (and not connected to the daughter card). -After installing the driver and connecting the USB cable, two COM ports +After installing the driver and connecting the USB cable, two COM ports should be visible in the list of COM ports available to connect to in the PC Host terminal console. The lower COM port corresponds to the SoC UART and the higher one corresponds to the MCU UART. @@ -237,7 +237,7 @@ with the following steps. #. Select the BMC COM Port (the same COM port used to issue the ver command earlier), and set the ‘Baud Rate’ to 115200. #. Set ‘Transfer Size’ to 60, and make sure ‘Disable Auto Baud Support’ - is unchecked.  + is unchecked. .. image:: /images/LMflashProg_Config.png @@ -652,5 +652,5 @@ Connecting Target... arm_A15_0: GEL Output: A15 non secure mode entered Users can now load and run code on the cores by using Run -> Load -Program. Happy Debugging !! +Program. Happy Debugging !! diff --git a/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst index 588efa693..8f953e351 100644 --- a/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst @@ -4,7 +4,7 @@ J722S EVM Hardware Setup .. rubric:: Description The J722S evaluation module (or TDA4VEN and AM67 EVM) is a stand-alone test and development platform -built around the J722S system-on-a-chip (SoC). J722S processors are comprised of a quad-core 64-bit +built around the J722S system-on-a-chip (SoC). J722S processors are comprised of a quad-core 64-bit Arm®-Cortex®-A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). The EVM gives developers the basic resources needed for most general‐purpose type projects. diff --git a/source/common/EVM_Hardware_Setup/_OMAPL137_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_OMAPL137_EVM_Hardware_Setup.rst index 9e6f5448d..7e50d0a47 100644 --- a/source/common/EVM_Hardware_Setup/_OMAPL137_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_OMAPL137_EVM_Hardware_Setup.rst @@ -77,7 +77,7 @@ Target Configuration .. Image:: /images/OMAPL137_targetConfig.png -- Check "OMAPL137" or "C6747" as Device and save.  +- Check "OMAPL137" or "C6747" as Device and save. .. Tip:: If you don't see "OMAPL137", ensure that you have installed CCS and selected Single Core DSP devices in the installation. diff --git a/source/common/EVM_Hardware_Setup/_TMDSEVM6657L_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_TMDSEVM6657L_EVM_Hardware_Setup.rst index bf46f7240..c19d1c17c 100644 --- a/source/common/EVM_Hardware_Setup/_TMDSEVM6657L_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_TMDSEVM6657L_EVM_Hardware_Setup.rst @@ -57,7 +57,7 @@ The application needs an IP address. It can use either a static IP address (pre-configured) or it can request one using DHCP. This is controlled by setting dip switch 2 of SW9. -| User Switch 2 ON : DHCP +| User Switch 2 ON : DHCP | User Switch 2 OFF: Static IP .. image:: /images/TMD6678LSW9.png @@ -95,7 +95,7 @@ Boot Mode Dip Switch Settings The EVM supports booting image from various devices (EEPROM, NAND or NOR) via IBL (at I2C address 0x51), I2C EEPROM (at I2C address 0x50), -and ROM Boot modes (such as Ethernet, SRIO, PCIe, SPI etc.) which +and ROM Boot modes (such as Ethernet, SRIO, PCIe, SPI etc.) which address the boot source directly from the ROM code. Below is the table showing the boot mode dip switch settings for different boot mode that the EVM supports: @@ -106,7 +106,7 @@ the EVM supports: | | (Pin1, 2, 3, 4, 5, 6, 7, | (Pin1, 2, 3, 4, 5, 6, 7, | | | 8) | 8) | +==========================+==========================+==========================+ -| IBL NOR boot on image 0 | (off, off, on, off, on, | (on, on, on, off, on, | +| IBL NOR boot on image 0 | (off, off, on, off, on, | (on, on, on, off, on, | | (default) | on, on, | on, on, on)\ :sup:`4` | | | on)\ :sup:`1,2,3` | | +--------------------------+--------------------------+--------------------------+ @@ -145,22 +145,22 @@ the EVM supports: **Footnotes:** -| 1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little Endian)  +| 1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little Endian) | -| 2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C boot mode (off, on, off) +| 2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C boot mode (off, on, off) | | 3. Pin 5-8 of SW3 and pin 1-2 of SW5 are the boot parameter index pins for I2C boot (paramter index 0/1 for NOR boot image 0/1, parameter index 2/3 for NAND boot image 0/1, parameter index 4 for TFTP boot). By default, image 0 is programmed to offset byte address 0x0 on NOR, and 0x20000 (block 1 start address) on NAND, image 1 is programmed to offset byte address 0x4000000 on NAND. | -| 4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50)  for I2C boot mode +| 4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50) for I2C boot mode | | 5. This will set the board to boot from SRIO boot mode, with reference clock at 250 MHz, data rate at 3.125 GBs, and lane setup 4-1x ports and DSP System PLL at 100 MHz. | -| 6. This will set the board to boot from Ethernet boot mode, with SerDes clock multiplier x 4, core PLL clock at 100 MHz. +| 6. This will set the board to boot from Ethernet boot mode, with SerDes clock multiplier x 4, core PLL clock at 100 MHz. | | 7. This will set the board to boot form PCIE boot mode, with PCIE in end point mode and DSP System PLL at 100 MHz. diff --git a/source/common/EVM_Hardware_Setup/_TMDXEVM6670L_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_TMDXEVM6670L_EVM_Hardware_Setup.rst index 2ce68cf2e..05f2e5fc4 100644 --- a/source/common/EVM_Hardware_Setup/_TMDXEVM6670L_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_TMDXEVM6670L_EVM_Hardware_Setup.rst @@ -71,7 +71,7 @@ Boot Mode Dip Switch Settings ----------------------------- The EVM supports booting image from various devices (EEPROM, NAND or -NOR) via IBL, it also supports ROM Boot modes, such as Ethernet, SRIO, +NOR) via IBL, it also supports ROM Boot modes, such as Ethernet, SRIO, PCIe, etc. Below is the table showing the boot mode dip switch settings for different boot mode that the EVM supports: @@ -120,16 +120,16 @@ for different boot mode that the EVM supports: **Footnotes:** -| 1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little Endian) +| 1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little Endian) | -| 2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C boot mode (off, on, off) +| 2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C boot mode (off, on, off) | | 3. Pin 1-4 of SW4 and pin 1-2 of SW5 are the boot parameter index pins for I2C boot (paramter index 0/1 for NOR boot image 0/1, parameter index 2/3 for NAND boot image 0/1, parameter index 4 for TFTP boot). By default, image 0 is programmed to offset byte address 0x0 on NOR, and 0x4000 (block 1 start address) on NAND, image 1 is programmed to offset byte address 0xA00000 on NOR, and 0x2000000 on NAND. | -| 4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50)  for I2C boot mode +| 4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50) for I2C boot mode | | 5. This will set the board to boot from SRIO boot mode, with reference clock at 250 MHz, data rate at 3.125 GBs, and lane setup 4-1x ports and DSP System PLL at 122.88 MHz. diff --git a/source/common/EVM_Hardware_Setup/_TMDXEVM6678L_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_TMDXEVM6678L_EVM_Hardware_Setup.rst index 14cb89922..39f49342f 100644 --- a/source/common/EVM_Hardware_Setup/_TMDXEVM6678L_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_TMDXEVM6678L_EVM_Hardware_Setup.rst @@ -74,7 +74,7 @@ The application needs an IP address. It can use either a static IP address (pre-configured) or it can request one using DHCP. This is controlled by setting dip switch 2 of SW9. -| User Switch 2 ON : DHCP +| User Switch 2 ON : DHCP | User Switch 2 OFF: Static IP .. image:: /images/TMD6678LSW9.png @@ -110,7 +110,7 @@ Boot Mode Dip Switch Settings The EVM supports booting image from various devices (EEPROM, NAND or NOR) via IBL (at I2C address 0x51), I2C EEPROM (at I2C address 0x50), -and ROM Boot modes (such as Ethernet, SRIO, PCIe, SPI etc.) which +and ROM Boot modes (such as Ethernet, SRIO, PCIe, SPI etc.) which address the boot source directly from the ROM code. Below is the table showing the boot mode dip switch settings for different boot mode that the EVM supports: @@ -121,7 +121,7 @@ the EVM supports: | | (Pin1, 2, 3, | (Pin1, 2, 3, | (Pin1, 2, 3, | (Pin1, 2, 3, | | | 4) | 4) | 4) | 4) | +================+================+================+================+================+ -| IBL NOR boot | (off, off, on, | (on, on, on, | (on, on, on, | (on, on, on, | +| IBL NOR boot | (off, off, on, | (on, on, on, | (on, on, on, | (on, on, on, | | on image 0 | off)\ :sup:`1, | on)\ :sup:`3` | off)\ :sup:`4` | on) | | (default) | 2` | | | | +----------------+----------------+----------------+----------------+----------------+ @@ -160,10 +160,10 @@ the EVM supports: | **Footnotes:** -1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little -Endian)  +1. Pin 1 of SW3 is the endian pin, by default, it is set to off (Little +Endian) -2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C +2. Pin 2-4 of SW3 are the boot mode pins, by default it is set to I2C boot mode (off, on, off) 3. Pin 1-4 of SW4 and pin 1-2 of SW5 are the boot parameter index pins @@ -173,7 +173,7 @@ default, image 0 is programmed to offset byte address 0x0 on NOR, and 0x4000 (block 1 start address) on NAND, image 1 is programmed to offset byte address 0xA00000 on NOR, and 0x2000000 on NAND. -4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50)  for I2C +4. Pin 4 of SW5 is the I2C address pin (off: 0x51, on: 0x50) for I2C boot mode 5. This will set the board to boot from SRIO boot mode, with reference @@ -181,7 +181,7 @@ clock at 312.5 MHz, data rate at 3.125 GBs, and lane setup 4-1x ports and DSP System PLL at 100 MHz. 6. This will set the board to boot from Ethernet boot mode, with SerDes -clock multiplier x 4, core PLL clock at 100 MHz. +clock multiplier x 4, core PLL clock at 100 MHz. 7. This will set the board to boot form PCIE boot mode, with PCIE in end point mode and DSP System PLL at 100 MHz. diff --git a/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst index 6691e66b2..e9b43f9d4 100644 --- a/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst @@ -183,7 +183,7 @@ corresponding to FTDI UARTtoUSB will be turned on. .. rubric:: Connecting IDK EVM to Code Composer Studio :name: connecting-idk-evm-to-code-composer-studio -**Step1 :** Download Code composer Studio and AM572x Sitara CSP package +**Step1 :** Download Code composer Studio and AM572x Sitara CSP package as described in the wiki article mentioned below: `Install Code composer Studio for @@ -285,11 +285,11 @@ is installed CortexA15_0: GEL Output: DEBUG: EMIF1 channel - Launch full levelling CortexA15_0: GEL Output: DEBUG: Setting LISA maps in non-interleaved dual-EMIF mode CortexA15_0: GEL Output: --->>> DDR3 Initialization is DONE! <<<--- - CortexA15_0: GEL Output: --->>> AM572x Target Connect Sequence DONE !!!!! <<< + CortexA15_0: GEL Output: --->>> AM572x Target Connect Sequence DONE !!!!! <<< | -**Step6** : To connect to the DSP, M4,PRUSS or to IVAHD go to Scripts +**Step6** : To connect to the DSP, M4,PRUSS or to IVAHD go to Scripts menu and under AM572x MULTICORE Initialization enable the corresponding Sub system clock Enable API.For Eg. FOr DSP1 select DSP11SSClkEnable\_API. After running the clock enable option, you can diff --git a/source/common/Industrial_Protocols/HSR_PRP/_Firmware.rst b/source/common/Industrial_Protocols/HSR_PRP/_Firmware.rst index 66fedd80d..2d2cad05a 100644 --- a/source/common/Industrial_Protocols/HSR_PRP/_Firmware.rst +++ b/source/common/Industrial_Protocols/HSR_PRP/_Firmware.rst @@ -216,7 +216,7 @@ Table: **Shared RAM Memory Map** +--------------------------+--------------------------+--------------------------+ | Name of Offset | Description | Offset in Shared RAM | -| | Refer to | (base : 0x140) | +| | Refer to | (base : 0x140) | | | *hsr\_prp\_firmware.h* | | +==========================+==========================+==========================+ | LRE\_CNT\_TX\_A | Number of frames | *4* | diff --git a/source/common/Industrial_Protocols/HSR_PRP/_Firmware_Features.rst b/source/common/Industrial_Protocols/HSR_PRP/_Firmware_Features.rst index 67cb55246..5f06530d9 100644 --- a/source/common/Industrial_Protocols/HSR_PRP/_Firmware_Features.rst +++ b/source/common/Industrial_Protocols/HSR_PRP/_Firmware_Features.rst @@ -44,11 +44,11 @@ Firmware Features Supported - Duplicate discard table on Port to Port path (HSR) - Data integrity (CRC) check during port to port forwarding, except cut through (HSR) -- **QoS scheme** : 3-bit VLAN PCP +- **QoS scheme** : 3-bit VLAN PCP - - No of levels supported : 8 - - Number of host queues : 2 \| 4 QoS levels per host queue - - Number of port queues : 4 \| 2 QoS levels per port queue + - No of levels supported : 8 + - Number of host queues : 2 \| 4 QoS levels per host queue + - Number of port queues : 4 \| 2 QoS levels per port queue - Number of host queues are configurable - **Statistics** @@ -66,4 +66,4 @@ Firmware Features Supported - Single and Two step clock supported - Peer delay Response is always sent as two-step -- **Storm Prevention** : Yes. Configurable per port +- **Storm Prevention** : Yes. Configurable per port diff --git a/source/common/PRU-ICSS/Header_Files.rst b/source/common/PRU-ICSS/Header_Files.rst index 0b19f09ab..be45e4241 100644 --- a/source/common/PRU-ICSS/Header_Files.rst +++ b/source/common/PRU-ICSS/Header_Files.rst @@ -46,7 +46,7 @@ layout is like this: union{ u32 register_name; struct { -bit_field_names : bit_size; +bit_field_names : bit_size; . . . } register_name_bit; }; diff --git a/source/common/PRU-ICSS/PRU-Cape-Hardware-User-Guide.rst b/source/common/PRU-ICSS/PRU-Cape-Hardware-User-Guide.rst index 0da326189..ec5953e16 100644 --- a/source/common/PRU-ICSS/PRU-Cape-Hardware-User-Guide.rst +++ b/source/common/PRU-ICSS/PRU-Cape-Hardware-User-Guide.rst @@ -8,8 +8,8 @@ PRU Cape Hardware User Guide Introduction ^^^^^^^^^^^^ -This document describes the hardware architecture of the PRU Cape  -which is compatible with the Beagle Bone Black development platform.  +This document describes the hardware architecture of the PRU Cape +which is compatible with the Beagle Bone Black development platform. | @@ -147,7 +147,7 @@ Signals Used +------------------------------+------------------------------+------------------------+------------------------+ | PR1\_PRU0\_GPI15 | P8-15 | GPMC\_AD15 | PRU0\_GPI\_15 | +------------------------------+------------------------------+------------------------+------------------------+ -| VDD\_3V3C | P9-3, P9-4  | VDD\_3V3C | VDD\_3V3C | +| VDD\_3V3C | P9-3, P9-4 | VDD\_3V3C | VDD\_3V3C | +------------------------------+------------------------------+------------------------+------------------------+ | DGND | P8-1, P8-2, P9-1,P9-2 | DGND | DGND | +------------------------------+------------------------------+------------------------+------------------------+ @@ -168,7 +168,7 @@ This section describes major functional blocks of the PRU Cape. Audio """"" -The audio portion of the PRU Cape is composed of a Dual 8-bit DAC +The audio portion of the PRU Cape is composed of a Dual 8-bit DAC (DAC082S085) and a dual 105 mW Amplifier (LM4808). The output is then sent to a 3.5 mm Audio jack with a max pk-pk of .89V, following the consumer standard. @@ -201,7 +201,7 @@ the cape, the rest of the EEPROM is available for use. +--------------------------+-------------------------+-----------------------+----------------------+ | **CAPE NAME** | **BBB HEADER NUMBER** | **BBB MODE 0 NAME** | **CAPE USE** | +--------------------------+-------------------------+-----------------------+----------------------+ -| I2C2\_SDA              | P9-20 | I2C2\_SDA | I2C SCL            | +| I2C2\_SDA | P9-20 | I2C2\_SDA | I2C SCL | +--------------------------+-------------------------+-----------------------+----------------------+ | I2C2\_SCL | P9-19 | I2C2\_SCL | I2C SDA | +--------------------------+-------------------------+-----------------------+----------------------+ @@ -223,14 +223,13 @@ IN to allow use of the PRU Subsystem's eCAP IP. | PR1\_PRU0\_GPI15 | P8-15 | GPMC\_AD15 | PRU0\_GPI\_15 | +-----------------------------+-------------------------+------------------------+------------------------+ -  LCD """ -The LCD screen is on a duaghter board with its own built in -controller, model number  NHD-0208AZ-RN-YBW-33V. The LCD is connected to +The LCD screen is on a duaghter board with its own built in +controller, model number NHD-0208AZ-RN-YBW-33V. The LCD is connected to the PRU Cape throught the 2x8 female header in the middle of the cape. -The LCD is a 2x8 Character display operating at 3.3V. +The LCD is a 2x8 Character display operating at 3.3V. | @@ -336,7 +335,7 @@ PRU or any signal that can be accessed through the Cape Headers. UART """" -There is one RS-232 connector (DB9 male) on the PRU Cape. The MAX3232ECD +There is one RS-232 connector (DB9 male) on the PRU Cape. The MAX3232ECD is the line driver/receiver. | diff --git a/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst b/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst index 63a9b7ca9..6386a042a 100644 --- a/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst +++ b/source/common/PRU-ICSS/PRU-Hands-on-Labs.rst @@ -402,7 +402,7 @@ Build the PRU Firmware :: while(1){ - if ((__R31 & SW1) != SW1){ + if ((__R31 & SW1) != SW1){ /* Interrupt PRU1, wait 500ms for cheap "debounce" */ /* TODO: Trigger interrupt - see #defines */ __delay_cycles(100000000); /* 500ms @ 200MHz */ diff --git a/source/common/Release_Specific/_MCSDK_to_Processor_SDK_Migration.rst b/source/common/Release_Specific/_MCSDK_to_Processor_SDK_Migration.rst index e78acc36b..c10259118 100644 --- a/source/common/Release_Specific/_MCSDK_to_Processor_SDK_Migration.rst +++ b/source/common/Release_Specific/_MCSDK_to_Processor_SDK_Migration.rst @@ -356,7 +356,7 @@ application rather than the design of the software. header files as “ti/csl/device/k2?/src/xxxx.h” needs to be changed to “ti/csl/soc/k2?/src/xxxx.h” - One top level include header files per IP replaces multiple CSL files - per IP for the following : + per IP for the following : - , , , , and diff --git a/source/debian/Building_Debian_Image.rst b/source/debian/Building_Debian_Image.rst index 1e4c7205b..e33d732db 100644 --- a/source/debian/Building_Debian_Image.rst +++ b/source/debian/Building_Debian_Image.rst @@ -45,26 +45,26 @@ Repository Structure ├── build.sh ├── builds.toml ├── configs - │   ├── bdebstrap_configs - │   │   ├── bookworm - │   │   │   ├── bookworm-.yaml - │   │   │   └── bookworm-rt-.yaml - │   │   └── trixie - │   │   ├── trixie-.yaml - │   │   └── trixie-rt-.yaml - │   ├── bsp_sources.toml - │   └── machines --> Machine configurations for each BSP version - │   ├── 09.02.00.010.toml - │   └── 10.00.05.toml + │ ├── bdebstrap_configs + │ │ ├── bookworm + │ │ │ ├── bookworm-.yaml + │ │ │ └── bookworm-rt-.yaml + │ │ └── trixie + │ │ ├── trixie-.yaml + │ │ └── trixie-rt-.yaml + │ ├── bsp_sources.toml + │ └── machines --> Machine configurations for each BSP version + │ ├── 09.02.00.010.toml + │ └── 10.00.05.toml ├── create-sdcard.sh ├── create-wic.sh ├── LICENSE ├── README.md ├── scripts - │   ├── build_bsp.sh - │   ├── build_distro.sh - │   ├── common.sh - │   └── setup.sh + │ ├── build_bsp.sh + │ ├── build_distro.sh + │ ├── common.sh + │ └── setup.sh └── target --> Custom files to deploy in target. ``build.sh``: the "main" script that the user should run to generate Debian images. diff --git a/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst index a5119bc64..5c3f60ddf 100644 --- a/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst +++ b/source/devices/AM335X/linux/Release_Specific_Release_Notes.rst @@ -301,7 +301,7 @@ Linux Kernel Known Issues :name: installation-and-usage The :ref:`Software Developer's Guide ` provides instructions on how to setup up your Linux development -environment, install the SDK and start your development.  It also includes User's Guides for various Example Applications and Code +environment, install the SDK and start your development. It also includes User's Guides for various Example Applications and Code Composer Studio. | diff --git a/source/devices/AM335X/rtos/Release_Specific_Migration_Guide.rst b/source/devices/AM335X/rtos/Release_Specific_Migration_Guide.rst index 2a59047a2..471d5ae0a 100644 --- a/source/devices/AM335X/rtos/Release_Specific_Migration_Guide.rst +++ b/source/devices/AM335X/rtos/Release_Specific_Migration_Guide.rst @@ -388,7 +388,7 @@ sample code sets SemaphoreP/HwiP to be used from external memory block: /* Get the Hw Attrs */ osal_ret = Osal_getHwAttrs(&hwAttrs); - if (osal_ret != osal_OK) + if (osal_ret != osal_OK) { return (false); } diff --git a/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst index 2575ad32b..f5e58971b 100644 --- a/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst +++ b/source/devices/AM437X/linux/Release_Specific_Release_Notes.rst @@ -275,7 +275,7 @@ Linux Kernel Known Issues :name: installation-and-usage The :ref:`Software Developer's Guide ` provides instructions on how to setup up your Linux development -environment, install the SDK and start your development.  It also includes User's Guides for various Example Applications and Code +environment, install the SDK and start your development. It also includes User's Guides for various Example Applications and Code Composer Studio. | diff --git a/source/devices/AM437X/rtos/Release_Specific_Migration_Guide.rst b/source/devices/AM437X/rtos/Release_Specific_Migration_Guide.rst index 3ba810093..fcf337d95 100644 --- a/source/devices/AM437X/rtos/Release_Specific_Migration_Guide.rst +++ b/source/devices/AM437X/rtos/Release_Specific_Migration_Guide.rst @@ -388,7 +388,7 @@ sample code sets SemaphoreP/HwiP to be used from external memory block: /* Get the Hw Attrs */ osal_ret = Osal_getHwAttrs(&hwAttrs); - if (osal_ret != osal_OK) + if (osal_ret != osal_OK) { return (false); } diff --git a/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst index 2bb2e897b..51398835f 100644 --- a/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst +++ b/source/devices/AM57X/linux/Release_Specific_Release_Notes.rst @@ -297,7 +297,7 @@ RT Linux Kernel Known Issues :name: installation-and-usage The `Software Developer's Guide `__ provides instructions on how to setup up your Linux development -environment, install the SDK and start your development.  It also includes User's Guides for various Example Applications and Code +environment, install the SDK and start your development. It also includes User's Guides for various Example Applications and Code Composer Studio. | diff --git a/source/devices/AM57X/rtos/Release_Specific_Migration_Guide.rst b/source/devices/AM57X/rtos/Release_Specific_Migration_Guide.rst index 37c61d1c3..ba36a9d55 100644 --- a/source/devices/AM57X/rtos/Release_Specific_Migration_Guide.rst +++ b/source/devices/AM57X/rtos/Release_Specific_Migration_Guide.rst @@ -494,7 +494,7 @@ sample code sets SemaphoreP/HwiP to be used from external memory block: /* Get the Hw Attrs */ osal_ret = Osal_getHwAttrs(&hwAttrs); - if (osal_ret != osal_OK) + if (osal_ret != osal_OK) { return (false); } diff --git a/source/devices/AM62AX/linux/Overview/Run_Setup_Scripts.rst b/source/devices/AM62AX/linux/Overview/Run_Setup_Scripts.rst index 9e9f8fe78..cbe43ae9d 100644 --- a/source/devices/AM62AX/linux/Overview/Run_Setup_Scripts.rst +++ b/source/devices/AM62AX/linux/Overview/Run_Setup_Scripts.rst @@ -33,11 +33,11 @@ does the following things: :name: how-to-run-the-setup-script The Setup Script (**setup.sh**) is located in the |__SDK_FULL_NAME__| installation -directory.  By default, this directory has a name that has the form +directory. By default, this directory has a name that has the form |__SDK_INSTALL_DIR__|. -Change to that ti-processor-sdk-linux install directory. +Change to that ti-processor-sdk-linux install directory. Then run the script: **./setup.sh** @@ -87,7 +87,7 @@ packages may vary for different releases: .. note:: This part requires you to have administrator priviliges (sudo access). -This step is required for users using Ubuntu 12.04+. By default the +This step is required for users using Ubuntu 12.04+. By default the user does not have the proper permissions to access a serial device ( ex ttyS0, ttyUSB0, etc...). A user must be apart of a "dialout" group to access these serial device without root privileges. diff --git a/source/devices/AM62PX/linux/Overview/Run_Setup_Scripts.rst b/source/devices/AM62PX/linux/Overview/Run_Setup_Scripts.rst index b34c41683..22a49cb03 100644 --- a/source/devices/AM62PX/linux/Overview/Run_Setup_Scripts.rst +++ b/source/devices/AM62PX/linux/Overview/Run_Setup_Scripts.rst @@ -33,11 +33,11 @@ does the following things: :name: how-to-run-the-setup-script The Setup Script (**setup.sh**) is located in the |__SDK_FULL_NAME__| installation -directory.  By default, this directory has a name that has the form +directory. By default, this directory has a name that has the form |__SDK_INSTALL_DIR__|. -Change to that ti-processor-sdk-linux install directory. +Change to that ti-processor-sdk-linux install directory. Then run the script: **./setup.sh** @@ -87,7 +87,7 @@ packages may vary for different releases: .. note:: This part requires you to have administrator priviliges (sudo access). -This step is required for users using Ubuntu 12.04+. By default the +This step is required for users using Ubuntu 12.04+. By default the user does not have the proper permissions to access a serial device ( ex ttyS0, ttyUSB0, etc...). A user must be apart of a "dialout" group to access these serial device without root privileges. diff --git a/source/devices/AM62X/linux/Overview/Run_Setup_Scripts.rst b/source/devices/AM62X/linux/Overview/Run_Setup_Scripts.rst index 607056146..de36ab888 100644 --- a/source/devices/AM62X/linux/Overview/Run_Setup_Scripts.rst +++ b/source/devices/AM62X/linux/Overview/Run_Setup_Scripts.rst @@ -33,11 +33,11 @@ does the following things: :name: how-to-run-the-setup-script The Setup Script (**setup.sh**) is located in the |__SDK_FULL_NAME__| installation -directory.  By default, this directory has a name that has the form +directory. By default, this directory has a name that has the form |__SDK_INSTALL_DIR__|. -Change to that ti-processor-sdk-linux install directory. +Change to that ti-processor-sdk-linux install directory. Then run the script: **./setup.sh** @@ -87,7 +87,7 @@ packages may vary for different releases: .. note:: This part requires you to have administrator priviliges (sudo access). -This step is required for users using Ubuntu 12.04+. By default the +This step is required for users using Ubuntu 12.04+. By default the user does not have the proper permissions to access a serial device ( ex ttyS0, ttyUSB0, etc...). A user must be apart of a "dialout" group to access these serial device without root privileges. diff --git a/source/devices/AM64X/linux/Overview/Create_SD_Card.rst b/source/devices/AM64X/linux/Overview/Create_SD_Card.rst index 7ca7c5c40..1556367cb 100644 --- a/source/devices/AM64X/linux/Overview/Create_SD_Card.rst +++ b/source/devices/AM64X/linux/Overview/Create_SD_Card.rst @@ -17,7 +17,7 @@ Create SD Card with Default Images | 2. The default bootable SD card image (WIC file) is available - at /filesystem/tisdk-default-image-am64xx-evm.wic.xz + at /filesystem/tisdk-default-image-am64xx-evm.wic.xz | diff --git a/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst b/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst index a05752b4b..bb2d5c6bd 100644 --- a/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst +++ b/source/devices/AM65X/linux/Release_Specific_Release_Notes.rst @@ -341,7 +341,7 @@ Installation and Usage ====================== The :ref:`Software Developer's Guide ` provides instructions on how to setup up your Linux development -environment, install the SDK and start your development.  It also includes User's Guides for various Example Applications and Code +environment, install the SDK and start your development. It also includes User's Guides for various Example Applications and Code Composer Studio. | diff --git a/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst b/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst index 3f1a814ce..d7048daeb 100644 --- a/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst +++ b/source/devices/J7_Family/linux/Release_Specific_Release_Notes.rst @@ -236,7 +236,7 @@ Issues opened in previous releases that were closed on this release "LCPD-38644","v4l2 compliance failing with try_fmt","am62axx_sk-fs,am62pxx_sk-fs,am68_sk-fs,am69_sk-fs,j721s2-evm,j722s_evm-fs,j742s2_evm-fs,j784s4-evm" "LCPD-38622","J722S 4 Camera IMX219 GStreamer Pipeline Failure","j722s_evm-fs" "LCPD-38596","Upstream: correct mux node name for can ","j7200-evm,j721s2-evm" - "LCPD-38554","MCAN: add am68, am69, j7-sk in mcan docs ","am68_sk-fs,am69_sk-fs,j721e-sk" + "LCPD-38554","MCAN: add am68, am69, j7-sk in mcan docs","am68_sk-fs,am69_sk-fs,j721e-sk" "LCPD-38528","Documentation: IPC: Update 6.1.y links to 6.6.y","am62pxx_sk-fs,am62xx_sk-fs,j722s_evm-fs" "LCPD-38500","Add J721E SR 2.0 Support (k3conf and u-boot)","j721e-idk-gw" "LCPD-38497","Graceful Shutdown test failing","am69_sk-fs,j7200-evm,j721e-idk-gw,j721s2-evm,j784s4-evm" diff --git a/source/linux/Examples_and_Demos/Application_Demos/Video_Analytics.rst b/source/linux/Examples_and_Demos/Application_Demos/Video_Analytics.rst index daa763d8a..95614b901 100644 --- a/source/linux/Examples_and_Demos/Application_Demos/Video_Analytics.rst +++ b/source/linux/Examples_and_Demos/Application_Demos/Video_Analytics.rst @@ -96,7 +96,7 @@ folder and can be compiled using the SDK's top-level Makefile .. rubric:: OpenCV (running on ARM A15s) :name: opencv-running-on-arm-a15s -| *FLOW: camera color frames from V4L2 driver -> OpenCV based algorithms +| *FLOW: camera color frames from V4L2 driver -> OpenCV based algorithms -> single float converted to 4 discrete values* Video analytics functionality includes simple algorithm to extract @@ -117,12 +117,12 @@ and waves become higher. .. rubric:: OpenCL (running on ARM A15s + C66x) :name: opencl-running-on-arm-a15s-c66x -| *FLOW: 4 discrete values of wind speed (2.5, 4, 7, 10m/s)  -> OpenCL +| *FLOW: 4 discrete values of wind speed (2.5, 4, 7, 10m/s) -> OpenCL based algorithms -> 256x256 float height map matrix (-1, ..., +1 range of vertex heights)* Wave surface simulation is based on generation of Phillips (2D) spectrum -followed by 2D IFFT (256x256). Both operations are executed by OpenCL +followed by 2D IFFT (256x256). Both operations are executed by OpenCL offload to single DSP core. Many details on this algorithm can be found in `graphics.ucsd.edu/courses/rendering/2005/jdewall/tessendorf.pdf `__. @@ -131,13 +131,13 @@ algorithm) using fixed wind direction *(an idea for improvement: wind direction can be controlled using hand gesture).* Height map in form of 256x256 float matrix is generated on output and -used by OpenGL based vertex renderer (performed in next step). Wave +used by OpenGL based vertex renderer (performed in next step). Wave surface simulation consists of two steps: - initial setup defining starting conditions (wind speed and wind direction are used as input in this stage only) - update of wave surface height map (Phillips spectrum modification - generated at t=0, along time axe and 2D IFFT for each time step). + generated at t=0, along time axe and 2D IFFT for each time step). .. rubric:: OpenGL ES (running on ARM A15s + GPU/SGX) :name: opengl-es-running-on-arm-a15s-gpusgx @@ -166,11 +166,11 @@ system and control of above threads* | qt-opencv-multithreaded (`github.com/devernay/qt-opencv-multithreaded `__ - ) is skeleton GUI application providing camera input and some basic + ) is skeleton GUI application providing camera input and some basic image processing algorithms. Additional algorithm (w.r.t baseline) is - hand gesture which starts OpenCV thread and OpenCL simulation thread. + hand gesture which starts OpenCV thread and OpenCL simulation thread. Wave surface window (detached, 600x400) appears only if hand is put - (at 2-3ft) in front of EVM camera. Intensity of waves is defined by + (at 2-3ft) in front of EVM camera. Intensity of waves is defined by how much fingers are spread. | Please wait for 2-3 seconds (after start of Gesture detection) before putting hand in front of camera, to allow good background estimation. @@ -184,13 +184,13 @@ system and control of above threads* The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | file name |  description | +| | file name | description | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 1 | CameraConnectDialog.cpp/CameraConnectDialog.h | | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2 | CameraGrab.cpp/CameraGrab.h | Auxilliary camera frame acquisition functions to achieve full FPS | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3 | CameraView.cpp/CameraView.h | Major class instantiated after connecting to camera. This class creates processing thread, wavesimulation thread and also instantiates wave display (3D graphics) widget. | +| 3 | CameraView.cpp/CameraView.h | Major class instantiated after connecting to camera. This class creates processing thread, wavesimulation thread and also instantiates wave display (3D graphics) widget. | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 4 | CaptureThread.cpp/CaptureThread.h | Input (camera) frame buffering. | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -198,7 +198,7 @@ The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 6 | GeometryEngine.cpp/GeometryEngine.h | Height map mash creation, vertex updates | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7 | Gesture.cpp/Gesture.h | Hand gesture (OpenCV) detection algorith, | +| 7 | Gesture.cpp/Gesture.h | Hand gesture (OpenCV) detection algorith, | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 8 | ImageProcessingSettingsDialog.cpp/ImageProcessingSettingsDialog.h | Settings of parameters used by image processing algorithms. | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -206,7 +206,7 @@ The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 10 | MainWindow.cpp/MainWindow.h | | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 11 | MatToQImage.cpp/MatToQImage.h | Conversion from OpenCV Mat object to QT QImage object | +| 11 | MatToQImage.cpp/MatToQImage.h | Conversion from OpenCV Mat object to QT QImage object | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 12 | ProcessingThread.cpp/ProcessingThread.h | Main processing thread, frame rate dynamics, invokes variois image processing algorithms | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -214,7 +214,7 @@ The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 14 | WaveDisplayWidget.cpp/WaveDisplayWidget.h | Wave surface 3D rendering (invokes methods from GeometryEngine.cpp) | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 15 | WaveSimulationThread.cpp/WaveSimulationThread.h | Wave surface physical simulation thread - host side of OpenCL dispatch. | +| 15 | WaveSimulationThread.cpp/WaveSimulationThread.h | Wave surface physical simulation thread - host side of OpenCL dispatch. | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 16 | Buffers.h | | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -222,7 +222,7 @@ The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 18 | Config.h | | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 19 | phillips.cl | DSP OpenCL phillips spectrum generation kernels and 2D IFFT kernel (invoking dsplib.ae66 optimized 1D FFT). After compilation (by clocl) phillips.dsp\_h is generated, and included in WaveSimulationThread.cpp (ocl kernels are compiled and downloaded in this thread, before run-time operation is started). | +| 19 | phillips.cl | DSP OpenCL phillips spectrum generation kernels and 2D IFFT kernel (invoking dsplib.ae66 optimized 1D FFT). After compilation (by clocl) phillips.dsp\_h is generated, and included in WaveSimulationThread.cpp (ocl kernels are compiled and downloaded in this thread, before run-time operation is started). | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 20 | vshader.glsl | Vertex shader (gets projection matrix, position and texture position as input arguments; generates texture coordinate and height for fragment shader | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -230,9 +230,9 @@ The functionality is organized as shows in the files/description below. +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 22 | shaders.qrc | Specify shader filenames | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 23 | textures.qrc | Specify texture file (2D block which is linearly interpolated in fragment shader, using position arguments provided by vertex shader) | +| 23 | textures.qrc | Specify texture file (2D block which is linearly interpolated in fragment shader, using position arguments provided by vertex shader) | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 24 | qt-opencv-multithreaded.pro | Top level QT make file: phi | +| 24 | qt-opencv-multithreaded.pro | Top level QT make file: phi | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 25 | ImageProcessingSettingsDialog.ui | User interface definition file for modification of algorithm parameters. | +------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst b/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst index 9a320149c..ace60e788 100644 --- a/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst +++ b/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst @@ -8,7 +8,7 @@ AM335x Power Management User Guide This article provides a description of the example applications under the Power page of the Matrix application that comes with the Sitara -SDK.  This page is labled "Power" in the top-level Matrix GUI. The +SDK. This page is labled "Power" in the top-level Matrix GUI. The location of the Power icon on the main Matrix app list may be different than shown here, depending on screen size. (Screen shots from SDK 06.00) diff --git a/source/linux/Examples_and_Demos/_ARM_Multimedia_Users_Guide.rst b/source/linux/Examples_and_Demos/_ARM_Multimedia_Users_Guide.rst index 1cb45cec2..a590a9da9 100644 --- a/source/linux/Examples_and_Demos/_ARM_Multimedia_Users_Guide.rst +++ b/source/linux/Examples_and_Demos/_ARM_Multimedia_Users_Guide.rst @@ -161,7 +161,7 @@ buffers, they do not modify the data otherwise. :: - gst-launch-0.10 filesrc location=$filename ! qtdemux name=demux demux.audio_00 ! queue ! ffdec_aac ! alsasink sync=false demux.video_00 ! queue ! ffdec_mpeg4 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 + gst-launch-0.10 filesrc location=$filename ! qtdemux name=demux demux.audio_00 ! queue ! ffdec_aac ! alsasink sync=false demux.video_00 ! queue ! ffdec_mpeg4 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 "filename" is defined based on the selected display device which could be LCD of DVI. @@ -180,7 +180,7 @@ as mentioned in the description page below. :: - gst-launch-0.10 filesrc location=$filename ! mpeg4videoparse ! ffdec_mpeg4 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 + gst-launch-0.10 filesrc location=$filename ! mpeg4videoparse ! ffdec_mpeg4 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 | @@ -198,7 +198,7 @@ as mentioned in the description page below. :: - gst-launch-0.10 filesrc location=$filename ! h264parse ! ffdec_h264 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 + gst-launch-0.10 filesrc location=$filename ! h264parse ! ffdec_h264 ! ffmpegcolorspace ! fbdevsink device=/dev/fb0 .. rubric:: AAC Decode :name: aac-decode @@ -214,7 +214,7 @@ mentioned in the description page below. :: - gst-launch-0.10 filesrc location=$filename ! aacparse ! faad ! alsasink + gst-launch-0.10 filesrc location=$filename ! aacparse ! faad ! alsasink .. rubric:: Streaming :name: streaming @@ -226,7 +226,7 @@ the files directory using the pipeline :: - gst-launch souphttpsrc location=http:///files/HistoryOfTI.aac ! aacparse ! faad ! alsasink + gst-launch souphttpsrc location=http:///files/HistoryOfTI.aac ! aacparse ! faad ! alsasink | diff --git a/source/linux/Examples_and_Demos/_Camera_Users_Guide.rst b/source/linux/Examples_and_Demos/_Camera_Users_Guide.rst index 1cdcf9875..0022439a7 100644 --- a/source/linux/Examples_and_Demos/_Camera_Users_Guide.rst +++ b/source/linux/Examples_and_Demos/_Camera_Users_Guide.rst @@ -70,19 +70,19 @@ Contact: `Harishankkar `__ +----------------------+-----------------------------------------+------------+-----------+ | OMAP35xx/AM/DM37xx | Signal Description | Comment | IO Type | +----------------------+-----------------------------------------+------------+-----------+ -| cam\_hs | Camera Horizontal Sync |   | IO | +| cam\_hs | Camera Horizontal Sync | | IO | +----------------------+-----------------------------------------+------------+-----------+ -| cam\_vs | Camera Vertical Sync |   | IO | +| cam\_vs | Camera Vertical Sync | | IO | +----------------------+-----------------------------------------+------------+-----------+ | cam\_xclka | Camera Clock Output a | Optional | O | +----------------------+-----------------------------------------+------------+-----------+ | cam\_xclkb | Camera Clock Output b | Optional | O | +----------------------+-----------------------------------------+------------+-----------+ -| cam\_[d0:12] | Camera/Video Digital Image Data |   | I | +| cam\_[d0:12] | Camera/Video Digital Image Data | | I | +----------------------+-----------------------------------------+------------+-----------+ | cam\_fld | Camera Field ID | Optional | IO | +----------------------+-----------------------------------------+------------+-----------+ -| cam\_pclk | Camera Pixel Clock |   | I | +| cam\_pclk | Camera Pixel Clock | | I | +----------------------+-----------------------------------------+------------+-----------+ | cam\_wen | Camera Write Enable | Optional | I | +----------------------+-----------------------------------------+------------+-----------+ diff --git a/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst b/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst index a3a6ed5bf..c85878f74 100644 --- a/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst +++ b/source/linux/Examples_and_Demos/_Hands_on_with_QT.rst @@ -463,7 +463,7 @@ development. style="margin: 5px; padding: 5px 10px; background-color: #ffffec; border-left: 5px solid #ff6600;"> **IMPORTANT** - Notice there is a red ! icon. Don't worry, lets add in the toolchain + Notice there is a red ! icon. Don't worry, lets add in the toolchain next and it should change to yellow. .. raw:: html @@ -1333,7 +1333,7 @@ style sheets. QPushButton { /**font: bold 16pt; - color: white ; + color: white ; border-image: url(:/pushblueup.png); background-color: transparent; diff --git a/source/linux/Examples_and_Demos/_Matrix_User_Guide.rst b/source/linux/Examples_and_Demos/_Matrix_User_Guide.rst index c4e141c56..bd8d0cb1c 100644 --- a/source/linux/Examples_and_Demos/_Matrix_User_Guide.rst +++ b/source/linux/Examples_and_Demos/_Matrix_User_Guide.rst @@ -45,9 +45,9 @@ Matrix is an HTML 5 based application launcher created to highlight available applications and demos provided in new Software Development Kits. There are two forms of Matrix, local and remote Matrix. All of the example applications and demos are available using either the local or -remote version. The local version launches by default when the target -system is booted and uses the target system's touchscreen interface for -user input. Matrix comes as a 4x3 matrix of icons or as a 4x2 matrix +remote version. The local version launches by default when the target +system is booted and uses the target system's touchscreen interface for +user input. Matrix comes as a 4x3 matrix of icons or as a 4x2 matrix depending on the display resolution. .. Image:: /images/Matrix_2_Main_Menu.png @@ -60,7 +60,7 @@ depending on the display resolution. Local Matrix refers to Matrix being displayed on a display device attached to the target system. The launcher for Matrix is just a -simple QT application that displays a Webkit base browser that points +simple QT application that displays a Webkit base browser that points to the URL http://localhost:80 .. raw:: html @@ -86,14 +86,14 @@ The URL for Remote Matrix is http:// You can find the target's ip address by using local Matrix and clicking on the Settings icon and then on the Network Settings icon. Or using a -terminal logged in to the target system enter the below command: +terminal logged in to the target system enter the below command: :: ifconfig From the output displayed, look in the section that starts with eth0. -You sould see an IP address right after "inet addr". This is the IP +You sould see an IP address right after "inet addr". This is the IP address you should use for remote Matrix. With Remote Matrix you can interact with Matrix on your PC, cellphone, @@ -106,7 +106,7 @@ still look at the display device connected to the target system. :name: matrix-project-webpage The offical website for Matrix is located at -`**gforge.ti.com/gf/project/matrix-gui-v2/** `__ Any +`**gforge.ti.com/gf/project/matrix-gui-v2/** `__ Any comments or bug reports for Matrix should be posted there. .. rubric:: How to Use the Matrix @@ -140,7 +140,7 @@ Below is a summary of all the Matrix web pages: .. rubric:: Example Application Description Page :name: example-application-description-page -Below is an example application description page. Description pages can +Below is an example application description page. Description pages can be used to add additional information that may not be obvious. .. raw:: html @@ -164,7 +164,7 @@ be used to add additional information that may not be obvious. .. rubric:: Coming Soon Page :name: coming-soon-page -- Displayed for Matrix directories that doesn't contain any +- Displayed for Matrix directories that doesn't contain any applications within it. .. rubric:: Application/Script Execution Page @@ -196,14 +196,14 @@ the .desktop files and also the html that is generated from the various php pages. While this provides a substantial performance boost, developers must be aware that any changes to the Matrix apps folder which includes adding, deleting and modifying files can result in many -problems within Matrix. To properly update Matrix with the latest -information, Matrix's caches need to be cleared.  +problems within Matrix. To properly update Matrix with the latest +information, Matrix's caches need to be cleared. -.. rubric:: Automatically Clearing Matrix Cache +.. rubric:: Automatically Clearing Matrix Cache :name: automaticallyclearing-matrix-cache The simpliest way to clear Matrix's cache is to use the Refresh Matrix -application found within Matrix's Settings submenu. Simply running the +application found within Matrix's Settings submenu. Simply running the application will cause Matrix to clear all the cached files and regenerate the .desktops cache file. Once the application is done running, Matrix will be updated with the latest information found from @@ -226,7 +226,7 @@ To clear Matrix's caches you need to perform only two steps: 1. Execute the generate.php file. -In the terminal of the target system, enter the folllowing line of code. +In the terminal of the target system, enter the folllowing line of code. :: @@ -235,7 +235,7 @@ In the terminal of the target system, enter the folllowing line of code. or In a browser enter the following url. Note replace with the -IP address of the target system. +IP address of the target system. :: @@ -257,7 +257,7 @@ Once the above steps are completed, Matrix will be updated. .. rubric:: Launching Matrix :name: launching-matrix -Use the following shell script in the target's terminal window to run +Use the following shell script in the target's terminal window to run Matrix as a background task: :: @@ -267,7 +267,7 @@ Matrix as a background task: This script ensures that the touchscreen has been calibrated and that the Qt Window server is running. -Alternatively, Matrix can be launched manually with this full syntax: +Alternatively, Matrix can be launched manually with this full syntax: :: @@ -296,7 +296,7 @@ Touchscreen** `__ -Blank template icons for Matrix can be found here:  +Blank template icons for Matrix can be found here: `**gforge.ti.com/gf/download/frsrelease/712/5167/blank\_icons\_1.1.tar.gz** `__ .. rubric:: Creating the .Desktop File @@ -390,7 +389,7 @@ The fields and values are case sensitive. .. rubric:: Creating a New Matrix Directory :name: creating-a-new-matrix-directory -You can get all the files including the image discussed below from the +You can get all the files including the image discussed below from the following file: `**Ex\_directory.tar.gz** `__ @@ -412,7 +411,7 @@ Fill the contents of the file with the text shown below: This .desktop above tells Matrix that this .desktop is meant to create a new directory since Type=Directory. The directory should be named "Ex -Demo" and will use the icon located within the ex\_directory directory. +Demo" and will use the icon located within the ex\_directory directory. This new directory should be the 5th icon displayed as long as there aren't any other .desktop files that specify X-MATRIX-DisplayPriority=5 and will be displayed in the Matrix Main Menu. Now any applications that @@ -422,21 +421,21 @@ Category parameter set to ex\_dir. - Note that sometimes Linux will rename the .desktop file to the name specified in the Name field. If this occurs don't worry about trying to force it to use the file name specified. -- If you are writing these files in Windows, be sure to use Unix-style - EOL characters +- If you are writing these files in Windows, be sure to use Unix-style + EOL characters -Now move the .desktop file and image into the ex\_directory directory +Now move the .desktop file and image into the ex\_directory directory that was created. -.. rubric:: Moving the Newly created Directory to the Target's - File System +.. rubric:: Moving the Newly created Directory to the Target's + File System :name: moving-the-newly-createddirectory-to-the-targets-filesystem Open the Linux terminal and go to the directory that contains the ex\_directory. -Enter the below command to copy ex\_directory to -the /usr/share/matrix-gui-2.0/apps/ directory located in the target's +Enter the below command to copy ex\_directory to +the /usr/share/matrix-gui-2.0/apps/ directory located in the target's file system. Depending on the targetNFS directory premissions you might have to include sudo before the cp command. @@ -444,8 +443,8 @@ have to include sudo before the cp command. host $ cp ex_directory ~/ti-processor-sdk-linux-[platformName]-evm-xx.xx.xx.xx/targetNFS/usr/share/matrix-gui-2.0/apps/ -If NFS isn't being used then you need to copy the ex\_directory to -the the /usr/share/matrix-gui-2.0/apps/ directory in the target's +If NFS isn't being used then you need to copy the ex\_directory to +the the /usr/share/matrix-gui-2.0/apps/ directory in the target's filesystem. .. rubric:: Updating Matrix @@ -462,7 +461,7 @@ for your Ex Demo. .. rubric:: Creating a New Application :name: creating-a-new-application -This example is assuming that you completed the \ `**Creating a New +This example is assuming that you completed the \ `**Creating a New Matrix Directory** <#creating-a-new-matrix-directory>`__ example. You can get all the files including the image discussed below from the @@ -491,17 +490,17 @@ Fill the contents of the file with the below text: Type=Application lets Matrix know that this .desktop is for an application. The name of the application is "Test App". The -icon example-icon.png can be found within the ex\_application -directory. The command to execute is a shell script that will be located +icon example-icon.png can be found within the ex\_application +directory. The command to execute is a shell script that will be located within ex\_application. The script that is being ran is a simply shell script that output text to the terminal. Therefore, the ProgramType should be set to console. This application should be added to the Ex -Demo directory from the previous example. Therefore, Categories will be +Demo directory from the previous example. Therefore, Categories will be set to ex\_dir which is the same value that X-MATRIX-CategoryTarget is set to. You could optionally remove the Categories field to have this application displayed in Matrix's Main Menu. This application will also have a description page. The html file to be used is located within the -ex\_application directory. A lock is also being used. Therefore, any +ex\_application directory. A lock is also being used. Therefore, any other application including itself that has the same lock can't run simultaneously. @@ -515,7 +514,7 @@ Create a file named test\_script.sh echo "I am finally awake!" | The newly created script needs to have its permission set to be - executable. Enter the below command to give read, write and execute + executable. Enter the below command to give read, write and execute permission to all users and groups for the script: :: @@ -530,19 +529,19 @@ Create a new file called app\_desc.html

Purpose:

The purpose of this application is to demonstrate the ease in adding a new application to Matrix.

-Now move the .desktop file, script file, the png image located in the -Ex\_application.tar.gz file and the html file into the ex\_application +Now move the .desktop file, script file, the png image located in the +Ex\_application.tar.gz file and the html file into the ex\_application folder. -.. rubric:: Moving the newly created Directory to the Target System +.. rubric:: Moving the newly created Directory to the Target System :name: moving-the-newly-createddirectory-to-the-target-system Open the Linux terminal and go to the directory that contains the ex\_application directory. Enter the below command to copy the ex\_application directory -to /usr/share/matrix-gui-2.0/apps/ located in the target's file system. -Depending on the targetNFS directory permissions you might have to +to /usr/share/matrix-gui-2.0/apps/ located in the target's file system. +Depending on the targetNFS directory permissions you might have to include sudo before the cp command. :: @@ -557,21 +556,21 @@ the target's filesystem. :name: updating-matrix-2 Now in either local or remote Matrix go to the Settings directory and -click and then run the Refresh Matrix application. This will delete all +click and then run the Refresh Matrix application. This will delete all the cache files that Matrix generates and regenerate all the needed files which will include any updates that you have made. -Now if you go back to the Matrix's Main Menu and click on the Ex -Demo directory you should see your newly created application. Click on +Now if you go back to the Matrix's Main Menu and click on the Ex +Demo directory you should see your newly created application. Click on the application's icon and you will see the application's description page. Click the Run button and your application will execute. If you try -to run two instances of this application simultaneously via local and +to run two instances of this application simultaneously via local and remote Matrtix you will get a message saying that the program can't run because a lock exists. Because of X-Matrix-Lock being set to test\_app\_lock, Matrix knows not to run two instances of a -program simultaneously that share the same lock. You can run the +program simultaneously that share the same lock. You can run the application again when the previous application is done running. You have just successfully added a new application to Matrix using all -the possibly parameters!  +the possibly parameters! diff --git a/source/linux/Examples_and_Demos/_WLAN_and_Bluetooth.rst b/source/linux/Examples_and_Demos/_WLAN_and_Bluetooth.rst index 937eb3fdd..ebedd2b78 100644 --- a/source/linux/Examples_and_Demos/_WLAN_and_Bluetooth.rst +++ b/source/linux/Examples_and_Demos/_WLAN_and_Bluetooth.rst @@ -7,7 +7,7 @@ Demos available for the WL127x. Many of the demos are platform-agnostic, others apply specifically to a single platform. The WL127x's dual mode 802.11 b/g/n and *Bluetooth* transceiver -gives users a robust selection of applications. A list of some basic use +gives users a robust selection of applications. A list of some basic use cases preloaded on the EVMs can be seen below: | diff --git a/source/linux/Foundational_Components/Graphics/Rogue/Build_Guide.rst b/source/linux/Foundational_Components/Graphics/Rogue/Build_Guide.rst index 617216d87..d859a5a17 100644 --- a/source/linux/Foundational_Components/Graphics/Rogue/Build_Guide.rst +++ b/source/linux/Foundational_Components/Graphics/Rogue/Build_Guide.rst @@ -94,20 +94,20 @@ In the repository the following structure can be seen: ├── README └── targetfs ├── am62_linux - │   └── lws-generic - │   └── release + │ └── lws-generic + │ └── release ├── am62p_linux - │   └── lws-generic - │   └── release + │ └── lws-generic + │ └── release ├── j721e_linux - │   └── lws-generic - │   └── release + │ └── lws-generic + │ └── release ├── j721s2_linux - │   └── lws-generic - │   └── release + │ └── lws-generic + │ └── release ├── j722s_linux - │   └── lws-generic - │   └── release + │ └── lws-generic + │ └── release └── j784s4_linux └── lws-generic └── release diff --git a/source/linux/Foundational_Components/Graphics/SGX/Build_Guide.rst b/source/linux/Foundational_Components/Graphics/SGX/Build_Guide.rst index b8240fbee..a268313a6 100644 --- a/source/linux/Foundational_Components/Graphics/SGX/Build_Guide.rst +++ b/source/linux/Foundational_Components/Graphics/SGX/Build_Guide.rst @@ -92,19 +92,19 @@ In the repository the following structure can be seen: ├── README.md └── targetfs ├── common - │   ├── 50-pvrsrvctl.rules.template - │   ├── etc - │   └── pvrsrvctl.service.template + │ ├── 50-pvrsrvctl.rules.template + │ ├── etc + │ └── pvrsrvctl.service.template ├── ti335x_linux - │   └── lws-generic + │ └── lws-generic ├── ti343x_linux - │   └── lws-generic + │ └── lws-generic ├── ti437x_linux - │   └── lws-generic + │ └── lws-generic ├── ti443x_linux - │   └── lws-generic + │ └── lws-generic ├── ti572x_linux - │   └── lws-generic + │ └── lws-generic └── ti654x_linux └── lws-generic diff --git a/source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst b/source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst index afbd206ef..f8ec669b0 100644 --- a/source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst +++ b/source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst @@ -161,7 +161,7 @@ You can print the SGX clock rate in a debug build as below: .. code-block:: c IMG_UINT32 rate = clk_get_rate(psSysSpecData->psSGX_FCK); - PVR_TRACE(("Sgx clock is %dMHz", HZ_TO_MHZ(rate))); + PVR_TRACE(("Sgx clock is %dMHz", HZ_TO_MHZ(rate))); Depending on the TI platform used, this will vary from 200 to 532 MHz. Ensure that SGX is running at the right clock. diff --git a/source/linux/Foundational_Components/IPC/_IPC_for_AM57xx.rst b/source/linux/Foundational_Components/IPC/_IPC_for_AM57xx.rst index 4696c29d7..7cb7986c2 100644 --- a/source/linux/Foundational_Components/IPC/_IPC_for_AM57xx.rst +++ b/source/linux/Foundational_Components/IPC/_IPC_for_AM57xx.rst @@ -79,17 +79,17 @@ CCS is installed at: /mnt/data/user/ti/my_custom_ccs_x.x.x_install ├── ccsvX - │   ├── ccs_base - │   ├── doc - │   ├── eclipse - │   ├── install_info - │   ├── install_logs - │   ├── install_scripts - │   ├── tools - │   ├── uninstall_ccs - │   ├── uninstall_ccs.dat - │   ├── uninstallers - │   └── utils + │ ├── ccs_base + │ ├── doc + │ ├── eclipse + │ ├── install_info + │ ├── install_logs + │ ├── install_scripts + │ ├── tools + │ ├── uninstall_ccs + │ ├── uninstall_ccs.dat + │ ├── uninstallers + │ └── utils ├── Code Composer Studio x.x.x.desktop └── xdctools_x_xx_xx_xx_core ├── bin @@ -158,34 +158,34 @@ Here are the key files that you should see after a successful build: :: ├── dsp1 - │   └── bin - │      ├── debug - │      │   └── server_dsp1.xe66 - │      └── release - │      └── server_dsp1.xe66 + │ └── bin + │ ├── debug + │ │ └── server_dsp1.xe66 + │ └── release + │ └── server_dsp1.xe66 ├── dsp2 - │   └── bin - │      ├── debug - │      │   └── server_dsp2.xe66 - │      └── release - │      └── server_dsp2.xe66 + │ └── bin + │ ├── debug + │ │ └── server_dsp2.xe66 + │ └── release + │ └── server_dsp2.xe66 ├── host - │      ├── debug - │      │   └── app_host - │      └── release - │      └── app_host + │ ├── debug + │ │ └── app_host + │ └── release + │ └── app_host ├── ipu1 - │   └── bin - │      ├── debug - │      │   └── server_ipu1.xem4 - │      └── release - │      └── server_ipu1.xem4 + │ └── bin + │ ├── debug + │ │ └── server_ipu1.xem4 + │ └── release + │ └── server_ipu1.xem4 └── ipu2 -    └── bin -       ├── debug -       │   └── server_ipu2.xem4 -       └── release -       └── server_ipu2.xem4 + └── bin + ├── debug + │ └── server_ipu2.xem4 + └── release + └── server_ipu2.xem4 | @@ -313,14 +313,14 @@ Finally, we can run the example on DSP1: root@am57xx-evm:~# cat /proc/iomem [snip...] - 58060000-58078fff : core - 58820000-5882ffff : l2ram - 58882000-588820ff : /ocp/mmu@58882000 - 80000000-9fffffff : System RAM - 80008000-808d204b : Kernel code - 80926000-809c96bf : Kernel data - a0000000-abffffff : CMEM - ac000000-ffcfffff : System RAM + 58060000-58078fff : core + 58820000-5882ffff : l2ram + 58882000-588820ff : /ocp/mmu@58882000 + 80000000-9fffffff : System RAM + 80008000-808d204b : Kernel code + 80926000-809c96bf : Kernel data + a0000000-abffffff : CMEM + ac000000-ffcfffff : System RAM | @@ -547,30 +547,24 @@ ipc/packages/ti/ipc/remoteproc/rsc\_table\_vayu\_dsp.h DSP_MEM_TEXT, 0, DSP_MEM_TEXT_SIZE, 0, 0, "DSP_MEM_TEXT", }, -   { TYPE_CARVEOUT, DSP_MEM_DATA, 0, DSP_MEM_DATA_SIZE, 0, 0, "DSP_MEM_DATA", }, -   { TYPE_CARVEOUT, DSP_MEM_HEAP, 0, DSP_MEM_HEAP_SIZE, 0, 0, "DSP_MEM_HEAP", }, -   { TYPE_CARVEOUT, DSP_MEM_IPC_DATA, 0, DSP_MEM_IPC_DATA_SIZE, 0, 0, "DSP_MEM_IPC_DATA", }, -   { TYPE_TRACE, TRACEBUFADDR, 0x8000, 0, "trace:dsp", }, -   -   { TYPE_DEVMEM, DSP_MEM_IPC_VRING, PHYS_MEM_IPC_VRING, @@ -856,7 +850,7 @@ ipc\_3\_43\_02\_04/examples/DRA7XX\_linux\_elf/ex02\_messageq/ipu1/IpuAmmu.cfg AMMU.largePages[0].size = AMMU.Large_512M; AMMU.largePages[0].L1_cacheable = AMMU.CachePolicy_CACHEABLE; AMMU.largePages[0].L1_posted = AMMU.PostedPolicy_POSTED; -   + /* Peripheral regions: Large Page (512M); non-cacheable */ /* config large page[1] to map 512MB VA 0x60000000 to L3 0x60000000 */ AMMU.largePages[1].pageEnabled = AMMU.Enable_YES; @@ -865,7 +859,7 @@ ipc\_3\_43\_02\_04/examples/DRA7XX\_linux\_elf/ex02\_messageq/ipu1/IpuAmmu.cfg AMMU.largePages[1].size = AMMU.Large_512M; AMMU.largePages[1].L1_cacheable = AMMU.CachePolicy_NON_CACHEABLE; AMMU.largePages[1].L1_posted = AMMU.PostedPolicy_POSTED; -   + /* Private, Shared and IPC Data regions: Large page (512M); cacheable */ /* config large page[2] to map 512MB VA 0x80000000 to L3 0x80000000 */ AMMU.largePages[2].pageEnabled = AMMU.Enable_YES; @@ -923,25 +917,25 @@ ipc/packages/ti/ipc/remoteproc/rsc\_table\_vayu\_ipu.h #define IPU_MEM_TEXT 0x0 #define IPU_MEM_DATA 0x80000000 -   + #define IPU_MEM_IOBUFS 0x90000000 -   + #define IPU_MEM_IPC_DATA 0x9F000000 #define IPU_MEM_IPC_VRING 0x60000000 #define IPU_MEM_RPMSG_VRING0 0x60000000 #define IPU_MEM_RPMSG_VRING1 0x60004000 #define IPU_MEM_VRING_BUFS0 0x60040000 #define IPU_MEM_VRING_BUFS1 0x60080000 -   + #define IPU_MEM_IPC_VRING_SIZE SZ_1M #define IPU_MEM_IPC_DATA_SIZE SZ_1M -   + #if defined(VAYU_IPU_1) #define IPU_MEM_TEXT_SIZE (SZ_1M) #elif defined(VAYU_IPU_2) #define IPU_MEM_TEXT_SIZE (SZ_1M * 6) #endif -   + #if defined(VAYU_IPU_1) #define IPU_MEM_DATA_SIZE (SZ_1M * 5) #elif defined(VAYU_IPU_2) @@ -961,13 +955,11 @@ ipc/packages/ti/ipc/remoteproc/rsc\_table\_vayu\_ipu.h IPU_MEM_TEXT, 0, IPU_MEM_TEXT_SIZE, 0, 0, "IPU_MEM_TEXT", }, -   { TYPE_CARVEOUT, IPU_MEM_DATA, 0, IPU_MEM_DATA_SIZE, 0, 0, "IPU_MEM_DATA", }, -   { TYPE_CARVEOUT, IPU_MEM_IPC_DATA, 0, @@ -1191,7 +1183,7 @@ To do this, follow these steps. - For **Target**, select ti.targets.elf.C66 - For **Platform**, select ti.platforms.evmDRA7XX - Once the platform is selected, edit its name buy hand and - append :dsp1 to the end. After this it should be + append :dsp1 to the end. After this it should be ti.platforms.evmDRA7XX:dsp1 - Go ahead and leave the **Build-profile** set to debug. - Hit the OK button. @@ -1393,11 +1385,11 @@ before BIOS\_start() .. code-block:: c ipc_main(); -   + if (callIpcStartup) { IpcMgr_ipcStartup(); } -   + /* Start BIOS */ BIOS_start(); return (0); @@ -1567,12 +1559,12 @@ following log on the serial IO console: :: - uart driver and utils example test cases : + uart driver and utils example test cases : Enter 16 characters or press Esc 1234567890123456 <- user input Data received is 1234567890123456 <- loopback from user input - uart driver and utils example test cases : + uart driver and utils example test cases : Enter 16 characters or press Esc | @@ -1639,7 +1631,7 @@ To do this, follow these steps. - For **Target**, select **ti.targets.arm.elf.M4** - For **Platform**, select **ti.platforms.evmDRA7XX** - Once the platform is selected, edit its name buy hand and - append :ipu2 to the end. After this it should be + append :ipu2 to the end. After this it should be ti.platforms.evmDRA7XX:ipu2 - Go ahead and leave the **Build-profile** set to debug. - Hit the OK button. @@ -1855,7 +1847,7 @@ needs to be performed by the M4. | -**Modified Code :** +**Modified Code :** :: @@ -1872,7 +1864,7 @@ adding the following code before Board\_init API call: (CSL_l4per_cm_core_componentRegs *)CSL_MPU_L4PER_CM_CORE_REGS; CSL_FINST(l4PerCmReg->CM_L4PER_UART3_CLKCTRL_REG, L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_MODULEMODE, ENABLE); - while(CSL_L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST_FUNC != + while(CSL_L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST_FUNC != CSL_FEXT(l4PerCmReg->CM_L4PER_UART3_CLKCTRL_REG, L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST)); diff --git a/source/linux/Foundational_Components/IPC/_IPC_for_AM65xx.rst b/source/linux/Foundational_Components/IPC/_IPC_for_AM65xx.rst index 3e0cfbf75..1997ea89f 100644 --- a/source/linux/Foundational_Components/IPC/_IPC_for_AM65xx.rst +++ b/source/linux/Foundational_Components/IPC/_IPC_for_AM65xx.rst @@ -109,22 +109,22 @@ Here are the key files that you should see after a successful build: :: ├── r5f-0 - │   └── bin - │      ├── debug - │      │   └── server_r5f-0.xer5f - │      └── release - │      │   └── server_r5f-0.xer5f + │ └── bin + │ ├── debug + │ │ └── server_r5f-0.xer5f + │ └── release + │ │ └── server_r5f-0.xer5f ├── r5f-1 - │   └── bin - │      ├── debug - │      │   └── server_r5f-1.xer5f - │      └── release - │      │   └── server_r5f-1.xer5f + │ └── bin + │ ├── debug + │ │ └── server_r5f-1.xer5f + │ └── release + │ │ └── server_r5f-1.xer5f ├── host - │      ├── debug - │      │   └── app_host - │      └── release - │      └── app_host + │ ├── debug + │ │ └── app_host + │ └── release + │ └── app_host | diff --git a/source/linux/Foundational_Components/IPC/_Quick_Start_Guide.rst b/source/linux/Foundational_Components/IPC/_Quick_Start_Guide.rst index 8c7022f81..77b69002e 100644 --- a/source/linux/Foundational_Components/IPC/_Quick_Start_Guide.rst +++ b/source/linux/Foundational_Components/IPC/_Quick_Start_Guide.rst @@ -102,7 +102,7 @@ The source code are located in: to set up the build environment. | -| **DSP RTOS :** +| **DSP RTOS :** **1.** Install RTOS Proc SDK at the default location diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/ADC.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/ADC.rst index 74ac70195..dea09e4f2 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/ADC.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/ADC.rst @@ -379,7 +379,7 @@ Important folders in the iio:deviceX directory are: - in\_voltageX\_en: is this channel enabled? - in\_voltageX\_index: index of this channel in the buffer's chunks -- in\_voltageX\_type : How the ADC stores its data. Reading this file +- in\_voltageX\_type : How the ADC stores its data. Reading this file should return you a string something like below: :: diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst index 5a417a732..dae24b77c 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst @@ -851,7 +851,7 @@ Additional Information #. `ALSA User Space Library `__ #. `Using ALSA Audio - API `__ Author: Paul + API `__ Author: Paul Davis .. rubric:: Software Help diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/VIP.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/VIP.rst index 6618e69ca..d00c05f77 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/VIP.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/VIP.rst @@ -607,7 +607,7 @@ any modifications) into the device. Following points to keep in mind – .vpdma_fmt = { &vpdma_raw_fmts[VPDMA_DATA_FMT_RAW8], }, }, -   + const struct vpdma_data_format vpdma_raw_fmts[] = { [VPDMA_DATA_FMT_RAW8] = { .type = VPDMA_DATA_FMT_TYPE_YUV, diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst index 3eec6f57e..5b6a2fde0 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst @@ -28,7 +28,7 @@ devices: For devices with available cryptographic hardware accelerators, a Linux driver and additionally a Cryptodev kernel module (for OpenSSL) is used -to access them.  Other devices use the pure software implementation of these +to access them. Other devices use the pure software implementation of these cryptographic operations. .. ifconfig:: CONFIG_crypto in ('sa2ul') diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.rst index a3de58a87..0d61d9cf8 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.rst @@ -1075,11 +1075,11 @@ Below commands will be redirected to the phy driver: :: - [ speed %d ] + [ speed %d ] [ duplex half|full ] [ autoneg on|off ] [ wol p|u|m|b|a|g|s|d... ] - [ sopass %x:%x:%x:%x:%x:%x ] + [ sopass %x:%x:%x:%x:%x:%x ] .. note:: @@ -1096,7 +1096,7 @@ Sets the driver message type flags by name or number :: - [ msglvl %d | msglvl type on|off ... ] + [ msglvl %d | msglvl type on|off ... ] # ethtool -s eth0 msglvl drv off # ethtool -s eth0 msglvl ifdown off # ethtool -s eth0 msglvl ifup off diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst index 0c1b2d924..271faf704 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP.rst @@ -1022,7 +1022,7 @@ NOT the current frequency. if (clock_gettime(clkid, &ts)) { perror("clock_gettime"); } else { - printf("clock time: %ld.%09ld or %s", + printf("clock time: %ld.%09ld or %s", ts.tv_sec, ts.tv_nsec, ctime(&ts.tv_sec)); } @@ -1232,7 +1232,7 @@ asserted low when the polarity bit is low. pfd.timeout.nsec = 0; pfd.timeout.flags = ~PPS_TIME_INVALID; if (ioctl(fd, PPS_FETCH, &pfd)) { - pr_err("failed to fetch PPS: %m"); + pr_err("failed to fetch PPS: %m"); return 0; } @@ -1788,7 +1788,7 @@ PTP EXTTS feature of the Linux PTP infrastructure. /* reading timestamps */ for (i=0; i < 10; i++) { read(fd, &event, sizeof(event)); - printf("event index %u at %lld.%09u\n", event.index, + printf("event index %u at %lld.%09u\n", event.index, event.t.sec, event.t.nsec); } @@ -2032,12 +2032,12 @@ Delete the 100-th entry in the table • version: the ALE version information • enable: 0 to disable the ALE, 1 to enable ALE (should be 1 for normal operations) • clear: set to 1 to clear the table (refer to [1] for description) - • ageout : set to 1 to force age out of entries (refer to [1] for description]) - • p0_uni_flood_en : set to 1 to enable unknown unicasts to be flooded to host port. Set to 0 to not flood such unicasts. Note: if set to 0, CPSW may delay + • ageout : set to 1 to force age out of entries (refer to [1] for description]) + • p0_uni_flood_en : set to 1 to enable unknown unicasts to be flooded to host port. Set to 0 to not flood such unicasts. Note: if set to 0, CPSW may delay sending packets to the SOC host until it learns what mac addresses the host is using. - • vlan_nolearn : set to 1 to prevent VLAN id from being learned along with source address. - • no_port_vlan : set to 1 to allow processing of packets received with VLAN ID=0; set to 0 to replace received packets with VLAN ID=0 to the VLAN set in the port’s default VLAN register. - • oui_deny : 0/1 (refer to [1] for a description of this bit) + • vlan_nolearn : set to 1 to prevent VLAN id from being learned along with source address. + • no_port_vlan : set to 1 to allow processing of packets received with VLAN ID=0; set to 0 to replace received packets with VLAN ID=0 to the VLAN set in the port’s default VLAN register. + • oui_deny : 0/1 (refer to [1] for a description of this bit) • bypass: set to 1 to enable ALE bypass. In this mode the CPSW will not act as switch on receive; instead it will forward all received traffic from external ports to the host port. Set to 0 for normal (switched) operations. • rate_limit_tx: set to 1 for rate limiting to apply to transmit direction, set to 0 for receive direction. Refer to [1] for a description of this bit. @@ -2051,25 +2051,25 @@ Delete the 100-th entry in the table o 3: forwarding • port_state.1: set the port 1 state. • port_state.2: set the port 2 state - • drop_untagged.0 : set to 1 to drop untagged packets received on port 0 (host port) - • drop_untagged.1 : set to 1 to drop untagged packets received on port 1 - • drop_untagged.2 : set to 1 to drop untagged packets received on port 2 - • drop_unknown.0 : set to 1 to drop packets received on port 0 (host port) with unknown VLAN tags. Set to 0 to allows these to be processed - • drop_unknown.1 : set to 1 to drop packets received on port 1 with unknown VLAN tags. Set to 0 to allow these to be processed. - • drop_unknown.2 : set to 1 to drop packets received on port 2 with unknown VLAN tags. Set to 0 to allow these to be processed. - • nolearn.0 : set to 1 to disable address learning for port 0 - • nolearn.1 : set to 1 to disable address learning for port 1 - • nolearn.2 : set to 1 to disable address learning for port 2 - • unknown_vlan_member : this is the port mask for packets received with unknown VLAN IDs. The port mask is a 5 bit number with a bit representing each port. Bit 0 refers to the + • drop_untagged.0 : set to 1 to drop untagged packets received on port 0 (host port) + • drop_untagged.1 : set to 1 to drop untagged packets received on port 1 + • drop_untagged.2 : set to 1 to drop untagged packets received on port 2 + • drop_unknown.0 : set to 1 to drop packets received on port 0 (host port) with unknown VLAN tags. Set to 0 to allows these to be processed + • drop_unknown.1 : set to 1 to drop packets received on port 1 with unknown VLAN tags. Set to 0 to allow these to be processed. + • drop_unknown.2 : set to 1 to drop packets received on port 2 with unknown VLAN tags. Set to 0 to allow these to be processed. + • nolearn.0 : set to 1 to disable address learning for port 0 + • nolearn.1 : set to 1 to disable address learning for port 1 + • nolearn.2 : set to 1 to disable address learning for port 2 + • unknown_vlan_member : this is the port mask for packets received with unknown VLAN IDs. The port mask is a 5 bit number with a bit representing each port. Bit 0 refers to the host port. A ‘1’ in bit position N means include the port in further forwarding decision. (e.g., port mask = 0x7 means ports 0 (internal), 1 and 2 should be included in the forwarding decision). Refer to [1] for more details. - • unknown_mcast_flood= : this is the port mask for packets received with unkwown VLAN ID and unknown (un-registered) destination multicast address. This port_mask will be used in the + • unknown_mcast_flood= : this is the port mask for packets received with unkwown VLAN ID and unknown (un-registered) destination multicast address. This port_mask will be used in the multicast flooding decision. unknown multicast flooding. • unknown_reg_flood: this is the port mask for packets received with unknown VLAN ID and registered (known) destination multicast address. It is used in the multicast forwarding decision. • unknown_force_untag_egress: this is a port mask to control if VLAN tags are stripped off on egress or not. Set to 1 to force tags to be stripped by h/w prior to transmission - • bcast_limit.0 : threshold for broadcast pacing on port 0 . + • bcast_limit.0 : threshold for broadcast pacing on port 0 . • bcast_limit.1: threshold for broadcast pacing on port 1. - • bcast_limit.2 : threshold for broadcast pacing on port 2 . + • bcast_limit.2 : threshold for broadcast pacing on port 2 . • mcast_limit.0: threshold for multicast pacing on port 0 . • mcast_limit.1: threshold for multicast pacing on port 1 .. • mcast_limit.2: threshold for multicast pacing on port 2 . @@ -2179,13 +2179,13 @@ egress on port 2 only: echo “unknown_force_untag_egress=7” > /sys/class/net/eth0/device/ale_control -To set to Port 1 to “Admit tagged” (i.e. drop un-tagged) : +To set to Port 1 to “Admit tagged” (i.e. drop un-tagged) : :: echo “drop_untagged.1=1” > /sys/class/net/eth0/device/ale_control -To set to Port 1 to “Admit all” : +To set to Port 1 to “Admit all” : :: diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS.rst index 967302389..336553197 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS.rst @@ -131,7 +131,7 @@ the supplied firmware. .. rubric:: Kernel configuration :name: kernel-configuration -To enable/disable PRU Ethernet driver support, start the Linux Kernel Configuration tool: +To enable/disable PRU Ethernet driver support, start the Linux Kernel Configuration tool: :: diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex.rst index a5311a3ec..34a076f5a 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex.rst @@ -478,7 +478,7 @@ including desktop, mobile, server, storage and embedded communications. procedure can be used to boot Linux kernel using this rootfs. Boot EVM to u-boot prompt. Add following env variables to u-boot - environment :- + environment :- :: diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI.rst index 71aefc5da..a272286ae 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI.rst @@ -430,9 +430,9 @@ section <#enabling-qspi-driver-configurations>`__ for more information). root~# ubiformat /dev/mtd9 ubiformat: mtd9 (nor), size 23199744 bytes (22.1 MiB), 354 eraseblocks of 65536 bytes (64.0 KiB), min. I/O size 1 bytes - libscan: scanning eraseblock 353 -- 100 % complete + libscan: scanning eraseblock 353 -- 100% complete ubiformat: 354 eraseblocks are supposedly empty - ubiformat: formatting eraseblock 353 -- 100 % complete + ubiformat: formatting eraseblock 353 -- 100% complete root:~# ubiattach -p /dev/mtd9 [ 270.874428] ubi0: attaching mtd9 [ 270.914131] ubi0: scanning is finished diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst index ef2a40aad..87618ed84 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst @@ -305,7 +305,7 @@ Driver Configuration which can check for pending background operations and give the card some time to clear up the same. | This feature is already part of the framework and to start using it - the User needs to enable EXT\_CSD : BKOPS\_EN [163] BIT 0. + the User needs to enable EXT\_CSD : BKOPS\_EN [163] BIT 0. **This can be done using the "mmc-utils" tool from user space or using the "mmc" command in U-boot.** diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND.rst index 6f4b1c285..95445b671 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND.rst @@ -319,8 +319,8 @@ many other things like wear leveling, bad-block management, etc. .. rubric:: **Board specific configurations** :name: board-specific-configurations -| Following table gives details about NAND devices present on various - EVM boards +| Following table gives details about NAND devices present on various + EVM boards +----------+----------+----------+----------+----------+----------+----------+----------+----------+ | EVM | NAND | Size | Bus-Widt | Block-Si | Page-Siz | OOB-Size | ECC | Hardware | @@ -400,7 +400,7 @@ BCH16. So BCH8 ECC Scheme has been used on this board. .. rubric:: Configurations (GPMC Specific) :name: configurations-gpmc-specific -.. rubric:: **How to enable GPMC NAND driver in Linux Kernel ?** +.. rubric:: **How to enable GPMC NAND driver in Linux Kernel ?** :name: how-to-enable-gpmc-nand-driver-in-linux-kernel .. ifconfig:: CONFIG_part_family in ('AM62X_family') @@ -412,7 +412,7 @@ BCH16. So BCH8 ECC Scheme has been used on this board. => setenv name_overlays ti/k3-am62x-lp-sk-nand.dtbo GPMC NAND driver can be enabled/disabled via *Linux Kernel -Configuration* tool. Enable below Configs to enable MTD Support along +Configuration* tool. Enable below Configs to enable MTD Support along with MTD NAND driver support :: diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/AM62_DWC3.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/AM62_DWC3.rst index 7a7962442..2b8e9a0bc 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/AM62_DWC3.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/AM62_DWC3.rst @@ -80,7 +80,7 @@ Kernel Configuration tool. ... -- Select DesignWare USB3 DRD Core Support and Texas Instruments AM62 +- Select DesignWare USB3 DRD Core Support and Texas Instruments AM62 Platforms :: @@ -93,7 +93,7 @@ Kernel Configuration tool. Texas Instruments AM62 Platforms ... -- Select 'xHCI HCD (USB 3.0) SUPPORT' from  menuconfig in 'USB support' +- Select 'xHCI HCD (USB 3.0) SUPPORT' from menuconfig in 'USB support' :: @@ -103,7 +103,7 @@ Kernel Configuration tool. <*> xHCI HCD (USB 3.0) support ... -- Select 'USB Gadget Support --->' from menuconfig in 'USB support' and +- Select 'USB Gadget Support --->' from menuconfig in 'USB support' and select the needed gadgets. (By default all gadgets are made as modules) diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3.rst index ed99b5d22..62fbfdce4 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3.rst @@ -33,7 +33,7 @@ DWC3 is integrated in AM65x, OMAP5, DRA7x and AM437x SoCs from TI. (drivers/extcon/extcon-palmas.c) notifies the events to OMAP glue driver (driver/usb/dwc3/dwc3-omap.c) via the extcon framework. The glue driver writes the events to the software mailbox present in DWC3 glue (SS USB - OTG controller  module in the diagram) which interrupts the core using + OTG controller module in the diagram) which interrupts the core using UTMI+ signals. .. image:: /images/Omap5-dwc3.png @@ -189,7 +189,7 @@ Kernel Configuration tool. ... -- Select DesignWare USB3 DRD Core Support and Texas Instruments OMAP5 +- Select DesignWare USB3 DRD Core Support and Texas Instruments OMAP5 and similar Platforms :: @@ -233,7 +233,7 @@ Kernel Configuration tool. <*> TI PIPE3 PHY Driver ... -- Select 'xHCI HCD (USB 3.0) SUPPORT' from  menuconfig in 'USB support' +- Select 'xHCI HCD (USB 3.0) SUPPORT' from menuconfig in 'USB support' :: @@ -243,7 +243,7 @@ Kernel Configuration tool. <*> xHCI HCD (USB 3.0) support ... -- Select 'USB Gadget Support --->' from menuconfig in 'USB support' and +- Select 'USB Gadget Support --->' from menuconfig in 'USB support' and select the needed gadgets. (By default all gadgets are made as modules) @@ -286,7 +286,7 @@ Kernel Configuration tool. EHCI Debug Device mode (serial) ---> USB Webcam Gadget -.. rubric:: **Configuring DWC3 in gadget only**  +.. rubric:: **Configuring DWC3 in gadget only** :name: configuring-dwc3-in-gadget-only .. ifconfig:: CONFIG_part_family in ('General_family') @@ -425,7 +425,7 @@ Connecting a USB2.0 pendrive to the USB host port gives the following prints [ 479.437774] usb 1-1: ep 0x81 - rounding interval to 128 microframes, ep desc says 255 microframes [ 479.447454] usb 1-1: ep 0x2 - rounding interval to 128 microframes, ep desc says 255 microframes [ 479.458124] usb-storage 1-1:1.0: USB Mass Storage device detected - [ 479.465355] scsi1 : usb-storage 1-1:1.0 + [ 479.465355] scsi1 : usb-storage 1-1:1.0 [ 480.784475] scsi 1:0:0:0: Direct-Access Sony Storage Media 0100 PQ: 0 ANSI: 4 [ 480.801677] sd 1:0:0:0: [sda] 61046784 512-byte logical blocks: (31.2 GB/29.1 GiB) [ 480.820740] sd 1:0:0:0: [sda] Write Protect is off @@ -680,8 +680,8 @@ modes is through a USB Reset. :name: other-resources For general Linux USB subsystem -- `Usbgeneralpage `__ +- `Usbgeneralpage `__ USB Debugging -- `elinux.org/images/1/17/USB\_Debugging\_and\_Profiling\_Techniques.pdf `__ +- `elinux.org/images/1/17/USB\_Debugging\_and\_Profiling\_Techniques.pdf `__ diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/MUSB.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/MUSB.rst index 5505c6dde..c400f8704 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/MUSB.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/USB/MUSB.rst @@ -190,5 +190,5 @@ Table: - The Mentor USB driver can be built as module or built into kernel. For more information refer to `USB - configuration `__  + configuration `__ diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/VPE.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/VPE.rst index 709a935b6..eb40f62d9 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/VPE.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/VPE.rst @@ -64,7 +64,7 @@ and deinterlacing: .. rubric:: Unsupported Features/Limitations :name: unsupported-featureslimitations -- Following formats are not supported : YUV444, YVYU, VYUY, NV16, NV61, +- Following formats are not supported : YUV444, YVYU, VYUY, NV16, NV61, NV21, 16bit and Lower RGB formats are not supported. - Passing of custom scaler and CSC coeffficients through user space are not supported. diff --git a/source/linux/Foundational_Components/Kernel/_LTP-DDT_Validation.rst b/source/linux/Foundational_Components/Kernel/_LTP-DDT_Validation.rst index d7e446356..9bbcd5946 100644 --- a/source/linux/Foundational_Components/Kernel/_LTP-DDT_Validation.rst +++ b/source/linux/Foundational_Components/Kernel/_LTP-DDT_Validation.rst @@ -131,7 +131,7 @@ Supported platforms with LTP-DDT .. rubric:: Host Platform Requirements :name: host-platform-requirements -Linux host is required : +Linux host is required : - for compiling LTP-DDT. - to host the NFS server to boot the EVM with NFS as root filesystem @@ -221,7 +221,7 @@ and the platform (option -P) to use. For example: -D : Run test under additional background load on Secondary storage -m : Run test under additional background load on Main memory -i : Run test under additional background load on IO Bus - -n  : Run test with network traffic in background. + -n : Run test with network traffic in background. Please refer to README-DDT file section 8) for more details. diff --git a/source/linux/Foundational_Components/Power_Management/pm_suspend_resume.rst b/source/linux/Foundational_Components/Power_Management/pm_suspend_resume.rst index 554eb6436..e0f71658f 100644 --- a/source/linux/Foundational_Components/Power_Management/pm_suspend_resume.rst +++ b/source/linux/Foundational_Components/Power_Management/pm_suspend_resume.rst @@ -217,7 +217,7 @@ cycle should look like this: PM: noirq resume of devices complete after 39.113 msecs PM: early resume of devices complete after 10.180 msecs net eth0: initializing cpsw version 1.12 (0) - net eth0: phy found : id is : 0x4dd074 + net eth0: phy found : id is : 0x4dd074 PM: resume of devices complete after 368.844 msecs Restarting tasks ... done $ diff --git a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_GDB_Setup_with_CCS.rst b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_GDB_Setup_with_CCS.rst index c47c8ac38..4a84af4ef 100644 --- a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_GDB_Setup_with_CCS.rst +++ b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_GDB_Setup_with_CCS.rst @@ -29,32 +29,32 @@ prerequisites are met: #. In CCS, select the project you wish to work with by clicking on it and highlighting it. -#. Select the Run -> Debug Configurations menu item.  This opens a +#. Select the Run -> Debug Configurations menu item. This opens a dialog box as shown below. .. Image:: /images/Initial-debug-configurations.png -3. Double click C/C++ Remote Application.  You should then see a new - debug configuration named "helloworld Debug" as shown below.  +3. Double click C/C++ Remote Application. You should then see a new + debug configuration named "helloworld Debug" as shown below. Select your target connection from the Connection drop-down - box.  In the example the target connection is called My Target EVM. + box. In the example the target connection is called My Target EVM. .. Image:: /images/Hello_World_Debug_Configuration.png 4. Click the Search Project button to open the Program Selection dialog - box below.  Click on the "armle - /helloworld/Debug/helloworld" item and + box below. Click on the "armle - /helloworld/Debug/helloworld" item and click OK. .. Image:: /images/Debug-config-2.png -5. Click the "Browse..." button for "Remote Absolute File Path for C/C++ - Application".  Navgate to the executable file on the remote file system.  - For this example, the executable file is found at "/usr/bin/helloworld". +5. Click the "Browse..." button for "Remote Absolute File Path for C/C++ + Application". Navgate to the executable file on the remote file system. + For this example, the executable file is found at "/usr/bin/helloworld". .. Image:: /images/Auto-debug-config-main-tab.png -6. Click the Debugger tab.  On the Debugger page, the Main tab should +6. Click the Debugger tab. On the Debugger page, the Main tab should be selected. Click Browse next to "GDB debugger" and browse to the GDB executable. @@ -64,7 +64,7 @@ GDB should be located at: | | Click browse next to "GDB command file" and browse to the .gdbinit file in the SDK install directory. -| GDB init file should be located at : /.gdbinit +| GDB init file should be located at : /.gdbinit | When you try to browse to the .gdbinit file, you will need to right click and select Show Hidden Files to see the file. @@ -86,21 +86,21 @@ the Debug Configuration window. You are now ready to debug the application! -.. rubric:: Running the Debug Session +.. rubric:: Running the Debug Session :name: running-thedebug-session -1. Make sure that you are setup for the debug build configuration which - contains symbol information.  In the C/C++ perspective, click on the +1. Make sure that you are setup for the debug build configuration which + contains symbol information. In the C/C++ perspective, click on the helloworld project to select it and -   Project -> Build Configurations -> Set Active -> Debug. + Project -> Build Configurations -> Set Active -> Debug. -2. Click the green "bug" icon to build the executable, transfer the +2. Click the green "bug" icon to build the executable, transfer the executable to the target, start gdbserver and and start debugging. -   CCS will change to the CCS Debug perspective. The debug tab will + CCS will change to the CCS Debug perspective. The debug tab will show the running threads and their status. The source code window will - show the program halted at the first executable source code line in the + show the program halted at the first executable source code line in the main() function. The Variables window will show the local variables and their current values. @@ -112,16 +112,16 @@ You are now ready to debug the application! 6. Use the debugger "Step Over" and "Step Into" icons to step through the source code. -7. To resume program execution, click the Run -> Resume menu item.  +7. To resume program execution, click the Run -> Resume menu item. -   NOTE: Do not click the Run -> Debug menu item, as that will attempt + NOTE: Do not click the Run -> Debug menu item, as that will attempt to start a new debug session. -   From here, you can make changes to the C source files, save the + From here, you can make changes to the C source files, save the changes and then just click the green "Bug" icon again and you will be debugging the new executable on the target. -  (Each time you start the debugger the executable is built, + (Each time you start the debugger the executable is built, automatically transferred to the target board and the gdbserver program is started for you.) @@ -129,7 +129,7 @@ You are now ready to debug the application! :name: stopping-the-debug-session When finished debugging the helloworld application, click the Run -> -Resume menu item.   To terminate the program,  click the Terminate icon +Resume menu item. To terminate the program, click the Terminate icon in CCS (this icon is a red square). .. rubric:: Manually Terminating Gdbserver @@ -154,8 +154,8 @@ Once setup, you can follow these steps to terminate gdbserver: 3) Click on "Executable Name" in the table headers to sort the list by executable name. -4) Find the gdbserver process.  Right click on it and select Kill.  This - will open a "Send a Kill Signal" dialog box.  Click the Kill button. +4) Find the gdbserver process. Right click on it and select Kill. This + will open a "Send a Kill Signal" dialog box. Click the Kill button. .. Image:: /images/Shell-processes.png diff --git a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Kernel_Debugging_with_CCS.rst b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Kernel_Debugging_with_CCS.rst index d067d6be2..a11614c54 100644 --- a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Kernel_Debugging_with_CCS.rst +++ b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Kernel_Debugging_with_CCS.rst @@ -99,7 +99,7 @@ Capabilities tab in the Preference dialog (select **Window** --> 3. Click on the icon **New launch configuration** (Top left of the pane) -4. Set the fields  **C/C++ Application:** and\ **Project:** +4. Set the fields **C/C++ Application:** and\ **Project:** respectively to the existing project in the workspace and the binary executable file @@ -130,11 +130,11 @@ Capabilities tab in the Preference dialog (select **Window** --> being used, but it is possible to use also CodeSourcery or other toolchain. -   Click browse next to "GDB command file" and browse to the .gdbinit - file in the SDK install directory.  When you try to browse to the - .gdbinit file, you will need + Click browse next to "GDB command file" and browse to the .gdbinit + file in the SDK install directory. When you try to browse to the + .gdbinit file, you will need -   to R-Click -> Show Hidden Files to see the file.   Click the Close + to R-Click -> Show Hidden Files to see the file. Click the Close button and you are now ready to debug the application! - In this example of the 06.00.00.00 SDK, the path is: @@ -458,9 +458,9 @@ expected address (wrong library or version mismatch?) warning: .dynamic section for "/lib/libc.so.6" is not at the expected address (wrong library or version mismatch?) When SDKs setup.sh script, it should automatically generate a .gdbinit -file for you in the base directory of the SDK.  +file for you in the base directory of the SDK. -The file will contain the line: set sysroot /targetNFS. +The file will contain the line: set sysroot /targetNFS. An example would be diff --git a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Remote_Explorer_Setup_with_CCS.rst b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Remote_Explorer_Setup_with_CCS.rst index 1bde67a8a..2994d651c 100644 --- a/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Remote_Explorer_Setup_with_CCS.rst +++ b/source/linux/Foundational_Components/Tools/Code_Composer_Studio/_Remote_Explorer_Setup_with_CCS.rst @@ -73,25 +73,25 @@ Connection Wizard. .. Image:: /images/X-New_Connection.png -#. Do NOT click the Finish button.  Click **Next** +#. Do NOT click the Finish button. Click **Next** #. Check **ssh.files** to use the *Secure Shell* protocol for communication .. Image:: /images/Ssh-files.png -#. Do NOT click the Finish button.  Click **Next** +#. Do NOT click the Finish button. Click **Next** #. Check **processes.shell.linux** to use a shell to work with processes on the remote system .. Image:: /images/Processes_.png -#. Do NOT click the Finish button.  Click **Next** +#. Do NOT click the Finish button. Click **Next** #. Check **ssh.shells** to use *Secure Shell* to work will shell commands .. Image:: /images/Shells.png -#. Do NOT click the Finish button.  Click **Next** +#. Do NOT click the Finish button. Click **Next** #. Check **ssh.terminals** to use *Secure Shell* to work with terminals .. Image:: /images/Terminals.png diff --git a/source/linux/Foundational_Components/U-Boot/Apps-Splash-Screen.rst b/source/linux/Foundational_Components/U-Boot/Apps-Splash-Screen.rst index dfdadea17..7ab5e687c 100644 --- a/source/linux/Foundational_Components/U-Boot/Apps-Splash-Screen.rst +++ b/source/linux/Foundational_Components/U-Boot/Apps-Splash-Screen.rst @@ -90,7 +90,7 @@ In board\_late\_init call the splash screen routine. :: - #if !defined(CONFIG_SPL_BUILD) + #if !defined(CONFIG_SPL_BUILD) splash_screen(); /* try reading mac address from efuse */ mac_lo = readl(&cdev->macid0l); @@ -105,7 +105,7 @@ bmp\_display. .. code-block:: text #if defined(CONFIG_LCD) && defined(CONFIG_AM335X_LCD) && \ -  !defined(CONFIG_SPL_BUILD) + !defined(CONFIG_SPL_BUILD) void lcdbacklight(int on) { gpio_request(GPIO_BACKLIGHT_EN, "backlight_en"); @@ -156,12 +156,12 @@ bmp\_display. struct am335x_lcdpanel lcd_panel; memset(&lcd_panel, 0, sizeof(struct am335x_lcdpanel)); - if (load_lcdtiming(&lcd_panel) != 0) + if (load_lcdtiming(&lcd_panel) != 0) return; lcd_panel.panel_power_ctrl = &lcdpower; - if (am335xfb_init(&lcd_panel) != 0) + if (am335xfb_init(&lcd_panel) != 0) printf("ERROR: failed to initialize video!"); /* Modify panel into to real resolution */ diff --git a/source/linux/Foundational_Components/_CMEM.rst b/source/linux/Foundational_Components/_CMEM.rst index c669c0424..88e7f9142 100644 --- a/source/linux/Foundational_Components/_CMEM.rst +++ b/source/linux/Foundational_Components/_CMEM.rst @@ -165,7 +165,7 @@ section of 'config.bib' of your BSP: :: - CMEM_DSP 89000000 02800000 RESERVED ; 40 MB + CMEM_DSP 89000000 02800000 RESERVED ; 40 MB That reserves 40MB of memory for CMEM, DSPLINK, DSP code as well as DSP heap usage starting at virtual address 0x89000000. There is no @@ -189,28 +189,28 @@ TI EVM3530: ; Make 1 pool available for allocation for block 1 "NumPools0"=dword:7 "NumPools1"=dword:0 -   + "Block0_NumBuffers_Pool0"=dword:20 "Block0_PoolSize_Pool0"=dword:1000 ; size in bytes (hex) "Block0_NumBuffers_Pool1"=dword:8 "Block0_PoolSize_Pool1"=dword:20000 ; size in bytes (hex) "Block0_NumBuffers_Pool2"=dword:5 "Block0_PoolSize_Pool2"=dword:100000 ; size in bytes (hex) -   + "Block0_NumBuffers_Pool3"=dword:1 "Block0_PoolSize_Pool3"=dword:15cfc0 ; size in bytes (hex) "Block0_NumBuffers_Pool4"=dword:1 "Block0_PoolSize_Pool4"=dword:3e800 ; size in bytes (hex) "Block0_NumBuffers_Pool5"=dword:1 "Block0_PoolSize_Pool5"=dword:36ee80 ; size in bytes (hex) -   + "Block0_NumBuffers_Pool6"=dword:3 "Block0_PoolSize_Pool6"=dword:96000 ; size in bytes (hex) -   + ;; "Block1_NumBuffers_Pool1"=dword:2 - ;; "Block1_PoolSize_Pool1"=dword:4000 ; size in bytes (hex) -   -   + ;; "Block1_PoolSize_Pool1"=dword:4000 ; size in bytes (hex) + + ; Physical start + physical end can be use to ask CMEM to map a specific ; range of physical addresses. ; This is a potential security risk. If physical start == 0 then the code @@ -218,7 +218,7 @@ TI EVM3530: ; physical end - physical start == length of allocation. In the special ; case, memory is allocated via a call to AllocPhysMem() (as shown in ; this example). MmMapIoSpace() is used to map the normal case where - ; physical start != 0. + ; physical start != 0. ; ; physical start and end for block 0 "PhysicalStart0"=dword:85000000 @@ -450,13 +450,13 @@ of processes to start as a parameter. Now load the kernel module :: -  % insmod cmemk.ko phys_start=0xcaf01000 phys_end=0xCB601000 pools=4x1000 phys_start_1=0xCB601000 phys_end_1=0xCB701000 pools_1=4x1000 + % insmod cmemk.ko phys_start=0xcaf01000 phys_end=0xCB601000 pools=4x1000 phys_start_1=0xCB601000 phys_end_1=0xCB701000 pools_1=4x1000 (Uses DDR) :: -  % insmod cmemk.ko phys_start=0x40300000 phys_end=0x4033FFFF pools=4x500 phys_start_1=0x4033FFFF phys_end_1=0x4037ffff pools_1=4x500 allowOverlap=1 + % insmod cmemk.ko phys_start=0x40300000 phys_end=0x4033FFFF pools=4x500 phys_start_1=0x4033FFFF phys_end_1=0x4037ffff pools_1=4x500 allowOverlap=1 (Uses OCMC1, for this rebuild the Translate Test app with macro BUFFER\_SIZE = 500 at line #49 in file @@ -465,7 +465,7 @@ test, :: -  % multi_process 3 + % multi_process 3 where 3 is the number of processes to be spawned. @@ -477,13 +477,13 @@ This app tests the address translation. Now load the kernel module :: -  % insmod cmemk.ko phys_start=0xcaf01000 phys_end=0xCB601000 pools=1x3145728 + % insmod cmemk.ko phys_start=0xcaf01000 phys_end=0xCB601000 pools=1x3145728 (Uses DDR) :: -  % insmod cmemk.ko phys_start=0x40300000 phys_end=0x4037ffff pools=1x20000 allowOverlap=1 + % insmod cmemk.ko phys_start=0x40300000 phys_end=0x4037ffff pools=1x20000 allowOverlap=1 (Uses OCMC1, for this rebuild the Translate Test app with macro BUFSIZE = 20000 at line #48 in file (linuxutils)/src/cmem/tests/translate.c) Now @@ -491,7 +491,7 @@ run the Translate test, :: -  % translate + % translate .. rubric:: API Test :name: api-test @@ -502,7 +502,7 @@ Now load the kernel module 'cmemk.ko' with the below command: :: -  % insmod cmemk.ko phys_start=0x87800000 phys_end=0x87F00000 pools=4xBUFSIZE phys_start_1=0x87F00000 phys_end_1=0x88000000 pools_1=4xBUFSIZE + % insmod cmemk.ko phys_start=0x87800000 phys_end=0x87F00000 pools=4xBUFSIZE phys_start_1=0x87F00000 phys_end_1=0x88000000 pools_1=4xBUFSIZE where BUFSIZE is the number of bytes you plan on passing as command line parameter to apitest. If in doubt, use a larger number as BUFSIZE @@ -511,13 +511,13 @@ Now run the API test, :: -  % apitest + % apitest (e.g) With BUFSIZE=10240 :: -  % apitest 10240 + % apitest 10240 .. rubric:: CMEM FAQ :name: cmem-faq diff --git a/source/linux/Foundational_Components/_OpenCV.rst b/source/linux/Foundational_Components/_OpenCV.rst index 421bfef25..01c3c7655 100644 --- a/source/linux/Foundational_Components/_OpenCV.rst +++ b/source/linux/Foundational_Components/_OpenCV.rst @@ -632,7 +632,7 @@ implementation: :: ... - String opts = format("-D CN=%d -D NMIXTURES=%d%s -DTIDSP_MOG2 -D SUBLINE_CACHE=%d", nchannels, nmixtures, bShadowDetection ? " -DSHADOW_DETECT" : "", subline_cache); + String opts = format("-D CN=%d -D NMIXTURES=%d%s -DTIDSP_MOG2 -D SUBLINE_CACHE=%d", nchannels, nmixtures, bShadowDetection ? " -DSHADOW_DETECT" : "", subline_cache); kernel_apply.create("mog2_kernel", ocl::video::bgfg_mog2_oclsrc, opts); ... @@ -716,8 +716,8 @@ modules/video/src/opencl/bgfg\_mog2.cl: TI DSP specific OpenCL implementation ... - cv::String kname = format( "tidsp_gaussian" ) ; - cv::String kdefs = format("-D T=%s -D T1=%s -D cn=%d", ocl::typeToStr(type), ocl::typeToStr(depth), cn) ; + cv::String kname = format( "tidsp_gaussian" ) ; + cv::String kdefs = format("-D T=%s -D T1=%s -D cn=%d", ocl::typeToStr(type), ocl::typeToStr(depth), cn) ; ocl::Kernel k(kname.c_str(), ocl::imgproc::gauss_oclsrc, kdefs.c_str() ); ... @@ -907,7 +907,7 @@ Profiling results of DSP optimized OpenCV OpenCL kernels (SDK 3.1), AM5728 platf -------------------------------------------------------------------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -**Single channel, 1200x709, barcode ROI detection use case** +**Single channel, 1200x709, barcode ROI detection use case** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. csv-table:: @@ -1112,17 +1112,17 @@ http://downloads.ti.com/mctools/esd/docs/opencl/memory/host-malloc-extension.htm #include #include #include -   + using namespace std; using namespace cv; using namespace cl; -   + const int NumElements = 512*512; // image size const int NumWorkGroups = 256; const int VectorElements = 4; const int NumVecElements = NumElements / VectorElements; const int WorkGroupSize = NumVecElements / NumWorkGroups; -   + void ProcRawCL(Mat &mat_src, const std::string &kernel_name) { //=============================================================== @@ -1136,7 +1136,7 @@ http://downloads.ti.com/mctools/esd/docs/opencl/memory/host-malloc-extension.htm Mat test_mat1(mat_src.size(), CV_8UC1, ptr_cmem1); Mat test_mat2(mat_src.size(), CV_8UC1, ptr_cmem2); Mat test_mat3(mat_src.size(), CV_8UC1, ptr_cmem3); -   + mat_src.copyTo(test_mat1); threshold(test_mat1, test_mat2, 128.0, 192.0, THRESH_BINARY); imwrite("out_cmem1.jpg", test_mat2); @@ -1146,31 +1146,31 @@ http://downloads.ti.com/mctools/esd/docs/opencl/memory/host-malloc-extension.htm { Context context(CL_DEVICE_TYPE_ACCELERATOR); std::vector devices = context.getInfo(); -   + int d = 0; std::string str; ifstream t(kernel_name); std::string kernelStr((istreambuf_iterator(t)), istreambuf_iterator()); -   + devices[d].getInfo(CL_DEVICE_NAME, &str); cout << "DEVICE: " << str << endl << endl; -   + Program::Sources source(1, std::make_pair(kernelStr.c_str(), kernelStr.length())); Program program = Program(context, source); program.build(devices); -   + Kernel kernel(program, "maskVector"); Buffer bufA (context, CL_MEM_READ_ONLY | CL_MEM_USE_HOST_PTR, bufsize, ptr_cmem2); Buffer bufDst (context, CL_MEM_WRITE_ONLY | CL_MEM_USE_HOST_PTR, bufsize, ptr_cmem1); kernel.setArg(0, bufA); kernel.setArg(1, bufDst); -   + Event ev1; -   + CommandQueue Q(context, devices[d], CL_QUEUE_PROFILING_ENABLE); Q.enqueueNDRangeKernel(kernel, NullRange, NDRange(NumVecElements), NDRange(WorkGroupSize), NULL, &ev1); ev1.wait(); -   + ocl_event_times(ev1, "Kernel Exec"); imwrite("out_cmem2.jpg", test_mat1); } diff --git a/source/linux/Foundational_Components/_OpenVX.rst b/source/linux/Foundational_Components/_OpenVX.rst index 1f3772ee5..e7c312a84 100644 --- a/source/linux/Foundational_Components/_OpenVX.rst +++ b/source/linux/Foundational_Components/_OpenVX.rst @@ -62,26 +62,26 @@ kernels and call them using OpenVX APIs. | | layer also binds TIOVX framework to | | | a specific OS like Linux or TI-RTOS | +--------------------------------------+--------------------------------------+ -| TIOVX Kernel Wrapper | Kernel wrappers allow TI and | +| TIOVX Kernel Wrapper | Kernel wrappers allow TI and | | | customers to integrate a natively | | | implemented kernel into the TIOVX | | | framework. | +--------------------------------------+--------------------------------------+ -| TIOVX Conformance tests | OpenVX conformance test from Khronos | +| TIOVX Conformance tests | OpenVX conformance test from Khronos | | | to make sure an implementation | | | implements OpenVX according to | | | specification. | +--------------------------------------+--------------------------------------+ -There are two versions of VXLIB kernels: without BAM framework, and -with BAM framework. BAM is a low level framework representing directed +There are two versions of VXLIB kernels: without BAM framework, and +with BAM framework. BAM is a low level framework representing directed acyclic graph, where EDMA transfers are heavily utilized to bring 2D memory objects to higher speed L2 memory, thus improving performance almost twofold. -Current release has kernels with BAM framework. This framework +Current release has kernels with BAM framework. This framework achieves higher performance via heavy use of EDMA, which brings blocks -of data from remote DDR memory to local L2, while DSP does the +of data from remote DDR memory to local L2, while DSP does the processing. List of these kernels can be checked in https://git.ti.com/processor-sdk/tiovx/trees/master/kernels/openvx-core/c66x/bam. @@ -91,7 +91,7 @@ https://git.ti.com/processor-sdk/tiovx/trees/master/kernels/openvx-core/c66x/bam There are 44 kernels in current release of VXLIB (typically there are multiple implementations for different data types). -Here is complete list of DSP kernel wrappers (wrappers are part of TIOVX): +Here is complete list of DSP kernel wrappers (wrappers are part of TIOVX): - AbsDiff - AccumulateSquare @@ -147,30 +147,30 @@ Following TIOVX components are present in EVM filesystem: | | | using different test | | | | vectors | +--------------------------+--------------------------+--------------------------+ -| DSP firmware | /lib/firmware/dra7-dsp1- | DSP firmware including | +| DSP firmware | /lib/firmware/dra7-dsp1- | DSP firmware including | | | fw.xe66.openvx, | DSP side of TIOVX | | | | framwork implementation, | | | /lib/firmware/dra7-dsp | IPC implementation, | -| | 2-fw.xe66.openvx | DSP kernels (part of | -| | | VXLIB DSP library) - for | +| | 2-fw.xe66.openvx | DSP kernels (part of | +| | | VXLIB DSP library) - for | | | | DSP1. This firmware is | | | | loaded at boot time, or | | | | using procedure | | | | mentioned below (to | -| | | switch from OCL firmware | -| | | to TIOVX firmware) | +| | | switch from OCL firmware | +| | | to TIOVX firmware) | +--------------------------+--------------------------+--------------------------+ TIOVX release 1.0.0.0 runs exclusively wrt OpenCL, as both firmwares use -common resources DSP cores and CMEM memory. That is: application can be +common resources DSP cores and CMEM memory. That is: application can be either TIOVX-based, or OpenCL -based. Future releases may remove this -limitation and use static split in resources (between OpenCL and +limitation and use static split in resources (between OpenCL and OpenVX). **TIOVX needs CMEM memory with two blocks**: block 0 is big DDR block for exchange of big buffers (>100MB) and block 1 (~1MB) which is used as shared memory visible from all cores to exchange shared data objects (typically in OCMC) -.. rubric:: Switch from OpenCL to OpenVX firmware: +.. rubric:: Switch from OpenCL to OpenVX firmware: :name: switch-from-opencl-to-openvxfirmware Run the command below to switch from OpenCL to OpenVx firmware: @@ -184,7 +184,7 @@ Run the command below to switch from OpenCL to OpenVx firmware: First, it is necessary to copy test vectors from https://git.ti.com/processor-sdk/tiovx/trees/master/conformance_tests/test_data -to EVM filesystem (e.g. ~/tiovx/test\_data).Then run following +to EVM filesystem (e.g. ~/tiovx/test\_data).Then run following commands: :: @@ -235,7 +235,7 @@ Please note that last ~3000 lines of test log include performance data (execution time and number of pixels processed) useful for further evaluation. -.. rubric:: Switch from OpenVX, back to OpenCL firmware: +.. rubric:: Switch from OpenVX, back to OpenCL firmware: :name: switch-from-openvx-back-to-openclfirmware After finishing running the TIOVX test application, switch the firmware back to the default for OpenCL: @@ -249,7 +249,7 @@ After finishing running the TIOVX test application, switch the firmware back to | TIOVX framework implementation is available at https://git.ti.com/processor-sdk/tiovx/trees/master -| TIOVX sample application including IPC implementation based on +| TIOVX sample application including IPC implementation based on standard MessageQ, as well as application running conformance tests, can be found at https://git.ti.com/processor-sdk/tiovx-app/trees/master diff --git a/source/linux/Foundational_Components_Multimedia_IVAHD.rst b/source/linux/Foundational_Components_Multimedia_IVAHD.rst index a948c9d6d..62ff25071 100644 --- a/source/linux/Foundational_Components_Multimedia_IVAHD.rst +++ b/source/linux/Foundational_Components_Multimedia_IVAHD.rst @@ -331,15 +331,15 @@ space conversion. :: 1. Decode-> Scale->Display - target # gst-launch-1.0 -v filesrc location=example_h264.mp4 ! qtdemux ! h264parse ! \ - ducatih264dec ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)720, height=(int)480' ! kmssink + target # gst-launch-1.0 -v filesrc location=example_h264.mp4 ! qtdemux ! h264parse ! \ + ducatih264dec ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)720, height=(int)480' ! kmssink :: 2. Color space conversion: - target # gst-launch-1.0 -v videotestsrc ! 'video/x-raw, format=(string)YUY2, width= \ - (int)1280, height=(int)720' ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)720, height=(int)480' \ -  ! kmssink + target # gst-launch-1.0 -v videotestsrc ! 'video/x-raw, format=(string)YUY2, width= \ + (int)1280, height=(int)720' ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)720, height=(int)480' \ + ! kmssink .. note:: 1. While using playbin for playing the stream, vpe plugin is automatically picked up. However vpe cannot be used @@ -353,18 +353,18 @@ respectively. :: Capture and Display Fullscreen - target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)YUY2, width=(int)1280, height=(int)720' ! vpe num-input-buffers=8 ! queue ! kmssink + target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)YUY2, width=(int)1280, height=(int)720' ! vpe num-input-buffers=8 ! queue ! kmssink :: Note: The following pipelines can also be used for NV12 capture-display usecase. Dmabuf is allocated by v4l2src if io-mode=4 and by kmssink and imported by v4l2src if io-mode=5 - target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)NV12, width=(int)1280, height=(int)720' ! kmssink - target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ - format=(string)NV12, width=(int)1280, height=(int)720' ! kmssink + target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)NV12, width=(int)1280, height=(int)720' ! kmssink + target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ + format=(string)NV12, width=(int)1280, height=(int)720' ! kmssink | @@ -372,8 +372,8 @@ respectively. Capture and Display to a window in wayland 1. refer Wayland/Weston to start the weston - 2. target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)YUY2, width=(int)1280, height=(int)720' ! vpe num-input-buffers=8 ! queue ! waylandsink + 2. target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)YUY2, width=(int)1280, height=(int)720' ! vpe num-input-buffers=8 ! queue ! waylandsink :: @@ -382,34 +382,34 @@ respectively. if io-mode=4 and by waylandsink and imported by v4l2src if io-mode=5. Waylandsink supports both shm and drm. A new property use-drm is added to specify drm allocator based bufferpool to be used. When using ducati or vpe plugins, use-drm is set in caps as true. - target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)NV12, width=(int)1280, height=(int)720' ! waylandsink use-drm=true - target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ - format=(string)NV12, width=(int)1280, height=(int)720' ! waylandsink use-drm=true + target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)NV12, width=(int)1280, height=(int)720' ! waylandsink use-drm=true + target # gst-launch-1.0 v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ + format=(string)NV12, width=(int)1280, height=(int)720' ! waylandsink use-drm=true | :: Capture and Encode into a MP4 file. - target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)YUY2, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! vpe num-input-buffers=8 ! \ - queue ! ducatimpeg4enc bitrate=4000 ! queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 + target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)YUY2, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! vpe num-input-buffers=8 ! \ + queue ! ducatimpeg4enc bitrate=4000 ! queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 :: Note: The following pipeline can be used in usecases where vpe processing is not required. - target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ - format=(string)NV12, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! ducatimpeg4enc bitrate=4000 ! \ - queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 + target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=5 ! 'video/x-raw, \ + format=(string)NV12, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! ducatimpeg4enc bitrate=4000 ! \ + queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 :: Capture and Encode and Display in parallel. - target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ - format=(string)YUY2, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! vpe num-input-buffers=8 ! tee name=t  ! \ - queue ! ducatimpeg4enc bitrate=4000 ! queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 t. ! queue ! kmssink + target # gst-launch-1.0 -e v4l2src device=/dev/video1 num-buffers=1000 io-mode=4 ! 'video/x-raw, \ + format=(string)YUY2, width=(int)1280, height=(int)720, framerate=(fraction)30/1' ! vpe num-input-buffers=8 ! tee name=t ! \ + queue ! ducatimpeg4enc bitrate=4000 ! queue ! mpeg4videoparse ! qtmux ! filesink location=x.mp4 t. ! queue ! kmssink Below provides more gstreamer pipeline examples. @@ -417,7 +417,7 @@ Below provides more gstreamer pipeline examples. :: - target # gst-launch-1.0 filesrc location=waterfall-352-288-nv12-inp.yuv ! videoparse width=352 height=288 format=nv12 ! video/x-raw, width=352, height=288 ! ducatih264enc ! filesink location=waterfall-352-288-nv12-inp_gst.h264 + target # gst-launch-1.0 filesrc location=waterfall-352-288-nv12-inp.yuv ! videoparse width=352 height=288 format=nv12 ! video/x-raw, width=352, height=288 ! ducatih264enc ! filesink location=waterfall-352-288-nv12-inp_gst.h264 The cap filter of "video/x-raw, width=352, height=288" is needed in this pipeline to specify the width and height. Otherwise, variable width and @@ -429,7 +429,7 @@ corrupted. :: - target # gst-launch-1.0 filesrc location= 4k.nv12 ! videoparse width=3840 height=2160 format=nv12 framerate=12/1 ! video/x-raw, width=3840, height=2160 ! ducatih264enc level=51 profile=100 bitrate=16000 ! filesink location=4k.h264 + target # gst-launch-1.0 filesrc location= 4k.nv12 ! videoparse width=3840 height=2160 format=nv12 framerate=12/1 ! video/x-raw, width=3840, height=2160 ! ducatih264enc level=51 profile=100 bitrate=16000 ! filesink location=4k.h264 .. rubric:: Full HD at 60fps Encoding :name: full-hd-at-60fps-encoding @@ -474,13 +474,13 @@ corrupted. :: - target # gst-launch-1.0 filesrc location=.265 ! 'video/x-raw, format=(string)NV12, framerate=(fraction)24/1, width=(int)1280, height=(int)720'  ! h265dec threads=2 ! vpe ! kmssink + target # gst-launch-1.0 filesrc location=.265 ! 'video/x-raw, format=(string)NV12, framerate=(fraction)24/1, width=(int)1280, height=(int)720' ! h265dec threads=2 ! vpe ! kmssink .. rubric:: DSP offloaded image processing pipeline :: - target # gst-launch-1.0 filesrc location=.265 ! 'video/x-raw, format=(string)NV12, framerate=(fraction)24/1, width=(int)1280, height=(int)720'  ! h265dec threads=1 ! videoconvert ! dsp66videokernel kerneltype=1 filtersize=9 lum-only=1 ! videoconvert ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)640, height=(int)480' ! kmssink + target # gst-launch-1.0 filesrc location=.265 ! 'video/x-raw, format=(string)NV12, framerate=(fraction)24/1, width=(int)1280, height=(int)720' ! h265dec threads=1 ! videoconvert ! dsp66videokernel kerneltype=1 filtersize=9 lum-only=1 ! videoconvert ! vpe ! 'video/x-raw, format=(string)NV12, width=(int)640, height=(int)480' ! kmssink This pipeline decodes an H265 clip on ARM A15, offloads the image processing task (Sobel 3x3 kernel) to DSP, and the processed clip is @@ -716,14 +716,14 @@ downloaded and installed. For example, the tool versions used in IPUMM :: - XDCVERSION  ?= xdctools_3_31_02_38_core - BIOSVERSION  ?= bios_6_42_02_29 - IPCVERSION  ?= ipc_3_40_01_08 - CEVERSION  ?= codec_engine_3_24_00_08 - FCVERSION  ?= framework_components_3_40_01_04 - XDAISVERSION  ?= xdais_7_24_00_04 + XDCVERSION ?= xdctools_3_31_02_38_core + BIOSVERSION ?= bios_6_42_02_29 + IPCVERSION ?= ipc_3_40_01_08 + CEVERSION ?= codec_engine_3_24_00_08 + FCVERSION ?= framework_components_3_40_01_04 + XDAISVERSION ?= xdais_7_24_00_04 # TI Compiler Settings - export TMS470CGTOOLPATH ?= $(BIOSTOOLSROOT)/ccsv6/tools/compiler/ti-cgt-arm_5.2.5 + export TMS470CGTOOLPATH ?= $(BIOSTOOLSROOT)/ccsv6/tools/compiler/ti-cgt-arm_5.2.5 Below are direct download links and install instructions for IPUMM 3.00.09.01 build tools. When installing the tools, it is preferable to @@ -925,7 +925,7 @@ shown below. :: FW_NAMES="dra7-dsp1-fw.xe66 dra7-dsp2-fw.xe66 dra7-ipu1-fw.xem4 dra7-ipu2-fw.xem4" - for FW in $FW_NAMES ; do + for FW in $FW_NAMES ; do echo 1 > /sys/class/firmware/$FW/loading cat /lib/firmware/$FW > /sys/class/firmware/$FW/data echo 0 > /sys/class/firmware/$FW/loading diff --git a/source/linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software.rst b/source/linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software.rst index 0d97b2eca..a394f9e0d 100644 --- a/source/linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software.rst +++ b/source/linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software.rst @@ -11,9 +11,9 @@ recipes that were updated while integrating the components to the ├── QT5: - │   ├──Baseline: - │   │ └──meta-qt5:recipes-qt/qt5/: recipes and patches from community - │   │ + │ ├──Baseline: + │ │ └──meta-qt5:recipes-qt/qt5/: recipes and patches from community + │ │ │ └──Arago (TI) updates: │ ├──meta-arago: │ │ ├──meta-arago-distro/recipes-qt/qt5: recipes update and additional patches @@ -31,9 +31,9 @@ recipes that were updated while integrating the components to the │ └──meta-processor-sdk: │ └──recipes-qt/qt5: additional recipe updates and patches ├──Wayland/Weston: - │   ├──Baseline: - │   │ └──oe-core/meta/recipes-graphics/wayland: recipes and patches from community - │   │ + │ ├──Baseline: + │ │ └──oe-core/meta/recipes-graphics/wayland: recipes and patches from community + │ │ │ └──Arago (TI) updates: │ ├──meta-arago: │ │ ├──meta-arago-distro/recipes-graphics/wayland: recipes update and additional patches @@ -44,8 +44,8 @@ recipes that were updated while integrating the components to the Note: There are many modules that depend on wayland. For example: chromium-wayland, qt5/qtwayland, gstreamer1.0-plugins-bad(waylandsink), glmark2 and gtk+3 ├──SGX (Not recommended to modify): - │   ├──Baseline: - │   │ + │ ├──Baseline: + │ │ │ ├──meta-ti: │ │ ├──recipes-graphics/libgles/ti-sgx-ddk-um_ │ │ └──recipes-bsp/powervr-drivers/ti-sgx-ddk-km_ @@ -61,8 +61,8 @@ recipes that were updated while integrating the components to the │ └──meta-processor-sdk: │ └──recipes-graphics/libgles/ti-sgx-ddk-um_version: for non-sgx build only ├──Gstreamer: - │   ├──Baseline: - │   │ + │ ├──Baseline: + │ │ │ ├──meta-openembedded: │ │ └──meta-multimedia/recipes-multimedia/gstreamer-0.10: recipes and patches from community │ │ diff --git a/source/linux/How_to_Guides/Host/AM335x_AM437x_Hardware_Migration_Guide.rst b/source/linux/How_to_Guides/Host/AM335x_AM437x_Hardware_Migration_Guide.rst index 97fc2661f..921d6588f 100644 --- a/source/linux/How_to_Guides/Host/AM335x_AM437x_Hardware_Migration_Guide.rst +++ b/source/linux/How_to_Guides/Host/AM335x_AM437x_Hardware_Migration_Guide.rst @@ -12,7 +12,7 @@ This document explains the differences between the TI AM335x processor and the T Basic Feature Comparison ######################### -The figure and table below show a comparison of the basic features of the AM335x and the AM437x. The remainder of the document presents a comparison of these features in greater detail, and also provides references to the appropriate documentation for further information. +The figure and table below show a comparison of the basic features of the AM335x and the AM437x. The remainder of the document presents a comparison of these features in greater detail, and also provides references to the appropriate documentation for further information. .. Image:: /images/AM335x_AM437x_1.png @@ -189,7 +189,7 @@ Memory Subsystem General Purpose Memory Controller ----------------------------------- -Both AM335x and AM437x support 7 chip selects. +Both AM335x and AM437x support 7 chip selects. External Memory Interface -------------------------- @@ -333,7 +333,7 @@ Table: **AM437x Voltage Rails** +------------------------+------------------------------------------------+-------------------+ | VDDS\_RTC | RTC domain | 1.8V | +------------------------+------------------------------------------------+-------------------+ -| VDDS\_DDR | DDR IO domain (DDR2 / DDR3) | 1.2V - 1.5V | +| VDDS\_DDR | DDR IO domain (DDR2 / DDR3) | 1.2V - 1.5V | +------------------------+------------------------------------------------+-------------------+ | VDDS | Dual voltage IO domains | 1.8V | +------------------------+------------------------------------------------+-------------------+ @@ -379,7 +379,7 @@ Table: **AM437x Voltage Rails** +------------------------+------------------------------------------------+-------------------+ | VDDSHV9 | Dual Voltage IO domain (1.8V/3.3V operation) | 1.8V/3.3V | +------------------------+------------------------------------------------+-------------------+ -| VDDSHV10 | Dual Voltage IO domain (1.8V/3.3V operation) | 1.8V/3.3V | +| VDDSHV10 | Dual Voltage IO domain (1.8V/3.3V operation) | 1.8V/3.3V | +------------------------+------------------------------------------------+-------------------+ | VDDSHV11 | Dual Voltage IO domain (1.8V/3.3V operation) | 1.8V/3.3V | +------------------------+------------------------------------------------+-------------------+ @@ -427,7 +427,7 @@ Table: **AM437x Input Clocks** +------------------+------------------------------------------------------------------------------+---------------------------------------------------+ | CLK\_32K\_RTC | External 32768 Hz crystal with internal 32K Osc or external 32768 Hz clock | 32768 Hz Precise | +------------------+------------------------------------------------------------------------------+---------------------------------------------------+ -| CLK\_32K\_MOSC | Divide down of Master Oscillator Crystal Frequency | Precise 32768 Hz only when using 26 MHz crystal | +| CLK\_32K\_MOSC | Divide down of Master Oscillator Crystal Frequency | Precise 32768 Hz only when using 26 MHz crystal | +------------------+------------------------------------------------------------------------------+---------------------------------------------------+ @@ -573,7 +573,7 @@ Bootmodes | | | |from an SPI EEPROM| | | | |or SPI Flash. | | | | | | -| | | |For both AM335x | +| | | |For both AM335x | | | | |and AM437x, the | | | | |SPI device should | | | | |be connected to | @@ -851,8 +851,8 @@ This table lists different bandwidth restrictions that are needed based on what Communication Interfaces ************************* -MMC/SD  -------- +MMC/SD +------ The MMC/SD modules are binary compatible between the two devices. Except, the CLK32 debounce clock is created by dividing the 96-MHz (48-MHz in AM437x) clock in the PRCM by two and then dividing the resulting 48-MHz (24-MHz in AM437x) clock by a fixed 732.4219 in the Control Module to get a 32-kHz clock. @@ -895,8 +895,8 @@ Real-Time Clock (RTC) The RTC module is identical between the two devices, except for the interface clock source -- AM335x uses CORE\_CLKOUTM4/2, providing a max frequency of 100 MHz. AM437x uses CLK\_M\_OSC, providing a max frequency of 26 MHz. -Ethernet  ---------- +Ethernet +-------- There are small differences between the AM335x and AM437x Ethernet module. @@ -904,22 +904,22 @@ The AM437x module adds support for multi core split processing, connecting the C In AM437x, the cpts\_rft\_clk (IEEE 1588v2 clock) adds DISP\_PLL\_CLK as a third source option. -McSPI  ------- +McSPI +----- AM335x includes 2 McSPI ports, each with two chip select signals. All McSPI have 4 DMA requests to EDMA. AM437x includes 5 McSPI ports. McSPI[0-2] support 4 chip select signals and 8 DMA requests to the eDMA. McSPI[3-4] only support 2 CS signals and 4 DMA requests to the eDMA. -PWM Subsystem (PWMSS)  ----------------------- +PWM Subsystem (PWMSS) +--------------------- The PWM Subsystem contains PWM, eCAP, and eQEP submodules. AM335x has 3 PWMSS instances. AM437x has 6 PWMSS instances, but eCAP3-5 and eQEP3-5 are not used. The PWMSS synchronization of the PWM and eCAP submodules is also different between AM335x and AM437x. -PRU-ICSS - Programmable Real-time Unit Subsystem and Industrial Communications Subsystem  ------------------------------------------------------------------------------------------- +PRU-ICSS - Programmable Real-time Unit Subsystem and Industrial Communications Subsystem +---------------------------------------------------------------------------------------- AM335x has one PRU-ICSS and AM437x has two PRU-ICSS. The PRU-ICSS on AM437x is backwards compatible with the subsystem on AM335x. The table below summarizes the differences between the PRU-ICSS instances on each device. diff --git a/source/linux/How_to_Guides/Host/AM335x_ICEv2_flash_erase.rst b/source/linux/How_to_Guides/Host/AM335x_ICEv2_flash_erase.rst index 806280cc4..56048811b 100644 --- a/source/linux/How_to_Guides/Host/AM335x_ICEv2_flash_erase.rst +++ b/source/linux/How_to_Guides/Host/AM335x_ICEv2_flash_erase.rst @@ -41,7 +41,7 @@ on a Ubuntu 14.04 host system - Click **File -> New-> Target Configuration File** - - Filename : AM3359-ice-v2.ccxml. Check "Use shared location" to be + - Filename : AM3359-ice-v2.ccxml. Check "Use shared location" to be available to anyone who uses the workspace. Click Finish. A window opens up which is to configure the connection details @@ -88,7 +88,7 @@ on a Ubuntu 14.04 host system - The program will give you the following prompts, type the responses and press Enter - - Enter Operation [1 - Flash ] [2 - Erase] : 2 + - Enter Operation [1 - Flash ] [2 - Erase] : 2 - Enter the offset [in Hex]: 0 - Enter size to be erased in Kilo bytes: 64 diff --git a/source/linux/How_to_Guides/Host/Boot_Sequence.rst b/source/linux/How_to_Guides/Host/Boot_Sequence.rst index 28ad4b5f4..a53ed713f 100644 --- a/source/linux/How_to_Guides/Host/Boot_Sequence.rst +++ b/source/linux/How_to_Guides/Host/Boot_Sequence.rst @@ -14,7 +14,7 @@ Boot Sequence .. rubric:: Introduction :name: introduction-boot-sequence - This page describes the boot sequence of an OMAP3 EVM.  + This page describes the boot sequence of an OMAP3 EVM. .. rubric:: General Boot Sequence (Linux system) :name: general-boot-sequence-linux-system @@ -28,41 +28,41 @@ Boot Sequence | - At power-up an OMAP3 device begins booting from internal Boot ROM.  This - code is fixed during the manufacturing process and cannot be altered.  + At power-up an OMAP3 device begins booting from internal Boot ROM. This + code is fixed during the manufacturing process and cannot be altered. The Boot ROM reads boot configuration pins (SW4 on the OMAP3 EVM) which - tell the Boot ROM where to look for the first external bootloader.  The - choices include NAND, UART, and SD/MMC Card.  Control is then passed to - this first external bootloader called x-loader.  The x-loader + tell the Boot ROM where to look for the first external bootloader. The + choices include NAND, UART, and SD/MMC Card. Control is then passed to + this first external bootloader called x-loader. The x-loader application is included in the Linux PSP provided by TI and can be - modified by the end user.  The x-loader application passes control to - u-boot.  U-boot is also a bootloader and is considered the second + modified by the end user. The x-loader application passes control to + u-boot. U-boot is also a bootloader and is considered the second external bootloader in this case. | - U-boot is the application which passes control to the Linux system.  The + U-boot is the application which passes control to the Linux system. The main goal of u-boot is to retrieve the Linux kernel and provide the - kernel with information about the location of the Linux filesystem.  + kernel with information about the location of the Linux filesystem. U-boot can be configured to retrieve the kernel from NAND, SD/MMC Card, - UART or Ethernet (via TFTP).  U-boot can also specify a root filesystem + UART or Ethernet (via TFTP). U-boot can also specify a root filesystem that is located in NAND (jffs2), SRAM (ramdisk), SD/MMC card (ext3 partition) or mounted over IP (NFS). | - U-boot then boots the Linux kernel.  The Linux kernel mounts the Linux + U-boot then boots the Linux kernel. The Linux kernel mounts the Linux root filesystem. .. rubric:: Booting TI SDK :name: booting-ti-sdk - The OMAP3 EVM which includes the TI SDK will come with an SD card.  This + The OMAP3 EVM which includes the TI SDK will come with an SD card. This card has been formatted and partition in such a way that the entire - system comes from this card.  There is a bootable FAT partition which + system comes from this card. There is a bootable FAT partition which contains x-loader (MLO), u-boot (u-boot.bin )and the Linux kernel - (uImage).  There is a separate ext3 partition which contains the Linux + (uImage). There is a separate ext3 partition which contains the Linux root filesystem. A tutorial for making this SD card can be found @@ -87,8 +87,8 @@ Boot Sequence | - When booting from an SD card, the OMAP3 Boot ROM code will search the SD - card for the filename "MLO" when looking for x-loader.  + When booting from an SD card, the OMAP3 Boot ROM code will search the SD + card for the filename "MLO" when looking for x-loader. To boot from this SD card, the switches on SW4 should be set to SD/MMC boot. @@ -96,10 +96,8 @@ Boot Sequence - **SW4 = 00100111 (high to low, i.e. SW4.1 = 1)** - **1 = "On" position on the switch** -   - | A UART terminal application connect to UART 1/2 of the EVM will - display output as the board boots up.  The first section shows output + display output as the board boots up. The first section shows output from x-loader as it boots from the SD/MMC card. :: @@ -112,10 +110,10 @@ Boot Sequence Starting OS Bootloader from MMC... Starting OS Bootloader... - X-loader then passes control to u-boot.  U-boot expects to find - "environment variables" in NAND flash.  When a board is booted for the + X-loader then passes control to u-boot. U-boot expects to find + "environment variables" in NAND flash. When a board is booted for the first time or if the NAND has been erased, u-boot will indicate a - Warning about bad NAND.  U-boot will write a default environment that it + Warning about bad NAND. U-boot will write a default environment that it will then use to continue the boot process. :: @@ -138,11 +136,11 @@ Boot Sequence Hit any key to stop autoboot: 0 The default environment is designed to boot the Linux system from the SD - card, so it is not necessary to stop the boot process.  And the next + card, so it is not necessary to stop the boot process. And the next time that the EVM is booted the default environment will exist in NAND so the "bad NAND" warning will not be displayed. - U-boot allows the user a 2-3 seconds window to stop the boot process.  + U-boot allows the user a 2-3 seconds window to stop the boot process. Hit any key in the UART terminal application and the u-boot prompt will be displayed as shown below: @@ -150,8 +148,8 @@ Boot Sequence OMAP3_EVM # - There are several useful commands to remember here.  To display the - environment variables, type "**printenv**" or just "**pri**".  + There are several useful commands to remember here. To display the + environment variables, type "**printenv**" or just "**pri**". :: @@ -182,13 +180,13 @@ Boot Sequence OMAP3_EVM # | The environment variables shown above are the default variables that - are included with u-boot from the TI SDK.  These will be re-written - any time that the NAND is erased, but otherwise these variables stay - in NAND and can be modified to change how Linux is booted. + are included with u-boot from the TI SDK. These will be re-written + any time that the NAND is erased, but otherwise these variables stay + in NAND and can be modified to change how Linux is booted. | To continue the boot from u-boot, simply type "**boot**" and the process will continue as if you did not stop the boot by hitting a - key.  This is also equivalent to typing "**run bootcmd**".  The + key. This is also equivalent to typing "**run bootcmd**". The **bootcmd** environment variable is actually a sequence of conditional statements (separated by semicolons) which perform checks on the hardware and software to complete the boot process. @@ -209,10 +207,10 @@ Boot Sequence Starting kernel ... Uncompressing Linux..................................................................................................... - .................................................. done, booting the kernel.  + .................................................. done, booting the kernel. | Then there will be a lot of messages from the kernel before getting to - the Linux login prompt.  Just type "root" at the login prompt + the Linux login prompt. Just type "root" at the login prompt :: @@ -223,7 +221,7 @@ Boot Sequence .. rubric:: Closer Look At bootcmd :name: closer-look-at-bootcmd - The bootcmd environment variable is a set of nested conditional + The bootcmd environment variable is a set of nested conditional statements. | @@ -234,10 +232,10 @@ Boot Sequence i; fi; else run nandboot; fi | The first conditional "**if mmc init**" checks to see if the SD/MMC - card exists.  If the card exists, the next conditional "**if run + card exists. If the card exists, the next conditional "**if run loadbootscript**" checks to see if the bootscript boot.scr exists on - the SD card.  If the boot script exists, then it is executed.  The + the SD card. If the boot script exists, then it is executed. The boot script contains the boot arguments and the command to actually - boot the Linux kernel.  So if the bootscript exists and is executed, + boot the Linux kernel. So if the bootscript exists and is executed, it should not return to rest of the bootcmd. diff --git a/source/linux/How_to_Guides/Host/Connect_to_an_EVM_via_Telnet.rst b/source/linux/How_to_Guides/Host/Connect_to_an_EVM_via_Telnet.rst index 6ad879f09..c9cb6d9cc 100644 --- a/source/linux/How_to_Guides/Host/Connect_to_an_EVM_via_Telnet.rst +++ b/source/linux/How_to_Guides/Host/Connect_to_an_EVM_via_Telnet.rst @@ -8,7 +8,7 @@ Connect to an EVM via Telnet The initialization file (/etc/init.d/rcS) starts a telnet server. If your development host is in the same sub-net as the EVM, you can telnet -to it using the IP address assigned in the U-boot environment.  The +to it using the IP address assigned in the U-boot environment. The following is an example from a Linux host. :: @@ -23,7 +23,7 @@ be root and the password should be left blank (just hit Enter). From a Windows XP host, click the Start button, then click Run... Type telnet and click OK. This will open a telnet window. -Type "o < ip-addr >" and hit enter.  Example: +Type "o < ip-addr >" and hit enter. Example: :: diff --git a/source/linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware.rst b/source/linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware.rst index 15bfdbc4f..e992fd565 100644 --- a/source/linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware.rst +++ b/source/linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware.rst @@ -19,8 +19,8 @@ provided here.** :name: introduction-build-ubuntu-linux-host-under-vmware This guide demonstrates how to get a virtual Ubuntu Linux machine -running with VMware under Windows 7.  Please use only the 32-bit Ubuntu -14.04 release as this is what is called an LTS (Long Term Support).  +running with VMware under Windows 7. Please use only the 32-bit Ubuntu +14.04 release as this is what is called an LTS (Long Term Support). There are SDK scripts that will be checking for this release identity. **Requirements**: @@ -28,14 +28,14 @@ There are SDK scripts that will be checking for this release identity. - Windows 7 host with internet connection, at least 1G of RAM and 40G of free hard drive space. -The instructions here are for setting up a 40G virtual machine.  The +The instructions here are for setting up a 40G virtual machine. The entire 40G is not taken at once, but as the machine is used and software -is installed, the machine can grow and take up as much as 40G.  +is installed, the machine can grow and take up as much as 40G. -.. rubric:: Download the Ubuntu 14.04 LTS ISO image +.. rubric:: Download the Ubuntu 14.04 LTS ISO image :name: download-the-ubuntu-14.04-ltsiso-image -Get the Ubuntu 14.04 LTS CD ISO image from: +Get the Ubuntu 14.04 LTS CD ISO image from: http://releases.ubuntu.com/14.04/. Select PC (Intel x86) desktop CD under the Desktop CD section. @@ -50,15 +50,15 @@ Get VMware from: http://www.vmware.com Vmware Player is a free download from the website and enables the user to create an entire virtual machine from scratch using just the ISO -image downloaded from Ubuntu.  It is necessary to sign up for an account -at VMware in order to get to the download areas.  The general steps to +image downloaded from Ubuntu. It is necessary to sign up for an account +at VMware in order to get to the download areas. The general steps to getting VMware are as follows: - Login to the vmware website - Select VMware Player from the products menu - Follow the steps to download VMware Player -**NOTE - We have tested with v7.0.0 with no known issues.  As of +**NOTE - We have tested with v7.0.0 with no known issues. As of Feburary, 2015, v7.0.0 is the latest version.** - Run the executable to install VMware @@ -71,19 +71,19 @@ Before starting a new installation it is assumed that the Windows host has a proper internet connection to a DHCP server and that the Windows host has enough hard drive space for the new virtual machine. -The following steps are performed with VMware 7.0.0.  The exact steps +The following steps are performed with VMware 7.0.0. The exact steps with other versions may vary slightly - Start VMware. - From the File menu select "Create a New Virtual Machine..." -- Choose to install the operating system later.  Click "Next". +- Choose to install the operating system later. Click "Next". - Select Linux as the "Guest Operating System" and then choose Ubuntu - as the "Version".  Click "next". + as the "Version". Click "next". - Provide a "Virtual machine name" and "Location" where the machine - will be stored on the Windows host.  The defaults are fine here.  + will be stored on the Windows host. The defaults are fine here. Click "Next". - For "Maximum disk size (GB)" it is good to start with 40G if - possible.  This means that it will take up 40G on the Windows host. + possible. This means that it will take up 40G on the Windows host. Make sure that the Windows host has at least this much before proceeding. It is also a good practice to tell VMware to split the virtual disk into 2G files. This will makes the image easier to copy @@ -107,20 +107,20 @@ connection state". .. rubric:: Adding a serial port to the virtual machine :name: adding-a-serial-port-to-the-virtual-machine -If you plan to use a serial terminal application, a serial port must be -added to the virtual machine.  This port must be a physical serial port -which exists on the host PC.  Click on "Add..." and select "Serial -Port".  Click "Next".  Choose "Use physical serial port on host".  Click -"Next".  Click Finish.  Click "Ok". +If you plan to use a serial terminal application, a serial port must be +added to the virtual machine. This port must be a physical serial port +which exists on the host PC. Click on "Add..." and select "Serial +Port". Click "Next". Choose "Use physical serial port on host". Click +"Next". Click Finish. Click "Ok". | Since this is a physical port on the host PC, it cannot be used by the -host PC and the virtual machine at the same time.  When the virtual +host PC and the virtual machine at the same time. When the virtual machine is started, the serial port will be unavailable for use by the -host PC.  If the serial port is being used at the time that the virtual +host PC. If the serial port is being used at the time that the virtual machine is started, the virtual machine will not be able to access the -serial port after it is booted up.  So if you want the virtual machine +serial port after it is booted up. So if you want the virtual machine to gain control of the physical serial port of the host PC, there can not be any application like hyperterminal or teraterm running on the host PC at the time that the virtual machine is started. @@ -129,37 +129,37 @@ Further instructions for using the serial port with minicom inside of Ubuntu are `here `__. -| Minicom is the preferred application for use with the Sitara SDK.  And +| Minicom is the preferred application for use with the Sitara SDK. And the installation and setup of minicom is done automattically by the - Sitara SDK installer.  + Sitara SDK installer. | -Now click on "Play virtual machine".  Since this is the first time -starting the machine and the Ubuntu ISO image is in the virtual CD +Now click on "Play virtual machine". Since this is the first time +starting the machine and the Ubuntu ISO image is in the virtual CD drive, the Ubuntu OS will install itself in the virtual machine. Click through the Ubuntu installation, making the appropriate choices as -you go.  This will help with SDK installation scripts. +you go. This will help with SDK installation scripts. .. Image:: /images/Vmware-player.PNG | -| The full installation will take 20-30 minutes.  When it completes the - machine will reboot.  The machine will now prompt for the username and +| The full installation will take 20-30 minutes. When it completes the + machine will reboot. The machine will now prompt for the username and password that you created during the installation. After the machine reboots into Ubuntu it is helpful to take the Ubuntu -ISO out of the virtual CD drive.  Click on the VM menu and select -"Settings...".  Click on CD/DVD and change the connection from "Use -ISO image file" to "Use physical drive".  The actual drive letter can be -selected from the drop down list.  If there is no physical drive on the +ISO out of the virtual CD drive. Click on the VM menu and select +"Settings...". Click on CD/DVD and change the connection from "Use +ISO image file" to "Use physical drive". The actual drive letter can be +selected from the drop down list. If there is no physical drive on the host machine, the CD/DVD device can be simply removed from the machine. .. rubric:: Install VMware Tools :name: install-vmware-tools -VMware tools is a very useful addition to VMware.  It allows you to +VMware tools is a very useful addition to VMware. It allows you to resize the VMware screen ,cut-and-paste of text and drag and drop files from the Ubuntu machine to and from the Windows host. @@ -168,26 +168,26 @@ Install VMware Tools .. Image:: /images/Install_vmware_tools.png -The VMware tools are contained in an ISO image that VMware -will automatically mount.  This drive will show up on the Ubuntu +The VMware tools are contained in an ISO image that VMware +will automatically mount. This drive will show up on the Ubuntu desktop as if it were a disk in a DVD drive. .. Image:: /images/Vmware-tools-cd.png -There will be a single tarball on the drive named +There will be a single tarball on the drive named VMwareTools-9.9.0-2304977.tar.gz (or with a slightly different version -number). Extract the tarball somewhere in your /home/ -directory.  You will see that a vmware-tools-distrib folder was +number). Extract the tarball somewhere in your /home/ +directory. You will see that a vmware-tools-distrib folder was created and a file name vmware-install.pl inside. Execute -vmware-install.pl to install VMware Tools.  The Perl script must be -executed as a super-user.  This is done in Ubuntu by pre-pending the -command with "sudo".  When prompted for a password, enter the -password for the user account.  In Ubuntu, there is no "root" -account.  However, the first user account created when Ubuntu is +vmware-install.pl to install VMware Tools. The Perl script must be +executed as a super-user. This is done in Ubuntu by pre-pending the +command with "sudo". When prompted for a password, enter the +password for the user account. In Ubuntu, there is no "root" +account. However, the first user account created when Ubuntu is installed can become a super-user with the "sudo" command. Select all of defaults during installation of VMware Tools. -An example is shown below.  +An example is shown below. :: @@ -199,10 +199,10 @@ An example is shown below.  :name: confirming-a-valid-network-connection After logging into the machine for the first time, bring up a terminal -window.  This can be found under the Applications menu in Ubuntu.  -Applications --> Accessories --> Terminal.  Type **pwd** in this -terminal.  This should return **/home/**.  Now type **ifconfig**.  -This should return information about the network connection.  Under +window. This can be found under the Applications menu in Ubuntu. +Applications --> Accessories --> Terminal. Type **pwd** in this +terminal. This should return **/home/**. Now type **ifconfig**. +This should return information about the network connection. Under **eth0** the IP address should be similar (but not the same) as the IP address owned by the Windows host. @@ -221,7 +221,7 @@ address owned by the Windows host. lo Link encap:Local Loopback inet addr:127.0.0.1 Mask:255.0.0.0 - inet6 addr: ::1/128 Scope:Host + inet6 addr: ::1/128 Scope:Host UP LOOPBACK RUNNING MTU:16436 Metric:1 RX packets:12 errors:0 dropped:0 overruns:0 frame:0 TX packets:12 errors:0 dropped:0 overruns:0 carrier:0 @@ -230,13 +230,13 @@ address owned by the Windows host. | -.. rubric:: How to Read a USB SD Card Reader in VMware +.. rubric:: How to Read a USB SD Card Reader in VMware :name: how-to-read-a-usbsdcard-reader-in-vmware | Sometimes there will be a need to connect a SD Card to the Virtual Machine (for example, to run the create SD card script provided with the SDK that partitions, formats, and populates a SD card that can be - used with a target board). When a USB card reader with an SD card is + used with a target board). When a USB card reader with an SD card is inserted into the USB slot of the host machine, the virtual machine will automatically detect the drive and mount partitions from the SD card, making the card available to Linux running in the virtual diff --git a/source/linux/How_to_Guides/Host/How_to_Flash_Linux_System_from_U-boot.rst b/source/linux/How_to_Guides/Host/How_to_Flash_Linux_System_from_U-boot.rst index 598d3919a..4ba5cb410 100644 --- a/source/linux/How_to_Guides/Host/How_to_Flash_Linux_System_from_U-boot.rst +++ b/source/linux/How_to_Guides/Host/How_to_Flash_Linux_System_from_U-boot.rst @@ -21,7 +21,7 @@ How to Flash from U-boot Shell This article applies to Sitara SDK 4.0.1 which uses the Platform Support Package (PSP) software version 03.01.00.06 - for AM35x and AM37x devices.   This information is obsolete as newer + for AM35x and AM37x devices. This information is obsolete as newer software has different NAND ECC requirements. .. rubric:: Introduction @@ -29,11 +29,11 @@ How to Flash from U-boot Shell This guide will show how use u-boot to flash the NAND of an OMAP3 EVM (for AM37x, DM37x or OMAP35xx devices) or an AM3517EVM (for AM35x - devices) with Linux system binaries.  + devices) with Linux system binaries. - Assumptions: - #. SD card with system binaries (x-loader, u-boot, Linux kernel) on + #. SD card with system binaries (x-loader, u-boot, Linux kernel) on **boot** partition #. Linux root filesystem in **rootfs** partition of SD card or root filesystem available via NFS @@ -41,35 +41,34 @@ How to Flash from U-boot Shell .. rubric:: Caution :name: caution - The procedures here will erase the NAND flash of the EVM.  This includes - all u-boot environment variables.  Use the "**printenv**" command (or + The procedures here will erase the NAND flash of the EVM. This includes + all u-boot environment variables. Use the "**printenv**" command (or just "**pri**") in u-boot to print a complete list of environment - variables.  Copy and paste these to a text file for safe keeping. + variables. Copy and paste these to a text file for safe keeping. - .. rubric:: Boot EVM into SD/MMC card boot mode + .. rubric:: Boot EVM into SD/MMC card boot mode :name: bootevm-into-sdmmc-card-boot-mode - The SD card must at least have the files MLO, u-boot.bin, and uImage.  - All of these files can also be found in the "./psp/prebuilt-images" + The SD card must at least have the files MLO, u-boot.bin, and uImage. + All of these files can also be found in the "./psp/prebuilt-images" directory in the Sitara SDK installation (with names that include the - platform name and software revision info).  The MLO file is simply a + platform name and software revision info). The MLO file is simply a re-named copy of the file x-load.bin.ift that is produced by rebuilding - x-loader and signing the file.  When the board is booted in SD/MMC card - boot mode, the ROM code looks specifically for the file with the name + x-loader and signing the file. When the board is booted in SD/MMC card + boot mode, the ROM code looks specifically for the file with the name MLO as the primary bootloader. - To boot from this SD card, the boot switches should be set to SD/MMC + To boot from this SD card, the boot switches should be set to SD/MMC boot: **For Mistral OMAP EVM (AM37x, DM37x or OMAP35xx devices)** - | Set SW4 switches #1, #2, #3 and #6 to the ON position and all others + | Set SW4 switches #1, #2, #3 and #6 to the ON position and all others OFF (MMC1, UART3 boot order) | **For LogicPD AM3517EVM (AM35x device)** - | Set SW7 switches #1 and #4 to the ON position and all others OFF.  + | Set SW7 switches #1 and #4 to the ON position and all others OFF. (USB, UART, MMC1, XIP boot order) - |   Start the board and interrupt the boot process when prompted by hitting any key in the UART terminal application: @@ -100,23 +99,17 @@ How to Flash from U-boot Shell Net: smc911x-0 Hit any key to stop autoboot: 0 OMAP3_EVM # - OMAP3_EVM #  - - All of the commands in this guide are performed at the u-boot prompt.  - -   - -   + OMAP3_EVM # -   + All of the commands in this guide are performed at the u-boot prompt. .. rubric:: Run the u-boot commands to flash the NAND :name: run-the-u-boot-commands-to-flash-the-nand All of the following commands are performed at the u-boot prompt. -   These commands are actually a series of u-boot commands that are - connected together with semicolons.  The individual commands can be + These commands are actually a series of u-boot commands that are + connected together with semicolons. The individual commands can be entered separately or simple pasted from here. | @@ -127,33 +120,25 @@ How to Flash from U-boot Shell mw.b 0x81600000 0xff 0x20000;nand erase 0 20000;mmc init;fatload mmc 0 0x81600000 x-load.bin.ift;nandecc hw; nand write.i 0x81600000 0 20000 -   - - Complete uboot write from MMC to NAND (only erases two blocks=256k) :: mw.b 0x81600000 0xff 0x40000;nand erase 80000 40000;mmc init;fatload mmc 0 0x81600000 u-boot.bin;nandecc sw; nand write.i 0x81600000 80000 40000 -   - - Complete kernel write from MMC to NAND (erases 3M) :: mw.b 0x81600000 0xff 0x1400000;nand erase 280000 300000;mmc init;fatload mmc 0 0x81600000 uImage;nandecc sw; nand write.i 0x81600000 280000 300000 -   - -   - - .. rubric:: Put the EVM in NAND boot mode + .. rubric:: Put the EVM in NAND boot mode :name: put-the-evm-in-nandboot-mode -  With the EVM in NAND boot mode and the images flashed in NAND as - detailed above, the SD card does not need to be in the EVM at boot up.  - X-loader and u-boot will run from NAND.  In order to also pull the Linux - kernel (uImage) from NAND it will be necessary to halt the boot process + With the EVM in NAND boot mode and the images flashed in NAND as + detailed above, the SD card does not need to be in the EVM at boot up. + X-loader and u-boot will run from NAND. In order to also pull the Linux + kernel (uImage) from NAND it will be necessary to halt the boot process and edit some u-boot environment variables. | @@ -165,30 +150,28 @@ How to Flash from U-boot Shell **For LogicPD AM3517EVM (AM35x device)** - Set SW7 with switches #1 thru #8 all to the OFF position. (NAND, EMAC, + Set SW7 with switches #1 thru #8 all to the OFF position. (NAND, EMAC, USB, MMC1 boot order) -   - - Save off the original boot command :: setenv bootcmd_original ${bootcmd} - saveenv  + saveenv | - Create command for reading the kernel from NAND and then another - command for doing the boot where the kernel is pulled from NAND and - the root filesystem is from the SD/MMC card.  + command for doing the boot where the kernel is pulled from NAND and + the root filesystem is from the SD/MMC card. :: setenv nand_kernel 'nand read.i ${loadaddr} 280000 300000' setenv nand_mmc_boot 'run nand_kernel;setenv bootargs ${mmcargs}; bootm' - Run this last command to actually perform the boot.  And always save the + Run this last command to actually perform the boot. And always save the environment after making changes. :: @@ -199,7 +182,7 @@ How to Flash from U-boot Shell .. rubric:: Flashing the Root File System to NAND :name: flashing-the-root-file-system-to-nand - A jffs2 file system can be copied into NAND flash.  Copy the file + A jffs2 file system can be copied into NAND flash. Copy the file rootfs.tar.gz to the /home/root directory on the SD Card. Boot the EVM to Linux and enter the following commands: @@ -226,12 +209,12 @@ How to Flash from U-boot Shell .. rubric:: Mounting File System from NFS :name: mounting-file-system-from-nfs - The file system can also be mounted as a Network File System (NFS).  The - NFS is simply a sub-directory of the Linux host development system.  + The file system can also be mounted as a Network File System (NFS). The + NFS is simply a sub-directory of the Linux host development system. - Another command can be made to pull the root filesystem via NFS.  This + Another command can be made to pull the root filesystem via NFS. This command can be combine with the one to pull the bootloaders and kernel - from NAND.  (The IP address and path to the NFS is an example and should + from NAND. (The IP address and path to the NFS is an example and should be changed by the user). :: diff --git a/source/linux/How_to_Guides/Host/How_to_Setup_Ubuntu_1404_Network_Boot.rst b/source/linux/How_to_Guides/Host/How_to_Setup_Ubuntu_1404_Network_Boot.rst index cf69a2e11..c4d66f798 100644 --- a/source/linux/How_to_Guides/Host/How_to_Setup_Ubuntu_1404_Network_Boot.rst +++ b/source/linux/How_to_Guides/Host/How_to_Setup_Ubuntu_1404_Network_Boot.rst @@ -194,10 +194,10 @@ USB there are some additional steps required. .. code:: #!/bin/sh -   + IF=$1 STATUS=$2 -   + if [ "$IF" = "usb0" ] && [ "$STATUS" = "up" ]; then service isc-dhcp-server restart fi @@ -248,7 +248,7 @@ USB there are some additional steps required. .. code:: #!/bin/sh -   + if [ "$IFACE" = usb0 ]; then sudo service isc-dhcp-server restart fi @@ -267,7 +267,7 @@ USB there are some additional steps required. [main] plugins=ifupdown -   + [ifupdown] managed=false diff --git a/source/linux/How_to_Guides/Host/How_to_Setup_a_Samba_Server.rst b/source/linux/How_to_Guides/Host/How_to_Setup_a_Samba_Server.rst index a5942e443..7b4941f25 100644 --- a/source/linux/How_to_Guides/Host/How_to_Setup_a_Samba_Server.rst +++ b/source/linux/How_to_Guides/Host/How_to_Setup_a_Samba_Server.rst @@ -5,10 +5,10 @@ How to Setup a Samba Server .. rubric:: Introduction :name: introduction-samba-server -When using a Virtual machine you may share files & folders via the -Share Foldr feature of that partoicular Virtual Machine.  Another +When using a Virtual machine you may share files & folders via the +Share Foldr feature of that partoicular Virtual Machine. Another alternative, especially if you are using a dedicated Linux host, is to -configure a Samba server on your Linux host.  +configure a Samba server on your Linux host. Samba allows a host to interact with a Microsoft Windows client or server as if it is a Windows file and print server. In other words, if @@ -19,15 +19,15 @@ machine) through windows. .. rubric:: Installing a Samba Server :name: installing-a-samba-server -1.  Samba can be installed by opening a terminal. (Applications -> +1. Samba can be installed by opening a terminal. (Applications -> System Tools -> Terminal) -2.  Switch to root user by typing su and entering the password you set +2. Switch to root user by typing su and entering the password you set during the install. 3. On Fedora install Samba with the yum command: system-config-samba -|     On Ubuntu install Samba using:  sudo apt-get install +| On Ubuntu install Samba using: sudo apt-get install system-config-samba 4. Open the Samba GUI (System -> Administration -> Samba). @@ -81,8 +81,8 @@ configure the network proxy.** 9. Enable the Samba and NFS services -- System -> Administration -> Services  (**NOTE - Not available in - Ubuntu 10.04 LTS.  However the Samba service should start +- System -> Administration -> Services (**NOTE - Not available in + Ubuntu 10.04 LTS. However the Samba service should start automatically**) - Enable the services by browsing through the list on the left and locating nfs and smb. If they are not already enabled, enable them by diff --git a/source/linux/How_to_Guides/Host/Moving_Files_to_the_Target_System.rst b/source/linux/How_to_Guides/Host/Moving_Files_to_the_Target_System.rst index 3030b7d7d..836eb7960 100644 --- a/source/linux/How_to_Guides/Host/Moving_Files_to_the_Target_System.rst +++ b/source/linux/How_to_Guides/Host/Moving_Files_to_the_Target_System.rst @@ -7,18 +7,18 @@ Moving Files to the Target System This guide discusses how applications or other files can be moved to the target file system of the EVM. -.. rubric:: File System on SD card +.. rubric:: File System on SD card :name: file-systemon-sd-card The SD card wic image which comes with the TI SDK has a Linux ext4 partition that is used as the target file system. This partition is readable from a Linux host. In Ubuntu |__LINUX_UBUNTU_VERSION_LONG__| this partition will be mounted on -:file`/media/$USER/rootfs` when the card is used with an SD card reader inserted into a USB port on the Ubuntu host.  +:file`/media/$USER/rootfs` when the card is used with an SD card reader inserted into a USB port on the Ubuntu host. -When the SD card is mounted with a card reader in the Linux host it is possible to perform :command:`cp` commands from the host into sub-directories +When the SD card is mounted with a card reader in the Linux host it is possible to perform :command:`cp` commands from the host into sub-directories under :file:`/media/$USER/rootfs` or just use a browser window to drag and drop the files from the host to the SD card. Switching the SD card back and forth from the EVM to the SD card reader -is time consuming during development.  Using a NFS during development is +is time consuming during development. Using a NFS during development is the preferred method and makes moving files between the host and target trivial. @@ -26,8 +26,8 @@ trivial. :name: file-system-on-network-file-system-nfs When the target file system is served from the Linux development host -machine it is trivial to move files between the host and target.  The -NFS directory is set up on the host machine by the SDK installer.  The +machine it is trivial to move files between the host and target. The +NFS directory is set up on the host machine by the SDK installer. The default location in the SDK environment is :file:`${PSDK_PATH}/targetNFS` This could vary depending on the version of the SDK and how it was installed. An :command:`ls -l` of this directory in the host system will show what will be the root @@ -59,13 +59,13 @@ directory of the target when it boots up. drwxr-xr-x 9 root root 4096 Mar 9 2018 var So from the perspective of the host, the target filesystem is just a -sub-directory of the host.  If the file is in :file:`./targetNFS` on the host, +sub-directory of the host. If the file is in :file:`./targetNFS` on the host, then the same file will show up in the root directory of the target -after the target boots into the NFS.  And if the file is in a +after the target boots into the NFS. And if the file is in a subdirectory of :file:`./targetNFS` (example :file:`./targetNFS/{sub-dir}/`) then it will show up in the /sub-dir directory of the target after the target boots into the NFS. -The top level makefile of the TI SDK supports an install target that +The top level makefile of the TI SDK supports an install target that will copy applications into the NFS of the SDK. See the README file at -the top level of the SDK for information about the install target. +the top level of the SDK for information about the install target. diff --git a/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst b/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst index d7f3ae0ad..78654aa39 100644 --- a/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst +++ b/source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst @@ -57,18 +57,18 @@ Features supported - Duplicate discard table on Port to Port path (HSR) - Data integrity (CRC) check during port to port forwarding, except cut through (HSR) -- **QoS scheme** : 3-bit VLAN PCP +- **QoS scheme** : 3-bit VLAN PCP - - No of levels supported : 2 - - Number of host queues : 2 \| 2 QoS levels per host queue - - Number of port queues : 2 \| 2 QoS levels per port queue + - No of levels supported : 2 + - Number of host queues : 2 \| 2 QoS levels per host queue + - Number of port queues : 2 \| 2 QoS levels per port queue - **Statistics** - Supports all MIB statistics as per standard - Node Table statistics for debugging -- **Storm Prevention** : Yes. Configurable per port +- **Storm Prevention** : Yes. Configurable per port - **Dual instance of HSR/PRP using two PRU-ICSS on AM571x** @@ -345,7 +345,7 @@ type without having to reboot the board:- * PRP Two feature flags are added to help offload HSR or PRP in the PRU -Ethernet driver :- hsr-rx-offload and prp-rx-offload. PRU Firmware +Ethernet driver :- hsr-rx-offload and prp-rx-offload. PRU Firmware essentially offload the rx side processing of LRE, such as duplicate detection and drop, node table update, stats update etc. To reflect the same, the features are named with a rx-offload suffx to the protocol name. diff --git a/source/linux/Industrial_Protocols/PTP/_PTP.rst b/source/linux/Industrial_Protocols/PTP/_PTP.rst index e2d40dc94..60eb26e0d 100644 --- a/source/linux/Industrial_Protocols/PTP/_PTP.rst +++ b/source/linux/Industrial_Protocols/PTP/_PTP.rst @@ -1619,7 +1619,7 @@ background $ phc2sys -a -m & Lines similar to the following should be displayed after a few seconds -(mixed with the "ptp4l[304.713]: rms ..." lines from ptp4l) : +(mixed with the "ptp4l[304.713]: rms ..." lines from ptp4l) : :: @@ -1830,9 +1830,9 @@ each clock plays in this test is as follows: :: - DUT-2 : AM572x : Master clock - DUT-1 : AM571x : Transparent clock - DUT-3 : AM572x : Slave clock + DUT-2 : AM572x : Master clock + DUT-1 : AM571x : Transparent clock + DUT-3 : AM572x : Slave clock .. note:: In this release BMCA enhanced for HSR is not supported, hence the connection is not a HSR close-loop network. @@ -1852,9 +1852,9 @@ section for HSR) will be used in the setup of the tests. :: - DUT-2 : setup_hsr.sh : dut_2_hsr_oc.cfg - DUT-1 : setup_hsr.sh : dut_1_hsr_oc.cfg - DUT-3 : setup_hsr.sh : dut_3_hsr_oc.cfg + DUT-2 : setup_hsr.sh : dut_2_hsr_oc.cfg + DUT-1 : setup_hsr.sh : dut_1_hsr_oc.cfg + DUT-3 : setup_hsr.sh : dut_3_hsr_oc.cfg - Connect the 3 AM57xx IDKs as shown above. @@ -1938,11 +1938,11 @@ associated with ICSS2 (PRUSS2 timer) is ptp1. lrwxrwxrwx 1 root root 0 Apr 20 19:11 ptp0 -> ../../devices/platform/44000000.ocp/48484000.ethernet/ptp/ptp0 lrwxrwxrwx 1 root root 0 Apr 21 21:18 ptp1 -> ../../devices/platform/pruss2_eth/ptp/ptp1 ptp clock names: - /sys/class/ptp/ptp0 : CTPS timer - /sys/class/ptp/ptp1 : PRUSS2 timer + /sys/class/ptp/ptp0 : CTPS timer + /sys/class/ptp/ptp1 : PRUSS2 timer pps's ptp device: - /sys/class/pps/pps0 : ptp0 - /sys/class/pps/pps1 : ptp1 + /sys/class/pps/pps0 : ptp0 + /sys/class/pps/pps1 : ptp1 root@am57xx-evm:~# Test 2. Without a hybrid clock between Master and Slave Clock diff --git a/source/linux/Overview/Download_and_Install_the_SDK.rst b/source/linux/Overview/Download_and_Install_the_SDK.rst index f0066f392..0efa3e488 100644 --- a/source/linux/Overview/Download_and_Install_the_SDK.rst +++ b/source/linux/Overview/Download_and_Install_the_SDK.rst @@ -55,7 +55,7 @@ Download & Install the SDK Installer on Host version of the SDK. We recommend checking the above site and using the latest version if at all possible. Before running the SDK Installer from the SD card, the SD Card from the EVM box needs to be mounted to your - Linux Host PC (using a USB SD Card reader).  The SDK Installer is found + Linux Host PC (using a USB SD Card reader). The SDK Installer is found in the START\_HERE partition of the SD card. .. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational') @@ -111,7 +111,7 @@ for the installer (e.g. text installer, etc.): ./|__SDK_INSTALL_FILE__| --help -.. rubric:: SDK Installer Execution Steps +.. rubric:: SDK Installer Execution Steps :name: sdkinstaller-execution-steps 1. **Confirm** diff --git a/source/linux/Overview/Processor_SDK_Linux_create_SD_card.rst b/source/linux/Overview/Processor_SDK_Linux_create_SD_card.rst index bc713af4b..aec507906 100644 --- a/source/linux/Overview/Processor_SDK_Linux_create_SD_card.rst +++ b/source/linux/Overview/Processor_SDK_Linux_create_SD_card.rst @@ -237,7 +237,7 @@ can move on to the next step. .. code-block:: text - Would you like to re-partition the drive anyways [y/n] : + Would you like to re-partition the drive anyways [y/n] : - Options: @@ -263,7 +263,7 @@ many partitions you want to create for the SD card. .. code-block:: text - Number of partitions needed [2/3] : + Number of partitions needed [2/3] : - Options: diff --git a/source/linux/Overview/Processor_SDK_Linux_create_SD_card_script.rst b/source/linux/Overview/Processor_SDK_Linux_create_SD_card_script.rst index a95d55cd8..15f1d96a7 100644 --- a/source/linux/Overview/Processor_SDK_Linux_create_SD_card_script.rst +++ b/source/linux/Overview/Processor_SDK_Linux_create_SD_card_script.rst @@ -93,7 +93,7 @@ can move on to the next step. :: - Would you like to re-partition the drive anyways [y/n] : + Would you like to re-partition the drive anyways [y/n] : - Options: @@ -115,7 +115,7 @@ many partitions you want to create for the SD card. :: - Number of partitions needed [2/3] : + Number of partitions needed [2/3] : - Options: @@ -358,7 +358,7 @@ After the SD card has been partitioned you will be prompted to: :: - Enter path where SD card tarballs were downloaded : + Enter path where SD card tarballs were downloaded : Point to the directory containing the following tarball files: diff --git a/source/linux/Overview/Run_Setup_Scripts.rst b/source/linux/Overview/Run_Setup_Scripts.rst index 3d300924b..f639e1ebe 100644 --- a/source/linux/Overview/Run_Setup_Scripts.rst +++ b/source/linux/Overview/Run_Setup_Scripts.rst @@ -33,7 +33,7 @@ does the following things: .. rubric:: BeagleBone Black Users :name: beaglebone-black-users - To run the SDK's setup scripts the following cables are required to be + To run the SDK's setup scripts the following cables are required to be connected to the BeagleBone Black and your Linux PC. Please ensure both are connected before following any of the steps in this guide. @@ -79,12 +79,12 @@ does the following things: :name: how-to-run-the-setup-script The Setup Script (**setup.sh**) is located in the |__SDK_FULL_NAME__| installation -directory.  By default, this directory has a name that has the form +directory. By default, this directory has a name that has the form |__SDK_INSTALL_DIR__|. .. ifconfig:: CONFIG_sdk in ('SITARA') - Change to that ti-processor-sdk-linux install directory. + Change to that ti-processor-sdk-linux install directory. Then run the script: @@ -140,7 +140,7 @@ packages may vary for different releases: This part requires you to have administrator priviliges (sudo access). -A unique step is required for users using Ubuntu 12.04+. By default the +A unique step is required for users using Ubuntu 12.04+. By default the user does not have the proper permissions to access a serial device ( ex ttyS0, ttyUSB0, etc...). A user must be apart of a "dialout" group to access these serial device without root privileges. diff --git a/source/linux/Overview/_Processor_SDK_Linux_GPLv3_Disclaimer.rst b/source/linux/Overview/_Processor_SDK_Linux_GPLv3_Disclaimer.rst index f5d959f21..86eba4f97 100644 --- a/source/linux/Overview/_Processor_SDK_Linux_GPLv3_Disclaimer.rst +++ b/source/linux/Overview/_Processor_SDK_Linux_GPLv3_Disclaimer.rst @@ -4,9 +4,9 @@ GPLv3 Disclaimer .. http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_GPLv3_Disclaimer There are GPLv3 licensed software components contained within the -Processor SDK for Linux on both the target and the host.  The software +Processor SDK for Linux on both the target and the host. The software manifest (software\_manifest.htm) for the Linux SDK is located in the -manifest/ directory of the installed SDK.  All GPLv3 components for both +manifest/ directory of the installed SDK. All GPLv3 components for both target and host are contained in the SDK directory. .. warning:: @@ -21,15 +21,15 @@ run the gplv3-notice script located on the target file system located here: **/etc/init.d/gplv3-notice** The gplv3-notice script will list all Processor SDK Linux installed -packages as shipped.  If you installed additional GPLv3 components this -script may not identify them until the next target reboot.   +packages as shipped. If you installed additional GPLv3 components this +script may not identify them until the next target reboot. | .. rubric:: How to Remove Target side GPLv3 Components :name: how-to-remove-target-side-gplv3-components -The gplv3-notice script also outputs how to remove the packages.  To +The gplv3-notice script also outputs how to remove the packages. To remove individual packages from the target development file system, use the opkg remove command which is: **opkg remove ** diff --git a/source/linux/Release_Specific_PLSDK_Release_Notes.rst b/source/linux/Release_Specific_PLSDK_Release_Notes.rst index e24089f79..dfeaf9e97 100644 --- a/source/linux/Release_Specific_PLSDK_Release_Notes.rst +++ b/source/linux/Release_Specific_PLSDK_Release_Notes.rst @@ -437,7 +437,7 @@ RT Linux Kernel Known Issues :name: installation-and-usage The `Software Developer's Guide `__ provides instructions on how to setup up your Linux development -environment, install the SDK and start your development.  It also includes User's Guides for various Example Applications and Code +environment, install the SDK and start your development. It also includes User's Guides for various Example Applications and Code Composer Studio. | diff --git a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_CToolsLib.rst b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_CToolsLib.rst index 28f09238d..29d13e2c9 100644 --- a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_CToolsLib.rst +++ b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_CToolsLib.rst @@ -73,7 +73,7 @@ STMLib - This library provides "C" printf and binary APIs for hardware assisted (System Trace software messages) instrumentation in your - code. STM messages are captured via an ETB or with an external + code. STM messages are captured via an ETB or with an external XDS560v2 System Trace receiver. - For instructions on setting up CCS to capture STM data see `Using System Trace(STM) `__. @@ -225,13 +225,13 @@ compatible with CCSv6. | | CortexA8 Core Trace | tion/esd/ctoolslib/ET | | | triggering. | MLib_0.6.zip>`__ | +-----------------------+-----------------------+-----------------------+ -| DSPTraceLib  | Software Library to | `DSPTraceLib_1.14 `__ | +-----------------------+-----------------------+-----------------------+ -| cTools_UCLib  | Library that | `Ctools_UCLib_1.5 `_ | +| | Library | /PMICMILib_1.3.zip>`_ | | | | _ | +-----------------------+-----------------------+-----------------------+ | SCILib | Statistic Collector | `SCILib_1.5 `__ . -  + Support ------- diff --git a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_Fault_Management.rst b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_Fault_Management.rst index a3c48fe29..d1ef27242 100644 --- a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_Fault_Management.rst +++ b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_Fault_Management.rst @@ -209,7 +209,7 @@ utilizes the DSP FM APIs. for (i = 0; i < fmGblCfgParams.maxNumCores; i++) { /* Notify remote DSP cores of exception - WARNING: This will generate NMI * pulse to the remote DSP cores */ - if (i != CSL_chipReadDNUM()) { + if (i != CSL_chipReadDNUM()) { Fault_Mgmt_notify_remote_core(i); } } diff --git a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst index 1a2158a43..dbf95b6a3 100644 --- a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst +++ b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst @@ -196,7 +196,7 @@ Known Issues/Errata may timeout resulting in uncorrelated data. In this case the data can be saved to a binary file and post process for correlation to work. -.. rubric:: uia_1_00_04_35 : Tutorial 1 and Tutorial 2 do not build properly. +.. rubric:: uia_1_00_04_35 : Tutorial 1 and Tutorial 2 do not build properly. :name: uia_1_00_04_35-tutorial-1-and-tutorial-2-do-not-build-properly. - The build fails with the error *"dc.services.global.XDCException: @@ -206,7 +206,7 @@ Known Issues/Errata the UIAMetaData.xs file. Then delete the folder from your project and rebuild. -.. rubric:: uia_1_03_00_02 : JTAG Transport does not work properly on +.. rubric:: uia_1_03_00_02 : JTAG Transport does not work properly on some devices. :name: uia_1_03_00_02-jtag-transport-does-not-work-properly-on-some-devices. diff --git a/source/rtos/Development_Tools/_PSDK_RTOS_Top_level_Makefile.rst b/source/rtos/Development_Tools/_PSDK_RTOS_Top_level_Makefile.rst index 71d8fbc57..c4a2b8a4d 100644 --- a/source/rtos/Development_Tools/_PSDK_RTOS_Top_level_Makefile.rst +++ b/source/rtos/Development_Tools/_PSDK_RTOS_Top_level_Makefile.rst @@ -84,30 +84,30 @@ installed RTOS SDK. :: C:\ti\processor_sdk_rtos_[soc]_[version]>setupenv.bat - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: set CG_XML_BIN_INSTALL_PATH=C:/ti/cg_xml/bin - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: set DOXYGEN_INSTALL_PATH=C:/ti/Doxygen/doxygen/1.5.1-p1/bin ************************************************************************** Environment Configuration: - PDK Directory  : /ti/PDK_AM~3/packages/ - CGTOOL INSTALL Directory  : C:/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : C:/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : C:/ti/xdctools_[version]_core - BIOS_INSTALL_PATH  : C:/ti/bios_[version] - IPC_INSTALL_PATH  : C:/ti/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : C:/ti/edma3_lld_[version] - NDK_INSTALL_PATH  : C:/ti/ndk_[version] - IMGLIB_INSTALL_PATH  : C:/ti/imglib_c66x_[version] - UIA_INSTALL_PATH  : C:/ti/uia_[version] - PROC_SDK_INSTALL_PATH  : C:/ti/processor_sdk_rtos_[soc]_[version] + PDK Directory : /ti/PDK_AM~3/packages/ + CGTOOL INSTALL Directory : C:/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : C:/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : C:/ti/xdctools_[version]_core + BIOS_INSTALL_PATH : C:/ti/bios_[version] + IPC_INSTALL_PATH : C:/ti/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : C:/ti/edma3_lld_[version] + NDK_INSTALL_PATH : C:/ti/ndk_[version] + IMGLIB_INSTALL_PATH : C:/ti/imglib_c66x_[version] + UIA_INSTALL_PATH : C:/ti/uia_[version] + PROC_SDK_INSTALL_PATH : C:/ti/processor_sdk_rtos_[soc]_[version] ************************************************************************** Changing to short name to support directory names containing spaces current directory: C:/ti/processor_sdk_rtos_[soc]_[version] @@ -145,30 +145,30 @@ SDK. :: ~/ti/processor_sdk_rtos_[soc>]_[version]$ source setupenv.sh - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: export CG_XML_BIN_INSTALL_PATH="~/ti/cg_xml/bin" - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: export DOXYGEN_INSTALL_PATH="~/ti/Doxygen/doxygen/1.5.1-p1/bin" ************************************************************************** Environment Configuration: - PDK Directory  : /home/[user]/ti/pdk_[soc]_[version]/packages - CGTOOL INSTALL Directory  : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : /home/[user]/ti/xdctools_[version]_core - BIOS_INSTALL_PATH  : /home/[user]/ti/bios_[version] - IPC_INSTALL_PATH  : /home/[user]/ti/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti/edma3_lld_[version] - NDK_INSTALL_PATH  : /home/[user]/ti/ndk_[version] - IMGLIB_INSTALL_PATH  : /home/[user]/ti/imglib_c66x_[version] - UIA_INSTALL_PATH  : /home/[user]/ti/uia_[version] - PROC_SDK_INSTALL_PATH  : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] + PDK Directory : /home/[user]/ti/pdk_[soc]_[version]/packages + CGTOOL INSTALL Directory : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : /home/[user]/ti/xdctools_[version]_core + BIOS_INSTALL_PATH : /home/[user]/ti/bios_[version] + IPC_INSTALL_PATH : /home/[user]/ti/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti/edma3_lld_[version] + NDK_INSTALL_PATH : /home/[user]/ti/ndk_[version] + IMGLIB_INSTALL_PATH : /home/[user]/ti/imglib_c66x_[version] + UIA_INSTALL_PATH : /home/[user]/ti/uia_[version] + PROC_SDK_INSTALL_PATH : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] PROCESSOR SDK BUILD ENVIRONMENT CONFIGURED ******************************************************************************* diff --git a/source/rtos/Examples_and_Demonstrations/_Audio_Benchmark_Starterkit.rst b/source/rtos/Examples_and_Demonstrations/_Audio_Benchmark_Starterkit.rst index 1753b5955..512e331ac 100644 --- a/source/rtos/Examples_and_Demonstrations/_Audio_Benchmark_Starterkit.rst +++ b/source/rtos/Examples_and_Demonstrations/_Audio_Benchmark_Starterkit.rst @@ -112,7 +112,7 @@ at both approaches. Using Makefile -------------- -**Step1 : Setup Processor SDK RTOS build Environment.** +**Step1 : Setup Processor SDK RTOS build Environment.** Developers are required to setup the Processor SDK RTOS build environment as described in :ref:`Processor SDK RTOS Setup environment ` @@ -126,7 +126,7 @@ environment as described in :ref:`Processor SDK RTOS Setup environment ` | -**Step2 : Invoke Make from root directory** +**Step2 : Invoke Make from root directory** The make file in the root director of the audio-starterkit can be used to build the entire package. To build the benchmark examples: @@ -149,7 +149,7 @@ For Other supported options, please type gmake help -**For Linux :** +**For Linux :** :: @@ -168,7 +168,7 @@ developer build environments. To create CCS Projects with the benchmarks, developers are required to run the BenchmarkProjectCreate script provided in the root directory of the starterkit. -**Step1 : Setup Processor SDK RTOS build Environment.** +**Step1 : Setup Processor SDK RTOS build Environment.** #. **set SDK_INSTALL_PATH = C:\\ti\\** #. **set TOOLS_INSTALL_PATH = C:\\ti\\** @@ -319,12 +319,12 @@ The syntax to run the create-sd script is as follows: create-sd.bat -**EVM** : refers to evaluation platfom on which the binaries are meant +**EVM** : refers to evaluation platfom on which the binaries are meant to be run Eg: create-sd evmK2G - Creates SD bootable images for K2G EVM. -**Step 2 : Format and copy the SD card binaries to the SD card** +**Step 2 : Format and copy the SD card binaries to the SD card** Create an SD card using the procedure described in :ref:`Creating SD card in Windows ` and :ref:`Create SD card in Linux ` @@ -392,7 +392,7 @@ elements are respectively stored at even and odd index locations. The API reference and the implementation details can found in the TI DSPLIB documentation included in the Processor SDK. -.. rubric:: Single Precision IIR : tisigCascadeBiquadSP_2c_3s_kernel +.. rubric:: Single Precision IIR : tisigCascadeBiquadSP_2c_3s_kernel (Cascade Biquad Filter for Multichannel input) :name: single-precision-iir-tisigcascadebiquadsp_2c_3s_kernel-cascade-biquad-filter-for-multichannel-input diff --git a/source/rtos/Examples_and_Demonstrations/_Bare_Metal_Examples.rst b/source/rtos/Examples_and_Demonstrations/_Bare_Metal_Examples.rst index dec7ab0cd..0eea0c074 100644 --- a/source/rtos/Examples_and_Demonstrations/_Bare_Metal_Examples.rst +++ b/source/rtos/Examples_and_Demonstrations/_Bare_Metal_Examples.rst @@ -167,9 +167,9 @@ highlighted code lines and save main.c file. * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -227,7 +227,7 @@ contains the following Memory configurations. :: - MSMC  : o=0x0c000000, l = 0x00600000 /* 6MB Muticore shared memory */ + MSMC : o=0x0c000000, l = 0x00600000 /* 6MB Muticore shared memory */ .. note:: The .lds file expects users to provide STACKSIZE and HEAPSIZE from @@ -318,9 +318,9 @@ Ensure the main.c file contains the following code * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -427,9 +427,9 @@ assembly code **startup_ARMCA8.S** and a linker command file * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -594,9 +594,9 @@ Ensure the main.c file contains the following code * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -721,9 +721,9 @@ template **Basic Examples-> Hello World**. * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -854,9 +854,9 @@ Ensure the main.c file contains the following code * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } @@ -909,7 +909,7 @@ The linker command file is designed to place code in OCMC memory. :: - MSMC  : o=0x0c000000, l = 0x00600000 /* 6MB Muticore shared memory */ + MSMC : o=0x0c000000, l = 0x00600000 /* 6MB Muticore shared memory */ .. note:: An optional step is to modify the section definition in linker command @@ -992,9 +992,9 @@ Ensure the main.c file contains the following code * hello.c */ #include -   + int main(void) { -   + printf("Hello_world\n"); return 0; } diff --git a/source/rtos/Examples_and_Demonstrations/_Big_Data_IPC_Examples.rst b/source/rtos/Examples_and_Demonstrations/_Big_Data_IPC_Examples.rst index 06deab7dc..c43989f84 100644 --- a/source/rtos/Examples_and_Demonstrations/_Big_Data_IPC_Examples.rst +++ b/source/rtos/Examples_and_Demonstrations/_Big_Data_IPC_Examples.rst @@ -106,7 +106,7 @@ How to Run the Example The Processor SDK Linux release includes the pre-built binaries for the host_linux example as part of the tisdk-rootfs-image filesystem. -Step 1 : To run the demo, the first step is to make sure there is no +Step 1 : To run the demo, the first step is to make sure there is no other default applications using the same resources. For example, the following command is needed to disable the default OpenCL applications. diff --git a/source/rtos/Examples_and_Demonstrations/_Jailhouse_Hypervisor.rst b/source/rtos/Examples_and_Demonstrations/_Jailhouse_Hypervisor.rst index c818437de..d708f20a0 100644 --- a/source/rtos/Examples_and_Demonstrations/_Jailhouse_Hypervisor.rst +++ b/source/rtos/Examples_and_Demonstrations/_Jailhouse_Hypervisor.rst @@ -52,8 +52,8 @@ https://github.com/siemens/jailhouse. | *1) set u-boot environment variable optargs*: setenv optargs vmalloc=512M -*2) use \ **am572x-evm-jailhouse.dtb** for AM572x-EVM -or \ **am572x-idk-jailhouse.dtb** for AM572x-IDK +*2) use \ **am572x-evm-jailhouse.dtb** for AM572x-EVM +or \ **am572x-idk-jailhouse.dtb** for AM572x-IDK * | @@ -162,7 +162,7 @@ Here are the steps to run the demo: :: root@am57xx-evm:~# jailhouse cell start 1 - Hey, I'm working !!!!!!!!!!! + Hey, I'm working !!!!!!!!!!! timer id 4fff2b01 timer value fffffc17; irq status 00000002; raw 00000002 min 00000017; avr 0000001b; max 000002c1 @@ -222,7 +222,7 @@ binary and start it. .. rubric:: Running PDK led_test.bin example :name: running-pdk-led_test.bin-example -After you enable hyprevisor, create a pdk cell   +After you enable hyprevisor, create a pdk cell :: @@ -269,7 +269,7 @@ You may see blinking leds, press "r" to repeat the test. | This example just demonstrates hypervisor's ability to run binaries that were built outside of jailhouse source tree. This and other RTOS examples were ported for this purpose. Look to RTOS SDK documentation - for description of the examples functionality.   + for description of the examples functionality. .. rubric:: Running the Demo on AM572x-IDK :name: running-the-demo-on-am572x-idk diff --git a/source/rtos/Examples_and_Demonstrations/_Posix_SMP_Demo.rst b/source/rtos/Examples_and_Demonstrations/_Posix_SMP_Demo.rst index 41d12d6a6..d0182eb4a 100644 --- a/source/rtos/Examples_and_Demonstrations/_Posix_SMP_Demo.rst +++ b/source/rtos/Examples_and_Demonstrations/_Posix_SMP_Demo.rst @@ -196,11 +196,11 @@ the toolchains for the cores being used. #DEPOT = #### BIOS-side dependencies #### - #BIOS_INSTALL_PATH ?= $(DEPOT)\bios_n_nn_nn_nn - #XDC_INSTALL_PATH ?= $(DEPOT)\xdctools_n_nn_nn_nn_core + #BIOS_INSTALL_PATH ?= $(DEPOT)\bios_n_nn_nn_nn + #XDC_INSTALL_PATH ?= $(DEPOT)\xdctools_n_nn_nn_nn_core #### BIOS-side toolchains #### - #TOOLCHAIN_PATH_A15 ?= $(DEPOT)\ccsv6\tools\compiler\gcc-arm-none-eabi-n_n-xxxxqn - #TOOLCHAIN_PATH_M4 ?= $(DEPOT)\ccsv6\tools\compiler\ti-cgt-arm_x.x.x + #TOOLCHAIN_PATH_A15 ?= $(DEPOT)\ccsv6\tools\compiler\gcc-arm-none-eabi-n_n-xxxxqn + #TOOLCHAIN_PATH_M4 ?= $(DEPOT)\ccsv6\tools\compiler\ti-cgt-arm_x.x.x Navigate to the demo directory and run "make". The steps to run the demo will be the same. diff --git a/source/rtos/Examples_and_Demonstrations/_RTOS_Template_App.rst b/source/rtos/Examples_and_Demonstrations/_RTOS_Template_App.rst index 93544e9f1..80643b4cc 100644 --- a/source/rtos/Examples_and_Demonstrations/_RTOS_Template_App.rst +++ b/source/rtos/Examples_and_Demonstrations/_RTOS_Template_App.rst @@ -128,11 +128,11 @@ The source files are organized as follows:: └── template_app ├── baremetal - │   ├── app.c --> Application tasks are here - │   ├── app.h --> Application header file - │   ├── baremetal_template_app_am572x_a15_evmAM572X.projectspec --> Project spec file + │ ├── app.c --> Application tasks are here + │ ├── app.h --> Application header file + │ ├── baremetal_template_app_am572x_a15_evmAM572X.projectspec --> Project spec file | ├── main.c --> Main file which has board and driver init code - │   ├── lnk_a15.cmd --> Linker command file. + │ ├── lnk_a15.cmd --> Linker command file. ├── GPIO_board.h --> Gpio board header ├── GPIO_evmAM572x_board.c --> Gpio board configuration └── rtos diff --git a/source/rtos/FAQ.rst b/source/rtos/FAQ.rst index b73ec227c..1aa3f1a2c 100644 --- a/source/rtos/FAQ.rst +++ b/source/rtos/FAQ.rst @@ -207,7 +207,7 @@ Guide `. | .. rubric:: How can I optimize the build time when rebuilding the - Processor SDK RTOS ? + Processor SDK RTOS ? :name: how-can-i-optimize-the-build-time-when-rebuilding-the-processor-sdk-rtos Processor SDK RTOS top level build will rebuild IPC, all components @@ -330,7 +330,7 @@ projects, users can follow the sequence provided below: Each low level driver (LLD) in the PDK package contains two versions of the driver library. The naming conventions are as follows: -- **Generic Core-specific Driver Library** : +- **Generic Core-specific Driver Library** : ti.drv.. Example: ti.drv.gpio.aa15fg (A15 core-specific GPIO driver library) @@ -728,7 +728,7 @@ on the custom hardware. Filesystem Support ================== -.. rubric:: What filesystem support if provided by Processor SDK RTOS ? +.. rubric:: What filesystem support if provided by Processor SDK RTOS ? Can I use UBIFS, RAMFS, or FATFS with TI RTOS when using external non-volatile memory devices? :name: what-filesystem-support-if-provided-by-processor-sdk-rtos-can-i-use-ubifs-ramfs-or-fatfs-with-ti-rtos-when-using-external-non-volatile-memory-devices @@ -839,7 +839,7 @@ to add correct coreID to the configuration to their BIOS configuration to allow the hardware interrupts to be routed to the secondary core. For example on AM572x which has 2 A15 cores, to run the TI RTOS example -on secondary ARM core, application users need to add : +on secondary ARM core, application users need to add : :: @@ -884,7 +884,7 @@ clock module. The GEL is created with the assumption that the DSP1 developers will use GPtimer5 and DSP2 users will use GPtimer6 to source clock module. This means that DSP2 developers will need to add configuration script to change the clock source to GPtimer6. Try to add -the following in your DSP2.cfg : +the following in your DSP2.cfg : :: diff --git a/source/rtos/How_to_Guides/Host/Flashing_and_Boot/_Flash_bootable_images.rst b/source/rtos/How_to_Guides/Host/Flashing_and_Boot/_Flash_bootable_images.rst index 28bda714e..0421f4087 100644 --- a/source/rtos/How_to_Guides/Host/Flashing_and_Boot/_Flash_bootable_images.rst +++ b/source/rtos/How_to_Guides/Host/Flashing_and_Boot/_Flash_bootable_images.rst @@ -141,7 +141,7 @@ For Windows users: > cd [SDK Install Path]\processor_sdk_rtos__\bin > set DSS_SCRIPT_DIR=[CCS Install Path]\ccsv6\ccs_base\scripting\bin - > %DSS_SCRIPT_DIR%\dss.bat program_evm.js [tmdx|tmds]evm(6678|6657|k2h|k2e|k2l)[l|le|ls][-le|-be] + > %DSS_SCRIPT_DIR%\dss.bat program_evm.js [tmdx|tmds]evm(6678|6657|k2h|k2e|k2l)[l|le|ls][-le|-be] For Linux users: diff --git a/source/rtos/How_to_Guides/Host/Porting/_Adding_Custom_Board_Library_Target_to_PSDK_RTOS_makefiles.rst b/source/rtos/How_to_Guides/Host/Porting/_Adding_Custom_Board_Library_Target_to_PSDK_RTOS_makefiles.rst index 2825a7199..5720c3513 100644 --- a/source/rtos/How_to_Guides/Host/Porting/_Adding_Custom_Board_Library_Target_to_PSDK_RTOS_makefiles.rst +++ b/source/rtos/How_to_Guides/Host/Porting/_Adding_Custom_Board_Library_Target_to_PSDK_RTOS_makefiles.rst @@ -59,7 +59,7 @@ files for including Low level driver(LLD), source files relevant to board and the common board.c file - In packages/ti/board/build/makefile.mk, add board.c to the - customBoard build : + customBoard build : :: @@ -238,7 +238,7 @@ AM572x EVM, you can invoke the build using: -**Step 10 : Building the custom board with the updated settings** +**Step 10 : Building the custom board with the updated settings** To build package change directory to /pdk_am57xx_x_x_x/packages, first run pdksetupenv.bat diff --git a/source/rtos/How_to_Guides/Host/Porting/_PSDK_RTOS_Porting_Guide_for_AM57xx_Speed_Grades.rst b/source/rtos/How_to_Guides/Host/Porting/_PSDK_RTOS_Porting_Guide_for_AM57xx_Speed_Grades.rst index fb50d6da5..67a3eaf73 100644 --- a/source/rtos/How_to_Guides/Host/Porting/_PSDK_RTOS_Porting_Guide_for_AM57xx_Speed_Grades.rst +++ b/source/rtos/How_to_Guides/Host/Porting/_PSDK_RTOS_Porting_Guide_for_AM57xx_Speed_Grades.rst @@ -35,7 +35,7 @@ Comparison of AM572x, AM571x and AM570x devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **Quick Feature Set comparison between devices in Sitara AM57xx -family :** +family :** .. Image:: /images/AM572x_AM571X_AM570x_Comparison.png @@ -129,7 +129,7 @@ above configuration, you will also need to modify OPP_NOM settings in the board library by updating the DPLL setting for MPU and DSP in the file _pll.c as shown below: -**Step1 : Update MPU, DSP, IVA and GPU DPLL setting** +**Step1 : Update MPU, DSP, IVA and GPU DPLL setting** - **MPU DPLL Changes:** @@ -172,7 +172,7 @@ removing the ivaPLL and gpuPLL settings in board. - gpuPllcParam.div = 3U; - gpuPllcParam.divM2 = 2U; -**Step 2 : Disable clocks configuration and wakeup for IVA in PRCM** +**Step 2 : Disable clocks configuration and wakeup for IVA in PRCM** - **Remove IVA wakeup and Module configuration** diff --git a/source/rtos/How_to_Guides/Host/Setup/_Update_ENV_for_a_Custom_Path.rst b/source/rtos/How_to_Guides/Host/Setup/_Update_ENV_for_a_Custom_Path.rst index b6c56dc36..780ac1d2e 100644 --- a/source/rtos/How_to_Guides/Host/Setup/_Update_ENV_for_a_Custom_Path.rst +++ b/source/rtos/How_to_Guides/Host/Setup/_Update_ENV_for_a_Custom_Path.rst @@ -48,7 +48,7 @@ installed somewhere other than the default C:\\ti location. For example, environment configuration assuming CCS is installed to [os_base]\\ti_temp and SDK RTOS has been installed to default path, -[os_base]\\ti : +[os_base]\\ti : - Windows @@ -68,30 +68,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: set CG_XML_BIN_INSTALL_PATH=C:/ti/cg_xml/bin - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: set DOXYGEN_INSTALL_PATH=C:/ti/Doxygen/doxygen/1.5.1-p1/bin ************************************************************************** Environment Configuration: - PDK Directory  : /ti/PDK_AM~3/packages/ - CGTOOL INSTALL Directory  : C:/ti_temp/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : C:/ti_temp/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : C:/ti/xdctools_[version]_core - BIOS_INSTALL_PATH  : C:/ti/bios_[version] - IPC_INSTALL_PATH  : C:/ti/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : C:/ti/edma3_lld_[version] - NDK_INSTALL_PATH  : C:/ti/ndk_[version] - IMGLIB_INSTALL_PATH  : C:/ti/imglib_c66x_[version] - UIA_INSTALL_PATH  : C:/ti/uia_[version] - PROC_SDK_INSTALL_PATH  : C:/ti/processor_sdk_rtos_[soc]_[version] + PDK Directory : /ti/PDK_AM~3/packages/ + CGTOOL INSTALL Directory : C:/ti_temp/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : C:/ti_temp/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : C:/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : C:/ti/xdctools_[version]_core + BIOS_INSTALL_PATH : C:/ti/bios_[version] + IPC_INSTALL_PATH : C:/ti/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : C:/ti/edma3_lld_[version] + NDK_INSTALL_PATH : C:/ti/ndk_[version] + IMGLIB_INSTALL_PATH : C:/ti/imglib_c66x_[version] + UIA_INSTALL_PATH : C:/ti/uia_[version] + PROC_SDK_INSTALL_PATH : C:/ti/processor_sdk_rtos_[soc]_[version] ************************************************************************** Changing to short name to support directory names containing spaces current directory: C:/ti/processor_sdk_rtos_[soc]_[version] @@ -116,30 +116,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: export CG_XML_BIN_INSTALL_PATH="~/ti/cg_xml/bin" - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: export DOXYGEN_INSTALL_PATH="~/ti/Doxygen/doxygen/1.5.1-p1/bin" ************************************************************************** Environment Configuration: - PDK Directory  : /home/[user]/ti/pdk_[soc]_[version]/packages - CGTOOL INSTALL Directory  : /home/[user]/ti_temp/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : /home/[user]/ti_temp/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : /home/[user]/ti/xdctools_[version]_core - BIOS_INSTALL_PATH  : /home/[user]/ti/bios_[version] - IPC_INSTALL_PATH  : /home/[user]/ti/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti/edma3_lld_[version] - NDK_INSTALL_PATH  : /home/[user]/ti/ndk_[version] - IMGLIB_INSTALL_PATH  : /home/[user]/ti/imglib_c66x_[version] - UIA_INSTALL_PATH  : /home/[user]/ti/uia_[version] - PROC_SDK_INSTALL_PATH  : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] + PDK Directory : /home/[user]/ti/pdk_[soc]_[version]/packages + CGTOOL INSTALL Directory : /home/[user]/ti_temp/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : /home/[user]/ti_temp/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : /home/[user]/ti_temp/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : /home/[user]/ti/xdctools_[version]_core + BIOS_INSTALL_PATH : /home/[user]/ti/bios_[version] + IPC_INSTALL_PATH : /home/[user]/ti/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti/edma3_lld_[version] + NDK_INSTALL_PATH : /home/[user]/ti/ndk_[version] + IMGLIB_INSTALL_PATH : /home/[user]/ti/imglib_c66x_[version] + UIA_INSTALL_PATH : /home/[user]/ti/uia_[version] + PROC_SDK_INSTALL_PATH : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] PROCESSOR SDK BUILD ENVIRONMENT CONFIGURED ******************************************************************************* @@ -179,30 +179,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: set CG_XML_BIN_INSTALL_PATH=C:/ti/cg_xml/bin - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: set DOXYGEN_INSTALL_PATH=C:/ti/Doxygen/doxygen/1.5.1-p1/bin ************************************************************************** Environment Configuration: - PDK Directory  : /ti_temp/PDK_AM~3/packages/ - CGTOOL INSTALL Directory  : C:/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : C:/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : C:/ti_temp/xdctools_[version]_core - BIOS_INSTALL_PATH  : C:/ti_temp/bios_[version] - IPC_INSTALL_PATH  : C:/ti_temp/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : C:/ti_temp/edma3_lld_[version] - NDK_INSTALL_PATH  : C:/ti_temp/ndk_[version] - IMGLIB_INSTALL_PATH  : C:/ti_temp/imglib_c66x_[version] - UIA_INSTALL_PATH  : C:/ti_temp/uia_[version] - PROC_SDK_INSTALL_PATH  : C:/ti_temp/processor_sdk_rtos_[soc]_[version] + PDK Directory : /ti_temp/PDK_AM~3/packages/ + CGTOOL INSTALL Directory : C:/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : C:/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : C:/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : C:/ti_temp/xdctools_[version]_core + BIOS_INSTALL_PATH : C:/ti_temp/bios_[version] + IPC_INSTALL_PATH : C:/ti_temp/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : C:/ti_temp/edma3_lld_[version] + NDK_INSTALL_PATH : C:/ti_temp/ndk_[version] + IMGLIB_INSTALL_PATH : C:/ti_temp/imglib_c66x_[version] + UIA_INSTALL_PATH : C:/ti_temp/uia_[version] + PROC_SDK_INSTALL_PATH : C:/ti_temp/processor_sdk_rtos_[soc]_[version] ************************************************************************** Changing to short name to support directory names containing spaces current directory: C:/ti_temp/processor_sdk_rtos_[soc]_[version] @@ -227,30 +227,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: export CG_XML_BIN_INSTALL_PATH="~/ti/cg_xml/bin" - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: export DOXYGEN_INSTALL_PATH="~/ti/Doxygen/doxygen/1.5.1-p1/bin" ************************************************************************** Environment Configuration: - PDK Directory  : /home/[user]/ti_temp/pdk_[soc]_[version]/packages - CGTOOL INSTALL Directory  : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : /home/[user]/ti_temp/xdctools_[version]_core - BIOS_INSTALL_PATH  : /home/[user]/ti_temp/bios_[version] - IPC_INSTALL_PATH  : /home/[user]/ti_temp/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti_temp/edma3_lld_[version] - NDK_INSTALL_PATH  : /home/[user]/ti_temp/ndk_[version] - IMGLIB_INSTALL_PATH  : /home/[user]/ti_temp/imglib_c66x_[version] - UIA_INSTALL_PATH  : /home/[user]/ti_temp/uia_[version] - PROC_SDK_INSTALL_PATH  : /home/[user]/ti_temp/processor_sdk_rtos_[soc]_[version] + PDK Directory : /home/[user]/ti_temp/pdk_[soc]_[version]/packages + CGTOOL INSTALL Directory : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : /home/[user]/ti/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : /home/[user]/ti/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : /home/[user]/ti_temp/xdctools_[version]_core + BIOS_INSTALL_PATH : /home/[user]/ti_temp/bios_[version] + IPC_INSTALL_PATH : /home/[user]/ti_temp/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/ti_temp/edma3_lld_[version] + NDK_INSTALL_PATH : /home/[user]/ti_temp/ndk_[version] + IMGLIB_INSTALL_PATH : /home/[user]/ti_temp/imglib_c66x_[version] + UIA_INSTALL_PATH : /home/[user]/ti_temp/uia_[version] + PROC_SDK_INSTALL_PATH : /home/[user]/ti_temp/processor_sdk_rtos_[soc]_[version] PROCESSOR SDK BUILD ENVIRONMENT CONFIGURED ******************************************************************************* @@ -286,7 +286,7 @@ be set to the custom install path **prior to running** the environment setup script. For example, environment configuration assuming CCS and the SDK have -been installed to [os_base]\\new_sdk_release\\ : +been installed to [os_base]\\new_sdk_release\\ : - Windows @@ -307,30 +307,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: set CG_XML_BIN_INSTALL_PATH=C:/ti/cg_xml/bin - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: set DOXYGEN_INSTALL_PATH=C:/ti/Doxygen/doxygen/1.5.1-p1/bin ************************************************************************** Environment Configuration: - PDK Directory  : /NEW_SD~1/PDK_AM~1/packages/ - CGTOOL INSTALL Directory  : C:/new_sdk_release/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : C:/new_sdk_release/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : C:/new_sdk_release/xdctools_[version]_core - BIOS_INSTALL_PATH  : C:/new_sdk_release/bios_[version] - IPC_INSTALL_PATH  : C:/new_sdk_release/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : C:/new_sdk_release/edma3_lld_[version] - NDK_INSTALL_PATH  : C:/new_sdk_release/ndk_[version] - IMGLIB_INSTALL_PATH  : C:/new_sdk_release/imglib_c66x_[version] - UIA_INSTALL_PATH  : C:/new_sdk_release/uia_[version] - PROC_SDK_INSTALL_PATH  : C:/new_sdk_release/processor_sdk_rtos_[soc]_[version] + PDK Directory : /NEW_SD~1/PDK_AM~1/packages/ + CGTOOL INSTALL Directory : C:/new_sdk_release/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : C:/new_sdk_release/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : C:/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : C:/new_sdk_release/xdctools_[version]_core + BIOS_INSTALL_PATH : C:/new_sdk_release/bios_[version] + IPC_INSTALL_PATH : C:/new_sdk_release/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : C:/new_sdk_release/edma3_lld_[version] + NDK_INSTALL_PATH : C:/new_sdk_release/ndk_[version] + IMGLIB_INSTALL_PATH : C:/new_sdk_release/imglib_c66x_[version] + UIA_INSTALL_PATH : C:/new_sdk_release/uia_[version] + PROC_SDK_INSTALL_PATH : C:/new_sdk_release/processor_sdk_rtos_[soc]_[version] ************************************************************************** Changing to short name to support directory names containing spaces current directory: C:/new_sdk_release/processor_sdk_rtos_[soc]_[version] @@ -356,30 +356,30 @@ Gives the output: :: - Optional parameter not configured : CG_XML_BIN_INSTALL_PATH + Optional parameter not configured : CG_XML_BIN_INSTALL_PATH REQUIRED for xdc release build Example: export CG_XML_BIN_INSTALL_PATH="~/ti/cg_xml/bin" - Optional parameter not configured : DOXYGEN_INSTALL_PATH + Optional parameter not configured : DOXYGEN_INSTALL_PATH REQUIRED for xdc release build Example: export DOXYGEN_INSTALL_PATH="~/ti/Doxygen/doxygen/1.5.1-p1/bin" ************************************************************************** Environment Configuration: - PDK Directory  : /home/[user]/new_sdk_release/pdk_[soc]_[version]/packages - CGTOOL INSTALL Directory  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/ti-cgt-c6000_[version] - TOOLCHAIN A15 Directory  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A8 Directory  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN A9 Directory  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] - TOOLCHAIN M4 Directory  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/ti-cgt-arm_[version] - FPULIB_PATH  : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu - CROSS_TOOL_PRFX  : arm-none-eabi- - XDC_INSTALL_PATH  : /home/[user]/new_sdk_release/xdctools_[version]_core - BIOS_INSTALL_PATH  : /home/[user]/new_sdk_release/bios_[version] - IPC_INSTALL_PATH  : /home/[user]/new_sdk_release/ipc_[version] - EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/new_sdk_release/edma3_lld_[version] - NDK_INSTALL_PATH  : /home/[user]/new_sdk_release/ndk_[version] - IMGLIB_INSTALL_PATH  : /home/[user]/new_sdk_release/imglib_c66x_[version] - UIA_INSTALL_PATH  : /home/[user]/new_sdk_release/uia_[version] - PROC_SDK_INSTALL_PATH  : /home/[user]/new_sdk_release/processor_sdk_rtos_[soc]_[version] + PDK Directory : /home/[user]/new_sdk_release/pdk_[soc]_[version]/packages + CGTOOL INSTALL Directory : /home/[user]/new_sdk_release/ccsv6/tools/compiler/ti-cgt-c6000_[version] + TOOLCHAIN A15 Directory : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A8 Directory : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN A9 Directory : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version] + TOOLCHAIN M4 Directory : /home/[user]/new_sdk_release/ccsv6/tools/compiler/ti-cgt-arm_[version] + FPULIB_PATH : /home/[user]/new_sdk_release/ccsv6/tools/compiler/gcc-arm-none-eabi-[version]/lib/gcc/arm-none-eabi/[version]/fpu + CROSS_TOOL_PRFX : arm-none-eabi- + XDC_INSTALL_PATH : /home/[user]/new_sdk_release/xdctools_[version]_core + BIOS_INSTALL_PATH : /home/[user]/new_sdk_release/bios_[version] + IPC_INSTALL_PATH : /home/[user]/new_sdk_release/ipc_[version] + EDMA3LLD_BIOS6_INSTALLDIR : /home/[user]/new_sdk_release/edma3_lld_[version] + NDK_INSTALL_PATH : /home/[user]/new_sdk_release/ndk_[version] + IMGLIB_INSTALL_PATH : /home/[user]/new_sdk_release/imglib_c66x_[version] + UIA_INSTALL_PATH : /home/[user]/new_sdk_release/uia_[version] + PROC_SDK_INSTALL_PATH : /home/[user]/new_sdk_release/processor_sdk_rtos_[soc]_[version] PROCESSOR SDK BUILD ENVIRONMENT CONFIGURED ******************************************************************************* diff --git a/source/rtos/How_to_Guides/Host/System_Integration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst b/source/rtos/How_to_Guides/Host/System_Integration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst index bf0c1188a..af6e32817 100644 --- a/source/rtos/How_to_Guides/Host/System_Integration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst +++ b/source/rtos/How_to_Guides/Host/System_Integration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst @@ -80,17 +80,17 @@ CCS is installed at: /mnt/data/user/ti/my_custom_ccs_x.x.x_install ├── ccsvX - │   ├── ccs_base - │   ├── doc - │   ├── eclipse - │   ├── install_info - │   ├── install_logs - │   ├── install_scripts - │   ├── tools - │   ├── uninstall_ccs - │   ├── uninstall_ccs.dat - │   ├── uninstallers - │   └── utils + │ ├── ccs_base + │ ├── doc + │ ├── eclipse + │ ├── install_info + │ ├── install_logs + │ ├── install_scripts + │ ├── tools + │ ├── uninstall_ccs + │ ├── uninstall_ccs.dat + │ ├── uninstallers + │ └── utils ├── Code Composer Studio x.x.x.desktop └── xdctools_x_xx_xx_xx_core ├── bin @@ -159,34 +159,34 @@ Here are the key files that you should see after a successful build: :: ├── dsp1 - │   └── bin - │      ├── debug - │      │   └── server_dsp1.xe66 - │      └── release - │      └── server_dsp1.xe66 + │ └── bin + │ ├── debug + │ │ └── server_dsp1.xe66 + │ └── release + │ └── server_dsp1.xe66 ├── dsp2 - │   └── bin - │      ├── debug - │      │   └── server_dsp2.xe66 - │      └── release - │      └── server_dsp2.xe66 + │ └── bin + │ ├── debug + │ │ └── server_dsp2.xe66 + │ └── release + │ └── server_dsp2.xe66 ├── host - │      ├── debug - │      │   └── app_host - │      └── release - │      └── app_host + │ ├── debug + │ │ └── app_host + │ └── release + │ └── app_host ├── ipu1 - │   └── bin - │      ├── debug - │      │   └── server_ipu1.xem4 - │      └── release - │      └── server_ipu1.xem4 + │ └── bin + │ ├── debug + │ │ └── server_ipu1.xem4 + │ └── release + │ └── server_ipu1.xem4 └── ipu2 -    └── bin -       ├── debug -       │   └── server_ipu2.xem4 -       └── release -       └── server_ipu2.xem4 + └── bin + ├── debug + │ └── server_ipu2.xem4 + └── release + └── server_ipu2.xem4 | @@ -315,14 +315,14 @@ Understanding the Memory Map root@am57xx-evm:~# cat /proc/iomem [snip...] - 58060000-58078fff : core - 58820000-5882ffff : l2ram - 58882000-588820ff : /ocp/mmu@58882000 - 80000000-9fffffff : System RAM - 80008000-808d204b : Kernel code - 80926000-809c96bf : Kernel data - a0000000-abffffff : CMEM - ac000000-ffcfffff : System RAM + 58060000-58078fff : core + 58820000-5882ffff : l2ram + 58882000-588820ff : /ocp/mmu@58882000 + 80000000-9fffffff : System RAM + 80008000-808d204b : Kernel code + 80926000-809c96bf : Kernel data + a0000000-abffffff : CMEM + ac000000-ffcfffff : System RAM | @@ -552,30 +552,30 @@ ipc/packages/ti/ipc/remoteproc/rsc_table_vayu_dsp.h DSP_MEM_TEXT, 0, DSP_MEM_TEXT_SIZE, 0, 0, "DSP_MEM_TEXT", }, -   + { TYPE_CARVEOUT, DSP_MEM_DATA, 0, DSP_MEM_DATA_SIZE, 0, 0, "DSP_MEM_DATA", }, -   + { TYPE_CARVEOUT, DSP_MEM_HEAP, 0, DSP_MEM_HEAP_SIZE, 0, 0, "DSP_MEM_HEAP", }, -   + { TYPE_CARVEOUT, DSP_MEM_IPC_DATA, 0, DSP_MEM_IPC_DATA_SIZE, 0, 0, "DSP_MEM_IPC_DATA", }, -   + { TYPE_TRACE, TRACEBUFADDR, 0x8000, 0, "trace:dsp", }, -   -   + + { TYPE_DEVMEM, DSP_MEM_IPC_VRING, PHYS_MEM_IPC_VRING, @@ -862,7 +862,7 @@ ipc_3_43_02_04/examples/DRA7XX_linux_elf/ex02_messageq/ipu1/IpuAmmu.cfg AMMU.largePages[0].size = AMMU.Large_512M; AMMU.largePages[0].L1_cacheable = AMMU.CachePolicy_CACHEABLE; AMMU.largePages[0].L1_posted = AMMU.PostedPolicy_POSTED; -   + /* Peripheral regions: Large Page (512M); non-cacheable */ /* config large page[1] to map 512MB VA 0x60000000 to L3 0x60000000 */ AMMU.largePages[1].pageEnabled = AMMU.Enable_YES; @@ -871,7 +871,7 @@ ipc_3_43_02_04/examples/DRA7XX_linux_elf/ex02_messageq/ipu1/IpuAmmu.cfg AMMU.largePages[1].size = AMMU.Large_512M; AMMU.largePages[1].L1_cacheable = AMMU.CachePolicy_NON_CACHEABLE; AMMU.largePages[1].L1_posted = AMMU.PostedPolicy_POSTED; -   + /* Private, Shared and IPC Data regions: Large page (512M); cacheable */ /* config large page[2] to map 512MB VA 0x80000000 to L3 0x80000000 */ AMMU.largePages[2].pageEnabled = AMMU.Enable_YES; @@ -927,25 +927,25 @@ ipc/packages/ti/ipc/remoteproc/rsc_table_vayu_ipu.h #define IPU_MEM_TEXT 0x0 #define IPU_MEM_DATA 0x80000000 -   + #define IPU_MEM_IOBUFS 0x90000000 -   + #define IPU_MEM_IPC_DATA 0x9F000000 #define IPU_MEM_IPC_VRING 0x60000000 #define IPU_MEM_RPMSG_VRING0 0x60000000 #define IPU_MEM_RPMSG_VRING1 0x60004000 #define IPU_MEM_VRING_BUFS0 0x60040000 #define IPU_MEM_VRING_BUFS1 0x60080000 -   + #define IPU_MEM_IPC_VRING_SIZE SZ_1M #define IPU_MEM_IPC_DATA_SIZE SZ_1M -   + #if defined(VAYU_IPU_1) #define IPU_MEM_TEXT_SIZE (SZ_1M) #elif defined(VAYU_IPU_2) #define IPU_MEM_TEXT_SIZE (SZ_1M * 6) #endif -   + #if defined(VAYU_IPU_1) #define IPU_MEM_DATA_SIZE (SZ_1M * 5) #elif defined(VAYU_IPU_2) @@ -963,13 +963,13 @@ ipc/packages/ti/ipc/remoteproc/rsc_table_vayu_ipu.h IPU_MEM_TEXT, 0, IPU_MEM_TEXT_SIZE, 0, 0, "IPU_MEM_TEXT", }, -   + { TYPE_CARVEOUT, IPU_MEM_DATA, 0, IPU_MEM_DATA_SIZE, 0, 0, "IPU_MEM_DATA", }, -   + { TYPE_CARVEOUT, IPU_MEM_IPC_DATA, 0, @@ -1177,7 +1177,7 @@ To do this, follow these steps. - For *Target*, select ti.targets.elf.C66 - For *Platform*, select ti.platforms.evmDRA7XX - Once the platform is selected, edit its name buy hand and - append :dsp1 to the end. After this it should be + append :dsp1 to the end. After this it should be ti.platforms.evmDRA7XX:dsp1 - Go ahead and leave the *Build-profile* set to debug. - Hit the OK button. @@ -1366,11 +1366,11 @@ BIOS_start() .. code-block:: c ipc_main(); -   + if (callIpcStartup) { IpcMgr_ipcStartup(); } -   + /* Start BIOS */ BIOS_start(); return (0); @@ -1541,12 +1541,12 @@ following log on the serial IO console: :: - uart driver and utils example test cases : + uart driver and utils example test cases : Enter 16 characters or press Esc 1234567890123456 <- user input Data received is 1234567890123456 <- loopback from user input - uart driver and utils example test cases : + uart driver and utils example test cases : Enter 16 characters or press Esc | @@ -1614,7 +1614,7 @@ To do this, follow these steps. - For *Target*, select **ti.targets.arm.elf.M4** - For *Platform*, select **ti.platforms.evmDRA7XX** - Once the platform is selected, edit its name buy hand and - append :ipu2 to the end. After this it should be + append :ipu2 to the end. After this it should be ti.platforms.evmDRA7XX:ipu2 - Go ahead and leave the *Build-profile* set to debug. - Hit the OK button. @@ -1834,7 +1834,7 @@ needs to be performed by the M4. | | -**Modified Code :** +**Modified Code :** .. code-block:: c @@ -1853,7 +1853,7 @@ adding the following code before Board_init API call: (CSL_l4per_cm_core_componentRegs *)CSL_MPU_L4PER_CM_CORE_REGS; CSL_FINST(l4PerCmReg->CM_L4PER_UART3_CLKCTRL_REG, L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_MODULEMODE, ENABLE); - while(CSL_L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST_FUNC != + while(CSL_L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST_FUNC != CSL_FEXT(l4PerCmReg->CM_L4PER_UART3_CLKCTRL_REG, L4PER_CM_CORE_COMPONENT_CM_L4PER_UART3_CLKCTRL_REG_IDLEST)); diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst index 932c0073b..c8794d449 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst @@ -83,7 +83,7 @@ Boot Sequence #. Secondary Bootloader(SBL) - Configure PLL and Initialize DDR - - Configure PRCM and PinMux  for Boot Peripherals + - Configure PRCM and PinMux for Boot Peripherals - Copies application image to DDR - Passes execution control to Application @@ -95,7 +95,7 @@ Tools and Binary formats +-----------------------+-----------------------+-----------------------+ | Binary format | Requirement | Details | +-----------------------+-----------------------+-----------------------+ -| .bin | QSPI bootloader, | QSPI bootloader | +| .bin | QSPI bootloader, | QSPI bootloader | | | | binary should in .bin | | | UART bootloader and | format and | | | app | Application binary | @@ -109,7 +109,7 @@ Tools and Binary formats | | | terminal. | +-----------------------+-----------------------+-----------------------+ | \_ti.bin | MMCSD bootloader | .bin binaries are | -| | and app, | converted to | +| | and app, | converted to | | | | \_ti.bin format by | | | NAND bootloader and | adding Image | | | app, | size(4bytes) and | @@ -122,7 +122,7 @@ Tools and Binary formats | | | chapter of `AM437x | | | | TRM`_ | | | | | -| | | MMCSD, NAND and MCSPI | +| | | MMCSD, NAND and MCSPI | | | | boot loaders and | | | | application binaries | | | | should be appended | @@ -336,7 +336,7 @@ Booting from SD Card involves two steps. #. Preparing SD card. #. Booting target. -Preparing SD card  +Preparing SD card ''''''''''''''''''' #. To boot target the SD card should be bootable. Follow the steps at @@ -433,10 +433,10 @@ details below: StarterWare QSPI Flash Writer!! BOARDInit status [0x0] - SoC  : [AM43XX] - Core  : [A9] - Board Detected  : [IDKEVM] - Base Board Revision  : [UNKNOWN] + SoC : [AM43XX] + Core : [A9] + Board Detected : [IDKEVM] + Base Board Revision : [UNKNOWN] Daughter Card Revision: [UNKNOWN] Copying boot to QSPI Flash Copying app to QSPI Flash @@ -451,17 +451,17 @@ Booting the target. #. Connect UART cable to a host running serial terminal application (teraterm/hyperterminal) with 115200 baud, 8bit, No parity and 1 STOP bit configuration. -#. After flashing successfully remove SD card and reboot to see +#. After flashing successfully remove SD card and reboot to see following logs :: StarterWare Boot Loader BOARDInit status [0x0] - SoC  : [AM43XX] - Core  : [A9] - Board Detected  : [IDKEVM] - Base Board Revision  : [UNKNOWN] + SoC : [AM43XX] + Core : [A9] + Board Detected : [IDKEVM] + Base Board Revision : [UNKNOWN] Daughter Card Revision: [UNKNOWN] Copying Header of the application image Copying image from flash to DDR @@ -482,15 +482,15 @@ Booting Via UART ROM and Bootloader supports XMODEM protocol with images being binary not requiring any additional headers. Following are steps for boot: -#. Configure board for UART boot mode : +#. Configure board for UART boot mode : UART boot need to be first in the boot device list. Note: In case if any other boot mode is selected, the first available boot image (eg:NAND or MMCSD etc) will override. In case of no valid images, - UART boot will be selected.    + UART boot will be selected. - - Select View->Memory Browser through CCS.    - - Select address 0x44e10040.    - - Write 0x19 to last 2 bytes of this memory address.(UART boot)    + - Select View->Memory Browser through CCS. + - Select address 0x44e10040. + - Write 0x19 to last 2 bytes of this memory address.(UART boot) - Soft reset the board. This is a volatile bit which gets reset after power on. @@ -498,7 +498,7 @@ not requiring any additional headers. Following are steps for boot: XMODEM. File can be sent via xmodem through tera-term File-> Transfer -> XMODEM -> Send. #. On transmitting bootloader - image, bootloader_boot_uart_a9host_debug.bin via XMODEM, following + image, bootloader_boot_uart_a9host_debug.bin via XMODEM, following message will be expected on serial console. :: @@ -506,17 +506,17 @@ not requiring any additional headers. Following are steps for boot: CCCCCCCCCCCCCCCCCCCCCCCCCCCC StarterWare Boot Loader BOARDInit status [0x0] - SoC  : [AM43XX] - Core  : [A9] - Board Detected  : [IDKEVM] - Base Board Revision  : [UNKNOWN] + SoC : [AM43XX] + Core : [A9] + Board Detected : [IDKEVM] + Base Board Revision : [UNKNOWN] Daughter Card Revision: [UNKNOWN] GPIO Instance number: 0 Pin number: 22 Please transfer file: CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC -  4.  As  a next step application binary (without header) can be sent + 4. As a next step application binary (without header) can be sent via XMODEM which will lead to application start executing. Booting Via McSPI @@ -584,7 +584,7 @@ Booting from McSPI involves two steps. .. rubric:: Booting the target :name: booting-the-target -#. Connect a serial cable to a host running a serial terminal +#. Connect a serial cable to a host running a serial terminal application (teraterm/hyperterminal) with 115200 baud, 8bit, No parity and 1 STOP bit configuration. #. Configure the board for SPI boot mode. @@ -629,7 +629,7 @@ Booting from NAND involves two steps. Enter image file path -    Provide the complete path (e.g. + Provide the complete path (e.g. //bootloader_boot_nand_a8host__ti.bin) - Enter offset when prompted as shown below. @@ -638,7 +638,7 @@ Booting from NAND involves two steps. Enter offset (in hex): -|     This offset is start location from where the image should be +| This offset is start location from where the image should be flashed. | NOTE: @@ -656,7 +656,7 @@ Booting from NAND involves two steps. Enter 3 ---> T0 EXIT Please enter ECC scheme type: -    Always select BCH8 for bootloader and application as ROM code and + Always select BCH8 for bootloader and application as ROM code and bootloader uses the BCH8 ECC scheme. - Ensure that flash info displayed by tool matches NAND flash in EVM. @@ -678,7 +678,7 @@ bootloader uses the BCH8 ECC scheme. - Connect a UART cable to a host running a serial terminal application (teraterm/hyperterminal) with 115200 baud, 8bit, No parity and 1 STOP bit configuration. -- Configure the board for NAND boot mode. Refer to corresponding +- Configure the board for NAND boot mode. Refer to corresponding hardware user's guide for bootmode settings. - On reset, ROM detects bootloader from NAND and copies it to internal memory. Bootloader then copies application image from the NAND to DDR @@ -689,10 +689,10 @@ bootloader uses the BCH8 ECC scheme. StarterWare Boot Loader BOARDInit status [0x0] - SoC  : [AM335X] - Core  : [A8] - Board Detected  : [GPEVM] - Base Board Revision  : [1.5] + SoC : [AM335X] + Core : [A8] + Board Detected : [GPEVM] + Base Board Revision : [1.5] Daughter Card Revision: [UNKNOWN] NAND flash is connected to GPMC on this board Jumping to StarterWare Application... @@ -803,7 +803,7 @@ adding heap1.sectionName = ".stack"; Memory.defaultHeapInstance = heap1; -**Compiler Setting :** --remove-section=.stack +**Compiler Setting :** --remove-section=.stack **Option 2** Configure Segment type to be "NO LOAD" in .cfg and use excludeSections diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst index d0767d1b9..dbb2d9339 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst @@ -24,7 +24,7 @@ Bootloader Execution Sequence I2C, MMCSD, SD/MMC, SPI, QSPI, Ethernet etc for reliable boot. - The sequence depends on RBL execution flow and Sysboot pins. - RBL gets image size and load address by checking TI Image Header - appended on bootloader binary(.bin). Check binary formats. + appended on bootloader binary(.bin). Check binary formats. - Loads the binary to internal memory at the Load address fetched from TI Image Header - Passes control to Secondary Bootloader(SBL) @@ -48,9 +48,9 @@ Bootloader Execution Sequence - Once Board Initialization is complete, it enables clocks to the target cores like C66x/DSP, IPU, etc and brings them out of reset. - Parses Multicore Application image located in memory device and - copies it to DDR memory based on load address for different + copies it to DDR memory based on load address for different sections. - - Once copy is successful it transfers control to application. + - Once copy is successful it transfers control to application. - **Application then starts executing from DDR**. @@ -85,7 +85,7 @@ Tools and Binary Formats ^^^^^^^^^^^^^^^^^^^^^^^^^^ This section lists out the various tools and scripts used by SBL for -different boot modes and those required to create a bootable application +different boot modes and those required to create a bootable application image. **SBL/MLO image format:** @@ -195,7 +195,7 @@ for more details on usage of this script and application image creation. SBL provides a CCS based qspi flash writer utility to flash image and multicore AppImage from a SD card to onboard QSPI device. It -is located at */packages/ti/boot/sbl/tools/flashWriter/qspi* +is located at */packages/ti/boot/sbl/tools/flashWriter/qspi* Building the SBL @@ -232,8 +232,8 @@ To build the SBL components: #. **Run pdksetupenv script** #. **make all -C ti/boot/sbl BOARD= SOC= BOOTMODE=** -- BOARD_NAME : idkAM572x, idkAM571x, evmAM572x, idkAM574x -- SOC_NAME : AM572x, AM571x, AM574x +- BOARD_NAME : idkAM572x, idkAM571x, evmAM572x, idkAM574x +- SOC_NAME : AM572x, AM571x, AM574x SBL can be built for all the AM57x platforms using below command @@ -276,7 +276,7 @@ Booting Via SD Card #. Preparing the SD card. #. Booting the target. -Preparing the SD card  +Preparing the SD card ''''''''''''''''''''''' #. To boot the target the SD card should be bootable. Follow the steps @@ -304,7 +304,7 @@ Booting Via eMMC #. Preparing the eMMC. #. Booting the target. -Preparing the eMMC  +Preparing the eMMC ''''''''''''''''''' #. To format the eMMC of the target board, Run the following application on the target board @@ -335,7 +335,7 @@ Booting Via QSPI """""""""""""""""" Booting from QSPI flash involves two steps- -#. Flashing bootloader and app image to QSPI flash. +#. Flashing bootloader and app image to QSPI flash. #. Booting the target. Preparing Flash Device @@ -343,7 +343,7 @@ Preparing Flash Device Use the CCS based qspi_flash_writer.out utility provided in <*TI_PDK_INSTALL_DIR>/packages/ti/boot/sbl/tools/flashwriter/qspi/'* -to flash the SBL image at offset 0 and application image at offset +to flash the SBL image at offset 0 and application image at offset 0x80000 to the QSPI device. QSPI device Memory Map: @@ -362,8 +362,8 @@ below. and application image(app) generated using the Script into the SD card. Rename the bootloader file to 'boot' and application image to 'app' - with no extensions.  -#. Copy 'config' file into the SD card, the config file should contain + with no extensions. +#. Copy 'config' file into the SD card, the config file should contain names of the image to be flashed and the offset. A sample config file can be found at */packages/ti/boot/sbl/tools/flashWriter/qspi/config*. @@ -382,7 +382,7 @@ below. #. Run the QSPI flash writer application. You will see the following logs on the EVM's UART console. #. After the images have been flashed to the QSPI device disconnect from - CCS and do a power reset to boot from the QSPI memory.  + CCS and do a power reset to boot from the QSPI memory. :: @@ -416,7 +416,7 @@ to validate the multi-core boot-up use case. Master application sends wake-up message to the DSP target cores & waits for acknowledgement message from the target cores in an infinite -loop.Each target DSP core waits for wake-up message from the master core  +loop.Each target DSP core waits for wake-up message from the master core responds back with an acknowledgement message. Application Image Creation @@ -454,7 +454,7 @@ Example: To create the final bootable application image use the AM57xImageGen script and follow these steps -1. Set the following environment variable in the shell.  BIN_PATH: +1. Set the following environment variable in the shell. BIN_PATH: Pointing to the path where the AppImage needs to be generated :: @@ -462,7 +462,7 @@ Pointing to the path where the AppImage needs to be generated Ex: export BIN_PATH=$(TI_PDK_INSTALL_DIR)/packages/ti/boot/sbl/binary 2. Edit the script file to point to the application elf files by setting -the input application variables.  +the input application variables. App_MPU_CPU0: Point to the path where the application .out for A15 MPU is located App_DSP1: Point to the path where the dsp core 1 application is located @@ -522,7 +522,7 @@ script and follow these steps 1. Set the following environment variable in windows command prompt -BIN_PATH: Pointing to the path where the AppImage needs to be generated  +BIN_PATH: Pointing to the path where the AppImage needs to be generated :: @@ -560,8 +560,8 @@ For information on board specific requirements like power supply, UART console port connections refer the Hardware User guide of the respective boards. -The configurations needed to setup UART console through a serial -terminal application on host PC are listed in the next section. +The configurations needed to setup UART console through a serial +terminal application on host PC are listed in the next section. UART Console Setup ''''''''''''''''''' @@ -569,7 +569,7 @@ PDK SBL prints messages on the UART Serial Console running on the host. Hence, a serial terminal application (like Tera Term/HyperTerminal/minicom) should be running on the host. -The host serial port must be configured at 115200 baud, no parity, 1 +The host serial port must be configured at 115200 baud, no parity, 1 stop bit and no flow control. Please ensure that the local echo setting for the terminal is turned off. @@ -579,7 +579,7 @@ Follow these steps to load the test application using a SD card on the target copy the MLO to your SD card (located -at $(TI_PDK_INSTALL_DIR)/packages/ti/boot/sbl/binary/[BOARD]/mmcsd) +at $(TI_PDK_INSTALL_DIR)/packages/ti/boot/sbl/binary/[BOARD]/mmcsd) #. copy the example app located at path pointed to by BIN_PATH to your SD card @@ -605,7 +605,7 @@ Memory Map """""""""""" Table indicated below provides memory map details for SBL image in -OCMC_RAM1.  For more details on pinmux and IO delay requirements refer +OCMC_RAM1. For more details on pinmux and IO delay requirements refer this link `Processor SDK Board Support `__ diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM65x_J721E.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM65x_J721E.rst index c7f930335..28162d72f 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM65x_J721E.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM65x_J721E.rst @@ -165,22 +165,22 @@ Directory structure │ └── sbl_smp_r5.asm <= Provides dummy override function for __mpu_init for SMP testcase. │ ├── binary <= ROM bootable SBL images for each board/boot media - │   ├── [board] - │      └── [bootmedia] - │        └── bin - │         └── sbl_[bootmedia]_img_mcu1_0_release.tiimage + │ ├── [board] + │ └── [bootmedia] + │ └── bin + │ └── sbl_[bootmedia]_img_mcu1_0_release.tiimage │ ├── lib <= SBL lib for each boot media/board supported - │   ├── [bootmedia] - │   │ └── [board] - │   │    └── r5f - │   │    └── release - │   │    └── sbl_lib_[bootmedia].aer5f - │   └── cust - │   └── [board] - │      └── r5f - │      └── release - │      └── sbl_lib_cust.aer5f + │ ├── [bootmedia] + │ │ └── [board] + │ │ └── r5f + │ │ └── release + │ │ └── sbl_lib_[bootmedia].aer5f + │ └── cust + │ └── [board] + │ └── r5f + │ └── release + │ └── sbl_lib_cust.aer5f │ ├── soc <= SOC specific SBL code │ └── k3 @@ -813,8 +813,8 @@ EVM Setup for testing SBL For information on board specific requirements like power supply, UART console port connections refer the Hardware User guide of the respective boards. -The configurations needed to setup UART console through a serial terminal  -application on host PC are listed in the next section. +The configurations needed to setup UART console through a serial terminal +application on host PC are listed in the next section. **UART Console Setup** @@ -822,7 +822,7 @@ PDK SBL prints messages on the UART Serial Console running on the host. Hence, a serial terminal application (like Tera Term/HyperTerminal/minicom) should be running on the host. -- The host serial port must be configured at 115200 baud, no parity, 1 stop bit +- The host serial port must be configured at 115200 baud, no parity, 1 stop bit and no flow control. - Please ensure that the local echo setting for the terminal is turned off. - All SBL prints are routed to the `MCU UART `__ diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_C66x.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_C66x.rst index 877100002..d12300fa1 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_C66x.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_C66x.rst @@ -27,8 +27,8 @@ supported bootmodes: .. note:: #. Support boot over I2C bus address 0x51 - #. Support POST boot over I2C bus address 0x50 - #. Only ELF and BBLOB images are supported for booting + #. Support POST boot over I2C bus address 0x50 + #. Only ELF and BBLOB images are supported for booting #. IBL is using the first 128KB L2 local memory, any application booting from IBL should NOT use the first 128KB L2 memory, OR should only use the first 128KB L2 memory for uninitialized data section @@ -273,16 +273,16 @@ elements of the NAND boot process. On reset the DSP starts execution with the bootrom which transfers execution to the secondary bootloader from EEPROM using the I2C target -bus address 0x51. The secondary bootloader loads the application program +bus address 0x51. The secondary bootloader loads the application program from NAND flash then transfers control to the application. To execute the NAND bootloader you must ensure the DIP switches for your platform -are properly configured for I2C Master Boot and address 0x51, AND -the boot parameter index dip switch should be set to 2 or 3. +are properly configured for I2C Master Boot and address 0x51, AND +the boot parameter index dip switch should be set to 2 or 3. NAND boot supports multiple images booting. Depending on the boot -parameter index dip switch, maximum 2 boot images can be supported. By +parameter index dip switch, maximum 2 boot images can be supported. By default NAND boot only supports a BBLOB image format, if the customer -wants to boot an ELF image,  the IBL configuration table needs to be +wants to boot an ELF image, the IBL configuration table needs to be modified and re-programmed to EEPROM. | @@ -301,11 +301,11 @@ execution to the secondary bootloader from EEPROM using the I2C target address 0x51. The secondary bootloader loads the application program from NOR flash then transfers control to the application. To execute the NOR bootloader you must ensure the DIP switches for your platform are -properly configured for I2C Master Boot and address 0x51, AND the boot +properly configured for I2C Master Boot and address 0x51, AND the boot parameter index switch should be set to 0 or 1. NOR boot supports multiple images booting. Depending on the boot -parameter index dip switch, maximum 2 boot images can be supported. +parameter index dip switch, maximum 2 boot images can be supported. | @@ -320,11 +320,11 @@ elements of the EMAC boot process. On reset the DSP starts execution with the bootrom which transfers execution to the secondary bootloader from EEPROM using the I2C target -address 0x51. The secondary bootloader loads the application program +address 0x51. The secondary bootloader loads the application program from a remote TFTP server then transfers control to the application. To execute the EMAC bootloader you must ensure the DIP switches for your -platform are properly configured for I2C Master Boot and address 0x51, -AND the boot parameter index switch should be set to 4. By default EMAC +platform are properly configured for I2C Master Boot and address 0x51, +AND the boot parameter index switch should be set to 4. By default EMAC boot only supports a BBLOB image format, if the customer wants to boot an ELF image, the IBL configuration table needs to be modified and re-programmed to EEPROM. diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Board_Support.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Board_Support.rst index abd89a519..baa5d6340 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Board_Support.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Board_Support.rst @@ -87,14 +87,14 @@ In baremetal case with a linker cmd file: :: - BOARD_IO_DELAY_CODE : { + BOARD_IO_DELAY_CODE : { . = ALIGN(4); *(BOARD_IO_DELAY_CODE*) } > OCMC_RAM1 - BOARD_IO_DELAY_DATA : { + BOARD_IO_DELAY_DATA : { . = ALIGN(4); *(BOARD_IO_DELAY_DATA*) diff --git a/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_OSAL.rst b/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_OSAL.rst index e2a82ed2a..ab383341c 100644 --- a/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_OSAL.rst +++ b/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_OSAL.rst @@ -27,7 +27,7 @@ APIs ^^^^ Porting of OSAL component will enable extending PDK components to -additional OS environment. Reference top level API header file  +additional OS environment. Reference top level API header file includes: :: diff --git a/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_Profiling.rst b/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_Profiling.rst index d75c30779..beccf1b9c 100644 --- a/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_Profiling.rst +++ b/source/rtos/PDK_Platform_Software/Device_Driver_Utilities/_Profiling.rst @@ -215,6 +215,6 @@ exclusive(exc): excluding the cycles of its child functions.) in the report. Functions which are optimized out will not appear in the report eg. - empty/single-line functions, ``ti_sysbios_*`` functions etc. + empty/single-line functions, ``ti_sysbios_*`` functions etc. | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_CPPI.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_CPPI.rst index d7f585aab..16b89b146 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_CPPI.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_CPPI.rst @@ -92,189 +92,189 @@ This came from k2k example: *******Test running on Core 0 ******************* *******Test running on Core 2 ******************* *******Test running on Core 3 ******************* - Core 0 : L1D cache size 4. L2 cache size 0. - Core 2 : Starting BIOS... - Core 3 : Starting BIOS... - Core 0 : Starting BIOS... - Core 1 : Starting BIOS... - Core 0 : Created RM packet heap - Core 0 : Created IPC MessageQ heap - Core 0 : Created receive Q for Client1 - Core 1 : Opened RM packet heap - Core 2 : Opened RM packet heap - Core 3 : Opened RM packet heap - Core 1 : Opened IPC MessageQ heap - Core 2 : Opened IPC MessageQ heap - Core 3 : Opened IPC MessageQ heap - Core 1 : Created receive Q for Server - Core 2 : Created receive Q for Server - Core 3 : Created receive Q for Server - Core 1 : Opened Server's receive Q - Core 1 : Waiting for QMSS to be initialized... - - Core 0 : Opened Client1's receive Q for Server - Core 0 : Created receive Q for Client2 - Core 0 : Opened Client2's receive Q for Server - Core 0 : Created receive Q for Client3 - Core 2 : Opened Server's receive Q - Core 2 : Waiting for QMSS to be initialized... - - Core 0 : Opened Client3's receive Q for Server - - Core 0 : QMSS initialization done - - - Core 3 : Opened Server's receive Q - Core 1 : QMSS initialization done - Core 2 : QMSS initialization done - Core 3 : Waiting for QMSS to be initialized... - - - Core 3 : QMSS initialization done - - - Core 0 : QMSS CPDMA Opened - Core 1 : QMSS CPDMA Opened - - - Core 0 : Memory region 0 inserted - Core 0 : Number of descriptors requested : 8. Number of descriptors allocated : 8 - Core 0 : Opened Rx channel : 0 - Core 0 : Opened Tx channel : 0 - Core 0 : Queue Number : 8192 opened - Core 0 : Queue Number : 8193 opened - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b20 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b20 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b50 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b50 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b80 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b80 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853bb0 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853bb0 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853be0 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853be0 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c10 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c10 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c40 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c40 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c70 - Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c70 - Core 0 : Received host descriptor from Queue 897 Sucessfully - Core 0 : Tx Channel closed successfully. Ref count :0 - Core 0 : Rx Channel closed successfully. Ref count :0 - Core 0 : Rx queue closed successfully. Ref count :0 - Core 0 : Tx queue closed successfully. Ref count :0 - Core 0 : Free queue closed successfully. Ref count :0 - Core 0 : Closing CPPI CPDMA Ref count : 3 - Core 0 : CPPI CPDMA closed successfully - Core 1 : Memory region 1 inserted - - - Core 1 : Number of descriptors requested : 8. Number of descriptors allocated : 8 - Core 2 : QMSS CPDMA Opened - Core 3 : QMSS CPDMA Opened - Core 1 : Opened Rx channel : 0 - - - Core 1 : Opened Tx channel : 0 - Core 2 : Memory region 2 inserted - Core 3 : Memory region 3 inserted - Core 1 : Queue Number : 0 opened - Core 2 : Number of descriptors requested : 8. Number of descriptors allocated : 8 - Core 3 : Number of descriptors requested : 8. Number of descriptors allocated : 8 - Core 1 : Queue Number : 1 opened - Core 2 : Opened Rx channel : 1 - Core 3 : Opened Rx channel : 2 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b20 - Core 2 : Opened Tx channel : 1 - Core 3 : Opened Tx channel : 2 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b20 - Core 2 : Queue Number : 8192 opened - Core 3 : Queue Number : 8193 opened - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b50 - Core 2 : Queue Number : 8194 opened - Core 3 : Queue Number : 8195 opened - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b50 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b20 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b20 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b80 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b20 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b20 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b80 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b50 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b50 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853bb0 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b50 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b50 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853bb0 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b80 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b80 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853be0 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b80 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b80 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853be0 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853bb0 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853bb0 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c10 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853bb0 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853bb0 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c10 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853be0 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853be0 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c40 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853be0 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853be0 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c40 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c10 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c10 - Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c70 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c10 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c10 - Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c70 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c40 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c40 - Core 1 : Received host descriptor from Queue 896 Sucessfully - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c40 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c40 - Core 1 : Tx Channel closed successfully. Ref count :0 - Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c70 - Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c70 - Core 1 : Rx Channel closed successfully. Ref count :0 - Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c70 - Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c70 - Core 1 : Rx queue closed successfully. Ref count :0 - Core 2 : Received host descriptor from Queue 9026 Sucessfully - Core 3 : Received host descriptor from Queue 898 Sucessfully - Core 1 : Tx queue closed successfully. Ref count :0 - Core 2 : Tx Channel closed successfully. Ref count :0 - Core 3 : Tx Channel closed successfully. Ref count :0 - Core 1 : Free queue closed successfully. Ref count :0 - Core 2 : Rx Channel closed successfully. Ref count :0 - Core 3 : Rx Channel closed successfully. Ref count :0 - Core 1 : Closing CPPI CPDMA Ref count : 2 - Core 2 : Rx queue closed successfully. Ref count :0 - Core 3 : Rx queue closed successfully. Ref count :0 - Core 1 : CPPI CPDMA closed successfully - Core 2 : Tx queue closed successfully. Ref count :0 - Core 3 : Tx queue closed successfully. Ref count :0 - Core 2 : Free queue closed successfully. Ref count :0 - Core 3 : Free queue closed successfully. Ref count :0 - Core 2 : Closing CPPI CPDMA Ref count : 1 - Core 3 : CPPI CPDMA closed successfully - Core 2 : CPPI CPDMA closed successfully - Core 2 : CPPI exit successful + Core 0 : L1D cache size 4. L2 cache size 0. + Core 2 : Starting BIOS... + Core 3 : Starting BIOS... + Core 0 : Starting BIOS... + Core 1 : Starting BIOS... + Core 0 : Created RM packet heap + Core 0 : Created IPC MessageQ heap + Core 0 : Created receive Q for Client1 + Core 1 : Opened RM packet heap + Core 2 : Opened RM packet heap + Core 3 : Opened RM packet heap + Core 1 : Opened IPC MessageQ heap + Core 2 : Opened IPC MessageQ heap + Core 3 : Opened IPC MessageQ heap + Core 1 : Created receive Q for Server + Core 2 : Created receive Q for Server + Core 3 : Created receive Q for Server + Core 1 : Opened Server's receive Q + Core 1 : Waiting for QMSS to be initialized... + + Core 0 : Opened Client1's receive Q for Server + Core 0 : Created receive Q for Client2 + Core 0 : Opened Client2's receive Q for Server + Core 0 : Created receive Q for Client3 + Core 2 : Opened Server's receive Q + Core 2 : Waiting for QMSS to be initialized... + + Core 0 : Opened Client3's receive Q for Server + + Core 0 : QMSS initialization done + + + Core 3 : Opened Server's receive Q + Core 1 : QMSS initialization done + Core 2 : QMSS initialization done + Core 3 : Waiting for QMSS to be initialized... + + + Core 3 : QMSS initialization done + + + Core 0 : QMSS CPDMA Opened + Core 1 : QMSS CPDMA Opened + + + Core 0 : Memory region 0 inserted + Core 0 : Number of descriptors requested : 8. Number of descriptors allocated : 8 + Core 0 : Opened Rx channel : 0 + Core 0 : Opened Tx channel : 0 + Core 0 : Queue Number : 8192 opened + Core 0 : Queue Number : 8193 opened + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b20 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b20 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b50 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b50 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853b80 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853b80 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853bb0 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853bb0 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853be0 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853be0 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c10 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c10 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c40 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c40 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@10853c70 + Receive Queue 8193 Entry Count : 1 Rx descriptor 0x@10853c70 + Core 0 : Received host descriptor from Queue 897 Sucessfully + Core 0 : Tx Channel closed successfully. Ref count :0 + Core 0 : Rx Channel closed successfully. Ref count :0 + Core 0 : Rx queue closed successfully. Ref count :0 + Core 0 : Tx queue closed successfully. Ref count :0 + Core 0 : Free queue closed successfully. Ref count :0 + Core 0 : Closing CPPI CPDMA Ref count : 3 + Core 0 : CPPI CPDMA closed successfully + Core 1 : Memory region 1 inserted + + + Core 1 : Number of descriptors requested : 8. Number of descriptors allocated : 8 + Core 2 : QMSS CPDMA Opened + Core 3 : QMSS CPDMA Opened + Core 1 : Opened Rx channel : 0 + + + Core 1 : Opened Tx channel : 0 + Core 2 : Memory region 2 inserted + Core 3 : Memory region 3 inserted + Core 1 : Queue Number : 0 opened + Core 2 : Number of descriptors requested : 8. Number of descriptors allocated : 8 + Core 3 : Number of descriptors requested : 8. Number of descriptors allocated : 8 + Core 1 : Queue Number : 1 opened + Core 2 : Opened Rx channel : 1 + Core 3 : Opened Rx channel : 2 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b20 + Core 2 : Opened Tx channel : 1 + Core 3 : Opened Tx channel : 2 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b20 + Core 2 : Queue Number : 8192 opened + Core 3 : Queue Number : 8193 opened + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b50 + Core 2 : Queue Number : 8194 opened + Core 3 : Queue Number : 8195 opened + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b50 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b20 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b20 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853b80 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b20 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b20 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853b80 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b50 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b50 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853bb0 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b50 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b50 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853bb0 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853b80 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853b80 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853be0 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853b80 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853b80 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853be0 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853bb0 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853bb0 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c10 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853bb0 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853bb0 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c10 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853be0 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853be0 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c40 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853be0 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853be0 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c40 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c10 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c10 + Transmit Queue 0 Entry Count : 1 Tx descriptor 0x@11853c70 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c10 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c10 + Receive Queue 1 Entry Count : 1 Rx descriptor 0x@11853c70 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c40 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c40 + Core 1 : Received host descriptor from Queue 896 Sucessfully + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c40 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c40 + Core 1 : Tx Channel closed successfully. Ref count :0 + Transmit Queue 8192 Entry Count : 1 Tx descriptor 0x@12853c70 + Transmit Queue 8193 Entry Count : 1 Tx descriptor 0x@13853c70 + Core 1 : Rx Channel closed successfully. Ref count :0 + Receive Queue 8194 Entry Count : 1 Rx descriptor 0x@12853c70 + Receive Queue 8195 Entry Count : 1 Rx descriptor 0x@13853c70 + Core 1 : Rx queue closed successfully. Ref count :0 + Core 2 : Received host descriptor from Queue 9026 Sucessfully + Core 3 : Received host descriptor from Queue 898 Sucessfully + Core 1 : Tx queue closed successfully. Ref count :0 + Core 2 : Tx Channel closed successfully. Ref count :0 + Core 3 : Tx Channel closed successfully. Ref count :0 + Core 1 : Free queue closed successfully. Ref count :0 + Core 2 : Rx Channel closed successfully. Ref count :0 + Core 3 : Rx Channel closed successfully. Ref count :0 + Core 1 : Closing CPPI CPDMA Ref count : 2 + Core 2 : Rx queue closed successfully. Ref count :0 + Core 3 : Rx queue closed successfully. Ref count :0 + Core 1 : CPPI CPDMA closed successfully + Core 2 : Tx queue closed successfully. Ref count :0 + Core 3 : Tx queue closed successfully. Ref count :0 + Core 2 : Free queue closed successfully. Ref count :0 + Core 3 : Free queue closed successfully. Ref count :0 + Core 2 : Closing CPPI CPDMA Ref count : 1 + Core 3 : CPPI CPDMA closed successfully + Core 2 : CPPI CPDMA closed successfully + Core 2 : CPPI exit successful ******************************************************* *************** CPPI LLD usage example Done *********** ******************************************************* - Core 1 : CPPI exit successful - Core 3 : CPPI exit successful + Core 1 : CPPI exit successful + Core 3 : CPPI exit successful ******************************************************* ******************************************************* *************** CPPI LLD usage example Done *********** *************** CPPI LLD usage example Done *********** ******************************************************* ******************************************************* - Core 0 : CPPI exit successful + Core 0 : CPPI exit successful Core 0: exit QMSS Instance name: RM_Server Handle: 0x00849ee8 @@ -282,7 +282,7 @@ This came from k2k example: Resource Status: - Core 0 : All resources freed successfully + Core 0 : All resources freed successfully ******************************************************* *************** CPPI LLD usage example Done *********** ******************************************************* diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_CSL.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_CSL.rst index 63a8df977..0b2ae7029 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_CSL.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_CSL.rst @@ -139,7 +139,7 @@ supported with the CSL library: - MMU - SPINLOCK - UART -- ECC : Limited to applicable SOC's/Boards:idkAM574x +- ECC : Limited to applicable SOC's/Boards:idkAM574x - GPMC : Limited to a15 core on idkAM572 and evmAM572x - ePWM : Duty Cycle example application - Limited to applicable SoC's/Boards: am65xx_evm, j721e_evm diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_FATFS.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_FATFS.rst index e32592715..60591e2ab 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_FATFS.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_FATFS.rst @@ -45,8 +45,8 @@ pins are required before calling any driver APIs.By default Board_Init() API supports all initialization sequence for TI supported EVMs. In addition it initializes UART instance for Console/STDIO.Refer `Processor SDK RTOS Board Support `__ -for additional details.Once board specific configuration is complete  -FATFS_init() API can be called to initialize FATFS for the driver. +for additional details.Once board specific configuration is complete +FATFS_init() API can be called to initialize FATFS for the driver. .. rubric:: **FATFS Configuration Structure** diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_GPIO.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_GPIO.rst index 1f4155577..2c8a05b04 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_GPIO.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_GPIO.rst @@ -6,7 +6,7 @@ Overview Introduction ^^^^^^^^^^^^ -GPIO module allows application to manage General Purpose I/O  instances +GPIO module allows application to manage General Purpose I/O instances and pins via simple portable APIs. Because of its simplicity, APIs are pin based and does not follow model of other drivers inside PDK which requires handle abstraction. @@ -61,7 +61,7 @@ API reference for Application: #include Below sequence indicates API calling sequence for a simple use case of -LED toggling +LED toggling .. code-block:: c @@ -92,35 +92,35 @@ Refer SDK Release Note for GPIO support across different EVMs. | | Toggling | being used. | AM571x, | | | | | | AM572x, | | | | || **AM335x | AM574x, | | -| | | ICEv2**:        | k2g, | | -| | | USER  LED 1 | k2hk, | | +| | | ICEv2**: | k2g, | | +| | | USER LED 1 | k2hk, | | | | | | k2l, | | | | || **AM437x | k2e, | | -| | | EVM**:          | c6657, | | -| | | USER  LED 1 | c6678, | | +| | | EVM**: | c6657, | | +| | | USER LED 1 | c6678, | | | | | | omapl137, | | -| | || **AM572x IDK** :  | | | +| | || **AM572x IDK** : | | | | | | STATUS LED 1 Yellow +---------------------+---------------------+ | | | **AM572x GP | am65xx | makefile | -| | | EVM** : USER LED1 | j721e | | -| | | **AM574x IDK** :  | | | +| | | EVM** : USER LED1 | j721e | | +| | | **AM574x IDK** : | | | | | | STATUS LED 1 Yellow | | | | | | **AM572x GP | | | -| | | EVM** : USER LED1 | | | -| | | **AM571x IDK** :  | | | +| | | EVM** : USER LED1 | | | +| | | **AM571x IDK** : | | | | | | Industrial LED 3 | | | | | | Red | | | | | | | | | -| | || **K2H EVM:**         | | | +| | || **K2H EVM:** | | | | | | USER LED 2 Blue | | | | | | | | | -| | || **K2E EVM:**         | | | +| | || **K2E EVM:** | | | | | | USER LED 1 Blue | | | | | | | | | -| | || **K2G EVM:**         | | | +| | || **K2G EVM:** | | | | | | USER LED 1 Yellow | | | | | | | | | -| | || **AM65xx EVM:**      | | | +| | || **AM65xx EVM:** | | | | | | USER LD16, LD17 | | | | | | | | | | | || **J721E EVM:** | | | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_GPMC.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_GPMC.rst index b4c29c6fc..916bb953d 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_GPMC.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_GPMC.rst @@ -76,7 +76,7 @@ API reference for application: #include - Sample code for initiating GPMC transaction: + Sample code for initiating GPMC transaction: .. code-block:: c @@ -93,7 +93,7 @@ API reference for application: transferOK = GPMC_transfer(gpmc, &gpmcTransaction); if (!transferOK) { /* GPMC transaction failed */ - }  + } Application ------------ @@ -123,7 +123,7 @@ Refer Release Note for GPMC support across different EVMs | | | All tests have | | | | passed. | +-----------------------+-----------------------+-----------------------+ -| GPMC NOR/NAND test | | Driver Unit Test | Following prints will | +| GPMC NOR/NAND test | | Driver Unit Test | Following prints will | | application | application to test | come on console based | | | GPMC NOR/NAND flash | on pass/fail | | | read/erase/write | criteria: | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_I2C.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_I2C.rst index 1ca0261df..6271c93f4 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_I2C.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_I2C.rst @@ -87,7 +87,7 @@ API reference for application: #include - Sample code for initiating I2C transaction: + Sample code for initiating I2C transaction: :: @@ -109,9 +109,9 @@ API reference for application: ... ... transferOK = I2C_transfer(i2c, &i2cTransaction); - if (transferOK != I2C_STS_SUCCESS) { + if (transferOK != I2C_STS_SUCCESS) { /* I2C transaction failed */ - }  + } Application ------------ @@ -135,7 +135,7 @@ Refer Release Note for I2C support across different EVMs | | | All tests have | omapl137, | | | | | passed. | | | +-----------------------+-----------------------+-----------------------+---------------------+---------------------+ -| I2C_TestApplication || Driver Unit Test || Following prints will| AM335x, | CCS project | +| I2C_TestApplication || Driver Unit Test || Following prints will| AM335x, | CCS project | | | application for | come on console based| AM437x, | | | | additional I2C | on pass/fail | AM571x, | | | | speed and other tests | criteria: | AM572x, | | @@ -154,7 +154,7 @@ Refer Release Note for I2C support across different EVMs | | || All tests have | | | | | | passed. | | | +-----------------------+-----------------------+-----------------------+---------------------+---------------------+ -| I2C_SMP_Test || Driver Unit Test || Following prints will| am572x-evm | CCS project | +| I2C_SMP_Test || Driver Unit Test || Following prints will| am572x-evm | CCS project | | Application | application for | come on console based| | | | | additional I2C | on pass/fail | | | | | speed and other tests | criteria: | | | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_ICSS_EMAC_LLD_FW.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_ICSS_EMAC_LLD_FW.rst index 12932090b..d4b5112df 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_ICSS_EMAC_LLD_FW.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_ICSS_EMAC_LLD_FW.rst @@ -56,7 +56,7 @@ Driver Configuration for TI supported EVMs. In addition it initializes UART instance for Console/STDIO.Refer `Processor SDK RTOS Board Support `__ for - additional details.Once board specific configuration is complete  + additional details.Once board specific configuration is complete driver APIS can be invoked. | @@ -162,7 +162,7 @@ different EVMs. | ICSS_EMAC_Basic | EMAC Loopback | 10/100 Mb/s | Unit Test will | | Example | test at | loopback cable | print ^All | | | PRU-ICSS | | tests have | -| | EMAC PHY. | | passed^ via | +| | EMAC PHY. | | passed^ via | | | | | UART console. | | | | Example | | | | | demonstrates | | | @@ -206,7 +206,7 @@ different EVMs. | ICSS_EMAC_Switc | Switch Loopback | 100 Mb/s | Unit Test will | | hExample | test at | loopback cable | print ^All | | | PRU-ICSS | | tests have | -| | EMAC PHY. | | passed^ via | +| | EMAC PHY. | | passed^ via | | | | | UART console. | | | | Example | | | | | demonstrates | | | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_IOLINK.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_IOLINK.rst index 39933b57a..367bafdee 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_IOLINK.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_IOLINK.rst @@ -79,7 +79,7 @@ API reference for application: #include - Sample code for IOLINK control operation: + Sample code for IOLINK control operation: :: diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_MMCSD.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_MMCSD.rst index 4560c904a..2a7c3d9ed 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_MMCSD.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_MMCSD.rst @@ -16,14 +16,14 @@ to/from the CPU device through two-wire interface | Type of transfers - -  Read - -  Write - -  Write followed by read + - Read + - Write + - Write followed by read | Operating modes - -  Blocking(interrupt or Non interrupt) - -  Callback mode(interrupt) + - Blocking(interrupt or Non interrupt) + - Callback mode(interrupt) | Supports only controller mode. Peripheral mode is not supported @@ -44,14 +44,14 @@ Board_Init() API supports all initialization sequence for TI supported EVMs. In addition it initializes UART instance for Console/STDIO.Refer `Processor SDK RTOS Board Support `__ for -additional details.Once board specific configuration is complete  -MMCSD_init() API can be called to initialize driver. +additional details.Once board specific configuration is complete +MMCSD_init() API can be called to initialize driver. .. rubric:: **MMCSD Configuration Structure** :name: mmcsd-configuration-structure The MMCSD_soc.c file binds driver with hardware attributes on the -board through MMCSD_config structure. This structure must be  +board through MMCSD_config structure. This structure must be initialized before the MMCSD_init() function is called and cannot be changed afterwards. For details about the individual fields of this structure, see the Doxygen help by opening diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_PCIe.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_PCIe.rst index e9f57d107..0e1f5e850 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_PCIe.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_PCIe.rst @@ -114,7 +114,7 @@ Examples +=================+=================+=================+=================+ | PCIE_idkAM57[1\ | 2-device PCIe | **IMPORTANT:** | **AM572x/AM574x | | 24]x*ExamplePr\ | connection | Cable must be | or AM571x | -| oject | | `MODIFIED`_ | EVM** : One | +| oject | | `MODIFIED`_ | EVM** : One | | | | in order to | board is | | | | avoid damaging | EP/other is RC; | | | | the clock | link is | @@ -191,7 +191,7 @@ Examples | | | ti/binary. | | | | | | | +-----------------+-----------------+-----------------+-----------------+ -| PCIE_evmK2G*Ex\ | 2-device PCIe | **IMPORTANT:** | **K2G EVM** : | +| PCIE_evmK2G*Ex\ | 2-device PCIe | **IMPORTANT:** | **K2G EVM** : | | ampleProject | connection | Cable must be | One board is | | | | `MODIFIED`_ | EP/other is RC; | | | | in order to | link is | @@ -203,7 +203,7 @@ Examples | | | | console. | | | | | | | | | Connect two | | -| | | K2G  EVMs J5 | | +| | | K2G EVMs J5 | | | | | using a | | | | | `MODIFIED`_ | | | | | male-male | | @@ -239,7 +239,7 @@ Examples +-----------------+-----------------+-----------------+-----------------+ | PCIE_idkAM571x\ | Packet Exchange | **IMPORTANT:** | **AM571X | | _*armEdmaPktEx\ | over PCIe | Cable must be | >=REV1.3A | -| ampleProject | Benchmark | `MODIFIED`_ | IDK** : One | +| ampleProject | Benchmark | `MODIFIED`_ | IDK** : One | | *(Available | | in order to | board is | | starting in | | avoid damaging | EP/other is RC; | | Processor-SDK | | the clock | link is | @@ -253,7 +253,7 @@ Examples | | | Connect two | except EP also | | | | like | prints packet | | | | >=REV1.3A | exchange | -| | | AM571x  IDK | benchmark | +| | | AM571x IDK | benchmark | | | | EVMs J22 | results. | | | | using a | | | | | `MODIFIED`_ | | @@ -275,7 +275,7 @@ Examples +-----------------+-----------------+-----------------+-----------------+ | Remaining | 2-device PCIe | Connect two | **6678, 6657, | | PCIE_*ExampleP\ | connection | like C66x/K2x | K2E, K2H, | -| roject | | (except K2G, | K2L** : One | +| roject | | (except K2G, | K2L** : One | | | | see previous | board is | | | | row) EVMs using | EP/other is RC; | | | | an AMC breakout | link is | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_PRUSS.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_PRUSS.rst index 99d159cfa..aa907dfe2 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_PRUSS.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_PRUSS.rst @@ -8,7 +8,7 @@ Introduction | The PRUSS (Programmable Real-Time Unit Subsystem) provides a well-defined API layer which allows applications to use the PRUSS low - level driver to control  sub system. + level driver to control sub system. | @@ -119,9 +119,9 @@ Examples | | count.Application | | | | is to test PRU’s || Prints related to | | | load, control and | sending and | -| | Interrupt | receiving  event from | +| | Interrupt | receiving event from | | | controller | PRU will be printed | -| | functionalities. | on  console. Test | +| | functionalities. | on console. Test | | | | program at the end | | | | expected to output: | | | | "All tests have | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_QMSS.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_QMSS.rst index bfaeded75..884974e0a 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_QMSS.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_QMSS.rst @@ -108,207 +108,207 @@ This came from K2K multicore example: ************ QMSS Multicore Example ************** ************************************************** ************************************************** - Core 1 : Starting BIOS... - Core 2 : Starting BIOS... - Core 3 : Starting BIOS... - Core 0 : Starting BIOS... - Core 0 : Created RM packet heap - Core 0 : Created IPC MessageQ heap - Core 0 : Created receive Q for Client1 - Core 1 : Opened RM packet heap - Core 2 : Opened RM packet heap - Core 3 : Opened RM packet heap - Core 1 : Opened IPC MessageQ heap - Core 2 : Opened IPC MessageQ heap - Core 3 : Opened IPC MessageQ heap - Core 1 : Created receive Q for Server - Core 2 : Created receive Q for Server - Core 3 : Created receive Q for Server - Core 1 : Opened Server's receive Q - Core 1 : Waiting for QMSS to be initialized... - - Core 0 : Opened Client1's receive Q for Server - Core 0 : Created receive Q for Client2 - Core 0 : Opened Client2's receive Q for Server - Core 0 : Created receive Q for Client3 - Core 2 : Opened Server's receive Q - Core 2 : Waiting for QMSS to be initialized... - - Core 0 : Opened Client3's receive Q for Server + Core 1 : Starting BIOS... + Core 2 : Starting BIOS... + Core 3 : Starting BIOS... + Core 0 : Starting BIOS... + Core 0 : Created RM packet heap + Core 0 : Created IPC MessageQ heap + Core 0 : Created receive Q for Client1 + Core 1 : Opened RM packet heap + Core 2 : Opened RM packet heap + Core 3 : Opened RM packet heap + Core 1 : Opened IPC MessageQ heap + Core 2 : Opened IPC MessageQ heap + Core 3 : Opened IPC MessageQ heap + Core 1 : Created receive Q for Server + Core 2 : Created receive Q for Server + Core 3 : Created receive Q for Server + Core 1 : Opened Server's receive Q + Core 1 : Waiting for QMSS to be initialized... + + Core 0 : Opened Client1's receive Q for Server + Core 0 : Created receive Q for Client2 + Core 0 : Opened Client2's receive Q for Server + Core 0 : Created receive Q for Client3 + Core 2 : Opened Server's receive Q + Core 2 : Waiting for QMSS to be initialized... + + Core 0 : Opened Client3's receive Q for Server -----------------------Initializing--------------------------- - Core 0 : L1D cache size 4. L2 cache size 0. - Core 0 : Memory region 0 inserted - Core 0 : Memory region 1 inserted - Core 0 : Tx Completion Queue Number  : 897 opened - Core 0 : Number of Tx descriptors requested : 32. Number of descriptors allocated : 32 - Core 0 : Number of Rx descriptors requested : 32. Number of descriptors allocated : 32 - Core 0 : Number of Sync free descriptors requested : 32. Number of descriptors allocated : 32 - Core 0 : Sync Queue Number  : 9025 opened - Core 0 : Sync Cfg Queue Number  : 9026 opened - Core 0 : Sync Free Queue Number  : 898 opened - Core 0 : Receive Free Queue Number  : 736 opened - Core 0 : Transmit Free Queue Number  : 8928 opened - Core 0 : System initialization completed: 8928 - Core 0 : Publishing RM nameserver names for shared queues + Core 0 : L1D cache size 4. L2 cache size 0. + Core 0 : Memory region 0 inserted + Core 0 : Memory region 1 inserted + Core 0 : Tx Completion Queue Number : 897 opened + Core 0 : Number of Tx descriptors requested : 32. Number of descriptors allocated : 32 + Core 0 : Number of Rx descriptors requested : 32. Number of descriptors allocated : 32 + Core 0 : Number of Sync free descriptors requested : 32. Number of descriptors allocated : 32 + Core 0 : Sync Queue Number : 9025 opened + Core 0 : Sync Cfg Queue Number : 9026 opened + Core 0 : Sync Free Queue Number : 898 opened + Core 0 : Receive Free Queue Number : 736 opened + Core 0 : Transmit Free Queue Number : 8928 opened + Core 0 : System initialization completed: 8928 + Core 0 : Publishing RM nameserver names for shared queues --------------------Queue status CORE 0---------------------- After Initialization - Tx Free Queue 8928 Entry Count  : 32 - Rx Free Queue 736 Entry Count  : 32 - Tx completion Queue 897 Entry Count  : 0 - Sync Queue 9025 Entry Count  : 0 - Sync free Queue 898 Entry Count  : 32 - Sync Cfg Queue 9026 Entry Count  : 0 + Tx Free Queue 8928 Entry Count : 32 + Rx Free Queue 736 Entry Count : 32 + Tx completion Queue 897 Entry Count : 0 + Sync Queue 9025 Entry Count : 0 + Sync free Queue 898 Entry Count : 32 + Sync Cfg Queue 9026 Entry Count : 0 ------------------------------------------------------------- - Core 0 : Registering High Priority interrupt channel : 0 eventId : 48 queue Number : 704 - - - Core 3 : Opened Server's receive Q - Core 1 : QMSS initialization done. - Core 2 : QMSS initialization done. - Core 3 : Waiting for QMSS to be initialized... - - - - - Core 3 : QMSS initialization done. - - Core 1 : Rx Free Queue Number  : 736 opened - Core 2 : Rx Free Queue Number  : 736 opened - Core 3 : Rx Free Queue Number  : 736 opened - Core 1 : Tx Free Queue Number  : 8928 opened - Core 2 : Tx Free Queue Number  : 8928 opened - Core 3 : Tx Free Queue Number  : 8928 opened - Core 1 : Tx Completion Queue Number : 897 opened - Core 2 : Tx Completion Queue Number : 897 opened - Core 3 : Tx Completion Queue Number : 897 opened - Core 1 : Sync Queue Number  : 9025 opened - Core 2 : Sync Queue Number  : 9025 opened - Core 3 : Sync Queue Number  : 9025 opened - Core 1 : Sync Free Queue Number  : 898 opened - Core 2 : Sync Free Queue Number  : 898 opened - Core 3 : Sync Free Queue Number  : 898 opened - Core 1 : Sync Cfg Queue Number  : 9026 opened - Core 2 : Sync Cfg Queue Number  : 9026 opened - Core 3 : Sync Cfg Queue Number  : 9026 opened - Core 1 : Registering High Priority interrupt channel : 1 eventId : 48 queue Number : 705 - Core 2 : Registering High Priority interrupt channel : 2 eventId : 48 queue Number : 706 - Core 3 : Registering High Priority interrupt channel : 3 eventId : 48 queue Number : 707 - Core 1 : Waiting for sync signal - Core 2 : Waiting for sync signal - Core 3 : Waiting for sync signal - Core 0 : Opened Tx channel  : 0 - Core 0 : Opened Rx channel  : 0 - Core 0 : Transmit Queue Number  : 800 - Core 0 : Receive Queue Number  : 704 - Core 0 : Opened Rx flow  : 0 - Core 0 : High priority accumulator programmed for channel : 0 queue : 704 - - Core 0 : Transmitting 8 packets.......... + Core 0 : Registering High Priority interrupt channel : 0 eventId : 48 queue Number : 704 + + + Core 3 : Opened Server's receive Q + Core 1 : QMSS initialization done. + Core 2 : QMSS initialization done. + Core 3 : Waiting for QMSS to be initialized... + + + + + Core 3 : QMSS initialization done. + + Core 1 : Rx Free Queue Number : 736 opened + Core 2 : Rx Free Queue Number : 736 opened + Core 3 : Rx Free Queue Number : 736 opened + Core 1 : Tx Free Queue Number : 8928 opened + Core 2 : Tx Free Queue Number : 8928 opened + Core 3 : Tx Free Queue Number : 8928 opened + Core 1 : Tx Completion Queue Number : 897 opened + Core 2 : Tx Completion Queue Number : 897 opened + Core 3 : Tx Completion Queue Number : 897 opened + Core 1 : Sync Queue Number : 9025 opened + Core 2 : Sync Queue Number : 9025 opened + Core 3 : Sync Queue Number : 9025 opened + Core 1 : Sync Free Queue Number : 898 opened + Core 2 : Sync Free Queue Number : 898 opened + Core 3 : Sync Free Queue Number : 898 opened + Core 1 : Sync Cfg Queue Number : 9026 opened + Core 2 : Sync Cfg Queue Number : 9026 opened + Core 3 : Sync Cfg Queue Number : 9026 opened + Core 1 : Registering High Priority interrupt channel : 1 eventId : 48 queue Number : 705 + Core 2 : Registering High Priority interrupt channel : 2 eventId : 48 queue Number : 706 + Core 3 : Registering High Priority interrupt channel : 3 eventId : 48 queue Number : 707 + Core 1 : Waiting for sync signal + Core 2 : Waiting for sync signal + Core 3 : Waiting for sync signal + Core 0 : Opened Tx channel : 0 + Core 0 : Opened Rx channel : 0 + Core 0 : Transmit Queue Number : 800 + Core 0 : Receive Queue Number : 704 + Core 0 : Opened Rx flow : 0 + Core 0 : High priority accumulator programmed for channel : 0 queue : 704 + + Core 0 : Transmitting 8 packets.......... ************************************************************* - Core 0 : Opened Tx channel  : 0 - Core 0 : Opened Rx channel  : 0 - Core 0 : Transmit Queue Number  : 800 - Core 0 : Receive Queue Number  : 705 - Core 0 : Opened Rx flow  : 0 - Core 0 : High priority accumulator programmed for channel : 1 queue : 705 + Core 0 : Opened Tx channel : 0 + Core 0 : Opened Rx channel : 0 + Core 0 : Transmit Queue Number : 800 + Core 0 : Receive Queue Number : 705 + Core 0 : Opened Rx flow : 0 + Core 0 : High priority accumulator programmed for channel : 1 queue : 705 - Core 0 : Transmitting 8 packets.......... + Core 0 : Transmitting 8 packets.......... ************************************************************* - Core 0 : Opened Tx channel  : 0 - Core 0 : Opened Rx channel  : 0 - Core 0 : Transmit Queue Number  : 800 - Core 0 : Receive Queue Number  : 706 - Core 0 : Opened Rx flow  : 0 - Core 0 : High priority accumulator programmed for channel : 2 queue : 706 + Core 0 : Opened Tx channel : 0 + Core 0 : Opened Rx channel : 0 + Core 0 : Transmit Queue Number : 800 + Core 0 : Receive Queue Number : 706 + Core 0 : Opened Rx flow : 0 + Core 0 : High priority accumulator programmed for channel : 2 queue : 706 - Core 0 : Transmitting 8 packets.......... + Core 0 : Transmitting 8 packets.......... ************************************************************* - Core 0 : Opened Tx channel  : 0 - Core 0 : Opened Rx channel  : 0 - Core 0 : Transmit Queue Number  : 800 - Core 0 : Receive Queue Number  : 707 - Core 0 : Opened Rx flow  : 0 - Core 0 : High priority accumulator programmed for channel : 3 queue : 707 + Core 0 : Opened Tx channel : 0 + Core 0 : Opened Rx channel : 0 + Core 0 : Transmit Queue Number : 800 + Core 0 : Receive Queue Number : 707 + Core 0 : Opened Rx flow : 0 + Core 0 : High priority accumulator programmed for channel : 3 queue : 707 - Core 0 : Transmitting 8 packets.......... + Core 0 : Transmitting 8 packets.......... ************************************************************* - Core 0 : Waiting for sync signal - Core 0 : Got sync signal + Core 0 : Waiting for sync signal + Core 0 : Got sync signal ************************************************************* --------------------Queue status CORE 0---------------------- After packet processing - Tx Free Queue 8928 Entry Count  : 0 - Rx Free Queue 736 Entry Count  : 32 - Tx completion Queue 897 Entry Count  : 32 - Sync Queue 9025 Entry Count  : 4 - Sync free Queue 898 Entry Count  : 27 - Sync Cfg Queue 9026 Entry Count  : 1 + Tx Free Queue 8928 Entry Count : 0 + Rx Free Queue 736 Entry Count : 32 + Tx completion Queue 897 Entry Count : 32 + Sync Queue 9025 Entry Count : 4 + Sync free Queue 898 Entry Count : 27 + Sync Cfg Queue 9026 Entry Count : 1 ------------------------------------------------------------- - Core 0 : Waiting for other cores to ack sync signal - Core 1 : Got sync signal - Core 2 : Got sync signal - Core 3 : Got sync signal + Core 0 : Waiting for other cores to ack sync signal + Core 1 : Got sync signal + Core 2 : Got sync signal + Core 3 : Got sync signal ************************************************************* ************************************************************* ************************************************************* - Core 0 : acks found + Core 0 : acks found --------------------Deinitializing--------------------------- --------------------Queue status CORE 0---------------------- Before exit - Tx Free Queue 8928 Entry Count  : 0 - Rx Free Queue 736 Entry Count  : 32 - Tx completion Queue 897 Entry Count  : 32 - Sync Queue 9025 Entry Count  : 0 - Sync free Queue 898 Entry Count  : 28 - Sync Cfg Queue 9026 Entry Count  : 4 + Tx Free Queue 8928 Entry Count : 0 + Rx Free Queue 736 Entry Count : 32 + Tx completion Queue 897 Entry Count : 32 + Sync Queue 9025 Entry Count : 0 + Sync free Queue 898 Entry Count : 28 + Sync Cfg Queue 9026 Entry Count : 4 ------------------------------------------------------------- - Core 0 : Receive free queue closed successfully. Ref count : 0 - Core 0 : Transmit completion queue closed successfully. Ref count : 3 - Core 0 : Transmit free queue closed successfully. Ref count : 3 - Core 0 : Sync queue closed successfully. Ref count : 3 - Core 0 : Sync free queue closed successfully. Ref count : 3 - Core 0 : Sync queue closed successfully. Ref count : 3 - Core 0 : CPPI CPDMA closed successfully - Core 0 : CPPI exit successful + Core 0 : Receive free queue closed successfully. Ref count : 0 + Core 0 : Transmit completion queue closed successfully. Ref count : 3 + Core 0 : Transmit free queue closed successfully. Ref count : 3 + Core 0 : Sync queue closed successfully. Ref count : 3 + Core 0 : Sync free queue closed successfully. Ref count : 3 + Core 0 : Sync queue closed successfully. Ref count : 3 + Core 0 : CPPI CPDMA closed successfully + Core 0 : CPPI exit successful Core 0: Cleaning regions Core 0: exit QMSS - Core 1 : Receive free queue closed successfully. Ref count : 3 - Core 2 : Receive free queue closed successfully. Ref count : 2 - Core 3 : Receive free queue closed successfully. Ref count : 1 - Core 1 : Transmit completion queue closed successfully. Ref count : 2 - Core 2 : Transmit completion queue closed successfully. Ref count : 1 - Core 3 : Transmit completion queue closed successfully. Ref count : 0 - Core 1 : Transmit free queue closed successfully. Ref count : 2 - Core 2 : Transmit free queue closed successfully. Ref count : 1 - Core 3 : Transmit free queue closed successfully. Ref count : 0 - Core 1 : Sync queue closed successfully. Ref count : 2 - Core 2 : Sync queue closed successfully. Ref count : 1 - Core 3 : Sync queue closed successfully. Ref count : 0 - Core 1 : Sync free queue closed successfully. Ref count : 2 - Core 2 : Sync free queue closed successfully. Ref count : 1 - Core 3 : Sync free queue closed successfully. Ref count : 0 - Core 1 : Sync queue closed successfully. Ref count : 2 - Core 2 : Sync queue closed successfully. Ref count : 1 - Core 3 : Sync queue closed successfully. Ref count : 0 + Core 1 : Receive free queue closed successfully. Ref count : 3 + Core 2 : Receive free queue closed successfully. Ref count : 2 + Core 3 : Receive free queue closed successfully. Ref count : 1 + Core 1 : Transmit completion queue closed successfully. Ref count : 2 + Core 2 : Transmit completion queue closed successfully. Ref count : 1 + Core 3 : Transmit completion queue closed successfully. Ref count : 0 + Core 1 : Transmit free queue closed successfully. Ref count : 2 + Core 2 : Transmit free queue closed successfully. Ref count : 1 + Core 3 : Transmit free queue closed successfully. Ref count : 0 + Core 1 : Sync queue closed successfully. Ref count : 2 + Core 2 : Sync queue closed successfully. Ref count : 1 + Core 3 : Sync queue closed successfully. Ref count : 0 + Core 1 : Sync free queue closed successfully. Ref count : 2 + Core 2 : Sync free queue closed successfully. Ref count : 1 + Core 3 : Sync free queue closed successfully. Ref count : 0 + Core 1 : Sync queue closed successfully. Ref count : 2 + Core 2 : Sync queue closed successfully. Ref count : 1 + Core 3 : Sync queue closed successfully. Ref count : 0 ******************************************************* ******************************************************* ******************************************************* @@ -318,14 +318,14 @@ This came from K2K multicore example: ******************************************************* ******************************************************* ******************************************************* - Core 0 : Deleting RM nameserver names for shared queues + Core 0 : Deleting RM nameserver names for shared queues Instance name: RM_Server Handle: 0x00854578 Type: Server Resource Status: - Core 0 : All resources freed successfully + Core 0 : All resources freed successfully ******************************************************* ******** QMSS Multicore (0) Example Done (PASS) ******* ******************************************************* diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_QSPI_McSPI.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_QSPI_McSPI.rst index a9e8d2ed8..de4a084ba 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_QSPI_McSPI.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_QSPI_McSPI.rst @@ -38,7 +38,7 @@ API supports all initialization sequence for TI supported EVMs. In addition it initializes UART instance for Console/STDIO.Refer `Processor SDK RTOS Board Support `__ for additional details.Once board specific configuration is -complete \ *SPI_init()* API should be called to initialize driver. +complete \ *SPI_init()* API should be called to initialize driver. SoC Specific Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -47,7 +47,7 @@ All SoC specific configurations (eg: SPI module registers base address, interrupt configurations, etc.) can be set using SPI_socSetInitCfg() SoC driver API before calling any SPI driver APIs. The default SoC specific configurations can be retrieved using SPI_socGetInitCfg() SoC driver -API.  +API. SPI Configuration Structure ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -59,9 +59,9 @@ called and cannot be changed afterwards. For details about individual fields of this structure, see Doxygen help by opening *PDK_INSTALL_DIR\packages\ti\drv\spi\docs\doxygen\html\index.html.* -Driver  requires common *SPI_config[]*  to configure hardware attributes -of MCSPI and QSPI/OSPI peripherals on SOC and board. First all MCSPI related -hardware attributes is defined followed by QSPI/OSPI hardware attributes. +Driver requires common *SPI_config[]* to configure hardware attributes +of MCSPI and QSPI/OSPI peripherals on SOC and board. First all MCSPI related +hardware attributes is defined followed by QSPI/OSPI hardware attributes. Application will need to include appropriate offset to instance while invoking *SPI_open()* API.. @@ -111,7 +111,7 @@ SPI IP V1 driver also supports multi-channel open API's: | At this point SPI driver is ready for data transfer in blocking mode on specific instance identified by handle. Pseudo/Sample code for -SPI read/write transaction is included below. Refer example for +SPI read/write transaction is included below. Refer example for additional details :: @@ -159,7 +159,7 @@ SPI | Example application | and write of data | **Pass criteria:** | k2l, | | | | to a NOR flash | | k2e, | | | | device connected | All tests have | c6657, | | -| | over SPI interface. | passed. | c6678, | | +| | over SPI interface. | passed. | c6678, | | | | By default, write | | omapl137, | | | | test is disabled, | | | | | | user can enable | | | | @@ -171,8 +171,8 @@ SPI | | | | | | | | If write test is | | | | | | enabled, write | | | | -| | transaction is  | | | | -| | verified  | | | | +| | transaction is | | | | +| | verified | | | | | | for correctness by | | | | | | reading contents | | | | | | back. | | | | @@ -226,7 +226,7 @@ QSPI | | connected over QSPI | All tests have | k2g, | | | | interface. Write | passed. | | | | | transaction is | | | | -| | verified  for | | | | +| | verified for | | | | | | correctness by | | | | | | reading contents | | | | | | back. | | | | @@ -272,43 +272,43 @@ MCSPI | | | Configuration | Results | | | +=================+=================+===========================================+=====================+================+===================+ | MCSPI_Serialize | Sample | **AM57x IDK EVM:** | | | AM335x, | CCS project | -| r | Application | | | ** **   | AM437x, | | +| r | Application | | | ** ** | AM437x, | | | Example | demonstrating | | | AM571x, | | | application | reading data | Short pins 1 and 2 on header | Following | AM572x, | | -| | generated from | J37(Industrial I/O) | prints  on | AM574x, | | +| | generated from | J37(Industrial I/O) | prints on | AM574x, | | | | industrial | | console | | | -| | input module.  | **AM335x ICE v2:** | expected: | | | +| | input module. | **AM335x ICE v2:** | expected: | | | | | Application | Short pins 1 and 2 on header | | | | | | uses GPIO pins | J14(Industrial I/O) | **Pass | | | | | to assert load | | criteria:** | | | | | signal in order | **AM437x IDK EVM:** | | | | | | to generate | Short pins 1 and 2 on | All tests have | | | -| | date from | header J1(Industrial I/O)  | passed. | | | +| | date from | header J1(Industrial I/O) | passed. | | | | | industrial | | | | | | | input module. | | | | | +-----------------+-----------------+-------------------------------------------+---------------------+----------------+-------------------+ | MCSPI_Dma_Seria | Sample | **AM57x IDK EVM:** | | | AM437x, | CCS project | -| lizer | Application | Short pins 1 and 2 on header | | ** **   | AM571x, | | +| lizer | Application | Short pins 1 and 2 on header | | ** ** | AM571x, | | | Example | demonstrating | J37(Industrial I/O) | | AM572x, | | | application | reading data | | | Following | AM574x, | | -| | generated from | **AM437x IDK EVM:** | prints  on | | | +| | generated from | **AM437x IDK EVM:** | prints on | | | | | industrial | Short pins 1 and 2 on header | console | | | | | input module | J1(Industrial I/O) | expected: | | | -| | through EDMA.  | | | | | +| | through EDMA. | | | | | | | Application | | **Pass | | | | | uses GPIO pins | | criteria:** | | | | | to assert load | | | | | | | signal in order | | All tests have | | | -| | to generate |   | passed. | | | +| | to generate | | passed. | | | | | date from | | | | | | | industrial | | | | | | | input module. | | | | | +-----------------+-----------------+-------------------------------------------+---------------------+----------------+-------------------+ | MCSPI_SerialFla | Sample | **AM335x GP EVM:** | | | AM335x, | CCS project | -| sh | Application | Set the EVM in profile 2 | | ** **   | | | +| sh | Application | Set the EVM in profile 2 | | ** ** | | | | | demonstrating | (SW8[1] = OFF, | | | | | | writing and | SW8[2] = ON, | Following | | | -| | reading data | SW8[3:4] = OFF) | prints  on | | | +| | reading data | SW8[3:4] = OFF) | prints on | | | | | from the serial | | console | | | | | flash through | | expected: | | | | | MCSPI EDMA | | | | | @@ -319,7 +319,7 @@ MCSPI | | | | passed. | | | +-----------------+-----------------+-------------------------------------------+---------------------+----------------+-------------------+ | MCSPI_periphera | Application | **Pin Connections:** | | **On | AM335x, | CCS project | -| lmode example | demonstrates | | peripheral  | AM437x, | | +| lmode example | demonstrates | | peripheral | AM437x, | | | application | peripheral | | EVM console: | AM571x, | | | | reciever and | | **IDK AM571x,** | **\ SPI | AM572x, | | | | transmit | | **IDK AM572x or IDK AM574x:** | initialized | AM574x, | | @@ -329,7 +329,7 @@ MCSPI | | case requires | | J21-Pin28(MOSI)---J21-Pin26(MOSI) | | am65xx, | makefile | | | two EVMs. One | | J21-Pin30(CS)------J21-Pin30(CS) | | j721e | | | | acts as | | J21-Pin22(DGND)--J21-Pin22(DGND) | | **On Controller | | | -| | Controller | | | EVM console: | | | +| | Controller | | | EVM console: | | | | | and Another as | | **IDK AM437x:** | | | | | | peripheral. | | EVM1(controller) ==== EVM2(peripheral) | initialized | | | | | McSPI | | J16-Pin24(CLK)-----J16-Pin24(CLK) | | Controller: PASS: | | | @@ -417,12 +417,12 @@ MCSPI | | on MCU1_0 core | | | | | +-----------------+-----------------+-------------------------------------------+---------------------+----------------+-------------------+ | MCSPI_SMP_Basic | Sample | | | | AM572x-EVM | CCS project | -| Example | Application | | | ** **   | | | +| Example | Application | | | ** ** | | | | application | demonstrating | | | | | | | reading data | | Following | | | -| | generated from | | prints  on | | | +| | generated from | | prints on | | | | | industrial | | console | | | -| | input module.  | | expected: | | | +| | input module. | | expected: | | | | | Application | | | | | | | uses GPIO pins | | **Pass | | | | | to assert load | | criteria:** | | | diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_Serdes_Diag.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_Serdes_Diag.rst index 20a9ee298..d571424cd 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_Serdes_Diag.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_Serdes_Diag.rst @@ -51,7 +51,7 @@ API reference for application: #include - Sample code for initiating Serdes Diag transaction: + Sample code for initiating Serdes Diag transaction: :: diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_UART.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_UART.rst index aede27ed5..34cedd888 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_UART.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_UART.rst @@ -40,8 +40,8 @@ pins are required before calling any driver APIs.By default Board_Init() API supports all initialization sequence for TI supported EVMs. In addition it initializes UART instance for Console/STDIO.Refer `Processor SDK RTOS Board Support `__ -for additional details.Once board specific configuration is complete  -UART_init() API can be called to initialize driver. +for additional details.Once board specific configuration is complete +UART_init() API can be called to initialize driver. .. rubric:: **UART Configuration Structure** :name: uart-configuration-structure @@ -159,7 +159,7 @@ operation ... UART_writePolling(handle, bufferPrompt, sizeof(bufferPrompt));/* Write Polling API */ -.. rubric:: DMA Usage : +.. rubric:: DMA Usage : :name: dma-usage UART driver supports DMA operations to transfer data between diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst index 714eb296b..cc6406263 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst @@ -15,7 +15,7 @@ class protocols: - USB device Audio Class - USB generic bulk device class -In rest of the page AM437x EVM is being refered as an example. Please +In rest of the page AM437x EVM is being refered as an example. Please check Release Notes for list of supported EVMs for driver. .. rubric:: Modes of Operation diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_VPS_Drivers.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_VPS_Drivers.rst index d43503607..0a2782175 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_VPS_Drivers.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_VPS_Drivers.rst @@ -171,9 +171,9 @@ Building VPS examples pdksetupenv.sh(bat) file. - cd /packages - pdksetupenv.bat (sh) -- make vps  : to build vps examples under **/ti/packages/binary** +- make vps : to build vps examples under **/ti/packages/binary** folder -- make vps_clean : to clean the vps and vps examples. +- make vps_clean : to clean the vps and vps examples. VPS examples ------------ diff --git a/source/rtos/PDK_Platform_Software/IPC/_IPC_3.x_FAQ.rst b/source/rtos/PDK_Platform_Software/IPC/_IPC_3.x_FAQ.rst index 713078ba6..ba427b0fd 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_IPC_3.x_FAQ.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_IPC_3.x_FAQ.rst @@ -253,7 +253,7 @@ between the various slaves. Perhaps the dev_warn() should be changed to a dev_dbg(). And yes, that's a typo - 'recepient' is really spelled 'recipient'. -Submit a patch and get your initials into the Linux kernel.  :) +Submit a patch and get your initials into the Linux kernel. :) Disabling auto-recovery """""""""""""""""""""""" diff --git a/source/rtos/PDK_Platform_Software/IPC/_IPC_FAQ_for_Keystone_Devices.rst b/source/rtos/PDK_Platform_Software/IPC/_IPC_FAQ_for_Keystone_Devices.rst index 954903f92..d07e3b8c4 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_IPC_FAQ_for_Keystone_Devices.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_IPC_FAQ_for_Keystone_Devices.rst @@ -3,9 +3,9 @@ Overview ^^^^^^^^^^ -This wiki article is a collection of frequently asked questions (FAQ) on +This wiki article is a collection of frequently asked questions (FAQ) on IPC on Keystone family of devices , along with some useful collateral -and software reference links.  +and software reference links. | @@ -38,7 +38,7 @@ Keystone IPC Frequently Asked Questions (FAQ) **Ans:** -Please visit : +Please visit : http://downloads.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/ipc/latest/docs/doxygen/html/index.html The IPC product contains the following APIs: @@ -105,13 +105,13 @@ machine. This cannot be built through CCS. | .. rubric:: Q: Is there any simple example to demonstrate IPC methods - like message Q or notify for Keystone-II ? + like message Q or notify for Keystone-II ? :name: q-is-there-any-simple-example-to-demonstrate-ipc-methods-like-message-q-or-notify-for-keystone-ii **Ans:** | Please look at the ex44_compute.zip - in :~/ti/ipc_3_3x_xx_xx/examples/TCI6638_linux_elf + in :~/ti/ipc_3_3x_xx_xx/examples/TCI6638_linux_elf :: @@ -164,7 +164,7 @@ CCS based projects for these examples. **Ans:** -Tested version : "mcsdk_bios_3_00_03_15". The Image processing demo was +Tested version : "mcsdk_bios_3_00_03_15". The Image processing demo was tested multiple times with this version and it works fine. The image processing demo source code can be found in below path. @@ -195,7 +195,7 @@ at | -.. rubric:: Q: How to import the slave code of Image processing demo and +.. rubric:: Q: How to import the slave code of Image processing demo and how do I build it? :name: qhow-to-import-the-slave-code-of-image-processing-demo-and-how-do-i-build-it @@ -226,7 +226,7 @@ Take the binary file, image_processing_evmtci66xxk2x_slave.out and replace it in the path target Linux filesystem, “/usr/share/matrix-gui-2.0/apps/demo_imageproc/bin/" -.. rubric:: Q:  While building the ARM(master) side code of Image +.. rubric:: Q: While building the ARM(master) side code of Image processing demo, I see a compilation error message about Std.h as below when I make it with or without BUILD_LOCAL=true. :name: q-while-building-the-armmaster-side-code-of-image-processing-demo-i-see-a-compilation-error-message-about-std.h-as-below-when-i-make-it-with-or-without-build_localtrue. @@ -238,7 +238,7 @@ replace it in the path target Linux filesystem, | *make[1]: Entering directory \`/home/user/ti/mcsdk_bios_3_0x_0x_0x/demos/image_processing/ipc/master/src' mcip_mem_mgmt.c:53:24: fatal error: ti/ipc/Std.h: No such file or - directory #include  Compilation terminated.* + directory #include Compilation terminated.* | **Ans:** | There is an error in the Makefile. Make file needs to be updated for @@ -253,8 +253,8 @@ as below, :: - IPC_INSTALL_DIR := /opt/ti/ipc_3_xx_0x_0x - CFLAGS  := -Wall -I$(COMMON_INC) -I$(MASTER_INC) -I$(IPC_INSTALL_DIR)/linux/include -I$(IPC_INSTALL_DIR)/packages -D_GNU_SOURCE + IPC_INSTALL_DIR := /opt/ti/ipc_3_xx_0x_0x + CFLAGS := -Wall -I$(COMMON_INC) -I$(MASTER_INC) -I$(IPC_INSTALL_DIR)/linux/include -I$(IPC_INSTALL_DIR)/packages -D_GNU_SOURCE .. rubric:: Q: While building the ARM(master) side code of Image processing demo, I see a linker error message like below. @@ -283,17 +283,17 @@ as below, :: - IPC_INSTALL_DIR := /opt/ti/ipc_3_3x_xx_xx + IPC_INSTALL_DIR := /opt/ti/ipc_3_3x_xx_xx #The location where the libraries are installed after building the IPC package - SIPC_LINUX_DIR := /opt/ti/ipc_3_3x_xx_xx/IPC_Linux_libraries + SIPC_LINUX_DIR := /opt/ti/ipc_3_3x_xx_xx/IPC_Linux_libraries :: - CROSS_COMPILE ?= arm-linux-gnueabihf- - CC  := $(CROSS_COMPILE)gcc - CFLAGS  := -Wall -I$(COMMON_INC) -I$(MASTER_INC) -I$(IPC_INSTALL_DIR)/linux/include -I$(IPC_INSTALL_DIR)/packages -D_GNU_SOURCE - LFLAGS  := -lpthread -L$(SIPC_LINUX_DIR)/ -ltitransportrpmsg -L$(SIPC_LINUX_DIR)/ -ltiipc -L$(SIPC_LINUX_DIR)/ -ltiipcutils + CROSS_COMPILE ?= arm-linux-gnueabihf- + CC := $(CROSS_COMPILE)gcc + CFLAGS := -Wall -I$(COMMON_INC) -I$(MASTER_INC) -I$(IPC_INSTALL_DIR)/linux/include -I$(IPC_INSTALL_DIR)/packages -D_GNU_SOURCE + LFLAGS := -lpthread -L$(SIPC_LINUX_DIR)/ -ltitransportrpmsg -L$(SIPC_LINUX_DIR)/ -ltiipc -L$(SIPC_LINUX_DIR)/ -ltiipcutils | @@ -354,7 +354,7 @@ after the throughput (msg/s) has been calculated. .. Image:: /images/Qmss_IPC.png .. rubric:: Q: How can I build the qmssIpcbenchmark of pdk_C6678_1_1_2_x - pdk_C6678_1_1_2_x with release build configuration ? + pdk_C6678_1_1_2_x with release build configuration ? :name: q-how-can-i-build-the-qmssipcbenchmark-of-pdk_c6678_1_1_2_x-pdk_c6678_1_1_2_x-with-release-build-configuration **Ans:** @@ -370,11 +370,11 @@ after the throughput (msg/s) has been calculated. | **How to change the Common.bld:** | 1. Go to C:\ti\ipc_3_00_xx_xx\packages\ti\sdo\ipc\build\Common.bld ( Note: Go to the IPC version you use for building the transport - library. Here, it refers to IPC version : 3.00.4.29) + library. Here, it refers to IPC version : 3.00.4.29) | 2. Modify | Line No:88 profiles[0] = "release"; | Line No: 99 var libPath = "lib/ipc/release/"; -| 3. Build with option : -mo -o3 -q -k -eo.o in config.bld of transport +| 3. Build with option : -mo -o3 -q -k -eo.o in config.bld of transport library located at "..\ti\pdk_C6678_1_1_2_x\packages\ti\transport\ipc\qmss\transports" | 4. Now build qmssIpcBenchmark project. @@ -385,7 +385,7 @@ after the throughput (msg/s) has been calculated. | .. rubric:: Q: How to re-build the IPC - QMSS transport library and - generate “ti.transport.ipc.qmss.transports.ae66” ? + generate “ti.transport.ipc.qmss.transports.ae66” ? :name: q-how-to-re-build-the-ipc---qmss-transport-library-and-generate-ti.transport.ipc.qmss.transports.ae66 **Ans:** diff --git a/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_Linux.rst b/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_Linux.rst index a462ddbe6..f4b42b3cd 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_Linux.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_Linux.rst @@ -450,7 +450,7 @@ The expected output on the Linux-side should be: :: - Using numLoops: 100; procId : 1 + Using numLoops: 100; procId : 1 Entered MessageQApp_execute Local MessageQId: 0x1 Remote queueId [0x10000] diff --git a/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_QNX.rst b/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_QNX.rst index a011a7f78..1056ce597 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_QNX.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_IPC_Install_Guide_QNX.rst @@ -195,7 +195,7 @@ report a version mismatch in cygwin: :: C:/QNX650/host/win32/x86/usr/bin/make -j 1 -Cle.v7 -fMakefile install - 1 [main] ? (5984) C:\QNX650\host\win32\x86\usr\photon\bin\find.exe: *** fa + 1 [main] ? (5984) C:\QNX650\host\win32\x86\usr\photon\bin\find.exe: *** fa tal error - system shared memory version mismatch detected - 0x8A88009C/0x2D1E009C. This problem is probably due to using incompatible versions of the cygwin DLL. Search for cygwin1.dll using the Windows Start->Find/Search facility @@ -349,7 +349,7 @@ should look similar to this: :: - Using numLoops: 10; procId : 1 + Using numLoops: 10; procId : 1 Entered MessageQApp_execute Local MessageQId: 0x1 Remote queueId [0x10000] diff --git a/source/rtos/PDK_Platform_Software/IPC/_IPC_Resource_customTable.rst b/source/rtos/PDK_Platform_Software/IPC/_IPC_Resource_customTable.rst index eba123847..59d88d4ed 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_IPC_Resource_customTable.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_IPC_Resource_customTable.rst @@ -61,82 +61,82 @@ improvements and other changes without notifications). .. code-block:: c #include "rsc_types.h" -   + /* IPU Memory Map */ #define L4_DRA7XX_BASE 0x4A000000 -   + /* L4_CFG & L4_WKUP */ #define L4_PERIPHERAL_L4CFG (L4_DRA7XX_BASE) #define IPU_PERIPHERAL_L4CFG 0x6A000000 -   + #define L4_PERIPHERAL_L4PER1 0x48000000 #define IPU_PERIPHERAL_L4PER1 0x68000000 -   + #define L4_PERIPHERAL_L4PER2 0x48400000 #define IPU_PERIPHERAL_L4PER2 0x68400000 -   + #define L4_PERIPHERAL_L4PER3 0x48800000 #define IPU_PERIPHERAL_L4PER3 0x68800000 -   + #define L4_PERIPHERAL_L4EMU 0x54000000 #define IPU_PERIPHERAL_L4EMU 0x74000000 -   + #define L3_PERIPHERAL_PRUSS 0x4B200000 #define IPU_PERIPHERAL_PRUSS 0x6B200000 -   + #define L3_PERIPHERAL_DMM 0x4E000000 #define IPU_PERIPHERAL_DMM 0x6E000000 -   + #define L3_IVAHD_CONFIG 0x5A000000 #define IPU_IVAHD_CONFIG 0x7A000000 -   + #define L3_IVAHD_SL2 0x5B000000 #define IPU_IVAHD_SL2 0x7B000000 -   + #define L3_TILER_MODE_0_1 0x60000000 #define IPU_TILER_MODE_0_1 0xA0000000 -   + #define L3_TILER_MODE_2 0x70000000 #define IPU_TILER_MODE_2 0xB0000000 -   + #define L3_TILER_MODE_3 0x78000000 #define IPU_TILER_MODE_3 0xB8000000 -   + #define L3_OCMC_RAM 0x40300000 #define IPU_OCMC_RAM 0x60300000 -   + #define L3_EMIF_SDRAM 0xA0000000 #define IPU_EMIF_SDRAM 0x10000000 -   + #define IPU_MEM_TEXT 0x0 #define IPU_MEM_DATA 0x80000000 -   + #define IPU_MEM_IOBUFS 0x90000000 -   + #define IPU_MEM_IPC_DATA 0x9F000000 #define IPU_MEM_IPC_VRING 0x60000000 #define IPU_MEM_RPMSG_VRING0 0x60000000 #define IPU_MEM_RPMSG_VRING1 0x60004000 #define IPU_MEM_VRING_BUFS0 0x60040000 #define IPU_MEM_VRING_BUFS1 0x60080000 -   + #define IPU_MEM_IPC_VRING_SIZE SZ_1M #define IPU_MEM_IPC_DATA_SIZE SZ_1M -   + #if defined(VAYU_IPU_1) #define IPU_MEM_TEXT_SIZE (SZ_1M) #elif defined(VAYU_IPU_2) #define IPU_MEM_TEXT_SIZE (SZ_1M * 6) #endif -   + #if defined(VAYU_IPU_1) #define IPU_MEM_DATA_SIZE (SZ_1M * 5) #elif defined(VAYU_IPU_2) #define IPU_MEM_DATA_SIZE (SZ_1M * 48) #endif -   + #define IPU_MEM_IOBUFS_SIZE (SZ_1M * 90) -   + /* * Assign fixed RAM addresses to facilitate a fixed MMU table. * PHYS_MEM_IPC_VRING & PHYS_MEM_IPC_DATA MUST be together. @@ -147,95 +147,95 @@ improvements and other changes without notifications). #elif defined (VAYU_IPU_2) #define PHYS_MEM_IPC_VRING 0x95800000 #endif -   + #define PHYS_MEM_IOBUFS 0xBA300000 -   + /* * Sizes of the virtqueues (expressed in number of buffers supported, * and must be power of 2) */ #define IPU_RPMSG_VQ0_SIZE 256 #define IPU_RPMSG_VQ1_SIZE 256 -   + /* flip up bits whose indices represent features we support */ #define RPMSG_IPU_C0_FEATURES 1 -   + struct my_resource_table { struct resource_table base; -   + UInt32 offset[21]; /* Should match 'num' in actual definition */ -   + /* rpmsg vdev entry */ struct fw_rsc_vdev rpmsg_vdev; struct fw_rsc_vdev_vring rpmsg_vring0; struct fw_rsc_vdev_vring rpmsg_vring1; -   + /* text carveout entry */ struct fw_rsc_carveout text_cout; -   + /* data carveout entry */ struct fw_rsc_carveout data_cout; -   + /* ipcdata carveout entry */ struct fw_rsc_carveout ipcdata_cout; -   + /* trace entry */ struct fw_rsc_trace trace; -   + /* devmem entry */ struct fw_rsc_devmem devmem0; -   + /* devmem entry */ struct fw_rsc_devmem devmem1; -   + /* devmem entry */ struct fw_rsc_devmem devmem2; -   + /* devmem entry */ struct fw_rsc_devmem devmem3; -   + /* devmem entry */ struct fw_rsc_devmem devmem4; -   + /* devmem entry */ struct fw_rsc_devmem devmem5; -   + /* devmem entry */ struct fw_rsc_devmem devmem6; -   + /* devmem entry */ struct fw_rsc_devmem devmem7; -   + /* devmem entry */ struct fw_rsc_devmem devmem8; -   + /* devmem entry */ struct fw_rsc_devmem devmem9; -   + /* devmem entry */ struct fw_rsc_devmem devmem10; -   + /* devmem entry */ struct fw_rsc_devmem devmem11; -   + /* devmem entry */ struct fw_rsc_devmem devmem12; -   + /* devmem entry */ struct fw_rsc_devmem devmem13; -   + /* devmem entry */ struct fw_rsc_devmem devmem14; -   + /* devmem entry */ struct fw_rsc_devmem devmem15; }; extern char ti_trace_SysMin_Module_State_0_outbuf__A; #define TRACEBUFADDR (UInt32)&ti_trace_SysMin_Module_State_0_outbuf__A -   + #pragma DATA_SECTION(ti_ipc_remoteproc_ResourceTable, ".resource_table") #pragma DATA_ALIGN(ti_ipc_remoteproc_ResourceTable, 4096) -   + struct my_resource_table ti_ipc_remoteproc_ResourceTable = { 1, /* we're the first version that implements this */ 21, /* number of entries in the table */ @@ -264,7 +264,7 @@ improvements and other changes without notifications). offsetof(struct my_resource_table, devmem14), offsetof(struct my_resource_table, devmem15), }, -   + /* rpmsg vdev entry */ { TYPE_VDEV, VIRTIO_ID_RPMSG, 0, @@ -274,119 +274,119 @@ improvements and other changes without notifications). /* the two vrings */ { IPU_MEM_RPMSG_VRING0, 4096, IPU_RPMSG_VQ0_SIZE, 1, 0 }, { IPU_MEM_RPMSG_VRING1, 4096, IPU_RPMSG_VQ1_SIZE, 2, 0 }, -   + { TYPE_CARVEOUT, IPU_MEM_TEXT, 0, IPU_MEM_TEXT_SIZE, 0, 0, "IPU_MEM_TEXT", }, -   + { TYPE_CARVEOUT, IPU_MEM_DATA, 0, IPU_MEM_DATA_SIZE, 0, 0, "IPU_MEM_DATA", }, -   + { TYPE_CARVEOUT, IPU_MEM_IPC_DATA, 0, IPU_MEM_IPC_DATA_SIZE, 0, 0, "IPU_MEM_IPC_DATA", }, -   + { TYPE_TRACE, TRACEBUFADDR, 0x8000, 0, "trace:sysm3", }, -   + { TYPE_DEVMEM, IPU_MEM_IPC_VRING, PHYS_MEM_IPC_VRING, IPU_MEM_IPC_VRING_SIZE, 0, 0, "IPU_MEM_IPC_VRING", }, -   + { TYPE_DEVMEM, IPU_MEM_IOBUFS, PHYS_MEM_IOBUFS, IPU_MEM_IOBUFS_SIZE, 0, 0, "IPU_MEM_IOBUFS", }, -   + { TYPE_DEVMEM, IPU_TILER_MODE_0_1, L3_TILER_MODE_0_1, SZ_256M, 0, 0, "IPU_TILER_MODE_0_1", }, -   + { TYPE_DEVMEM, IPU_TILER_MODE_2, L3_TILER_MODE_2, SZ_128M, 0, 0, "IPU_TILER_MODE_2", }, -   + { TYPE_DEVMEM, IPU_TILER_MODE_3, L3_TILER_MODE_3, SZ_128M, 0, 0, "IPU_TILER_MODE_3", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_L4CFG, L4_PERIPHERAL_L4CFG, SZ_16M, 0, 0, "IPU_PERIPHERAL_L4CFG", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_L4PER1, L4_PERIPHERAL_L4PER1, SZ_2M, 0, 0, "IPU_PERIPHERAL_L4PER1", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_L4PER2, L4_PERIPHERAL_L4PER2, SZ_4M, 0, 0, "IPU_PERIPHERAL_L4PER2", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_L4PER3, L4_PERIPHERAL_L4PER3, SZ_8M, 0, 0, "IPU_PERIPHERAL_L4PER3", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_L4EMU, L4_PERIPHERAL_L4EMU, SZ_16M, 0, 0, "IPU_PERIPHERAL_L4EMU", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_PRUSS, L3_PERIPHERAL_PRUSS, SZ_1M, 0, 0, "IPU_PERIPHERAL_PRUSS", }, -   + { TYPE_DEVMEM, IPU_IVAHD_CONFIG, L3_IVAHD_CONFIG, SZ_16M, 0, 0, "IPU_IVAHD_CONFIG", }, -   + { TYPE_DEVMEM, IPU_IVAHD_SL2, L3_IVAHD_SL2, SZ_16M, 0, 0, "IPU_IVAHD_SL2", }, -   + { TYPE_DEVMEM, IPU_PERIPHERAL_DMM, L3_PERIPHERAL_DMM, SZ_1M, 0, 0, "IPU_PERIPHERAL_DMM", }, -   + { TYPE_DEVMEM, IPU_OCMC_RAM, L3_OCMC_RAM, SZ_4M, 0, 0, "IPU_OCMC_RAM", }, -   + { TYPE_DEVMEM, IPU_EMIF_SDRAM, L3_EMIF_SDRAM, @@ -412,9 +412,9 @@ The virtual addresses #defined are: #define IPU_MEM_TEXT 0x0 #define IPU_MEM_DATA 0x80000000 -   + #define IPU_MEM_IOBUFS 0x90000000 -   + #define IPU_MEM_IPC_DATA 0x9F000000 #define IPU_MEM_IPC_VRING 0x60000000 @@ -440,7 +440,7 @@ the remoteproc CMA area in Linux DTS file: reusable; status = "okay"; }; -   + ipu1_cma_pool: ipu1_cma@9d000000 { compatible = "shared-dma-pool"; reg = <0x9d000000 0x2000000>; diff --git a/source/rtos/PDK_Platform_Software/IPC/_Optimizing_IPC_Applications.rst b/source/rtos/PDK_Platform_Software/IPC/_Optimizing_IPC_Applications.rst index 4038570d4..1f7c0116e 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_Optimizing_IPC_Applications.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_Optimizing_IPC_Applications.rst @@ -200,10 +200,10 @@ runtime performance of IPC applications: GateMP_Params gateParams; GateMP_Handle gateHandle; HeapBufMP_Params heapParams; -   + GateMP_Params_init(&gateParams); gateHandle = GateMP_create(&gateParams); -   + HeapBufMP_Params_init(&heapParams); heapParams.gate = gateHandle; @@ -243,10 +243,10 @@ runtime performance of IPC applications: HeapBufMP_Params heapParams; HeapBufMP_Handle heapHandle; -   + HeapBufMP_Params_init(&heapParams); heapParams.regionId = 1; -   + heapHandle = HeapBufMP_create(&heapParams); This heap can be used by either of the Cortex M3 cores on an diff --git a/source/rtos/PDK_Platform_Software/IPC/_The_ti.sdo.ipc_Package.rst b/source/rtos/PDK_Platform_Software/IPC/_The_ti.sdo.ipc_Package.rst index 7eb4ea448..eba13d39a 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_The_ti.sdo.ipc_Package.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_The_ti.sdo.ipc_Package.rst @@ -151,23 +151,23 @@ need to include different XDC, IPC, and SYS/BIOS header files. #include #include -   + /* ---- XDC.RUNTIME module Headers */ #include #include #include -   + /* ----- IPC module Headers */ #include #include #include #include #include -   + /* ---- BIOS6 module Headers */ #include #include -   + /* ---- Get globals from .cfg Header */ #include @@ -235,7 +235,7 @@ provided status constants. For example: MessageQ_Msg msg; MessageQ_Handle messageQ; Int status; -   + ... status = MessageQ_get(messageQ, &msg, MessageQ_FOREVER); if (status < 0) { diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Debug_with_ICSS_EMAC_LLD.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Debug_with_ICSS_EMAC_LLD.rst index 41bc8b4a9..82eaf369a 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Debug_with_ICSS_EMAC_LLD.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Debug_with_ICSS_EMAC_LLD.rst @@ -69,7 +69,7 @@ Program. Here browse to the required executable and click OK 8. After a successful load, the program is expected to be in suspended state and program counter is pointing to main function. If the program -is not in suspended state : +is not in suspended state : i. Suspend the application by selecting Run->Suspend @@ -177,24 +177,24 @@ covers most of them (not exhaustively!) The first step is to identify the exact problem, to do that please perform these steps in order. -#. **Check if Rx is disabled** : It's possible to disable Rx in firmware +#. **Check if Rx is disabled** : It's possible to disable Rx in firmware through IOCTL. This is controlled through a location in ICSS memory. See `memory map `__. Check this as a very first step. It's not a common error but it's possible that user is invoking the IOCTL by mistake. -#. **Check if firmware is receiving packets** : See statistics `this `__ +#. **Check if firmware is receiving packets** : See statistics `this `__ and `this `__ and find out if PRU is receiving the frames. Failure to receive frames in firmware can indicate other issues like corrupted frames, link negotiation failure or PHY related issues. -#. **Check if Rx interrupt is being asserted** : This can be one of the +#. **Check if Rx interrupt is being asserted** : This can be one of the reasons why Host would not receive packets. Put a break point in **ICSS_EmacRxInterruptHandler** and send a single packet using any PC based tool. The ISR should get hit. Refer to this `section `__ on how to configure the interrupt properly if interrupt is not being asserted. -#. **Check if Packets are being copied in driver** : If the interrupt is +#. **Check if Packets are being copied in driver** : If the interrupt is asserted but packets do not reach the application, check Host statistics to verify if packets are being received correctly in the driver. Refer to the @@ -205,7 +205,7 @@ perform these steps in order. length is zero it indicates some data corruption in the receive queues or firmware behaving incorrectly, this scenario should not occur. -#. **Check if NDK is receiving the frames** : If driver is receiving the +#. **Check if NDK is receiving the frames** : If driver is receiving the frames and user cannot see frames in socket then it indicates issues with TCP/IP stack. Refer to `NDK User's guide `__ on correct @@ -214,7 +214,7 @@ perform these steps in order. is known to work though. In addition to this check if NDK buffers have been allocated correctly. If you are using your own TCP/IP stack refer to the Porting Guide and double check. -#. **Check if Storm prevention is enabled** : This is one of the most +#. **Check if Storm prevention is enabled** : This is one of the most common reasons why throughput may get lowered or if the threshold is set incorrectly packets may not reach Host at all. Check if storm prevention module is enabled by checking the variable @@ -222,17 +222,17 @@ perform these steps in order. `this `__ for more details. Additionally one should check the statistics to see if the PRU statistics **stormPrevCounter** is getting incremented. -#. **Check Interface MAC** : The firmware compares the interface MAC +#. **Check Interface MAC** : The firmware compares the interface MAC written to the PRU memory by the Host against the incoming packets destination MAC to verify if the packet must be forwarded to Host or cut-through. Please refer to the `memory map `__ and check if the MAC value is what you are expecting it to be. -#. **Queue Overflow** : If too many packets are received on a single +#. **Queue Overflow** : If too many packets are received on a single queue without Host emptying them out then overflow may occur, packets will be lost in such a scenario. This is somewhat related to throughput issues but may occur independently as well. -#. **Check throughput** : This is applicable in case everything else +#. **Check throughput** : This is applicable in case everything else appears to be correct but the number of packets reaching the Host is not 100% of the transmitted value. This can happen because of two reasons. 1. Data rate is too fast and interrupt pacing is disabled. @@ -245,7 +245,7 @@ perform these steps in order. find the throughput by comparing the number of packets received on the Host vs that in the firmware. -**More on Throughput** : If throughput is low then try to find out how +**More on Throughput** : If throughput is low then try to find out how the Rx processing on Host can be sped up or if any other high priority task is blocking the execution of **RxTask**. The EMAC and switch are tested during release to cope with 100% throughput at line rate (960 IPG @@ -263,9 +263,9 @@ classified into two types. See `Tx data path `__ for more information. -#. **Cut-through issues** : Packets received on one port and meant to go +#. **Cut-through issues** : Packets received on one port and meant to go out of the opposite port. (Not applicable to EMAC) -#. **Transmit from Host** : Packets sent out from the Host on any one +#. **Transmit from Host** : Packets sent out from the Host on any one port. As a first step please check the statistics on firmware as well as Host @@ -275,7 +275,7 @@ is by comparing transmit statistics for Host and firmware. The probable causes for transmit not working are listed below. This can also be used as a checklist for debugging. -#. **Link down** : The link event is mapped to an ISR +#. **Link down** : The link event is mapped to an ISR **ICSS_EmacLinkISR** which in turn calls another API **ICSS_EmacUpdatePhyStatus** to update the link status in firmware. If this is not done correctly then it's possible that firmware will @@ -284,7 +284,7 @@ also be used as a checklist for debugging. The Tx API checks for link and will not transmit if the link is down so this issue is more relevant to cut-through/store-forward. More on Link status `here `__. -#. **Incorrect speed** : The link ISR also checks for speed and +#. **Incorrect speed** : The link ISR also checks for speed and duplexity values. The values are written to in the same ISR **ICSS_EmacUpdatePhyStatus**, if the speed is read incorrectly then it's possible that firmware will not send out packets or may send out @@ -295,7 +295,7 @@ also be used as a checklist for debugging. at the offset mentioned in `memory map `__, please verify the value (as mentioned in memory map) and compare with the actual interface speed. -#. **Incorrect pinmux for Collision/Carrier Sense** : This is applicable +#. **Incorrect pinmux for Collision/Carrier Sense** : This is applicable in case of developers using their custom boards, it's important that the collision and carrier sense signals be wired correctly (see ICEv2 `layout `__) @@ -304,16 +304,16 @@ also be used as a checklist for debugging. problems. If there is an issue with pinmuxing these two pins it's recommended that half duplex functionality be disabled. Half Duplex functionality is controlled by the variable **halfDuplexEnable** -#. **Queue contention issues** : Looking at the QoS +#. **Queue contention issues** : Looking at the QoS `scheme `__ it's possible that there is a contention for the transmit queue when both Host and the opposite port are trying to transmit on the same port. In such cases if there are too many packets vying for the contention queue they will be dropped. Such conditions are rare. -#. **Queue overflow** : As the name suggests if too many packets are +#. **Queue overflow** : As the name suggests if too many packets are sent out on a single queue then overflow can happen and packets may get lost. -#. **NDK transmit** : Issues with NDK buffers may cause issues with Tx, +#. **NDK transmit** : Issues with NDK buffers may cause issues with Tx, in such cases put a breakpoint in **ICSS_EmacTxPacket** to see if NDK is calling it. @@ -342,17 +342,17 @@ Getting the values Statistics are accessible in three ways -- **IOCTL calls** : IOCTL calls (including an example) have been +- **IOCTL calls** : IOCTL calls (including an example) have been previously explained `here `__ in developer guide. -- **Reading directly in memory window** : (This applies only to PRU +- **Reading directly in memory window** : (This applies only to PRU based statistics). Use the statistics `memory map `__ to find out the offset and look at the memory directly. Information on how to access the ICSS memory is provided `here `__. -- **In CCS watch window** : When using CCS the statistics can be read +- **In CCS watch window** : When using CCS the statistics can be read directly through the ICSS EMAC handle. Host statistics are available through **hostStat** while PRU statistics are available through **pruStat**. An example code snippet from **TxPacketEnqueue** API @@ -366,7 +366,7 @@ Statistics are accessible in three ways hostStatPtr += (portNumber - 1); ICSS_EmacUpdateTxStats(macAddr,(unsigned int)lengthOfPacket, hostStatPtr); -**NOTE :** Since they are void members they need to be typecast to +**NOTE :** Since they are void members they need to be typecast to access the members in CCS watch window. Example Usage @@ -544,7 +544,7 @@ not, copy it from \\ti_internal\examples\ethernet_switch\Tcp) resides in the test PC (e.g., C:\ti\ndk_2_24_02_31\packages\ti\ndk\winapps). -5. Enter this command: send.exe %DUT_IP_ADDRESS% 100 +5. Enter this command: send.exe %DUT_IP_ADDRESS% 100 where, diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Develop_with_ICSS_EMAC_LLD.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Develop_with_ICSS_EMAC_LLD.rst index a38709151..09a654a29 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Develop_with_ICSS_EMAC_LLD.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/ICSS_EMAC_LLD/_Develop_with_ICSS_EMAC_LLD.rst @@ -478,7 +478,7 @@ detailed description is given below. .. code-block:: c /*Read till all queues are empty*/ - while(allQueuesEempty != 1 && numPacketsInLoop <= ((((ICSSEMAC_Object*)icssEmacHandle->object)->emacInitcfg)->pacingThreshold)) + while(allQueuesEempty != 1 && numPacketsInLoop <= ((((ICSSEMAC_Object*)icssEmacHandle->object)->emacInitcfg)->pacingThreshold)) { /*This API reads the queues and gets the queue and port number for each packet*/ pLength = ICSS_EmacRxPktInfo(icssEmacHandle, &port_number, &queue_number); @@ -493,7 +493,7 @@ detailed description is given below. else { /*Protocol specific callback*/ - if(((((ICSSEMAC_Object*)icssEmacHandle->object)->callBackHandle)->rxRTCallBack)->callBack != NULL) + if(((((ICSSEMAC_Object*)icssEmacHandle->object)->callBackHandle)->rxRTCallBack)->callBack != NULL) { ((((ICSSEMAC_Object*)icssEmacHandle->object)->callBackHandle)->rxRTCallBack)->callBack(&queue_number, ((((ICSSEMAC_Object*)icssEmacHandle->object)->callBackHandle)->rxRTCallBack)->userArg); @@ -594,9 +594,9 @@ API directly calls the underlying API. To avoid confusion developers must always call the API **ICSS_EmacTxPacket** (NOT [STRIKEOUT:**ICSS_EmacTxPacketEnqueue**]) with **portNumber** as -- *ICSS_EMAC_PORT_0* : If they do not know the port number on which to +- *ICSS_EMAC_PORT_0* : If they do not know the port number on which to transmit. -- *ICSS_EMAC_PORT_1* or *ICSS_EMAC_PORT_2* : If they know the port +- *ICSS_EMAC_PORT_1* or *ICSS_EMAC_PORT_2* : If they know the port number .. note:: @@ -740,7 +740,7 @@ two interrupts (no time triggered send in Switch mode). The eight interrupts are: -#. Rx interrupt x 2 : One for each port, both mapping to same ISR. These +#. Rx interrupt x 2 : One for each port, both mapping to same ISR. These are used by PRU to tell ARM about the presence of a packet. For Port 0 this is interrupt number (ARM) 20 on AM335x and for Port 1 it is 21. In the mapping these are indicated by **PRU_ARM_EVENT0** and @@ -774,7 +774,7 @@ The eight interrupts are: There are two types of interrupts: -- ***ICSS Interrupts*** : These are interrupts that are routed through +- ***ICSS Interrupts*** : These are interrupts that are routed through the ICSS Interrupt controller to the Host (Refer to section 4.4.2 of `AM335x TRM `__). It consists of interrupts asserted by the PRU as well as interrupts @@ -936,7 +936,7 @@ porting other operating systems etc. | -- ***Host Interrupts*** : Host interrupts are interrupts that are not +- ***Host Interrupts*** : Host interrupts are interrupts that are not coming via ICSS Interrupt controller. These include peripherals, EDMA, timers etc. A full list is present inside the Interrupt section of any TRM. On AM335x a total of 128 interrupts are available through @@ -967,11 +967,11 @@ critical packets need to be serviced immediately, it's possible that some delay may occur. Pacing is enabled in the driver using the variable **intrPacingMode**. There are two pacing modes in driver. -- **INTR_PACING_MODE1** : This is entirely ARM based, i.e. interrupts +- **INTR_PACING_MODE1** : This is entirely ARM based, i.e. interrupts are disabled only on the Host. This does not require any firmware support. This is the scheme supported with Ethernet MAC and Ethernet IP Adapter. -- **INTR_PACING_MODE1** : In this scheme interrupts are disabled on the +- **INTR_PACING_MODE1** : In this scheme interrupts are disabled on the PRU. This requires firmware support. Only supported in Profinet right now. @@ -1097,7 +1097,7 @@ use corresponding `IOCTL `__ calls. The IOCTL command for Learning/FDB modules is ***ICSS_EMAC_IOCTL_LEARNING_CTRL*** -***Adding A MAC address*** : The corresponding API for this is +***Adding A MAC address*** : The corresponding API for this is :: @@ -1107,7 +1107,7 @@ The API is integrated inside **ICSS_EmacRxPktGet** so developer need not call it separately, if at all it is required please use the IOCTL call for this. IOCTL Param value is *ICSS_EMAC_LEARN_CTRL_UPDATE_TABLE* -***Looking up an Entry*** : The corresponding API for this is +***Looking up an Entry*** : The corresponding API for this is :: @@ -1116,7 +1116,7 @@ for this. IOCTL Param value is *ICSS_EMAC_LEARN_CTRL_UPDATE_TABLE* Integrated with driver inside **ICSS_EmacTxPacket**, use IOCTL Param value *ICSS_EMAC_LEARN_CTRL_FIND_MAC* -***Removing a MAC address*** : The corresponding API for this is +***Removing a MAC address*** : The corresponding API for this is :: @@ -1125,7 +1125,7 @@ value *ICSS_EMAC_LEARN_CTRL_FIND_MAC* Entries are removed automatically upon ageing, if forced removal is required use IOCTL Param value *ICSS_EMAC_LEARN_CTRL_REMOVE_MAC* -***Ageing an Entry*** : The driver already implements this inside the +***Ageing an Entry*** : The driver already implements this inside the periodic task which is called every 100 NDK Ticks ***\_HwPktPoll()*** but users can call it as well. IOCTL Param value *ICSS_EMAC_LEARN_CTRL_INC_COUNTER* @@ -1136,7 +1136,7 @@ The corresponding API for this is void incrementCounter(HashTable_t *tablePtr) -***Removing an Aged Entry*** : The corresponding API for this is +***Removing an Aged Entry*** : The corresponding API for this is :: @@ -1144,7 +1144,7 @@ The corresponding API for this is Integrated with driver. IOCTL Param value *ICSS_EMAC_LEARN_CTRL_AGEING* -***Changing Port State*** : Change the port state to appropriate value. +***Changing Port State*** : Change the port state to appropriate value. This is useful in the implementation of requirements specified by IEEE 802.1D. @@ -1160,7 +1160,7 @@ entries to simulate passage of time). Not integrated with driver, application must do it. IOCTL Param value *ICSS_EMAC_LEARN_CTRL_SET_PORTSTATE* -***Flushing/Clearing the entire Table*** : The corresponding API for +***Flushing/Clearing the entire Table*** : The corresponding API for this is :: @@ -1240,7 +1240,7 @@ use corresponding `IOCTL `__ calls. The IOCTL command for Learning/FDB modules is ***ICSS_EMAC_IOCTL_STORM_PREV_CTRL*** -***Enabling Storm Prevention***  : The corresponding API for this is +***Enabling Storm Prevention*** : The corresponding API for this is .. code-block:: c @@ -1248,7 +1248,7 @@ calls. The IOCTL command for Learning/FDB modules is Corresponding IOCTL Param value is *ICSS_EMAC_STORM_PREV_CTRL_ENABLE* -***Disabling Storm Prevention*** : Similar to enablement, variable set +***Disabling Storm Prevention*** : Similar to enablement, variable set to False. The corresponding API for this is :: @@ -1257,7 +1257,7 @@ to False. The corresponding API for this is IOCTL Param value is *ICSS_EMAC_STORM_PREV_CTRL_DISABLE* -***Resetting the counters*** : This is called inside **\_HwPktPoll** +***Resetting the counters*** : This is called inside **\_HwPktPoll** which is the NDK tick function. The time period of this tick function (default 100ms) in combination with **credits** value decides the rate at which Storm Prevention works. This is called by default inside the @@ -1271,7 +1271,7 @@ The corresponding API for this is IOCTL Param value is *ICSS_EMAC_STORM_PREV_CTRL_RESET* -***Changing the rate*** : To change how many packets are accepted or +***Changing the rate*** : To change how many packets are accepted or rejected change the value in the structure. At every iteration these values are written to the data RAM by the **ICSS_EmacResetStormPreventionCounter** API. The scheme through which @@ -1292,12 +1292,12 @@ Most often Storm Prevention is the main reason for users not being able to receive a packet, esp if the rate is configured incorrectly. So first verify if it is enabled for that port. This can be done by -- Checking structure variable : See the value of **suppressionEnabled** +- Checking structure variable : See the value of **suppressionEnabled** variable in the structure. -- Checking memory : See the memory offset STORM_PREVENTION_OFFSET in +- Checking memory : See the memory offset STORM_PREVENTION_OFFSET in the corresponding data RAM. The first bit of the byte location tells you whether the logic is enabled on the port. -- Disabling Storm Prevention : This is the easiest and preferable for +- Disabling Storm Prevention : This is the easiest and preferable for someone not using an emulator. Use the corresponding IOCTL call. To quickly verify if the logic is indeed dropping packets, try sending @@ -1319,24 +1319,24 @@ Design The Statistics are divided into -- ***Statistics on PRU*** : Since the LLD functionality is implemented +- ***Statistics on PRU*** : Since the LLD functionality is implemented on the PRU's the majority of statistics are implemented on them. The count for each port is stored on the respective Data RAM's starting at the offset STATISTICS_OFFSET. The map is shown below -- ***Statistics on Host*** : The packets coming to the Host are counted +- ***Statistics on Host*** : The packets coming to the Host are counted once again, this is useful for debugging purposes and to measure throughput (from the PRU to Host) if required. Some statistics like "Unknown protocol type" are only implemented on the Host. Functionally the statistics are classified into -- ***Rx/Tx related statistics*** : This includes count of broadcast, +- ***Rx/Tx related statistics*** : This includes count of broadcast, multicast and unicast packets and their derivatives. Only valid packets are part of this which means that an Rx packet which has been dropped because of storm prevention will not be counted. -- ***Error Counters*** : This includes statistics such as Dropped +- ***Error Counters*** : This includes statistics such as Dropped frames, Rx/Tx errors etc. -- ***Other statistics*** : Includes statistics related to 802.1 +- ***Other statistics*** : Includes statistics related to 802.1 CSMA/CD, number of link breaks etc. A description of PRU statistics along with corresponding memory map is @@ -1660,7 +1660,7 @@ use corresponding `IOCTL `__ calls. The IOCTL command for Statistics module is ***ICSS_EMAC_IOCTL_STATS_CTRL*** -***Reading PRU Statistics***  : To fetch PRU statistics an M2M copy is +***Reading PRU Statistics*** : To fetch PRU statistics an M2M copy is done from the PRU Data RAM to the PRU statistics structure on DDR. To get the values correctly the memory layout on both sides should be identical. Developers should not modify the member order in @@ -1679,7 +1679,7 @@ The corresponding API for this is IOCTL Param value is *ICSS_EMAC_IOCTL_STAT_CTRL_GET* -***Clearing PRU and Host Statistics***  : To clear the values do memory +***Clearing PRU and Host Statistics*** : To clear the values do memory write to the structure memory, PRU data RAM and initialize to 0. The corresponding API for this is @@ -1908,14 +1908,14 @@ The primary IOCTL call is through the API **ICSS_EmacIoctl** which is implemented in the file icss_emacFwInit.c An IOCTL call uses two parameters to find out which driver API to call -#. **ioctlCommand** : Is used to locate the module (Statistics/ Port +#. **ioctlCommand** : Is used to locate the module (Statistics/ Port control etc) which should be called. -#. **ioctlParams** : Is used to give module specific instructions +#. **ioctlParams** : Is used to give module specific instructions ***ioctlParams*** consists of -- **command** : Indicates which specific API to execute -- **ioctlVal** : Sometimes the API may require specific input, this is +- **command** : Indicates which specific API to execute +- **ioctlVal** : Sometimes the API may require specific input, this is used to provide that. For example to disable receive functionality on a port the following @@ -1956,56 +1956,56 @@ There is only one API for IOCTL. It's defined below The possible values for ***ioctlCommand*** are -- *ICSS_EMAC_IOCTL_PORT_CTRL* : Select Port Control Operations. +- *ICSS_EMAC_IOCTL_PORT_CTRL* : Select Port Control Operations. Enable/Disable Rx for the specified port. -- *ICSS_EMAC_IOCTL_LEARNING_CTRL* : Select Learning/FDB module. -- *ICSS_EMAC_IOCTL_STORM_PREV_CTRL* : Select Storm Prevention module. -- *ICSS_EMAC_IOCTL_STATS_CTRL* : Select Statistics module. -- *ICSS_EMAC_IOCTL_TTS_CTRL* : Select Time Triggered Send Configuration +- *ICSS_EMAC_IOCTL_LEARNING_CTRL* : Select Learning/FDB module. +- *ICSS_EMAC_IOCTL_STORM_PREV_CTRL* : Select Storm Prevention module. +- *ICSS_EMAC_IOCTL_STATS_CTRL* : Select Statistics module. +- *ICSS_EMAC_IOCTL_TTS_CTRL* : Select Time Triggered Send Configuration module. Enable/Disable TTS for the specified port. -- *ICSS_EMAC_IOCTL_TTS_STATUS_CTRL* : Select Time Triggered Send Query +- *ICSS_EMAC_IOCTL_TTS_STATUS_CTRL* : Select Time Triggered Send Query module. Get TTS status and other details for the specified port from PRU firmware. Possible values for ***ioctlParams*** are -- **ICSS_EMAC_IOCTL_LEARNING_CTRL** : Refer to Learning/FDB API's +- **ICSS_EMAC_IOCTL_LEARNING_CTRL** : Refer to Learning/FDB API's - - *ICSS_EMAC_LEARN_CTRL_UPDATE_TABLE* : Add an entry to the Hash + - *ICSS_EMAC_LEARN_CTRL_UPDATE_TABLE* : Add an entry to the Hash table. - - *ICSS_EMAC_LEARN_CTRL_CLR_TABLE* : Clear the Learning Table for + - *ICSS_EMAC_LEARN_CTRL_CLR_TABLE* : Clear the Learning Table for the specified port. - - *ICSS_EMAC_LEARN_CTRL_AGEING* : Age out old entries from the + - *ICSS_EMAC_LEARN_CTRL_AGEING* : Age out old entries from the table. - - *ICSS_EMAC_LEARN_CTRL_FIND_MAC* : Find the port number given a MAC + - *ICSS_EMAC_LEARN_CTRL_FIND_MAC* : Find the port number given a MAC ID. - - *ICSS_EMAC_LEARN_CTRL_REMOVE_MAC* : Remove a MAC ID from the + - *ICSS_EMAC_LEARN_CTRL_REMOVE_MAC* : Remove a MAC ID from the Learning Table - - *ICSS_EMAC_LEARN_CTRL_INC_COUNTER* : Age the entries with time by + - *ICSS_EMAC_LEARN_CTRL_INC_COUNTER* : Age the entries with time by calling this periodically - - *ICSS_EMAC_LEARN_CTRL_INIT_TABLE* : Initialize the learning table - - *ICSS_EMAC_LEARN_CTRL_SET_PORTSTATE* : Set the Port state to value + - *ICSS_EMAC_LEARN_CTRL_INIT_TABLE* : Initialize the learning table + - *ICSS_EMAC_LEARN_CTRL_SET_PORTSTATE* : Set the Port state to value defined by the enum type **portState** -- **ICSS_EMAC_IOCTL_STATS_CTRL** : Refer to Statistics API's +- **ICSS_EMAC_IOCTL_STATS_CTRL** : Refer to Statistics API's - - *ICSS_EMAC_IOCTL_STAT_CTRL_GET* : Get the statistics - - *ICSS_EMAC_IOCTL_STAT_CTRL_CLEAR* : Clear all stat counters + - *ICSS_EMAC_IOCTL_STAT_CTRL_GET* : Get the statistics + - *ICSS_EMAC_IOCTL_STAT_CTRL_CLEAR* : Clear all stat counters -- **ICSS_EMAC_IOCTL_STORM_PREV_CTRL** : Refer to Storm prevention API's +- **ICSS_EMAC_IOCTL_STORM_PREV_CTRL** : Refer to Storm prevention API's - - *ICSS_EMAC_STORM_PREV_CTRL_ENABLE* : Enable Storm Prevention - - *ICSS_EMAC_STORM_PREV_CTRL_DISABLE* : Disable Storm Prevention - - *ICSS_EMAC_STORM_PREV_CTRL_SET_CREDITS* : Set how many BC/MC + - *ICSS_EMAC_STORM_PREV_CTRL_ENABLE* : Enable Storm Prevention + - *ICSS_EMAC_STORM_PREV_CTRL_DISABLE* : Disable Storm Prevention + - *ICSS_EMAC_STORM_PREV_CTRL_SET_CREDITS* : Set how many BC/MC packets are allowed in a period of 100 NDK Ticks (Time period of **\_HwPktPoll()**) - - *ICSS_EMAC_STORM_PREV_CTRL_INIT* : Initialize Storm Prevention - - *ICSS_EMAC_STORM_PREV_CTRL_RESET* : Renew the storm prevention + - *ICSS_EMAC_STORM_PREV_CTRL_INIT* : Initialize Storm Prevention + - *ICSS_EMAC_STORM_PREV_CTRL_RESET* : Renew the storm prevention counters, this allows more packets to come through once existing credits have expired. This must be called periodically in **\_HwPktPoll()** -- **ICSS_EMAC_IOCTL_PORT_CTRL** : For Rx Enable/Disable operations. +- **ICSS_EMAC_IOCTL_PORT_CTRL** : For Rx Enable/Disable operations. There are no sub-commands here. Whether to enable or disable is decided by the value of ***ioctlVal*** diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_I2C_FIRMWARE.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_I2C_FIRMWARE.rst index f1744c7a1..8216201bc 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_I2C_FIRMWARE.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_I2C_FIRMWARE.rst @@ -299,7 +299,7 @@ Sample code for SMBus transaction: status = I2C_transfer(handle, &i2cTransaction); if (status != I2C_STS_SUCCESS) { /* I2C transaction failed */ - }  + } | diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst index 912d80d80..cae7bc552 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst @@ -32,7 +32,7 @@ Code Organization ================= THE SORTE ARM application and firmware sources can be found under the -following directory : +following directory : **/packages/ti/drv/pruss/example/apps/sorte/** diff --git a/source/rtos/Release_Specific/_Build_the_SDK.rst b/source/rtos/Release_Specific/_Build_the_SDK.rst index d0e5346b7..bd75c25bb 100644 --- a/source/rtos/Release_Specific/_Build_the_SDK.rst +++ b/source/rtos/Release_Specific/_Build_the_SDK.rst @@ -87,7 +87,7 @@ installed RTOS SDK. IPC_PLATFORM: DRA7XX IPC_ALT_PLATFORM: AM572X AM571X - PROC_SDK_INSTALL_PATH  : C:/ti/processor_sdk_rtos_[soc]_[version] + PROC_SDK_INSTALL_PATH : C:/ti/processor_sdk_rtos_[soc]_[version] ************************************************************************** Changing to short name to support directory names containing spaces current directory: C:/ti/processor_sdk_rtos_[soc]_[version] @@ -115,7 +115,7 @@ SDK. ~/ti/processor_sdk_rtos_[soc>]_[version]$ source setupenv.sh IPC_PLATFORM: DRA7XX IPC_ALT_PLATFORM: AM572X AM571X - PROC_SDK_INSTALL_PATH  : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] + PROC_SDK_INSTALL_PATH : /home/[user]/ti/processor_sdk_rtos_[soc]_[version] PROCESSOR SDK BUILD ENVIRONMENT CONFIGURED ******************************************************************************* diff --git a/source/rtos/Release_Specific/_Migration_Guide.rst b/source/rtos/Release_Specific/_Migration_Guide.rst index 8ab0f70ba..ec906c36e 100644 --- a/source/rtos/Release_Specific/_Migration_Guide.rst +++ b/source/rtos/Release_Specific/_Migration_Guide.rst @@ -386,7 +386,7 @@ sample code sets SemaphoreP/HwiP to be used from external memory block: /* Get the Hw Attrs */ osal_ret = Osal_getHwAttrs(&hwAttrs); - if (osal_ret != osal_OK) + if (osal_ret != osal_OK) { return (false); } diff --git a/source/rtos/Tools/Code_Composer_Studio/_Multi_Core_System_Analyzer.rst b/source/rtos/Tools/Code_Composer_Studio/_Multi_Core_System_Analyzer.rst index c5aa9d192..ead92f2f0 100644 --- a/source/rtos/Tools/Code_Composer_Studio/_Multi_Core_System_Analyzer.rst +++ b/source/rtos/Tools/Code_Composer_Studio/_Multi_Core_System_Analyzer.rst @@ -193,7 +193,7 @@ MCSDK. may timeout resulting in uncorrelated data. In this case the data can be saved to a binary file and post process for correlation to work. -.. rubric:: uia_1_00_04_35 : Tutorial 1 and Tutorial 2 do not build +.. rubric:: uia_1_00_04_35 : Tutorial 1 and Tutorial 2 do not build properly. :name: uia_1_00_04_35-tutorial-1-and-tutorial-2-do-not-build-properly. @@ -206,7 +206,7 @@ MCSDK. the UIAMetaData.xs file. Then delete the folder from your project and rebuild. -.. rubric:: uia_1_03_00_02 : JTAG Transport does not work properly on +.. rubric:: uia_1_03_00_02 : JTAG Transport does not work properly on some devices. :name: uia_1_03_00_02-jtag-transport-does-not-work-properly-on-some-devices. diff --git a/source/rtos/Tools/Code_Composer_Studio/_XDS100_Emulator_Info.rst b/source/rtos/Tools/Code_Composer_Studio/_XDS100_Emulator_Info.rst index 16e8ba5c6..9be2e126a 100644 --- a/source/rtos/Tools/Code_Composer_Studio/_XDS100_Emulator_Info.rst +++ b/source/rtos/Tools/Code_Composer_Studio/_XDS100_Emulator_Info.rst @@ -60,7 +60,7 @@ features (Please check your vendor for hardware details): - XDS100v1 emulators are only recommended for users who need to use Code Composer Studio v3.3, anyone using Code Composer Studio v4 or later should consider an XDS100v2 or later emulator due to the - increased performance.  Some of our 3rd Party partners have + increased performance. Some of our 3rd Party partners have implemented XDS100v2 emulators that can also operate in v1 mode for compatibility with Code Composer Studio v3.3. - XDS100v3 emulators are recommended for users who require support for @@ -130,7 +130,7 @@ below features are supported: - LED to indicate IEEE 1149.7 Class 4 operation. - LED to indicate operation in adapter mode. -.. rubric:: Features NOT supported  +.. rubric:: Features NOT supported :name: features-not-supported - It does not support `Real Time Data eXchange @@ -169,7 +169,7 @@ XDS100v3 is needed. |
| | | | **Code Composer Studio v5.1.x Support** (XDS100v1, XDS100v2 and | -| XDS100v3 hardware) | +| XDS100v3 hardware) | | | | .. raw:: html | | | @@ -182,27 +182,27 @@ XDS100v3 is needed. | | Version** | Release/Version | | | | | *** | | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C28xx     | v1, v2, v3 | `Code Composer | Additional SW | -|             |                 | Studio v5 | patch required | -| |                 | page `__ and | | +| | | _v5>`__ and | | | | | newer | | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C54xx | v1, v2, v3 | - as above - | - as above - | +| TMS320C54xx | v1, v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C55xx | v1, v2, v3  | - as above - | - as above - | +| TMS320C55xx | v1, v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ | TMS320C674x | v1, v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C64x+ | v1, v2, v3  | - as above - | - as above - | +| TMS320C64x+ | v1, v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C66x | v1, v2, v3  | - as above - | - as above - | +| TMS320C66x | v1, v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ -| ARM9 | v2, v3  | - as above - | - as above - | +| ARM9 | v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ | ARM Cortex A9 | v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ @@ -211,13 +211,13 @@ XDS100v3 is needed. | ARM Cortex | v2, v3 | - as above - | - as above - | | M3/M4 | | | | +-----------------+-----------------+-----------------+-----------------+ -| ARM Cortex R4 | v2, v3  | - as above - | - as above - | +| ARM Cortex R4 | v2, v3 | - as above - | - as above - | +-----------------+-----------------+-----------------+-----------------+ | -A. Install Code Composer Studio 5.1.x (XDS100v1 and XDS100v2 support is -included) as per the table above **before ** connecting XDS100 USB +A. Install Code Composer Studio 5.1.x (XDS100v1 and XDS100v2 support is +included) as per the table above **before ** connecting XDS100 USB hardware. B. Install the EmuPack with XDS100v3 support. @@ -225,7 +225,7 @@ B. Install the EmuPack with XDS100v3 support. C. Connect the XDS100 hardware #. Make sure the Code Composer Studio 5.1.x and EmuPack with XDS100v3 - support is installed FIRST **before** plugging in the XDS100 HW to + support is installed FIRST **before** plugging in the XDS100 HW to the PC. #. Connect USB cable from the PC to the XDS100 hardware. Connect the JTAG to the target board (be careful to plug it in correctly: pin 1 @@ -268,16 +268,16 @@ D. Setup Code Composer Studio v5.1.x | | Version** | Release/Version | | | | | *** | | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C28xx     | v1, | `Code Composer | No additional | -|             | v2              | Studio | SW required for | -| |                 | v4.1 | | -| |                 | `__ and | | -| |   | newer | | +| TMS320C28xx | v1, | `Code Composer | No additional | +| | v2 | Studio | SW required for | +| | | v4.1 | | +| | | `__ and | | +| | | newer | | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C54xx | v1, v2 | - as above - | | +| TMS320C54xx | v1, v2 | - as above - | | +-----------------+-----------------+-----------------+-----------------+ -| TMS320C55xx | v1, v2 | - as above - | | +| TMS320C55xx | v1, v2 | - as above - | | +-----------------+-----------------+-----------------+-----------------+ | TMS320C674x | v1, v2 | - as above - | | +-----------------+-----------------+-----------------+-----------------+ @@ -302,8 +302,8 @@ D. Setup Code Composer Studio v5.1.x | -A. Install Code Composer Studio 4.x (XDS100 SW support is included) as -per the table above **before ** connecting XDS100 USB hardware. +A. Install Code Composer Studio 4.x (XDS100 SW support is included) as +per the table above **before ** connecting XDS100 USB hardware. B. Connect the XDS100 hardware @@ -372,8 +372,8 @@ C. Setup Code Composer Studio v4.x | | | C2000 DSK | included in CCS | | | | Version | Installation. | | | | (version | No additional | -| | | #3.3.81.28, 3.3 | SW required. | -| | | .83.16 or | | +| | | #3.3.81.28, 3.3 | SW required. | +| | | .83.16 or | | | | | newer) | | +-----------------+-----------------+-----------------+-----------------+ | TMS320C674x | v1 | CCS v3.3 | Included with | @@ -814,7 +814,7 @@ stick and "Target Connect" worked afetr re-starting CCSv4 available from TI `here `__. - A: TMS320C674x: The Blackhawk `XDS560 `__\ (TI - part #TMDSEMU560U  for USB and TI part #TMDSEMU560PCI for PCI) are + part #TMDSEMU560U for USB and TI part #TMDSEMU560PCI for PCI) are available from TI `here `__. The Spectrum Digital `XDS510 `__\ (TI part @@ -879,7 +879,7 @@ for every action - With CCS v4.1 (with the XDS100v2 SW) and above you can plug more than one XDS100 on a single PC. This is not supported with CCSv3.3. - Each XDS100 must have a unique serial number. Run xds100serial.exe - installed under CCSv4.1 "/ccsv4/common/uscif/utility" to + installed under CCSv4.1 "/ccsv4/common/uscif/utility" to get the serial number of each connected XDS100 emulator. Create Target Configuration for 2 emulators, Under “connection properties”, change “emulator selection” to “select by serial number” option. @@ -1544,13 +1544,13 @@ now be able to use your XDS100 with CCS. - Please note that this CPLD update is designed for use with CCS v4.1.1 and newer. -.. rubric:: Q: How do I perform a system reset (SRST) using - the XDS100v3? +.. rubric:: Q: How do I perform a system reset (SRST) using + the XDS100v3? :name: q-howdo-iperform-a-system-reset-srstusing-thexds100v3 -| A: There is an issue in the FPGA VHDL released in the XDS100v3 Design - Kit v1.0 on 1 June 2011 which inadvertently disables this feature.  It - will be corrected in the next XDS100v3 Design Kit update.  +| A: There is an issue in the FPGA VHDL released in the XDS100v3 Design + Kit v1.0 on 1 June 2011 which inadvertently disables this feature. It + will be corrected in the next XDS100v3 Design Kit update. .. rubric:: Older Versions :name: older-versions diff --git a/source/rtos/Tools/Code_Composer_Studio/_XDS560_Emulator_Info.rst b/source/rtos/Tools/Code_Composer_Studio/_XDS560_Emulator_Info.rst index 2d1056b44..9082d8a01 100644 --- a/source/rtos/Tools/Code_Composer_Studio/_XDS560_Emulator_Info.rst +++ b/source/rtos/Tools/Code_Composer_Studio/_XDS560_Emulator_Info.rst @@ -191,7 +191,7 @@ N/A | **`TMDSADP1460 `__** | **14e_TI-60t_TI**\ :sup:`6` - **`701282 `__**\ :sup:`7` + **`701282 `__**\ :sup:`7` N/A diff --git a/source/rtos/index_faq.rst b/source/rtos/index_faq.rst index 35867ca2c..b16eecf74 100644 --- a/source/rtos/index_faq.rst +++ b/source/rtos/index_faq.rst @@ -306,7 +306,7 @@ Guide `. | .. rubric:: How can I optimize the build time when rebuilding the - Processor SDK RTOS ? + Processor SDK RTOS ? :name: how-can-i-optimize-the-build-time-when-rebuilding-the-processor-sdk-rtos Processor SDK RTOS top level build will rebuild IPC, all components @@ -429,7 +429,7 @@ projects, users can follow the sequence provided below: Each low level driver (LLD) in the PDK package contains two versions of the driver library. The naming conventions are as follows: -- **Generic Core-specific Driver Library** : +- **Generic Core-specific Driver Library** : ti.drv.. Example: ti.drv.gpio.aa15fg (A15 core-specific GPIO driver library) @@ -845,7 +845,7 @@ Commissioning on KeyStone I and II Devices Filesystem Support ================== -.. rubric:: What filesystem support if provided by Processor SDK RTOS ? +.. rubric:: What filesystem support if provided by Processor SDK RTOS ? Can I use UBIFS, RAMFS, or FATFS with TI RTOS when using external non-volatile memory devices? :name: what-filesystem-support-if-provided-by-processor-sdk-rtos-can-i-use-ubifs-ramfs-or-fatfs-with-ti-rtos-when-using-external-non-volatile-memory-devices @@ -963,7 +963,7 @@ to add correct coreID to the configuration to their BIOS configuration to allow the hardware interrupts to be routed to the secondary core. For example on AM572x which has 2 A15 cores, to run the TI RTOS example -on secondary ARM core, application users need to add : +on secondary ARM core, application users need to add : :: @@ -1008,7 +1008,7 @@ clock module. The GEL is created with the assumption that the DSP1 developers will use GPtimer5 and DSP2 users will use GPtimer6 to source clock module. This means that DSP2 developers will need to add configuration script to change the clock source to GPtimer6. Try to add -the following in your DSP2.cfg : +the following in your DSP2.cfg : :: diff --git a/source/system/Demo_User_Guides/Benchmark_Demo_User_Guide.rst b/source/system/Demo_User_Guides/Benchmark_Demo_User_Guide.rst index f0db2c190..ad4830550 100644 --- a/source/system/Demo_User_Guides/Benchmark_Demo_User_Guide.rst +++ b/source/system/Demo_User_Guides/Benchmark_Demo_User_Guide.rst @@ -48,7 +48,7 @@ Get Started 4. Connect an ethernet cable from your ethernet switch or router to the AM64x EVM -5. Connect your PC to the same ethernet switch or router +5. Connect your PC to the same ethernet switch or router 6. Connect the UART (J26 via USB cable) to the PC's USB port. @@ -63,18 +63,18 @@ Get Started .. Image:: /images/OOB_Linux_ifconfig.png 10. On the PC, open a Internet Browser and enter in the - following: \ http://IP_ADDRESS_OF_AM64x_EVM:8081, for example, http://192.168.86.198:8081 + following: \ http://IP_ADDRESS_OF_AM64x_EVM:8081, for example, http://192.168.86.198:8081 11. The following web page will pop up: .. Image:: /images/OOB_GUI_root.png -12. Click on the "Benchmark Demo":  +12. Click on the "Benchmark Demo": .. Image:: /images/OOB_GUI_stats.png 13. With the current release, the R5F app for each R5F core are fixed. User can only - change the "Options" for each core, then click "LOAD" to refresh the statistics  + change the "Options" for each core, then click "LOAD" to refresh the statistics +-------------+------------------+----------------------+-----------------------------------------------------------+ | **R5 Core** | **App Name** | Default Option | **Description** | @@ -82,7 +82,7 @@ Get Started | 0_0 | ADC and PWM Loop | 8Khz | ADC/PWM benchmark for R5 5 ADC sample read & 1 PWM write | | | | | This is not enabled in current release. | +-------------+------------------+----------------------+-----------------------------------------------------------+ -| 0_1  | CFFT | 1Khz & 128pt | CMSIS CFFT benchmark for R5 | +| 0_1 | CFFT | 1Khz & 128pt | CMSIS CFFT benchmark for R5 | +-------------+------------------+----------------------+-----------------------------------------------------------+ | 1_0 | FIR Filtering | 1Khz | CMSIS FIR filtering benchmark for R5 320pt & 29-tap | +-------------+------------------+----------------------+-----------------------------------------------------------+ @@ -97,11 +97,11 @@ Software Architecture Building Blocks --------------- -- **User Interface:** The GUI was built by using `GUI Composer `__. The +- **User Interface:** The GUI was built by using `GUI Composer `__. The Benchmark Demo is the second page where inputs and outputs can be accessed. -- **Web Server:** The benchmark data is sent between the GUI and the +- **Web Server:** The benchmark data is sent between the GUI and the AM64x via HTTP communication. New data are pulled from the AM64x and sent to the GUI every second, while data sending from the GUI to the AM64x is transmitted every time "Load" is clicked. The data are @@ -113,7 +113,7 @@ Building Blocks MCU+ SDK for more details. - Linux application code handles the IPC RPMsg\_char and the JSON - file update for A53  + file update for A53 - Web server code is built on Node JS @@ -156,13 +156,13 @@ is a JSON string containing the input/output benchmark data. JSON ~~~~ -A JSON file has been used to exchange structured information between the -web server and the A53 Linux application (a user space application -program). It will read the user input such as the input application and +A JSON file has been used to exchange structured information between the +web server and the A53 Linux application (a user space application +program). It will read the user input such as the input application and parameters used to run on the desired R5F core. On the other hand, the A53 Linux application will also get the benchmark data from the R5 cores and then update the JSON file accordingly. The updated JSON file -will then be displayed on the GUI every second.      +will then be displayed on the GUI every second. Build Baremetal Demos and Update SD card ---------------------------------------- @@ -183,11 +183,11 @@ Directory Structure The source code can be found at `[this link] `__. +------+--------------------------------------------------+----------------------------------------------------------------------------------------+ -| | **Directory Name** | **Description** | +| | **Directory Name** | **Description** | +======+==================================================+========================================================================================+ | 1 | apps/benchmark\_demo/webserver\_app/app | GUI code and component files | +------+--------------------------------------------------+----------------------------------------------------------------------------------------+ -| 2 | apps/benchmark\_demo/webserver\_app/linux\_app | Linux application code handles the IPC RPMsg\_char and the JSON file update for A53  | +| 2 | apps/benchmark\_demo/webserver\_app/linux\_app | Linux application code handles the IPC RPMsg\_char and the JSON file update for A53 | +------+--------------------------------------------------+----------------------------------------------------------------------------------------+ | 3 | apps/benchmark\_demo/webserver\_app/webserver | Web server and node files | +------+--------------------------------------------------+----------------------------------------------------------------------------------------+ diff --git a/source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst b/source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst index 1c9f4aa55..c1b4ed8e0 100644 --- a/source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst +++ b/source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst @@ -24,13 +24,13 @@ Hardware Prerequisites - TI AM64x GP EVM and power supply - - TI FSI serial interface (FSI) adapter board: `TMDSFSIADAPEVM `_ + - TI FSI serial interface (FSI) adapter board: `TMDSFSIADAPEVM `_ - 3x Seconary Nodes, for each Seconary Node: - TI F280049 Launchpad: `LAUNCHXL-F280049C `_ - - TI FSI serial interface (FSI) adapter board: `TMDSFSIADAPEVM `_ + - TI FSI serial interface (FSI) adapter board: `TMDSFSIADAPEVM `_ - TI GaNFET BoosterPack: `BOOSTXL-3PHGANINV `_ @@ -835,7 +835,7 @@ Directory Contents The source code can be found at `[this link] `__. +----+------------------------------------------------------+-------------------------------+ -| | **Directory Name** | **Description** | +| | **Directory Name** | **Description** | +====+======================================================+===============================+ | 1 | apps/servo_drive_demo/c2000_slave/ | Contains a README, C2000 | | | | binary for the F28004x | From 9885e14a7ec2cc70319ab30cc7e856ec99681bf3 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 10:59:08 -0600 Subject: [PATCH 2/9] style: use isonum standard symbol definitions for reg Use the isonum standard symbol defintions for unicode characters like the registered sign. Signed-off-by: Randolph Sapp --- .../_66AK2G02_ICE_EVM_Hardware_setup.rst | 5 +++-- .../EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst | 4 +++- .../EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst | 4 +++- .../EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst | 4 +++- .../EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst | 4 +++- source/devices/AM62AX/linux/Linux_Performance_Guide.rst | 5 +++-- source/devices/AM62PX/linux/Linux_Performance_Guide.rst | 5 +++-- source/devices/AM62X/linux/Linux_Performance_Guide.rst | 5 +++-- source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst | 8 +++++--- .../linux/_Release_Specific_Kernel_Performance_Guide.rst | 5 +++-- .../_AM335x_Power_Management_User_Guide.rst | 4 +++- .../IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst | 4 +++- .../Kernel/Kernel_Drivers/Storage/MMC-SD.rst | 4 +++- .../PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst | 4 ++-- .../PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst | 4 +++- .../_CoreSDK_RT_Kernel_Performance_Guide.rst | 6 ++++-- .../Performance_Guide/_Kernel_Performance_Guide.rst | 6 ++++-- .../Performance_Guide/_RT_Kernel_Performance_Guide.rst | 7 ++++--- .../_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst | 4 +++- 19 files changed, 61 insertions(+), 31 deletions(-) diff --git a/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst b/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst index b98f8bd8e..c7ad54c6c 100644 --- a/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst +++ b/source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst @@ -1,3 +1,4 @@ +.. include:: 66AK2G02 ICE EVM Hardware Setup ================================ @@ -11,7 +12,7 @@ industrial communications applications for the Texas Instrument’s Keystone2 System-on-Chip (SoC) 66AK2G02. The K2G SOC (66AK2G02) is the new device from TI’s Keystone II architecture with -- ARM® Cortex® -A15 Microprocessor Unit (ARM A15) Subsystem at up to +- ARM\ |reg| Cortex\ |reg| -A15 Microprocessor Unit (ARM A15) Subsystem at up to 600MHz - C66x Fixed- and Floating-Point VLIW DSP Subsystem at up to 600MHz - Two Programmable Real-Time Unit and Industrial Communication @@ -20,7 +21,7 @@ device from TI’s Keystone II architecture with RAM - Up to 36-Bit DDR3 External Memory Interface (EMIF) with ECC (32-Bit Data + 4-Bit ECC) -- PCI-Express® 2.0 Port with Integrated PHY +- PCI-Express\ |reg| 2.0 Port with Integrated PHY - Three Multichannel Audio Serial Port (McASP) Peripherals - Multichannel Buffered Serial Port (McBSP) - Six Enhanced High Resolution Pulse Width Modulation (eHRPWM) diff --git a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst index b2eb84f2c..47621f1b6 100644 --- a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/AM572x_GP_EVM_Hardware_Setup AM572x GP EVM Hardware Setup @@ -7,7 +9,7 @@ AM572x GP EVM Hardware Setup :name: description The AM572x Evaluation Module provides an affordable platform to quickly -start evaluation of Sitara™ ARM® Cortex®-A15 AM57x Processors (AM5728, +start evaluation of Sitara™ ARM\ |reg| Cortex\ |reg|\ -A15 AM57x Processors (AM5728, AM5726, AM5718, AM5716) and accelerate development for HMI, machine vision, networking, medical imaging and many other industrial applications. It is a development platform based on the dual ARM diff --git a/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst index 2ccd80bdf..af5b377b8 100644 --- a/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst @@ -1,3 +1,5 @@ +.. include:: + AM62Px SK EVM Hardware Setup ============================ @@ -5,7 +7,7 @@ AM62Px SK EVM Hardware Setup The AM62Px starter kit (SK) evaluation module (EVM) is a stand-alone test and development platform built around the AM62Px system-on-a-chip (SoC). AM62Px processors are comprised of a quad-core 64-bit -Arm®-Cortex®-A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). +Arm\ |reg|\ -Cortex\ |reg|\ -A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). To know more on how to quickly start Linux on the AM62Px Starter Kit EVM (SK EVM) and run out-of-box demos, you can refer `AM62Px Starter Kit EVM Quick Start Guide. `__ diff --git a/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst index 2c1c7d921..7ea1964ed 100644 --- a/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst @@ -1,3 +1,5 @@ +.. include:: + AM62x SK EVM Hardware Setup =========================== @@ -5,7 +7,7 @@ AM62x SK EVM Hardware Setup The AM62x starter kit (SK) evaluation module (EVM) is a stand-alone test and development platform built around the AM62x system-on-a-chip (SoC). AM62x processors are comprised of a quad-core 64-bit -Arm®-Cortex®-A53 microprocessor, single-core Arm Cortex-R5F microcontroller (MCU) and an Arm +Arm\ |reg|\ -Cortex\ |reg|\ -A53 microprocessor, single-core Arm Cortex-R5F microcontroller (MCU) and an Arm Cortex-M4F MCU. To know more on how to quickly start Linux on the AM62x Starter Kit EVM (SK EVM) and run out-of-box demos, you can refer `AM62x Starter Kit EVM Quick Start Guide. `__ diff --git a/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst index 8f953e351..37e455800 100644 --- a/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst @@ -1,3 +1,5 @@ +.. include:: + J722S EVM Hardware Setup ==================================================== @@ -5,7 +7,7 @@ J722S EVM Hardware Setup The J722S evaluation module (or TDA4VEN and AM67 EVM) is a stand-alone test and development platform built around the J722S system-on-a-chip (SoC). J722S processors are comprised of a quad-core 64-bit -Arm®-Cortex®-A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). +Arm\ |reg|\ -Cortex\ |reg|\ -A53 microprocessor, dual-core Arm Cortex-R5F microcontroller (MCU). The EVM gives developers the basic resources needed for most general‐purpose type projects. .. rubric:: J722S EVM diff --git a/source/devices/AM62AX/linux/Linux_Performance_Guide.rst b/source/devices/AM62AX/linux/Linux_Performance_Guide.rst index 9d30e3d51..d41ce30f6 100644 --- a/source/devices/AM62AX/linux/Linux_Performance_Guide.rst +++ b/source/devices/AM62AX/linux/Linux_Performance_Guide.rst @@ -1,3 +1,4 @@ +.. include:: ====================================== Linux 10.00 Performance Guide @@ -274,8 +275,8 @@ Execute the benchmark with the following: CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/devices/AM62PX/linux/Linux_Performance_Guide.rst b/source/devices/AM62PX/linux/Linux_Performance_Guide.rst index 5da49d250..ec37b1dd3 100644 --- a/source/devices/AM62PX/linux/Linux_Performance_Guide.rst +++ b/source/devices/AM62PX/linux/Linux_Performance_Guide.rst @@ -1,3 +1,4 @@ +.. include:: ====================================== Linux 10.00 Performance Guide @@ -296,8 +297,8 @@ Execute the benchmark with the following: CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/devices/AM62X/linux/Linux_Performance_Guide.rst b/source/devices/AM62X/linux/Linux_Performance_Guide.rst index 408f1922a..df95bcc17 100644 --- a/source/devices/AM62X/linux/Linux_Performance_Guide.rst +++ b/source/devices/AM62X/linux/Linux_Performance_Guide.rst @@ -1,3 +1,4 @@ +.. include:: ====================================== Linux 10.00 Performance Guide @@ -300,8 +301,8 @@ Execute the benchmark with the following: CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst b/source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst index 5673ee28d..b851d2406 100644 --- a/source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst +++ b/source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst @@ -1,3 +1,5 @@ +.. include:: + ====================================== RT-linux 10.00 Performance Guide ====================================== @@ -283,8 +285,8 @@ resulting in a score that is double the bandwidth LMBench will show. CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. @@ -529,7 +531,7 @@ PCIe-ETH "256","939" - Command: iperf3 -c $server_ip -w $window_size -- PCIe-Ethernet Card being used: Intel® 82574L Gigabit Ethernet Controller +- PCIe-Ethernet Card being used: Intel\ |reg| 82574L Gigabit Ethernet Controller PCIe-NVMe-SSD ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst b/source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst index 84ce31417..e201eb686 100644 --- a/source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst +++ b/source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst @@ -1,3 +1,4 @@ +.. include:: ====================================== Linux 10.01 Performance Guide @@ -310,8 +311,8 @@ Execute the benchmark with the following: CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst b/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst index ace60e788..5fed0fe34 100644 --- a/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst +++ b/source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/AM335x_Power_Management_User_Guide AM335x Power Management User Guide @@ -294,7 +296,7 @@ insight in to the power consumption of select Sitara processors. Summary `__ This document discusses the power consumption for common system -application usage scenarios for the AM335x ARM® Cortex™-A8 +application usage scenarios for the AM335x ARM\ |reg| Cortex™-A8 Microprocessors (MPUs). - `AM335x Power Management Standby User's diff --git a/source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst b/source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst index d03b4942f..8b2b42ee5 100644 --- a/source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst +++ b/source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst @@ -1,6 +1,8 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Processor-sdk-MultiWay-of-ARM-DSP-Communication -This document describes the ways of communication on TI multicore devices. The individual cores in an applicatioin can assume the roles of Host/Device or Master/Slave. This discussion here assumes the Host/Master is ARM® cluster running SMP/Linux and the Device/Slave is the C6xx DSP cluster running TI-RTOS. +This document describes the ways of communication on TI multicore devices. The individual cores in an applicatioin can assume the roles of Host/Device or Master/Slave. This discussion here assumes the Host/Master is ARM\ |reg| cluster running SMP/Linux and the Device/Slave is the C6xx DSP cluster running TI-RTOS. .. rubric:: OpenCL :name: opencl diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst index 87618ed84..d6a75963c 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Linux_Core_MMC/SD_User%27s_Guide MMC/SD @@ -8,7 +10,7 @@ Introduction The multimedia card high-speed/SDIO (MMC/SDIO) host controller provides an interface between a local host (LH) such as a microprocessor unit -(MPU) or digital signal processor (DSP) and either MMC, SD® memory +(MPU) or digital signal processor (DSP) and either MMC, SD\ |reg| memory cards, or SDIO cards and handles MMC/SDIO transactions with minimal LH intervention. diff --git a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst index ba46b58db..7eb76e2c9 100644 --- a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst +++ b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst @@ -1,4 +1,4 @@ -| +.. include:: .. rubric:: **Boards Supported** @@ -6,7 +6,7 @@ .. rubric:: `AM65x evaluation module (EVM) `__ -The AM65x Evaluation Module provides a platform to quickly start evaluation of Sitara™ Arm® Cortex®-A53 AM65x Processors (AM6548, AM6546, AM6528, AM6527, AM6526) and accelerate development for HMI, networking, patient monitoring, and other industrial applications. It is a development platform based on the quad core Cortex-A53, dual Cortex-R5F processor that is integrated with ample connectivity such as PCIe, USB 3.0/2.0, Gigabit Ethernet, PRU_ICSSG Ethernet, etc. +The AM65x Evaluation Module provides a platform to quickly start evaluation of Sitara™ Arm\ |reg| Cortex\ |reg|\ -A53 AM65x Processors (AM6548, AM6546, AM6528, AM6527, AM6526) and accelerate development for HMI, networking, patient monitoring, and other industrial applications. It is a development platform based on the quad core Cortex-A53, dual Cortex-R5F processor that is integrated with ample connectivity such as PCIe, USB 3.0/2.0, Gigabit Ethernet, PRU_ICSSG Ethernet, etc. On this platform one CPSW Ethernet port and two ICSSG2 Ethernet ports are available for use. diff --git a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst index c260e1d4e..3f784ea8d 100644 --- a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst +++ b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU-ICSS_Ethernet.rst @@ -1,3 +1,5 @@ +.. include:: + .. _pru_icss_ethernet: PRU-ICSS Ethernet @@ -28,7 +30,7 @@ Archives section at the bottom of this page. The AM3359 Industrial Communications Engine (ICE) is a development platform targeted for systems that specifically focus on the industrial -communications capabilities of the Sitara AM335x ARM® Cortex™-A8 +communications capabilities of the Sitara AM335x ARM\ |reg| Cortex™-A8 Processors The AM335x ARM Cortex-A8 Processors integrate the Programmable Real-time diff --git a/source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst b/source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst index 68aa5cd30..f06ffe250 100644 --- a/source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst +++ b/source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst @@ -1,3 +1,5 @@ +.. include:: + ====================================== RT-linux 09.01.00 Performance Guide ====================================== @@ -297,8 +299,8 @@ Table: **Stream** CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst b/source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst index ba4e5781c..a7877baf5 100644 --- a/source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst +++ b/source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_Kernel_Performance_Guide @@ -266,8 +268,8 @@ Table: **Stream** CoreMarkPro ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst b/source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst index 07834df14..964de312b 100644 --- a/source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst +++ b/source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst @@ -1,5 +1,6 @@ -.. http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_RT_Kernel_Performance_Guide +.. include:: +.. http://processors.wiki.ti.com/index.php/Processor_SDK_Linux_RT_Kernel_Performance_Guide .. rubric:: **Read This First** :name: read-this-first-rt-kernel-perf-guide @@ -257,8 +258,8 @@ Table: *Stream* **CoreMarkPro** -CoreMark®-Pro is a comprehensive, advanced processor benchmark that works with -and enhances the market-proven industry-standard EEMBC CoreMark® benchmark. +CoreMark\ |reg|\ -Pro is a comprehensive, advanced processor benchmark that works with +and enhances the market-proven industry-standard EEMBC CoreMark\ |reg| benchmark. While CoreMark stresses the CPU pipeline, CoreMark-Pro tests the entire processor, adding comprehensive support for multicore technology, a combination of integer and floating-point workloads, and data sets for utilizing larger memory subsystems. diff --git a/source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst b/source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst index c9a5d720b..9cbbd8dc3 100644 --- a/source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst +++ b/source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Running_IPC_Examples_on_DRA7xx/AM572x The sections relevant to AM57xx have been pulled from the `Debugging Tools and Techniques With IPC3.x Application Note `_ and placed here. @@ -8,7 +10,7 @@ During development of software, it is common to encounter issues that must be de robust software offering. When developing software that uses the IPC3.x product for inter-processor communication, there are tools and techniques available to aid in the debugging process. These tools and techniques help to more quickly understand and debug the issue. This document addresses all three -HLOS’s supported by IPC3.x: Android™ platform, Linux®, and QNX®. Where applicable, differences +HLOS’s supported by IPC3.x: Android™ platform, Linux\ |reg|\ , and QNX\ |reg|\ . Where applicable, differences between the OS's are noted. This document aims to provide tools, techniques, and resources for debugging issues encountered when using the IPC3.x to communicate with remote core software. From dfbca4e80c2d13f4e78f18bde0784f60839bcc3e Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:13:13 -0600 Subject: [PATCH 3/9] style: use isonum standard symbols for micro Use isonum standard symbol definitions for the micro symbol. Signed-off-by: Randolph Sapp --- .../_AM572x_GP_EVM_Hardware_Setup.rst | 2 +- .../_TMDXIDK5728_Hardware_Setup.rst | 46 +++++++++---------- source/linux/Industrial_Protocols/_SORTE.rst | 4 +- .../Device_Drivers/_TSIP.rst | 4 +- .../PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst | 4 +- .../PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst | 3 +- 6 files changed, 35 insertions(+), 28 deletions(-) diff --git a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst index 47621f1b6..a0673fd2b 100644 --- a/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst @@ -34,7 +34,7 @@ and dual ARM Cortex-M4 cores. **Other components:** -- µSD card with Linux SDK +- |micro|\ SD card with Linux SDK - USB-to-serial debug cable - HDMI cable for optional external display - LCD brackets diff --git a/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst index e9b43f9d4..d407cabae 100644 --- a/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_TMDXIDK5728_Hardware_Setup.rst @@ -35,29 +35,29 @@ designed to help you through the initial setup of the EVM. | -+--------------------------------------------------------------------------+ -| **1. Once you have received the TI-RTOS or Linux™ software from your TI | -| representative, create a bootable µSD card (using the included blank | -| µSD) and insert it into the EVM** | -+--------------------------------------------------------------------------+ -| .. raw:: html | -| | -|
| -| | -| .. raw:: html | -| | -|
| -| | -| .. raw:: html | -| | -|
| -| | -| .. raw:: html | -| | -|
| -| | -| .. Image:: /images/IDK_uSD.png | -+--------------------------------------------------------------------------+ ++------------------------------------------------------------------------------+ +| **1. Once you have received the TI-RTOS or Linux™ software from your TI | +| representative, create a bootable |micro|\ SD card (using the included blank | +| |micro|\ SD) and insert it into the EVM** | ++------------------------------------------------------------------------------+ +| .. raw:: html | +| | +|
| +| | +| .. raw:: html | +| | +|
| +| | +| .. raw:: html | +| | +|
| +| | +| .. raw:: html | +| | +|
| +| | +| .. Image:: /images/IDK_uSD.png | ++------------------------------------------------------------------------------+ +--------------------------------------------------------------------------+ | **2. Connect the power cable to the power jack on the board and plug in | diff --git a/source/linux/Industrial_Protocols/_SORTE.rst b/source/linux/Industrial_Protocols/_SORTE.rst index 5db14a1e2..c680e94dc 100644 --- a/source/linux/Industrial_Protocols/_SORTE.rst +++ b/source/linux/Industrial_Protocols/_SORTE.rst @@ -1,3 +1,5 @@ +.. include:: + ********************************** SORTE ********************************** @@ -9,7 +11,7 @@ Overview The Simple Open Real-time Ethernet protocol (SORTE) is a TI-developed industrial Ethernet protocol that -supports 4-µs cycle time. The SORTE protocol operates exclusively on +supports 4-\ |micro|\ s cycle time. The SORTE protocol operates exclusively on TI's PRU-ICSS (Programmable Real-Time Unit Subsystem and Industrial Communication SubSystem), and therefore, the ARM Cortex-A8, A9 or A15 processors (depending on the device family) are available for industrial applications. diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst index f262d010f..88a6487a0 100644 --- a/source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst +++ b/source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Processor_SDK_RTOS_TSIP Overview @@ -18,7 +20,7 @@ serial clocks as redundant sources for all transmit and receive data signals, or one frame sync and serial clock for transmit and the second frame sync and clock for receive. The standard serial data rate for each TSIP transmit and receive data signal is 8.192 Mbps. The standard frame -sync is a one or more bit wide pulse that occurs once every 125 µs or a +sync is a one or more bit wide pulse that occurs once every 125 |micro|\ s or a minimum of one serial clock period every 1024 serial clocks. At the standard rate and default configuration there are eight transmit diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst index 9f0590600..f355ea4c7 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://ap-fpdsp-swapps.dal.design.ti.com/index.php/Processor_SDK_RTOS_IOLINK_FIRMWARE Introduction @@ -28,7 +30,7 @@ Following are high-level IOLINK FW features: +-----------------------------------+-----------------------------------+ | Baud Rate | COM1/COM2/COM3 | +-----------------------------------+-----------------------------------+ -| Minumum Cycle Time | 400 µs | +| Minumum Cycle Time | 400 |micro|\ s | +-----------------------------------+-----------------------------------+ | Maximum Cycle Time | 132 ms | +-----------------------------------+-----------------------------------+ diff --git a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst index cae7bc552..7216ccd02 100644 --- a/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst +++ b/source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst @@ -1,3 +1,4 @@ +.. include:: Introduction ============ @@ -18,7 +19,7 @@ Protocol Overview ================= The SORTE protocol is a TI-developed industrial Ethernet protocol that -supports 4-µs cycle time. The SORTE protocol operates on the PRU-ICSS, +supports 4-\ |micro|\ s cycle time. The SORTE protocol operates on the PRU-ICSS, which is an industrial peripheral within Sitara and KeyStone processors from Texas Instruments. SORTE protocol operates exclusively on the PRU-ICSS; therefore, the ARM Cortex-A8, A9 or A15 processors – depending From b1eb51d78c1960c07592730124b50acd692fc7c5 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:19:09 -0600 Subject: [PATCH 4/9] style: use i2c notation instead of unicode Use standard I2C notation instead of using the unicode power of 2 symbol. Signed-off-by: Randolph Sapp --- source/common/EVM_Hardware_Setup/_AM64x_EVM_Hardware_Setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/common/EVM_Hardware_Setup/_AM64x_EVM_Hardware_Setup.rst b/source/common/EVM_Hardware_Setup/_AM64x_EVM_Hardware_Setup.rst index be78bc608..48812ba40 100644 --- a/source/common/EVM_Hardware_Setup/_AM64x_EVM_Hardware_Setup.rst +++ b/source/common/EVM_Hardware_Setup/_AM64x_EVM_Hardware_Setup.rst @@ -24,7 +24,7 @@ headers, multiple boot options and flexible debug capabilities.The starter kit is equipped with AM64x processor and an optimized feature-set to allow the user to create commercial and industrial solutions using Ethernet-based, USB, and serial wired interfaces, two Ethernet Ports for wired connectivity. Using standard -serial protocols such as UART, I²C, and SPI, the starter kit can interface with +serial protocols such as UART, I2C, and SPI, the starter kit can interface with a multitude of other devices, acting as a communications gateway. For Quick Start Quide `click here. `__ From bd4523a3d69850fc0daa6b9d926045ef00361bd3 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:21:55 -0600 Subject: [PATCH 5/9] style: use isonum symbols for degree sign Use isonum standard symbol definitions for the degree sign. Signed-off-by: Randolph Sapp --- .../Examples_and_Demonstrations/_Audio_Pre_Processing.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst b/source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst index bca667901..f0950bd91 100644 --- a/source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst +++ b/source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst @@ -1,3 +1,5 @@ +.. include:: + .. http://processors.wiki.ti.com/index.php/Processor_SDK_RTOS_Audio_Pre-Processing Introduction @@ -15,7 +17,7 @@ The key functions in this use case include: - Read 7 canned audio input files from hard drive into buffers in DDR using GEL function -- Generate 12 virtual mics using BF (Beamforming) (30° apart) +- Generate 12 virtual mics using BF (Beamforming) (30\ |deg| apart) - Apply ASNR (Adaptive Spectral Noise Reduction) on each virtual mic - Use MSS (Multiple Source Selection) to select the best virtual mic from the 12 virtual mics @@ -73,7 +75,7 @@ The application will use AER & VOLIB APIs for its noise reduction processing needs. The following steps are performed for noise reduction: - Use 7 canned audio inputs to generate 12 virtual mics using - BF(Beamforming) (30° apart) + BF(Beamforming) (30\ |deg| apart) - Apply ASNR(Adaptive Spectral Noise Reduction) on each virtual mic - Use MSS(Multiple Source Selection)to select the best virtual mic from the 12 virtual mics From 40618dc9295bb7779afd5c9bb68ced8e33c68e59 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:23:12 -0600 Subject: [PATCH 6/9] style: use vertical bar instead of broken bar Use ascii vertical bar instead of the unicode broken bar symbol. Signed-off-by: Randolph Sapp --- .../Kernel/Kernel_Drivers/Crypto.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst index 5b6a2fde0..95a17d513 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst @@ -49,11 +49,11 @@ kernel configuration. .. code-block:: text Symbol: CRYPTO_DEV_SA2UL [=m] - ¦ Type : tristate - ¦ Prompt: Support for TI security accelerator - ¦ Location: - ¦ -> Cryptographic API (CRYPTO [=y]) - ¦ (1) -> Hardware crypto devices (CRYPTO_HW [=y]) + | Type : tristate + | Prompt: Support for TI security accelerator + | Location: + | -> Cryptographic API (CRYPTO [=y]) + | (1) -> Hardware crypto devices (CRYPTO_HW [=y]) To check if sa2ul module is properly installed, run the below command from the Linux command prompt: From 762e38c46b4860b4164a812c64e4b1ceec4dc59f Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:27:11 -0600 Subject: [PATCH 7/9] fix: remove invisible character Based on the rest of this code snippet, this character should have never been here. Signed-off-by: Randolph Sapp --- source/rtos/PDK_Platform_Software/IPC/_NameServer_Module.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/rtos/PDK_Platform_Software/IPC/_NameServer_Module.rst b/source/rtos/PDK_Platform_Software/IPC/_NameServer_Module.rst index 82863446a..649ee9e5a 100644 --- a/source/rtos/PDK_Platform_Software/IPC/_NameServer_Module.rst +++ b/source/rtos/PDK_Platform_Software/IPC/_NameServer_Module.rst @@ -42,7 +42,7 @@ To create a NameServer instance statically, you can add statements similar to th var nameServerParams = new NameServer.Params; nameServerParams.maxRuntimeEntries = 10; nameServerParams.maxNameLen = 32; - var nameServer0 = NameServer.create("nameServer0", nameServerParams); + var nameServer0 = NameServer.create("nameServer0", nameServerParams); If you want to specify the heap to be used by the NameServer module and a NameServer instance, use configuration statements similar to the following: From e585cd1be762a2ed4bbfcc628af159e2573759fa Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 7 Nov 2024 11:36:01 -0600 Subject: [PATCH 8/9] fix: fix invalid characters in table Fix invalid characters in csv table. An old jira ticket is using unusual characters. Signed-off-by: Randolph Sapp --- source/linux/Release_Specific_PLSDK_Release_Notes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/linux/Release_Specific_PLSDK_Release_Notes.rst b/source/linux/Release_Specific_PLSDK_Release_Notes.rst index dfeaf9e97..6bcd73e73 100644 --- a/source/linux/Release_Specific_PLSDK_Release_Notes.rst +++ b/source/linux/Release_Specific_PLSDK_Release_Notes.rst @@ -259,7 +259,7 @@ Errata Workarounds Available in this Release LCPD-16350,DSS: Frame Buffer Flip/Mirror Feature Using RGB24/BGR24 Packed Format can Result in Pixel Corruption LCPD-9173,i897: USB Stop Endpoint doesnt work in certain circumstances LCPD-17333,[CPTS] GENF (and ESTF) Reconfiguration Issue - LCPD-14186,UDMA-P Host Packet Descriptor’s “0x3FFFFF” Packet Length Mode not Functional + LCPD-14186,"UDMA-P Host Packet Descriptor's ""0x3FFFFF"" Packet Length Mode not Functional" LCPD-1776,"[J6 SATA Adaptation] J6 - Errata i783, SATA Lockup After SATA DPLL Unlock/Relock" LCPD-941,"OMAP4,5: DSS: implement workaround for errata i740" LCPD-1171,DRA7: DMM errata i878 (framebuffer part) @@ -292,7 +292,7 @@ SDK Known Issues PLSDK-2960,am571x-idk,HSR/PRP: Noticed 1 packet loss seen with UDP tests over 60 minute test,None PLSDK-2989,"am335x-evm, am437x-evm, am437x-hsevm, am572x-evm, am572x-hsevm, k2e-evm, k2g-evm, k2l-evm, k2l-hsevm",defconfig build failure: reported diff, PLSDK-3031,"am571x-idk, am572x-idk, am574x-idk",HSR: erroneous A-B forwarding of frames, - PLSDK-3032,"am571x-idk, am572x-idk, am574x-idk","HSR: forwarding of untagged frames in default mode H not according to IEC 62439-3:2016, “5.3.3 DANH receiving from an HSR port”.",None + PLSDK-3032,"am571x-idk, am572x-idk, am574x-idk","HSR: forwarding of untagged frames in default mode H not according to IEC 62439-3:2016, ""5.3.3 DANH receiving from an HSR port"".",None PLSDK-3057,"am335x-evm, am437x-evm, am572x-evm, am654x-evm, am654x-idk",ARMNN with TFLite parser: performance/accuracy issue with quantized mobilenet models,Patch from arm compute library https://review.mlplatform.org/c/ml/ComputeLibrary/+/1620/. PLSDK-3071,"am571x-idk, am572x-evm, am572x-idk, am574x-idk",Dual camera demo: Overlapping of camera and stats panel due to big font size,None PLSDK-3074,am572x-idk,NetJury Test Failure: TC_PRP_4_2_4_____IP_addresses,None From 913535946b20f01869f919f7e069c1f46798d414 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Fri, 6 Dec 2024 16:44:24 -0600 Subject: [PATCH 9/9] fix: Literal blocks in _BOOT_AM335x_AM437x Address some warnings in _BOOT_AM335x_AM437x by properly indenting sections. Signed-off-by: Randolph Sapp --- .../_BOOT_AM335x_AM437x.rst | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst index c8794d449..a0d644c01 100644 --- a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst +++ b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM335x_AM437x.rst @@ -516,8 +516,8 @@ not requiring any additional headers. Following are steps for boot: Please transfer file: CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC - 4. As a next step application binary (without header) can be sent -via XMODEM which will lead to application start executing. +#. As a next step application binary (without header) can be sent via XMODEM + which will lead to application start executing. Booting Via McSPI """"""""""""""""""" @@ -625,12 +625,12 @@ Booting from NAND involves two steps. - If Option 1 is selected, enter image path to flash when prompted as shown below. -:: + :: - Enter image file path + Enter image file path - Provide the complete path (e.g. -//bootloader_boot_nand_a8host__ti.bin) + Provide the complete path (e.g. + //bootloader_boot_nand_a8host__ti.bin) - Enter offset when prompted as shown below. @@ -648,16 +648,16 @@ Booting from NAND involves two steps. - Select ECC for flashing. -:: + :: - Choose the ECC scheme from given options - Enter 1 ---> BCH 8 bit - Enter 2 ---> HAM - Enter 3 ---> T0 EXIT - Please enter ECC scheme type: + Choose the ECC scheme from given options + Enter 1 ---> BCH 8 bit + Enter 2 ---> HAM + Enter 3 ---> T0 EXIT + Please enter ECC scheme type: - Always select BCH8 for bootloader and application as ROM code and -bootloader uses the BCH8 ECC scheme. + Always select BCH8 for bootloader and application as ROM code and + bootloader uses the BCH8 ECC scheme. - Ensure that flash info displayed by tool matches NAND flash in EVM. - After this tool should first erase the required region in flash and