[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 <errno.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 {
	unsigned long	intpipe;
	int		intpktsize;
	int		intinterval;
	struct int_queue *intq;

	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;

/* 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;
	ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);

	*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, 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_kbd_pdata *data = dev->privptr;

	/* Submit a interrupt transfer request */
	usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
			   data->intinterval);

	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);
#elif	defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
	struct usb_kbd_pdata *data = dev->privptr;
	if (poll_int_queue(dev, data->intq)) {
		usb_kbd_irq_worker(dev);
		/* We've consumed all queued int packets, create new */
		destroy_int_queue(dev, data->intq);
		data->intq = create_int_queue(dev, data->intpipe, 1,
				      USB_KBD_BOOT_REPORT_SIZE, data->new,
				      data->intinterval);
	}
#endif
}

/* test if a character is in the queue */
static int usb_kbd_testc(struct stdio_dev *sdev)
{
	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(struct stdio_dev *sdev)
{
	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;

	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;

	data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
	data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
			       USB_KBD_BOOT_REPORT_SIZE);
	data->intinterval = ep->bInterval;

	/* 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");
#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
	data->intq = create_int_queue(dev, data->intpipe, 1,
				      USB_KBD_BOOT_REPORT_SIZE, data->new,
				      data->intinterval);
	if (!data->intq) {
#else
	if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
			       data->intinterval) < 0) {
#endif
		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;
	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;

		/* 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.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(int force)
{
#ifdef CONFIG_SYS_STDIO_DEREGISTER
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

	dev = stdio_get_by_name(DEVNAME);
	if (dev) {
		usb_kbd_dev = (struct usb_device *)dev->priv;
		data = usb_kbd_dev->privptr;
		if (stdio_deregister_dev(dev, force) != 0)
			return 1;
#ifdef CONFIG_CONSOLE_MUX
		if (iomux_doenv(stdin, getenv("stdin")) != 0)
			return 1;
#endif
#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
		destroy_int_queue(usb_kbd_dev, data->intq);
#endif
		free(data->new);
		free(data);
	}

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