Pull request #18: Motor Control SDK: Update release documentation
Merge in PINDSW/motor_control_sdk from PINDSW-6551_update_release_documentation to next * commit '90c7b05a0e9efc24a9f63e0fcc7d2fadfeeb61af': am243x/am263x: docs: Add migration guide am243x: docs: Add release notes page for 9.0.0 allsoc: docs: Update the main page of documentation allsoc: docs: Fix the doxygen groups for API documentation
1
.gitignore
vendored
@ -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
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# Current Sense {#CURRENT_SENSE}
|
||||
|
||||
[TOC]
|
||||
|
||||
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
|
||||
- 3 %SDFM channels on single PRU core
|
||||
- Overcurrent (OC) for comparator: free running SINC3 filter with OSR 32-256
|
||||
- Normal current (NC) for data read: free running SINC3 filter with OSR 32-256, always multiple of OC OSR (NC OSR = K*OC OSR :: K ∈ Z)
|
||||
- Event generation(ARM interrupt for data read from DMEM, GPIO toggle for high and low thresholds)
|
||||
- High and Low threshold comparator
|
||||
|
||||
## Features Not Supported
|
||||
- Zero cross comparator
|
||||
- Below 32 OSR
|
||||
|
||||
## ICSS SDFM Design
|
||||
\subpage SDFM_DESIGN explains the design in detail.
|
||||
|
||||
## Example
|
||||
\ref EXAMPLE_MOTORCONTROL_SDFM
|
||||
|
||||
## API
|
||||
\ref SDFM_API_MODULE
|
||||
@ -4,8 +4,8 @@
|
||||
|
||||
## Introduction
|
||||
This design implements Sigma delta interface on TI Sitara™ AM64x/AM243x.
|
||||
ICSS SDFM is a Sigma delta filter for phase current measurement.
|
||||
Only two lines are required for each channel, differential pair each for SDFM clock & SDFM data.
|
||||
ICSS %SDFM is a Sigma delta filter for phase current measurement.
|
||||
Only two lines are required for each channel, differential pair each for %SDFM clock & %SDFM data.
|
||||
Clock is provided by external device or internal device and data comes from sigma delta modulator in form of digital bit stream.
|
||||
|
||||
|
||||
@ -16,8 +16,8 @@ Clock is provided by external device or internal device and data comes from sigm
|
||||
## Implementation
|
||||
The Sigma delta filter is implemented on TI Sitara™ Devices.
|
||||
Design is split into three parts – Sigma delta hardware support in PRU, firmware running in PRU and driver running in ARM.
|
||||
Application is supposed to use the ICSS SDFM driver APIs to leverage SDFM functionality.
|
||||
SDK example uses the SDFM hardware capability in Slice 1 of PRU-ICSSG0.
|
||||
Application is supposed to use the ICSS %SDFM driver APIs to leverage %SDFM functionality.
|
||||
SDK example uses the %SDFM hardware capability in Slice 1 of PRU-ICSSG0.
|
||||
|
||||
|
||||
### Specifications
|
||||
@ -67,8 +67,8 @@ Following section describes the firmware implementation of Sigma delta decimatio
|
||||
\image html SDFM_FIRMWARE_FLOWCHART.png "Overall Block Diagram"
|
||||
|
||||
Firmware first clear PRU registers & Task manager.
|
||||
Then it waits for the R5 to set SDFM enable bit. After the enable set then it acknowledge to R5.
|
||||
After above these initial steps firmware does initialization of PRU-ICSSG's SDFM hardware interface, task manager & IEP0 then it comes in infinite waiting loop.
|
||||
Then it waits for the R5 to set %SDFM enable bit. After the enable set then it acknowledge to R5.
|
||||
After above these initial steps firmware does initialization of PRU-ICSSG's %SDFM hardware interface, task manager & IEP0 then it comes in infinite waiting loop.
|
||||
|
||||
When the COMP4 event hits the task manager assign OC loop to PC and Firmware starts execution of OC loop
|
||||
In OC loop firmware read sample data from accumulator and it checks for NC sample if the current OC sample belongs to NC sample then it does sampling for NC.
|
||||
@ -151,6 +151,6 @@ NOTE: There is some jitter in sample read timing, Sample data can be sampled bef
|
||||
<tr>
|
||||
<td>SD8_CLK
|
||||
<td>PIN_PRG0_PRU0_GPO16
|
||||
<td>SDFM clock input pin
|
||||
<td>%SDFM clock input pin
|
||||
</tr>
|
||||
</table>
|
||||
@ -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
|
||||
@ -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
|
||||
@ -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
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
# SDFM {#SDFM}
|
||||
|
||||
[TOC]
|
||||
|
||||
## Introduction
|
||||
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
|
||||
- 3 SDFM channels on single PRU core
|
||||
- Overcurrent (OC) for comparator: free running SINC3 filter with OSR 32-256
|
||||
- Normal current (NC) for data read: free running SINC3 filter with OSR 32-256, always multiple of OC OSR (NC OSR = K*OC OSR :: K ∈ Z)
|
||||
- Event generation(ARM interrupt for data read from DMEM, GPIO toggle for high and low thresholds)
|
||||
- High and Low threshold comparator
|
||||
|
||||
## Features Not Supported
|
||||
- Zero cross comparator
|
||||
- Below 32 OSR
|
||||
|
||||
|
||||
## ICSS SDFM Design
|
||||
\subpage SDFM_DESIGN explains the design in detail.
|
||||
|
||||
## Example
|
||||
\ref EXAMPLE_MOTORCONTROL_SDFM
|
||||
|
||||
## API
|
||||
\ref SDFM_API_MODULE
|
||||
@ -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
|
||||
|
||||
@ -5,20 +5,25 @@
|
||||
# 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
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes.md
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes_09_00_00.md
|
||||
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg
|
||||
@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"
|
||||
8
docs_src/docs/api_guide/device/am243x/release_notes.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Release Notes {#RELEASE_NOTES_PAGE}
|
||||
|
||||
[TOC]
|
||||
|
||||
Refer the below pages for release specific information
|
||||
|
||||
- \subpage RELEASE_NOTES_09_00_00_PAGE
|
||||
|
||||
378
docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md
Normal file
@ -0,0 +1,378 @@
|
||||
# Release Notes 09.00.00 {#RELEASE_NOTES_09_00_00_PAGE}
|
||||
|
||||
[TOC]
|
||||
|
||||
\attention Also refer to individual module pages for more details on each feature, unsupported features, important usage guidelines.
|
||||
|
||||
\attention For release notes of Industrial Communications SDK and MCU+ SDK, please refer to \htmllink{@VAR_IC_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html, @VAR_SOC_NAME Industrial Communications SDK Release Notes 09.00.00} and \htmllink{@VAR_MCU_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html, @VAR_SOC_NAME MCU+ SDK Release Notes 09.00.00} respectively.
|
||||
|
||||
\note The examples will show usage of SW modules and APIs on a specific CPU instance and OS combination. \n
|
||||
Unless noted otherwise, the SW modules would work in both FreeRTOS and NORTOS environment. \n
|
||||
Unless noted otherwise, the SW modules would work on any of the R5F's present on the SOC. \n
|
||||
Unless noted otherwise, the SW modules would work on all supported EVMs \n
|
||||
|
||||
## New in this Release
|
||||
|
||||
Feature | Module
|
||||
------------------------------------------------------------------------------------------------|-----------------------------------
|
||||
SYNC Mode Support with 2 channels | Position Sense HDSL
|
||||
Trigger based normal current sampling | Current Sense %SDFM
|
||||
Double sampling per PWM cycle | Current Sense %SDFM
|
||||
|
||||
## Device and Validation Information
|
||||
|
||||
SOC | Supported CPUs | Boards | Host PC
|
||||
-------|-----------------|-------------------------------------------------------------------------------------------------------------|-----------------------------------
|
||||
AM243x | R5F | AM243x GP EVM (referred to as am243x-evm in code), \n AM243x LAUNCHPAD (referred to as am243x-lp in code) | Windows 10 64b or Ubuntu 18.04 64b
|
||||
|
||||
## Tools, Compiler and Other Open Source SW Module Information
|
||||
|
||||
Tools / SW module | Supported CPUs | Version
|
||||
------------------------|----------------|-----------------------
|
||||
Code Composer Studio | R5F, M4F, A53 | @VAR_CCS_VERSION
|
||||
SysConfig | R5F, M4F, A53 | @VAR_SYSCFG_VERSION, build @VAR_SYSCFG_BUILD
|
||||
TI ARM CLANG | R5F, M4F | @VAR_TI_ARM_CLANG_VERSION
|
||||
FreeRTOS Kernel | R5F, M4F, A53 | @VAR_FREERTOS_KERNEL_VERSION
|
||||
FreeRTOS SMP Kernel | A53 | @VAR_FREERTOS_SMP_KERNEL_VERSION
|
||||
|
||||
\attention TI ARM CLANG @VAR_TI_ARM_CLANG_VERSION is not part of CCS by default, Follow steps at \htmllink{@VAR_MCU_SDK_DOCS_PATH/SDK_DOWNLOAD_PAGE.html#INSTALL_TIARMCLANG, TI CLANG Compiler Toolchain} to install the compiler.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- ### Experimental Features
|
||||
|
||||
\attention Features listed below are early versions and should be considered as "experimental".
|
||||
\attention Users can evaluate the feature, however the feature is not fully tested at TI side.
|
||||
\attention TI would not support these feature on public e2e.
|
||||
\attention Experimental features will be enabled with limited examples and SW modules.
|
||||
|
||||
|
||||
Feature | Module
|
||||
--------------------------------------------------------------------|--------------------------
|
||||
| -->
|
||||
|
||||
<!-- ### Features not supported in release -->
|
||||
|
||||
|
||||
<!-- ### AM243X LAUNCHPAD not tested/not supported features
|
||||
|
||||
Below features are not support on AM243X LAUNCHPAD due to SOC or board constraints, -->
|
||||
|
||||
|
||||
### Position Sense
|
||||
|
||||
Module | Supported CPUs | SysConfig Support | OS Support | Key features tested | Key features not tested
|
||||
-------------|----------------|-------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------
|
||||
EnDat | R5F | YES | FreeRTOS, NORTOS | Single channel, Multi channel, Continuous mode for single channel, Load share mode, Recovery Time for 2.2 command set, Boosterpack with AM243x-LP | 16 MHz Baud Rate Different cable lengths, Continuous clock mode for multi channel
|
||||
HDSL | R5F | YES | FreeRTOS, NORTOS | Freerun mode(300MHz,225MHz), Sync mode(225MHz), Short Message Read & Write, Long Message Read & Write, Boosterpack with AM243x-LP | Long cables
|
||||
Tamagawa | R5F | YES | FreeRTOS, NORTOS | Absolute position, Encoder ID, Reset, EEPROM Read, EEPROM Write, 2.5 Mbps and 5 Mbps Encoder Support, Boosterpack with AM243x-LP | -
|
||||
|
||||
### Current Sense
|
||||
|
||||
|
||||
Module | Supported CPUs | SysConfig Support | OS Support | Key features tested | Key features not tested
|
||||
-------------|----------------|-------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------
|
||||
%SDFM | R5F | YES | FreeRTOS, NORTOS | | -
|
||||
|
||||
|
||||
## Fixed Issues
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Applicable Releases
|
||||
<th> Resolution/Comments
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5651
|
||||
<td> HDSL: Multi-turn bits of fast position do not contain correct data
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5689
|
||||
<td> HDSL: High deviation in fast position when encoder shaft is fixed
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6487
|
||||
<td> HDSL: FIX bits in ONLINE STATUS 1 register are losing the expected fix value
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6488
|
||||
<td> HDSL: SUM/SSUM bit not working in ONLINE STATUS registers
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6492
|
||||
<td> HDSL: Protocol reset is not working
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6530
|
||||
<td> HDSL: QMLW bit not working in ONLINE STATUS registers
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5538
|
||||
<td> HDSL: Long message not working with multi-channel application
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6489
|
||||
<td> HDSL: Offsets for ONLINE STATUS registers in C structure are not correct
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6607
|
||||
<td> %SDFM: NULL pointer dereferenced in \ref SDFM_getFilterData
|
||||
<td> Current Sense %SDFM
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6526
|
||||
<td> HDSL: FREL/FRES bits in EVENT/EVENT_S registers are not sticky
|
||||
<td> Position Sense HDSL
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5681
|
||||
<td> EnDat: Recovery Time not correct for 2.1 commands
|
||||
<td> Position Sense EnDat
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5681
|
||||
<td> %SDFM: Sampling does not work with EPWM as %SDFM clock
|
||||
<td> Current Sense %SDFM
|
||||
<td> -
|
||||
<td> -
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Known Issues
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Applicable Releases
|
||||
<th> Workaround
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5537
|
||||
<td> HDSL not working with 225 MHz PRU-ICSSG Core Clock Frequency
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> Use 300 MHz frequency for PRU-ICSSG Core Clock
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6628
|
||||
<td> HDSL: Reset value of PRST bit is not correct
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6608
|
||||
<td> %SDFM: Incorrect samples seen intermittently with EPWM as %SDFM clock
|
||||
<td> Current Sense %SDFM
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6630
|
||||
<td> HDSL: POS bit is not set during initial fast position alignment
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6629
|
||||
<td> HDSL: SSUM bit in EVENT_S is not set when SUMMARY is non-zero
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-5690
|
||||
<td> HDSL: EDGE register is not updated
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
<tr>
|
||||
<td> PINDSW-6486
|
||||
<td> HDSL: RSSI register shows higher values than expected for a non-noisy setup
|
||||
<td> Position Sense HDSL
|
||||
<td> 9.0 onwards
|
||||
<td> -
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- ## Errata
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> SDK Status
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2311
|
||||
<td> USART: Spurious DMA Interrupts
|
||||
<td> UART
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2313
|
||||
<td> GPMC: Sub-32-bit read issue with NAND and FPGA/FIFO
|
||||
<td> GPMC
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2331
|
||||
<td> CPSW: Device lockup when reading CPSW registers
|
||||
<td> CPSW, SBL
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2345
|
||||
<td> CPSW: Ethernet Packet corruption occurs if CPDMA fetches a packet which spans across memory banks
|
||||
<td> CPSW
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2326
|
||||
<td> PCIe: MAIN_PLLx operating in fractional mode, which is required for enabling SSC, is not compliant with PCIe Refclk jitter limits
|
||||
<td> PCIe
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2312
|
||||
<td> MMCSD: HS200 and SDR104 Command Timeout Window Too Small
|
||||
<td> MMCSD
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2310
|
||||
<td> USART: Erroneous clear/trigger of timeout interrupt
|
||||
<td> UART
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2279
|
||||
<td> MCAN: Specification Update for dedicated Tx Buffers and Tx Queues configured with same Message ID
|
||||
<td> MCAN
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2278
|
||||
<td> MCAN: Message Transmit order not guaranteed from dedicated Tx Buffers configured with same Message ID
|
||||
<td> MCAN
|
||||
<td> Open
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
## Limitations
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Reported in Release
|
||||
<th> Applicable Devices
|
||||
<th> Workaround
|
||||
</tr>
|
||||
<tr>
|
||||
<td> MCUSDK-208
|
||||
<td> gmake with -j can sometimes lock up Windows command prompt
|
||||
<td> Build
|
||||
<td> 7.3.0
|
||||
<td> AM64x, AM243x
|
||||
<td> Use bash for windows as part of git for windows or don't use -j option
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Upgrade and Compatibility Information {#UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0}
|
||||
|
||||
<!-- \attention When migrating from MCU+ SDK, see \ref MIGRATION_GUIDES for more details -->
|
||||
|
||||
This section lists changes which could affect user applications developed using older SDK versions.
|
||||
Read this carefully to see if you need to do any changes in your existing application when migrating to this SDK version relative to
|
||||
previous SDK version. Also refer to older SDK version release notes to see changes in
|
||||
earlier SDKs.
|
||||
|
||||
<!-- ### Compiler Options
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
### Examples
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Drivers
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -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
|
||||
@ -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"
|
||||
@ -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
|
||||
|
||||
@ -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"
|
||||
@ -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
|
||||
@ -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
|
||||
@ -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
|
||||
@ -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+=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.
|
||||
|
||||
@ -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
|
||||
@ -154,7 +154,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
|
||||
<tr>
|
||||
<td>J17</td>
|
||||
<td>Pin 1-2 Connected</td>
|
||||
<td>SDFM Clock Feedback Select</td>
|
||||
<td>%SDFM Clock Feedback Select</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J18/J19</td>
|
||||
@ -194,7 +194,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
|
||||
<tr>
|
||||
<td>J27</td>
|
||||
<td>ON</td>
|
||||
<td>3WIRE/SDFM MUX</td>
|
||||
<td>3WIRE/%SDFM MUX</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J28</td>
|
||||
@ -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
|
||||
|
||||
@ -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**
|
||||
@ -132,7 +132,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
|
||||
<tr>
|
||||
<td>J17</td>
|
||||
<td>Pin 1-2 Connected</td>
|
||||
<td>SDFM Clock Feedback Select</td>
|
||||
<td>%SDFM Clock Feedback Select</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J18/J19</td>
|
||||
@ -172,7 +172,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, below additiona
|
||||
<tr>
|
||||
<td>J27</td>
|
||||
<td>ON</td>
|
||||
<td>3WIRE/SDFM MUX</td>
|
||||
<td>3WIRE/%SDFM MUX</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J28</td>
|
||||
@ -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:
|
||||
|
||||
@ -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%}
|
||||
|
||||
@ -4,24 +4,24 @@
|
||||
|
||||
|
||||
|
||||
The ICSS SDFM driver provides a well defined set of APIs to expose sigma delta interface.
|
||||
The ICSS %SDFM driver provides a well defined set of APIs to expose sigma delta interface.
|
||||
|
||||
The ICSS SDFM example invokes these APIs to
|
||||
- Set SDFM channels
|
||||
The ICSS %SDFM example invokes these APIs to
|
||||
- Set %SDFM channels
|
||||
- Set ACC source, NC OSR, OC OSR, Clock source & Clock inversion
|
||||
- Enable & disable threshold comparators
|
||||
- Set high, low & zero cross threshold values
|
||||
- configure sample trigger time (time for read sample)
|
||||
- Inform firmware to enable SDFM mode
|
||||
- Inform firmware to enable %SDFM mode
|
||||
- Configure GPIO pins for high, low & zero cross thresholds
|
||||
|
||||
|
||||
Once these steps are executed
|
||||
- ICSS SDFM example waits for a interrupt (trigger by SDFM firmware) to read sample data
|
||||
- ICSS %SDFM example waits for a interrupt (trigger by %SDFM firmware) to read sample data
|
||||
- when interrupt occurs, example reads sample data from DMEM and again comes back to waiting loop
|
||||
|
||||
### ICSS SDFM Example Implementation
|
||||
Following section describes the Example implementation of ICSS SDFM on ARM(R5F).
|
||||
Following section describes the Example implementation of ICSS %SDFM on ARM(R5F).
|
||||
\image html SDFM_EXAMPLE_FLOWCHART.png "ICSS SDFM Example"
|
||||
|
||||
## Important files and directory structure
|
||||
@ -34,16 +34,16 @@ Following section describes the Example implementation of ICSS SDFM on ARM(R5F).
|
||||
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/motor_control/icss_sdfm</td></tr>
|
||||
<tr>
|
||||
<td>app_sddf.c & sddf.c</td>
|
||||
<td>ICSS SDFM application</td>
|
||||
<td>ICSS %SDFM application</td>
|
||||
</tr>
|
||||
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/source/current_sense/sdfm</td></tr>
|
||||
<tr>
|
||||
<td>firmware/</td>
|
||||
<td>Folder containing SDFM firmware sources.</td>
|
||||
<td>Folder containing %SDFM firmware sources</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>driver/</td>
|
||||
<td>ICSS SDFM driver.</td>
|
||||
<td>ICSS %SDFM driver</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -137,7 +137,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, additional hard
|
||||
<tr>
|
||||
<td>J17</td>
|
||||
<td>Pin 1-2 Connected</td>
|
||||
<td>SDFM Clock Feedback Select</td>
|
||||
<td>%SDFM Clock Feedback Select</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J18/J19</td>
|
||||
@ -177,7 +177,7 @@ Other than the basic EVM setup mentioned in \ref EVM_SETUP_PAGE, additional hard
|
||||
<tr>
|
||||
<td>J27</td>
|
||||
<td>ON</td>
|
||||
<td>3WIRE/SDFM MUX</td>
|
||||
<td>3WIRE/%SDFM MUX</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>J28</td>
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
BIN
docs_src/docs/api_guide/images/am243x/block_diagram.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
docs_src/docs/api_guide/images/am263x/block_diagram.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
docs_src/docs/api_guide/images/am64x/block_diagram.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 350 KiB After Width: | Height: | Size: 350 KiB |
|
Before Width: | Height: | Size: 956 KiB After Width: | Height: | Size: 956 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 271 KiB After Width: | Height: | Size: 271 KiB |
|
Before Width: | Height: | Size: 173 KiB |
|
Before Width: | Height: | Size: 106 KiB |
|
Before Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 3.4 MiB After Width: | Height: | Size: 3.4 MiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 506 KiB After Width: | Height: | Size: 506 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 1.7 MiB After Width: | Height: | Size: 1.7 MiB |
|
Before Width: | Height: | Size: 2.2 MiB After Width: | Height: | Size: 2.2 MiB |
|
Before Width: | Height: | Size: 450 KiB After Width: | Height: | Size: 450 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 218 KiB After Width: | Height: | Size: 218 KiB |
|
Before Width: | Height: | Size: 2.3 MiB After Width: | Height: | Size: 2.3 MiB |
|
Before Width: | Height: | Size: 265 KiB After Width: | Height: | Size: 265 KiB |
|
Before Width: | Height: | Size: 2.7 MiB After Width: | Height: | Size: 2.7 MiB |
|
Before Width: | Height: | Size: 2.0 MiB After Width: | Height: | Size: 2.0 MiB |
|
Before Width: | Height: | Size: 505 KiB After Width: | Height: | Size: 505 KiB |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 8.1 KiB After Width: | Height: | Size: 8.1 KiB |
|
Before Width: | Height: | Size: 159 KiB After Width: | Height: | Size: 159 KiB |
|
Before Width: | Height: | Size: 671 KiB After Width: | Height: | Size: 671 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 8.5 KiB After Width: | Height: | Size: 8.5 KiB |
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 178 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 150 KiB After Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 202 KiB After Width: | Height: | Size: 202 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 165 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |