[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 {
	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_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;
	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
	int ret = stdio_deregister(DEVNAME, force);
	if (ret && ret != -ENODEV)
		return ret;

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