1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * max6650.c - Part of lm_sensors, Linux kernel modules for hardware
6 * (C) 2007 by Hans J. Koch <hjk@hansjkoch.de>
8 * based on code written by John Morris <john.morris@spirentcom.com>
9 * Copyright (c) 2003 Spirent Communications
10 * and Claus Gindhart <claus.gindhart@kontron.com>
12 * This module has only been tested with the MAX6650 chip. It should
13 * also work with the MAX6651. It does not distinguish max6650 and max6651
16 * The datasheet was last seen at:
18 * http://pdfserv.maxim-ic.com/en/ds/MAX6650-MAX6651.pdf
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/jiffies.h>
25 #include <linux/i2c.h>
26 #include <linux/hwmon.h>
27 #include <linux/hwmon-sysfs.h>
28 #include <linux/err.h>
29 #include <linux/of_device.h>
30 #include <linux/thermal.h>
36 /* fan_voltage: 5=5V fan, 12=12V fan, 0=don't change */
37 static int fan_voltage;
38 /* prescaler: Possible values are 1, 2, 4, 8, 16 or 0 for don't change */
40 /* clock: The clock frequency of the chip (max6651 can be clocked externally) */
41 static int clock = 254000;
43 module_param(fan_voltage, int, 0444);
44 module_param(prescaler, int, 0444);
45 module_param(clock, int, 0444);
48 * MAX 6650/6651 registers
51 #define MAX6650_REG_SPEED 0x00
52 #define MAX6650_REG_CONFIG 0x02
53 #define MAX6650_REG_GPIO_DEF 0x04
54 #define MAX6650_REG_DAC 0x06
55 #define MAX6650_REG_ALARM_EN 0x08
56 #define MAX6650_REG_ALARM 0x0A
57 #define MAX6650_REG_TACH0 0x0C
58 #define MAX6650_REG_TACH1 0x0E
59 #define MAX6650_REG_TACH2 0x10
60 #define MAX6650_REG_TACH3 0x12
61 #define MAX6650_REG_GPIO_STAT 0x14
62 #define MAX6650_REG_COUNT 0x16
65 * Config register bits
68 #define MAX6650_CFG_V12 0x08
69 #define MAX6650_CFG_PRESCALER_MASK 0x07
70 #define MAX6650_CFG_PRESCALER_2 0x01
71 #define MAX6650_CFG_PRESCALER_4 0x02
72 #define MAX6650_CFG_PRESCALER_8 0x03
73 #define MAX6650_CFG_PRESCALER_16 0x04
74 #define MAX6650_CFG_MODE_MASK 0x30
75 #define MAX6650_CFG_MODE_ON 0x00
76 #define MAX6650_CFG_MODE_OFF 0x10
77 #define MAX6650_CFG_MODE_CLOSED_LOOP 0x20
78 #define MAX6650_CFG_MODE_OPEN_LOOP 0x30
79 #define MAX6650_COUNT_MASK 0x03
82 * Alarm status register bits
85 #define MAX6650_ALRM_MAX 0x01
86 #define MAX6650_ALRM_MIN 0x02
87 #define MAX6650_ALRM_TACH 0x04
88 #define MAX6650_ALRM_GPIO1 0x08
89 #define MAX6650_ALRM_GPIO2 0x10
91 /* Minimum and maximum values of the FAN-RPM */
92 #define FAN_RPM_MIN 240
93 #define FAN_RPM_MAX 30000
95 #define DIV_FROM_REG(reg) (1 << ((reg) & 7))
96 #define DAC_LIMIT(v12) ((v12) ? 180 : 76)
99 * Client data (each client gets its own)
102 struct max6650_data {
103 struct i2c_client *client;
104 struct mutex update_lock; /* protect alarm register updates */
106 bool valid; /* false until following fields are valid */
107 unsigned long last_updated; /* in jiffies */
109 /* register values */
117 unsigned long cooling_dev_state;
120 static const u8 tach_reg[] = {
127 static const struct of_device_id __maybe_unused max6650_dt_match[] = {
129 .compatible = "maxim,max6650",
133 .compatible = "maxim,max6651",
138 MODULE_DEVICE_TABLE(of, max6650_dt_match);
140 static int dac_to_pwm(int dac, bool v12)
143 * Useful range for dac is 0-180 for 12V fans and 0-76 for 5V fans.
144 * Lower DAC values mean higher speeds.
146 return clamp_val(255 - (255 * dac) / DAC_LIMIT(v12), 0, 255);
149 static u8 pwm_to_dac(unsigned int pwm, bool v12)
151 int limit = DAC_LIMIT(v12);
153 return limit - (limit * pwm) / 255;
156 static struct max6650_data *max6650_update_device(struct device *dev)
158 struct max6650_data *data = dev_get_drvdata(dev);
159 struct i2c_client *client = data->client;
163 mutex_lock(&data->update_lock);
165 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
166 for (i = 0; i < data->nr_fans; i++) {
167 reg = i2c_smbus_read_byte_data(client, tach_reg[i]);
176 * Alarms are cleared on read in case the condition that
177 * caused the alarm is removed. Keep the value latched here
178 * for providing the register through different alarm files.
180 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM);
186 data->last_updated = jiffies;
191 mutex_unlock(&data->update_lock);
198 * Change the operating mode of the chip (if needed).
199 * mode is one of the MAX6650_CFG_MODE_* values.
201 static int max6650_set_operating_mode(struct max6650_data *data, u8 mode)
204 u8 config = data->config;
206 if (mode == (config & MAX6650_CFG_MODE_MASK))
209 config = (config & ~MAX6650_CFG_MODE_MASK) | mode;
211 result = i2c_smbus_write_byte_data(data->client, MAX6650_REG_CONFIG,
216 data->config = config;
222 * Set the fan speed to the specified RPM (or read back the RPM setting).
223 * This works in closed loop mode only. Use pwm1 for open loop speed setting.
225 * The MAX6650/1 will automatically control fan speed when in closed loop
230 * 1) The MAX6650/1 internal 254kHz clock frequency is set correctly. Use
231 * the clock module parameter if you need to fine tune this.
233 * 2) The prescaler (low three bits of the config register) has already
234 * been set to an appropriate value. Use the prescaler module parameter
235 * if your BIOS doesn't initialize the chip properly.
237 * The relevant equations are given on pages 21 and 22 of the datasheet.
239 * From the datasheet, the relevant equation when in regulation is:
241 * [fCLK / (128 x (KTACH + 1))] = 2 x FanSpeed / KSCALE
245 * fCLK is the oscillator frequency (either the 254kHz internal
246 * oscillator or the externally applied clock)
248 * KTACH is the value in the speed register
250 * FanSpeed is the speed of the fan in rps
252 * KSCALE is the prescaler value (1, 2, 4, 8, or 16)
254 * When reading, we need to solve for FanSpeed. When writing, we need to
257 * Note: this tachometer is completely separate from the tachometers
258 * used to measure the fan speeds. Only one fan's speed (fan1) is
262 static int max6650_set_target(struct max6650_data *data, unsigned long rpm)
267 return max6650_set_operating_mode(data, MAX6650_CFG_MODE_OFF);
269 rpm = clamp_val(rpm, FAN_RPM_MIN, FAN_RPM_MAX);
272 * Divide the required speed by 60 to get from rpm to rps, then
273 * use the datasheet equation:
275 * KTACH = [(fCLK x KSCALE) / (256 x FanSpeed)] - 1
278 kscale = DIV_FROM_REG(data->config);
279 ktach = ((clock * kscale) / (256 * rpm / 60)) - 1;
286 return i2c_smbus_write_byte_data(data->client, MAX6650_REG_SPEED,
291 * Get gpio alarm status:
297 static ssize_t alarm_show(struct device *dev,
298 struct device_attribute *devattr, char *buf)
300 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
301 struct max6650_data *data = max6650_update_device(dev);
305 return PTR_ERR(data);
307 alarm = data->alarm & attr->index;
309 mutex_lock(&data->update_lock);
310 data->alarm &= ~attr->index;
312 mutex_unlock(&data->update_lock);
315 return sprintf(buf, "%d\n", alarm);
318 static SENSOR_DEVICE_ATTR_RO(gpio1_alarm, alarm, MAX6650_ALRM_GPIO1);
319 static SENSOR_DEVICE_ATTR_RO(gpio2_alarm, alarm, MAX6650_ALRM_GPIO2);
321 static umode_t max6650_attrs_visible(struct kobject *kobj, struct attribute *a,
324 struct device *dev = kobj_to_dev(kobj);
325 struct max6650_data *data = dev_get_drvdata(dev);
326 struct device_attribute *devattr;
329 * Hide the alarms that have not been enabled by the firmware
332 devattr = container_of(a, struct device_attribute, attr);
333 if (devattr == &sensor_dev_attr_gpio1_alarm.dev_attr ||
334 devattr == &sensor_dev_attr_gpio2_alarm.dev_attr) {
335 if (!(data->alarm_en & to_sensor_dev_attr(devattr)->index))
342 static struct attribute *max6650_attrs[] = {
343 &sensor_dev_attr_gpio1_alarm.dev_attr.attr,
344 &sensor_dev_attr_gpio2_alarm.dev_attr.attr,
348 static const struct attribute_group max6650_group = {
349 .attrs = max6650_attrs,
350 .is_visible = max6650_attrs_visible,
353 static const struct attribute_group *max6650_groups[] = {
358 static int max6650_init_client(struct max6650_data *data,
359 struct i2c_client *client)
361 struct device *dev = &client->dev;
368 if (of_property_read_u32(dev->of_node, "maxim,fan-microvolt",
370 voltage = fan_voltage;
372 voltage /= 1000000; /* Microvolts to volts */
373 if (of_property_read_u32(dev->of_node, "maxim,fan-prescale",
375 prescale = prescaler;
377 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
379 dev_err(dev, "Error reading config register, aborting.\n");
387 reg &= ~MAX6650_CFG_V12;
390 reg |= MAX6650_CFG_V12;
393 dev_err(dev, "illegal value for fan_voltage (%d)\n", voltage);
400 reg &= ~MAX6650_CFG_PRESCALER_MASK;
403 reg = (reg & ~MAX6650_CFG_PRESCALER_MASK)
404 | MAX6650_CFG_PRESCALER_2;
407 reg = (reg & ~MAX6650_CFG_PRESCALER_MASK)
408 | MAX6650_CFG_PRESCALER_4;
411 reg = (reg & ~MAX6650_CFG_PRESCALER_MASK)
412 | MAX6650_CFG_PRESCALER_8;
415 reg = (reg & ~MAX6650_CFG_PRESCALER_MASK)
416 | MAX6650_CFG_PRESCALER_16;
419 dev_err(dev, "illegal value for prescaler (%d)\n", prescale);
422 dev_info(dev, "Fan voltage: %dV, prescaler: %d.\n",
423 (reg & MAX6650_CFG_V12) ? 12 : 5,
424 1 << (reg & MAX6650_CFG_PRESCALER_MASK));
426 err = i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, reg);
428 dev_err(dev, "Config write error, aborting.\n");
433 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_SPEED);
435 dev_err(dev, "Failed to read speed register, aborting.\n");
440 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_DAC);
442 dev_err(dev, "Failed to read DAC register, aborting.\n");
447 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT);
449 dev_err(dev, "Failed to read count register, aborting.\n");
454 reg = i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM_EN);
456 dev_err(dev, "Failed to read alarm configuration, aborting.\n");
459 data->alarm_en = reg;
461 if (!of_property_read_u32(client->dev.of_node, "maxim,fan-target-rpm",
463 max6650_set_target(data, target_rpm);
464 max6650_set_operating_mode(data, MAX6650_CFG_MODE_CLOSED_LOOP);
470 static int max6650_get_max_state(struct thermal_cooling_device *cdev,
471 unsigned long *state)
478 static int max6650_get_cur_state(struct thermal_cooling_device *cdev,
479 unsigned long *state)
481 struct max6650_data *data = cdev->devdata;
483 *state = data->cooling_dev_state;
488 static int max6650_set_cur_state(struct thermal_cooling_device *cdev,
491 struct max6650_data *data = cdev->devdata;
492 struct i2c_client *client = data->client;
495 state = clamp_val(state, 0, 255);
497 mutex_lock(&data->update_lock);
499 data->dac = pwm_to_dac(state, data->config & MAX6650_CFG_V12);
500 err = i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, data->dac);
502 max6650_set_operating_mode(data, state ?
503 MAX6650_CFG_MODE_OPEN_LOOP :
504 MAX6650_CFG_MODE_OFF);
505 data->cooling_dev_state = state;
508 mutex_unlock(&data->update_lock);
513 static const struct thermal_cooling_device_ops max6650_cooling_ops = {
514 .get_max_state = max6650_get_max_state,
515 .get_cur_state = max6650_get_cur_state,
516 .set_cur_state = max6650_set_cur_state,
519 static int max6650_read(struct device *dev, enum hwmon_sensor_types type,
520 u32 attr, int channel, long *val)
522 struct max6650_data *data = max6650_update_device(dev);
526 return PTR_ERR(data);
531 case hwmon_pwm_input:
532 *val = dac_to_pwm(data->dac,
533 data->config & MAX6650_CFG_V12);
535 case hwmon_pwm_enable:
539 * 1 = Open loop, Voltage is set according to speed,
541 * 2 = Closed loop, RPM for all fans regulated by fan1
545 mode = (data->config & MAX6650_CFG_MODE_MASK) >> 4;
546 *val = (4 - mode) & 3; /* {0 1 2 3} -> {0 3 2 1} */
554 case hwmon_fan_input:
556 * Calculation details:
558 * Each tachometer counts over an interval given by the
559 * "count" register (0.25, 0.5, 1 or 2 seconds).
560 * The driver assumes that the fans produce two pulses
561 * per revolution (this seems to be the most common).
563 *val = DIV_ROUND_CLOSEST(data->tach[channel] * 120,
564 DIV_FROM_REG(data->count));
567 *val = DIV_FROM_REG(data->count);
569 case hwmon_fan_target:
571 * Use the datasheet equation:
572 * FanSpeed = KSCALE x fCLK / [256 x (KTACH + 1)]
573 * then multiply by 60 to give rpm.
575 *val = 60 * DIV_FROM_REG(data->config) * clock /
576 (256 * (data->speed + 1));
578 case hwmon_fan_min_alarm:
579 *val = !!(data->alarm & MAX6650_ALRM_MIN);
580 data->alarm &= ~MAX6650_ALRM_MIN;
583 case hwmon_fan_max_alarm:
584 *val = !!(data->alarm & MAX6650_ALRM_MAX);
585 data->alarm &= ~MAX6650_ALRM_MAX;
588 case hwmon_fan_fault:
589 *val = !!(data->alarm & MAX6650_ALRM_TACH);
590 data->alarm &= ~MAX6650_ALRM_TACH;
603 static const u8 max6650_pwm_modes[] = {
605 MAX6650_CFG_MODE_OPEN_LOOP,
606 MAX6650_CFG_MODE_CLOSED_LOOP,
607 MAX6650_CFG_MODE_OFF,
610 static int max6650_write(struct device *dev, enum hwmon_sensor_types type,
611 u32 attr, int channel, long val)
613 struct max6650_data *data = dev_get_drvdata(dev);
617 mutex_lock(&data->update_lock);
622 case hwmon_pwm_input:
623 reg = pwm_to_dac(clamp_val(val, 0, 255),
624 data->config & MAX6650_CFG_V12);
625 ret = i2c_smbus_write_byte_data(data->client,
626 MAX6650_REG_DAC, reg);
631 case hwmon_pwm_enable:
632 if (val < 0 || val >= ARRAY_SIZE(max6650_pwm_modes)) {
636 ret = max6650_set_operating_mode(data,
637 max6650_pwm_modes[val]);
664 ret = i2c_smbus_write_byte_data(data->client,
665 MAX6650_REG_COUNT, reg);
670 case hwmon_fan_target:
675 ret = max6650_set_target(data, val);
688 mutex_unlock(&data->update_lock);
692 static umode_t max6650_is_visible(const void *_data,
693 enum hwmon_sensor_types type, u32 attr,
696 const struct max6650_data *data = _data;
698 if (channel && (channel >= data->nr_fans || type != hwmon_fan))
704 case hwmon_fan_input:
706 case hwmon_fan_target:
709 case hwmon_fan_min_alarm:
710 if (data->alarm_en & MAX6650_ALRM_MIN)
713 case hwmon_fan_max_alarm:
714 if (data->alarm_en & MAX6650_ALRM_MAX)
717 case hwmon_fan_fault:
718 if (data->alarm_en & MAX6650_ALRM_TACH)
727 case hwmon_pwm_input:
728 case hwmon_pwm_enable:
740 static const struct hwmon_channel_info * const max6650_info[] = {
741 HWMON_CHANNEL_INFO(fan, HWMON_F_INPUT | HWMON_F_TARGET | HWMON_F_DIV |
742 HWMON_F_MIN_ALARM | HWMON_F_MAX_ALARM |
744 HWMON_F_INPUT, HWMON_F_INPUT, HWMON_F_INPUT),
745 HWMON_CHANNEL_INFO(pwm, HWMON_PWM_INPUT | HWMON_PWM_ENABLE),
749 static const struct hwmon_ops max6650_hwmon_ops = {
750 .read = max6650_read,
751 .write = max6650_write,
752 .is_visible = max6650_is_visible,
755 static const struct hwmon_chip_info max6650_chip_info = {
756 .ops = &max6650_hwmon_ops,
757 .info = max6650_info,
760 static const struct i2c_device_id max6650_id[];
762 static int max6650_probe(struct i2c_client *client)
764 struct thermal_cooling_device *cooling_dev;
765 struct device *dev = &client->dev;
766 const struct of_device_id *of_id =
767 of_match_device(of_match_ptr(max6650_dt_match), dev);
768 struct max6650_data *data;
769 struct device *hwmon_dev;
772 data = devm_kzalloc(dev, sizeof(struct max6650_data), GFP_KERNEL);
776 data->client = client;
777 i2c_set_clientdata(client, data);
778 mutex_init(&data->update_lock);
779 data->nr_fans = of_id ? (int)(uintptr_t)of_id->data :
780 i2c_match_id(max6650_id, client)->driver_data;
783 * Initialize the max6650 chip
785 err = max6650_init_client(data, client);
789 hwmon_dev = devm_hwmon_device_register_with_info(dev,
793 err = PTR_ERR_OR_ZERO(hwmon_dev);
797 if (IS_ENABLED(CONFIG_THERMAL)) {
798 cooling_dev = devm_thermal_of_cooling_device_register(dev,
799 dev->of_node, client->name,
800 data, &max6650_cooling_ops);
801 if (IS_ERR(cooling_dev)) {
802 dev_warn(dev, "thermal cooling device register failed: %ld\n",
803 PTR_ERR(cooling_dev));
810 static const struct i2c_device_id max6650_id[] = {
815 MODULE_DEVICE_TABLE(i2c, max6650_id);
817 static struct i2c_driver max6650_driver = {
820 .of_match_table = of_match_ptr(max6650_dt_match),
822 .probe = max6650_probe,
823 .id_table = max6650_id,
826 module_i2c_driver(max6650_driver);
828 MODULE_AUTHOR("Hans J. Koch");
829 MODULE_DESCRIPTION("MAX6650 sensor driver");
830 MODULE_LICENSE("GPL");