AM263x MCU+ SDK  10.02.00
Release Notes 10.02.00

Attention
1. Also refer to individual module pages for more details on each feature, unsupported features, important usage guidelines.
2. Multi Core ELF image format support has been added (Understanding Multicore ELF image format). RPRC format will be deprecated from SDK 11.0.
3. The default Stack size is 16KB and Heap size 32 KB for SDK examples. This can be adjusted as per application requirement through Memory Configurator in SysCfg or by updating Linker script in case of standalone applications.
4. SDK will be migrated to support CCS Theia from next release (SDK 11.0) and the support for CCS Eclipse will be deprecated.
5. The default SysCfg linked to CCS is an older version and needs to updated to the SDK supported version mentioned below. Please follow steps mentioned in Check Packages as seen by CCS.
Note
The examples will show usage of SW modules and APIs on a specific CPU instance and OS combination.
Unless explicitly noted otherwise, the SW modules would work in both FreeRTOS and no-RTOS environment.
Unless explicitly noted otherwise, the SW modules would work on any of the R5F's present on the SOC.

New in this Release

Feature Module
EDMA Error Handling Support EDMA
Rev A Launchpad Support Board
LIN LLD Support LIN
IEEE1722 Simple Talker/Listener example with PCM data for stereo channel Networking

Device and Validation Information

SOC Supported CPUs EVM Host PC
AM263x R5F AM263x ControlCard Revision E2 (referred to as am263x-cc in code).
Windows 10 64b or Ubuntu 18.04 64b
AM263x R5F AM263x LaunchPad Revision Rev A (referred to as am263x-lp in code) Windows 10 64b or Ubuntu 18.04 64b

Dependent Tools and Compiler Information

Tools Supported CPUs Version
Code Composer Studio R5F 12.8.1
SysConfig R5F 1.23.0 build, build 4000
TI ARM CLANG R5F 4.0.1.LTS
FreeRTOS Kernel R5F 11.1.0
LwIP R5F STABLE-2_2_0_RELEASE
Mbed-TLS R5F 2.13.1

Key Features

Experimental Features

Attention
Features listed below are early versions and should be considered as "experimental".
Users can evaluate the feature, however the feature is not fully tested at TI side.
TI would not support these feature on public e2e.
Experimental features will be enabled with limited examples and SW modules.
Feature Module
Ether-ring Driver Implementation Networking
Ether-ring Demo with Real Time Traffic Generator and Background LwIP traffic Networking

OS Kernel

OS Supported CPUs SysConfig Support Key features tested Key features not tested / NOT supported
FreeRTOS Kernel R5F NA Task, Task notification, interrupts, semaphores, mutexs, timers Task load measurement using FreeRTOS run time statistics APIs. Limited support for ROV features.
FreeRTOS POSIX R5F NA pthread, mqueue, semaphore, clock -
NO RTOS R5F NA See Driver Porting Layer (DPL) below -

Driver Porting Layer (DPL)

Module Supported CPUs SysConfig Support OS support Key features tested Key features not tested / NOT supported
Cache R5F YES FreeRTOS, NORTOS Cache write back, invalidate, enable/disable -
Clock R5F YES FreeRTOS, NORTOS Tick timer at user specified resolution, timeouts and delays -
CpuId R5F NA FreeRTOS, NORTOS Verify Core ID and Cluster ID that application is currently running on -
CycleCounter R5F NA FreeRTOS, NORTOS Measure CPU cycles using CPU specific internal counters -
Debug R5F YES FreeRTOS, NORTOS Logging and assert to any combo of: UART, CCS, shared memory -
Heap R5F NA FreeRTOS, NORTOS Create arbitrary heaps in user defined memory segments -
Hwi R5F YES FreeRTOS, NORTOS Interrupt register, enable/disable/restore, Interrupt prioritization -
MPU R5F YES FreeRTOS, NORTOS Setup MPU and control access to address space -
Semaphore R5F NA FreeRTOS, NORTOS Binary, Counting Semaphore, recursive mutexs with timeout -
Task R5F NA FreeRTOS Create, delete tasks -
Timer R5F YES FreeRTOS, NORTOS Configure arbitrary timers -

Secondary Bootloader (SBL)

Module Supported CPUs SysConfig Support OS support Key features tested Key features not tested / NOT supported
Bootloader R5FSS0-0 YES NORTOS Boot modes: QSPI, UART. All R5F's. RPRC, MCELF, multi-core image format Force Dual Core Mode, Disable Dual Core Switch and R5SS1 only not tested

SOC Device Drivers

Peripheral Supported CPUs SysConfig Support DMA Supported Key features tested Key features not tested / NOT supported
ADC R5F YES Yes. Example: adc_soc_continuous_dma Single software triggered conversion, Multiple ADC trigger using PWM, Result read using DMA, EPWM trip through PPB limit, PPB features, Burst mode, Single and Differential mode, Interrupt with Offset from Aquisition Window, EPWM/ECAP/RTI triggered conversions -
Bootloader R5F YES Yes. DMA enabled for SBL QSPI Boot modes: QSPI, UART. All R5F's -
CMPSS R5F YES NA Asynchronous PWM trip, Digital Filter, Calibration, -
CPSW R5F YES No MAC loopback, PHY loopback, LWIP: Getting IP, Ping, Iperf, Layer 2 MAC, Layer 2 PTP Timestamping and Ethernet CPSW Switch support, TSN stack RMII, MII mode
DAC R5F YES Yes. Example: dac_sine_dma Constant voltage, Square wave generation, Sine wave generation with and without DMA, Ramp wave generation, Random Voltage generation -
ECAP R5F YES yes. Example : ecap_edma ECAP APWM mode, PWM capture, DMA trigger in both APWM and Capture Modes -
EDMA R5F YES NA DMA transfer using interrupt and polling mode, QDMA Transfer, Channel Chaining, PaRAM Linking, Error Handling -
EPWM R5F YES Yes. Example: epwm_dma PWM outputs A and B in up-down count mode, Trip zone, Update PWM using EDMA, Valley switching, High resolution time period adjustment, type5 feature -
EQEP R5F YES NA Speed and Position measurement. Frequency Measurement, Speed and Direction Measurement, cw-ccw modes -
FSI R5F YES Yes. Example: fsi_loopback_dma RX, TX, polling, interrupt mode, Dma, single lane loopback. - FSI Spi Mode
GPIO R5F YES NA Output, Input and Interrupt functionality -
I2C R5F YES No Controller mode, basic read/write -
IPC Notify R5F YES NA Mailbox functionality, IPC between RTOS/NORTOS CPUs M4F core
IPC Rpmsg R5F YES NA RPMessage protocol based IPC M4F core
LIN R5F YES YES RX, TX, polling, interrupt, DMA mode. -
MCAN R5F YES No RX, TX, interrupt and polling mode, Corrupt Message Transmission Prevention, Error Passive state, Bus Off State, Bus Monitoring Mode -
MCSPI R5F YES Yes. Example: mcspi_loopback_dma Controller/Peripheral mode, basic read/write, polling, interrupt and DMA mode -
MDIO R5F YES NA Register read/write, link status and link interrupt enable API -
MPU Firewall R5F YES NA Only compiled (Works only on HS-SE device) -
MMCSD R5F YES NA MMCSD 4bit, Raw read/write file IO, eMMC
PINMUX R5F YES NA Tested with multiple peripheral pinmuxes -
PMU R5F NO NA Tested various PMU events Counter overflow detection is not enabled
PRUICSS R5F YES NA Tested with Ethercat FW HAL -
QSPI R5F YES Yes. Example: qspi_flash_dma_transfer Read direct, Write indirect, Read/Write commands, DMA for read -
RTI R5F YES No Counter read, timebase selction, comparator setup for Interrupt, DMA requests Capture feature, fast enabling/disabling of events not tested
SDFM R5F YES Yes. Example: sdfm_filter_sync_dmaread Filter data read from CPU, Filter data read with PWM sync -
SOC R5F YES NA Lock/unlock MMRs, clock enable, set Hz, Xbar configuration, SW Warm Reset, Address Translation -
SPINLOCK R5F NA NA Lock, unlock HW spinlocks -
UART R5F YES Yes. Example: uart_echo_dma Basic read/write at baud rate 115200, polling, interrupt mode HW flow control not tested, DMA mode not supported
WATCHDOG R5F YES NA Reset mode, Interrupt mode -

Board Device Drivers

Peripheral Supported CPUs SysConfig Support Key features tested Key features not tested
EEPROM R5F YES Only compiled -
ETHPHY R5F YES Tested with ethercat_slave_beckhoff_ssc_demo example -
FLASH R5F YES QSPI Flash -
LED R5F YES GPIO -
IOEXPANDER R5F YES IO configurability -

CMSIS

Module Supported CPUs SysConfig Support OS Support Key features tested Key features not tested
- - - - - -

Ethernet and Networking

Module Supported CPUs SysConfig Support OS Support Key features tested Key features not tested
Time-Sensitive Networking(gPTP-IEEE 802.1AS) R5F NO FreeRTOS gPTP IEEE 802.1 AS-2020 compliant gPTP stack, End Nodes and Bridge mode support, YANG data model configuration, IEEE 1722 compliant AVTP Stack Multi-Clock Domain
LwIP R5F YES FreeRTOS TCP/UDP IP networking stack with and without checksum offload enabled, TCP/UDP IP networking stack with server and client functionality, basic Socket APIs, netconn APIs and raw APIs, DHCP, ping, TCP iperf, scatter-gather, DSCP priority mapping Other LwIP features
Ethernet driver (ENET) R5F YES FreeRTOS Ethernet as port using CPSW, MAC loopback and PHY loopback, Layer 2 MAC, Packet Timestamping, CPSW Switch, CPSW EST, interrupt pacing, Policer and Classifier, MDIO Manual Mode, Credit Based Shaper (IEEE 802.1Qav), Strapped PHY (Early Ethernet) RMII, MII mode
ICSS-EMAC R5F YES FreeRTOS Switch and MAC features, Storm Prevention (MAC), Host Statistics, Multicast Filtering Promiscuous Mode
Mbed-TLS R5F NO FreeRTOS Tested software cryptography after porting, used mbedTLS with LwIP to implement HTTPS server Hardware offloaded cryptography
Ether-ring Implementation R5F NO FreeRTOS Duplicate Rejection, Ring termination and Packet Duplication, Latency measurement for different real-time traffic profiles, Performance KPIs N/A

Demos

Module Supported CPUs SysConfig Support OS Support Key features tested Key features not tested
- - - - - -

Safety Diagnostic Library

Module Supported CPUs SysConfig Support OS support Key features tested Key features not tested / NOT supported
MCRC R5F NA NORTOS Full CPU, Auto CPU Mode and Semi CPU Auto Mode -
DCC R5F NA NORTOS Single Shot and Continuous modes -
PBIST R5F NA NORTOS Memories supported by MSS PBIST controller. -
ESM R5F NA NORTOS Tested in combination with RTI, DCC -
RTI R5F NA NORTOS WINDOWSIZE_100_PERCENT, WINDOWSIZE_50_PERCENT ,Latency/Propagation timing error(early)(50% window),Latency/Propagation timing error(late)(50% window) -
ECC R5F NA NORTOS ECC of MSS_L2, R5F TCM, MCAN, VIM, ICSSM, TPTC -
ECC Bus Safety R5F NA NORTOS AHB, AXI, TPTC -
CCM R5F NA NORTOS CCM Self Test Mode,Error Forcing Mode and Self Test Error Forcing Mode. -
R5F STC(LBIST), Static Register Read R5F NA NORTOS STC of R5F, R5F CPU Static Register Read -
Integrated Example R5F NA FreeRTOS Integrated example with all the SDL modules integrated in to one example. ECC Bu Safety and STC.

Fixed Issues

ID Head Line Module Applicable Releases Applicable Devices Resolution/Comments
PROC_SDL-8519 In ECC for R5F data cache only, double bit test is not supported. SDL 10.00.00 onwards AM263x, AM263Px Fixed the example.
PROC_SDL-8864 D-tag and D-data ECC examples fail in release profile. SDL 10.00.00 onwards AM263x, AM263Px Fixed the example.
MCUSDK-13341 ECAP: Emulation mode does not work. ECAP 9.02.00 onwards AM263x, AM263Px, AM261x Add halt control API for ECAP in soc.c file and emulation mode in syscfg to be emulation free.
MCUSDK-14051 EQEP: CW CCW example doesn't use polling or interrupt EQEP 10.01.00 onwards AM263x, AM263Px, AM261x Modified example to use unit timer interrupt.
MCUSDK-12354 ADC: Syscfg code generation failed for soc-reference ADC 9.01.00 onwards AM263x, AM263Px, AM261x Update reference monitor number and buffer number
MCUSDK-14332 SDFM soc ctrl syscfg: code generates outside callable functions SDFM 10.00.01 onwards AM263x, AM263Px, AM261x Updated code generation of soc ctrl sdfm module in syscfg.
MCUSDK-12238 OUTPUTXBAR input sources from CMPSS needs to be renamed ADC 9.00.01 onwards AM263Px OUTPUTXBAR input sources from CMPSS are renamed as CMPSSA/Bx_CTRIPOUTH/L.
MCUSDK-13874 Syscfg load json function for flash configuration imports does not work OSPI 10.00.00 onwards AM263x, AM263Px Fix in SysCfg Meta file.
MCUSDK-13109 RTI Interrupt req is Pulse type and not Level type RTI 10.00.00 onwards AM263x, AM263Px, AM261x Updated interrupt type to Pulse
MCUSDK-13523 McSPI FIFO not enabled in DMA mode McSPI 10.00.00 onwards AM263x Added FIFO support in McSPI driver for Read and Write
MCUSDK-14516 UART ISR Blocking for long time UART 10.00.00 onwards AM263x, AM263Px, AM261x Removed unwanted timeout loop in UART ISR
MCUSDK-13473 UART uniflash script fails with large images ( > 1MB) SBL 10.00.00 onwards AM263x, AM263Px, AM261x Reference before assignment error in python script
MCUSDK-12986 FreeRTOS: Barrier instructions missing in Interrupt Disable/Enable API's FreeRTOS 09.01.00 onwards AM263x, AM263Px, AM261x FIQ should be used when Priority masking is required. No update in SDK.

Known Issues

ID Head Line Module Reported in release Workaround
MCUSDK-13865 HRPWM Deadband sfo example has 1ns jitter EPWM 10.00.00 onwards -
MCUSDK-13201 HRPWM waveform not generating (in updwon count) when prescaler is non-zero and HRPE is enabled EPWM 10.00.01 onwards None
MCUSDK-13834 EQEP: EQEP frequency measurement example is not working as expected EQEP 10.00.01 onwards None
MCUSDK-13164 AM263x: EPWM deadband example failure EPWM 09.02.00 remove sync between the epwms and use the global tbclksync to synchronize the EPWMs
MCUSDK-7319 CONTROLSS-SDFM: Two Back-to-Back Writes to SDCPARMx Register Bit Fields CEVT1SEL, CEVT2SEL, and HZEN Within Three SD-Modulator Clock Cycles can Corrupt SDFM State Machine, Resulting in Spurious Comparator Events SDFM 08.04.00 onwards Avoid back-to-back writes within three SD-modulator clock cycles or have the SDCPARMx register bit fields configured in one register write.
MCUSDK-9082 MbedTLS - RSA exploit by kernel-privileged cache side-channel attackers Mbed-TLS 08.06.00 onwards -
MCUSDK-13011 Multicore Empty project not working properly FreeRTOS 09.01.00 onwards -
PINDSW-7715 Dual EMAC instance not working with both ports together for icss_emac_lwip example ICSS-EMAC 09.02.00 onwards None
PINDSW-7746 icss_emac_lwip example having low iperf values in TCP and UDP ICSS-EMAC 09.02.00 onwards None
PINDSW-8118 Enabling DHCP mode in icss_emac_lwip example causes assert ICSS-EMAC 09.02.00 onwards None
MCUSDK-12756 MbedTLS - Timing side channel attack in RSA private operation exposing plaintext. Mbed-TLS 08.06.00 onwards None
MCUSDK-13164 AM263x: epwm deadband example validation failure EPWM 09.01.00 onwards The Waveform of the EPWM is correct and is as expected.
MCUSDK-13202 Frame drops are seen in PRU GPIO based SENT decoder example while sending frames in burst format PRU-IO 09.00.00 onwards None
PROC_SDL-8392 In ECC bus safety example, ECC error is not properly cleared at the source. SDL 08.06.00 onwards None
PROC_SDL-8857 SDL integrated example does not support ECC Bus Safety. SDL 10.01.00 onwards Use standalone example.
PROC_SDL-9148 ECC D-Data fail during release SDL 10.02.00 onwards None
MCUSDK-13466 UART Transfer fails in 10MHz Auto Baud mode UART 10.00.00 onwards Use different mode for 10MHz clock
MCUSDK-13193 SBL SD transfer time increased w.r.t SDK 9.2 SBL 10.00.00 onwards None.
MCUSDK-13652 Readelf throws warning while parsing RS note SBL, QSPI Readelf command throws error when trying to read the RS note segment from an mcelf file. -
MCUSDK-14110 Error building examples in CCS in mac Infra Example build fails in CCS only in MAC Machines Building projects in CCS in MAC machines
MCUSDK-14509 AM263x/Am263px/AM261x: 10% Packet drop with UDP iperf in 100M bandwidth in 1Gbps FullDuplex linkspeed Networking 10.00.00 onwards -

Errata

ID Head Line Module SDK Status
i2311 USART: Spurious DMA Interrupts UART Implemented
i2313 GPMC: Sub-32-bit read issue with NAND and FPGA/FIFO GPMC Not supported in SDK
i2324 No synchronizer present between GCM and GCD status signals Common Implemented
i2345 CPSW: Ethernet Packet corruption occurs if CPDMA fetches a packet which spans across memory banks CPSW Implemented
i2350 McSPI data transfer using EDMA in 'ABSYNC' mode stops after 32 bits transfer McSPI Implemented
i2354 SDFM: Two Back-to-Back Writes to SDCPARMx Register Bit Fields CEVT1SEL, CEVT2SEL, and HZEN Within Three SD-Modulator Clock Cycles can Corrupt SDFM State Machine, Resulting in Spurious Comparator Events SDFM Open
i2375 SDFM: SDFM module event flags (SDIFLG.FLTx_FLG_CEVTx) do not get set again if the comparator event is still active and digital filter path (using SDCOMPxCTL.CEVTxDIGFILTSEL) is being selected SDFM Open
i2355 ADC: DMA Read of Stale Result ADC Implemented
i2356 ADC: Interrupts may Stop if INTxCONT (Continue-to-Interrupt Mode) is not Set ADC Implemented
i2375 SDFM module event flags (SDIFLG.FLTx_FLG_CEVTx) do not get set again if the comparator event is still active and digital filter path (using SDCOMPxCTL.CEVTxDIGFILTSEL) is being selected SDFM Open
i2392 Race condition in capture registers resulting in events miss Common Open
i2394 Race condition in interrupt and error aggregator capture registers resulting in events miss Common Updated error aggregator registers in EDMA.
i2401 CPSW: Host Timestamps Cause CPSW Port to Lock up CPSW Open
i2402 CPSW: Ethernet to Host Checksum Offload does not work CPSW Open
i2404 Race condition in mailbox registers resulting in events miss IPC Implemented
i2405 CONTROLSS: Race condition OUTPUT_XBAR and PWM_XBAR resulting in event miss XBAR Open

Limitations

ID Head Line Module Reported in release Workaround
MCUSDK-13630 Cache should not be enabled at last 32B L2 Bank boundary Cache 10.01.00 Create MPU configurations for last 32B of each L2 Bank with Non Cached attribute
- - - - -

Upgrade and Compatibility Information

Compiler Options

Module Affected API Change Additional Remarks
- - - -

SOC Device Drivers

Module Affected API Change Additional Remarks
- - - -

Ethernet and Networking

Module Affected API Change Additional Remarks
- - - -