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/delay.h>
11 #include <linux/kernel.h>
12 #include <linux/math64.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/err.h>
16 #include <linux/slab.h>
17 #include <linux/i2c.h>
18 #include <linux/hwmon.h>
19 #include <linux/hwmon-sysfs.h>
20 #include <linux/pmbus.h>
21 #include <linux/regulator/driver.h>
22 #include <linux/regulator/machine.h>
24 #include <linux/thermal.h>
28 * Number of additional attribute pointers to allocate
29 * with each call to krealloc
31 #define PMBUS_ATTR_ALLOC_SIZE 32
32 #define PMBUS_NAME_SIZE 24
35 module_param(wp, int, 0444);
38 struct pmbus_sensor *next;
39 char name[PMBUS_NAME_SIZE]; /* sysfs sensor name */
40 struct device_attribute attribute;
41 u8 page; /* page number */
42 u8 phase; /* phase number, 0xff for all phases */
43 u16 reg; /* register */
44 enum pmbus_sensor_classes class; /* sensor class */
45 bool update; /* runtime sensor update needed */
46 bool convert; /* Whether or not to apply linear/vid/direct */
47 int data; /* Sensor data.
48 Negative if there was a read error */
50 #define to_pmbus_sensor(_attr) \
51 container_of(_attr, struct pmbus_sensor, attribute)
53 struct pmbus_boolean {
54 char name[PMBUS_NAME_SIZE]; /* sysfs boolean name */
55 struct sensor_device_attribute attribute;
56 struct pmbus_sensor *s1;
57 struct pmbus_sensor *s2;
59 #define to_pmbus_boolean(_attr) \
60 container_of(_attr, struct pmbus_boolean, attribute)
63 char name[PMBUS_NAME_SIZE]; /* sysfs label name */
64 struct device_attribute attribute;
65 char label[PMBUS_NAME_SIZE]; /* label */
67 #define to_pmbus_label(_attr) \
68 container_of(_attr, struct pmbus_label, attribute)
70 /* Macros for converting between sensor index and register/page/status mask */
72 #define PB_STATUS_MASK 0xffff
73 #define PB_REG_SHIFT 16
74 #define PB_REG_MASK 0x3ff
75 #define PB_PAGE_SHIFT 26
76 #define PB_PAGE_MASK 0x3f
78 #define pb_reg_to_index(page, reg, mask) (((page) << PB_PAGE_SHIFT) | \
79 ((reg) << PB_REG_SHIFT) | (mask))
81 #define pb_index_to_page(index) (((index) >> PB_PAGE_SHIFT) & PB_PAGE_MASK)
82 #define pb_index_to_reg(index) (((index) >> PB_REG_SHIFT) & PB_REG_MASK)
83 #define pb_index_to_mask(index) ((index) & PB_STATUS_MASK)
87 struct device *hwmon_dev;
88 struct regulator_dev **rdevs;
90 u32 flags; /* from platform data */
92 u8 revision; /* The PMBus revision the device is compliant with */
94 int exponent[PMBUS_PAGES];
95 /* linear mode: exponent for output voltages */
97 const struct pmbus_driver_info *info;
101 struct attribute_group group;
102 const struct attribute_group **groups;
103 struct dentry *debugfs; /* debugfs device directory */
105 struct pmbus_sensor *sensors;
107 struct mutex update_lock;
109 bool has_status_word; /* device uses STATUS_WORD register */
110 int (*read_status)(struct i2c_client *client, int page);
112 s16 currpage; /* current page, -1 for unknown/unset */
113 s16 currphase; /* current phase, 0xff for all, -1 for unknown/unset */
115 int vout_low[PMBUS_PAGES]; /* voltage low margin */
116 int vout_high[PMBUS_PAGES]; /* voltage high margin */
117 ktime_t write_time; /* Last SMBUS write timestamp */
118 ktime_t access_time; /* Last SMBUS access timestamp */
121 struct pmbus_debugfs_entry {
122 struct i2c_client *client;
127 static const int pmbus_fan_rpm_mask[] = {
134 static const int pmbus_fan_config_registers[] = {
141 static const int pmbus_fan_command_registers[] = {
148 void pmbus_clear_cache(struct i2c_client *client)
150 struct pmbus_data *data = i2c_get_clientdata(client);
151 struct pmbus_sensor *sensor;
153 for (sensor = data->sensors; sensor; sensor = sensor->next)
154 sensor->data = -ENODATA;
156 EXPORT_SYMBOL_NS_GPL(pmbus_clear_cache, "PMBUS");
158 void pmbus_set_update(struct i2c_client *client, u8 reg, bool update)
160 struct pmbus_data *data = i2c_get_clientdata(client);
161 struct pmbus_sensor *sensor;
163 for (sensor = data->sensors; sensor; sensor = sensor->next)
164 if (sensor->reg == reg)
165 sensor->update = update;
167 EXPORT_SYMBOL_NS_GPL(pmbus_set_update, "PMBUS");
169 /* Some chips need a delay between accesses. */
170 static void pmbus_wait(struct i2c_client *client)
172 struct pmbus_data *data = i2c_get_clientdata(client);
173 const struct pmbus_driver_info *info = data->info;
176 if (info->access_delay) {
177 delta = ktime_us_delta(ktime_get(), data->access_time);
179 if (delta < info->access_delay)
180 fsleep(info->access_delay - delta);
181 } else if (info->write_delay) {
182 delta = ktime_us_delta(ktime_get(), data->write_time);
184 if (delta < info->write_delay)
185 fsleep(info->write_delay - delta);
189 /* Sets the last accessed timestamp for pmbus_wait */
190 static void pmbus_update_ts(struct i2c_client *client, bool write_op)
192 struct pmbus_data *data = i2c_get_clientdata(client);
193 const struct pmbus_driver_info *info = data->info;
195 if (info->access_delay) {
196 data->access_time = ktime_get();
197 } else if (info->write_delay && write_op) {
198 data->write_time = ktime_get();
202 int pmbus_set_page(struct i2c_client *client, int page, int phase)
204 struct pmbus_data *data = i2c_get_clientdata(client);
210 if (!(data->info->func[page] & PMBUS_PAGE_VIRTUAL) &&
211 data->info->pages > 1 && page != data->currpage) {
213 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page);
214 pmbus_update_ts(client, true);
219 rv = i2c_smbus_read_byte_data(client, PMBUS_PAGE);
220 pmbus_update_ts(client, false);
227 data->currpage = page;
229 if (data->info->phases[page] && data->currphase != phase &&
230 !(data->info->func[page] & PMBUS_PHASE_VIRTUAL)) {
232 rv = i2c_smbus_write_byte_data(client, PMBUS_PHASE,
234 pmbus_update_ts(client, true);
238 data->currphase = phase;
242 EXPORT_SYMBOL_NS_GPL(pmbus_set_page, "PMBUS");
244 int pmbus_write_byte(struct i2c_client *client, int page, u8 value)
248 rv = pmbus_set_page(client, page, 0xff);
253 rv = i2c_smbus_write_byte(client, value);
254 pmbus_update_ts(client, true);
258 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte, "PMBUS");
261 * _pmbus_write_byte() is similar to pmbus_write_byte(), but checks if
262 * a device specific mapping function exists and calls it if necessary.
264 static int _pmbus_write_byte(struct i2c_client *client, int page, u8 value)
266 struct pmbus_data *data = i2c_get_clientdata(client);
267 const struct pmbus_driver_info *info = data->info;
270 if (info->write_byte) {
271 status = info->write_byte(client, page, value);
272 if (status != -ENODATA)
275 return pmbus_write_byte(client, page, value);
278 int pmbus_write_word_data(struct i2c_client *client, int page, u8 reg,
283 rv = pmbus_set_page(client, page, 0xff);
288 rv = i2c_smbus_write_word_data(client, reg, word);
289 pmbus_update_ts(client, true);
293 EXPORT_SYMBOL_NS_GPL(pmbus_write_word_data, "PMBUS");
296 static int pmbus_write_virt_reg(struct i2c_client *client, int page, int reg,
304 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
305 id = reg - PMBUS_VIRT_FAN_TARGET_1;
306 bit = pmbus_fan_rpm_mask[id];
307 rv = pmbus_update_fan(client, page, id, bit, bit, word);
318 * _pmbus_write_word_data() is similar to pmbus_write_word_data(), but checks if
319 * a device specific mapping function exists and calls it if necessary.
321 static int _pmbus_write_word_data(struct i2c_client *client, int page, int reg,
324 struct pmbus_data *data = i2c_get_clientdata(client);
325 const struct pmbus_driver_info *info = data->info;
328 if (info->write_word_data) {
329 status = info->write_word_data(client, page, reg, word);
330 if (status != -ENODATA)
334 if (reg >= PMBUS_VIRT_BASE)
335 return pmbus_write_virt_reg(client, page, reg, word);
337 return pmbus_write_word_data(client, page, reg, word);
341 * _pmbus_write_byte_data() is similar to pmbus_write_byte_data(), but checks if
342 * a device specific mapping function exists and calls it if necessary.
344 static int _pmbus_write_byte_data(struct i2c_client *client, int page, int reg, u8 value)
346 struct pmbus_data *data = i2c_get_clientdata(client);
347 const struct pmbus_driver_info *info = data->info;
350 if (info->write_byte_data) {
351 status = info->write_byte_data(client, page, reg, value);
352 if (status != -ENODATA)
355 return pmbus_write_byte_data(client, page, reg, value);
359 * _pmbus_read_byte_data() is similar to pmbus_read_byte_data(), but checks if
360 * a device specific mapping function exists and calls it if necessary.
362 static int _pmbus_read_byte_data(struct i2c_client *client, int page, int reg)
364 struct pmbus_data *data = i2c_get_clientdata(client);
365 const struct pmbus_driver_info *info = data->info;
368 if (info->read_byte_data) {
369 status = info->read_byte_data(client, page, reg);
370 if (status != -ENODATA)
373 return pmbus_read_byte_data(client, page, reg);
376 int pmbus_update_fan(struct i2c_client *client, int page, int id,
377 u8 config, u8 mask, u16 command)
383 from = _pmbus_read_byte_data(client, page,
384 pmbus_fan_config_registers[id]);
388 to = (from & ~mask) | (config & mask);
390 rv = _pmbus_write_byte_data(client, page,
391 pmbus_fan_config_registers[id], to);
396 return _pmbus_write_word_data(client, page,
397 pmbus_fan_command_registers[id], command);
399 EXPORT_SYMBOL_NS_GPL(pmbus_update_fan, "PMBUS");
401 int pmbus_read_word_data(struct i2c_client *client, int page, int phase, u8 reg)
405 rv = pmbus_set_page(client, page, phase);
410 rv = i2c_smbus_read_word_data(client, reg);
411 pmbus_update_ts(client, false);
415 EXPORT_SYMBOL_NS_GPL(pmbus_read_word_data, "PMBUS");
417 static int pmbus_read_virt_reg(struct i2c_client *client, int page, int reg)
423 case PMBUS_VIRT_FAN_TARGET_1 ... PMBUS_VIRT_FAN_TARGET_4:
424 id = reg - PMBUS_VIRT_FAN_TARGET_1;
425 rv = pmbus_get_fan_rate_device(client, page, id, rpm);
436 * _pmbus_read_word_data() is similar to pmbus_read_word_data(), but checks if
437 * a device specific mapping function exists and calls it if necessary.
439 static int _pmbus_read_word_data(struct i2c_client *client, int page,
442 struct pmbus_data *data = i2c_get_clientdata(client);
443 const struct pmbus_driver_info *info = data->info;
446 if (info->read_word_data) {
447 status = info->read_word_data(client, page, phase, reg);
448 if (status != -ENODATA)
452 if (reg >= PMBUS_VIRT_BASE)
453 return pmbus_read_virt_reg(client, page, reg);
455 return pmbus_read_word_data(client, page, phase, reg);
458 /* Same as above, but without phase parameter, for use in check functions */
459 static int __pmbus_read_word_data(struct i2c_client *client, int page, int reg)
461 return _pmbus_read_word_data(client, page, 0xff, reg);
464 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg)
468 rv = pmbus_set_page(client, page, 0xff);
473 rv = i2c_smbus_read_byte_data(client, reg);
474 pmbus_update_ts(client, false);
478 EXPORT_SYMBOL_NS_GPL(pmbus_read_byte_data, "PMBUS");
480 int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, u8 value)
484 rv = pmbus_set_page(client, page, 0xff);
489 rv = i2c_smbus_write_byte_data(client, reg, value);
490 pmbus_update_ts(client, true);
494 EXPORT_SYMBOL_NS_GPL(pmbus_write_byte_data, "PMBUS");
496 int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg,
502 rv = _pmbus_read_byte_data(client, page, reg);
506 tmp = (rv & ~mask) | (value & mask);
509 rv = _pmbus_write_byte_data(client, page, reg, tmp);
513 EXPORT_SYMBOL_NS_GPL(pmbus_update_byte_data, "PMBUS");
515 static int pmbus_read_block_data(struct i2c_client *client, int page, u8 reg,
520 rv = pmbus_set_page(client, page, 0xff);
525 rv = i2c_smbus_read_block_data(client, reg, data_buf);
526 pmbus_update_ts(client, false);
531 static struct pmbus_sensor *pmbus_find_sensor(struct pmbus_data *data, int page,
534 struct pmbus_sensor *sensor;
536 for (sensor = data->sensors; sensor; sensor = sensor->next) {
537 if (sensor->page == page && sensor->reg == reg)
541 return ERR_PTR(-EINVAL);
544 static int pmbus_get_fan_rate(struct i2c_client *client, int page, int id,
545 enum pmbus_fan_mode mode,
548 struct pmbus_data *data = i2c_get_clientdata(client);
549 bool want_rpm, have_rpm;
550 struct pmbus_sensor *s;
554 want_rpm = (mode == rpm);
557 reg = want_rpm ? PMBUS_VIRT_FAN_TARGET_1 : PMBUS_VIRT_PWM_1;
558 s = pmbus_find_sensor(data, page, reg + id);
565 config = _pmbus_read_byte_data(client, page,
566 pmbus_fan_config_registers[id]);
570 have_rpm = !!(config & pmbus_fan_rpm_mask[id]);
571 if (want_rpm == have_rpm)
572 return pmbus_read_word_data(client, page, 0xff,
573 pmbus_fan_command_registers[id]);
575 /* Can't sensibly map between RPM and PWM, just return zero */
579 int pmbus_get_fan_rate_device(struct i2c_client *client, int page, int id,
580 enum pmbus_fan_mode mode)
582 return pmbus_get_fan_rate(client, page, id, mode, false);
584 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_device, "PMBUS");
586 int pmbus_get_fan_rate_cached(struct i2c_client *client, int page, int id,
587 enum pmbus_fan_mode mode)
589 return pmbus_get_fan_rate(client, page, id, mode, true);
591 EXPORT_SYMBOL_NS_GPL(pmbus_get_fan_rate_cached, "PMBUS");
593 static void pmbus_clear_fault_page(struct i2c_client *client, int page)
595 _pmbus_write_byte(client, page, PMBUS_CLEAR_FAULTS);
598 void pmbus_clear_faults(struct i2c_client *client)
600 struct pmbus_data *data = i2c_get_clientdata(client);
603 for (i = 0; i < data->info->pages; i++)
604 pmbus_clear_fault_page(client, i);
606 EXPORT_SYMBOL_NS_GPL(pmbus_clear_faults, "PMBUS");
608 static int pmbus_check_status_cml(struct i2c_client *client)
610 struct pmbus_data *data = i2c_get_clientdata(client);
613 status = data->read_status(client, -1);
614 if (status < 0 || (status & PB_STATUS_CML)) {
615 status2 = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
616 if (status2 < 0 || (status2 & PB_CML_FAULT_INVALID_COMMAND))
622 static bool pmbus_check_register(struct i2c_client *client,
623 int (*func)(struct i2c_client *client,
628 struct pmbus_data *data = i2c_get_clientdata(client);
630 rv = func(client, page, reg);
631 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
632 rv = pmbus_check_status_cml(client);
633 if (rv < 0 && (data->flags & PMBUS_READ_STATUS_AFTER_FAILED_CHECK))
634 data->read_status(client, -1);
635 if (reg < PMBUS_VIRT_BASE)
636 pmbus_clear_fault_page(client, -1);
640 static bool pmbus_check_status_register(struct i2c_client *client, int page)
643 struct pmbus_data *data = i2c_get_clientdata(client);
645 status = data->read_status(client, page);
646 if (status >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK) &&
647 (status & PB_STATUS_CML)) {
648 status = _pmbus_read_byte_data(client, -1, PMBUS_STATUS_CML);
649 if (status < 0 || (status & PB_CML_FAULT_INVALID_COMMAND))
653 pmbus_clear_fault_page(client, -1);
657 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg)
659 return pmbus_check_register(client, _pmbus_read_byte_data, page, reg);
661 EXPORT_SYMBOL_NS_GPL(pmbus_check_byte_register, "PMBUS");
663 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg)
665 return pmbus_check_register(client, __pmbus_read_word_data, page, reg);
667 EXPORT_SYMBOL_NS_GPL(pmbus_check_word_register, "PMBUS");
669 static bool __maybe_unused pmbus_check_block_register(struct i2c_client *client,
673 struct pmbus_data *data = i2c_get_clientdata(client);
674 char data_buf[I2C_SMBUS_BLOCK_MAX + 2];
676 rv = pmbus_read_block_data(client, page, reg, data_buf);
677 if (rv >= 0 && !(data->flags & PMBUS_SKIP_STATUS_CHECK))
678 rv = pmbus_check_status_cml(client);
679 if (rv < 0 && (data->flags & PMBUS_READ_STATUS_AFTER_FAILED_CHECK))
680 data->read_status(client, -1);
681 pmbus_clear_fault_page(client, -1);
685 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client *client)
687 struct pmbus_data *data = i2c_get_clientdata(client);
691 EXPORT_SYMBOL_NS_GPL(pmbus_get_driver_info, "PMBUS");
693 static int pmbus_get_status(struct i2c_client *client, int page, int reg)
695 struct pmbus_data *data = i2c_get_clientdata(client);
699 case PMBUS_STATUS_WORD:
700 status = data->read_status(client, page);
703 status = _pmbus_read_byte_data(client, page, reg);
707 pmbus_clear_faults(client);
711 static void pmbus_update_sensor_data(struct i2c_client *client, struct pmbus_sensor *sensor)
713 if (sensor->data < 0 || sensor->update)
714 sensor->data = _pmbus_read_word_data(client, sensor->page,
715 sensor->phase, sensor->reg);
719 * Convert ieee754 sensor values to milli- or micro-units
720 * depending on sensor type.
722 * ieee754 data format:
724 * bit 10..14: exponent
727 * v=(−1)^signbit * 2^(−14) * 0.significantbits
729 * v=(−1)^signbit * 2^(exponent - 15) * 1.significantbits
733 * Add the number mantissa bits into the calculations for simplicity.
734 * To do that, add '10' to the exponent. By doing that, we can just add
735 * 0x400 to normal values and get the expected result.
737 static long pmbus_reg2data_ieee754(struct pmbus_data *data,
738 struct pmbus_sensor *sensor)
744 /* only support half precision for now */
745 sign = sensor->data & 0x8000;
746 exponent = (sensor->data >> 10) & 0x1f;
747 val = sensor->data & 0x3ff;
749 if (exponent == 0) { /* subnormal */
750 exponent = -(14 + 10);
751 } else if (exponent == 0x1f) { /* NaN, convert to min/max */
755 exponent -= (15 + 10); /* normal */
759 /* scale result to milli-units for all sensors except fans */
760 if (sensor->class != PSC_FAN)
763 /* scale result to micro-units for power sensors */
764 if (sensor->class == PSC_POWER)
779 * Convert linear sensor values to milli- or micro-units
780 * depending on sensor type.
782 static s64 pmbus_reg2data_linear(struct pmbus_data *data,
783 struct pmbus_sensor *sensor)
789 if (sensor->class == PSC_VOLTAGE_OUT) { /* LINEAR16 */
790 exponent = data->exponent[sensor->page];
791 mantissa = (u16) sensor->data;
792 } else { /* LINEAR11 */
793 exponent = ((s16)sensor->data) >> 11;
794 mantissa = ((s16)((sensor->data & 0x7ff) << 5)) >> 5;
799 /* scale result to milli-units for all sensors except fans */
800 if (sensor->class != PSC_FAN)
803 /* scale result to micro-units for power sensors */
804 if (sensor->class == PSC_POWER)
816 * Convert direct sensor values to milli- or micro-units
817 * depending on sensor type.
819 static s64 pmbus_reg2data_direct(struct pmbus_data *data,
820 struct pmbus_sensor *sensor)
822 s64 b, val = (s16)sensor->data;
825 m = data->info->m[sensor->class];
826 b = data->info->b[sensor->class];
827 R = data->info->R[sensor->class];
832 /* X = 1/m * (Y * 10^-R - b) */
834 /* scale result to milli-units for everything but fans */
835 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
840 /* scale result to micro-units for power sensors */
841 if (sensor->class == PSC_POWER) {
851 val = div_s64(val + 5LL, 10L); /* round closest */
855 val = div_s64(val - b, m);
860 * Convert VID sensor values to milli- or micro-units
861 * depending on sensor type.
863 static s64 pmbus_reg2data_vid(struct pmbus_data *data,
864 struct pmbus_sensor *sensor)
866 long val = sensor->data;
869 switch (data->info->vrm_version[sensor->page]) {
871 if (val >= 0x02 && val <= 0xb2)
872 rv = DIV_ROUND_CLOSEST(160000 - (val - 2) * 625, 100);
876 rv = 250 + (val - 1) * 5;
880 rv = 500 + (val - 1) * 10;
884 rv = 200 + (val - 1) * 10;
887 if (val >= 0x0 && val <= 0xd8)
888 rv = DIV_ROUND_CLOSEST(155000 - val * 625, 100);
894 static s64 pmbus_reg2data(struct pmbus_data *data, struct pmbus_sensor *sensor)
898 if (!sensor->convert)
901 switch (data->info->format[sensor->class]) {
903 val = pmbus_reg2data_direct(data, sensor);
906 val = pmbus_reg2data_vid(data, sensor);
909 val = pmbus_reg2data_ieee754(data, sensor);
913 val = pmbus_reg2data_linear(data, sensor);
919 #define MAX_IEEE_MANTISSA (0x7ff * 1000)
920 #define MIN_IEEE_MANTISSA (0x400 * 1000)
922 static u16 pmbus_data2reg_ieee754(struct pmbus_data *data,
923 struct pmbus_sensor *sensor, long val)
925 u16 exponent = (15 + 10);
938 /* Power is in uW. Convert to mW before converting. */
939 if (sensor->class == PSC_POWER)
940 val = DIV_ROUND_CLOSEST(val, 1000L);
943 * For simplicity, convert fan data to milli-units
944 * before calculating the exponent.
946 if (sensor->class == PSC_FAN)
949 /* Reduce large mantissa until it fits into 10 bit */
950 while (val > MAX_IEEE_MANTISSA && exponent < 30) {
955 * Increase small mantissa to generate valid 'normal'
958 while (val < MIN_IEEE_MANTISSA && exponent > 1) {
963 /* Convert mantissa from milli-units to units */
964 mantissa = DIV_ROUND_CLOSEST(val, 1000);
967 * Ensure that the resulting number is within range.
968 * Valid range is 0x400..0x7ff, where bit 10 reflects
969 * the implied high bit in normalized ieee754 numbers.
970 * Set the range to 0x400..0x7ff to reflect this.
971 * The upper bit is then removed by the mask against
972 * 0x3ff in the final assignment.
974 if (mantissa > 0x7ff)
976 else if (mantissa < 0x400)
979 /* Convert to sign, 5 bit exponent, 10 bit mantissa */
980 return sign | (mantissa & 0x3ff) | ((exponent << 10) & 0x7c00);
983 #define MAX_LIN_MANTISSA (1023 * 1000)
984 #define MIN_LIN_MANTISSA (511 * 1000)
986 static u16 pmbus_data2reg_linear(struct pmbus_data *data,
987 struct pmbus_sensor *sensor, s64 val)
989 s16 exponent = 0, mantissa;
990 bool negative = false;
996 if (sensor->class == PSC_VOLTAGE_OUT) {
997 /* LINEAR16 does not support negative voltages */
1002 * For a static exponents, we don't have a choice
1003 * but to adjust the value to it.
1005 if (data->exponent[sensor->page] < 0)
1006 val <<= -data->exponent[sensor->page];
1008 val >>= data->exponent[sensor->page];
1009 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
1010 return clamp_val(val, 0, 0xffff);
1018 /* Power is in uW. Convert to mW before converting. */
1019 if (sensor->class == PSC_POWER)
1020 val = DIV_ROUND_CLOSEST_ULL(val, 1000);
1023 * For simplicity, convert fan data to milli-units
1024 * before calculating the exponent.
1026 if (sensor->class == PSC_FAN)
1029 /* Reduce large mantissa until it fits into 10 bit */
1030 while (val >= MAX_LIN_MANTISSA && exponent < 15) {
1034 /* Increase small mantissa to improve precision */
1035 while (val < MIN_LIN_MANTISSA && exponent > -15) {
1040 /* Convert mantissa from milli-units to units */
1041 mantissa = clamp_val(DIV_ROUND_CLOSEST_ULL(val, 1000), 0, 0x3ff);
1045 mantissa = -mantissa;
1047 /* Convert to 5 bit exponent, 11 bit mantissa */
1048 return (mantissa & 0x7ff) | ((exponent << 11) & 0xf800);
1051 static u16 pmbus_data2reg_direct(struct pmbus_data *data,
1052 struct pmbus_sensor *sensor, s64 val)
1057 m = data->info->m[sensor->class];
1058 b = data->info->b[sensor->class];
1059 R = data->info->R[sensor->class];
1061 /* Power is in uW. Adjust R and b. */
1062 if (sensor->class == PSC_POWER) {
1067 /* Calculate Y = (m * X + b) * 10^R */
1068 if (!(sensor->class == PSC_FAN || sensor->class == PSC_PWM)) {
1069 R -= 3; /* Adjust R and b for data in milli-units */
1079 val = div_s64(val + 5LL, 10L); /* round closest */
1083 return (u16)clamp_val(val, S16_MIN, S16_MAX);
1086 static u16 pmbus_data2reg_vid(struct pmbus_data *data,
1087 struct pmbus_sensor *sensor, s64 val)
1089 val = clamp_val(val, 500, 1600);
1091 return 2 + DIV_ROUND_CLOSEST_ULL((1600LL - val) * 100LL, 625);
1094 static u16 pmbus_data2reg(struct pmbus_data *data,
1095 struct pmbus_sensor *sensor, s64 val)
1099 if (!sensor->convert)
1102 switch (data->info->format[sensor->class]) {
1104 regval = pmbus_data2reg_direct(data, sensor, val);
1107 regval = pmbus_data2reg_vid(data, sensor, val);
1110 regval = pmbus_data2reg_ieee754(data, sensor, val);
1114 regval = pmbus_data2reg_linear(data, sensor, val);
1121 * Return boolean calculated from converted data.
1122 * <index> defines a status register index and mask.
1123 * The mask is in the lower 8 bits, the register index is in bits 8..23.
1125 * The associated pmbus_boolean structure contains optional pointers to two
1126 * sensor attributes. If specified, those attributes are compared against each
1127 * other to determine if a limit has been exceeded.
1129 * If the sensor attribute pointers are NULL, the function returns true if
1130 * (status[reg] & mask) is true.
1132 * If sensor attribute pointers are provided, a comparison against a specified
1133 * limit has to be performed to determine the boolean result.
1134 * In this case, the function returns true if v1 >= v2 (where v1 and v2 are
1135 * sensor values referenced by sensor attribute pointers s1 and s2).
1137 * To determine if an object exceeds upper limits, specify <s1,s2> = <v,limit>.
1138 * To determine if an object exceeds lower limits, specify <s1,s2> = <limit,v>.
1140 * If a negative value is stored in any of the referenced registers, this value
1141 * reflects an error code which will be returned.
1143 static int pmbus_get_boolean(struct i2c_client *client, struct pmbus_boolean *b,
1146 struct pmbus_data *data = i2c_get_clientdata(client);
1147 struct pmbus_sensor *s1 = b->s1;
1148 struct pmbus_sensor *s2 = b->s2;
1149 u16 mask = pb_index_to_mask(index);
1150 u8 page = pb_index_to_page(index);
1151 u16 reg = pb_index_to_reg(index);
1155 mutex_lock(&data->update_lock);
1156 status = pmbus_get_status(client, page, reg);
1163 pmbus_update_sensor_data(client, s1);
1165 pmbus_update_sensor_data(client, s2);
1167 regval = status & mask;
1169 if (data->revision >= PMBUS_REV_12) {
1170 ret = _pmbus_write_byte_data(client, page, reg, regval);
1174 pmbus_clear_fault_page(client, page);
1190 v1 = pmbus_reg2data(data, s1);
1191 v2 = pmbus_reg2data(data, s2);
1192 ret = !!(regval && v1 >= v2);
1197 mutex_unlock(&data->update_lock);
1201 static ssize_t pmbus_show_boolean(struct device *dev,
1202 struct device_attribute *da, char *buf)
1204 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
1205 struct pmbus_boolean *boolean = to_pmbus_boolean(attr);
1206 struct i2c_client *client = to_i2c_client(dev->parent);
1209 val = pmbus_get_boolean(client, boolean, attr->index);
1212 return sysfs_emit(buf, "%d\n", val);
1215 static ssize_t pmbus_show_sensor(struct device *dev,
1216 struct device_attribute *devattr, char *buf)
1218 struct i2c_client *client = to_i2c_client(dev->parent);
1219 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
1220 struct pmbus_data *data = i2c_get_clientdata(client);
1223 mutex_lock(&data->update_lock);
1224 pmbus_update_sensor_data(client, sensor);
1225 if (sensor->data < 0)
1228 ret = sysfs_emit(buf, "%lld\n", pmbus_reg2data(data, sensor));
1229 mutex_unlock(&data->update_lock);
1233 static ssize_t pmbus_set_sensor(struct device *dev,
1234 struct device_attribute *devattr,
1235 const char *buf, size_t count)
1237 struct i2c_client *client = to_i2c_client(dev->parent);
1238 struct pmbus_data *data = i2c_get_clientdata(client);
1239 struct pmbus_sensor *sensor = to_pmbus_sensor(devattr);
1245 if (kstrtos64(buf, 10, &val) < 0)
1248 mutex_lock(&data->update_lock);
1249 regval = pmbus_data2reg(data, sensor, val);
1250 ret = _pmbus_write_word_data(client, sensor->page, sensor->reg, regval);
1254 sensor->data = -ENODATA;
1255 mutex_unlock(&data->update_lock);
1259 static ssize_t pmbus_show_label(struct device *dev,
1260 struct device_attribute *da, char *buf)
1262 struct pmbus_label *label = to_pmbus_label(da);
1264 return sysfs_emit(buf, "%s\n", label->label);
1267 static int pmbus_add_attribute(struct pmbus_data *data, struct attribute *attr)
1269 if (data->num_attributes >= data->max_attributes - 1) {
1270 int new_max_attrs = data->max_attributes + PMBUS_ATTR_ALLOC_SIZE;
1271 void *new_attrs = devm_krealloc_array(data->dev, data->group.attrs,
1272 new_max_attrs, sizeof(void *),
1276 data->group.attrs = new_attrs;
1277 data->max_attributes = new_max_attrs;
1280 data->group.attrs[data->num_attributes++] = attr;
1281 data->group.attrs[data->num_attributes] = NULL;
1285 static void pmbus_dev_attr_init(struct device_attribute *dev_attr,
1288 ssize_t (*show)(struct device *dev,
1289 struct device_attribute *attr,
1291 ssize_t (*store)(struct device *dev,
1292 struct device_attribute *attr,
1293 const char *buf, size_t count))
1295 sysfs_attr_init(&dev_attr->attr);
1296 dev_attr->attr.name = name;
1297 dev_attr->attr.mode = mode;
1298 dev_attr->show = show;
1299 dev_attr->store = store;
1302 static void pmbus_attr_init(struct sensor_device_attribute *a,
1305 ssize_t (*show)(struct device *dev,
1306 struct device_attribute *attr,
1308 ssize_t (*store)(struct device *dev,
1309 struct device_attribute *attr,
1310 const char *buf, size_t count),
1313 pmbus_dev_attr_init(&a->dev_attr, name, mode, show, store);
1317 static int pmbus_add_boolean(struct pmbus_data *data,
1318 const char *name, const char *type, int seq,
1319 struct pmbus_sensor *s1,
1320 struct pmbus_sensor *s2,
1321 u8 page, u16 reg, u16 mask)
1323 struct pmbus_boolean *boolean;
1324 struct sensor_device_attribute *a;
1326 if (WARN((s1 && !s2) || (!s1 && s2), "Bad s1/s2 parameters\n"))
1329 boolean = devm_kzalloc(data->dev, sizeof(*boolean), GFP_KERNEL);
1333 a = &boolean->attribute;
1335 snprintf(boolean->name, sizeof(boolean->name), "%s%d_%s",
1339 pmbus_attr_init(a, boolean->name, 0444, pmbus_show_boolean, NULL,
1340 pb_reg_to_index(page, reg, mask));
1342 return pmbus_add_attribute(data, &a->dev_attr.attr);
1345 /* of thermal for pmbus temperature sensors */
1346 struct pmbus_thermal_data {
1347 struct pmbus_data *pmbus_data;
1348 struct pmbus_sensor *sensor;
1351 static int pmbus_thermal_get_temp(struct thermal_zone_device *tz, int *temp)
1353 struct pmbus_thermal_data *tdata = thermal_zone_device_priv(tz);
1354 struct pmbus_sensor *sensor = tdata->sensor;
1355 struct pmbus_data *pmbus_data = tdata->pmbus_data;
1356 struct i2c_client *client = to_i2c_client(pmbus_data->dev);
1357 struct device *dev = pmbus_data->hwmon_dev;
1361 /* May not even get to hwmon yet */
1366 mutex_lock(&pmbus_data->update_lock);
1367 pmbus_update_sensor_data(client, sensor);
1368 if (sensor->data < 0)
1371 *temp = (int)pmbus_reg2data(pmbus_data, sensor);
1372 mutex_unlock(&pmbus_data->update_lock);
1377 static const struct thermal_zone_device_ops pmbus_thermal_ops = {
1378 .get_temp = pmbus_thermal_get_temp,
1381 static int pmbus_thermal_add_sensor(struct pmbus_data *pmbus_data,
1382 struct pmbus_sensor *sensor, int index)
1384 struct device *dev = pmbus_data->dev;
1385 struct pmbus_thermal_data *tdata;
1386 struct thermal_zone_device *tzd;
1388 tdata = devm_kzalloc(dev, sizeof(*tdata), GFP_KERNEL);
1392 tdata->sensor = sensor;
1393 tdata->pmbus_data = pmbus_data;
1395 tzd = devm_thermal_of_zone_register(dev, index, tdata,
1396 &pmbus_thermal_ops);
1398 * If CONFIG_THERMAL_OF is disabled, this returns -ENODEV,
1399 * so ignore that error but forward any other error.
1401 if (IS_ERR(tzd) && (PTR_ERR(tzd) != -ENODEV))
1402 return PTR_ERR(tzd);
1407 static struct pmbus_sensor *pmbus_add_sensor(struct pmbus_data *data,
1408 const char *name, const char *type,
1409 int seq, int page, int phase,
1411 enum pmbus_sensor_classes class,
1412 bool update, bool readonly,
1415 struct pmbus_sensor *sensor;
1416 struct device_attribute *a;
1418 sensor = devm_kzalloc(data->dev, sizeof(*sensor), GFP_KERNEL);
1421 a = &sensor->attribute;
1424 snprintf(sensor->name, sizeof(sensor->name), "%s%d_%s",
1427 snprintf(sensor->name, sizeof(sensor->name), "%s%d",
1430 if (data->flags & PMBUS_WRITE_PROTECTED)
1433 sensor->page = page;
1434 sensor->phase = phase;
1436 sensor->class = class;
1437 sensor->update = update;
1438 sensor->convert = convert;
1439 sensor->data = -ENODATA;
1440 pmbus_dev_attr_init(a, sensor->name,
1441 readonly ? 0444 : 0644,
1442 pmbus_show_sensor, pmbus_set_sensor);
1444 if (pmbus_add_attribute(data, &a->attr))
1447 sensor->next = data->sensors;
1448 data->sensors = sensor;
1450 /* temperature sensors with _input values are registered with thermal */
1451 if (class == PSC_TEMPERATURE && strcmp(type, "input") == 0)
1452 pmbus_thermal_add_sensor(data, sensor, seq);
1457 static int pmbus_add_label(struct pmbus_data *data,
1458 const char *name, int seq,
1459 const char *lstring, int index, int phase)
1461 struct pmbus_label *label;
1462 struct device_attribute *a;
1464 label = devm_kzalloc(data->dev, sizeof(*label), GFP_KERNEL);
1468 a = &label->attribute;
1470 snprintf(label->name, sizeof(label->name), "%s%d_label", name, seq);
1473 strncpy(label->label, lstring,
1474 sizeof(label->label) - 1);
1476 snprintf(label->label, sizeof(label->label), "%s.%d",
1480 snprintf(label->label, sizeof(label->label), "%s%d",
1483 snprintf(label->label, sizeof(label->label), "%s%d.%d",
1484 lstring, index, phase);
1487 pmbus_dev_attr_init(a, label->name, 0444, pmbus_show_label, NULL);
1488 return pmbus_add_attribute(data, &a->attr);
1492 * Search for attributes. Allocate sensors, booleans, and labels as needed.
1496 * The pmbus_limit_attr structure describes a single limit attribute
1497 * and its associated alarm attribute.
1499 struct pmbus_limit_attr {
1500 u16 reg; /* Limit register */
1501 u16 sbit; /* Alarm attribute status bit */
1502 bool update; /* True if register needs updates */
1503 bool low; /* True if low limit; for limits with compare
1505 const char *attr; /* Attribute name */
1506 const char *alarm; /* Alarm attribute name */
1510 * The pmbus_sensor_attr structure describes one sensor attribute. This
1511 * description includes a reference to the associated limit attributes.
1513 struct pmbus_sensor_attr {
1514 u16 reg; /* sensor register */
1515 u16 gbit; /* generic status bit */
1516 u8 nlimit; /* # of limit registers */
1517 enum pmbus_sensor_classes class;/* sensor class */
1518 const char *label; /* sensor label */
1519 bool paged; /* true if paged sensor */
1520 bool update; /* true if update needed */
1521 bool compare; /* true if compare function needed */
1522 u32 func; /* sensor mask */
1523 u32 sfunc; /* sensor status mask */
1524 int sreg; /* status register */
1525 const struct pmbus_limit_attr *limit;/* limit registers */
1529 * Add a set of limit attributes and, if supported, the associated
1531 * returns 0 if no alarm register found, 1 if an alarm register was found,
1534 static int pmbus_add_limit_attrs(struct i2c_client *client,
1535 struct pmbus_data *data,
1536 const struct pmbus_driver_info *info,
1537 const char *name, int index, int page,
1538 struct pmbus_sensor *base,
1539 const struct pmbus_sensor_attr *attr)
1541 const struct pmbus_limit_attr *l = attr->limit;
1542 int nlimit = attr->nlimit;
1545 struct pmbus_sensor *curr;
1547 for (i = 0; i < nlimit; i++) {
1548 if (pmbus_check_word_register(client, page, l->reg)) {
1549 curr = pmbus_add_sensor(data, name, l->attr, index,
1550 page, 0xff, l->reg, attr->class,
1551 attr->update || l->update,
1555 if (l->sbit && (info->func[page] & attr->sfunc)) {
1556 ret = pmbus_add_boolean(data, name,
1558 attr->compare ? l->low ? curr : base
1560 attr->compare ? l->low ? base : curr
1562 page, attr->sreg, l->sbit);
1573 static int pmbus_add_sensor_attrs_one(struct i2c_client *client,
1574 struct pmbus_data *data,
1575 const struct pmbus_driver_info *info,
1577 int index, int page, int phase,
1578 const struct pmbus_sensor_attr *attr,
1581 struct pmbus_sensor *base;
1582 bool upper = !!(attr->gbit & 0xff00); /* need to check STATUS_WORD */
1586 ret = pmbus_add_label(data, name, index, attr->label,
1587 paged ? page + 1 : 0, phase);
1591 base = pmbus_add_sensor(data, name, "input", index, page, phase,
1592 attr->reg, attr->class, true, true, true);
1595 /* No limit and alarm attributes for phase specific sensors */
1596 if (attr->sfunc && phase == 0xff) {
1597 ret = pmbus_add_limit_attrs(client, data, info, name,
1598 index, page, base, attr);
1602 * Add generic alarm attribute only if there are no individual
1603 * alarm attributes, if there is a global alarm bit, and if
1604 * the generic status register (word or byte, depending on
1605 * which global bit is set) for this page is accessible.
1607 if (!ret && attr->gbit &&
1608 (!upper || data->has_status_word) &&
1609 pmbus_check_status_register(client, page)) {
1610 ret = pmbus_add_boolean(data, name, "alarm", index,
1612 page, PMBUS_STATUS_WORD,
1621 static bool pmbus_sensor_is_paged(const struct pmbus_driver_info *info,
1622 const struct pmbus_sensor_attr *attr)
1630 * Some attributes may be present on more than one page despite
1631 * not being marked with the paged attribute. If that is the case,
1632 * then treat the sensor as being paged and add the page suffix to the
1634 * We don't just add the paged attribute to all such attributes, in
1635 * order to maintain the un-suffixed labels in the case where the
1636 * attribute is only on page 0.
1638 for (p = 1; p < info->pages; p++) {
1639 if (info->func[p] & attr->func)
1645 static int pmbus_add_sensor_attrs(struct i2c_client *client,
1646 struct pmbus_data *data,
1648 const struct pmbus_sensor_attr *attrs,
1651 const struct pmbus_driver_info *info = data->info;
1656 for (i = 0; i < nattrs; i++) {
1658 bool paged = pmbus_sensor_is_paged(info, attrs);
1660 pages = paged ? info->pages : 1;
1661 for (page = 0; page < pages; page++) {
1662 if (info->func[page] & attrs->func) {
1663 ret = pmbus_add_sensor_attrs_one(client, data, info,
1665 0xff, attrs, paged);
1670 if (info->phases[page]) {
1673 for (phase = 0; phase < info->phases[page];
1675 if (!(info->pfunc[phase] & attrs->func))
1677 ret = pmbus_add_sensor_attrs_one(client,
1678 data, info, name, index, page,
1679 phase, attrs, paged);
1691 static const struct pmbus_limit_attr vin_limit_attrs[] = {
1693 .reg = PMBUS_VIN_UV_WARN_LIMIT,
1695 .alarm = "min_alarm",
1696 .sbit = PB_VOLTAGE_UV_WARNING,
1698 .reg = PMBUS_VIN_UV_FAULT_LIMIT,
1700 .alarm = "lcrit_alarm",
1701 .sbit = PB_VOLTAGE_UV_FAULT | PB_VOLTAGE_VIN_OFF,
1703 .reg = PMBUS_VIN_OV_WARN_LIMIT,
1705 .alarm = "max_alarm",
1706 .sbit = PB_VOLTAGE_OV_WARNING,
1708 .reg = PMBUS_VIN_OV_FAULT_LIMIT,
1710 .alarm = "crit_alarm",
1711 .sbit = PB_VOLTAGE_OV_FAULT,
1713 .reg = PMBUS_VIRT_READ_VIN_AVG,
1717 .reg = PMBUS_VIRT_READ_VIN_MIN,
1721 .reg = PMBUS_VIRT_READ_VIN_MAX,
1725 .reg = PMBUS_VIRT_RESET_VIN_HISTORY,
1726 .attr = "reset_history",
1728 .reg = PMBUS_MFR_VIN_MIN,
1729 .attr = "rated_min",
1731 .reg = PMBUS_MFR_VIN_MAX,
1732 .attr = "rated_max",
1736 static const struct pmbus_limit_attr vmon_limit_attrs[] = {
1738 .reg = PMBUS_VIRT_VMON_UV_WARN_LIMIT,
1740 .alarm = "min_alarm",
1741 .sbit = PB_VOLTAGE_UV_WARNING,
1743 .reg = PMBUS_VIRT_VMON_UV_FAULT_LIMIT,
1745 .alarm = "lcrit_alarm",
1746 .sbit = PB_VOLTAGE_UV_FAULT,
1748 .reg = PMBUS_VIRT_VMON_OV_WARN_LIMIT,
1750 .alarm = "max_alarm",
1751 .sbit = PB_VOLTAGE_OV_WARNING,
1753 .reg = PMBUS_VIRT_VMON_OV_FAULT_LIMIT,
1755 .alarm = "crit_alarm",
1756 .sbit = PB_VOLTAGE_OV_FAULT,
1760 static const struct pmbus_limit_attr vout_limit_attrs[] = {
1762 .reg = PMBUS_VOUT_UV_WARN_LIMIT,
1764 .alarm = "min_alarm",
1765 .sbit = PB_VOLTAGE_UV_WARNING,
1767 .reg = PMBUS_VOUT_UV_FAULT_LIMIT,
1769 .alarm = "lcrit_alarm",
1770 .sbit = PB_VOLTAGE_UV_FAULT,
1772 .reg = PMBUS_VOUT_OV_WARN_LIMIT,
1774 .alarm = "max_alarm",
1775 .sbit = PB_VOLTAGE_OV_WARNING,
1777 .reg = PMBUS_VOUT_OV_FAULT_LIMIT,
1779 .alarm = "crit_alarm",
1780 .sbit = PB_VOLTAGE_OV_FAULT,
1782 .reg = PMBUS_VIRT_READ_VOUT_AVG,
1786 .reg = PMBUS_VIRT_READ_VOUT_MIN,
1790 .reg = PMBUS_VIRT_READ_VOUT_MAX,
1794 .reg = PMBUS_VIRT_RESET_VOUT_HISTORY,
1795 .attr = "reset_history",
1797 .reg = PMBUS_MFR_VOUT_MIN,
1798 .attr = "rated_min",
1800 .reg = PMBUS_MFR_VOUT_MAX,
1801 .attr = "rated_max",
1805 static const struct pmbus_sensor_attr voltage_attributes[] = {
1807 .reg = PMBUS_READ_VIN,
1808 .class = PSC_VOLTAGE_IN,
1810 .func = PMBUS_HAVE_VIN,
1811 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1812 .sreg = PMBUS_STATUS_INPUT,
1813 .gbit = PB_STATUS_VIN_UV,
1814 .limit = vin_limit_attrs,
1815 .nlimit = ARRAY_SIZE(vin_limit_attrs),
1817 .reg = PMBUS_VIRT_READ_VMON,
1818 .class = PSC_VOLTAGE_IN,
1820 .func = PMBUS_HAVE_VMON,
1821 .sfunc = PMBUS_HAVE_STATUS_VMON,
1822 .sreg = PMBUS_VIRT_STATUS_VMON,
1823 .limit = vmon_limit_attrs,
1824 .nlimit = ARRAY_SIZE(vmon_limit_attrs),
1826 .reg = PMBUS_READ_VCAP,
1827 .class = PSC_VOLTAGE_IN,
1829 .func = PMBUS_HAVE_VCAP,
1831 .reg = PMBUS_READ_VOUT,
1832 .class = PSC_VOLTAGE_OUT,
1835 .func = PMBUS_HAVE_VOUT,
1836 .sfunc = PMBUS_HAVE_STATUS_VOUT,
1837 .sreg = PMBUS_STATUS_VOUT,
1838 .gbit = PB_STATUS_VOUT_OV,
1839 .limit = vout_limit_attrs,
1840 .nlimit = ARRAY_SIZE(vout_limit_attrs),
1844 /* Current attributes */
1846 static const struct pmbus_limit_attr iin_limit_attrs[] = {
1848 .reg = PMBUS_IIN_OC_WARN_LIMIT,
1850 .alarm = "max_alarm",
1851 .sbit = PB_IIN_OC_WARNING,
1853 .reg = PMBUS_IIN_OC_FAULT_LIMIT,
1855 .alarm = "crit_alarm",
1856 .sbit = PB_IIN_OC_FAULT,
1858 .reg = PMBUS_VIRT_READ_IIN_AVG,
1862 .reg = PMBUS_VIRT_READ_IIN_MIN,
1866 .reg = PMBUS_VIRT_READ_IIN_MAX,
1870 .reg = PMBUS_VIRT_RESET_IIN_HISTORY,
1871 .attr = "reset_history",
1873 .reg = PMBUS_MFR_IIN_MAX,
1874 .attr = "rated_max",
1878 static const struct pmbus_limit_attr iout_limit_attrs[] = {
1880 .reg = PMBUS_IOUT_OC_WARN_LIMIT,
1882 .alarm = "max_alarm",
1883 .sbit = PB_IOUT_OC_WARNING,
1885 .reg = PMBUS_IOUT_UC_FAULT_LIMIT,
1887 .alarm = "lcrit_alarm",
1888 .sbit = PB_IOUT_UC_FAULT,
1890 .reg = PMBUS_IOUT_OC_FAULT_LIMIT,
1892 .alarm = "crit_alarm",
1893 .sbit = PB_IOUT_OC_FAULT,
1895 .reg = PMBUS_VIRT_READ_IOUT_AVG,
1899 .reg = PMBUS_VIRT_READ_IOUT_MIN,
1903 .reg = PMBUS_VIRT_READ_IOUT_MAX,
1907 .reg = PMBUS_VIRT_RESET_IOUT_HISTORY,
1908 .attr = "reset_history",
1910 .reg = PMBUS_MFR_IOUT_MAX,
1911 .attr = "rated_max",
1915 static const struct pmbus_sensor_attr current_attributes[] = {
1917 .reg = PMBUS_READ_IIN,
1918 .class = PSC_CURRENT_IN,
1920 .func = PMBUS_HAVE_IIN,
1921 .sfunc = PMBUS_HAVE_STATUS_INPUT,
1922 .sreg = PMBUS_STATUS_INPUT,
1923 .gbit = PB_STATUS_INPUT,
1924 .limit = iin_limit_attrs,
1925 .nlimit = ARRAY_SIZE(iin_limit_attrs),
1927 .reg = PMBUS_READ_IOUT,
1928 .class = PSC_CURRENT_OUT,
1931 .func = PMBUS_HAVE_IOUT,
1932 .sfunc = PMBUS_HAVE_STATUS_IOUT,
1933 .sreg = PMBUS_STATUS_IOUT,
1934 .gbit = PB_STATUS_IOUT_OC,
1935 .limit = iout_limit_attrs,
1936 .nlimit = ARRAY_SIZE(iout_limit_attrs),
1940 /* Power attributes */
1942 static const struct pmbus_limit_attr pin_limit_attrs[] = {
1944 .reg = PMBUS_PIN_OP_WARN_LIMIT,
1947 .sbit = PB_PIN_OP_WARNING,
1949 .reg = PMBUS_VIRT_READ_PIN_AVG,
1953 .reg = PMBUS_VIRT_READ_PIN_MIN,
1955 .attr = "input_lowest",
1957 .reg = PMBUS_VIRT_READ_PIN_MAX,
1959 .attr = "input_highest",
1961 .reg = PMBUS_VIRT_RESET_PIN_HISTORY,
1962 .attr = "reset_history",
1964 .reg = PMBUS_MFR_PIN_MAX,
1965 .attr = "rated_max",
1969 static const struct pmbus_limit_attr pout_limit_attrs[] = {
1971 .reg = PMBUS_POUT_MAX,
1973 .alarm = "cap_alarm",
1974 .sbit = PB_POWER_LIMITING,
1976 .reg = PMBUS_POUT_OP_WARN_LIMIT,
1978 .alarm = "max_alarm",
1979 .sbit = PB_POUT_OP_WARNING,
1981 .reg = PMBUS_POUT_OP_FAULT_LIMIT,
1983 .alarm = "crit_alarm",
1984 .sbit = PB_POUT_OP_FAULT,
1986 .reg = PMBUS_VIRT_READ_POUT_AVG,
1990 .reg = PMBUS_VIRT_READ_POUT_MIN,
1992 .attr = "input_lowest",
1994 .reg = PMBUS_VIRT_READ_POUT_MAX,
1996 .attr = "input_highest",
1998 .reg = PMBUS_VIRT_RESET_POUT_HISTORY,
1999 .attr = "reset_history",
2001 .reg = PMBUS_MFR_POUT_MAX,
2002 .attr = "rated_max",
2006 static const struct pmbus_sensor_attr power_attributes[] = {
2008 .reg = PMBUS_READ_PIN,
2011 .func = PMBUS_HAVE_PIN,
2012 .sfunc = PMBUS_HAVE_STATUS_INPUT,
2013 .sreg = PMBUS_STATUS_INPUT,
2014 .gbit = PB_STATUS_INPUT,
2015 .limit = pin_limit_attrs,
2016 .nlimit = ARRAY_SIZE(pin_limit_attrs),
2018 .reg = PMBUS_READ_POUT,
2022 .func = PMBUS_HAVE_POUT,
2023 .sfunc = PMBUS_HAVE_STATUS_IOUT,
2024 .sreg = PMBUS_STATUS_IOUT,
2025 .limit = pout_limit_attrs,
2026 .nlimit = ARRAY_SIZE(pout_limit_attrs),
2030 /* Temperature atributes */
2032 static const struct pmbus_limit_attr temp_limit_attrs[] = {
2034 .reg = PMBUS_UT_WARN_LIMIT,
2037 .alarm = "min_alarm",
2038 .sbit = PB_TEMP_UT_WARNING,
2040 .reg = PMBUS_UT_FAULT_LIMIT,
2043 .alarm = "lcrit_alarm",
2044 .sbit = PB_TEMP_UT_FAULT,
2046 .reg = PMBUS_OT_WARN_LIMIT,
2048 .alarm = "max_alarm",
2049 .sbit = PB_TEMP_OT_WARNING,
2051 .reg = PMBUS_OT_FAULT_LIMIT,
2053 .alarm = "crit_alarm",
2054 .sbit = PB_TEMP_OT_FAULT,
2056 .reg = PMBUS_VIRT_READ_TEMP_MIN,
2059 .reg = PMBUS_VIRT_READ_TEMP_AVG,
2062 .reg = PMBUS_VIRT_READ_TEMP_MAX,
2065 .reg = PMBUS_VIRT_RESET_TEMP_HISTORY,
2066 .attr = "reset_history",
2068 .reg = PMBUS_MFR_MAX_TEMP_1,
2069 .attr = "rated_max",
2073 static const struct pmbus_limit_attr temp_limit_attrs2[] = {
2075 .reg = PMBUS_UT_WARN_LIMIT,
2078 .alarm = "min_alarm",
2079 .sbit = PB_TEMP_UT_WARNING,
2081 .reg = PMBUS_UT_FAULT_LIMIT,
2084 .alarm = "lcrit_alarm",
2085 .sbit = PB_TEMP_UT_FAULT,
2087 .reg = PMBUS_OT_WARN_LIMIT,
2089 .alarm = "max_alarm",
2090 .sbit = PB_TEMP_OT_WARNING,
2092 .reg = PMBUS_OT_FAULT_LIMIT,
2094 .alarm = "crit_alarm",
2095 .sbit = PB_TEMP_OT_FAULT,
2097 .reg = PMBUS_VIRT_READ_TEMP2_MIN,
2100 .reg = PMBUS_VIRT_READ_TEMP2_AVG,
2103 .reg = PMBUS_VIRT_READ_TEMP2_MAX,
2106 .reg = PMBUS_VIRT_RESET_TEMP2_HISTORY,
2107 .attr = "reset_history",
2109 .reg = PMBUS_MFR_MAX_TEMP_2,
2110 .attr = "rated_max",
2114 static const struct pmbus_limit_attr temp_limit_attrs3[] = {
2116 .reg = PMBUS_UT_WARN_LIMIT,
2119 .alarm = "min_alarm",
2120 .sbit = PB_TEMP_UT_WARNING,
2122 .reg = PMBUS_UT_FAULT_LIMIT,
2125 .alarm = "lcrit_alarm",
2126 .sbit = PB_TEMP_UT_FAULT,
2128 .reg = PMBUS_OT_WARN_LIMIT,
2130 .alarm = "max_alarm",
2131 .sbit = PB_TEMP_OT_WARNING,
2133 .reg = PMBUS_OT_FAULT_LIMIT,
2135 .alarm = "crit_alarm",
2136 .sbit = PB_TEMP_OT_FAULT,
2138 .reg = PMBUS_MFR_MAX_TEMP_3,
2139 .attr = "rated_max",
2143 static const struct pmbus_sensor_attr temp_attributes[] = {
2145 .reg = PMBUS_READ_TEMPERATURE_1,
2146 .class = PSC_TEMPERATURE,
2150 .func = PMBUS_HAVE_TEMP,
2151 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2152 .sreg = PMBUS_STATUS_TEMPERATURE,
2153 .gbit = PB_STATUS_TEMPERATURE,
2154 .limit = temp_limit_attrs,
2155 .nlimit = ARRAY_SIZE(temp_limit_attrs),
2157 .reg = PMBUS_READ_TEMPERATURE_2,
2158 .class = PSC_TEMPERATURE,
2162 .func = PMBUS_HAVE_TEMP2,
2163 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2164 .sreg = PMBUS_STATUS_TEMPERATURE,
2165 .gbit = PB_STATUS_TEMPERATURE,
2166 .limit = temp_limit_attrs2,
2167 .nlimit = ARRAY_SIZE(temp_limit_attrs2),
2169 .reg = PMBUS_READ_TEMPERATURE_3,
2170 .class = PSC_TEMPERATURE,
2174 .func = PMBUS_HAVE_TEMP3,
2175 .sfunc = PMBUS_HAVE_STATUS_TEMP,
2176 .sreg = PMBUS_STATUS_TEMPERATURE,
2177 .gbit = PB_STATUS_TEMPERATURE,
2178 .limit = temp_limit_attrs3,
2179 .nlimit = ARRAY_SIZE(temp_limit_attrs3),
2183 static const int pmbus_fan_registers[] = {
2184 PMBUS_READ_FAN_SPEED_1,
2185 PMBUS_READ_FAN_SPEED_2,
2186 PMBUS_READ_FAN_SPEED_3,
2187 PMBUS_READ_FAN_SPEED_4
2190 static const int pmbus_fan_status_registers[] = {
2191 PMBUS_STATUS_FAN_12,
2192 PMBUS_STATUS_FAN_12,
2193 PMBUS_STATUS_FAN_34,
2197 static const u32 pmbus_fan_flags[] = {
2204 static const u32 pmbus_fan_status_flags[] = {
2205 PMBUS_HAVE_STATUS_FAN12,
2206 PMBUS_HAVE_STATUS_FAN12,
2207 PMBUS_HAVE_STATUS_FAN34,
2208 PMBUS_HAVE_STATUS_FAN34
2213 /* Precondition: FAN_CONFIG_x_y and FAN_COMMAND_x must exist for the fan ID */
2214 static int pmbus_add_fan_ctrl(struct i2c_client *client,
2215 struct pmbus_data *data, int index, int page, int id,
2218 struct pmbus_sensor *sensor;
2220 sensor = pmbus_add_sensor(data, "fan", "target", index, page,
2221 0xff, PMBUS_VIRT_FAN_TARGET_1 + id, PSC_FAN,
2222 false, false, true);
2227 if (!((data->info->func[page] & PMBUS_HAVE_PWM12) ||
2228 (data->info->func[page] & PMBUS_HAVE_PWM34)))
2231 sensor = pmbus_add_sensor(data, "pwm", NULL, index, page,
2232 0xff, PMBUS_VIRT_PWM_1 + id, PSC_PWM,
2233 false, false, true);
2238 sensor = pmbus_add_sensor(data, "pwm", "enable", index, page,
2239 0xff, PMBUS_VIRT_PWM_ENABLE_1 + id, PSC_PWM,
2240 true, false, false);
2248 static int pmbus_add_fan_attributes(struct i2c_client *client,
2249 struct pmbus_data *data)
2251 const struct pmbus_driver_info *info = data->info;
2256 for (page = 0; page < info->pages; page++) {
2259 for (f = 0; f < ARRAY_SIZE(pmbus_fan_registers); f++) {
2262 if (!(info->func[page] & pmbus_fan_flags[f]))
2265 if (!pmbus_check_word_register(client, page,
2266 pmbus_fan_registers[f]))
2270 * Skip fan if not installed.
2271 * Each fan configuration register covers multiple fans,
2272 * so we have to do some magic.
2274 regval = _pmbus_read_byte_data(client, page,
2275 pmbus_fan_config_registers[f]);
2277 (!(regval & (PB_FAN_1_INSTALLED >> ((f & 1) * 4)))))
2280 if (pmbus_add_sensor(data, "fan", "input", index,
2281 page, 0xff, pmbus_fan_registers[f],
2282 PSC_FAN, true, true, true) == NULL)
2286 if (pmbus_check_word_register(client, page,
2287 pmbus_fan_command_registers[f])) {
2288 ret = pmbus_add_fan_ctrl(client, data, index,
2295 * Each fan status register covers multiple fans,
2296 * so we have to do some magic.
2298 if ((info->func[page] & pmbus_fan_status_flags[f]) &&
2299 pmbus_check_byte_register(client,
2300 page, pmbus_fan_status_registers[f])) {
2303 if (f > 1) /* fan 3, 4 */
2304 reg = PMBUS_STATUS_FAN_34;
2306 reg = PMBUS_STATUS_FAN_12;
2307 ret = pmbus_add_boolean(data, "fan",
2308 "alarm", index, NULL, NULL, page, reg,
2309 PB_FAN_FAN1_WARNING >> (f & 1));
2312 ret = pmbus_add_boolean(data, "fan",
2313 "fault", index, NULL, NULL, page, reg,
2314 PB_FAN_FAN1_FAULT >> (f & 1));
2324 struct pmbus_samples_attr {
2329 struct pmbus_samples_reg {
2331 struct pmbus_samples_attr *attr;
2332 struct device_attribute dev_attr;
2335 static struct pmbus_samples_attr pmbus_samples_registers[] = {
2337 .reg = PMBUS_VIRT_SAMPLES,
2340 .reg = PMBUS_VIRT_IN_SAMPLES,
2341 .name = "in_samples",
2343 .reg = PMBUS_VIRT_CURR_SAMPLES,
2344 .name = "curr_samples",
2346 .reg = PMBUS_VIRT_POWER_SAMPLES,
2347 .name = "power_samples",
2349 .reg = PMBUS_VIRT_TEMP_SAMPLES,
2350 .name = "temp_samples",
2354 #define to_samples_reg(x) container_of(x, struct pmbus_samples_reg, dev_attr)
2356 static ssize_t pmbus_show_samples(struct device *dev,
2357 struct device_attribute *devattr, char *buf)
2360 struct i2c_client *client = to_i2c_client(dev->parent);
2361 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2362 struct pmbus_data *data = i2c_get_clientdata(client);
2364 mutex_lock(&data->update_lock);
2365 val = _pmbus_read_word_data(client, reg->page, 0xff, reg->attr->reg);
2366 mutex_unlock(&data->update_lock);
2370 return sysfs_emit(buf, "%d\n", val);
2373 static ssize_t pmbus_set_samples(struct device *dev,
2374 struct device_attribute *devattr,
2375 const char *buf, size_t count)
2379 struct i2c_client *client = to_i2c_client(dev->parent);
2380 struct pmbus_samples_reg *reg = to_samples_reg(devattr);
2381 struct pmbus_data *data = i2c_get_clientdata(client);
2383 if (kstrtol(buf, 0, &val) < 0)
2386 mutex_lock(&data->update_lock);
2387 ret = _pmbus_write_word_data(client, reg->page, reg->attr->reg, val);
2388 mutex_unlock(&data->update_lock);
2390 return ret ? : count;
2393 static int pmbus_add_samples_attr(struct pmbus_data *data, int page,
2394 struct pmbus_samples_attr *attr)
2396 struct pmbus_samples_reg *reg;
2398 reg = devm_kzalloc(data->dev, sizeof(*reg), GFP_KERNEL);
2405 pmbus_dev_attr_init(®->dev_attr, attr->name, 0644,
2406 pmbus_show_samples, pmbus_set_samples);
2408 return pmbus_add_attribute(data, ®->dev_attr.attr);
2411 static int pmbus_add_samples_attributes(struct i2c_client *client,
2412 struct pmbus_data *data)
2414 const struct pmbus_driver_info *info = data->info;
2417 if (!(info->func[0] & PMBUS_HAVE_SAMPLES))
2420 for (s = 0; s < ARRAY_SIZE(pmbus_samples_registers); s++) {
2421 struct pmbus_samples_attr *attr;
2424 attr = &pmbus_samples_registers[s];
2425 if (!pmbus_check_word_register(client, 0, attr->reg))
2428 ret = pmbus_add_samples_attr(data, 0, attr);
2436 static int pmbus_find_attributes(struct i2c_client *client,
2437 struct pmbus_data *data)
2441 /* Voltage sensors */
2442 ret = pmbus_add_sensor_attrs(client, data, "in", voltage_attributes,
2443 ARRAY_SIZE(voltage_attributes));
2447 /* Current sensors */
2448 ret = pmbus_add_sensor_attrs(client, data, "curr", current_attributes,
2449 ARRAY_SIZE(current_attributes));
2454 ret = pmbus_add_sensor_attrs(client, data, "power", power_attributes,
2455 ARRAY_SIZE(power_attributes));
2459 /* Temperature sensors */
2460 ret = pmbus_add_sensor_attrs(client, data, "temp", temp_attributes,
2461 ARRAY_SIZE(temp_attributes));
2466 ret = pmbus_add_fan_attributes(client, data);
2470 ret = pmbus_add_samples_attributes(client, data);
2475 * The pmbus_class_attr_map structure maps one sensor class to
2476 * it's corresponding sensor attributes array.
2478 struct pmbus_class_attr_map {
2479 enum pmbus_sensor_classes class;
2481 const struct pmbus_sensor_attr *attr;
2484 static const struct pmbus_class_attr_map class_attr_map[] = {
2486 .class = PSC_VOLTAGE_IN,
2487 .attr = voltage_attributes,
2488 .nattr = ARRAY_SIZE(voltage_attributes),
2490 .class = PSC_VOLTAGE_OUT,
2491 .attr = voltage_attributes,
2492 .nattr = ARRAY_SIZE(voltage_attributes),
2494 .class = PSC_CURRENT_IN,
2495 .attr = current_attributes,
2496 .nattr = ARRAY_SIZE(current_attributes),
2498 .class = PSC_CURRENT_OUT,
2499 .attr = current_attributes,
2500 .nattr = ARRAY_SIZE(current_attributes),
2503 .attr = power_attributes,
2504 .nattr = ARRAY_SIZE(power_attributes),
2506 .class = PSC_TEMPERATURE,
2507 .attr = temp_attributes,
2508 .nattr = ARRAY_SIZE(temp_attributes),
2513 * Read the coefficients for direct mode.
2515 static int pmbus_read_coefficients(struct i2c_client *client,
2516 struct pmbus_driver_info *info,
2517 const struct pmbus_sensor_attr *attr)
2520 union i2c_smbus_data data;
2521 enum pmbus_sensor_classes class = attr->class;
2526 data.block[1] = attr->reg;
2527 data.block[2] = 0x01;
2530 rv = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2531 I2C_SMBUS_WRITE, PMBUS_COEFFICIENTS,
2532 I2C_SMBUS_BLOCK_PROC_CALL, &data);
2533 pmbus_update_ts(client, true);
2538 if (data.block[0] != 5)
2541 m = data.block[1] | (data.block[2] << 8);
2542 b = data.block[3] | (data.block[4] << 8);
2551 static int pmbus_init_coefficients(struct i2c_client *client,
2552 struct pmbus_driver_info *info)
2554 int i, n, ret = -EINVAL;
2555 const struct pmbus_class_attr_map *map;
2556 const struct pmbus_sensor_attr *attr;
2558 for (i = 0; i < ARRAY_SIZE(class_attr_map); i++) {
2559 map = &class_attr_map[i];
2560 if (info->format[map->class] != direct)
2562 for (n = 0; n < map->nattr; n++) {
2563 attr = &map->attr[n];
2564 if (map->class != attr->class)
2566 ret = pmbus_read_coefficients(client, info, attr);
2571 dev_err(&client->dev,
2572 "No coefficients found for sensor class %d\n",
2582 * Identify chip parameters.
2583 * This function is called for all chips.
2585 static int pmbus_identify_common(struct i2c_client *client,
2586 struct pmbus_data *data, int page)
2590 if (pmbus_check_byte_register(client, page, PMBUS_VOUT_MODE))
2591 vout_mode = _pmbus_read_byte_data(client, page,
2593 if (vout_mode >= 0 && vout_mode != 0xff) {
2595 * Not all chips support the VOUT_MODE command,
2596 * so a failure to read it is not an error.
2598 switch (vout_mode >> 5) {
2599 case 0: /* linear mode */
2600 if (data->info->format[PSC_VOLTAGE_OUT] != linear)
2603 data->exponent[page] = ((s8)(vout_mode << 3)) >> 3;
2605 case 1: /* VID mode */
2606 if (data->info->format[PSC_VOLTAGE_OUT] != vid)
2609 case 2: /* direct mode */
2610 if (data->info->format[PSC_VOLTAGE_OUT] != direct)
2613 case 3: /* ieee 754 half precision */
2614 if (data->info->format[PSC_VOLTAGE_OUT] != ieee754)
2625 static int pmbus_read_status_byte(struct i2c_client *client, int page)
2627 return _pmbus_read_byte_data(client, page, PMBUS_STATUS_BYTE);
2630 static int pmbus_read_status_word(struct i2c_client *client, int page)
2632 return _pmbus_read_word_data(client, page, 0xff, PMBUS_STATUS_WORD);
2635 /* PEC attribute support */
2637 static ssize_t pec_show(struct device *dev, struct device_attribute *dummy,
2640 struct i2c_client *client = to_i2c_client(dev);
2642 return sysfs_emit(buf, "%d\n", !!(client->flags & I2C_CLIENT_PEC));
2645 static ssize_t pec_store(struct device *dev, struct device_attribute *dummy,
2646 const char *buf, size_t count)
2648 struct i2c_client *client = to_i2c_client(dev);
2652 err = kstrtobool(buf, &enable);
2657 client->flags |= I2C_CLIENT_PEC;
2659 client->flags &= ~I2C_CLIENT_PEC;
2664 static DEVICE_ATTR_RW(pec);
2666 static void pmbus_remove_pec(void *dev)
2668 device_remove_file(dev, &dev_attr_pec);
2671 static void pmbus_init_wp(struct i2c_client *client, struct pmbus_data *data)
2677 _pmbus_write_byte_data(client, -1,
2678 PMBUS_WRITE_PROTECT, 0);
2682 _pmbus_write_byte_data(client, -1,
2683 PMBUS_WRITE_PROTECT, PB_WP_VOUT);
2687 _pmbus_write_byte_data(client, -1,
2688 PMBUS_WRITE_PROTECT, PB_WP_OP);
2692 _pmbus_write_byte_data(client, -1,
2693 PMBUS_WRITE_PROTECT, PB_WP_ALL);
2697 /* Ignore the other values */
2701 ret = _pmbus_read_byte_data(client, -1, PMBUS_WRITE_PROTECT);
2705 switch (ret & PB_WP_ANY) {
2707 data->flags |= PMBUS_OP_PROTECTED;
2710 data->flags |= PMBUS_VOUT_PROTECTED;
2713 data->flags |= PMBUS_WRITE_PROTECTED | PMBUS_SKIP_STATUS_CHECK;
2721 static int pmbus_init_common(struct i2c_client *client, struct pmbus_data *data,
2722 struct pmbus_driver_info *info)
2724 struct device *dev = &client->dev;
2728 * Figure out if PEC is enabled before accessing any other register.
2729 * Make sure PEC is disabled, will be enabled later if needed.
2731 client->flags &= ~I2C_CLIENT_PEC;
2733 /* Enable PEC if the controller and bus supports it */
2734 if (!(data->flags & PMBUS_NO_CAPABILITY)) {
2736 ret = i2c_smbus_read_byte_data(client, PMBUS_CAPABILITY);
2737 pmbus_update_ts(client, false);
2739 if (ret >= 0 && (ret & PB_CAPABILITY_ERROR_CHECK)) {
2740 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_PEC))
2741 client->flags |= I2C_CLIENT_PEC;
2746 * Some PMBus chips don't support PMBUS_STATUS_WORD, so try
2747 * to use PMBUS_STATUS_BYTE instead if that is the case.
2748 * Bail out if both registers are not supported.
2750 data->read_status = pmbus_read_status_word;
2752 ret = i2c_smbus_read_word_data(client, PMBUS_STATUS_WORD);
2753 pmbus_update_ts(client, false);
2755 if (ret < 0 || ret == 0xffff) {
2756 data->read_status = pmbus_read_status_byte;
2758 ret = i2c_smbus_read_byte_data(client, PMBUS_STATUS_BYTE);
2759 pmbus_update_ts(client, false);
2761 if (ret < 0 || ret == 0xff) {
2762 dev_err(dev, "PMBus status register not found\n");
2766 data->has_status_word = true;
2770 * Check if the chip is write protected. If it is, we can not clear
2771 * faults, and we should not try it. Also, in that case, writes into
2772 * limit registers need to be disabled.
2774 if (!(data->flags & PMBUS_NO_WRITE_PROTECT))
2775 pmbus_init_wp(client, data);
2777 ret = i2c_smbus_read_byte_data(client, PMBUS_REVISION);
2779 data->revision = ret;
2781 if (data->info->pages)
2782 pmbus_clear_faults(client);
2784 pmbus_clear_fault_page(client, -1);
2786 if (info->identify) {
2787 ret = (*info->identify)(client, info);
2789 dev_err(dev, "Chip identification failed\n");
2794 if (info->pages <= 0 || info->pages > PMBUS_PAGES) {
2795 dev_err(dev, "Bad number of PMBus pages: %d\n", info->pages);
2799 for (page = 0; page < info->pages; page++) {
2800 ret = pmbus_identify_common(client, data, page);
2802 dev_err(dev, "Failed to identify chip capabilities\n");
2807 if (data->flags & PMBUS_USE_COEFFICIENTS_CMD) {
2808 if (!i2c_check_functionality(client->adapter,
2809 I2C_FUNC_SMBUS_BLOCK_PROC_CALL))
2812 ret = pmbus_init_coefficients(client, info);
2817 if (client->flags & I2C_CLIENT_PEC) {
2819 * If I2C_CLIENT_PEC is set here, both the I2C adapter and the
2820 * chip support PEC. Add 'pec' attribute to client device to let
2821 * the user control it.
2823 ret = device_create_file(dev, &dev_attr_pec);
2826 ret = devm_add_action_or_reset(dev, pmbus_remove_pec, dev);
2834 /* A PMBus status flag and the corresponding REGULATOR_ERROR_* and REGULATOR_EVENTS_* flag */
2835 struct pmbus_status_assoc {
2836 int pflag, rflag, eflag;
2839 /* PMBus->regulator bit mappings for a PMBus status register */
2840 struct pmbus_status_category {
2843 const struct pmbus_status_assoc *bits; /* zero-terminated */
2846 static const struct pmbus_status_category __maybe_unused pmbus_status_flag_map[] = {
2848 .func = PMBUS_HAVE_STATUS_VOUT,
2849 .reg = PMBUS_STATUS_VOUT,
2850 .bits = (const struct pmbus_status_assoc[]) {
2851 { PB_VOLTAGE_UV_WARNING, REGULATOR_ERROR_UNDER_VOLTAGE_WARN,
2852 REGULATOR_EVENT_UNDER_VOLTAGE_WARN },
2853 { PB_VOLTAGE_UV_FAULT, REGULATOR_ERROR_UNDER_VOLTAGE,
2854 REGULATOR_EVENT_UNDER_VOLTAGE },
2855 { PB_VOLTAGE_OV_WARNING, REGULATOR_ERROR_OVER_VOLTAGE_WARN,
2856 REGULATOR_EVENT_OVER_VOLTAGE_WARN },
2857 { PB_VOLTAGE_OV_FAULT, REGULATOR_ERROR_REGULATION_OUT,
2858 REGULATOR_EVENT_OVER_VOLTAGE_WARN },
2862 .func = PMBUS_HAVE_STATUS_IOUT,
2863 .reg = PMBUS_STATUS_IOUT,
2864 .bits = (const struct pmbus_status_assoc[]) {
2865 { PB_IOUT_OC_WARNING, REGULATOR_ERROR_OVER_CURRENT_WARN,
2866 REGULATOR_EVENT_OVER_CURRENT_WARN },
2867 { PB_IOUT_OC_FAULT, REGULATOR_ERROR_OVER_CURRENT,
2868 REGULATOR_EVENT_OVER_CURRENT },
2869 { PB_IOUT_OC_LV_FAULT, REGULATOR_ERROR_OVER_CURRENT,
2870 REGULATOR_EVENT_OVER_CURRENT },
2874 .func = PMBUS_HAVE_STATUS_TEMP,
2875 .reg = PMBUS_STATUS_TEMPERATURE,
2876 .bits = (const struct pmbus_status_assoc[]) {
2877 { PB_TEMP_OT_WARNING, REGULATOR_ERROR_OVER_TEMP_WARN,
2878 REGULATOR_EVENT_OVER_TEMP_WARN },
2879 { PB_TEMP_OT_FAULT, REGULATOR_ERROR_OVER_TEMP,
2880 REGULATOR_EVENT_OVER_TEMP },
2886 static int _pmbus_is_enabled(struct i2c_client *client, u8 page)
2890 ret = _pmbus_read_byte_data(client, page, PMBUS_OPERATION);
2895 return !!(ret & PB_OPERATION_CONTROL_ON);
2898 static int __maybe_unused pmbus_is_enabled(struct i2c_client *client, u8 page)
2900 struct pmbus_data *data = i2c_get_clientdata(client);
2903 mutex_lock(&data->update_lock);
2904 ret = _pmbus_is_enabled(client, page);
2905 mutex_unlock(&data->update_lock);
2910 #define to_dev_attr(_dev_attr) \
2911 container_of(_dev_attr, struct device_attribute, attr)
2913 static void pmbus_notify(struct pmbus_data *data, int page, int reg, int flags)
2917 for (i = 0; i < data->num_attributes; i++) {
2918 struct device_attribute *da = to_dev_attr(data->group.attrs[i]);
2919 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
2920 int index = attr->index;
2921 u16 smask = pb_index_to_mask(index);
2922 u8 spage = pb_index_to_page(index);
2923 u16 sreg = pb_index_to_reg(index);
2925 if (reg == sreg && page == spage && (smask & flags)) {
2926 dev_dbg(data->dev, "sysfs notify: %s", da->attr.name);
2927 sysfs_notify(&data->dev->kobj, NULL, da->attr.name);
2928 kobject_uevent(&data->dev->kobj, KOBJ_CHANGE);
2937 static int _pmbus_get_flags(struct pmbus_data *data, u8 page, unsigned int *flags,
2938 unsigned int *event, bool notify)
2941 const struct pmbus_status_category *cat;
2942 const struct pmbus_status_assoc *bit;
2943 struct device *dev = data->dev;
2944 struct i2c_client *client = to_i2c_client(dev);
2945 int func = data->info->func[page];
2950 for (i = 0; i < ARRAY_SIZE(pmbus_status_flag_map); i++) {
2951 cat = &pmbus_status_flag_map[i];
2952 if (!(func & cat->func))
2955 status = _pmbus_read_byte_data(client, page, cat->reg);
2959 for (bit = cat->bits; bit->pflag; bit++)
2960 if (status & bit->pflag) {
2961 *flags |= bit->rflag;
2962 *event |= bit->eflag;
2965 if (notify && status)
2966 pmbus_notify(data, page, cat->reg, status);
2971 * Map what bits of STATUS_{WORD,BYTE} we can to REGULATOR_ERROR_*
2972 * bits. Some of the other bits are tempting (especially for cases
2973 * where we don't have the relevant PMBUS_HAVE_STATUS_*
2974 * functionality), but there's an unfortunate ambiguity in that
2975 * they're defined as indicating a fault *or* a warning, so we can't
2976 * easily determine whether to report REGULATOR_ERROR_<foo> or
2977 * REGULATOR_ERROR_<foo>_WARN.
2979 status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
2983 if (_pmbus_is_enabled(client, page)) {
2984 if (status & PB_STATUS_OFF) {
2985 *flags |= REGULATOR_ERROR_FAIL;
2986 *event |= REGULATOR_EVENT_FAIL;
2989 if (status & PB_STATUS_POWER_GOOD_N) {
2990 *flags |= REGULATOR_ERROR_REGULATION_OUT;
2991 *event |= REGULATOR_EVENT_REGULATION_OUT;
2995 * Unlike most other status bits, PB_STATUS_{IOUT_OC,VOUT_OV} are
2996 * defined strictly as fault indicators (not warnings).
2998 if (status & PB_STATUS_IOUT_OC) {
2999 *flags |= REGULATOR_ERROR_OVER_CURRENT;
3000 *event |= REGULATOR_EVENT_OVER_CURRENT;
3002 if (status & PB_STATUS_VOUT_OV) {
3003 *flags |= REGULATOR_ERROR_REGULATION_OUT;
3004 *event |= REGULATOR_EVENT_FAIL;
3008 * If we haven't discovered any thermal faults or warnings via
3009 * PMBUS_STATUS_TEMPERATURE, map PB_STATUS_TEMPERATURE to a warning as
3010 * a (conservative) best-effort interpretation.
3012 if (!(*flags & (REGULATOR_ERROR_OVER_TEMP | REGULATOR_ERROR_OVER_TEMP_WARN)) &&
3013 (status & PB_STATUS_TEMPERATURE)) {
3014 *flags |= REGULATOR_ERROR_OVER_TEMP_WARN;
3015 *event |= REGULATOR_EVENT_OVER_TEMP_WARN;
3022 static int __maybe_unused pmbus_get_flags(struct pmbus_data *data, u8 page, unsigned int *flags,
3023 unsigned int *event, bool notify)
3027 mutex_lock(&data->update_lock);
3028 ret = _pmbus_get_flags(data, page, flags, event, notify);
3029 mutex_unlock(&data->update_lock);
3034 #if IS_ENABLED(CONFIG_REGULATOR)
3035 static int pmbus_regulator_is_enabled(struct regulator_dev *rdev)
3037 struct device *dev = rdev_get_dev(rdev);
3038 struct i2c_client *client = to_i2c_client(dev->parent);
3040 return pmbus_is_enabled(client, rdev_get_id(rdev));
3043 static int _pmbus_regulator_on_off(struct regulator_dev *rdev, bool enable)
3045 struct device *dev = rdev_get_dev(rdev);
3046 struct i2c_client *client = to_i2c_client(dev->parent);
3047 struct pmbus_data *data = i2c_get_clientdata(client);
3048 u8 page = rdev_get_id(rdev);
3051 mutex_lock(&data->update_lock);
3052 ret = pmbus_update_byte_data(client, page, PMBUS_OPERATION,
3053 PB_OPERATION_CONTROL_ON,
3054 enable ? PB_OPERATION_CONTROL_ON : 0);
3055 mutex_unlock(&data->update_lock);
3060 static int pmbus_regulator_enable(struct regulator_dev *rdev)
3062 return _pmbus_regulator_on_off(rdev, 1);
3065 static int pmbus_regulator_disable(struct regulator_dev *rdev)
3067 return _pmbus_regulator_on_off(rdev, 0);
3070 static int pmbus_regulator_get_error_flags(struct regulator_dev *rdev, unsigned int *flags)
3072 struct device *dev = rdev_get_dev(rdev);
3073 struct i2c_client *client = to_i2c_client(dev->parent);
3074 struct pmbus_data *data = i2c_get_clientdata(client);
3077 return pmbus_get_flags(data, rdev_get_id(rdev), flags, &event, false);
3080 static int pmbus_regulator_get_status(struct regulator_dev *rdev)
3082 struct device *dev = rdev_get_dev(rdev);
3083 struct i2c_client *client = to_i2c_client(dev->parent);
3084 struct pmbus_data *data = i2c_get_clientdata(client);
3085 u8 page = rdev_get_id(rdev);
3089 mutex_lock(&data->update_lock);
3090 status = pmbus_get_status(client, page, PMBUS_STATUS_WORD);
3096 if (status & PB_STATUS_OFF) {
3097 ret = REGULATOR_STATUS_OFF;
3101 /* If regulator is ON & reports power good then return ON */
3102 if (!(status & PB_STATUS_POWER_GOOD_N)) {
3103 ret = REGULATOR_STATUS_ON;
3107 ret = _pmbus_get_flags(data, rdev_get_id(rdev), &status, &event, false);
3111 if (status & (REGULATOR_ERROR_UNDER_VOLTAGE | REGULATOR_ERROR_OVER_CURRENT |
3112 REGULATOR_ERROR_REGULATION_OUT | REGULATOR_ERROR_FAIL | REGULATOR_ERROR_OVER_TEMP)) {
3113 ret = REGULATOR_STATUS_ERROR;
3117 ret = REGULATOR_STATUS_UNDEFINED;
3120 mutex_unlock(&data->update_lock);
3124 static int pmbus_regulator_get_low_margin(struct i2c_client *client, int page)
3126 struct pmbus_data *data = i2c_get_clientdata(client);
3127 struct pmbus_sensor s = {
3129 .class = PSC_VOLTAGE_OUT,
3134 if (data->vout_low[page] < 0) {
3135 if (pmbus_check_word_register(client, page, PMBUS_MFR_VOUT_MIN))
3136 s.data = _pmbus_read_word_data(client, page, 0xff,
3137 PMBUS_MFR_VOUT_MIN);
3139 s.data = _pmbus_read_word_data(client, page, 0xff,
3140 PMBUS_VOUT_MARGIN_LOW);
3144 data->vout_low[page] = pmbus_reg2data(data, &s);
3147 return data->vout_low[page];
3150 static int pmbus_regulator_get_high_margin(struct i2c_client *client, int page)
3152 struct pmbus_data *data = i2c_get_clientdata(client);
3153 struct pmbus_sensor s = {
3155 .class = PSC_VOLTAGE_OUT,
3160 if (data->vout_high[page] < 0) {
3161 if (pmbus_check_word_register(client, page, PMBUS_MFR_VOUT_MAX))
3162 s.data = _pmbus_read_word_data(client, page, 0xff,
3163 PMBUS_MFR_VOUT_MAX);
3165 s.data = _pmbus_read_word_data(client, page, 0xff,
3166 PMBUS_VOUT_MARGIN_HIGH);
3170 data->vout_high[page] = pmbus_reg2data(data, &s);
3173 return data->vout_high[page];
3176 static int pmbus_regulator_get_voltage(struct regulator_dev *rdev)
3178 struct device *dev = rdev_get_dev(rdev);
3179 struct i2c_client *client = to_i2c_client(dev->parent);
3180 struct pmbus_data *data = i2c_get_clientdata(client);
3181 struct pmbus_sensor s = {
3182 .page = rdev_get_id(rdev),
3183 .class = PSC_VOLTAGE_OUT,
3187 s.data = _pmbus_read_word_data(client, s.page, 0xff, PMBUS_READ_VOUT);
3191 return (int)pmbus_reg2data(data, &s) * 1000; /* unit is uV */
3194 static int pmbus_regulator_set_voltage(struct regulator_dev *rdev, int min_uv,
3195 int max_uv, unsigned int *selector)
3197 struct device *dev = rdev_get_dev(rdev);
3198 struct i2c_client *client = to_i2c_client(dev->parent);
3199 struct pmbus_data *data = i2c_get_clientdata(client);
3200 struct pmbus_sensor s = {
3201 .page = rdev_get_id(rdev),
3202 .class = PSC_VOLTAGE_OUT,
3206 int val = DIV_ROUND_CLOSEST(min_uv, 1000); /* convert to mV */
3211 low = pmbus_regulator_get_low_margin(client, s.page);
3215 high = pmbus_regulator_get_high_margin(client, s.page);
3219 /* Make sure we are within margins */
3225 val = pmbus_data2reg(data, &s, val);
3227 return _pmbus_write_word_data(client, s.page, PMBUS_VOUT_COMMAND, (u16)val);
3230 static int pmbus_regulator_list_voltage(struct regulator_dev *rdev,
3231 unsigned int selector)
3233 struct device *dev = rdev_get_dev(rdev);
3234 struct i2c_client *client = to_i2c_client(dev->parent);
3235 struct pmbus_data *data = i2c_get_clientdata(client);
3238 if (data->flags & PMBUS_VOUT_PROTECTED)
3241 if (selector >= rdev->desc->n_voltages ||
3242 selector < rdev->desc->linear_min_sel)
3245 selector -= rdev->desc->linear_min_sel;
3246 val = DIV_ROUND_CLOSEST(rdev->desc->min_uV +
3247 (rdev->desc->uV_step * selector), 1000); /* convert to mV */
3249 low = pmbus_regulator_get_low_margin(client, rdev_get_id(rdev));
3253 high = pmbus_regulator_get_high_margin(client, rdev_get_id(rdev));
3257 if (val >= low && val <= high)
3258 return val * 1000; /* unit is uV */
3263 const struct regulator_ops pmbus_regulator_ops = {
3264 .enable = pmbus_regulator_enable,
3265 .disable = pmbus_regulator_disable,
3266 .is_enabled = pmbus_regulator_is_enabled,
3267 .get_error_flags = pmbus_regulator_get_error_flags,
3268 .get_status = pmbus_regulator_get_status,
3269 .get_voltage = pmbus_regulator_get_voltage,
3270 .set_voltage = pmbus_regulator_set_voltage,
3271 .list_voltage = pmbus_regulator_list_voltage,
3273 EXPORT_SYMBOL_NS_GPL(pmbus_regulator_ops, "PMBUS");
3275 int pmbus_regulator_init_cb(struct regulator_dev *rdev,
3276 struct regulator_config *config)
3278 struct pmbus_data *data = config->driver_data;
3279 struct regulation_constraints *constraints = rdev->constraints;
3281 if (data->flags & PMBUS_OP_PROTECTED)
3282 constraints->valid_ops_mask &= ~REGULATOR_CHANGE_STATUS;
3284 if (data->flags & PMBUS_VOUT_PROTECTED)
3285 constraints->valid_ops_mask &= ~REGULATOR_CHANGE_VOLTAGE;
3289 EXPORT_SYMBOL_NS_GPL(pmbus_regulator_init_cb, "PMBUS");
3291 static int pmbus_regulator_register(struct pmbus_data *data)
3293 struct device *dev = data->dev;
3294 const struct pmbus_driver_info *info = data->info;
3295 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
3298 data->rdevs = devm_kzalloc(dev, sizeof(struct regulator_dev *) * info->num_regulators,
3303 for (i = 0; i < info->num_regulators; i++) {
3304 struct regulator_config config = { };
3307 config.driver_data = data;
3309 if (pdata && pdata->reg_init_data)
3310 config.init_data = &pdata->reg_init_data[i];
3312 data->rdevs[i] = devm_regulator_register(dev, &info->reg_desc[i],
3314 if (IS_ERR(data->rdevs[i]))
3315 return dev_err_probe(dev, PTR_ERR(data->rdevs[i]),
3316 "Failed to register %s regulator\n",
3317 info->reg_desc[i].name);
3323 static int pmbus_regulator_notify(struct pmbus_data *data, int page, int event)
3327 for (j = 0; j < data->info->num_regulators; j++) {
3328 if (page == rdev_get_id(data->rdevs[j])) {
3329 regulator_notifier_call_chain(data->rdevs[j], event, NULL);
3336 static int pmbus_regulator_register(struct pmbus_data *data)
3341 static int pmbus_regulator_notify(struct pmbus_data *data, int page, int event)
3347 static int pmbus_write_smbalert_mask(struct i2c_client *client, u8 page, u8 reg, u8 val)
3351 ret = _pmbus_write_word_data(client, page, PMBUS_SMBALERT_MASK, reg | (val << 8));
3354 * Clear fault systematically in case writing PMBUS_SMBALERT_MASK
3355 * is not supported by the chip.
3357 pmbus_clear_fault_page(client, page);
3362 static irqreturn_t pmbus_fault_handler(int irq, void *pdata)
3364 struct pmbus_data *data = pdata;
3365 struct i2c_client *client = to_i2c_client(data->dev);
3367 int i, status, event;
3368 mutex_lock(&data->update_lock);
3369 for (i = 0; i < data->info->pages; i++) {
3370 _pmbus_get_flags(data, i, &status, &event, true);
3373 pmbus_regulator_notify(data, i, event);
3376 pmbus_clear_faults(client);
3377 mutex_unlock(&data->update_lock);
3382 static int pmbus_irq_setup(struct i2c_client *client, struct pmbus_data *data)
3384 struct device *dev = &client->dev;
3385 const struct pmbus_status_category *cat;
3386 const struct pmbus_status_assoc *bit;
3387 int i, j, err, func;
3390 static const u8 misc_status[] = {PMBUS_STATUS_CML, PMBUS_STATUS_OTHER,
3391 PMBUS_STATUS_MFR_SPECIFIC, PMBUS_STATUS_FAN_12,
3392 PMBUS_STATUS_FAN_34};
3397 for (i = 0; i < data->info->pages; i++) {
3398 func = data->info->func[i];
3400 for (j = 0; j < ARRAY_SIZE(pmbus_status_flag_map); j++) {
3401 cat = &pmbus_status_flag_map[j];
3402 if (!(func & cat->func))
3405 for (bit = cat->bits; bit->pflag; bit++)
3408 err = pmbus_write_smbalert_mask(client, i, cat->reg, ~mask);
3410 dev_dbg_once(dev, "Failed to set smbalert for reg 0x%02x\n",
3414 for (j = 0; j < ARRAY_SIZE(misc_status); j++)
3415 pmbus_write_smbalert_mask(client, i, misc_status[j], 0xff);
3418 /* Register notifiers */
3419 err = devm_request_threaded_irq(dev, client->irq, NULL, pmbus_fault_handler,
3420 IRQF_ONESHOT, "pmbus-irq", data);
3422 dev_err(dev, "failed to request an irq %d\n", err);
3429 static struct dentry *pmbus_debugfs_dir; /* pmbus debugfs directory */
3431 #if IS_ENABLED(CONFIG_DEBUG_FS)
3432 static int pmbus_debugfs_get(void *data, u64 *val)
3435 struct pmbus_debugfs_entry *entry = data;
3436 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
3438 rc = mutex_lock_interruptible(&pdata->update_lock);
3441 rc = _pmbus_read_byte_data(entry->client, entry->page, entry->reg);
3442 mutex_unlock(&pdata->update_lock);
3450 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops, pmbus_debugfs_get, NULL,
3453 static int pmbus_debugfs_get_status(void *data, u64 *val)
3456 struct pmbus_debugfs_entry *entry = data;
3457 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
3459 rc = mutex_lock_interruptible(&pdata->update_lock);
3462 rc = pdata->read_status(entry->client, entry->page);
3463 mutex_unlock(&pdata->update_lock);
3471 DEFINE_DEBUGFS_ATTRIBUTE(pmbus_debugfs_ops_status, pmbus_debugfs_get_status,
3472 NULL, "0x%04llx\n");
3474 static ssize_t pmbus_debugfs_mfr_read(struct file *file, char __user *buf,
3475 size_t count, loff_t *ppos)
3478 struct pmbus_debugfs_entry *entry = file->private_data;
3479 struct pmbus_data *pdata = i2c_get_clientdata(entry->client);
3480 char data[I2C_SMBUS_BLOCK_MAX + 2] = { 0 };
3482 rc = mutex_lock_interruptible(&pdata->update_lock);
3485 rc = pmbus_read_block_data(entry->client, entry->page, entry->reg,
3487 mutex_unlock(&pdata->update_lock);
3491 /* Add newline at the end of a read data */
3494 /* Include newline into the length */
3497 return simple_read_from_buffer(buf, count, ppos, data, rc);
3500 static const struct file_operations pmbus_debugfs_ops_mfr = {
3501 .llseek = noop_llseek,
3502 .read = pmbus_debugfs_mfr_read,
3504 .open = simple_open,
3507 static void pmbus_remove_debugfs(void *data)
3509 struct dentry *entry = data;
3511 debugfs_remove_recursive(entry);
3514 static int pmbus_init_debugfs(struct i2c_client *client,
3515 struct pmbus_data *data)
3518 char name[PMBUS_NAME_SIZE];
3519 struct pmbus_debugfs_entry *entries;
3521 if (!pmbus_debugfs_dir)
3525 * Create the debugfs directory for this device. Use the hwmon device
3526 * name to avoid conflicts (hwmon numbers are globally unique).
3528 data->debugfs = debugfs_create_dir(dev_name(data->hwmon_dev),
3530 if (IS_ERR_OR_NULL(data->debugfs)) {
3531 data->debugfs = NULL;
3536 * Allocate the max possible entries we need.
3537 * 7 entries device-specific
3538 * 10 entries page-specific
3540 entries = devm_kcalloc(data->dev,
3541 7 + data->info->pages * 10, sizeof(*entries),
3547 * Add device-specific entries.
3548 * Please note that the PMBUS standard allows all registers to be
3550 * To reduce the number of debugfs entries for devices with many pages
3551 * assume that values of the following registers are the same for all
3552 * pages and report values only for page 0.
3554 if (pmbus_check_byte_register(client, 0, PMBUS_REVISION)) {
3555 entries[idx].client = client;
3556 entries[idx].page = 0;
3557 entries[idx].reg = PMBUS_REVISION;
3558 debugfs_create_file("revision", 0444, data->debugfs,
3560 &pmbus_debugfs_ops);
3563 if (pmbus_check_block_register(client, 0, PMBUS_MFR_ID)) {
3564 entries[idx].client = client;
3565 entries[idx].page = 0;
3566 entries[idx].reg = PMBUS_MFR_ID;
3567 debugfs_create_file("mfr_id", 0444, data->debugfs,
3569 &pmbus_debugfs_ops_mfr);
3572 if (pmbus_check_block_register(client, 0, PMBUS_MFR_MODEL)) {
3573 entries[idx].client = client;
3574 entries[idx].page = 0;
3575 entries[idx].reg = PMBUS_MFR_MODEL;
3576 debugfs_create_file("mfr_model", 0444, data->debugfs,
3578 &pmbus_debugfs_ops_mfr);
3581 if (pmbus_check_block_register(client, 0, PMBUS_MFR_REVISION)) {
3582 entries[idx].client = client;
3583 entries[idx].page = 0;
3584 entries[idx].reg = PMBUS_MFR_REVISION;
3585 debugfs_create_file("mfr_revision", 0444, data->debugfs,
3587 &pmbus_debugfs_ops_mfr);
3590 if (pmbus_check_block_register(client, 0, PMBUS_MFR_LOCATION)) {
3591 entries[idx].client = client;
3592 entries[idx].page = 0;
3593 entries[idx].reg = PMBUS_MFR_LOCATION;
3594 debugfs_create_file("mfr_location", 0444, data->debugfs,
3596 &pmbus_debugfs_ops_mfr);
3599 if (pmbus_check_block_register(client, 0, PMBUS_MFR_DATE)) {
3600 entries[idx].client = client;
3601 entries[idx].page = 0;
3602 entries[idx].reg = PMBUS_MFR_DATE;
3603 debugfs_create_file("mfr_date", 0444, data->debugfs,
3605 &pmbus_debugfs_ops_mfr);
3608 if (pmbus_check_block_register(client, 0, PMBUS_MFR_SERIAL)) {
3609 entries[idx].client = client;
3610 entries[idx].page = 0;
3611 entries[idx].reg = PMBUS_MFR_SERIAL;
3612 debugfs_create_file("mfr_serial", 0444, data->debugfs,
3614 &pmbus_debugfs_ops_mfr);
3617 /* Add page specific entries */
3618 for (i = 0; i < data->info->pages; ++i) {
3619 /* Check accessibility of status register if it's not page 0 */
3620 if (!i || pmbus_check_status_register(client, i)) {
3621 /* No need to set reg as we have special read op. */
3622 entries[idx].client = client;
3623 entries[idx].page = i;
3624 scnprintf(name, PMBUS_NAME_SIZE, "status%d", i);
3625 debugfs_create_file(name, 0444, data->debugfs,
3627 &pmbus_debugfs_ops_status);
3630 if (data->info->func[i] & PMBUS_HAVE_STATUS_VOUT) {
3631 entries[idx].client = client;
3632 entries[idx].page = i;
3633 entries[idx].reg = PMBUS_STATUS_VOUT;
3634 scnprintf(name, PMBUS_NAME_SIZE, "status%d_vout", i);
3635 debugfs_create_file(name, 0444, data->debugfs,
3637 &pmbus_debugfs_ops);
3640 if (data->info->func[i] & PMBUS_HAVE_STATUS_IOUT) {
3641 entries[idx].client = client;
3642 entries[idx].page = i;
3643 entries[idx].reg = PMBUS_STATUS_IOUT;
3644 scnprintf(name, PMBUS_NAME_SIZE, "status%d_iout", i);
3645 debugfs_create_file(name, 0444, data->debugfs,
3647 &pmbus_debugfs_ops);
3650 if (data->info->func[i] & PMBUS_HAVE_STATUS_INPUT) {
3651 entries[idx].client = client;
3652 entries[idx].page = i;
3653 entries[idx].reg = PMBUS_STATUS_INPUT;
3654 scnprintf(name, PMBUS_NAME_SIZE, "status%d_input", i);
3655 debugfs_create_file(name, 0444, data->debugfs,
3657 &pmbus_debugfs_ops);
3660 if (data->info->func[i] & PMBUS_HAVE_STATUS_TEMP) {
3661 entries[idx].client = client;
3662 entries[idx].page = i;
3663 entries[idx].reg = PMBUS_STATUS_TEMPERATURE;
3664 scnprintf(name, PMBUS_NAME_SIZE, "status%d_temp", i);
3665 debugfs_create_file(name, 0444, data->debugfs,
3667 &pmbus_debugfs_ops);
3670 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_CML)) {
3671 entries[idx].client = client;
3672 entries[idx].page = i;
3673 entries[idx].reg = PMBUS_STATUS_CML;
3674 scnprintf(name, PMBUS_NAME_SIZE, "status%d_cml", i);
3675 debugfs_create_file(name, 0444, data->debugfs,
3677 &pmbus_debugfs_ops);
3680 if (pmbus_check_byte_register(client, i, PMBUS_STATUS_OTHER)) {
3681 entries[idx].client = client;
3682 entries[idx].page = i;
3683 entries[idx].reg = PMBUS_STATUS_OTHER;
3684 scnprintf(name, PMBUS_NAME_SIZE, "status%d_other", i);
3685 debugfs_create_file(name, 0444, data->debugfs,
3687 &pmbus_debugfs_ops);
3690 if (pmbus_check_byte_register(client, i,
3691 PMBUS_STATUS_MFR_SPECIFIC)) {
3692 entries[idx].client = client;
3693 entries[idx].page = i;
3694 entries[idx].reg = PMBUS_STATUS_MFR_SPECIFIC;
3695 scnprintf(name, PMBUS_NAME_SIZE, "status%d_mfr", i);
3696 debugfs_create_file(name, 0444, data->debugfs,
3698 &pmbus_debugfs_ops);
3701 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN12) {
3702 entries[idx].client = client;
3703 entries[idx].page = i;
3704 entries[idx].reg = PMBUS_STATUS_FAN_12;
3705 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan12", i);
3706 debugfs_create_file(name, 0444, data->debugfs,
3708 &pmbus_debugfs_ops);
3711 if (data->info->func[i] & PMBUS_HAVE_STATUS_FAN34) {
3712 entries[idx].client = client;
3713 entries[idx].page = i;
3714 entries[idx].reg = PMBUS_STATUS_FAN_34;
3715 scnprintf(name, PMBUS_NAME_SIZE, "status%d_fan34", i);
3716 debugfs_create_file(name, 0444, data->debugfs,
3718 &pmbus_debugfs_ops);
3722 return devm_add_action_or_reset(data->dev,
3723 pmbus_remove_debugfs, data->debugfs);
3726 static int pmbus_init_debugfs(struct i2c_client *client,
3727 struct pmbus_data *data)
3731 #endif /* IS_ENABLED(CONFIG_DEBUG_FS) */
3733 int pmbus_do_probe(struct i2c_client *client, struct pmbus_driver_info *info)
3735 struct device *dev = &client->dev;
3736 const struct pmbus_platform_data *pdata = dev_get_platdata(dev);
3737 struct pmbus_data *data;
3738 size_t groups_num = 0;
3746 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_WRITE_BYTE
3747 | I2C_FUNC_SMBUS_BYTE_DATA
3748 | I2C_FUNC_SMBUS_WORD_DATA))
3751 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
3756 while (info->groups[groups_num])
3759 data->groups = devm_kcalloc(dev, groups_num + 2, sizeof(void *),
3764 i2c_set_clientdata(client, data);
3765 mutex_init(&data->update_lock);
3769 data->flags = pdata->flags;
3771 data->currpage = -1;
3772 data->currphase = -1;
3774 for (i = 0; i < ARRAY_SIZE(data->vout_low); i++) {
3775 data->vout_low[i] = -1;
3776 data->vout_high[i] = -1;
3779 ret = pmbus_init_common(client, data, info);
3783 ret = pmbus_find_attributes(client, data);
3788 * If there are no attributes, something is wrong.
3789 * Bail out instead of trying to register nothing.
3791 if (!data->num_attributes) {
3792 dev_err(dev, "No attributes found\n");
3796 name = devm_kstrdup(dev, client->name, GFP_KERNEL);
3799 strreplace(name, '-', '_');
3801 data->groups[0] = &data->group;
3802 memcpy(data->groups + 1, info->groups, sizeof(void *) * groups_num);
3803 data->hwmon_dev = devm_hwmon_device_register_with_groups(dev,
3804 name, data, data->groups);
3805 if (IS_ERR(data->hwmon_dev)) {
3806 dev_err(dev, "Failed to register hwmon device\n");
3807 return PTR_ERR(data->hwmon_dev);
3810 ret = pmbus_regulator_register(data);
3814 ret = pmbus_irq_setup(client, data);
3818 ret = pmbus_init_debugfs(client, data);
3820 dev_warn(dev, "Failed to register debugfs\n");
3824 EXPORT_SYMBOL_NS_GPL(pmbus_do_probe, "PMBUS");
3826 struct dentry *pmbus_get_debugfs_dir(struct i2c_client *client)
3828 struct pmbus_data *data = i2c_get_clientdata(client);
3830 return data->debugfs;
3832 EXPORT_SYMBOL_NS_GPL(pmbus_get_debugfs_dir, "PMBUS");
3834 int pmbus_lock_interruptible(struct i2c_client *client)
3836 struct pmbus_data *data = i2c_get_clientdata(client);
3838 return mutex_lock_interruptible(&data->update_lock);
3840 EXPORT_SYMBOL_NS_GPL(pmbus_lock_interruptible, "PMBUS");
3842 void pmbus_unlock(struct i2c_client *client)
3844 struct pmbus_data *data = i2c_get_clientdata(client);
3846 mutex_unlock(&data->update_lock);
3848 EXPORT_SYMBOL_NS_GPL(pmbus_unlock, "PMBUS");
3850 static int __init pmbus_core_init(void)
3852 pmbus_debugfs_dir = debugfs_create_dir("pmbus", NULL);
3853 if (IS_ERR(pmbus_debugfs_dir))
3854 pmbus_debugfs_dir = NULL;
3859 static void __exit pmbus_core_exit(void)
3861 debugfs_remove_recursive(pmbus_debugfs_dir);
3864 module_init(pmbus_core_init);
3865 module_exit(pmbus_core_exit);
3867 MODULE_AUTHOR("Guenter Roeck");
3868 MODULE_DESCRIPTION("PMBus core driver");
3869 MODULE_LICENSE("GPL");