Skip to contentSkip to conversation

regulator: core: use regulator name for sysfs

PATCH In review Shawn Joo 3 participants 5 messages Feb 21, 2013 Voltage and current regulator framework

lore
Share & tools
lore

Shawn Joo

author
#0 lore raw

PATCH 1/1 regulator: core: use regulator name for sysfs

regulator is named by numbering on sysfs, e.g. regulator.0, regulator.1 it confuses to find desired regulator before counting the order. add option for regulator name by use_name_onsysfs.
if it is true and name is not NULL, desc's name will be the name. e.g. if name in desc is "LDO0", then regulator.LDO0 on sysfs. otherwise it follows origin.

---
 drivers/regulator/core.c         |    7 ++++++-
 include/linux/regulator/driver.h |    1 +
 2 files changed, 7 insertions(+), 1 deletions(-)
drivers/regulator/core.c +6 -1
index 2785843..4dde54d 100644
@@ -3399,7 +3399,12 @@ regulator_register(const struct regulator_desc *regulator_desc,
 	rdev->dev.class = &regulator_class;
 	rdev->dev.of_node = config->of_node;
 	rdev->dev.parent = dev;
-	dev_set_name(&rdev->dev, "regulator.%d",
+	if (regulator_desc->use_name_onsysfs &&
+			regulator_desc->name != NULL)
+		dev_set_name(&rdev->dev, "regulator.%s",
+			regulator_desc->name);
+	else
+		dev_set_name(&rdev->dev, "regulator.%d",
 		     atomic_inc_return(&regulator_no) - 1);
 	ret = device_register(&rdev->dev);
 	if (ret != 0) {
include/linux/regulator/driver.h +1 -0
index d10bb0f..597f8dd 100644
@@ -224,6 +224,7 @@ struct regulator_desc {
 	unsigned int bypass_mask;
 
 	unsigned int enable_time;
+	bool use_name_onsysfs;
 };
 
 /**
Signature · 1 line
1.7.0.4
#1 lore raw
Quoted 6 lines · Shawn Joo

regulator is named by numbering on sysfs, e.g. regulator.0, regulator.1 it confuses to find desired regulator before counting the order. add option for regulator name by use_name_onsysfs.
if it is true and name is not NULL, desc's name will be the name. e.g. if name in desc is "LDO0", then regulator.LDO0 on sysfs. otherwise it follows origin.

Does it make sense to make this change always, rather than based on some new flag in regulator_desc?

Another place a similar change might be useful is debugfs.

#2 lore raw
Quoted 11 lines · Stephen Warren
Quoted 6 lines · Shawn Joo

regulator is named by numbering on sysfs, e.g. regulator.0, regulator.1 it confuses to find desired regulator before counting the order. add option for regulator name by use_name_onsysfs.
if it is true and name is not NULL, desc's name will be the name. e.g. if name in desc is "LDO0", then regulator.LDO0 on sysfs. otherwise it follows origin.

Does it make sense to make this change always, rather than based on some new flag in regulator_desc?

It's certainly insane to change this based on the driver and given that sysfs is supposed to be an ABI it's questionable if we should do it at all. We certainly can't use the descriptor name as that's very likely to clash if you have more than one PMIC. Taking a glance through sysfs on my system what we're doing at the minute is pretty idiomatic, sysfs isn't really intended for humans but rather for machines to prettify.

Quoted 1 line

Another place a similar change might be useful is debugfs.

debugfs already uses more human readable names, it uses the supply name (which is what we should be using if we were going to do anything as it really ought to be unique already).

#3 lore raw
Quoted 13 lines · Mark Brown
Quoted 11 lines · Stephen Warren
Quoted 6 lines · Shawn Joo

regulator is named by numbering on sysfs, e.g. regulator.0, regulator.1 it confuses to find desired regulator before counting the order. add option for regulator name by use_name_onsysfs. if it is true and name is not NULL, desc's name will be the name. e.g. if name in desc is "LDO0", then regulator.LDO0 on sysfs. otherwise it follows origin.

Does it make sense to make this change always, rather than based on some new flag in regulator_desc?

Quoted 7 lines

It's certainly insane to change this based on the driver and given that sysfs is supposed to be an ABI it's questionable if we should do it at all. We certainly can't use the descriptor name as that's very likely to clash if you have more than one PMIC. Taking a glance through sysfs on my system what we're doing at the minute is pretty idiomatic, sysfs isn't really intended for humans but rather for machines to prettify.

Does the ABI describe just the layout of the sysfs filesystem, or also the names of instances? Certainly the list of names of regulators won't be in any ABI documentation. That said, I suppose for existing platforms it'd probably be legitimate for someone to have looked there and seen the names and assumed they would never change on that particular platform, so changing them would break an implicit ABI.

Quoted 5 lines
Quoted 1 line

Another place a similar change might be useful is debugfs.

debugfs already uses more human readable names, it uses the supply name (which is what we should be using if we were going to do anything as it really ought to be unique already).

Oh so it does. Was this a recent change? I could have sworn I saw lots of regulator.n there, but perhaps I'm remembering sysfs.

#4 lore raw
Quoted 10 lines · Stephen Warren
Quoted 7 lines · Mark Brown

It's certainly insane to change this based on the driver and given that sysfs is supposed to be an ABI it's questionable if we should do it at all. We certainly can't use the descriptor name as that's very likely to clash if you have more than one PMIC. Taking a glance through sysfs on my system what we're doing at the minute is pretty idiomatic, sysfs isn't really intended for humans but rather for machines to prettify.

Quoted 2 lines

Does the ABI describe just the layout of the sysfs filesystem, or also the names of instances? Certainly the list of names of regulators

Turns out we didn't bother documenting the directory naming.

Quoted 4 lines

won't be in any ABI documentation. That said, I suppose for existing platforms it'd probably be legitimate for someone to have looked there and seen the names and assumed they would never change on that particular platform, so changing them would break an implicit ABI.

Indeed, plus the information is all there. Like I say the current pattern seems idiomatic for sysfs but really the issue with the current patch is the per driver thing which just doesn't make sense.

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

Another place a similar change might be useful is debugfs.

debugfs already uses more human readable names, it uses the supply name (which is what we should be using if we were going to do anything as it really ought to be unique already).

Oh so it does. Was this a recent change? I could have sworn I saw lots of regulator.n there, but perhaps I'm remembering sysfs.

It's always been the same.