allsoc: docs: Update the main page of documentation

- Update the text
- Update the block diagram and links
- Add links to IC SDK and MCU+ SDK
- Fix the documentation build warnings

Fixes: PINDSW-6552

Signed-off-by: Dhaval Khandla <dhavaljk@ti.com>
This commit is contained in:
Dhaval Khandla 2023-09-01 16:56:05 +05:30
parent 3cc1c220cd
commit 81850f6662
109 changed files with 180 additions and 232 deletions

1
.gitignore vendored
View File

@ -54,6 +54,7 @@ source/usb/tinyusb/tinyusb-stack
source/dsplib_c66x_3_4_0_0/ source/dsplib_c66x_3_4_0_0/
docs/industrial_protocol_docs docs/industrial_protocol_docs
mcusdk_tagfile mcusdk_tagfile
mcsdk_tagfile
__pycache__/ __pycache__/
source/position_sense/hdsl/firmware/*.lst source/position_sense/hdsl/firmware/*.lst
source/position_sense/hdsl/firmware/*.obj source/position_sense/hdsl/firmware/*.obj

View File

@ -1,8 +1,11 @@
# SDFM {#SDFM} # Current Sense {#CURRENT_SENSE}
[TOC] [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. 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 ## Features Supported
@ -16,7 +19,6 @@ ICSS SDFM is a sigma delta interface for phase current measurement in high perfo
- Zero cross comparator - Zero cross comparator
- Below 32 OSR - Below 32 OSR
## ICSS SDFM Design ## ICSS SDFM Design
\subpage SDFM_DESIGN explains the design in detail. \subpage SDFM_DESIGN explains the design in detail.

View File

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

View File

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

View File

@ -5,8 +5,9 @@
## Introduction ## 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. 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 \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 ## Features Supported

View File

@ -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/position_sense/position_sense.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/position_sense/endat.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/position_sense/endat_design.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/position_sense/hdsl.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/position_sense/hdsl_design.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/position_sense/hdsl_registers_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/position_sense/hdsl_exceptions_list.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/position_sense/tamagawa.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/position_sense/tamagawa_design.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/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_api.h
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_drv.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/hdsl/include/hdsl_drv.h
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa/include/tamagawa_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 INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_drv.h

View File

@ -5,20 +5,22 @@
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # 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 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)/examples.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.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 # Used to selectively pick DEVICE specific sections within .md files
ENABLED_SECTIONS = SOC_AM64X ENABLED_SECTIONS = SOC_AM243X
# SOC specific aliases # SOC specific aliases
ALIASES+=VAR_SOC_NAME="AM64X" ALIASES+=VAR_SOC_NAME="AM243X"
ALIASES+=VAR_SOC_NAME_LOWER="am64x" ALIASES+=VAR_SOC_NAME_LOWER="am243x"
ALIASES+=VAR_BOARD_NAME="AM64X-EVM" ALIASES+=VAR_BOARD_NAME="AM243X-EVM"
ALIASES+=VAR_BOARD_NAME_LOWER="am64x-evm" ALIASES+=VAR_BOARD_NAME_LOWER="am243x-evm"
ALIASES+=VAR_SK_BOARD_NAME="AM64X-SK" ALIASES+=VAR_LP_BOARD_NAME="AM243X-LP"
ALIASES+=VAR_SK_BOARD_NAME_LOWER="am64x-sk" ALIASES+=VAR_LP_BOARD_NAME_LOWER="am243x-lp"
ALIASES+=VAR_SOC_MANIFEST="motor_control_sdk_am64x_manifest.html" 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"

View File

@ -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 INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa_over_soc_uart/include/tamagawa_soc_uart_interface.h

View File

@ -5,7 +5,7 @@
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # 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 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)/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="AM263X-LP"
ALIASES+=VAR_LP_BOARD_NAME_LOWER="am263x-lp" ALIASES+=VAR_LP_BOARD_NAME_LOWER="am263x-lp"
ALIASES+=VAR_SOC_MANIFEST="mcu_plus_sdk_am263x_manifest.html" 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"

View File

@ -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/position_sense/position_sense.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/position_sense/endat.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/position_sense/endat_design.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/position_sense/hdsl.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/position_sense/hdsl_design.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/position_sense/hdsl_registers_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/position_sense/hdsl_exceptions_list.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/position_sense/tamagawa.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/position_sense/tamagawa_design.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/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_api.h
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/endat/include/endat_drv.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/hdsl/include/hdsl_drv.h
INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/position_sense/tamagawa/include/tamagawa_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 INPUT+= $(MOTOR_CONTROL_SDK_PATH)/source/current_sense/sdfm/include/sdfm_drv.h

View File

@ -5,7 +5,7 @@
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # 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 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)/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="AM64X-SK"
ALIASES+=VAR_SK_BOARD_NAME_LOWER="am64x-sk" ALIASES+=VAR_SK_BOARD_NAME_LOWER="am64x-sk"
ALIASES+=VAR_SOC_MANIFEST="motor_control_sdk_am64x_manifest.html" 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"

View File

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

View File

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

View File

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

View File

@ -218,7 +218,7 @@ ALIASES+=imageStyle{2}="\htmlonly <style>div.image img[src=\"\1\"]{\2}</style>\e
ALIASES+=inlineVideo{3}="\htmlonly <video autoplay playinline muted controls \3 style=\"display:block; margin: 0 auto;\"> <source src=\"\1\" type=\"video/mp4\"> </video> <p style=\"text-align: center;\"><strong>\2</strong></p> \endhtmlonly" ALIASES+=inlineVideo{3}="\htmlonly <video autoplay playinline muted controls \3 style=\"display:block; margin: 0 auto;\"> <source src=\"\1\" type=\"video/mp4\"> </video> <p style=\"text-align: center;\"><strong>\2</strong></p> \endhtmlonly"
ALIASES+=VAR_MY_NAME="my_value" ALIASES+=VAR_MY_NAME="my_value"
ALIASES+=VAR_TI_HOME_PAGE="\htmllink{https://www.ti.com,TI}" 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_VERSION="12.4.0"
ALIASES+=VAR_CCS_FOLDER_VERSION="1240" ALIASES+=VAR_CCS_FOLDER_VERSION="1240"
ALIASES+=VAR_CCS_VERSION_AM263X="12.4.0" ALIASES+=VAR_CCS_VERSION_AM263X="12.4.0"
@ -853,7 +853,9 @@ EXAMPLE_RECURSIVE = NO
# \image command). # \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/
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 # 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 # 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 # 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. # 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 # 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. # class index. If set to NO only the inherited external classes will be listed.

View File

@ -110,7 +110,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F).
## Hardware Prerequisites ## 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 - EnDAT encoder
- TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 - TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179
- TIDEP-01015 3 Axis board - TIDEP-01015 3 Axis board
@ -205,10 +205,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
\endcond \endcond
## Build, load and run ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.
### Sample Output ### Sample Output

View File

@ -73,7 +73,7 @@ It then presents the user with menu options, based on the option selected, appli
## Hardware Prerequisites ## 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 - HDSL encoder
- Below are two options to connect encoder to AM64x/AM243x EVM. - Below are two options to connect encoder to AM64x/AM243x EVM.
- **Option 1** - **Option 1**
@ -183,10 +183,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
\endcond \endcond
## Build, load and run ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.
# Sync Mode: # Sync Mode:

View File

@ -57,7 +57,7 @@ Firmware is split to three sections, initialization, datalink and transport. At
## Hardware Prerequisites ## 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 - HDSL encoder
- Below are two options to connect encoder to AM64x/AM243x EVM. - Below are two options to connect encoder to AM64x/AM243x EVM.
- **Option 1** - **Option 1**
@ -84,10 +84,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
## Build, load and run ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.
\imageStyle{hdsl_ddr_trace.png,width:60%} \imageStyle{hdsl_ddr_trace.png,width:60%}

View File

@ -79,7 +79,7 @@ Following section describes the Example implementation of ICSS SDFM on ARM(R5F).
# Steps to Run the Example # Steps to Run the Example
## Hardware Prerequisites ## 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 - TIDEP-01015 3 Axis board
- Interface card connecting EVM and TIDEP-01015 3 Axis board - Interface card connecting EVM and TIDEP-01015 3 Axis board
- Signal generator - Signal generator
@ -89,10 +89,10 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
## Build, load and run ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.

View File

@ -84,7 +84,7 @@ The Tamagawa receiver firmware running on ICSS0-PRU1 provides a defined interfac
# Steps to Run the Example # Steps to Run the Example
## Hardware Prerequisites ## 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 - Tamagawa Encoders
- TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179 - TIDA-00179 Universal Digital Interface to Absolute Position Encoders, http://www.ti.com/tool/TIDA-00179
- TIDEP-01015 3 Axis board - 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 ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.
### Sample Output ### Sample Output

View File

@ -82,10 +82,10 @@ The tamagawa over uart example runs on R5 and communicates with tamagawa encoder
## Build, load and run ## 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 - **When using makefiles to build**, note the required combination and build using
make command (see \ref MAKEFILE_BUILD_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 \ref CCS_LAUNCH_PAGE - 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. - Refer to UART terminal for user interface menu options.
### Sample Output ### Sample Output

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

View File

Before

Width:  |  Height:  |  Size: 956 KiB

After

Width:  |  Height:  |  Size: 956 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 3.4 MiB

After

Width:  |  Height:  |  Size: 3.4 MiB

View File

Before

Width:  |  Height:  |  Size: 506 KiB

After

Width:  |  Height:  |  Size: 506 KiB

View File

Before

Width:  |  Height:  |  Size: 1.7 MiB

After

Width:  |  Height:  |  Size: 1.7 MiB

View File

Before

Width:  |  Height:  |  Size: 2.2 MiB

After

Width:  |  Height:  |  Size: 2.2 MiB

View File

Before

Width:  |  Height:  |  Size: 450 KiB

After

Width:  |  Height:  |  Size: 450 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 2.3 MiB

After

Width:  |  Height:  |  Size: 2.3 MiB

View File

Before

Width:  |  Height:  |  Size: 265 KiB

After

Width:  |  Height:  |  Size: 265 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 MiB

After

Width:  |  Height:  |  Size: 2.0 MiB

View File

Before

Width:  |  Height:  |  Size: 505 KiB

After

Width:  |  Height:  |  Size: 505 KiB

View File

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 8.1 KiB

After

Width:  |  Height:  |  Size: 8.1 KiB

View File

Before

Width:  |  Height:  |  Size: 671 KiB

After

Width:  |  Height:  |  Size: 671 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 150 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Some files were not shown because too many files have changed in this diff Show More