1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * MAXIM MAX77693/MAX77843 Haptic device driver
5 * Copyright (C) 2014,2015 Samsung Electronics
6 * Jaewon Kim <jaewon02.kim@samsung.com>
7 * Krzysztof Kozlowski <krzk@kernel.org>
9 * This program is not provided / owned by Maxim Integrated Products.
12 #include <linux/err.h>
13 #include <linux/init.h>
14 #include <linux/i2c.h>
15 #include <linux/regmap.h>
16 #include <linux/input.h>
17 #include <linux/module.h>
18 #include <linux/platform_device.h>
19 #include <linux/pwm.h>
20 #include <linux/slab.h>
21 #include <linux/workqueue.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/mfd/max77693.h>
24 #include <linux/mfd/max77693-common.h>
25 #include <linux/mfd/max77693-private.h>
26 #include <linux/mfd/max77843-private.h>
28 #define MAX_MAGNITUDE_SHIFT 16
30 enum max77693_haptic_motor_type {
31 MAX77693_HAPTIC_ERM = 0,
35 enum max77693_haptic_pulse_mode {
36 MAX77693_HAPTIC_EXTERNAL_MODE = 0,
37 MAX77693_HAPTIC_INTERNAL_MODE,
40 enum max77693_haptic_pwm_divisor {
41 MAX77693_HAPTIC_PWM_DIVISOR_32 = 0,
42 MAX77693_HAPTIC_PWM_DIVISOR_64,
43 MAX77693_HAPTIC_PWM_DIVISOR_128,
44 MAX77693_HAPTIC_PWM_DIVISOR_256,
47 struct max77693_haptic {
48 enum max77693_types dev_type;
50 struct regmap *regmap_pmic;
51 struct regmap *regmap_haptic;
53 struct input_dev *input_dev;
54 struct pwm_device *pwm_dev;
55 struct regulator *motor_reg;
59 unsigned int magnitude;
60 unsigned int pwm_duty;
61 enum max77693_haptic_motor_type type;
62 enum max77693_haptic_pulse_mode mode;
64 struct work_struct work;
67 static int max77693_haptic_set_duty_cycle(struct max77693_haptic *haptic)
69 struct pwm_args pargs;
73 pwm_get_args(haptic->pwm_dev, &pargs);
74 delta = (pargs.period + haptic->pwm_duty) / 2;
75 error = pwm_config(haptic->pwm_dev, delta, pargs.period);
77 dev_err(haptic->dev, "failed to configure pwm: %d\n", error);
84 static int max77843_haptic_bias(struct max77693_haptic *haptic, bool on)
88 if (haptic->dev_type != TYPE_MAX77843)
91 error = regmap_update_bits(haptic->regmap_haptic,
92 MAX77843_SYS_REG_MAINCTRL1,
93 MAX77843_MAINCTRL1_BIASEN_MASK,
94 on << MAINCTRL1_BIASEN_SHIFT);
96 dev_err(haptic->dev, "failed to %s bias: %d\n",
97 on ? "enable" : "disable", error);
104 static int max77693_haptic_configure(struct max77693_haptic *haptic,
107 unsigned int value, config_reg;
110 switch (haptic->dev_type) {
112 value = ((haptic->type << MAX77693_CONFIG2_MODE) |
113 (enable << MAX77693_CONFIG2_MEN) |
114 (haptic->mode << MAX77693_CONFIG2_HTYP) |
115 MAX77693_HAPTIC_PWM_DIVISOR_128);
116 config_reg = MAX77693_HAPTIC_REG_CONFIG2;
119 value = (haptic->type << MCONFIG_MODE_SHIFT) |
120 (enable << MCONFIG_MEN_SHIFT) |
121 MAX77693_HAPTIC_PWM_DIVISOR_128;
122 config_reg = MAX77843_HAP_REG_MCONFIG;
128 error = regmap_write(haptic->regmap_haptic,
132 "failed to update haptic config: %d\n", error);
139 static int max77693_haptic_lowsys(struct max77693_haptic *haptic, bool enable)
143 if (haptic->dev_type != TYPE_MAX77693)
146 error = regmap_update_bits(haptic->regmap_pmic,
147 MAX77693_PMIC_REG_LSCNFG,
148 MAX77693_PMIC_LOW_SYS_MASK,
149 enable << MAX77693_PMIC_LOW_SYS_SHIFT);
151 dev_err(haptic->dev, "cannot update pmic regmap: %d\n", error);
158 static void max77693_haptic_enable(struct max77693_haptic *haptic)
165 error = pwm_enable(haptic->pwm_dev);
168 "failed to enable haptic pwm device: %d\n", error);
172 error = max77693_haptic_lowsys(haptic, true);
174 goto err_enable_lowsys;
176 error = max77693_haptic_configure(haptic, true);
178 goto err_enable_config;
180 haptic->enabled = true;
185 max77693_haptic_lowsys(haptic, false);
187 pwm_disable(haptic->pwm_dev);
190 static void max77693_haptic_disable(struct max77693_haptic *haptic)
194 if (!haptic->enabled)
197 error = max77693_haptic_configure(haptic, false);
201 error = max77693_haptic_lowsys(haptic, false);
203 goto err_disable_lowsys;
205 pwm_disable(haptic->pwm_dev);
206 haptic->enabled = false;
211 max77693_haptic_configure(haptic, true);
214 static void max77693_haptic_play_work(struct work_struct *work)
216 struct max77693_haptic *haptic =
217 container_of(work, struct max77693_haptic, work);
220 error = max77693_haptic_set_duty_cycle(haptic);
222 dev_err(haptic->dev, "failed to set duty cycle: %d\n", error);
226 if (haptic->magnitude)
227 max77693_haptic_enable(haptic);
229 max77693_haptic_disable(haptic);
232 static int max77693_haptic_play_effect(struct input_dev *dev, void *data,
233 struct ff_effect *effect)
235 struct max77693_haptic *haptic = input_get_drvdata(dev);
236 struct pwm_args pargs;
237 u64 period_mag_multi;
239 haptic->magnitude = effect->u.rumble.strong_magnitude;
240 if (!haptic->magnitude)
241 haptic->magnitude = effect->u.rumble.weak_magnitude;
244 * The magnitude comes from force-feedback interface.
245 * The formula to convert magnitude to pwm_duty as follows:
246 * - pwm_duty = (magnitude * pwm_period) / MAX_MAGNITUDE(0xFFFF)
248 pwm_get_args(haptic->pwm_dev, &pargs);
249 period_mag_multi = (u64)pargs.period * haptic->magnitude;
250 haptic->pwm_duty = (unsigned int)(period_mag_multi >>
251 MAX_MAGNITUDE_SHIFT);
253 schedule_work(&haptic->work);
258 static int max77693_haptic_open(struct input_dev *dev)
260 struct max77693_haptic *haptic = input_get_drvdata(dev);
263 error = max77843_haptic_bias(haptic, true);
267 error = regulator_enable(haptic->motor_reg);
270 "failed to enable regulator: %d\n", error);
277 static void max77693_haptic_close(struct input_dev *dev)
279 struct max77693_haptic *haptic = input_get_drvdata(dev);
282 cancel_work_sync(&haptic->work);
283 max77693_haptic_disable(haptic);
285 error = regulator_disable(haptic->motor_reg);
288 "failed to disable regulator: %d\n", error);
290 max77843_haptic_bias(haptic, false);
293 static int max77693_haptic_probe(struct platform_device *pdev)
295 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
296 struct max77693_haptic *haptic;
299 haptic = devm_kzalloc(&pdev->dev, sizeof(*haptic), GFP_KERNEL);
303 haptic->regmap_pmic = max77693->regmap;
304 haptic->dev = &pdev->dev;
305 haptic->type = MAX77693_HAPTIC_LRA;
306 haptic->mode = MAX77693_HAPTIC_EXTERNAL_MODE;
307 haptic->suspend_state = false;
309 /* Variant-specific init */
310 haptic->dev_type = platform_get_device_id(pdev)->driver_data;
311 switch (haptic->dev_type) {
313 haptic->regmap_haptic = max77693->regmap_haptic;
316 haptic->regmap_haptic = max77693->regmap;
319 dev_err(&pdev->dev, "unsupported device type: %u\n",
324 INIT_WORK(&haptic->work, max77693_haptic_play_work);
326 /* Get pwm and regulatot for haptic device */
327 haptic->pwm_dev = devm_pwm_get(&pdev->dev, NULL);
328 if (IS_ERR(haptic->pwm_dev)) {
329 dev_err(&pdev->dev, "failed to get pwm device\n");
330 return PTR_ERR(haptic->pwm_dev);
334 * FIXME: pwm_apply_args() should be removed when switching to the
337 pwm_apply_args(haptic->pwm_dev);
339 haptic->motor_reg = devm_regulator_get(&pdev->dev, "haptic");
340 if (IS_ERR(haptic->motor_reg)) {
341 dev_err(&pdev->dev, "failed to get regulator\n");
342 return PTR_ERR(haptic->motor_reg);
345 /* Initialize input device for haptic device */
346 haptic->input_dev = devm_input_allocate_device(&pdev->dev);
347 if (!haptic->input_dev) {
348 dev_err(&pdev->dev, "failed to allocate input device\n");
352 haptic->input_dev->name = "max77693-haptic";
353 haptic->input_dev->id.version = 1;
354 haptic->input_dev->dev.parent = &pdev->dev;
355 haptic->input_dev->open = max77693_haptic_open;
356 haptic->input_dev->close = max77693_haptic_close;
357 input_set_drvdata(haptic->input_dev, haptic);
358 input_set_capability(haptic->input_dev, EV_FF, FF_RUMBLE);
360 error = input_ff_create_memless(haptic->input_dev, NULL,
361 max77693_haptic_play_effect);
363 dev_err(&pdev->dev, "failed to create force-feedback\n");
367 error = input_register_device(haptic->input_dev);
369 dev_err(&pdev->dev, "failed to register input device\n");
373 platform_set_drvdata(pdev, haptic);
378 static int max77693_haptic_suspend(struct device *dev)
380 struct platform_device *pdev = to_platform_device(dev);
381 struct max77693_haptic *haptic = platform_get_drvdata(pdev);
383 if (haptic->enabled) {
384 max77693_haptic_disable(haptic);
385 haptic->suspend_state = true;
391 static int max77693_haptic_resume(struct device *dev)
393 struct platform_device *pdev = to_platform_device(dev);
394 struct max77693_haptic *haptic = platform_get_drvdata(pdev);
396 if (haptic->suspend_state) {
397 max77693_haptic_enable(haptic);
398 haptic->suspend_state = false;
404 static DEFINE_SIMPLE_DEV_PM_OPS(max77693_haptic_pm_ops,
405 max77693_haptic_suspend,
406 max77693_haptic_resume);
408 static const struct platform_device_id max77693_haptic_id[] = {
409 { "max77693-haptic", TYPE_MAX77693 },
410 { "max77843-haptic", TYPE_MAX77843 },
413 MODULE_DEVICE_TABLE(platform, max77693_haptic_id);
415 static struct platform_driver max77693_haptic_driver = {
417 .name = "max77693-haptic",
418 .pm = pm_sleep_ptr(&max77693_haptic_pm_ops),
420 .probe = max77693_haptic_probe,
421 .id_table = max77693_haptic_id,
423 module_platform_driver(max77693_haptic_driver);
425 MODULE_AUTHOR("Jaewon Kim <jaewon02.kim@samsung.com>");
426 MODULE_AUTHOR("Krzysztof Kozlowski <krzk@kernel.org>");
427 MODULE_DESCRIPTION("MAXIM 77693/77843 Haptic driver");
428 MODULE_LICENSE("GPL");