Skip to contentSkip to conversation

scsi: ufs: Fix regulator operations and remove "<name>-fixed-regulator" device tree property

PATCH RESEND In review Stanley Chu 3 participants 13 messages Mar 27, 2019 – Mar 28, 2019 6 messages not in the archive

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

v3 cover scsi: ufs: Fix regulator operations and remove "<name>-fixed-regulator" device tree property

Hi,

Resend this patch series for review.

This version (v3) fixed and added more details in commit messages, and added one patch to fix "undefined voltage range" issue as well.

This patch series fixes UFS regulator operations, including voltage and current (re-)configuration flow during UFS initialization and power mode switching.

In the end, remove "<name>-fixed-regulator" device tree property because it is not necessary anymore after these fixes.

V3:
- Fix and add more details in commit messages.
- Add one patch "scsi: ufs: Avoid configuring undefined voltage range on a regulator".

V2:
- Add two patches to prepare to and remove "<name>-fixed-regulator" device tree property.
- Add more details on patch "scsi: ufs: remove unused min_uA field in struct ufs_vreg" (Marc Gonzalez).

Stanley Chu (5):
scsi: ufs: Remove unused min_uA field in struct ufs_vreg
scsi: ufs: Avoid configuring regulator with undefined voltage range
scsi: ufs: Fix regulator load and icc-level configuration
scsi: ufs: Change "<name>-max-microamp" to non-mandatory property
scsi: ufs: Remove "<name>-fixed-regulator" device tree property

 drivers/scsi/ufs/ufs.h           |  1 -
 drivers/scsi/ufs/ufshcd-pltfrm.c | 14 +++-----------
 drivers/scsi/ufs/ufshcd.c        | 28 ++++++++++++++++++++--------
 3 files changed, 23 insertions(+), 20 deletions(-)
Signature · 1 line
2.18.0

A message that is not in the archive (sent off-list or not yet received): 1553680707-28579-1-git-send-email-stanley.chu-NuS5LvNUpcJWk0Htik3J/[email protected]

#2 lore raw

PATCH RESEND v3 1/5 scsi: ufs: Remove unused min_uA field in struct ufs_vreg

There are two fields related to regulator current limit in struct
ufs_vreg: "min_uA" and "max_uA".

"max_uA" is probed by "<name>-max-microamp" property from device tree and used for

- regulator_set_load operations, and
- icc_level configuration in device.

However "min_uA" field is not used anywhere, thus we can remove it.

---
 drivers/scsi/ufs/ufs.h           | 1 -
 drivers/scsi/ufs/ufshcd-pltfrm.c | 1 -
 2 files changed, 2 deletions(-)
drivers/scsi/ufs/ufs.h +0 -1
index 21e4ccb5ba6e..99a9c4d16f6b 100644
@@ -516,7 +516,6 @@ struct ufs_vreg {
 	bool enabled;
 	int min_uV;
 	int max_uV;
-	int min_uA;
 	int max_uA;
 };
 
drivers/scsi/ufs/ufshcd-pltfrm.c +0 -1
index 27213676329c..32cf8c56f029 100644
@@ -164,7 +164,6 @@ static int ufshcd_populate_vreg(struct device *dev, const char *name,
 		goto out;
 	}
 
-	vreg->min_uA = 0;
 	if (!strcmp(name, "vcc")) {
 		if (of_property_read_bool(np, "vcc-supply-1p8")) {
 			vreg->min_uV = UFS_VREG_VCC_1P8_MIN_UV;
Signature · 1 line
2.18.0
#3 lore raw

PATCH RESEND v3 2/5 scsi: ufs: Avoid configuring regulator with undefined voltage range

In reply to a message not in the archive

For regulators used by UFS, vcc, vccq and vccq2 will have voltage range initialized by ufshcd_populate_vreg(), however other regulators may have undefined voltage range if dt-bindings have no such definition.

In above undefined case, both "min_uV" and "max_uV" fields in ufs_vreg struct will be zero values and these values will be configured on regulators in different power modes.

Currently this may have no harm if both "min_uV" and "max_uV" always keep "zero values" because regulator_set_voltage() will always bypass such invalid values and return "good" results.

However improper values shall be fixed to avoid potential bugs. Simply bypass voltage configuration if voltage range is not defined.

---
 drivers/scsi/ufs/ufshcd.c | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)
drivers/scsi/ufs/ufshcd.c +8 -5
index e040f9dd9ff3..81d99aebb867 100644
@@ -7039,12 +7039,15 @@ static int ufshcd_config_vreg(struct device *dev,
 	name = vreg->name;
 
 	if (regulator_count_voltages(reg) > 0) {
-		min_uV = on ? vreg->min_uV : 0;
-		ret = regulator_set_voltage(reg, min_uV, vreg->max_uV);
-		if (ret) {
-			dev_err(dev, "%s: %s set voltage failed, err=%d\n",
+		if (vreg->min_uV && vreg->max_uV) {
+			min_uV = on ? vreg->min_uV : 0;
+			ret = regulator_set_voltage(reg, min_uV, vreg->max_uV);
+			if (ret) {
+				dev_err(dev,
+					"%s: %s set voltage failed, err=%d\n",
 					__func__, name, ret);
-			goto out;
+				goto out;
+			}
 		}
 
 		uA_load = on ? vreg->max_uA : 0;
Signature · 1 line
2.18.0

A message that is not in the archive (sent off-list or not yet received): 1553680707-28579-3-git-send-email-stanley.chu-NuS5LvNUpcJWk0Htik3J/[email protected]

Reviewed-by
#5 lore raw

RE: [PATCH RESEND v3 2/5] scsi: ufs: Avoid configuring regulator with undefined voltage range

Quoted 9 lines

For regulators used by UFS, vcc, vccq and vccq2 will have voltage range initialized by ufshcd_populate_vreg(), however other regulators may have undefined voltage range if dt-bindings have no such definition.

In above undefined case, both "min_uV" and "max_uV" fields in ufs_vreg struct will be zero values and these values will be configured on regulators in different power modes.

Quoted 8 lines

Currently this may have no harm if both "min_uV" and "max_uV" always keep "zero values" because regulator_set_voltage() will always bypass such invalid values and return "good" results.

However improper values shall be fixed to avoid potential bugs. Simply bypass voltage configuration if voltage range is not defined.

#6 lore raw

PATCH RESEND v3 3/5 scsi: ufs: Fix regulator load and icc-level configuration

In reply to a message not in the archive

Currently if a regulator has "<name>-fixed-regulator" property in device tree, it will skip current limit initialization. This lead to a zero "max_uA" value in struct ufs_vreg.

However, "regulator_set_load" operation shall be required on regulators which have valid current limits, otherwise a zero "max_uA" set by "regulator_set_load" may cause unexpected behavior when this regulator is enabled or set as high power mode.

Similarly, in device's icc_level configuration flow, the target icc_level shall be updated if regulator also has valid current limit, otherwise a wrong icc_level will be calculated by zero "max_uA" and thus causes unexpected results after it is written to device.

---
 drivers/scsi/ufs/ufshcd.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/scsi/ufs/ufshcd.c +12 -3
index 81d99aebb867..5ba49c8cd2a3 100644
@@ -6294,19 +6294,19 @@ static u32 ufshcd_find_max_sup_active_icc_level(struct ufs_hba *hba,
 		goto out;
 	}
 
-	if (hba->vreg_info.vcc)
+	if (hba->vreg_info.vcc && hba->vreg_info.vcc->max_uA)
 		icc_level = ufshcd_get_max_icc_level(
 				hba->vreg_info.vcc->max_uA,
 				POWER_DESC_MAX_ACTV_ICC_LVLS - 1,
 				&desc_buf[PWR_DESC_ACTIVE_LVLS_VCC_0]);
 
-	if (hba->vreg_info.vccq)
+	if (hba->vreg_info.vccq && hba->vreg_info.vccq->max_uA)
 		icc_level = ufshcd_get_max_icc_level(
 				hba->vreg_info.vccq->max_uA,
 				icc_level,
 				&desc_buf[PWR_DESC_ACTIVE_LVLS_VCCQ_0]);
 
-	if (hba->vreg_info.vccq2)
+	if (hba->vreg_info.vccq2 && hba->vreg_info.vccq2->max_uA)
 		icc_level = ufshcd_get_max_icc_level(
 				hba->vreg_info.vccq2->max_uA,
 				icc_level,
@@ -7004,6 +7004,15 @@ static int ufshcd_config_vreg_load(struct device *dev, struct ufs_vreg *vreg,
 	if (!vreg)
 		return 0;
 
+	/*
+	 * "set_load" operation shall be required on those regulators
+	 * which specifically configured current limitation. Otherwise
+	 * zero max_uA may cause unexpected behavior when regulator is
+	 * enabled or set as high power mode.
+	 */
+	if (!vreg->max_uA)
+		return 0;
+
 	ret = regulator_set_load(vreg->reg, ua);
 	if (ret < 0) {
 		dev_err(dev, "%s: %s set load (ua=%d) failed, err=%d\n",
Signature · 1 line
2.18.0

A message that is not in the archive (sent off-list or not yet received): 1553680707-28579-4-git-send-email-stanley.chu-NuS5LvNUpcJWk0Htik3J/[email protected]

Reviewed-by
#8 lore raw

RE: [PATCH RESEND v3 3/5] scsi: ufs: Fix regulator load and icc-level configuration

Quoted 10 lines

Currently if a regulator has "<name>-fixed-regulator" property in device tree, it will skip current limit initialization. This lead to a zero "max_uA" value in struct ufs_vreg.

However, "regulator_set_load" operation shall be required on regulators which have valid current limits, otherwise a zero "max_uA" set by "regulator_set_load" may cause unexpected behavior when this regulator is enabled or set as high power mode.

Quoted 6 lines

Similarly, in device's icc_level configuration flow, the target icc_level shall be updated if regulator also has valid current limit, otherwise a wrong icc_level will be calculated by zero "max_uA" and thus causes unexpected results after it is written to device.

#9 lore raw

PATCH RESEND v3 4/5 scsi: ufs: Change "<name>-max-microamp" to non-mandatory property

In reply to a message not in the archive

In dt-bindings for ufs, "<name>-max-microamp" property indicates current limit and is mandatory if "<name>-fixed-regulator" is not defined on a specified regulator.

However, in some platforms, regulators without "<name>-fixed-regulator" property may not need to define their current limit because they may want to define voltage range only for proper voltage switching in different power modes, especially for vcc, vccq or vccq2.

Currently missing "<name>-max-microamp" property in device tree will lead to initialization fail currently, thus such limitation shall be resolved to tolerate this kind of regulators.

After resolving this, regulators without "<name>-max-microamp" property will have undefined "max current" value, i.e., zero value in "max_uA" field in struct ufs_vreg. Because we do bypass current switching operation (by regulator_set_load) in case of undefined current limit, this patch shall be safe.

---
 drivers/scsi/ufs/ufshcd-pltfrm.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
drivers/scsi/ufs/ufshcd-pltfrm.c +3 -5
index 32cf8c56f029..2420e6962219 100644
@@ -157,11 +157,9 @@ static int ufshcd_populate_vreg(struct device *dev, const char *name,
 		goto out;
 
 	snprintf(prop_name, MAX_PROP_SIZE, "%s-max-microamp", name);
-	ret = of_property_read_u32(np, prop_name, &vreg->max_uA);
-	if (ret) {
-		dev_err(dev, "%s: unable to find %s err %d\n",
-				__func__, prop_name, ret);
-		goto out;
+	if (of_property_read_u32(np, prop_name, &vreg->max_uA)) {
+		dev_info(dev, "%s: unable to find %s\n", __func__, prop_name);
+		vreg->max_uA = 0;
 	}
 
 	if (!strcmp(name, "vcc")) {
Signature · 1 line
2.18.0

A message that is not in the archive (sent off-list or not yet received): 1553680707-28579-5-git-send-email-stanley.chu-NuS5LvNUpcJWk0Htik3J/[email protected]

Reviewed-by
#11 lore raw

RE: [PATCH RESEND v3 4/5] scsi: ufs: Change "<name>-max-microamp" to non-mandatory property

Quoted 5 lines

In dt-bindings for ufs, "<name>-max-microamp" property indicates current limit and is mandatory if "<name>-fixed-regulator" is not defined on a specified regulator.

Quoted 7 lines

However, in some platforms, regulators without "<name>-fixed-regulator" property may not need to define their current limit because they may want to define voltage range only for proper voltage switching in different power modes, especially for vcc, vccq or vccq2.

Currently missing "<name>-max-microamp" property in device tree will lead to initialization fail currently, thus such limitation shall be

lead initialization to fail, thus ...

Quoted 9 lines

resolved to tolerate this kind of regulators.

After resolving this, regulators without "<name>-max-microamp" property will have undefined "max current" value, i.e., zero value in "max_uA" field in struct ufs_vreg. Because we do bypass current switching operation (by regulator_set_load) in case of undefined current limit, this patch shall be safe.

You might want to cc some platform guys, e.g. Evan Green and/or Codeaurora guys, To take a look.

Thanks,
Avri

#12 lore raw

PATCH RESEND v3 5/5 scsi: ufs: Remove "<name>-fixed-regulator" device tree property

In reply to a message not in the archive

"<name>-fixed-regulator" device tree property can be safely removed because below things are fixed or resolved,

1. "<name>-max-microamp" becomes optional property: Undefined "<name>-max-microamp" will not cause initialization fail if "<name>-fixed-regulator" is not defined.

2. Current switching operation (by regulator_set_load) now has rules:
Regulators will have undefined current limit if "<name>-fixed-regulator" is not defined. But this is safe because only regulator which has configured current limit from "<name>-max-microamp" property is allowed to change its load.

Although "<name>-fixed-regulator" is not used in any dt-bindings in tree, this patch is still safe for regulators already defined "<name>-fixed-regulator". To be more clear, if a regulator defined "<name>-fixed-regulator" before, the behavior difference after this patch is,

1. "<name>-max-microamp":
If a regulator defined "<name>-fixed-regulator", it is not necessary to define "<name>-max-microamp" property in device tree and it is expected to have an undefined current limit, i.e., "max_uA" field is zero in struct ufs_vreg. This is exactly the same as patched.

2. "vcc-supply-1p8" or volatge range settings:
* For vcc, vccq or vccq2, these three regulators shall not define "<name>-fixed-regulator" because defining it will lead to undefined voltage range and thus voltage switching will be unexpected.
* For other regulators with undefined voltage range, voltage range will be still undefined after patched.

Therefore this patch is safe for all existed regulators with "<name>-fixed-regulator" property already defined.

---
 drivers/scsi/ufs/ufshcd-pltfrm.c | 5 -----
 1 file changed, 5 deletions(-)
drivers/scsi/ufs/ufshcd-pltfrm.c +0 -5
index 2420e6962219..7b404df965b2 100644
@@ -151,11 +151,6 @@ static int ufshcd_populate_vreg(struct device *dev, const char *name,
 
 	vreg->name = kstrdup(name, GFP_KERNEL);
 
-	/* if fixed regulator no need further initialization */
-	snprintf(prop_name, MAX_PROP_SIZE, "%s-fixed-regulator", name);
-	if (of_property_read_bool(np, prop_name))
-		goto out;
-
 	snprintf(prop_name, MAX_PROP_SIZE, "%s-max-microamp", name);
 	if (of_property_read_u32(np, prop_name, &vreg->max_uA)) {
 		dev_info(dev, "%s: unable to find %s\n", __func__, prop_name);
Signature · 1 line
2.18.0
#13 lore raw
In reply to a message not in the archive
Quoted 25 lines

Hi,

Resend this patch series for review.

This version (v3) fixed and added more details in commit messages, and added one patch to fix "undefined voltage range" issue as well.

This patch series fixes UFS regulator operations, including voltage and current (re-)configuration flow during UFS initialization and power mode switching.

In the end, remove "<name>-fixed-regulator" device tree property because it is not necessary anymore after these fixes.

V3:
- Fix and add more details in commit messages.
- Add one patch "scsi: ufs: Avoid configuring undefined voltage range on a regulator".

V2:
- Add two patches to prepare to and remove "<name>-fixed-regulator" device tree property.
- Add more details on patch "scsi: ufs: remove unused min_uA field in struct ufs_vreg" (Marc Gonzalez).

Quoted 7 lines

Stanley Chu (5):
scsi: ufs: Remove unused min_uA field in struct ufs_vreg
scsi: ufs: Avoid configuring regulator with undefined voltage range
scsi: ufs: Fix regulator load and icc-level configuration
scsi: ufs: Change "<name>-max-microamp" to non-mandatory property
scsi: ufs: Remove "<name>-fixed-regulator" device tree property

This series looks good to me, but better get acked-by from couple of platform guys as well.

Thanks,
Avri

A message that is not in the archive (sent off-list or not yet received): SN6PR04MB49250E97111EB8975E0ED7EFFC580-UKdxhu0+N/[email protected]

#15 lore raw

Hi Avri,

Quoted 24 lines · Avri Altman
Quoted 24 lines

Hi,

Resend this patch series for review.

This version (v3) fixed and added more details in commit messages, and added one patch to fix "undefined voltage range" issue as well.

This patch series fixes UFS regulator operations, including voltage and current (re-)configuration flow during UFS initialization and power mode switching.

In the end, remove "<name>-fixed-regulator" device tree property because it is not necessary anymore after these fixes.

V3:
- Fix and add more details in commit messages.
- Add one patch "scsi: ufs: Avoid configuring undefined voltage range on a regulator".

V2:
- Add two patches to prepare to and remove "<name>-fixed-regulator" device tree property.
- Add more details on patch "scsi: ufs: remove unused min_uA field in struct ufs_vreg" (Marc Gonzalez).

Quoted 8 lines
Quoted 7 lines

Stanley Chu (5):
scsi: ufs: Remove unused min_uA field in struct ufs_vreg
scsi: ufs: Avoid configuring regulator with undefined voltage range
scsi: ufs: Fix regulator load and icc-level configuration
scsi: ufs: Change "<name>-max-microamp" to non-mandatory property
scsi: ufs: Remove "<name>-fixed-regulator" device tree property

This series looks good to me, but better get acked-by from couple of platform guys as well.

Thanks so much for review.

I'll fix commit message and invite more reviewers in next version.

Quoted 4 lines

Thanks,
Avri

Thanks,
Stanley

Acked-by
#16 lore raw
In reply to a message not in the archive

Hi Stanley,
Please collect all the {review/acked}-by tags when reposting so that people are aware which all patches need to review.
https://www.spinics.net/lists/linux-scsi/msg128818.html
This series looks good, it will be if we get a Tested-by as well. For this series

Quoted 34 lines · Stanley Chu

Hi,

Resend this patch series for review.

This version (v3) fixed and added more details in commit messages, and added one patch to fix "undefined voltage range" issue as well.

This patch series fixes UFS regulator operations, including voltage and current (re-)configuration flow during UFS initialization and power mode switching.

In the end, remove "<name>-fixed-regulator" device tree property because it is not necessary anymore after these fixes.

V3:
- Fix and add more details in commit messages.
- Add one patch "scsi: ufs: Avoid configuring undefined voltage range on a regulator".

V2:
- Add two patches to prepare to and remove "<name>-fixed-regulator" device tree property.
- Add more details on patch "scsi: ufs: remove unused min_uA field in struct ufs_vreg" (Marc Gonzalez).

Stanley Chu (5):
scsi: ufs: Remove unused min_uA field in struct ufs_vreg
scsi: ufs: Avoid configuring regulator with undefined voltage range
scsi: ufs: Fix regulator load and icc-level configuration
scsi: ufs: Change "<name>-max-microamp" to non-mandatory property
scsi: ufs: Remove "<name>-fixed-regulator" device tree property

 drivers/scsi/ufs/ufs.h           |  1 -
 drivers/scsi/ufs/ufshcd-pltfrm.c | 14 +++-----------
 drivers/scsi/ufs/ufshcd.c        | 28 ++++++++++++++++++++--------
 3 files changed, 23 insertions(+), 20 deletions(-)

--
2.18.0

Signature · 2 lines
Regards,
Alim

A message that is not in the archive (sent off-list or not yet received): CAGOxZ51zdtoLz=E_vmpwt+2wTJq32yUQa=h_OiV7qO1N-c=NUA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#18 lore raw

Hi Alim,

Quoted 4 lines · Alim Akhtar

Hi Stanley,
Please collect all the {review/acked}-by tags when reposting so that people are aware which all patches need to review.
https://www.spinics.net/lists/linux-scsi/msg128818.html

Sorry it's my mistake to miss some tags in reposted patch. Will fix it in next version.

Quoted 3 lines

This series looks good, it will be if we get a Tested-by as well. For this series

Thanks so much for review.

Quoted 28 lines · Stanley Chu
Quoted 26 lines

Hi,

Resend this patch series for review.

This version (v3) fixed and added more details in commit messages, and added one patch to fix "undefined voltage range" issue as well.

This patch series fixes UFS regulator operations, including voltage and current (re-)configuration flow during UFS initialization and power mode switching.

In the end, remove "<name>-fixed-regulator" device tree property because it is not necessary anymore after these fixes.

V3:
- Fix and add more details in commit messages.
- Add one patch "scsi: ufs: Avoid configuring undefined voltage range on a regulator".

V2:
- Add two patches to prepare to and remove "<name>-fixed-regulator" device tree property.
- Add more details on patch "scsi: ufs: remove unused min_uA field in struct ufs_vreg" (Marc Gonzalez).

Stanley Chu (5):
scsi: ufs: Remove unused min_uA field in struct ufs_vreg
scsi: ufs: Avoid configuring regulator with undefined voltage range
scsi: ufs: Fix regulator load and icc-level configuration
scsi: ufs: Change "<name>-max-microamp" to non-mandatory property
scsi: ufs: Remove "<name>-fixed-regulator" device tree property

Quoted 10 lines
Quoted 8 lines
 drivers/scsi/ufs/ufs.h           |  1 -
 drivers/scsi/ufs/ufshcd-pltfrm.c | 14 +++-----------
 drivers/scsi/ufs/ufshcd.c        | 28 ++++++++++++++++++++--------
 3 files changed, 23 insertions(+), 20 deletions(-)

--
2.18.0

Thanks,
Stanley