drivers/input/touchscreen/h3600_ts_input.c

   1 /*
   2  * $Id: h3600_ts_input.c,v 1.4 2002/01/23 06:39:37 jsimmons Exp $
   3  *
   4  *  Copyright (c) 2001 "Crazy" James Simmons jsimmons@transvirtual.com
   5  *
   6  *  Sponsored by Transvirtual Technology.
   7  *
   8  *  Derived from the code in h3600_ts.[ch] by Charles Flynn
   9  */
  10
  11 /*
  12  * Driver for the h3600 Touch Screen and other Atmel controlled devices.
  13  */
  14
  15 /*
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  29  *
  30  * Should you need to contact me, the author, you can do so by
  31  * e-mail - mail your message to <jsimmons@transvirtual.com>.
  32  */
  33
  34 #include <linux/errno.h>
  35 #include <linux/kernel.h>
  36 #include <linux/module.h>
  37 #include <linux/slab.h>
  38 #include <linux/input.h>
  39 #include <linux/serio.h>
  40 #include <linux/init.h>
  41 #include <linux/delay.h>
  42 #include <linux/pm.h>
  43
  44 /* SA1100 serial defines */
  45 #include <asm/arch/hardware.h>
  46 #include <asm/arch/irqs.h>
  47
  48 MODULE_AUTHOR("James Simmons <jsimmons@transvirtual.com>");
  49 MODULE_DESCRIPTION("H3600 touchscreen driver");
  50 MODULE_LICENSE("GPL");
  51
  52 /*
  53  * Definitions & global arrays.
  54  */
  55
  56 /* The start and end of frame characters SOF and EOF */
  57 #define CHAR_SOF                0x02
  58 #define CHAR_EOF                0x03
  59 #define FRAME_OVERHEAD          3       /* CHAR_SOF,CHAR_EOF,LENGTH = 3 */
  60
  61 /*
  62         Atmel events and response IDs contained in frame.
  63         Programmer has no control over these numbers.
  64         TODO there are holes - specifically  1,7,0x0a
  65 */
  66 #define VERSION_ID              0       /* Get Version (request/respose) */
  67 #define KEYBD_ID                2       /* Keyboard (event) */
  68 #define TOUCHS_ID               3       /* Touch Screen (event)*/
  69 #define EEPROM_READ_ID          4       /* (request/response) */
  70 #define EEPROM_WRITE_ID         5       /* (request/response) */
  71 #define THERMAL_ID              6       /* (request/response) */
  72 #define NOTIFY_LED_ID           8       /* (request/response) */
  73 #define BATTERY_ID              9       /* (request/response) */
  74 #define SPI_READ_ID             0x0b    /* ( request/response) */
  75 #define SPI_WRITE_ID            0x0c    /* ( request/response) */
  76 #define FLITE_ID                0x0d    /* backlight ( request/response) */
  77 #define STX_ID                  0xa1    /* extension pack status (req/resp) */
  78
  79 #define MAX_ID                  14
  80
  81 #define H3600_MAX_LENGTH 16
  82 #define H3600_KEY 0xf
  83
  84 #define H3600_SCANCODE_RECORD   1        /* 1 -> record button */
  85 #define H3600_SCANCODE_CALENDAR 2        /* 2 -> calendar */
  86 #define H3600_SCANCODE_CONTACTS 3        /* 3 -> contact */
  87 #define H3600_SCANCODE_Q        4        /* 4 -> Q button */
  88 #define H3600_SCANCODE_START    5        /* 5 -> start menu */
  89 #define H3600_SCANCODE_UP       6        /* 6 -> up */
  90 #define H3600_SCANCODE_RIGHT    7        /* 7 -> right */
  91 #define H3600_SCANCODE_LEFT     8        /* 8 -> left */
  92 #define H3600_SCANCODE_DOWN     9        /* 9 -> down */
  93
  94 static char *h3600_name = "H3600 TouchScreen";
  95
  96 /*
  97  * Per-touchscreen data.
  98  */
  99 struct h3600_dev {
 100         struct input_dev dev;
 101         struct serio *serio;
 102         unsigned char event;    /* event ID from packet */
 103         unsigned char chksum;
 104         unsigned char len;
 105         unsigned char idx;
 106         unsigned char buf[H3600_MAX_LENGTH];
 107         char phys[32];
 108 };
 109
 110 static irqreturn_t action_button_handler(int irq, void *dev_id, struct pt_regs *regs)
 111 {
 112         int down = (GPLR & GPIO_BITSY_ACTION_BUTTON) ? 0 : 1;
 113         struct input_dev *dev = (struct input_dev *) dev_id;
 114
 115         input_regs(dev, regs);
 116         input_report_key(dev, KEY_ENTER, down);
 117         input_sync(dev);
 118
 119         return IRQ_HANDLED;
 120 }
 121
 122 static irqreturn_t npower_button_handler(int irq, void *dev_id, struct pt_regs *regs)
 123 {
 124         int down = (GPLR & GPIO_BITSY_NPOWER_BUTTON) ? 0 : 1;
 125         struct input_dev *dev = (struct input_dev *) dev_id;
 126
 127         /*
 128          * This interrupt is only called when we release the key. So we have
 129          * to fake a key press.
 130          */
 131         input_regs(dev, regs);
 132         input_report_key(dev, KEY_SUSPEND, 1);
 133         input_report_key(dev, KEY_SUSPEND, down);
 134         input_sync(dev);
 135
 136         return IRQ_HANDLED;
 137 }
 138
 139 #ifdef CONFIG_PM
 140
 141 static int flite_brightness = 25;
 142
 143 enum flite_pwr {
 144         FLITE_PWR_OFF = 0,
 145         FLITE_PWR_ON = 1
 146 };
 147
 148 /*
 149  * h3600_flite_power: enables or disables power to frontlight, using last bright */
 150 unsigned int h3600_flite_power(struct input_dev *dev, enum flite_pwr pwr)
 151 {
 152         unsigned char brightness = (pwr == FLITE_PWR_OFF) ? 0 : flite_brightness;
 153         struct h3600_dev *ts = dev->private;
 154
 155         /* Must be in this order */
 156         ts->serio->write(ts->serio, 1);
 157         ts->serio->write(ts->serio, pwr);
 158         ts->serio->write(ts->serio, brightness);
 159         return 0;
 160 }
 161
 162 static int suspended = 0;
 163 static int h3600ts_pm_callback(struct pm_dev *pm_dev, pm_request_t req,
 164                                 void *data)
 165 {
 166         struct input_dev *dev = (struct input_dev *) data;
 167
 168         switch (req) {
 169         case PM_SUSPEND: /* enter D1-D3 */
 170                 suspended = 1;
 171                 h3600_flite_power(dev, FLITE_PWR_OFF);
 172                 break;
 173         case PM_BLANK:
 174                 if (!suspended)
 175                         h3600_flite_power(dev, FLITE_PWR_OFF);
 176                 break;
 177         case PM_RESUME:  /* enter D0 */
 178                 /* same as unblank */
 179         case PM_UNBLANK:
 180                 if (suspended) {
 181                         //initSerial();
 182                         suspended = 0;
 183                 }
 184                 h3600_flite_power(dev, FLITE_PWR_ON);
 185                 break;
 186         }
 187         return 0;
 188 }
 189 #endif
 190
 191 /*
 192  * This function translates the native event packets to linux input event
 193  * packets. Some packets coming from serial are not touchscreen related. In
 194  * this case we send them off to be processed elsewhere.
 195  */
 196 static void h3600ts_process_packet(struct h3600_dev *ts, struct pt_regs *regs)
 197 {
 198         struct input_dev *dev = &ts->dev;
 199         static int touched = 0;
 200         int key, down = 0;
 201
 202         input_regs(dev, regs);
 203
 204         switch (ts->event) {
 205                 /*
 206                    Buttons - returned as a single byte
 207                         7 6 5 4 3 2 1 0
 208                         S x x x N N N N
 209
 210                    S       switch state ( 0=pressed 1=released)
 211                    x       Unused.
 212                    NNNN    switch number 0-15
 213
 214                 Note: This is true for non interrupt generated key events.
 215                 */
 216                 case KEYBD_ID:
 217                         down = (ts->buf[0] & 0x80) ? 0 : 1;
 218
 219                         switch (ts->buf[0] & 0x7f) {
 220                                 case H3600_SCANCODE_RECORD:
 221                                         key = KEY_RECORD;
 222                                         break;
 223                                 case H3600_SCANCODE_CALENDAR:
 224                                         key = KEY_PROG1;
 225                                         break;
 226                                 case H3600_SCANCODE_CONTACTS:
 227                                         key = KEY_PROG2;
 228                                         break;
 229                                 case H3600_SCANCODE_Q:
 230                                         key = KEY_Q;
 231                                         break;
 232                                 case H3600_SCANCODE_START:
 233                                         key = KEY_PROG3;
 234                                         break;
 235                                 case H3600_SCANCODE_UP:
 236                                         key = KEY_UP;
 237                                         break;
 238                                 case H3600_SCANCODE_RIGHT:
 239                                         key = KEY_RIGHT;
 240                                         break;
 241                                 case H3600_SCANCODE_LEFT:
 242                                         key = KEY_LEFT;
 243                                         break;
 244                                 case H3600_SCANCODE_DOWN:
 245                                         key = KEY_DOWN;
 246                                         break;
 247                                 default:
 248                                         key = 0;
 249                         }
 250                         if (key)
 251                                 input_report_key(dev, key, down);
 252                         break;
 253                 /*
 254                  * Native touchscreen event data is formatted as shown below:-
 255                  *
 256                  *      +-------+-------+-------+-------+
 257                  *      | Xmsb  | Xlsb  | Ymsb  | Ylsb  |
 258                  *      +-------+-------+-------+-------+
 259                  *       byte 0    1       2       3
 260                  */
 261                 case TOUCHS_ID:
 262                         if (!touched) {
 263                                 input_report_key(dev, BTN_TOUCH, 1);
 264                                 touched = 1;
 265                         }
 266
 267                         if (ts->len) {
 268                                 unsigned short x, y;
 269
 270                                 x = ts->buf[0]; x <<= 8; x += ts->buf[1];
 271                                 y = ts->buf[2]; y <<= 8; y += ts->buf[3];
 272
 273                                 input_report_abs(dev, ABS_X, x);
 274                                 input_report_abs(dev, ABS_Y, y);
 275                         } else {
 276                                 input_report_key(dev, BTN_TOUCH, 0);
 277                                 touched = 0;
 278                         }
 279                         break;
 280                 default:
 281                         /* Send a non input event elsewhere */
 282                         break;
 283         }
 284
 285         input_sync(dev);
 286 }
 287
 288 /*
 289  * h3600ts_event() handles events from the input module.
 290  */
 291 static int h3600ts_event(struct input_dev *dev, unsigned int type,
 292                          unsigned int code, int value)
 293 {
 294         struct h3600_dev *ts = dev->private;
 295
 296         switch (type) {
 297                 case EV_LED: {
 298                 //      ts->serio->write(ts->serio, SOME_CMD);
 299                         return 0;
 300                 }
 301         }
 302         return -1;
 303 }
 304
 305 /*
 306         Frame format
 307   byte    1       2               3              len + 4
 308         +-------+---------------+---------------+--=------------+
 309         |SOF    |id     |len    | len bytes     | Chksum        |
 310         +-------+---------------+---------------+--=------------+
 311   bit   0     7  8    11 12   15 16
 312
 313         +-------+---------------+-------+
 314         |SOF    |id     |0      |Chksum | - Note Chksum does not include SOF
 315         +-------+---------------+-------+
 316   bit   0     7  8    11 12   15 16
 317
 318 */
 319
 320 static int state;
 321
 322 /* decode States  */
 323 #define STATE_SOF       0       /* start of FRAME */
 324 #define STATE_ID        1       /* state where we decode the ID & len */
 325 #define STATE_DATA      2       /* state where we decode data */
 326 #define STATE_EOF       3       /* state where we decode checksum or EOF */
 327
 328 static irqreturn_t h3600ts_interrupt(struct serio *serio, unsigned char data,
 329                                      unsigned int flags, struct pt_regs *regs)
 330 {
 331         struct h3600_dev *ts = serio->private;
 332
 333         /*
 334          * We have a new frame coming in.
 335          */
 336         switch (state) {
 337                 case STATE_SOF:
 338                         if (data == CHAR_SOF)
 339                                 state = STATE_ID;
 340                         break;
 341                 case STATE_ID:
 342                         ts->event = (data & 0xf0) >> 4;
 343                         ts->len = (data & 0xf);
 344                         ts->idx = 0;
 345                         if (ts->event >= MAX_ID) {
 346                                 state = STATE_SOF;
 347                                 break;
 348                         }
 349                         ts->chksum = data;
 350                         state = (ts->len > 0) ? STATE_DATA : STATE_EOF;
 351                         break;
 352                 case STATE_DATA:
 353                         ts->chksum += data;
 354                         ts->buf[ts->idx]= data;
 355                         if(++ts->idx == ts->len)
 356                                 state = STATE_EOF;
 357                         break;
 358                 case STATE_EOF:
 359                         state = STATE_SOF;
 360                         if (data == CHAR_EOF || data == ts->chksum)
 361                                 h3600ts_process_packet(ts, regs);
 362                         break;
 363                 default:
 364                         printk("Error3\n");
 365                         break;
 366         }
 367
 368         return IRQ_HANDLED;
 369 }
 370
 371 /*
 372  * h3600ts_connect() is the routine that is called when someone adds a
 373  * new serio device. It looks whether it was registered as a H3600 touchscreen
 374  * and if yes, registers it as an input device.
 375  */
 376 static void h3600ts_connect(struct serio *serio, struct serio_dev *dev)
 377 {
 378         struct h3600_dev *ts;
 379
 380         if (serio->type != (SERIO_RS232 | SERIO_H3600))
 381                 return;
 382
 383         if (!(ts = kmalloc(sizeof(struct h3600_dev), GFP_KERNEL)))
 384                 return;
 385
 386         memset(ts, 0, sizeof(struct h3600_dev));
 387
 388         init_input_dev(&ts->dev);
 389
 390         /* Device specific stuff */
 391         set_GPIO_IRQ_edge(GPIO_BITSY_ACTION_BUTTON, GPIO_BOTH_EDGES);
 392         set_GPIO_IRQ_edge(GPIO_BITSY_NPOWER_BUTTON, GPIO_RISING_EDGE);
 393
 394         if (request_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, action_button_handler,
 395                         SA_SHIRQ | SA_INTERRUPT | SA_SAMPLE_RANDOM,
 396                         "h3600_action", &ts->dev)) {
 397                 printk(KERN_ERR "h3600ts.c: Could not allocate Action Button IRQ!\n");
 398                 kfree(ts);
 399                 return;
 400         }
 401
 402         if (request_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, npower_button_handler,
 403                         SA_SHIRQ | SA_INTERRUPT | SA_SAMPLE_RANDOM,
 404                         "h3600_suspend", &ts->dev)) {
 405                 free_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, &ts->dev);
 406                 printk(KERN_ERR "h3600ts.c: Could not allocate Power Button IRQ!\n");
 407                 kfree(ts);
 408                 return;
 409         }
 410
 411         /* Now we have things going we setup our input device */
 412         ts->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS) | BIT(EV_LED) | BIT(EV_PWR);
 413         ts->dev.ledbit[0] = BIT(LED_SLEEP);
 414         input_set_abs_params(&ts->dev, ABS_X, 60, 985, 0, 0);
 415         input_set_abs_params(&ts->dev, ABS_Y, 35, 1024, 0, 0);
 416
 417         set_bit(KEY_RECORD, ts->dev.keybit);
 418         set_bit(KEY_Q, ts->dev.keybit);
 419         set_bit(KEY_PROG1, ts->dev.keybit);
 420         set_bit(KEY_PROG2, ts->dev.keybit);
 421         set_bit(KEY_PROG3, ts->dev.keybit);
 422         set_bit(KEY_UP, ts->dev.keybit);
 423         set_bit(KEY_RIGHT, ts->dev.keybit);
 424         set_bit(KEY_LEFT, ts->dev.keybit);
 425         set_bit(KEY_DOWN, ts->dev.keybit);
 426         set_bit(KEY_ENTER, ts->dev.keybit);
 427         ts->dev.keybit[LONG(BTN_TOUCH)] |= BIT(BTN_TOUCH);
 428         ts->dev.keybit[LONG(KEY_SUSPEND)] |= BIT(KEY_SUSPEND);
 429
 430         ts->serio = serio;
 431         serio->private = ts;
 432
 433         sprintf(ts->phys, "%s/input0", serio->phys);
 434
 435         ts->dev.event = h3600ts_event;
 436         ts->dev.private = ts;
 437         ts->dev.name = h3600_name;
 438         ts->dev.phys = ts->phys;
 439         ts->dev.id.bustype = BUS_RS232;
 440         ts->dev.id.vendor = SERIO_H3600;
 441         ts->dev.id.product = 0x0666;  /* FIXME !!! We can ask the hardware */
 442         ts->dev.id.version = 0x0100;
 443
 444         if (serio_open(serio, dev)) {
 445                 free_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, ts);
 446                 free_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, ts);
 447                 kfree(ts);
 448                 return;
 449         }
 450
 451         //h3600_flite_control(1, 25);     /* default brightness */
 452 #ifdef CONFIG_PM
 453         ts->dev.pm_dev = pm_register(PM_ILLUMINATION_DEV, PM_SYS_LIGHT,
 454                                         h3600ts_pm_callback);
 455         printk("registered pm callback\n");
 456 #endif
 457         input_register_device(&ts->dev);
 458
 459         printk(KERN_INFO "input: %s on %s\n", h3600_name, serio->phys);
 460 }
 461
 462 /*
 463  * h3600ts_disconnect() is the opposite of h3600ts_connect()
 464  */
 465
 466 static void h3600ts_disconnect(struct serio *serio)
 467 {
 468         struct h3600_dev *ts = serio->private;
 469
 470         free_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, &ts->dev);
 471         free_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, &ts->dev);
 472         input_unregister_device(&ts->dev);
 473         serio_close(serio);
 474         kfree(ts);
 475 }
 476
 477 /*
 478  * The serio device structure.
 479  */
 480
 481 static struct serio_dev h3600ts_dev = {
 482         .interrupt =    h3600ts_interrupt,
 483         .connect =      h3600ts_connect,
 484         .disconnect =   h3600ts_disconnect,
 485 };
 486
 487 /*
 488  * The functions for inserting/removing us as a module.
 489  */
 490
 491 static int __init h3600ts_init(void)
 492 {
 493         serio_register_device(&h3600ts_dev);
 494         return 0;
 495 }
 496
 497 static void __exit h3600ts_exit(void)
 498 {
 499         serio_unregister_device(&h3600ts_dev);
 500 }
 501
 502 module_init(h3600ts_init);
 503 module_exit(h3600ts_exit);