xref: /openbmc/linux/drivers/input/joystick/pxrc.c (revision aaccf3c97418f169afdbb5855e9cbcbda34e90fd)
168ef4836SMarcus Folkesson // SPDX-License-Identifier: GPL-2.0
268ef4836SMarcus Folkesson /*
368ef4836SMarcus Folkesson  * Driver for Phoenix RC Flight Controller Adapter
468ef4836SMarcus Folkesson  *
568ef4836SMarcus Folkesson  * Copyright (C) 2018 Marcus Folkesson <marcus.folkesson@gmail.com>
668ef4836SMarcus Folkesson  */
768ef4836SMarcus Folkesson 
868ef4836SMarcus Folkesson #include <linux/kernel.h>
968ef4836SMarcus Folkesson #include <linux/errno.h>
1068ef4836SMarcus Folkesson #include <linux/slab.h>
1168ef4836SMarcus Folkesson #include <linux/module.h>
1268ef4836SMarcus Folkesson #include <linux/uaccess.h>
1368ef4836SMarcus Folkesson #include <linux/usb.h>
1468ef4836SMarcus Folkesson #include <linux/usb/input.h>
1568ef4836SMarcus Folkesson #include <linux/mutex.h>
1668ef4836SMarcus Folkesson #include <linux/input.h>
1768ef4836SMarcus Folkesson 
18*76336b41SDmitry Torokhov #define PXRC_VENDOR_ID		0x1781
19*76336b41SDmitry Torokhov #define PXRC_PRODUCT_ID		0x0898
2068ef4836SMarcus Folkesson 
2168ef4836SMarcus Folkesson struct pxrc {
2268ef4836SMarcus Folkesson 	struct input_dev	*input;
2368ef4836SMarcus Folkesson 	struct usb_interface	*intf;
2468ef4836SMarcus Folkesson 	struct urb		*urb;
2568ef4836SMarcus Folkesson 	struct mutex		pm_mutex;
2668ef4836SMarcus Folkesson 	bool			is_open;
2768ef4836SMarcus Folkesson 	char			phys[64];
2868ef4836SMarcus Folkesson };
2968ef4836SMarcus Folkesson 
pxrc_usb_irq(struct urb * urb)3068ef4836SMarcus Folkesson static void pxrc_usb_irq(struct urb *urb)
3168ef4836SMarcus Folkesson {
3268ef4836SMarcus Folkesson 	struct pxrc *pxrc = urb->context;
33c8783d39SDmitry Torokhov 	u8 *data = urb->transfer_buffer;
3468ef4836SMarcus Folkesson 	int error;
3568ef4836SMarcus Folkesson 
3668ef4836SMarcus Folkesson 	switch (urb->status) {
3768ef4836SMarcus Folkesson 	case 0:
3868ef4836SMarcus Folkesson 		/* success */
3968ef4836SMarcus Folkesson 		break;
4068ef4836SMarcus Folkesson 	case -ETIME:
4168ef4836SMarcus Folkesson 		/* this urb is timing out */
4268ef4836SMarcus Folkesson 		dev_dbg(&pxrc->intf->dev,
4368ef4836SMarcus Folkesson 			"%s - urb timed out - was the device unplugged?\n",
4468ef4836SMarcus Folkesson 			__func__);
4568ef4836SMarcus Folkesson 		return;
4668ef4836SMarcus Folkesson 	case -ECONNRESET:
4768ef4836SMarcus Folkesson 	case -ENOENT:
4868ef4836SMarcus Folkesson 	case -ESHUTDOWN:
4968ef4836SMarcus Folkesson 	case -EPIPE:
5068ef4836SMarcus Folkesson 		/* this urb is terminated, clean up */
5168ef4836SMarcus Folkesson 		dev_dbg(&pxrc->intf->dev, "%s - urb shutting down with status: %d\n",
5268ef4836SMarcus Folkesson 			__func__, urb->status);
5368ef4836SMarcus Folkesson 		return;
5468ef4836SMarcus Folkesson 	default:
5568ef4836SMarcus Folkesson 		dev_dbg(&pxrc->intf->dev, "%s - nonzero urb status received: %d\n",
5668ef4836SMarcus Folkesson 			__func__, urb->status);
5768ef4836SMarcus Folkesson 		goto exit;
5868ef4836SMarcus Folkesson 	}
5968ef4836SMarcus Folkesson 
6068ef4836SMarcus Folkesson 	if (urb->actual_length == 8) {
61c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_X, data[0]);
62c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_Y, data[2]);
63c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_RX, data[3]);
64c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_RY, data[4]);
65c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_RUDDER, data[5]);
66c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_THROTTLE, data[6]);
67c8783d39SDmitry Torokhov 		input_report_abs(pxrc->input, ABS_MISC, data[7]);
6868ef4836SMarcus Folkesson 
69c8783d39SDmitry Torokhov 		input_report_key(pxrc->input, BTN_A, data[1]);
7068ef4836SMarcus Folkesson 	}
7168ef4836SMarcus Folkesson 
7268ef4836SMarcus Folkesson exit:
7368ef4836SMarcus Folkesson 	/* Resubmit to fetch new fresh URBs */
7468ef4836SMarcus Folkesson 	error = usb_submit_urb(urb, GFP_ATOMIC);
7568ef4836SMarcus Folkesson 	if (error && error != -EPERM)
7668ef4836SMarcus Folkesson 		dev_err(&pxrc->intf->dev,
7768ef4836SMarcus Folkesson 			"%s - usb_submit_urb failed with result: %d",
7868ef4836SMarcus Folkesson 			__func__, error);
7968ef4836SMarcus Folkesson }
8068ef4836SMarcus Folkesson 
pxrc_open(struct input_dev * input)8168ef4836SMarcus Folkesson static int pxrc_open(struct input_dev *input)
8268ef4836SMarcus Folkesson {
8368ef4836SMarcus Folkesson 	struct pxrc *pxrc = input_get_drvdata(input);
8468ef4836SMarcus Folkesson 	int retval;
8568ef4836SMarcus Folkesson 
8668ef4836SMarcus Folkesson 	mutex_lock(&pxrc->pm_mutex);
8768ef4836SMarcus Folkesson 	retval = usb_submit_urb(pxrc->urb, GFP_KERNEL);
8868ef4836SMarcus Folkesson 	if (retval) {
8968ef4836SMarcus Folkesson 		dev_err(&pxrc->intf->dev,
9068ef4836SMarcus Folkesson 			"%s - usb_submit_urb failed, error: %d\n",
9168ef4836SMarcus Folkesson 			__func__, retval);
9268ef4836SMarcus Folkesson 		retval = -EIO;
9368ef4836SMarcus Folkesson 		goto out;
9468ef4836SMarcus Folkesson 	}
9568ef4836SMarcus Folkesson 
9668ef4836SMarcus Folkesson 	pxrc->is_open = true;
9768ef4836SMarcus Folkesson 
9868ef4836SMarcus Folkesson out:
9968ef4836SMarcus Folkesson 	mutex_unlock(&pxrc->pm_mutex);
10068ef4836SMarcus Folkesson 	return retval;
10168ef4836SMarcus Folkesson }
10268ef4836SMarcus Folkesson 
pxrc_close(struct input_dev * input)10368ef4836SMarcus Folkesson static void pxrc_close(struct input_dev *input)
10468ef4836SMarcus Folkesson {
10568ef4836SMarcus Folkesson 	struct pxrc *pxrc = input_get_drvdata(input);
10668ef4836SMarcus Folkesson 
10768ef4836SMarcus Folkesson 	mutex_lock(&pxrc->pm_mutex);
10868ef4836SMarcus Folkesson 	usb_kill_urb(pxrc->urb);
10968ef4836SMarcus Folkesson 	pxrc->is_open = false;
11068ef4836SMarcus Folkesson 	mutex_unlock(&pxrc->pm_mutex);
11168ef4836SMarcus Folkesson }
11268ef4836SMarcus Folkesson 
pxrc_free_urb(void * _pxrc)11334dad2cfSDmitry Torokhov static void pxrc_free_urb(void *_pxrc)
11434dad2cfSDmitry Torokhov {
11534dad2cfSDmitry Torokhov 	struct pxrc *pxrc = _pxrc;
11634dad2cfSDmitry Torokhov 
11734dad2cfSDmitry Torokhov 	usb_free_urb(pxrc->urb);
11834dad2cfSDmitry Torokhov }
11934dad2cfSDmitry Torokhov 
pxrc_probe(struct usb_interface * intf,const struct usb_device_id * id)120*76336b41SDmitry Torokhov static int pxrc_probe(struct usb_interface *intf,
121*76336b41SDmitry Torokhov 		      const struct usb_device_id *id)
12268ef4836SMarcus Folkesson {
123*76336b41SDmitry Torokhov 	struct usb_device *udev = interface_to_usbdev(intf);
124*76336b41SDmitry Torokhov 	struct pxrc *pxrc;
12568ef4836SMarcus Folkesson 	struct usb_endpoint_descriptor *epirq;
126c8783d39SDmitry Torokhov 	size_t xfer_size;
127c8783d39SDmitry Torokhov 	void *xfer_buf;
12834dad2cfSDmitry Torokhov 	int error;
12968ef4836SMarcus Folkesson 
130*76336b41SDmitry Torokhov 	/*
131*76336b41SDmitry Torokhov 	 * Locate the endpoint information. This device only has an
132*76336b41SDmitry Torokhov 	 * interrupt endpoint.
133*76336b41SDmitry Torokhov 	 */
134*76336b41SDmitry Torokhov 	error = usb_find_common_endpoints(intf->cur_altsetting,
13568ef4836SMarcus Folkesson 					  NULL, NULL, &epirq, NULL);
13634dad2cfSDmitry Torokhov 	if (error) {
137*76336b41SDmitry Torokhov 		dev_err(&intf->dev, "Could not find endpoint\n");
13834dad2cfSDmitry Torokhov 		return error;
13968ef4836SMarcus Folkesson 	}
14068ef4836SMarcus Folkesson 
141*76336b41SDmitry Torokhov 	pxrc = devm_kzalloc(&intf->dev, sizeof(*pxrc), GFP_KERNEL);
142*76336b41SDmitry Torokhov 	if (!pxrc)
14334dad2cfSDmitry Torokhov 		return -ENOMEM;
14468ef4836SMarcus Folkesson 
145*76336b41SDmitry Torokhov 	mutex_init(&pxrc->pm_mutex);
146*76336b41SDmitry Torokhov 	pxrc->intf = intf;
147*76336b41SDmitry Torokhov 
14868ef4836SMarcus Folkesson 	usb_set_intfdata(pxrc->intf, pxrc);
149*76336b41SDmitry Torokhov 
150*76336b41SDmitry Torokhov 	xfer_size = usb_endpoint_maxp(epirq);
151*76336b41SDmitry Torokhov 	xfer_buf = devm_kmalloc(&intf->dev, xfer_size, GFP_KERNEL);
152*76336b41SDmitry Torokhov 	if (!xfer_buf)
153*76336b41SDmitry Torokhov 		return -ENOMEM;
15468ef4836SMarcus Folkesson 
15568ef4836SMarcus Folkesson 	pxrc->urb = usb_alloc_urb(0, GFP_KERNEL);
15634dad2cfSDmitry Torokhov 	if (!pxrc->urb)
15734dad2cfSDmitry Torokhov 		return -ENOMEM;
15834dad2cfSDmitry Torokhov 
159*76336b41SDmitry Torokhov 	error = devm_add_action_or_reset(&intf->dev, pxrc_free_urb, pxrc);
16034dad2cfSDmitry Torokhov 	if (error)
16134dad2cfSDmitry Torokhov 		return error;
16268ef4836SMarcus Folkesson 
163*76336b41SDmitry Torokhov 	usb_fill_int_urb(pxrc->urb, udev,
164*76336b41SDmitry Torokhov 			 usb_rcvintpipe(udev, epirq->bEndpointAddress),
165*76336b41SDmitry Torokhov 			 xfer_buf, xfer_size, pxrc_usb_irq, pxrc, 1);
16668ef4836SMarcus Folkesson 
167*76336b41SDmitry Torokhov 	pxrc->input = devm_input_allocate_device(&intf->dev);
168*76336b41SDmitry Torokhov 	if (!pxrc->input) {
169*76336b41SDmitry Torokhov 		dev_err(&intf->dev, "couldn't allocate input device\n");
17068ef4836SMarcus Folkesson 		return -ENOMEM;
17168ef4836SMarcus Folkesson 	}
17268ef4836SMarcus Folkesson 
17368ef4836SMarcus Folkesson 	pxrc->input->name = "PXRC Flight Controller Adapter";
174*76336b41SDmitry Torokhov 
175*76336b41SDmitry Torokhov 	usb_make_path(udev, pxrc->phys, sizeof(pxrc->phys));
176*76336b41SDmitry Torokhov 	strlcat(pxrc->phys, "/input0", sizeof(pxrc->phys));
17768ef4836SMarcus Folkesson 	pxrc->input->phys = pxrc->phys;
178*76336b41SDmitry Torokhov 
179*76336b41SDmitry Torokhov 	usb_to_input_id(udev, &pxrc->input->id);
18068ef4836SMarcus Folkesson 
18168ef4836SMarcus Folkesson 	pxrc->input->open = pxrc_open;
18268ef4836SMarcus Folkesson 	pxrc->input->close = pxrc_close;
18368ef4836SMarcus Folkesson 
18468ef4836SMarcus Folkesson 	input_set_capability(pxrc->input, EV_KEY, BTN_A);
18568ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_X, 0, 255, 0, 0);
18668ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_Y, 0, 255, 0, 0);
18768ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_RX, 0, 255, 0, 0);
18868ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_RY, 0, 255, 0, 0);
18968ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_RUDDER, 0, 255, 0, 0);
19068ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_THROTTLE, 0, 255, 0, 0);
19168ef4836SMarcus Folkesson 	input_set_abs_params(pxrc->input, ABS_MISC, 0, 255, 0, 0);
19268ef4836SMarcus Folkesson 
19368ef4836SMarcus Folkesson 	input_set_drvdata(pxrc->input, pxrc);
19468ef4836SMarcus Folkesson 
195*76336b41SDmitry Torokhov 	error = input_register_device(pxrc->input);
19634dad2cfSDmitry Torokhov 	if (error)
19734dad2cfSDmitry Torokhov 		return error;
19868ef4836SMarcus Folkesson 
19968ef4836SMarcus Folkesson 	return 0;
20068ef4836SMarcus Folkesson }
20168ef4836SMarcus Folkesson 
pxrc_disconnect(struct usb_interface * intf)20268ef4836SMarcus Folkesson static void pxrc_disconnect(struct usb_interface *intf)
20368ef4836SMarcus Folkesson {
20434dad2cfSDmitry Torokhov 	/* All driver resources are devm-managed. */
20568ef4836SMarcus Folkesson }
20668ef4836SMarcus Folkesson 
pxrc_suspend(struct usb_interface * intf,pm_message_t message)20768ef4836SMarcus Folkesson static int pxrc_suspend(struct usb_interface *intf, pm_message_t message)
20868ef4836SMarcus Folkesson {
20968ef4836SMarcus Folkesson 	struct pxrc *pxrc = usb_get_intfdata(intf);
21068ef4836SMarcus Folkesson 
21168ef4836SMarcus Folkesson 	mutex_lock(&pxrc->pm_mutex);
21268ef4836SMarcus Folkesson 	if (pxrc->is_open)
21368ef4836SMarcus Folkesson 		usb_kill_urb(pxrc->urb);
21468ef4836SMarcus Folkesson 	mutex_unlock(&pxrc->pm_mutex);
21568ef4836SMarcus Folkesson 
21668ef4836SMarcus Folkesson 	return 0;
21768ef4836SMarcus Folkesson }
21868ef4836SMarcus Folkesson 
pxrc_resume(struct usb_interface * intf)21968ef4836SMarcus Folkesson static int pxrc_resume(struct usb_interface *intf)
22068ef4836SMarcus Folkesson {
22168ef4836SMarcus Folkesson 	struct pxrc *pxrc = usb_get_intfdata(intf);
22268ef4836SMarcus Folkesson 	int retval = 0;
22368ef4836SMarcus Folkesson 
22468ef4836SMarcus Folkesson 	mutex_lock(&pxrc->pm_mutex);
22568ef4836SMarcus Folkesson 	if (pxrc->is_open && usb_submit_urb(pxrc->urb, GFP_KERNEL) < 0)
22668ef4836SMarcus Folkesson 		retval = -EIO;
22768ef4836SMarcus Folkesson 
22868ef4836SMarcus Folkesson 	mutex_unlock(&pxrc->pm_mutex);
22968ef4836SMarcus Folkesson 	return retval;
23068ef4836SMarcus Folkesson }
23168ef4836SMarcus Folkesson 
pxrc_pre_reset(struct usb_interface * intf)23268ef4836SMarcus Folkesson static int pxrc_pre_reset(struct usb_interface *intf)
23368ef4836SMarcus Folkesson {
23468ef4836SMarcus Folkesson 	struct pxrc *pxrc = usb_get_intfdata(intf);
23568ef4836SMarcus Folkesson 
23668ef4836SMarcus Folkesson 	mutex_lock(&pxrc->pm_mutex);
23768ef4836SMarcus Folkesson 	usb_kill_urb(pxrc->urb);
23868ef4836SMarcus Folkesson 	return 0;
23968ef4836SMarcus Folkesson }
24068ef4836SMarcus Folkesson 
pxrc_post_reset(struct usb_interface * intf)24168ef4836SMarcus Folkesson static int pxrc_post_reset(struct usb_interface *intf)
24268ef4836SMarcus Folkesson {
24368ef4836SMarcus Folkesson 	struct pxrc *pxrc = usb_get_intfdata(intf);
24468ef4836SMarcus Folkesson 	int retval = 0;
24568ef4836SMarcus Folkesson 
24668ef4836SMarcus Folkesson 	if (pxrc->is_open && usb_submit_urb(pxrc->urb, GFP_KERNEL) < 0)
24768ef4836SMarcus Folkesson 		retval = -EIO;
24868ef4836SMarcus Folkesson 
24968ef4836SMarcus Folkesson 	mutex_unlock(&pxrc->pm_mutex);
25068ef4836SMarcus Folkesson 
25168ef4836SMarcus Folkesson 	return retval;
25268ef4836SMarcus Folkesson }
25368ef4836SMarcus Folkesson 
pxrc_reset_resume(struct usb_interface * intf)25468ef4836SMarcus Folkesson static int pxrc_reset_resume(struct usb_interface *intf)
25568ef4836SMarcus Folkesson {
25668ef4836SMarcus Folkesson 	return pxrc_resume(intf);
25768ef4836SMarcus Folkesson }
25868ef4836SMarcus Folkesson 
259ce55f75fSDmitry Torokhov static const struct usb_device_id pxrc_table[] = {
260ce55f75fSDmitry Torokhov 	{ USB_DEVICE(PXRC_VENDOR_ID, PXRC_PRODUCT_ID) },
261ce55f75fSDmitry Torokhov 	{ }
262ce55f75fSDmitry Torokhov };
263ce55f75fSDmitry Torokhov MODULE_DEVICE_TABLE(usb, pxrc_table);
264ce55f75fSDmitry Torokhov 
26568ef4836SMarcus Folkesson static struct usb_driver pxrc_driver = {
26668ef4836SMarcus Folkesson 	.name =		"pxrc",
26768ef4836SMarcus Folkesson 	.probe =	pxrc_probe,
26868ef4836SMarcus Folkesson 	.disconnect =	pxrc_disconnect,
26968ef4836SMarcus Folkesson 	.id_table =	pxrc_table,
27068ef4836SMarcus Folkesson 	.suspend	= pxrc_suspend,
27168ef4836SMarcus Folkesson 	.resume		= pxrc_resume,
27268ef4836SMarcus Folkesson 	.pre_reset	= pxrc_pre_reset,
27368ef4836SMarcus Folkesson 	.post_reset	= pxrc_post_reset,
27468ef4836SMarcus Folkesson 	.reset_resume	= pxrc_reset_resume,
27568ef4836SMarcus Folkesson };
27668ef4836SMarcus Folkesson 
27768ef4836SMarcus Folkesson module_usb_driver(pxrc_driver);
27868ef4836SMarcus Folkesson 
27968ef4836SMarcus Folkesson MODULE_AUTHOR("Marcus Folkesson <marcus.folkesson@gmail.com>");
28068ef4836SMarcus Folkesson MODULE_DESCRIPTION("PhoenixRC Flight Controller Adapter");
28168ef4836SMarcus Folkesson MODULE_LICENSE("GPL v2");
282