1 // SPDX-License-Identifier: GPL-2.0
3  * USB Serial Converter stuff
5  *	Copyright (C) 1999 - 2012
6  *	    Greg Kroah-Hartman (greg@kroah.com)
14 #include <linux/serial.h>
17 /* The maximum number of ports one device can grab at once */
20 /* USB serial flags */
26  * @serial: pointer back to the struct usb_serial owner of this port.
29  * @minor: the minor number of the port
30  * @port_number: the struct usb_serial port number of this port (starts at 0)
56  * @tx_bytes: number of bytes currently in host stack queues
59  * @flags: usb serial port flags
61  * @dev: pointer to the serial device
63  * This structure is used by the usb-serial core and drivers for the specific
67 	struct usb_serial	*serial;  member
114 	return dev_get_drvdata(&port->dev);  in usb_get_serial_port_data()
120 	dev_set_drvdata(&port->dev, data);  in usb_set_serial_port_data()
124  * usb_serial - structure used by the usb-serial core for a device
129  * @suspend_count: number of suspended (sibling) interfaces
130  * @num_ports: the number of ports this device has
131  * @num_interrupt_in: number of interrupt in endpoints we have
132  * @num_interrupt_out: number of interrupt out endpoints we have
133  * @num_bulk_in: number of bulk in endpoints we have
134  * @num_bulk_out: number of bulk out endpoints we have
137  *	usb-serial driver is required to manage this data, the usb-serial core
163 /* get and set the serial private data pointer helper functions */
164 static inline void *usb_get_serial_data(struct usb_serial *serial)  in usb_get_serial_data()  argument
166 	return serial->private;  in usb_get_serial_data()
169 static inline void usb_set_serial_data(struct usb_serial *serial, void *data)  in usb_set_serial_data()  argument
171 	serial->private = data;  in usb_set_serial_data()
186  * usb_serial_driver - describes a usb serial driver
191  * @num_ports: the number of different ports this device will have.
192  * @num_bulk_in: minimum number of bulk-in endpoints
193  * @num_bulk_out: minimum number of bulk-out endpoints
194  * @num_interrupt_in: minimum number of interrupt-in endpoints
195  * @num_interrupt_out: minimum number of interrupt-out endpoints
196  * @bulk_in_size: minimum number of bytes to allocate for bulk-in buffer
197  *	(0 = end-point size)
198  * @bulk_out_size: bytes to allocate for bulk-out buffer (0 = end-point size)
200  *	device has dynamically. It can also be used to verify the number of
201  *	endpoints or to modify the port-endpoint mapping. It will be called
222  * This structure is defines a USB Serial driver.  It provides all of
223  * the information that the USB serial core code needs.  If the function
224  * pointers are defined, then the USB serial core code will call them when
226  * called, the generic serial function will be used instead.
252 	int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
253 	int (*attach)(struct usb_serial *serial);
254 	int (*calc_num_ports)(struct usb_serial *serial,
257 	void (*disconnect)(struct usb_serial *serial);
258 	void (*release)(struct usb_serial *serial);
263 	int (*suspend)(struct usb_serial *serial, pm_message_t message);
264 	int (*resume)(struct usb_serial *serial);
265 	int (*reset_resume)(struct usb_serial *serial);
267 	/* serial function calls */
297 	/* Called by the usb serial hooks to allow the user to rework the
325 /* USB Serial console functions */
329 void usb_serial_console_disconnect(struct usb_serial *serial);
333 static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}  in usb_serial_console_disconnect()  argument
338 void usb_serial_put(struct usb_serial *serial);
340 int usb_serial_claim_interface(struct usb_serial *serial, struct usb_interface *intf);
347 int usb_serial_generic_resume(struct usb_serial *serial);
391 	dev_dbg(dev, "%s - length = %d, data = %*ph\n",  in usb_serial_debug_data()
404 	if (!__port->port.console || !__print_once) {			\
406 		dev_err(&__port->dev, fmt, ##__VA_ARGS__);		\
411  * module_usb_serial_driver() - Helper macro for registering a USB Serial driver
415  * Helper macro for USB serial drivers which do not do anything special