Skip to contentSkip to conversation

i2c: designware: Add a note about struct dw_scl_sda_cfg usage

PATCH In review Andy Shevchenko 1 participant 2 messages Dec 3, 2021 – Dec 7, 2021

Subsystems (3)
lore
Share & tools
lore

Andy Shevchenko

author reviewer
#0 lore raw

PATCH 1/1 i2c: designware: Add a note about struct dw_scl_sda_cfg usage

Add a note about struct dw_scl_sda_cfg usage to discourage people of using this structure on new platforms. Instead they should try hard to put the needed information into firmware descriptions.

---
 drivers/i2c/busses/i2c-designware-pcidrv.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/i2c/busses/i2c-designware-pcidrv.c +7 -0
index 0f409a4c2da0..3ba506c3a9a9 100644
@@ -38,6 +38,13 @@ enum dw_pci_ctl_id_t {
 	navi_amd,
 };
 
+/*
+ * This is a legacy structure to describe the hardware counters
+ * to configure signal timings on the bus. For Device Tree platforms
+ * one should use the respective properties and for ACPI there is
+ * a set of ACPI methods that provide these counters. No new
+ * platform should use this structure.
+ */
 struct dw_scl_sda_cfg {
 	u32 ss_hcnt;
 	u32 fs_hcnt;
Signature · 1 line
2.33.0
author reviewer
#1 lore raw
Quoted 3 lines · Andy Shevchenko

Add a note about struct dw_scl_sda_cfg usage to discourage people of using this structure on new platforms. Instead they should try hard to put the needed information into firmware descriptions.

Scratch this, I will send a bigger series where I incorporate this one into.

Signature · 2 lines
With Best Regards,
Andy Shevchenko