[deliverable/linux.git] / drivers / input / keyboard / spitzkbd.c

/*
 *  Keyboard driver for Sharp Spitz, Borzoi and Akita (SL-Cxx00 series)
 *
 *  Copyright (c) 2005 Richard Purdie
 *
 *  Based on corgikbd.c
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 */

#include <linux/delay.h>
#include <linux/device.h>
#include <linux/init.h>
#include <linux/input.h>
#include <linux/interrupt.h>
#include <linux/jiffies.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <asm/irq.h>

#include <asm/arch/spitz.h>
#include <asm/arch/hardware.h>
#include <asm/arch/pxa-regs.h>

#define KB_ROWS			7
#define KB_COLS			11
#define KB_ROWMASK(r)		(1 << (r))
#define SCANCODE(r,c)		(((r)<<4) + (c) + 1)
#define	NR_SCANCODES		((KB_ROWS<<4) + 1)

#define HINGE_SCAN_INTERVAL	(150) /* ms */

#define SPITZ_KEY_CALENDER	KEY_F1
#define SPITZ_KEY_ADDRESS	KEY_F2
#define SPITZ_KEY_FN		KEY_F3
#define SPITZ_KEY_CANCEL	KEY_F4
#define SPITZ_KEY_EXOK		KEY_F5
#define SPITZ_KEY_EXCANCEL	KEY_F6
#define SPITZ_KEY_EXJOGDOWN	KEY_F7
#define SPITZ_KEY_EXJOGUP	KEY_F8
#define SPITZ_KEY_JAP1		KEY_LEFTALT
#define SPITZ_KEY_JAP2		KEY_RIGHTCTRL
#define SPITZ_KEY_SYNC		KEY_F9
#define SPITZ_KEY_MAIL		KEY_F10
#define SPITZ_KEY_OK		KEY_F11
#define SPITZ_KEY_MENU		KEY_F12

static unsigned char spitzkbd_keycode[NR_SCANCODES] = {
	0,                                                                                                                /* 0 */
	KEY_LEFTCTRL, KEY_1, KEY_3, KEY_5, KEY_6, KEY_7, KEY_9, KEY_0, KEY_BACKSPACE, SPITZ_KEY_EXOK, SPITZ_KEY_EXCANCEL, 0, 0, 0, 0, 0,  /* 1-16 */
	0, KEY_2, KEY_4, KEY_R, KEY_Y, KEY_8, KEY_I, KEY_O, KEY_P, SPITZ_KEY_EXJOGDOWN, SPITZ_KEY_EXJOGUP, 0, 0, 0, 0, 0, /* 17-32 */
	KEY_TAB, KEY_Q, KEY_E, KEY_T, KEY_G, KEY_U, KEY_J, KEY_K, 0, 0, 0, 0, 0, 0, 0, 0,                                 /* 33-48 */
	SPITZ_KEY_CALENDER, KEY_W, KEY_S, KEY_F, KEY_V, KEY_H, KEY_M, KEY_L, 0, KEY_RIGHTSHIFT, 0, 0, 0, 0, 0, 0,         /* 49-64 */
	SPITZ_KEY_ADDRESS, KEY_A, KEY_D, KEY_C, KEY_B, KEY_N, KEY_DOT, 0, KEY_ENTER, KEY_LEFTSHIFT, 0, 0, 0, 0, 0, 0,	  /* 65-80 */
	SPITZ_KEY_MAIL, KEY_Z, KEY_X, KEY_MINUS, KEY_SPACE, KEY_COMMA, 0, KEY_UP, 0, 0, SPITZ_KEY_FN, 0, 0, 0, 0, 0,      /* 81-96 */
	KEY_SYSRQ, SPITZ_KEY_JAP1, SPITZ_KEY_JAP2, SPITZ_KEY_CANCEL, SPITZ_KEY_OK, SPITZ_KEY_MENU, KEY_LEFT, KEY_DOWN, KEY_RIGHT, 0, 0, 0, 0, 0, 0, 0  /* 97-112 */
};

static int spitz_strobes[] = {
	SPITZ_GPIO_KEY_STROBE0,
	SPITZ_GPIO_KEY_STROBE1,
	SPITZ_GPIO_KEY_STROBE2,
	SPITZ_GPIO_KEY_STROBE3,
	SPITZ_GPIO_KEY_STROBE4,
	SPITZ_GPIO_KEY_STROBE5,
	SPITZ_GPIO_KEY_STROBE6,
	SPITZ_GPIO_KEY_STROBE7,
	SPITZ_GPIO_KEY_STROBE8,
	SPITZ_GPIO_KEY_STROBE9,
	SPITZ_GPIO_KEY_STROBE10,
};

static int spitz_senses[] = {
	SPITZ_GPIO_KEY_SENSE0,
	SPITZ_GPIO_KEY_SENSE1,
	SPITZ_GPIO_KEY_SENSE2,
	SPITZ_GPIO_KEY_SENSE3,
	SPITZ_GPIO_KEY_SENSE4,
	SPITZ_GPIO_KEY_SENSE5,
	SPITZ_GPIO_KEY_SENSE6,
};

struct spitzkbd {
	unsigned char keycode[ARRAY_SIZE(spitzkbd_keycode)];
	struct input_dev *input;
	char phys[32];

	spinlock_t lock;
	struct timer_list timer;
	struct timer_list htimer;

	unsigned int suspended;
	unsigned long suspend_jiffies;
};

#define KB_DISCHARGE_DELAY	10
#define KB_ACTIVATE_DELAY	10

/* Helper functions for reading the keyboard matrix
 * Note: We should really be using pxa_gpio_mode to alter GPDR but it
 *       requires a function call per GPIO bit which is excessive
 *       when we need to access 11 bits at once, multiple times.
 * These functions must be called within local_irq_save()/local_irq_restore()
 * or similar.
 */
static inline void spitzkbd_discharge_all(void)
{
	/* STROBE All HiZ */
	GPCR0  =  SPITZ_GPIO_G0_STROBE_BIT;
	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
	GPCR1  =  SPITZ_GPIO_G1_STROBE_BIT;
	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
	GPCR2  =  SPITZ_GPIO_G2_STROBE_BIT;
	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
	GPCR3  =  SPITZ_GPIO_G3_STROBE_BIT;
	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
}

static inline void spitzkbd_activate_all(void)
{
	/* STROBE ALL -> High */
	GPSR0  =  SPITZ_GPIO_G0_STROBE_BIT;
	GPDR0 |=  SPITZ_GPIO_G0_STROBE_BIT;
	GPSR1  =  SPITZ_GPIO_G1_STROBE_BIT;
	GPDR1 |=  SPITZ_GPIO_G1_STROBE_BIT;
	GPSR2  =  SPITZ_GPIO_G2_STROBE_BIT;
	GPDR2 |=  SPITZ_GPIO_G2_STROBE_BIT;
	GPSR3  =  SPITZ_GPIO_G3_STROBE_BIT;
	GPDR3 |=  SPITZ_GPIO_G3_STROBE_BIT;

	udelay(KB_DISCHARGE_DELAY);

	/* Clear any interrupts we may have triggered when altering the GPIO lines */
	GEDR0 = SPITZ_GPIO_G0_SENSE_BIT;
	GEDR1 = SPITZ_GPIO_G1_SENSE_BIT;
	GEDR2 = SPITZ_GPIO_G2_SENSE_BIT;
	GEDR3 = SPITZ_GPIO_G3_SENSE_BIT;
}

static inline void spitzkbd_activate_col(int col)
{
	int gpio = spitz_strobes[col];
	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
	GPSR(gpio) = GPIO_bit(gpio);
	GPDR(gpio) |= GPIO_bit(gpio);
}

static inline void spitzkbd_reset_col(int col)
{
	int gpio = spitz_strobes[col];
	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
	GPCR(gpio) = GPIO_bit(gpio);
	GPDR(gpio) |= GPIO_bit(gpio);
}

static inline int spitzkbd_get_row_status(int col)
{
	return ((GPLR0 >> 12) & 0x01) | ((GPLR0 >> 16) & 0x02)
		| ((GPLR2 >> 25) & 0x04) | ((GPLR1 << 1) & 0x08)
		| ((GPLR1 >> 0) & 0x10) | ((GPLR1 >> 1) & 0x60);
}

/*
 * The spitz keyboard only generates interrupts when a key is pressed.
 * When a key is pressed, we enable a timer which then scans the
 * keyboard to detect when the key is released.
 */

/* Scan the hardware keyboard and push any changes up through the input layer */
static void spitzkbd_scankeyboard(struct spitzkbd *spitzkbd_data, struct pt_regs *regs)
{
	unsigned int row, col, rowd;
	unsigned long flags;
	unsigned int num_pressed, pwrkey = ((GPLR(SPITZ_GPIO_ON_KEY) & GPIO_bit(SPITZ_GPIO_ON_KEY)) != 0);

	if (spitzkbd_data->suspended)
		return;

	spin_lock_irqsave(&spitzkbd_data->lock, flags);

	input_regs(spitzkbd_data->input, regs);

	num_pressed = 0;
	for (col = 0; col < KB_COLS; col++) {
		/*
		 * Discharge the output driver capacitatance
		 * in the keyboard matrix. (Yes it is significant..)
		 */

		spitzkbd_discharge_all();
		udelay(KB_DISCHARGE_DELAY);

		spitzkbd_activate_col(col);
		udelay(KB_ACTIVATE_DELAY);

		rowd = spitzkbd_get_row_status(col);
		for (row = 0; row < KB_ROWS; row++) {
			unsigned int scancode, pressed;

			scancode = SCANCODE(row, col);
			pressed = rowd & KB_ROWMASK(row);

			input_report_key(spitzkbd_data->input, spitzkbd_data->keycode[scancode], pressed);

			if (pressed)
				num_pressed++;
		}
		spitzkbd_reset_col(col);
	}

	spitzkbd_activate_all();

	input_report_key(spitzkbd_data->input, SPITZ_KEY_SYNC, (GPLR(SPITZ_GPIO_SYNC) & GPIO_bit(SPITZ_GPIO_SYNC)) != 0 );
	input_report_key(spitzkbd_data->input, KEY_SUSPEND, pwrkey);

	if (pwrkey && time_after(jiffies, spitzkbd_data->suspend_jiffies + msecs_to_jiffies(1000))) {
		input_event(spitzkbd_data->input, EV_PWR, KEY_SUSPEND, 1);
		spitzkbd_data->suspend_jiffies = jiffies;
	}

	input_sync(spitzkbd_data->input);

	/* if any keys are pressed, enable the timer */
	if (num_pressed)
		mod_timer(&spitzkbd_data->timer, jiffies + msecs_to_jiffies(100));

	spin_unlock_irqrestore(&spitzkbd_data->lock, flags);
}

/*
 * spitz keyboard interrupt handler.
 */
static irqreturn_t spitzkbd_interrupt(int irq, void *dev_id, struct pt_regs *regs)
{
	struct spitzkbd *spitzkbd_data = dev_id;

	if (!timer_pending(&spitzkbd_data->timer)) {
		/** wait chattering delay **/
		udelay(20);
		spitzkbd_scankeyboard(spitzkbd_data, regs);
	}

	return IRQ_HANDLED;
}

/*
 * spitz timer checking for released keys
 */
static void spitzkbd_timer_callback(unsigned long data)
{
	struct spitzkbd *spitzkbd_data = (struct spitzkbd *) data;

	spitzkbd_scankeyboard(spitzkbd_data, NULL);
}

/*
 * The hinge switches generate an interrupt.
 * We debounce the switches and pass them to the input system.
 */

static irqreturn_t spitzkbd_hinge_isr(int irq, void *dev_id, struct pt_regs *regs)
{
	struct spitzkbd *spitzkbd_data = dev_id;

	if (!timer_pending(&spitzkbd_data->htimer))
		mod_timer(&spitzkbd_data->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));

	return IRQ_HANDLED;
}

#define HINGE_STABLE_COUNT 2
static int sharpsl_hinge_state;
static int hinge_count;

static void spitzkbd_hinge_timer(unsigned long data)
{
	struct spitzkbd *spitzkbd_data = (struct spitzkbd *) data;
	unsigned long state;
	unsigned long flags;

	state = GPLR(SPITZ_GPIO_SWA) & (GPIO_bit(SPITZ_GPIO_SWA)|GPIO_bit(SPITZ_GPIO_SWB));
	if (state != sharpsl_hinge_state) {
		hinge_count = 0;
		sharpsl_hinge_state = state;
	} else if (hinge_count < HINGE_STABLE_COUNT) {
		hinge_count++;
	}

	if (hinge_count >= HINGE_STABLE_COUNT) {
		spin_lock_irqsave(&spitzkbd_data->lock, flags);

		input_report_switch(spitzkbd_data->input, SW_0, ((GPLR(SPITZ_GPIO_SWA) & GPIO_bit(SPITZ_GPIO_SWA)) != 0));
		input_report_switch(spitzkbd_data->input, SW_1, ((GPLR(SPITZ_GPIO_SWB) & GPIO_bit(SPITZ_GPIO_SWB)) != 0));
		input_sync(spitzkbd_data->input);

		spin_unlock_irqrestore(&spitzkbd_data->lock, flags);
	} else {
		mod_timer(&spitzkbd_data->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
	}
}

#ifdef CONFIG_PM
static int spitzkbd_suspend(struct device *dev, pm_message_t state)
{
	int i;
	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);
	spitzkbd->suspended = 1;

	/* Set Strobe lines as inputs - *except* strobe line 0 leave this
	   enabled so we can detect a power button press for resume */
	for (i = 1; i < SPITZ_KEY_STROBE_NUM; i++)
		pxa_gpio_mode(spitz_strobes[i] | GPIO_IN);

	return 0;
}

static int spitzkbd_resume(struct device *dev)
{
	int i;
	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);

	for (i = 0; i < SPITZ_KEY_STROBE_NUM; i++)
		pxa_gpio_mode(spitz_strobes[i] | GPIO_OUT | GPIO_DFLT_HIGH);

	/* Upon resume, ignore the suspend key for a short while */
	spitzkbd->suspend_jiffies = jiffies;
	spitzkbd->suspended = 0;

	return 0;
}
#else
#define spitzkbd_suspend	NULL
#define spitzkbd_resume		NULL
#endif

static int __init spitzkbd_probe(struct device *dev)
{
	struct spitzkbd *spitzkbd;
	struct input_dev *input_dev;
	int i;

	spitzkbd = kzalloc(sizeof(struct spitzkbd), GFP_KERNEL);
	if (!spitzkbd)
		return -ENOMEM;

	input_dev = input_allocate_device();
	if (!input_dev) {
		kfree(spitzkbd);
		return -ENOMEM;
	}

	dev_set_drvdata(dev, spitzkbd);
	strcpy(spitzkbd->phys, "spitzkbd/input0");

	spin_lock_init(&spitzkbd->lock);

	/* Init Keyboard rescan timer */
	init_timer(&spitzkbd->timer);
	spitzkbd->timer.function = spitzkbd_timer_callback;
	spitzkbd->timer.data = (unsigned long) spitzkbd;

	/* Init Hinge Timer */
	init_timer(&spitzkbd->htimer);
	spitzkbd->htimer.function = spitzkbd_hinge_timer;
	spitzkbd->htimer.data = (unsigned long) spitzkbd;

	spitzkbd->suspend_jiffies = jiffies;

	spitzkbd->input = input_dev;

	input_dev->private = spitzkbd;
	input_dev->name = "Spitz Keyboard";
	input_dev->phys = spitzkbd->phys;
	input_dev->cdev.dev = dev;

	input_dev->id.bustype = BUS_HOST;
	input_dev->id.vendor = 0x0001;
	input_dev->id.product = 0x0001;
	input_dev->id.version = 0x0100;

	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_PWR) | BIT(EV_SW);
	input_dev->keycode = spitzkbd->keycode;
	input_dev->keycodesize = sizeof(unsigned char);
	input_dev->keycodemax = ARRAY_SIZE(spitzkbd_keycode);

	memcpy(spitzkbd->keycode, spitzkbd_keycode, sizeof(spitzkbd->keycode));
	for (i = 0; i < ARRAY_SIZE(spitzkbd_keycode); i++)
		set_bit(spitzkbd->keycode[i], input_dev->keybit);
	clear_bit(0, input_dev->keybit);
	set_bit(SW_0, input_dev->swbit);
	set_bit(SW_1, input_dev->swbit);

	input_register_device(input_dev);

	mod_timer(&spitzkbd->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));

	/* Setup sense interrupts - RisingEdge Detect, sense lines as inputs */
	for (i = 0; i < SPITZ_KEY_SENSE_NUM; i++) {
		pxa_gpio_mode(spitz_senses[i] | GPIO_IN);
		if (request_irq(IRQ_GPIO(spitz_senses[i]), spitzkbd_interrupt,
						SA_INTERRUPT, "Spitzkbd Sense", spitzkbd))
			printk(KERN_WARNING "spitzkbd: Can't get Sense IRQ: %d!\n", i);
		else
			set_irq_type(IRQ_GPIO(spitz_senses[i]),IRQT_RISING);
	}

	/* Set Strobe lines as outputs - set high */
	for (i = 0; i < SPITZ_KEY_STROBE_NUM; i++)
		pxa_gpio_mode(spitz_strobes[i] | GPIO_OUT | GPIO_DFLT_HIGH);

	pxa_gpio_mode(SPITZ_GPIO_SYNC | GPIO_IN);
	pxa_gpio_mode(SPITZ_GPIO_ON_KEY | GPIO_IN);
	pxa_gpio_mode(SPITZ_GPIO_SWA | GPIO_IN);
	pxa_gpio_mode(SPITZ_GPIO_SWB | GPIO_IN);

	request_irq(SPITZ_IRQ_GPIO_SYNC, spitzkbd_interrupt, SA_INTERRUPT, "Spitzkbd Sync", spitzkbd);
	request_irq(SPITZ_IRQ_GPIO_ON_KEY, spitzkbd_interrupt, SA_INTERRUPT, "Spitzkbd PwrOn", spitzkbd);
	request_irq(SPITZ_IRQ_GPIO_SWA, spitzkbd_hinge_isr, SA_INTERRUPT, "Spitzkbd SWA", spitzkbd);
	request_irq(SPITZ_IRQ_GPIO_SWB, spitzkbd_hinge_isr, SA_INTERRUPT, "Spitzkbd SWB", spitzkbd);

	set_irq_type(SPITZ_IRQ_GPIO_SYNC, IRQT_BOTHEDGE);
	set_irq_type(SPITZ_IRQ_GPIO_ON_KEY, IRQT_BOTHEDGE);
	set_irq_type(SPITZ_IRQ_GPIO_SWA, IRQT_BOTHEDGE);
	set_irq_type(SPITZ_IRQ_GPIO_SWB, IRQT_BOTHEDGE);

	printk(KERN_INFO "input: Spitz Keyboard Registered\n");

	return 0;
}

static int spitzkbd_remove(struct device *dev)
{
	int i;
	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);

	for (i = 0; i < SPITZ_KEY_SENSE_NUM; i++)
		free_irq(IRQ_GPIO(spitz_senses[i]), spitzkbd);

	free_irq(SPITZ_IRQ_GPIO_SYNC, spitzkbd);
	free_irq(SPITZ_IRQ_GPIO_ON_KEY, spitzkbd);
	free_irq(SPITZ_IRQ_GPIO_SWA, spitzkbd);
	free_irq(SPITZ_IRQ_GPIO_SWB, spitzkbd);

	del_timer_sync(&spitzkbd->htimer);
	del_timer_sync(&spitzkbd->timer);

	input_unregister_device(spitzkbd->input);

	kfree(spitzkbd);

	return 0;
}

static struct device_driver spitzkbd_driver = {
	.name		= "spitz-keyboard",
	.bus		= &platform_bus_type,
	.probe		= spitzkbd_probe,
	.remove		= spitzkbd_remove,
	.suspend	= spitzkbd_suspend,
	.resume		= spitzkbd_resume,
};

static int __devinit spitzkbd_init(void)
{
	return driver_register(&spitzkbd_driver);
}

static void __exit spitzkbd_exit(void)
{
	driver_unregister(&spitzkbd_driver);
}

module_init(spitzkbd_init);
module_exit(spitzkbd_exit);

MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
MODULE_DESCRIPTION("Spitz Keyboard Driver");
MODULE_LICENSE("GPLv2");
Commit	Line	Data
fff71312 RP	1	/*
	2	* Keyboard driver for Sharp Spitz, Borzoi and Akita (SL-Cxx00 series)
	3	*
	4	* Copyright (c) 2005 Richard Purdie
	5	*
	6	* Based on corgikbd.c
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	*/
	13
	14	#include <linux/delay.h>
	15	#include <linux/device.h>
	16	#include <linux/init.h>
	17	#include <linux/input.h>
	18	#include <linux/interrupt.h>
	19	#include <linux/jiffies.h>
	20	#include <linux/module.h>
	21	#include <linux/slab.h>
	22	#include <asm/irq.h>
	23
	24	#include <asm/arch/spitz.h>
	25	#include <asm/arch/hardware.h>
	26	#include <asm/arch/pxa-regs.h>
	27
	28	#define KB_ROWS 7
	29	#define KB_COLS 11
	30	#define KB_ROWMASK(r) (1 << (r))
	31	#define SCANCODE(r,c) (((r)<<4) + (c) + 1)
	32	#define NR_SCANCODES ((KB_ROWS<<4) + 1)
	33
	34	#define HINGE_SCAN_INTERVAL (150) /* ms */
	35
	36	#define SPITZ_KEY_CALENDER KEY_F1
	37	#define SPITZ_KEY_ADDRESS KEY_F2
	38	#define SPITZ_KEY_FN KEY_F3
	39	#define SPITZ_KEY_CANCEL KEY_F4
	40	#define SPITZ_KEY_EXOK KEY_F5
	41	#define SPITZ_KEY_EXCANCEL KEY_F6
	42	#define SPITZ_KEY_EXJOGDOWN KEY_F7
	43	#define SPITZ_KEY_EXJOGUP KEY_F8
	44	#define SPITZ_KEY_JAP1 KEY_LEFTALT
	45	#define SPITZ_KEY_JAP2 KEY_RIGHTCTRL
	46	#define SPITZ_KEY_SYNC KEY_F9
	47	#define SPITZ_KEY_MAIL KEY_F10
	48	#define SPITZ_KEY_OK KEY_F11
	49	#define SPITZ_KEY_MENU KEY_F12
	50
	51	static unsigned char spitzkbd_keycode[NR_SCANCODES] = {
	52	0, /* 0 */
	53	KEY_LEFTCTRL, KEY_1, KEY_3, KEY_5, KEY_6, KEY_7, KEY_9, KEY_0, KEY_BACKSPACE, SPITZ_KEY_EXOK, SPITZ_KEY_EXCANCEL, 0, 0, 0, 0, 0, /* 1-16 */
	54	0, KEY_2, KEY_4, KEY_R, KEY_Y, KEY_8, KEY_I, KEY_O, KEY_P, SPITZ_KEY_EXJOGDOWN, SPITZ_KEY_EXJOGUP, 0, 0, 0, 0, 0, /* 17-32 */
	55	KEY_TAB, KEY_Q, KEY_E, KEY_T, KEY_G, KEY_U, KEY_J, KEY_K, 0, 0, 0, 0, 0, 0, 0, 0, /* 33-48 */
41489493	56	SPITZ_KEY_CALENDER, KEY_W, KEY_S, KEY_F, KEY_V, KEY_H, KEY_M, KEY_L, 0, KEY_RIGHTSHIFT, 0, 0, 0, 0, 0, 0, /* 49-64 */
fff71312 RP	57	SPITZ_KEY_ADDRESS, KEY_A, KEY_D, KEY_C, KEY_B, KEY_N, KEY_DOT, 0, KEY_ENTER, KEY_LEFTSHIFT, 0, 0, 0, 0, 0, 0, /* 65-80 */
	58	SPITZ_KEY_MAIL, KEY_Z, KEY_X, KEY_MINUS, KEY_SPACE, KEY_COMMA, 0, KEY_UP, 0, 0, SPITZ_KEY_FN, 0, 0, 0, 0, 0, /* 81-96 */
	59	KEY_SYSRQ, SPITZ_KEY_JAP1, SPITZ_KEY_JAP2, SPITZ_KEY_CANCEL, SPITZ_KEY_OK, SPITZ_KEY_MENU, KEY_LEFT, KEY_DOWN, KEY_RIGHT, 0, 0, 0, 0, 0, 0, 0 /* 97-112 */
	60	};
	61
	62	static int spitz_strobes[] = {
	63	SPITZ_GPIO_KEY_STROBE0,
	64	SPITZ_GPIO_KEY_STROBE1,
	65	SPITZ_GPIO_KEY_STROBE2,
	66	SPITZ_GPIO_KEY_STROBE3,
	67	SPITZ_GPIO_KEY_STROBE4,
	68	SPITZ_GPIO_KEY_STROBE5,
	69	SPITZ_GPIO_KEY_STROBE6,
	70	SPITZ_GPIO_KEY_STROBE7,
	71	SPITZ_GPIO_KEY_STROBE8,
	72	SPITZ_GPIO_KEY_STROBE9,
	73	SPITZ_GPIO_KEY_STROBE10,
	74	};
	75
	76	static int spitz_senses[] = {
	77	SPITZ_GPIO_KEY_SENSE0,
	78	SPITZ_GPIO_KEY_SENSE1,
	79	SPITZ_GPIO_KEY_SENSE2,
	80	SPITZ_GPIO_KEY_SENSE3,
	81	SPITZ_GPIO_KEY_SENSE4,
	82	SPITZ_GPIO_KEY_SENSE5,
	83	SPITZ_GPIO_KEY_SENSE6,
	84	};
	85
	86	struct spitzkbd {
	87	unsigned char keycode[ARRAY_SIZE(spitzkbd_keycode)];
3c42f0c3	88	struct input_dev *input;
fff71312 RP	89	char phys[32];
	90
	91	spinlock_t lock;
	92	struct timer_list timer;
	93	struct timer_list htimer;
	94
	95	unsigned int suspended;
	96	unsigned long suspend_jiffies;
	97	};
	98
	99	#define KB_DISCHARGE_DELAY 10
	100	#define KB_ACTIVATE_DELAY 10
	101
	102	/* Helper functions for reading the keyboard matrix
	103	* Note: We should really be using pxa_gpio_mode to alter GPDR but it
	104	* requires a function call per GPIO bit which is excessive
	105	* when we need to access 11 bits at once, multiple times.
	106	* These functions must be called within local_irq_save()/local_irq_restore()
	107	* or similar.
	108	*/
	109	static inline void spitzkbd_discharge_all(void)
	110	{
	111	/* STROBE All HiZ */
	112	GPCR0 = SPITZ_GPIO_G0_STROBE_BIT;
	113	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
	114	GPCR1 = SPITZ_GPIO_G1_STROBE_BIT;
	115	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
	116	GPCR2 = SPITZ_GPIO_G2_STROBE_BIT;
	117	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
	118	GPCR3 = SPITZ_GPIO_G3_STROBE_BIT;
	119	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
	120	}
	121
	122	static inline void spitzkbd_activate_all(void)
	123	{
	124	/* STROBE ALL -> High */
	125	GPSR0 = SPITZ_GPIO_G0_STROBE_BIT;
	126	GPDR0 \|= SPITZ_GPIO_G0_STROBE_BIT;
	127	GPSR1 = SPITZ_GPIO_G1_STROBE_BIT;
	128	GPDR1 \|= SPITZ_GPIO_G1_STROBE_BIT;
	129	GPSR2 = SPITZ_GPIO_G2_STROBE_BIT;
	130	GPDR2 \|= SPITZ_GPIO_G2_STROBE_BIT;
	131	GPSR3 = SPITZ_GPIO_G3_STROBE_BIT;
	132	GPDR3 \|= SPITZ_GPIO_G3_STROBE_BIT;
	133
	134	udelay(KB_DISCHARGE_DELAY);
	135
	136	/* Clear any interrupts we may have triggered when altering the GPIO lines */
	137	GEDR0 = SPITZ_GPIO_G0_SENSE_BIT;
	138	GEDR1 = SPITZ_GPIO_G1_SENSE_BIT;
	139	GEDR2 = SPITZ_GPIO_G2_SENSE_BIT;
	140	GEDR3 = SPITZ_GPIO_G3_SENSE_BIT;
	141	}
	142
	143	static inline void spitzkbd_activate_col(int col)
	144	{
	145	int gpio = spitz_strobes[col];
	146	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
	147	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
	148	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
	149	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
	150	GPSR(gpio) = GPIO_bit(gpio);
	151	GPDR(gpio) \|= GPIO_bit(gpio);
	152	}
153
154	static inline void spitzkbd_reset_col(int col)
155	{
156	int gpio = spitz_strobes[col];
157	GPDR0 &= ~SPITZ_GPIO_G0_STROBE_BIT;
158	GPDR1 &= ~SPITZ_GPIO_G1_STROBE_BIT;
159	GPDR2 &= ~SPITZ_GPIO_G2_STROBE_BIT;
160	GPDR3 &= ~SPITZ_GPIO_G3_STROBE_BIT;
161	GPCR(gpio) = GPIO_bit(gpio);
162	GPDR(gpio) \|= GPIO_bit(gpio);
163	}
164
165	static inline int spitzkbd_get_row_status(int col)
166	{
167	return ((GPLR0 >> 12) & 0x01) \| ((GPLR0 >> 16) & 0x02)
168	\| ((GPLR2 >> 25) & 0x04) \| ((GPLR1 << 1) & 0x08)
169	\| ((GPLR1 >> 0) & 0x10) \| ((GPLR1 >> 1) & 0x60);
170	}
171
172	/*
173	* The spitz keyboard only generates interrupts when a key is pressed.
174	* When a key is pressed, we enable a timer which then scans the
175	* keyboard to detect when the key is released.
176	*/
177
178	/* Scan the hardware keyboard and push any changes up through the input layer */
179	static void spitzkbd_scankeyboard(struct spitzkbd spitzkbd_data, struct pt_regs regs)
180	{
181	unsigned int row, col, rowd;
182	unsigned long flags;
183	unsigned int num_pressed, pwrkey = ((GPLR(SPITZ_GPIO_ON_KEY) & GPIO_bit(SPITZ_GPIO_ON_KEY)) != 0);
184
185	if (spitzkbd_data->suspended)
186	return;
187
188	spin_lock_irqsave(&spitzkbd_data->lock, flags);
189
3c42f0c3	190	input_regs(spitzkbd_data->input, regs);
fff71312 RP	191
	192	num_pressed = 0;
	193	for (col = 0; col < KB_COLS; col++) {
	194	/*
	195	* Discharge the output driver capacitatance
	196	* in the keyboard matrix. (Yes it is significant..)
	197	*/
	198
	199	spitzkbd_discharge_all();
	200	udelay(KB_DISCHARGE_DELAY);
	201
	202	spitzkbd_activate_col(col);
	203	udelay(KB_ACTIVATE_DELAY);
	204
	205	rowd = spitzkbd_get_row_status(col);
	206	for (row = 0; row < KB_ROWS; row++) {
	207	unsigned int scancode, pressed;
	208
	209	scancode = SCANCODE(row, col);
	210	pressed = rowd & KB_ROWMASK(row);
	211
3c42f0c3	212	input_report_key(spitzkbd_data->input, spitzkbd_data->keycode[scancode], pressed);
fff71312 RP	213
	214	if (pressed)
	215	num_pressed++;
	216	}
	217	spitzkbd_reset_col(col);
	218	}
	219
	220	spitzkbd_activate_all();
	221
3c42f0c3 DT	222	input_report_key(spitzkbd_data->input, SPITZ_KEY_SYNC, (GPLR(SPITZ_GPIO_SYNC) & GPIO_bit(SPITZ_GPIO_SYNC)) != 0 );
3c42f0c3 DT	223	input_report_key(spitzkbd_data->input, KEY_SUSPEND, pwrkey);
fff71312 RP	224
fff71312 RP	225	if (pwrkey && time_after(jiffies, spitzkbd_data->suspend_jiffies + msecs_to_jiffies(1000))) {
3c42f0c3	226	input_event(spitzkbd_data->input, EV_PWR, KEY_SUSPEND, 1);
fff71312 RP	227	spitzkbd_data->suspend_jiffies = jiffies;
	228	}
	229
3c42f0c3	230	input_sync(spitzkbd_data->input);
fff71312 RP	231
	232	/* if any keys are pressed, enable the timer */
	233	if (num_pressed)
	234	mod_timer(&spitzkbd_data->timer, jiffies + msecs_to_jiffies(100));
	235
	236	spin_unlock_irqrestore(&spitzkbd_data->lock, flags);
	237	}
	238
	239	/*
	240	* spitz keyboard interrupt handler.
	241	*/
	242	static irqreturn_t spitzkbd_interrupt(int irq, void dev_id, struct pt_regs regs)
	243	{
	244	struct spitzkbd *spitzkbd_data = dev_id;
	245
	246	if (!timer_pending(&spitzkbd_data->timer)) {
	247	/ wait chattering delay /
	248	udelay(20);
	249	spitzkbd_scankeyboard(spitzkbd_data, regs);
	250	}
	251
	252	return IRQ_HANDLED;
	253	}
	254
	255	/*
	256	* spitz timer checking for released keys
	257	*/
	258	static void spitzkbd_timer_callback(unsigned long data)
	259	{
	260	struct spitzkbd spitzkbd_data = (struct spitzkbd ) data;
3c42f0c3	261
fff71312 RP	262	spitzkbd_scankeyboard(spitzkbd_data, NULL);
	263	}
	264
	265	/*
	266	* The hinge switches generate an interrupt.
	267	* We debounce the switches and pass them to the input system.
	268	*/
	269
	270	static irqreturn_t spitzkbd_hinge_isr(int irq, void dev_id, struct pt_regs regs)
	271	{
	272	struct spitzkbd *spitzkbd_data = dev_id;
	273
	274	if (!timer_pending(&spitzkbd_data->htimer))
	275	mod_timer(&spitzkbd_data->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
	276
	277	return IRQ_HANDLED;
	278	}
	279
	280	#define HINGE_STABLE_COUNT 2
	281	static int sharpsl_hinge_state;
	282	static int hinge_count;
	283
	284	static void spitzkbd_hinge_timer(unsigned long data)
	285	{
	286	struct spitzkbd spitzkbd_data = (struct spitzkbd ) data;
	287	unsigned long state;
	288	unsigned long flags;
	289
	290	state = GPLR(SPITZ_GPIO_SWA) & (GPIO_bit(SPITZ_GPIO_SWA)\|GPIO_bit(SPITZ_GPIO_SWB));
	291	if (state != sharpsl_hinge_state) {
	292	hinge_count = 0;
	293	sharpsl_hinge_state = state;
	294	} else if (hinge_count < HINGE_STABLE_COUNT) {
	295	hinge_count++;
	296	}
	297
	298	if (hinge_count >= HINGE_STABLE_COUNT) {
	299	spin_lock_irqsave(&spitzkbd_data->lock, flags);
	300
3c42f0c3 DT	301	input_report_switch(spitzkbd_data->input, SW_0, ((GPLR(SPITZ_GPIO_SWA) & GPIO_bit(SPITZ_GPIO_SWA)) != 0));
	302	input_report_switch(spitzkbd_data->input, SW_1, ((GPLR(SPITZ_GPIO_SWB) & GPIO_bit(SPITZ_GPIO_SWB)) != 0));
	303	input_sync(spitzkbd_data->input);
fff71312 RP	304
	305	spin_unlock_irqrestore(&spitzkbd_data->lock, flags);
	306	} else {
	307	mod_timer(&spitzkbd_data->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
	308	}
	309	}
	310
	311	#ifdef CONFIG_PM
9480e307	312	static int spitzkbd_suspend(struct device *dev, pm_message_t state)
fff71312	313	{
9480e307 RK	314	int i;
	315	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);
	316	spitzkbd->suspended = 1;
	317
	318	/* Set Strobe lines as inputs - except strobe line 0 leave this
	319	enabled so we can detect a power button press for resume */
	320	for (i = 1; i < SPITZ_KEY_STROBE_NUM; i++)
	321	pxa_gpio_mode(spitz_strobes[i] \| GPIO_IN);
	322
fff71312 RP	323	return 0;
	324	}
	325
9480e307	326	static int spitzkbd_resume(struct device *dev)
fff71312	327	{
9480e307 RK	328	int i;
9480e307 RK	329	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);
fff71312	330
9480e307 RK	331	for (i = 0; i < SPITZ_KEY_STROBE_NUM; i++)
	332	pxa_gpio_mode(spitz_strobes[i] \| GPIO_OUT \| GPIO_DFLT_HIGH);
	333
	334	/* Upon resume, ignore the suspend key for a short while */
	335	spitzkbd->suspend_jiffies = jiffies;
	336	spitzkbd->suspended = 0;
fff71312	337
fff71312 RP	338	return 0;
	339	}
	340	#else
	341	#define spitzkbd_suspend NULL
	342	#define spitzkbd_resume NULL
	343	#endif
	344
	345	static int __init spitzkbd_probe(struct device *dev)
	346	{
fff71312	347	struct spitzkbd *spitzkbd;
3c42f0c3 DT	348	struct input_dev *input_dev;
3c42f0c3 DT	349	int i;
fff71312 RP	350
	351	spitzkbd = kzalloc(sizeof(struct spitzkbd), GFP_KERNEL);
	352	if (!spitzkbd)
	353	return -ENOMEM;
	354
3c42f0c3 DT	355	input_dev = input_allocate_device();
	356	if (!input_dev) {
	357	kfree(spitzkbd);
	358	return -ENOMEM;
	359	}
	360
	361	dev_set_drvdata(dev, spitzkbd);
fff71312 RP	362	strcpy(spitzkbd->phys, "spitzkbd/input0");
	363
	364	spin_lock_init(&spitzkbd->lock);
	365
	366	/* Init Keyboard rescan timer */
	367	init_timer(&spitzkbd->timer);
	368	spitzkbd->timer.function = spitzkbd_timer_callback;
	369	spitzkbd->timer.data = (unsigned long) spitzkbd;
	370
	371	/* Init Hinge Timer */
	372	init_timer(&spitzkbd->htimer);
	373	spitzkbd->htimer.function = spitzkbd_hinge_timer;
	374	spitzkbd->htimer.data = (unsigned long) spitzkbd;
	375
3c42f0c3 DT	376	spitzkbd->suspend_jiffies = jiffies;
	377
	378	spitzkbd->input = input_dev;
	379
	380	input_dev->private = spitzkbd;
	381	input_dev->name = "Spitz Keyboard";
	382	input_dev->phys = spitzkbd->phys;
	383	input_dev->cdev.dev = dev;
	384
	385	input_dev->id.bustype = BUS_HOST;
	386	input_dev->id.vendor = 0x0001;
	387	input_dev->id.product = 0x0001;
	388	input_dev->id.version = 0x0100;
	389
	390	input_dev->evbit[0] = BIT(EV_KEY) \| BIT(EV_REP) \| BIT(EV_PWR) \| BIT(EV_SW);
	391	input_dev->keycode = spitzkbd->keycode;
	392	input_dev->keycodesize = sizeof(unsigned char);
	393	input_dev->keycodemax = ARRAY_SIZE(spitzkbd_keycode);
fff71312 RP	394
	395	memcpy(spitzkbd->keycode, spitzkbd_keycode, sizeof(spitzkbd->keycode));
	396	for (i = 0; i < ARRAY_SIZE(spitzkbd_keycode); i++)
3c42f0c3 DT	397	set_bit(spitzkbd->keycode[i], input_dev->keybit);
	398	clear_bit(0, input_dev->keybit);
	399	set_bit(SW_0, input_dev->swbit);
	400	set_bit(SW_1, input_dev->swbit);
	401
	402	input_register_device(input_dev);
fff71312	403
fff71312 RP	404	mod_timer(&spitzkbd->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
	405
	406	/* Setup sense interrupts - RisingEdge Detect, sense lines as inputs */
	407	for (i = 0; i < SPITZ_KEY_SENSE_NUM; i++) {
	408	pxa_gpio_mode(spitz_senses[i] \| GPIO_IN);
	409	if (request_irq(IRQ_GPIO(spitz_senses[i]), spitzkbd_interrupt,
	410	SA_INTERRUPT, "Spitzkbd Sense", spitzkbd))
	411	printk(KERN_WARNING "spitzkbd: Can't get Sense IRQ: %d!\n", i);
	412	else
	413	set_irq_type(IRQ_GPIO(spitz_senses[i]),IRQT_RISING);
	414	}
	415
	416	/* Set Strobe lines as outputs - set high */
	417	for (i = 0; i < SPITZ_KEY_STROBE_NUM; i++)
	418	pxa_gpio_mode(spitz_strobes[i] \| GPIO_OUT \| GPIO_DFLT_HIGH);
	419
	420	pxa_gpio_mode(SPITZ_GPIO_SYNC \| GPIO_IN);
	421	pxa_gpio_mode(SPITZ_GPIO_ON_KEY \| GPIO_IN);
	422	pxa_gpio_mode(SPITZ_GPIO_SWA \| GPIO_IN);
	423	pxa_gpio_mode(SPITZ_GPIO_SWB \| GPIO_IN);
	424
	425	request_irq(SPITZ_IRQ_GPIO_SYNC, spitzkbd_interrupt, SA_INTERRUPT, "Spitzkbd Sync", spitzkbd);
	426	request_irq(SPITZ_IRQ_GPIO_ON_KEY, spitzkbd_interrupt, SA_INTERRUPT, "Spitzkbd PwrOn", spitzkbd);
	427	request_irq(SPITZ_IRQ_GPIO_SWA, spitzkbd_hinge_isr, SA_INTERRUPT, "Spitzkbd SWA", spitzkbd);
	428	request_irq(SPITZ_IRQ_GPIO_SWB, spitzkbd_hinge_isr, SA_INTERRUPT, "Spitzkbd SWB", spitzkbd);
	429
	430	set_irq_type(SPITZ_IRQ_GPIO_SYNC, IRQT_BOTHEDGE);
	431	set_irq_type(SPITZ_IRQ_GPIO_ON_KEY, IRQT_BOTHEDGE);
	432	set_irq_type(SPITZ_IRQ_GPIO_SWA, IRQT_BOTHEDGE);
	433	set_irq_type(SPITZ_IRQ_GPIO_SWB, IRQT_BOTHEDGE);
	434
	435	printk(KERN_INFO "input: Spitz Keyboard Registered\n");
	436
	437	return 0;
	438	}
	439
	440	static int spitzkbd_remove(struct device *dev)
	441	{
	442	int i;
	443	struct spitzkbd *spitzkbd = dev_get_drvdata(dev);
	444
	445	for (i = 0; i < SPITZ_KEY_SENSE_NUM; i++)
	446	free_irq(IRQ_GPIO(spitz_senses[i]), spitzkbd);
	447
	448	free_irq(SPITZ_IRQ_GPIO_SYNC, spitzkbd);
	449	free_irq(SPITZ_IRQ_GPIO_ON_KEY, spitzkbd);
	450	free_irq(SPITZ_IRQ_GPIO_SWA, spitzkbd);
	451	free_irq(SPITZ_IRQ_GPIO_SWB, spitzkbd);
	452
	453	del_timer_sync(&spitzkbd->htimer);
	454	del_timer_sync(&spitzkbd->timer);
	455
3c42f0c3	456	input_unregister_device(spitzkbd->input);
fff71312 RP	457
	458	kfree(spitzkbd);
	459
	460	return 0;
	461	}
	462
	463	static struct device_driver spitzkbd_driver = {
	464	.name = "spitz-keyboard",
	465	.bus = &platform_bus_type,
	466	.probe = spitzkbd_probe,
	467	.remove = spitzkbd_remove,
	468	.suspend = spitzkbd_suspend,
	469	.resume = spitzkbd_resume,
	470	};
	471
	472	static int __devinit spitzkbd_init(void)
	473	{
	474	return driver_register(&spitzkbd_driver);
	475	}
	476
	477	static void __exit spitzkbd_exit(void)
	478	{
	479	driver_unregister(&spitzkbd_driver);
	480	}
	481
	482	module_init(spitzkbd_init);
	483	module_exit(spitzkbd_exit);
	484
	485	MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
	486	MODULE_DESCRIPTION("Spitz Keyboard Driver");
	487	MODULE_LICENSE("GPLv2");