ASoC: codecs: add rk817 support

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

Quoted 6 lines · Chris Morgan

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

Nit: These should be chronological.

Quoted 62 lines

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

drivers/mfd/rk808.c static const struct mfd_cell rk817s[] = { · line 171

Quoted 8 lines

drivers/mfd/rk808.c +5 -0

@@ -163,6 +164,11 @@ static const struct mfd_cell rk817s[] = {
 		.num_resources = ARRAY_SIZE(rk817_rtc_resources),
 		.resources = &rk817_rtc_resources[0],
 	},
+#ifdef CONFIG_SND_SOC_RK817
+	{
+		.name = "rk817-codec",
+	},
+#endif

No #ifery please.

Just replace it with a comment.

If no associated driver exists, it just won't match/bind.

Signature · 5 lines

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

Quoted 10 lines · Lee Jones

Quoted 6 lines · Chris Morgan

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

Nit: These should be chronological.

Acknowledged. I will make sure to do this if a v10 is necessary.

Quoted 73 lines

Quoted 62 lines

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

drivers/mfd/rk808.c static const struct mfd_cell rk817s[] = { · line 171

Quoted 8 lines

drivers/mfd/rk808.c +5 -0

@@ -163,6 +164,11 @@ static const struct mfd_cell rk817s[] = {
 		.num_resources = ARRAY_SIZE(rk817_rtc_resources),
 		.resources = &rk817_rtc_resources[0],
 	},
+#ifdef CONFIG_SND_SOC_RK817
+	{
+		.name = "rk817-codec",
+	},
+#endif

No #ifery please.

Quoted 3 lines

Just replace it with a comment.

If no associated driver exists, it just won't match/bind.

I did the "if" here because I noticed that if I have a rk817 and do not utilize the codec I receive a dmesg warning. I put the if here to silence it in the event that someone was using this PMIC but didn't want to use the audio codec. I will make the change if you say so though, but I just want to confirm that it's acceptable to have a warning for all rk817s that do not use the codec about a missing codec. The hardware is always present, I just can't say for certain it will always be used.

Quoted 91 lines · Chris Morgan

Quoted 10 lines · Lee Jones

Quoted 6 lines · Chris Morgan

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

Nit: These should be chronological.

Acknowledged. I will make sure to do this if a v10 is necessary.

Quoted 73 lines

Quoted 62 lines

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

drivers/mfd/rk808.c static const struct mfd_cell rk817s[] = { · line 171

Quoted 8 lines

drivers/mfd/rk808.c +5 -0

@@ -163,6 +164,11 @@ static const struct mfd_cell rk817s[] = {
 		.num_resources = ARRAY_SIZE(rk817_rtc_resources),
 		.resources = &rk817_rtc_resources[0],
 	},
+#ifdef CONFIG_SND_SOC_RK817
+	{
+		.name = "rk817-codec",
+	},
+#endif

No #ifery please.

Quoted 3 lines

Just replace it with a comment.

If no associated driver exists, it just won't match/bind.

Quoted 7 lines

I did the "if" here because I noticed that if I have a rk817 and do not utilize the codec I receive a dmesg warning. I put the if here to silence it in the event that someone was using this PMIC but didn't want to use the audio codec. I will make the change if you say so though, but I just want to confirm that it's acceptable to have a warning for all rk817s that do not use the codec about a missing codec. The hardware is always present, I just can't say for certain it will always be used.

What is the dmesg warning you receive?

Signature · 5 lines

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

Quoted 101 lines · Chris Morgan

Quoted 92 lines · Lee Jones

Quoted 10 lines · Chris Morgan

Quoted 7 lines

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

Nit: These should be chronological.

Acknowledged. I will make sure to do this if a v10 is necessary.

Quoted 73 lines

Quoted 62 lines

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

drivers/mfd/rk808.c static const struct mfd_cell rk817s[] = { · line 171

Quoted 8 lines

drivers/mfd/rk808.c +5 -0

@@ -163,6 +164,11 @@ static const struct mfd_cell rk817s[] = {
 		.num_resources = ARRAY_SIZE(rk817_rtc_resources),
 		.resources = &rk817_rtc_resources[0],
 	},
+#ifdef CONFIG_SND_SOC_RK817
+	{
+		.name = "rk817-codec",
+	},
+#endif

No #ifery please.

Quoted 3 lines

Just replace it with a comment.

If no associated driver exists, it just won't match/bind.

Quoted 7 lines

I did the "if" here because I noticed that if I have a rk817 and do not utilize the codec I receive a dmesg warning. I put the if here to silence it in the event that someone was using this PMIC but didn't want to use the audio codec. I will make the change if you say so though, but I just want to confirm that it's acceptable to have a warning for all rk817s that do not use the codec about a missing codec. The hardware is always present, I just can't say for certain it will always be used.

Quoted 1 line

What is the dmesg warning you receive?

It appears I was confused, I will update the code. No warning is received when I take away the ifdef guard. However, if I build the codec and don't include a devicetree node for it I get the following lines in dmesg:

rk817-codec rk817-codec: rk817_codec_parse_dt_property() Can not get child: codec rk817-codec rk817-codec: rk817_platform_probe() parse device tree property error -19

So it looks like this ifdef was meant to "fix" a problem that it doesn't even fix. I'll get rid of it and resubmit. To that end, do you think these messages above are okay, or should we try to fix them in the edge case of a user with an rk817 who doesn't use the codec but still has the codec driver compiled?

Hi Chris,

Am Freitag, 14. Mai 2021, 17:50:08 CEST schrieb Chris Morgan:

Quoted 109 lines · Lee Jones

Quoted 101 lines · Chris Morgan

Quoted 92 lines · Lee Jones

Quoted 10 lines · Chris Morgan

Quoted 7 lines

From: Chris Morgan <[email protected]>

Add rk817 codec support cell to rk808 mfd driver.

Tested-by Maciej Matuszczyk <[email protected]>

Signed-off-by Chris Morgan <[email protected]>

Nit: These should be chronological.

Acknowledged. I will make sure to do this if a v10 is necessary.

Quoted 73 lines

Quoted 62 lines

---
Changes in v9:
- Add cover letter.
- Remove documentation for interrupt parent per Rob Herring's request.
- Remove unused MODULE_DEVICE_TABLE to fix a bug identified by kernel test robot.
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.

 drivers/mfd/rk808.c       | 85 +++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/rk808.h | 81 +++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+)

drivers/mfd/rk808.c +1 -0

index ad923dd4e007..9231209184e0 100644
@@ -65,6 +65,7 @@ static bool rk817_is_volatile_reg(struct device *dev, unsigned int reg)
 	switch (reg) {
 	case RK817_SECONDS_REG ... RK817_WEEKS_REG:
 	case RK817_RTC_STATUS_REG:
+	case RK817_CODEC_DTOP_LPT_SRST:
 	case RK817_INT_STS_REG0:
 	case RK817_INT_STS_REG1:
 	case RK817_INT_STS_REG2:

drivers/mfd/rk808.c static const struct mfd_cell rk817s[] = { · line 171

Quoted 8 lines

drivers/mfd/rk808.c +5 -0

@@ -163,6 +164,11 @@ static const struct mfd_cell rk817s[] = {
 		.num_resources = ARRAY_SIZE(rk817_rtc_resources),
 		.resources = &rk817_rtc_resources[0],
 	},
+#ifdef CONFIG_SND_SOC_RK817
+	{
+		.name = "rk817-codec",
+	},
+#endif

No #ifery please.

Quoted 3 lines

Just replace it with a comment.

If no associated driver exists, it just won't match/bind.

Quoted 7 lines

I did the "if" here because I noticed that if I have a rk817 and do not utilize the codec I receive a dmesg warning. I put the if here to silence it in the event that someone was using this PMIC but didn't want to use the audio codec. I will make the change if you say so though, but I just want to confirm that it's acceptable to have a warning for all rk817s that do not use the codec about a missing codec. The hardware is always present, I just can't say for certain it will always be used.

Quoted 1 line

What is the dmesg warning you receive?

It appears I was confused, I will update the code. No warning is received when I take away the ifdef guard. However, if I build the codec and don't include a devicetree node for it I get the following lines in dmesg:

Quoted 8 lines

rk817-codec rk817-codec: rk817_codec_parse_dt_property() Can not get child: codec rk817-codec rk817-codec: rk817_platform_probe() parse device tree property error -19

So it looks like this ifdef was meant to "fix" a problem that it doesn't even fix. I'll get rid of it and resubmit. To that end, do you think these messages above are okay, or should we try to fix them in the edge case of a user with an rk817 who doesn't use the codec but still has the codec driver compiled?

The general case is always having most stuff enabled (as modules) think distro-kernels. So having the codec available but a board not using it should not result in error messages confusing the user ;-) .

I don't think the rk817-codec will be the first mfd to stumble upon this, so I guess just looking through others might provide the solution on how to resolve this "silently" ;-)

Heiko