1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * pwm-fan.c - Hwmon driver for fans connected to PWM lines.
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
10 #include <linux/delay.h>
11 #include <linux/hwmon.h>
12 #include <linux/interrupt.h>
13 #include <linux/mod_devicetable.h>
14 #include <linux/module.h>
15 #include <linux/mutex.h>
16 #include <linux/platform_device.h>
17 #include <linux/property.h>
18 #include <linux/pwm.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/sysfs.h>
21 #include <linux/thermal.h>
22 #include <linux/timer.h>
32 enum pwm_fan_enable_mode {
34 pwm_disable_reg_enable,
35 pwm_enable_reg_enable,
36 pwm_disable_reg_disable,
43 struct pwm_device *pwm;
44 struct pwm_state pwm_state;
45 struct regulator *reg_en;
46 enum pwm_fan_enable_mode enable_mode;
47 bool regulator_enabled;
51 struct pwm_fan_tach *tachs;
52 u32 *pulses_per_revolution;
54 struct timer_list rpm_timer;
56 unsigned int pwm_value;
57 unsigned int pwm_fan_state;
58 unsigned int pwm_fan_max_state;
59 unsigned int *pwm_fan_cooling_levels;
60 struct thermal_cooling_device *cdev;
62 struct hwmon_chip_info info;
63 struct hwmon_channel_info fan_channel;
65 u64 pwm_duty_cycle_from_stopped;
66 u32 pwm_usec_from_stopped;
69 /* This handler assumes self resetting edge triggered interrupt. */
70 static irqreturn_t pulse_handler(int irq, void *dev_id)
72 struct pwm_fan_tach *tach = dev_id;
74 atomic_inc(&tach->pulses);
79 static void sample_timer(struct timer_list *t)
81 struct pwm_fan_ctx *ctx = from_timer(ctx, t, rpm_timer);
82 unsigned int delta = ktime_ms_delta(ktime_get(), ctx->sample_start);
86 for (i = 0; i < ctx->tach_count; i++) {
87 struct pwm_fan_tach *tach = &ctx->tachs[i];
90 pulses = atomic_read(&tach->pulses);
91 atomic_sub(pulses, &tach->pulses);
92 tach->rpm = (unsigned int)(pulses * 1000 * 60) /
93 (ctx->pulses_per_revolution[i] * delta);
96 ctx->sample_start = ktime_get();
99 mod_timer(&ctx->rpm_timer, jiffies + HZ);
102 static void pwm_fan_enable_mode_2_state(int enable_mode,
103 struct pwm_state *state,
104 bool *enable_regulator)
106 switch (enable_mode) {
107 case pwm_disable_reg_enable:
108 /* disable pwm, keep regulator enabled */
109 state->enabled = false;
110 *enable_regulator = true;
112 case pwm_enable_reg_enable:
113 /* keep pwm and regulator enabled */
114 state->enabled = true;
115 *enable_regulator = true;
117 case pwm_off_reg_off:
118 case pwm_disable_reg_disable:
119 /* disable pwm and regulator */
120 state->enabled = false;
121 *enable_regulator = false;
125 static int pwm_fan_switch_power(struct pwm_fan_ctx *ctx, bool on)
132 if (!ctx->regulator_enabled && on) {
133 ret = regulator_enable(ctx->reg_en);
135 ctx->regulator_enabled = true;
136 } else if (ctx->regulator_enabled && !on) {
137 ret = regulator_disable(ctx->reg_en);
139 ctx->regulator_enabled = false;
144 static int pwm_fan_power_on(struct pwm_fan_ctx *ctx)
146 struct pwm_state *state = &ctx->pwm_state;
152 ret = pwm_fan_switch_power(ctx, true);
154 dev_err(ctx->dev, "failed to enable power supply\n");
158 state->enabled = true;
159 ret = pwm_apply_might_sleep(ctx->pwm, state);
161 dev_err(ctx->dev, "failed to enable PWM\n");
162 goto disable_regulator;
170 pwm_fan_switch_power(ctx, false);
174 static int pwm_fan_power_off(struct pwm_fan_ctx *ctx, bool force_disable)
176 struct pwm_state *state = &ctx->pwm_state;
177 bool enable_regulator = false;
183 pwm_fan_enable_mode_2_state(ctx->enable_mode,
188 state->enabled = false;
189 state->duty_cycle = 0;
190 ret = pwm_apply_might_sleep(ctx->pwm, state);
192 dev_err(ctx->dev, "failed to disable PWM\n");
196 pwm_fan_switch_power(ctx, enable_regulator);
198 ctx->enabled = false;
203 static int __set_pwm(struct pwm_fan_ctx *ctx, unsigned long pwm)
205 struct pwm_state *state = &ctx->pwm_state;
206 unsigned long final_pwm = pwm;
207 unsigned long period;
212 if (ctx->enable_mode == pwm_off_reg_off)
213 /* pwm-fan hard disabled */
216 period = state->period;
217 update = state->duty_cycle < ctx->pwm_duty_cycle_from_stopped;
219 state->duty_cycle = ctx->pwm_duty_cycle_from_stopped;
221 state->duty_cycle = DIV_ROUND_UP(pwm * (period - 1), MAX_PWM);
222 ret = pwm_apply_might_sleep(ctx->pwm, state);
225 ret = pwm_fan_power_on(ctx);
226 if (!ret && update) {
228 state->duty_cycle = DIV_ROUND_UP(pwm * (period - 1), MAX_PWM);
229 usleep_range(ctx->pwm_usec_from_stopped,
230 ctx->pwm_usec_from_stopped * 2);
231 ret = pwm_apply_might_sleep(ctx->pwm, state);
234 ret = pwm_fan_power_off(ctx, false);
237 ctx->pwm_value = pwm;
242 static int set_pwm(struct pwm_fan_ctx *ctx, unsigned long pwm)
246 mutex_lock(&ctx->lock);
247 ret = __set_pwm(ctx, pwm);
248 mutex_unlock(&ctx->lock);
253 static void pwm_fan_update_state(struct pwm_fan_ctx *ctx, unsigned long pwm)
257 for (i = 0; i < ctx->pwm_fan_max_state; ++i)
258 if (pwm < ctx->pwm_fan_cooling_levels[i + 1])
261 ctx->pwm_fan_state = i;
264 static int pwm_fan_update_enable(struct pwm_fan_ctx *ctx, long val)
269 mutex_lock(&ctx->lock);
271 if (ctx->enable_mode == val)
274 old_val = ctx->enable_mode;
275 ctx->enable_mode = val;
278 /* Disable pwm-fan unconditionally */
280 ret = __set_pwm(ctx, 0);
282 ret = pwm_fan_switch_power(ctx, false);
284 ctx->enable_mode = old_val;
285 pwm_fan_update_state(ctx, 0);
288 * Change PWM and/or regulator state if currently disabled
289 * Nothing to do if currently enabled
292 struct pwm_state *state = &ctx->pwm_state;
293 bool enable_regulator = false;
295 state->duty_cycle = 0;
296 pwm_fan_enable_mode_2_state(val,
300 pwm_apply_might_sleep(ctx->pwm, state);
301 pwm_fan_switch_power(ctx, enable_regulator);
302 pwm_fan_update_state(ctx, 0);
306 mutex_unlock(&ctx->lock);
311 static int pwm_fan_write(struct device *dev, enum hwmon_sensor_types type,
312 u32 attr, int channel, long val)
314 struct pwm_fan_ctx *ctx = dev_get_drvdata(dev);
318 case hwmon_pwm_input:
319 if (val < 0 || val > MAX_PWM)
321 ret = set_pwm(ctx, val);
324 pwm_fan_update_state(ctx, val);
326 case hwmon_pwm_enable:
327 if (val < 0 || val > 3)
330 ret = pwm_fan_update_enable(ctx, val);
340 static int pwm_fan_read(struct device *dev, enum hwmon_sensor_types type,
341 u32 attr, int channel, long *val)
343 struct pwm_fan_ctx *ctx = dev_get_drvdata(dev);
348 case hwmon_pwm_input:
349 *val = ctx->pwm_value;
351 case hwmon_pwm_enable:
352 *val = ctx->enable_mode;
357 *val = ctx->tachs[channel].rpm;
365 static umode_t pwm_fan_is_visible(const void *data,
366 enum hwmon_sensor_types type,
367 u32 attr, int channel)
381 static const struct hwmon_ops pwm_fan_hwmon_ops = {
382 .is_visible = pwm_fan_is_visible,
383 .read = pwm_fan_read,
384 .write = pwm_fan_write,
387 /* thermal cooling device callbacks */
388 static int pwm_fan_get_max_state(struct thermal_cooling_device *cdev,
389 unsigned long *state)
391 struct pwm_fan_ctx *ctx = cdev->devdata;
396 *state = ctx->pwm_fan_max_state;
401 static int pwm_fan_get_cur_state(struct thermal_cooling_device *cdev,
402 unsigned long *state)
404 struct pwm_fan_ctx *ctx = cdev->devdata;
409 *state = ctx->pwm_fan_state;
415 pwm_fan_set_cur_state(struct thermal_cooling_device *cdev, unsigned long state)
417 struct pwm_fan_ctx *ctx = cdev->devdata;
420 if (!ctx || (state > ctx->pwm_fan_max_state))
423 if (state == ctx->pwm_fan_state)
426 ret = set_pwm(ctx, ctx->pwm_fan_cooling_levels[state]);
428 dev_err(&cdev->device, "Cannot set pwm!\n");
432 ctx->pwm_fan_state = state;
437 static const struct thermal_cooling_device_ops pwm_fan_cooling_ops = {
438 .get_max_state = pwm_fan_get_max_state,
439 .get_cur_state = pwm_fan_get_cur_state,
440 .set_cur_state = pwm_fan_set_cur_state,
443 static int pwm_fan_get_cooling_data(struct device *dev, struct pwm_fan_ctx *ctx)
447 if (!device_property_present(dev, "cooling-levels"))
450 ret = device_property_count_u32(dev, "cooling-levels");
452 dev_err(dev, "Wrong data!\n");
453 return ret ? : -EINVAL;
457 ctx->pwm_fan_cooling_levels = devm_kcalloc(dev, num, sizeof(u32),
459 if (!ctx->pwm_fan_cooling_levels)
462 ret = device_property_read_u32_array(dev, "cooling-levels",
463 ctx->pwm_fan_cooling_levels, num);
465 dev_err(dev, "Property 'cooling-levels' cannot be read!\n");
469 for (i = 0; i < num; i++) {
470 if (ctx->pwm_fan_cooling_levels[i] > MAX_PWM) {
471 dev_err(dev, "PWM fan state[%d]:%d > %d\n", i,
472 ctx->pwm_fan_cooling_levels[i], MAX_PWM);
477 ctx->pwm_fan_max_state = num - 1;
482 static void pwm_fan_cleanup(void *__ctx)
484 struct pwm_fan_ctx *ctx = __ctx;
486 del_timer_sync(&ctx->rpm_timer);
487 /* Switch off everything */
488 ctx->enable_mode = pwm_disable_reg_disable;
489 pwm_fan_power_off(ctx, true);
492 static int pwm_fan_probe(struct platform_device *pdev)
494 struct thermal_cooling_device *cdev;
495 struct device *dev = &pdev->dev;
496 struct pwm_fan_ctx *ctx;
497 struct device *hwmon;
499 const struct hwmon_channel_info **channels;
500 u32 initial_pwm, pwm_min_from_stopped = 0;
501 u32 *fan_channel_config;
502 int channel_count = 1; /* We always have a PWM channel. */
505 ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
509 mutex_init(&ctx->lock);
511 ctx->dev = &pdev->dev;
512 ctx->pwm = devm_pwm_get(dev, NULL);
513 if (IS_ERR(ctx->pwm))
514 return dev_err_probe(dev, PTR_ERR(ctx->pwm), "Could not get PWM\n");
516 platform_set_drvdata(pdev, ctx);
518 ctx->reg_en = devm_regulator_get_optional(dev, "fan");
519 if (IS_ERR(ctx->reg_en)) {
520 if (PTR_ERR(ctx->reg_en) != -ENODEV)
521 return PTR_ERR(ctx->reg_en);
526 pwm_init_state(ctx->pwm, &ctx->pwm_state);
529 * PWM fans are controlled solely by the duty cycle of the PWM signal,
530 * they do not care about the exact timing. Thus set usage_power to true
531 * to allow less flexible hardware to work as a PWM source for fan
534 ctx->pwm_state.usage_power = true;
537 * set_pwm assumes that MAX_PWM * (period - 1) fits into an unsigned
538 * long. Check this here to prevent the fan running at a too low
541 if (ctx->pwm_state.period > ULONG_MAX / MAX_PWM + 1) {
542 dev_err(dev, "Configured period too big\n");
546 ctx->enable_mode = pwm_disable_reg_enable;
548 ret = pwm_fan_get_cooling_data(dev, ctx);
552 /* use maximum cooling level if provided */
553 if (ctx->pwm_fan_cooling_levels)
554 initial_pwm = ctx->pwm_fan_cooling_levels[ctx->pwm_fan_max_state];
556 initial_pwm = MAX_PWM;
559 * Set duty cycle to maximum allowed and enable PWM output as well as
560 * the regulator. In case of error nothing is changed
562 ret = set_pwm(ctx, initial_pwm);
564 dev_err(dev, "Failed to configure PWM: %d\n", ret);
567 timer_setup(&ctx->rpm_timer, sample_timer, 0);
568 ret = devm_add_action_or_reset(dev, pwm_fan_cleanup, ctx);
572 ctx->tach_count = platform_irq_count(pdev);
573 if (ctx->tach_count < 0)
574 return dev_err_probe(dev, ctx->tach_count,
575 "Could not get number of fan tachometer inputs\n");
576 dev_dbg(dev, "%d fan tachometer inputs\n", ctx->tach_count);
578 if (ctx->tach_count) {
579 channel_count++; /* We also have a FAN channel. */
581 ctx->tachs = devm_kcalloc(dev, ctx->tach_count,
582 sizeof(struct pwm_fan_tach),
587 ctx->fan_channel.type = hwmon_fan;
588 fan_channel_config = devm_kcalloc(dev, ctx->tach_count + 1,
589 sizeof(u32), GFP_KERNEL);
590 if (!fan_channel_config)
592 ctx->fan_channel.config = fan_channel_config;
594 ctx->pulses_per_revolution = devm_kmalloc_array(dev,
596 sizeof(*ctx->pulses_per_revolution),
598 if (!ctx->pulses_per_revolution)
601 /* Setup default pulses per revolution */
602 for (i = 0; i < ctx->tach_count; i++)
603 ctx->pulses_per_revolution[i] = 2;
605 device_property_read_u32_array(dev, "pulses-per-revolution",
606 ctx->pulses_per_revolution, ctx->tach_count);
609 channels = devm_kcalloc(dev, channel_count + 1,
610 sizeof(struct hwmon_channel_info *), GFP_KERNEL);
614 channels[0] = HWMON_CHANNEL_INFO(pwm, HWMON_PWM_INPUT | HWMON_PWM_ENABLE);
616 for (i = 0; i < ctx->tach_count; i++) {
617 struct pwm_fan_tach *tach = &ctx->tachs[i];
619 tach->irq = platform_get_irq(pdev, i);
620 if (tach->irq == -EPROBE_DEFER)
623 ret = devm_request_irq(dev, tach->irq, pulse_handler, 0,
627 "Failed to request interrupt: %d\n",
633 if (!ctx->pulses_per_revolution[i]) {
634 dev_err(dev, "pulses-per-revolution can't be zero.\n");
638 fan_channel_config[i] = HWMON_F_INPUT;
640 dev_dbg(dev, "tach%d: irq=%d, pulses_per_revolution=%d\n",
641 i, tach->irq, ctx->pulses_per_revolution[i]);
644 if (ctx->tach_count > 0) {
645 ctx->sample_start = ktime_get();
646 mod_timer(&ctx->rpm_timer, jiffies + HZ);
648 channels[1] = &ctx->fan_channel;
651 ret = device_property_read_u32(dev, "fan-stop-to-start-percent",
652 &pwm_min_from_stopped);
653 if (!ret && pwm_min_from_stopped) {
654 ctx->pwm_duty_cycle_from_stopped =
655 DIV_ROUND_UP_ULL(pwm_min_from_stopped *
656 (ctx->pwm_state.period - 1),
659 ret = device_property_read_u32(dev, "fan-stop-to-start-us",
660 &ctx->pwm_usec_from_stopped);
662 ctx->pwm_usec_from_stopped = 250000;
664 ctx->info.ops = &pwm_fan_hwmon_ops;
665 ctx->info.info = channels;
667 hwmon = devm_hwmon_device_register_with_info(dev, "pwmfan",
668 ctx, &ctx->info, NULL);
670 dev_err(dev, "Failed to register hwmon device\n");
671 return PTR_ERR(hwmon);
674 ctx->pwm_fan_state = ctx->pwm_fan_max_state;
675 if (IS_ENABLED(CONFIG_THERMAL)) {
676 cdev = devm_thermal_of_cooling_device_register(dev,
677 dev->of_node, "pwm-fan", ctx, &pwm_fan_cooling_ops);
681 "Failed to register pwm-fan as cooling device: %d\n",
691 static void pwm_fan_shutdown(struct platform_device *pdev)
693 struct pwm_fan_ctx *ctx = platform_get_drvdata(pdev);
695 pwm_fan_cleanup(ctx);
698 static int pwm_fan_suspend(struct device *dev)
700 struct pwm_fan_ctx *ctx = dev_get_drvdata(dev);
702 return pwm_fan_power_off(ctx, true);
705 static int pwm_fan_resume(struct device *dev)
707 struct pwm_fan_ctx *ctx = dev_get_drvdata(dev);
709 return set_pwm(ctx, ctx->pwm_value);
712 static DEFINE_SIMPLE_DEV_PM_OPS(pwm_fan_pm, pwm_fan_suspend, pwm_fan_resume);
714 static const struct of_device_id of_pwm_fan_match[] = {
715 { .compatible = "pwm-fan", },
718 MODULE_DEVICE_TABLE(of, of_pwm_fan_match);
720 static struct platform_driver pwm_fan_driver = {
721 .probe = pwm_fan_probe,
722 .shutdown = pwm_fan_shutdown,
725 .pm = pm_sleep_ptr(&pwm_fan_pm),
726 .of_match_table = of_pwm_fan_match,
730 module_platform_driver(pwm_fan_driver);
733 MODULE_ALIAS("platform:pwm-fan");
734 MODULE_DESCRIPTION("PWM FAN driver");
735 MODULE_LICENSE("GPL");