linux/drivers/input/misc/max8997_haptic.c
<<
>>
Prefs
   1/*
   2 * MAX8997-haptic controller driver
   3 *
   4 * Copyright (C) 2012 Samsung Electronics
   5 * Donggeun Kim <dg77.kim@samsung.com>
   6 *
   7 * This program is not provided / owned by Maxim Integrated Products.
   8 *
   9 * This program is free software; you can redistribute it and/or modify
  10 * it under the terms of the GNU General Public License as published by
  11 * the Free Software Foundation; either version 2 of the License, or
  12 * (at your option) any later version.
  13 *
  14 * This program is distributed in the hope that it will be useful,
  15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 * GNU General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU General Public License
  20 * along with this program; if not, write to the Free Software
  21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22 *
  23 */
  24
  25#include <linux/module.h>
  26#include <linux/slab.h>
  27#include <linux/platform_device.h>
  28#include <linux/err.h>
  29#include <linux/pwm.h>
  30#include <linux/input.h>
  31#include <linux/mfd/max8997-private.h>
  32#include <linux/mfd/max8997.h>
  33#include <linux/regulator/consumer.h>
  34
  35/* Haptic configuration 2 register */
  36#define MAX8997_MOTOR_TYPE_SHIFT        7
  37#define MAX8997_ENABLE_SHIFT            6
  38#define MAX8997_MODE_SHIFT              5
  39
  40/* Haptic driver configuration register */
  41#define MAX8997_CYCLE_SHIFT             6
  42#define MAX8997_SIG_PERIOD_SHIFT        4
  43#define MAX8997_SIG_DUTY_SHIFT          2
  44#define MAX8997_PWM_DUTY_SHIFT          0
  45
  46struct max8997_haptic {
  47        struct device *dev;
  48        struct i2c_client *client;
  49        struct input_dev *input_dev;
  50        struct regulator *regulator;
  51
  52        struct work_struct work;
  53        struct mutex mutex;
  54
  55        bool enabled;
  56        unsigned int level;
  57
  58        struct pwm_device *pwm;
  59        unsigned int pwm_period;
  60        enum max8997_haptic_pwm_divisor pwm_divisor;
  61
  62        enum max8997_haptic_motor_type type;
  63        enum max8997_haptic_pulse_mode mode;
  64
  65        unsigned int internal_mode_pattern;
  66        unsigned int pattern_cycle;
  67        unsigned int pattern_signal_period;
  68};
  69
  70static int max8997_haptic_set_duty_cycle(struct max8997_haptic *chip)
  71{
  72        int ret = 0;
  73
  74        if (chip->mode == MAX8997_EXTERNAL_MODE) {
  75                unsigned int duty = chip->pwm_period * chip->level / 100;
  76                ret = pwm_config(chip->pwm, duty, chip->pwm_period);
  77        } else {
  78                int i;
  79                u8 duty_index = 0;
  80
  81                for (i = 0; i <= 64; i++) {
  82                        if (chip->level <= i * 100 / 64) {
  83                                duty_index = i;
  84                                break;
  85                        }
  86                }
  87                switch (chip->internal_mode_pattern) {
  88                case 0:
  89                        max8997_write_reg(chip->client,
  90                                MAX8997_HAPTIC_REG_SIGPWMDC1, duty_index);
  91                        break;
  92                case 1:
  93                        max8997_write_reg(chip->client,
  94                                MAX8997_HAPTIC_REG_SIGPWMDC2, duty_index);
  95                        break;
  96                case 2:
  97                        max8997_write_reg(chip->client,
  98                                MAX8997_HAPTIC_REG_SIGPWMDC3, duty_index);
  99                        break;
 100                case 3:
 101                        max8997_write_reg(chip->client,
 102                                MAX8997_HAPTIC_REG_SIGPWMDC4, duty_index);
 103                        break;
 104                default:
 105                        break;
 106                }
 107        }
 108        return ret;
 109}
 110
 111static void max8997_haptic_configure(struct max8997_haptic *chip)
 112{
 113        u8 value;
 114
 115        value = chip->type << MAX8997_MOTOR_TYPE_SHIFT |
 116                chip->enabled << MAX8997_ENABLE_SHIFT |
 117                chip->mode << MAX8997_MODE_SHIFT | chip->pwm_divisor;
 118        max8997_write_reg(chip->client, MAX8997_HAPTIC_REG_CONF2, value);
 119
 120        if (chip->mode == MAX8997_INTERNAL_MODE && chip->enabled) {
 121                value = chip->internal_mode_pattern << MAX8997_CYCLE_SHIFT |
 122                        chip->internal_mode_pattern << MAX8997_SIG_PERIOD_SHIFT |
 123                        chip->internal_mode_pattern << MAX8997_SIG_DUTY_SHIFT |
 124                        chip->internal_mode_pattern << MAX8997_PWM_DUTY_SHIFT;
 125                max8997_write_reg(chip->client,
 126                        MAX8997_HAPTIC_REG_DRVCONF, value);
 127
 128                switch (chip->internal_mode_pattern) {
 129                case 0:
 130                        value = chip->pattern_cycle << 4;
 131                        max8997_write_reg(chip->client,
 132                                MAX8997_HAPTIC_REG_CYCLECONF1, value);
 133                        value = chip->pattern_signal_period;
 134                        max8997_write_reg(chip->client,
 135                                MAX8997_HAPTIC_REG_SIGCONF1, value);
 136                        break;
 137
 138                case 1:
 139                        value = chip->pattern_cycle;
 140                        max8997_write_reg(chip->client,
 141                                MAX8997_HAPTIC_REG_CYCLECONF1, value);
 142                        value = chip->pattern_signal_period;
 143                        max8997_write_reg(chip->client,
 144                                MAX8997_HAPTIC_REG_SIGCONF2, value);
 145                        break;
 146
 147                case 2:
 148                        value = chip->pattern_cycle << 4;
 149                        max8997_write_reg(chip->client,
 150                                MAX8997_HAPTIC_REG_CYCLECONF2, value);
 151                        value = chip->pattern_signal_period;
 152                        max8997_write_reg(chip->client,
 153                                MAX8997_HAPTIC_REG_SIGCONF3, value);
 154                        break;
 155
 156                case 3:
 157                        value = chip->pattern_cycle;
 158                        max8997_write_reg(chip->client,
 159                                MAX8997_HAPTIC_REG_CYCLECONF2, value);
 160                        value = chip->pattern_signal_period;
 161                        max8997_write_reg(chip->client,
 162                                MAX8997_HAPTIC_REG_SIGCONF4, value);
 163                        break;
 164
 165                default:
 166                        break;
 167                }
 168        }
 169}
 170
 171static void max8997_haptic_enable(struct max8997_haptic *chip)
 172{
 173        int error;
 174
 175        mutex_lock(&chip->mutex);
 176
 177        error = max8997_haptic_set_duty_cycle(chip);
 178        if (error) {
 179                dev_err(chip->dev, "set_pwm_cycle failed, error: %d\n", error);
 180                goto out;
 181        }
 182
 183        if (!chip->enabled) {
 184                chip->enabled = true;
 185                regulator_enable(chip->regulator);
 186                max8997_haptic_configure(chip);
 187                if (chip->mode == MAX8997_EXTERNAL_MODE)
 188                        pwm_enable(chip->pwm);
 189        }
 190
 191out:
 192        mutex_unlock(&chip->mutex);
 193}
 194
 195static void max8997_haptic_disable(struct max8997_haptic *chip)
 196{
 197        mutex_lock(&chip->mutex);
 198
 199        if (chip->enabled) {
 200                chip->enabled = false;
 201                max8997_haptic_configure(chip);
 202                if (chip->mode == MAX8997_EXTERNAL_MODE)
 203                        pwm_disable(chip->pwm);
 204                regulator_disable(chip->regulator);
 205        }
 206
 207        mutex_unlock(&chip->mutex);
 208}
 209
 210static void max8997_haptic_play_effect_work(struct work_struct *work)
 211{
 212        struct max8997_haptic *chip =
 213                        container_of(work, struct max8997_haptic, work);
 214
 215        if (chip->level)
 216                max8997_haptic_enable(chip);
 217        else
 218                max8997_haptic_disable(chip);
 219}
 220
 221static int max8997_haptic_play_effect(struct input_dev *dev, void *data,
 222                                  struct ff_effect *effect)
 223{
 224        struct max8997_haptic *chip = input_get_drvdata(dev);
 225
 226        chip->level = effect->u.rumble.strong_magnitude;
 227        if (!chip->level)
 228                chip->level = effect->u.rumble.weak_magnitude;
 229
 230        schedule_work(&chip->work);
 231
 232        return 0;
 233}
 234
 235static void max8997_haptic_close(struct input_dev *dev)
 236{
 237        struct max8997_haptic *chip = input_get_drvdata(dev);
 238
 239        cancel_work_sync(&chip->work);
 240        max8997_haptic_disable(chip);
 241}
 242
 243static int max8997_haptic_probe(struct platform_device *pdev)
 244{
 245        struct max8997_dev *iodev = dev_get_drvdata(pdev->dev.parent);
 246        const struct max8997_platform_data *pdata =
 247                                        dev_get_platdata(iodev->dev);
 248        const struct max8997_haptic_platform_data *haptic_pdata =
 249                                        pdata->haptic_pdata;
 250        struct max8997_haptic *chip;
 251        struct input_dev *input_dev;
 252        int error;
 253
 254        if (!haptic_pdata) {
 255                dev_err(&pdev->dev, "no haptic platform data\n");
 256                return -EINVAL;
 257        }
 258
 259        chip = kzalloc(sizeof(struct max8997_haptic), GFP_KERNEL);
 260        input_dev = input_allocate_device();
 261        if (!chip || !input_dev) {
 262                dev_err(&pdev->dev, "unable to allocate memory\n");
 263                error = -ENOMEM;
 264                goto err_free_mem;
 265        }
 266
 267        INIT_WORK(&chip->work, max8997_haptic_play_effect_work);
 268        mutex_init(&chip->mutex);
 269
 270        chip->client = iodev->haptic;
 271        chip->dev = &pdev->dev;
 272        chip->input_dev = input_dev;
 273        chip->pwm_period = haptic_pdata->pwm_period;
 274        chip->type = haptic_pdata->type;
 275        chip->mode = haptic_pdata->mode;
 276        chip->pwm_divisor = haptic_pdata->pwm_divisor;
 277
 278        switch (chip->mode) {
 279        case MAX8997_INTERNAL_MODE:
 280                chip->internal_mode_pattern =
 281                                haptic_pdata->internal_mode_pattern;
 282                chip->pattern_cycle = haptic_pdata->pattern_cycle;
 283                chip->pattern_signal_period =
 284                                haptic_pdata->pattern_signal_period;
 285                break;
 286
 287        case MAX8997_EXTERNAL_MODE:
 288                chip->pwm = pwm_request(haptic_pdata->pwm_channel_id,
 289                                        "max8997-haptic");
 290                if (IS_ERR(chip->pwm)) {
 291                        error = PTR_ERR(chip->pwm);
 292                        dev_err(&pdev->dev,
 293                                "unable to request PWM for haptic, error: %d\n",
 294                                error);
 295                        goto err_free_mem;
 296                }
 297                break;
 298
 299        default:
 300                dev_err(&pdev->dev,
 301                        "Invalid chip mode specified (%d)\n", chip->mode);
 302                error = -EINVAL;
 303                goto err_free_mem;
 304        }
 305
 306        chip->regulator = regulator_get(&pdev->dev, "inmotor");
 307        if (IS_ERR(chip->regulator)) {
 308                error = PTR_ERR(chip->regulator);
 309                dev_err(&pdev->dev,
 310                        "unable to get regulator, error: %d\n",
 311                        error);
 312                goto err_free_pwm;
 313        }
 314
 315        input_dev->name = "max8997-haptic";
 316        input_dev->id.version = 1;
 317        input_dev->dev.parent = &pdev->dev;
 318        input_dev->close = max8997_haptic_close;
 319        input_set_drvdata(input_dev, chip);
 320        input_set_capability(input_dev, EV_FF, FF_RUMBLE);
 321
 322        error = input_ff_create_memless(input_dev, NULL,
 323                                max8997_haptic_play_effect);
 324        if (error) {
 325                dev_err(&pdev->dev,
 326                        "unable to create FF device, error: %d\n",
 327                        error);
 328                goto err_put_regulator;
 329        }
 330
 331        error = input_register_device(input_dev);
 332        if (error) {
 333                dev_err(&pdev->dev,
 334                        "unable to register input device, error: %d\n",
 335                        error);
 336                goto err_destroy_ff;
 337        }
 338
 339        platform_set_drvdata(pdev, chip);
 340        return 0;
 341
 342err_destroy_ff:
 343        input_ff_destroy(input_dev);
 344err_put_regulator:
 345        regulator_put(chip->regulator);
 346err_free_pwm:
 347        if (chip->mode == MAX8997_EXTERNAL_MODE)
 348                pwm_free(chip->pwm);
 349err_free_mem:
 350        input_free_device(input_dev);
 351        kfree(chip);
 352
 353        return error;
 354}
 355
 356static int max8997_haptic_remove(struct platform_device *pdev)
 357{
 358        struct max8997_haptic *chip = platform_get_drvdata(pdev);
 359
 360        input_unregister_device(chip->input_dev);
 361        regulator_put(chip->regulator);
 362
 363        if (chip->mode == MAX8997_EXTERNAL_MODE)
 364                pwm_free(chip->pwm);
 365
 366        kfree(chip);
 367
 368        return 0;
 369}
 370
 371#ifdef CONFIG_PM_SLEEP
 372static int max8997_haptic_suspend(struct device *dev)
 373{
 374        struct platform_device *pdev = to_platform_device(dev);
 375        struct max8997_haptic *chip = platform_get_drvdata(pdev);
 376
 377        max8997_haptic_disable(chip);
 378
 379        return 0;
 380}
 381#endif
 382
 383static SIMPLE_DEV_PM_OPS(max8997_haptic_pm_ops, max8997_haptic_suspend, NULL);
 384
 385static const struct platform_device_id max8997_haptic_id[] = {
 386        { "max8997-haptic", 0 },
 387        { },
 388};
 389MODULE_DEVICE_TABLE(i2c, max8997_haptic_id);
 390
 391static struct platform_driver max8997_haptic_driver = {
 392        .driver = {
 393                .name   = "max8997-haptic",
 394                .owner  = THIS_MODULE,
 395                .pm     = &max8997_haptic_pm_ops,
 396        },
 397        .probe          = max8997_haptic_probe,
 398        .remove         = max8997_haptic_remove,
 399        .id_table       = max8997_haptic_id,
 400};
 401module_platform_driver(max8997_haptic_driver);
 402
 403MODULE_ALIAS("platform:max8997-haptic");
 404MODULE_AUTHOR("Donggeun Kim <dg77.kim@samsung.com>");
 405MODULE_DESCRIPTION("max8997_haptic driver");
 406MODULE_LICENSE("GPL");
 407