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