Skip to content

Commit 659c9c4

Browse files
committed
docs(linux): add SSC configuration guide for DSS PLLs
Add comprehensive how-to guide for enabling Spread Spectrum Clocking (SSC) on Display Subsystem (DSS) Phase-locked loops (PLLs). The guide covers: - SSC configuration parameters via device tree - Three configuration examples (center spread, down spread, greater depth) - Supported SoCs: AM62x, AM62Ax, AM62Dx, AM62Px - Troubleshooting and best practices - Customer responsibilities Signed-off-by: Sparsh Kumar <[email protected]>
1 parent acfa2f5 commit 659c9c4

File tree

7 files changed

+216
-0
lines changed

7 files changed

+216
-0
lines changed

configs/AM62AX/AM62AX_linux_toc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ linux/How_to_Guides/Target/How_to_test_MCAN_on_AM62x
123123
linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
124124
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
125125
linux/How_to_Guides/Target/How_to_playback_audio_over_HDMI
126+
linux/How_to_Guides/Target/How_to_enable_SSC_for_DSS
126127
linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
127128
linux/How_to_Guides/Target/Runtime_debug_unlock_on_secure_device
128129
linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux

configs/AM62DX/AM62DX_linux_toc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ linux/How_to_Guides
7676
linux/How_to_Guides_Developer_Notes
7777
linux/How_to_Guides/Host/SYSFW_Trace_Parser
7878
linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
79+
linux/How_to_Guides/Target/How_to_enable_SSC_for_DSS
7980
linux/How_to_Guides/Target/How_to_emmc_boot
8081
linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
8182
linux/How_to_Guides/Target/Runtime_debug_unlock_on_secure_device

configs/AM62PX/AM62PX_linux_toc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ linux/How_to_Guides/Target/How_to_test_MCAN_on_AM62x
160160
linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
161161
linux/How_to_Guides/Target/How_to_playback_audio_over_HDMI
162162
linux/How_to_Guides/Target/How_to_enable_display_sharing_between_remotecore_and_Linux
163+
linux/How_to_Guides/Target/How_to_enable_SSC_for_DSS
163164
linux/How_to_Guides/Target/How_to_boot_quickly
164165
linux/How_to_Guides/Target/How_to_enable_Microtips_LVDS_Panel
165166
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux

configs/AM62X/AM62X_linux_toc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
167167
linux/How_to_Guides/Target/How_to_playback_audio_over_HDMI
168168
linux/How_to_Guides/Target/How_to_enable_Microtips_LVDS_Panel
169169
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
170+
linux/How_to_Guides/Target/How_to_enable_SSC_for_DSS
170171
linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
171172
linux/How_to_Guides/Target/Runtime_debug_unlock_on_secure_device
172173
linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _dss7:
2+
13
DSS
24
#################
35

@@ -375,6 +377,8 @@ Device Tree Node
375377
Documentation for tidss device tree node and its properties can be found in linux kernel device tree bindings in below directory
376378
``Documentation/devicetree/bindings/display/ti/``. Seperate binding files are present for different version of the DSS controller.
377379

380+
For information about configuring Spread Spectrum Clocking (SSC) for DSS, see :ref:`how-to-enable-ssc-for-dss`.
381+
378382

379383
Driver Usage
380384
============
Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
.. _how-to-enable-ssc-for-dss:
2+
3+
############################################################
4+
How to enable spread spectrum clocking for display subsystem
5+
############################################################
6+
7+
************
8+
Introduction
9+
************
10+
11+
Spread Spectrum Clocking (SSC) is an electromagnetic interference (EMI) reduction technique that:
12+
13+
- Modulates the clock frequency rather than keeping it constant
14+
- Varies the frequency over time in a controlled way
15+
- Spreads energy across many frequencies instead of focusing it at one frequency
16+
- Reduces peak emissions by spreading the electromagnetic energy
17+
18+
This technique is common in electronic systems, especially in high-speed digital circuits. It helps meet EMI compliance without needing extra shielding or filters.
19+
20+
Digital clock signals have a square wave shape. Most energy focuses at the center frequency and odd harmonics. In the frequency domain, SSC reduces the peak amplitude of the digital clock signal by spreading the energy across a wider frequency range. In the time domain, SSC adds jitter to the clock signal, but the voltage amplitude remains unchanged.
21+
22+
Display Subsystem (DSS) supports SSC configuration for its pixel clocks through device tree properties. This helps you meet EMI compliance requirements. For DPI, DSS typically uses Phase-Locked Loop (PLL) 17. You can also use PLL 16 or PLL 18.
23+
24+
This guide shows how to configure SSC for DSS pixel clocks on supported TI SoCs.
25+
26+
.. important::
27+
28+
The pixel clock frequency for DPI from the DSS PLL must not exceed 165MHz. When using center spread mode, calculate the highest peak frequency to ensure it stays under this limit:
29+
30+
- For center spread: Highest frequency = Nominal frequency × (1 + (Modulation depth × 1.2) / 100)
31+
- For down spread: Highest frequency = Nominal frequency (no overshoot)
32+
33+
Example: With 100 MHz nominal frequency and 0.5% modulation depth in center spread mode:
34+
35+
- Highest frequency = 100 MHz × (1 + (0.5 × 1.2) / 100) = 100.6 MHz
36+
37+
The 1.2 factor accounts for the 20% overshoot on the modulation depth in center spread mode.
38+
39+
*************************************************
40+
Spread spectrum clocking configuration parameters
41+
*************************************************
42+
43+
The ``assigned-clock-sscs`` device tree property configures SSC and takes three parameters:
44+
45+
+-----------------------+----------------------------------------------------------------+
46+
| Parameter | Description |
47+
+=======================+================================================================+
48+
|| Modulation Frequency || The frequency at which the spread spectrum modulation occurs |
49+
|| (Hz) || - Minimum: 32,000 Hz (32 kHz) |
50+
|| || - Maximum: Reference clock frequency / 200 |
51+
|| || - Typical values: 32 kHz to 120 kHz |
52+
+-----------------------+----------------------------------------------------------------+
53+
|| Modulation Depth || The amount of frequency spread as a percentage |
54+
|| || - Minimum: 10 (0.1%) |
55+
|| || - Maximum: 310 (3.1%) |
56+
|| || - Adjustable in increments of 10 (0.1%) |
57+
|| || - Example: 50 = 0.5% spread |
58+
|| || - Units: 1/10,000 (for example, 50 represents 0.5%) |
59+
+-----------------------+----------------------------------------------------------------+
60+
|| Spread Type || - 1: Center spread (frequency varies on both higher and lower |
61+
|| || frequencies than nominal) |
62+
|| || - 3: Down spread (frequency varies only lower than nominal) |
63+
+-----------------------+----------------------------------------------------------------+
64+
65+
The modulation uses a triangular waveform. The Device Manager automatically configures the PLL hardware based on the parameters specified in the device tree.
66+
67+
********
68+
Examples
69+
********
70+
71+
Example 1: Basic SSC configuration (center spread)
72+
==================================================
73+
74+
This example shows how to enable SSC for the DSS VP2 clock with the following parameters:
75+
76+
- Modulation frequency: 100 kHz
77+
- Modulation depth: 10 (0.1%)
78+
- Spread type: Center spread (1)
79+
80+
Add the following properties to the DSS node in your device tree file (for example, :file:`k3-am62p-j722s-common-main.dtsi`):
81+
82+
.. code-block:: dts
83+
84+
&dss0 {
85+
assigned-clocks = <&k3_clks 186 2>;
86+
assigned-clock-sscs = <100000 10 1>;
87+
};
88+
89+
.. warning::
90+
91+
This example uses center spread mode (1). Remember to apply the 1.2 factor for the 20% overshoot when calculating peak frequency. Consider down spread mode (Example 2) if you need to avoid exceeding the nominal frequency.
92+
93+
Example 2: SSC with down spread mode
94+
====================================
95+
96+
This example demonstrates down spread mode, which we recommend for display interfaces:
97+
98+
- Modulation frequency: 33 kHz
99+
- Modulation depth: 50 (0.5%)
100+
- Spread type: Down spread (3)
101+
102+
.. code-block:: dts
103+
104+
&dss0 {
105+
assigned-clocks = <&k3_clks 186 2>;
106+
assigned-clock-sscs = <33000 50 3>;
107+
};
108+
109+
Example 3: Greater modulation depth
110+
===================================
111+
112+
Here is a configuration with greater modulation depth for better EMI reduction:
113+
114+
- Modulation frequency: 50 kHz
115+
- Modulation depth: 250 (2.5%)
116+
- Spread type: Down spread (3)
117+
118+
.. code-block:: dts
119+
120+
&dss0 {
121+
assigned-clocks = <&k3_clks 186 2>;
122+
assigned-clock-sscs = <50000 250 3>;
123+
};
124+
125+
***************
126+
Troubleshooting
127+
***************
128+
129+
Display artifacts
130+
=================
131+
132+
If you observe display artifacts, flickering, or other visual anomalies after enabling SSC:
133+
134+
1. Reduce the modulation depth to a smaller value (for example, try 0.1% or 10 in device tree)
135+
2. Try a different modulation frequency (typical range: 32-100 kHz)
136+
3. Switch from center spread to down spread mode if not already using it
137+
4. Consult your display panel data sheet for spread spectrum tolerance specifications
138+
139+
Clock not found error
140+
=====================
141+
142+
If you experience errors during boot about clock assignment:
143+
144+
1. Verify the clock ID is correct for your SoC (check the technical reference manual)
145+
2. Ensure the Device Manager supports SSC for the specified clock
146+
3. Check that the kernel version includes SSC support for the clock subsystem
147+
148+
****************************
149+
Requirements and limitations
150+
****************************
151+
152+
**Hardware support:**
153+
154+
- SSC is currently supported only on display PLL for these SoCs: AM62x, AM62Ax, AM62Dx, AM62Px
155+
- The display PLL is typically PLL 17. You can also use PLL 16 or PLL 18 for DPI applications
156+
157+
**Configuration:**
158+
159+
- Configure SSC together with ``assigned-clocks`` and ``assigned-clock-sscs`` to specify which clock receives the SSC settings
160+
- SSC causes the instantaneous clock frequency to deviate from the nominal rate
161+
- Some panels have strict jitter requirements
162+
163+
**Firmware capability:**
164+
165+
Check if your firmware supports SSC by using the capability flag:
166+
167+
.. code-block:: console
168+
169+
# Check firmware capabilities (requires ti-sci driver)
170+
cat /sys/kernel/debug/ti-sci/fw_caps
171+
172+
Look for ``TISCI_MSG_FLAG_FW_CAP_CLOCK_SSC`` in the capabilities list.
173+
174+
**********************************
175+
Best practices and recommendations
176+
**********************************
177+
178+
- Start with low modulation depth (0.1% to 0.5%) and increase only if needed
179+
- Use down spread mode (3) for display interfaces to ensure the clock never exceeds the specified maximum frequency
180+
- Apply the 1.2 factor when using center spread mode
181+
- Validate configuration with your display panel to ensure timing margins meet requirements
182+
183+
*************************
184+
Customer responsibilities
185+
*************************
186+
187+
.. warning::
188+
189+
**You assume all responsibility for the configuration and usage of spread spectrum clocking.** You must:
190+
191+
1. Research the clock limitations associated with your selected display panel
192+
2. Configure SSC to be compatible with that specific display panel
193+
3. Verify that the SSC configuration does not cause any system-related issues for any operating condition
194+
4. Work with the display panel vendor to resolve any issues caused by enabling SSC
195+
5. Validate displays to have enough functional margin with the jitter introduced by spread spectrum modulation
196+
197+
Some display panels have clocking limitations not mentioned in their data sheets. Work directly with the display panel manufacturer on any display-related issues from SSC.
198+
199+
**********
200+
References
201+
**********
202+
203+
- :ref:`dss7`
204+
- SoC Technical Reference Manual (TRM)
205+
- System Firmware Documentation - PM Clock API
206+
- Linux kernel device tree bindings: ``Documentation/devicetree/bindings/display/ti/``
207+
- Linux kernel clock framework documentation: ``Documentation/driver-api/clk.rst``

source/linux/How_to_Guides_Developer_Notes.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Developer Notes
3333
How_to_Guides/Target/How_to_Use_K3Conf_Tool
3434
How_to_Guides/Target/How_to_Tune_Real_Time_Linux
3535
How_to_Guides/Target/How_to_enable_display_sharing_between_remotecore_and_Linux
36+
How_to_Guides/Target/How_to_enable_SSC_for_DSS
3637
How_to_Guides/Target/How_to_boot_quickly
3738
How_to_Guides/Target/Runtime_debug_unlock_on_secure_device
3839
How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5

0 commit comments

Comments
 (0)