External/motor-control-sdk
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

am64x/am243x: hdsl: Update documentation for HDSL examples

Browse Source 
- DDR Trace example was removed
- Update the paths in documentation

Fixes: PINDSW-6651

Signed-off-by: Dhaval Khandla <dhavaljk@ti.com>
This commit is contained in:
Dhaval Khandla 2023-09-15 13:57:32 +05:30
parent 1c0fd2b4af
commit c92255b0fe
9 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs_src/docs/api_guide/components/position_sense/tamagawa_design.md
View File

@ -26,7 +26,7 @@ Refer PRU-ICSS chapter of AM64x/AM243x Technical Reference Manual
## Software Description
At start-up, the application running on the ARM Cortex-R5 initializes the module clocks and configures the pinmux. The PRU is initialized and the PRU firmware is loaded on PRU slice of choice for a chosen ICSS instance (tested on PRU1 on ICSSG0). After the PRU1 starts executing, the Tamagawa interface is operational and the application can use it to communicate with an encoder. Use the Tamagawa diagnostic example to learn more about initialization and communication with the Tamagawa interface. This Tamagawa diagnostic example (available at the path "examples/motor_control/tamagawa_diagnostic" in the directory where MCU PLUS SDK is installed), also provides an easy way to validate the Tamagawa transactions. The diagnostic example provides menu options on the host PC in a serial terminal application, where the user can select the data ID code to be sent. Based on the data ID code, the application updates the Tamagwa interface with the data ID code and trigger transaction. The application then waits until it receives an indication of complete transaction by the firmware through the interface before displaying the result.
At start-up, the application running on the ARM Cortex-R5 initializes the module clocks and configures the pinmux. The PRU is initialized and the PRU firmware is loaded on PRU slice of choice for a chosen ICSS instance (tested on PRU1 on ICSSG0). After the PRU1 starts executing, the Tamagawa interface is operational and the application can use it to communicate with an encoder. Use the Tamagawa diagnostic example to learn more about initialization and communication with the Tamagawa interface. This Tamagawa diagnostic example, also provides an easy way to validate the Tamagawa transactions. The diagnostic example provides menu options on the host PC in a serial terminal application, where the user can select the data ID code to be sent. Based on the data ID code, the application updates the Tamagwa interface with the data ID code and trigger transaction. The application then waits until it receives an indication of complete transaction by the firmware through the interface before displaying the result.
### PRU Firmware Design
The firmware first initializes the PRU hardware, after which it waits until a command has been triggered through the interface. Upon triggering, the transmit data is set up based on the data ID code and the data is transmitted. The data ID code then waits until receiving all the data that depends on the data ID. The parsing over the received data then commences, which is again based on the data ID, and the interface is updated with the result. The CRC verification occurs next and the interface indicates command completion. The firmware then waits for the next command trigger from the interface.

4
docs_src/docs/api_guide/examples/dcl/dcl_df22/dcl_df22.md
View File

@ -19,7 +19,7 @@ based on the test input and compare the output with the expected value.
<th>Folder/Files
<th>Description
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${MOTOR_CONTROL_SDK_PATH}/examples/dcl/dcl_df22/</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/dcl/dcl_df22/</td></tr>
<tr>
<td>df22_test.c</td>
<td>Main function for DF22 testing</td>
@ -32,7 +32,7 @@ based on the test input and compare the output with the expected value.
<td>data/</td>
<td>Contains pre-generated data files result compares with</td>
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${MOTOR_CONTROL_SDK_PATH}/source/dcl</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/source/dcl</td></tr>
<tr>
<td>dcl/</td>
<td>Folder containing DCL library source</td>

4
docs_src/docs/api_guide/examples/dcl/dcl_pi/dcl_pi.md
View File

@ -17,7 +17,7 @@ based on the test input and compare the output with the expected value.
<th>Folder/Files
<th>Description
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${MOTOR_CONTROL_SDK_PATH}/examples/dcl/dcl_pi/</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/dcl/dcl_pi/</td></tr>
<tr>
<td>pi_test.c</td>
<td>Main function for PI testing</td>
@ -30,7 +30,7 @@ based on the test input and compare the output with the expected value.
<td>data/</td>
<td>Contains pre-generated data files result compares with</td>
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${MOTOR_CONTROL_SDK_PATH}/source/dcl</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/source/dcl</td></tr>
<tr>
<td>dcl/</td>
<td>Folder containing DCL library source</td>

4
docs_src/docs/api_guide/examples/endat_example.md
View File

@ -89,7 +89,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F).
PRU | PRU1, TXPRU1 and RTUPRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER
Example folder | examples/motorcontrol/endat_example
Example folder | examples/position_sense/endat_diagnostic
\endcond
@ -102,7 +102,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F).
PRU | PRU1, TXPRU1 and RTUPRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
Example folder | examples/motorcontrol/endat_example
Example folder | examples/position_sense/endat_diagnostic
\endcond

2
docs_src/docs/api_guide/examples/examples.md
View File

@ -5,7 +5,6 @@ This page lists all the examples and demos supported in this SDK.
- Position Sense
-# \subpage EXAMPLE_MOTORCONTROL_ENDAT
-# \subpage EXAMPLE_MOTORCONTROL_HDSL
-# \subpage EXAMPLE_MOTORCONTROL_HDSL_TRACE
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA
- Current Sense
-# \subpage EXAMPLE_MOTORCONTROL_SDFM
@ -15,7 +14,6 @@ This page lists all the examples and demos supported in this SDK.
- Position Sense
-# \subpage EXAMPLE_MOTORCONTROL_ENDAT
-# \subpage EXAMPLE_MOTORCONTROL_HDSL
-# \subpage EXAMPLE_MOTORCONTROL_HDSL_TRACE
-# \subpage EXAMPLE_MOTORCONTROL_TAMAGAWA
- Current Sense
-# \subpage EXAMPLE_MOTORCONTROL_SDFM

6
docs_src/docs/api_guide/examples/hdsl_example.md
View File

@ -30,7 +30,7 @@ This example also allows the capability to save the HDSL register data into memo
<th>Folder/Files
<th>Description
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/motor_control/hdsl_diagnostic</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/position_sense/hdsl_diagnostic</td></tr>
<tr>
<td>hdsl_diagnostic.c
hdsl_diagnostic.h</td>
@ -61,7 +61,7 @@ This example also allows the capability to save the HDSL register data into memo
PRU | PRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER
Example folder | examples/motorcontrol/hdsl_example
Example folder | examples/position_sense/hdsl_diagnostic
\endcond
@ -74,7 +74,7 @@ This example also allows the capability to save the HDSL register data into memo
PRU | PRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER (2 channel and 1 channel examples), @VAR_LP_BOARD_NAME_LOWER (1 channel example)
Example folder | examples/motorcontrol/hdsl_example
Example folder | examples/position_sense/hdsl_diagnostic
\endcond

6
docs_src/docs/api_guide/examples/tamagawa_example.md
View File

@ -37,7 +37,7 @@ The Tamagawa receiver firmware running on ICSS0-PRU1 provides a defined interfac
<th>Folder/Files
<th>Description
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/motor_control/tamagawa_diagnostic</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/position_sense/tamagawa_diagnostic</td></tr>
<tr>
<td>tamagawa_diagnostic.c</td>
<td>Tamagawa diagnostic application</td>
@ -64,7 +64,7 @@ The Tamagawa receiver firmware running on ICSS0-PRU1 provides a defined interfac
PRU | PRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER
Example folder | examples/motor_control/tamagawa_diagnostic
Example folder | examples/position_sense/tamagawa_diagnostic
\endcond
@ -77,7 +77,7 @@ The Tamagawa receiver firmware running on ICSS0-PRU1 provides a defined interfac
PRU | PRU1
Toolchain | ti-arm-clang
Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER (E3 Revision)
Example folder | examples/motor_control/tamagawa_diagnostic
Example folder | examples/position_sense/tamagawa_diagnostic
\endcond

6
docs_src/docs/api_guide/examples/tamagawa_uart_example.md
View File

@ -34,7 +34,7 @@ The tamagawa over uart example runs on R5 and communicates with tamagawa encoder
<th>Folder/Files
<th>Description
</tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/motor_control/tamagawa_diagnostic_over_soc_uart/uart_tamagawa.c</td></tr>
<tr><td colspan="2" bgcolor=#F0F0F0> ${SDK_INSTALL_PATH}/examples/position_sense/tamagawa_diagnostic_over_soc_uart</td></tr>
<tr>
<td>uart_tamagawa.c</td>
<td>Tamagawa UART application</td>
@ -46,7 +46,7 @@ The tamagawa over uart example runs on R5 and communicates with tamagawa encoder
</tr>
<tr>
<td>driver/</td>
<td>Tamagawa Uart driver.</td>
<td>Tamagawa uart driver</td>
</tr>
</table>
@ -58,7 +58,7 @@ The tamagawa over uart example runs on R5 and communicates with tamagawa encoder
CPU + OS | r5fss0-0 freertos
Toolchain | ti-arm-clang
Board | @VAR_LP_BOARD_NAME_LOWER
Example folder | examples/motor_control/tamagawa_diagnostic_over_soc_uart
Example folder | examples/position_sense/tamagawa_diagnostic_over_soc_uart
\endcond

6
docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md
View File

@ -4,6 +4,9 @@ Components under Motor Control SDK were available in MCU+ SDK 7.x and 8.x releas
If you are a user of MCU+ SDK, then items listed on this page that will assist you in migration to Motor Control SDK.
- To build examples from Industrial Communications SDK and MCU+ SDK using CCS projects, user has to add <b>${SDK_INSTALL_PATH}/ind_comms_sdk</b> and <b>${SDK_INSTALL_PATH}/mcu_plus_sdk</b> to "Product discovery path" respectively in CCS.
\cond SOC_AM64X || SOC_AM243X
- The examples, drivers and PRU-ICSS firmwares for position sense encoders and current sense %SDFM (using PRU-ICSS) are moved from MCU+ SDK to Motor Control SDK. Folder location changes are also shown below.
@ -12,7 +15,8 @@ If you are a user of MCU+ SDK, then items listed on this page that will assist y
----------------------------|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------
Position Sense EnDat | `examples/motor_control/endat_diagnostic` | `examples/position_sense/endat_diagnostic`
^ | `source/motor_control/position_sense/endat` | `source/position_sense/endat`
Position Sense HDSL | `examples/motor_control/hdsl_diagnostic`\n `examples/motor_control/hdsl_diagnostic_with_traces`| `examples/position_sense/hdsl_diagnostic`\n `examples/position_sense/hdsl_diagnostic_with_traces`
Position Sense HDSL | `examples/motor_control/hdsl_diagnostic` | `examples/position_sense/hdsl_diagnostic`
^ | `examples/motor_control/hdsl_diagnostic_with_traces` | Merged with `hdsl_diagnostic` example
^ | `source/motor_control/position_sense/hdsl` | `source/position_sense/hdsl`
Position Sense Tamagawa | `examples/motor_control/tamagawa_diagnostic` | `examples/position_sense/tamagawa_diagnostic`
^ | `source/motor_control/position_sense/tamagawa` | `source/position_sense/tamagawa`