2 * Hardware monitoring driver for PMBus devices
4 * Copyright (c) 2010, 2011 Ericsson AB.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <linux/i2c.h>
27 #include <linux/hwmon.h>
28 #include <linux/hwmon-sysfs.h>
29 #include <linux/delay.h>
30 #include <linux/i2c/pmbus.h>
34 * Constants needed to determine number of sensors, booleans, and labels.
36 #define PMBUS_MAX_INPUT_SENSORS 11 /* 6*volt, 3*curr, 2*power */
37 #define PMBUS_VOUT_SENSORS_PER_PAGE 5 /* input, min, max, lcrit,
39 #define PMBUS_IOUT_SENSORS_PER_PAGE 4 /* input, min, max, crit */
40 #define PMBUS_POUT_SENSORS_PER_PAGE 4 /* input, cap, max, crit */
41 #define PMBUS_MAX_SENSORS_PER_FAN 1 /* input */
42 #define PMBUS_MAX_SENSORS_PER_TEMP 5 /* input, min, max, lcrit,
45 #define PMBUS_MAX_INPUT_BOOLEANS 7 /* v: min_alarm, max_alarm,
46 lcrit_alarm, crit_alarm;
49 #define PMBUS_VOUT_BOOLEANS_PER_PAGE 4 /* min_alarm, max_alarm,
50 lcrit_alarm, crit_alarm */
51 #define PMBUS_IOUT_BOOLEANS_PER_PAGE 3 /* alarm, lcrit_alarm,
53 #define PMBUS_POUT_BOOLEANS_PER_PAGE 2 /* alarm, crit_alarm */
54 #define PMBUS_MAX_BOOLEANS_PER_FAN 2 /* alarm, fault */
55 #define PMBUS_MAX_BOOLEANS_PER_TEMP 4 /* min_alarm, max_alarm,
56 lcrit_alarm, crit_alarm */
58 #define PMBUS_MAX_INPUT_LABELS 4 /* vin, vcap, iin, pin */
61 * status, status_vout, status_iout, status_fans, status_fan34, and status_temp
62 * are paged. status_input is unpaged.
64 #define PB_NUM_STATUS_REG (PMBUS_PAGES * 6 + 1)
67 * Index into status register array, per status register group
69 #define PB_STATUS_BASE 0
70 #define PB_STATUS_VOUT_BASE (PB_STATUS_BASE + PMBUS_PAGES)
71 #define PB_STATUS_IOUT_BASE (PB_STATUS_VOUT_BASE + PMBUS_PAGES)
72 #define PB_STATUS_FAN_BASE (PB_STATUS_IOUT_BASE + PMBUS_PAGES)
73 #define PB_STATUS_FAN34_BASE (PB_STATUS_FAN_BASE + PMBUS_PAGES)
74 #define PB_STATUS_INPUT_BASE (PB_STATUS_FAN34_BASE + PMBUS_PAGES)
75 #define PB_STATUS_TEMP_BASE (PB_STATUS_INPUT_BASE + 1)
78 char name[I2C_NAME_SIZE]; /* sysfs sensor name */
79 struct sensor_device_attribute attribute;
80 u8 page; /* page number */
81 u8 reg; /* register */
82 enum pmbus_sensor_classes class; /* sensor class */
83 bool update; /* runtime sensor update needed */
84 int data; /* Sensor data.
85 Negative if there was a read error */
88 struct pmbus_boolean {
89 char name[I2C_NAME_SIZE]; /* sysfs boolean name */
90 struct sensor_device_attribute attribute;
94 char name[I2C_NAME_SIZE]; /* sysfs label name */
95 struct sensor_device_attribute attribute;
96 char label[I2C_NAME_SIZE]; /* label */
100 struct device *hwmon_dev;
102 u32 flags; /* from platform data */
104 int exponent; /* linear mode: exponent for output voltages */
106 const struct pmbus_driver_info *info;
110 struct attribute **attributes;
111 struct attribute_group group;
114 * Sensors cover both sensor and limit registers.
118 struct pmbus_sensor *sensors;
120 * Booleans are used for alarms.
121 * Values are determined from status registers.
125 struct pmbus_boolean *booleans;
127 * Labels are used to map generic names (e.g., "in1")
128 * to PMBus specific names (e.g., "vin" or "vout1").
132 struct pmbus_label *labels;
134 struct mutex update_lock;
136 unsigned long last_updated; /* in jiffies */
139 * A single status register covers multiple attributes,
140 * so we keep them all together.
142 u8 status[PB_NUM_STATUS_REG];
147 int pmbus_set_page(struct i2c_client *client, u8 page)
149 struct pmbus_data *data = i2c_get_clientdata(client);
153 if (page != data->currpage) {
154 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
155 newpage = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
159 data->currpage = page;
163 EXPORT_SYMBOL_GPL(pmbus_set_page);
165 static int pmbus_write_byte(struct i2c_client *client, u8 page, u8 value)
169 rv = pmbus_set_page(client, page);
173 return i2c_smbus_write_byte(client, value);
176 static int pmbus_write_word_data(struct i2c_client *client, u8 page, u8 reg,
181 rv = pmbus_set_page(client, page);
185 return i2c_smbus_write_word_data(client, reg, word);
188 int pmbus_read_word_data(struct i2c_client *client, u8 page, u8 reg)
192 rv = pmbus_set_page(client, page);
196 return i2c_smbus_read_word_data(client, reg);
198 EXPORT_SYMBOL_GPL(pmbus_read_word_data);
200 int pmbus_read_byte_data(struct i2c_client *client, u8 page, u8 reg)
204 rv = pmbus_set_page(client, page);
208 return i2c_smbus_read_byte_data(client, reg);
210 EXPORT_SYMBOL_GPL(pmbus_read_byte_data);
212 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
214 pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
217 void pmbus_clear_faults(struct i2c_client *client)
219 struct pmbus_data *data = i2c_get_clientdata(client);
222 for (i = 0; i < data->info->pages; i++)
223 pmbus_clear_fault_page(client, i);
225 EXPORT_SYMBOL_GPL(pmbus_clear_faults);
227 static int pmbus_check_status_cml(struct i2c_client *client, int page)
231 status = pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
232 if (status < 0 || (status & PB_STATUS_CML)) {
233 status2 = pmbus_read_byte_data(client, page, PMBUS_STATUS_CML);
234 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
240 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
243 struct pmbus_data *data = i2c_get_clientdata(client);
245 rv = pmbus_read_byte_data(client, page, reg);
246 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
247 rv = pmbus_check_status_cml(client, page);
248 pmbus_clear_fault_page(client, page);
251 EXPORT_SYMBOL_GPL(pmbus_check_byte_register);
253 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
256 struct pmbus_data *data = i2c_get_clientdata(client);
258 rv = pmbus_read_word_data(client, page, reg);
259 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
260 rv = pmbus_check_status_cml(client, page);
261 pmbus_clear_fault_page(client, page);
264 EXPORT_SYMBOL_GPL(pmbus_check_word_register);
266 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
268 struct pmbus_data *data = i2c_get_clientdata(client);
272 EXPORT_SYMBOL_GPL(pmbus_get_driver_info);
275 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
276 * a device specific mapping funcion exists and calls it if necessary.
278 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
280 struct pmbus_data *data = i2c_get_clientdata(client);
281 const struct pmbus_driver_info *info = data->info;
284 if (info->read_byte_data) {
285 status = info->read_byte_data(client, page, reg);
286 if (status != -ENODATA)
289 return pmbus_read_byte_data(client, page, reg);
292 static struct pmbus_data *pmbus_update_device(struct device *dev)
294 struct i2c_client *client = to_i2c_client(dev);
295 struct pmbus_data *data = i2c_get_clientdata(client);
296 const struct pmbus_driver_info *info = data->info;
298 mutex_lock(&data->update_lock);
299 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
302 for (i = 0; i < info->pages; i++)
303 data->status[PB_STATUS_BASE + i]
304 = pmbus_read_byte_data(client, i,
306 for (i = 0; i < info->pages; i++) {
307 if (!(info->func[i] & PMBUS_HAVE_STATUS_VOUT))
309 data->status[PB_STATUS_VOUT_BASE + i]
310 = _pmbus_read_byte_data(client, i, PMBUS_STATUS_VOUT);
312 for (i = 0; i < info->pages; i++) {
313 if (!(info->func[i] & PMBUS_HAVE_STATUS_IOUT))
315 data->status[PB_STATUS_IOUT_BASE + i]
316 = _pmbus_read_byte_data(client, i, PMBUS_STATUS_IOUT);
318 for (i = 0; i < info->pages; i++) {
319 if (!(info->func[i] & PMBUS_HAVE_STATUS_TEMP))
321 data->status[PB_STATUS_TEMP_BASE + i]
322 = _pmbus_read_byte_data(client, i,
323 PMBUS_STATUS_TEMPERATURE);
325 for (i = 0; i < info->pages; i++) {
326 if (!(info->func[i] & PMBUS_HAVE_STATUS_FAN12))
328 data->status[PB_STATUS_FAN_BASE + i]
329 = _pmbus_read_byte_data(client, i,
330 PMBUS_STATUS_FAN_12);
333 for (i = 0; i < info->pages; i++) {
334 if (!(info->func[i] & PMBUS_HAVE_STATUS_FAN34))
336 data->status[PB_STATUS_FAN34_BASE + i]
337 = _pmbus_read_byte_data(client, i,
338 PMBUS_STATUS_FAN_34);
341 if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
342 data->status[PB_STATUS_INPUT_BASE]
343 = _pmbus_read_byte_data(client, 0,
346 for (i = 0; i < data->num_sensors; i++) {
347 struct pmbus_sensor *sensor = &data->sensors[i];
349 if (!data->valid || sensor->update)
351 = pmbus_read_word_data(client, sensor->page,
354 pmbus_clear_faults(client);
355 data->last_updated = jiffies;
358 mutex_unlock(&data->update_lock);
363 * Convert linear sensor values to milli- or micro-units
364 * depending on sensor type.
366 static long pmbus_reg2data_linear(struct pmbus_data *data,
367 struct pmbus_sensor *sensor)
373 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
374 exponent = data->exponent;
375 mantissa = (u16) sensor->data;
376 } else { /* LINEAR11 */
377 exponent = (sensor->data >> 11) & 0x001f;
378 mantissa = sensor->data & 0x07ff;
381 exponent |= 0xffe0; /* sign extend exponent */
382 if (mantissa > 0x03ff)
383 mantissa |= 0xfffff800; /* sign extend mantissa */
388 /* scale result to milli-units for all sensors except fans */
389 if (sensor->class != PSC_FAN)
392 /* scale result to micro-units for power sensors */
393 if (sensor->class == PSC_POWER)
405 * Convert direct sensor values to milli- or micro-units
406 * depending on sensor type.
408 static long pmbus_reg2data_direct(struct pmbus_data *data,
409 struct pmbus_sensor *sensor)
411 long val = (s16) sensor->data;
414 m = data->info->m[sensor->class];
415 b = data->info->b[sensor->class];
416 R = data->info->R[sensor->class];
421 /* X = 1/m * (Y * 10^-R - b) */
423 /* scale result to milli-units for everything but fans */
424 if (sensor->class != PSC_FAN) {
429 /* scale result to micro-units for power sensors */
430 if (sensor->class == PSC_POWER) {
440 val = DIV_ROUND_CLOSEST(val, 10);
444 return (val - b) / m;
448 * Convert VID sensor values to milli- or micro-units
449 * depending on sensor type.
450 * We currently only support VR11.
452 static long pmbus_reg2data_vid(struct pmbus_data *data,
453 struct pmbus_sensor *sensor)
455 long val = sensor->data;
457 if (val < 0x02 || val > 0xb2)
459 return DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
462 static long pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
466 switch (data->info->format[sensor->class]) {
468 val = pmbus_reg2data_direct(data, sensor);
471 val = pmbus_reg2data_vid(data, sensor);
475 val = pmbus_reg2data_linear(data, sensor);
481 #define MAX_MANTISSA (1023 * 1000)
482 #define MIN_MANTISSA (511 * 1000)
484 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
485 enum pmbus_sensor_classes class, long val)
487 s16 exponent = 0, mantissa;
488 bool negative = false;
494 if (class == PSC_VOLTAGE_OUT) {
495 /* LINEAR16 does not support negative voltages */
500 * For a static exponents, we don't have a choice
501 * but to adjust the value to it.
503 if (data->exponent < 0)
504 val <<= -data->exponent;
506 val >>= data->exponent;
507 val = DIV_ROUND_CLOSEST(val, 1000);
516 /* Power is in uW. Convert to mW before converting. */
517 if (class == PSC_POWER)
518 val = DIV_ROUND_CLOSEST(val, 1000L);
521 * For simplicity, convert fan data to milli-units
522 * before calculating the exponent.
524 if (class == PSC_FAN)
527 /* Reduce large mantissa until it fits into 10 bit */
528 while (val >= MAX_MANTISSA && exponent < 15) {
532 /* Increase small mantissa to improve precision */
533 while (val < MIN_MANTISSA && exponent > -15) {
538 /* Convert mantissa from milli-units to units */
539 mantissa = DIV_ROUND_CLOSEST(val, 1000);
541 /* Ensure that resulting number is within range */
542 if (mantissa > 0x3ff)
547 mantissa = -mantissa;
549 /* Convert to 5 bit exponent, 11 bit mantissa */
550 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
553 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
554 enum pmbus_sensor_classes class, long val)
558 m = data->info->m[class];
559 b = data->info->b[class];
560 R = data->info->R[class];
562 /* Power is in uW. Adjust R and b. */
563 if (class == PSC_POWER) {
568 /* Calculate Y = (m * X + b) * 10^R */
569 if (class != PSC_FAN) {
570 R -= 3; /* Adjust R and b for data in milli-units */
580 val = DIV_ROUND_CLOSEST(val, 10);
587 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
588 enum pmbus_sensor_classes class, long val)
590 val = SENSORS_LIMIT(val, 500, 1600);
592 return 2 + DIV_ROUND_CLOSEST((1600 - val) * 100, 625);
595 static u16 pmbus_data2reg(struct pmbus_data *data,
596 enum pmbus_sensor_classes class, long val)
600 switch (data->info->format[class]) {
602 regval = pmbus_data2reg_direct(data, class, val);
605 regval = pmbus_data2reg_vid(data, class, val);
609 regval = pmbus_data2reg_linear(data, class, val);
616 * Return boolean calculated from converted data.
617 * <index> defines a status register index and mask, and optionally
618 * two sensor indexes.
619 * The upper half-word references the two sensors,
620 * two sensor indices.
621 * The upper half-word references the two optional sensors,
622 * the lower half word references status register and mask.
623 * The function returns true if (status[reg] & mask) is true and,
624 * if specified, if v1 >= v2.
625 * To determine if an object exceeds upper limits, specify <v, limit>.
626 * To determine if an object exceeds lower limits, specify <limit, v>.
628 * For booleans created with pmbus_add_boolean_reg(), only the lower 16 bits of
629 * index are set. s1 and s2 (the sensor index values) are zero in this case.
630 * The function returns true if (status[reg] & mask) is true.
632 * If the boolean was created with pmbus_add_boolean_cmp(), a comparison against
633 * a specified limit has to be performed to determine the boolean result.
634 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
635 * sensor values referenced by sensor indices s1 and s2).
637 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
638 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
640 * If a negative value is stored in any of the referenced registers, this value
641 * reflects an error code which will be returned.
643 static int pmbus_get_boolean(struct pmbus_data *data, int index, int *val)
645 u8 s1 = (index >> 24) & 0xff;
646 u8 s2 = (index >> 16) & 0xff;
647 u8 reg = (index >> 8) & 0xff;
648 u8 mask = index & 0xff;
652 status = data->status[reg];
656 regval = status & mask;
661 struct pmbus_sensor *sensor1, *sensor2;
663 sensor1 = &data->sensors[s1];
664 if (sensor1->data < 0)
665 return sensor1->data;
666 sensor2 = &data->sensors[s2];
667 if (sensor2->data < 0)
668 return sensor2->data;
670 v1 = pmbus_reg2data(data, sensor1);
671 v2 = pmbus_reg2data(data, sensor2);
672 *val = !!(regval && v1 >= v2);
677 static ssize_t pmbus_show_boolean(struct device *dev,
678 struct device_attribute *da, char *buf)
680 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
681 struct pmbus_data *data = pmbus_update_device(dev);
685 err = pmbus_get_boolean(data, attr->index, &val);
688 return snprintf(buf, PAGE_SIZE, "%d\n", val);
691 static ssize_t pmbus_show_sensor(struct device *dev,
692 struct device_attribute *da, char *buf)
694 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
695 struct pmbus_data *data = pmbus_update_device(dev);
696 struct pmbus_sensor *sensor;
698 sensor = &data->sensors[attr->index];
699 if (sensor->data < 0)
702 return snprintf(buf, PAGE_SIZE, "%ld\n", pmbus_reg2data(data, sensor));
705 static ssize_t pmbus_set_sensor(struct device *dev,
706 struct device_attribute *devattr,
707 const char *buf, size_t count)
709 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
710 struct i2c_client *client = to_i2c_client(dev);
711 struct pmbus_data *data = i2c_get_clientdata(client);
712 struct pmbus_sensor *sensor = &data->sensors[attr->index];
718 if (strict_strtol(buf, 10, &val) < 0)
721 mutex_lock(&data->update_lock);
722 regval = pmbus_data2reg(data, sensor->class, val);
723 ret = pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
727 data->sensors[attr->index].data = regval;
728 mutex_unlock(&data->update_lock);
732 static ssize_t pmbus_show_label(struct device *dev,
733 struct device_attribute *da, char *buf)
735 struct i2c_client *client = to_i2c_client(dev);
736 struct pmbus_data *data = i2c_get_clientdata(client);
737 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
739 return snprintf(buf, PAGE_SIZE, "%s\n",
740 data->labels[attr->index].label);
743 #define PMBUS_ADD_ATTR(data, _name, _idx, _mode, _type, _show, _set) \
745 struct sensor_device_attribute *a \
746 = &data->_type##s[data->num_##_type##s].attribute; \
747 BUG_ON(data->num_attributes >= data->max_attributes); \
748 sysfs_attr_init(&a->dev_attr.attr); \
749 a->dev_attr.attr.name = _name; \
750 a->dev_attr.attr.mode = _mode; \
751 a->dev_attr.show = _show; \
752 a->dev_attr.store = _set; \
754 data->attributes[data->num_attributes] = &a->dev_attr.attr; \
755 data->num_attributes++; \
758 #define PMBUS_ADD_GET_ATTR(data, _name, _type, _idx) \
759 PMBUS_ADD_ATTR(data, _name, _idx, S_IRUGO, _type, \
760 pmbus_show_##_type, NULL)
762 #define PMBUS_ADD_SET_ATTR(data, _name, _type, _idx) \
763 PMBUS_ADD_ATTR(data, _name, _idx, S_IWUSR | S_IRUGO, _type, \
764 pmbus_show_##_type, pmbus_set_##_type)
766 static void pmbus_add_boolean(struct pmbus_data *data,
767 const char *name, const char *type, int seq,
770 struct pmbus_boolean *boolean;
772 BUG_ON(data->num_booleans >= data->max_booleans);
774 boolean = &data->booleans[data->num_booleans];
776 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
778 PMBUS_ADD_GET_ATTR(data, boolean->name, boolean, idx);
779 data->num_booleans++;
782 static void pmbus_add_boolean_reg(struct pmbus_data *data,
783 const char *name, const char *type,
784 int seq, int reg, int bit)
786 pmbus_add_boolean(data, name, type, seq, (reg << 8) | bit);
789 static void pmbus_add_boolean_cmp(struct pmbus_data *data,
790 const char *name, const char *type,
791 int seq, int i1, int i2, int reg, int mask)
793 pmbus_add_boolean(data, name, type, seq,
794 (i1 << 24) | (i2 << 16) | (reg << 8) | mask);
797 static void pmbus_add_sensor(struct pmbus_data *data,
798 const char *name, const char *type, int seq,
799 int page, int reg, enum pmbus_sensor_classes class,
800 bool update, bool readonly)
802 struct pmbus_sensor *sensor;
804 BUG_ON(data->num_sensors >= data->max_sensors);
806 sensor = &data->sensors[data->num_sensors];
807 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
811 sensor->class = class;
812 sensor->update = update;
814 PMBUS_ADD_GET_ATTR(data, sensor->name, sensor,
817 PMBUS_ADD_SET_ATTR(data, sensor->name, sensor,
822 static void pmbus_add_label(struct pmbus_data *data,
823 const char *name, int seq,
824 const char *lstring, int index)
826 struct pmbus_label *label;
828 BUG_ON(data->num_labels >= data->max_labels);
830 label = &data->labels[data->num_labels];
831 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
833 strncpy(label->label, lstring, sizeof(label->label) - 1);
835 snprintf(label->label, sizeof(label->label), "%s%d", lstring,
838 PMBUS_ADD_GET_ATTR(data, label->name, label, data->num_labels);
843 * Determine maximum number of sensors, booleans, and labels.
844 * To keep things simple, only make a rough high estimate.
846 static void pmbus_find_max_attr(struct i2c_client *client,
847 struct pmbus_data *data)
849 const struct pmbus_driver_info *info = data->info;
850 int page, max_sensors, max_booleans, max_labels;
852 max_sensors = PMBUS_MAX_INPUT_SENSORS;
853 max_booleans = PMBUS_MAX_INPUT_BOOLEANS;
854 max_labels = PMBUS_MAX_INPUT_LABELS;
856 for (page = 0; page < info->pages; page++) {
857 if (info->func[page] & PMBUS_HAVE_VOUT) {
858 max_sensors += PMBUS_VOUT_SENSORS_PER_PAGE;
859 max_booleans += PMBUS_VOUT_BOOLEANS_PER_PAGE;
862 if (info->func[page] & PMBUS_HAVE_IOUT) {
863 max_sensors += PMBUS_IOUT_SENSORS_PER_PAGE;
864 max_booleans += PMBUS_IOUT_BOOLEANS_PER_PAGE;
867 if (info->func[page] & PMBUS_HAVE_POUT) {
868 max_sensors += PMBUS_POUT_SENSORS_PER_PAGE;
869 max_booleans += PMBUS_POUT_BOOLEANS_PER_PAGE;
872 if (info->func[page] & PMBUS_HAVE_FAN12) {
873 max_sensors += 2 * PMBUS_MAX_SENSORS_PER_FAN;
874 max_booleans += 2 * PMBUS_MAX_BOOLEANS_PER_FAN;
876 if (info->func[page] & PMBUS_HAVE_FAN34) {
877 max_sensors += 2 * PMBUS_MAX_SENSORS_PER_FAN;
878 max_booleans += 2 * PMBUS_MAX_BOOLEANS_PER_FAN;
880 if (info->func[page] & PMBUS_HAVE_TEMP) {
881 max_sensors += PMBUS_MAX_SENSORS_PER_TEMP;
882 max_booleans += PMBUS_MAX_BOOLEANS_PER_TEMP;
884 if (info->func[page] & PMBUS_HAVE_TEMP2) {
885 max_sensors += PMBUS_MAX_SENSORS_PER_TEMP;
886 max_booleans += PMBUS_MAX_BOOLEANS_PER_TEMP;
888 if (info->func[page] & PMBUS_HAVE_TEMP3) {
889 max_sensors += PMBUS_MAX_SENSORS_PER_TEMP;
890 max_booleans += PMBUS_MAX_BOOLEANS_PER_TEMP;
893 data->max_sensors = max_sensors;
894 data->max_booleans = max_booleans;
895 data->max_labels = max_labels;
896 data->max_attributes = max_sensors + max_booleans + max_labels;
900 * Search for attributes. Allocate sensors, booleans, and labels as needed.
904 * The pmbus_limit_attr structure describes a single limit attribute
905 * and its associated alarm attribute.
907 struct pmbus_limit_attr {
908 u8 reg; /* Limit register */
909 const char *attr; /* Attribute name */
910 const char *alarm; /* Alarm attribute name */
911 u32 sbit; /* Alarm attribute status bit */
915 * The pmbus_sensor_attr structure describes one sensor attribute. This
916 * description includes a reference to the associated limit attributes.
918 struct pmbus_sensor_attr {
919 u8 reg; /* sensor register */
920 enum pmbus_sensor_classes class;/* sensor class */
921 const char *label; /* sensor label */
922 bool paged; /* true if paged sensor */
923 bool update; /* true if update needed */
924 bool compare; /* true if compare function needed */
925 u32 func; /* sensor mask */
926 u32 sfunc; /* sensor status mask */
927 int sbase; /* status base register */
928 u32 gbit; /* generic status bit */
929 const struct pmbus_limit_attr *limit;/* limit registers */
930 int nlimit; /* # of limit registers */
934 * Add a set of limit attributes and, if supported, the associated
937 static bool pmbus_add_limit_attrs(struct i2c_client *client,
938 struct pmbus_data *data,
939 const struct pmbus_driver_info *info,
940 const char *name, int index, int page,
942 const struct pmbus_sensor_attr *attr)
944 const struct pmbus_limit_attr *l = attr->limit;
945 int nlimit = attr->nlimit;
946 bool have_alarm = false;
949 for (i = 0; i < nlimit; i++) {
950 if (pmbus_check_word_register(client, page, l->reg)) {
951 cindex = data->num_sensors;
952 pmbus_add_sensor(data, name, l->attr, index, page,
953 l->reg, attr->class, attr->update,
955 if (info->func[page] & attr->sfunc) {
957 pmbus_add_boolean_cmp(data, name,
960 attr->sbase + page, l->sbit);
962 pmbus_add_boolean_reg(data, name,
964 attr->sbase + page, l->sbit);
974 static void pmbus_add_sensor_attrs_one(struct i2c_client *client,
975 struct pmbus_data *data,
976 const struct pmbus_driver_info *info,
979 const struct pmbus_sensor_attr *attr)
982 int cbase = data->num_sensors;
985 pmbus_add_label(data, name, index, attr->label,
986 attr->paged ? page + 1 : 0);
987 pmbus_add_sensor(data, name, "input", index, page, attr->reg,
988 attr->class, true, true);
990 have_alarm = pmbus_add_limit_attrs(client, data, info, name,
991 index, page, cbase, attr);
993 * Add generic alarm attribute only if there are no individual
994 * alarm attributes, and if there is a global alarm bit.
996 if (!have_alarm && attr->gbit)
997 pmbus_add_boolean_reg(data, name, "alarm", index,
998 PB_STATUS_BASE + page,
1003 static void pmbus_add_sensor_attrs(struct i2c_client *client,
1004 struct pmbus_data *data,
1006 const struct pmbus_sensor_attr *attrs,
1009 const struct pmbus_driver_info *info = data->info;
1013 for (i = 0; i < nattrs; i++) {
1016 pages = attrs->paged ? info->pages : 1;
1017 for (page = 0; page < pages; page++) {
1018 if (!(info->func[page] & attrs->func))
1020 pmbus_add_sensor_attrs_one(client, data, info, name,
1021 index, page, attrs);
1028 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1030 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1032 .alarm = "min_alarm",
1033 .sbit = PB_VOLTAGE_UV_WARNING,
1035 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1037 .alarm = "lcrit_alarm",
1038 .sbit = PB_VOLTAGE_UV_FAULT,
1040 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1042 .alarm = "max_alarm",
1043 .sbit = PB_VOLTAGE_OV_WARNING,
1045 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1047 .alarm = "crit_alarm",
1048 .sbit = PB_VOLTAGE_OV_FAULT,
1052 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1054 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1056 .alarm = "min_alarm",
1057 .sbit = PB_VOLTAGE_UV_WARNING,
1059 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1061 .alarm = "lcrit_alarm",
1062 .sbit = PB_VOLTAGE_UV_FAULT,
1064 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1066 .alarm = "max_alarm",
1067 .sbit = PB_VOLTAGE_OV_WARNING,
1069 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1071 .alarm = "crit_alarm",
1072 .sbit = PB_VOLTAGE_OV_FAULT,
1076 static const struct pmbus_sensor_attr voltage_attributes[] = {
1078 .reg = PMBUS_READ_VIN,
1079 .class = PSC_VOLTAGE_IN,
1081 .func = PMBUS_HAVE_VIN,
1082 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1083 .sbase = PB_STATUS_INPUT_BASE,
1084 .gbit = PB_STATUS_VIN_UV,
1085 .limit = vin_limit_attrs,
1086 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1088 .reg = PMBUS_READ_VCAP,
1089 .class = PSC_VOLTAGE_IN,
1091 .func = PMBUS_HAVE_VCAP,
1093 .reg = PMBUS_READ_VOUT,
1094 .class = PSC_VOLTAGE_OUT,
1097 .func = PMBUS_HAVE_VOUT,
1098 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1099 .sbase = PB_STATUS_VOUT_BASE,
1100 .gbit = PB_STATUS_VOUT_OV,
1101 .limit = vout_limit_attrs,
1102 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1106 /* Current attributes */
1108 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1110 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1112 .alarm = "max_alarm",
1113 .sbit = PB_IIN_OC_WARNING,
1115 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1117 .alarm = "crit_alarm",
1118 .sbit = PB_IIN_OC_FAULT,
1122 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1124 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1126 .alarm = "max_alarm",
1127 .sbit = PB_IOUT_OC_WARNING,
1129 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1131 .alarm = "lcrit_alarm",
1132 .sbit = PB_IOUT_UC_FAULT,
1134 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1136 .alarm = "crit_alarm",
1137 .sbit = PB_IOUT_OC_FAULT,
1141 static const struct pmbus_sensor_attr current_attributes[] = {
1143 .reg = PMBUS_READ_IIN,
1144 .class = PSC_CURRENT_IN,
1146 .func = PMBUS_HAVE_IIN,
1147 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1148 .sbase = PB_STATUS_INPUT_BASE,
1149 .limit = iin_limit_attrs,
1150 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1152 .reg = PMBUS_READ_IOUT,
1153 .class = PSC_CURRENT_OUT,
1156 .func = PMBUS_HAVE_IOUT,
1157 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1158 .sbase = PB_STATUS_IOUT_BASE,
1159 .gbit = PB_STATUS_IOUT_OC,
1160 .limit = iout_limit_attrs,
1161 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1165 /* Power attributes */
1167 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1169 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1172 .sbit = PB_PIN_OP_WARNING,
1176 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1178 .reg = PMBUS_POUT_MAX,
1180 .alarm = "cap_alarm",
1181 .sbit = PB_POWER_LIMITING,
1183 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1185 .alarm = "max_alarm",
1186 .sbit = PB_POUT_OP_WARNING,
1188 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1190 .alarm = "crit_alarm",
1191 .sbit = PB_POUT_OP_FAULT,
1195 static const struct pmbus_sensor_attr power_attributes[] = {
1197 .reg = PMBUS_READ_PIN,
1200 .func = PMBUS_HAVE_PIN,
1201 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1202 .sbase = PB_STATUS_INPUT_BASE,
1203 .limit = pin_limit_attrs,
1204 .nlimit = ARRAY_SIZE(pin_limit_attrs),
1206 .reg = PMBUS_READ_POUT,
1210 .func = PMBUS_HAVE_POUT,
1211 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1212 .sbase = PB_STATUS_IOUT_BASE,
1213 .limit = pout_limit_attrs,
1214 .nlimit = ARRAY_SIZE(pout_limit_attrs),
1218 /* Temperature atributes */
1220 static const struct pmbus_limit_attr temp_limit_attrs[] = {
1222 .reg = PMBUS_UT_WARN_LIMIT,
1224 .alarm = "min_alarm",
1225 .sbit = PB_TEMP_UT_WARNING,
1227 .reg = PMBUS_UT_FAULT_LIMIT,
1229 .alarm = "lcrit_alarm",
1230 .sbit = PB_TEMP_UT_FAULT,
1232 .reg = PMBUS_OT_WARN_LIMIT,
1234 .alarm = "max_alarm",
1235 .sbit = PB_TEMP_OT_WARNING,
1237 .reg = PMBUS_OT_FAULT_LIMIT,
1239 .alarm = "crit_alarm",
1240 .sbit = PB_TEMP_OT_FAULT,
1244 static const struct pmbus_sensor_attr temp_attributes[] = {
1246 .reg = PMBUS_READ_TEMPERATURE_1,
1247 .class = PSC_TEMPERATURE,
1251 .func = PMBUS_HAVE_TEMP,
1252 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1253 .sbase = PB_STATUS_TEMP_BASE,
1254 .gbit = PB_STATUS_TEMPERATURE,
1255 .limit = temp_limit_attrs,
1256 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1258 .reg = PMBUS_READ_TEMPERATURE_2,
1259 .class = PSC_TEMPERATURE,
1263 .func = PMBUS_HAVE_TEMP2,
1264 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1265 .sbase = PB_STATUS_TEMP_BASE,
1266 .gbit = PB_STATUS_TEMPERATURE,
1267 .limit = temp_limit_attrs,
1268 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1270 .reg = PMBUS_READ_TEMPERATURE_3,
1271 .class = PSC_TEMPERATURE,
1275 .func = PMBUS_HAVE_TEMP3,
1276 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1277 .sbase = PB_STATUS_TEMP_BASE,
1278 .gbit = PB_STATUS_TEMPERATURE,
1279 .limit = temp_limit_attrs,
1280 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1284 static const int pmbus_fan_registers[] = {
1285 PMBUS_READ_FAN_SPEED_1,
1286 PMBUS_READ_FAN_SPEED_2,
1287 PMBUS_READ_FAN_SPEED_3,
1288 PMBUS_READ_FAN_SPEED_4
1291 static const int pmbus_fan_config_registers[] = {
1292 PMBUS_FAN_CONFIG_12,
1293 PMBUS_FAN_CONFIG_12,
1294 PMBUS_FAN_CONFIG_34,
1298 static const int pmbus_fan_status_registers[] = {
1299 PMBUS_STATUS_FAN_12,
1300 PMBUS_STATUS_FAN_12,
1301 PMBUS_STATUS_FAN_34,
1305 static const u32 pmbus_fan_flags[] = {
1312 static const u32 pmbus_fan_status_flags[] = {
1313 PMBUS_HAVE_STATUS_FAN12,
1314 PMBUS_HAVE_STATUS_FAN12,
1315 PMBUS_HAVE_STATUS_FAN34,
1316 PMBUS_HAVE_STATUS_FAN34
1320 static void pmbus_add_fan_attributes(struct i2c_client *client,
1321 struct pmbus_data *data)
1323 const struct pmbus_driver_info *info = data->info;
1327 for (page = 0; page < info->pages; page++) {
1330 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
1333 if (!(info->func[page] & pmbus_fan_flags[f]))
1336 if (!pmbus_check_word_register(client, page,
1337 pmbus_fan_registers[f]))
1341 * Skip fan if not installed.
1342 * Each fan configuration register covers multiple fans,
1343 * so we have to do some magic.
1345 regval = _pmbus_read_byte_data(client, page,
1346 pmbus_fan_config_registers[f]);
1348 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
1351 pmbus_add_sensor(data, "fan", "input", index, page,
1352 pmbus_fan_registers[f], PSC_FAN, true,
1356 * Each fan status register covers multiple fans,
1357 * so we have to do some magic.
1359 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
1360 pmbus_check_byte_register(client,
1361 page, pmbus_fan_status_registers[f])) {
1364 if (f > 1) /* fan 3, 4 */
1365 base = PB_STATUS_FAN34_BASE + page;
1367 base = PB_STATUS_FAN_BASE + page;
1368 pmbus_add_boolean_reg(data, "fan", "alarm",
1370 PB_FAN_FAN1_WARNING >> (f & 1));
1371 pmbus_add_boolean_reg(data, "fan", "fault",
1373 PB_FAN_FAN1_FAULT >> (f & 1));
1380 static void pmbus_find_attributes(struct i2c_client *client,
1381 struct pmbus_data *data)
1383 /* Voltage sensors */
1384 pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
1385 ARRAY_SIZE(voltage_attributes));
1387 /* Current sensors */
1388 pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
1389 ARRAY_SIZE(current_attributes));
1392 pmbus_add_sensor_attrs(client, data, "power", power_attributes,
1393 ARRAY_SIZE(power_attributes));
1395 /* Temperature sensors */
1396 pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
1397 ARRAY_SIZE(temp_attributes));
1400 pmbus_add_fan_attributes(client, data);
1404 * Identify chip parameters.
1405 * This function is called for all chips.
1407 static int pmbus_identify_common(struct i2c_client *client,
1408 struct pmbus_data *data)
1410 int vout_mode = -1, exponent;
1412 if (pmbus_check_byte_register(client, 0, PMBUS_VOUT_MODE))
1413 vout_mode = pmbus_read_byte_data(client, 0, PMBUS_VOUT_MODE);
1414 if (vout_mode >= 0 && vout_mode != 0xff) {
1416 * Not all chips support the VOUT_MODE command,
1417 * so a failure to read it is not an error.
1419 switch (vout_mode >> 5) {
1420 case 0: /* linear mode */
1421 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
1424 exponent = vout_mode & 0x1f;
1425 /* and sign-extend it */
1426 if (exponent & 0x10)
1428 data->exponent = exponent;
1430 case 1: /* VID mode */
1431 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
1434 case 2: /* direct mode */
1435 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
1443 /* Determine maximum number of sensors, booleans, and labels */
1444 pmbus_find_max_attr(client, data);
1445 pmbus_clear_fault_page(client, 0);
1449 int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
1450 struct pmbus_driver_info *info)
1452 const struct pmbus_platform_data *pdata = client->dev.platform_data;
1453 struct pmbus_data *data;
1457 dev_err(&client->dev, "Missing chip information");
1461 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
1462 | I2C_FUNC_SMBUS_BYTE_DATA
1463 | I2C_FUNC_SMBUS_WORD_DATA))
1466 data = kzalloc(sizeof(*data), GFP_KERNEL);
1468 dev_err(&client->dev, "No memory to allocate driver data\n");
1472 i2c_set_clientdata(client, data);
1473 mutex_init(&data->update_lock);
1475 /* Bail out if PMBus status register does not exist. */
1476 if (i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE) < 0) {
1477 dev_err(&client->dev, "PMBus status register not found\n");
1483 data->flags = pdata->flags;
1486 pmbus_clear_faults(client);
1488 if (info->identify) {
1489 ret = (*info->identify)(client, info);
1491 dev_err(&client->dev, "Chip identification failed\n");
1496 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
1497 dev_err(&client->dev, "Bad number of PMBus pages: %d\n",
1503 * Bail out if more than one page was configured, but we can not
1504 * select the highest page. This is an indication that the wrong
1505 * chip type was selected. Better bail out now than keep
1506 * returning errors later on.
1508 if (info->pages > 1 && pmbus_set_page(client, info->pages - 1) < 0) {
1509 dev_err(&client->dev, "Failed to select page %d\n",
1515 ret = pmbus_identify_common(client, data);
1517 dev_err(&client->dev, "Failed to identify chip capabilities\n");
1522 data->sensors = kzalloc(sizeof(struct pmbus_sensor) * data->max_sensors,
1524 if (!data->sensors) {
1525 dev_err(&client->dev, "No memory to allocate sensor data\n");
1529 data->booleans = kzalloc(sizeof(struct pmbus_boolean)
1530 * data->max_booleans, GFP_KERNEL);
1531 if (!data->booleans) {
1532 dev_err(&client->dev, "No memory to allocate boolean data\n");
1536 data->labels = kzalloc(sizeof(struct pmbus_label) * data->max_labels,
1538 if (!data->labels) {
1539 dev_err(&client->dev, "No memory to allocate label data\n");
1543 data->attributes = kzalloc(sizeof(struct attribute *)
1544 * data->max_attributes, GFP_KERNEL);
1545 if (!data->attributes) {
1546 dev_err(&client->dev, "No memory to allocate attribute data\n");
1550 pmbus_find_attributes(client, data);
1553 * If there are no attributes, something is wrong.
1554 * Bail out instead of trying to register nothing.
1556 if (!data->num_attributes) {
1557 dev_err(&client->dev, "No attributes found\n");
1559 goto out_attributes;
1562 /* Register sysfs hooks */
1563 data->group.attrs = data->attributes;
1564 ret = sysfs_create_group(&client->dev.kobj, &data->group);
1566 dev_err(&client->dev, "Failed to create sysfs entries\n");
1567 goto out_attributes;
1569 data->hwmon_dev = hwmon_device_register(&client->dev);
1570 if (IS_ERR(data->hwmon_dev)) {
1571 ret = PTR_ERR(data->hwmon_dev);
1572 dev_err(&client->dev, "Failed to register hwmon device\n");
1573 goto out_hwmon_device_register;
1577 out_hwmon_device_register:
1578 sysfs_remove_group(&client->dev.kobj, &data->group);
1580 kfree(data->attributes);
1582 kfree(data->labels);
1584 kfree(data->booleans);
1586 kfree(data->sensors);
1591 EXPORT_SYMBOL_GPL(pmbus_do_probe);
1593 int pmbus_do_remove(struct i2c_client *client)
1595 struct pmbus_data *data = i2c_get_clientdata(client);
1596 hwmon_device_unregister(data->hwmon_dev);
1597 sysfs_remove_group(&client->dev.kobj, &data->group);
1598 kfree(data->attributes);
1599 kfree(data->labels);
1600 kfree(data->booleans);
1601 kfree(data->sensors);
1605 EXPORT_SYMBOL_GPL(pmbus_do_remove);
1607 MODULE_AUTHOR("Guenter Roeck");
1608 MODULE_DESCRIPTION("PMBus core driver");
1609 MODULE_LICENSE("GPL");