External/motor-control-sdk
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

am243x/am263x: docs: Add migration guide

Browse Source 
Fixes: PINDSW-6637

Signed-off-by: Dhaval Khandla <dhavaljk@ti.com>
This commit is contained in:
Dhaval Khandla 2023-09-01 20:08:10 +05:30
parent 372402b0f5
commit 90c7b05a0e
3 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs_src/docs/api_guide/device/am243x/includes.cfg
View File

@ -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

2
docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md
View File

@ -316,7 +316,7 @@ Module | Supported CPUs | SysConfig Support | OS Support | Key feat
</tr>
</table>
## Upgrade and Compatibility Information
## Upgrade and Compatibility Information {#UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0}
<!-- \attention When migrating from MCU+ SDK, see \ref MIGRATION_GUIDES for more details -->

37
docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md Normal file
View File

@ -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.