[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 <dm.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		/* 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;
	unsigned long	last_report;
	struct int_queue *intq;

	uint32_t	repeat_delay;

	uint32_t	usb_in_pointer;
	uint32_t	usb_out_pointer;
	uint8_t		usb_kbd_buffer[USB_KBD_BUFFER_LEN];

	uint8_t		*new;
	uint8_t		old[USB_KBD_BOOT_REPORT_SIZE];

	uint8_t		flags;
};

extern int __maybe_unused net_busy_flag;

/* The period of time between two calls of usb_kbd_testc(). */
static unsigned long __maybe_unused kbd_testc_tms;

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

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

		data->usb_in_pointer++;
	}

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

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

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

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

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

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

		data->repeat_delay = REPEAT_DELAY;
	}

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

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

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

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

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

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

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

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

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

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

	return 0;
}

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

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

	if ((old[i] > 3) &&
	    (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
			new + USB_KBD_BOOT_REPORT_SIZE)) {
		res |= usb_kbd_translate(data, old[i], data->new[0], up);
	}

	return res;
}

/* Interrupt service routine */
static int usb_kbd_irq_worker(struct usb_device *dev)
{
	struct usb_kbd_pdata *data = dev->privptr;
	int i, res = 0;

	/* No combo key pressed */
	if (data->new[0] == 0x00)
		data->flags &= ~USB_KBD_CTRL;
	/* Left or Right Ctrl pressed */
	else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
		data->flags |= USB_KBD_CTRL;

	for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
		res |= usb_kbd_service_key(dev, i, 0);
		res |= usb_kbd_service_key(dev, i, 1);
	}

	/* Key is still pressed */
	if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
		res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);

	if (res == 1)
		usb_kbd_setled(dev);

	memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);

	return 1;
}

/* Keyboard interrupt handler */
static int usb_kbd_irq(struct usb_device *dev)
{
	if ((dev->irq_status != 0) ||
	    (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
		debug("USB KBD: Error %lX, len %d\n",
		      dev->irq_status, dev->irq_act_len);
		return 1;
	}

	return usb_kbd_irq_worker(dev);
}

/* Interrupt polling */
static inline void usb_kbd_poll_for_event(struct usb_device *dev)
{
#if defined(CONFIG_SYS_USB_EVENT_POLL)
	struct usb_kbd_pdata *data = dev->privptr;

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

	usb_kbd_irq_worker(dev);
#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
      defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
#if 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);
#else
	struct usb_kbd_pdata *data = dev->privptr;
	if (poll_int_queue(dev, data->intq)) {
		usb_kbd_irq_worker(dev);
		/* We've consumed all queued int packets, create new */
		destroy_int_queue(dev, data->intq);
		data->intq = create_int_queue(dev, data->intpipe, 1,
				      USB_KBD_BOOT_REPORT_SIZE, data->new,
				      data->intinterval);
#endif
		data->last_report = get_timer(0);
	/* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
	} else if (data->last_report != -1 &&
		   get_timer(data->last_report) > REPEAT_RATE) {
		usb_kbd_irq_worker(dev);
		data->last_report = get_timer(0);
	}
#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;
	data->last_report = -1;

	/* We found a USB Keyboard, install it. */
	usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);

#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
    !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
	debug("USB KBD: found set idle...\n");
	usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
#endif

	debug("USB KBD: enable interrupt pipe...\n");
#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
	data->intq = create_int_queue(dev, data->intpipe, 1,
				      USB_KBD_BOOT_REPORT_SIZE, data->new,
				      data->intinterval);
	if (!data->intq) {
#else
	if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
			       data->intinterval) < 0) {
#endif
		printf("Failed to get keyboard state from device %04x:%04x\n",
		       dev->descriptor.idVendor, dev->descriptor.idProduct);
		/* Abort, we don't want to use that non-functional keyboard. */
		return 0;
	}

	/* Success. */
	return 1;
}

static int probe_usb_keyboard(struct usb_device *dev)
{
	char *stdinname;
	struct stdio_dev usb_kbd_dev;
	int error;

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

	/* 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;

	stdinname = getenv("stdin");
#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 0;
}

/* Search for keyboard and register it if found. */
int drv_usb_kbd_init(void)
{
	int error, i;

	debug("%s: Probing for keyboard\n", __func__);
#ifdef CONFIG_DM_USB
	/*
	 * TODO: We should add USB_DEVICE() declarations to each USB ethernet
	 * driver and then most of this file can be removed.
	 */
	struct udevice *bus;
	struct uclass *uc;
	int ret;

	ret = uclass_get(UCLASS_USB, &uc);
	if (ret)
		return ret;
	uclass_foreach_dev(bus, uc) {
		for (i = 0; i < USB_MAX_DEVICE; i++) {
			struct usb_device *dev;

			dev = usb_get_dev_index(bus, i); /* get device */
			debug("i=%d, %p\n", i, dev);
			if (!dev)
				break; /* no more devices available */

			error = probe_usb_keyboard(dev);
			if (!error)
				return 1;
			if (error && error != -ENOENT)
				return error;
		} /* for */
	}
#else
	/* Scan all USB Devices */
	for (i = 0; i < USB_MAX_DEVICE; i++) {
		struct usb_device *dev;

		/* Get USB device. */
		dev = usb_get_dev_index(i);
		if (!dev)
			break;

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

		error = probe_usb_keyboard(dev);
		if (!error)
			return 1;
		if (error && error != -ENOENT)
			return error;
	}
#endif

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

/* Deregister the keyboard. */
int usb_kbd_deregister(int force)
{
#ifdef CONFIG_SYS_STDIO_DEREGISTER
	struct stdio_dev *dev;
	struct usb_device *usb_kbd_dev;
	struct usb_kbd_pdata *data;

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

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