Skip to contentSkip to conversation

hwmon: (pmbus/core): Implement regulator get_status

PATCH Superseded Naresh Solanki 2 participants 3 messages Nov 24, 2022 Hardware monitoring

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 1/1 hwmon: (pmbus/core): Implement regulator get_status

From: Patrick Rudolph <[email protected]>

Add get_status for pmbus_regulator_ops.

---
Changes:
- use lock throughout the function
- Avoid line continuation upto 100 column
- Optimize use of & and | operator
- Check for VOUT, IOUT, TEMPERATURE bit in status word before checking respective status register for fault.
- Report regulator current status.
- Utilize get_error_flag to check for regulator errors.
- Check for return value of function get_error_flag

---
 drivers/hwmon/pmbus/pmbus_core.c | 44 ++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
drivers/hwmon/pmbus/pmbus_core.c +44 -0
index 20ca26e19db7..0b13214c662f 100644
@@ -2855,6 +2855,49 @@ static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned
 	return 0;
 }
 
+static int pmbus_regulator_get_status(struct regulator_dev *rdev)
+{
+	struct device *dev = rdev_get_dev(rdev);
+	struct i2c_client *client = to_i2c_client(dev->parent);
+	struct pmbus_data *data = i2c_get_clientdata(client);
+	u8 page = rdev_get_id(rdev);
+	int status, ret;
+
+	mutex_lock(&data->update_lock);
+	status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
+	if (status < 0) {
+		ret = status;
+		goto unlock;
+	}
+
+	if (status & PB_STATUS_OFF) {
+		ret = REGULATOR_STATUS_OFF;
+		goto unlock;
+	}
+
+	/* If regulator is ON & reports power good then return ON */
+	if (!(status & PB_STATUS_POWER_GOOD_N)) {
+		ret = REGULATOR_STATUS_ON;
+		goto unlock;
+	}
+
+	if (rdev->desc->ops->get_error_flags) {
+		ret = rdev->desc->ops->get_error_flags(rdev, &status);
+		if (ret)
+			goto unlock;
+
+		if (status & (REGULATOR_ERROR_UNDER_VOLTAGE | REGULATOR_ERROR_OVER_CURRENT |
+		   REGULATOR_ERROR_REGULATION_OUT | REGULATOR_ERROR_FAIL |
+		   REGULATOR_ERROR_OVER_TEMP))
+			ret = REGULATOR_STATUS_ERROR;
+	} else
+		ret = REGULATOR_STATUS_UNDEFINED;
+
+unlock:
+	mutex_unlock(&data->update_lock);
+	return ret;
+}
+
 static int pmbus_regulator_get_low_margin(struct i2c_client *client, int page)
 {
 	struct pmbus_data *data = i2c_get_clientdata(client);
@@ -2995,6 +3038,7 @@ const struct regulator_ops pmbus_regulator_ops = {
 	.disable = pmbus_regulator_disable,
 	.is_enabled = pmbus_regulator_is_enabled,
 	.get_error_flags = pmbus_regulator_get_error_flags,
+	.get_status = pmbus_regulator_get_status,
 	.get_voltage = pmbus_regulator_get_voltage,
 	.set_voltage = pmbus_regulator_set_voltage,
 	.list_voltage = pmbus_regulator_list_voltage,

base-commit: 2c71b3246ec3246522e8cb7c8191dc7a5d62cc70

Signature · 1 line
2.37.3
maintainer
#1 lore raw
Quoted 46 lines · Naresh Solanki

From: Patrick Rudolph <[email protected]>

Add get_status for pmbus_regulator_ops.

---
Changes:
- use lock throughout the function
- Avoid line continuation upto 100 column
- Optimize use of & and | operator
- Check for VOUT, IOUT, TEMPERATURE bit in status word before checking respective status register for fault.
- Report regulator current status.
- Utilize get_error_flag to check for regulator errors.
- Check for return value of function get_error_flag

---
  drivers/hwmon/pmbus/pmbus_core.c | 44 ++++++++++++++++++++++++++++++++
  1 file changed, 44 insertions(+)
drivers/hwmon/pmbus/pmbus_core.c +17 -0
index 20ca26e19db7..0b13214c662f 100644
@@ -2855,6 +2855,49 @@ static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned
  	return 0;
  }
 
+static int pmbus_regulator_get_status(struct regulator_dev *rdev)
+{
+	struct device *dev = rdev_get_dev(rdev);
+	struct i2c_client *client = to_i2c_client(dev->parent);
+	struct pmbus_data *data = i2c_get_clientdata(client);
+	u8 page = rdev_get_id(rdev);
+	int status, ret;
+
+	mutex_lock(&data->update_lock);
+	status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
+	if (status < 0) {
+		ret = status;
+		goto unlock;
+	}
+
+	if (status & PB_STATUS_OFF) {
+		ret = REGULATOR_STATUS_OFF;

drivers/hwmon/pmbus/pmbus_core.c static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned · line 2884

Quoted 10 lines
drivers/hwmon/pmbus/pmbus_core.c +10 -0
+		goto unlock;
+	}
+
+	/* If regulator is ON & reports power good then return ON */
+	if (!(status & PB_STATUS_POWER_GOOD_N)) {
+		ret = REGULATOR_STATUS_ON;
+		goto unlock;
+	}
+
+	if (rdev->desc->ops->get_error_flags) {

Looking into this again, why is this check necessary ? Isn't this the regulator_ops from below ? Also, why not just call pmbus_regulator_get_error_flags() directly ?

drivers/hwmon/pmbus/pmbus_core.c static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned · line 2892

Quoted 8 lines
drivers/hwmon/pmbus/pmbus_core.c +8 -0
+		ret = rdev->desc->ops->get_error_flags(rdev, &status);
+		if (ret)
+			goto unlock;
+
+		if (status & (REGULATOR_ERROR_UNDER_VOLTAGE | REGULATOR_ERROR_OVER_CURRENT |
+		   REGULATOR_ERROR_REGULATION_OUT | REGULATOR_ERROR_FAIL |
+		   REGULATOR_ERROR_OVER_TEMP))
+			ret = REGULATOR_STATUS_ERROR;

If the condition above is false, the return value will be 0, or REGULATOR_STATUS_OFF. Is that intentional ?

drivers/hwmon/pmbus/pmbus_core.c static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned · line 2895

Quoted 3 lines
drivers/hwmon/pmbus/pmbus_core.c +3 -0
+	} else
+		ret = REGULATOR_STATUS_UNDEFINED;
+

CHECK: braces {} should be used on all arms of this statement #72: FILE: drivers/hwmon/pmbus/pmbus_core.c:2884:
+ if (rdev->desc->ops->get_error_flags) {
[...]
+ } else

Guenter

Quoted 18 lines
drivers/hwmon/pmbus/pmbus_core.c +6 -0
+unlock:
+	mutex_unlock(&data->update_lock);
+	return ret;
+}
+
  static int pmbus_regulator_get_low_margin(struct i2c_client *client, int page)
  {
  	struct pmbus_data *data = i2c_get_clientdata(client);
@@ -2995,6 +3038,7 @@ const struct regulator_ops pmbus_regulator_ops = {
  	.disable = pmbus_regulator_disable,
  	.is_enabled = pmbus_regulator_is_enabled,
  	.get_error_flags = pmbus_regulator_get_error_flags,
+	.get_status = pmbus_regulator_get_status,
  	.get_voltage = pmbus_regulator_get_voltage,
  	.set_voltage = pmbus_regulator_set_voltage,
  	.list_voltage = pmbus_regulator_list_voltage,

base-commit: 2c71b3246ec3246522e8cb7c8191dc7a5d62cc70

#2 lore raw
Quoted 53 lines · Guenter Roeck
Quoted 52 lines · Naresh Solanki

From: Patrick Rudolph <[email protected]>

Add get_status for pmbus_regulator_ops.

---
Changes:
- use lock throughout the function
- Avoid line continuation upto 100 column
- Optimize use of & and | operator
- Check for VOUT, IOUT, TEMPERATURE bit in status word before checking respective status register for fault.
- Report regulator current status.
- Utilize get_error_flag to check for regulator errors.
- Check for return value of function get_error_flag

---
  drivers/hwmon/pmbus/pmbus_core.c | 44 ++++++++++++++++++++++++++++++++

  1 file changed, 44 insertions(+)
drivers/hwmon/pmbus/pmbus_core.c +0 -0
index 20ca26e19db7..0b13214c662f 100644
@@ -2855,6 +2855,49 @@ static int 

pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned return 0;
  }

drivers/hwmon/pmbus/pmbus_core.c +23 -0
+static int pmbus_regulator_get_status(struct regulator_dev *rdev)
+{
+    struct device *dev = rdev_get_dev(rdev);
+    struct i2c_client *client = to_i2c_client(dev->parent);
+    struct pmbus_data *data = i2c_get_clientdata(client);
+    u8 page = rdev_get_id(rdev);
+    int status, ret;
+
+    mutex_lock(&data->update_lock);
+    status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
+    if (status < 0) {
+        ret = status;
+        goto unlock;
+    }
+
+    if (status & PB_STATUS_OFF) {
+        ret = REGULATOR_STATUS_OFF;
+        goto unlock;
+    }
+
+    /* If regulator is ON & reports power good then return ON */
+    if (!(status & PB_STATUS_POWER_GOOD_N)) {
+        ret = REGULATOR_STATUS_ON;
Quoted 8 lines
Quoted 4 lines

+        goto unlock;
+    }
+
+    if (rdev->desc->ops->get_error_flags) {

Looking into this again, why is this check necessary ? Isn't this the regulator_ops from below ? Also, why not just call pmbus_regulator_get_error_flags() directly ?

Yes. Felt that to be the right way.
Will update to do pmbus_regulator_get)error_flags directly

Quoted 11 lines
Quoted 10 lines

+        ret = rdev->desc->ops->get_error_flags(rdev, &status); +        if (ret)
+            goto unlock;
+
+        if (status & (REGULATOR_ERROR_UNDER_VOLTAGE | REGULATOR_ERROR_OVER_CURRENT |
+           REGULATOR_ERROR_REGULATION_OUT | REGULATOR_ERROR_FAIL | +           REGULATOR_ERROR_OVER_TEMP))
+            ret = REGULATOR_STATUS_ERROR;

Quoted 2 lines

If the condition above is false, the return value will be 0, or REGULATOR_STATUS_OFF. Is that intentional ?

No. It should be REGULATOR_ERR_UNDEFINED. will fix in next revision.

Quoted 30 lines
Quoted 4 lines

+    } else
+        ret = REGULATOR_STATUS_UNDEFINED;
+

CHECK: braces {} should be used on all arms of this statement #72: FILE: drivers/hwmon/pmbus/pmbus_core.c:2884:
+    if (rdev->desc->ops->get_error_flags) {
[...]
+    } else

Guenter

Quoted 17 lines
drivers/hwmon/pmbus/pmbus_core.c +5 -0
+unlock:
+    mutex_unlock(&data->update_lock);
+    return ret;
+}
+

  static int pmbus_regulator_get_low_margin(struct i2c_client *client, int page) {
      struct pmbus_data *data = i2c_get_clientdata(client);

drivers/hwmon/pmbus/pmbus_core.c +1 -0
@@ -2995,6 +3038,7 @@ const struct regulator_ops pmbus_regulator_ops = {
       .disable = pmbus_regulator_disable,
       .is_enabled = pmbus_regulator_is_enabled,
       .get_error_flags = pmbus_regulator_get_error_flags,
+    .get_status = pmbus_regulator_get_status,
       .get_voltage = pmbus_regulator_get_voltage,
       .set_voltage = pmbus_regulator_set_voltage,
       .list_voltage = pmbus_regulator_list_voltage,
Quoted 2 lines
Quoted 1 line

base-commit: 2c71b3246ec3246522e8cb7c8191dc7a5d62cc70

Regards,
Naresh