drivers/input/keyboard/bf54x-keys.c

   1 /*
   2  * File:         drivers/input/keyboard/bf54x-keys.c
   3  * Based on:
   4  * Author:       Michael Hennerich <hennerich@blackfin.uclinux.org>
   5  *
   6  * Created:
   7  * Description:  keypad driver for Analog Devices Blackfin BF54x Processors
   8  *
   9  *
  10  * Modified:
  11  *               Copyright 2007-2008 Analog Devices Inc.
  12  *
  13  * Bugs:         Enter bugs at http://blackfin.uclinux.org/
  14  *
  15  * This program is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program; if not, see the file COPYING, or write
  27  * to the Free Software Foundation, Inc.,
  28  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  29  */
  30
  31 #include <linux/module.h>
  32
  33 #include <linux/fs.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/irq.h>
  36 #include <linux/slab.h>
  37 #include <linux/sched.h>
  38 #include <linux/pm.h>
  39 #include <linux/sysctl.h>
  40 #include <linux/proc_fs.h>
  41 #include <linux/delay.h>
  42 #include <linux/platform_device.h>
  43 #include <linux/input.h>
  44
  45 #include <asm/portmux.h>
  46 #include <mach/bf54x_keys.h>
  47
  48 #define DRV_NAME        "bf54x-keys"
  49 #define TIME_SCALE      100     /* 100 ns */
  50 #define MAX_MULT        (0xFF * TIME_SCALE)
  51 #define MAX_RC          8       /* Max Row/Col */
  52
  53 static const u16 per_rows[] = {
  54         P_KEY_ROW7,
  55         P_KEY_ROW6,
  56         P_KEY_ROW5,
  57         P_KEY_ROW4,
  58         P_KEY_ROW3,
  59         P_KEY_ROW2,
  60         P_KEY_ROW1,
  61         P_KEY_ROW0,
  62         0
  63 };
  64
  65 static const u16 per_cols[] = {
  66         P_KEY_COL7,
  67         P_KEY_COL6,
  68         P_KEY_COL5,
  69         P_KEY_COL4,
  70         P_KEY_COL3,
  71         P_KEY_COL2,
  72         P_KEY_COL1,
  73         P_KEY_COL0,
  74         0
  75 };
  76
  77 struct bf54x_kpad {
  78         struct input_dev *input;
  79         int irq;
  80         unsigned short lastkey;
  81         unsigned short *keycode;
  82         struct timer_list timer;
  83         unsigned int keyup_test_jiffies;
  84         unsigned short kpad_msel;
  85         unsigned short kpad_prescale;
  86         unsigned short kpad_ctl;
  87 };
  88
  89 static inline int bfin_kpad_find_key(struct bf54x_kpad *bf54x_kpad,
  90                         struct input_dev *input, u16 keyident)
  91 {
  92         u16 i;
  93
  94         for (i = 0; i < input->keycodemax; i++)
  95                 if (bf54x_kpad->keycode[i + input->keycodemax] == keyident)
  96                         return bf54x_kpad->keycode[i];
  97         return -1;
  98 }
  99
 100 static inline void bfin_keycodecpy(unsigned short *keycode,
 101                         const unsigned int *pdata_kc,
 102                         unsigned short keymapsize)
 103 {
 104         unsigned int i;
 105
 106         for (i = 0; i < keymapsize; i++) {
 107                 keycode[i] = pdata_kc[i] & 0xffff;
 108                 keycode[i + keymapsize] = pdata_kc[i] >> 16;
 109         }
 110 }
 111
 112 static inline u16 bfin_kpad_get_prescale(u32 timescale)
 113 {
 114         u32 sclk = get_sclk();
 115
 116         return ((((sclk / 1000) * timescale) / 1024) - 1);
 117 }
 118
 119 static inline u16 bfin_kpad_get_keypressed(struct bf54x_kpad *bf54x_kpad)
 120 {
 121         return (bfin_read_KPAD_STAT() & KPAD_PRESSED);
 122 }
 123
 124 static inline void bfin_kpad_clear_irq(void)
 125 {
 126         bfin_write_KPAD_STAT(0xFFFF);
 127         bfin_write_KPAD_ROWCOL(0xFFFF);
 128 }
 129
 130 static void bfin_kpad_timer(struct timer_list *t)
 131 {
 132         struct bf54x_kpad *bf54x_kpad = from_timer(bf54x_kpad, t, timer);
 133
 134         if (bfin_kpad_get_keypressed(bf54x_kpad)) {
 135                 /* Try again later */
 136                 mod_timer(&bf54x_kpad->timer,
 137                           jiffies + bf54x_kpad->keyup_test_jiffies);
 138                 return;
 139         }
 140
 141         input_report_key(bf54x_kpad->input, bf54x_kpad->lastkey, 0);
 142         input_sync(bf54x_kpad->input);
 143
 144         /* Clear IRQ Status */
 145
 146         bfin_kpad_clear_irq();
 147         enable_irq(bf54x_kpad->irq);
 148 }
 149
 150 static irqreturn_t bfin_kpad_isr(int irq, void *dev_id)
 151 {
 152         struct platform_device *pdev = dev_id;
 153         struct bf54x_kpad *bf54x_kpad = platform_get_drvdata(pdev);
 154         struct input_dev *input = bf54x_kpad->input;
 155         int key;
 156         u16 rowcol = bfin_read_KPAD_ROWCOL();
 157
 158         key = bfin_kpad_find_key(bf54x_kpad, input, rowcol);
 159
 160         input_report_key(input, key, 1);
 161         input_sync(input);
 162
 163         if (bfin_kpad_get_keypressed(bf54x_kpad)) {
 164                 disable_irq_nosync(bf54x_kpad->irq);
 165                 bf54x_kpad->lastkey = key;
 166                 mod_timer(&bf54x_kpad->timer,
 167                           jiffies + bf54x_kpad->keyup_test_jiffies);
 168         } else {
 169                 input_report_key(input, key, 0);
 170                 input_sync(input);
 171
 172                 bfin_kpad_clear_irq();
 173         }
 174
 175         return IRQ_HANDLED;
 176 }
 177
 178 static int bfin_kpad_probe(struct platform_device *pdev)
 179 {
 180         struct bf54x_kpad *bf54x_kpad;
 181         struct bfin_kpad_platform_data *pdata = dev_get_platdata(&pdev->dev);
 182         struct input_dev *input;
 183         int i, error;
 184
 185         if (!pdata->rows || !pdata->cols || !pdata->keymap) {
 186                 dev_err(&pdev->dev, "no rows, cols or keymap from pdata\n");
 187                 return -EINVAL;
 188         }
 189
 190         if (!pdata->keymapsize ||
 191             pdata->keymapsize > (pdata->rows * pdata->cols)) {
 192                 dev_err(&pdev->dev, "invalid keymapsize\n");
 193                 return -EINVAL;
 194         }
 195
 196         bf54x_kpad = kzalloc(sizeof(struct bf54x_kpad), GFP_KERNEL);
 197         if (!bf54x_kpad)
 198                 return -ENOMEM;
 199
 200         platform_set_drvdata(pdev, bf54x_kpad);
 201
 202         /* Allocate memory for keymap followed by private LUT */
 203         bf54x_kpad->keycode = kmalloc(pdata->keymapsize *
 204                                         sizeof(unsigned short) * 2, GFP_KERNEL);
 205         if (!bf54x_kpad->keycode) {
 206                 error = -ENOMEM;
 207                 goto out;
 208         }
 209
 210         if (!pdata->debounce_time || pdata->debounce_time > MAX_MULT ||
 211             !pdata->coldrive_time || pdata->coldrive_time > MAX_MULT) {
 212                 dev_warn(&pdev->dev,
 213                         "invalid platform debounce/columndrive time\n");
 214                 bfin_write_KPAD_MSEL(0xFF0);    /* Default MSEL */
 215         } else {
 216                 bfin_write_KPAD_MSEL(
 217                         ((pdata->debounce_time / TIME_SCALE)
 218                                                 & DBON_SCALE) |
 219                         (((pdata->coldrive_time / TIME_SCALE) << 8)
 220                                                 & COLDRV_SCALE));
 221
 222         }
 223
 224         if (!pdata->keyup_test_interval)
 225                 bf54x_kpad->keyup_test_jiffies = msecs_to_jiffies(50);
 226         else
 227                 bf54x_kpad->keyup_test_jiffies =
 228                         msecs_to_jiffies(pdata->keyup_test_interval);
 229
 230         if (peripheral_request_list((u16 *)&per_rows[MAX_RC - pdata->rows],
 231                                     DRV_NAME)) {
 232                 dev_err(&pdev->dev, "requesting peripherals failed\n");
 233                 error = -EFAULT;
 234                 goto out0;
 235         }
 236
 237         if (peripheral_request_list((u16 *)&per_cols[MAX_RC - pdata->cols],
 238                                     DRV_NAME)) {
 239                 dev_err(&pdev->dev, "requesting peripherals failed\n");
 240                 error = -EFAULT;
 241                 goto out1;
 242         }
 243
 244         bf54x_kpad->irq = platform_get_irq(pdev, 0);
 245         if (bf54x_kpad->irq < 0) {
 246                 error = -ENODEV;
 247                 goto out2;
 248         }
 249
 250         error = request_irq(bf54x_kpad->irq, bfin_kpad_isr,
 251                                 0, DRV_NAME, pdev);
 252         if (error) {
 253                 dev_err(&pdev->dev, "unable to claim irq %d\n",
 254                         bf54x_kpad->irq);
 255                 goto out2;
 256         }
 257
 258         input = input_allocate_device();
 259         if (!input) {
 260                 error = -ENOMEM;
 261                 goto out3;
 262         }
 263
 264         bf54x_kpad->input = input;
 265
 266         input->name = pdev->name;
 267         input->phys = "bf54x-keys/input0";
 268         input->dev.parent = &pdev->dev;
 269
 270         input->id.bustype = BUS_HOST;
 271         input->id.vendor = 0x0001;
 272         input->id.product = 0x0001;
 273         input->id.version = 0x0100;
 274
 275         input->keycodesize = sizeof(unsigned short);
 276         input->keycodemax = pdata->keymapsize;
 277         input->keycode = bf54x_kpad->keycode;
 278
 279         bfin_keycodecpy(bf54x_kpad->keycode, pdata->keymap, pdata->keymapsize);
 280
 281         /* setup input device */
 282         __set_bit(EV_KEY, input->evbit);
 283
 284         if (pdata->repeat)
 285                 __set_bit(EV_REP, input->evbit);
 286
 287         for (i = 0; i < input->keycodemax; i++)
 288                 if (bf54x_kpad->keycode[i] <= KEY_MAX)
 289                         __set_bit(bf54x_kpad->keycode[i], input->keybit);
 290         __clear_bit(KEY_RESERVED, input->keybit);
 291
 292         error = input_register_device(input);
 293         if (error) {
 294                 dev_err(&pdev->dev, "unable to register input device\n");
 295                 goto out4;
 296         }
 297
 298         /* Init Keypad Key Up/Release test timer */
 299
 300         timer_setup(&bf54x_kpad->timer, bfin_kpad_timer, 0);
 301
 302         bfin_write_KPAD_PRESCALE(bfin_kpad_get_prescale(TIME_SCALE));
 303
 304         bfin_write_KPAD_CTL((((pdata->cols - 1) << 13) & KPAD_COLEN) |
 305                                 (((pdata->rows - 1) << 10) & KPAD_ROWEN) |
 306                                 (2 & KPAD_IRQMODE));
 307
 308         bfin_write_KPAD_CTL(bfin_read_KPAD_CTL() | KPAD_EN);
 309
 310         device_init_wakeup(&pdev->dev, 1);
 311
 312         return 0;
 313
 314 out4:
 315         input_free_device(input);
 316 out3:
 317         free_irq(bf54x_kpad->irq, pdev);
 318 out2:
 319         peripheral_free_list((u16 *)&per_cols[MAX_RC - pdata->cols]);
 320 out1:
 321         peripheral_free_list((u16 *)&per_rows[MAX_RC - pdata->rows]);
 322 out0:
 323         kfree(bf54x_kpad->keycode);
 324 out:
 325         kfree(bf54x_kpad);
 326
 327         return error;
 328 }
 329
 330 static int bfin_kpad_remove(struct platform_device *pdev)
 331 {
 332         struct bfin_kpad_platform_data *pdata = dev_get_platdata(&pdev->dev);
 333         struct bf54x_kpad *bf54x_kpad = platform_get_drvdata(pdev);
 334
 335         del_timer_sync(&bf54x_kpad->timer);
 336         free_irq(bf54x_kpad->irq, pdev);
 337
 338         input_unregister_device(bf54x_kpad->input);
 339
 340         peripheral_free_list((u16 *)&per_rows[MAX_RC - pdata->rows]);
 341         peripheral_free_list((u16 *)&per_cols[MAX_RC - pdata->cols]);
 342
 343         kfree(bf54x_kpad->keycode);
 344         kfree(bf54x_kpad);
 345
 346         return 0;
 347 }
 348
 349 #ifdef CONFIG_PM
 350 static int bfin_kpad_suspend(struct platform_device *pdev, pm_message_t state)
 351 {
 352         struct bf54x_kpad *bf54x_kpad = platform_get_drvdata(pdev);
 353
 354         bf54x_kpad->kpad_msel = bfin_read_KPAD_MSEL();
 355         bf54x_kpad->kpad_prescale = bfin_read_KPAD_PRESCALE();
 356         bf54x_kpad->kpad_ctl = bfin_read_KPAD_CTL();
 357
 358         if (device_may_wakeup(&pdev->dev))
 359                 enable_irq_wake(bf54x_kpad->irq);
 360
 361         return 0;
 362 }
 363
 364 static int bfin_kpad_resume(struct platform_device *pdev)
 365 {
 366         struct bf54x_kpad *bf54x_kpad = platform_get_drvdata(pdev);
 367
 368         bfin_write_KPAD_MSEL(bf54x_kpad->kpad_msel);
 369         bfin_write_KPAD_PRESCALE(bf54x_kpad->kpad_prescale);
 370         bfin_write_KPAD_CTL(bf54x_kpad->kpad_ctl);
 371
 372         if (device_may_wakeup(&pdev->dev))
 373                 disable_irq_wake(bf54x_kpad->irq);
 374
 375         return 0;
 376 }
 377 #else
 378 # define bfin_kpad_suspend NULL
 379 # define bfin_kpad_resume  NULL
 380 #endif
 381
 382 static struct platform_driver bfin_kpad_device_driver = {
 383         .driver         = {
 384                 .name   = DRV_NAME,
 385         },
 386         .probe          = bfin_kpad_probe,
 387         .remove         = bfin_kpad_remove,
 388         .suspend        = bfin_kpad_suspend,
 389         .resume         = bfin_kpad_resume,
 390 };
 391 module_platform_driver(bfin_kpad_device_driver);
 392
 393 MODULE_LICENSE("GPL");
 394 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
 395 MODULE_DESCRIPTION("Keypad driver for BF54x Processors");
 396 MODULE_ALIAS("platform:bf54x-keys");