input/misc/pm8xxx-vibrator.c

0001 // SPDX-License-Identifier: GPL-2.0-only
0002 /* Copyright (c) 2010-2011, Code Aurora Forum. All rights reserved.
0003  */
0004
0005 #include <linux/errno.h>
0006 #include <linux/input.h>
0007 #include <linux/kernel.h>
0008 #include <linux/module.h>
0009 #include <linux/of.h>
0010 #include <linux/of_device.h>
0011 #include <linux/platform_device.h>
0012 #include <linux/regmap.h>
0013 #include <linux/slab.h>
0014
0015 #define VIB_MAX_LEVEL_mV    (3100)
0016 #define VIB_MIN_LEVEL_mV    (1200)
0017 #define VIB_MAX_LEVELS      (VIB_MAX_LEVEL_mV - VIB_MIN_LEVEL_mV)
0018
0019 #define MAX_FF_SPEED        0xff
0020
0021 struct pm8xxx_regs {
0022     unsigned int enable_addr;
0023     unsigned int enable_mask;
0024
0025     unsigned int drv_addr;
0026     unsigned int drv_mask;
0027     unsigned int drv_shift;
0028     unsigned int drv_en_manual_mask;
0029 };
0030
0031 static const struct pm8xxx_regs pm8058_regs = {
0032     .drv_addr = 0x4A,
0033     .drv_mask = 0xf8,
0034     .drv_shift = 3,
0035     .drv_en_manual_mask = 0xfc,
0036 };
0037
0038 static struct pm8xxx_regs pm8916_regs = {
0039     .enable_addr = 0xc046,
0040     .enable_mask = BIT(7),
0041     .drv_addr = 0xc041,
0042     .drv_mask = 0x1F,
0043     .drv_shift = 0,
0044     .drv_en_manual_mask = 0,
0045 };
0046
0047 /**
0048  * struct pm8xxx_vib - structure to hold vibrator data
0049  * @vib_input_dev: input device supporting force feedback
0050  * @work: work structure to set the vibration parameters
0051  * @regmap: regmap for register read/write
0052  * @regs: registers' info
0053  * @speed: speed of vibration set from userland
0054  * @active: state of vibrator
0055  * @level: level of vibration to set in the chip
0056  * @reg_vib_drv: regs->drv_addr register value
0057  */
0058 struct pm8xxx_vib {
0059     struct input_dev *vib_input_dev;
0060     struct work_struct work;
0061     struct regmap *regmap;
0062     const struct pm8xxx_regs *regs;
0063     int speed;
0064     int level;
0065     bool active;
0066     u8  reg_vib_drv;
0067 };
0068
0069 /**
0070  * pm8xxx_vib_set - handler to start/stop vibration
0071  * @vib: pointer to vibrator structure
0072  * @on: state to set
0073  */
0074 static int pm8xxx_vib_set(struct pm8xxx_vib *vib, bool on)
0075 {
0076     int rc;
0077     unsigned int val = vib->reg_vib_drv;
0078     const struct pm8xxx_regs *regs = vib->regs;
0079
0080     if (on)
0081         val |= (vib->level << regs->drv_shift) & regs->drv_mask;
0082     else
0083         val &= ~regs->drv_mask;
0084
0085     rc = regmap_write(vib->regmap, regs->drv_addr, val);
0086     if (rc < 0)
0087         return rc;
0088
0089     vib->reg_vib_drv = val;
0090
0091     if (regs->enable_mask)
0092         rc = regmap_update_bits(vib->regmap, regs->enable_addr,
0093                     regs->enable_mask, on ? ~0 : 0);
0094
0095     return rc;
0096 }
0097
0098 /**
0099  * pm8xxx_work_handler - worker to set vibration level
0100  * @work: pointer to work_struct
0101  */
0102 static void pm8xxx_work_handler(struct work_struct *work)
0103 {
0104     struct pm8xxx_vib *vib = container_of(work, struct pm8xxx_vib, work);
0105     const struct pm8xxx_regs *regs = vib->regs;
0106     int rc;
0107     unsigned int val;
0108
0109     rc = regmap_read(vib->regmap, regs->drv_addr, &val);
0110     if (rc < 0)
0111         return;
0112
0113     /*
0114      * pmic vibrator supports voltage ranges from 1.2 to 3.1V, so
0115      * scale the level to fit into these ranges.
0116      */
0117     if (vib->speed) {
0118         vib->active = true;
0119         vib->level = ((VIB_MAX_LEVELS * vib->speed) / MAX_FF_SPEED) +
0120                         VIB_MIN_LEVEL_mV;
0121         vib->level /= 100;
0122     } else {
0123         vib->active = false;
0124         vib->level = VIB_MIN_LEVEL_mV / 100;
0125     }
0126
0127     pm8xxx_vib_set(vib, vib->active);
0128 }
0129
0130 /**
0131  * pm8xxx_vib_close - callback of input close callback
0132  * @dev: input device pointer
0133  *
0134  * Turns off the vibrator.
0135  */
0136 static void pm8xxx_vib_close(struct input_dev *dev)
0137 {
0138     struct pm8xxx_vib *vib = input_get_drvdata(dev);
0139
0140     cancel_work_sync(&vib->work);
0141     if (vib->active)
0142         pm8xxx_vib_set(vib, false);
0143 }
0144
0145 /**
0146  * pm8xxx_vib_play_effect - function to handle vib effects.
0147  * @dev: input device pointer
0148  * @data: data of effect
0149  * @effect: effect to play
0150  *
0151  * Currently this driver supports only rumble effects.
0152  */
0153 static int pm8xxx_vib_play_effect(struct input_dev *dev, void *data,
0154                   struct ff_effect *effect)
0155 {
0156     struct pm8xxx_vib *vib = input_get_drvdata(dev);
0157
0158     vib->speed = effect->u.rumble.strong_magnitude >> 8;
0159     if (!vib->speed)
0160         vib->speed = effect->u.rumble.weak_magnitude >> 9;
0161
0162     schedule_work(&vib->work);
0163
0164     return 0;
0165 }
0166
0167 static int pm8xxx_vib_probe(struct platform_device *pdev)
0168 {
0169     struct pm8xxx_vib *vib;
0170     struct input_dev *input_dev;
0171     int error;
0172     unsigned int val;
0173     const struct pm8xxx_regs *regs;
0174
0175     vib = devm_kzalloc(&pdev->dev, sizeof(*vib), GFP_KERNEL);
0176     if (!vib)
0177         return -ENOMEM;
0178
0179     vib->regmap = dev_get_regmap(pdev->dev.parent, NULL);
0180     if (!vib->regmap)
0181         return -ENODEV;
0182
0183     input_dev = devm_input_allocate_device(&pdev->dev);
0184     if (!input_dev)
0185         return -ENOMEM;
0186
0187     INIT_WORK(&vib->work, pm8xxx_work_handler);
0188     vib->vib_input_dev = input_dev;
0189
0190     regs = of_device_get_match_data(&pdev->dev);
0191
0192     /* operate in manual mode */
0193     error = regmap_read(vib->regmap, regs->drv_addr, &val);
0194     if (error < 0)
0195         return error;
0196
0197     val &= regs->drv_en_manual_mask;
0198     error = regmap_write(vib->regmap, regs->drv_addr, val);
0199     if (error < 0)
0200         return error;
0201
0202     vib->regs = regs;
0203     vib->reg_vib_drv = val;
0204
0205     input_dev->name = "pm8xxx_vib_ffmemless";
0206     input_dev->id.version = 1;
0207     input_dev->close = pm8xxx_vib_close;
0208     input_set_drvdata(input_dev, vib);
0209     input_set_capability(vib->vib_input_dev, EV_FF, FF_RUMBLE);
0210
0211     error = input_ff_create_memless(input_dev, NULL,
0212                     pm8xxx_vib_play_effect);
0213     if (error) {
0214         dev_err(&pdev->dev,
0215             "couldn't register vibrator as FF device\n");
0216         return error;
0217     }
0218
0219     error = input_register_device(input_dev);
0220     if (error) {
0221         dev_err(&pdev->dev, "couldn't register input device\n");
0222         return error;
0223     }
0224
0225     platform_set_drvdata(pdev, vib);
0226     return 0;
0227 }
0228
0229 static int __maybe_unused pm8xxx_vib_suspend(struct device *dev)
0230 {
0231     struct pm8xxx_vib *vib = dev_get_drvdata(dev);
0232
0233     /* Turn off the vibrator */
0234     pm8xxx_vib_set(vib, false);
0235
0236     return 0;
0237 }
0238
0239 static SIMPLE_DEV_PM_OPS(pm8xxx_vib_pm_ops, pm8xxx_vib_suspend, NULL);
0240
0241 static const struct of_device_id pm8xxx_vib_id_table[] = {
0242     { .compatible = "qcom,pm8058-vib", .data = &pm8058_regs },
0243     { .compatible = "qcom,pm8921-vib", .data = &pm8058_regs },
0244     { .compatible = "qcom,pm8916-vib", .data = &pm8916_regs },
0245     { }
0246 };
0247 MODULE_DEVICE_TABLE(of, pm8xxx_vib_id_table);
0248
0249 static struct platform_driver pm8xxx_vib_driver = {
0250     .probe      = pm8xxx_vib_probe,
0251     .driver     = {
0252         .name   = "pm8xxx-vib",
0253         .pm = &pm8xxx_vib_pm_ops,
0254         .of_match_table = pm8xxx_vib_id_table,
0255     },
0256 };
0257 module_platform_driver(pm8xxx_vib_driver);
0258
0259 MODULE_ALIAS("platform:pm8xxx_vib");
0260 MODULE_DESCRIPTION("PMIC8xxx vibrator driver based on ff-memless framework");
0261 MODULE_LICENSE("GPL v2");
0262 MODULE_AUTHOR("Amy Maloche <amaloche@codeaurora.org>");