diff --git a/docs_src/docs/api_guide/device/am263x/includes.cfg b/docs_src/docs/api_guide/device/am263x/includes.cfg index b6e851a..b0b26e9 100644 --- a/docs_src/docs/api_guide/device/am263x/includes.cfg +++ b/docs_src/docs/api_guide/device/am263x/includes.cfg @@ -8,6 +8,9 @@ PROJECT_NAME = "AM263x Motor Control SDK" INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/main_page/main_page.md +INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md +INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes.md +INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes_09_00_00.md @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg diff --git a/docs_src/docs/api_guide/device/am263x/release_notes.md b/docs_src/docs/api_guide/device/am263x/release_notes.md new file mode 100644 index 0000000..d4c7104 --- /dev/null +++ b/docs_src/docs/api_guide/device/am263x/release_notes.md @@ -0,0 +1,8 @@ +# Release Notes {#RELEASE_NOTES_PAGE} + +[TOC] + +Refer the below pages for release specific information + +- \subpage RELEASE_NOTES_09_00_00_PAGE + diff --git a/docs_src/docs/api_guide/device/am263x/release_notes_09_00_00.md b/docs_src/docs/api_guide/device/am263x/release_notes_09_00_00.md new file mode 100644 index 0000000..261acb9 --- /dev/null +++ b/docs_src/docs/api_guide/device/am263x/release_notes_09_00_00.md @@ -0,0 +1,198 @@ +# Release Notes 09.00.00 {#RELEASE_NOTES_09_00_00_PAGE} + +[TOC] + +\attention Also refer to individual module pages for more details on each feature, unsupported features, important usage guidelines. + +\attention For release notes of Industrial Communications SDK and MCU+ SDK, please refer to @VAR_SOC_NAME Industrial Communications SDK Release Notes 09.00.00 and @VAR_SOC_NAME MCU+ SDK Release Notes 09.00.00 respectively. + +\note The examples will show usage of SW modules and APIs on a specific CPU instance and OS combination. \n + Unless noted otherwise, the SW modules would work in both FreeRTOS and NORTOS environment. \n + Unless noted otherwise, the SW modules would work on any of the R5F's present on the SOC. \n + Unless noted otherwise, the SW modules would work on all supported EVMs \n + +## New in this Release + +Feature | Module +------------------------------------------------------------------------------------------------|----------------------------------- +Digital Control Library | Real Time Libraries + +## Device and Validation Information + +SOC | Supported CPUs | EVM | Host PC +------|-----------------|------------------------------------------------------------------------------|----------------------------------------- +AM263x| R5F | AM263x ControlCard Revision E1 (referred to as am263x-cc in code). \n | Windows 10 64b or Ubuntu 18.04 64b +AM263x| R5F | AM263x LaunchPad Revision E2 (referred to as am263x-lp in code) | Windows 10 64b or Ubuntu 18.04 64b + +## Tools, Compiler and Other Open Source SW Module Information + +Tools | Supported CPUs | Version +------------------------|----------------|-------------------------------------------------------------- +Code Composer Studio | R5F | @VAR_CCS_VERSION_AM263X +SysConfig | R5F | @VAR_SYSCFG_VERSION_AM263X, build @VAR_SYSCFG_BUILD_AM263X +TI ARM CLANG | R5F | @VAR_TI_ARM_CLANG_VERSION +FreeRTOS Kernel | R5F | @VAR_FREERTOS_KERNEL_VERSION + +## Key Features + +### Position Sense + +Module | Supported CPUs | SysConfig Support | OS Support | Key features tested | Key features not tested +-------------|----------------|-------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------- +Tamagawa | R5F | YES | FreeRTOS | Absolute position, Encoder ID, Reset, EEPROM Read, EEPROM Write, 2.5 Mbps and 5 Mbps Encoder Support | - + + + + + + + +## Limitations + + + + + +
ID + Head Line + Module + Reported in Release + Applicable Devices + Workaround +
MCUSDK-208 + gmake with -j can sometimes lock up Windows command prompt + Build + 7.3.0 + AM64x, AM243x + Use bash for windows as part of git for windows or don't use -j option +
+ + + + + + + + + + diff --git a/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md b/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md index c55c4cc..c1d4dc0 100644 --- a/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md +++ b/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md @@ -1,6 +1,12 @@ # Migration Guide {#MIGRATION_GUIDES} +\cond SOC_AM64X || SOC_AM243X Components under Motor Control SDK were available in MCU+ SDK 7.x and 8.x releases. +\endcond + +\cond SOC_AM263X +Components under Motor Control SDK were available in MCU+ SDK 8.x releases. +\endcond If you are a user of MCU+ SDK, then items listed on this page that will assist you in migration to Motor Control SDK. @@ -38,5 +44,7 @@ If you are a user of MCU+ SDK, then items listed on this page that will assist y - Motor Control SDK also includes @VAR_SOC_NAME Industrial Communications SDK under `ind_comms_sdk` folder and @VAR_SOC_NAME MCU+ SDK under `mcu_plus_sdk` folder. +\cond SOC_AM64X || SOC_AM243X - \ref UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0 has details on changes which can affect migration of applications based on MCU+ SDK 08.06.00 to Motor Control SDK 09.00.00. +\endcond