From 90c7b05a0e9efc24a9f63e0fcc7d2fadfeeb61af Mon Sep 17 00:00:00 2001 From: Dhaval Khandla Date: Fri, 1 Sep 2023 20:08:10 +0530 Subject: [PATCH] am243x/am263x: docs: Add migration guide Fixes: PINDSW-6637 Signed-off-by: Dhaval Khandla --- .../docs/api_guide/device/am243x/includes.cfg | 1 + .../device/am243x/release_notes_09_00_00.md | 2 +- .../mcusdk_migration_guide.md | 37 +++++++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md diff --git a/docs_src/docs/api_guide/device/am243x/includes.cfg b/docs_src/docs/api_guide/device/am243x/includes.cfg index 9198c95..f3c5b15 100644 --- a/docs_src/docs/api_guide/device/am243x/includes.cfg +++ b/docs_src/docs/api_guide/device/am243x/includes.cfg @@ -8,6 +8,7 @@ PROJECT_NAME = "AM243x 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 diff --git a/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md b/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md index 980a851..b362b0f 100644 --- a/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md +++ b/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md @@ -316,7 +316,7 @@ Module | Supported CPUs | SysConfig Support | OS Support | Key feat -## Upgrade and Compatibility Information +## Upgrade and Compatibility Information {#UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0} 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 new file mode 100644 index 0000000..340cba2 --- /dev/null +++ b/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md @@ -0,0 +1,37 @@ +# Migration Guide {#MIGRATION_GUIDES} + +Components under Motor Control SDK were available in MCU+ SDK 7.x and 8.x releases. + +If you are a user of MCU+ SDK, then items listed on this page that will assist you in migration to Motor Control SDK. + +\cond SOC_AM64X || SOC_AM243X + +- The examples, drivers and PRU-ICSS firmwares for position sense encoders and current sense %SDFM (using PRU-ICSS) are moved from MCU+ SDK to Motor Control SDK. Folder location changes are also shown below. + + Module | MCU+ SDK Folder Location | Motor Control SDK Folder Location + ----------------------------|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------- + Position Sense EnDat | `examples/motor_control/endat_diagnostic` | `examples/position_sense/endat_diagnostic` + ^ | `source/motor_control/position_sense/endat` | `source/position_sense/endat` + Position Sense HDSL | `examples/motor_control/hdsl_diagnostic`\n `examples/motor_control/hdsl_diagnostic_with_traces`| `examples/position_sense/hdsl_diagnostic`\n `examples/position_sense/hdsl_diagnostic_with_traces` + ^ | `source/motor_control/position_sense/hdsl` | `source/position_sense/hdsl` + Position Sense Tamagawa | `examples/motor_control/tamagawa_diagnostic` | `examples/position_sense/tamagawa_diagnostic` + ^ | `source/motor_control/position_sense/tamagawa` | `source/position_sense/tamagawa` + Current Sense %SDFM | `examples/motor_control/icss_sdfm` | `examples/current_sense/icss_sdfm` + ^ | `source/motor_control/current_sense/sdfm` | `source/current_sense/sdfm` + +\endcond + +\cond SOC_AM263X + +- The example and driver for position sense encoder is moved from MCU+ SDK to Motor Control SDK. Folder location changes are also shown below. + + Module | MCU+ SDK Folder Location | Motor Control SDK Folder Location + ----------------------------|---------------------------------------------------------------------------------------------|----------------------------------------------------------- + Position Sense Tamagawa | `examples/motor_control/tamagawa_diagnostic_over_soc_uart` | `examples/position_sense/tamagawa_diagnostic_over_soc_uart` + ^ | `source/motor_control/position_sense/tamagawa_over_soc_uart` | `source/position_sense/tamagawa_over_soc_uart` + +\endcond + +- Motor Control SDK also includes \htmllink{@VAR_IC_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME Industrial Communications SDK} under `ind_comms_sdk` folder and \htmllink{@VAR_MCU_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME MCU+ SDK} under `mcu_plus_sdk` folder. + +- \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. \ No newline at end of file