Skip to contentSkip to conversation

Docs: iio: ad7191: Correct clock configuration

PATCH Superseded Ammar Mustafa 2 participants 4 messages Feb 27

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Docs: iio: ad7191: Correct clock configuration

Correct the ad7191 documentation to match the datasheet:
- Fix inverted CLKSEL pin logic: device should use external clock when low, internal CMOS/crystal when high.
- Correct CMOS-compatible clock pin from MCLK2 to MCLK1.

---
 Documentation/iio/ad7191.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/iio/ad7191.rst +4 -4
index 977d4fea14b0..bb8a1efcfb98 100644
@@ -63,12 +63,12 @@ Clock Configuration
 
 The AD7191 supports both internal and external clock sources:
 
-- When CLKSEL pin is tied LOW: Uses internal 4.92MHz clock (no clock property
-  needed)
-- When CLKSEL pin is tied HIGH: Requires external clock source
+- When CLKSEL pin is tied LOW: Requires external clock source
   - Can be a crystal between MCLK1 and MCLK2 pins
-  - Or a CMOS-compatible clock driving MCLK2 pin
+  - Or a CMOS-compatible clock driving MCLK1 pin and MCLK2 left unconnected
   - Must specify the "clocks" property in device tree when using external clock
+- When CLKSEL pin is tied HIGH: Uses internal 4.92MHz clock (no clock property
+  needed)
 
 SPI Interface Requirements
 --------------------------
Signature · 1 line
2.43.0
#1 lore raw
Quoted 4 lines · Ammar Mustafa

Correct the ad7191 documentation to match the datasheet:
- Fix inverted CLKSEL pin logic: device should use external clock when low, internal CMOS/crystal when high.
- Correct CMOS-compatible clock pin from MCLK2 to MCLK1.

...

Documentation/iio/ad7191.rst Clock Configuration · line 71

Quoted 10 lines

-- When CLKSEL pin is tied LOW: Uses internal 4.92MHz clock (no clock property

Documentation/iio/ad7191.rst +4 -3
-  needed)
-- When CLKSEL pin is tied HIGH: Requires external clock source
+- When CLKSEL pin is tied LOW: Requires external clock source
   - Can be a crystal between MCLK1 and MCLK2 pins
-  - Or a CMOS-compatible clock driving MCLK2 pin
+  - Or a CMOS-compatible clock driving MCLK1 pin and MCLK2 left unconnected
   - Must specify the "clocks" property in device tree when using external clock
+- When CLKSEL pin is tied HIGH: Uses internal 4.92MHz clock (no clock property
+  needed)

Is it active-low or active-high pin?

...

When I see such a confusion in the documentation I propose to replace HIGH/LOW to active/inactive or asserted/deasserted.

And no need to swap the entries.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 19 lines · Andy Shevchenko
Quoted 4 lines · Ammar Mustafa

Correct the ad7191 documentation to match the datasheet:
- Fix inverted CLKSEL pin logic: device should use external clock when low, internal CMOS/crystal when high.
- Correct CMOS-compatible clock pin from MCLK2 to MCLK1.

...

Documentation/iio/ad7191.rst Clock Configuration · line 71

Quoted 10 lines

-- When CLKSEL pin is tied LOW: Uses internal 4.92MHz clock (no clock property

Documentation/iio/ad7191.rst +4 -3
-  needed)
-- When CLKSEL pin is tied HIGH: Requires external clock source
+- When CLKSEL pin is tied LOW: Requires external clock source
   - Can be a crystal between MCLK1 and MCLK2 pins
-  - Or a CMOS-compatible clock driving MCLK2 pin
+  - Or a CMOS-compatible clock driving MCLK1 pin and MCLK2 left unconnected
   - Must specify the "clocks" property in device tree when using external clock
+- When CLKSEL pin is tied HIGH: Uses internal 4.92MHz clock (no clock property
+  needed)
Quoted 14 lines

Is it active-low or active-high pin?

...

When I see such a confusion in the documentation I propose to replace HIGH/LOW to active/inactive or asserted/deasserted.

And no need to swap the entries.

Signature · 2 lines
With Best Regards,
Andy Shevchenko

I haven't seen anything in the documentation to believe clksel is active-low. I agree that assert/deassert would remove this confusion. I can resend the patch with this change and without the swapped entries.

Thanks,

Ammar Mustafa

#3 lore raw
Quoted 2 lines · Ammar Mustafa
Quoted 1 line · Andy Shevchenko

On Fri, Feb 27, 2026 at 10:37:41AM -0500, Ammar Mustafa wrote:

...

Quoted 8 lines
Quoted 4 lines

When I see such a confusion in the documentation I propose to replace HIGH/LOW to active/inactive or asserted/deasserted.

And no need to swap the entries.

I haven't seen anything in the documentation to believe clksel is active-low. I agree that assert/deassert would remove this confusion. I can resend the patch with this change and without the swapped entries.

Please, do.

Signature · 2 lines
With Best Regards,
Andy Shevchenko