+
+ | Folder/Files
+ | Description
+ |
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_nine_channel_with_continuous_mode |
+ Application specific sources for ICSS %SDFM for continuous normal current sampling for nine channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_three_channel_with_continuous_mode |
+ Application specific sources for ICSS %SDFM for continuous normal current sampling for three channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense |
+ Common source for ICSS %SDFM applications |
+
+| ${SDK_INSTALL_PATH}/source/current_sense/sdfm |
+
+ | firmware/ |
+ Folder containing ICSS %SDFM firmware sources |
+
+
+ | driver/ |
+ ICSS %SDFM driver source |
+
+
+ | include/ |
+ Folder containing ICSS %SDFM structures and APIs declarations |
+
+
+
+# Supported Combinations
+
+\cond SOC_AM243X
+
+ Parameter | Value
+ ----------------|-----------
+ CPU + OS | r5fss0-0 freertos
+ ICSSG | ICSSG0
+ PRU | PRU0
+ Toolchain | ti-arm-clang
+ Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
+ Examples folder | examples/current_sense
+
+\endcond
+
+# Steps to Run the Example
+
+## Hardware Prerequisites
+Other than the basic EVM setup mentioned in
+
+ | Test Details
+ | Steps
+ | Pass/Fail Criteria
+ |
+
+ | 1. Normal current sample data |
+ 1. Run example on supported board |
+ The drawn graph and raw data should look like the attached image |
+
+
+ |
+ 2. Draw the graph of sdfm_ch0_samples, sdfm_ch1_samples and sdfm_ch2_samples arrays |
+ \image html SDFM_Continuous_mode_sample.PNG "NC sample data" |
+
+
+
+ | 2. To check NC Samples with Different NC OSR Values |
+ 1. Set NC OSR values between 16 to 255 |
+ Raw data should have different resolution for different OSR values |
+
+
+ |
+ 2. Build and run example |
+ |
+
+
+ |
+ 3. Observe resolution of raw data |
+ |
+
+
+ | 3. To check NC samples with different sdfm clock values |
+ 1. Set NC OSR to 64 |
+ Raw data should have different resolution for different sdfm clock values |
+
+
+ |
+ 2. Set ecap_divider variable in sdfm.c file for different sd clock generation |
+ |
+
+
+ |
+ 3. Set Sigma delta clock equal to ecap generated clock |
+ |
+
+
+ |
+ 4. Build and run example |
+ |
+
+
+ |
+ 5. Observe resolution of raw data |
+ |
+
+
+ | 4. To check Fast detect |
+ 1. Set NC OSR to 64 |
+ Trip must be triggered for the respective pwm trip zone block |
+
+
+ |
+ 2. Enable Fast detect |
+ |
+
+
+ |
+ 3. Set Fast Detect fields with these values { window size = 4, Zero max = 18, Zero min = 2} |
+ Zero max/min Threshold hit bits must be constantly unset and set |
+
+
+
+ |
+ 4. Build and run example |
+ One max/min threshold hit bits must be unset |
+
+
+ |
+ 5. 1) Observe TZ_OUT PIN.
+ 2) Check zero/one count max & zero/one count min threshold hit bits in memory map |
+ |
+
+\cond SOC_AM243X
+
+ | 5.Testing with sdfm clock from EPWM |
+ 1. Make hardware set up like attached image |
+ All test cases results should match with ECAP test case results |
+
+
+ |
+ 2. \image html SDFM_EPWM1_HW_Setup.png "SDFM: Hw set for clock from EPWM" |
+ |
+
+
+ |
+ 3. Enable "APP_EPWM1_ENABLE" macro in app_sdfm.c file |
+ |
+
+
+ |
+ 4. Set EPWM1 out put frequency to 12.5MHz or 5MHz in app_sdfm.c file |
+ |
+
+
+ |
+ 5. Set Sigma delta clock equal to EPWM1 output frequency |
+ |
+
+
+ |
+ 6. Build and run example |
+ |
+
+
+ |
+ 7. Test all tese cases from 1 to 5 with EPWM clock |
+ |
+
+ \endcond
+
diff --git a/docs_src/docs/api_guide/examples/sdfm_examples.md b/docs_src/docs/api_guide/examples/sdfm_examples.md
new file mode 100644
index 0000000..46711cb
--- /dev/null
+++ b/docs_src/docs/api_guide/examples/sdfm_examples.md
@@ -0,0 +1,120 @@
+# ICSS %SDFM Examples {#EXAMPLES_MOTORCONTROL_SDFM}
+
+[TOC]
+
+This page lists all the examples of ICSSG %SDFM availble in this SDK. Following sections describe the features available in each of the examples.
+
+The ICSS %SDFM driver provides a well defined set of APIs to expose sigma delta interface.
+
+The ICSS %SDFM examples invoke these APIs to
+- Set %SDFM channels
+- Set ACC source, NC OSR, OC OSR, Clock source & Clock inversion
+- Enable & disable threshold comparators
+- Set high and low threshold values
+- Enable Zero Cross & set Zero cross threshold value
+- configure normal current sample trigger time (time for read sample)
+- Enable & disable double update
+- Inform firmware to enable %SDFM mode
+- Configure and fast detect block
+- Enable PRU load share mode
+- Enable Phase Compensation
+
+Once these steps are executed
+- 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 Examples Implementation
+Following section describes the flow of the examples.
+
+\image html SDFM_EXAMPLE_FLOWCHART.png "ICSS SDFM Examples"
+
+# Important files and directory structure
+
+
+
+ | Folder/Files
+ | Description
+ |
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_nine_channel_with_continuous_mode |
+ Application specific sources for ICSS %SDFM for continuous normal current sampling for nine channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_nine_channel_load_share_mode |
+ Application specific sources for ICSS %SDFM for trigger based normal current sampling for nine channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_three_channel_single_pru_mode |
+ Application specific sources for ICSS %SDFM for trigger based normal current sampling for three channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_three_channel_with_continuous_mode |
+ Application specific sources for ICSS %SDFM for continuous normal current sampling for three channels |
+
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_three_channel_with_phase_compensation |
+ Application specific sources for ICSS %SDFM with phase compensation |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense |
+ Common source for ICSS %SDFM applications |
+
+| ${SDK_INSTALL_PATH}/source/current_sense/sdfm |
+
+ | firmware/ |
+ Folder containing ICSS %SDFM firmware sources |
+
+
+ | driver/ |
+ ICSS %SDFM driver source |
+
+
+ | include/ |
+ Folder containing ICSS %SDFM structures and APIs declarations |
+
+
+
+# Supported Combinations {#EXAMPLES_MOTORCONTROL_SDFM_COMBOS}
+
+\cond SOC_AM243X
+
+ Parameter | Value
+ ----------------|-----------
+ CPU + OS | r5fss0-0 freertos
+ ICSSG | ICSSG0
+ PRU | PRU0
+ Toolchain | ti-arm-clang
+ Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
+ Examples folder | examples/current_sense
+
+\endcond
+
+# ICSS SDFM Examples Description
+
+Following are different examples for ICSS %SDFM:
+
+
+
+ | Example
+ | Enabled Features
+ | Tested/Supported Features
+ |
+
+ | \subpage BASIC_SDFM_EXAMPLES |
+ Trigger based Normal current, Over current detection |
+ Zero cross detection, Fast detect, Double Update |
+
+
+ | \subpage BASIC_SDFM_EXAMPLES_WITH_CONTINUOUS_NC |
+ Continuous normal current sampling |
+ Fast detect |
+
+
+ | \subpage BASIC_SDFM_EXAMPLE_WITH_PHASE_DELAY |
+ Trigger based Normal current, Phase compensation, Over current detection |
+ Fast detect, Double Update, Zero cross detection |
+
+
+
+
diff --git a/docs_src/docs/api_guide/examples/sdfm_trigger_based_nc_example_with_phase_delay.md b/docs_src/docs/api_guide/examples/sdfm_trigger_based_nc_example_with_phase_delay.md
new file mode 100644
index 0000000..076fef3
--- /dev/null
+++ b/docs_src/docs/api_guide/examples/sdfm_trigger_based_nc_example_with_phase_delay.md
@@ -0,0 +1,129 @@
+# %SDFM Example With Phase Compensation {#BASIC_SDFM_EXAMPLE_WITH_PHASE_DELAY}
+
+[TOC]
+
+# ICSS SDFM three channel with phase compensation
+
+This example measures phase compensation for %SDFM channel 0 in PRU GPIO mode
+during initialization. Normal current OSR, Over current OSR and Normal current trigger time can be configured by the user
+
+Only one core - PRU is used for this example.
+
+The example does the below:
+- Configure ICSSG1 IEP0 for generating clock for %SDFM
+- Enable Phase Compensation Measurement
+- Configure SYNC1 Delay register based on the easured phase delay
+- Set %SDFM channels: Channel 0 - Channel 2
+- Configure normal current sample trigger time (time for read sample) and OSR
+
+# Important files and directory structure
+
+
| Folder/Files
| Description
|
-| ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm |
- | app_sdfm.c & sdfm.c |
- ICSS %SDFM application |
+ ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_nine_channel_load_share_mode |
+ Application specific sources for ICSS %SDFM for trigger based normal current sampling for nine channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense/icss_sdfm_three_channel_single_pru_mode |
+ Application specific sources for ICSS %SDFM for trigger based normal current sampling for three channels |
+
+
+ | ${SDK_INSTALL_PATH}/examples/current_sense |
+ Common source for ICSS %SDFM applications |
| ${SDK_INSTALL_PATH}/source/current_sense/sdfm |
| firmware/ |
- Folder containing %SDFM firmware sources |
+ Folder containing ICSS %SDFM firmware sources |
| driver/ |
- ICSS %SDFM driver |
+ ICSS %SDFM driver source |
| include/ |
- Folder containing ICSS %SDFM structures & APIs sources |
+ Folder containing ICSS %SDFM structures and APIs declarations |
-
-# Supported Combinations {#EXAMPLES_MOTORCONTROL_SDFM_COMBOS}
-
-\cond SOC_AM64X
-
- Parameter | Value
- ---------------|-----------
- CPU + OS | r5fss0-0 freertos
- ICSSG | ICSSG0
- PRU | PRU0
- Toolchain | ti-arm-clang
- Board | @VAR_BOARD_NAME_LOWER
- Example folder | examples/current_sense/icss_sdfm
-
-\endcond
+# Supported Combinations
\cond SOC_AM243X
- Parameter | Value
- ---------------|-----------
- CPU + OS | r5fss0-0 freertos
- ICSSG | ICSSG0
- PRU | PRU0
- Toolchain | ti-arm-clang
- Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
- Example folder | examples/current_sense/icss_sdfm
+ Parameter | Value
+ ----------------|-----------
+ CPU + OS | r5fss0-0 freertos
+ ICSSG | ICSSG0
+ PRU | PRU0
+ Toolchain | ti-arm-clang
+ Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER
+ Examples folder | examples/current_sense
\endcond
# Steps to Run the Example
## Hardware Prerequisites
-Other than the basic EVM setup mentioned in 
 Observe TZ_OUT PIN.
+ <td>5. 1) Observe TZ_OUT PIN.
2) Check zero/one count max & zero/one count min threshold hit bits in memory map</td>
<td></td>
</tr>
+<tr>
+ <td>8. To check Zero Cross</td>
+ <td>1. Set OC OSR to 16</td>
+ <td> Logic analyzer capture should match with this capture </td>
+</tr>
+<tr>
+ <td></td>
+ <td>2. Enable Zero cross detection</td>
+ <td></td>
+ </tr>
+<tr>
+ <td></td>
+ <td>3. Set zero cross threshold vales to 1700 {value should be between max sampled value and min sampled value for 16 OSR}</td>
+ <td>\image html SDFM_Zero_cross_GPIO_output.png ){kind=link}