hwmon (occ): Add sysfs attributes for additional OCC data

The OCC provides a variety of additional information about the state of
the host processor, such as throttling, error conditions, and the number
of OCCs detected in the system. This information is essential to service
processor applications such as fan control and host management.
Therefore, export this data in the form of sysfs attributes attached to
the platform device (to which the hwmon device is also attached).

Signed-off-by: Eddie James <eajames@linux.ibm.com>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>

diff --git a/drivers/hwmon/occ/Makefile b/drivers/hwmon/occ/Makefile
index 57c0e91..3fec12d 100644 (file)
--- a/drivers/hwmon/occ/Makefile
+++ b/drivers/hwmon/occ/Makefile
@@ -1,5 +1,5 @@
-occ-p8-hwmon-objs := common.o p8_i2c.o
-occ-p9-hwmon-objs := common.o p9_sbe.o
+occ-p8-hwmon-objs := common.o sysfs.o p8_i2c.o
+occ-p9-hwmon-objs := common.o sysfs.o p9_sbe.o
 
 obj-$(CONFIG_SENSORS_OCC_P8_I2C) += occ-p8-hwmon.o
 obj-$(CONFIG_SENSORS_OCC_P9_SBE) += occ-p9-hwmon.o

diff --git a/drivers/hwmon/occ/common.c b/drivers/hwmon/occ/common.c
index c6c8161..423903f 100644 (file)
--- a/drivers/hwmon/occ/common.c
+++ b/drivers/hwmon/occ/common.c
@@ -14,6 +14,11 @@
 
 #define EXTN_FLAG_SENSOR_ID            BIT(7)
 
+#define OCC_ERROR_COUNT_THRESHOLD      2       /* required by OCC spec */
+
+#define OCC_STATE_SAFE                 4
+#define OCC_SAFE_TIMEOUT               msecs_to_jiffies(60000) /* 1 min */
+
 #define OCC_UPDATE_FREQUENCY           msecs_to_jiffies(1000)
 
 #define OCC_TEMP_SENSOR_FAULT          0xFF
@@ -115,8 +120,10 @@ struct extended_sensor {
 
 static int occ_poll(struct occ *occ)
 {
+       int rc;
        u16 checksum = occ->poll_cmd_data + 1;
        u8 cmd[8];
+       struct occ_poll_response_header *header;
 
        /* big endian */
        cmd[0] = 0;                     /* sequence number */
@@ -129,7 +136,35 @@ static int occ_poll(struct occ *occ)
        cmd[7] = 0;
 
        /* mutex should already be locked if necessary */
-       return occ->send_cmd(occ, cmd);
+       rc = occ->send_cmd(occ, cmd);
+       if (rc) {
+               if (occ->error_count++ > OCC_ERROR_COUNT_THRESHOLD)
+                       occ->error = rc;
+
+               goto done;
+       }
+
+       /* clear error since communication was successful */
+       occ->error_count = 0;
+       occ->error = 0;
+
+       /* check for safe state */
+       header = (struct occ_poll_response_header *)occ->resp.data;
+       if (header->occ_state == OCC_STATE_SAFE) {
+               if (occ->last_safe) {
+                       if (time_after(jiffies,
+                                      occ->last_safe + OCC_SAFE_TIMEOUT))
+                               occ->error = -EHOSTDOWN;
+               } else {
+                       occ->last_safe = jiffies;
+               }
+       } else {
+               occ->last_safe = 0;
+       }
+
+done:
+       occ_sysfs_poll_done(occ);
+       return rc;
 }
 
 static int occ_set_user_power_cap(struct occ *occ, u16 user_power_cap)
@@ -161,7 +196,7 @@ static int occ_set_user_power_cap(struct occ *occ, u16 user_power_cap)
        return rc;
 }
 
-static int occ_update_response(struct occ *occ)
+int occ_update_response(struct occ *occ)
 {
        int rc = mutex_lock_interruptible(&occ->lock);
 
@@ -1055,5 +1090,9 @@ int occ_setup(struct occ *occ, const char *name)
                return rc;
        }
 
-       return 0;
+       rc = occ_setup_sysfs(occ);
+       if (rc)
+               dev_err(occ->bus_dev, "failed to setup sysfs: %d\n", rc);
+
+       return rc;
 }

diff --git a/drivers/hwmon/occ/common.h b/drivers/hwmon/occ/common.h
index 9d01973..7c44df3 100644 (file)
--- a/drivers/hwmon/occ/common.h
+++ b/drivers/hwmon/occ/common.h
@@ -104,8 +104,25 @@ struct occ {
        struct occ_attribute *attrs;
        struct attribute_group group;
        const struct attribute_group *groups[2];
+
+       int error;                      /* latest transfer error */
+       unsigned int error_count;       /* number of xfr errors observed */
+       unsigned long last_safe;        /* time OCC entered "safe" state */
+
+       /*
+        * Store the previous state data for comparison in order to notify
+        * sysfs readers of state changes.
+        */
+       int prev_error;
+       u8 prev_stat;
+       u8 prev_ext_stat;
+       u8 prev_occs_present;
 };
 
 int occ_setup(struct occ *occ, const char *name);
+int occ_setup_sysfs(struct occ *occ);
+void occ_shutdown(struct occ *occ);
+void occ_sysfs_poll_done(struct occ *occ);
+int occ_update_response(struct occ *occ);
 
 #endif /* OCC_COMMON_H */

diff --git a/drivers/hwmon/occ/p8_i2c.c b/drivers/hwmon/occ/p8_i2c.c
index e4c2c04..b59efc9 100644 (file)
--- a/drivers/hwmon/occ/p8_i2c.c
+++ b/drivers/hwmon/occ/p8_i2c.c
@@ -223,6 +223,15 @@ static int p8_i2c_occ_probe(struct i2c_client *client,
        return occ_setup(occ, "p8_occ");
 }
 
+static int p8_i2c_occ_remove(struct i2c_client *client)
+{
+       struct occ *occ = dev_get_drvdata(&client->dev);
+
+       occ_shutdown(occ);
+
+       return 0;
+}
+
 static const struct of_device_id p8_i2c_occ_of_match[] = {
        { .compatible = "ibm,p8-occ-hwmon" },
        {}
@@ -236,6 +245,7 @@ static struct i2c_driver p8_i2c_occ_driver = {
                .of_match_table = p8_i2c_occ_of_match,
        },
        .probe = p8_i2c_occ_probe,
+       .remove = p8_i2c_occ_remove,
 };
 
 module_i2c_driver(p8_i2c_occ_driver);

diff --git a/drivers/hwmon/occ/p9_sbe.c b/drivers/hwmon/occ/p9_sbe.c
index b33f4fe..b65c1d1 100644 (file)
--- a/drivers/hwmon/occ/p9_sbe.c
+++ b/drivers/hwmon/occ/p9_sbe.c
@@ -86,6 +86,7 @@ static int p9_sbe_occ_remove(struct platform_device *pdev)
        struct p9_sbe_occ *ctx = to_p9_sbe_occ(occ);
 
        ctx->sbe = NULL;
+       occ_shutdown(occ);
 
        return 0;
 }

diff --git a/drivers/hwmon/occ/sysfs.c b/drivers/hwmon/occ/sysfs.c
new file mode 100644 (file)
index 0000000..743b26e
--- /dev/null
+++ b/drivers/hwmon/occ/sysfs.c
@@ -0,0 +1,188 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * OCC hwmon driver sysfs interface
+ *
+ * Copyright (C) IBM Corporation 2018
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ */
+
+#include <linux/bitops.h>
+#include <linux/device.h>
+#include <linux/hwmon-sysfs.h>
+#include <linux/kernel.h>
+#include <linux/sysfs.h>
+
+#include "common.h"
+
+/* OCC status register */
+#define OCC_STAT_MASTER                        BIT(7)
+#define OCC_STAT_ACTIVE                        BIT(0)
+
+/* OCC extended status register */
+#define OCC_EXT_STAT_DVFS_OT           BIT(7)
+#define OCC_EXT_STAT_DVFS_POWER                BIT(6)
+#define OCC_EXT_STAT_MEM_THROTTLE      BIT(5)
+#define OCC_EXT_STAT_QUICK_DROP                BIT(4)
+
+static ssize_t occ_sysfs_show(struct device *dev,
+                             struct device_attribute *attr, char *buf)
+{
+       int rc;
+       int val = 0;
+       struct occ *occ = dev_get_drvdata(dev);
+       struct occ_poll_response_header *header;
+       struct sensor_device_attribute *sattr = to_sensor_dev_attr(attr);
+
+       rc = occ_update_response(occ);
+       if (rc)
+               return rc;
+
+       header = (struct occ_poll_response_header *)occ->resp.data;
+
+       switch (sattr->index) {
+       case 0:
+               val = !!(header->status & OCC_STAT_MASTER);
+               break;
+       case 1:
+               val = !!(header->status & OCC_STAT_ACTIVE);
+               break;
+       case 2:
+               val = !!(header->status & OCC_EXT_STAT_DVFS_OT);
+               break;
+       case 3:
+               val = !!(header->status & OCC_EXT_STAT_DVFS_POWER);
+               break;
+       case 4:
+               val = !!(header->status & OCC_EXT_STAT_MEM_THROTTLE);
+               break;
+       case 5:
+               val = !!(header->status & OCC_EXT_STAT_QUICK_DROP);
+               break;
+       case 6:
+               val = header->occ_state;
+               break;
+       case 7:
+               if (header->status & OCC_STAT_MASTER)
+                       val = hweight8(header->occs_present);
+               else
+                       val = 1;
+               break;
+       case 8:
+               val = occ->error;
+               break;
+       default:
+               return -EINVAL;
+       }
+
+       return snprintf(buf, PAGE_SIZE - 1, "%d\n", val);
+}
+
+static SENSOR_DEVICE_ATTR(occ_master, 0444, occ_sysfs_show, NULL, 0);
+static SENSOR_DEVICE_ATTR(occ_active, 0444, occ_sysfs_show, NULL, 1);
+static SENSOR_DEVICE_ATTR(occ_dvfs_overtemp, 0444, occ_sysfs_show, NULL, 2);
+static SENSOR_DEVICE_ATTR(occ_dvfs_power, 0444, occ_sysfs_show, NULL, 3);
+static SENSOR_DEVICE_ATTR(occ_mem_throttle, 0444, occ_sysfs_show, NULL, 4);
+static SENSOR_DEVICE_ATTR(occ_quick_pwr_drop, 0444, occ_sysfs_show, NULL, 5);
+static SENSOR_DEVICE_ATTR(occ_state, 0444, occ_sysfs_show, NULL, 6);
+static SENSOR_DEVICE_ATTR(occs_present, 0444, occ_sysfs_show, NULL, 7);
+static SENSOR_DEVICE_ATTR(occ_error, 0444, occ_sysfs_show, NULL, 8);
+
+static struct attribute *occ_attributes[] = {
+       &sensor_dev_attr_occ_master.dev_attr.attr,
+       &sensor_dev_attr_occ_active.dev_attr.attr,
+       &sensor_dev_attr_occ_dvfs_overtemp.dev_attr.attr,
+       &sensor_dev_attr_occ_dvfs_power.dev_attr.attr,
+       &sensor_dev_attr_occ_mem_throttle.dev_attr.attr,
+       &sensor_dev_attr_occ_quick_pwr_drop.dev_attr.attr,
+       &sensor_dev_attr_occ_state.dev_attr.attr,
+       &sensor_dev_attr_occs_present.dev_attr.attr,
+       &sensor_dev_attr_occ_error.dev_attr.attr,
+       NULL
+};
+
+static const struct attribute_group occ_sysfs = {
+       .attrs = occ_attributes,
+};
+
+void occ_sysfs_poll_done(struct occ *occ)
+{
+       const char *name;
+       struct occ_poll_response_header *header =
+               (struct occ_poll_response_header *)occ->resp.data;
+
+       /*
+        * On the first poll response, we haven't yet created the sysfs
+        * attributes, so don't make any notify calls.
+        */
+       if (!occ->hwmon)
+               goto done;
+
+       if ((header->status & OCC_STAT_MASTER) !=
+           (occ->prev_stat & OCC_STAT_MASTER)) {
+               name = sensor_dev_attr_occ_master.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->status & OCC_STAT_ACTIVE) !=
+           (occ->prev_stat & OCC_STAT_ACTIVE)) {
+               name = sensor_dev_attr_occ_active.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->ext_status & OCC_EXT_STAT_DVFS_OT) !=
+           (occ->prev_ext_stat & OCC_EXT_STAT_DVFS_OT)) {
+               name = sensor_dev_attr_occ_dvfs_overtemp.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->ext_status & OCC_EXT_STAT_DVFS_POWER) !=
+           (occ->prev_ext_stat & OCC_EXT_STAT_DVFS_POWER)) {
+               name = sensor_dev_attr_occ_dvfs_power.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->ext_status & OCC_EXT_STAT_MEM_THROTTLE) !=
+           (occ->prev_ext_stat & OCC_EXT_STAT_MEM_THROTTLE)) {
+               name = sensor_dev_attr_occ_mem_throttle.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->ext_status & OCC_EXT_STAT_QUICK_DROP) !=
+           (occ->prev_ext_stat & OCC_EXT_STAT_QUICK_DROP)) {
+               name = sensor_dev_attr_occ_quick_pwr_drop.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if ((header->status & OCC_STAT_MASTER) &&
+           header->occs_present != occ->prev_occs_present) {
+               name = sensor_dev_attr_occs_present.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       if (occ->error && occ->error != occ->prev_error) {
+               name = sensor_dev_attr_occ_error.dev_attr.attr.name;
+               sysfs_notify(&occ->bus_dev->kobj, NULL, name);
+       }
+
+       /* no notifications for OCC state; doesn't indicate error condition */
+
+done:
+       occ->prev_error = occ->error;
+       occ->prev_stat = header->status;
+       occ->prev_ext_stat = header->ext_status;
+       occ->prev_occs_present = header->occs_present;
+}
+
+int occ_setup_sysfs(struct occ *occ)
+{
+       return sysfs_create_group(&occ->bus_dev->kobj, &occ_sysfs);
+}
+
+void occ_shutdown(struct occ *occ)
+{
+       sysfs_remove_group(&occ->bus_dev->kobj, &occ_sysfs);
+}