diff --git a/docs/HDSL_AM64xE1_Schematics.pdf b/docs/HDSL_AM64xE1_Schematics.pdf new file mode 100644 index 0000000..76bfc27 Binary files /dev/null and b/docs/HDSL_AM64xE1_Schematics.pdf differ 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 de8b817..ff0788c 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 @@ -4,7 +4,7 @@ \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 \htmllink{@VAR_IC_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html, @VAR_SOC_NAME Industrial Communications SDK Release Notes 09.00.00} and \htmllink{@VAR_MCU_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html, @VAR_SOC_NAME MCU+ SDK Release Notes 09.00.00} respectively. +\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 @@ -38,7 +38,7 @@ TI ARM CLANG | R5F, M4F | @VAR_TI_ARM_CLANG_VERSION FreeRTOS Kernel | R5F, M4F, A53 | @VAR_FREERTOS_KERNEL_VERSION FreeRTOS SMP Kernel | A53 | @VAR_FREERTOS_SMP_KERNEL_VERSION -\attention TI ARM CLANG @VAR_TI_ARM_CLANG_VERSION is not part of CCS by default, Follow steps at \htmllink{@VAR_MCU_SDK_DOCS_PATH/SDK_DOWNLOAD_PAGE.html#INSTALL_TIARMCLANG, TI CLANG Compiler Toolchain} to install the compiler. +\attention TI ARM CLANG @VAR_TI_ARM_CLANG_VERSION is not part of CCS by default, Follow steps at TI CLANG Compiler Toolchain to install the compiler. ## Key Features diff --git a/docs_src/docs/api_guide/examples/dcl/dcl_df22/dcl_df22.md b/docs_src/docs/api_guide/examples/dcl/dcl_df22/dcl_df22.md index 75b3283..2905ab1 100644 --- a/docs_src/docs/api_guide/examples/dcl/dcl_df22/dcl_df22.md +++ b/docs_src/docs/api_guide/examples/dcl/dcl_df22/dcl_df22.md @@ -83,9 +83,9 @@ based on the test input and compare the output with the expected value. # Steps to Run the Example -- **When using CCS projects to build**, import the CCS project for the required combination and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). -- **When using makefiles to build**, note the required combination and build using make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}). -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} +- **When using CCS projects to build**, import the CCS project for the required combination and build it using the CCS project menu (see Using SDK with CCS Projects ). +- **When using makefiles to build**, note the required combination and build using make command (see Using SDK with Makefiles ). +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run ### Sample Output diff --git a/docs_src/docs/api_guide/examples/dcl/dcl_pi/dcl_pi.md b/docs_src/docs/api_guide/examples/dcl/dcl_pi/dcl_pi.md index c5ce4d7..f1142dc 100644 --- a/docs_src/docs/api_guide/examples/dcl/dcl_pi/dcl_pi.md +++ b/docs_src/docs/api_guide/examples/dcl/dcl_pi/dcl_pi.md @@ -81,9 +81,9 @@ based on the test input and compare the output with the expected value. # Steps to Run the Example -- **When using CCS projects to build**, import the CCS project for the required combination and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). -- **When using makefiles to build**, note the required combination and build using make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}). -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} +- **When using CCS projects to build**, import the CCS project for the required combination and build it using the CCS project menu (see Using SDK with CCS Projects ). +- **When using makefiles to build**, note the required combination and build using make command (see Using SDK with Makefiles ). +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run diff --git a/docs_src/docs/api_guide/examples/endat_example.md b/docs_src/docs/api_guide/examples/endat_example.md index 5267f1f..80d3296 100644 --- a/docs_src/docs/api_guide/examples/endat_example.md +++ b/docs_src/docs/api_guide/examples/endat_example.md @@ -110,9 +110,9 @@ Following section describes the Example implementation of EnDat on ARM(R5F). ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM_SETUP_PAGE.html, EVM Setup}, below additional HW is required to run this demo +Other than the basic EVM setup mentioned in EVM Setup , below additional HW is required to run this demo - EnDAT encoder -- TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 +- TIDA-00179 Universal Digital Interface to Absolute Position Encoders - TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board @@ -121,7 +121,7 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM - EnDat encoder - AM243x-LP board -- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO +- BP-AM2BLDCSERVO \endcond ## Hardware Setup @@ -205,10 +205,10 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM \endcond ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). +- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see Using SDK with CCS Projects ). - **When using makefiles to build**, note the required combination and build using - make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}) -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} + make command (see Using SDK with Makefiles ) +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run - Refer to UART terminal for user interface menu options. ### Sample Output diff --git a/docs_src/docs/api_guide/examples/hdsl_example.md b/docs_src/docs/api_guide/examples/hdsl_example.md index 1295542..5804e52 100644 --- a/docs_src/docs/api_guide/examples/hdsl_example.md +++ b/docs_src/docs/api_guide/examples/hdsl_example.md @@ -82,11 +82,11 @@ This example also allows the capability to save the HDSL register data into memo ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM_SETUP_PAGE.html, EVM Setup}, below additional HW is required to run this demo +Other than the basic EVM setup mentioned in EVM Setup , below additional HW is required to run this demo - HDSL encoder - Below are two options to connect encoder to AM64x/AM243x EVM. - **Option 1** - - TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 + - TIDA-00179 Universal Digital Interface to Absolute Position Encoders - TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board - Connect the Hiperface DSL encoder to HDSL+/-(Pin number 6 and 7) signals available on header J7 or Sub-D15 connector of the "Universal Digital Interface to Absolute Position Encoders" board. @@ -95,14 +95,14 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM - Connect the Hiperface DSL encoder to J10. - HDSL AM64xE1 Transceiver supports two channels that can be used to support HDSL safety, multi axis servo drives. - Schematics are shared in the MCU+SDK package. For more design details of the transceiver card, please contact TI via E2E/FAE. - - \htmllink{../am64x_am243x/HDSL_AM64xE1_Schematics.pdf, HDSL Transceiver Card Schematics} document. + - HDSL Transceiver Card Schematics document. \cond SOC_AM243X ### Hardware Prerequisities for Booster Pack - HDSL encoder - AM243x-LP board -- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO +- BP-AM2BLDCSERVO \endcond @@ -192,10 +192,10 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM \endcond ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). +- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see Using SDK with CCS Projects ). - **When using makefiles to build**, note the required combination and build using - make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}) -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} + make command (see Using SDK with Makefiles ) +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run - Refer to UART terminal for user interface menu options. # Mode, Channel(s) and Board Selection from sysconfig: diff --git a/docs_src/docs/api_guide/examples/sdfm_example.md b/docs_src/docs/api_guide/examples/sdfm_example.md index 669019e..26bfa81 100644 --- a/docs_src/docs/api_guide/examples/sdfm_example.md +++ b/docs_src/docs/api_guide/examples/sdfm_example.md @@ -84,7 +84,7 @@ Following section describes the Example implementation of ICSS %SDFM on ARM(R5F) # Steps to Run the Example ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM_SETUP_PAGE.html, EVM Setup}, below additional HW is required to run this demo +Other than the basic EVM setup mentioned in EVM Setup , below additional HW is required to run this demo - TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board - Signal generator @@ -105,10 +105,10 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM \endcond ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). +- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see Using SDK with CCS Projects ). - **When using makefiles to build**, note the required combination and build using - make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}) -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} + make command (see Using SDK with Makefiles ) +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run - Refer to UART terminal for user interface menu options. diff --git a/docs_src/docs/api_guide/examples/tamagawa_example.md b/docs_src/docs/api_guide/examples/tamagawa_example.md index 0cfb0d7..8ffa2f7 100644 --- a/docs_src/docs/api_guide/examples/tamagawa_example.md +++ b/docs_src/docs/api_guide/examples/tamagawa_example.md @@ -84,9 +84,9 @@ The Tamagawa receiver firmware running on ICSS0-PRU1 provides a defined interfac # Steps to Run the Example ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM_SETUP_PAGE.html, EVM Setup}, additional hardware required to run this demo is mentioned below +Other than the basic EVM setup mentioned in EVM Setup , additional hardware required to run this demo is mentioned below - Tamagawa Encoders -- TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 +- TIDA-00179 Universal Digital Interface to Absolute Position Encoders - TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board @@ -95,7 +95,7 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM - Tamagawa encoder - AM243x-LP board -- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO +- BP-AM2BLDCSERVO \endcond @@ -191,10 +191,10 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). +- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see Using SDK with CCS Projects ). - **When using makefiles to build**, note the required combination and build using - make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}) -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} + make command (see Using SDK with Makefiles ) +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run - Refer to UART terminal for user interface menu options. ### Sample Output diff --git a/docs_src/docs/api_guide/examples/tamagawa_uart_example.md b/docs_src/docs/api_guide/examples/tamagawa_uart_example.md index 80fb87c..ee57af8 100644 --- a/docs_src/docs/api_guide/examples/tamagawa_uart_example.md +++ b/docs_src/docs/api_guide/examples/tamagawa_uart_example.md @@ -82,10 +82,10 @@ The tamagawa over uart example runs on R5 and communicates with tamagawa encoder ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_PROJECTS_PAGE.html, Using SDK with CCS Projects}). +- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see Using SDK with CCS Projects ). - **When using makefiles to build**, note the required combination and build using - make command (see \htmllink{@VAR_MCU_SDK_DOCS_PATH/MAKEFILE_BUILD_PAGE.html, Using SDK with Makefiles}) -- Launch a CCS debug session and run the executable, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/CCS_LAUNCH_PAGE.html, CCS Launch\, Load and Run} + make command (see Using SDK with Makefiles ) +- Launch a CCS debug session and run the executable, see CCS Launch, Load and Run - Refer to UART terminal for user interface menu options. ### Sample Output diff --git a/docs_src/docs/api_guide/main_page/main_page.md b/docs_src/docs/api_guide/main_page/main_page.md index 71ef526..2f5413a 100644 --- a/docs_src/docs/api_guide/main_page/main_page.md +++ b/docs_src/docs/api_guide/main_page/main_page.md @@ -9,11 +9,11 @@ Real-time communication with encoders and current sensing is typically handled b Applications and PRU-ICSS firmwares for position sense and current sense are provided in the SDK. -\attention This SDK also includes \htmllink{@VAR_IC_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME Industrial Communications SDK} and \htmllink{@VAR_MCU_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME MCU+ SDK}. +\attention This SDK also includes @VAR_SOC_NAME Industrial Communications SDK and @VAR_SOC_NAME MCU+ SDK. ## Getting Started -To get started, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/GETTING_STARTED.html, GETTING STARTED} page. +To get started, see GETTING STARTED page. ## Block Diagram @@ -132,7 +132,7 @@ The main software components in the block diagram specific to motor control are \endcond -For details on software components of Industrial Communications SDK and MCU+ SDK, please refer to \htmllink{@VAR_IC_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME Industrial Communications SDK} and \htmllink{@VAR_MCU_SDK_DOCS_PATH/index.html, @VAR_SOC_NAME MCU+ SDK} respectively. +For details on software components of Industrial Communications SDK and MCU+ SDK, please refer to @VAR_SOC_NAME Industrial Communications SDK and @VAR_SOC_NAME MCU+ SDK respectively. ## Directory Structure 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 3feb590..2b85f6f 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 @@ -36,6 +36,7 @@ If you are a user of MCU+ SDK, then items listed on this page that will assist y \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. +- 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. - \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. +