Skip to contentSkip to conversation

iio: adc: qcom-spmi-adc5: Fix the channel name

PATCH Applied Andy Shevchenko 6 participants 16 messages Jan 18, 2023 – Jan 28, 2023

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

PATCH v2 1/1 iio: adc: qcom-spmi-adc5: Fix the channel name

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
 				    struct fwnode_handle *fwnode,
 				    const struct adc5_data *data)
 {
-	const char *name = fwnode_get_name(fwnode), *channel_name;
+	const char *channel_name;
+	char *name;
 	u32 chan, value, varr[2];
 	u32 sid = 0;
 	int ret;
 	struct device *dev = adc->dev;
 
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+	if (!name)
+		return -ENOMEM;
+
+	/* Cut the address part */
+	name[strchrnul(name, '@') - name] = '\0';
+
 	ret = fwnode_property_read_u32(fwnode, "reg", &chan);
 	if (ret) {
 		dev_err(dev, "invalid channel number %s\n", name);
Signature · 1 line
2.39.0
Reviewed-by on v2 1/1
#1 lore raw
Quoted 9 lines · Andy Shevchenko

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

One question and suggestion below.

Quoted 12 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +0 -0
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
 				    struct fwnode_handle *fwnode,
 				    const struct adc5_data *data)

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 638

Quoted 10 lines
drivers/iio/adc/qcom-spmi-adc5.c +3 -1
 {
-	const char *name = fwnode_get_name(fwnode), *channel_name;
+	const char *channel_name;
+	char *name;
 	u32 chan, value, varr[2];
 	u32 sid = 0;
 	int ret;
 	struct device *dev = adc->dev;
 
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);

Is this better/cleaner than copying the string from fwnode_get_name?

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 643

Quoted 5 lines
drivers/iio/adc/qcom-spmi-adc5.c +5 -0
+	if (!name)
+		return -ENOMEM;
+
+	/* Cut the address part */
+	name[strchrnul(name, '@') - name] = '\0';

This is the same as *strchrnul(name, '@') = '\0'; if I'm not mistaken.

- Marijn

Quoted 7 lines
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+
 	ret = fwnode_property_read_u32(fwnode, "reg", &chan);
 	if (ret) {
 		dev_err(dev, "invalid channel number %s\n", name);
Signature · 1 line
2.39.0
#2 lore raw
Quoted 5 lines · Marijn Suijten
Quoted 4 lines · Andy Shevchenko

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Quoted 7 lines
Quoted 5 lines

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

Thank you!

My answers below.

...

Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 638

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);

Is this better/cleaner than copying the string from fwnode_get_name?

Coying to where? And what would be the lifetime of that string?

With devm_kasprintf():
- we don't care how long the string is
- we don't care about corner cases of lifetime as it's the same as device itself (i.o.w. the same as the IIO device container)

...

Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 643

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name[strchrnul(name, '@') - name] = '\0';

This is the same as *strchrnul(name, '@') = '\0'; if I'm not mistaken.

Yes, But it's harder to read and understand. I believe the compiler has enough power to optimize this to the same assembly code.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw

On 2023-01-18 15:22:42, Andy Shevchenko wrote:
...

Quoted 10 lines
Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 638

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);

Is this better/cleaner than copying the string from fwnode_get_name?

Coying to where? And what would be the lifetime of that string?

With devm_kasprintf():
- we don't care how long the string is
- we don't care about corner cases of lifetime as it's the same as device itself (i.o.w. the same as the IIO device container)

Curious if there isn't a devm_strdup(name) or similar? Main point is that %pfwP seems like magic when fwnode_get_name is not (but returns a const string that we cannot modify). If there is not, let's stick with devm_kasprintf().

Quoted 6 lines
Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 643

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name[strchrnul(name, '@') - name] = '\0';

This is the same as *strchrnul(name, '@') = '\0'; if I'm not mistaken.

Yes, But it's harder to read and understand. I believe the compiler has enough power to optimize this to the same assembly code.

I find the latter clearer as it doesn't require the reader to figure out that name - name cancels itself out. Alternatively we can write strchrnul(name, '@')[0].

- Marijn

#4 lore raw
Quoted 1 line · Marijn Suijten

On 2023-01-18 15:22:42, Andy Shevchenko wrote:

...

Quoted 6 lines
Quoted 6 lines
Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 638

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);

Is this better/cleaner than copying the string from fwnode_get_name?

Coying to where? And what would be the lifetime of that string?

Quoted 8 lines
Quoted 4 lines

With devm_kasprintf():
- we don't care how long the string is
- we don't care about corner cases of lifetime as it's the same as device itself (i.o.w. the same as the IIO device container)

Curious if there isn't a devm_strdup(name) or similar? Main point is that %pfwP seems like magic when fwnode_get_name is not (but returns a const string that we cannot modify).

The devm_kstrdup(fwnode_get_name()) is an open coded variant of the above. I don't think we need to open code and produce NIH even a single API. And no, there is no magic behind that. At least from the fwnode point of view.

You may very well say that > 1500 instances of "%pOF" is a magic...

Quoted 2 lines

If there is not, let's stick with
devm_kasprintf().

There is, but I'm against it. See above why.

Quoted 10 lines
Quoted 6 lines
Quoted 3 lines

drivers/iio/adc/qcom-spmi-adc5.c static int adc5_get_fw_channel_data(struct adc5_chip *adc, · line 643

Quoted 1 line
drivers/iio/adc/qcom-spmi-adc5.c +1 -0
+	name[strchrnul(name, '@') - name] = '\0';

This is the same as *strchrnul(name, '@') = '\0'; if I'm not mistaken.

Yes, But it's harder to read and understand. I believe the compiler has enough power to optimize this to the same assembly code.

I find the latter clearer as it doesn't require the reader to figure out that name - name cancels itself out. Alternatively we can write strchrnul(name, '@')[0].

I don't like to have Pythonisms in the C code, really.

P.S. I guess this little patch already emptied my bandwidth, so I leave any further discussion to you and IIO maintainers. Thank you for the review!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#5 lore raw

On 2023-01-18 16:29:24, Andy Shevchenko wrote:
...

Quoted 5 lines

The devm_kstrdup(fwnode_get_name()) is an open coded variant of the above. I don't think we need to open code and produce NIH even a single API. And no, there is no magic behind that. At least from the fwnode point of view.

You may very well say that > 1500 instances of "%pOF" is a magic...

Forgive me for not having a clear definition of "open coding" in mind (showing a different way of implementing something, compared to the "status quo" that I was not yet aware of?), nor knowing what NIH is supposed to mean in this context. We're in bike-shedding territory anyway, guess I should just bookmark the page that details all the many % format strings available.

...

Quoted 9 lines
Quoted 3 lines

I find the latter clearer as it doesn't require the reader to figure out that name - name cancels itself out. Alternatively we can write strchrnul(name, '@')[0].

I don't like to have Pythonisms in the C code, really.

P.S. I guess this little patch already emptied my bandwidth, so I leave any further discussion to you and IIO maintainers. Thank you for the review!

Just soaking up kernel coding standards here :)

- Marijn

#6 lore raw
Quoted 1 line · Marijn Suijten

On 2023-01-18 16:29:24, Andy Shevchenko wrote:

...

Quoted 10 lines
Quoted 5 lines

The devm_kstrdup(fwnode_get_name()) is an open coded variant of the above. I don't think we need to open code and produce NIH even a single API. And no, there is no magic behind that. At least from the fwnode point of view.

You may very well say that > 1500 instances of "%pOF" is a magic...

Forgive me for not having a clear definition of "open coding" in mind (showing a different way of implementing something, compared to the "status quo" that I was not yet aware of?), nor knowing what NIH is supposed to mean in this context.

"open coding" means to have a copy of the function of macro that is already implemented and available (even if it's private to some driver or module, we always can move it to the generic module and header).

NIH: Not Invented Here.

Quoted 3 lines

We're in bike-shedding territory
anyway, guess I should just bookmark the page that details all the many % format strings available.

True :-)

...

Quoted 11 lines
Quoted 9 lines
Quoted 3 lines

I find the latter clearer as it doesn't require the reader to figure out that name - name cancels itself out. Alternatively we can write strchrnul(name, '@')[0].

I don't like to have Pythonisms in the C code, really.

P.S. I guess this little patch already emptied my bandwidth, so I leave any further discussion to you and IIO maintainers. Thank you for the review!

Just soaking up kernel coding standards here :)

Right.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#7 lore raw
In reply to Andy Shevchenko
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

Mostly I want to be sure they know this exists before it causes surprise.

Jonathan

Quoted 31 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
 				    struct fwnode_handle *fwnode,
 				    const struct adc5_data *data)
 {
-	const char *name = fwnode_get_name(fwnode), *channel_name;
+	const char *channel_name;
+	char *name;
 	u32 chan, value, varr[2];
 	u32 sid = 0;
 	int ret;
 	struct device *dev = adc->dev;
 
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+	if (!name)
+		return -ENOMEM;
+
+	/* Cut the address part */
+	name[strchrnul(name, '@') - name] = '\0';
+
 	ret = fwnode_property_read_u32(fwnode, "reg", &chan);
 	if (ret) {
 		dev_err(dev, "invalid channel number %s\n", name);
#8 lore raw
Quoted 9 lines · Jonathan Cameron
Quoted 6 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Quoted 7 lines
Quoted 3 lines
Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

Hmm... But this is to fix the ABI breakage. It means that the previous series by Nuno had broken it.

Quoted 1 line

Mostly I want to be sure they know this exists before it causes surprise.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#9 lore raw
Quoted 14 lines · On Mon, 23 Jan 2023 14:02:51 +0200 Andy Shevchenko…
Quoted 13 lines · Jonathan Cameron
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")
Quoted 6 lines
Quoted 3 lines

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

Hmm... But this is to fix the ABI breakage. It means that the previous series by Nuno had broken it.

Absolutely agree. I plan to take the change. The risk that someone needs to fix up their use of the broken ABI makes it worth a little more shouting about than if we had caught it sooner.

Jonathan

Quoted 3 lines
Quoted 2 lines

Mostly I want to be sure they know this exists before it causes surprise.

#10 lore raw
In reply to Jonathan Cameron
Quoted 9 lines · Jonathan Cameron
Quoted 6 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Quoted 7 lines
Quoted 3 lines
Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Konrad

Quoted 37 lines

Mostly I want to be sure they know this exists before it causes surprise.

Jonathan

Quoted 31 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
 				    struct fwnode_handle *fwnode,
 				    const struct adc5_data *data)
 {
-	const char *name = fwnode_get_name(fwnode), *channel_name;
+	const char *channel_name;
+	char *name;
 	u32 chan, value, varr[2];
 	u32 sid = 0;
 	int ret;
 	struct device *dev = adc->dev;
 
+	name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+	if (!name)
+		return -ENOMEM;
+
+	/* Cut the address part */
+	name[strchrnul(name, '@') - name] = '\0';
+
 	ret = fwnode_property_read_u32(fwnode, "reg", &chan);
 	if (ret) {
 		dev_err(dev, "invalid channel number %s\n", name);
#11 lore raw
Quoted 14 lines · Konrad Dybcio
Quoted 13 lines · Jonathan Cameron
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")
Quoted 8 lines
Quoted 3 lines

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Can you clarify "old names"? The ABI-broken ones after Nuno's patch with @xx suffix, or the orignal names (without @xx) before that, which this patch from Andy reverts back to?

- Marijn

#12 lore raw
Quoted 20 lines · Marijn Suijten
Quoted 19 lines · Konrad Dybcio
Quoted 9 lines · Jonathan Cameron
Quoted 6 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Quoted 7 lines
Quoted 3 lines
Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Quoted 7 lines
Quoted 3 lines

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Can you clarify "old names"? The ABI-broken ones after Nuno's patch with @xx suffix, or the orignal names (without @xx) before that, which this patch from Andy reverts back to?

Nuno's patch names, this is a fix for that but in a very unfortunate event, they might have started using sysfs paths right when the breakage happened.

Konrad

Quoted 2 lines

- Marijn

#13 lore raw
In reply to Konrad Dybcio

Hi,

Quoted 15 lines · Konrad Dybcio
Quoted 13 lines · Jonathan Cameron
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")
Quoted 8 lines
Quoted 3 lines

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Thanks for the CC. I _think_ the only place we use these ADCs is for certain thermistors and I think that those are all just hooked up in the device tree, so the channel name doesn't matter. I'll also note that no Qualcomm Chromebooks are shipping with anything newer than kernel 5.15 right now, and (I checked) the ChromeOS 5.15 tree doesn't have commit 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties"). Thus, even if I'm wrong and the name is used someplace hidden then the "old" name would be better for us. I haven't tested the patch myself, but it sounds as if ${SUBJECT} patch is actually moving us back to the old name.

+Matthias to keep me honest since he's spent more time with the ADCs.

Quoted 38 lines

Konrad

Quoted 37 lines

Mostly I want to be sure they know this exists before it causes surprise.

Jonathan

Quoted 31 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
                                 struct fwnode_handle *fwnode,
                                 const struct adc5_data *data)
 {
-    const char *name = fwnode_get_name(fwnode), *channel_name;
+    const char *channel_name;
+    char *name;
     u32 chan, value, varr[2];
     u32 sid = 0;
     int ret;
     struct device *dev = adc->dev;
 
+    name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+    if (!name)
+            return -ENOMEM;
+
+    /* Cut the address part */
+    name[strchrnul(name, '@') - name] = '\0';
+
     ret = fwnode_property_read_u32(fwnode, "reg", &chan);
     if (ret) {
             dev_err(dev, "invalid channel number %s\n", name);
#14 lore raw
Quoted 38 lines · Doug Anderson

Hi,

Quoted 15 lines · Konrad Dybcio
Quoted 13 lines · Jonathan Cameron
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")
Quoted 8 lines
Quoted 3 lines

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Thanks for the CC. I _think_ the only place we use these ADCs is for certain thermistors and I think that those are all just hooked up in the device tree, so the channel name doesn't matter. I'll also note that no Qualcomm Chromebooks are shipping with anything newer than kernel 5.15 right now, and (I checked) the ChromeOS 5.15 tree doesn't have commit 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties"). Thus, even if I'm wrong and the name is used someplace hidden then the "old" name would be better for us. I haven't tested the patch myself, but it sounds as if ${SUBJECT} patch is actually moving us back to the old name.

Quoted 1 line

+Matthias to keep me honest since he's spent more time with the ADCs.

Agreed that the channel name doesn't matter, Chrome OS currently only uses the ADCs for thermal zones controlled by the kernel.

Quoted 36 lines
Quoted 36 lines
Quoted 36 lines

Mostly I want to be sure they know this exists before it causes surprise.

Jonathan

Quoted 31 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
                                 struct fwnode_handle *fwnode,
                                 const struct adc5_data *data)
 {
-    const char *name = fwnode_get_name(fwnode), *channel_name;
+    const char *channel_name;
+    char *name;
     u32 chan, value, varr[2];
     u32 sid = 0;
     int ret;
     struct device *dev = adc->dev;
 
+    name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+    if (!name)
+            return -ENOMEM;
+
+    /* Cut the address part */
+    name[strchrnul(name, '@') - name] = '\0';
+
     ret = fwnode_property_read_u32(fwnode, "reg", &chan);
     if (ret) {
             dev_err(dev, "invalid channel number %s\n", name);
maintainer Applied
#15 lore raw
Quoted 39 lines · On Wed, 25 Jan 2023 19:39:46 +0000 Matthias Kaehlcke <[email protected]> wrote:
Quoted 38 lines · Doug Anderson

Hi,

Quoted 15 lines · Konrad Dybcio
Quoted 13 lines · Jonathan Cameron
Quoted 9 lines · On Wed, 18 Jan 2023 12:06:23 +0200 Andy Shevchenko…

The node name can contain an address part which is unused by the driver. Moreover, this string is propagated into the userspace label, sysfs filenames *and breaking ABI*.

Cut the address part out before assigning the channel name.

Fixes 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties")
Quoted 8 lines
Quoted 3 lines

LGTM, but given it will have ABI impact, I'd like to hear from Andy, Bjorn or Konrad as maintainers and /or Dmitry as someone who has touched this driver fairly recently.

+ Doug

Unless the Chromium folks relied on the old names (they're the only ones I can think of that actually could have tapped into this), I say green light!

Thanks for the CC. I _think_ the only place we use these ADCs is for certain thermistors and I think that those are all just hooked up in the device tree, so the channel name doesn't matter. I'll also note that no Qualcomm Chromebooks are shipping with anything newer than kernel 5.15 right now, and (I checked) the ChromeOS 5.15 tree doesn't have commit 4f47a236a23d ("iio: adc: qcom-spmi-adc5: convert to device properties"). Thus, even if I'm wrong and the name is used someplace hidden then the "old" name would be better for us. I haven't tested the patch myself, but it sounds as if ${SUBJECT} patch is actually moving us back to the old name.

Quoted 4 lines
Quoted 1 line

+Matthias to keep me honest since he's spent more time with the ADCs.

Agreed that the channel name doesn't matter, Chrome OS currently only uses the ADCs for thermal zones controlled by the kernel.

Great. Thanks for all the info.

Applied to the fixes-togreg branch of iio.git and marked for stable.

Jonathan

Quoted 37 lines
Quoted 37 lines
Quoted 37 lines
Quoted 37 lines

Mostly I want to be sure they know this exists before it causes surprise.

Jonathan

Quoted 31 lines

---
v2: rephrased commit message (Marijn), fixed compilation issue (Marijin)

 drivers/iio/adc/qcom-spmi-adc5.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/iio/adc/qcom-spmi-adc5.c +9 -1
index e90c299c913a..c2d5e06f137a 100644
@@ -628,12 +628,20 @@ static int adc5_get_fw_channel_data(struct adc5_chip *adc,
                                 struct fwnode_handle *fwnode,
                                 const struct adc5_data *data)
 {
-    const char *name = fwnode_get_name(fwnode), *channel_name;
+    const char *channel_name;
+    char *name;
     u32 chan, value, varr[2];
     u32 sid = 0;
     int ret;
     struct device *dev = adc->dev;
 
+    name = devm_kasprintf(dev, GFP_KERNEL, "%pfwP", fwnode);
+    if (!name)
+            return -ENOMEM;
+
+    /* Cut the address part */
+    name[strchrnul(name, '@') - name] = '\0';
+
     ret = fwnode_property_read_u32(fwnode, "reg", &chan);
     if (ret) {
             dev_err(dev, "invalid channel number %s\n", name);