xref: /linux-6.15/drivers/usb/serial/usb_debug.c (revision ac3695fb)
1958e8741SGreg Kroah-Hartman /*
2958e8741SGreg Kroah-Hartman  * USB Debug cable driver
3958e8741SGreg Kroah-Hartman  *
4958e8741SGreg Kroah-Hartman  * Copyright (C) 2006 Greg Kroah-Hartman <[email protected]>
5958e8741SGreg Kroah-Hartman  *
6958e8741SGreg Kroah-Hartman  *	This program is free software; you can redistribute it and/or
7958e8741SGreg Kroah-Hartman  *	modify it under the terms of the GNU General Public License version
8958e8741SGreg Kroah-Hartman  *	2 as published by the Free Software Foundation.
9958e8741SGreg Kroah-Hartman  */
10958e8741SGreg Kroah-Hartman 
115a0e3ad6STejun Heo #include <linux/gfp.h>
12958e8741SGreg Kroah-Hartman #include <linux/kernel.h>
13958e8741SGreg Kroah-Hartman #include <linux/init.h>
14958e8741SGreg Kroah-Hartman #include <linux/tty.h>
15958e8741SGreg Kroah-Hartman #include <linux/module.h>
16958e8741SGreg Kroah-Hartman #include <linux/usb.h>
17958e8741SGreg Kroah-Hartman #include <linux/usb/serial.h>
18958e8741SGreg Kroah-Hartman 
1971be4f81SAleksey Gorelov #define USB_DEBUG_MAX_PACKET_SIZE	8
2098fcb5f7SJason Wessel #define USB_DEBUG_BRK_SIZE		8
2198fcb5f7SJason Wessel static char USB_DEBUG_BRK[USB_DEBUG_BRK_SIZE] = {
2298fcb5f7SJason Wessel 	0x00,
2398fcb5f7SJason Wessel 	0xff,
2498fcb5f7SJason Wessel 	0x01,
2598fcb5f7SJason Wessel 	0xfe,
2698fcb5f7SJason Wessel 	0x00,
2798fcb5f7SJason Wessel 	0xfe,
2898fcb5f7SJason Wessel 	0x01,
2998fcb5f7SJason Wessel 	0xff,
3098fcb5f7SJason Wessel };
3171be4f81SAleksey Gorelov 
327d40d7e8SNémeth Márton static const struct usb_device_id id_table[] = {
33958e8741SGreg Kroah-Hartman 	{ USB_DEVICE(0x0525, 0x127a) },
34958e8741SGreg Kroah-Hartman 	{ },
35958e8741SGreg Kroah-Hartman };
36958e8741SGreg Kroah-Hartman MODULE_DEVICE_TABLE(usb, id_table);
37958e8741SGreg Kroah-Hartman 
38958e8741SGreg Kroah-Hartman static struct usb_driver debug_driver = {
39958e8741SGreg Kroah-Hartman 	.name =		"debug",
40958e8741SGreg Kroah-Hartman 	.probe =	usb_serial_probe,
41958e8741SGreg Kroah-Hartman 	.disconnect =	usb_serial_disconnect,
42958e8741SGreg Kroah-Hartman 	.id_table =	id_table,
43958e8741SGreg Kroah-Hartman 	.no_dynamic_id =	1,
44958e8741SGreg Kroah-Hartman };
45958e8741SGreg Kroah-Hartman 
4698fcb5f7SJason Wessel /* This HW really does not support a serial break, so one will be
4798fcb5f7SJason Wessel  * emulated when ever the break state is set to true.
4898fcb5f7SJason Wessel  */
4998fcb5f7SJason Wessel static void usb_debug_break_ctl(struct tty_struct *tty, int break_state)
5098fcb5f7SJason Wessel {
5198fcb5f7SJason Wessel 	struct usb_serial_port *port = tty->driver_data;
5298fcb5f7SJason Wessel 	if (!break_state)
5398fcb5f7SJason Wessel 		return;
5498fcb5f7SJason Wessel 	usb_serial_generic_write(tty, port, USB_DEBUG_BRK, USB_DEBUG_BRK_SIZE);
5598fcb5f7SJason Wessel }
5698fcb5f7SJason Wessel 
57*ac3695fbSJohan Hovold static void usb_debug_process_read_urb(struct urb *urb)
5898fcb5f7SJason Wessel {
5998fcb5f7SJason Wessel 	struct usb_serial_port *port = urb->context;
6098fcb5f7SJason Wessel 
6198fcb5f7SJason Wessel 	if (urb->actual_length == USB_DEBUG_BRK_SIZE &&
6298fcb5f7SJason Wessel 		memcmp(urb->transfer_buffer, USB_DEBUG_BRK,
6398fcb5f7SJason Wessel 						USB_DEBUG_BRK_SIZE) == 0) {
6498fcb5f7SJason Wessel 		usb_serial_handle_break(port);
6598fcb5f7SJason Wessel 		return;
6698fcb5f7SJason Wessel 	}
6798fcb5f7SJason Wessel 
68*ac3695fbSJohan Hovold 	usb_serial_generic_process_read_urb(urb);
6998fcb5f7SJason Wessel }
7098fcb5f7SJason Wessel 
71958e8741SGreg Kroah-Hartman static struct usb_serial_driver debug_device = {
72958e8741SGreg Kroah-Hartman 	.driver = {
73958e8741SGreg Kroah-Hartman 		.owner =	THIS_MODULE,
74958e8741SGreg Kroah-Hartman 		.name =		"debug",
75958e8741SGreg Kroah-Hartman 	},
76958e8741SGreg Kroah-Hartman 	.id_table =		id_table,
775620b5f7SAlan Stern 	.usb_driver =		&debug_driver,
78958e8741SGreg Kroah-Hartman 	.num_ports =		1,
797288d755SJohan Hovold 	.bulk_out_size =	USB_DEBUG_MAX_PACKET_SIZE,
8098fcb5f7SJason Wessel 	.break_ctl =		usb_debug_break_ctl,
81*ac3695fbSJohan Hovold 	.process_read_urb =	usb_debug_process_read_urb,
82958e8741SGreg Kroah-Hartman };
83958e8741SGreg Kroah-Hartman 
84958e8741SGreg Kroah-Hartman static int __init debug_init(void)
85958e8741SGreg Kroah-Hartman {
86958e8741SGreg Kroah-Hartman 	int retval;
87958e8741SGreg Kroah-Hartman 
88958e8741SGreg Kroah-Hartman 	retval = usb_serial_register(&debug_device);
89958e8741SGreg Kroah-Hartman 	if (retval)
90958e8741SGreg Kroah-Hartman 		return retval;
91958e8741SGreg Kroah-Hartman 	retval = usb_register(&debug_driver);
92958e8741SGreg Kroah-Hartman 	if (retval)
93958e8741SGreg Kroah-Hartman 		usb_serial_deregister(&debug_device);
94958e8741SGreg Kroah-Hartman 	return retval;
95958e8741SGreg Kroah-Hartman }
96958e8741SGreg Kroah-Hartman 
97958e8741SGreg Kroah-Hartman static void __exit debug_exit(void)
98958e8741SGreg Kroah-Hartman {
99958e8741SGreg Kroah-Hartman 	usb_deregister(&debug_driver);
100958e8741SGreg Kroah-Hartman 	usb_serial_deregister(&debug_device);
101958e8741SGreg Kroah-Hartman }
102958e8741SGreg Kroah-Hartman 
103958e8741SGreg Kroah-Hartman module_init(debug_init);
104958e8741SGreg Kroah-Hartman module_exit(debug_exit);
105958e8741SGreg Kroah-Hartman MODULE_LICENSE("GPL");
106