[people/ms/u-boot.git] / common / usb_kbd.c

/*
 * (C) Copyright 2001
 * Denis Peter, MPL AG Switzerland
 *
 * Part of this source has been derived from the Linux USB
 * project.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */
#include <common.h>
#include <malloc.h>
#include <stdio_dev.h>
#include <asm/byteorder.h>

#include <usb.h>

#ifdef	USB_KBD_DEBUG
#define USB_KBD_PRINTF(fmt, args...)	printf(fmt, ##args)
#else
#define USB_KBD_PRINTF(fmt, args...)
#endif

/*
 * If overwrite_console returns 1, the stdin, stderr and stdout
 * are switched to the serial port, else the settings in the
 * environment are used
 */
#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
extern int overwrite_console(void);
#else
int overwrite_console(void)
{
	return 0;
}
#endif

/* Keyboard sampling rate */
#define REPEAT_RATE	(40 / 4)	/* 40msec -> 25cps */
#define REPEAT_DELAY	10		/* 10 x REPEAT_RATE = 400msec */

#define NUM_LOCK	0x53
#define CAPS_LOCK	0x39
#define SCROLL_LOCK	0x47

/* Modifier bits */
#define LEFT_CNTR	(1 << 0)
#define LEFT_SHIFT	(1 << 1)
#define LEFT_ALT	(1 << 2)
#define LEFT_GUI	(1 << 3)
#define RIGHT_CNTR	(1 << 4)
#define RIGHT_SHIFT	(1 << 5)
#define RIGHT_ALT	(1 << 6)
#define RIGHT_GUI	(1 << 7)

/* Size of the keyboard buffer */
#define USB_KBD_BUFFER_LEN	0x20

/* Device name */
#define DEVNAME			"usbkbd"

/* Keyboard maps */
static const unsigned char usb_kbd_numkey[] = {
	'1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
	'\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
	'\\', '#', ';', '\'', '`', ',', '.', '/'
};
static const unsigned char usb_kbd_numkey_shifted[] = {
	'!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
	'\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
	'|', '~', ':', '"', '~', '<', '>', '?'
};

static const unsigned char usb_kbd_num_keypad[] = {
	'/', '*', '-', '+', '\r',
	'1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
	'.', 0, 0, 0, '='
};

/*
 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
 *       order. See usb_kbd_setled() function!
 */
#define USB_KBD_NUMLOCK		(1 << 0)
#define USB_KBD_CAPSLOCK	(1 << 1)
#define USB_KBD_SCROLLLOCK	(1 << 2)
#define USB_KBD_CTRL		(1 << 3)

#define USB_KBD_LEDMASK		\
	(USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)

struct usb_kbd_pdata {
	uint32_t	repeat_delay;

	uint32_t	usb_in_pointer;
	uint32_t	usb_out_pointer;
	uint8_t		usb_kbd_buffer[USB_KBD_BUFFER_LEN];

	uint8_t		new[8];
	uint8_t		old[8];

	uint8_t		flags;
};

/* Generic keyboard event polling. */
void usb_kbd_generic_poll(void)
{
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep;
	int pipe;
	int maxp;

	/* Get the pointer to USB Keyboard device pointer */
	dev = stdio_get_by_name(DEVNAME);
	usb_kbd_dev = (struct usb_device *)dev->priv;
	data = usb_kbd_dev->privptr;
	iface = &usb_kbd_dev->config.if_desc[0];
	ep = &iface->ep_desc[0];
	pipe = usb_rcvintpipe(usb_kbd_dev, ep->bEndpointAddress);

	/* Submit a interrupt transfer request */
	maxp = usb_maxpacket(usb_kbd_dev, pipe);
	usb_submit_int_msg(usb_kbd_dev, pipe, data->new,
			maxp > 8 ? 8 : maxp, ep->bInterval);
}

/* Puts character in the queue and sets up the in and out pointer. */
static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
{
	if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
		/* Check for buffer full. */
		if (data->usb_out_pointer == 0)
			return;

		data->usb_in_pointer = 0;
	} else {
		/* Check for buffer full. */
		if (data->usb_in_pointer == data->usb_out_pointer - 1)
			return;

		data->usb_in_pointer++;
	}

	data->usb_kbd_buffer[data->usb_in_pointer] = c;
}

/*
 * Set the LEDs. Since this is used in the irq routine, the control job is
 * issued with a timeout of 0. This means, that the job is queued without
 * waiting for job completion.
 */
static void usb_kbd_setled(struct usb_device *dev)
{
	struct usb_interface *iface = &dev->config.if_desc[0];
	struct usb_kbd_pdata *data = dev->privptr;
	uint32_t leds = data->flags & USB_KBD_LEDMASK;

	usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
}

#define CAPITAL_MASK	0x20
/* Translate the scancode in ASCII */
static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
				unsigned char modifier, int pressed)
{
	uint8_t keycode = 0;

	/* Key released */
	if (pressed == 0) {
		data->repeat_delay = 0;
		return 0;
	}

	if (pressed == 2) {
		data->repeat_delay++;
		if (data->repeat_delay < REPEAT_DELAY)
			return 0;

		data->repeat_delay = REPEAT_DELAY;
	}

	/* Alphanumeric values */
	if ((scancode > 3) && (scancode <= 0x1d)) {
		keycode = scancode - 4 + 'a';

		if (data->flags & USB_KBD_CAPSLOCK)
			keycode &= ~CAPITAL_MASK;

		if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
			/* Handle CAPSLock + Shift pressed simultaneously */
			if (keycode & CAPITAL_MASK)
				keycode &= ~CAPITAL_MASK;
			else
				keycode |= CAPITAL_MASK;
		}
	}

	if ((scancode > 0x1d) && (scancode < 0x3a)) {
		/* Shift pressed */
		if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
			keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
		else
			keycode = usb_kbd_numkey[scancode - 0x1e];
	}

	/* Numeric keypad */
	if ((scancode >= 0x54) && (scancode <= 0x67))
		keycode = usb_kbd_num_keypad[scancode - 0x54];

	if (data->flags & USB_KBD_CTRL)
		keycode = scancode - 0x3;

	if (pressed == 1) {
		if (scancode == NUM_LOCK) {
			data->flags ^= USB_KBD_NUMLOCK;
			return 1;
		}

		if (scancode == CAPS_LOCK) {
			data->flags ^= USB_KBD_CAPSLOCK;
			return 1;
		}
		if (scancode == SCROLL_LOCK) {
			data->flags ^= USB_KBD_SCROLLLOCK;
			return 1;
		}
	}

	/* Report keycode if any */
	if (keycode) {
		USB_KBD_PRINTF("%c", keycode);
		usb_kbd_put_queue(data, keycode);
	}

	return 0;
}

static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
{
	uint32_t res = 0;
	struct usb_kbd_pdata *data = dev->privptr;
	uint8_t *new;
	uint8_t *old;

	if (up) {
		new = data->old;
		old = data->new;
	} else {
		new = data->new;
		old = data->old;
	}

	if ((old[i] > 3) && (memscan(new + 2, old[i], 6) == new + 8))
		res |= usb_kbd_translate(data, old[i], data->new[0], up);

	return res;
}

/* Interrupt service routine */
static int usb_kbd_irq_worker(struct usb_device *dev)
{
	struct usb_kbd_pdata *data = dev->privptr;
	int i, res = 0;

	/* No combo key pressed */
	if (data->new[0] == 0x00)
		data->flags &= ~USB_KBD_CTRL;
	/* Left or Right Ctrl pressed */
	else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
		data->flags |= USB_KBD_CTRL;

	for (i = 2; i < 8; i++) {
		res |= usb_kbd_service_key(dev, i, 0);
		res |= usb_kbd_service_key(dev, i, 1);
	}

	/* Key is still pressed */
	if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
		res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);

	if (res == 1)
		usb_kbd_setled(dev);

	memcpy(data->old, data->new, 8);

	return 1;
}

/* Keyboard interrupt handler */
static int usb_kbd_irq(struct usb_device *dev)
{
	if ((dev->irq_status != 0) || (dev->irq_act_len != 8)) {
		USB_KBD_PRINTF("USB KBD: Error %lX, len %d\n",
				dev->irq_status, dev->irq_act_len);
		return 1;
	}

	return usb_kbd_irq_worker(dev);
}

/* Interrupt polling */
static inline void usb_kbd_poll_for_event(struct usb_device *dev)
{
#if	defined(CONFIG_SYS_USB_EVENT_POLL)
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep;
	struct usb_kbd_pdata *data;
	int pipe;
	int maxp;

	/* Get the pointer to USB Keyboard device pointer */
	data = dev->privptr;
	iface = &dev->config.if_desc[0];
	ep = &iface->ep_desc[0];
	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);

	/* Submit a interrupt transfer request */
	maxp = usb_maxpacket(dev, pipe);
	usb_submit_int_msg(dev, pipe, &data->new[0],
			maxp > 8 ? 8 : maxp, ep->bInterval);

	usb_kbd_irq_worker(dev);
#elif	defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
	struct usb_interface *iface;
	struct usb_kbd_pdata *data = dev->privptr;
	iface = &dev->config.if_desc[0];
	usb_get_report(dev, iface->desc.bInterfaceNumber,
			1, 0, data->new, sizeof(data->new));
	if (memcmp(data->old, data->new, sizeof(data->new)))
		usb_kbd_irq_worker(dev);
#endif
}

/* test if a character is in the queue */
static int usb_kbd_testc(void)
{
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

	dev = stdio_get_by_name(DEVNAME);
	usb_kbd_dev = (struct usb_device *)dev->priv;
	data = usb_kbd_dev->privptr;

	usb_kbd_poll_for_event(usb_kbd_dev);

	return !(data->usb_in_pointer == data->usb_out_pointer);
}

/* gets the character from the queue */
static int usb_kbd_getc(void)
{
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

	dev = stdio_get_by_name(DEVNAME);
	usb_kbd_dev = (struct usb_device *)dev->priv;
	data = usb_kbd_dev->privptr;

	while (data->usb_in_pointer == data->usb_out_pointer)
		usb_kbd_poll_for_event(usb_kbd_dev);

	if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
		data->usb_out_pointer = 0;
	else
		data->usb_out_pointer++;

	return data->usb_kbd_buffer[data->usb_out_pointer];
}

/* probes the USB device dev for keyboard type. */
static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
{
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep;
	struct usb_kbd_pdata *data;
	int pipe, maxp;

	if (dev->descriptor.bNumConfigurations != 1)
		return 0;

	iface = &dev->config.if_desc[ifnum];

	if (iface->desc.bInterfaceClass != 3)
		return 0;

	if (iface->desc.bInterfaceSubClass != 1)
		return 0;

	if (iface->desc.bInterfaceProtocol != 1)
		return 0;

	if (iface->desc.bNumEndpoints != 1)
		return 0;

	ep = &iface->ep_desc[0];

	/* Check if endpoint 1 is interrupt endpoint */
	if (!(ep->bEndpointAddress & 0x80))
		return 0;

	if ((ep->bmAttributes & 3) != 3)
		return 0;

	USB_KBD_PRINTF("USB KBD: found set protocol...\n");

	data = malloc(sizeof(struct usb_kbd_pdata));
	if (!data) {
		printf("USB KBD: Error allocating private data\n");
		return 0;
	}

	/* Clear private data */
	memset(data, 0, sizeof(struct usb_kbd_pdata));

	/* Insert private data into USB device structure */
	dev->privptr = data;

	/* Set IRQ handler */
	dev->irq_handle = usb_kbd_irq;

	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
	maxp = usb_maxpacket(dev, pipe);

	/* We found a USB Keyboard, install it. */
	usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);

	USB_KBD_PRINTF("USB KBD: found set idle...\n");
	usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);

	USB_KBD_PRINTF("USB KBD: enable interrupt pipe...\n");
	usb_submit_int_msg(dev, pipe, data->new, maxp > 8 ? 8 : maxp,
				ep->bInterval);

	/* Success. */
	return 1;
}

/* Search for keyboard and register it if found. */
int drv_usb_kbd_init(void)
{
	struct stdio_dev usb_kbd_dev, *old_dev;
	struct usb_device *dev;
	char *stdinname = getenv("stdin");
	int error, i;

	/* Scan all USB Devices */
	for (i = 0; i < USB_MAX_DEVICE; i++) {
		/* Get USB device. */
		dev = usb_get_dev_index(i);
		if (!dev)
			return -1;

		if (dev->devnum == -1)
			continue;

		/* Try probing the keyboard */
		if (usb_kbd_probe(dev, 0) != 1)
			continue;

		/* We found a keyboard, check if it is already registered. */
		USB_KBD_PRINTF("USB KBD: found set up device.\n");
		old_dev = stdio_get_by_name(DEVNAME);
		if (old_dev) {
			/* Already registered, just return ok. */
			USB_KBD_PRINTF("USB KBD: is already registered.\n");
			return 1;
		}

		/* Register the keyboard */
		USB_KBD_PRINTF("USB KBD: register.\n");
		memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
		strcpy(usb_kbd_dev.name, DEVNAME);
		usb_kbd_dev.flags =  DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
		usb_kbd_dev.putc = NULL;
		usb_kbd_dev.puts = NULL;
		usb_kbd_dev.getc = usb_kbd_getc;
		usb_kbd_dev.tstc = usb_kbd_testc;
		usb_kbd_dev.priv = (void *)dev;
		error = stdio_register(&usb_kbd_dev);
		if (error)
			return error;

#ifdef CONFIG_CONSOLE_MUX
		error = iomux_doenv(stdin, stdinname);
		if (error)
			return error;
#else
		/* Check if this is the standard input device. */
		if (strcmp(stdinname, DEVNAME))
			return 1;

		/* Reassign the console */
		if (overwrite_console())
			return 1;

		error = console_assign(stdin, DEVNAME);
		if (error)
			return error;
#endif

		return 1;
	}

	/* No USB Keyboard found */
	return -1;
}

/* Deregister the keyboard. */
int usb_kbd_deregister(void)
{
#ifdef CONFIG_SYS_STDIO_DEREGISTER
	return stdio_deregister(DEVNAME);
#else
	return 1;
#endif
}
Commit	Line	Data
affae2bf WD	1	/*
	2	* (C) Copyright 2001
	3	* Denis Peter, MPL AG Switzerland
	4	*
	5	* Part of this source has been derived from the Linux USB
	6	* project.
	7	*
	8	* See file CREDITS for list of people who contributed to this
	9	* project.
	10	*
	11	* This program is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU General Public License as
	13	* published by the Free Software Foundation; either version 2 of
	14	* the License, or (at your option) any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	24	* MA 02111-1307 USA
	25	*
	26	*/
	27	#include <common.h>
9a8c72a6	28	#include <malloc.h>
52cb4d4f	29	#include <stdio_dev.h>
c918261c	30	#include <asm/byteorder.h>
affae2bf	31
affae2bf WD	32	#include <usb.h>
affae2bf WD	33
9a8c72a6 MV	34	#ifdef USB_KBD_DEBUG
	35	#define USB_KBD_PRINTF(fmt, args...) printf(fmt, ##args)
	36	#else
	37	#define USB_KBD_PRINTF(fmt, args...)
	38	#endif
	39
affae2bf	40	/*
00b7d6ec	41	* If overwrite_console returns 1, the stdin, stderr and stdout
affae2bf WD	42	* are switched to the serial port, else the settings in the
	43	* environment are used
	44	*/
6d0f6bcf	45	#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
00b7d6ec	46	extern int overwrite_console(void);
affae2bf	47	#else
00b7d6ec	48	int overwrite_console(void)
affae2bf	49	{
00b7d6ec	50	return 0;
affae2bf WD	51	}
	52	#endif
	53
9a8c72a6 MV	54	/* Keyboard sampling rate */
	55	#define REPEAT_RATE (40 / 4) /* 40msec -> 25cps */
	56	#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
affae2bf WD	57
affae2bf WD	58	#define NUM_LOCK 0x53
00b7d6ec MV	59	#define CAPS_LOCK 0x39
00b7d6ec MV	60	#define SCROLL_LOCK 0x47
affae2bf	61
affae2bf	62	/* Modifier bits */
9a8c72a6 MV	63	#define LEFT_CNTR (1 << 0)
	64	#define LEFT_SHIFT (1 << 1)
	65	#define LEFT_ALT (1 << 2)
	66	#define LEFT_GUI (1 << 3)
	67	#define RIGHT_CNTR (1 << 4)
	68	#define RIGHT_SHIFT (1 << 5)
	69	#define RIGHT_ALT (1 << 6)
	70	#define RIGHT_GUI (1 << 7)
	71
	72	/* Size of the keyboard buffer */
	73	#define USB_KBD_BUFFER_LEN 0x20
	74
	75	/* Device name */
00b7d6ec	76	#define DEVNAME "usbkbd"
affae2bf	77
9a8c72a6 MV	78	/* Keyboard maps */
9a8c72a6 MV	79	static const unsigned char usb_kbd_numkey[] = {
00b7d6ec MV	80	'1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
	81	'\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
	82	'\\', '#', ';', '\'', '`', ',', '.', '/'
affae2bf	83	};
9a8c72a6	84	static const unsigned char usb_kbd_numkey_shifted[] = {
00b7d6ec MV	85	'!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
	86	'\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
	87	'\|', '~', ':', '"', '~', '<', '>', '?'
affae2bf WD	88	};
affae2bf WD	89
d53da847 VP	90	static const unsigned char usb_kbd_num_keypad[] = {
	91	'/', '*', '-', '+', '\r',
	92	'1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
	93	'.', 0, 0, 0, '='
	94	};
	95
9a8c72a6 MV	96	/*
	97	* NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
	98	* order. See usb_kbd_setled() function!
	99	*/
	100	#define USB_KBD_NUMLOCK (1 << 0)
	101	#define USB_KBD_CAPSLOCK (1 << 1)
	102	#define USB_KBD_SCROLLLOCK (1 << 2)
	103	#define USB_KBD_CTRL (1 << 3)
48c8073e	104
9a8c72a6 MV	105	#define USB_KBD_LEDMASK \
9a8c72a6 MV	106	(USB_KBD_NUMLOCK \| USB_KBD_CAPSLOCK \| USB_KBD_SCROLLLOCK)
48c8073e	107
9a8c72a6 MV	108	struct usb_kbd_pdata {
9a8c72a6 MV	109	uint32_t repeat_delay;
affae2bf	110
9a8c72a6 MV	111	uint32_t usb_in_pointer;
	112	uint32_t usb_out_pointer;
	113	uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
48c8073e	114
9a8c72a6 MV	115	uint8_t new[8];
9a8c72a6 MV	116	uint8_t old[8];
48c8073e	117
9a8c72a6 MV	118	uint8_t flags;
9a8c72a6 MV	119	};
48c8073e	120
9a8c72a6 MV	121	/* Generic keyboard event polling. */
9a8c72a6 MV	122	void usb_kbd_generic_poll(void)
affae2bf	123	{
48c8073e MV	124	struct stdio_dev *dev;
48c8073e MV	125	struct usb_device *usb_kbd_dev;
9a8c72a6 MV	126	struct usb_kbd_pdata *data;
	127	struct usb_interface *iface;
	128	struct usb_endpoint_descriptor *ep;
	129	int pipe;
	130	int maxp;
48c8073e	131
9a8c72a6 MV	132	/* Get the pointer to USB Keyboard device pointer */
9a8c72a6 MV	133	dev = stdio_get_by_name(DEVNAME);
48c8073e	134	usb_kbd_dev = (struct usb_device *)dev->priv;
9a8c72a6 MV	135	data = usb_kbd_dev->privptr;
	136	iface = &usb_kbd_dev->config.if_desc[0];
	137	ep = &iface->ep_desc[0];
	138	pipe = usb_rcvintpipe(usb_kbd_dev, ep->bEndpointAddress);
48c8073e	139
9a8c72a6 MV	140	/* Submit a interrupt transfer request */
	141	maxp = usb_maxpacket(usb_kbd_dev, pipe);
	142	usb_submit_int_msg(usb_kbd_dev, pipe, data->new,
	143	maxp > 8 ? 8 : maxp, ep->bInterval);
affae2bf WD	144	}
affae2bf WD	145
9a8c72a6 MV	146	/* Puts character in the queue and sets up the in and out pointer. */
9a8c72a6 MV	147	static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
affae2bf	148	{
9a8c72a6 MV	149	if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
	150	/* Check for buffer full. */
	151	if (data->usb_out_pointer == 0)
	152	return;
affae2bf	153
9a8c72a6 MV	154	data->usb_in_pointer = 0;
	155	} else {
	156	/* Check for buffer full. */
	157	if (data->usb_in_pointer == data->usb_out_pointer - 1)
	158	return;
affae2bf	159
9a8c72a6 MV	160	data->usb_in_pointer++;
9a8c72a6 MV	161	}
affae2bf	162
9a8c72a6	163	data->usb_kbd_buffer[data->usb_in_pointer] = c;
affae2bf WD	164	}
affae2bf WD	165
9a8c72a6 MV	166	/*
	167	* Set the LEDs. Since this is used in the irq routine, the control job is
	168	* issued with a timeout of 0. This means, that the job is queued without
	169	* waiting for job completion.
affae2bf	170	*/
affae2bf WD	171	static void usb_kbd_setled(struct usb_device *dev)
affae2bf WD	172	{
9a8c72a6 MV	173	struct usb_interface *iface = &dev->config.if_desc[0];
	174	struct usb_kbd_pdata *data = dev->privptr;
	175	uint32_t leds = data->flags & USB_KBD_LEDMASK;
	176
affae2bf WD	177	usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
affae2bf WD	178	USB_REQ_SET_REPORT, USB_TYPE_CLASS \| USB_RECIP_INTERFACE,
8f8bd565	179	0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
affae2bf WD	180	}
affae2bf WD	181
9a8c72a6	182	#define CAPITAL_MASK 0x20
affae2bf	183	/* Translate the scancode in ASCII */
9a8c72a6 MV	184	static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
9a8c72a6 MV	185	unsigned char modifier, int pressed)
affae2bf	186	{
9a8c72a6	187	uint8_t keycode = 0;
affae2bf	188
9a8c72a6	189	/* Key released */
00b7d6ec	190	if (pressed == 0) {
9a8c72a6	191	data->repeat_delay = 0;
affae2bf WD	192	return 0;
affae2bf WD	193	}
9a8c72a6	194
00b7d6ec	195	if (pressed == 2) {
9a8c72a6 MV	196	data->repeat_delay++;
9a8c72a6 MV	197	if (data->repeat_delay < REPEAT_DELAY)
affae2bf	198	return 0;
9a8c72a6 MV	199
9a8c72a6 MV	200	data->repeat_delay = REPEAT_DELAY;
affae2bf	201	}
9a8c72a6 MV	202
	203	/* Alphanumeric values */
	204	if ((scancode > 3) && (scancode <= 0x1d)) {
	205	keycode = scancode - 4 + 'a';
	206
	207	if (data->flags & USB_KBD_CAPSLOCK)
00b7d6ec	208	keycode &= ~CAPITAL_MASK;
9a8c72a6 MV	209
	210	if (modifier & (LEFT_SHIFT \| RIGHT_SHIFT)) {
	211	/* Handle CAPSLock + Shift pressed simultaneously */
00b7d6ec	212	if (keycode & CAPITAL_MASK)
00b7d6ec	213	keycode &= ~CAPITAL_MASK;
affae2bf	214	else
00b7d6ec	215	keycode \|= CAPITAL_MASK;
affae2bf WD	216	}
affae2bf WD	217	}
9a8c72a6 MV	218
	219	if ((scancode > 0x1d) && (scancode < 0x3a)) {
	220	/* Shift pressed */
	221	if (modifier & (LEFT_SHIFT \| RIGHT_SHIFT))
	222	keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
	223	else
	224	keycode = usb_kbd_numkey[scancode - 0x1e];
affae2bf	225	}
4785a694	226
d53da847 VP	227	/* Numeric keypad */
	228	if ((scancode >= 0x54) && (scancode <= 0x67))
	229	keycode = usb_kbd_num_keypad[scancode - 0x54];
	230
9a8c72a6	231	if (data->flags & USB_KBD_CTRL)
4785a694 ZW	232	keycode = scancode - 0x3;
4785a694 ZW	233
00b7d6ec MV	234	if (pressed == 1) {
00b7d6ec MV	235	if (scancode == NUM_LOCK) {
9a8c72a6	236	data->flags ^= USB_KBD_NUMLOCK;
affae2bf WD	237	return 1;
affae2bf WD	238	}
9a8c72a6	239
00b7d6ec	240	if (scancode == CAPS_LOCK) {
9a8c72a6	241	data->flags ^= USB_KBD_CAPSLOCK;
affae2bf WD	242	return 1;
affae2bf WD	243	}
00b7d6ec	244	if (scancode == SCROLL_LOCK) {
9a8c72a6	245	data->flags ^= USB_KBD_SCROLLLOCK;
affae2bf WD	246	return 1;
	247	}
	248	}
9a8c72a6 MV	249
	250	/* Report keycode if any */
	251	if (keycode) {
00b7d6ec	252	USB_KBD_PRINTF("%c", keycode);
9a8c72a6	253	usb_kbd_put_queue(data, keycode);
affae2bf	254	}
9a8c72a6	255
affae2bf WD	256	return 0;
	257	}
	258
9a8c72a6 MV	259	static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
	260	{
	261	uint32_t res = 0;
	262	struct usb_kbd_pdata *data = dev->privptr;
	263	uint8_t *new;
	264	uint8_t *old;
	265
	266	if (up) {
	267	new = data->old;
	268	old = data->new;
	269	} else {
	270	new = data->new;
	271	old = data->old;
	272	}
	273
	274	if ((old[i] > 3) && (memscan(new + 2, old[i], 6) == new + 8))
	275	res \|= usb_kbd_translate(data, old[i], data->new[0], up);
	276
	277	return res;
	278	}
	279
affae2bf	280	/* Interrupt service routine */
48c8073e	281	static int usb_kbd_irq_worker(struct usb_device *dev)
affae2bf	282	{
9a8c72a6 MV	283	struct usb_kbd_pdata *data = dev->privptr;
9a8c72a6 MV	284	int i, res = 0;
4785a694	285
9a8c72a6 MV	286	/* No combo key pressed */
	287	if (data->new[0] == 0x00)
	288	data->flags &= ~USB_KBD_CTRL;
	289	/* Left or Right Ctrl pressed */
	290	else if ((data->new[0] == LEFT_CNTR) \|\| (data->new[0] == RIGHT_CNTR))
	291	data->flags \|= USB_KBD_CTRL;
00b7d6ec	292
9a8c72a6 MV	293	for (i = 2; i < 8; i++) {
	294	res \|= usb_kbd_service_key(dev, i, 0);
	295	res \|= usb_kbd_service_key(dev, i, 1);
affae2bf	296	}
00b7d6ec	297
9a8c72a6 MV	298	/* Key is still pressed */
	299	if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
	300	res \|= usb_kbd_translate(data, data->new[2], data->new[0], 2);
	301
00b7d6ec	302	if (res == 1)
affae2bf	303	usb_kbd_setled(dev);
00b7d6ec	304
9a8c72a6	305	memcpy(data->old, data->new, 8);
00b7d6ec	306
9a8c72a6	307	return 1;
affae2bf WD	308	}
affae2bf WD	309
9a8c72a6	310	/* Keyboard interrupt handler */
48c8073e MV	311	static int usb_kbd_irq(struct usb_device *dev)
	312	{
	313	if ((dev->irq_status != 0) \|\| (dev->irq_act_len != 8)) {
9a8c72a6	314	USB_KBD_PRINTF("USB KBD: Error %lX, len %d\n",
48c8073e MV	315	dev->irq_status, dev->irq_act_len);
	316	return 1;
	317	}
	318
	319	return usb_kbd_irq_worker(dev);
	320	}
	321
9a8c72a6 MV	322	/* Interrupt polling */
	323	static inline void usb_kbd_poll_for_event(struct usb_device *dev)
	324	{
	325	#if defined(CONFIG_SYS_USB_EVENT_POLL)
f9636e8d AM	326	struct usb_interface *iface;
	327	struct usb_endpoint_descriptor *ep;
	328	struct usb_kbd_pdata *data;
	329	int pipe;
	330	int maxp;
	331
	332	/* Get the pointer to USB Keyboard device pointer */
	333	data = dev->privptr;
	334	iface = &dev->config.if_desc[0];
	335	ep = &iface->ep_desc[0];
	336	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
	337
	338	/* Submit a interrupt transfer request */
	339	maxp = usb_maxpacket(dev, pipe);
	340	usb_submit_int_msg(dev, pipe, &data->new[0],
	341	maxp > 8 ? 8 : maxp, ep->bInterval);
	342
9a8c72a6 MV	343	usb_kbd_irq_worker(dev);
	344	#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
	345	struct usb_interface *iface;
	346	struct usb_kbd_pdata *data = dev->privptr;
	347	iface = &dev->config.if_desc[0];
	348	usb_get_report(dev, iface->desc.bInterfaceNumber,
3d17308e	349	1, 0, data->new, sizeof(data->new));
9a8c72a6 MV	350	if (memcmp(data->old, data->new, sizeof(data->new)))
	351	usb_kbd_irq_worker(dev);
	352	#endif
	353	}
	354
	355	/* test if a character is in the queue */
	356	static int usb_kbd_testc(void)
	357	{
	358	struct stdio_dev *dev;
	359	struct usb_device *usb_kbd_dev;
	360	struct usb_kbd_pdata *data;
	361
	362	dev = stdio_get_by_name(DEVNAME);
	363	usb_kbd_dev = (struct usb_device *)dev->priv;
	364	data = usb_kbd_dev->privptr;
	365
	366	usb_kbd_poll_for_event(usb_kbd_dev);
	367
	368	return !(data->usb_in_pointer == data->usb_out_pointer);
	369	}
	370
	371	/* gets the character from the queue */
	372	static int usb_kbd_getc(void)
	373	{
	374	struct stdio_dev *dev;
	375	struct usb_device *usb_kbd_dev;
	376	struct usb_kbd_pdata *data;
	377
	378	dev = stdio_get_by_name(DEVNAME);
	379	usb_kbd_dev = (struct usb_device *)dev->priv;
	380	data = usb_kbd_dev->privptr;
	381
	382	while (data->usb_in_pointer == data->usb_out_pointer)
	383	usb_kbd_poll_for_event(usb_kbd_dev);
	384
	385	if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
	386	data->usb_out_pointer = 0;
	387	else
	388	data->usb_out_pointer++;
	389
	390	return data->usb_kbd_buffer[data->usb_out_pointer];
	391	}
	392
	393	/* probes the USB device dev for keyboard type. */
affae2bf WD	394	static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
affae2bf WD	395	{
8f8bd565	396	struct usb_interface *iface;
affae2bf	397	struct usb_endpoint_descriptor *ep;
9a8c72a6	398	struct usb_kbd_pdata *data;
00b7d6ec	399	int pipe, maxp;
affae2bf	400
00b7d6ec MV	401	if (dev->descriptor.bNumConfigurations != 1)
00b7d6ec MV	402	return 0;
9a8c72a6	403
affae2bf WD	404	iface = &dev->config.if_desc[ifnum];
affae2bf WD	405
8f8bd565 TR	406	if (iface->desc.bInterfaceClass != 3)
8f8bd565 TR	407	return 0;
9a8c72a6	408
8f8bd565 TR	409	if (iface->desc.bInterfaceSubClass != 1)
8f8bd565 TR	410	return 0;
9a8c72a6	411
8f8bd565 TR	412	if (iface->desc.bInterfaceProtocol != 1)
8f8bd565 TR	413	return 0;
9a8c72a6	414
8f8bd565 TR	415	if (iface->desc.bNumEndpoints != 1)
8f8bd565 TR	416	return 0;
affae2bf WD	417
	418	ep = &iface->ep_desc[0];
	419
9a8c72a6	420	/* Check if endpoint 1 is interrupt endpoint */
00b7d6ec MV	421	if (!(ep->bEndpointAddress & 0x80))
00b7d6ec MV	422	return 0;
9a8c72a6	423
00b7d6ec MV	424	if ((ep->bmAttributes & 3) != 3)
00b7d6ec MV	425	return 0;
9a8c72a6 MV	426
	427	USB_KBD_PRINTF("USB KBD: found set protocol...\n");
	428
	429	data = malloc(sizeof(struct usb_kbd_pdata));
	430	if (!data) {
	431	printf("USB KBD: Error allocating private data\n");
	432	return 0;
	433	}
	434
	435	/* Clear private data */
	436	memset(data, 0, sizeof(struct usb_kbd_pdata));
	437
	438	/* Insert private data into USB device structure */
	439	dev->privptr = data;
	440
	441	/* Set IRQ handler */
	442	dev->irq_handle = usb_kbd_irq;
	443
affae2bf WD	444	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
affae2bf WD	445	maxp = usb_maxpacket(dev, pipe);
9a8c72a6 MV	446
	447	/* We found a USB Keyboard, install it. */
	448	usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
	449
	450	USB_KBD_PRINTF("USB KBD: found set idle...\n");
	451	usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
	452
	453	USB_KBD_PRINTF("USB KBD: enable interrupt pipe...\n");
	454	usb_submit_int_msg(dev, pipe, data->new, maxp > 8 ? 8 : maxp,
00b7d6ec	455	ep->bInterval);
9a8c72a6 MV	456
9a8c72a6 MV	457	/* Success. */
affae2bf WD	458	return 1;
	459	}
	460
9a8c72a6 MV	461	/* Search for keyboard and register it if found. */
	462	int drv_usb_kbd_init(void)
	463	{
	464	struct stdio_dev usb_kbd_dev, *old_dev;
	465	struct usb_device *dev;
	466	char *stdinname = getenv("stdin");
	467	int error, i;
	468
	469	/* Scan all USB Devices */
	470	for (i = 0; i < USB_MAX_DEVICE; i++) {
	471	/* Get USB device. */
	472	dev = usb_get_dev_index(i);
	473	if (!dev)
	474	return -1;
	475
	476	if (dev->devnum == -1)
	477	continue;
	478
	479	/* Try probing the keyboard */
	480	if (usb_kbd_probe(dev, 0) != 1)
	481	continue;
	482
	483	/* We found a keyboard, check if it is already registered. */
	484	USB_KBD_PRINTF("USB KBD: found set up device.\n");
	485	old_dev = stdio_get_by_name(DEVNAME);
	486	if (old_dev) {
	487	/* Already registered, just return ok. */
	488	USB_KBD_PRINTF("USB KBD: is already registered.\n");
	489	return 1;
	490	}
	491
	492	/* Register the keyboard */
	493	USB_KBD_PRINTF("USB KBD: register.\n");
	494	memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
	495	strcpy(usb_kbd_dev.name, DEVNAME);
	496	usb_kbd_dev.flags = DEV_FLAGS_INPUT \| DEV_FLAGS_SYSTEM;
	497	usb_kbd_dev.putc = NULL;
	498	usb_kbd_dev.puts = NULL;
	499	usb_kbd_dev.getc = usb_kbd_getc;
	500	usb_kbd_dev.tstc = usb_kbd_testc;
	501	usb_kbd_dev.priv = (void *)dev;
	502	error = stdio_register(&usb_kbd_dev);
	503	if (error)
	504	return error;
	505
fb3ef649 AM	506	#ifdef CONFIG_CONSOLE_MUX
	507	error = iomux_doenv(stdin, stdinname);
	508	if (error)
	509	return error;
	510	#else
9a8c72a6 MV	511	/* Check if this is the standard input device. */
	512	if (strcmp(stdinname, DEVNAME))
	513	return 1;
	514
	515	/* Reassign the console */
	516	if (overwrite_console())
	517	return 1;
	518
	519	error = console_assign(stdin, DEVNAME);
	520	if (error)
	521	return error;
fb3ef649	522	#endif
9a8c72a6 MV	523
	524	return 1;
	525	}
	526
	527	/* No USB Keyboard found */
	528	return -1;
	529	}
	530
	531	/* Deregister the keyboard. */
	532	int usb_kbd_deregister(void)
	533	{
	534	#ifdef CONFIG_SYS_STDIO_DEREGISTER
	535	return stdio_deregister(DEVNAME);
	536	#else
	537	return 1;
	538	#endif
	539	}