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

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

	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,
			maxp > 8 ? 8 : maxp, ep->bInterval);
}

/* Puts character in the queue and sets up the in and out pointer. */
static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
{
	if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
		/* Check for buffer full. */
		if (data->usb_out_pointer == 0)
			return;

		data->usb_in_pointer = 0;
	} else {
		/* Check for buffer full. */
		if (data->usb_in_pointer == data->usb_out_pointer - 1)
			return;

		data->usb_in_pointer++;
	}

	data->usb_kbd_buffer[data->usb_in_pointer] = c;
}

/*
 * Set the LEDs. Since this is used in the irq routine, the control job is
 * issued with a timeout of 0. This means, that the job is queued without
 * waiting for job completion.
 */
static void usb_kbd_setled(struct usb_device *dev)
{
	struct usb_interface *iface = &dev->config.if_desc[0];
	struct usb_kbd_pdata *data = dev->privptr;
	uint32_t leds = data->flags & USB_KBD_LEDMASK;

	usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
}

#define CAPITAL_MASK	0x20
/* Translate the scancode in ASCII */
static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
				unsigned char modifier, int pressed)
{
	uint8_t keycode = 0;

	/* Key released */
	if (pressed == 0) {
		data->repeat_delay = 0;
		return 0;
	}

	if (pressed == 2) {
		data->repeat_delay++;
		if (data->repeat_delay < REPEAT_DELAY)
			return 0;

		data->repeat_delay = REPEAT_DELAY;
	}

	/* Alphanumeric values */
	if ((scancode > 3) && (scancode <= 0x1d)) {
		keycode = scancode - 4 + 'a';

		if (data->flags & USB_KBD_CAPSLOCK)
			keycode &= ~CAPITAL_MASK;

		if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
			/* Handle CAPSLock + Shift pressed simultaneously */
			if (keycode & CAPITAL_MASK)
				keycode &= ~CAPITAL_MASK;
			else
				keycode |= CAPITAL_MASK;
		}
	}

	if ((scancode > 0x1d) && (scancode < 0x3a)) {
		/* Shift pressed */
		if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
			keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
		else
			keycode = usb_kbd_numkey[scancode - 0x1e];
	}

	/* Arrow keys */
	if ((scancode >= 0x4f) && (scancode <= 0x52))
		keycode = usb_kbd_arrow[scancode - 0x4f];

	/* Numeric keypad */
	if ((scancode >= 0x54) && (scancode <= 0x67))
		keycode = usb_kbd_num_keypad[scancode - 0x54];

	if (data->flags & USB_KBD_CTRL)
		keycode = scancode - 0x3;

	if (pressed == 1) {
		if (scancode == NUM_LOCK) {
			data->flags ^= USB_KBD_NUMLOCK;
			return 1;
		}

		if (scancode == CAPS_LOCK) {
			data->flags ^= USB_KBD_CAPSLOCK;
			return 1;
		}
		if (scancode == SCROLL_LOCK) {
			data->flags ^= USB_KBD_SCROLLLOCK;
			return 1;
		}
	}

	/* Report keycode if any */
	if (keycode) {
		debug("%c", keycode);
		usb_kbd_put_queue(data, keycode);
	}

	return 0;
}

static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
{
	uint32_t res = 0;
	struct usb_kbd_pdata *data = dev->privptr;
	uint8_t *new;
	uint8_t *old;

	if (up) {
		new = data->old;
		old = data->new;
	} else {
		new = data->new;
		old = data->old;
	}

	if ((old[i] > 3) && (memscan(new + 2, old[i], 6) == new + 8))
		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 < 8; 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, 8);

	return 1;
}

/* Keyboard interrupt handler */
static int usb_kbd_irq(struct usb_device *dev)
{
	if ((dev->irq_status != 0) || (dev->irq_act_len != 8)) {
		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],
			maxp > 8 ? 8 : maxp, 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, sizeof(data->new));
	if (memcmp(data->old, data->new, sizeof(data->new)))
		usb_kbd_irq_worker(dev);
#endif
}

/* test if a character is in the queue */
static int usb_kbd_testc(void)
{
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

#ifdef CONFIG_CMD_NET
	/*
	 * If net_busy_flag is 1, NET transfer is running,
	 * then we check key-pressed every second (first check may be
	 * less than 1 second) to improve TFTP booting performance.
	 */
	if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
		return 0;
	kbd_testc_tms = get_timer(0);
#endif
	dev = stdio_get_by_name(DEVNAME);
	usb_kbd_dev = (struct usb_device *)dev->priv;
	data = usb_kbd_dev->privptr;

	usb_kbd_poll_for_event(usb_kbd_dev);

	return !(data->usb_in_pointer == data->usb_out_pointer);
}

/* gets the character from the queue */
static int usb_kbd_getc(void)
{
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

	dev = stdio_get_by_name(DEVNAME);
	usb_kbd_dev = (struct usb_device *)dev->priv;
	data = usb_kbd_dev->privptr;

	while (data->usb_in_pointer == data->usb_out_pointer)
		usb_kbd_poll_for_event(usb_kbd_dev);

	if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
		data->usb_out_pointer = 0;
	else
		data->usb_out_pointer++;

	return data->usb_kbd_buffer[data->usb_out_pointer];
}

/* probes the USB device dev for keyboard type. */
static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
{
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep;
	struct usb_kbd_pdata *data;
	int pipe, maxp;

	if (dev->descriptor.bNumConfigurations != 1)
		return 0;

	iface = &dev->config.if_desc[ifnum];

	if (iface->desc.bInterfaceClass != 3)
		return 0;

	if (iface->desc.bInterfaceSubClass != 1)
		return 0;

	if (iface->desc.bInterfaceProtocol != 1)
		return 0;

	if (iface->desc.bNumEndpoints != 1)
		return 0;

	ep = &iface->ep_desc[0];

	/* Check if endpoint 1 is interrupt endpoint */
	if (!(ep->bEndpointAddress & 0x80))
		return 0;

	if ((ep->bmAttributes & 3) != 3)
		return 0;

	debug("USB KBD: found set protocol...\n");

	data = malloc(sizeof(struct usb_kbd_pdata));
	if (!data) {
		printf("USB KBD: Error allocating private data\n");
		return 0;
	}

	/* Clear private data */
	memset(data, 0, sizeof(struct usb_kbd_pdata));

	/* allocate input buffer aligned and sized to USB DMA alignment */
	data->new = memalign(USB_DMA_MINALIGN, roundup(8, 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, maxp > 8 ? 8 : maxp,
			       ep->bInterval) < 0) {
		printf("Failed to get keyboard state from device %04x:%04x\n",
		       dev->descriptor.idVendor, dev->descriptor.idProduct);
		/* Abort, we don't want to use that non-functional keyboard. */
		return 0;
	}

	/* Success. */
	return 1;
}

/* Search for keyboard and register it if found. */
int drv_usb_kbd_init(void)
{
	struct stdio_dev usb_kbd_dev, *old_dev;
	struct usb_device *dev;
	char *stdinname = getenv("stdin");
	int error, i;

	/* Scan all USB Devices */
	for (i = 0; i < USB_MAX_DEVICE; i++) {
		/* Get USB device. */
		dev = usb_get_dev_index(i);
		if (!dev)
			return -1;

		if (dev->devnum == -1)
			continue;

		/* Try probing the keyboard */
		if (usb_kbd_probe(dev, 0) != 1)
			continue;

		/* We found a keyboard, check if it is already registered. */
		debug("USB KBD: found set up device.\n");
		old_dev = stdio_get_by_name(DEVNAME);
		if (old_dev) {
			/* Already registered, just return ok. */
			debug("USB KBD: is already registered.\n");
			usb_kbd_deregister();
			return 1;
		}

		/* Register the keyboard */
		debug("USB KBD: register.\n");
		memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
		strcpy(usb_kbd_dev.name, DEVNAME);
		usb_kbd_dev.flags =  DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
		usb_kbd_dev.putc = NULL;
		usb_kbd_dev.puts = NULL;
		usb_kbd_dev.getc = usb_kbd_getc;
		usb_kbd_dev.tstc = usb_kbd_testc;
		usb_kbd_dev.priv = (void *)dev;
		error = stdio_register(&usb_kbd_dev);
		if (error)
			return error;

#ifdef CONFIG_CONSOLE_MUX
		error = iomux_doenv(stdin, stdinname);
		if (error)
			return error;
#else
		/* Check if this is the standard input device. */
		if (strcmp(stdinname, DEVNAME))
			return 1;

		/* Reassign the console */
		if (overwrite_console())
			return 1;

		error = console_assign(stdin, DEVNAME);
		if (error)
			return error;
#endif

		return 1;
	}

	/* No USB Keyboard found */
	return -1;
}

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