xref: /OK3568_Linux_fs/kernel/drivers/usb/serial/bus.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * USB Serial Converter Bus specific functions
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2002 Greg Kroah-Hartman (greg@kroah.com)
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/kernel.h>
9*4882a593Smuzhiyun #include <linux/errno.h>
10*4882a593Smuzhiyun #include <linux/tty.h>
11*4882a593Smuzhiyun #include <linux/slab.h>
12*4882a593Smuzhiyun #include <linux/module.h>
13*4882a593Smuzhiyun #include <linux/usb.h>
14*4882a593Smuzhiyun #include <linux/usb/serial.h>
15*4882a593Smuzhiyun 
usb_serial_device_match(struct device * dev,struct device_driver * drv)16*4882a593Smuzhiyun static int usb_serial_device_match(struct device *dev,
17*4882a593Smuzhiyun 						struct device_driver *drv)
18*4882a593Smuzhiyun {
19*4882a593Smuzhiyun 	struct usb_serial_driver *driver;
20*4882a593Smuzhiyun 	const struct usb_serial_port *port;
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun 	/*
23*4882a593Smuzhiyun 	 * drivers are already assigned to ports in serial_probe so it's
24*4882a593Smuzhiyun 	 * a simple check here.
25*4882a593Smuzhiyun 	 */
26*4882a593Smuzhiyun 	port = to_usb_serial_port(dev);
27*4882a593Smuzhiyun 	if (!port)
28*4882a593Smuzhiyun 		return 0;
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun 	driver = to_usb_serial_driver(drv);
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	if (driver == port->serial->type)
33*4882a593Smuzhiyun 		return 1;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 	return 0;
36*4882a593Smuzhiyun }
37*4882a593Smuzhiyun 
usb_serial_device_probe(struct device * dev)38*4882a593Smuzhiyun static int usb_serial_device_probe(struct device *dev)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun 	struct usb_serial_driver *driver;
41*4882a593Smuzhiyun 	struct usb_serial_port *port;
42*4882a593Smuzhiyun 	struct device *tty_dev;
43*4882a593Smuzhiyun 	int retval = 0;
44*4882a593Smuzhiyun 	int minor;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	port = to_usb_serial_port(dev);
47*4882a593Smuzhiyun 	if (!port)
48*4882a593Smuzhiyun 		return -ENODEV;
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun 	/* make sure suspend/resume doesn't race against port_probe */
51*4882a593Smuzhiyun 	retval = usb_autopm_get_interface(port->serial->interface);
52*4882a593Smuzhiyun 	if (retval)
53*4882a593Smuzhiyun 		return retval;
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	driver = port->serial->type;
56*4882a593Smuzhiyun 	if (driver->port_probe) {
57*4882a593Smuzhiyun 		retval = driver->port_probe(port);
58*4882a593Smuzhiyun 		if (retval)
59*4882a593Smuzhiyun 			goto err_autopm_put;
60*4882a593Smuzhiyun 	}
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	minor = port->minor;
63*4882a593Smuzhiyun 	tty_dev = tty_port_register_device(&port->port, usb_serial_tty_driver,
64*4882a593Smuzhiyun 					   minor, dev);
65*4882a593Smuzhiyun 	if (IS_ERR(tty_dev)) {
66*4882a593Smuzhiyun 		retval = PTR_ERR(tty_dev);
67*4882a593Smuzhiyun 		goto err_port_remove;
68*4882a593Smuzhiyun 	}
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	usb_autopm_put_interface(port->serial->interface);
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	dev_info(&port->serial->dev->dev,
73*4882a593Smuzhiyun 		 "%s converter now attached to ttyUSB%d\n",
74*4882a593Smuzhiyun 		 driver->description, minor);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	return 0;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun err_port_remove:
79*4882a593Smuzhiyun 	if (driver->port_remove)
80*4882a593Smuzhiyun 		driver->port_remove(port);
81*4882a593Smuzhiyun err_autopm_put:
82*4882a593Smuzhiyun 	usb_autopm_put_interface(port->serial->interface);
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	return retval;
85*4882a593Smuzhiyun }
86*4882a593Smuzhiyun 
usb_serial_device_remove(struct device * dev)87*4882a593Smuzhiyun static int usb_serial_device_remove(struct device *dev)
88*4882a593Smuzhiyun {
89*4882a593Smuzhiyun 	struct usb_serial_driver *driver;
90*4882a593Smuzhiyun 	struct usb_serial_port *port;
91*4882a593Smuzhiyun 	int retval = 0;
92*4882a593Smuzhiyun 	int minor;
93*4882a593Smuzhiyun 	int autopm_err;
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	port = to_usb_serial_port(dev);
96*4882a593Smuzhiyun 	if (!port)
97*4882a593Smuzhiyun 		return -ENODEV;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	/*
100*4882a593Smuzhiyun 	 * Make sure suspend/resume doesn't race against port_remove.
101*4882a593Smuzhiyun 	 *
102*4882a593Smuzhiyun 	 * Note that no further runtime PM callbacks will be made if
103*4882a593Smuzhiyun 	 * autopm_get fails.
104*4882a593Smuzhiyun 	 */
105*4882a593Smuzhiyun 	autopm_err = usb_autopm_get_interface(port->serial->interface);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	minor = port->minor;
108*4882a593Smuzhiyun 	tty_unregister_device(usb_serial_tty_driver, minor);
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun 	driver = port->serial->type;
111*4882a593Smuzhiyun 	if (driver->port_remove)
112*4882a593Smuzhiyun 		retval = driver->port_remove(port);
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	dev_info(dev, "%s converter now disconnected from ttyUSB%d\n",
115*4882a593Smuzhiyun 		 driver->description, minor);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	if (!autopm_err)
118*4882a593Smuzhiyun 		usb_autopm_put_interface(port->serial->interface);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	return retval;
121*4882a593Smuzhiyun }
122*4882a593Smuzhiyun 
new_id_store(struct device_driver * driver,const char * buf,size_t count)123*4882a593Smuzhiyun static ssize_t new_id_store(struct device_driver *driver,
124*4882a593Smuzhiyun 			    const char *buf, size_t count)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun 	struct usb_serial_driver *usb_drv = to_usb_serial_driver(driver);
127*4882a593Smuzhiyun 	ssize_t retval = usb_store_new_id(&usb_drv->dynids, usb_drv->id_table,
128*4882a593Smuzhiyun 					 driver, buf, count);
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	if (retval >= 0 && usb_drv->usb_driver != NULL)
131*4882a593Smuzhiyun 		retval = usb_store_new_id(&usb_drv->usb_driver->dynids,
132*4882a593Smuzhiyun 					  usb_drv->usb_driver->id_table,
133*4882a593Smuzhiyun 					  &usb_drv->usb_driver->drvwrap.driver,
134*4882a593Smuzhiyun 					  buf, count);
135*4882a593Smuzhiyun 	return retval;
136*4882a593Smuzhiyun }
137*4882a593Smuzhiyun 
new_id_show(struct device_driver * driver,char * buf)138*4882a593Smuzhiyun static ssize_t new_id_show(struct device_driver *driver, char *buf)
139*4882a593Smuzhiyun {
140*4882a593Smuzhiyun 	struct usb_serial_driver *usb_drv = to_usb_serial_driver(driver);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	return usb_show_dynids(&usb_drv->dynids, buf);
143*4882a593Smuzhiyun }
144*4882a593Smuzhiyun static DRIVER_ATTR_RW(new_id);
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun static struct attribute *usb_serial_drv_attrs[] = {
147*4882a593Smuzhiyun 	&driver_attr_new_id.attr,
148*4882a593Smuzhiyun 	NULL,
149*4882a593Smuzhiyun };
150*4882a593Smuzhiyun ATTRIBUTE_GROUPS(usb_serial_drv);
151*4882a593Smuzhiyun 
free_dynids(struct usb_serial_driver * drv)152*4882a593Smuzhiyun static void free_dynids(struct usb_serial_driver *drv)
153*4882a593Smuzhiyun {
154*4882a593Smuzhiyun 	struct usb_dynid *dynid, *n;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	spin_lock(&drv->dynids.lock);
157*4882a593Smuzhiyun 	list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
158*4882a593Smuzhiyun 		list_del(&dynid->node);
159*4882a593Smuzhiyun 		kfree(dynid);
160*4882a593Smuzhiyun 	}
161*4882a593Smuzhiyun 	spin_unlock(&drv->dynids.lock);
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun struct bus_type usb_serial_bus_type = {
165*4882a593Smuzhiyun 	.name =		"usb-serial",
166*4882a593Smuzhiyun 	.match =	usb_serial_device_match,
167*4882a593Smuzhiyun 	.probe =	usb_serial_device_probe,
168*4882a593Smuzhiyun 	.remove =	usb_serial_device_remove,
169*4882a593Smuzhiyun 	.drv_groups = 	usb_serial_drv_groups,
170*4882a593Smuzhiyun };
171*4882a593Smuzhiyun 
usb_serial_bus_register(struct usb_serial_driver * driver)172*4882a593Smuzhiyun int usb_serial_bus_register(struct usb_serial_driver *driver)
173*4882a593Smuzhiyun {
174*4882a593Smuzhiyun 	int retval;
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 	driver->driver.bus = &usb_serial_bus_type;
177*4882a593Smuzhiyun 	spin_lock_init(&driver->dynids.lock);
178*4882a593Smuzhiyun 	INIT_LIST_HEAD(&driver->dynids.list);
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun 	retval = driver_register(&driver->driver);
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 	return retval;
183*4882a593Smuzhiyun }
184*4882a593Smuzhiyun 
usb_serial_bus_deregister(struct usb_serial_driver * driver)185*4882a593Smuzhiyun void usb_serial_bus_deregister(struct usb_serial_driver *driver)
186*4882a593Smuzhiyun {
187*4882a593Smuzhiyun 	free_dynids(driver);
188*4882a593Smuzhiyun 	driver_unregister(&driver->driver);
189*4882a593Smuzhiyun }
190*4882a593Smuzhiyun 
191