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/pmbus.h>
20 #include <linux/regulator/driver.h>
21 #include <linux/regulator/machine.h>
23 #include <linux/thermal.h>
27 * Number of additional attribute pointers to allocate
28 * with each call to krealloc
30 #define PMBUS_ATTR_ALLOC_SIZE 32
31 #define PMBUS_NAME_SIZE 24
34 struct pmbus_sensor *next;
35 char name[PMBUS_NAME_SIZE]; /* sysfs sensor name */
36 struct device_attribute attribute;
37 u8 page; /* page number */
38 u8 phase; /* phase number, 0xff for all phases */
39 u16 reg; /* register */
40 enum pmbus_sensor_classes class; /* sensor class */
41 bool update; /* runtime sensor update needed */
42 bool convert; /* Whether or not to apply linear/vid/direct */
43 int data; /* Sensor data.
44 Negative if there was a read error */
46 #define to_pmbus_sensor(_attr) \
47 container_of(_attr, struct pmbus_sensor, attribute)
49 struct pmbus_boolean {
50 char name[PMBUS_NAME_SIZE]; /* sysfs boolean name */
51 struct sensor_device_attribute attribute;
52 struct pmbus_sensor *s1;
53 struct pmbus_sensor *s2;
55 #define to_pmbus_boolean(_attr) \
56 container_of(_attr, struct pmbus_boolean, attribute)
59 char name[PMBUS_NAME_SIZE]; /* sysfs label name */
60 struct device_attribute attribute;
61 char label[PMBUS_NAME_SIZE]; /* label */
63 #define to_pmbus_label(_attr) \
64 container_of(_attr, struct pmbus_label, attribute)
66 /* Macros for converting between sensor index and register/page/status mask */
68 #define PB_STATUS_MASK 0xffff
69 #define PB_REG_SHIFT 16
70 #define PB_REG_MASK 0x3ff
71 #define PB_PAGE_SHIFT 26
72 #define PB_PAGE_MASK 0x3f
74 #define pb_reg_to_index(page, reg, mask) (((page) << PB_PAGE_SHIFT) | \
75 ((reg) << PB_REG_SHIFT) | (mask))
77 #define pb_index_to_page(index) (((index) >> PB_PAGE_SHIFT) & PB_PAGE_MASK)
78 #define pb_index_to_reg(index) (((index) >> PB_REG_SHIFT) & PB_REG_MASK)
79 #define pb_index_to_mask(index) ((index) & PB_STATUS_MASK)
83 struct device *hwmon_dev;
85 u32 flags; /* from platform data */
87 int exponent[PMBUS_PAGES];
88 /* linear mode: exponent for output voltages */
90 const struct pmbus_driver_info *info;
94 struct attribute_group group;
95 const struct attribute_group **groups;
96 struct dentry *debugfs; /* debugfs device directory */
98 struct pmbus_sensor *sensors;
100 struct mutex update_lock;
102 bool has_status_word; /* device uses STATUS_WORD register */
103 int (*read_status)(struct i2c_client *client, int page);
105 s16 currpage; /* current page, -1 for unknown/unset */
106 s16 currphase; /* current phase, 0xff for all, -1 for unknown/unset */
109 struct pmbus_debugfs_entry {
110 struct i2c_client *client;
115 static const int pmbus_fan_rpm_mask[] = {
122 static const int pmbus_fan_config_registers[] = {
129 static const int pmbus_fan_command_registers[] = {
136 void pmbus_clear_cache(struct i2c_client *client)
138 struct pmbus_data *data = i2c_get_clientdata(client);
139 struct pmbus_sensor *sensor;
141 for (sensor = data->sensors; sensor; sensor = sensor->next)
142 sensor->data = -ENODATA;
144 EXPORT_SYMBOL_NS_GPL(pmbus_clear_cache, PMBUS);
146 void pmbus_set_update(struct i2c_client *client, u8 reg, bool update)
148 struct pmbus_data *data = i2c_get_clientdata(client);
149 struct pmbus_sensor *sensor;
151 for (sensor = data->sensors; sensor; sensor = sensor->next)
152 if (sensor->reg == reg)
153 sensor->update = update;
155 EXPORT_SYMBOL_NS_GPL(pmbus_set_update, PMBUS);
157 int pmbus_set_page(struct i2c_client *client, int page, int phase)
159 struct pmbus_data *data = i2c_get_clientdata(client);
165 if (!(data->info->func[page] & PMBUS_PAGE_VIRTUAL) &&
166 data->info->pages > 1 && page != data->currpage) {
167 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
171 rv = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
178 data->currpage = page;
180 if (data->info->phases[page] && data->currphase != phase &&
181 !(data->info->func[page] & PMBUS_PHASE_VIRTUAL)) {
182 rv = i2c_smbus_write_byte_data(client, PMBUS_PHASE,
187 data->currphase = phase;
191 EXPORT_SYMBOL_NS_GPL(pmbus_set_page, PMBUS);
193 int pmbus_write_byte(struct i2c_client *client, int page, u8 value)
197 rv = pmbus_set_page(client, page, 0xff);
201 return i2c_smbus_write_byte(client, value);
203 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte, PMBUS);
206 * _pmbus_write_byte() is similar to pmbus_write_byte(), but checks if
207 * a device specific mapping function exists and calls it if necessary.
209 static int _pmbus_write_byte(struct i2c_client *client, int page, u8 value)
211 struct pmbus_data *data = i2c_get_clientdata(client);
212 const struct pmbus_driver_info *info = data->info;
215 if (info->write_byte) {
216 status = info->write_byte(client, page, value);
217 if (status != -ENODATA)
220 return pmbus_write_byte(client, page, value);
223 int pmbus_write_word_data(struct i2c_client *client, int page, u8 reg,
228 rv = pmbus_set_page(client, page, 0xff);
232 return i2c_smbus_write_word_data(client, reg, word);
234 EXPORT_SYMBOL_NS_GPL(pmbus_write_word_data, PMBUS);
237 static int pmbus_write_virt_reg(struct i2c_client *client, int page, int reg,
245 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
246 id = reg - PMBUS_VIRT_FAN_TARGET_1;
247 bit = pmbus_fan_rpm_mask[id];
248 rv = pmbus_update_fan(client, page, id, bit, bit, word);
259 * _pmbus_write_word_data() is similar to pmbus_write_word_data(), but checks if
260 * a device specific mapping function exists and calls it if necessary.
262 static int _pmbus_write_word_data(struct i2c_client *client, int page, int reg,
265 struct pmbus_data *data = i2c_get_clientdata(client);
266 const struct pmbus_driver_info *info = data->info;
269 if (info->write_word_data) {
270 status = info->write_word_data(client, page, reg, word);
271 if (status != -ENODATA)
275 if (reg >= PMBUS_VIRT_BASE)
276 return pmbus_write_virt_reg(client, page, reg, word);
278 return pmbus_write_word_data(client, page, reg, word);
282 * _pmbus_write_byte_data() is similar to pmbus_write_byte_data(), but checks if
283 * a device specific mapping function exists and calls it if necessary.
285 static int _pmbus_write_byte_data(struct i2c_client *client, int page, int reg, u8 value)
287 struct pmbus_data *data = i2c_get_clientdata(client);
288 const struct pmbus_driver_info *info = data->info;
291 if (info->write_byte_data) {
292 status = info->write_byte_data(client, page, reg, value);
293 if (status != -ENODATA)
296 return pmbus_write_byte_data(client, page, reg, value);
300 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
301 * a device specific mapping function exists and calls it if necessary.
303 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
305 struct pmbus_data *data = i2c_get_clientdata(client);
306 const struct pmbus_driver_info *info = data->info;
309 if (info->read_byte_data) {
310 status = info->read_byte_data(client, page, reg);
311 if (status != -ENODATA)
314 return pmbus_read_byte_data(client, page, reg);
317 int pmbus_update_fan(struct i2c_client *client, int page, int id,
318 u8 config, u8 mask, u16 command)
324 from = _pmbus_read_byte_data(client, page,
325 pmbus_fan_config_registers[id]);
329 to = (from & ~mask) | (config & mask);
331 rv = _pmbus_write_byte_data(client, page,
332 pmbus_fan_config_registers[id], to);
337 return _pmbus_write_word_data(client, page,
338 pmbus_fan_command_registers[id], command);
340 EXPORT_SYMBOL_NS_GPL(pmbus_update_fan, PMBUS);
342 int pmbus_read_word_data(struct i2c_client *client, int page, int phase, u8 reg)
346 rv = pmbus_set_page(client, page, phase);
350 return i2c_smbus_read_word_data(client, reg);
352 EXPORT_SYMBOL_NS_GPL(pmbus_read_word_data, PMBUS);
354 static int pmbus_read_virt_reg(struct i2c_client *client, int page, int reg)
360 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
361 id = reg - PMBUS_VIRT_FAN_TARGET_1;
362 rv = pmbus_get_fan_rate_device(client, page, id, rpm);
373 * _pmbus_read_word_data() is similar to pmbus_read_word_data(), but checks if
374 * a device specific mapping function exists and calls it if necessary.
376 static int _pmbus_read_word_data(struct i2c_client *client, int page,
379 struct pmbus_data *data = i2c_get_clientdata(client);
380 const struct pmbus_driver_info *info = data->info;
383 if (info->read_word_data) {
384 status = info->read_word_data(client, page, phase, reg);
385 if (status != -ENODATA)
389 if (reg >= PMBUS_VIRT_BASE)
390 return pmbus_read_virt_reg(client, page, reg);
392 return pmbus_read_word_data(client, page, phase, reg);
395 /* Same as above, but without phase parameter, for use in check functions */
396 static int __pmbus_read_word_data(struct i2c_client *client, int page, int reg)
398 return _pmbus_read_word_data(client, page, 0xff, reg);
401 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg)
405 rv = pmbus_set_page(client, page, 0xff);
409 return i2c_smbus_read_byte_data(client, reg);
411 EXPORT_SYMBOL_NS_GPL(pmbus_read_byte_data, PMBUS);
413 int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, u8 value)
417 rv = pmbus_set_page(client, page, 0xff);
421 return i2c_smbus_write_byte_data(client, reg, value);
423 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte_data, PMBUS);
425 int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg,
431 rv = _pmbus_read_byte_data(client, page, reg);
435 tmp = (rv & ~mask) | (value & mask);
438 rv = _pmbus_write_byte_data(client, page, reg, tmp);
442 EXPORT_SYMBOL_NS_GPL(pmbus_update_byte_data, PMBUS);
444 static struct pmbus_sensor *pmbus_find_sensor(struct pmbus_data *data, int page,
447 struct pmbus_sensor *sensor;
449 for (sensor = data->sensors; sensor; sensor = sensor->next) {
450 if (sensor->page == page && sensor->reg == reg)
454 return ERR_PTR(-EINVAL);
457 static int pmbus_get_fan_rate(struct i2c_client *client, int page, int id,
458 enum pmbus_fan_mode mode,
461 struct pmbus_data *data = i2c_get_clientdata(client);
462 bool want_rpm, have_rpm;
463 struct pmbus_sensor *s;
467 want_rpm = (mode == rpm);
470 reg = want_rpm ? PMBUS_VIRT_FAN_TARGET_1 : PMBUS_VIRT_PWM_1;
471 s = pmbus_find_sensor(data, page, reg + id);
478 config = _pmbus_read_byte_data(client, page,
479 pmbus_fan_config_registers[id]);
483 have_rpm = !!(config & pmbus_fan_rpm_mask[id]);
484 if (want_rpm == have_rpm)
485 return pmbus_read_word_data(client, page, 0xff,
486 pmbus_fan_command_registers[id]);
488 /* Can't sensibly map between RPM and PWM, just return zero */
492 int pmbus_get_fan_rate_device(struct i2c_client *client, int page, int id,
493 enum pmbus_fan_mode mode)
495 return pmbus_get_fan_rate(client, page, id, mode, false);
497 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_device, PMBUS);
499 int pmbus_get_fan_rate_cached(struct i2c_client *client, int page, int id,
500 enum pmbus_fan_mode mode)
502 return pmbus_get_fan_rate(client, page, id, mode, true);
504 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_cached, PMBUS);
506 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
508 _pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
511 void pmbus_clear_faults(struct i2c_client *client)
513 struct pmbus_data *data = i2c_get_clientdata(client);
516 for (i = 0; i < data->info->pages; i++)
517 pmbus_clear_fault_page(client, i);
519 EXPORT_SYMBOL_NS_GPL(pmbus_clear_faults, PMBUS);
521 static int pmbus_check_status_cml(struct i2c_client *client)
523 struct pmbus_data *data = i2c_get_clientdata(client);
526 status = data->read_status(client, -1);
527 if (status < 0 || (status & PB_STATUS_CML)) {
528 status2 = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
529 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
535 static bool pmbus_check_register(struct i2c_client *client,
536 int (*func)(struct i2c_client *client,
541 struct pmbus_data *data = i2c_get_clientdata(client);
543 rv = func(client, page, reg);
544 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
545 rv = pmbus_check_status_cml(client);
546 if (rv < 0 && (data->flags & PMBUS_READ_STATUS_AFTER_FAILED_CHECK))
547 data->read_status(client, -1);
548 pmbus_clear_fault_page(client, -1);
552 static bool pmbus_check_status_register(struct i2c_client *client, int page)
555 struct pmbus_data *data = i2c_get_clientdata(client);
557 status = data->read_status(client, page);
558 if (status >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK) &&
559 (status & PB_STATUS_CML)) {
560 status = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
561 if (status < 0 || (status & PB_CML_FAULT_INVALID_COMMAND))
565 pmbus_clear_fault_page(client, -1);
569 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
571 return pmbus_check_register(client, _pmbus_read_byte_data, page, reg);
573 EXPORT_SYMBOL_NS_GPL(pmbus_check_byte_register, PMBUS);
575 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
577 return pmbus_check_register(client, __pmbus_read_word_data, page, reg);
579 EXPORT_SYMBOL_NS_GPL(pmbus_check_word_register, PMBUS);
581 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
583 struct pmbus_data *data = i2c_get_clientdata(client);
587 EXPORT_SYMBOL_NS_GPL(pmbus_get_driver_info, PMBUS);
589 static int pmbus_get_status(struct i2c_client *client, int page, int reg)
591 struct pmbus_data *data = i2c_get_clientdata(client);
595 case PMBUS_STATUS_WORD:
596 status = data->read_status(client, page);
599 status = _pmbus_read_byte_data(client, page, reg);
603 pmbus_clear_faults(client);
607 static void pmbus_update_sensor_data(struct i2c_client *client, struct pmbus_sensor *sensor)
609 if (sensor->data < 0 || sensor->update)
610 sensor->data = _pmbus_read_word_data(client, sensor->page,
611 sensor->phase, sensor->reg);
615 * Convert linear sensor values to milli- or micro-units
616 * depending on sensor type.
618 static s64 pmbus_reg2data_linear(struct pmbus_data *data,
619 struct pmbus_sensor *sensor)
625 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
626 exponent = data->exponent[sensor->page];
627 mantissa = (u16) sensor->data;
628 } else { /* LINEAR11 */
629 exponent = ((s16)sensor->data) >> 11;
630 mantissa = ((s16)((sensor->data & 0x7ff) << 5)) >> 5;
635 /* scale result to milli-units for all sensors except fans */
636 if (sensor->class != PSC_FAN)
639 /* scale result to micro-units for power sensors */
640 if (sensor->class == PSC_POWER)
652 * Convert direct sensor values to milli- or micro-units
653 * depending on sensor type.
655 static s64 pmbus_reg2data_direct(struct pmbus_data *data,
656 struct pmbus_sensor *sensor)
658 s64 b, val = (s16)sensor->data;
661 m = data->info->m[sensor->class];
662 b = data->info->b[sensor->class];
663 R = data->info->R[sensor->class];
668 /* X = 1/m * (Y * 10^-R - b) */
670 /* scale result to milli-units for everything but fans */
671 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
676 /* scale result to micro-units for power sensors */
677 if (sensor->class == PSC_POWER) {
687 val = div_s64(val + 5LL, 10L); /* round closest */
691 val = div_s64(val - b, m);
696 * Convert VID sensor values to milli- or micro-units
697 * depending on sensor type.
699 static s64 pmbus_reg2data_vid(struct pmbus_data *data,
700 struct pmbus_sensor *sensor)
702 long val = sensor->data;
705 switch (data->info->vrm_version[sensor->page]) {
707 if (val >= 0x02 && val <= 0xb2)
708 rv = DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
712 rv = 250 + (val - 1) * 5;
716 rv = 500 + (val - 1) * 10;
720 rv = 200 + (val - 1) * 10;
723 if (val >= 0x0 && val <= 0xd8)
724 rv = DIV_ROUND_CLOSEST(155000 - val * 625, 100);
730 static s64 pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
734 if (!sensor->convert)
737 switch (data->info->format[sensor->class]) {
739 val = pmbus_reg2data_direct(data, sensor);
742 val = pmbus_reg2data_vid(data, sensor);
746 val = pmbus_reg2data_linear(data, sensor);
752 #define MAX_MANTISSA (1023 * 1000)
753 #define MIN_MANTISSA (511 * 1000)
755 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
756 struct pmbus_sensor *sensor, s64 val)
758 s16 exponent = 0, mantissa;
759 bool negative = false;
765 if (sensor->class == PSC_VOLTAGE_OUT) {
766 /* LINEAR16 does not support negative voltages */
771 * For a static exponents, we don't have a choice
772 * but to adjust the value to it.
774 if (data->exponent[sensor->page] < 0)
775 val <<= -data->exponent[sensor->page];
777 val >>= data->exponent[sensor->page];
778 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
779 return clamp_val(val, 0, 0xffff);
787 /* Power is in uW. Convert to mW before converting. */
788 if (sensor->class == PSC_POWER)
789 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
792 * For simplicity, convert fan data to milli-units
793 * before calculating the exponent.
795 if (sensor->class == PSC_FAN)
798 /* Reduce large mantissa until it fits into 10 bit */
799 while (val >= MAX_MANTISSA && exponent < 15) {
803 /* Increase small mantissa to improve precision */
804 while (val < MIN_MANTISSA && exponent > -15) {
809 /* Convert mantissa from milli-units to units */
810 mantissa = clamp_val(DIV_ROUND_CLOSEST_ULL(val, 1000), 0, 0x3ff);
814 mantissa = -mantissa;
816 /* Convert to 5 bit exponent, 11 bit mantissa */
817 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
820 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
821 struct pmbus_sensor *sensor, s64 val)
826 m = data->info->m[sensor->class];
827 b = data->info->b[sensor->class];
828 R = data->info->R[sensor->class];
830 /* Power is in uW. Adjust R and b. */
831 if (sensor->class == PSC_POWER) {
836 /* Calculate Y = (m * X + b) * 10^R */
837 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
838 R -= 3; /* Adjust R and b for data in milli-units */
848 val = div_s64(val + 5LL, 10L); /* round closest */
852 return (u16)clamp_val(val, S16_MIN, S16_MAX);
855 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
856 struct pmbus_sensor *sensor, s64 val)
858 val = clamp_val(val, 500, 1600);
860 return 2 + DIV_ROUND_CLOSEST_ULL((1600LL - val) * 100LL, 625);
863 static u16 pmbus_data2reg(struct pmbus_data *data,
864 struct pmbus_sensor *sensor, s64 val)
868 if (!sensor->convert)
871 switch (data->info->format[sensor->class]) {
873 regval = pmbus_data2reg_direct(data, sensor, val);
876 regval = pmbus_data2reg_vid(data, sensor, val);
880 regval = pmbus_data2reg_linear(data, sensor, val);
887 * Return boolean calculated from converted data.
888 * <index> defines a status register index and mask.
889 * The mask is in the lower 8 bits, the register index is in bits 8..23.
891 * The associated pmbus_boolean structure contains optional pointers to two
892 * sensor attributes. If specified, those attributes are compared against each
893 * other to determine if a limit has been exceeded.
895 * If the sensor attribute pointers are NULL, the function returns true if
896 * (status[reg] & mask) is true.
898 * If sensor attribute pointers are provided, a comparison against a specified
899 * limit has to be performed to determine the boolean result.
900 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
901 * sensor values referenced by sensor attribute pointers s1 and s2).
903 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
904 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
906 * If a negative value is stored in any of the referenced registers, this value
907 * reflects an error code which will be returned.
909 static int pmbus_get_boolean(struct i2c_client *client, struct pmbus_boolean *b,
912 struct pmbus_data *data = i2c_get_clientdata(client);
913 struct pmbus_sensor *s1 = b->s1;
914 struct pmbus_sensor *s2 = b->s2;
915 u16 mask = pb_index_to_mask(index);
916 u8 page = pb_index_to_page(index);
917 u16 reg = pb_index_to_reg(index);
921 mutex_lock(&data->update_lock);
922 status = pmbus_get_status(client, page, reg);
929 pmbus_update_sensor_data(client, s1);
931 pmbus_update_sensor_data(client, s2);
933 regval = status & mask;
935 ret = _pmbus_write_byte_data(client, page, reg, regval);
951 v1 = pmbus_reg2data(data, s1);
952 v2 = pmbus_reg2data(data, s2);
953 ret = !!(regval && v1 >= v2);
958 mutex_unlock(&data->update_lock);
962 static ssize_t pmbus_show_boolean(struct device *dev,
963 struct device_attribute *da, char *buf)
965 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
966 struct pmbus_boolean *boolean = to_pmbus_boolean(attr);
967 struct i2c_client *client = to_i2c_client(dev->parent);
970 val = pmbus_get_boolean(client, boolean, attr->index);
973 return sysfs_emit(buf, "%d\n", val);
976 static ssize_t pmbus_show_sensor(struct device *dev,
977 struct device_attribute *devattr, char *buf)
979 struct i2c_client *client = to_i2c_client(dev->parent);
980 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
981 struct pmbus_data *data = i2c_get_clientdata(client);
984 mutex_lock(&data->update_lock);
985 pmbus_update_sensor_data(client, sensor);
986 if (sensor->data < 0)
989 ret = sysfs_emit(buf, "%lld\n", pmbus_reg2data(data, sensor));
990 mutex_unlock(&data->update_lock);
994 static ssize_t pmbus_set_sensor(struct device *dev,
995 struct device_attribute *devattr,
996 const char *buf, size_t count)
998 struct i2c_client *client = to_i2c_client(dev->parent);
999 struct pmbus_data *data = i2c_get_clientdata(client);
1000 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
1006 if (kstrtos64(buf, 10, &val) < 0)
1009 mutex_lock(&data->update_lock);
1010 regval = pmbus_data2reg(data, sensor, val);
1011 ret = _pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
1015 sensor->data = -ENODATA;
1016 mutex_unlock(&data->update_lock);
1020 static ssize_t pmbus_show_label(struct device *dev,
1021 struct device_attribute *da, char *buf)
1023 struct pmbus_label *label = to_pmbus_label(da);
1025 return sysfs_emit(buf, "%s\n", label->label);
1028 static int pmbus_add_attribute(struct pmbus_data *data, struct attribute *attr)
1030 if (data->num_attributes >= data->max_attributes - 1) {
1031 int new_max_attrs = data->max_attributes + PMBUS_ATTR_ALLOC_SIZE;
1032 void *new_attrs = devm_krealloc(data->dev, data->group.attrs,
1033 new_max_attrs * sizeof(void *),
1037 data->group.attrs = new_attrs;
1038 data->max_attributes = new_max_attrs;
1041 data->group.attrs[data->num_attributes++] = attr;
1042 data->group.attrs[data->num_attributes] = NULL;
1046 static void pmbus_dev_attr_init(struct device_attribute *dev_attr,
1049 ssize_t (*show)(struct device *dev,
1050 struct device_attribute *attr,
1052 ssize_t (*store)(struct device *dev,
1053 struct device_attribute *attr,
1054 const char *buf, size_t count))
1056 sysfs_attr_init(&dev_attr->attr);
1057 dev_attr->attr.name = name;
1058 dev_attr->attr.mode = mode;
1059 dev_attr->show = show;
1060 dev_attr->store = store;
1063 static void pmbus_attr_init(struct sensor_device_attribute *a,
1066 ssize_t (*show)(struct device *dev,
1067 struct device_attribute *attr,
1069 ssize_t (*store)(struct device *dev,
1070 struct device_attribute *attr,
1071 const char *buf, size_t count),
1074 pmbus_dev_attr_init(&a->dev_attr, name, mode, show, store);
1078 static int pmbus_add_boolean(struct pmbus_data *data,
1079 const char *name, const char *type, int seq,
1080 struct pmbus_sensor *s1,
1081 struct pmbus_sensor *s2,
1082 u8 page, u16 reg, u16 mask)
1084 struct pmbus_boolean *boolean;
1085 struct sensor_device_attribute *a;
1087 if (WARN((s1 && !s2) || (!s1 && s2), "Bad s1/s2 parameters\n"))
1090 boolean = devm_kzalloc(data->dev, sizeof(*boolean), GFP_KERNEL);
1094 a = &boolean->attribute;
1096 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
1100 pmbus_attr_init(a, boolean->name, 0444, pmbus_show_boolean, NULL,
1101 pb_reg_to_index(page, reg, mask));
1103 return pmbus_add_attribute(data, &a->dev_attr.attr);
1106 /* of thermal for pmbus temperature sensors */
1107 struct pmbus_thermal_data {
1108 struct pmbus_data *pmbus_data;
1109 struct pmbus_sensor *sensor;
1112 static int pmbus_thermal_get_temp(void *data, int *temp)
1114 struct pmbus_thermal_data *tdata = data;
1115 struct pmbus_sensor *sensor = tdata->sensor;
1116 struct pmbus_data *pmbus_data = tdata->pmbus_data;
1117 struct i2c_client *client = to_i2c_client(pmbus_data->dev);
1118 struct device *dev = pmbus_data->hwmon_dev;
1122 /* May not even get to hwmon yet */
1127 mutex_lock(&pmbus_data->update_lock);
1128 pmbus_update_sensor_data(client, sensor);
1129 if (sensor->data < 0)
1132 *temp = (int)pmbus_reg2data(pmbus_data, sensor);
1133 mutex_unlock(&pmbus_data->update_lock);
1138 static const struct thermal_zone_of_device_ops pmbus_thermal_ops = {
1139 .get_temp = pmbus_thermal_get_temp,
1142 static int pmbus_thermal_add_sensor(struct pmbus_data *pmbus_data,
1143 struct pmbus_sensor *sensor, int index)
1145 struct device *dev = pmbus_data->dev;
1146 struct pmbus_thermal_data *tdata;
1147 struct thermal_zone_device *tzd;
1149 tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
1153 tdata->sensor = sensor;
1154 tdata->pmbus_data = pmbus_data;
1156 tzd = devm_thermal_zone_of_sensor_register(dev, index, tdata,
1157 &pmbus_thermal_ops);
1159 * If CONFIG_THERMAL_OF is disabled, this returns -ENODEV,
1160 * so ignore that error but forward any other error.
1162 if (IS_ERR(tzd) && (PTR_ERR(tzd) != -ENODEV))
1163 return PTR_ERR(tzd);
1168 static struct pmbus_sensor *pmbus_add_sensor(struct pmbus_data *data,
1169 const char *name, const char *type,
1170 int seq, int page, int phase,
1172 enum pmbus_sensor_classes class,
1173 bool update, bool readonly,
1176 struct pmbus_sensor *sensor;
1177 struct device_attribute *a;
1179 sensor = devm_kzalloc(data->dev, sizeof(*sensor), GFP_KERNEL);
1182 a = &sensor->attribute;
1185 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
1188 snprintf(sensor->name, sizeof(sensor->name), "%s%d",
1191 if (data->flags & PMBUS_WRITE_PROTECTED)
1194 sensor->page = page;
1195 sensor->phase = phase;
1197 sensor->class = class;
1198 sensor->update = update;
1199 sensor->convert = convert;
1200 sensor->data = -ENODATA;
1201 pmbus_dev_attr_init(a, sensor->name,
1202 readonly ? 0444 : 0644,
1203 pmbus_show_sensor, pmbus_set_sensor);
1205 if (pmbus_add_attribute(data, &a->attr))
1208 sensor->next = data->sensors;
1209 data->sensors = sensor;
1211 /* temperature sensors with _input values are registered with thermal */
1212 if (class == PSC_TEMPERATURE && strcmp(type, "input") == 0)
1213 pmbus_thermal_add_sensor(data, sensor, seq);
1218 static int pmbus_add_label(struct pmbus_data *data,
1219 const char *name, int seq,
1220 const char *lstring, int index, int phase)
1222 struct pmbus_label *label;
1223 struct device_attribute *a;
1225 label = devm_kzalloc(data->dev, sizeof(*label), GFP_KERNEL);
1229 a = &label->attribute;
1231 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
1234 strncpy(label->label, lstring,
1235 sizeof(label->label) - 1);
1237 snprintf(label->label, sizeof(label->label), "%s.%d",
1241 snprintf(label->label, sizeof(label->label), "%s%d",
1244 snprintf(label->label, sizeof(label->label), "%s%d.%d",
1245 lstring, index, phase);
1248 pmbus_dev_attr_init(a, label->name, 0444, pmbus_show_label, NULL);
1249 return pmbus_add_attribute(data, &a->attr);
1253 * Search for attributes. Allocate sensors, booleans, and labels as needed.
1257 * The pmbus_limit_attr structure describes a single limit attribute
1258 * and its associated alarm attribute.
1260 struct pmbus_limit_attr {
1261 u16 reg; /* Limit register */
1262 u16 sbit; /* Alarm attribute status bit */
1263 bool update; /* True if register needs updates */
1264 bool low; /* True if low limit; for limits with compare
1266 const char *attr; /* Attribute name */
1267 const char *alarm; /* Alarm attribute name */
1271 * The pmbus_sensor_attr structure describes one sensor attribute. This
1272 * description includes a reference to the associated limit attributes.
1274 struct pmbus_sensor_attr {
1275 u16 reg; /* sensor register */
1276 u16 gbit; /* generic status bit */
1277 u8 nlimit; /* # of limit registers */
1278 enum pmbus_sensor_classes class;/* sensor class */
1279 const char *label; /* sensor label */
1280 bool paged; /* true if paged sensor */
1281 bool update; /* true if update needed */
1282 bool compare; /* true if compare function needed */
1283 u32 func; /* sensor mask */
1284 u32 sfunc; /* sensor status mask */
1285 int sreg; /* status register */
1286 const struct pmbus_limit_attr *limit;/* limit registers */
1290 * Add a set of limit attributes and, if supported, the associated
1292 * returns 0 if no alarm register found, 1 if an alarm register was found,
1295 static int pmbus_add_limit_attrs(struct i2c_client *client,
1296 struct pmbus_data *data,
1297 const struct pmbus_driver_info *info,
1298 const char *name, int index, int page,
1299 struct pmbus_sensor *base,
1300 const struct pmbus_sensor_attr *attr)
1302 const struct pmbus_limit_attr *l = attr->limit;
1303 int nlimit = attr->nlimit;
1306 struct pmbus_sensor *curr;
1308 for (i = 0; i < nlimit; i++) {
1309 if (pmbus_check_word_register(client, page, l->reg)) {
1310 curr = pmbus_add_sensor(data, name, l->attr, index,
1311 page, 0xff, l->reg, attr->class,
1312 attr->update || l->update,
1316 if (l->sbit && (info->func[page] & attr->sfunc)) {
1317 ret = pmbus_add_boolean(data, name,
1319 attr->compare ? l->low ? curr : base
1321 attr->compare ? l->low ? base : curr
1323 page, attr->sreg, l->sbit);
1334 static int pmbus_add_sensor_attrs_one(struct i2c_client *client,
1335 struct pmbus_data *data,
1336 const struct pmbus_driver_info *info,
1338 int index, int page, int phase,
1339 const struct pmbus_sensor_attr *attr,
1342 struct pmbus_sensor *base;
1343 bool upper = !!(attr->gbit & 0xff00); /* need to check STATUS_WORD */
1347 ret = pmbus_add_label(data, name, index, attr->label,
1348 paged ? page + 1 : 0, phase);
1352 base = pmbus_add_sensor(data, name, "input", index, page, phase,
1353 attr->reg, attr->class, true, true, true);
1356 /* No limit and alarm attributes for phase specific sensors */
1357 if (attr->sfunc && phase == 0xff) {
1358 ret = pmbus_add_limit_attrs(client, data, info, name,
1359 index, page, base, attr);
1363 * Add generic alarm attribute only if there are no individual
1364 * alarm attributes, if there is a global alarm bit, and if
1365 * the generic status register (word or byte, depending on
1366 * which global bit is set) for this page is accessible.
1368 if (!ret && attr->gbit &&
1369 (!upper || data->has_status_word) &&
1370 pmbus_check_status_register(client, page)) {
1371 ret = pmbus_add_boolean(data, name, "alarm", index,
1373 page, PMBUS_STATUS_WORD,
1382 static bool pmbus_sensor_is_paged(const struct pmbus_driver_info *info,
1383 const struct pmbus_sensor_attr *attr)
1391 * Some attributes may be present on more than one page despite
1392 * not being marked with the paged attribute. If that is the case,
1393 * then treat the sensor as being paged and add the page suffix to the
1395 * We don't just add the paged attribute to all such attributes, in
1396 * order to maintain the un-suffixed labels in the case where the
1397 * attribute is only on page 0.
1399 for (p = 1; p < info->pages; p++) {
1400 if (info->func[p] & attr->func)
1406 static int pmbus_add_sensor_attrs(struct i2c_client *client,
1407 struct pmbus_data *data,
1409 const struct pmbus_sensor_attr *attrs,
1412 const struct pmbus_driver_info *info = data->info;
1417 for (i = 0; i < nattrs; i++) {
1419 bool paged = pmbus_sensor_is_paged(info, attrs);
1421 pages = paged ? info->pages : 1;
1422 for (page = 0; page < pages; page++) {
1423 if (info->func[page] & attrs->func) {
1424 ret = pmbus_add_sensor_attrs_one(client, data, info,
1426 0xff, attrs, paged);
1431 if (info->phases[page]) {
1434 for (phase = 0; phase < info->phases[page];
1436 if (!(info->pfunc[phase] & attrs->func))
1438 ret = pmbus_add_sensor_attrs_one(client,
1439 data, info, name, index, page,
1440 phase, attrs, paged);
1452 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1454 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1456 .alarm = "min_alarm",
1457 .sbit = PB_VOLTAGE_UV_WARNING,
1459 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1461 .alarm = "lcrit_alarm",
1462 .sbit = PB_VOLTAGE_UV_FAULT | PB_VOLTAGE_VIN_OFF,
1464 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1466 .alarm = "max_alarm",
1467 .sbit = PB_VOLTAGE_OV_WARNING,
1469 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1471 .alarm = "crit_alarm",
1472 .sbit = PB_VOLTAGE_OV_FAULT,
1474 .reg = PMBUS_VIRT_READ_VIN_AVG,
1478 .reg = PMBUS_VIRT_READ_VIN_MIN,
1482 .reg = PMBUS_VIRT_READ_VIN_MAX,
1486 .reg = PMBUS_VIRT_RESET_VIN_HISTORY,
1487 .attr = "reset_history",
1489 .reg = PMBUS_MFR_VIN_MIN,
1490 .attr = "rated_min",
1492 .reg = PMBUS_MFR_VIN_MAX,
1493 .attr = "rated_max",
1497 static const struct pmbus_limit_attr vmon_limit_attrs[] = {
1499 .reg = PMBUS_VIRT_VMON_UV_WARN_LIMIT,
1501 .alarm = "min_alarm",
1502 .sbit = PB_VOLTAGE_UV_WARNING,
1504 .reg = PMBUS_VIRT_VMON_UV_FAULT_LIMIT,
1506 .alarm = "lcrit_alarm",
1507 .sbit = PB_VOLTAGE_UV_FAULT,
1509 .reg = PMBUS_VIRT_VMON_OV_WARN_LIMIT,
1511 .alarm = "max_alarm",
1512 .sbit = PB_VOLTAGE_OV_WARNING,
1514 .reg = PMBUS_VIRT_VMON_OV_FAULT_LIMIT,
1516 .alarm = "crit_alarm",
1517 .sbit = PB_VOLTAGE_OV_FAULT,
1521 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1523 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1525 .alarm = "min_alarm",
1526 .sbit = PB_VOLTAGE_UV_WARNING,
1528 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1530 .alarm = "lcrit_alarm",
1531 .sbit = PB_VOLTAGE_UV_FAULT,
1533 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1535 .alarm = "max_alarm",
1536 .sbit = PB_VOLTAGE_OV_WARNING,
1538 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1540 .alarm = "crit_alarm",
1541 .sbit = PB_VOLTAGE_OV_FAULT,
1543 .reg = PMBUS_VIRT_READ_VOUT_AVG,
1547 .reg = PMBUS_VIRT_READ_VOUT_MIN,
1551 .reg = PMBUS_VIRT_READ_VOUT_MAX,
1555 .reg = PMBUS_VIRT_RESET_VOUT_HISTORY,
1556 .attr = "reset_history",
1558 .reg = PMBUS_MFR_VOUT_MIN,
1559 .attr = "rated_min",
1561 .reg = PMBUS_MFR_VOUT_MAX,
1562 .attr = "rated_max",
1566 static const struct pmbus_sensor_attr voltage_attributes[] = {
1568 .reg = PMBUS_READ_VIN,
1569 .class = PSC_VOLTAGE_IN,
1571 .func = PMBUS_HAVE_VIN,
1572 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1573 .sreg = PMBUS_STATUS_INPUT,
1574 .gbit = PB_STATUS_VIN_UV,
1575 .limit = vin_limit_attrs,
1576 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1578 .reg = PMBUS_VIRT_READ_VMON,
1579 .class = PSC_VOLTAGE_IN,
1581 .func = PMBUS_HAVE_VMON,
1582 .sfunc = PMBUS_HAVE_STATUS_VMON,
1583 .sreg = PMBUS_VIRT_STATUS_VMON,
1584 .limit = vmon_limit_attrs,
1585 .nlimit = ARRAY_SIZE(vmon_limit_attrs),
1587 .reg = PMBUS_READ_VCAP,
1588 .class = PSC_VOLTAGE_IN,
1590 .func = PMBUS_HAVE_VCAP,
1592 .reg = PMBUS_READ_VOUT,
1593 .class = PSC_VOLTAGE_OUT,
1596 .func = PMBUS_HAVE_VOUT,
1597 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1598 .sreg = PMBUS_STATUS_VOUT,
1599 .gbit = PB_STATUS_VOUT_OV,
1600 .limit = vout_limit_attrs,
1601 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1605 /* Current attributes */
1607 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1609 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1611 .alarm = "max_alarm",
1612 .sbit = PB_IIN_OC_WARNING,
1614 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1616 .alarm = "crit_alarm",
1617 .sbit = PB_IIN_OC_FAULT,
1619 .reg = PMBUS_VIRT_READ_IIN_AVG,
1623 .reg = PMBUS_VIRT_READ_IIN_MIN,
1627 .reg = PMBUS_VIRT_READ_IIN_MAX,
1631 .reg = PMBUS_VIRT_RESET_IIN_HISTORY,
1632 .attr = "reset_history",
1634 .reg = PMBUS_MFR_IIN_MAX,
1635 .attr = "rated_max",
1639 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1641 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1643 .alarm = "max_alarm",
1644 .sbit = PB_IOUT_OC_WARNING,
1646 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1648 .alarm = "lcrit_alarm",
1649 .sbit = PB_IOUT_UC_FAULT,
1651 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1653 .alarm = "crit_alarm",
1654 .sbit = PB_IOUT_OC_FAULT,
1656 .reg = PMBUS_VIRT_READ_IOUT_AVG,
1660 .reg = PMBUS_VIRT_READ_IOUT_MIN,
1664 .reg = PMBUS_VIRT_READ_IOUT_MAX,
1668 .reg = PMBUS_VIRT_RESET_IOUT_HISTORY,
1669 .attr = "reset_history",
1671 .reg = PMBUS_MFR_IOUT_MAX,
1672 .attr = "rated_max",
1676 static const struct pmbus_sensor_attr current_attributes[] = {
1678 .reg = PMBUS_READ_IIN,
1679 .class = PSC_CURRENT_IN,
1681 .func = PMBUS_HAVE_IIN,
1682 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1683 .sreg = PMBUS_STATUS_INPUT,
1684 .gbit = PB_STATUS_INPUT,
1685 .limit = iin_limit_attrs,
1686 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1688 .reg = PMBUS_READ_IOUT,
1689 .class = PSC_CURRENT_OUT,
1692 .func = PMBUS_HAVE_IOUT,
1693 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1694 .sreg = PMBUS_STATUS_IOUT,
1695 .gbit = PB_STATUS_IOUT_OC,
1696 .limit = iout_limit_attrs,
1697 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1701 /* Power attributes */
1703 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1705 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1708 .sbit = PB_PIN_OP_WARNING,
1710 .reg = PMBUS_VIRT_READ_PIN_AVG,
1714 .reg = PMBUS_VIRT_READ_PIN_MIN,
1716 .attr = "input_lowest",
1718 .reg = PMBUS_VIRT_READ_PIN_MAX,
1720 .attr = "input_highest",
1722 .reg = PMBUS_VIRT_RESET_PIN_HISTORY,
1723 .attr = "reset_history",
1725 .reg = PMBUS_MFR_PIN_MAX,
1726 .attr = "rated_max",
1730 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1732 .reg = PMBUS_POUT_MAX,
1734 .alarm = "cap_alarm",
1735 .sbit = PB_POWER_LIMITING,
1737 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1739 .alarm = "max_alarm",
1740 .sbit = PB_POUT_OP_WARNING,
1742 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1744 .alarm = "crit_alarm",
1745 .sbit = PB_POUT_OP_FAULT,
1747 .reg = PMBUS_VIRT_READ_POUT_AVG,
1751 .reg = PMBUS_VIRT_READ_POUT_MIN,
1753 .attr = "input_lowest",
1755 .reg = PMBUS_VIRT_READ_POUT_MAX,
1757 .attr = "input_highest",
1759 .reg = PMBUS_VIRT_RESET_POUT_HISTORY,
1760 .attr = "reset_history",
1762 .reg = PMBUS_MFR_POUT_MAX,
1763 .attr = "rated_max",
1767 static const struct pmbus_sensor_attr power_attributes[] = {
1769 .reg = PMBUS_READ_PIN,
1772 .func = PMBUS_HAVE_PIN,
1773 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1774 .sreg = PMBUS_STATUS_INPUT,
1775 .gbit = PB_STATUS_INPUT,
1776 .limit = pin_limit_attrs,
1777 .nlimit = ARRAY_SIZE(pin_limit_attrs),
1779 .reg = PMBUS_READ_POUT,
1783 .func = PMBUS_HAVE_POUT,
1784 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1785 .sreg = PMBUS_STATUS_IOUT,
1786 .limit = pout_limit_attrs,
1787 .nlimit = ARRAY_SIZE(pout_limit_attrs),
1791 /* Temperature atributes */
1793 static const struct pmbus_limit_attr temp_limit_attrs[] = {
1795 .reg = PMBUS_UT_WARN_LIMIT,
1798 .alarm = "min_alarm",
1799 .sbit = PB_TEMP_UT_WARNING,
1801 .reg = PMBUS_UT_FAULT_LIMIT,
1804 .alarm = "lcrit_alarm",
1805 .sbit = PB_TEMP_UT_FAULT,
1807 .reg = PMBUS_OT_WARN_LIMIT,
1809 .alarm = "max_alarm",
1810 .sbit = PB_TEMP_OT_WARNING,
1812 .reg = PMBUS_OT_FAULT_LIMIT,
1814 .alarm = "crit_alarm",
1815 .sbit = PB_TEMP_OT_FAULT,
1817 .reg = PMBUS_VIRT_READ_TEMP_MIN,
1820 .reg = PMBUS_VIRT_READ_TEMP_AVG,
1823 .reg = PMBUS_VIRT_READ_TEMP_MAX,
1826 .reg = PMBUS_VIRT_RESET_TEMP_HISTORY,
1827 .attr = "reset_history",
1829 .reg = PMBUS_MFR_MAX_TEMP_1,
1830 .attr = "rated_max",
1834 static const struct pmbus_limit_attr temp_limit_attrs2[] = {
1836 .reg = PMBUS_UT_WARN_LIMIT,
1839 .alarm = "min_alarm",
1840 .sbit = PB_TEMP_UT_WARNING,
1842 .reg = PMBUS_UT_FAULT_LIMIT,
1845 .alarm = "lcrit_alarm",
1846 .sbit = PB_TEMP_UT_FAULT,
1848 .reg = PMBUS_OT_WARN_LIMIT,
1850 .alarm = "max_alarm",
1851 .sbit = PB_TEMP_OT_WARNING,
1853 .reg = PMBUS_OT_FAULT_LIMIT,
1855 .alarm = "crit_alarm",
1856 .sbit = PB_TEMP_OT_FAULT,
1858 .reg = PMBUS_VIRT_READ_TEMP2_MIN,
1861 .reg = PMBUS_VIRT_READ_TEMP2_AVG,
1864 .reg = PMBUS_VIRT_READ_TEMP2_MAX,
1867 .reg = PMBUS_VIRT_RESET_TEMP2_HISTORY,
1868 .attr = "reset_history",
1870 .reg = PMBUS_MFR_MAX_TEMP_2,
1871 .attr = "rated_max",
1875 static const struct pmbus_limit_attr temp_limit_attrs3[] = {
1877 .reg = PMBUS_UT_WARN_LIMIT,
1880 .alarm = "min_alarm",
1881 .sbit = PB_TEMP_UT_WARNING,
1883 .reg = PMBUS_UT_FAULT_LIMIT,
1886 .alarm = "lcrit_alarm",
1887 .sbit = PB_TEMP_UT_FAULT,
1889 .reg = PMBUS_OT_WARN_LIMIT,
1891 .alarm = "max_alarm",
1892 .sbit = PB_TEMP_OT_WARNING,
1894 .reg = PMBUS_OT_FAULT_LIMIT,
1896 .alarm = "crit_alarm",
1897 .sbit = PB_TEMP_OT_FAULT,
1899 .reg = PMBUS_MFR_MAX_TEMP_3,
1900 .attr = "rated_max",
1904 static const struct pmbus_sensor_attr temp_attributes[] = {
1906 .reg = PMBUS_READ_TEMPERATURE_1,
1907 .class = PSC_TEMPERATURE,
1911 .func = PMBUS_HAVE_TEMP,
1912 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1913 .sreg = PMBUS_STATUS_TEMPERATURE,
1914 .gbit = PB_STATUS_TEMPERATURE,
1915 .limit = temp_limit_attrs,
1916 .nlimit = ARRAY_SIZE(temp_limit_attrs),
1918 .reg = PMBUS_READ_TEMPERATURE_2,
1919 .class = PSC_TEMPERATURE,
1923 .func = PMBUS_HAVE_TEMP2,
1924 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1925 .sreg = PMBUS_STATUS_TEMPERATURE,
1926 .gbit = PB_STATUS_TEMPERATURE,
1927 .limit = temp_limit_attrs2,
1928 .nlimit = ARRAY_SIZE(temp_limit_attrs2),
1930 .reg = PMBUS_READ_TEMPERATURE_3,
1931 .class = PSC_TEMPERATURE,
1935 .func = PMBUS_HAVE_TEMP3,
1936 .sfunc = PMBUS_HAVE_STATUS_TEMP,
1937 .sreg = PMBUS_STATUS_TEMPERATURE,
1938 .gbit = PB_STATUS_TEMPERATURE,
1939 .limit = temp_limit_attrs3,
1940 .nlimit = ARRAY_SIZE(temp_limit_attrs3),
1944 static const int pmbus_fan_registers[] = {
1945 PMBUS_READ_FAN_SPEED_1,
1946 PMBUS_READ_FAN_SPEED_2,
1947 PMBUS_READ_FAN_SPEED_3,
1948 PMBUS_READ_FAN_SPEED_4
1951 static const int pmbus_fan_status_registers[] = {
1952 PMBUS_STATUS_FAN_12,
1953 PMBUS_STATUS_FAN_12,
1954 PMBUS_STATUS_FAN_34,
1958 static const u32 pmbus_fan_flags[] = {
1965 static const u32 pmbus_fan_status_flags[] = {
1966 PMBUS_HAVE_STATUS_FAN12,
1967 PMBUS_HAVE_STATUS_FAN12,
1968 PMBUS_HAVE_STATUS_FAN34,
1969 PMBUS_HAVE_STATUS_FAN34
1974 /* Precondition: FAN_CONFIG_x_y and FAN_COMMAND_x must exist for the fan ID */
1975 static int pmbus_add_fan_ctrl(struct i2c_client *client,
1976 struct pmbus_data *data, int index, int page, int id,
1979 struct pmbus_sensor *sensor;
1981 sensor = pmbus_add_sensor(data, "fan", "target", index, page,
1982 0xff, PMBUS_VIRT_FAN_TARGET_1 + id, PSC_FAN,
1983 false, false, true);
1988 if (!((data->info->func[page] & PMBUS_HAVE_PWM12) ||
1989 (data->info->func[page] & PMBUS_HAVE_PWM34)))
1992 sensor = pmbus_add_sensor(data, "pwm", NULL, index, page,
1993 0xff, PMBUS_VIRT_PWM_1 + id, PSC_PWM,
1994 false, false, true);
1999 sensor = pmbus_add_sensor(data, "pwm", "enable", index, page,
2000 0xff, PMBUS_VIRT_PWM_ENABLE_1 + id, PSC_PWM,
2001 true, false, false);
2009 static int pmbus_add_fan_attributes(struct i2c_client *client,
2010 struct pmbus_data *data)
2012 const struct pmbus_driver_info *info = data->info;
2017 for (page = 0; page < info->pages; page++) {
2020 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
2023 if (!(info->func[page] & pmbus_fan_flags[f]))
2026 if (!pmbus_check_word_register(client, page,
2027 pmbus_fan_registers[f]))
2031 * Skip fan if not installed.
2032 * Each fan configuration register covers multiple fans,
2033 * so we have to do some magic.
2035 regval = _pmbus_read_byte_data(client, page,
2036 pmbus_fan_config_registers[f]);
2038 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
2041 if (pmbus_add_sensor(data, "fan", "input", index,
2042 page, 0xff, pmbus_fan_registers[f],
2043 PSC_FAN, true, true, true) == NULL)
2047 if (pmbus_check_word_register(client, page,
2048 pmbus_fan_command_registers[f])) {
2049 ret = pmbus_add_fan_ctrl(client, data, index,
2056 * Each fan status register covers multiple fans,
2057 * so we have to do some magic.
2059 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
2060 pmbus_check_byte_register(client,
2061 page, pmbus_fan_status_registers[f])) {
2064 if (f > 1) /* fan 3, 4 */
2065 reg = PMBUS_STATUS_FAN_34;
2067 reg = PMBUS_STATUS_FAN_12;
2068 ret = pmbus_add_boolean(data, "fan",
2069 "alarm", index, NULL, NULL, page, reg,
2070 PB_FAN_FAN1_WARNING >> (f & 1));
2073 ret = pmbus_add_boolean(data, "fan",
2074 "fault", index, NULL, NULL, page, reg,
2075 PB_FAN_FAN1_FAULT >> (f & 1));
2085 struct pmbus_samples_attr {
2090 struct pmbus_samples_reg {
2092 struct pmbus_samples_attr *attr;
2093 struct device_attribute dev_attr;
2096 static struct pmbus_samples_attr pmbus_samples_registers[] = {
2098 .reg = PMBUS_VIRT_SAMPLES,
2101 .reg = PMBUS_VIRT_IN_SAMPLES,
2102 .name = "in_samples",
2104 .reg = PMBUS_VIRT_CURR_SAMPLES,
2105 .name = "curr_samples",
2107 .reg = PMBUS_VIRT_POWER_SAMPLES,
2108 .name = "power_samples",
2110 .reg = PMBUS_VIRT_TEMP_SAMPLES,
2111 .name = "temp_samples",
2115 #define to_samples_reg(x) container_of(x, struct pmbus_samples_reg, dev_attr)
2117 static ssize_t pmbus_show_samples(struct device *dev,
2118 struct device_attribute *devattr, char *buf)
2121 struct i2c_client *client = to_i2c_client(dev->parent);
2122 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2123 struct pmbus_data *data = i2c_get_clientdata(client);
2125 mutex_lock(&data->update_lock);
2126 val = _pmbus_read_word_data(client, reg->page, 0xff, reg->attr->reg);
2127 mutex_unlock(&data->update_lock);
2131 return sysfs_emit(buf, "%d\n", val);
2134 static ssize_t pmbus_set_samples(struct device *dev,
2135 struct device_attribute *devattr,
2136 const char *buf, size_t count)
2140 struct i2c_client *client = to_i2c_client(dev->parent);
2141 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2142 struct pmbus_data *data = i2c_get_clientdata(client);
2144 if (kstrtol(buf, 0, &val) < 0)
2147 mutex_lock(&data->update_lock);
2148 ret = _pmbus_write_word_data(client, reg->page, reg->attr->reg, val);
2149 mutex_unlock(&data->update_lock);
2151 return ret ? : count;
2154 static int pmbus_add_samples_attr(struct pmbus_data *data, int page,
2155 struct pmbus_samples_attr *attr)
2157 struct pmbus_samples_reg *reg;
2159 reg = devm_kzalloc(data->dev, sizeof(*reg), GFP_KERNEL);
2166 pmbus_dev_attr_init(®->dev_attr, attr->name, 0644,
2167 pmbus_show_samples, pmbus_set_samples);
2169 return pmbus_add_attribute(data, ®->dev_attr.attr);
2172 static int pmbus_add_samples_attributes(struct i2c_client *client,
2173 struct pmbus_data *data)
2175 const struct pmbus_driver_info *info = data->info;
2178 if (!(info->func[0] & PMBUS_HAVE_SAMPLES))
2181 for (s = 0; s < ARRAY_SIZE(pmbus_samples_registers); s++) {
2182 struct pmbus_samples_attr *attr;
2185 attr = &pmbus_samples_registers[s];
2186 if (!pmbus_check_word_register(client, 0, attr->reg))
2189 ret = pmbus_add_samples_attr(data, 0, attr);
2197 static int pmbus_find_attributes(struct i2c_client *client,
2198 struct pmbus_data *data)
2202 /* Voltage sensors */
2203 ret = pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
2204 ARRAY_SIZE(voltage_attributes));
2208 /* Current sensors */
2209 ret = pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
2210 ARRAY_SIZE(current_attributes));
2215 ret = pmbus_add_sensor_attrs(client, data, "power", power_attributes,
2216 ARRAY_SIZE(power_attributes));
2220 /* Temperature sensors */
2221 ret = pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
2222 ARRAY_SIZE(temp_attributes));
2227 ret = pmbus_add_fan_attributes(client, data);
2231 ret = pmbus_add_samples_attributes(client, data);
2236 * The pmbus_class_attr_map structure maps one sensor class to
2237 * it's corresponding sensor attributes array.
2239 struct pmbus_class_attr_map {
2240 enum pmbus_sensor_classes class;
2242 const struct pmbus_sensor_attr *attr;
2245 static const struct pmbus_class_attr_map class_attr_map[] = {
2247 .class = PSC_VOLTAGE_IN,
2248 .attr = voltage_attributes,
2249 .nattr = ARRAY_SIZE(voltage_attributes),
2251 .class = PSC_VOLTAGE_OUT,
2252 .attr = voltage_attributes,
2253 .nattr = ARRAY_SIZE(voltage_attributes),
2255 .class = PSC_CURRENT_IN,
2256 .attr = current_attributes,
2257 .nattr = ARRAY_SIZE(current_attributes),
2259 .class = PSC_CURRENT_OUT,
2260 .attr = current_attributes,
2261 .nattr = ARRAY_SIZE(current_attributes),
2264 .attr = power_attributes,
2265 .nattr = ARRAY_SIZE(power_attributes),
2267 .class = PSC_TEMPERATURE,
2268 .attr = temp_attributes,
2269 .nattr = ARRAY_SIZE(temp_attributes),
2274 * Read the coefficients for direct mode.
2276 static int pmbus_read_coefficients(struct i2c_client *client,
2277 struct pmbus_driver_info *info,
2278 const struct pmbus_sensor_attr *attr)
2281 union i2c_smbus_data data;
2282 enum pmbus_sensor_classes class = attr->class;
2287 data.block[1] = attr->reg;
2288 data.block[2] = 0x01;
2290 rv = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2291 I2C_SMBUS_WRITE, PMBUS_COEFFICIENTS,
2292 I2C_SMBUS_BLOCK_PROC_CALL, &data);
2297 if (data.block[0] != 5)
2300 m = data.block[1] | (data.block[2] << 8);
2301 b = data.block[3] | (data.block[4] << 8);
2310 static int pmbus_init_coefficients(struct i2c_client *client,
2311 struct pmbus_driver_info *info)
2313 int i, n, ret = -EINVAL;
2314 const struct pmbus_class_attr_map *map;
2315 const struct pmbus_sensor_attr *attr;
2317 for (i = 0; i < ARRAY_SIZE(class_attr_map); i++) {
2318 map = &class_attr_map[i];
2319 if (info->format[map->class] != direct)
2321 for (n = 0; n < map->nattr; n++) {
2322 attr = &map->attr[n];
2323 if (map->class != attr->class)
2325 ret = pmbus_read_coefficients(client, info, attr);
2330 dev_err(&client->dev,
2331 "No coefficients found for sensor class %d\n",
2341 * Identify chip parameters.
2342 * This function is called for all chips.
2344 static int pmbus_identify_common(struct i2c_client *client,
2345 struct pmbus_data *data, int page)
2349 if (pmbus_check_byte_register(client, page, PMBUS_VOUT_MODE))
2350 vout_mode = _pmbus_read_byte_data(client, page,
2352 if (vout_mode >= 0 && vout_mode != 0xff) {
2354 * Not all chips support the VOUT_MODE command,
2355 * so a failure to read it is not an error.
2357 switch (vout_mode >> 5) {
2358 case 0: /* linear mode */
2359 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
2362 data->exponent[page] = ((s8)(vout_mode << 3)) >> 3;
2364 case 1: /* VID mode */
2365 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
2368 case 2: /* direct mode */
2369 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
2377 pmbus_clear_fault_page(client, page);
2381 static int pmbus_read_status_byte(struct i2c_client *client, int page)
2383 return _pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
2386 static int pmbus_read_status_word(struct i2c_client *client, int page)
2388 return _pmbus_read_word_data(client, page, 0xff, PMBUS_STATUS_WORD);
2391 static int pmbus_init_common(struct i2c_client *client, struct pmbus_data *data,
2392 struct pmbus_driver_info *info)
2394 struct device *dev = &client->dev;
2398 * Figure out if PEC is enabled before accessing any other register.
2399 * Make sure PEC is disabled, will be enabled later if needed.
2401 client->flags &= ~I2C_CLIENT_PEC;
2403 /* Enable PEC if the controller and bus supports it */
2404 if (!(data->flags & PMBUS_NO_CAPABILITY)) {
2405 ret = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
2406 if (ret >= 0 && (ret & PB_CAPABILITY_ERROR_CHECK)) {
2407 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_PEC))
2408 client->flags |= I2C_CLIENT_PEC;
2413 * Some PMBus chips don't support PMBUS_STATUS_WORD, so try
2414 * to use PMBUS_STATUS_BYTE instead if that is the case.
2415 * Bail out if both registers are not supported.
2417 data->read_status = pmbus_read_status_word;
2418 ret = i2c_smbus_read_word_data(client, PMBUS_STATUS_WORD);
2419 if (ret < 0 || ret == 0xffff) {
2420 data->read_status = pmbus_read_status_byte;
2421 ret = i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE);
2422 if (ret < 0 || ret == 0xff) {
2423 dev_err(dev, "PMBus status register not found\n");
2427 data->has_status_word = true;
2431 * Check if the chip is write protected. If it is, we can not clear
2432 * faults, and we should not try it. Also, in that case, writes into
2433 * limit registers need to be disabled.
2435 if (!(data->flags & PMBUS_NO_WRITE_PROTECT)) {
2436 ret = i2c_smbus_read_byte_data(client, PMBUS_WRITE_PROTECT);
2437 if (ret > 0 && (ret & PB_WP_ANY))
2438 data->flags |= PMBUS_WRITE_PROTECTED | PMBUS_SKIP_STATUS_CHECK;
2441 if (data->info->pages)
2442 pmbus_clear_faults(client);
2444 pmbus_clear_fault_page(client, -1);
2446 if (info->identify) {
2447 ret = (*info->identify)(client, info);
2449 dev_err(dev, "Chip identification failed\n");
2454 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
2455 dev_err(dev, "Bad number of PMBus pages: %d\n", info->pages);
2459 for (page = 0; page < info->pages; page++) {
2460 ret = pmbus_identify_common(client, data, page);
2462 dev_err(dev, "Failed to identify chip capabilities\n");
2467 if (data->flags & PMBUS_USE_COEFFICIENTS_CMD) {
2468 if (!i2c_check_functionality(client->adapter,
2469 I2C_FUNC_SMBUS_BLOCK_PROC_CALL))
2472 ret = pmbus_init_coefficients(client, info);
2480 #if IS_ENABLED(CONFIG_REGULATOR)
2481 static int pmbus_regulator_is_enabled(struct regulator_dev *rdev)
2483 struct device *dev = rdev_get_dev(rdev);
2484 struct i2c_client *client = to_i2c_client(dev->parent);
2485 struct pmbus_data *data = i2c_get_clientdata(client);
2486 u8 page = rdev_get_id(rdev);
2489 mutex_lock(&data->update_lock);
2490 ret = _pmbus_read_byte_data(client, page, PMBUS_OPERATION);
2491 mutex_unlock(&data->update_lock);
2496 return !!(ret & PB_OPERATION_CONTROL_ON);
2499 static int _pmbus_regulator_on_off(struct regulator_dev *rdev, bool enable)
2501 struct device *dev = rdev_get_dev(rdev);
2502 struct i2c_client *client = to_i2c_client(dev->parent);
2503 struct pmbus_data *data = i2c_get_clientdata(client);
2504 u8 page = rdev_get_id(rdev);
2507 mutex_lock(&data->update_lock);
2508 ret = pmbus_update_byte_data(client, page, PMBUS_OPERATION,
2509 PB_OPERATION_CONTROL_ON,
2510 enable ? PB_OPERATION_CONTROL_ON : 0);
2511 mutex_unlock(&data->update_lock);
2516 static int pmbus_regulator_enable(struct regulator_dev *rdev)
2518 return _pmbus_regulator_on_off(rdev, 1);
2521 static int pmbus_regulator_disable(struct regulator_dev *rdev)
2523 return _pmbus_regulator_on_off(rdev, 0);
2526 /* A PMBus status flag and the corresponding REGULATOR_ERROR_* flag */
2527 struct pmbus_regulator_status_assoc {
2531 /* PMBus->regulator bit mappings for a PMBus status register */
2532 struct pmbus_regulator_status_category {
2535 const struct pmbus_regulator_status_assoc *bits; /* zero-terminated */
2538 static const struct pmbus_regulator_status_category pmbus_regulator_flag_map[] = {
2540 .func = PMBUS_HAVE_STATUS_VOUT,
2541 .reg = PMBUS_STATUS_VOUT,
2542 .bits = (const struct pmbus_regulator_status_assoc[]) {
2543 { PB_VOLTAGE_UV_WARNING, REGULATOR_ERROR_UNDER_VOLTAGE_WARN },
2544 { PB_VOLTAGE_UV_FAULT, REGULATOR_ERROR_UNDER_VOLTAGE },
2545 { PB_VOLTAGE_OV_WARNING, REGULATOR_ERROR_OVER_VOLTAGE_WARN },
2546 { PB_VOLTAGE_OV_FAULT, REGULATOR_ERROR_REGULATION_OUT },
2550 .func = PMBUS_HAVE_STATUS_IOUT,
2551 .reg = PMBUS_STATUS_IOUT,
2552 .bits = (const struct pmbus_regulator_status_assoc[]) {
2553 { PB_IOUT_OC_WARNING, REGULATOR_ERROR_OVER_CURRENT_WARN },
2554 { PB_IOUT_OC_FAULT, REGULATOR_ERROR_OVER_CURRENT },
2555 { PB_IOUT_OC_LV_FAULT, REGULATOR_ERROR_OVER_CURRENT },
2559 .func = PMBUS_HAVE_STATUS_TEMP,
2560 .reg = PMBUS_STATUS_TEMPERATURE,
2561 .bits = (const struct pmbus_regulator_status_assoc[]) {
2562 { PB_TEMP_OT_WARNING, REGULATOR_ERROR_OVER_TEMP_WARN },
2563 { PB_TEMP_OT_FAULT, REGULATOR_ERROR_OVER_TEMP },
2569 static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned int *flags)
2572 const struct pmbus_regulator_status_category *cat;
2573 const struct pmbus_regulator_status_assoc *bit;
2574 struct device *dev = rdev_get_dev(rdev);
2575 struct i2c_client *client = to_i2c_client(dev->parent);
2576 struct pmbus_data *data = i2c_get_clientdata(client);
2577 u8 page = rdev_get_id(rdev);
2578 int func = data->info->func[page];
2582 mutex_lock(&data->update_lock);
2584 for (i = 0; i < ARRAY_SIZE(pmbus_regulator_flag_map); i++) {
2585 cat = &pmbus_regulator_flag_map[i];
2586 if (!(func & cat->func))
2589 status = _pmbus_read_byte_data(client, page, cat->reg);
2591 mutex_unlock(&data->update_lock);
2595 for (bit = cat->bits; bit->pflag; bit++) {
2596 if (status & bit->pflag)
2597 *flags |= bit->rflag;
2602 * Map what bits of STATUS_{WORD,BYTE} we can to REGULATOR_ERROR_*
2603 * bits. Some of the other bits are tempting (especially for cases
2604 * where we don't have the relevant PMBUS_HAVE_STATUS_*
2605 * functionality), but there's an unfortunate ambiguity in that
2606 * they're defined as indicating a fault *or* a warning, so we can't
2607 * easily determine whether to report REGULATOR_ERROR_<foo> or
2608 * REGULATOR_ERROR_<foo>_WARN.
2610 status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
2611 mutex_unlock(&data->update_lock);
2615 if (pmbus_regulator_is_enabled(rdev) && (status & PB_STATUS_OFF))
2616 *flags |= REGULATOR_ERROR_FAIL;
2619 * Unlike most other status bits, PB_STATUS_{IOUT_OC,VOUT_OV} are
2620 * defined strictly as fault indicators (not warnings).
2622 if (status & PB_STATUS_IOUT_OC)
2623 *flags |= REGULATOR_ERROR_OVER_CURRENT;
2624 if (status & PB_STATUS_VOUT_OV)
2625 *flags |= REGULATOR_ERROR_REGULATION_OUT;
2628 * If we haven't discovered any thermal faults or warnings via
2629 * PMBUS_STATUS_TEMPERATURE, map PB_STATUS_TEMPERATURE to a warning as
2630 * a (conservative) best-effort interpretation.
2632 if (!(*flags & (REGULATOR_ERROR_OVER_TEMP | REGULATOR_ERROR_OVER_TEMP_WARN)) &&
2633 (status & PB_STATUS_TEMPERATURE))
2634 *flags |= REGULATOR_ERROR_OVER_TEMP_WARN;
2639 static int pmbus_regulator_get_voltage(struct regulator_dev *rdev)
2641 struct device *dev = rdev_get_dev(rdev);
2642 struct i2c_client *client = to_i2c_client(dev->parent);
2643 struct pmbus_data *data = i2c_get_clientdata(client);
2644 struct pmbus_sensor s = {
2645 .page = rdev_get_id(rdev),
2646 .class = PSC_VOLTAGE_OUT,
2650 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_READ_VOUT);
2654 return (int)pmbus_reg2data(data, &s) * 1000; /* unit is uV */
2657 static int pmbus_regulator_set_voltage(struct regulator_dev *rdev, int min_uv,
2658 int max_uv, unsigned int *selector)
2660 struct device *dev = rdev_get_dev(rdev);
2661 struct i2c_client *client = to_i2c_client(dev->parent);
2662 struct pmbus_data *data = i2c_get_clientdata(client);
2663 struct pmbus_sensor s = {
2664 .page = rdev_get_id(rdev),
2665 .class = PSC_VOLTAGE_OUT,
2669 int val = DIV_ROUND_CLOSEST(min_uv, 1000); /* convert to mV */
2674 if (pmbus_check_word_register(client, s.page, PMBUS_MFR_VOUT_MIN))
2675 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_MFR_VOUT_MIN);
2677 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_VOUT_MARGIN_LOW);
2681 low = pmbus_reg2data(data, &s);
2684 if (pmbus_check_word_register(client, s.page, PMBUS_MFR_VOUT_MAX))
2685 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_MFR_VOUT_MAX);
2687 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_VOUT_MARGIN_HIGH);
2691 high = pmbus_reg2data(data, &s);
2693 /* Make sure we are within margins */
2699 val = pmbus_data2reg(data, &s, val);
2701 return _pmbus_write_word_data(client, s.page, PMBUS_VOUT_COMMAND, (u16)val);
2704 const struct regulator_ops pmbus_regulator_ops = {
2705 .enable = pmbus_regulator_enable,
2706 .disable = pmbus_regulator_disable,
2707 .is_enabled = pmbus_regulator_is_enabled,
2708 .get_error_flags = pmbus_regulator_get_error_flags,
2709 .get_voltage = pmbus_regulator_get_voltage,
2710 .set_voltage = pmbus_regulator_set_voltage,
2712 EXPORT_SYMBOL_NS_GPL(pmbus_regulator_ops, PMBUS);
2714 static int pmbus_regulator_register(struct pmbus_data *data)
2716 struct device *dev = data->dev;
2717 const struct pmbus_driver_info *info = data->info;
2718 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
2719 struct regulator_dev *rdev;
2722 for (i = 0; i < info->num_regulators; i++) {
2723 struct regulator_config config = { };
2726 config.driver_data = data;
2728 if (pdata && pdata->reg_init_data)
2729 config.init_data = &pdata->reg_init_data[i];
2731 rdev = devm_regulator_register(dev, &info->reg_desc[i],
2734 dev_err(dev, "Failed to register %s regulator\n",
2735 info->reg_desc[i].name);
2736 return PTR_ERR(rdev);
2743 static int pmbus_regulator_register(struct pmbus_data *data)
2749 static struct dentry *pmbus_debugfs_dir; /* pmbus debugfs directory */
2751 #if IS_ENABLED(CONFIG_DEBUG_FS)
2752 static int pmbus_debugfs_get(void *data, u64 *val)
2755 struct pmbus_debugfs_entry *entry = data;
2757 rc = _pmbus_read_byte_data(entry->client, entry->page, entry->reg);
2765 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops, pmbus_debugfs_get, NULL,
2768 static int pmbus_debugfs_get_status(void *data, u64 *val)
2771 struct pmbus_debugfs_entry *entry = data;
2772 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
2774 rc = pdata->read_status(entry->client, entry->page);
2782 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_status, pmbus_debugfs_get_status,
2783 NULL, "0x%04llx\n");
2785 static int pmbus_debugfs_get_pec(void *data, u64 *val)
2787 struct i2c_client *client = data;
2789 *val = !!(client->flags & I2C_CLIENT_PEC);
2794 static int pmbus_debugfs_set_pec(void *data, u64 val)
2797 struct i2c_client *client = data;
2800 client->flags &= ~I2C_CLIENT_PEC;
2807 rc = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
2811 if (!(rc & PB_CAPABILITY_ERROR_CHECK))
2814 client->flags |= I2C_CLIENT_PEC;
2818 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_pec, pmbus_debugfs_get_pec,
2819 pmbus_debugfs_set_pec, "%llu\n");
2821 static void pmbus_remove_debugfs(void *data)
2823 struct dentry *entry = data;
2825 debugfs_remove_recursive(entry);
2828 static int pmbus_init_debugfs(struct i2c_client *client,
2829 struct pmbus_data *data)
2832 char name[PMBUS_NAME_SIZE];
2833 struct pmbus_debugfs_entry *entries;
2835 if (!pmbus_debugfs_dir)
2839 * Create the debugfs directory for this device. Use the hwmon device
2840 * name to avoid conflicts (hwmon numbers are globally unique).
2842 data->debugfs = debugfs_create_dir(dev_name(data->hwmon_dev),
2844 if (IS_ERR_OR_NULL(data->debugfs)) {
2845 data->debugfs = NULL;
2849 /* Allocate the max possible entries we need. */
2850 entries = devm_kcalloc(data->dev,
2851 data->info->pages * 10, sizeof(*entries),
2856 debugfs_create_file("pec", 0664, data->debugfs, client,
2857 &pmbus_debugfs_ops_pec);
2859 for (i = 0; i < data->info->pages; ++i) {
2860 /* Check accessibility of status register if it's not page 0 */
2861 if (!i || pmbus_check_status_register(client, i)) {
2862 /* No need to set reg as we have special read op. */
2863 entries[idx].client = client;
2864 entries[idx].page = i;
2865 scnprintf(name, PMBUS_NAME_SIZE, "status%d", i);
2866 debugfs_create_file(name, 0444, data->debugfs,
2868 &pmbus_debugfs_ops_status);
2871 if (data->info->func[i] & PMBUS_HAVE_STATUS_VOUT) {
2872 entries[idx].client = client;
2873 entries[idx].page = i;
2874 entries[idx].reg = PMBUS_STATUS_VOUT;
2875 scnprintf(name, PMBUS_NAME_SIZE, "status%d_vout", i);
2876 debugfs_create_file(name, 0444, data->debugfs,
2878 &pmbus_debugfs_ops);
2881 if (data->info->func[i] & PMBUS_HAVE_STATUS_IOUT) {
2882 entries[idx].client = client;
2883 entries[idx].page = i;
2884 entries[idx].reg = PMBUS_STATUS_IOUT;
2885 scnprintf(name, PMBUS_NAME_SIZE, "status%d_iout", i);
2886 debugfs_create_file(name, 0444, data->debugfs,
2888 &pmbus_debugfs_ops);
2891 if (data->info->func[i] & PMBUS_HAVE_STATUS_INPUT) {
2892 entries[idx].client = client;
2893 entries[idx].page = i;
2894 entries[idx].reg = PMBUS_STATUS_INPUT;
2895 scnprintf(name, PMBUS_NAME_SIZE, "status%d_input", i);
2896 debugfs_create_file(name, 0444, data->debugfs,
2898 &pmbus_debugfs_ops);
2901 if (data->info->func[i] & PMBUS_HAVE_STATUS_TEMP) {
2902 entries[idx].client = client;
2903 entries[idx].page = i;
2904 entries[idx].reg = PMBUS_STATUS_TEMPERATURE;
2905 scnprintf(name, PMBUS_NAME_SIZE, "status%d_temp", i);
2906 debugfs_create_file(name, 0444, data->debugfs,
2908 &pmbus_debugfs_ops);
2911 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_CML)) {
2912 entries[idx].client = client;
2913 entries[idx].page = i;
2914 entries[idx].reg = PMBUS_STATUS_CML;
2915 scnprintf(name, PMBUS_NAME_SIZE, "status%d_cml", i);
2916 debugfs_create_file(name, 0444, data->debugfs,
2918 &pmbus_debugfs_ops);
2921 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_OTHER)) {
2922 entries[idx].client = client;
2923 entries[idx].page = i;
2924 entries[idx].reg = PMBUS_STATUS_OTHER;
2925 scnprintf(name, PMBUS_NAME_SIZE, "status%d_other", i);
2926 debugfs_create_file(name, 0444, data->debugfs,
2928 &pmbus_debugfs_ops);
2931 if (pmbus_check_byte_register(client, i,
2932 PMBUS_STATUS_MFR_SPECIFIC)) {
2933 entries[idx].client = client;
2934 entries[idx].page = i;
2935 entries[idx].reg = PMBUS_STATUS_MFR_SPECIFIC;
2936 scnprintf(name, PMBUS_NAME_SIZE, "status%d_mfr", i);
2937 debugfs_create_file(name, 0444, data->debugfs,
2939 &pmbus_debugfs_ops);
2942 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN12) {
2943 entries[idx].client = client;
2944 entries[idx].page = i;
2945 entries[idx].reg = PMBUS_STATUS_FAN_12;
2946 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan12", i);
2947 debugfs_create_file(name, 0444, data->debugfs,
2949 &pmbus_debugfs_ops);
2952 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN34) {
2953 entries[idx].client = client;
2954 entries[idx].page = i;
2955 entries[idx].reg = PMBUS_STATUS_FAN_34;
2956 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan34", i);
2957 debugfs_create_file(name, 0444, data->debugfs,
2959 &pmbus_debugfs_ops);
2963 return devm_add_action_or_reset(data->dev,
2964 pmbus_remove_debugfs, data->debugfs);
2967 static int pmbus_init_debugfs(struct i2c_client *client,
2968 struct pmbus_data *data)
2972 #endif /* IS_ENABLED(CONFIG_DEBUG_FS) */
2974 int pmbus_do_probe(struct i2c_client *client, struct pmbus_driver_info *info)
2976 struct device *dev = &client->dev;
2977 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
2978 struct pmbus_data *data;
2979 size_t groups_num = 0;
2986 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
2987 | I2C_FUNC_SMBUS_BYTE_DATA
2988 | I2C_FUNC_SMBUS_WORD_DATA))
2991 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
2996 while (info->groups[groups_num])
2999 data->groups = devm_kcalloc(dev, groups_num + 2, sizeof(void *),
3004 i2c_set_clientdata(client, data);
3005 mutex_init(&data->update_lock);
3009 data->flags = pdata->flags;
3011 data->currpage = -1;
3012 data->currphase = -1;
3014 ret = pmbus_init_common(client, data, info);
3018 ret = pmbus_find_attributes(client, data);
3023 * If there are no attributes, something is wrong.
3024 * Bail out instead of trying to register nothing.
3026 if (!data->num_attributes) {
3027 dev_err(dev, "No attributes found\n");
3031 name = devm_kstrdup(dev, client->name, GFP_KERNEL);
3034 strreplace(name, '-', '_');
3036 data->groups[0] = &data->group;
3037 memcpy(data->groups + 1, info->groups, sizeof(void *) * groups_num);
3038 data->hwmon_dev = devm_hwmon_device_register_with_groups(dev,
3039 name, data, data->groups);
3040 if (IS_ERR(data->hwmon_dev)) {
3041 dev_err(dev, "Failed to register hwmon device\n");
3042 return PTR_ERR(data->hwmon_dev);
3045 ret = pmbus_regulator_register(data);
3049 ret = pmbus_init_debugfs(client, data);
3051 dev_warn(dev, "Failed to register debugfs\n");
3055 EXPORT_SYMBOL_NS_GPL(pmbus_do_probe, PMBUS);
3057 struct dentry *pmbus_get_debugfs_dir(struct i2c_client *client)
3059 struct pmbus_data *data = i2c_get_clientdata(client);
3061 return data->debugfs;
3063 EXPORT_SYMBOL_NS_GPL(pmbus_get_debugfs_dir, PMBUS);
3065 static int __init pmbus_core_init(void)
3067 pmbus_debugfs_dir = debugfs_create_dir("pmbus", NULL);
3068 if (IS_ERR(pmbus_debugfs_dir))
3069 pmbus_debugfs_dir = NULL;
3074 static void __exit pmbus_core_exit(void)
3076 debugfs_remove_recursive(pmbus_debugfs_dir);
3079 module_init(pmbus_core_init);
3080 module_exit(pmbus_core_exit);
3082 MODULE_AUTHOR("Guenter Roeck");
3083 MODULE_DESCRIPTION("PMBus core driver");
3084 MODULE_LICENSE("GPL");