USB: wacom tablet driver reorganization

#

# Multipart objects.

wacom-objs	:= wacom_sys.o wacom_wac.o

usbhid-objs	:= hid-core.o

# Optional parts of multipart objects.

/*

 * drivers/usb/input/wacom.h

 *

 *  USB Wacom Graphire and Wacom Intuos tablet support

 *

 *  Copyright (c) 2000-2004 Vojtech Pavlik	<vojtech@ucw.cz>

 *  Copyright (c) 2000 Andreas Bach Aaen	<abach@stofanet.dk>

 *  Copyright (c) 2000 Clifford Wolf		<clifford@clifford.at>

 *  Copyright (c) 2000 Sam Mosel		<sam.mosel@computer.org>

 *  Copyright (c) 2000 James E. Blair		<corvus@gnu.org>

 *  Copyright (c) 2000 Daniel Egger		<egger@suse.de>

 *  Copyright (c) 2001 Frederic Lepied		<flepied@mandrakesoft.com>

 *  Copyright (c) 2004 Panagiotis Issaris	<panagiotis.issaris@mech.kuleuven.ac.be>

 *  Copyright (c) 2002-2006 Ping Cheng		<pingc@wacom.com>

 *

 *  ChangeLog:

 *      v0.1 (vp)  - Initial release

 *      v0.2 (aba) - Support for all buttons / combinations

 *      v0.3 (vp)  - Support for Intuos added

 *	v0.4 (sm)  - Support for more Intuos models, menustrip

 *			relative mode, proximity.

 *	v0.5 (vp)  - Big cleanup, nifty features removed,

 *			they belong in userspace

 *	v1.8 (vp)  - Submit URB only when operating, moved to CVS,

 *			use input_report_key instead of report_btn and

 *			other cleanups

 *	v1.11 (vp) - Add URB ->dev setting for new kernels

 *	v1.11 (jb) - Add support for the 4D Mouse & Lens

 *	v1.12 (de) - Add support for two more inking pen IDs

 *	v1.14 (vp) - Use new USB device id probing scheme.

 *		     Fix Wacom Graphire mouse wheel

 *	v1.18 (vp) - Fix mouse wheel direction

 *		     Make mouse relative

 *      v1.20 (fl) - Report tool id for Intuos devices

 *                 - Multi tools support

 *                 - Corrected Intuos protocol decoding (airbrush, 4D mouse, lens cursor...)

 *                 - Add PL models support

 *		   - Fix Wacom Graphire mouse wheel again

 *	v1.21 (vp) - Removed protocol descriptions

 *		   - Added MISC_SERIAL for tool serial numbers

 *	      (gb) - Identify version on module load.

 *    v1.21.1 (fl) - added Graphire2 support

 *    v1.21.2 (fl) - added Intuos2 support

 *                 - added all the PL ids

 *    v1.21.3 (fl) - added another eraser id from Neil Okamoto

 *                 - added smooth filter for Graphire from Peri Hankey

 *                 - added PenPartner support from Olaf van Es

 *                 - new tool ids from Ole Martin Bjoerndalen

 *	v1.29 (pc) - Add support for more tablets

 *		   - Fix pressure reporting

 *	v1.30 (vp) - Merge 2.4 and 2.5 drivers

 *		   - Since 2.5 now has input_sync(), remove MSC_SERIAL abuse

 *		   - Cleanups here and there

 *    v1.30.1 (pi) - Added Graphire3 support

 *	v1.40 (pc) - Add support for several new devices, fix eraser reporting, ...

 *	v1.43 (pc) - Added support for Cintiq 21UX

 *		   - Fixed a Graphire bug

 *		   - Merged wacom_intuos3_irq into wacom_intuos_irq

 *	v1.44 (pc) - Added support for Graphire4, Cintiq 710, Intuos3 6x11, etc.

 *		   - Report Device IDs

 *      v1.45 (pc) - Added support for DTF 521, Intuos3 12x12 and 12x19

 *                 - Minor data report fix

 *      v1.46 (pc) - Split wacom.c into wacom_sys.c and wacom_wac.c,

 *		   - where wacom_sys.c deals with system specific code,

 * 		   - and wacom_wac.c deals with Wacom specific code

 */

/*

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 */

#ifndef WACOM_H

#define WACOM_H

#include <linux/kernel.h>

#include <linux/slab.h>

#include <linux/module.h>

#include <linux/init.h>

#include <linux/usb/input.h>

#include <asm/unaligned.h>

/*

 * Version Information

 */

#define DRIVER_VERSION "v1.46"

#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"

#define DRIVER_DESC "USB Wacom Graphire and Wacom Intuos tablet driver"

#define DRIVER_LICENSE "GPL"

MODULE_AUTHOR(DRIVER_AUTHOR);

MODULE_DESCRIPTION(DRIVER_DESC);

MODULE_LICENSE(DRIVER_LICENSE);

#define USB_VENDOR_ID_WACOM	0x056a

struct wacom {

	dma_addr_t data_dma;

	struct input_dev *dev;

	struct usb_device *usbdev;

	struct urb *irq;

	struct wacom_wac * wacom_wac;

	char phys[32];

};

struct wacom_combo {

	struct wacom * wacom;

	struct urb * urb;

	struct pt_regs *regs;

};

extern int wacom_wac_irq(struct wacom_wac * wacom_wac, void * wcombo);

extern void wacom_sys_irq(struct urb *urb, struct pt_regs *regs);

extern void wacom_report_abs(void *wcombo, unsigned int abs_type, int abs_data);

extern void wacom_report_rel(void *wcombo, unsigned int rel_type, int rel_data);

extern void wacom_report_key(void *wcombo, unsigned int key_type, int key_data);

extern void wacom_input_event(void *wcombo, unsigned int type, unsigned int code, int value);

extern void wacom_input_regs(void *wcombo);

extern void wacom_input_sync(void *wcombo);

extern void wacom_init_input_dev(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_g4(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_g(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_i3(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_i(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_pl(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern void input_dev_pt(struct input_dev *input_dev, struct wacom_wac *wacom_wac);

extern __u16 wacom_le16_to_cpu(unsigned char *data);

extern __u16 wacom_be16_to_cpu(unsigned char *data);

extern struct wacom_features * get_wacom_feature(const struct usb_device_id *id);

extern const struct usb_device_id * get_device_table(void);

#endif

/*

 * drivers/usb/input/wacom_sys.c

 *

 *  USB Wacom Graphire and Wacom Intuos tablet support - system specific code

 */

/*

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 */

#include "wacom.h"

#include "wacom_wac.h"

#define USB_REQ_GET_REPORT	0x01

#define USB_REQ_SET_REPORT	0x09

static int usb_get_report(struct usb_interface *intf, unsigned char type,

				unsigned char id, void *buf, int size)

{

	return usb_control_msg(interface_to_usbdev(intf),

		usb_rcvctrlpipe(interface_to_usbdev(intf), 0),

		USB_REQ_GET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,

		(type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,

		buf, size, 100);

}

static int usb_set_report(struct usb_interface *intf, unsigned char type,

				unsigned char id, void *buf, int size)

{

	return usb_control_msg(interface_to_usbdev(intf),

		usb_sndctrlpipe(interface_to_usbdev(intf), 0),

                USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,

                (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,

		buf, size, 1000);

}

static struct input_dev * get_input_dev(struct wacom_combo *wcombo)

{

	return wcombo->wacom->dev;

}

void wacom_sys_irq(struct urb *urb, struct pt_regs *regs)

{

	struct wacom *wacom = urb->context;

	struct wacom_combo wcombo;

	int retval;

	switch (urb->status) {

	case 0:

		/* success */

		break;

	case -ECONNRESET:

	case -ENOENT:

	case -ESHUTDOWN:

		/* this urb is terminated, clean up */

		dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);

		return;

	default:

		dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);

		goto exit;

	}

	wcombo.wacom = wacom;

	wcombo.urb = urb;

	wcombo.regs = regs;

	if (wacom_wac_irq(wacom->wacom_wac, (void *)&wcombo))

		input_sync(get_input_dev(&wcombo));

 exit:

	retval = usb_submit_urb (urb, GFP_ATOMIC);

	if (retval)

		err ("%s - usb_submit_urb failed with result %d",

		     __FUNCTION__, retval);

}

void wacom_report_key(void *wcombo, unsigned int key_type, int key_data)

{

	input_report_key(get_input_dev((struct wacom_combo *)wcombo), key_type, key_data);

	return;

}

void wacom_report_abs(void *wcombo, unsigned int abs_type, int abs_data)

{

	input_report_abs(get_input_dev((struct wacom_combo *)wcombo), abs_type, abs_data);

	return;

}

void wacom_report_rel(void *wcombo, unsigned int rel_type, int rel_data)

{

	input_report_rel(get_input_dev((struct wacom_combo *)wcombo), rel_type, rel_data);

	return;

}

void wacom_input_event(void *wcombo, unsigned int type, unsigned int code, int value)

{

	input_event(get_input_dev((struct wacom_combo *)wcombo), type, code, value);

	return;

}

__u16 wacom_be16_to_cpu(unsigned char *data)

{

	__u16 value;

	value = be16_to_cpu(*(__be16 *) data);

	return value;

}

__u16 wacom_le16_to_cpu(unsigned char *data)

{

	__u16 value;

	value = be16_to_cpu(*(__be16 *) data);

	return value;

}

void wacom_input_regs(void *wcombo)

{

	input_regs(get_input_dev((struct wacom_combo *)wcombo), ((struct wacom_combo *)wcombo)->regs);

	return;

}

void wacom_input_sync(void *wcombo)

{

	input_sync(get_input_dev((struct wacom_combo *)wcombo));

	return;

}

static int wacom_open(struct input_dev *dev)

{

	struct wacom *wacom = dev->private;

	wacom->irq->dev = wacom->usbdev;

	if (usb_submit_urb(wacom->irq, GFP_KERNEL))

		return -EIO;

	return 0;

}

static void wacom_close(struct input_dev *dev)

{

	struct wacom *wacom = dev->private;

	usb_kill_urb(wacom->irq);

}

void input_dev_g4(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->evbit[0] |= BIT(EV_MSC);

	input_dev->mscbit[0] |= BIT(MSC_SERIAL);

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_FINGER);

	input_dev->keybit[LONG(BTN_LEFT)] |= BIT(BTN_0) | BIT(BTN_1) | BIT(BTN_2) | BIT(BTN_3) | BIT(BTN_4) | BIT(BTN_5) | BIT(BTN_6) | BIT(BTN_7);

}

void input_dev_g(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->evbit[0] |= BIT(EV_REL);

	input_dev->relbit[0] |= BIT(REL_WHEEL);

	input_dev->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE);

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_RUBBER) | BIT(BTN_TOOL_MOUSE) | BIT(BTN_STYLUS2);

	input_set_abs_params(input_dev, ABS_DISTANCE, 0, wacom_wac->features->distance_max, 0, 0);

}

void input_dev_i3(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_FINGER);

	input_dev->keybit[LONG(BTN_LEFT)] |= BIT(BTN_0) | BIT(BTN_1) | BIT(BTN_2) | BIT(BTN_3) | BIT(BTN_4) | BIT(BTN_5) | BIT(BTN_6) | BIT(BTN_7);

	input_set_abs_params(input_dev, ABS_RX, 0, 4097, 0, 0);

	input_set_abs_params(input_dev, ABS_RY, 0, 4097, 0, 0);

}

void input_dev_i(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->evbit[0] |= BIT(EV_MSC) | BIT(EV_REL);

	input_dev->mscbit[0] |= BIT(MSC_SERIAL);

	input_dev->relbit[0] |= BIT(REL_WHEEL);

	input_dev->keybit[LONG(BTN_LEFT)] |= BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE) | BIT(BTN_SIDE) | BIT(BTN_EXTRA);

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_RUBBER) | BIT(BTN_TOOL_MOUSE)	| BIT(BTN_TOOL_BRUSH)

		| BIT(BTN_TOOL_PENCIL) | BIT(BTN_TOOL_AIRBRUSH) | BIT(BTN_TOOL_LENS) | BIT(BTN_STYLUS2);

	input_set_abs_params(input_dev, ABS_DISTANCE, 0, wacom_wac->features->distance_max, 0, 0);

	input_set_abs_params(input_dev, ABS_WHEEL, 0, 1023, 0, 0);

	input_set_abs_params(input_dev, ABS_TILT_X, 0, 127, 0, 0);

	input_set_abs_params(input_dev, ABS_TILT_Y, 0, 127, 0, 0);

	input_set_abs_params(input_dev, ABS_RZ, -900, 899, 0, 0);

	input_set_abs_params(input_dev, ABS_THROTTLE, -1023, 1023, 0, 0);

}

void input_dev_pl(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_STYLUS2) | BIT(BTN_TOOL_RUBBER);

}

void input_dev_pt(struct input_dev *input_dev, struct wacom_wac *wacom_wac)

{

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_RUBBER);

}

static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)

{

	struct usb_device *dev = interface_to_usbdev(intf);

	struct usb_endpoint_descriptor *endpoint;

	struct wacom *wacom;

	struct wacom_wac *wacom_wac;

	struct input_dev *input_dev;

	char rep_data[2], limit = 0;

	wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);

	wacom_wac = kzalloc(sizeof(struct wacom_wac), GFP_KERNEL);

	input_dev = input_allocate_device();

	if (!wacom || !input_dev || !wacom_wac)

		goto fail1;

	wacom_wac->data = usb_buffer_alloc(dev, 10, GFP_KERNEL, &wacom->data_dma);

	if (!wacom_wac->data)

		goto fail1;

	wacom->irq = usb_alloc_urb(0, GFP_KERNEL);

	if (!wacom->irq)

		goto fail2;

	wacom->usbdev = dev;

	wacom->dev = input_dev;

	usb_make_path(dev, wacom->phys, sizeof(wacom->phys));

	strlcat(wacom->phys, "/input0", sizeof(wacom->phys));

	wacom_wac->features = get_wacom_feature(id);

	if (wacom_wac->features->pktlen > 10)

		BUG();

	input_dev->name = wacom_wac->features->name;

	wacom->wacom_wac = wacom_wac;

	usb_to_input_id(dev, &input_dev->id);

	input_dev->cdev.dev = &intf->dev;

	input_dev->private = wacom;

	input_dev->open = wacom_open;

	input_dev->close = wacom_close;

	input_dev->evbit[0] |= BIT(EV_KEY) | BIT(EV_ABS);

	input_dev->keybit[LONG(BTN_DIGI)] |= BIT(BTN_TOOL_PEN) | BIT(BTN_TOUCH) | BIT(BTN_STYLUS);

	input_set_abs_params(input_dev, ABS_X, 0, wacom_wac->features->x_max, 4, 0);

	input_set_abs_params(input_dev, ABS_Y, 0, wacom_wac->features->y_max, 4, 0);

	input_set_abs_params(input_dev, ABS_PRESSURE, 0, wacom_wac->features->pressure_max, 0, 0);

	input_dev->absbit[LONG(ABS_MISC)] |= BIT(ABS_MISC);

	wacom_init_input_dev(input_dev, wacom_wac);

	endpoint = &intf->cur_altsetting->endpoint[0].desc;

	usb_fill_int_urb(wacom->irq, dev,

			 usb_rcvintpipe(dev, endpoint->bEndpointAddress),

			 wacom_wac->data, wacom_wac->features->pktlen,

			 wacom_wac->features->irq, wacom, endpoint->bInterval);

	wacom->irq->transfer_dma = wacom->data_dma;

	wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	input_register_device(wacom->dev);

	/* Ask the tablet to report tablet data. Repeat until it succeeds */

	do {

		rep_data[0] = 2;

		rep_data[1] = 2;

		usb_set_report(intf, 3, 2, rep_data, 2);

		usb_get_report(intf, 3, 2, rep_data, 2);

	} while (rep_data[1] != 2 && limit++ < 5);

	usb_set_intfdata(intf, wacom);

	return 0;

fail2:	usb_buffer_free(dev, 10, wacom_wac->data, wacom->data_dma);

fail1:	input_free_device(input_dev);

	kfree(wacom);

	kfree(wacom_wac);

	return -ENOMEM;

}

static void wacom_disconnect(struct usb_interface *intf)

{

	struct wacom *wacom = usb_get_intfdata (intf);

	usb_set_intfdata(intf, NULL);

	if (wacom) {

		usb_kill_urb(wacom->irq);

		input_unregister_device(wacom->dev);

		usb_free_urb(wacom->irq);

		usb_buffer_free(interface_to_usbdev(intf), 10, wacom->wacom_wac->data, wacom->data_dma);

		kfree(wacom);

		kfree(wacom->wacom_wac);

	}

}

static struct usb_driver wacom_driver = {

	.name =		"wacom",

	.probe =	wacom_probe,

	.disconnect =	wacom_disconnect,

};

static int __init wacom_init(void)

{

	int result;

	wacom_driver.id_table = get_device_table();

	result = usb_register(&wacom_driver);

	if (result == 0)

		info(DRIVER_VERSION ":" DRIVER_DESC);

	return result;

}

static void __exit wacom_exit(void)

{

	usb_deregister(&wacom_driver);

}

module_init(wacom_init);

module_exit(wacom_exit);