* [RFC Patch Resend 1/2] i2c debug counters as sysfs attributes
2021-11-09 22:53 [RFC Patch Resend 0/2] I2C statistics as sysfs attributes Sui Chen
@ 2021-11-09 22:53 ` Sui Chen
2021-11-09 23:13 ` Joe Perches
2021-11-09 22:53 ` [RFC Patch Resend 2/2] add npcm7xx " Sui Chen
1 sibling, 1 reply; 4+ messages in thread
From: Sui Chen @ 2021-11-09 22:53 UTC (permalink / raw)
To: linux-kernel; +Cc: Sui Chen
This change adds a few example I2C debug counters as sysfs attributes:
- ber_cnt (bus error count)
- nack_cnt (NACK count)
- rec_fail_cnt, rec_succ_cnt (recovery failure/success count)
- timeout_cnt (timeout count)
- i2c_speed (bus frequency)
The function i2c_adapter_create_stats_folder creates a stats directory
in the device's sysfs directory to hold the debug counters. The platform
drivers will instantiate the counters in the stats directory if
available.
Signed-off-by: Sui Chen <suichen@google.com>
---
drivers/i2c/i2c-core-base.c | 2 +
drivers/i2c/i2c-dev.c | 98 +++++++++++++++++++++++++++++++++++++
include/linux/i2c.h | 26 ++++++++++
3 files changed, 126 insertions(+)
diff --git a/drivers/i2c/i2c-core-base.c b/drivers/i2c/i2c-core-base.c
index 84f12bf90644a..c42113daf32a7 100644
--- a/drivers/i2c/i2c-core-base.c
+++ b/drivers/i2c/i2c-core-base.c
@@ -1610,6 +1610,8 @@ static int i2c_register_adapter(struct i2c_adapter *adap)
bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
mutex_unlock(&core_lock);
+ i2c_adapter_create_stats_folder(adap);
+
return 0;
out_reg:
diff --git a/drivers/i2c/i2c-dev.c b/drivers/i2c/i2c-dev.c
index 77f576e516522..fbec54519bc04 100644
--- a/drivers/i2c/i2c-dev.c
+++ b/drivers/i2c/i2c-dev.c
@@ -767,6 +767,104 @@ static void __exit i2c_dev_exit(void)
unregister_chrdev_region(MKDEV(I2C_MAJOR, 0), I2C_MINORS);
}
+
+static struct i2c_adapter* kobj_to_adapter(struct device* pdev) {
+ struct kobject* dev_kobj = ((struct kobject*)pdev)->parent;
+ struct device* dev = container_of(dev_kobj, struct device, kobj);
+ return to_i2c_adapter(dev);
+}
+
+static ssize_t ber_cnt_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* ber_cnt = kobj_to_adapter(pdev)->stats->ber_cnt;
+ if (ber_cnt == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *ber_cnt);
+ return ret;
+}
+DEVICE_ATTR_RO(ber_cnt);
+
+ssize_t nack_cnt_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* nack_cnt = kobj_to_adapter(pdev)->stats->nack_cnt;
+ if (nack_cnt == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *nack_cnt);
+ return ret;
+}
+DEVICE_ATTR_RO(nack_cnt);
+
+ssize_t rec_succ_cnt_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* rec_succ_cnt = kobj_to_adapter(pdev)->stats->rec_succ_cnt;
+ if (rec_succ_cnt == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *rec_succ_cnt);
+ return ret;
+}
+DEVICE_ATTR_RO(rec_succ_cnt);
+
+ssize_t rec_fail_cnt_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* rec_fail_cnt = kobj_to_adapter(pdev)->stats->rec_fail_cnt;
+ if (rec_fail_cnt == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *rec_fail_cnt);
+ return ret;
+}
+DEVICE_ATTR_RO(rec_fail_cnt);
+
+ssize_t timeout_cnt_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* timeout_cnt = kobj_to_adapter(pdev)->stats->timeout_cnt;
+ if (timeout_cnt == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *timeout_cnt);
+ return ret;
+}
+DEVICE_ATTR_RO(timeout_cnt);
+
+ssize_t i2c_speed_show(struct device* pdev,
+ struct device_attribute* attr, char* buf) {
+ u64* i2c_speed = kobj_to_adapter(pdev)->stats->i2c_speed;
+ if (i2c_speed == NULL) return 0;
+ ssize_t ret = sprintf(buf, "%llu\n", *i2c_speed);
+ return ret;
+}
+DEVICE_ATTR_RO(i2c_speed);
+
+void i2c_adapter_create_stats_folder(struct i2c_adapter* adapter) {
+ adapter->stats = kzalloc(sizeof(struct i2c_adapter_stats), GFP_KERNEL);
+ adapter->stats->kobj = kobject_create_and_add("stats", &adapter->dev.kobj);;
+}
+
+void i2c_adapter_stats_register_counter(struct i2c_adapter* adapter,
+ const char* counter_name, void* data_source) {
+ int ret;
+ if (adapter->stats == NULL) {
+ i2c_adapter_create_stats_folder(adapter);
+ }
+
+ if (!strcmp(counter_name, "ber_cnt")) {
+ adapter->stats->ber_cnt = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_ber_cnt.attr);
+ } else if (!strcmp(counter_name, "nack_cnt")) {
+ adapter->stats->nack_cnt = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_nack_cnt.attr);
+ } else if (!strcmp(counter_name, "rec_succ_cnt")) {
+ adapter->stats->rec_succ_cnt = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_rec_succ_cnt.attr);
+ } else if (!strcmp(counter_name, "rec_fail_cnt")) {
+ adapter->stats->rec_fail_cnt = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_rec_fail_cnt.attr);
+ } else if (!strcmp(counter_name, "timeout_cnt")) {
+ adapter->stats->timeout_cnt = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_timeout_cnt.attr);
+ } else if (!strcmp(counter_name, "i2c_speed")) {
+ adapter->stats->i2c_speed = data_source;
+ ret = sysfs_create_file(adapter->stats->kobj, &dev_attr_i2c_speed.attr);
+ }
+
+ if (ret) {
+ printk("Failed to create sysfs file for %s", counter_name);
+ }
+}
+
MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
MODULE_DESCRIPTION("I2C /dev entries driver");
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index 3eb60a2e9e618..b5c84297c60d9 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -21,6 +21,7 @@
#include <linux/of.h> /* for struct device_node */
#include <linux/swab.h> /* for swab16 */
#include <uapi/linux/i2c.h>
+#include <linux/slab.h> /* for kzalloc */
extern struct bus_type i2c_bus_type;
extern struct device_type i2c_adapter_type;
@@ -684,6 +685,26 @@ struct i2c_adapter_quirks {
u16 max_comb_2nd_msg_len;
};
+/**
+ * I2C statistics
+ * The list of statistics are currently copied from npcm7xx.
+ * Perhaps a more universal set of statistics can be used.
+ *
+ * The stats are currently modeled as pointers to members in the bus drivers.
+ * A null pointer indicates the counter is not supported by the bus driver.
+ */
+struct i2c_adapter_stats {
+ struct kobject* kobj;
+
+ // For the counters a NULL value means the counter is not available.
+ u64* ber_cnt;
+ u64* nack_cnt;
+ u64* rec_succ_cnt;
+ u64* rec_fail_cnt;
+ u64* timeout_cnt;
+ u64* i2c_speed;
+};
+
/* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */
#define I2C_AQ_COMB BIT(0)
/* first combined message must be write */
@@ -735,12 +756,17 @@ struct i2c_adapter {
struct i2c_bus_recovery_info *bus_recovery_info;
const struct i2c_adapter_quirks *quirks;
+ struct i2c_adapter_stats* stats;
struct irq_domain *host_notify_domain;
struct regulator *bus_regulator;
};
#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
+void i2c_adapter_create_stats_folder(struct i2c_adapter* adapter);
+void i2c_adapter_stats_register_counter(struct i2c_adapter* adapter,
+ const char* counter_name, void* data_source);
+
static inline void *i2c_get_adapdata(const struct i2c_adapter *adap)
{
return dev_get_drvdata(&adap->dev);
--
2.34.0.rc0.344.g81b53c2807-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread* [RFC Patch Resend 2/2] add npcm7xx debug counters as sysfs attributes
2021-11-09 22:53 [RFC Patch Resend 0/2] I2C statistics as sysfs attributes Sui Chen
2021-11-09 22:53 ` [RFC Patch Resend 1/2] i2c debug counters " Sui Chen
@ 2021-11-09 22:53 ` Sui Chen
1 sibling, 0 replies; 4+ messages in thread
From: Sui Chen @ 2021-11-09 22:53 UTC (permalink / raw)
To: linux-kernel; +Cc: Sui Chen, Tali Perry
This change adds npcm7xx debug counters as sysfs attributes using the
i2c_adapter_stats_register_counter function.
Signed-off-by: Sui Chen <suichen@google.com>
Reviewed-by: Tali Perry <tali.perry1@gmail.com>
---
drivers/i2c/busses/i2c-npcm7xx.c | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/drivers/i2c/busses/i2c-npcm7xx.c b/drivers/i2c/busses/i2c-npcm7xx.c
index 2ad166355ec9b..def044207cae2 100644
--- a/drivers/i2c/busses/i2c-npcm7xx.c
+++ b/drivers/i2c/busses/i2c-npcm7xx.c
@@ -2224,6 +2224,14 @@ static void npcm_i2c_init_debugfs(struct platform_device *pdev,
debugfs_create_u64("rec_fail_cnt", 0444, d, &bus->rec_fail_cnt);
debugfs_create_u64("timeout_cnt", 0444, d, &bus->timeout_cnt);
+ /* register debug counters in sysfs */
+ i2c_adapter_stats_register_counter(&bus->adap, "ber_cnt", &bus->ber_cnt);
+ i2c_adapter_stats_register_counter(&bus->adap, "nack_cnt", &bus->nack_cnt);
+ i2c_adapter_stats_register_counter(&bus->adap, "rec_succ_cnt", &bus->rec_succ_cnt);
+ i2c_adapter_stats_register_counter(&bus->adap, "rec_fail_cnt", &bus->rec_fail_cnt);
+ i2c_adapter_stats_register_counter(&bus->adap, "timeout_cnt", &bus->timeout_cnt);
+ i2c_adapter_stats_register_counter(&bus->adap, "i2c_speed", &bus->bus_freq);
+
bus->debugfs = d;
}
--
2.34.0.rc0.344.g81b53c2807-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread