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 */
108 int vout_low[PMBUS_PAGES]; /* voltage low margin */
109 int vout_high[PMBUS_PAGES]; /* voltage high margin */
112 struct pmbus_debugfs_entry {
113 struct i2c_client *client;
118 static const int pmbus_fan_rpm_mask[] = {
125 static const int pmbus_fan_config_registers[] = {
132 static const int pmbus_fan_command_registers[] = {
139 void pmbus_clear_cache(struct i2c_client *client)
141 struct pmbus_data *data = i2c_get_clientdata(client);
142 struct pmbus_sensor *sensor;
144 for (sensor = data->sensors; sensor; sensor = sensor->next)
145 sensor->data = -ENODATA;
147 EXPORT_SYMBOL_NS_GPL(pmbus_clear_cache, PMBUS);
149 void pmbus_set_update(struct i2c_client *client, u8 reg, bool update)
151 struct pmbus_data *data = i2c_get_clientdata(client);
152 struct pmbus_sensor *sensor;
154 for (sensor = data->sensors; sensor; sensor = sensor->next)
155 if (sensor->reg == reg)
156 sensor->update = update;
158 EXPORT_SYMBOL_NS_GPL(pmbus_set_update, PMBUS);
160 int pmbus_set_page(struct i2c_client *client, int page, int phase)
162 struct pmbus_data *data = i2c_get_clientdata(client);
168 if (!(data->info->func[page] & PMBUS_PAGE_VIRTUAL) &&
169 data->info->pages > 1 && page != data->currpage) {
170 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
174 rv = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
181 data->currpage = page;
183 if (data->info->phases[page] && data->currphase != phase &&
184 !(data->info->func[page] & PMBUS_PHASE_VIRTUAL)) {
185 rv = i2c_smbus_write_byte_data(client, PMBUS_PHASE,
190 data->currphase = phase;
194 EXPORT_SYMBOL_NS_GPL(pmbus_set_page, PMBUS);
196 int pmbus_write_byte(struct i2c_client *client, int page, u8 value)
200 rv = pmbus_set_page(client, page, 0xff);
204 return i2c_smbus_write_byte(client, value);
206 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte, PMBUS);
209 * _pmbus_write_byte() is similar to pmbus_write_byte(), but checks if
210 * a device specific mapping function exists and calls it if necessary.
212 static int _pmbus_write_byte(struct i2c_client *client, int page, u8 value)
214 struct pmbus_data *data = i2c_get_clientdata(client);
215 const struct pmbus_driver_info *info = data->info;
218 if (info->write_byte) {
219 status = info->write_byte(client, page, value);
220 if (status != -ENODATA)
223 return pmbus_write_byte(client, page, value);
226 int pmbus_write_word_data(struct i2c_client *client, int page, u8 reg,
231 rv = pmbus_set_page(client, page, 0xff);
235 return i2c_smbus_write_word_data(client, reg, word);
237 EXPORT_SYMBOL_NS_GPL(pmbus_write_word_data, PMBUS);
240 static int pmbus_write_virt_reg(struct i2c_client *client, int page, int reg,
248 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
249 id = reg - PMBUS_VIRT_FAN_TARGET_1;
250 bit = pmbus_fan_rpm_mask[id];
251 rv = pmbus_update_fan(client, page, id, bit, bit, word);
262 * _pmbus_write_word_data() is similar to pmbus_write_word_data(), but checks if
263 * a device specific mapping function exists and calls it if necessary.
265 static int _pmbus_write_word_data(struct i2c_client *client, int page, int reg,
268 struct pmbus_data *data = i2c_get_clientdata(client);
269 const struct pmbus_driver_info *info = data->info;
272 if (info->write_word_data) {
273 status = info->write_word_data(client, page, reg, word);
274 if (status != -ENODATA)
278 if (reg >= PMBUS_VIRT_BASE)
279 return pmbus_write_virt_reg(client, page, reg, word);
281 return pmbus_write_word_data(client, page, reg, word);
285 * _pmbus_write_byte_data() is similar to pmbus_write_byte_data(), but checks if
286 * a device specific mapping function exists and calls it if necessary.
288 static int _pmbus_write_byte_data(struct i2c_client *client, int page, int reg, u8 value)
290 struct pmbus_data *data = i2c_get_clientdata(client);
291 const struct pmbus_driver_info *info = data->info;
294 if (info->write_byte_data) {
295 status = info->write_byte_data(client, page, reg, value);
296 if (status != -ENODATA)
299 return pmbus_write_byte_data(client, page, reg, value);
303 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
304 * a device specific mapping function exists and calls it if necessary.
306 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
308 struct pmbus_data *data = i2c_get_clientdata(client);
309 const struct pmbus_driver_info *info = data->info;
312 if (info->read_byte_data) {
313 status = info->read_byte_data(client, page, reg);
314 if (status != -ENODATA)
317 return pmbus_read_byte_data(client, page, reg);
320 int pmbus_update_fan(struct i2c_client *client, int page, int id,
321 u8 config, u8 mask, u16 command)
327 from = _pmbus_read_byte_data(client, page,
328 pmbus_fan_config_registers[id]);
332 to = (from & ~mask) | (config & mask);
334 rv = _pmbus_write_byte_data(client, page,
335 pmbus_fan_config_registers[id], to);
340 return _pmbus_write_word_data(client, page,
341 pmbus_fan_command_registers[id], command);
343 EXPORT_SYMBOL_NS_GPL(pmbus_update_fan, PMBUS);
345 int pmbus_read_word_data(struct i2c_client *client, int page, int phase, u8 reg)
349 rv = pmbus_set_page(client, page, phase);
353 return i2c_smbus_read_word_data(client, reg);
355 EXPORT_SYMBOL_NS_GPL(pmbus_read_word_data, PMBUS);
357 static int pmbus_read_virt_reg(struct i2c_client *client, int page, int reg)
363 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
364 id = reg - PMBUS_VIRT_FAN_TARGET_1;
365 rv = pmbus_get_fan_rate_device(client, page, id, rpm);
376 * _pmbus_read_word_data() is similar to pmbus_read_word_data(), but checks if
377 * a device specific mapping function exists and calls it if necessary.
379 static int _pmbus_read_word_data(struct i2c_client *client, int page,
382 struct pmbus_data *data = i2c_get_clientdata(client);
383 const struct pmbus_driver_info *info = data->info;
386 if (info->read_word_data) {
387 status = info->read_word_data(client, page, phase, reg);
388 if (status != -ENODATA)
392 if (reg >= PMBUS_VIRT_BASE)
393 return pmbus_read_virt_reg(client, page, reg);
395 return pmbus_read_word_data(client, page, phase, reg);
398 /* Same as above, but without phase parameter, for use in check functions */
399 static int __pmbus_read_word_data(struct i2c_client *client, int page, int reg)
401 return _pmbus_read_word_data(client, page, 0xff, reg);
404 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg)
408 rv = pmbus_set_page(client, page, 0xff);
412 return i2c_smbus_read_byte_data(client, reg);
414 EXPORT_SYMBOL_NS_GPL(pmbus_read_byte_data, PMBUS);
416 int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, u8 value)
420 rv = pmbus_set_page(client, page, 0xff);
424 return i2c_smbus_write_byte_data(client, reg, value);
426 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte_data, PMBUS);
428 int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg,
434 rv = _pmbus_read_byte_data(client, page, reg);
438 tmp = (rv & ~mask) | (value & mask);
441 rv = _pmbus_write_byte_data(client, page, reg, tmp);
445 EXPORT_SYMBOL_NS_GPL(pmbus_update_byte_data, PMBUS);
447 static int pmbus_read_block_data(struct i2c_client *client, int page, u8 reg,
452 rv = pmbus_set_page(client, page, 0xff);
456 return i2c_smbus_read_block_data(client, reg, data_buf);
459 static struct pmbus_sensor *pmbus_find_sensor(struct pmbus_data *data, int page,
462 struct pmbus_sensor *sensor;
464 for (sensor = data->sensors; sensor; sensor = sensor->next) {
465 if (sensor->page == page && sensor->reg == reg)
469 return ERR_PTR(-EINVAL);
472 static int pmbus_get_fan_rate(struct i2c_client *client, int page, int id,
473 enum pmbus_fan_mode mode,
476 struct pmbus_data *data = i2c_get_clientdata(client);
477 bool want_rpm, have_rpm;
478 struct pmbus_sensor *s;
482 want_rpm = (mode == rpm);
485 reg = want_rpm ? PMBUS_VIRT_FAN_TARGET_1 : PMBUS_VIRT_PWM_1;
486 s = pmbus_find_sensor(data, page, reg + id);
493 config = _pmbus_read_byte_data(client, page,
494 pmbus_fan_config_registers[id]);
498 have_rpm = !!(config & pmbus_fan_rpm_mask[id]);
499 if (want_rpm == have_rpm)
500 return pmbus_read_word_data(client, page, 0xff,
501 pmbus_fan_command_registers[id]);
503 /* Can't sensibly map between RPM and PWM, just return zero */
507 int pmbus_get_fan_rate_device(struct i2c_client *client, int page, int id,
508 enum pmbus_fan_mode mode)
510 return pmbus_get_fan_rate(client, page, id, mode, false);
512 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_device, PMBUS);
514 int pmbus_get_fan_rate_cached(struct i2c_client *client, int page, int id,
515 enum pmbus_fan_mode mode)
517 return pmbus_get_fan_rate(client, page, id, mode, true);
519 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_cached, PMBUS);
521 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
523 _pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
526 void pmbus_clear_faults(struct i2c_client *client)
528 struct pmbus_data *data = i2c_get_clientdata(client);
531 for (i = 0; i < data->info->pages; i++)
532 pmbus_clear_fault_page(client, i);
534 EXPORT_SYMBOL_NS_GPL(pmbus_clear_faults, PMBUS);
536 static int pmbus_check_status_cml(struct i2c_client *client)
538 struct pmbus_data *data = i2c_get_clientdata(client);
541 status = data->read_status(client, -1);
542 if (status < 0 || (status & PB_STATUS_CML)) {
543 status2 = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
544 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
550 static bool pmbus_check_register(struct i2c_client *client,
551 int (*func)(struct i2c_client *client,
556 struct pmbus_data *data = i2c_get_clientdata(client);
558 rv = func(client, page, reg);
559 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
560 rv = pmbus_check_status_cml(client);
561 if (rv < 0 && (data->flags & PMBUS_READ_STATUS_AFTER_FAILED_CHECK))
562 data->read_status(client, -1);
563 pmbus_clear_fault_page(client, -1);
567 static bool pmbus_check_status_register(struct i2c_client *client, int page)
570 struct pmbus_data *data = i2c_get_clientdata(client);
572 status = data->read_status(client, page);
573 if (status >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK) &&
574 (status & PB_STATUS_CML)) {
575 status = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
576 if (status < 0 || (status & PB_CML_FAULT_INVALID_COMMAND))
580 pmbus_clear_fault_page(client, -1);
584 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
586 return pmbus_check_register(client, _pmbus_read_byte_data, page, reg);
588 EXPORT_SYMBOL_NS_GPL(pmbus_check_byte_register, PMBUS);
590 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
592 return pmbus_check_register(client, __pmbus_read_word_data, page, reg);
594 EXPORT_SYMBOL_NS_GPL(pmbus_check_word_register, PMBUS);
596 static bool __maybe_unused pmbus_check_block_register(struct i2c_client *client,
600 struct pmbus_data *data = i2c_get_clientdata(client);
601 char data_buf[I2C_SMBUS_BLOCK_MAX + 2];
603 rv = pmbus_read_block_data(client, page, reg, data_buf);
604 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
605 rv = pmbus_check_status_cml(client);
606 if (rv < 0 && (data->flags & PMBUS_READ_STATUS_AFTER_FAILED_CHECK))
607 data->read_status(client, -1);
608 pmbus_clear_fault_page(client, -1);
612 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
614 struct pmbus_data *data = i2c_get_clientdata(client);
618 EXPORT_SYMBOL_NS_GPL(pmbus_get_driver_info, PMBUS);
620 static int pmbus_get_status(struct i2c_client *client, int page, int reg)
622 struct pmbus_data *data = i2c_get_clientdata(client);
626 case PMBUS_STATUS_WORD:
627 status = data->read_status(client, page);
630 status = _pmbus_read_byte_data(client, page, reg);
634 pmbus_clear_faults(client);
638 static void pmbus_update_sensor_data(struct i2c_client *client, struct pmbus_sensor *sensor)
640 if (sensor->data < 0 || sensor->update)
641 sensor->data = _pmbus_read_word_data(client, sensor->page,
642 sensor->phase, sensor->reg);
646 * Convert ieee754 sensor values to milli- or micro-units
647 * depending on sensor type.
649 * ieee754 data format:
651 * bit 10..14: exponent
654 * v=(−1)^signbit * 2^(−14) * 0.significantbits
656 * v=(−1)^signbit * 2^(exponent - 15) * 1.significantbits
660 * Add the number mantissa bits into the calculations for simplicity.
661 * To do that, add '10' to the exponent. By doing that, we can just add
662 * 0x400 to normal values and get the expected result.
664 static long pmbus_reg2data_ieee754(struct pmbus_data *data,
665 struct pmbus_sensor *sensor)
671 /* only support half precision for now */
672 sign = sensor->data & 0x8000;
673 exponent = (sensor->data >> 10) & 0x1f;
674 val = sensor->data & 0x3ff;
676 if (exponent == 0) { /* subnormal */
677 exponent = -(14 + 10);
678 } else if (exponent == 0x1f) { /* NaN, convert to min/max */
682 exponent -= (15 + 10); /* normal */
686 /* scale result to milli-units for all sensors except fans */
687 if (sensor->class != PSC_FAN)
690 /* scale result to micro-units for power sensors */
691 if (sensor->class == PSC_POWER)
706 * Convert linear sensor values to milli- or micro-units
707 * depending on sensor type.
709 static s64 pmbus_reg2data_linear(struct pmbus_data *data,
710 struct pmbus_sensor *sensor)
716 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
717 exponent = data->exponent[sensor->page];
718 mantissa = (u16) sensor->data;
719 } else { /* LINEAR11 */
720 exponent = ((s16)sensor->data) >> 11;
721 mantissa = ((s16)((sensor->data & 0x7ff) << 5)) >> 5;
726 /* scale result to milli-units for all sensors except fans */
727 if (sensor->class != PSC_FAN)
730 /* scale result to micro-units for power sensors */
731 if (sensor->class == PSC_POWER)
743 * Convert direct sensor values to milli- or micro-units
744 * depending on sensor type.
746 static s64 pmbus_reg2data_direct(struct pmbus_data *data,
747 struct pmbus_sensor *sensor)
749 s64 b, val = (s16)sensor->data;
752 m = data->info->m[sensor->class];
753 b = data->info->b[sensor->class];
754 R = data->info->R[sensor->class];
759 /* X = 1/m * (Y * 10^-R - b) */
761 /* scale result to milli-units for everything but fans */
762 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
767 /* scale result to micro-units for power sensors */
768 if (sensor->class == PSC_POWER) {
778 val = div_s64(val + 5LL, 10L); /* round closest */
782 val = div_s64(val - b, m);
787 * Convert VID sensor values to milli- or micro-units
788 * depending on sensor type.
790 static s64 pmbus_reg2data_vid(struct pmbus_data *data,
791 struct pmbus_sensor *sensor)
793 long val = sensor->data;
796 switch (data->info->vrm_version[sensor->page]) {
798 if (val >= 0x02 && val <= 0xb2)
799 rv = DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
803 rv = 250 + (val - 1) * 5;
807 rv = 500 + (val - 1) * 10;
811 rv = 200 + (val - 1) * 10;
814 if (val >= 0x0 && val <= 0xd8)
815 rv = DIV_ROUND_CLOSEST(155000 - val * 625, 100);
821 static s64 pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
825 if (!sensor->convert)
828 switch (data->info->format[sensor->class]) {
830 val = pmbus_reg2data_direct(data, sensor);
833 val = pmbus_reg2data_vid(data, sensor);
836 val = pmbus_reg2data_ieee754(data, sensor);
840 val = pmbus_reg2data_linear(data, sensor);
846 #define MAX_IEEE_MANTISSA (0x7ff * 1000)
847 #define MIN_IEEE_MANTISSA (0x400 * 1000)
849 static u16 pmbus_data2reg_ieee754(struct pmbus_data *data,
850 struct pmbus_sensor *sensor, long val)
852 u16 exponent = (15 + 10);
865 /* Power is in uW. Convert to mW before converting. */
866 if (sensor->class == PSC_POWER)
867 val = DIV_ROUND_CLOSEST(val, 1000L);
870 * For simplicity, convert fan data to milli-units
871 * before calculating the exponent.
873 if (sensor->class == PSC_FAN)
876 /* Reduce large mantissa until it fits into 10 bit */
877 while (val > MAX_IEEE_MANTISSA && exponent < 30) {
882 * Increase small mantissa to generate valid 'normal'
885 while (val < MIN_IEEE_MANTISSA && exponent > 1) {
890 /* Convert mantissa from milli-units to units */
891 mantissa = DIV_ROUND_CLOSEST(val, 1000);
894 * Ensure that the resulting number is within range.
895 * Valid range is 0x400..0x7ff, where bit 10 reflects
896 * the implied high bit in normalized ieee754 numbers.
897 * Set the range to 0x400..0x7ff to reflect this.
898 * The upper bit is then removed by the mask against
899 * 0x3ff in the final assignment.
901 if (mantissa > 0x7ff)
903 else if (mantissa < 0x400)
906 /* Convert to sign, 5 bit exponent, 10 bit mantissa */
907 return sign | (mantissa & 0x3ff) | ((exponent << 10) & 0x7c00);
910 #define MAX_LIN_MANTISSA (1023 * 1000)
911 #define MIN_LIN_MANTISSA (511 * 1000)
913 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
914 struct pmbus_sensor *sensor, s64 val)
916 s16 exponent = 0, mantissa;
917 bool negative = false;
923 if (sensor->class == PSC_VOLTAGE_OUT) {
924 /* LINEAR16 does not support negative voltages */
929 * For a static exponents, we don't have a choice
930 * but to adjust the value to it.
932 if (data->exponent[sensor->page] < 0)
933 val <<= -data->exponent[sensor->page];
935 val >>= data->exponent[sensor->page];
936 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
937 return clamp_val(val, 0, 0xffff);
945 /* Power is in uW. Convert to mW before converting. */
946 if (sensor->class == PSC_POWER)
947 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
950 * For simplicity, convert fan data to milli-units
951 * before calculating the exponent.
953 if (sensor->class == PSC_FAN)
956 /* Reduce large mantissa until it fits into 10 bit */
957 while (val >= MAX_LIN_MANTISSA && exponent < 15) {
961 /* Increase small mantissa to improve precision */
962 while (val < MIN_LIN_MANTISSA && exponent > -15) {
967 /* Convert mantissa from milli-units to units */
968 mantissa = clamp_val(DIV_ROUND_CLOSEST_ULL(val, 1000), 0, 0x3ff);
972 mantissa = -mantissa;
974 /* Convert to 5 bit exponent, 11 bit mantissa */
975 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
978 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
979 struct pmbus_sensor *sensor, s64 val)
984 m = data->info->m[sensor->class];
985 b = data->info->b[sensor->class];
986 R = data->info->R[sensor->class];
988 /* Power is in uW. Adjust R and b. */
989 if (sensor->class == PSC_POWER) {
994 /* Calculate Y = (m * X + b) * 10^R */
995 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
996 R -= 3; /* Adjust R and b for data in milli-units */
1006 val = div_s64(val + 5LL, 10L); /* round closest */
1010 return (u16)clamp_val(val, S16_MIN, S16_MAX);
1013 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
1014 struct pmbus_sensor *sensor, s64 val)
1016 val = clamp_val(val, 500, 1600);
1018 return 2 + DIV_ROUND_CLOSEST_ULL((1600LL - val) * 100LL, 625);
1021 static u16 pmbus_data2reg(struct pmbus_data *data,
1022 struct pmbus_sensor *sensor, s64 val)
1026 if (!sensor->convert)
1029 switch (data->info->format[sensor->class]) {
1031 regval = pmbus_data2reg_direct(data, sensor, val);
1034 regval = pmbus_data2reg_vid(data, sensor, val);
1037 regval = pmbus_data2reg_ieee754(data, sensor, val);
1041 regval = pmbus_data2reg_linear(data, sensor, val);
1048 * Return boolean calculated from converted data.
1049 * <index> defines a status register index and mask.
1050 * The mask is in the lower 8 bits, the register index is in bits 8..23.
1052 * The associated pmbus_boolean structure contains optional pointers to two
1053 * sensor attributes. If specified, those attributes are compared against each
1054 * other to determine if a limit has been exceeded.
1056 * If the sensor attribute pointers are NULL, the function returns true if
1057 * (status[reg] & mask) is true.
1059 * If sensor attribute pointers are provided, a comparison against a specified
1060 * limit has to be performed to determine the boolean result.
1061 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
1062 * sensor values referenced by sensor attribute pointers s1 and s2).
1064 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
1065 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
1067 * If a negative value is stored in any of the referenced registers, this value
1068 * reflects an error code which will be returned.
1070 static int pmbus_get_boolean(struct i2c_client *client, struct pmbus_boolean *b,
1073 struct pmbus_data *data = i2c_get_clientdata(client);
1074 struct pmbus_sensor *s1 = b->s1;
1075 struct pmbus_sensor *s2 = b->s2;
1076 u16 mask = pb_index_to_mask(index);
1077 u8 page = pb_index_to_page(index);
1078 u16 reg = pb_index_to_reg(index);
1082 mutex_lock(&data->update_lock);
1083 status = pmbus_get_status(client, page, reg);
1090 pmbus_update_sensor_data(client, s1);
1092 pmbus_update_sensor_data(client, s2);
1094 regval = status & mask;
1096 ret = _pmbus_write_byte_data(client, page, reg, regval);
1112 v1 = pmbus_reg2data(data, s1);
1113 v2 = pmbus_reg2data(data, s2);
1114 ret = !!(regval && v1 >= v2);
1119 mutex_unlock(&data->update_lock);
1123 static ssize_t pmbus_show_boolean(struct device *dev,
1124 struct device_attribute *da, char *buf)
1126 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
1127 struct pmbus_boolean *boolean = to_pmbus_boolean(attr);
1128 struct i2c_client *client = to_i2c_client(dev->parent);
1131 val = pmbus_get_boolean(client, boolean, attr->index);
1134 return sysfs_emit(buf, "%d\n", val);
1137 static ssize_t pmbus_show_sensor(struct device *dev,
1138 struct device_attribute *devattr, char *buf)
1140 struct i2c_client *client = to_i2c_client(dev->parent);
1141 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
1142 struct pmbus_data *data = i2c_get_clientdata(client);
1145 mutex_lock(&data->update_lock);
1146 pmbus_update_sensor_data(client, sensor);
1147 if (sensor->data < 0)
1150 ret = sysfs_emit(buf, "%lld\n", pmbus_reg2data(data, sensor));
1151 mutex_unlock(&data->update_lock);
1155 static ssize_t pmbus_set_sensor(struct device *dev,
1156 struct device_attribute *devattr,
1157 const char *buf, size_t count)
1159 struct i2c_client *client = to_i2c_client(dev->parent);
1160 struct pmbus_data *data = i2c_get_clientdata(client);
1161 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
1167 if (kstrtos64(buf, 10, &val) < 0)
1170 mutex_lock(&data->update_lock);
1171 regval = pmbus_data2reg(data, sensor, val);
1172 ret = _pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
1176 sensor->data = -ENODATA;
1177 mutex_unlock(&data->update_lock);
1181 static ssize_t pmbus_show_label(struct device *dev,
1182 struct device_attribute *da, char *buf)
1184 struct pmbus_label *label = to_pmbus_label(da);
1186 return sysfs_emit(buf, "%s\n", label->label);
1189 static int pmbus_add_attribute(struct pmbus_data *data, struct attribute *attr)
1191 if (data->num_attributes >= data->max_attributes - 1) {
1192 int new_max_attrs = data->max_attributes + PMBUS_ATTR_ALLOC_SIZE;
1193 void *new_attrs = devm_krealloc(data->dev, data->group.attrs,
1194 new_max_attrs * sizeof(void *),
1198 data->group.attrs = new_attrs;
1199 data->max_attributes = new_max_attrs;
1202 data->group.attrs[data->num_attributes++] = attr;
1203 data->group.attrs[data->num_attributes] = NULL;
1207 static void pmbus_dev_attr_init(struct device_attribute *dev_attr,
1210 ssize_t (*show)(struct device *dev,
1211 struct device_attribute *attr,
1213 ssize_t (*store)(struct device *dev,
1214 struct device_attribute *attr,
1215 const char *buf, size_t count))
1217 sysfs_attr_init(&dev_attr->attr);
1218 dev_attr->attr.name = name;
1219 dev_attr->attr.mode = mode;
1220 dev_attr->show = show;
1221 dev_attr->store = store;
1224 static void pmbus_attr_init(struct sensor_device_attribute *a,
1227 ssize_t (*show)(struct device *dev,
1228 struct device_attribute *attr,
1230 ssize_t (*store)(struct device *dev,
1231 struct device_attribute *attr,
1232 const char *buf, size_t count),
1235 pmbus_dev_attr_init(&a->dev_attr, name, mode, show, store);
1239 static int pmbus_add_boolean(struct pmbus_data *data,
1240 const char *name, const char *type, int seq,
1241 struct pmbus_sensor *s1,
1242 struct pmbus_sensor *s2,
1243 u8 page, u16 reg, u16 mask)
1245 struct pmbus_boolean *boolean;
1246 struct sensor_device_attribute *a;
1248 if (WARN((s1 && !s2) || (!s1 && s2), "Bad s1/s2 parameters\n"))
1251 boolean = devm_kzalloc(data->dev, sizeof(*boolean), GFP_KERNEL);
1255 a = &boolean->attribute;
1257 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
1261 pmbus_attr_init(a, boolean->name, 0444, pmbus_show_boolean, NULL,
1262 pb_reg_to_index(page, reg, mask));
1264 return pmbus_add_attribute(data, &a->dev_attr.attr);
1267 /* of thermal for pmbus temperature sensors */
1268 struct pmbus_thermal_data {
1269 struct pmbus_data *pmbus_data;
1270 struct pmbus_sensor *sensor;
1273 static int pmbus_thermal_get_temp(struct thermal_zone_device *tz, int *temp)
1275 struct pmbus_thermal_data *tdata = tz->devdata;
1276 struct pmbus_sensor *sensor = tdata->sensor;
1277 struct pmbus_data *pmbus_data = tdata->pmbus_data;
1278 struct i2c_client *client = to_i2c_client(pmbus_data->dev);
1279 struct device *dev = pmbus_data->hwmon_dev;
1283 /* May not even get to hwmon yet */
1288 mutex_lock(&pmbus_data->update_lock);
1289 pmbus_update_sensor_data(client, sensor);
1290 if (sensor->data < 0)
1293 *temp = (int)pmbus_reg2data(pmbus_data, sensor);
1294 mutex_unlock(&pmbus_data->update_lock);
1299 static const struct thermal_zone_device_ops pmbus_thermal_ops = {
1300 .get_temp = pmbus_thermal_get_temp,
1303 static int pmbus_thermal_add_sensor(struct pmbus_data *pmbus_data,
1304 struct pmbus_sensor *sensor, int index)
1306 struct device *dev = pmbus_data->dev;
1307 struct pmbus_thermal_data *tdata;
1308 struct thermal_zone_device *tzd;
1310 tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
1314 tdata->sensor = sensor;
1315 tdata->pmbus_data = pmbus_data;
1317 tzd = devm_thermal_of_zone_register(dev, index, tdata,
1318 &pmbus_thermal_ops);
1320 * If CONFIG_THERMAL_OF is disabled, this returns -ENODEV,
1321 * so ignore that error but forward any other error.
1323 if (IS_ERR(tzd) && (PTR_ERR(tzd) != -ENODEV))
1324 return PTR_ERR(tzd);
1329 static struct pmbus_sensor *pmbus_add_sensor(struct pmbus_data *data,
1330 const char *name, const char *type,
1331 int seq, int page, int phase,
1333 enum pmbus_sensor_classes class,
1334 bool update, bool readonly,
1337 struct pmbus_sensor *sensor;
1338 struct device_attribute *a;
1340 sensor = devm_kzalloc(data->dev, sizeof(*sensor), GFP_KERNEL);
1343 a = &sensor->attribute;
1346 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
1349 snprintf(sensor->name, sizeof(sensor->name), "%s%d",
1352 if (data->flags & PMBUS_WRITE_PROTECTED)
1355 sensor->page = page;
1356 sensor->phase = phase;
1358 sensor->class = class;
1359 sensor->update = update;
1360 sensor->convert = convert;
1361 sensor->data = -ENODATA;
1362 pmbus_dev_attr_init(a, sensor->name,
1363 readonly ? 0444 : 0644,
1364 pmbus_show_sensor, pmbus_set_sensor);
1366 if (pmbus_add_attribute(data, &a->attr))
1369 sensor->next = data->sensors;
1370 data->sensors = sensor;
1372 /* temperature sensors with _input values are registered with thermal */
1373 if (class == PSC_TEMPERATURE && strcmp(type, "input") == 0)
1374 pmbus_thermal_add_sensor(data, sensor, seq);
1379 static int pmbus_add_label(struct pmbus_data *data,
1380 const char *name, int seq,
1381 const char *lstring, int index, int phase)
1383 struct pmbus_label *label;
1384 struct device_attribute *a;
1386 label = devm_kzalloc(data->dev, sizeof(*label), GFP_KERNEL);
1390 a = &label->attribute;
1392 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
1395 strncpy(label->label, lstring,
1396 sizeof(label->label) - 1);
1398 snprintf(label->label, sizeof(label->label), "%s.%d",
1402 snprintf(label->label, sizeof(label->label), "%s%d",
1405 snprintf(label->label, sizeof(label->label), "%s%d.%d",
1406 lstring, index, phase);
1409 pmbus_dev_attr_init(a, label->name, 0444, pmbus_show_label, NULL);
1410 return pmbus_add_attribute(data, &a->attr);
1414 * Search for attributes. Allocate sensors, booleans, and labels as needed.
1418 * The pmbus_limit_attr structure describes a single limit attribute
1419 * and its associated alarm attribute.
1421 struct pmbus_limit_attr {
1422 u16 reg; /* Limit register */
1423 u16 sbit; /* Alarm attribute status bit */
1424 bool update; /* True if register needs updates */
1425 bool low; /* True if low limit; for limits with compare
1427 const char *attr; /* Attribute name */
1428 const char *alarm; /* Alarm attribute name */
1432 * The pmbus_sensor_attr structure describes one sensor attribute. This
1433 * description includes a reference to the associated limit attributes.
1435 struct pmbus_sensor_attr {
1436 u16 reg; /* sensor register */
1437 u16 gbit; /* generic status bit */
1438 u8 nlimit; /* # of limit registers */
1439 enum pmbus_sensor_classes class;/* sensor class */
1440 const char *label; /* sensor label */
1441 bool paged; /* true if paged sensor */
1442 bool update; /* true if update needed */
1443 bool compare; /* true if compare function needed */
1444 u32 func; /* sensor mask */
1445 u32 sfunc; /* sensor status mask */
1446 int sreg; /* status register */
1447 const struct pmbus_limit_attr *limit;/* limit registers */
1451 * Add a set of limit attributes and, if supported, the associated
1453 * returns 0 if no alarm register found, 1 if an alarm register was found,
1456 static int pmbus_add_limit_attrs(struct i2c_client *client,
1457 struct pmbus_data *data,
1458 const struct pmbus_driver_info *info,
1459 const char *name, int index, int page,
1460 struct pmbus_sensor *base,
1461 const struct pmbus_sensor_attr *attr)
1463 const struct pmbus_limit_attr *l = attr->limit;
1464 int nlimit = attr->nlimit;
1467 struct pmbus_sensor *curr;
1469 for (i = 0; i < nlimit; i++) {
1470 if (pmbus_check_word_register(client, page, l->reg)) {
1471 curr = pmbus_add_sensor(data, name, l->attr, index,
1472 page, 0xff, l->reg, attr->class,
1473 attr->update || l->update,
1477 if (l->sbit && (info->func[page] & attr->sfunc)) {
1478 ret = pmbus_add_boolean(data, name,
1480 attr->compare ? l->low ? curr : base
1482 attr->compare ? l->low ? base : curr
1484 page, attr->sreg, l->sbit);
1495 static int pmbus_add_sensor_attrs_one(struct i2c_client *client,
1496 struct pmbus_data *data,
1497 const struct pmbus_driver_info *info,
1499 int index, int page, int phase,
1500 const struct pmbus_sensor_attr *attr,
1503 struct pmbus_sensor *base;
1504 bool upper = !!(attr->gbit & 0xff00); /* need to check STATUS_WORD */
1508 ret = pmbus_add_label(data, name, index, attr->label,
1509 paged ? page + 1 : 0, phase);
1513 base = pmbus_add_sensor(data, name, "input", index, page, phase,
1514 attr->reg, attr->class, true, true, true);
1517 /* No limit and alarm attributes for phase specific sensors */
1518 if (attr->sfunc && phase == 0xff) {
1519 ret = pmbus_add_limit_attrs(client, data, info, name,
1520 index, page, base, attr);
1524 * Add generic alarm attribute only if there are no individual
1525 * alarm attributes, if there is a global alarm bit, and if
1526 * the generic status register (word or byte, depending on
1527 * which global bit is set) for this page is accessible.
1529 if (!ret && attr->gbit &&
1530 (!upper || data->has_status_word) &&
1531 pmbus_check_status_register(client, page)) {
1532 ret = pmbus_add_boolean(data, name, "alarm", index,
1534 page, PMBUS_STATUS_WORD,
1543 static bool pmbus_sensor_is_paged(const struct pmbus_driver_info *info,
1544 const struct pmbus_sensor_attr *attr)
1552 * Some attributes may be present on more than one page despite
1553 * not being marked with the paged attribute. If that is the case,
1554 * then treat the sensor as being paged and add the page suffix to the
1556 * We don't just add the paged attribute to all such attributes, in
1557 * order to maintain the un-suffixed labels in the case where the
1558 * attribute is only on page 0.
1560 for (p = 1; p < info->pages; p++) {
1561 if (info->func[p] & attr->func)
1567 static int pmbus_add_sensor_attrs(struct i2c_client *client,
1568 struct pmbus_data *data,
1570 const struct pmbus_sensor_attr *attrs,
1573 const struct pmbus_driver_info *info = data->info;
1578 for (i = 0; i < nattrs; i++) {
1580 bool paged = pmbus_sensor_is_paged(info, attrs);
1582 pages = paged ? info->pages : 1;
1583 for (page = 0; page < pages; page++) {
1584 if (info->func[page] & attrs->func) {
1585 ret = pmbus_add_sensor_attrs_one(client, data, info,
1587 0xff, attrs, paged);
1592 if (info->phases[page]) {
1595 for (phase = 0; phase < info->phases[page];
1597 if (!(info->pfunc[phase] & attrs->func))
1599 ret = pmbus_add_sensor_attrs_one(client,
1600 data, info, name, index, page,
1601 phase, attrs, paged);
1613 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1615 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1617 .alarm = "min_alarm",
1618 .sbit = PB_VOLTAGE_UV_WARNING,
1620 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1622 .alarm = "lcrit_alarm",
1623 .sbit = PB_VOLTAGE_UV_FAULT | PB_VOLTAGE_VIN_OFF,
1625 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1627 .alarm = "max_alarm",
1628 .sbit = PB_VOLTAGE_OV_WARNING,
1630 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1632 .alarm = "crit_alarm",
1633 .sbit = PB_VOLTAGE_OV_FAULT,
1635 .reg = PMBUS_VIRT_READ_VIN_AVG,
1639 .reg = PMBUS_VIRT_READ_VIN_MIN,
1643 .reg = PMBUS_VIRT_READ_VIN_MAX,
1647 .reg = PMBUS_VIRT_RESET_VIN_HISTORY,
1648 .attr = "reset_history",
1650 .reg = PMBUS_MFR_VIN_MIN,
1651 .attr = "rated_min",
1653 .reg = PMBUS_MFR_VIN_MAX,
1654 .attr = "rated_max",
1658 static const struct pmbus_limit_attr vmon_limit_attrs[] = {
1660 .reg = PMBUS_VIRT_VMON_UV_WARN_LIMIT,
1662 .alarm = "min_alarm",
1663 .sbit = PB_VOLTAGE_UV_WARNING,
1665 .reg = PMBUS_VIRT_VMON_UV_FAULT_LIMIT,
1667 .alarm = "lcrit_alarm",
1668 .sbit = PB_VOLTAGE_UV_FAULT,
1670 .reg = PMBUS_VIRT_VMON_OV_WARN_LIMIT,
1672 .alarm = "max_alarm",
1673 .sbit = PB_VOLTAGE_OV_WARNING,
1675 .reg = PMBUS_VIRT_VMON_OV_FAULT_LIMIT,
1677 .alarm = "crit_alarm",
1678 .sbit = PB_VOLTAGE_OV_FAULT,
1682 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1684 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1686 .alarm = "min_alarm",
1687 .sbit = PB_VOLTAGE_UV_WARNING,
1689 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1691 .alarm = "lcrit_alarm",
1692 .sbit = PB_VOLTAGE_UV_FAULT,
1694 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1696 .alarm = "max_alarm",
1697 .sbit = PB_VOLTAGE_OV_WARNING,
1699 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1701 .alarm = "crit_alarm",
1702 .sbit = PB_VOLTAGE_OV_FAULT,
1704 .reg = PMBUS_VIRT_READ_VOUT_AVG,
1708 .reg = PMBUS_VIRT_READ_VOUT_MIN,
1712 .reg = PMBUS_VIRT_READ_VOUT_MAX,
1716 .reg = PMBUS_VIRT_RESET_VOUT_HISTORY,
1717 .attr = "reset_history",
1719 .reg = PMBUS_MFR_VOUT_MIN,
1720 .attr = "rated_min",
1722 .reg = PMBUS_MFR_VOUT_MAX,
1723 .attr = "rated_max",
1727 static const struct pmbus_sensor_attr voltage_attributes[] = {
1729 .reg = PMBUS_READ_VIN,
1730 .class = PSC_VOLTAGE_IN,
1732 .func = PMBUS_HAVE_VIN,
1733 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1734 .sreg = PMBUS_STATUS_INPUT,
1735 .gbit = PB_STATUS_VIN_UV,
1736 .limit = vin_limit_attrs,
1737 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1739 .reg = PMBUS_VIRT_READ_VMON,
1740 .class = PSC_VOLTAGE_IN,
1742 .func = PMBUS_HAVE_VMON,
1743 .sfunc = PMBUS_HAVE_STATUS_VMON,
1744 .sreg = PMBUS_VIRT_STATUS_VMON,
1745 .limit = vmon_limit_attrs,
1746 .nlimit = ARRAY_SIZE(vmon_limit_attrs),
1748 .reg = PMBUS_READ_VCAP,
1749 .class = PSC_VOLTAGE_IN,
1751 .func = PMBUS_HAVE_VCAP,
1753 .reg = PMBUS_READ_VOUT,
1754 .class = PSC_VOLTAGE_OUT,
1757 .func = PMBUS_HAVE_VOUT,
1758 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1759 .sreg = PMBUS_STATUS_VOUT,
1760 .gbit = PB_STATUS_VOUT_OV,
1761 .limit = vout_limit_attrs,
1762 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1766 /* Current attributes */
1768 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1770 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1772 .alarm = "max_alarm",
1773 .sbit = PB_IIN_OC_WARNING,
1775 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1777 .alarm = "crit_alarm",
1778 .sbit = PB_IIN_OC_FAULT,
1780 .reg = PMBUS_VIRT_READ_IIN_AVG,
1784 .reg = PMBUS_VIRT_READ_IIN_MIN,
1788 .reg = PMBUS_VIRT_READ_IIN_MAX,
1792 .reg = PMBUS_VIRT_RESET_IIN_HISTORY,
1793 .attr = "reset_history",
1795 .reg = PMBUS_MFR_IIN_MAX,
1796 .attr = "rated_max",
1800 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1802 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1804 .alarm = "max_alarm",
1805 .sbit = PB_IOUT_OC_WARNING,
1807 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1809 .alarm = "lcrit_alarm",
1810 .sbit = PB_IOUT_UC_FAULT,
1812 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1814 .alarm = "crit_alarm",
1815 .sbit = PB_IOUT_OC_FAULT,
1817 .reg = PMBUS_VIRT_READ_IOUT_AVG,
1821 .reg = PMBUS_VIRT_READ_IOUT_MIN,
1825 .reg = PMBUS_VIRT_READ_IOUT_MAX,
1829 .reg = PMBUS_VIRT_RESET_IOUT_HISTORY,
1830 .attr = "reset_history",
1832 .reg = PMBUS_MFR_IOUT_MAX,
1833 .attr = "rated_max",
1837 static const struct pmbus_sensor_attr current_attributes[] = {
1839 .reg = PMBUS_READ_IIN,
1840 .class = PSC_CURRENT_IN,
1842 .func = PMBUS_HAVE_IIN,
1843 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1844 .sreg = PMBUS_STATUS_INPUT,
1845 .gbit = PB_STATUS_INPUT,
1846 .limit = iin_limit_attrs,
1847 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1849 .reg = PMBUS_READ_IOUT,
1850 .class = PSC_CURRENT_OUT,
1853 .func = PMBUS_HAVE_IOUT,
1854 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1855 .sreg = PMBUS_STATUS_IOUT,
1856 .gbit = PB_STATUS_IOUT_OC,
1857 .limit = iout_limit_attrs,
1858 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1862 /* Power attributes */
1864 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1866 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1869 .sbit = PB_PIN_OP_WARNING,
1871 .reg = PMBUS_VIRT_READ_PIN_AVG,
1875 .reg = PMBUS_VIRT_READ_PIN_MIN,
1877 .attr = "input_lowest",
1879 .reg = PMBUS_VIRT_READ_PIN_MAX,
1881 .attr = "input_highest",
1883 .reg = PMBUS_VIRT_RESET_PIN_HISTORY,
1884 .attr = "reset_history",
1886 .reg = PMBUS_MFR_PIN_MAX,
1887 .attr = "rated_max",
1891 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1893 .reg = PMBUS_POUT_MAX,
1895 .alarm = "cap_alarm",
1896 .sbit = PB_POWER_LIMITING,
1898 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1900 .alarm = "max_alarm",
1901 .sbit = PB_POUT_OP_WARNING,
1903 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1905 .alarm = "crit_alarm",
1906 .sbit = PB_POUT_OP_FAULT,
1908 .reg = PMBUS_VIRT_READ_POUT_AVG,
1912 .reg = PMBUS_VIRT_READ_POUT_MIN,
1914 .attr = "input_lowest",
1916 .reg = PMBUS_VIRT_READ_POUT_MAX,
1918 .attr = "input_highest",
1920 .reg = PMBUS_VIRT_RESET_POUT_HISTORY,
1921 .attr = "reset_history",
1923 .reg = PMBUS_MFR_POUT_MAX,
1924 .attr = "rated_max",
1928 static const struct pmbus_sensor_attr power_attributes[] = {
1930 .reg = PMBUS_READ_PIN,
1933 .func = PMBUS_HAVE_PIN,
1934 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1935 .sreg = PMBUS_STATUS_INPUT,
1936 .gbit = PB_STATUS_INPUT,
1937 .limit = pin_limit_attrs,
1938 .nlimit = ARRAY_SIZE(pin_limit_attrs),
1940 .reg = PMBUS_READ_POUT,
1944 .func = PMBUS_HAVE_POUT,
1945 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1946 .sreg = PMBUS_STATUS_IOUT,
1947 .limit = pout_limit_attrs,
1948 .nlimit = ARRAY_SIZE(pout_limit_attrs),
1952 /* Temperature atributes */
1954 static const struct pmbus_limit_attr temp_limit_attrs[] = {
1956 .reg = PMBUS_UT_WARN_LIMIT,
1959 .alarm = "min_alarm",
1960 .sbit = PB_TEMP_UT_WARNING,
1962 .reg = PMBUS_UT_FAULT_LIMIT,
1965 .alarm = "lcrit_alarm",
1966 .sbit = PB_TEMP_UT_FAULT,
1968 .reg = PMBUS_OT_WARN_LIMIT,
1970 .alarm = "max_alarm",
1971 .sbit = PB_TEMP_OT_WARNING,
1973 .reg = PMBUS_OT_FAULT_LIMIT,
1975 .alarm = "crit_alarm",
1976 .sbit = PB_TEMP_OT_FAULT,
1978 .reg = PMBUS_VIRT_READ_TEMP_MIN,
1981 .reg = PMBUS_VIRT_READ_TEMP_AVG,
1984 .reg = PMBUS_VIRT_READ_TEMP_MAX,
1987 .reg = PMBUS_VIRT_RESET_TEMP_HISTORY,
1988 .attr = "reset_history",
1990 .reg = PMBUS_MFR_MAX_TEMP_1,
1991 .attr = "rated_max",
1995 static const struct pmbus_limit_attr temp_limit_attrs2[] = {
1997 .reg = PMBUS_UT_WARN_LIMIT,
2000 .alarm = "min_alarm",
2001 .sbit = PB_TEMP_UT_WARNING,
2003 .reg = PMBUS_UT_FAULT_LIMIT,
2006 .alarm = "lcrit_alarm",
2007 .sbit = PB_TEMP_UT_FAULT,
2009 .reg = PMBUS_OT_WARN_LIMIT,
2011 .alarm = "max_alarm",
2012 .sbit = PB_TEMP_OT_WARNING,
2014 .reg = PMBUS_OT_FAULT_LIMIT,
2016 .alarm = "crit_alarm",
2017 .sbit = PB_TEMP_OT_FAULT,
2019 .reg = PMBUS_VIRT_READ_TEMP2_MIN,
2022 .reg = PMBUS_VIRT_READ_TEMP2_AVG,
2025 .reg = PMBUS_VIRT_READ_TEMP2_MAX,
2028 .reg = PMBUS_VIRT_RESET_TEMP2_HISTORY,
2029 .attr = "reset_history",
2031 .reg = PMBUS_MFR_MAX_TEMP_2,
2032 .attr = "rated_max",
2036 static const struct pmbus_limit_attr temp_limit_attrs3[] = {
2038 .reg = PMBUS_UT_WARN_LIMIT,
2041 .alarm = "min_alarm",
2042 .sbit = PB_TEMP_UT_WARNING,
2044 .reg = PMBUS_UT_FAULT_LIMIT,
2047 .alarm = "lcrit_alarm",
2048 .sbit = PB_TEMP_UT_FAULT,
2050 .reg = PMBUS_OT_WARN_LIMIT,
2052 .alarm = "max_alarm",
2053 .sbit = PB_TEMP_OT_WARNING,
2055 .reg = PMBUS_OT_FAULT_LIMIT,
2057 .alarm = "crit_alarm",
2058 .sbit = PB_TEMP_OT_FAULT,
2060 .reg = PMBUS_MFR_MAX_TEMP_3,
2061 .attr = "rated_max",
2065 static const struct pmbus_sensor_attr temp_attributes[] = {
2067 .reg = PMBUS_READ_TEMPERATURE_1,
2068 .class = PSC_TEMPERATURE,
2072 .func = PMBUS_HAVE_TEMP,
2073 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2074 .sreg = PMBUS_STATUS_TEMPERATURE,
2075 .gbit = PB_STATUS_TEMPERATURE,
2076 .limit = temp_limit_attrs,
2077 .nlimit = ARRAY_SIZE(temp_limit_attrs),
2079 .reg = PMBUS_READ_TEMPERATURE_2,
2080 .class = PSC_TEMPERATURE,
2084 .func = PMBUS_HAVE_TEMP2,
2085 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2086 .sreg = PMBUS_STATUS_TEMPERATURE,
2087 .gbit = PB_STATUS_TEMPERATURE,
2088 .limit = temp_limit_attrs2,
2089 .nlimit = ARRAY_SIZE(temp_limit_attrs2),
2091 .reg = PMBUS_READ_TEMPERATURE_3,
2092 .class = PSC_TEMPERATURE,
2096 .func = PMBUS_HAVE_TEMP3,
2097 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2098 .sreg = PMBUS_STATUS_TEMPERATURE,
2099 .gbit = PB_STATUS_TEMPERATURE,
2100 .limit = temp_limit_attrs3,
2101 .nlimit = ARRAY_SIZE(temp_limit_attrs3),
2105 static const int pmbus_fan_registers[] = {
2106 PMBUS_READ_FAN_SPEED_1,
2107 PMBUS_READ_FAN_SPEED_2,
2108 PMBUS_READ_FAN_SPEED_3,
2109 PMBUS_READ_FAN_SPEED_4
2112 static const int pmbus_fan_status_registers[] = {
2113 PMBUS_STATUS_FAN_12,
2114 PMBUS_STATUS_FAN_12,
2115 PMBUS_STATUS_FAN_34,
2119 static const u32 pmbus_fan_flags[] = {
2126 static const u32 pmbus_fan_status_flags[] = {
2127 PMBUS_HAVE_STATUS_FAN12,
2128 PMBUS_HAVE_STATUS_FAN12,
2129 PMBUS_HAVE_STATUS_FAN34,
2130 PMBUS_HAVE_STATUS_FAN34
2135 /* Precondition: FAN_CONFIG_x_y and FAN_COMMAND_x must exist for the fan ID */
2136 static int pmbus_add_fan_ctrl(struct i2c_client *client,
2137 struct pmbus_data *data, int index, int page, int id,
2140 struct pmbus_sensor *sensor;
2142 sensor = pmbus_add_sensor(data, "fan", "target", index, page,
2143 0xff, PMBUS_VIRT_FAN_TARGET_1 + id, PSC_FAN,
2144 false, false, true);
2149 if (!((data->info->func[page] & PMBUS_HAVE_PWM12) ||
2150 (data->info->func[page] & PMBUS_HAVE_PWM34)))
2153 sensor = pmbus_add_sensor(data, "pwm", NULL, index, page,
2154 0xff, PMBUS_VIRT_PWM_1 + id, PSC_PWM,
2155 false, false, true);
2160 sensor = pmbus_add_sensor(data, "pwm", "enable", index, page,
2161 0xff, PMBUS_VIRT_PWM_ENABLE_1 + id, PSC_PWM,
2162 true, false, false);
2170 static int pmbus_add_fan_attributes(struct i2c_client *client,
2171 struct pmbus_data *data)
2173 const struct pmbus_driver_info *info = data->info;
2178 for (page = 0; page < info->pages; page++) {
2181 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
2184 if (!(info->func[page] & pmbus_fan_flags[f]))
2187 if (!pmbus_check_word_register(client, page,
2188 pmbus_fan_registers[f]))
2192 * Skip fan if not installed.
2193 * Each fan configuration register covers multiple fans,
2194 * so we have to do some magic.
2196 regval = _pmbus_read_byte_data(client, page,
2197 pmbus_fan_config_registers[f]);
2199 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
2202 if (pmbus_add_sensor(data, "fan", "input", index,
2203 page, 0xff, pmbus_fan_registers[f],
2204 PSC_FAN, true, true, true) == NULL)
2208 if (pmbus_check_word_register(client, page,
2209 pmbus_fan_command_registers[f])) {
2210 ret = pmbus_add_fan_ctrl(client, data, index,
2217 * Each fan status register covers multiple fans,
2218 * so we have to do some magic.
2220 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
2221 pmbus_check_byte_register(client,
2222 page, pmbus_fan_status_registers[f])) {
2225 if (f > 1) /* fan 3, 4 */
2226 reg = PMBUS_STATUS_FAN_34;
2228 reg = PMBUS_STATUS_FAN_12;
2229 ret = pmbus_add_boolean(data, "fan",
2230 "alarm", index, NULL, NULL, page, reg,
2231 PB_FAN_FAN1_WARNING >> (f & 1));
2234 ret = pmbus_add_boolean(data, "fan",
2235 "fault", index, NULL, NULL, page, reg,
2236 PB_FAN_FAN1_FAULT >> (f & 1));
2246 struct pmbus_samples_attr {
2251 struct pmbus_samples_reg {
2253 struct pmbus_samples_attr *attr;
2254 struct device_attribute dev_attr;
2257 static struct pmbus_samples_attr pmbus_samples_registers[] = {
2259 .reg = PMBUS_VIRT_SAMPLES,
2262 .reg = PMBUS_VIRT_IN_SAMPLES,
2263 .name = "in_samples",
2265 .reg = PMBUS_VIRT_CURR_SAMPLES,
2266 .name = "curr_samples",
2268 .reg = PMBUS_VIRT_POWER_SAMPLES,
2269 .name = "power_samples",
2271 .reg = PMBUS_VIRT_TEMP_SAMPLES,
2272 .name = "temp_samples",
2276 #define to_samples_reg(x) container_of(x, struct pmbus_samples_reg, dev_attr)
2278 static ssize_t pmbus_show_samples(struct device *dev,
2279 struct device_attribute *devattr, char *buf)
2282 struct i2c_client *client = to_i2c_client(dev->parent);
2283 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2284 struct pmbus_data *data = i2c_get_clientdata(client);
2286 mutex_lock(&data->update_lock);
2287 val = _pmbus_read_word_data(client, reg->page, 0xff, reg->attr->reg);
2288 mutex_unlock(&data->update_lock);
2292 return sysfs_emit(buf, "%d\n", val);
2295 static ssize_t pmbus_set_samples(struct device *dev,
2296 struct device_attribute *devattr,
2297 const char *buf, size_t count)
2301 struct i2c_client *client = to_i2c_client(dev->parent);
2302 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2303 struct pmbus_data *data = i2c_get_clientdata(client);
2305 if (kstrtol(buf, 0, &val) < 0)
2308 mutex_lock(&data->update_lock);
2309 ret = _pmbus_write_word_data(client, reg->page, reg->attr->reg, val);
2310 mutex_unlock(&data->update_lock);
2312 return ret ? : count;
2315 static int pmbus_add_samples_attr(struct pmbus_data *data, int page,
2316 struct pmbus_samples_attr *attr)
2318 struct pmbus_samples_reg *reg;
2320 reg = devm_kzalloc(data->dev, sizeof(*reg), GFP_KERNEL);
2327 pmbus_dev_attr_init(®->dev_attr, attr->name, 0644,
2328 pmbus_show_samples, pmbus_set_samples);
2330 return pmbus_add_attribute(data, ®->dev_attr.attr);
2333 static int pmbus_add_samples_attributes(struct i2c_client *client,
2334 struct pmbus_data *data)
2336 const struct pmbus_driver_info *info = data->info;
2339 if (!(info->func[0] & PMBUS_HAVE_SAMPLES))
2342 for (s = 0; s < ARRAY_SIZE(pmbus_samples_registers); s++) {
2343 struct pmbus_samples_attr *attr;
2346 attr = &pmbus_samples_registers[s];
2347 if (!pmbus_check_word_register(client, 0, attr->reg))
2350 ret = pmbus_add_samples_attr(data, 0, attr);
2358 static int pmbus_find_attributes(struct i2c_client *client,
2359 struct pmbus_data *data)
2363 /* Voltage sensors */
2364 ret = pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
2365 ARRAY_SIZE(voltage_attributes));
2369 /* Current sensors */
2370 ret = pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
2371 ARRAY_SIZE(current_attributes));
2376 ret = pmbus_add_sensor_attrs(client, data, "power", power_attributes,
2377 ARRAY_SIZE(power_attributes));
2381 /* Temperature sensors */
2382 ret = pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
2383 ARRAY_SIZE(temp_attributes));
2388 ret = pmbus_add_fan_attributes(client, data);
2392 ret = pmbus_add_samples_attributes(client, data);
2397 * The pmbus_class_attr_map structure maps one sensor class to
2398 * it's corresponding sensor attributes array.
2400 struct pmbus_class_attr_map {
2401 enum pmbus_sensor_classes class;
2403 const struct pmbus_sensor_attr *attr;
2406 static const struct pmbus_class_attr_map class_attr_map[] = {
2408 .class = PSC_VOLTAGE_IN,
2409 .attr = voltage_attributes,
2410 .nattr = ARRAY_SIZE(voltage_attributes),
2412 .class = PSC_VOLTAGE_OUT,
2413 .attr = voltage_attributes,
2414 .nattr = ARRAY_SIZE(voltage_attributes),
2416 .class = PSC_CURRENT_IN,
2417 .attr = current_attributes,
2418 .nattr = ARRAY_SIZE(current_attributes),
2420 .class = PSC_CURRENT_OUT,
2421 .attr = current_attributes,
2422 .nattr = ARRAY_SIZE(current_attributes),
2425 .attr = power_attributes,
2426 .nattr = ARRAY_SIZE(power_attributes),
2428 .class = PSC_TEMPERATURE,
2429 .attr = temp_attributes,
2430 .nattr = ARRAY_SIZE(temp_attributes),
2435 * Read the coefficients for direct mode.
2437 static int pmbus_read_coefficients(struct i2c_client *client,
2438 struct pmbus_driver_info *info,
2439 const struct pmbus_sensor_attr *attr)
2442 union i2c_smbus_data data;
2443 enum pmbus_sensor_classes class = attr->class;
2448 data.block[1] = attr->reg;
2449 data.block[2] = 0x01;
2451 rv = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2452 I2C_SMBUS_WRITE, PMBUS_COEFFICIENTS,
2453 I2C_SMBUS_BLOCK_PROC_CALL, &data);
2458 if (data.block[0] != 5)
2461 m = data.block[1] | (data.block[2] << 8);
2462 b = data.block[3] | (data.block[4] << 8);
2471 static int pmbus_init_coefficients(struct i2c_client *client,
2472 struct pmbus_driver_info *info)
2474 int i, n, ret = -EINVAL;
2475 const struct pmbus_class_attr_map *map;
2476 const struct pmbus_sensor_attr *attr;
2478 for (i = 0; i < ARRAY_SIZE(class_attr_map); i++) {
2479 map = &class_attr_map[i];
2480 if (info->format[map->class] != direct)
2482 for (n = 0; n < map->nattr; n++) {
2483 attr = &map->attr[n];
2484 if (map->class != attr->class)
2486 ret = pmbus_read_coefficients(client, info, attr);
2491 dev_err(&client->dev,
2492 "No coefficients found for sensor class %d\n",
2502 * Identify chip parameters.
2503 * This function is called for all chips.
2505 static int pmbus_identify_common(struct i2c_client *client,
2506 struct pmbus_data *data, int page)
2510 if (pmbus_check_byte_register(client, page, PMBUS_VOUT_MODE))
2511 vout_mode = _pmbus_read_byte_data(client, page,
2513 if (vout_mode >= 0 && vout_mode != 0xff) {
2515 * Not all chips support the VOUT_MODE command,
2516 * so a failure to read it is not an error.
2518 switch (vout_mode >> 5) {
2519 case 0: /* linear mode */
2520 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
2523 data->exponent[page] = ((s8)(vout_mode << 3)) >> 3;
2525 case 1: /* VID mode */
2526 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
2529 case 2: /* direct mode */
2530 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
2533 case 3: /* ieee 754 half precision */
2534 if (data->info->format[PSC_VOLTAGE_OUT] != ieee754)
2542 pmbus_clear_fault_page(client, page);
2546 static int pmbus_read_status_byte(struct i2c_client *client, int page)
2548 return _pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
2551 static int pmbus_read_status_word(struct i2c_client *client, int page)
2553 return _pmbus_read_word_data(client, page, 0xff, PMBUS_STATUS_WORD);
2556 /* PEC attribute support */
2558 static ssize_t pec_show(struct device *dev, struct device_attribute *dummy,
2561 struct i2c_client *client = to_i2c_client(dev);
2563 return sysfs_emit(buf, "%d\n", !!(client->flags & I2C_CLIENT_PEC));
2566 static ssize_t pec_store(struct device *dev, struct device_attribute *dummy,
2567 const char *buf, size_t count)
2569 struct i2c_client *client = to_i2c_client(dev);
2573 err = kstrtobool(buf, &enable);
2578 client->flags |= I2C_CLIENT_PEC;
2580 client->flags &= ~I2C_CLIENT_PEC;
2585 static DEVICE_ATTR_RW(pec);
2587 static void pmbus_remove_pec(void *dev)
2589 device_remove_file(dev, &dev_attr_pec);
2592 static int pmbus_init_common(struct i2c_client *client, struct pmbus_data *data,
2593 struct pmbus_driver_info *info)
2595 struct device *dev = &client->dev;
2599 * Figure out if PEC is enabled before accessing any other register.
2600 * Make sure PEC is disabled, will be enabled later if needed.
2602 client->flags &= ~I2C_CLIENT_PEC;
2604 /* Enable PEC if the controller and bus supports it */
2605 if (!(data->flags & PMBUS_NO_CAPABILITY)) {
2606 ret = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
2607 if (ret >= 0 && (ret & PB_CAPABILITY_ERROR_CHECK)) {
2608 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_PEC))
2609 client->flags |= I2C_CLIENT_PEC;
2614 * Some PMBus chips don't support PMBUS_STATUS_WORD, so try
2615 * to use PMBUS_STATUS_BYTE instead if that is the case.
2616 * Bail out if both registers are not supported.
2618 data->read_status = pmbus_read_status_word;
2619 ret = i2c_smbus_read_word_data(client, PMBUS_STATUS_WORD);
2620 if (ret < 0 || ret == 0xffff) {
2621 data->read_status = pmbus_read_status_byte;
2622 ret = i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE);
2623 if (ret < 0 || ret == 0xff) {
2624 dev_err(dev, "PMBus status register not found\n");
2628 data->has_status_word = true;
2632 * Check if the chip is write protected. If it is, we can not clear
2633 * faults, and we should not try it. Also, in that case, writes into
2634 * limit registers need to be disabled.
2636 if (!(data->flags & PMBUS_NO_WRITE_PROTECT)) {
2637 ret = i2c_smbus_read_byte_data(client, PMBUS_WRITE_PROTECT);
2638 if (ret > 0 && (ret & PB_WP_ANY))
2639 data->flags |= PMBUS_WRITE_PROTECTED | PMBUS_SKIP_STATUS_CHECK;
2642 if (data->info->pages)
2643 pmbus_clear_faults(client);
2645 pmbus_clear_fault_page(client, -1);
2647 if (info->identify) {
2648 ret = (*info->identify)(client, info);
2650 dev_err(dev, "Chip identification failed\n");
2655 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
2656 dev_err(dev, "Bad number of PMBus pages: %d\n", info->pages);
2660 for (page = 0; page < info->pages; page++) {
2661 ret = pmbus_identify_common(client, data, page);
2663 dev_err(dev, "Failed to identify chip capabilities\n");
2668 if (data->flags & PMBUS_USE_COEFFICIENTS_CMD) {
2669 if (!i2c_check_functionality(client->adapter,
2670 I2C_FUNC_SMBUS_BLOCK_PROC_CALL))
2673 ret = pmbus_init_coefficients(client, info);
2678 if (client->flags & I2C_CLIENT_PEC) {
2680 * If I2C_CLIENT_PEC is set here, both the I2C adapter and the
2681 * chip support PEC. Add 'pec' attribute to client device to let
2682 * the user control it.
2684 ret = device_create_file(dev, &dev_attr_pec);
2687 ret = devm_add_action_or_reset(dev, pmbus_remove_pec, dev);
2695 #if IS_ENABLED(CONFIG_REGULATOR)
2696 static int pmbus_regulator_is_enabled(struct regulator_dev *rdev)
2698 struct device *dev = rdev_get_dev(rdev);
2699 struct i2c_client *client = to_i2c_client(dev->parent);
2700 struct pmbus_data *data = i2c_get_clientdata(client);
2701 u8 page = rdev_get_id(rdev);
2704 mutex_lock(&data->update_lock);
2705 ret = _pmbus_read_byte_data(client, page, PMBUS_OPERATION);
2706 mutex_unlock(&data->update_lock);
2711 return !!(ret & PB_OPERATION_CONTROL_ON);
2714 static int _pmbus_regulator_on_off(struct regulator_dev *rdev, bool enable)
2716 struct device *dev = rdev_get_dev(rdev);
2717 struct i2c_client *client = to_i2c_client(dev->parent);
2718 struct pmbus_data *data = i2c_get_clientdata(client);
2719 u8 page = rdev_get_id(rdev);
2722 mutex_lock(&data->update_lock);
2723 ret = pmbus_update_byte_data(client, page, PMBUS_OPERATION,
2724 PB_OPERATION_CONTROL_ON,
2725 enable ? PB_OPERATION_CONTROL_ON : 0);
2726 mutex_unlock(&data->update_lock);
2731 static int pmbus_regulator_enable(struct regulator_dev *rdev)
2733 return _pmbus_regulator_on_off(rdev, 1);
2736 static int pmbus_regulator_disable(struct regulator_dev *rdev)
2738 return _pmbus_regulator_on_off(rdev, 0);
2741 /* A PMBus status flag and the corresponding REGULATOR_ERROR_* flag */
2742 struct pmbus_regulator_status_assoc {
2746 /* PMBus->regulator bit mappings for a PMBus status register */
2747 struct pmbus_regulator_status_category {
2750 const struct pmbus_regulator_status_assoc *bits; /* zero-terminated */
2753 static const struct pmbus_regulator_status_category pmbus_regulator_flag_map[] = {
2755 .func = PMBUS_HAVE_STATUS_VOUT,
2756 .reg = PMBUS_STATUS_VOUT,
2757 .bits = (const struct pmbus_regulator_status_assoc[]) {
2758 { PB_VOLTAGE_UV_WARNING, REGULATOR_ERROR_UNDER_VOLTAGE_WARN },
2759 { PB_VOLTAGE_UV_FAULT, REGULATOR_ERROR_UNDER_VOLTAGE },
2760 { PB_VOLTAGE_OV_WARNING, REGULATOR_ERROR_OVER_VOLTAGE_WARN },
2761 { PB_VOLTAGE_OV_FAULT, REGULATOR_ERROR_REGULATION_OUT },
2765 .func = PMBUS_HAVE_STATUS_IOUT,
2766 .reg = PMBUS_STATUS_IOUT,
2767 .bits = (const struct pmbus_regulator_status_assoc[]) {
2768 { PB_IOUT_OC_WARNING, REGULATOR_ERROR_OVER_CURRENT_WARN },
2769 { PB_IOUT_OC_FAULT, REGULATOR_ERROR_OVER_CURRENT },
2770 { PB_IOUT_OC_LV_FAULT, REGULATOR_ERROR_OVER_CURRENT },
2774 .func = PMBUS_HAVE_STATUS_TEMP,
2775 .reg = PMBUS_STATUS_TEMPERATURE,
2776 .bits = (const struct pmbus_regulator_status_assoc[]) {
2777 { PB_TEMP_OT_WARNING, REGULATOR_ERROR_OVER_TEMP_WARN },
2778 { PB_TEMP_OT_FAULT, REGULATOR_ERROR_OVER_TEMP },
2784 static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned int *flags)
2787 const struct pmbus_regulator_status_category *cat;
2788 const struct pmbus_regulator_status_assoc *bit;
2789 struct device *dev = rdev_get_dev(rdev);
2790 struct i2c_client *client = to_i2c_client(dev->parent);
2791 struct pmbus_data *data = i2c_get_clientdata(client);
2792 u8 page = rdev_get_id(rdev);
2793 int func = data->info->func[page];
2797 mutex_lock(&data->update_lock);
2799 for (i = 0; i < ARRAY_SIZE(pmbus_regulator_flag_map); i++) {
2800 cat = &pmbus_regulator_flag_map[i];
2801 if (!(func & cat->func))
2804 status = _pmbus_read_byte_data(client, page, cat->reg);
2806 mutex_unlock(&data->update_lock);
2810 for (bit = cat->bits; bit->pflag; bit++) {
2811 if (status & bit->pflag)
2812 *flags |= bit->rflag;
2817 * Map what bits of STATUS_{WORD,BYTE} we can to REGULATOR_ERROR_*
2818 * bits. Some of the other bits are tempting (especially for cases
2819 * where we don't have the relevant PMBUS_HAVE_STATUS_*
2820 * functionality), but there's an unfortunate ambiguity in that
2821 * they're defined as indicating a fault *or* a warning, so we can't
2822 * easily determine whether to report REGULATOR_ERROR_<foo> or
2823 * REGULATOR_ERROR_<foo>_WARN.
2825 status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
2826 mutex_unlock(&data->update_lock);
2830 if (pmbus_regulator_is_enabled(rdev) && (status & PB_STATUS_OFF))
2831 *flags |= REGULATOR_ERROR_FAIL;
2834 * Unlike most other status bits, PB_STATUS_{IOUT_OC,VOUT_OV} are
2835 * defined strictly as fault indicators (not warnings).
2837 if (status & PB_STATUS_IOUT_OC)
2838 *flags |= REGULATOR_ERROR_OVER_CURRENT;
2839 if (status & PB_STATUS_VOUT_OV)
2840 *flags |= REGULATOR_ERROR_REGULATION_OUT;
2843 * If we haven't discovered any thermal faults or warnings via
2844 * PMBUS_STATUS_TEMPERATURE, map PB_STATUS_TEMPERATURE to a warning as
2845 * a (conservative) best-effort interpretation.
2847 if (!(*flags & (REGULATOR_ERROR_OVER_TEMP | REGULATOR_ERROR_OVER_TEMP_WARN)) &&
2848 (status & PB_STATUS_TEMPERATURE))
2849 *flags |= REGULATOR_ERROR_OVER_TEMP_WARN;
2854 static int pmbus_regulator_get_low_margin(struct i2c_client *client, int page)
2856 struct pmbus_data *data = i2c_get_clientdata(client);
2857 struct pmbus_sensor s = {
2859 .class = PSC_VOLTAGE_OUT,
2864 if (data->vout_low[page] < 0) {
2865 if (pmbus_check_word_register(client, page, PMBUS_MFR_VOUT_MIN))
2866 s.data = _pmbus_read_word_data(client, page, 0xff,
2867 PMBUS_MFR_VOUT_MIN);
2869 s.data = _pmbus_read_word_data(client, page, 0xff,
2870 PMBUS_VOUT_MARGIN_LOW);
2874 data->vout_low[page] = pmbus_reg2data(data, &s);
2877 return data->vout_low[page];
2880 static int pmbus_regulator_get_high_margin(struct i2c_client *client, int page)
2882 struct pmbus_data *data = i2c_get_clientdata(client);
2883 struct pmbus_sensor s = {
2885 .class = PSC_VOLTAGE_OUT,
2890 if (data->vout_high[page] < 0) {
2891 if (pmbus_check_word_register(client, page, PMBUS_MFR_VOUT_MAX))
2892 s.data = _pmbus_read_word_data(client, page, 0xff,
2893 PMBUS_MFR_VOUT_MAX);
2895 s.data = _pmbus_read_word_data(client, page, 0xff,
2896 PMBUS_VOUT_MARGIN_HIGH);
2900 data->vout_high[page] = pmbus_reg2data(data, &s);
2903 return data->vout_high[page];
2906 static int pmbus_regulator_get_voltage(struct regulator_dev *rdev)
2908 struct device *dev = rdev_get_dev(rdev);
2909 struct i2c_client *client = to_i2c_client(dev->parent);
2910 struct pmbus_data *data = i2c_get_clientdata(client);
2911 struct pmbus_sensor s = {
2912 .page = rdev_get_id(rdev),
2913 .class = PSC_VOLTAGE_OUT,
2917 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_READ_VOUT);
2921 return (int)pmbus_reg2data(data, &s) * 1000; /* unit is uV */
2924 static int pmbus_regulator_set_voltage(struct regulator_dev *rdev, int min_uv,
2925 int max_uv, unsigned int *selector)
2927 struct device *dev = rdev_get_dev(rdev);
2928 struct i2c_client *client = to_i2c_client(dev->parent);
2929 struct pmbus_data *data = i2c_get_clientdata(client);
2930 struct pmbus_sensor s = {
2931 .page = rdev_get_id(rdev),
2932 .class = PSC_VOLTAGE_OUT,
2936 int val = DIV_ROUND_CLOSEST(min_uv, 1000); /* convert to mV */
2941 low = pmbus_regulator_get_low_margin(client, s.page);
2945 high = pmbus_regulator_get_high_margin(client, s.page);
2949 /* Make sure we are within margins */
2955 val = pmbus_data2reg(data, &s, val);
2957 return _pmbus_write_word_data(client, s.page, PMBUS_VOUT_COMMAND, (u16)val);
2960 static int pmbus_regulator_list_voltage(struct regulator_dev *rdev,
2961 unsigned int selector)
2963 struct device *dev = rdev_get_dev(rdev);
2964 struct i2c_client *client = to_i2c_client(dev->parent);
2967 if (selector >= rdev->desc->n_voltages ||
2968 selector < rdev->desc->linear_min_sel)
2971 selector -= rdev->desc->linear_min_sel;
2972 val = DIV_ROUND_CLOSEST(rdev->desc->min_uV +
2973 (rdev->desc->uV_step * selector), 1000); /* convert to mV */
2975 low = pmbus_regulator_get_low_margin(client, rdev_get_id(rdev));
2979 high = pmbus_regulator_get_high_margin(client, rdev_get_id(rdev));
2983 if (val >= low && val <= high)
2984 return val * 1000; /* unit is uV */
2989 const struct regulator_ops pmbus_regulator_ops = {
2990 .enable = pmbus_regulator_enable,
2991 .disable = pmbus_regulator_disable,
2992 .is_enabled = pmbus_regulator_is_enabled,
2993 .get_error_flags = pmbus_regulator_get_error_flags,
2994 .get_voltage = pmbus_regulator_get_voltage,
2995 .set_voltage = pmbus_regulator_set_voltage,
2996 .list_voltage = pmbus_regulator_list_voltage,
2998 EXPORT_SYMBOL_NS_GPL(pmbus_regulator_ops, PMBUS);
3000 static int pmbus_regulator_register(struct pmbus_data *data)
3002 struct device *dev = data->dev;
3003 const struct pmbus_driver_info *info = data->info;
3004 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
3005 struct regulator_dev *rdev;
3008 for (i = 0; i < info->num_regulators; i++) {
3009 struct regulator_config config = { };
3012 config.driver_data = data;
3014 if (pdata && pdata->reg_init_data)
3015 config.init_data = &pdata->reg_init_data[i];
3017 rdev = devm_regulator_register(dev, &info->reg_desc[i],
3020 return dev_err_probe(dev, PTR_ERR(rdev),
3021 "Failed to register %s regulator\n",
3022 info->reg_desc[i].name);
3028 static int pmbus_regulator_register(struct pmbus_data *data)
3034 static struct dentry *pmbus_debugfs_dir; /* pmbus debugfs directory */
3036 #if IS_ENABLED(CONFIG_DEBUG_FS)
3037 static int pmbus_debugfs_get(void *data, u64 *val)
3040 struct pmbus_debugfs_entry *entry = data;
3042 rc = _pmbus_read_byte_data(entry->client, entry->page, entry->reg);
3050 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops, pmbus_debugfs_get, NULL,
3053 static int pmbus_debugfs_get_status(void *data, u64 *val)
3056 struct pmbus_debugfs_entry *entry = data;
3057 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
3059 rc = pdata->read_status(entry->client, entry->page);
3067 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_status, pmbus_debugfs_get_status,
3068 NULL, "0x%04llx\n");
3070 static ssize_t pmbus_debugfs_mfr_read(struct file *file, char __user *buf,
3071 size_t count, loff_t *ppos)
3074 struct pmbus_debugfs_entry *entry = file->private_data;
3075 char data[I2C_SMBUS_BLOCK_MAX + 2] = { 0 };
3077 rc = pmbus_read_block_data(entry->client, entry->page, entry->reg,
3082 /* Add newline at the end of a read data */
3085 /* Include newline into the length */
3088 return simple_read_from_buffer(buf, count, ppos, data, rc);
3091 static const struct file_operations pmbus_debugfs_ops_mfr = {
3092 .llseek = noop_llseek,
3093 .read = pmbus_debugfs_mfr_read,
3095 .open = simple_open,
3098 static void pmbus_remove_debugfs(void *data)
3100 struct dentry *entry = data;
3102 debugfs_remove_recursive(entry);
3105 static int pmbus_init_debugfs(struct i2c_client *client,
3106 struct pmbus_data *data)
3109 char name[PMBUS_NAME_SIZE];
3110 struct pmbus_debugfs_entry *entries;
3112 if (!pmbus_debugfs_dir)
3116 * Create the debugfs directory for this device. Use the hwmon device
3117 * name to avoid conflicts (hwmon numbers are globally unique).
3119 data->debugfs = debugfs_create_dir(dev_name(data->hwmon_dev),
3121 if (IS_ERR_OR_NULL(data->debugfs)) {
3122 data->debugfs = NULL;
3127 * Allocate the max possible entries we need.
3128 * 6 entries device-specific
3129 * 10 entries page-specific
3131 entries = devm_kcalloc(data->dev,
3132 6 + data->info->pages * 10, sizeof(*entries),
3138 * Add device-specific entries.
3139 * Please note that the PMBUS standard allows all registers to be
3141 * To reduce the number of debugfs entries for devices with many pages
3142 * assume that values of the following registers are the same for all
3143 * pages and report values only for page 0.
3145 if (pmbus_check_block_register(client, 0, PMBUS_MFR_ID)) {
3146 entries[idx].client = client;
3147 entries[idx].page = 0;
3148 entries[idx].reg = PMBUS_MFR_ID;
3149 debugfs_create_file("mfr_id", 0444, data->debugfs,
3151 &pmbus_debugfs_ops_mfr);
3154 if (pmbus_check_block_register(client, 0, PMBUS_MFR_MODEL)) {
3155 entries[idx].client = client;
3156 entries[idx].page = 0;
3157 entries[idx].reg = PMBUS_MFR_MODEL;
3158 debugfs_create_file("mfr_model", 0444, data->debugfs,
3160 &pmbus_debugfs_ops_mfr);
3163 if (pmbus_check_block_register(client, 0, PMBUS_MFR_REVISION)) {
3164 entries[idx].client = client;
3165 entries[idx].page = 0;
3166 entries[idx].reg = PMBUS_MFR_REVISION;
3167 debugfs_create_file("mfr_revision", 0444, data->debugfs,
3169 &pmbus_debugfs_ops_mfr);
3172 if (pmbus_check_block_register(client, 0, PMBUS_MFR_LOCATION)) {
3173 entries[idx].client = client;
3174 entries[idx].page = 0;
3175 entries[idx].reg = PMBUS_MFR_LOCATION;
3176 debugfs_create_file("mfr_location", 0444, data->debugfs,
3178 &pmbus_debugfs_ops_mfr);
3181 if (pmbus_check_block_register(client, 0, PMBUS_MFR_DATE)) {
3182 entries[idx].client = client;
3183 entries[idx].page = 0;
3184 entries[idx].reg = PMBUS_MFR_DATE;
3185 debugfs_create_file("mfr_date", 0444, data->debugfs,
3187 &pmbus_debugfs_ops_mfr);
3190 if (pmbus_check_block_register(client, 0, PMBUS_MFR_SERIAL)) {
3191 entries[idx].client = client;
3192 entries[idx].page = 0;
3193 entries[idx].reg = PMBUS_MFR_SERIAL;
3194 debugfs_create_file("mfr_serial", 0444, data->debugfs,
3196 &pmbus_debugfs_ops_mfr);
3199 /* Add page specific entries */
3200 for (i = 0; i < data->info->pages; ++i) {
3201 /* Check accessibility of status register if it's not page 0 */
3202 if (!i || pmbus_check_status_register(client, i)) {
3203 /* No need to set reg as we have special read op. */
3204 entries[idx].client = client;
3205 entries[idx].page = i;
3206 scnprintf(name, PMBUS_NAME_SIZE, "status%d", i);
3207 debugfs_create_file(name, 0444, data->debugfs,
3209 &pmbus_debugfs_ops_status);
3212 if (data->info->func[i] & PMBUS_HAVE_STATUS_VOUT) {
3213 entries[idx].client = client;
3214 entries[idx].page = i;
3215 entries[idx].reg = PMBUS_STATUS_VOUT;
3216 scnprintf(name, PMBUS_NAME_SIZE, "status%d_vout", i);
3217 debugfs_create_file(name, 0444, data->debugfs,
3219 &pmbus_debugfs_ops);
3222 if (data->info->func[i] & PMBUS_HAVE_STATUS_IOUT) {
3223 entries[idx].client = client;
3224 entries[idx].page = i;
3225 entries[idx].reg = PMBUS_STATUS_IOUT;
3226 scnprintf(name, PMBUS_NAME_SIZE, "status%d_iout", i);
3227 debugfs_create_file(name, 0444, data->debugfs,
3229 &pmbus_debugfs_ops);
3232 if (data->info->func[i] & PMBUS_HAVE_STATUS_INPUT) {
3233 entries[idx].client = client;
3234 entries[idx].page = i;
3235 entries[idx].reg = PMBUS_STATUS_INPUT;
3236 scnprintf(name, PMBUS_NAME_SIZE, "status%d_input", i);
3237 debugfs_create_file(name, 0444, data->debugfs,
3239 &pmbus_debugfs_ops);
3242 if (data->info->func[i] & PMBUS_HAVE_STATUS_TEMP) {
3243 entries[idx].client = client;
3244 entries[idx].page = i;
3245 entries[idx].reg = PMBUS_STATUS_TEMPERATURE;
3246 scnprintf(name, PMBUS_NAME_SIZE, "status%d_temp", i);
3247 debugfs_create_file(name, 0444, data->debugfs,
3249 &pmbus_debugfs_ops);
3252 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_CML)) {
3253 entries[idx].client = client;
3254 entries[idx].page = i;
3255 entries[idx].reg = PMBUS_STATUS_CML;
3256 scnprintf(name, PMBUS_NAME_SIZE, "status%d_cml", i);
3257 debugfs_create_file(name, 0444, data->debugfs,
3259 &pmbus_debugfs_ops);
3262 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_OTHER)) {
3263 entries[idx].client = client;
3264 entries[idx].page = i;
3265 entries[idx].reg = PMBUS_STATUS_OTHER;
3266 scnprintf(name, PMBUS_NAME_SIZE, "status%d_other", i);
3267 debugfs_create_file(name, 0444, data->debugfs,
3269 &pmbus_debugfs_ops);
3272 if (pmbus_check_byte_register(client, i,
3273 PMBUS_STATUS_MFR_SPECIFIC)) {
3274 entries[idx].client = client;
3275 entries[idx].page = i;
3276 entries[idx].reg = PMBUS_STATUS_MFR_SPECIFIC;
3277 scnprintf(name, PMBUS_NAME_SIZE, "status%d_mfr", i);
3278 debugfs_create_file(name, 0444, data->debugfs,
3280 &pmbus_debugfs_ops);
3283 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN12) {
3284 entries[idx].client = client;
3285 entries[idx].page = i;
3286 entries[idx].reg = PMBUS_STATUS_FAN_12;
3287 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan12", i);
3288 debugfs_create_file(name, 0444, data->debugfs,
3290 &pmbus_debugfs_ops);
3293 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN34) {
3294 entries[idx].client = client;
3295 entries[idx].page = i;
3296 entries[idx].reg = PMBUS_STATUS_FAN_34;
3297 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan34", i);
3298 debugfs_create_file(name, 0444, data->debugfs,
3300 &pmbus_debugfs_ops);
3304 return devm_add_action_or_reset(data->dev,
3305 pmbus_remove_debugfs, data->debugfs);
3308 static int pmbus_init_debugfs(struct i2c_client *client,
3309 struct pmbus_data *data)
3313 #endif /* IS_ENABLED(CONFIG_DEBUG_FS) */
3315 int pmbus_do_probe(struct i2c_client *client, struct pmbus_driver_info *info)
3317 struct device *dev = &client->dev;
3318 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
3319 struct pmbus_data *data;
3320 size_t groups_num = 0;
3328 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
3329 | I2C_FUNC_SMBUS_BYTE_DATA
3330 | I2C_FUNC_SMBUS_WORD_DATA))
3333 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
3338 while (info->groups[groups_num])
3341 data->groups = devm_kcalloc(dev, groups_num + 2, sizeof(void *),
3346 i2c_set_clientdata(client, data);
3347 mutex_init(&data->update_lock);
3351 data->flags = pdata->flags;
3353 data->currpage = -1;
3354 data->currphase = -1;
3356 for (i = 0; i < ARRAY_SIZE(data->vout_low); i++) {
3357 data->vout_low[i] = -1;
3358 data->vout_high[i] = -1;
3361 ret = pmbus_init_common(client, data, info);
3365 ret = pmbus_find_attributes(client, data);
3370 * If there are no attributes, something is wrong.
3371 * Bail out instead of trying to register nothing.
3373 if (!data->num_attributes) {
3374 dev_err(dev, "No attributes found\n");
3378 name = devm_kstrdup(dev, client->name, GFP_KERNEL);
3381 strreplace(name, '-', '_');
3383 data->groups[0] = &data->group;
3384 memcpy(data->groups + 1, info->groups, sizeof(void *) * groups_num);
3385 data->hwmon_dev = devm_hwmon_device_register_with_groups(dev,
3386 name, data, data->groups);
3387 if (IS_ERR(data->hwmon_dev)) {
3388 dev_err(dev, "Failed to register hwmon device\n");
3389 return PTR_ERR(data->hwmon_dev);
3392 ret = pmbus_regulator_register(data);
3396 ret = pmbus_init_debugfs(client, data);
3398 dev_warn(dev, "Failed to register debugfs\n");
3402 EXPORT_SYMBOL_NS_GPL(pmbus_do_probe, PMBUS);
3404 struct dentry *pmbus_get_debugfs_dir(struct i2c_client *client)
3406 struct pmbus_data *data = i2c_get_clientdata(client);
3408 return data->debugfs;
3410 EXPORT_SYMBOL_NS_GPL(pmbus_get_debugfs_dir, PMBUS);
3412 static int __init pmbus_core_init(void)
3414 pmbus_debugfs_dir = debugfs_create_dir("pmbus", NULL);
3415 if (IS_ERR(pmbus_debugfs_dir))
3416 pmbus_debugfs_dir = NULL;
3421 static void __exit pmbus_core_exit(void)
3423 debugfs_remove_recursive(pmbus_debugfs_dir);
3426 module_init(pmbus_core_init);
3427 module_exit(pmbus_core_exit);
3429 MODULE_AUTHOR("Guenter Roeck");
3430 MODULE_DESCRIPTION("PMBus core driver");
3431 MODULE_LICENSE("GPL");