Skip to contentSkip to conversation

hwmon: (pmbus) Improve initialization of 'currpage' and 'currphase'

PATCH In review Guenter Roeck 2 participants 3 messages May 7, 2020 Hardware monitoring

lore
Share & tools
lore

Guenter Roeck

author maintainer
#0 lore raw

PATCH 1/1 hwmon: (pmbus) Improve initialization of 'currpage' and 'currphase'

The 'currpage' and 'currphase' variables in struct pmbus_data are used by the PMBus core to determine if the phase or page value has changed. Both are initialized with values which are never expected to be set in the code to ensure that the first page/phase write operation is actually performed.

This is not well explained and occasionally causes confusion. Change the type of both variables to s16 and initialize with -1 to ensure that the initial value never matches a requested value, and clarify that this value means "unknown/unset".

---
 drivers/hwmon/pmbus/pmbus_core.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/hwmon/pmbus/pmbus_core.c +4 -4
index 8d321bf7d15b..a420877ba533 100644
@@ -109,8 +109,8 @@ struct pmbus_data {
 	bool has_status_word;		/* device uses STATUS_WORD register */
 	int (*read_status)(struct i2c_client *client, int page);
 
-	u8 currpage;
-	u8 currphase;	/* current phase, 0xff for all */
+	s16 currpage;	/* current page, -1 for unknown/unset */
+	s16 currphase;	/* current phase, 0xff for all, -1 for unknown/unset */
 };
 
 struct pmbus_debugfs_entry {
@@ -2529,8 +2529,8 @@ int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
 	if (pdata)
 		data->flags = pdata->flags;
 	data->info = info;
-	data->currpage = 0xff;
-	data->currphase = 0xfe;
+	data->currpage = -1;
+	data->currphase = -1;
 
 	ret = pmbus_init_common(client, data, info);
 	if (ret < 0)
Signature · 1 line
2.17.1
#1 lore raw

Hi Guenter,

LGTM; minor nits:

Quoted 22 lines · Guenter Roeck

The 'currpage' and 'currphase' variables in struct pmbus_data are used by the PMBus core to determine if the phase or page value has changed. Both are initialized with values which are never expected to be set in the code to ensure that the first page/phase write operation is actually performed.

This is not well explained and occasionally causes confusion. Change the type of both variables to s16 and initialize with -1 to ensure that the initial value never matches a requested value, and clarify that this value means "unknown/unset".

---
 drivers/hwmon/pmbus/pmbus_core.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/hwmon/pmbus/pmbus_core.c +0 -0
index 8d321bf7d15b..a420877ba533 100644

drivers/hwmon/pmbus/pmbus_core.c struct pmbus_data { · line 113

Quoted 7 lines
drivers/hwmon/pmbus/pmbus_core.c +2 -2
@@ -109,8 +109,8 @@ struct pmbus_data {
        bool has_status_word;           /* device uses STATUS_WORD register */
        int (*read_status)(struct i2c_client *client, int page);
 
-       u8 currpage;
-       u8 currphase;   /* current phase, 0xff for all */
+       s16 currpage;   /* current page, -1 for unknown/unset */
+       s16 currphase;  /* current phase, 0xff for all, -1 for unknown/unset */

I'm not sure if assigning macros for -1 and 0xff would be a good idea?

Quoted 15 lines
drivers/hwmon/pmbus/pmbus_core.c +2 -3
 };
 
 struct pmbus_debugfs_entry {
@@ -2529,8 +2529,8 @@ int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
        if (pdata)
                data->flags = pdata->flags;
        data->info = info;
-       data->currpage = 0xff;
-       data->currphase = 0xfe;
+       data->currpage = -1;
+       data->currphase = -1;
 
        ret = pmbus_init_common(client, data, info);
        if (ret < 0)
--
Quoted 2 lines

2.17.1

Thx!

- Alex Qiu

author maintainer
#2 lore raw
Quoted 30 lines · Alex Qiu

Hi Guenter,

LGTM; minor nits:

Quoted 25 lines · Guenter Roeck

The 'currpage' and 'currphase' variables in struct pmbus_data are used by the PMBus core to determine if the phase or page value has changed. Both are initialized with values which are never expected to be set in the code to ensure that the first page/phase write operation is actually performed.

This is not well explained and occasionally causes confusion. Change the type of both variables to s16 and initialize with -1 to ensure that the initial value never matches a requested value, and clarify that this value means "unknown/unset".

---
 drivers/hwmon/pmbus/pmbus_core.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/hwmon/pmbus/pmbus_core.c +0 -0
index 8d321bf7d15b..a420877ba533 100644
@@ -109,8 +109,8 @@ struct pmbus_data {
        bool has_status_word;           /* device uses STATUS_WORD register */
        int (*read_status)(struct i2c_client *client, int page);
 
Quoted 5 lines

drivers/hwmon/pmbus/pmbus_core.c struct pmbus_data { · line 113

Quoted 4 lines
drivers/hwmon/pmbus/pmbus_core.c +2 -2
-       u8 currpage;
-       u8 currphase;   /* current phase, 0xff for all */
+       s16 currpage;   /* current page, -1 for unknown/unset */
+       s16 currphase;  /* current phase, 0xff for all, -1 for unknown/unset */

I'm not sure if assigning macros for -1 and 0xff would be a good idea?

The driver uses hardcoded 0xff in various places. We could replace it with defines, but that should be a separate patch.

Thanks,
Guenter