diff --git a/.gitignore b/.gitignore index 44c7dfb..f07d620 100644 --- a/.gitignore +++ b/.gitignore @@ -54,6 +54,7 @@ source/usb/tinyusb/tinyusb-stack source/dsplib_c66x_3_4_0_0/ docs/industrial_protocol_docs mcusdk_tagfile +mcsdk_tagfile __pycache__/ source/position_sense/hdsl/firmware/*.lst source/position_sense/hdsl/firmware/*.obj diff --git a/docs_src/docs/api_guide/components/sdfm.md b/docs_src/docs/api_guide/components/current_sense/current_sense.md similarity index 68% rename from docs_src/docs/api_guide/components/sdfm.md rename to docs_src/docs/api_guide/components/current_sense/current_sense.md index ec51bd9..8b648f8 100644 --- a/docs_src/docs/api_guide/components/sdfm.md +++ b/docs_src/docs/api_guide/components/current_sense/current_sense.md @@ -1,8 +1,11 @@ -# SDFM {#SDFM} +# Current Sense {#CURRENT_SENSE} [TOC] -## Introduction +Current sensing is handled by the Programmable Real-Time Unit Industrial Communication Subsystem (PRU-ICSS). The PRU-ICSS is a co-processor subsystem containing Programmable Real-Time (PRU) cores which implements the low level firmware. The PRU-ICSS frees up the main ARM cores in the device for other functions, such as control and data processing. + +## SDFM {#SDFM} + ICSS SDFM is a sigma delta interface for phase current measurement in high performance motor and servo drives. During Sigma delta decimation filtering (SDDF) the PRU hardware provides hardware integrators that do the accumulation part of Sinc filtering, while the ICSS SDFM firmware does differentiation part. ## Features Supported @@ -16,7 +19,6 @@ ICSS SDFM is a sigma delta interface for phase current measurement in high perfo - Zero cross comparator - Below 32 OSR - ## ICSS SDFM Design \subpage SDFM_DESIGN explains the design in detail. @@ -24,4 +26,4 @@ ICSS SDFM is a sigma delta interface for phase current measurement in high perfo \ref EXAMPLE_MOTORCONTROL_SDFM ## API -\ref SDFM_API_MODULE +\ref SDFM_API_MODULE \ No newline at end of file diff --git a/docs_src/docs/api_guide/components/sdfm_design.md b/docs_src/docs/api_guide/components/current_sense/sdfm_design.md similarity index 100% rename from docs_src/docs/api_guide/components/sdfm_design.md rename to docs_src/docs/api_guide/components/current_sense/sdfm_design.md diff --git a/docs_src/docs/api_guide/components/motor_control.md b/docs_src/docs/api_guide/components/motor_control.md deleted file mode 100644 index 7c84c37..0000000 --- a/docs_src/docs/api_guide/components/motor_control.md +++ /dev/null @@ -1,22 +0,0 @@ -# Motor Control {#ENCODERS_DOC} - -[TOC] - -## Introduction -\cond SOC_AM64X || SOC_AM243X -The Motor Control-Encoder Toolkit enables real-time communications with encoders for TI processors/MCUs. Communication is typically handled by the Programmable Real-Time Unit Industrial Communication Subsystem (PRU-ICSS). The PRU-ICSS is a co-processor subsystem containing Programmable Real-Time (PRU) cores which implement the low level firmware. The upper application layer are implemented in software running on Arm cores. - -PRU cores are primarily used for communication with encoder, and can also be used for other applications such as motor control and custom interfaces. The PRU-ICSS frees up the main Arm cores in the device for other functions, such as control and data processing. - -Applications and PRU-ICSS firmware to communicate with following are provided in the SDK: - -- \subpage ENDAT -- \subpage HDSL -- \subpage TAMAGAWA -- \subpage SDFM -\endcond - -\cond SOC_AM263X -The Motor Control-Encoder Toolkit enables real-time communications with encoders for TI processors/MCUs. -- \subpage TAMAGAWA_OVER_UART -\endcond \ No newline at end of file diff --git a/docs_src/docs/api_guide/components/endat.md b/docs_src/docs/api_guide/components/position_sense/endat.md similarity index 100% rename from docs_src/docs/api_guide/components/endat.md rename to docs_src/docs/api_guide/components/position_sense/endat.md diff --git a/docs_src/docs/api_guide/components/endat_design.md b/docs_src/docs/api_guide/components/position_sense/endat_design.md similarity index 100% rename from docs_src/docs/api_guide/components/endat_design.md rename to docs_src/docs/api_guide/components/position_sense/endat_design.md diff --git a/docs_src/docs/api_guide/components/hdsl.md b/docs_src/docs/api_guide/components/position_sense/hdsl.md similarity index 100% rename from docs_src/docs/api_guide/components/hdsl.md rename to docs_src/docs/api_guide/components/position_sense/hdsl.md diff --git a/docs_src/docs/api_guide/components/hdsl_design.md b/docs_src/docs/api_guide/components/position_sense/hdsl_design.md similarity index 100% rename from docs_src/docs/api_guide/components/hdsl_design.md rename to docs_src/docs/api_guide/components/position_sense/hdsl_design.md diff --git a/docs_src/docs/api_guide/components/hdsl_exceptions_list.md b/docs_src/docs/api_guide/components/position_sense/hdsl_exceptions_list.md similarity index 100% rename from docs_src/docs/api_guide/components/hdsl_exceptions_list.md rename to docs_src/docs/api_guide/components/position_sense/hdsl_exceptions_list.md diff --git a/docs_src/docs/api_guide/components/hdsl_registers_list.md b/docs_src/docs/api_guide/components/position_sense/hdsl_registers_list.md similarity index 100% rename from docs_src/docs/api_guide/components/hdsl_registers_list.md rename to docs_src/docs/api_guide/components/position_sense/hdsl_registers_list.md diff --git a/docs_src/docs/api_guide/components/position_sense/position_sense.md b/docs_src/docs/api_guide/components/position_sense/position_sense.md new file mode 100644 index 0000000..063155e --- /dev/null +++ b/docs_src/docs/api_guide/components/position_sense/position_sense.md @@ -0,0 +1,23 @@ +# Position Sense {#POSITION_SENSE} + +[TOC] + +\cond SOC_AM64X || SOC_AM243X + +Real-time communication with encoders and current sensing is typically handled by the Programmable Real-Time Unit Industrial Communication Subsystem (PRU-ICSS). The PRU-ICSS is a co-processor subsystem containing Programmable Real-Time (PRU) cores which implement the low level firmware. The PRU-ICSS frees up the main ARM cores in the device for other functions, such as control and data processing. + +Applications and PRU-ICSS firmwares for following position sense encoders are provided in the SDK. + +- \subpage ENDAT +- \subpage HDSL +- \subpage TAMAGAWA + +\endcond + +\cond SOC_AM263X + +Applications and PRU-ICSS firmwares for following position sense encoder is provided in the SDK. + +\subpage TAMAGAWA_OVER_UART + +\endcond \ No newline at end of file diff --git a/docs_src/docs/api_guide/components/tamagawa.md b/docs_src/docs/api_guide/components/position_sense/tamagawa.md similarity index 89% rename from docs_src/docs/api_guide/components/tamagawa.md rename to docs_src/docs/api_guide/components/position_sense/tamagawa.md index 4f76713..63206d6 100644 --- a/docs_src/docs/api_guide/components/tamagawa.md +++ b/docs_src/docs/api_guide/components/position_sense/tamagawa.md @@ -5,8 +5,9 @@ ## Introduction The Tamagawa receiver firmware running on PRU-ICSS provides a defined well interface to execute the Tamagawa protocol. The Tamagawa diagnostic application interacts with the Tamagawa receiver firmware interface. + \note -Starting with MCU+ SDK version 08.05.00, the Tamagawa firmware and examples are based on EnDAT hardware interface from PRU-ICSSG. +Tamagawa firmware and examples are based on EnDAT hardware interface from PRU-ICSSG. ## Features Supported diff --git a/docs_src/docs/api_guide/components/tamagawa_design.md b/docs_src/docs/api_guide/components/position_sense/tamagawa_design.md similarity index 100% rename from docs_src/docs/api_guide/components/tamagawa_design.md rename to docs_src/docs/api_guide/components/position_sense/tamagawa_design.md diff --git a/docs_src/docs/api_guide/components/tamagawa_uart.md b/docs_src/docs/api_guide/components/position_sense/tamagawa_uart.md similarity index 100% rename from docs_src/docs/api_guide/components/tamagawa_uart.md rename to docs_src/docs/api_guide/components/position_sense/tamagawa_uart.md diff --git a/docs_src/docs/api_guide/device/am243x/components.cfg b/docs_src/docs/api_guide/device/am243x/components.cfg index 3b54898..ee6c538 100644 --- a/docs_src/docs/api_guide/device/am243x/components.cfg +++ b/docs_src/docs/api_guide/device/am243x/components.cfg @@ -1,17 +1,19 @@ -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/endat.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/endat_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_registers_list.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_exceptions_list.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/sdfm.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/sdfm_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/position_sense.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/endat.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/endat_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_registers_list.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_exceptions_list.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/tamagawa.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/tamagawa_design.md + +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/current_sense/current_sense.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/current_sense/sdfm_design.md INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_api.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_drv.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/hdsl/include/hdsl_drv.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa/include/tamagawa_drv.h -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sddf_api.h +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_api.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_drv.h diff --git a/docs_src/docs/api_guide/device/am243x/includes.cfg b/docs_src/docs/api_guide/device/am243x/includes.cfg index 9238e40..1eb2cc7 100644 --- a/docs_src/docs/api_guide/device/am243x/includes.cfg +++ b/docs_src/docs/api_guide/device/am243x/includes.cfg @@ -5,20 +5,22 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "AM243x MOTOR CONTROL SDK" +PROJECT_NAME = "AM243x Motor Control SDK" INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/main_page/main_page.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 # Used to selectively pick DEVICE specific sections within .md files -ENABLED_SECTIONS = SOC_AM64X +ENABLED_SECTIONS = SOC_AM243X # SOC specific aliases -ALIASES+=VAR_SOC_NAME="AM64X" -ALIASES+=VAR_SOC_NAME_LOWER="am64x" -ALIASES+=VAR_BOARD_NAME="AM64X-EVM" -ALIASES+=VAR_BOARD_NAME_LOWER="am64x-evm" -ALIASES+=VAR_SK_BOARD_NAME="AM64X-SK" -ALIASES+=VAR_SK_BOARD_NAME_LOWER="am64x-sk" -ALIASES+=VAR_SOC_MANIFEST="motor_control_sdk_am64x_manifest.html" +ALIASES+=VAR_SOC_NAME="AM243X" +ALIASES+=VAR_SOC_NAME_LOWER="am243x" +ALIASES+=VAR_BOARD_NAME="AM243X-EVM" +ALIASES+=VAR_BOARD_NAME_LOWER="am243x-evm" +ALIASES+=VAR_LP_BOARD_NAME="AM243X-LP" +ALIASES+=VAR_LP_BOARD_NAME_LOWER="am243x-lp" +ALIASES+=VAR_SOC_MANIFEST="motor_control_sdk_am243x_manifest.html" +ALIASES+=VAR_MCU_SDK_DOCS_PATH="../../mcu_plus_sdk/docs/api_guide_am243x" +ALIASES+=VAR_IC_SDK_DOCS_PATH="../../ind_comms_sdk/docs/api_guide_am243x" \ No newline at end of file diff --git a/docs_src/docs/api_guide/device/am263x/components.cfg b/docs_src/docs/api_guide/device/am263x/components.cfg index a46ef93..baac63a 100644 --- a/docs_src/docs/api_guide/device/am263x/components.cfg +++ b/docs_src/docs/api_guide/device/am263x/components.cfg @@ -1,2 +1,4 @@ -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa_uart.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/position_sense.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/tamagawa_uart.md + INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa_over_soc_uart/include/tamagawa_soc_uart_interface.h \ No newline at end of file diff --git a/docs_src/docs/api_guide/device/am263x/includes.cfg b/docs_src/docs/api_guide/device/am263x/includes.cfg index 14b8ab6..daafc25 100644 --- a/docs_src/docs/api_guide/device/am263x/includes.cfg +++ b/docs_src/docs/api_guide/device/am263x/includes.cfg @@ -5,7 +5,7 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "AM263x MOTOR CONTROL SDK" +PROJECT_NAME = "AM263x Motor Control SDK" INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/main_page/main_page.md @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg @@ -22,3 +22,5 @@ ALIASES+=VAR_BOARD_NAME_LOWER="am263x-cc" ALIASES+=VAR_LP_BOARD_NAME="AM263X-LP" ALIASES+=VAR_LP_BOARD_NAME_LOWER="am263x-lp" ALIASES+=VAR_SOC_MANIFEST="mcu_plus_sdk_am263x_manifest.html" +ALIASES+=VAR_MCU_SDK_DOCS_PATH="../../mcu_plus_sdk/docs/api_guide_am263x" +ALIASES+=VAR_IC_SDK_DOCS_PATH="../../ind_comms_sdk/docs/api_guide_am263x" \ No newline at end of file diff --git a/docs_src/docs/api_guide/device/am64x/components.cfg b/docs_src/docs/api_guide/device/am64x/components.cfg index 3b54898..ee6c538 100644 --- a/docs_src/docs/api_guide/device/am64x/components.cfg +++ b/docs_src/docs/api_guide/device/am64x/components.cfg @@ -1,17 +1,19 @@ -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/endat.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/endat_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_registers_list.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/hdsl_exceptions_list.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa_design.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/sdfm.md -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/sdfm_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/position_sense.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/endat.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/endat_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_design.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_registers_list.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/hdsl_exceptions_list.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/tamagawa.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/position_sense/tamagawa_design.md + +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/current_sense/current_sense.md +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/current_sense/sdfm_design.md INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_api.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_drv.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/hdsl/include/hdsl_drv.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa/include/tamagawa_drv.h -INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sddf_api.h +INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_api.h INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_drv.h diff --git a/docs_src/docs/api_guide/device/am64x/includes.cfg b/docs_src/docs/api_guide/device/am64x/includes.cfg index edd869d..fe94c59 100644 --- a/docs_src/docs/api_guide/device/am64x/includes.cfg +++ b/docs_src/docs/api_guide/device/am64x/includes.cfg @@ -5,7 +5,7 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "AM64x MOTOR CONTROL SDK" +PROJECT_NAME = "AM64x Motor Control SDK" INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/main_page/main_page.md @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg @@ -22,3 +22,5 @@ ALIASES+=VAR_BOARD_NAME_LOWER="am64x-evm" ALIASES+=VAR_SK_BOARD_NAME="AM64X-SK" ALIASES+=VAR_SK_BOARD_NAME_LOWER="am64x-sk" ALIASES+=VAR_SOC_MANIFEST="motor_control_sdk_am64x_manifest.html" +ALIASES+=VAR_MCU_SDK_DOCS_PATH="../../mcu_plus_sdk/docs/api_guide_am64x" +ALIASES+=VAR_IC_SDK_DOCS_PATH="../../ind_comms_sdk/docs/api_guide_am64x" \ No newline at end of file diff --git a/docs_src/docs/api_guide/doxy_warnings_am243x.txt b/docs_src/docs/api_guide/doxy_warnings_am243x.txt index 10ae173..e69de29 100644 --- a/docs_src/docs/api_guide/doxy_warnings_am243x.txt +++ b/docs_src/docs/api_guide/doxy_warnings_am243x.txt @@ -1,55 +0,0 @@ -warning: tag INPUT: input source 'C:/ti/motor_control_sdk/source/current_sense/sdfm/include/sddf_api.h' does not exist -warning: source C:/ti/motor_control_sdk/source/current_sense/sdfm/include/sddf_api.h is not a readable file or directory... skipping. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:114: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:209: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:211: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:212: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:77: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:187: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:189: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:190: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:61: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:88: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:90: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:91: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:88: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:195: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:197: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:198: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:83: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:93: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:95: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:96: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:77: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:187: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:189: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:190: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:61: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:88: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:90: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:91: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:114: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:209: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:211: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:212: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:88: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:195: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:197: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:198: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:83: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:93: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:95: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:96: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/components/sdfm.md:28: warning: unable to resolve reference to 'SDFM_API_MODULE' for \ref command -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:263: warning: explicit link request to 'PRUICSS_Handle' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:398: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:398: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:411: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:411: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:231: warning: explicit link request to 'PRUICSS_PRU0' could not be resolved -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:14: warning: unable to resolve reference to 'GETTING_STARTED' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:21: warning: image file am64x/block_diagram.png is not found in IMAGE_PATH: assuming external image. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:35: warning: unable to resolve reference to 'EXAMPLES_MOTORCONTROL' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:14: warning: unable to resolve reference to 'GETTING_STARTED' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:21: warning: image file am64x/block_diagram.png is not found in IMAGE_PATH: assuming external image. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:35: warning: unable to resolve reference to 'EXAMPLES_MOTORCONTROL' for \ref command diff --git a/docs_src/docs/api_guide/doxy_warnings_am263x.txt b/docs_src/docs/api_guide/doxy_warnings_am263x.txt index 8f215c7..e69de29 100644 --- a/docs_src/docs/api_guide/doxy_warnings_am263x.txt +++ b/docs_src/docs/api_guide/doxy_warnings_am263x.txt @@ -1,5 +0,0 @@ -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_uart_example.md:89: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_uart_example.md:91: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_uart_example.md:92: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:13: warning: unable to resolve reference to `GETTING_STARTED' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:34: warning: unable to resolve reference to `EXAMPLES_MOTORCONTROL' for \ref command diff --git a/docs_src/docs/api_guide/doxy_warnings_am64x.txt b/docs_src/docs/api_guide/doxy_warnings_am64x.txt index 10ae173..e69de29 100644 --- a/docs_src/docs/api_guide/doxy_warnings_am64x.txt +++ b/docs_src/docs/api_guide/doxy_warnings_am64x.txt @@ -1,55 +0,0 @@ -warning: tag INPUT: input source 'C:/ti/motor_control_sdk/source/current_sense/sdfm/include/sddf_api.h' does not exist -warning: source C:/ti/motor_control_sdk/source/current_sense/sdfm/include/sddf_api.h is not a readable file or directory... skipping. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:114: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:209: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:211: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:212: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:77: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:187: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:189: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:190: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:61: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:88: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:90: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:91: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:88: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:195: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:197: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:198: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:83: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:93: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:95: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:96: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:77: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:187: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:189: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:190: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:61: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:88: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:90: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example_trace.md:91: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:114: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:209: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:211: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/endat_example.md:212: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:88: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:195: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:197: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/tamagawa_example.md:198: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:83: warning: unable to resolve reference to 'EVM_SETUP_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:93: warning: unable to resolve reference to 'CCS_PROJECTS_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:95: warning: unable to resolve reference to 'MAKEFILE_BUILD_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/sdfm_example.md:96: warning: unable to resolve reference to 'CCS_LAUNCH_PAGE' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/components/sdfm.md:28: warning: unable to resolve reference to 'SDFM_API_MODULE' for \ref command -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:263: warning: explicit link request to 'PRUICSS_Handle' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:398: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:398: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:411: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:411: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved -C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:231: warning: explicit link request to 'PRUICSS_PRU0' could not be resolved -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:14: warning: unable to resolve reference to 'GETTING_STARTED' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:21: warning: image file am64x/block_diagram.png is not found in IMAGE_PATH: assuming external image. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:35: warning: unable to resolve reference to 'EXAMPLES_MOTORCONTROL' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:14: warning: unable to resolve reference to 'GETTING_STARTED' for \ref command -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:21: warning: image file am64x/block_diagram.png is not found in IMAGE_PATH: assuming external image. -C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:35: warning: unable to resolve reference to 'EXAMPLES_MOTORCONTROL' for \ref command diff --git a/docs_src/docs/api_guide/doxygen.cfg b/docs_src/docs/api_guide/doxygen.cfg index 2d99f72..344cff3 100644 --- a/docs_src/docs/api_guide/doxygen.cfg +++ b/docs_src/docs/api_guide/doxygen.cfg @@ -218,7 +218,7 @@ ALIASES+=imageStyle{2}="\htmlonly \e ALIASES+=inlineVideo{3}="\htmlonly
\2
\endhtmlonly" ALIASES+=VAR_MY_NAME="my_value" ALIASES+=VAR_TI_HOME_PAGE="\htmllink{https://www.ti.com,TI}" -ALIASES+=VAR_SDK_NAME="MCU+ SDK" +ALIASES+=VAR_SDK_NAME="Motor Control SDK" ALIASES+=VAR_CCS_VERSION="12.4.0" ALIASES+=VAR_CCS_FOLDER_VERSION="1240" ALIASES+=VAR_CCS_VERSION_AM263X="12.4.0" @@ -853,7 +853,9 @@ EXAMPLE_RECURSIVE = NO # \image command). IMAGE_PATH+=$(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/images/ -IMAGE_PATH+=$(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/images/motorcontrol +IMAGE_PATH+=$(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/images/$(DEVICE)/ +IMAGE_PATH+=$(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/images/position_sense +IMAGE_PATH+=$(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/images/current_sense # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -1992,7 +1994,7 @@ TAGFILES = # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/mcusdk_tagfile +GENERATE_TAGFILE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/mcsdk_tagfile # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/docs_src/docs/api_guide/examples/endat_example.md b/docs_src/docs/api_guide/examples/endat_example.md index f158e52..1ec868b 100644 --- a/docs_src/docs/api_guide/examples/endat_example.md +++ b/docs_src/docs/api_guide/examples/endat_example.md @@ -110,7 +110,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F). ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additional HW is required to run this demo +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 - EnDAT encoder - TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 - TIDEP-01015 3 Axis board @@ -205,10 +205,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona \endcond ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - 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 12d3ac5..0314328 100644 --- a/docs_src/docs/api_guide/examples/hdsl_example.md +++ b/docs_src/docs/api_guide/examples/hdsl_example.md @@ -73,7 +73,7 @@ It then presents the user with menu options, based on the option selected, appli ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additional HW is required to run this demo +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 - HDSL encoder - Below are two options to connect encoder to AM64x/AM243x EVM. - **Option 1** @@ -183,10 +183,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona \endcond ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - Refer to UART terminal for user interface menu options. # Sync Mode: diff --git a/docs_src/docs/api_guide/examples/hdsl_example_trace.md b/docs_src/docs/api_guide/examples/hdsl_example_trace.md index 12c3fa1..8909282 100644 --- a/docs_src/docs/api_guide/examples/hdsl_example_trace.md +++ b/docs_src/docs/api_guide/examples/hdsl_example_trace.md @@ -57,7 +57,7 @@ Firmware is split to three sections, initialization, datalink and transport. At ## Hardware Prerequisites -Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additional HW is required to run this demo +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 - HDSL encoder - Below are two options to connect encoder to AM64x/AM243x EVM. - **Option 1** @@ -84,10 +84,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - Refer to UART terminal for user interface menu options. \imageStyle{hdsl_ddr_trace.png,width:60%} diff --git a/docs_src/docs/api_guide/examples/sdfm_example.md b/docs_src/docs/api_guide/examples/sdfm_example.md index 1df82a5..80805da 100644 --- a/docs_src/docs/api_guide/examples/sdfm_example.md +++ b/docs_src/docs/api_guide/examples/sdfm_example.md @@ -79,7 +79,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 \ref EVM_SETUP_PAGE, below additional HW is required to run this demo +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 - TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board - Signal generator @@ -89,10 +89,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - 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 91acda9..63394de 100644 --- a/docs_src/docs/api_guide/examples/tamagawa_example.md +++ b/docs_src/docs/api_guide/examples/tamagawa_example.md @@ -84,7 +84,7 @@ 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 \ref EVM_SETUP_PAGE, additional hardware required to run this demo is mentioned below +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 - Tamagawa Encoders - TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 - TIDEP-01015 3 Axis board @@ -191,10 +191,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, additional hard ## Build, load and run -- **When using CCS projects to build**, import the CCS project and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - 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 59a2e37..2f3b2f9 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 \ref CCS_PROJECTS_PAGE). +- **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 makefiles to build**, note the required combination and build using - make command (see \ref MAKEFILE_BUILD_PAGE) -- Launch a CCS debug session and run the executable, see \ref CCS_LAUNCH_PAGE + 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} - Refer to UART terminal for user interface menu options. ### Sample Output diff --git a/docs_src/docs/api_guide/images/am243x/block_diagram.png b/docs_src/docs/api_guide/images/am243x/block_diagram.png new file mode 100644 index 0000000..5ea5796 Binary files /dev/null and b/docs_src/docs/api_guide/images/am243x/block_diagram.png differ diff --git a/docs_src/docs/api_guide/images/am263x/block_diagram.png b/docs_src/docs/api_guide/images/am263x/block_diagram.png new file mode 100644 index 0000000..5ea5796 Binary files /dev/null and b/docs_src/docs/api_guide/images/am263x/block_diagram.png differ diff --git a/docs_src/docs/api_guide/images/am64x/block_diagram.png b/docs_src/docs/api_guide/images/am64x/block_diagram.png new file mode 100644 index 0000000..6e8d619 Binary files /dev/null and b/docs_src/docs/api_guide/images/am64x/block_diagram.png differ diff --git a/docs_src/docs/api_guide/images/block_diagram.png b/docs_src/docs/api_guide/images/block_diagram.png deleted file mode 100644 index 9082213..0000000 Binary files a/docs_src/docs/api_guide/images/block_diagram.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/SDFM_FIRMWARE_FLOWCHART.png b/docs_src/docs/api_guide/images/current_sense/SDFM_FIRMWARE_FLOWCHART.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/SDFM_FIRMWARE_FLOWCHART.png rename to docs_src/docs/api_guide/images/current_sense/SDFM_FIRMWARE_FLOWCHART.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/SDFM_HwSetup_image.PNG b/docs_src/docs/api_guide/images/current_sense/SDFM_HwSetup_image.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/SDFM_HwSetup_image.PNG rename to docs_src/docs/api_guide/images/current_sense/SDFM_HwSetup_image.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/SDFM_sample_output.PNG b/docs_src/docs/api_guide/images/current_sense/SDFM_sample_output.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/SDFM_sample_output.PNG rename to docs_src/docs/api_guide/images/current_sense/SDFM_sample_output.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/SDFM_threshold_comparator_salea_capture.png b/docs_src/docs/api_guide/images/current_sense/SDFM_threshold_comparator_salea_capture.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/SDFM_threshold_comparator_salea_capture.png rename to docs_src/docs/api_guide/images/current_sense/SDFM_threshold_comparator_salea_capture.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Threshold_comparator_flow.png b/docs_src/docs/api_guide/images/current_sense/Threshold_comparator_flow.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Threshold_comparator_flow.png rename to docs_src/docs/api_guide/images/current_sense/Threshold_comparator_flow.png diff --git a/docs_src/docs/api_guide/images/images.pptx b/docs_src/docs/api_guide/images/images.pptx index a069efb..1569566 100644 Binary files a/docs_src/docs/api_guide/images/images.pptx and b/docs_src/docs/api_guide/images/images.pptx differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/OOB_Demo_DDRInit.png b/docs_src/docs/api_guide/images/motorcontrol/OOB_Demo_DDRInit.png deleted file mode 100644 index 4f2532c..0000000 Binary files a/docs_src/docs/api_guide/images/motorcontrol/OOB_Demo_DDRInit.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_root.png b/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_root.png deleted file mode 100644 index a727b4b..0000000 Binary files a/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_root.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_stats.png b/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_stats.png deleted file mode 100644 index 8112a89..0000000 Binary files a/docs_src/docs/api_guide/images/motorcontrol/OOB_GUI_stats.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/OOB_Linux_ifconfig.png b/docs_src/docs/api_guide/images/motorcontrol/OOB_Linux_ifconfig.png deleted file mode 100644 index c5a36af..0000000 Binary files a/docs_src/docs/api_guide/images/motorcontrol/OOB_Linux_ifconfig.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/OOB_SW_arch.png b/docs_src/docs/api_guide/images/motorcontrol/OOB_SW_arch.png deleted file mode 100644 index 7433463..0000000 Binary files a/docs_src/docs/api_guide/images/motorcontrol/OOB_SW_arch.png and /dev/null differ diff --git a/docs_src/docs/api_guide/images/motorcontrol/EnDAT_Connections.png b/docs_src/docs/api_guide/images/position_sense/EnDAT_Connections.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/EnDAT_Connections.png rename to docs_src/docs/api_guide/images/position_sense/EnDAT_Connections.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/EnDAT_Initialization_UART_PRINT.png b/docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/EnDAT_Initialization_UART_PRINT.png rename to docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/EnDat_Booster_Pack.png b/docs_src/docs/api_guide/images/position_sense/EnDat_Booster_Pack.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/EnDat_Booster_Pack.png rename to docs_src/docs/api_guide/images/position_sense/EnDat_Booster_Pack.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/EnDat_channel_selection_In_sysconfig.PNG b/docs_src/docs/api_guide/images/position_sense/EnDat_channel_selection_In_sysconfig.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/EnDat_channel_selection_In_sysconfig.PNG rename to docs_src/docs/api_guide/images/position_sense/EnDat_channel_selection_In_sysconfig.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_Example_Implementation.png b/docs_src/docs/api_guide/images/position_sense/Endat_Example_Implementation.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_Example_Implementation.png rename to docs_src/docs/api_guide/images/position_sense/Endat_Example_Implementation.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_Load_share_receive.png b/docs_src/docs/api_guide/images/position_sense/Endat_Load_share_receive.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_Load_share_receive.png rename to docs_src/docs/api_guide/images/position_sense/Endat_Load_share_receive.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_RT_FlowChart_for_position.png b/docs_src/docs/api_guide/images/position_sense/Endat_RT_FlowChart_for_position.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_RT_FlowChart_for_position.png rename to docs_src/docs/api_guide/images/position_sense/Endat_RT_FlowChart_for_position.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_RT_FlowChart_for_supplement.png b/docs_src/docs/api_guide/images/position_sense/Endat_RT_FlowChart_for_supplement.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_RT_FlowChart_for_supplement.png rename to docs_src/docs/api_guide/images/position_sense/Endat_RT_FlowChart_for_supplement.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_Recovery_Time_For_Position.png b/docs_src/docs/api_guide/images/position_sense/Endat_Recovery_Time_For_Position.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_Recovery_Time_For_Position.png rename to docs_src/docs/api_guide/images/position_sense/Endat_Recovery_Time_For_Position.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_Recovery_Time_For_Supplement.PNG b/docs_src/docs/api_guide/images/position_sense/Endat_Recovery_Time_For_Supplement.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_Recovery_Time_For_Supplement.PNG rename to docs_src/docs/api_guide/images/position_sense/Endat_Recovery_Time_For_Supplement.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_channel_selection_configuration.png b/docs_src/docs/api_guide/images/position_sense/Endat_channel_selection_configuration.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_channel_selection_configuration.png rename to docs_src/docs/api_guide/images/position_sense/Endat_channel_selection_configuration.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Endat_load_share_mode.png b/docs_src/docs/api_guide/images/position_sense/Endat_load_share_mode.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Endat_load_share_mode.png rename to docs_src/docs/api_guide/images/position_sense/Endat_load_share_mode.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/HDSL_AM64xE1.png b/docs_src/docs/api_guide/images/position_sense/HDSL_AM64xE1.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/HDSL_AM64xE1.png rename to docs_src/docs/api_guide/images/position_sense/HDSL_AM64xE1.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/HDSL_Booster_Pack.png b/docs_src/docs/api_guide/images/position_sense/HDSL_Booster_Pack.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/HDSL_Booster_Pack.png rename to docs_src/docs/api_guide/images/position_sense/HDSL_Booster_Pack.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/HDSL_Connections.png b/docs_src/docs/api_guide/images/position_sense/HDSL_Connections.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/HDSL_Connections.png rename to docs_src/docs/api_guide/images/position_sense/HDSL_Connections.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/HDSL_Normal.png b/docs_src/docs/api_guide/images/position_sense/HDSL_Normal.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/HDSL_Normal.png rename to docs_src/docs/api_guide/images/position_sense/HDSL_Normal.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/HDSL_SYNC.png b/docs_src/docs/api_guide/images/position_sense/HDSL_SYNC.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/HDSL_SYNC.png rename to docs_src/docs/api_guide/images/position_sense/HDSL_SYNC.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/SDFM_EXAMPLE_FLOWCHART.png b/docs_src/docs/api_guide/images/position_sense/SDFM_EXAMPLE_FLOWCHART.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/SDFM_EXAMPLE_FLOWCHART.png rename to docs_src/docs/api_guide/images/position_sense/SDFM_EXAMPLE_FLOWCHART.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Booster_Pack.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_Booster_Pack.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Booster_Pack.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_Booster_Pack.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_SampleOutput.JPG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_SampleOutput.JPG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_SampleOutput.JPG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_SampleOutput.JPG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Setup_am243x_lp.jpeg b/docs_src/docs/api_guide/images/position_sense/Tamagawa_Setup_am243x_lp.jpeg similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Setup_am243x_lp.jpeg rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_Setup_am243x_lp.jpeg diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Setup_image.jpg b/docs_src/docs/api_guide/images/position_sense/Tamagawa_Setup_image.jpg similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Setup_image.jpg rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_Setup_image.jpg diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_SysConfig.JPG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_SysConfig.JPG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_SysConfig.JPG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_SysConfig.JPG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_UART_output.PNG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_UART_output.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_UART_output.PNG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_UART_output.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Uart_Hw_Setup.PNG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_Uart_Hw_Setup.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_Uart_Hw_Setup.PNG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_Uart_Hw_Setup.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_connections.JPG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_connections.JPG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_connections.JPG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_connections.JPG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_eeprom_write_flow_chart.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_eeprom_write_flow_chart.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_eeprom_write_flow_chart.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_eeprom_write_flow_chart.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_flowchart.JPG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_flowchart.JPG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_flowchart.JPG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_flowchart.JPG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_initialization_flow_chart.JPG b/docs_src/docs/api_guide/images/position_sense/Tamagawa_initialization_flow_chart.JPG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_initialization_flow_chart.JPG rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_initialization_flow_chart.JPG diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_parse_data.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_parse_data.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_parse_data.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_parse_data.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_rx_flow_chart.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_rx_flow_chart.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_rx_flow_chart.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_rx_flow_chart.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_setup.jpg b/docs_src/docs/api_guide/images/position_sense/Tamagawa_setup.jpg similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_setup.jpg rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_setup.jpg diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_setup_tx_data.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_setup_tx_data.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_setup_tx_data.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_setup_tx_data.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_tx_flow_chart.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_tx_flow_chart.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_tx_flow_chart.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_tx_flow_chart.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_uart_flow_chart.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_uart_flow_chart.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_uart_flow_chart.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_uart_flow_chart.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/Tamagawa_verify_crc.png b/docs_src/docs/api_guide/images/position_sense/Tamagawa_verify_crc.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/Tamagawa_verify_crc.png rename to docs_src/docs/api_guide/images/position_sense/Tamagawa_verify_crc.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_2_2_supplement_send.png b/docs_src/docs/api_guide/images/position_sense/endat_2_2_supplement_send.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_2_2_supplement_send.png rename to docs_src/docs/api_guide/images/position_sense/endat_2_2_supplement_send.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_continuous_mode.png b/docs_src/docs/api_guide/images/position_sense/endat_continuous_mode.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_continuous_mode.png rename to docs_src/docs/api_guide/images/position_sense/endat_continuous_mode.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_initialization.png b/docs_src/docs/api_guide/images/position_sense/endat_initialization.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_initialization.png rename to docs_src/docs/api_guide/images/position_sense/endat_initialization.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_load_share_mode_initialization.png b/docs_src/docs/api_guide/images/position_sense/endat_load_share_mode_initialization.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_load_share_mode_initialization.png rename to docs_src/docs/api_guide/images/position_sense/endat_load_share_mode_initialization.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_module_integration.png b/docs_src/docs/api_guide/images/position_sense/endat_module_integration.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_module_integration.png rename to docs_src/docs/api_guide/images/position_sense/endat_module_integration.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_on_fly_downsampling.png b/docs_src/docs/api_guide/images/position_sense/endat_on_fly_downsampling.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_on_fly_downsampling.png rename to docs_src/docs/api_guide/images/position_sense/endat_on_fly_downsampling.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_overall_block_diagram.png b/docs_src/docs/api_guide/images/position_sense/endat_overall_block_diagram.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_overall_block_diagram.png rename to docs_src/docs/api_guide/images/position_sense/endat_overall_block_diagram.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_receive.png b/docs_src/docs/api_guide/images/position_sense/endat_receive.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_receive.png rename to docs_src/docs/api_guide/images/position_sense/endat_receive.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_receive_downsampling.png b/docs_src/docs/api_guide/images/position_sense/endat_receive_downsampling.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_receive_downsampling.png rename to docs_src/docs/api_guide/images/position_sense/endat_receive_downsampling.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_send.png b/docs_src/docs/api_guide/images/position_sense/endat_send.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_send.png rename to docs_src/docs/api_guide/images/position_sense/endat_send.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/endat_send_receive.png b/docs_src/docs/api_guide/images/position_sense/endat_send_receive.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/endat_send_receive.png rename to docs_src/docs/api_guide/images/position_sense/endat_send_receive.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_ddr_trace.png b/docs_src/docs/api_guide/images/position_sense/hdsl_ddr_trace.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_ddr_trace.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_ddr_trace.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_ddr_uart.PNG b/docs_src/docs/api_guide/images/position_sense/hdsl_ddr_uart.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_ddr_uart.PNG rename to docs_src/docs/api_guide/images/position_sense/hdsl_ddr_uart.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_default_uart_menu.PNG b/docs_src/docs/api_guide/images/position_sense/hdsl_default_uart_menu.PNG similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_default_uart_menu.PNG rename to docs_src/docs/api_guide/images/position_sense/hdsl_default_uart_menu.PNG diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_delta_pos.png b/docs_src/docs/api_guide/images/position_sense/hdsl_delta_pos.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_delta_pos.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_delta_pos.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_external_sync.png b/docs_src/docs/api_guide/images/position_sense/hdsl_external_sync.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_external_sync.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_external_sync.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_external_sync_sample_edge.png b/docs_src/docs/api_guide/images/position_sense/hdsl_external_sync_sample_edge.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_external_sync_sample_edge.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_external_sync_sample_edge.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_layer_model.png b/docs_src/docs/api_guide/images/position_sense/hdsl_layer_model.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_layer_model.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_layer_model.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_loading_fw.png b/docs_src/docs/api_guide/images/position_sense/hdsl_loading_fw.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_loading_fw.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_loading_fw.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_rssi.png b/docs_src/docs/api_guide/images/position_sense/hdsl_rssi.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_rssi.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_rssi.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_sampling.png b/docs_src/docs/api_guide/images/position_sense/hdsl_sampling.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_sampling.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_sampling.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_state_machine.png b/docs_src/docs/api_guide/images/position_sense/hdsl_state_machine.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_state_machine.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_state_machine.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_sync_algo.png b/docs_src/docs/api_guide/images/position_sense/hdsl_sync_algo.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_sync_algo.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_sync_algo.png diff --git a/docs_src/docs/api_guide/images/motorcontrol/hdsl_test_pattern.png b/docs_src/docs/api_guide/images/position_sense/hdsl_test_pattern.png similarity index 100% rename from docs_src/docs/api_guide/images/motorcontrol/hdsl_test_pattern.png rename to docs_src/docs/api_guide/images/position_sense/hdsl_test_pattern.png diff --git a/docs_src/docs/api_guide/images/syscfg_00.png b/docs_src/docs/api_guide/images/syscfg_00.png deleted file mode 100644 index 3c3e0b6..0000000 Binary files a/docs_src/docs/api_guide/images/syscfg_00.png and /dev/null differ 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 713e037..31ddc16 100644 --- a/docs_src/docs/api_guide/main_page/main_page.md +++ b/docs_src/docs/api_guide/main_page/main_page.md @@ -2,34 +2,28 @@ [TOC] -\if SOC_AM64X -Welcome to **@VAR_SDK_NAME for @VAR_SOC_NAME**. This SDK contains examples, libraries and tools to develop **RTOS and no-RTOS** based applications for **ARM R5F, ARM M4F, ARM A53 (single core and SMP on both cores) CPUs** and related peripherals. -\else -Welcome to **@VAR_SDK_NAME for @VAR_SOC_NAME**. This SDK contains examples, libraries and tools to develop **RTOS and no-RTOS** based applications for **ARM R5F, ARM M4F CPUs** and related peripherals. -\endif +Welcome to **@VAR_SDK_NAME for @VAR_SOC_NAME**. This SDK contains examples, libraries and tools to develop **RTOS and no-RTOS** based applications enabling real-time communication for position and current sense from motors, and real-time control libraries for **ARM R5F CPU** and related peripherals. -\cond SOC_AM64X -This SDK also contains examples to interface these ARM R5F, ARM M4F applications with **Processor SDK Linux** based Cortex-A applications. -\endcond + +Real-time communication with encoders and current sensing is typically handled by the Programmable Real-Time Unit Industrial Communication Subsystem (PRU-ICSS). The PRU-ICSS is a co-processor subsystem containing Programmable Real-Time (PRU) cores which implement the low level firmware. The PRU-ICSS frees up the main ARM cores in the device for other functions, such as control and data processing. + +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}. ## Getting Started -To get started, see \ref GETTING_STARTED +To get started, see \htmllink{@VAR_MCU_SDK_DOCS_PATH/GETTING_STARTED.html, GETTING STARTED} page. ## Block Diagram -Given below is a block diagram of the SW modules in this SDK, +Given below is a block diagram of the SW modules in this SDK -\if SOC_AM64X -\imageStyle{am64x/block_diagram.png,width:70%} -\image html am64x/block_diagram.png "Software Block Diagram" -\else -\imageStyle{block_diagram.png,width:70%} \image html block_diagram.png "Software Block Diagram" -\endif -The main software components in the block diagram are described below +The main software components in the block diagram specific to motor control are described below +\cond SOC_AM64X || SOC_AM243X| Documentation Page | Description | ||||
|---|---|---|---|---|---|
| **Protocol Stacks and Middleware** | |||||
| **Position Sense Encoders** | |||||
| Motor Control - | \ref EXAMPLES_MOTORCONTROL - | Drive protocols for EnDAT, HDSL. + | EnDat + | \ref ENDAT + | Driver and PRU-ICSS firmware for EnDat encoder interface + |
| HDSL + | \ref HDSL + | Driver and PRU-ICSS firmware for Hiperface DSL encoder interface + | |||
| Tamagawa + | \ref TAMAGAWA + | Driver and PRU-ICSS firmware for Tamagawa encoder interface + | |||
| **Current Sense** | |||||
| %SDFM + | \ref SDFM + | Driver and firmware for current sense using Sigma-Delta Filtering Module | |||
| **Examples and Demos** | |||||
| Examples and Demos | \ref EXAMPLES - | Examples and demos showing usage of different SW libraries and APIs + | Examples and demos showing usage of different SW libraries and APIs for motor control | ||
| Software Components + | Documentation Page + | Description + |
|---|---|---|
| **Position Sense Encoders** | ||
| Tamagawa + | \ref TAMAGAWA_OVER_UART + | Driver for Tamagawa encoder interface + |
| **Examples and Demos** | ||
| Examples and Demos + | \ref EXAMPLES + | Examples and demos showing usage of different SW libraries and APIs for motor control + |