Skip to contentSkip to conversation

spi: cs42l43: Tidy up header includes

PATCH Applied Charles Keepax 3 participants 14 messages Jan 29, 2024 – Feb 8, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/6 spi: cs42l43: Tidy up header includes

Including some missing headers.

---

No change since v3.

Thanks,
Charles

 drivers/spi/spi-cs42l43.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/spi/spi-cs42l43.c +2 -0
index f13073e12593..16b2c6c2e006 100644
@@ -11,7 +11,9 @@
 #include <linux/errno.h>
 #include <linux/mfd/cs42l43.h>
 #include <linux/mfd/cs42l43-regs.h>
+#include <linux/mod_devicetable.h>
 #include <linux/module.h>
+#include <linux/of.h>
 #include <linux/platform_device.h>
 #include <linux/pm_runtime.h>
 #include <linux/regmap.h>
Signature · 1 line
2.30.2
#1 lore raw

PATCH v4 2/6 mfd: cs42l43: Tidy up header includes

Use more forward declarations, move header guards to cover other includes, and rely less on including headers through other headers.

---

Changes since v3:
- Returned to v1 by not including pm.h and regmap.h in cs42l43.h

Thanks,
Charles

 drivers/mfd/cs42l43-i2c.c   |  6 +++++-
 drivers/mfd/cs42l43-sdw.c   |  6 +++++-
 drivers/mfd/cs42l43.c       |  8 +++++++-
 drivers/mfd/cs42l43.h       | 10 ++++++----
 include/linux/mfd/cs42l43.h | 13 +++++++------
 5 files changed, 30 insertions(+), 13 deletions(-)
drivers/mfd/cs42l43-i2c.c +5 -1
index 4922211680c9..7162274a0b55 100644
@@ -6,11 +6,15 @@
  *                         Cirrus Logic International Semiconductor Ltd.
  */
 
+#include <linux/array_size.h>
 #include <linux/err.h>
-#include <linux/errno.h>
 #include <linux/i2c.h>
+#include <linux/mfd/cs42l43.h>
 #include <linux/mfd/cs42l43-regs.h>
+#include <linux/mod_devicetable.h>
 #include <linux/module.h>
+#include <linux/pm.h>
+#include <linux/regmap.h>
 
 #include "cs42l43.h"
 
drivers/mfd/cs42l43-sdw.c +5 -1
index 1d85bbf8cdd5..d6962a5a35f6 100644
@@ -6,11 +6,15 @@
  *                         Cirrus Logic International Semiconductor Ltd.
  */
 
+#include <linux/array_size.h>
 #include <linux/device.h>
 #include <linux/err.h>
-#include <linux/errno.h>
+#include <linux/mfd/cs42l43.h>
 #include <linux/mfd/cs42l43-regs.h>
+#include <linux/mod_devicetable.h>
 #include <linux/module.h>
+#include <linux/pm.h>
+#include <linux/regmap.h>
 #include <linux/soundwire/sdw.h>
 #include <linux/soundwire/sdw_registers.h>
 #include <linux/soundwire/sdw_type.h>
drivers/mfd/cs42l43.c +7 -1
index 7b6d07cbe6fc..4e2bc5ad244a 100644
@@ -6,18 +6,24 @@
  *                         Cirrus Logic International Semiconductor Ltd.
  */
 
+#include <linux/array_size.h>
 #include <linux/bitops.h>
 #include <linux/build_bug.h>
 #include <linux/delay.h>
+#include <linux/device.h>
 #include <linux/err.h>
-#include <linux/errno.h>
 #include <linux/firmware.h>
+#include <linux/gpio/consumer.h>
 #include <linux/jiffies.h>
 #include <linux/mfd/core.h>
+#include <linux/mfd/cs42l43.h>
 #include <linux/mfd/cs42l43-regs.h>
 #include <linux/module.h>
+#include <linux/pm.h>
 #include <linux/pm_runtime.h>
+#include <linux/regmap.h>
 #include <linux/soundwire/sdw.h>
+#include <linux/types.h>
 
 #include "cs42l43.h"
 
drivers/mfd/cs42l43.h +6 -4
index eb4caf393833..8d1b1b0f5a47 100644
@@ -6,15 +6,17 @@
  *                         Cirrus Logic International Semiconductor Ltd.
  */
 
-#include <linux/mfd/cs42l43.h>
-#include <linux/pm.h>
-#include <linux/regmap.h>
-
 #ifndef CS42L43_CORE_INT_H
 #define CS42L43_CORE_INT_H
 
 #define CS42L43_N_DEFAULTS 176
 
+struct dev_pm_ops;
+struct device;
+struct reg_default;
+
+struct cs42l43;
+
 extern const struct dev_pm_ops cs42l43_pm_ops;
 extern const struct reg_default cs42l43_reg_default[CS42L43_N_DEFAULTS];
 
include/linux/mfd/cs42l43.h +7 -6
index cf8263aab41b..2239d8585e78 100644
@@ -6,20 +6,21 @@
  *                         Cirrus Logic International Semiconductor Ltd.
  */
 
+#ifndef CS42L43_CORE_EXT_H
+#define CS42L43_CORE_EXT_H
+
 #include <linux/completion.h>
-#include <linux/device.h>
-#include <linux/gpio/consumer.h>
 #include <linux/mutex.h>
 #include <linux/regmap.h>
 #include <linux/regulator/consumer.h>
-#include <linux/soundwire/sdw.h>
 #include <linux/workqueue.h>
 
-#ifndef CS42L43_CORE_EXT_H
-#define CS42L43_CORE_EXT_H
-
 #define CS42L43_N_SUPPLIES		3
 
+struct device;
+struct gpio_desc;
+struct sdw_slave;
+
 enum cs42l43_irq_numbers {
 	CS42L43_PLL_LOST_LOCK,
 	CS42L43_PLL_READY,
Signature · 1 line
2.30.2
#2 lore raw

PATCH v4 3/6 mfd: cs42l43: Use __u8 type rather than u8 for firmware interface

In reply to Charles Keepax

__xxx is the preferred type for firmware interfaces.

---

No change since v3.

Thanks,
Charles

 drivers/mfd/cs42l43.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/mfd/cs42l43.c +2 -2
index 4e2bc5ad244a..65a331481d97 100644
@@ -55,8 +55,8 @@
 struct cs42l43_patch_header {
 	__le16 version;
 	__le16 size;
-	u8 reserved;
-	u8 secure;
+	__u8 reserved;
+	__u8 secure;
 	__le16 bss_size;
 	__le32 apply_addr;
 	__le32 checksum;
Signature · 1 line
2.30.2
#3 lore raw

PATCH v4 4/6 mfd: cs42l43: Add time postfixes on defines

In reply to Charles Keepax

Make the defines a little clearer by adding time based postfixes.

---

No change since v3.

Thanks,
Charles

 drivers/mfd/cs42l43.c | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)
drivers/mfd/cs42l43.c +18 -18
index 65a331481d97..aea0f8f48578 100644
@@ -27,30 +27,30 @@
 
 #include "cs42l43.h"
 
-#define CS42L43_RESET_DELAY			20
+#define CS42L43_RESET_DELAY_MS			20
 
-#define CS42L43_SDW_ATTACH_TIMEOUT		500
-#define CS42L43_SDW_DETACH_TIMEOUT		100
+#define CS42L43_SDW_ATTACH_TIMEOUT_MS		500
+#define CS42L43_SDW_DETACH_TIMEOUT_MS		100
 
 #define CS42L43_MCU_BOOT_STAGE1			1
 #define CS42L43_MCU_BOOT_STAGE2			2
 #define CS42L43_MCU_BOOT_STAGE3			3
 #define CS42L43_MCU_BOOT_STAGE4			4
-#define CS42L43_MCU_POLL			5000
-#define CS42L43_MCU_CMD_TIMEOUT			20000
+#define CS42L43_MCU_POLL_US			5000
+#define CS42L43_MCU_CMD_TIMEOUT_US		20000
 #define CS42L43_MCU_UPDATE_FORMAT		3
 #define CS42L43_MCU_UPDATE_OFFSET		0x100000
-#define CS42L43_MCU_UPDATE_TIMEOUT		500000
+#define CS42L43_MCU_UPDATE_TIMEOUT_US		500000
 #define CS42L43_MCU_UPDATE_RETRIES		5
 
 #define CS42L43_MCU_SUPPORTED_REV		0x2105
 #define CS42L43_MCU_SHADOW_REGS_REQUIRED_REV	0x2200
 #define CS42L43_MCU_SUPPORTED_BIOS_REV		0x0001
 
-#define CS42L43_VDDP_DELAY			50
-#define CS42L43_VDDD_DELAY			1000
+#define CS42L43_VDDP_DELAY_US			50
+#define CS42L43_VDDD_DELAY_US			1000
 
-#define CS42L43_AUTOSUSPEND_TIME		250
+#define CS42L43_AUTOSUSPEND_TIME_MS		250
 
 struct cs42l43_patch_header {
 	__le16 version;
@@ -538,10 +538,10 @@ static int cs42l43_soft_reset(struct cs42l43 *cs42l43)
 	regcache_cache_only(cs42l43->regmap, true);
 	regmap_multi_reg_write_bypassed(cs42l43->regmap, reset, ARRAY_SIZE(reset));
 
-	msleep(CS42L43_RESET_DELAY);
+	msleep(CS42L43_RESET_DELAY_MS);
 
 	if (cs42l43->sdw) {
-		unsigned long timeout = msecs_to_jiffies(CS42L43_SDW_DETACH_TIMEOUT);
+		unsigned long timeout = msecs_to_jiffies(CS42L43_SDW_DETACH_TIMEOUT_MS);
 		unsigned long time;
 
 		time = wait_for_completion_timeout(&cs42l43->device_detach, timeout);
@@ -561,7 +561,7 @@ static int cs42l43_soft_reset(struct cs42l43 *cs42l43)
 static int cs42l43_wait_for_attach(struct cs42l43 *cs42l43)
 {
 	if (!cs42l43->attached) {
-		unsigned long timeout = msecs_to_jiffies(CS42L43_SDW_ATTACH_TIMEOUT);
+		unsigned long timeout = msecs_to_jiffies(CS42L43_SDW_ATTACH_TIMEOUT_MS);
 		unsigned long time;
 
 		time = wait_for_completion_timeout(&cs42l43->device_attach, timeout);
@@ -603,7 +603,7 @@ static int cs42l43_mcu_stage_2_3(struct cs42l43 *cs42l43, bool shadow)
 
 	ret = regmap_read_poll_timeout(cs42l43->regmap, CS42L43_BOOT_STATUS,
 				       val, (val == CS42L43_MCU_BOOT_STAGE3),
-				       CS42L43_MCU_POLL, CS42L43_MCU_CMD_TIMEOUT);
+				       CS42L43_MCU_POLL_US, CS42L43_MCU_CMD_TIMEOUT_US);
 	if (ret) {
 		dev_err(cs42l43->dev, "Failed to move to stage 3: %d, 0x%x\n", ret, val);
 		return ret;
@@ -652,7 +652,7 @@ static int cs42l43_mcu_disable(struct cs42l43 *cs42l43)
 
 	ret = regmap_read_poll_timeout(cs42l43->regmap, CS42L43_SOFT_INT_SHADOW, val,
 				       (val & CS42L43_CONTROL_APPLIED_INT_MASK),
-				       CS42L43_MCU_POLL, CS42L43_MCU_CMD_TIMEOUT);
+				       CS42L43_MCU_POLL_US, CS42L43_MCU_CMD_TIMEOUT_US);
 	if (ret) {
 		dev_err(cs42l43->dev, "Failed to disable firmware: %d, 0x%x\n", ret, val);
 		return ret;
@@ -696,7 +696,7 @@ static void cs42l43_mcu_load_firmware(const struct firmware *firmware, void *con
 
 	ret = regmap_read_poll_timeout(cs42l43->regmap, CS42L43_SOFT_INT_SHADOW, val,
 				       (val & CS42L43_PATCH_APPLIED_INT_MASK),
-				       CS42L43_MCU_POLL, CS42L43_MCU_UPDATE_TIMEOUT);
+				       CS42L43_MCU_POLL_US, CS42L43_MCU_UPDATE_TIMEOUT_US);
 	if (ret) {
 		dev_err(cs42l43->dev, "Failed to update firmware: %d, 0x%x\n", ret, val);
 		cs42l43->firmware_error = ret;
@@ -957,7 +957,7 @@ static int cs42l43_power_up(struct cs42l43 *cs42l43)
 	}
 
 	/* vdd-p must be on for 50uS before any other supply */
-	usleep_range(CS42L43_VDDP_DELAY, 2 * CS42L43_VDDP_DELAY);
+	usleep_range(CS42L43_VDDP_DELAY_US, 2 * CS42L43_VDDP_DELAY_US);
 
 	gpiod_set_value_cansleep(cs42l43->reset, 1);
 
@@ -973,7 +973,7 @@ static int cs42l43_power_up(struct cs42l43 *cs42l43)
 		goto err_core_supplies;
 	}
 
-	usleep_range(CS42L43_VDDD_DELAY, 2 * CS42L43_VDDD_DELAY);
+	usleep_range(CS42L43_VDDD_DELAY_US, 2 * CS42L43_VDDD_DELAY_US);
 
 	return 0;
 
@@ -1057,7 +1057,7 @@ int cs42l43_dev_probe(struct cs42l43 *cs42l43)
 	if (ret)
 		return ret;
 
-	pm_runtime_set_autosuspend_delay(cs42l43->dev, CS42L43_AUTOSUSPEND_TIME);
+	pm_runtime_set_autosuspend_delay(cs42l43->dev, CS42L43_AUTOSUSPEND_TIME_MS);
 	pm_runtime_use_autosuspend(cs42l43->dev);
 	pm_runtime_set_active(cs42l43->dev);
 	/*
Signature · 1 line
2.30.2
#4 lore raw

PATCH v4 5/6 mfd: cs42l43: Add some missing dev_err_probe()s

In reply to Charles Keepax

Use of dev_err_probe() was missed in the i2c and sdw parts of the code, update the missing parts.

---

No change since v3.

Thanks,
Charles

 drivers/mfd/cs42l43-i2c.c | 9 +++------
 drivers/mfd/cs42l43-sdw.c | 9 +++------
 2 files changed, 6 insertions(+), 12 deletions(-)
drivers/mfd/cs42l43-i2c.c +3 -6
index 7162274a0b55..c9e4ea76149a 100644
@@ -38,7 +38,6 @@ static const struct regmap_config cs42l43_i2c_regmap = {
 static int cs42l43_i2c_probe(struct i2c_client *i2c)
 {
 	struct cs42l43 *cs42l43;
-	int ret;
 
 	cs42l43 = devm_kzalloc(&i2c->dev, sizeof(*cs42l43), GFP_KERNEL);
 	if (!cs42l43)
@@ -50,11 +49,9 @@ static int cs42l43_i2c_probe(struct i2c_client *i2c)
 	cs42l43->attached = true;
 
 	cs42l43->regmap = devm_regmap_init_i2c(i2c, &cs42l43_i2c_regmap);
-	if (IS_ERR(cs42l43->regmap)) {
-		ret = PTR_ERR(cs42l43->regmap);
-		dev_err(cs42l43->dev, "Failed to allocate regmap: %d\n", ret);
-		return ret;
-	}
+	if (IS_ERR(cs42l43->regmap))
+		return dev_err_probe(cs42l43->dev, PTR_ERR(cs42l43->regmap),
+				     "Failed to allocate regmap\n");
 
 	return cs42l43_dev_probe(cs42l43);
 }
drivers/mfd/cs42l43-sdw.c +3 -6
index d6962a5a35f6..65f7b1d78248 100644
@@ -171,7 +171,6 @@ static int cs42l43_sdw_probe(struct sdw_slave *sdw, const struct sdw_device_id *
 {
 	struct cs42l43 *cs42l43;
 	struct device *dev = &sdw->dev;
-	int ret;
 
 	cs42l43 = devm_kzalloc(dev, sizeof(*cs42l43), GFP_KERNEL);
 	if (!cs42l43)
@@ -181,11 +180,9 @@ static int cs42l43_sdw_probe(struct sdw_slave *sdw, const struct sdw_device_id *
 	cs42l43->sdw = sdw;
 
 	cs42l43->regmap = devm_regmap_init_sdw(sdw, &cs42l43_sdw_regmap);
-	if (IS_ERR(cs42l43->regmap)) {
-		ret = PTR_ERR(cs42l43->regmap);
-		dev_err(cs42l43->dev, "Failed to allocate regmap: %d\n", ret);
-		return ret;
-	}
+	if (IS_ERR(cs42l43->regmap))
+		return dev_err_probe(cs42l43->dev, PTR_ERR(cs42l43->regmap),
+				     "Failed to allocate regmap\n");
 
 	return cs42l43_dev_probe(cs42l43);
 }
Signature · 1 line
2.30.2
#5 lore raw

PATCH v4 6/6 mfd: cs42l43: Handle error from devm_pm_runtime_enable()

In reply to Charles Keepax

As it devm_pm_runtime_enable() can fail due to memory allocations, it is best to handle the error.

---

No change since v3.

Thanks,
Charles

 drivers/mfd/cs42l43.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/mfd/cs42l43.c +3 -1
index aea0f8f48578..56bd9dbbe10b 100644
@@ -1065,7 +1065,9 @@ int cs42l43_dev_probe(struct cs42l43 *cs42l43)
 	 * the boot work runs.
 	 */
 	pm_runtime_get_noresume(cs42l43->dev);
-	devm_pm_runtime_enable(cs42l43->dev);
+	ret = devm_pm_runtime_enable(cs42l43->dev);
+	if (ret)
+		return ret;
 
 	queue_work(system_long_wq, &cs42l43->boot_work);
 
Signature · 1 line
2.30.2
maintainer
#6 lore raw
In reply to Charles Keepax

Mark,

Quoted 6 lines · Charles Keepax

Including some missing headers.

You can just take this, no?

Quoted 28 lines

---

No change since v3.

Thanks,
Charles

 drivers/spi/spi-cs42l43.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/spi/spi-cs42l43.c +2 -0
index f13073e12593..16b2c6c2e006 100644
@@ -11,7 +11,9 @@
 #include <linux/errno.h>
 #include <linux/mfd/cs42l43.h>
 #include <linux/mfd/cs42l43-regs.h>
+#include <linux/mod_devicetable.h>
 #include <linux/module.h>
+#include <linux/of.h>
 #include <linux/platform_device.h>
 #include <linux/pm_runtime.h>
 #include <linux/regmap.h>
Signature · 1 line
2.30.2
Signature · 1 line
Lee Jones [李琼斯]
maintainer Applied
#7 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

In reply to Charles Keepax
Quoted 3 lines · Charles Keepax

Including some missing headers.

Applied, thanks!

[2/6] mfd: cs42l43: Tidy up header includes

      commit: a5bc1c6c93853fb1026fb5feb6c36c9cd9512724
[3/6] mfd: cs42l43: Use __u8 type rather than u8 for firmware interface
      commit: eb40e181cc480c89b906aca1f29ff6f6df6b66b9
[4/6] mfd: cs42l43: Add time postfixes on defines
      commit: 43a94a8cf0fa136d5fc726121ff7a602754c9680
[5/6] mfd: cs42l43: Add some missing dev_err_probe()s
      commit: 104c68194edbe0e8c3036ce283a3f69434415be2
[6/6] mfd: cs42l43: Handle error from devm_pm_runtime_enable()
      commit: 8716f2c79eb82bd4dc5d7f9523a560e35efe0795

--
Lee Jones [李琼斯]

#8 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

Quoted 18 lines · Lee Jones
Quoted 3 lines · Charles Keepax

Including some missing headers.

Applied, thanks!

[2/6] mfd: cs42l43: Tidy up header includes

      commit: a5bc1c6c93853fb1026fb5feb6c36c9cd9512724
[3/6] mfd: cs42l43: Use __u8 type rather than u8 for firmware interface
      commit: eb40e181cc480c89b906aca1f29ff6f6df6b66b9
[4/6] mfd: cs42l43: Add time postfixes on defines
      commit: 43a94a8cf0fa136d5fc726121ff7a602754c9680
[5/6] mfd: cs42l43: Add some missing dev_err_probe()s
      commit: 104c68194edbe0e8c3036ce283a3f69434415be2
[6/6] mfd: cs42l43: Handle error from devm_pm_runtime_enable()
      commit: 8716f2c79eb82bd4dc5d7f9523a560e35efe0795
Quoted 3 lines

--
Lee Jones [李琼斯]

The SPI one needs to be applied along with these, otherwise this will cause build breakage in the SPI driver.

Thanks,
Charles

maintainer
#9 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

Quoted 19 lines · Charles Keepax
Quoted 18 lines · Lee Jones
Quoted 3 lines · Charles Keepax

Including some missing headers.

Applied, thanks!

[2/6] mfd: cs42l43: Tidy up header includes

      commit: a5bc1c6c93853fb1026fb5feb6c36c9cd9512724
[3/6] mfd: cs42l43: Use __u8 type rather than u8 for firmware interface
      commit: eb40e181cc480c89b906aca1f29ff6f6df6b66b9
[4/6] mfd: cs42l43: Add time postfixes on defines
      commit: 43a94a8cf0fa136d5fc726121ff7a602754c9680
[5/6] mfd: cs42l43: Add some missing dev_err_probe()s
      commit: 104c68194edbe0e8c3036ce283a3f69434415be2
[6/6] mfd: cs42l43: Handle error from devm_pm_runtime_enable()
      commit: 8716f2c79eb82bd4dc5d7f9523a560e35efe0795
Quoted 6 lines
Quoted 3 lines

--
Lee Jones [李琼斯]

The SPI one needs to be applied along with these, otherwise this will cause build breakage in the SPI driver.

Okay.

Mark, can I just take it without sending a PR?

Signature · 1 line
Lee Jones [李琼斯]
maintainer
#10 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

Quoted 8 lines · Lee Jones
Quoted 2 lines · Charles Keepax

The SPI one needs to be applied along with these, otherwise this will cause build breakage in the SPI driver.

Okay.

Mark, can I just take it without sending a PR?

Sure.

maintainer Applied
#11 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

In reply to Charles Keepax
Quoted 3 lines · Charles Keepax

Including some missing headers.

Applied, thanks!

[1/6] spi: cs42l43: Tidy up header includes

      commit: 0863c47b4147b948a23f03031ac880096512a878

--
Lee Jones [李琼斯]

#12 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

Quoted 9 lines · Lee Jones
Quoted 3 lines · Charles Keepax

Including some missing headers.

Applied, thanks!

[1/6] spi: cs42l43: Tidy up header includes

      commit: 0863c47b4147b948a23f03031ac880096512a878

Thanks all, sorry about the confusion I really should have kept including the blurb I did on the first version of the patch that pointed this out explicitly.

Thanks,
Charles

maintainer
#13 lore raw

Re: (subset) [PATCH v4 1/6] spi: cs42l43: Tidy up header includes

Quoted 6 lines · Charles Keepax
Quoted 5 lines · Lee Jones
Quoted 3 lines · Charles Keepax

Including some missing headers.

Quoted 8 lines
Quoted 4 lines

Applied, thanks!

[1/6] spi: cs42l43: Tidy up header includes

      commit: 0863c47b4147b948a23f03031ac880096512a878

Thanks all, sorry about the confusion I really should have kept including the blurb I did on the first version of the patch that pointed this out explicitly.

No problem. I would have probably missed it anyway!

Signature · 1 line
Lee Jones [李琼斯]