2 * Hardware monitoring driver for PMBus devices
4 * Copyright (c) 2010, 2011 Ericsson AB.
5 * Copyright (c) 2012 Guenter Roeck
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/debugfs.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/err.h>
27 #include <linux/slab.h>
28 #include <linux/i2c.h>
29 #include <linux/hwmon.h>
30 #include <linux/hwmon-sysfs.h>
31 #include <linux/jiffies.h>
32 #include <linux/pmbus.h>
33 #include <linux/regulator/driver.h>
34 #include <linux/regulator/machine.h>
38 * Number of additional attribute pointers to allocate
39 * with each call to krealloc
41 #define PMBUS_ATTR_ALLOC_SIZE 32
44 * Index into status register array, per status register group
46 #define PB_STATUS_BASE 0
47 #define PB_STATUS_VOUT_BASE (PB_STATUS_BASE + PMBUS_PAGES)
48 #define PB_STATUS_IOUT_BASE (PB_STATUS_VOUT_BASE + PMBUS_PAGES)
49 #define PB_STATUS_FAN_BASE (PB_STATUS_IOUT_BASE + PMBUS_PAGES)
50 #define PB_STATUS_FAN34_BASE (PB_STATUS_FAN_BASE + PMBUS_PAGES)
51 #define PB_STATUS_TEMP_BASE (PB_STATUS_FAN34_BASE + PMBUS_PAGES)
52 #define PB_STATUS_INPUT_BASE (PB_STATUS_TEMP_BASE + PMBUS_PAGES)
53 #define PB_STATUS_VMON_BASE (PB_STATUS_INPUT_BASE + 1)
55 #define PB_NUM_STATUS_REG (PB_STATUS_VMON_BASE + 1)
57 #define PMBUS_NAME_SIZE 24
60 struct pmbus_sensor *next;
61 char name[PMBUS_NAME_SIZE]; /* sysfs sensor name */
62 struct device_attribute attribute;
63 u8 page; /* page number */
64 u16 reg; /* register */
65 enum pmbus_sensor_classes class; /* sensor class */
66 bool update; /* runtime sensor update needed */
67 int data; /* Sensor data.
68 Negative if there was a read error */
70 #define to_pmbus_sensor(_attr) \
71 container_of(_attr, struct pmbus_sensor, attribute)
73 struct pmbus_boolean {
74 char name[PMBUS_NAME_SIZE]; /* sysfs boolean name */
75 struct sensor_device_attribute attribute;
76 struct pmbus_sensor *s1;
77 struct pmbus_sensor *s2;
79 #define to_pmbus_boolean(_attr) \
80 container_of(_attr, struct pmbus_boolean, attribute)
83 char name[PMBUS_NAME_SIZE]; /* sysfs label name */
84 struct device_attribute attribute;
85 char label[PMBUS_NAME_SIZE]; /* label */
87 #define to_pmbus_label(_attr) \
88 container_of(_attr, struct pmbus_label, attribute)
92 struct device *hwmon_dev;
94 u32 flags; /* from platform data */
96 int exponent[PMBUS_PAGES];
97 /* linear mode: exponent for output voltages */
99 const struct pmbus_driver_info *info;
103 struct attribute_group group;
104 const struct attribute_group *groups[2];
105 struct dentry *debugfs; /* debugfs device directory */
107 struct pmbus_sensor *sensors;
109 struct mutex update_lock;
111 unsigned long last_updated; /* in jiffies */
114 * A single status register covers multiple attributes,
115 * so we keep them all together.
117 u16 status[PB_NUM_STATUS_REG];
119 bool has_status_word; /* device uses STATUS_WORD register */
120 int (*read_status)(struct i2c_client *client, int page);
125 struct pmbus_debugfs_entry {
126 struct i2c_client *client;
131 void pmbus_clear_cache(struct i2c_client *client)
133 struct pmbus_data *data = i2c_get_clientdata(client);
137 EXPORT_SYMBOL_GPL(pmbus_clear_cache);
139 int pmbus_set_page(struct i2c_client *client, int page)
141 struct pmbus_data *data = i2c_get_clientdata(client);
145 if (page >= 0 && page != data->currpage) {
146 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
147 newpage = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
151 data->currpage = page;
155 EXPORT_SYMBOL_GPL(pmbus_set_page);
157 int pmbus_write_byte(struct i2c_client *client, int page, u8 value)
161 rv = pmbus_set_page(client, page);
165 return i2c_smbus_write_byte(client, value);
167 EXPORT_SYMBOL_GPL(pmbus_write_byte);
170 * _pmbus_write_byte() is similar to pmbus_write_byte(), but checks if
171 * a device specific mapping function exists and calls it if necessary.
173 static int _pmbus_write_byte(struct i2c_client *client, int page, u8 value)
175 struct pmbus_data *data = i2c_get_clientdata(client);
176 const struct pmbus_driver_info *info = data->info;
179 if (info->write_byte) {
180 status = info->write_byte(client, page, value);
181 if (status != -ENODATA)
184 return pmbus_write_byte(client, page, value);
187 int pmbus_write_word_data(struct i2c_client *client, int page, u8 reg,
192 rv = pmbus_set_page(client, page);
196 return i2c_smbus_write_word_data(client, reg, word);
198 EXPORT_SYMBOL_GPL(pmbus_write_word_data);
201 * _pmbus_write_word_data() is similar to pmbus_write_word_data(), but checks if
202 * a device specific mapping function exists and calls it if necessary.
204 static int _pmbus_write_word_data(struct i2c_client *client, int page, int reg,
207 struct pmbus_data *data = i2c_get_clientdata(client);
208 const struct pmbus_driver_info *info = data->info;
211 if (info->write_word_data) {
212 status = info->write_word_data(client, page, reg, word);
213 if (status != -ENODATA)
216 if (reg >= PMBUS_VIRT_BASE)
218 return pmbus_write_word_data(client, page, reg, word);
221 int pmbus_read_word_data(struct i2c_client *client, int page, u8 reg)
225 rv = pmbus_set_page(client, page);
229 return i2c_smbus_read_word_data(client, reg);
231 EXPORT_SYMBOL_GPL(pmbus_read_word_data);
234 * _pmbus_read_word_data() is similar to pmbus_read_word_data(), but checks if
235 * a device specific mapping function exists and calls it if necessary.
237 static int _pmbus_read_word_data(struct i2c_client *client, int page, int reg)
239 struct pmbus_data *data = i2c_get_clientdata(client);
240 const struct pmbus_driver_info *info = data->info;
243 if (info->read_word_data) {
244 status = info->read_word_data(client, page, reg);
245 if (status != -ENODATA)
248 if (reg >= PMBUS_VIRT_BASE)
250 return pmbus_read_word_data(client, page, reg);
253 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg)
257 rv = pmbus_set_page(client, page);
261 return i2c_smbus_read_byte_data(client, reg);
263 EXPORT_SYMBOL_GPL(pmbus_read_byte_data);
265 int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, u8 value)
269 rv = pmbus_set_page(client, page);
273 return i2c_smbus_write_byte_data(client, reg, value);
275 EXPORT_SYMBOL_GPL(pmbus_write_byte_data);
277 int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg,
283 rv = pmbus_read_byte_data(client, page, reg);
287 tmp = (rv & ~mask) | (value & mask);
290 rv = pmbus_write_byte_data(client, page, reg, tmp);
294 EXPORT_SYMBOL_GPL(pmbus_update_byte_data);
297 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
298 * a device specific mapping function exists and calls it if necessary.
300 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
302 struct pmbus_data *data = i2c_get_clientdata(client);
303 const struct pmbus_driver_info *info = data->info;
306 if (info->read_byte_data) {
307 status = info->read_byte_data(client, page, reg);
308 if (status != -ENODATA)
311 return pmbus_read_byte_data(client, page, reg);
314 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
316 _pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
319 void pmbus_clear_faults(struct i2c_client *client)
321 struct pmbus_data *data = i2c_get_clientdata(client);
324 for (i = 0; i < data->info->pages; i++)
325 pmbus_clear_fault_page(client, i);
327 EXPORT_SYMBOL_GPL(pmbus_clear_faults);
329 static int pmbus_check_status_cml(struct i2c_client *client)
331 struct pmbus_data *data = i2c_get_clientdata(client);
334 status = data->read_status(client, -1);
335 if (status < 0 || (status & PB_STATUS_CML)) {
336 status2 = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
337 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
343 static bool pmbus_check_register(struct i2c_client *client,
344 int (*func)(struct i2c_client *client,
349 struct pmbus_data *data = i2c_get_clientdata(client);
351 rv = func(client, page, reg);
352 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
353 rv = pmbus_check_status_cml(client);
354 pmbus_clear_fault_page(client, -1);
358 static bool pmbus_check_status_register(struct i2c_client *client, int page)
361 struct pmbus_data *data = i2c_get_clientdata(client);
363 status = data->read_status(client, page);
364 if (status >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK) &&
365 (status & PB_STATUS_CML)) {
366 status = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
367 if (status < 0 || (status & PB_CML_FAULT_INVALID_COMMAND))
371 pmbus_clear_fault_page(client, -1);
375 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
377 return pmbus_check_register(client, _pmbus_read_byte_data, page, reg);
379 EXPORT_SYMBOL_GPL(pmbus_check_byte_register);
381 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
383 return pmbus_check_register(client, _pmbus_read_word_data, page, reg);
385 EXPORT_SYMBOL_GPL(pmbus_check_word_register);
387 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
389 struct pmbus_data *data = i2c_get_clientdata(client);
393 EXPORT_SYMBOL_GPL(pmbus_get_driver_info);
395 static struct _pmbus_status {
400 { PMBUS_HAVE_STATUS_VOUT, PB_STATUS_VOUT_BASE, PMBUS_STATUS_VOUT },
401 { PMBUS_HAVE_STATUS_IOUT, PB_STATUS_IOUT_BASE, PMBUS_STATUS_IOUT },
402 { PMBUS_HAVE_STATUS_TEMP, PB_STATUS_TEMP_BASE,
403 PMBUS_STATUS_TEMPERATURE },
404 { PMBUS_HAVE_STATUS_FAN12, PB_STATUS_FAN_BASE, PMBUS_STATUS_FAN_12 },
405 { PMBUS_HAVE_STATUS_FAN34, PB_STATUS_FAN34_BASE, PMBUS_STATUS_FAN_34 },
408 static struct pmbus_data *pmbus_update_device(struct device *dev)
410 struct i2c_client *client = to_i2c_client(dev->parent);
411 struct pmbus_data *data = i2c_get_clientdata(client);
412 const struct pmbus_driver_info *info = data->info;
413 struct pmbus_sensor *sensor;
415 mutex_lock(&data->update_lock);
416 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
419 for (i = 0; i < info->pages; i++) {
420 data->status[PB_STATUS_BASE + i]
421 = data->read_status(client, i);
422 for (j = 0; j < ARRAY_SIZE(pmbus_status); j++) {
423 struct _pmbus_status *s = &pmbus_status[j];
425 if (!(info->func[i] & s->func))
427 data->status[s->base + i]
428 = _pmbus_read_byte_data(client, i,
433 if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
434 data->status[PB_STATUS_INPUT_BASE]
435 = _pmbus_read_byte_data(client, 0,
438 if (info->func[0] & PMBUS_HAVE_STATUS_VMON)
439 data->status[PB_STATUS_VMON_BASE]
440 = _pmbus_read_byte_data(client, 0,
441 PMBUS_VIRT_STATUS_VMON);
443 for (sensor = data->sensors; sensor; sensor = sensor->next) {
444 if (!data->valid || sensor->update)
446 = _pmbus_read_word_data(client,
450 pmbus_clear_faults(client);
451 data->last_updated = jiffies;
454 mutex_unlock(&data->update_lock);
459 * Convert linear sensor values to milli- or micro-units
460 * depending on sensor type.
462 static long pmbus_reg2data_linear(struct pmbus_data *data,
463 struct pmbus_sensor *sensor)
469 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
470 exponent = data->exponent[sensor->page];
471 mantissa = (u16) sensor->data;
472 } else { /* LINEAR11 */
473 exponent = ((s16)sensor->data) >> 11;
474 mantissa = ((s16)((sensor->data & 0x7ff) << 5)) >> 5;
479 /* scale result to milli-units for all sensors except fans */
480 if (sensor->class != PSC_FAN)
483 /* scale result to micro-units for power sensors */
484 if (sensor->class == PSC_POWER)
496 * Convert direct sensor values to milli- or micro-units
497 * depending on sensor type.
499 static long pmbus_reg2data_direct(struct pmbus_data *data,
500 struct pmbus_sensor *sensor)
502 long val = (s16) sensor->data;
505 m = data->info->m[sensor->class];
506 b = data->info->b[sensor->class];
507 R = data->info->R[sensor->class];
512 /* X = 1/m * (Y * 10^-R - b) */
514 /* scale result to milli-units for everything but fans */
515 if (sensor->class != PSC_FAN) {
520 /* scale result to micro-units for power sensors */
521 if (sensor->class == PSC_POWER) {
531 val = DIV_ROUND_CLOSEST(val, 10);
535 return (val - b) / m;
539 * Convert VID sensor values to milli- or micro-units
540 * depending on sensor type.
542 static long pmbus_reg2data_vid(struct pmbus_data *data,
543 struct pmbus_sensor *sensor)
545 long val = sensor->data;
548 switch (data->info->vrm_version) {
550 if (val >= 0x02 && val <= 0xb2)
551 rv = DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
555 rv = 250 + (val - 1) * 5;
559 rv = 500 + (val - 1) * 10;
565 static long pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
569 switch (data->info->format[sensor->class]) {
571 val = pmbus_reg2data_direct(data, sensor);
574 val = pmbus_reg2data_vid(data, sensor);
578 val = pmbus_reg2data_linear(data, sensor);
584 #define MAX_MANTISSA (1023 * 1000)
585 #define MIN_MANTISSA (511 * 1000)
587 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
588 struct pmbus_sensor *sensor, long val)
590 s16 exponent = 0, mantissa;
591 bool negative = false;
597 if (sensor->class == PSC_VOLTAGE_OUT) {
598 /* LINEAR16 does not support negative voltages */
603 * For a static exponents, we don't have a choice
604 * but to adjust the value to it.
606 if (data->exponent[sensor->page] < 0)
607 val <<= -data->exponent[sensor->page];
609 val >>= data->exponent[sensor->page];
610 val = DIV_ROUND_CLOSEST(val, 1000);
619 /* Power is in uW. Convert to mW before converting. */
620 if (sensor->class == PSC_POWER)
621 val = DIV_ROUND_CLOSEST(val, 1000L);
624 * For simplicity, convert fan data to milli-units
625 * before calculating the exponent.
627 if (sensor->class == PSC_FAN)
630 /* Reduce large mantissa until it fits into 10 bit */
631 while (val >= MAX_MANTISSA && exponent < 15) {
635 /* Increase small mantissa to improve precision */
636 while (val < MIN_MANTISSA && exponent > -15) {
641 /* Convert mantissa from milli-units to units */
642 mantissa = DIV_ROUND_CLOSEST(val, 1000);
644 /* Ensure that resulting number is within range */
645 if (mantissa > 0x3ff)
650 mantissa = -mantissa;
652 /* Convert to 5 bit exponent, 11 bit mantissa */
653 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
656 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
657 struct pmbus_sensor *sensor, long val)
661 m = data->info->m[sensor->class];
662 b = data->info->b[sensor->class];
663 R = data->info->R[sensor->class];
665 /* Power is in uW. Adjust R and b. */
666 if (sensor->class == PSC_POWER) {
671 /* Calculate Y = (m * X + b) * 10^R */
672 if (sensor->class != PSC_FAN) {
673 R -= 3; /* Adjust R and b for data in milli-units */
683 val = DIV_ROUND_CLOSEST(val, 10);
690 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
691 struct pmbus_sensor *sensor, long val)
693 val = clamp_val(val, 500, 1600);
695 return 2 + DIV_ROUND_CLOSEST((1600 - val) * 100, 625);
698 static u16 pmbus_data2reg(struct pmbus_data *data,
699 struct pmbus_sensor *sensor, long val)
703 switch (data->info->format[sensor->class]) {
705 regval = pmbus_data2reg_direct(data, sensor, val);
708 regval = pmbus_data2reg_vid(data, sensor, val);
712 regval = pmbus_data2reg_linear(data, sensor, val);
719 * Return boolean calculated from converted data.
720 * <index> defines a status register index and mask.
721 * The mask is in the lower 8 bits, the register index is in bits 8..23.
723 * The associated pmbus_boolean structure contains optional pointers to two
724 * sensor attributes. If specified, those attributes are compared against each
725 * other to determine if a limit has been exceeded.
727 * If the sensor attribute pointers are NULL, the function returns true if
728 * (status[reg] & mask) is true.
730 * If sensor attribute pointers are provided, a comparison against a specified
731 * limit has to be performed to determine the boolean result.
732 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
733 * sensor values referenced by sensor attribute pointers s1 and s2).
735 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
736 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
738 * If a negative value is stored in any of the referenced registers, this value
739 * reflects an error code which will be returned.
741 static int pmbus_get_boolean(struct pmbus_data *data, struct pmbus_boolean *b,
744 struct pmbus_sensor *s1 = b->s1;
745 struct pmbus_sensor *s2 = b->s2;
746 u16 reg = (index >> 16) & 0xffff;
747 u16 mask = index & 0xffff;
751 status = data->status[reg];
755 regval = status & mask;
758 } else if (!s1 || !s2) {
759 WARN(1, "Bad boolean descriptor %p: s1=%p, s2=%p\n", b, s1, s2);
769 v1 = pmbus_reg2data(data, s1);
770 v2 = pmbus_reg2data(data, s2);
771 ret = !!(regval && v1 >= v2);
776 static ssize_t pmbus_show_boolean(struct device *dev,
777 struct device_attribute *da, char *buf)
779 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
780 struct pmbus_boolean *boolean = to_pmbus_boolean(attr);
781 struct pmbus_data *data = pmbus_update_device(dev);
784 val = pmbus_get_boolean(data, boolean, attr->index);
787 return snprintf(buf, PAGE_SIZE, "%d\n", val);
790 static ssize_t pmbus_show_sensor(struct device *dev,
791 struct device_attribute *devattr, char *buf)
793 struct pmbus_data *data = pmbus_update_device(dev);
794 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
796 if (sensor->data < 0)
799 return snprintf(buf, PAGE_SIZE, "%ld\n", pmbus_reg2data(data, sensor));
802 static ssize_t pmbus_set_sensor(struct device *dev,
803 struct device_attribute *devattr,
804 const char *buf, size_t count)
806 struct i2c_client *client = to_i2c_client(dev->parent);
807 struct pmbus_data *data = i2c_get_clientdata(client);
808 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
814 if (kstrtol(buf, 10, &val) < 0)
817 mutex_lock(&data->update_lock);
818 regval = pmbus_data2reg(data, sensor, val);
819 ret = _pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
823 sensor->data = regval;
824 mutex_unlock(&data->update_lock);
828 static ssize_t pmbus_show_label(struct device *dev,
829 struct device_attribute *da, char *buf)
831 struct pmbus_label *label = to_pmbus_label(da);
833 return snprintf(buf, PAGE_SIZE, "%s\n", label->label);
836 static int pmbus_add_attribute(struct pmbus_data *data, struct attribute *attr)
838 if (data->num_attributes >= data->max_attributes - 1) {
839 int new_max_attrs = data->max_attributes + PMBUS_ATTR_ALLOC_SIZE;
840 void *new_attrs = krealloc(data->group.attrs,
841 new_max_attrs * sizeof(void *),
845 data->group.attrs = new_attrs;
846 data->max_attributes = new_max_attrs;
849 data->group.attrs[data->num_attributes++] = attr;
850 data->group.attrs[data->num_attributes] = NULL;
854 static void pmbus_dev_attr_init(struct device_attribute *dev_attr,
857 ssize_t (*show)(struct device *dev,
858 struct device_attribute *attr,
860 ssize_t (*store)(struct device *dev,
861 struct device_attribute *attr,
862 const char *buf, size_t count))
864 sysfs_attr_init(&dev_attr->attr);
865 dev_attr->attr.name = name;
866 dev_attr->attr.mode = mode;
867 dev_attr->show = show;
868 dev_attr->store = store;
871 static void pmbus_attr_init(struct sensor_device_attribute *a,
874 ssize_t (*show)(struct device *dev,
875 struct device_attribute *attr,
877 ssize_t (*store)(struct device *dev,
878 struct device_attribute *attr,
879 const char *buf, size_t count),
882 pmbus_dev_attr_init(&a->dev_attr, name, mode, show, store);
886 static int pmbus_add_boolean(struct pmbus_data *data,
887 const char *name, const char *type, int seq,
888 struct pmbus_sensor *s1,
889 struct pmbus_sensor *s2,
892 struct pmbus_boolean *boolean;
893 struct sensor_device_attribute *a;
895 boolean = devm_kzalloc(data->dev, sizeof(*boolean), GFP_KERNEL);
899 a = &boolean->attribute;
901 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
905 pmbus_attr_init(a, boolean->name, S_IRUGO, pmbus_show_boolean, NULL,
908 return pmbus_add_attribute(data, &a->dev_attr.attr);
911 static struct pmbus_sensor *pmbus_add_sensor(struct pmbus_data *data,
912 const char *name, const char *type,
913 int seq, int page, int reg,
914 enum pmbus_sensor_classes class,
915 bool update, bool readonly)
917 struct pmbus_sensor *sensor;
918 struct device_attribute *a;
920 sensor = devm_kzalloc(data->dev, sizeof(*sensor), GFP_KERNEL);
923 a = &sensor->attribute;
925 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
929 sensor->class = class;
930 sensor->update = update;
931 pmbus_dev_attr_init(a, sensor->name,
932 readonly ? S_IRUGO : S_IRUGO | S_IWUSR,
933 pmbus_show_sensor, pmbus_set_sensor);
935 if (pmbus_add_attribute(data, &a->attr))
938 sensor->next = data->sensors;
939 data->sensors = sensor;
944 static int pmbus_add_label(struct pmbus_data *data,
945 const char *name, int seq,
946 const char *lstring, int index)
948 struct pmbus_label *label;
949 struct device_attribute *a;
951 label = devm_kzalloc(data->dev, sizeof(*label), GFP_KERNEL);
955 a = &label->attribute;
957 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
959 strncpy(label->label, lstring, sizeof(label->label) - 1);
961 snprintf(label->label, sizeof(label->label), "%s%d", lstring,
964 pmbus_dev_attr_init(a, label->name, S_IRUGO, pmbus_show_label, NULL);
965 return pmbus_add_attribute(data, &a->attr);
969 * Search for attributes. Allocate sensors, booleans, and labels as needed.
973 * The pmbus_limit_attr structure describes a single limit attribute
974 * and its associated alarm attribute.
976 struct pmbus_limit_attr {
977 u16 reg; /* Limit register */
978 u16 sbit; /* Alarm attribute status bit */
979 bool update; /* True if register needs updates */
980 bool low; /* True if low limit; for limits with compare
982 const char *attr; /* Attribute name */
983 const char *alarm; /* Alarm attribute name */
987 * The pmbus_sensor_attr structure describes one sensor attribute. This
988 * description includes a reference to the associated limit attributes.
990 struct pmbus_sensor_attr {
991 u16 reg; /* sensor register */
992 u16 gbit; /* generic status bit */
993 u8 nlimit; /* # of limit registers */
994 enum pmbus_sensor_classes class;/* sensor class */
995 const char *label; /* sensor label */
996 bool paged; /* true if paged sensor */
997 bool update; /* true if update needed */
998 bool compare; /* true if compare function needed */
999 u32 func; /* sensor mask */
1000 u32 sfunc; /* sensor status mask */
1001 int sbase; /* status base register */
1002 const struct pmbus_limit_attr *limit;/* limit registers */
1006 * Add a set of limit attributes and, if supported, the associated
1008 * returns 0 if no alarm register found, 1 if an alarm register was found,
1011 static int pmbus_add_limit_attrs(struct i2c_client *client,
1012 struct pmbus_data *data,
1013 const struct pmbus_driver_info *info,
1014 const char *name, int index, int page,
1015 struct pmbus_sensor *base,
1016 const struct pmbus_sensor_attr *attr)
1018 const struct pmbus_limit_attr *l = attr->limit;
1019 int nlimit = attr->nlimit;
1022 struct pmbus_sensor *curr;
1024 for (i = 0; i < nlimit; i++) {
1025 if (pmbus_check_word_register(client, page, l->reg)) {
1026 curr = pmbus_add_sensor(data, name, l->attr, index,
1027 page, l->reg, attr->class,
1028 attr->update || l->update,
1032 if (l->sbit && (info->func[page] & attr->sfunc)) {
1033 ret = pmbus_add_boolean(data, name,
1035 attr->compare ? l->low ? curr : base
1037 attr->compare ? l->low ? base : curr
1039 attr->sbase + page, l->sbit);
1050 static int pmbus_add_sensor_attrs_one(struct i2c_client *client,
1051 struct pmbus_data *data,
1052 const struct pmbus_driver_info *info,
1054 int index, int page,
1055 const struct pmbus_sensor_attr *attr)
1057 struct pmbus_sensor *base;
1058 bool upper = !!(attr->gbit & 0xff00); /* need to check STATUS_WORD */
1062 ret = pmbus_add_label(data, name, index, attr->label,
1063 attr->paged ? page + 1 : 0);
1067 base = pmbus_add_sensor(data, name, "input", index, page, attr->reg,
1068 attr->class, true, true);
1072 ret = pmbus_add_limit_attrs(client, data, info, name,
1073 index, page, base, attr);
1077 * Add generic alarm attribute only if there are no individual
1078 * alarm attributes, if there is a global alarm bit, and if
1079 * the generic status register (word or byte, depending on
1080 * which global bit is set) for this page is accessible.
1082 if (!ret && attr->gbit &&
1083 (!upper || (upper && data->has_status_word)) &&
1084 pmbus_check_status_register(client, page)) {
1085 ret = pmbus_add_boolean(data, name, "alarm", index,
1087 PB_STATUS_BASE + page,
1096 static int pmbus_add_sensor_attrs(struct i2c_client *client,
1097 struct pmbus_data *data,
1099 const struct pmbus_sensor_attr *attrs,
1102 const struct pmbus_driver_info *info = data->info;
1107 for (i = 0; i < nattrs; i++) {
1110 pages = attrs->paged ? info->pages : 1;
1111 for (page = 0; page < pages; page++) {
1112 if (!(info->func[page] & attrs->func))
1114 ret = pmbus_add_sensor_attrs_one(client, data, info,
1126 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1128 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1130 .alarm = "min_alarm",
1131 .sbit = PB_VOLTAGE_UV_WARNING,
1133 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1135 .alarm = "lcrit_alarm",
1136 .sbit = PB_VOLTAGE_UV_FAULT,
1138 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1140 .alarm = "max_alarm",
1141 .sbit = PB_VOLTAGE_OV_WARNING,
1143 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1145 .alarm = "crit_alarm",
1146 .sbit = PB_VOLTAGE_OV_FAULT,
1148 .reg = PMBUS_VIRT_READ_VIN_AVG,
1152 .reg = PMBUS_VIRT_READ_VIN_MIN,
1156 .reg = PMBUS_VIRT_READ_VIN_MAX,
1160 .reg = PMBUS_VIRT_RESET_VIN_HISTORY,
1161 .attr = "reset_history",
1165 static const struct pmbus_limit_attr vmon_limit_attrs[] = {
1167 .reg = PMBUS_VIRT_VMON_UV_WARN_LIMIT,
1169 .alarm = "min_alarm",
1170 .sbit = PB_VOLTAGE_UV_WARNING,
1172 .reg = PMBUS_VIRT_VMON_UV_FAULT_LIMIT,
1174 .alarm = "lcrit_alarm",
1175 .sbit = PB_VOLTAGE_UV_FAULT,
1177 .reg = PMBUS_VIRT_VMON_OV_WARN_LIMIT,
1179 .alarm = "max_alarm",
1180 .sbit = PB_VOLTAGE_OV_WARNING,
1182 .reg = PMBUS_VIRT_VMON_OV_FAULT_LIMIT,
1184 .alarm = "crit_alarm",
1185 .sbit = PB_VOLTAGE_OV_FAULT,
1189 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1191 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1193 .alarm = "min_alarm",
1194 .sbit = PB_VOLTAGE_UV_WARNING,
1196 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1198 .alarm = "lcrit_alarm",
1199 .sbit = PB_VOLTAGE_UV_FAULT,
1201 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1203 .alarm = "max_alarm",
1204 .sbit = PB_VOLTAGE_OV_WARNING,
1206 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1208 .alarm = "crit_alarm",
1209 .sbit = PB_VOLTAGE_OV_FAULT,
1211 .reg = PMBUS_VIRT_READ_VOUT_AVG,
1215 .reg = PMBUS_VIRT_READ_VOUT_MIN,
1219 .reg = PMBUS_VIRT_READ_VOUT_MAX,
1223 .reg = PMBUS_VIRT_RESET_VOUT_HISTORY,
1224 .attr = "reset_history",
1228 static const struct pmbus_sensor_attr voltage_attributes[] = {
1230 .reg = PMBUS_READ_VIN,
1231 .class = PSC_VOLTAGE_IN,
1233 .func = PMBUS_HAVE_VIN,
1234 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1235 .sbase = PB_STATUS_INPUT_BASE,
1236 .gbit = PB_STATUS_VIN_UV,
1237 .limit = vin_limit_attrs,
1238 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1240 .reg = PMBUS_VIRT_READ_VMON,
1241 .class = PSC_VOLTAGE_IN,
1243 .func = PMBUS_HAVE_VMON,
1244 .sfunc = PMBUS_HAVE_STATUS_VMON,
1245 .sbase = PB_STATUS_VMON_BASE,
1246 .limit = vmon_limit_attrs,
1247 .nlimit = ARRAY_SIZE(vmon_limit_attrs),
1249 .reg = PMBUS_READ_VCAP,
1250 .class = PSC_VOLTAGE_IN,
1252 .func = PMBUS_HAVE_VCAP,
1254 .reg = PMBUS_READ_VOUT,
1255 .class = PSC_VOLTAGE_OUT,
1258 .func = PMBUS_HAVE_VOUT,
1259 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1260 .sbase = PB_STATUS_VOUT_BASE,
1261 .gbit = PB_STATUS_VOUT_OV,
1262 .limit = vout_limit_attrs,
1263 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1267 /* Current attributes */
1269 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1271 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1273 .alarm = "max_alarm",
1274 .sbit = PB_IIN_OC_WARNING,
1276 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1278 .alarm = "crit_alarm",
1279 .sbit = PB_IIN_OC_FAULT,
1281 .reg = PMBUS_VIRT_READ_IIN_AVG,
1285 .reg = PMBUS_VIRT_READ_IIN_MIN,
1289 .reg = PMBUS_VIRT_READ_IIN_MAX,
1293 .reg = PMBUS_VIRT_RESET_IIN_HISTORY,
1294 .attr = "reset_history",
1298 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1300 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1302 .alarm = "max_alarm",
1303 .sbit = PB_IOUT_OC_WARNING,
1305 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1307 .alarm = "lcrit_alarm",
1308 .sbit = PB_IOUT_UC_FAULT,
1310 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1312 .alarm = "crit_alarm",
1313 .sbit = PB_IOUT_OC_FAULT,
1315 .reg = PMBUS_VIRT_READ_IOUT_AVG,
1319 .reg = PMBUS_VIRT_READ_IOUT_MIN,
1323 .reg = PMBUS_VIRT_READ_IOUT_MAX,
1327 .reg = PMBUS_VIRT_RESET_IOUT_HISTORY,
1328 .attr = "reset_history",
1332 static const struct pmbus_sensor_attr current_attributes[] = {
1334 .reg = PMBUS_READ_IIN,
1335 .class = PSC_CURRENT_IN,
1337 .func = PMBUS_HAVE_IIN,
1338 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1339 .sbase = PB_STATUS_INPUT_BASE,
1340 .gbit = PB_STATUS_INPUT,
1341 .limit = iin_limit_attrs,
1342 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1344 .reg = PMBUS_READ_IOUT,
1345 .class = PSC_CURRENT_OUT,
1348 .func = PMBUS_HAVE_IOUT,
1349 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1350 .sbase = PB_STATUS_IOUT_BASE,
1351 .gbit = PB_STATUS_IOUT_OC,
1352 .limit = iout_limit_attrs,
1353 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1357 /* Power attributes */
1359 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1361 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1364 .sbit = PB_PIN_OP_WARNING,
1366 .reg = PMBUS_VIRT_READ_PIN_AVG,
1370 .reg = PMBUS_VIRT_READ_PIN_MIN,
1372 .attr = "input_lowest",
1374 .reg = PMBUS_VIRT_READ_PIN_MAX,
1376 .attr = "input_highest",
1378 .reg = PMBUS_VIRT_RESET_PIN_HISTORY,
1379 .attr = "reset_history",
1383 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1385 .reg = PMBUS_POUT_MAX,
1387 .alarm = "cap_alarm",
1388 .sbit = PB_POWER_LIMITING,
1390 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1392 .alarm = "max_alarm",
1393 .sbit = PB_POUT_OP_WARNING,
1395 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1397 .alarm = "crit_alarm",
1398 .sbit = PB_POUT_OP_FAULT,
1400 .reg = PMBUS_VIRT_READ_POUT_AVG,
1404 .reg = PMBUS_VIRT_READ_POUT_MIN,
1406 .attr = "input_lowest",
1408 .reg = PMBUS_VIRT_READ_POUT_MAX,
1410 .attr = "input_highest",
1412 .reg = PMBUS_VIRT_RESET_POUT_HISTORY,
1413 .attr = "reset_history",
1417 static const struct pmbus_sensor_attr power_attributes[] = {
1419 .reg = PMBUS_READ_PIN,
1422 .func = PMBUS_HAVE_PIN,
1423 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1424 .sbase = PB_STATUS_INPUT_BASE,
1425 .gbit = PB_STATUS_INPUT,
1426 .limit = pin_limit_attrs,
1427 .nlimit = ARRAY_SIZE(pin_limit_attrs),
1429 .reg = PMBUS_READ_POUT,
1433 .func = PMBUS_HAVE_POUT,
1434 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1435 .sbase = PB_STATUS_IOUT_BASE,
1436 .limit = pout_limit_attrs,
1437 .nlimit = ARRAY_SIZE(pout_limit_attrs),
1441 /* Temperature atributes */
1443 static const struct pmbus_limit_attr temp_limit_attrs[] = {
1445 .reg = PMBUS_UT_WARN_LIMIT,
1448 .alarm = "min_alarm",
1449 .sbit = PB_TEMP_UT_WARNING,
1451 .reg = PMBUS_UT_FAULT_LIMIT,
1454 .alarm = "lcrit_alarm",
1455 .sbit = PB_TEMP_UT_FAULT,
1457 .reg = PMBUS_OT_WARN_LIMIT,
1459 .alarm = "max_alarm",
1460 .sbit = PB_TEMP_OT_WARNING,
1462 .reg = PMBUS_OT_FAULT_LIMIT,
1464 .alarm = "crit_alarm",
1465 .sbit = PB_TEMP_OT_FAULT,
1467 .reg = PMBUS_VIRT_READ_TEMP_MIN,
1470 .reg = PMBUS_VIRT_READ_TEMP_AVG,
1473 .reg = PMBUS_VIRT_READ_TEMP_MAX,
1476 .reg = PMBUS_VIRT_RESET_TEMP_HISTORY,
1477 .attr = "reset_history",
1481 static const struct pmbus_limit_attr temp_limit_attrs2[] = {
1483 .reg = PMBUS_UT_WARN_LIMIT,
1486 .alarm = "min_alarm",
1487 .sbit = PB_TEMP_UT_WARNING,
1489 .reg = PMBUS_UT_FAULT_LIMIT,
1492 .alarm = "lcrit_alarm",
1493 .sbit = PB_TEMP_UT_FAULT,
1495 .reg = PMBUS_OT_WARN_LIMIT,
1497 .alarm = "max_alarm",
1498 .sbit = PB_TEMP_OT_WARNING,
1500 .reg = PMBUS_OT_FAULT_LIMIT,
1502 .alarm = "crit_alarm",
1503 .sbit = PB_TEMP_OT_FAULT,
1505 .reg = PMBUS_VIRT_READ_TEMP2_MIN,
1508 .reg = PMBUS_VIRT_READ_TEMP2_AVG,
1511 .reg = PMBUS_VIRT_READ_TEMP2_MAX,
1514 .reg = PMBUS_VIRT_RESET_TEMP2_HISTORY,
1515 .attr = "reset_history",
1519 static const struct pmbus_limit_attr temp_limit_attrs3[] = {
1521 .reg = PMBUS_UT_WARN_LIMIT,
1524 .alarm = "min_alarm",
1525 .sbit = PB_TEMP_UT_WARNING,
1527 .reg = PMBUS_UT_FAULT_LIMIT,
1530 .alarm = "lcrit_alarm",
1531 .sbit = PB_TEMP_UT_FAULT,
1533 .reg = PMBUS_OT_WARN_LIMIT,
1535 .alarm = "max_alarm",
1536 .sbit = PB_TEMP_OT_WARNING,
1538 .reg = PMBUS_OT_FAULT_LIMIT,
1540 .alarm = "crit_alarm",
1541 .sbit = PB_TEMP_OT_FAULT,
1545 static const struct pmbus_sensor_attr temp_attributes[] = {
1547 .reg = PMBUS_READ_TEMPERATURE_1,
1548 .class = PSC_TEMPERATURE,
1552 .func = PMBUS_HAVE_TEMP,
1553 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1554 .sbase = PB_STATUS_TEMP_BASE,
1555 .gbit = PB_STATUS_TEMPERATURE,
1556 .limit = temp_limit_attrs,
1557 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1559 .reg = PMBUS_READ_TEMPERATURE_2,
1560 .class = PSC_TEMPERATURE,
1564 .func = PMBUS_HAVE_TEMP2,
1565 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1566 .sbase = PB_STATUS_TEMP_BASE,
1567 .gbit = PB_STATUS_TEMPERATURE,
1568 .limit = temp_limit_attrs2,
1569 .nlimit = ARRAY_SIZE(temp_limit_attrs2),
1571 .reg = PMBUS_READ_TEMPERATURE_3,
1572 .class = PSC_TEMPERATURE,
1576 .func = PMBUS_HAVE_TEMP3,
1577 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1578 .sbase = PB_STATUS_TEMP_BASE,
1579 .gbit = PB_STATUS_TEMPERATURE,
1580 .limit = temp_limit_attrs3,
1581 .nlimit = ARRAY_SIZE(temp_limit_attrs3),
1585 static const int pmbus_fan_registers[] = {
1586 PMBUS_READ_FAN_SPEED_1,
1587 PMBUS_READ_FAN_SPEED_2,
1588 PMBUS_READ_FAN_SPEED_3,
1589 PMBUS_READ_FAN_SPEED_4
1592 static const int pmbus_fan_config_registers[] = {
1593 PMBUS_FAN_CONFIG_12,
1594 PMBUS_FAN_CONFIG_12,
1595 PMBUS_FAN_CONFIG_34,
1599 static const int pmbus_fan_status_registers[] = {
1600 PMBUS_STATUS_FAN_12,
1601 PMBUS_STATUS_FAN_12,
1602 PMBUS_STATUS_FAN_34,
1606 static const u32 pmbus_fan_flags[] = {
1613 static const u32 pmbus_fan_status_flags[] = {
1614 PMBUS_HAVE_STATUS_FAN12,
1615 PMBUS_HAVE_STATUS_FAN12,
1616 PMBUS_HAVE_STATUS_FAN34,
1617 PMBUS_HAVE_STATUS_FAN34
1621 static int pmbus_add_fan_attributes(struct i2c_client *client,
1622 struct pmbus_data *data)
1624 const struct pmbus_driver_info *info = data->info;
1629 for (page = 0; page < info->pages; page++) {
1632 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
1635 if (!(info->func[page] & pmbus_fan_flags[f]))
1638 if (!pmbus_check_word_register(client, page,
1639 pmbus_fan_registers[f]))
1643 * Skip fan if not installed.
1644 * Each fan configuration register covers multiple fans,
1645 * so we have to do some magic.
1647 regval = _pmbus_read_byte_data(client, page,
1648 pmbus_fan_config_registers[f]);
1650 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
1653 if (pmbus_add_sensor(data, "fan", "input", index,
1654 page, pmbus_fan_registers[f],
1655 PSC_FAN, true, true) == NULL)
1659 * Each fan status register covers multiple fans,
1660 * so we have to do some magic.
1662 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
1663 pmbus_check_byte_register(client,
1664 page, pmbus_fan_status_registers[f])) {
1667 if (f > 1) /* fan 3, 4 */
1668 base = PB_STATUS_FAN34_BASE + page;
1670 base = PB_STATUS_FAN_BASE + page;
1671 ret = pmbus_add_boolean(data, "fan",
1672 "alarm", index, NULL, NULL, base,
1673 PB_FAN_FAN1_WARNING >> (f & 1));
1676 ret = pmbus_add_boolean(data, "fan",
1677 "fault", index, NULL, NULL, base,
1678 PB_FAN_FAN1_FAULT >> (f & 1));
1688 static int pmbus_find_attributes(struct i2c_client *client,
1689 struct pmbus_data *data)
1693 /* Voltage sensors */
1694 ret = pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
1695 ARRAY_SIZE(voltage_attributes));
1699 /* Current sensors */
1700 ret = pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
1701 ARRAY_SIZE(current_attributes));
1706 ret = pmbus_add_sensor_attrs(client, data, "power", power_attributes,
1707 ARRAY_SIZE(power_attributes));
1711 /* Temperature sensors */
1712 ret = pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
1713 ARRAY_SIZE(temp_attributes));
1718 ret = pmbus_add_fan_attributes(client, data);
1723 * Identify chip parameters.
1724 * This function is called for all chips.
1726 static int pmbus_identify_common(struct i2c_client *client,
1727 struct pmbus_data *data, int page)
1731 if (pmbus_check_byte_register(client, page, PMBUS_VOUT_MODE))
1732 vout_mode = _pmbus_read_byte_data(client, page,
1734 if (vout_mode >= 0 && vout_mode != 0xff) {
1736 * Not all chips support the VOUT_MODE command,
1737 * so a failure to read it is not an error.
1739 switch (vout_mode >> 5) {
1740 case 0: /* linear mode */
1741 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
1744 data->exponent[page] = ((s8)(vout_mode << 3)) >> 3;
1746 case 1: /* VID mode */
1747 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
1750 case 2: /* direct mode */
1751 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
1759 pmbus_clear_fault_page(client, page);
1763 static int pmbus_read_status_byte(struct i2c_client *client, int page)
1765 return _pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
1768 static int pmbus_read_status_word(struct i2c_client *client, int page)
1770 return _pmbus_read_word_data(client, page, PMBUS_STATUS_WORD);
1773 static int pmbus_init_common(struct i2c_client *client, struct pmbus_data *data,
1774 struct pmbus_driver_info *info)
1776 struct device *dev = &client->dev;
1780 * Some PMBus chips don't support PMBUS_STATUS_WORD, so try
1781 * to use PMBUS_STATUS_BYTE instead if that is the case.
1782 * Bail out if both registers are not supported.
1784 data->read_status = pmbus_read_status_word;
1785 ret = i2c_smbus_read_word_data(client, PMBUS_STATUS_WORD);
1786 if (ret < 0 || ret == 0xffff) {
1787 data->read_status = pmbus_read_status_byte;
1788 ret = i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE);
1789 if (ret < 0 || ret == 0xff) {
1790 dev_err(dev, "PMBus status register not found\n");
1794 data->has_status_word = true;
1797 /* Enable PEC if the controller supports it */
1798 ret = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
1799 if (ret >= 0 && (ret & PB_CAPABILITY_ERROR_CHECK))
1800 client->flags |= I2C_CLIENT_PEC;
1802 pmbus_clear_faults(client);
1804 if (info->identify) {
1805 ret = (*info->identify)(client, info);
1807 dev_err(dev, "Chip identification failed\n");
1812 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
1813 dev_err(dev, "Bad number of PMBus pages: %d\n", info->pages);
1817 for (page = 0; page < info->pages; page++) {
1818 ret = pmbus_identify_common(client, data, page);
1820 dev_err(dev, "Failed to identify chip capabilities\n");
1827 #if IS_ENABLED(CONFIG_REGULATOR)
1828 static int pmbus_regulator_is_enabled(struct regulator_dev *rdev)
1830 struct device *dev = rdev_get_dev(rdev);
1831 struct i2c_client *client = to_i2c_client(dev->parent);
1832 u8 page = rdev_get_id(rdev);
1835 ret = pmbus_read_byte_data(client, page, PMBUS_OPERATION);
1839 return !!(ret & PB_OPERATION_CONTROL_ON);
1842 static int _pmbus_regulator_on_off(struct regulator_dev *rdev, bool enable)
1844 struct device *dev = rdev_get_dev(rdev);
1845 struct i2c_client *client = to_i2c_client(dev->parent);
1846 u8 page = rdev_get_id(rdev);
1848 return pmbus_update_byte_data(client, page, PMBUS_OPERATION,
1849 PB_OPERATION_CONTROL_ON,
1850 enable ? PB_OPERATION_CONTROL_ON : 0);
1853 static int pmbus_regulator_enable(struct regulator_dev *rdev)
1855 return _pmbus_regulator_on_off(rdev, 1);
1858 static int pmbus_regulator_disable(struct regulator_dev *rdev)
1860 return _pmbus_regulator_on_off(rdev, 0);
1863 const struct regulator_ops pmbus_regulator_ops = {
1864 .enable = pmbus_regulator_enable,
1865 .disable = pmbus_regulator_disable,
1866 .is_enabled = pmbus_regulator_is_enabled,
1868 EXPORT_SYMBOL_GPL(pmbus_regulator_ops);
1870 static int pmbus_regulator_register(struct pmbus_data *data)
1872 struct device *dev = data->dev;
1873 const struct pmbus_driver_info *info = data->info;
1874 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
1875 struct regulator_dev *rdev;
1878 for (i = 0; i < info->num_regulators; i++) {
1879 struct regulator_config config = { };
1882 config.driver_data = data;
1884 if (pdata && pdata->reg_init_data)
1885 config.init_data = &pdata->reg_init_data[i];
1887 rdev = devm_regulator_register(dev, &info->reg_desc[i],
1890 dev_err(dev, "Failed to register %s regulator\n",
1891 info->reg_desc[i].name);
1892 return PTR_ERR(rdev);
1899 static int pmbus_regulator_register(struct pmbus_data *data)
1905 static struct dentry *pmbus_debugfs_dir; /* pmbus debugfs directory */
1907 #if IS_ENABLED(CONFIG_DEBUG_FS)
1908 static int pmbus_debugfs_get(void *data, u64 *val)
1911 struct pmbus_debugfs_entry *entry = data;
1913 rc = _pmbus_read_byte_data(entry->client, entry->page, entry->reg);
1921 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops, pmbus_debugfs_get, NULL,
1924 static int pmbus_debugfs_get_status(void *data, u64 *val)
1927 struct pmbus_debugfs_entry *entry = data;
1928 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
1930 rc = pdata->read_status(entry->client, entry->page);
1938 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_status, pmbus_debugfs_get_status,
1939 NULL, "0x%04llx\n");
1941 static int pmbus_init_debugfs(struct i2c_client *client,
1942 struct pmbus_data *data)
1945 char name[PMBUS_NAME_SIZE];
1946 struct pmbus_debugfs_entry *entries;
1948 if (!pmbus_debugfs_dir)
1952 * Create the debugfs directory for this device. Use the hwmon device
1953 * name to avoid conflicts (hwmon numbers are globally unique).
1955 data->debugfs = debugfs_create_dir(dev_name(data->hwmon_dev),
1957 if (IS_ERR_OR_NULL(data->debugfs)) {
1958 data->debugfs = NULL;
1962 /* Allocate the max possible entries we need. */
1963 entries = devm_kzalloc(data->dev,
1964 sizeof(*entries) * (data->info->pages * 10),
1969 for (i = 0; i < data->info->pages; ++i) {
1970 /* Check accessibility of status register if it's not page 0 */
1971 if (!i || pmbus_check_status_register(client, i)) {
1972 /* No need to set reg as we have special read op. */
1973 entries[idx].client = client;
1974 entries[idx].page = i;
1975 scnprintf(name, PMBUS_NAME_SIZE, "status%d", i);
1976 debugfs_create_file(name, 0444, data->debugfs,
1978 &pmbus_debugfs_ops_status);
1981 if (data->info->func[i] & PMBUS_HAVE_STATUS_VOUT) {
1982 entries[idx].client = client;
1983 entries[idx].page = i;
1984 entries[idx].reg = PMBUS_STATUS_VOUT;
1985 scnprintf(name, PMBUS_NAME_SIZE, "status%d_vout", i);
1986 debugfs_create_file(name, 0444, data->debugfs,
1988 &pmbus_debugfs_ops);
1991 if (data->info->func[i] & PMBUS_HAVE_STATUS_IOUT) {
1992 entries[idx].client = client;
1993 entries[idx].page = i;
1994 entries[idx].reg = PMBUS_STATUS_IOUT;
1995 scnprintf(name, PMBUS_NAME_SIZE, "status%d_iout", i);
1996 debugfs_create_file(name, 0444, data->debugfs,
1998 &pmbus_debugfs_ops);
2001 if (data->info->func[i] & PMBUS_HAVE_STATUS_INPUT) {
2002 entries[idx].client = client;
2003 entries[idx].page = i;
2004 entries[idx].reg = PMBUS_STATUS_INPUT;
2005 scnprintf(name, PMBUS_NAME_SIZE, "status%d_input", i);
2006 debugfs_create_file(name, 0444, data->debugfs,
2008 &pmbus_debugfs_ops);
2011 if (data->info->func[i] & PMBUS_HAVE_STATUS_TEMP) {
2012 entries[idx].client = client;
2013 entries[idx].page = i;
2014 entries[idx].reg = PMBUS_STATUS_TEMPERATURE;
2015 scnprintf(name, PMBUS_NAME_SIZE, "status%d_temp", i);
2016 debugfs_create_file(name, 0444, data->debugfs,
2018 &pmbus_debugfs_ops);
2021 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_CML)) {
2022 entries[idx].client = client;
2023 entries[idx].page = i;
2024 entries[idx].reg = PMBUS_STATUS_CML;
2025 scnprintf(name, PMBUS_NAME_SIZE, "status%d_cml", i);
2026 debugfs_create_file(name, 0444, data->debugfs,
2028 &pmbus_debugfs_ops);
2031 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_OTHER)) {
2032 entries[idx].client = client;
2033 entries[idx].page = i;
2034 entries[idx].reg = PMBUS_STATUS_OTHER;
2035 scnprintf(name, PMBUS_NAME_SIZE, "status%d_other", i);
2036 debugfs_create_file(name, 0444, data->debugfs,
2038 &pmbus_debugfs_ops);
2041 if (pmbus_check_byte_register(client, i,
2042 PMBUS_STATUS_MFR_SPECIFIC)) {
2043 entries[idx].client = client;
2044 entries[idx].page = i;
2045 entries[idx].reg = PMBUS_STATUS_MFR_SPECIFIC;
2046 scnprintf(name, PMBUS_NAME_SIZE, "status%d_mfr", i);
2047 debugfs_create_file(name, 0444, data->debugfs,
2049 &pmbus_debugfs_ops);
2052 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN12) {
2053 entries[idx].client = client;
2054 entries[idx].page = i;
2055 entries[idx].reg = PMBUS_STATUS_FAN_12;
2056 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan12", i);
2057 debugfs_create_file(name, 0444, data->debugfs,
2059 &pmbus_debugfs_ops);
2062 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN34) {
2063 entries[idx].client = client;
2064 entries[idx].page = i;
2065 entries[idx].reg = PMBUS_STATUS_FAN_34;
2066 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan34", i);
2067 debugfs_create_file(name, 0444, data->debugfs,
2069 &pmbus_debugfs_ops);
2076 static int pmbus_init_debugfs(struct i2c_client *client,
2077 struct pmbus_data *data)
2081 #endif /* IS_ENABLED(CONFIG_DEBUG_FS) */
2083 int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
2084 struct pmbus_driver_info *info)
2086 struct device *dev = &client->dev;
2087 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
2088 struct pmbus_data *data;
2094 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
2095 | I2C_FUNC_SMBUS_BYTE_DATA
2096 | I2C_FUNC_SMBUS_WORD_DATA))
2099 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
2103 i2c_set_clientdata(client, data);
2104 mutex_init(&data->update_lock);
2108 data->flags = pdata->flags;
2111 ret = pmbus_init_common(client, data, info);
2115 ret = pmbus_find_attributes(client, data);
2120 * If there are no attributes, something is wrong.
2121 * Bail out instead of trying to register nothing.
2123 if (!data->num_attributes) {
2124 dev_err(dev, "No attributes found\n");
2129 data->groups[0] = &data->group;
2130 data->hwmon_dev = hwmon_device_register_with_groups(dev, client->name,
2131 data, data->groups);
2132 if (IS_ERR(data->hwmon_dev)) {
2133 ret = PTR_ERR(data->hwmon_dev);
2134 dev_err(dev, "Failed to register hwmon device\n");
2138 ret = pmbus_regulator_register(data);
2140 goto out_unregister;
2142 ret = pmbus_init_debugfs(client, data);
2144 dev_warn(dev, "Failed to register debugfs\n");
2149 hwmon_device_unregister(data->hwmon_dev);
2151 kfree(data->group.attrs);
2154 EXPORT_SYMBOL_GPL(pmbus_do_probe);
2156 int pmbus_do_remove(struct i2c_client *client)
2158 struct pmbus_data *data = i2c_get_clientdata(client);
2160 debugfs_remove_recursive(data->debugfs);
2162 hwmon_device_unregister(data->hwmon_dev);
2163 kfree(data->group.attrs);
2166 EXPORT_SYMBOL_GPL(pmbus_do_remove);
2168 static int __init pmbus_core_init(void)
2170 pmbus_debugfs_dir = debugfs_create_dir("pmbus", NULL);
2171 if (IS_ERR(pmbus_debugfs_dir))
2172 pmbus_debugfs_dir = NULL;
2177 static void __exit pmbus_core_exit(void)
2179 debugfs_remove_recursive(pmbus_debugfs_dir);
2182 module_init(pmbus_core_init);
2183 module_exit(pmbus_core_exit);
2185 MODULE_AUTHOR("Guenter Roeck");
2186 MODULE_DESCRIPTION("PMBus core driver");
2187 MODULE_LICENSE("GPL");