[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.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */
#include <common.h>
#include <malloc.h>
#include <stdio_dev.h>
#include <asm/byteorder.h>

#include <usb.h>

/*
 * 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, '='
};

/*
 * map arrow keys to ^F/^B ^N/^P, can't really use the proper
 * ANSI sequence for arrow keys because the queuing code breaks
 * when a single keypress expands to 3 queue elements
 */
static const unsigned char usb_kbd_arrow[] = {
	0x6, 0x2, 0xe, 0x10
};

/*
 * 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;
	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];
	}

	/* Arrow keys */
	if ((scancode >= 0x4f) && (scancode <= 0x52))
		keycode = usb_kbd_arrow[scancode - 0x4f];

	/* 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) {
		debug("%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)) {
		debug("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;

	debug("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));

	/* allocate input buffer aligned and sized to USB DMA alignment */
	data->new = memalign(USB_DMA_MINALIGN, roundup(8, USB_DMA_MINALIGN));

	/* 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);

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

	debug("USB KBD: enable interrupt pipe...\n");
	if (usb_submit_int_msg(dev, pipe, data->new, maxp > 8 ? 8 : maxp,
			       ep->bInterval) < 0) {
		printf("Failed to get keyboard state from device %04x:%04x\n",
		       dev->descriptor.idVendor, dev->descriptor.idProduct);
		/* Abort, we don't want to use that non-functional keyboard. */
		return 0;
	}

	/* 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. */
		debug("USB KBD: found set up device.\n");
		old_dev = stdio_get_by_name(DEVNAME);
		if (old_dev) {
			/* Already registered, just return ok. */
			debug("USB KBD: is already registered.\n");
			usb_kbd_deregister();
			return 1;
		}

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