am64x/am243x/am263x : add documentation
add documentation Fixes: PINDSW-6434 Signed-off-by: Naresh A <nareshk@ti.com>
This commit is contained in:
Naresh A
parent
596d48c7d7
commit
354e989698
@ -1,12 +1,11 @@
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/motor_control.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/endat.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/endat_design.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/hdsl.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/hdsl_design.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/tamagawa.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/tamagawa_design.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/sdfm.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/sdfm_design.md
|
||||
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/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)/source/position_sense/endat/include/endat_api.h
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_drv.h
|
||||
6
docs_src/docs/api_guide/device/am243x/examples.cfg
Normal file
6
docs_src/docs/api_guide/device/am243x/examples.cfg
Normal file
@ -0,0 +1,6 @@
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/examples.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/hdsl_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/hdsl_example_trace.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/endat_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/tamagawa_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/sdfm_example.md
|
||||
24
docs_src/docs/api_guide/device/am243x/includes.cfg
Normal file
24
docs_src/docs/api_guide/device/am243x/includes.cfg
Normal file
@ -0,0 +1,24 @@
|
||||
|
||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
||||
# double-quotes, unless you are using Doxywizard) that should identify the
|
||||
# project for which the documentation is generated. This name is used in the
|
||||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
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
|
||||
|
||||
# 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"
|
||||
@ -1,3 +1,2 @@
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/tamagawa_uart.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/motor_control.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/tamagawa_uart.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa_over_soc_uart/include/tamagawa_soc_uart_interface.h
|
||||
2
docs_src/docs/api_guide/device/am263x/examples.cfg
Normal file
2
docs_src/docs/api_guide/device/am263x/examples.cfg
Normal file
@ -0,0 +1,2 @@
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/examples.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/tamagawa_uart_example.md
|
||||
24
docs_src/docs/api_guide/device/am263x/includes.cfg
Normal file
24
docs_src/docs/api_guide/device/am263x/includes.cfg
Normal file
@ -0,0 +1,24 @@
|
||||
|
||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
||||
# double-quotes, unless you are using Doxywizard) that should identify the
|
||||
# project for which the documentation is generated. This name is used in the
|
||||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
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
|
||||
@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_AM263X
|
||||
|
||||
# SOC specific aliases
|
||||
ALIASES+=VAR_SOC_NAME="AM263X"
|
||||
ALIASES+=VAR_SOC_NAME_LOWER="am263x"
|
||||
ALIASES+=VAR_BOARD_NAME="AM263X-CC"
|
||||
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"
|
||||
15
docs_src/docs/api_guide/device/am64x/components.cfg
Normal file
15
docs_src/docs/api_guide/device/am64x/components.cfg
Normal file
@ -0,0 +1,15 @@
|
||||
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/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)/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_drv.h
|
||||
@ -1,8 +1,6 @@
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/examples.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/motorcontrol.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example_trace.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/endat_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/tamagawa_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/motorcontrol/sdfm_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/hdsl_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/hdsl_example_trace.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/endat_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/tamagawa_example.md
|
||||
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/examples/sdfm_example.md
|
||||
|
||||
@ -8,8 +8,8 @@
|
||||
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/am64x/examples.cfg
|
||||
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/motor_control/motor_control_am64x_am243x.cfg
|
||||
@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
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/hdsl_example.md:76: 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:188: 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:190: 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:191: 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:60: 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:89: 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:91: 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:92: 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:113: 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:210: 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:212: 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:213: 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:87: 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:196: 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:198: 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:199: 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:82: 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:94: 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:96: 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:97: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:256: warning: explicit link request to 'PRUICSS_Handle' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:391: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:391: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:404: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:404: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:226: 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: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:20: 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:34: warning: unable to resolve reference to `EXAMPLES_MOTORCONTROL' for \ref command
|
||||
@ -0,0 +1,5 @@
|
||||
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
|
||||
@ -1,28 +1,23 @@
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example.md:76: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example.md:188: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example.md:190: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example.md:191: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example_trace.md:60: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/hdsl_example_trace.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/motorcontrol/hdsl_example_trace.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/motorcontrol/hdsl_example_trace.md:92: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/endat_example.md:113: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/endat_example.md:210: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/endat_example.md:212: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/endat_example.md:213: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/tamagawa_example.md:87: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/tamagawa_example.md:196: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/tamagawa_example.md:198: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/tamagawa_example.md:199: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md:68: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md:84: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md:86: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md:119: warning: image file boot_pins_sd_mode_oob.png is not found in IMAGE_PATH: assuming external image.
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/benchmarkdemo_example_am64x.md:125: warning: unable to resolve reference to `CCS_UART_TERMINAL' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/sdfm_example.md:82: warning: unable to resolve reference to `EVM_SETUP_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/sdfm_example.md:94: warning: unable to resolve reference to `CCS_PROJECTS_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/sdfm_example.md:96: warning: unable to resolve reference to `MAKEFILE_BUILD_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/examples/motorcontrol/sdfm_example.md:97: 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:76: 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:188: 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:190: 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:191: 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:60: 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:89: 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:91: 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:92: 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:113: 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:210: 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:212: 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:213: 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:87: 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:196: 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:198: 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:199: 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:82: 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:94: 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:96: 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:97: warning: unable to resolve reference to `CCS_LAUNCH_PAGE' for \ref command
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:256: warning: explicit link request to 'PRUICSS_Handle' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:391: warning: explicit link request to 'SystemP_SUCCESS' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:391: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved
|
||||
@ -30,6 +25,5 @@ C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:404: warni
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:404: warning: explicit link request to 'SystemP_TIMEOUT' could not be resolved
|
||||
C:/ti/motor_control_sdk/source/position_sense/hdsl/include/hdsl_drv.h:226: 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: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:16: warning: found subsection command outside of section context!
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:17: warning: unable to resolve reference to `MIGRATION_GUIDES' for \ref command
|
||||
C:/ti/motor_control_sdk/docs_src/docs/api_guide/main_page/main_page.md:24: 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:20: 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:34: warning: unable to resolve reference to `EXAMPLES_MOTORCONTROL' for \ref command
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = 08.04.00
|
||||
PROJECT_NUMBER = 09.00.00
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
||||
@ -1,8 +1,13 @@
|
||||
# Examples and Demos {#EXAMPLES}
|
||||
This page lists all the examples and demos supported in this SDK.
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
-# \subpage EXAMPLES_MOTORCONTROL
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_ENDAT
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_HDSL
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_HDSL_TRACE
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_SDFM
|
||||
\endcond
|
||||
|
||||
\cond SOC_AM263X
|
||||
-# \subpage EXAMPLES_MOTORCONTROL
|
||||
\endcond
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA_OVER_UART
|
||||
\endcond
|
||||
@ -1,148 +0,0 @@
|
||||
# Benchmark Demo with GUI Composer {#EXAMPLE_MOTORCONTROL_BENCHMARKDEMO}
|
||||
|
||||
[TOC]
|
||||
|
||||
## Introduction
|
||||
|
||||
The Benchmark Demo showcases the capabilities of the 4 R5F cores on AM243x. Each R5F core runs a particular benchmark test and displays the results on a Cloud-based GUI.
|
||||
|
||||
The @VAR_BOARD_NAME version of the demo also has power monitoring functionality and displays voltage, current, and total power consumption.
|
||||
|
||||
The mapping of R5F core to the benchmark that is run is shown below
|
||||
<table>
|
||||
<tr>
|
||||
<th>R5 Core
|
||||
<th>Benchmark
|
||||
<th>Default Option
|
||||
<th>Description
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 0 (rf5ss0-0)</td>
|
||||
<td>Stream memory benchmark</td>
|
||||
<td>1 hz execution loop</td>
|
||||
<td>Memory bandwidth benchmark for R5. For more details on the STREAM benchmark, see http://www.cs.virginia.edu/stream/ref.html
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 1 (rf5ss0-1)</td>
|
||||
<td>CFFT benchmark</td>
|
||||
<td>1Khz execution loop, 128 point CFFT</td>
|
||||
<td>CMSIS CFFT benchmark for R5F</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 2 (rf5ss1-0)</td>
|
||||
<td>FIR filtering benchmark</td>
|
||||
<td>1 Khz execution loop, 320 point, 29-tap</td>
|
||||
<td>CMSIS FIR filtering benchmark for R5F </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 3 (rf5ss1-1)</td>
|
||||
<td>Field Oriented Control (FOC) benchmark </td>
|
||||
<td>32 Khz execution loop</td>
|
||||
<td>CMSIS FOC benchmark for R5F</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# Steps to Run the Example {#STEPS}
|
||||
|
||||
## EVM Setup
|
||||
|
||||
- To run the demo from GUI composer, firstly you need to make sure the EVM is setup as mentioned here, \ref EVM_SETUP_PAGE
|
||||
- Specifically,
|
||||
- Make sure you have connected the power, USB UART and USB JTAG cables as mentioned here, \ref EVM_CABLES
|
||||
- Make sure you have identified the UART port that is used for the print logs as mentioned here, \ref CCS_UART_TERMINAL
|
||||
- Check if the SOC initialization binary is already flashed. If flashed, you will see something like below in the UART terminal,
|
||||
\code
|
||||
Starting NULL Bootloader ...
|
||||
|
||||
DMSC Firmware Version 21.1.1--v2021.01a (Terrific Lla
|
||||
DMSC Firmware revision 0x15
|
||||
DMSC ABI revision 3.1
|
||||
|
||||
INFO: Bootloader_runCpu:147: CPU r5f1-0 is initialized to 800000000 Hz !!!
|
||||
INFO: Bootloader_runCpu:147: CPU r5f1-1 is initialized to 800000000 Hz !!!
|
||||
INFO: Bootloader_runCpu:147: CPU m4f0-0 is initialized to 400000000 Hz !!!
|
||||
INFO: Bootloader_loadSelfCpu:199: CPU r5f0-0 is initialized to 800000000 Hz !!!
|
||||
INFO: Bootloader_loadSelfCpu:199: CPU r5f0-1 is initialized to 800000000 Hz !!!
|
||||
INFO: Bootloader_runSelfCpu:209: All done, reseting self ...
|
||||
\endcode
|
||||
- If you see this in the UART terminal, you are all set to launch the demo, else you will
|
||||
need to flash the SOC initialization binary as mentioned here, \ref EVM_FLASH_SOC_INIT
|
||||
- Now you can launch the demo via GUI composer as mentioned next
|
||||
|
||||
## Launch the demo
|
||||
|
||||
- Close all open UART terminals and JTAG connections. GUI composer via the browser will need access
|
||||
to the UART port and JTAG port.
|
||||
|
||||
- Power on the EVM with the USB UART and USB JTAG cables connected.
|
||||
|
||||
- In a web browser, Firefox, Chrome or Edge, click on the below link
|
||||
- For @VAR_LP_BOARD_NAME, https://dev.ti.com/gallery/view/SitaraMCU/AM243x_LaunchPad_OOB_Experience
|
||||
- For @VAR_BOARD_NAME, https://dev.ti.com/gallery/view/SitaraMCU/AM243x_EVM_OOB_Experience
|
||||
|
||||
- Click on benchmark demo
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_00.png,width:20%}
|
||||
\image html am243x_benchmark_demo_00.png
|
||||
|
||||
- Select the UART port noted during EVM setup and set the UART baud rate as shown below,
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_01.png,width:20%}
|
||||
\image html am243x_benchmark_demo_01.png
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_02.png,width:30%}
|
||||
\image html am243x_benchmark_demo_02.png
|
||||
|
||||
- Click on `LAUNCH` to launch the demo
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_03.png,width:50%}
|
||||
\image html am243x_benchmark_demo_03.png
|
||||
|
||||
- You will see some setup happening in the bottom of the browser window, let this continue. First time this make take a minute or so to complete.
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_04.png,width:90%}
|
||||
\image html am243x_benchmark_demo_04.png
|
||||
|
||||
- After all the setup and download is done, you will see the benchmark demo results updating in the GUI as shown below
|
||||
|
||||
\imageStyle{am243x_benchmark_demo_05.png,width:90%}
|
||||
\image html am243x_benchmark_demo_05.png
|
||||
|
||||
- You can interact with the GUI options to change the settings and see the updated results.
|
||||
|
||||
# Supported Combinations
|
||||
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
|
||||
Parameter | Value
|
||||
---------------|-----------
|
||||
CPU + OS | r5fss0-0 nortos
|
||||
^ | r5fss0-1 nortos
|
||||
^ | r5fss1-0 nortos
|
||||
^ | r5fss1-1 nortos
|
||||
Toolchain | ti-arm-clang
|
||||
Boards | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
|
||||
Example folder | examples/motor_control/benchmark_demo/
|
||||
|
||||
\endcond
|
||||
|
||||
# Build and run the demo without GUI composer
|
||||
|
||||
\note The GUI composer loads a pre-built binary from a server to run the demo. This prebuilt binary cannot be changed by end users.
|
||||
|
||||
\note This section is a reference for users to understand and build the underlying source code of the demo. However
|
||||
they will not be able to see the results of the updated binary on the GUI composer.
|
||||
|
||||
\note This is a `system` or multi-core project, so refer to system project build instructions for CCS project or makefiles when building the example.
|
||||
|
||||
- **When using CCS projects to build**, import the system CCS project
|
||||
and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). This will build all the dependant CPU projects as well
|
||||
- **When using makefiles to build**, build the system makefile using
|
||||
make command (see \ref MAKEFILE_BUILD_PAGE). This will build all the dependant CPU makefiles as well.
|
||||
- Launch a CCS debug session and run the executables, see \ref CCS_LAUNCH_PAGE
|
||||
- This is a multi-core example. Hence the executables should be loaded and run for all the above mentioned cores
|
||||
- When you run the demo it will output some text on UART console continuously. When running
|
||||
with GUI composer this text is used as input to render the contents of the GUI.
|
||||
|
||||
|
||||
@ -1,177 +0,0 @@
|
||||
# Benchmark Demo with Linux on A53 {#EXAMPLE_MOTORCONTROL_BENCHMARKDEMO}
|
||||
|
||||
[TOC]
|
||||
|
||||
## Introduction
|
||||
|
||||
The benchmark demo showcases the capabilities of the four R5F cores as well as
|
||||
the A53 core. This demo is run by default when **Processor SDK Linux** is flashed to SD card.
|
||||
Different R5F benchmarks will run on each of the four R5F cores. There are four options available for each
|
||||
benchmark. Users can switch the options using the drop-down menu in the GUI to view
|
||||
performance of R5F with each option.
|
||||
|
||||
The mapping of R5F core to the benchmark that is run is shown below
|
||||
<table>
|
||||
<tr>
|
||||
<th>R5 Core
|
||||
<th>Benchmark
|
||||
<th>Default Option
|
||||
<th>Description
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 0 (rf5ss0-0)</td>
|
||||
<td>ADC and PWM benchmark</td>
|
||||
<td>8 Khz execution loop</td>
|
||||
<td>ADC/PWM benchmark for R5F, here we read 5 ADC samples and do 1 PWM write. **NOTE: This is not enabled in current release**.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 1 (rf5ss0-1)</td>
|
||||
<td>CFFT benchmark</td>
|
||||
<td>1Khz execution loop, 128 point CFFT</td>
|
||||
<td>CMSIS CFFT benchmark for R5F</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 2 (rf5ss1-0)</td>
|
||||
<td>FIR filtering benchmark</td>
|
||||
<td>1 Khz execution loop, 320 point, 29-tap</td>
|
||||
<td>CMSIS FIR filtering benchmark for R5F </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>R5F Core 3 (rf5ss1-1)</td>
|
||||
<td>Field Oriented Control (FOC) benchmark </td>
|
||||
<td>16 Khz execution loop</td>
|
||||
<td>CMSIS FOC benchmark for R5F</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# Supported Combinations
|
||||
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
|
||||
Parameter | Value
|
||||
---------------|-----------
|
||||
CPU + OS | r5fss0-0 nortos
|
||||
^ | r5fss0-1 nortos
|
||||
^ | r5fss1-0 nortos
|
||||
^ | r5fss1-1 nortos
|
||||
Toolchain | ti-arm-clang
|
||||
Board | @VAR_BOARD_NAME_LOWER
|
||||
Example folder | examples/motor_control/benchmark_demo/
|
||||
|
||||
\endcond
|
||||
|
||||
# Steps to Run the Example {#STEPS}
|
||||
|
||||
## Hardware Prerequisites
|
||||
|
||||
Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additional HW is required to run this demo
|
||||
- PC with a web browser and wired ethernet connectivity (Windows or Linux)
|
||||
- Ethernet cables
|
||||
- Ethernet switch or ethernet router with DHCP service
|
||||
- SD card (minimum 2GB)
|
||||
|
||||
## Build the R5F side projects
|
||||
|
||||
\note The default **Processor SDK Linux** has prebuilt applications already, so this step can be skipped unless you have modified the
|
||||
demo application on R5F.
|
||||
|
||||
\note This is a `system` or multi-core project, so refer to system project build instructions for CCS project or makefiles when building the example.
|
||||
|
||||
- **When using CCS projects to build**, import the system CCS project
|
||||
and build it using the CCS project menu (see \ref CCS_PROJECTS_PAGE). This will build all the dependant CPU projects as well
|
||||
- **When using makefiles to build**, build the system makefile using
|
||||
make command (see \ref MAKEFILE_BUILD_PAGE). This will build all the dependant CPU makefiles as well.
|
||||
- After the build is complete the copy the below files to the SD card containing Linux filesystem in folder `/lib/firmware`.
|
||||
\code
|
||||
{system project output folder}/am64-main-r5f0_0-fw
|
||||
{system project output folder}/am64-main-r5f0_1-fw
|
||||
{system project output folder}/am64-main-r5f1_0-fw
|
||||
{system project output folder}/am64-main-r5f1_1-fw
|
||||
|
||||
When using makefiles to build, "system project output folder", is
|
||||
${SDK_INSTALL_PATH}/examples/motor_control/benchmark_demo/{board}/system_nortos
|
||||
|
||||
When using CCS projects to build, "system project output folder", is
|
||||
${CCS_WORKSPACE_PATH}/benchmark_demo_{board}_system_nortos/{Debug or Release}
|
||||
|
||||
\endcode
|
||||
|
||||
- **NOTE**, the copy step can only be done using a Linux machine since the Linux filesystem on the SD card cannot be seen on a Windows machine.
|
||||
|
||||
## Run the demo
|
||||
|
||||
- To run this demo, Linux needs to run on the Cortex A-core.
|
||||
- This typically involves flashing a prebuilt Linux filesystem (`.wic` file) to the SD card
|
||||
- Refer to **Processor SDK Linux** user guide to setup Linux on Cortex-A core.
|
||||
|
||||
- Keep the EVM in **POWER-OFF** state.
|
||||
|
||||
- Insert the SD card with Linux filesystem onto the EVM
|
||||
|
||||
- Set the EVM boot mode to "SD boot mode"
|
||||
|
||||
\imageStyle{boot_pins_sd_mode_oob.png,width:50%}
|
||||
\image html boot_pins_sd_mode_oob.png "SD BOOT MODE"
|
||||
|
||||
- Connect an ethernet cable from your ethernet switch or router to the EVM
|
||||
|
||||
- Connect your PC to the same ethernet switch or router
|
||||
|
||||
- Identify and setup a UART terminal console as mentioned in \ref CCS_UART_TERMINAL
|
||||
|
||||
- **POWER-ON** the EVM.
|
||||
|
||||
- After the Linux boot completes, login as "root", then type in "ifconfig" in Linux prompt to find out the IP address for the EVM
|
||||
|
||||
\imageStyle{OOB_Linux_ifconfig.png,width:40%}
|
||||
\image html OOB_Linux_ifconfig.png
|
||||
|
||||
- On the PC, open a Internet Browser and enter in below in the address bar,
|
||||
\code
|
||||
http://{IP address of the EVM}:8081
|
||||
|
||||
Example,
|
||||
http://192.168.86.198:8081
|
||||
\endcode
|
||||
|
||||
|
||||
- The following web page will show in the browser,
|
||||
|
||||
\imageStyle{OOB_GUI_root.png,width:50%}
|
||||
\image html OOB_GUI_root.png
|
||||
|
||||
- Click on the "Benchmark Demo",
|
||||
|
||||
\imageStyle{OOB_GUI_stats.png,width:70%}
|
||||
\image html OOB_GUI_stats.png
|
||||
|
||||
- The R5F application for each core is fixed. User can change the `Options` for each core, then click `LOAD` to refresh the statistics
|
||||
|
||||
|
||||
# Sample Output
|
||||
|
||||
Shown below is a sample output when the application is run.
|
||||
|
||||
\imageStyle{OOB_GUI_stats.png,width:70%}
|
||||
\image html OOB_GUI_stats.png
|
||||
|
||||
# Benchmark Results
|
||||
|
||||
\cond SOC_AM64X
|
||||
|
||||
CORE | CMSIS Application | CPU Usage(Avg) | Interrupt Latency (ns)(Avg) | Cycle Counter per loop(Avg)
|
||||
---------------|-------------------|----------------|-----------------------------|----------------------------
|
||||
R5FSS0_1 | CFFT(128pt) | 0 | 358 | 7878
|
||||
^ | CFFT(256pt) | 2 | 393 | 18374
|
||||
^ | CFFT(512pt) | 4 | 850 | 34633
|
||||
^ | CFFT(1024pt) | 13 | 1027 | 105388
|
||||
R5FSS1_0 | FIR(1KHz) | 3 | 160 | 26942
|
||||
^ | FIR(2KHz) | 6 | 204 | 26981
|
||||
^ | FIR(4KHz) | 13 | 166 | 26965
|
||||
^ | FIR(8KHz) | 26 | 202 | 26994
|
||||
R5FSS1_1 | FOC(16KHz) | 0 | 202 | 316
|
||||
^ | FOC(32KHz) | 1 | 164 | 318
|
||||
^ | FOC(100KHz) | 3 | 174 | 314
|
||||
^ | FOC(250KHz) | 10 | 199 | 315
|
||||
\endcond
|
||||
@ -1,16 +0,0 @@
|
||||
# Motor Control {#EXAMPLES_MOTORCONTROL}
|
||||
|
||||
This page lists all the examples related to motor control applications.
|
||||
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_BENCHMARKDEMO
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_ENDAT
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_HDSL
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_HDSL_TRACE
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_SDFM
|
||||
\endcond
|
||||
|
||||
\cond SOC_AM263X
|
||||
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA_OVER_UART
|
||||
\endcond
|
||||
@ -16,10 +16,6 @@ This SDK also contains examples to interface these ARM R5F, ARM M4F applications
|
||||
|
||||
To get started, see \ref GETTING_STARTED
|
||||
|
||||
## Migration Information {#MIGRATION_INFORMATION}
|
||||
|
||||
When migrating from Processor SDK RTOS, see \ref MIGRATION_GUIDES for more details.
|
||||
|
||||
## Block Diagram
|
||||
|
||||
Given below is a block diagram of the SW modules in this SDK,
|
||||
@ -45,7 +41,7 @@ The main software components in the block diagram are described below
|
||||
<tr>
|
||||
<td>Motor Control
|
||||
<td>\ref EXAMPLES_MOTORCONTROL
|
||||
<td>Drive protocols for EnDAT, HDSL and Benchmark demo for CFFT, FIR and FOC.
|
||||
<td>Drive protocols for EnDAT, HDSL.
|
||||
</tr>
|
||||
<tr><td colspan="3" bgcolor=#F0F0F0>**Examples and Demos**</td></tr>
|
||||
<tr>
|
||||
@ -89,10 +85,6 @@ Given below is a overview of the directory structure to help you navigate the SD
|
||||
<td>source/
|
||||
<td>Device drivers, middleware libraries and APIs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>motor_control/
|
||||
<td>Motor control related encoder libraries like HDSL and EnDATc</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Given below are the paths where the different tools needed outside the SDK, like CCS, SysConfig are installed by default in Windows.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user