[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)

/*
 * USB Keyboard reports are 8 bytes in boot protocol.
 * Appendix B of HID Device Class Definition 1.11
 */
#define USB_KBD_BOOT_REPORT_SIZE 8

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[USB_KBD_BOOT_REPORT_SIZE];

	uint8_t		flags;
};

extern int __maybe_unused net_busy_flag;

/* The period of time between two calls of usb_kbd_testc(). */
static unsigned long __maybe_unused kbd_testc_tms;

/* 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,
		min(maxp, USB_KBD_BOOT_REPORT_SIZE),
		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], USB_KBD_BOOT_REPORT_SIZE - 2) ==
			new + USB_KBD_BOOT_REPORT_SIZE)) {
		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 < USB_KBD_BOOT_REPORT_SIZE; 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, USB_KBD_BOOT_REPORT_SIZE);

	return 1;
}

/* Keyboard interrupt handler */
static int usb_kbd_irq(struct usb_device *dev)
{
	if ((dev->irq_status != 0) ||
	    (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
		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],
		min(maxp, USB_KBD_BOOT_REPORT_SIZE),
		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, USB_KBD_BOOT_REPORT_SIZE);
	if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
		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;

#ifdef CONFIG_CMD_NET
	/*
	 * If net_busy_flag is 1, NET transfer is running,
	 * then we check key-pressed every second (first check may be
	 * less than 1 second) to improve TFTP booting performance.
	 */
	if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
		return 0;
	kbd_testc_tms = get_timer(0);
#endif
	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(USB_KBD_BOOT_REPORT_SIZE, 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,
			       min(maxp, USB_KBD_BOOT_REPORT_SIZE),
			       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
08a98b89 AC	94	/*
	95	* USB Keyboard reports are 8 bytes in boot protocol.
	96	* Appendix B of HID Device Class Definition 1.11
	97	*/
	98	#define USB_KBD_BOOT_REPORT_SIZE 8
	99
9a8c72a6 MV	100	struct usb_kbd_pdata {
9a8c72a6 MV	101	uint32_t repeat_delay;
affae2bf	102
9a8c72a6 MV	103	uint32_t usb_in_pointer;
	104	uint32_t usb_out_pointer;
	105	uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
48c8073e	106
d7475386	107	uint8_t *new;
08a98b89	108	uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
48c8073e	109
9a8c72a6 MV	110	uint8_t flags;
9a8c72a6 MV	111	};
48c8073e	112
07551f23 JL	113	extern int __maybe_unused net_busy_flag;
	114
	115	/* The period of time between two calls of usb_kbd_testc(). */
	116	static unsigned long __maybe_unused kbd_testc_tms;
	117
9a8c72a6 MV	118	/* Generic keyboard event polling. */
9a8c72a6 MV	119	void usb_kbd_generic_poll(void)
affae2bf	120	{
48c8073e MV	121	struct stdio_dev *dev;
48c8073e MV	122	struct usb_device *usb_kbd_dev;
9a8c72a6 MV	123	struct usb_kbd_pdata *data;
	124	struct usb_interface *iface;
	125	struct usb_endpoint_descriptor *ep;
	126	int pipe;
	127	int maxp;
48c8073e	128
9a8c72a6 MV	129	/* Get the pointer to USB Keyboard device pointer */
9a8c72a6 MV	130	dev = stdio_get_by_name(DEVNAME);
48c8073e	131	usb_kbd_dev = (struct usb_device *)dev->priv;
9a8c72a6 MV	132	data = usb_kbd_dev->privptr;
	133	iface = &usb_kbd_dev->config.if_desc[0];
	134	ep = &iface->ep_desc[0];
	135	pipe = usb_rcvintpipe(usb_kbd_dev, ep->bEndpointAddress);
48c8073e	136
9a8c72a6 MV	137	/* Submit a interrupt transfer request */
	138	maxp = usb_maxpacket(usb_kbd_dev, pipe);
	139	usb_submit_int_msg(usb_kbd_dev, pipe, data->new,
08a98b89 AC	140	min(maxp, USB_KBD_BOOT_REPORT_SIZE),
08a98b89 AC	141	ep->bInterval);
affae2bf WD	142	}
affae2bf WD	143
9a8c72a6 MV	144	/* Puts character in the queue and sets up the in and out pointer. */
9a8c72a6 MV	145	static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
affae2bf	146	{
9a8c72a6 MV	147	if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
	148	/* Check for buffer full. */
	149	if (data->usb_out_pointer == 0)
	150	return;
affae2bf	151
9a8c72a6 MV	152	data->usb_in_pointer = 0;
	153	} else {
	154	/* Check for buffer full. */
	155	if (data->usb_in_pointer == data->usb_out_pointer - 1)
	156	return;
affae2bf	157
9a8c72a6 MV	158	data->usb_in_pointer++;
9a8c72a6 MV	159	}
affae2bf	160
9a8c72a6	161	data->usb_kbd_buffer[data->usb_in_pointer] = c;
affae2bf WD	162	}
affae2bf WD	163
9a8c72a6 MV	164	/*
	165	* Set the LEDs. Since this is used in the irq routine, the control job is
	166	* issued with a timeout of 0. This means, that the job is queued without
	167	* waiting for job completion.
affae2bf	168	*/
affae2bf WD	169	static void usb_kbd_setled(struct usb_device *dev)
affae2bf WD	170	{
9a8c72a6 MV	171	struct usb_interface *iface = &dev->config.if_desc[0];
	172	struct usb_kbd_pdata *data = dev->privptr;
	173	uint32_t leds = data->flags & USB_KBD_LEDMASK;
	174
affae2bf WD	175	usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
affae2bf WD	176	USB_REQ_SET_REPORT, USB_TYPE_CLASS \| USB_RECIP_INTERFACE,
8f8bd565	177	0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
affae2bf WD	178	}
affae2bf WD	179
9a8c72a6	180	#define CAPITAL_MASK 0x20
affae2bf	181	/* Translate the scancode in ASCII */
9a8c72a6 MV	182	static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
9a8c72a6 MV	183	unsigned char modifier, int pressed)
affae2bf	184	{
9a8c72a6	185	uint8_t keycode = 0;
affae2bf	186
9a8c72a6	187	/* Key released */
00b7d6ec	188	if (pressed == 0) {
9a8c72a6	189	data->repeat_delay = 0;
affae2bf WD	190	return 0;
affae2bf WD	191	}
9a8c72a6	192
00b7d6ec	193	if (pressed == 2) {
9a8c72a6 MV	194	data->repeat_delay++;
9a8c72a6 MV	195	if (data->repeat_delay < REPEAT_DELAY)
affae2bf	196	return 0;
9a8c72a6 MV	197
9a8c72a6 MV	198	data->repeat_delay = REPEAT_DELAY;
affae2bf	199	}
9a8c72a6 MV	200
	201	/* Alphanumeric values */
	202	if ((scancode > 3) && (scancode <= 0x1d)) {
	203	keycode = scancode - 4 + 'a';
	204
	205	if (data->flags & USB_KBD_CAPSLOCK)
00b7d6ec	206	keycode &= ~CAPITAL_MASK;
9a8c72a6 MV	207
	208	if (modifier & (LEFT_SHIFT \| RIGHT_SHIFT)) {
	209	/* Handle CAPSLock + Shift pressed simultaneously */
00b7d6ec	210	if (keycode & CAPITAL_MASK)
00b7d6ec	211	keycode &= ~CAPITAL_MASK;
affae2bf	212	else
00b7d6ec	213	keycode \|= CAPITAL_MASK;
affae2bf WD	214	}
affae2bf WD	215	}
9a8c72a6 MV	216
	217	if ((scancode > 0x1d) && (scancode < 0x3a)) {
	218	/* Shift pressed */
	219	if (modifier & (LEFT_SHIFT \| RIGHT_SHIFT))
	220	keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
	221	else
	222	keycode = usb_kbd_numkey[scancode - 0x1e];
affae2bf	223	}
4785a694	224
4151a400 AM	225	/* Arrow keys */
	226	if ((scancode >= 0x4f) && (scancode <= 0x52))
	227	keycode = usb_kbd_arrow[scancode - 0x4f];
	228
d53da847 VP	229	/* Numeric keypad */
	230	if ((scancode >= 0x54) && (scancode <= 0x67))
	231	keycode = usb_kbd_num_keypad[scancode - 0x54];
	232
9a8c72a6	233	if (data->flags & USB_KBD_CTRL)
4785a694 ZW	234	keycode = scancode - 0x3;
4785a694 ZW	235
00b7d6ec MV	236	if (pressed == 1) {
00b7d6ec MV	237	if (scancode == NUM_LOCK) {
9a8c72a6	238	data->flags ^= USB_KBD_NUMLOCK;
affae2bf WD	239	return 1;
affae2bf WD	240	}
9a8c72a6	241
00b7d6ec	242	if (scancode == CAPS_LOCK) {
9a8c72a6	243	data->flags ^= USB_KBD_CAPSLOCK;
affae2bf WD	244	return 1;
affae2bf WD	245	}
00b7d6ec	246	if (scancode == SCROLL_LOCK) {
9a8c72a6	247	data->flags ^= USB_KBD_SCROLLLOCK;
affae2bf WD	248	return 1;
	249	}
	250	}
9a8c72a6 MV	251
	252	/* Report keycode if any */
	253	if (keycode) {
ceb4972a	254	debug("%c", keycode);
9a8c72a6	255	usb_kbd_put_queue(data, keycode);
affae2bf	256	}
9a8c72a6	257
affae2bf WD	258	return 0;
	259	}
	260
9a8c72a6 MV	261	static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
	262	{
	263	uint32_t res = 0;
	264	struct usb_kbd_pdata *data = dev->privptr;
	265	uint8_t *new;
	266	uint8_t *old;
	267
	268	if (up) {
	269	new = data->old;
	270	old = data->new;
	271	} else {
	272	new = data->new;
	273	old = data->old;
	274	}
	275
08a98b89 AC	276	if ((old[i] > 3) &&
	277	(memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
	278	new + USB_KBD_BOOT_REPORT_SIZE)) {
9a8c72a6	279	res \|= usb_kbd_translate(data, old[i], data->new[0], up);
08a98b89	280	}
9a8c72a6 MV	281
	282	return res;
	283	}
	284
affae2bf	285	/* Interrupt service routine */
48c8073e	286	static int usb_kbd_irq_worker(struct usb_device *dev)
affae2bf	287	{
9a8c72a6 MV	288	struct usb_kbd_pdata *data = dev->privptr;
9a8c72a6 MV	289	int i, res = 0;
4785a694	290
9a8c72a6 MV	291	/* No combo key pressed */
	292	if (data->new[0] == 0x00)
	293	data->flags &= ~USB_KBD_CTRL;
	294	/* Left or Right Ctrl pressed */
	295	else if ((data->new[0] == LEFT_CNTR) \|\| (data->new[0] == RIGHT_CNTR))
	296	data->flags \|= USB_KBD_CTRL;
00b7d6ec	297
08a98b89	298	for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
9a8c72a6 MV	299	res \|= usb_kbd_service_key(dev, i, 0);
9a8c72a6 MV	300	res \|= usb_kbd_service_key(dev, i, 1);
affae2bf	301	}
00b7d6ec	302
9a8c72a6 MV	303	/* Key is still pressed */
	304	if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
	305	res \|= usb_kbd_translate(data, data->new[2], data->new[0], 2);
	306
00b7d6ec	307	if (res == 1)
affae2bf	308	usb_kbd_setled(dev);
00b7d6ec	309
08a98b89	310	memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
00b7d6ec	311
9a8c72a6	312	return 1;
affae2bf WD	313	}
affae2bf WD	314
9a8c72a6	315	/* Keyboard interrupt handler */
48c8073e MV	316	static int usb_kbd_irq(struct usb_device *dev)
48c8073e MV	317	{
08a98b89 AC	318	if ((dev->irq_status != 0) \|\|
08a98b89 AC	319	(dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
ceb4972a VG	320	debug("USB KBD: Error %lX, len %d\n",
ceb4972a VG	321	dev->irq_status, dev->irq_act_len);
48c8073e MV	322	return 1;
	323	}
	324
	325	return usb_kbd_irq_worker(dev);
	326	}
	327
9a8c72a6 MV	328	/* Interrupt polling */
	329	static inline void usb_kbd_poll_for_event(struct usb_device *dev)
	330	{
	331	#if defined(CONFIG_SYS_USB_EVENT_POLL)
f9636e8d AM	332	struct usb_interface *iface;
	333	struct usb_endpoint_descriptor *ep;
	334	struct usb_kbd_pdata *data;
	335	int pipe;
	336	int maxp;
	337
	338	/* Get the pointer to USB Keyboard device pointer */
	339	data = dev->privptr;
	340	iface = &dev->config.if_desc[0];
	341	ep = &iface->ep_desc[0];
	342	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
	343
	344	/* Submit a interrupt transfer request */
	345	maxp = usb_maxpacket(dev, pipe);
	346	usb_submit_int_msg(dev, pipe, &data->new[0],
08a98b89 AC	347	min(maxp, USB_KBD_BOOT_REPORT_SIZE),
08a98b89 AC	348	ep->bInterval);
f9636e8d	349
9a8c72a6 MV	350	usb_kbd_irq_worker(dev);
	351	#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
	352	struct usb_interface *iface;
	353	struct usb_kbd_pdata *data = dev->privptr;
	354	iface = &dev->config.if_desc[0];
	355	usb_get_report(dev, iface->desc.bInterfaceNumber,
08a98b89 AC	356	1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
08a98b89 AC	357	if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
9a8c72a6 MV	358	usb_kbd_irq_worker(dev);
	359	#endif
	360	}
	361
	362	/* test if a character is in the queue */
	363	static int usb_kbd_testc(void)
	364	{
	365	struct stdio_dev *dev;
	366	struct usb_device *usb_kbd_dev;
	367	struct usb_kbd_pdata *data;
	368
c95e2b9e JL	369	#ifdef CONFIG_CMD_NET
	370	/*
	371	* If net_busy_flag is 1, NET transfer is running,
	372	* then we check key-pressed every second (first check may be
	373	* less than 1 second) to improve TFTP booting performance.
	374	*/
	375	if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
	376	return 0;
	377	kbd_testc_tms = get_timer(0);
	378	#endif
9a8c72a6 MV	379	dev = stdio_get_by_name(DEVNAME);
	380	usb_kbd_dev = (struct usb_device *)dev->priv;
	381	data = usb_kbd_dev->privptr;
	382
	383	usb_kbd_poll_for_event(usb_kbd_dev);
	384
	385	return !(data->usb_in_pointer == data->usb_out_pointer);
	386	}
	387
	388	/* gets the character from the queue */
	389	static int usb_kbd_getc(void)
	390	{
	391	struct stdio_dev *dev;
	392	struct usb_device *usb_kbd_dev;
	393	struct usb_kbd_pdata *data;
	394
	395	dev = stdio_get_by_name(DEVNAME);
	396	usb_kbd_dev = (struct usb_device *)dev->priv;
	397	data = usb_kbd_dev->privptr;
	398
	399	while (data->usb_in_pointer == data->usb_out_pointer)
	400	usb_kbd_poll_for_event(usb_kbd_dev);
	401
	402	if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
	403	data->usb_out_pointer = 0;
	404	else
	405	data->usb_out_pointer++;
	406
	407	return data->usb_kbd_buffer[data->usb_out_pointer];
	408	}
	409
	410	/* probes the USB device dev for keyboard type. */
affae2bf WD	411	static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
affae2bf WD	412	{
8f8bd565	413	struct usb_interface *iface;
affae2bf	414	struct usb_endpoint_descriptor *ep;
9a8c72a6	415	struct usb_kbd_pdata *data;
00b7d6ec	416	int pipe, maxp;
affae2bf	417
00b7d6ec MV	418	if (dev->descriptor.bNumConfigurations != 1)
00b7d6ec MV	419	return 0;
9a8c72a6	420
affae2bf WD	421	iface = &dev->config.if_desc[ifnum];
affae2bf WD	422
8f8bd565 TR	423	if (iface->desc.bInterfaceClass != 3)
8f8bd565 TR	424	return 0;
9a8c72a6	425
8f8bd565 TR	426	if (iface->desc.bInterfaceSubClass != 1)
8f8bd565 TR	427	return 0;
9a8c72a6	428
8f8bd565 TR	429	if (iface->desc.bInterfaceProtocol != 1)
8f8bd565 TR	430	return 0;
9a8c72a6	431
8f8bd565 TR	432	if (iface->desc.bNumEndpoints != 1)
8f8bd565 TR	433	return 0;
affae2bf WD	434
	435	ep = &iface->ep_desc[0];
	436
9a8c72a6	437	/* Check if endpoint 1 is interrupt endpoint */
00b7d6ec MV	438	if (!(ep->bEndpointAddress & 0x80))
00b7d6ec MV	439	return 0;
9a8c72a6	440
00b7d6ec MV	441	if ((ep->bmAttributes & 3) != 3)
00b7d6ec MV	442	return 0;
9a8c72a6	443
ceb4972a	444	debug("USB KBD: found set protocol...\n");
9a8c72a6 MV	445
	446	data = malloc(sizeof(struct usb_kbd_pdata));
	447	if (!data) {
	448	printf("USB KBD: Error allocating private data\n");
	449	return 0;
	450	}
	451
	452	/* Clear private data */
	453	memset(data, 0, sizeof(struct usb_kbd_pdata));
	454
d7475386	455	/* allocate input buffer aligned and sized to USB DMA alignment */
08a98b89 AC	456	data->new = memalign(USB_DMA_MINALIGN,
08a98b89 AC	457	roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
d7475386	458
9a8c72a6 MV	459	/* Insert private data into USB device structure */
	460	dev->privptr = data;
	461
	462	/* Set IRQ handler */
	463	dev->irq_handle = usb_kbd_irq;
	464
affae2bf WD	465	pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
affae2bf WD	466	maxp = usb_maxpacket(dev, pipe);
9a8c72a6 MV	467
	468	/* We found a USB Keyboard, install it. */
	469	usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
	470
ceb4972a	471	debug("USB KBD: found set idle...\n");
9a8c72a6 MV	472	usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
9a8c72a6 MV	473
ceb4972a	474	debug("USB KBD: enable interrupt pipe...\n");
08a98b89 AC	475	if (usb_submit_int_msg(dev, pipe, data->new,
08a98b89 AC	476	min(maxp, USB_KBD_BOOT_REPORT_SIZE),
5da2dc97 VP	477	ep->bInterval) < 0) {
	478	printf("Failed to get keyboard state from device %04x:%04x\n",
	479	dev->descriptor.idVendor, dev->descriptor.idProduct);
	480	/* Abort, we don't want to use that non-functional keyboard. */
	481	return 0;
	482	}
9a8c72a6 MV	483
9a8c72a6 MV	484	/* Success. */
affae2bf WD	485	return 1;
	486	}
	487
9a8c72a6 MV	488	/* Search for keyboard and register it if found. */
	489	int drv_usb_kbd_init(void)
	490	{
	491	struct stdio_dev usb_kbd_dev, *old_dev;
	492	struct usb_device *dev;
	493	char *stdinname = getenv("stdin");
	494	int error, i;
	495
	496	/* Scan all USB Devices */
	497	for (i = 0; i < USB_MAX_DEVICE; i++) {
	498	/* Get USB device. */
	499	dev = usb_get_dev_index(i);
	500	if (!dev)
	501	return -1;
	502
	503	if (dev->devnum == -1)
	504	continue;
	505
	506	/* Try probing the keyboard */
	507	if (usb_kbd_probe(dev, 0) != 1)
	508	continue;
	509
	510	/* We found a keyboard, check if it is already registered. */
ceb4972a	511	debug("USB KBD: found set up device.\n");
9a8c72a6 MV	512	old_dev = stdio_get_by_name(DEVNAME);
	513	if (old_dev) {
	514	/* Already registered, just return ok. */
ceb4972a	515	debug("USB KBD: is already registered.\n");
09defbc7	516	usb_kbd_deregister();
9a8c72a6 MV	517	return 1;
	518	}
	519
	520	/* Register the keyboard */
ceb4972a	521	debug("USB KBD: register.\n");
9a8c72a6 MV	522	memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
	523	strcpy(usb_kbd_dev.name, DEVNAME);
	524	usb_kbd_dev.flags = DEV_FLAGS_INPUT \| DEV_FLAGS_SYSTEM;
	525	usb_kbd_dev.putc = NULL;
	526	usb_kbd_dev.puts = NULL;
	527	usb_kbd_dev.getc = usb_kbd_getc;
	528	usb_kbd_dev.tstc = usb_kbd_testc;
	529	usb_kbd_dev.priv = (void *)dev;
	530	error = stdio_register(&usb_kbd_dev);
	531	if (error)
	532	return error;
	533
fb3ef649 AM	534	#ifdef CONFIG_CONSOLE_MUX
	535	error = iomux_doenv(stdin, stdinname);
	536	if (error)
	537	return error;
	538	#else
9a8c72a6 MV	539	/* Check if this is the standard input device. */
	540	if (strcmp(stdinname, DEVNAME))
	541	return 1;
	542
	543	/* Reassign the console */
	544	if (overwrite_console())
	545	return 1;
	546
	547	error = console_assign(stdin, DEVNAME);
	548	if (error)
	549	return error;
fb3ef649	550	#endif
9a8c72a6 MV	551
	552	return 1;
	553	}
	554
	555	/* No USB Keyboard found */
	556	return -1;
	557	}
	558
	559	/* Deregister the keyboard. */
	560	int usb_kbd_deregister(void)
	561	{
	562	#ifdef CONFIG_SYS_STDIO_DEREGISTER
	563	return stdio_deregister(DEVNAME);
	564	#else
	565	return 1;
	566	#endif
	567	}