1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Hardware monitoring driver for PMBus devices
5 * Copyright (c) 2010, 2011 Ericsson AB.
6 * Copyright (c) 2012 Guenter Roeck
9 #include <linux/debugfs.h>
10 #include <linux/kernel.h>
11 #include <linux/math64.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/err.h>
15 #include <linux/slab.h>
16 #include <linux/i2c.h>
17 #include <linux/hwmon.h>
18 #include <linux/hwmon-sysfs.h>
19 #include <linux/jiffies.h>
20 #include <linux/pmbus.h>
21 #include <linux/regulator/driver.h>
22 #include <linux/regulator/machine.h>
26 * Number of additional attribute pointers to allocate
27 * with each call to krealloc
29 #define PMBUS_ATTR_ALLOC_SIZE 32
32 * Index into status register array, per status register group
34 #define PB_STATUS_BASE 0
35 #define PB_STATUS_VOUT_BASE (PB_STATUS_BASE + PMBUS_PAGES)
36 #define PB_STATUS_IOUT_BASE (PB_STATUS_VOUT_BASE + PMBUS_PAGES)
37 #define PB_STATUS_FAN_BASE (PB_STATUS_IOUT_BASE + PMBUS_PAGES)
38 #define PB_STATUS_FAN34_BASE (PB_STATUS_FAN_BASE + PMBUS_PAGES)
39 #define PB_STATUS_TEMP_BASE (PB_STATUS_FAN34_BASE + PMBUS_PAGES)
40 #define PB_STATUS_INPUT_BASE (PB_STATUS_TEMP_BASE + PMBUS_PAGES)
41 #define PB_STATUS_VMON_BASE (PB_STATUS_INPUT_BASE + 1)
43 #define PB_NUM_STATUS_REG (PB_STATUS_VMON_BASE + 1)
45 #define PMBUS_NAME_SIZE 24
48 struct pmbus_sensor *next;
49 char name[PMBUS_NAME_SIZE]; /* sysfs sensor name */
50 struct device_attribute attribute;
51 u8 page; /* page number */
52 u8 phase; /* phase number, 0xff for all phases */
53 u16 reg; /* register */
54 enum pmbus_sensor_classes class; /* sensor class */
55 bool update; /* runtime sensor update needed */
56 bool convert; /* Whether or not to apply linear/vid/direct */
57 int data; /* Sensor data.
58 Negative if there was a read error */
60 #define to_pmbus_sensor(_attr) \
61 container_of(_attr, struct pmbus_sensor, attribute)
63 struct pmbus_boolean {
64 char name[PMBUS_NAME_SIZE]; /* sysfs boolean name */
65 struct sensor_device_attribute attribute;
66 struct pmbus_sensor *s1;
67 struct pmbus_sensor *s2;
69 #define to_pmbus_boolean(_attr) \
70 container_of(_attr, struct pmbus_boolean, attribute)
73 char name[PMBUS_NAME_SIZE]; /* sysfs label name */
74 struct device_attribute attribute;
75 char label[PMBUS_NAME_SIZE]; /* label */
77 #define to_pmbus_label(_attr) \
78 container_of(_attr, struct pmbus_label, attribute)
82 struct device *hwmon_dev;
84 u32 flags; /* from platform data */
86 int exponent[PMBUS_PAGES];
87 /* linear mode: exponent for output voltages */
89 const struct pmbus_driver_info *info;
93 struct attribute_group group;
94 const struct attribute_group **groups;
95 struct dentry *debugfs; /* debugfs device directory */
97 struct pmbus_sensor *sensors;
99 struct mutex update_lock;
101 unsigned long last_updated; /* in jiffies */
104 * A single status register covers multiple attributes,
105 * so we keep them all together.
107 u16 status[PB_NUM_STATUS_REG];
109 bool has_status_word; /* device uses STATUS_WORD register */
110 int (*read_status)(struct i2c_client *client, int page);
112 s16 currpage; /* current page, -1 for unknown/unset */
113 s16 currphase; /* current phase, 0xff for all, -1 for unknown/unset */
116 struct pmbus_debugfs_entry {
117 struct i2c_client *client;
122 static const int pmbus_fan_rpm_mask[] = {
129 static const int pmbus_fan_config_registers[] = {
136 static const int pmbus_fan_command_registers[] = {
143 void pmbus_clear_cache(struct i2c_client *client)
145 struct pmbus_data *data = i2c_get_clientdata(client);
149 EXPORT_SYMBOL_GPL(pmbus_clear_cache);
151 int pmbus_set_page(struct i2c_client *client, int page, int phase)
153 struct pmbus_data *data = i2c_get_clientdata(client);
159 if (!(data->info->func[page] & PMBUS_PAGE_VIRTUAL) &&
160 data->info->pages > 1 && page != data->currpage) {
161 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
165 rv = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
172 data->currpage = page;
174 if (data->info->phases[page] && data->currphase != phase &&
175 !(data->info->func[page] & PMBUS_PHASE_VIRTUAL)) {
176 rv = i2c_smbus_write_byte_data(client, PMBUS_PHASE,
181 data->currphase = phase;
185 EXPORT_SYMBOL_GPL(pmbus_set_page);
187 int pmbus_write_byte(struct i2c_client *client, int page, u8 value)
191 rv = pmbus_set_page(client, page, 0xff);
195 return i2c_smbus_write_byte(client, value);
197 EXPORT_SYMBOL_GPL(pmbus_write_byte);
200 * _pmbus_write_byte() is similar to pmbus_write_byte(), but checks if
201 * a device specific mapping function exists and calls it if necessary.
203 static int _pmbus_write_byte(struct i2c_client *client, int page, u8 value)
205 struct pmbus_data *data = i2c_get_clientdata(client);
206 const struct pmbus_driver_info *info = data->info;
209 if (info->write_byte) {
210 status = info->write_byte(client, page, value);
211 if (status != -ENODATA)
214 return pmbus_write_byte(client, page, value);
217 int pmbus_write_word_data(struct i2c_client *client, int page, u8 reg,
222 rv = pmbus_set_page(client, page, 0xff);
226 return i2c_smbus_write_word_data(client, reg, word);
228 EXPORT_SYMBOL_GPL(pmbus_write_word_data);
231 static int pmbus_write_virt_reg(struct i2c_client *client, int page, int reg,
239 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
240 id = reg - PMBUS_VIRT_FAN_TARGET_1;
241 bit = pmbus_fan_rpm_mask[id];
242 rv = pmbus_update_fan(client, page, id, bit, bit, word);
253 * _pmbus_write_word_data() is similar to pmbus_write_word_data(), but checks if
254 * a device specific mapping function exists and calls it if necessary.
256 static int _pmbus_write_word_data(struct i2c_client *client, int page, int reg,
259 struct pmbus_data *data = i2c_get_clientdata(client);
260 const struct pmbus_driver_info *info = data->info;
263 if (info->write_word_data) {
264 status = info->write_word_data(client, page, reg, word);
265 if (status != -ENODATA)
269 if (reg >= PMBUS_VIRT_BASE)
270 return pmbus_write_virt_reg(client, page, reg, word);
272 return pmbus_write_word_data(client, page, reg, word);
275 int pmbus_update_fan(struct i2c_client *client, int page, int id,
276 u8 config, u8 mask, u16 command)
282 from = pmbus_read_byte_data(client, page,
283 pmbus_fan_config_registers[id]);
287 to = (from & ~mask) | (config & mask);
289 rv = pmbus_write_byte_data(client, page,
290 pmbus_fan_config_registers[id], to);
295 return _pmbus_write_word_data(client, page,
296 pmbus_fan_command_registers[id], command);
298 EXPORT_SYMBOL_GPL(pmbus_update_fan);
300 int pmbus_read_word_data(struct i2c_client *client, int page, int phase, u8 reg)
304 rv = pmbus_set_page(client, page, phase);
308 return i2c_smbus_read_word_data(client, reg);
310 EXPORT_SYMBOL_GPL(pmbus_read_word_data);
312 static int pmbus_read_virt_reg(struct i2c_client *client, int page, int reg)
318 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
319 id = reg - PMBUS_VIRT_FAN_TARGET_1;
320 rv = pmbus_get_fan_rate_device(client, page, id, rpm);
331 * _pmbus_read_word_data() is similar to pmbus_read_word_data(), but checks if
332 * a device specific mapping function exists and calls it if necessary.
334 static int _pmbus_read_word_data(struct i2c_client *client, int page,
337 struct pmbus_data *data = i2c_get_clientdata(client);
338 const struct pmbus_driver_info *info = data->info;
341 if (info->read_word_data) {
342 status = info->read_word_data(client, page, phase, reg);
343 if (status != -ENODATA)
347 if (reg >= PMBUS_VIRT_BASE)
348 return pmbus_read_virt_reg(client, page, reg);
350 return pmbus_read_word_data(client, page, phase, reg);
353 /* Same as above, but without phase parameter, for use in check functions */
354 static int __pmbus_read_word_data(struct i2c_client *client, int page, int reg)
356 return _pmbus_read_word_data(client, page, 0xff, reg);
359 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg)
363 rv = pmbus_set_page(client, page, 0xff);
367 return i2c_smbus_read_byte_data(client, reg);
369 EXPORT_SYMBOL_GPL(pmbus_read_byte_data);
371 int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, u8 value)
375 rv = pmbus_set_page(client, page, 0xff);
379 return i2c_smbus_write_byte_data(client, reg, value);
381 EXPORT_SYMBOL_GPL(pmbus_write_byte_data);
383 int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg,
389 rv = pmbus_read_byte_data(client, page, reg);
393 tmp = (rv & ~mask) | (value & mask);
396 rv = pmbus_write_byte_data(client, page, reg, tmp);
400 EXPORT_SYMBOL_GPL(pmbus_update_byte_data);
403 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
404 * a device specific mapping function exists and calls it if necessary.
406 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
408 struct pmbus_data *data = i2c_get_clientdata(client);
409 const struct pmbus_driver_info *info = data->info;
412 if (info->read_byte_data) {
413 status = info->read_byte_data(client, page, reg);
414 if (status != -ENODATA)
417 return pmbus_read_byte_data(client, page, reg);
420 static struct pmbus_sensor *pmbus_find_sensor(struct pmbus_data *data, int page,
423 struct pmbus_sensor *sensor;
425 for (sensor = data->sensors; sensor; sensor = sensor->next) {
426 if (sensor->page == page && sensor->reg == reg)
430 return ERR_PTR(-EINVAL);
433 static int pmbus_get_fan_rate(struct i2c_client *client, int page, int id,
434 enum pmbus_fan_mode mode,
437 struct pmbus_data *data = i2c_get_clientdata(client);
438 bool want_rpm, have_rpm;
439 struct pmbus_sensor *s;
443 want_rpm = (mode == rpm);
446 reg = want_rpm ? PMBUS_VIRT_FAN_TARGET_1 : PMBUS_VIRT_PWM_1;
447 s = pmbus_find_sensor(data, page, reg + id);
454 config = pmbus_read_byte_data(client, page,
455 pmbus_fan_config_registers[id]);
459 have_rpm = !!(config & pmbus_fan_rpm_mask[id]);
460 if (want_rpm == have_rpm)
461 return pmbus_read_word_data(client, page, 0xff,
462 pmbus_fan_command_registers[id]);
464 /* Can't sensibly map between RPM and PWM, just return zero */
468 int pmbus_get_fan_rate_device(struct i2c_client *client, int page, int id,
469 enum pmbus_fan_mode mode)
471 return pmbus_get_fan_rate(client, page, id, mode, false);
473 EXPORT_SYMBOL_GPL(pmbus_get_fan_rate_device);
475 int pmbus_get_fan_rate_cached(struct i2c_client *client, int page, int id,
476 enum pmbus_fan_mode mode)
478 return pmbus_get_fan_rate(client, page, id, mode, true);
480 EXPORT_SYMBOL_GPL(pmbus_get_fan_rate_cached);
482 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
484 _pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
487 void pmbus_clear_faults(struct i2c_client *client)
489 struct pmbus_data *data = i2c_get_clientdata(client);
492 for (i = 0; i < data->info->pages; i++)
493 pmbus_clear_fault_page(client, i);
495 EXPORT_SYMBOL_GPL(pmbus_clear_faults);
497 static int pmbus_check_status_cml(struct i2c_client *client)
499 struct pmbus_data *data = i2c_get_clientdata(client);
502 status = data->read_status(client, -1);
503 if (status < 0 || (status & PB_STATUS_CML)) {
504 status2 = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
505 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
511 static bool pmbus_check_register(struct i2c_client *client,
512 int (*func)(struct i2c_client *client,
517 struct pmbus_data *data = i2c_get_clientdata(client);
519 rv = func(client, page, reg);
520 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
521 rv = pmbus_check_status_cml(client);
522 pmbus_clear_fault_page(client, -1);
526 static bool pmbus_check_status_register(struct i2c_client *client, int page)
529 struct pmbus_data *data = i2c_get_clientdata(client);
531 status = data->read_status(client, page);
532 if (status >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK) &&
533 (status & PB_STATUS_CML)) {
534 status = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
535 if (status < 0 || (status & PB_CML_FAULT_INVALID_COMMAND))
539 pmbus_clear_fault_page(client, -1);
543 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
545 return pmbus_check_register(client, _pmbus_read_byte_data, page, reg);
547 EXPORT_SYMBOL_GPL(pmbus_check_byte_register);
549 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
551 return pmbus_check_register(client, __pmbus_read_word_data, page, reg);
553 EXPORT_SYMBOL_GPL(pmbus_check_word_register);
555 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
557 struct pmbus_data *data = i2c_get_clientdata(client);
561 EXPORT_SYMBOL_GPL(pmbus_get_driver_info);
563 static struct _pmbus_status {
568 { PMBUS_HAVE_STATUS_VOUT, PB_STATUS_VOUT_BASE, PMBUS_STATUS_VOUT },
569 { PMBUS_HAVE_STATUS_IOUT, PB_STATUS_IOUT_BASE, PMBUS_STATUS_IOUT },
570 { PMBUS_HAVE_STATUS_TEMP, PB_STATUS_TEMP_BASE,
571 PMBUS_STATUS_TEMPERATURE },
572 { PMBUS_HAVE_STATUS_FAN12, PB_STATUS_FAN_BASE, PMBUS_STATUS_FAN_12 },
573 { PMBUS_HAVE_STATUS_FAN34, PB_STATUS_FAN34_BASE, PMBUS_STATUS_FAN_34 },
576 static struct pmbus_data *pmbus_update_device(struct device *dev)
578 struct i2c_client *client = to_i2c_client(dev->parent);
579 struct pmbus_data *data = i2c_get_clientdata(client);
580 const struct pmbus_driver_info *info = data->info;
581 struct pmbus_sensor *sensor;
583 mutex_lock(&data->update_lock);
584 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
587 for (i = 0; i < info->pages; i++) {
588 data->status[PB_STATUS_BASE + i]
589 = data->read_status(client, i);
590 for (j = 0; j < ARRAY_SIZE(pmbus_status); j++) {
591 struct _pmbus_status *s = &pmbus_status[j];
593 if (!(info->func[i] & s->func))
595 data->status[s->base + i]
596 = _pmbus_read_byte_data(client, i,
601 if (info->func[0] & PMBUS_HAVE_STATUS_INPUT)
602 data->status[PB_STATUS_INPUT_BASE]
603 = _pmbus_read_byte_data(client, 0,
606 if (info->func[0] & PMBUS_HAVE_STATUS_VMON)
607 data->status[PB_STATUS_VMON_BASE]
608 = _pmbus_read_byte_data(client, 0,
609 PMBUS_VIRT_STATUS_VMON);
611 for (sensor = data->sensors; sensor; sensor = sensor->next) {
612 if (!data->valid || sensor->update)
614 = _pmbus_read_word_data(client,
619 pmbus_clear_faults(client);
620 data->last_updated = jiffies;
623 mutex_unlock(&data->update_lock);
628 * Convert linear sensor values to milli- or micro-units
629 * depending on sensor type.
631 static s64 pmbus_reg2data_linear(struct pmbus_data *data,
632 struct pmbus_sensor *sensor)
638 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
639 exponent = data->exponent[sensor->page];
640 mantissa = (u16) sensor->data;
641 } else { /* LINEAR11 */
642 exponent = ((s16)sensor->data) >> 11;
643 mantissa = ((s16)((sensor->data & 0x7ff) << 5)) >> 5;
648 /* scale result to milli-units for all sensors except fans */
649 if (sensor->class != PSC_FAN)
652 /* scale result to micro-units for power sensors */
653 if (sensor->class == PSC_POWER)
665 * Convert direct sensor values to milli- or micro-units
666 * depending on sensor type.
668 static s64 pmbus_reg2data_direct(struct pmbus_data *data,
669 struct pmbus_sensor *sensor)
671 s64 b, val = (s16)sensor->data;
674 m = data->info->m[sensor->class];
675 b = data->info->b[sensor->class];
676 R = data->info->R[sensor->class];
681 /* X = 1/m * (Y * 10^-R - b) */
683 /* scale result to milli-units for everything but fans */
684 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
689 /* scale result to micro-units for power sensors */
690 if (sensor->class == PSC_POWER) {
700 val = div_s64(val + 5LL, 10L); /* round closest */
704 val = div_s64(val - b, m);
709 * Convert VID sensor values to milli- or micro-units
710 * depending on sensor type.
712 static s64 pmbus_reg2data_vid(struct pmbus_data *data,
713 struct pmbus_sensor *sensor)
715 long val = sensor->data;
718 switch (data->info->vrm_version[sensor->page]) {
720 if (val >= 0x02 && val <= 0xb2)
721 rv = DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
725 rv = 250 + (val - 1) * 5;
729 rv = 500 + (val - 1) * 10;
733 rv = 200 + (val - 1) * 10;
736 if (val >= 0x0 && val <= 0xd8)
737 rv = DIV_ROUND_CLOSEST(155000 - val * 625, 100);
743 static s64 pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
747 if (!sensor->convert)
750 switch (data->info->format[sensor->class]) {
752 val = pmbus_reg2data_direct(data, sensor);
755 val = pmbus_reg2data_vid(data, sensor);
759 val = pmbus_reg2data_linear(data, sensor);
765 #define MAX_MANTISSA (1023 * 1000)
766 #define MIN_MANTISSA (511 * 1000)
768 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
769 struct pmbus_sensor *sensor, s64 val)
771 s16 exponent = 0, mantissa;
772 bool negative = false;
778 if (sensor->class == PSC_VOLTAGE_OUT) {
779 /* LINEAR16 does not support negative voltages */
784 * For a static exponents, we don't have a choice
785 * but to adjust the value to it.
787 if (data->exponent[sensor->page] < 0)
788 val <<= -data->exponent[sensor->page];
790 val >>= data->exponent[sensor->page];
791 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
792 return clamp_val(val, 0, 0xffff);
800 /* Power is in uW. Convert to mW before converting. */
801 if (sensor->class == PSC_POWER)
802 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
805 * For simplicity, convert fan data to milli-units
806 * before calculating the exponent.
808 if (sensor->class == PSC_FAN)
811 /* Reduce large mantissa until it fits into 10 bit */
812 while (val >= MAX_MANTISSA && exponent < 15) {
816 /* Increase small mantissa to improve precision */
817 while (val < MIN_MANTISSA && exponent > -15) {
822 /* Convert mantissa from milli-units to units */
823 mantissa = clamp_val(DIV_ROUND_CLOSEST_ULL(val, 1000), 0, 0x3ff);
827 mantissa = -mantissa;
829 /* Convert to 5 bit exponent, 11 bit mantissa */
830 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
833 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
834 struct pmbus_sensor *sensor, s64 val)
839 m = data->info->m[sensor->class];
840 b = data->info->b[sensor->class];
841 R = data->info->R[sensor->class];
843 /* Power is in uW. Adjust R and b. */
844 if (sensor->class == PSC_POWER) {
849 /* Calculate Y = (m * X + b) * 10^R */
850 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
851 R -= 3; /* Adjust R and b for data in milli-units */
861 val = div_s64(val + 5LL, 10L); /* round closest */
865 return (u16)clamp_val(val, S16_MIN, S16_MAX);
868 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
869 struct pmbus_sensor *sensor, s64 val)
871 val = clamp_val(val, 500, 1600);
873 return 2 + DIV_ROUND_CLOSEST_ULL((1600LL - val) * 100LL, 625);
876 static u16 pmbus_data2reg(struct pmbus_data *data,
877 struct pmbus_sensor *sensor, s64 val)
881 if (!sensor->convert)
884 switch (data->info->format[sensor->class]) {
886 regval = pmbus_data2reg_direct(data, sensor, val);
889 regval = pmbus_data2reg_vid(data, sensor, val);
893 regval = pmbus_data2reg_linear(data, sensor, val);
900 * Return boolean calculated from converted data.
901 * <index> defines a status register index and mask.
902 * The mask is in the lower 8 bits, the register index is in bits 8..23.
904 * The associated pmbus_boolean structure contains optional pointers to two
905 * sensor attributes. If specified, those attributes are compared against each
906 * other to determine if a limit has been exceeded.
908 * If the sensor attribute pointers are NULL, the function returns true if
909 * (status[reg] & mask) is true.
911 * If sensor attribute pointers are provided, a comparison against a specified
912 * limit has to be performed to determine the boolean result.
913 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
914 * sensor values referenced by sensor attribute pointers s1 and s2).
916 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
917 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
919 * If a negative value is stored in any of the referenced registers, this value
920 * reflects an error code which will be returned.
922 static int pmbus_get_boolean(struct pmbus_data *data, struct pmbus_boolean *b,
925 struct pmbus_sensor *s1 = b->s1;
926 struct pmbus_sensor *s2 = b->s2;
927 u16 reg = (index >> 16) & 0xffff;
928 u16 mask = index & 0xffff;
932 status = data->status[reg];
936 regval = status & mask;
939 } else if (!s1 || !s2) {
940 WARN(1, "Bad boolean descriptor %p: s1=%p, s2=%p\n", b, s1, s2);
950 v1 = pmbus_reg2data(data, s1);
951 v2 = pmbus_reg2data(data, s2);
952 ret = !!(regval && v1 >= v2);
957 static ssize_t pmbus_show_boolean(struct device *dev,
958 struct device_attribute *da, char *buf)
960 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
961 struct pmbus_boolean *boolean = to_pmbus_boolean(attr);
962 struct pmbus_data *data = pmbus_update_device(dev);
965 val = pmbus_get_boolean(data, boolean, attr->index);
968 return snprintf(buf, PAGE_SIZE, "%d\n", val);
971 static ssize_t pmbus_show_sensor(struct device *dev,
972 struct device_attribute *devattr, char *buf)
974 struct pmbus_data *data = pmbus_update_device(dev);
975 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
977 if (sensor->data < 0)
980 return snprintf(buf, PAGE_SIZE, "%lld\n", pmbus_reg2data(data, sensor));
983 static ssize_t pmbus_set_sensor(struct device *dev,
984 struct device_attribute *devattr,
985 const char *buf, size_t count)
987 struct i2c_client *client = to_i2c_client(dev->parent);
988 struct pmbus_data *data = i2c_get_clientdata(client);
989 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
995 if (kstrtos64(buf, 10, &val) < 0)
998 mutex_lock(&data->update_lock);
999 regval = pmbus_data2reg(data, sensor, val);
1000 ret = _pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
1004 sensor->data = regval;
1005 mutex_unlock(&data->update_lock);
1009 static ssize_t pmbus_show_label(struct device *dev,
1010 struct device_attribute *da, char *buf)
1012 struct pmbus_label *label = to_pmbus_label(da);
1014 return snprintf(buf, PAGE_SIZE, "%s\n", label->label);
1017 static int pmbus_add_attribute(struct pmbus_data *data, struct attribute *attr)
1019 if (data->num_attributes >= data->max_attributes - 1) {
1020 int new_max_attrs = data->max_attributes + PMBUS_ATTR_ALLOC_SIZE;
1021 void *new_attrs = krealloc(data->group.attrs,
1022 new_max_attrs * sizeof(void *),
1026 data->group.attrs = new_attrs;
1027 data->max_attributes = new_max_attrs;
1030 data->group.attrs[data->num_attributes++] = attr;
1031 data->group.attrs[data->num_attributes] = NULL;
1035 static void pmbus_dev_attr_init(struct device_attribute *dev_attr,
1038 ssize_t (*show)(struct device *dev,
1039 struct device_attribute *attr,
1041 ssize_t (*store)(struct device *dev,
1042 struct device_attribute *attr,
1043 const char *buf, size_t count))
1045 sysfs_attr_init(&dev_attr->attr);
1046 dev_attr->attr.name = name;
1047 dev_attr->attr.mode = mode;
1048 dev_attr->show = show;
1049 dev_attr->store = store;
1052 static void pmbus_attr_init(struct sensor_device_attribute *a,
1055 ssize_t (*show)(struct device *dev,
1056 struct device_attribute *attr,
1058 ssize_t (*store)(struct device *dev,
1059 struct device_attribute *attr,
1060 const char *buf, size_t count),
1063 pmbus_dev_attr_init(&a->dev_attr, name, mode, show, store);
1067 static int pmbus_add_boolean(struct pmbus_data *data,
1068 const char *name, const char *type, int seq,
1069 struct pmbus_sensor *s1,
1070 struct pmbus_sensor *s2,
1073 struct pmbus_boolean *boolean;
1074 struct sensor_device_attribute *a;
1076 boolean = devm_kzalloc(data->dev, sizeof(*boolean), GFP_KERNEL);
1080 a = &boolean->attribute;
1082 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
1086 pmbus_attr_init(a, boolean->name, 0444, pmbus_show_boolean, NULL,
1087 (reg << 16) | mask);
1089 return pmbus_add_attribute(data, &a->dev_attr.attr);
1092 static struct pmbus_sensor *pmbus_add_sensor(struct pmbus_data *data,
1093 const char *name, const char *type,
1094 int seq, int page, int phase,
1096 enum pmbus_sensor_classes class,
1097 bool update, bool readonly,
1100 struct pmbus_sensor *sensor;
1101 struct device_attribute *a;
1103 sensor = devm_kzalloc(data->dev, sizeof(*sensor), GFP_KERNEL);
1106 a = &sensor->attribute;
1109 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
1112 snprintf(sensor->name, sizeof(sensor->name), "%s%d",
1115 if (data->flags & PMBUS_WRITE_PROTECTED)
1118 sensor->page = page;
1119 sensor->phase = phase;
1121 sensor->class = class;
1122 sensor->update = update;
1123 sensor->convert = convert;
1124 pmbus_dev_attr_init(a, sensor->name,
1125 readonly ? 0444 : 0644,
1126 pmbus_show_sensor, pmbus_set_sensor);
1128 if (pmbus_add_attribute(data, &a->attr))
1131 sensor->next = data->sensors;
1132 data->sensors = sensor;
1137 static int pmbus_add_label(struct pmbus_data *data,
1138 const char *name, int seq,
1139 const char *lstring, int index, int phase)
1141 struct pmbus_label *label;
1142 struct device_attribute *a;
1144 label = devm_kzalloc(data->dev, sizeof(*label), GFP_KERNEL);
1148 a = &label->attribute;
1150 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
1153 strncpy(label->label, lstring,
1154 sizeof(label->label) - 1);
1156 snprintf(label->label, sizeof(label->label), "%s.%d",
1160 snprintf(label->label, sizeof(label->label), "%s%d",
1163 snprintf(label->label, sizeof(label->label), "%s%d.%d",
1164 lstring, index, phase);
1167 pmbus_dev_attr_init(a, label->name, 0444, pmbus_show_label, NULL);
1168 return pmbus_add_attribute(data, &a->attr);
1172 * Search for attributes. Allocate sensors, booleans, and labels as needed.
1176 * The pmbus_limit_attr structure describes a single limit attribute
1177 * and its associated alarm attribute.
1179 struct pmbus_limit_attr {
1180 u16 reg; /* Limit register */
1181 u16 sbit; /* Alarm attribute status bit */
1182 bool update; /* True if register needs updates */
1183 bool low; /* True if low limit; for limits with compare
1185 const char *attr; /* Attribute name */
1186 const char *alarm; /* Alarm attribute name */
1190 * The pmbus_sensor_attr structure describes one sensor attribute. This
1191 * description includes a reference to the associated limit attributes.
1193 struct pmbus_sensor_attr {
1194 u16 reg; /* sensor register */
1195 u16 gbit; /* generic status bit */
1196 u8 nlimit; /* # of limit registers */
1197 enum pmbus_sensor_classes class;/* sensor class */
1198 const char *label; /* sensor label */
1199 bool paged; /* true if paged sensor */
1200 bool update; /* true if update needed */
1201 bool compare; /* true if compare function needed */
1202 u32 func; /* sensor mask */
1203 u32 sfunc; /* sensor status mask */
1204 int sbase; /* status base register */
1205 const struct pmbus_limit_attr *limit;/* limit registers */
1209 * Add a set of limit attributes and, if supported, the associated
1211 * returns 0 if no alarm register found, 1 if an alarm register was found,
1214 static int pmbus_add_limit_attrs(struct i2c_client *client,
1215 struct pmbus_data *data,
1216 const struct pmbus_driver_info *info,
1217 const char *name, int index, int page,
1218 struct pmbus_sensor *base,
1219 const struct pmbus_sensor_attr *attr)
1221 const struct pmbus_limit_attr *l = attr->limit;
1222 int nlimit = attr->nlimit;
1225 struct pmbus_sensor *curr;
1227 for (i = 0; i < nlimit; i++) {
1228 if (pmbus_check_word_register(client, page, l->reg)) {
1229 curr = pmbus_add_sensor(data, name, l->attr, index,
1230 page, 0xff, l->reg, attr->class,
1231 attr->update || l->update,
1235 if (l->sbit && (info->func[page] & attr->sfunc)) {
1236 ret = pmbus_add_boolean(data, name,
1238 attr->compare ? l->low ? curr : base
1240 attr->compare ? l->low ? base : curr
1242 attr->sbase + page, l->sbit);
1253 static int pmbus_add_sensor_attrs_one(struct i2c_client *client,
1254 struct pmbus_data *data,
1255 const struct pmbus_driver_info *info,
1257 int index, int page, int phase,
1258 const struct pmbus_sensor_attr *attr,
1261 struct pmbus_sensor *base;
1262 bool upper = !!(attr->gbit & 0xff00); /* need to check STATUS_WORD */
1266 ret = pmbus_add_label(data, name, index, attr->label,
1267 paged ? page + 1 : 0, phase);
1271 base = pmbus_add_sensor(data, name, "input", index, page, phase,
1272 attr->reg, attr->class, true, true, true);
1275 /* No limit and alarm attributes for phase specific sensors */
1276 if (attr->sfunc && phase == 0xff) {
1277 ret = pmbus_add_limit_attrs(client, data, info, name,
1278 index, page, base, attr);
1282 * Add generic alarm attribute only if there are no individual
1283 * alarm attributes, if there is a global alarm bit, and if
1284 * the generic status register (word or byte, depending on
1285 * which global bit is set) for this page is accessible.
1287 if (!ret && attr->gbit &&
1288 (!upper || (upper && data->has_status_word)) &&
1289 pmbus_check_status_register(client, page)) {
1290 ret = pmbus_add_boolean(data, name, "alarm", index,
1292 PB_STATUS_BASE + page,
1301 static bool pmbus_sensor_is_paged(const struct pmbus_driver_info *info,
1302 const struct pmbus_sensor_attr *attr)
1310 * Some attributes may be present on more than one page despite
1311 * not being marked with the paged attribute. If that is the case,
1312 * then treat the sensor as being paged and add the page suffix to the
1314 * We don't just add the paged attribute to all such attributes, in
1315 * order to maintain the un-suffixed labels in the case where the
1316 * attribute is only on page 0.
1318 for (p = 1; p < info->pages; p++) {
1319 if (info->func[p] & attr->func)
1325 static int pmbus_add_sensor_attrs(struct i2c_client *client,
1326 struct pmbus_data *data,
1328 const struct pmbus_sensor_attr *attrs,
1331 const struct pmbus_driver_info *info = data->info;
1336 for (i = 0; i < nattrs; i++) {
1338 bool paged = pmbus_sensor_is_paged(info, attrs);
1340 pages = paged ? info->pages : 1;
1341 for (page = 0; page < pages; page++) {
1342 if (!(info->func[page] & attrs->func))
1344 ret = pmbus_add_sensor_attrs_one(client, data, info,
1346 0xff, attrs, paged);
1350 if (info->phases[page]) {
1353 for (phase = 0; phase < info->phases[page];
1355 if (!(info->pfunc[phase] & attrs->func))
1357 ret = pmbus_add_sensor_attrs_one(client,
1358 data, info, name, index, page,
1359 phase, attrs, paged);
1371 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1373 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1375 .alarm = "min_alarm",
1376 .sbit = PB_VOLTAGE_UV_WARNING,
1378 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1380 .alarm = "lcrit_alarm",
1381 .sbit = PB_VOLTAGE_UV_FAULT,
1383 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1385 .alarm = "max_alarm",
1386 .sbit = PB_VOLTAGE_OV_WARNING,
1388 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1390 .alarm = "crit_alarm",
1391 .sbit = PB_VOLTAGE_OV_FAULT,
1393 .reg = PMBUS_VIRT_READ_VIN_AVG,
1397 .reg = PMBUS_VIRT_READ_VIN_MIN,
1401 .reg = PMBUS_VIRT_READ_VIN_MAX,
1405 .reg = PMBUS_VIRT_RESET_VIN_HISTORY,
1406 .attr = "reset_history",
1410 static const struct pmbus_limit_attr vmon_limit_attrs[] = {
1412 .reg = PMBUS_VIRT_VMON_UV_WARN_LIMIT,
1414 .alarm = "min_alarm",
1415 .sbit = PB_VOLTAGE_UV_WARNING,
1417 .reg = PMBUS_VIRT_VMON_UV_FAULT_LIMIT,
1419 .alarm = "lcrit_alarm",
1420 .sbit = PB_VOLTAGE_UV_FAULT,
1422 .reg = PMBUS_VIRT_VMON_OV_WARN_LIMIT,
1424 .alarm = "max_alarm",
1425 .sbit = PB_VOLTAGE_OV_WARNING,
1427 .reg = PMBUS_VIRT_VMON_OV_FAULT_LIMIT,
1429 .alarm = "crit_alarm",
1430 .sbit = PB_VOLTAGE_OV_FAULT,
1434 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1436 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1438 .alarm = "min_alarm",
1439 .sbit = PB_VOLTAGE_UV_WARNING,
1441 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1443 .alarm = "lcrit_alarm",
1444 .sbit = PB_VOLTAGE_UV_FAULT,
1446 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1448 .alarm = "max_alarm",
1449 .sbit = PB_VOLTAGE_OV_WARNING,
1451 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1453 .alarm = "crit_alarm",
1454 .sbit = PB_VOLTAGE_OV_FAULT,
1456 .reg = PMBUS_VIRT_READ_VOUT_AVG,
1460 .reg = PMBUS_VIRT_READ_VOUT_MIN,
1464 .reg = PMBUS_VIRT_READ_VOUT_MAX,
1468 .reg = PMBUS_VIRT_RESET_VOUT_HISTORY,
1469 .attr = "reset_history",
1473 static const struct pmbus_sensor_attr voltage_attributes[] = {
1475 .reg = PMBUS_READ_VIN,
1476 .class = PSC_VOLTAGE_IN,
1478 .func = PMBUS_HAVE_VIN,
1479 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1480 .sbase = PB_STATUS_INPUT_BASE,
1481 .gbit = PB_STATUS_VIN_UV,
1482 .limit = vin_limit_attrs,
1483 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1485 .reg = PMBUS_VIRT_READ_VMON,
1486 .class = PSC_VOLTAGE_IN,
1488 .func = PMBUS_HAVE_VMON,
1489 .sfunc = PMBUS_HAVE_STATUS_VMON,
1490 .sbase = PB_STATUS_VMON_BASE,
1491 .limit = vmon_limit_attrs,
1492 .nlimit = ARRAY_SIZE(vmon_limit_attrs),
1494 .reg = PMBUS_READ_VCAP,
1495 .class = PSC_VOLTAGE_IN,
1497 .func = PMBUS_HAVE_VCAP,
1499 .reg = PMBUS_READ_VOUT,
1500 .class = PSC_VOLTAGE_OUT,
1503 .func = PMBUS_HAVE_VOUT,
1504 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1505 .sbase = PB_STATUS_VOUT_BASE,
1506 .gbit = PB_STATUS_VOUT_OV,
1507 .limit = vout_limit_attrs,
1508 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1512 /* Current attributes */
1514 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1516 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1518 .alarm = "max_alarm",
1519 .sbit = PB_IIN_OC_WARNING,
1521 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1523 .alarm = "crit_alarm",
1524 .sbit = PB_IIN_OC_FAULT,
1526 .reg = PMBUS_VIRT_READ_IIN_AVG,
1530 .reg = PMBUS_VIRT_READ_IIN_MIN,
1534 .reg = PMBUS_VIRT_READ_IIN_MAX,
1538 .reg = PMBUS_VIRT_RESET_IIN_HISTORY,
1539 .attr = "reset_history",
1543 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1545 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1547 .alarm = "max_alarm",
1548 .sbit = PB_IOUT_OC_WARNING,
1550 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1552 .alarm = "lcrit_alarm",
1553 .sbit = PB_IOUT_UC_FAULT,
1555 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1557 .alarm = "crit_alarm",
1558 .sbit = PB_IOUT_OC_FAULT,
1560 .reg = PMBUS_VIRT_READ_IOUT_AVG,
1564 .reg = PMBUS_VIRT_READ_IOUT_MIN,
1568 .reg = PMBUS_VIRT_READ_IOUT_MAX,
1572 .reg = PMBUS_VIRT_RESET_IOUT_HISTORY,
1573 .attr = "reset_history",
1577 static const struct pmbus_sensor_attr current_attributes[] = {
1579 .reg = PMBUS_READ_IIN,
1580 .class = PSC_CURRENT_IN,
1582 .func = PMBUS_HAVE_IIN,
1583 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1584 .sbase = PB_STATUS_INPUT_BASE,
1585 .gbit = PB_STATUS_INPUT,
1586 .limit = iin_limit_attrs,
1587 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1589 .reg = PMBUS_READ_IOUT,
1590 .class = PSC_CURRENT_OUT,
1593 .func = PMBUS_HAVE_IOUT,
1594 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1595 .sbase = PB_STATUS_IOUT_BASE,
1596 .gbit = PB_STATUS_IOUT_OC,
1597 .limit = iout_limit_attrs,
1598 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1602 /* Power attributes */
1604 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1606 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1609 .sbit = PB_PIN_OP_WARNING,
1611 .reg = PMBUS_VIRT_READ_PIN_AVG,
1615 .reg = PMBUS_VIRT_READ_PIN_MIN,
1617 .attr = "input_lowest",
1619 .reg = PMBUS_VIRT_READ_PIN_MAX,
1621 .attr = "input_highest",
1623 .reg = PMBUS_VIRT_RESET_PIN_HISTORY,
1624 .attr = "reset_history",
1628 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1630 .reg = PMBUS_POUT_MAX,
1632 .alarm = "cap_alarm",
1633 .sbit = PB_POWER_LIMITING,
1635 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1637 .alarm = "max_alarm",
1638 .sbit = PB_POUT_OP_WARNING,
1640 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1642 .alarm = "crit_alarm",
1643 .sbit = PB_POUT_OP_FAULT,
1645 .reg = PMBUS_VIRT_READ_POUT_AVG,
1649 .reg = PMBUS_VIRT_READ_POUT_MIN,
1651 .attr = "input_lowest",
1653 .reg = PMBUS_VIRT_READ_POUT_MAX,
1655 .attr = "input_highest",
1657 .reg = PMBUS_VIRT_RESET_POUT_HISTORY,
1658 .attr = "reset_history",
1662 static const struct pmbus_sensor_attr power_attributes[] = {
1664 .reg = PMBUS_READ_PIN,
1667 .func = PMBUS_HAVE_PIN,
1668 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1669 .sbase = PB_STATUS_INPUT_BASE,
1670 .gbit = PB_STATUS_INPUT,
1671 .limit = pin_limit_attrs,
1672 .nlimit = ARRAY_SIZE(pin_limit_attrs),
1674 .reg = PMBUS_READ_POUT,
1678 .func = PMBUS_HAVE_POUT,
1679 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1680 .sbase = PB_STATUS_IOUT_BASE,
1681 .limit = pout_limit_attrs,
1682 .nlimit = ARRAY_SIZE(pout_limit_attrs),
1686 /* Temperature atributes */
1688 static const struct pmbus_limit_attr temp_limit_attrs[] = {
1690 .reg = PMBUS_UT_WARN_LIMIT,
1693 .alarm = "min_alarm",
1694 .sbit = PB_TEMP_UT_WARNING,
1696 .reg = PMBUS_UT_FAULT_LIMIT,
1699 .alarm = "lcrit_alarm",
1700 .sbit = PB_TEMP_UT_FAULT,
1702 .reg = PMBUS_OT_WARN_LIMIT,
1704 .alarm = "max_alarm",
1705 .sbit = PB_TEMP_OT_WARNING,
1707 .reg = PMBUS_OT_FAULT_LIMIT,
1709 .alarm = "crit_alarm",
1710 .sbit = PB_TEMP_OT_FAULT,
1712 .reg = PMBUS_VIRT_READ_TEMP_MIN,
1715 .reg = PMBUS_VIRT_READ_TEMP_AVG,
1718 .reg = PMBUS_VIRT_READ_TEMP_MAX,
1721 .reg = PMBUS_VIRT_RESET_TEMP_HISTORY,
1722 .attr = "reset_history",
1726 static const struct pmbus_limit_attr temp_limit_attrs2[] = {
1728 .reg = PMBUS_UT_WARN_LIMIT,
1731 .alarm = "min_alarm",
1732 .sbit = PB_TEMP_UT_WARNING,
1734 .reg = PMBUS_UT_FAULT_LIMIT,
1737 .alarm = "lcrit_alarm",
1738 .sbit = PB_TEMP_UT_FAULT,
1740 .reg = PMBUS_OT_WARN_LIMIT,
1742 .alarm = "max_alarm",
1743 .sbit = PB_TEMP_OT_WARNING,
1745 .reg = PMBUS_OT_FAULT_LIMIT,
1747 .alarm = "crit_alarm",
1748 .sbit = PB_TEMP_OT_FAULT,
1750 .reg = PMBUS_VIRT_READ_TEMP2_MIN,
1753 .reg = PMBUS_VIRT_READ_TEMP2_AVG,
1756 .reg = PMBUS_VIRT_READ_TEMP2_MAX,
1759 .reg = PMBUS_VIRT_RESET_TEMP2_HISTORY,
1760 .attr = "reset_history",
1764 static const struct pmbus_limit_attr temp_limit_attrs3[] = {
1766 .reg = PMBUS_UT_WARN_LIMIT,
1769 .alarm = "min_alarm",
1770 .sbit = PB_TEMP_UT_WARNING,
1772 .reg = PMBUS_UT_FAULT_LIMIT,
1775 .alarm = "lcrit_alarm",
1776 .sbit = PB_TEMP_UT_FAULT,
1778 .reg = PMBUS_OT_WARN_LIMIT,
1780 .alarm = "max_alarm",
1781 .sbit = PB_TEMP_OT_WARNING,
1783 .reg = PMBUS_OT_FAULT_LIMIT,
1785 .alarm = "crit_alarm",
1786 .sbit = PB_TEMP_OT_FAULT,
1790 static const struct pmbus_sensor_attr temp_attributes[] = {
1792 .reg = PMBUS_READ_TEMPERATURE_1,
1793 .class = PSC_TEMPERATURE,
1797 .func = PMBUS_HAVE_TEMP,
1798 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1799 .sbase = PB_STATUS_TEMP_BASE,
1800 .gbit = PB_STATUS_TEMPERATURE,
1801 .limit = temp_limit_attrs,
1802 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1804 .reg = PMBUS_READ_TEMPERATURE_2,
1805 .class = PSC_TEMPERATURE,
1809 .func = PMBUS_HAVE_TEMP2,
1810 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1811 .sbase = PB_STATUS_TEMP_BASE,
1812 .gbit = PB_STATUS_TEMPERATURE,
1813 .limit = temp_limit_attrs2,
1814 .nlimit = ARRAY_SIZE(temp_limit_attrs2),
1816 .reg = PMBUS_READ_TEMPERATURE_3,
1817 .class = PSC_TEMPERATURE,
1821 .func = PMBUS_HAVE_TEMP3,
1822 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1823 .sbase = PB_STATUS_TEMP_BASE,
1824 .gbit = PB_STATUS_TEMPERATURE,
1825 .limit = temp_limit_attrs3,
1826 .nlimit = ARRAY_SIZE(temp_limit_attrs3),
1830 static const int pmbus_fan_registers[] = {
1831 PMBUS_READ_FAN_SPEED_1,
1832 PMBUS_READ_FAN_SPEED_2,
1833 PMBUS_READ_FAN_SPEED_3,
1834 PMBUS_READ_FAN_SPEED_4
1837 static const int pmbus_fan_status_registers[] = {
1838 PMBUS_STATUS_FAN_12,
1839 PMBUS_STATUS_FAN_12,
1840 PMBUS_STATUS_FAN_34,
1844 static const u32 pmbus_fan_flags[] = {
1851 static const u32 pmbus_fan_status_flags[] = {
1852 PMBUS_HAVE_STATUS_FAN12,
1853 PMBUS_HAVE_STATUS_FAN12,
1854 PMBUS_HAVE_STATUS_FAN34,
1855 PMBUS_HAVE_STATUS_FAN34
1860 /* Precondition: FAN_CONFIG_x_y and FAN_COMMAND_x must exist for the fan ID */
1861 static int pmbus_add_fan_ctrl(struct i2c_client *client,
1862 struct pmbus_data *data, int index, int page, int id,
1865 struct pmbus_sensor *sensor;
1867 sensor = pmbus_add_sensor(data, "fan", "target", index, page,
1868 0xff, PMBUS_VIRT_FAN_TARGET_1 + id, PSC_FAN,
1869 false, false, true);
1874 if (!((data->info->func[page] & PMBUS_HAVE_PWM12) ||
1875 (data->info->func[page] & PMBUS_HAVE_PWM34)))
1878 sensor = pmbus_add_sensor(data, "pwm", NULL, index, page,
1879 0xff, PMBUS_VIRT_PWM_1 + id, PSC_PWM,
1880 false, false, true);
1885 sensor = pmbus_add_sensor(data, "pwm", "enable", index, page,
1886 0xff, PMBUS_VIRT_PWM_ENABLE_1 + id, PSC_PWM,
1887 true, false, false);
1895 static int pmbus_add_fan_attributes(struct i2c_client *client,
1896 struct pmbus_data *data)
1898 const struct pmbus_driver_info *info = data->info;
1903 for (page = 0; page < info->pages; page++) {
1906 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
1909 if (!(info->func[page] & pmbus_fan_flags[f]))
1912 if (!pmbus_check_word_register(client, page,
1913 pmbus_fan_registers[f]))
1917 * Skip fan if not installed.
1918 * Each fan configuration register covers multiple fans,
1919 * so we have to do some magic.
1921 regval = _pmbus_read_byte_data(client, page,
1922 pmbus_fan_config_registers[f]);
1924 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
1927 if (pmbus_add_sensor(data, "fan", "input", index,
1928 page, 0xff, pmbus_fan_registers[f],
1929 PSC_FAN, true, true, true) == NULL)
1933 if (pmbus_check_word_register(client, page,
1934 pmbus_fan_command_registers[f])) {
1935 ret = pmbus_add_fan_ctrl(client, data, index,
1942 * Each fan status register covers multiple fans,
1943 * so we have to do some magic.
1945 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
1946 pmbus_check_byte_register(client,
1947 page, pmbus_fan_status_registers[f])) {
1950 if (f > 1) /* fan 3, 4 */
1951 base = PB_STATUS_FAN34_BASE + page;
1953 base = PB_STATUS_FAN_BASE + page;
1954 ret = pmbus_add_boolean(data, "fan",
1955 "alarm", index, NULL, NULL, base,
1956 PB_FAN_FAN1_WARNING >> (f & 1));
1959 ret = pmbus_add_boolean(data, "fan",
1960 "fault", index, NULL, NULL, base,
1961 PB_FAN_FAN1_FAULT >> (f & 1));
1971 struct pmbus_samples_attr {
1976 struct pmbus_samples_reg {
1978 struct pmbus_samples_attr *attr;
1979 struct device_attribute dev_attr;
1982 static struct pmbus_samples_attr pmbus_samples_registers[] = {
1984 .reg = PMBUS_VIRT_SAMPLES,
1987 .reg = PMBUS_VIRT_IN_SAMPLES,
1988 .name = "in_samples",
1990 .reg = PMBUS_VIRT_CURR_SAMPLES,
1991 .name = "curr_samples",
1993 .reg = PMBUS_VIRT_POWER_SAMPLES,
1994 .name = "power_samples",
1996 .reg = PMBUS_VIRT_TEMP_SAMPLES,
1997 .name = "temp_samples",
2001 #define to_samples_reg(x) container_of(x, struct pmbus_samples_reg, dev_attr)
2003 static ssize_t pmbus_show_samples(struct device *dev,
2004 struct device_attribute *devattr, char *buf)
2007 struct i2c_client *client = to_i2c_client(dev->parent);
2008 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2010 val = _pmbus_read_word_data(client, reg->page, 0xff, reg->attr->reg);
2014 return snprintf(buf, PAGE_SIZE, "%d\n", val);
2017 static ssize_t pmbus_set_samples(struct device *dev,
2018 struct device_attribute *devattr,
2019 const char *buf, size_t count)
2023 struct i2c_client *client = to_i2c_client(dev->parent);
2024 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2025 struct pmbus_data *data = i2c_get_clientdata(client);
2027 if (kstrtol(buf, 0, &val) < 0)
2030 mutex_lock(&data->update_lock);
2031 ret = _pmbus_write_word_data(client, reg->page, reg->attr->reg, val);
2032 mutex_unlock(&data->update_lock);
2034 return ret ? : count;
2037 static int pmbus_add_samples_attr(struct pmbus_data *data, int page,
2038 struct pmbus_samples_attr *attr)
2040 struct pmbus_samples_reg *reg;
2042 reg = devm_kzalloc(data->dev, sizeof(*reg), GFP_KERNEL);
2049 pmbus_dev_attr_init(®->dev_attr, attr->name, 0644,
2050 pmbus_show_samples, pmbus_set_samples);
2052 return pmbus_add_attribute(data, ®->dev_attr.attr);
2055 static int pmbus_add_samples_attributes(struct i2c_client *client,
2056 struct pmbus_data *data)
2058 const struct pmbus_driver_info *info = data->info;
2061 if (!(info->func[0] & PMBUS_HAVE_SAMPLES))
2064 for (s = 0; s < ARRAY_SIZE(pmbus_samples_registers); s++) {
2065 struct pmbus_samples_attr *attr;
2068 attr = &pmbus_samples_registers[s];
2069 if (!pmbus_check_word_register(client, 0, attr->reg))
2072 ret = pmbus_add_samples_attr(data, 0, attr);
2080 static int pmbus_find_attributes(struct i2c_client *client,
2081 struct pmbus_data *data)
2085 /* Voltage sensors */
2086 ret = pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
2087 ARRAY_SIZE(voltage_attributes));
2091 /* Current sensors */
2092 ret = pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
2093 ARRAY_SIZE(current_attributes));
2098 ret = pmbus_add_sensor_attrs(client, data, "power", power_attributes,
2099 ARRAY_SIZE(power_attributes));
2103 /* Temperature sensors */
2104 ret = pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
2105 ARRAY_SIZE(temp_attributes));
2110 ret = pmbus_add_fan_attributes(client, data);
2114 ret = pmbus_add_samples_attributes(client, data);
2119 * Identify chip parameters.
2120 * This function is called for all chips.
2122 static int pmbus_identify_common(struct i2c_client *client,
2123 struct pmbus_data *data, int page)
2127 if (pmbus_check_byte_register(client, page, PMBUS_VOUT_MODE))
2128 vout_mode = _pmbus_read_byte_data(client, page,
2130 if (vout_mode >= 0 && vout_mode != 0xff) {
2132 * Not all chips support the VOUT_MODE command,
2133 * so a failure to read it is not an error.
2135 switch (vout_mode >> 5) {
2136 case 0: /* linear mode */
2137 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
2140 data->exponent[page] = ((s8)(vout_mode << 3)) >> 3;
2142 case 1: /* VID mode */
2143 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
2146 case 2: /* direct mode */
2147 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
2155 pmbus_clear_fault_page(client, page);
2159 static int pmbus_read_status_byte(struct i2c_client *client, int page)
2161 return _pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
2164 static int pmbus_read_status_word(struct i2c_client *client, int page)
2166 return _pmbus_read_word_data(client, page, 0xff, PMBUS_STATUS_WORD);
2169 static int pmbus_init_common(struct i2c_client *client, struct pmbus_data *data,
2170 struct pmbus_driver_info *info)
2172 struct device *dev = &client->dev;
2176 * Some PMBus chips don't support PMBUS_STATUS_WORD, so try
2177 * to use PMBUS_STATUS_BYTE instead if that is the case.
2178 * Bail out if both registers are not supported.
2180 data->read_status = pmbus_read_status_word;
2181 ret = i2c_smbus_read_word_data(client, PMBUS_STATUS_WORD);
2182 if (ret < 0 || ret == 0xffff) {
2183 data->read_status = pmbus_read_status_byte;
2184 ret = i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE);
2185 if (ret < 0 || ret == 0xff) {
2186 dev_err(dev, "PMBus status register not found\n");
2190 data->has_status_word = true;
2193 /* Enable PEC if the controller supports it */
2194 ret = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
2195 if (ret >= 0 && (ret & PB_CAPABILITY_ERROR_CHECK))
2196 client->flags |= I2C_CLIENT_PEC;
2199 * Check if the chip is write protected. If it is, we can not clear
2200 * faults, and we should not try it. Also, in that case, writes into
2201 * limit registers need to be disabled.
2203 ret = i2c_smbus_read_byte_data(client, PMBUS_WRITE_PROTECT);
2204 if (ret > 0 && (ret & PB_WP_ANY))
2205 data->flags |= PMBUS_WRITE_PROTECTED | PMBUS_SKIP_STATUS_CHECK;
2207 if (data->info->pages)
2208 pmbus_clear_faults(client);
2210 pmbus_clear_fault_page(client, -1);
2212 if (info->identify) {
2213 ret = (*info->identify)(client, info);
2215 dev_err(dev, "Chip identification failed\n");
2220 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
2221 dev_err(dev, "Bad number of PMBus pages: %d\n", info->pages);
2225 for (page = 0; page < info->pages; page++) {
2226 ret = pmbus_identify_common(client, data, page);
2228 dev_err(dev, "Failed to identify chip capabilities\n");
2235 #if IS_ENABLED(CONFIG_REGULATOR)
2236 static int pmbus_regulator_is_enabled(struct regulator_dev *rdev)
2238 struct device *dev = rdev_get_dev(rdev);
2239 struct i2c_client *client = to_i2c_client(dev->parent);
2240 u8 page = rdev_get_id(rdev);
2243 ret = pmbus_read_byte_data(client, page, PMBUS_OPERATION);
2247 return !!(ret & PB_OPERATION_CONTROL_ON);
2250 static int _pmbus_regulator_on_off(struct regulator_dev *rdev, bool enable)
2252 struct device *dev = rdev_get_dev(rdev);
2253 struct i2c_client *client = to_i2c_client(dev->parent);
2254 u8 page = rdev_get_id(rdev);
2256 return pmbus_update_byte_data(client, page, PMBUS_OPERATION,
2257 PB_OPERATION_CONTROL_ON,
2258 enable ? PB_OPERATION_CONTROL_ON : 0);
2261 static int pmbus_regulator_enable(struct regulator_dev *rdev)
2263 return _pmbus_regulator_on_off(rdev, 1);
2266 static int pmbus_regulator_disable(struct regulator_dev *rdev)
2268 return _pmbus_regulator_on_off(rdev, 0);
2271 const struct regulator_ops pmbus_regulator_ops = {
2272 .enable = pmbus_regulator_enable,
2273 .disable = pmbus_regulator_disable,
2274 .is_enabled = pmbus_regulator_is_enabled,
2276 EXPORT_SYMBOL_GPL(pmbus_regulator_ops);
2278 static int pmbus_regulator_register(struct pmbus_data *data)
2280 struct device *dev = data->dev;
2281 const struct pmbus_driver_info *info = data->info;
2282 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
2283 struct regulator_dev *rdev;
2286 for (i = 0; i < info->num_regulators; i++) {
2287 struct regulator_config config = { };
2290 config.driver_data = data;
2292 if (pdata && pdata->reg_init_data)
2293 config.init_data = &pdata->reg_init_data[i];
2295 rdev = devm_regulator_register(dev, &info->reg_desc[i],
2298 dev_err(dev, "Failed to register %s regulator\n",
2299 info->reg_desc[i].name);
2300 return PTR_ERR(rdev);
2307 static int pmbus_regulator_register(struct pmbus_data *data)
2313 static struct dentry *pmbus_debugfs_dir; /* pmbus debugfs directory */
2315 #if IS_ENABLED(CONFIG_DEBUG_FS)
2316 static int pmbus_debugfs_get(void *data, u64 *val)
2319 struct pmbus_debugfs_entry *entry = data;
2321 rc = _pmbus_read_byte_data(entry->client, entry->page, entry->reg);
2329 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops, pmbus_debugfs_get, NULL,
2332 static int pmbus_debugfs_get_status(void *data, u64 *val)
2335 struct pmbus_debugfs_entry *entry = data;
2336 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
2338 rc = pdata->read_status(entry->client, entry->page);
2346 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_status, pmbus_debugfs_get_status,
2347 NULL, "0x%04llx\n");
2349 static int pmbus_init_debugfs(struct i2c_client *client,
2350 struct pmbus_data *data)
2353 char name[PMBUS_NAME_SIZE];
2354 struct pmbus_debugfs_entry *entries;
2356 if (!pmbus_debugfs_dir)
2360 * Create the debugfs directory for this device. Use the hwmon device
2361 * name to avoid conflicts (hwmon numbers are globally unique).
2363 data->debugfs = debugfs_create_dir(dev_name(data->hwmon_dev),
2365 if (IS_ERR_OR_NULL(data->debugfs)) {
2366 data->debugfs = NULL;
2370 /* Allocate the max possible entries we need. */
2371 entries = devm_kcalloc(data->dev,
2372 data->info->pages * 10, sizeof(*entries),
2377 for (i = 0; i < data->info->pages; ++i) {
2378 /* Check accessibility of status register if it's not page 0 */
2379 if (!i || pmbus_check_status_register(client, i)) {
2380 /* No need to set reg as we have special read op. */
2381 entries[idx].client = client;
2382 entries[idx].page = i;
2383 scnprintf(name, PMBUS_NAME_SIZE, "status%d", i);
2384 debugfs_create_file(name, 0444, data->debugfs,
2386 &pmbus_debugfs_ops_status);
2389 if (data->info->func[i] & PMBUS_HAVE_STATUS_VOUT) {
2390 entries[idx].client = client;
2391 entries[idx].page = i;
2392 entries[idx].reg = PMBUS_STATUS_VOUT;
2393 scnprintf(name, PMBUS_NAME_SIZE, "status%d_vout", i);
2394 debugfs_create_file(name, 0444, data->debugfs,
2396 &pmbus_debugfs_ops);
2399 if (data->info->func[i] & PMBUS_HAVE_STATUS_IOUT) {
2400 entries[idx].client = client;
2401 entries[idx].page = i;
2402 entries[idx].reg = PMBUS_STATUS_IOUT;
2403 scnprintf(name, PMBUS_NAME_SIZE, "status%d_iout", i);
2404 debugfs_create_file(name, 0444, data->debugfs,
2406 &pmbus_debugfs_ops);
2409 if (data->info->func[i] & PMBUS_HAVE_STATUS_INPUT) {
2410 entries[idx].client = client;
2411 entries[idx].page = i;
2412 entries[idx].reg = PMBUS_STATUS_INPUT;
2413 scnprintf(name, PMBUS_NAME_SIZE, "status%d_input", i);
2414 debugfs_create_file(name, 0444, data->debugfs,
2416 &pmbus_debugfs_ops);
2419 if (data->info->func[i] & PMBUS_HAVE_STATUS_TEMP) {
2420 entries[idx].client = client;
2421 entries[idx].page = i;
2422 entries[idx].reg = PMBUS_STATUS_TEMPERATURE;
2423 scnprintf(name, PMBUS_NAME_SIZE, "status%d_temp", i);
2424 debugfs_create_file(name, 0444, data->debugfs,
2426 &pmbus_debugfs_ops);
2429 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_CML)) {
2430 entries[idx].client = client;
2431 entries[idx].page = i;
2432 entries[idx].reg = PMBUS_STATUS_CML;
2433 scnprintf(name, PMBUS_NAME_SIZE, "status%d_cml", i);
2434 debugfs_create_file(name, 0444, data->debugfs,
2436 &pmbus_debugfs_ops);
2439 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_OTHER)) {
2440 entries[idx].client = client;
2441 entries[idx].page = i;
2442 entries[idx].reg = PMBUS_STATUS_OTHER;
2443 scnprintf(name, PMBUS_NAME_SIZE, "status%d_other", i);
2444 debugfs_create_file(name, 0444, data->debugfs,
2446 &pmbus_debugfs_ops);
2449 if (pmbus_check_byte_register(client, i,
2450 PMBUS_STATUS_MFR_SPECIFIC)) {
2451 entries[idx].client = client;
2452 entries[idx].page = i;
2453 entries[idx].reg = PMBUS_STATUS_MFR_SPECIFIC;
2454 scnprintf(name, PMBUS_NAME_SIZE, "status%d_mfr", i);
2455 debugfs_create_file(name, 0444, data->debugfs,
2457 &pmbus_debugfs_ops);
2460 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN12) {
2461 entries[idx].client = client;
2462 entries[idx].page = i;
2463 entries[idx].reg = PMBUS_STATUS_FAN_12;
2464 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan12", i);
2465 debugfs_create_file(name, 0444, data->debugfs,
2467 &pmbus_debugfs_ops);
2470 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN34) {
2471 entries[idx].client = client;
2472 entries[idx].page = i;
2473 entries[idx].reg = PMBUS_STATUS_FAN_34;
2474 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan34", i);
2475 debugfs_create_file(name, 0444, data->debugfs,
2477 &pmbus_debugfs_ops);
2484 static int pmbus_init_debugfs(struct i2c_client *client,
2485 struct pmbus_data *data)
2489 #endif /* IS_ENABLED(CONFIG_DEBUG_FS) */
2491 int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id,
2492 struct pmbus_driver_info *info)
2494 struct device *dev = &client->dev;
2495 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
2496 struct pmbus_data *data;
2497 size_t groups_num = 0;
2503 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
2504 | I2C_FUNC_SMBUS_BYTE_DATA
2505 | I2C_FUNC_SMBUS_WORD_DATA))
2508 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
2513 while (info->groups[groups_num])
2516 data->groups = devm_kcalloc(dev, groups_num + 2, sizeof(void *),
2521 i2c_set_clientdata(client, data);
2522 mutex_init(&data->update_lock);
2526 data->flags = pdata->flags;
2528 data->currpage = -1;
2529 data->currphase = -1;
2531 ret = pmbus_init_common(client, data, info);
2535 ret = pmbus_find_attributes(client, data);
2540 * If there are no attributes, something is wrong.
2541 * Bail out instead of trying to register nothing.
2543 if (!data->num_attributes) {
2544 dev_err(dev, "No attributes found\n");
2549 data->groups[0] = &data->group;
2550 memcpy(data->groups + 1, info->groups, sizeof(void *) * groups_num);
2551 data->hwmon_dev = hwmon_device_register_with_groups(dev, client->name,
2552 data, data->groups);
2553 if (IS_ERR(data->hwmon_dev)) {
2554 ret = PTR_ERR(data->hwmon_dev);
2555 dev_err(dev, "Failed to register hwmon device\n");
2559 ret = pmbus_regulator_register(data);
2561 goto out_unregister;
2563 ret = pmbus_init_debugfs(client, data);
2565 dev_warn(dev, "Failed to register debugfs\n");
2570 hwmon_device_unregister(data->hwmon_dev);
2572 kfree(data->group.attrs);
2575 EXPORT_SYMBOL_GPL(pmbus_do_probe);
2577 int pmbus_do_remove(struct i2c_client *client)
2579 struct pmbus_data *data = i2c_get_clientdata(client);
2581 debugfs_remove_recursive(data->debugfs);
2583 hwmon_device_unregister(data->hwmon_dev);
2584 kfree(data->group.attrs);
2587 EXPORT_SYMBOL_GPL(pmbus_do_remove);
2589 struct dentry *pmbus_get_debugfs_dir(struct i2c_client *client)
2591 struct pmbus_data *data = i2c_get_clientdata(client);
2593 return data->debugfs;
2595 EXPORT_SYMBOL_GPL(pmbus_get_debugfs_dir);
2597 static int __init pmbus_core_init(void)
2599 pmbus_debugfs_dir = debugfs_create_dir("pmbus", NULL);
2600 if (IS_ERR(pmbus_debugfs_dir))
2601 pmbus_debugfs_dir = NULL;
2606 static void __exit pmbus_core_exit(void)
2608 debugfs_remove_recursive(pmbus_debugfs_dir);
2611 module_init(pmbus_core_init);
2612 module_exit(pmbus_core_exit);
2614 MODULE_AUTHOR("Guenter Roeck");
2615 MODULE_DESCRIPTION("PMBus core driver");
2616 MODULE_LICENSE("GPL");