[thirdparty/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;

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