777 lines · 20.9 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0/* * Tty port functions */ #include <linux/types.h>#include <linux/errno.h>#include <linux/tty.h>#include <linux/tty_driver.h>#include <linux/tty_flip.h>#include <linux/serial.h>#include <linux/timer.h>#include <linux/string.h>#include <linux/slab.h>#include <linux/sched/signal.h>#include <linux/wait.h>#include <linux/bitops.h>#include <linux/delay.h>#include <linux/module.h>#include <linux/serdev.h>#include "tty.h" static size_t tty_port_default_receive_buf(struct tty_port *port, const u8 *p,					   const u8 *f, size_t count){	struct tty_struct *tty;	struct tty_ldisc *ld; 	tty = READ_ONCE(port->itty);	if (!tty)		return 0; 	ld = tty_ldisc_ref(tty);	if (!ld)		return 0; 	count = tty_ldisc_receive_buf(ld, p, f, count); 	tty_ldisc_deref(ld); 	return count;} static void tty_port_default_lookahead_buf(struct tty_port *port, const u8 *p,					   const u8 *f, size_t count){	struct tty_struct *tty;	struct tty_ldisc *ld; 	tty = READ_ONCE(port->itty);	if (!tty)		return; 	ld = tty_ldisc_ref(tty);	if (!ld)		return; 	if (ld->ops->lookahead_buf)		ld->ops->lookahead_buf(ld->tty, p, f, count); 	tty_ldisc_deref(ld);} static void tty_port_default_wakeup(struct tty_port *port){	scoped_guard(tty_port_tty, port)		tty_wakeup(scoped_tty());} const struct tty_port_client_operations tty_port_default_client_ops = {	.receive_buf = tty_port_default_receive_buf,	.lookahead_buf = tty_port_default_lookahead_buf,	.write_wakeup = tty_port_default_wakeup,};EXPORT_SYMBOL_GPL(tty_port_default_client_ops); /** * tty_port_init - initialize tty_port * @port: tty_port to initialize * * Initializes the state of struct tty_port. When a port was initialized using * this function, one has to destroy the port by tty_port_destroy(). Either * indirectly by using &tty_port refcounting (tty_port_put()) or directly if * refcounting is not used. */void tty_port_init(struct tty_port *port){	memset(port, 0, sizeof(*port));	tty_buffer_init(port);	init_waitqueue_head(&port->open_wait);	init_waitqueue_head(&port->delta_msr_wait);	mutex_init(&port->mutex);	mutex_init(&port->buf_mutex);	spin_lock_init(&port->lock);	port->close_delay = (50 * HZ) / 100;	port->closing_wait = (3000 * HZ) / 100;	port->client_ops = &tty_port_default_client_ops;	kref_init(&port->kref);}EXPORT_SYMBOL(tty_port_init); /** * tty_port_link_wq - link tty_port and flip workqueue * @port: tty_port of the device * @flip_wq: workqueue to queue flip buffer work on * * Whenever %TTY_DRIVER_NO_WORKQUEUE is used, every tty_port can be linked to * a workqueue manually by this function. * tty_port will use system_dfl_wq when buf.flip_wq is NULL. * * Note that tty_port API will NOT destroy the workqueue. */void tty_port_link_wq(struct tty_port *port, struct workqueue_struct *flip_wq){	port->buf.flip_wq = flip_wq;}EXPORT_SYMBOL_GPL(tty_port_link_wq); /** * tty_port_link_device - link tty and tty_port * @port: tty_port of the device * @driver: tty_driver for this device * @index: index of the tty * * Provide the tty layer with a link from a tty (specified by @index) to a * tty_port (@port). Use this only if neither tty_port_register_device() nor * tty_port_install() is used in the driver. If used, this has to be called * before tty_register_driver(). */void tty_port_link_device(struct tty_port *port,		struct tty_driver *driver, unsigned index){	if (WARN_ON(index >= driver->num))		return;	driver->ports[index] = port;}EXPORT_SYMBOL_GPL(tty_port_link_device); /** * tty_port_register_device - register tty device * @port: tty_port of the device * @driver: tty_driver for this device * @index: index of the tty * @device: parent if exists, otherwise NULL * * It is the same as tty_register_device() except the provided @port is linked * to a concrete tty specified by @index. Use this or tty_port_install() (or * both). Call tty_port_link_device() as a last resort. */struct device *tty_port_register_device(struct tty_port *port,		struct tty_driver *driver, unsigned index,		struct device *device){	return tty_port_register_device_attr(port, driver, index, device, NULL, NULL);}EXPORT_SYMBOL_GPL(tty_port_register_device); /** * tty_port_register_device_attr - register tty device * @port: tty_port of the device * @driver: tty_driver for this device * @index: index of the tty * @device: parent if exists, otherwise NULL * @drvdata: Driver data to be set to device. * @attr_grp: Attribute group to be set on device. * * It is the same as tty_register_device_attr() except the provided @port is * linked to a concrete tty specified by @index. Use this or tty_port_install() * (or both). Call tty_port_link_device() as a last resort. */struct device *tty_port_register_device_attr(struct tty_port *port,		struct tty_driver *driver, unsigned index,		struct device *device, void *drvdata,		const struct attribute_group **attr_grp){	tty_port_link_device(port, driver, index);	tty_port_link_driver_wq(port, driver);	return tty_register_device_attr(driver, index, device, drvdata,			attr_grp);}EXPORT_SYMBOL_GPL(tty_port_register_device_attr); /** * tty_port_register_device_attr_serdev - register tty or serdev device * @port: tty_port of the device * @driver: tty_driver for this device * @index: index of the tty * @host: serial port hardware device * @parent: parent if exists, otherwise NULL * @drvdata: driver data for the device * @attr_grp: attribute group for the device * * Register a serdev or tty device depending on if the parent device has any * defined serdev clients or not. */struct device *tty_port_register_device_attr_serdev(struct tty_port *port,		struct tty_driver *driver, unsigned index,		struct device *host, struct device *parent, void *drvdata,		const struct attribute_group **attr_grp){	struct device *dev; 	tty_port_link_device(port, driver, index);	tty_port_link_driver_wq(port, driver); 	dev = serdev_tty_port_register(port, host, parent, driver, index);	if (PTR_ERR(dev) != -ENODEV) {		/* Skip creating cdev if we registered a serdev device */		return dev;	} 	return tty_register_device_attr(driver, index, parent, drvdata,			attr_grp);}EXPORT_SYMBOL_GPL(tty_port_register_device_attr_serdev); /** * tty_port_unregister_device - deregister a tty or serdev device * @port: tty_port of the device * @driver: tty_driver for this device * @index: index of the tty * * If a tty or serdev device is registered with a call to * tty_port_register_device_serdev() then this function must be called when * the device is gone. */void tty_port_unregister_device(struct tty_port *port,		struct tty_driver *driver, unsigned index){	int ret; 	WRITE_ONCE(port->buf.flip_wq, NULL);	ret = serdev_tty_port_unregister(port);	if (ret == 0)		return; 	tty_unregister_device(driver, index);}EXPORT_SYMBOL_GPL(tty_port_unregister_device); int tty_port_alloc_xmit_buf(struct tty_port *port){	/* We may sleep in get_zeroed_page() */	guard(mutex)(&port->buf_mutex); 	if (port->xmit_buf)		return 0; 	port->xmit_buf = (u8 *)get_zeroed_page(GFP_KERNEL);	if (port->xmit_buf == NULL)		return -ENOMEM; 	kfifo_init(&port->xmit_fifo, port->xmit_buf, PAGE_SIZE); 	return 0;}EXPORT_SYMBOL(tty_port_alloc_xmit_buf); void tty_port_free_xmit_buf(struct tty_port *port){	guard(mutex)(&port->buf_mutex);	free_page((unsigned long)port->xmit_buf);	port->xmit_buf = NULL;	INIT_KFIFO(port->xmit_fifo);}EXPORT_SYMBOL(tty_port_free_xmit_buf); /** * tty_port_destroy - destroy inited port * @port: tty port to be destroyed * * When a port was initialized using tty_port_init(), one has to destroy the * port by this function. Either indirectly by using &tty_port refcounting * (tty_port_put()) or directly if refcounting is not used. */void tty_port_destroy(struct tty_port *port){	tty_buffer_cancel_work(port);	tty_buffer_free_all(port);	WRITE_ONCE(port->buf.flip_wq, NULL);}EXPORT_SYMBOL(tty_port_destroy); static void tty_port_destructor(struct kref *kref){	struct tty_port *port = container_of(kref, struct tty_port, kref); 	/* check if last port ref was dropped before tty release */	if (WARN_ON(port->itty))		return;	free_page((unsigned long)port->xmit_buf);	tty_port_destroy(port);	if (port->ops && port->ops->destruct)		port->ops->destruct(port);	else		kfree(port);} /** * tty_port_put - drop a reference to tty_port * @port: port to drop a reference of (can be NULL) * * The final put will destroy and free up the @port using * @port->ops->destruct() hook, or using kfree() if not provided. */void tty_port_put(struct tty_port *port){	if (port)		kref_put(&port->kref, tty_port_destructor);}EXPORT_SYMBOL(tty_port_put); /** * tty_port_tty_get	-	get a tty reference * @port: tty port * * Return a refcount protected tty instance or %NULL if the port is not * associated with a tty (eg due to close or hangup). */struct tty_struct *tty_port_tty_get(struct tty_port *port){	guard(spinlock_irqsave)(&port->lock);	return tty_kref_get(port->tty);}EXPORT_SYMBOL(tty_port_tty_get); /** * tty_port_tty_set	-	set the tty of a port * @port: tty port * @tty: the tty * * Associate the port and tty pair. Manages any internal refcounts. Pass %NULL * to deassociate a port. */void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty){	guard(spinlock_irqsave)(&port->lock);	tty_kref_put(port->tty);	port->tty = tty_kref_get(tty);}EXPORT_SYMBOL(tty_port_tty_set); /** * tty_port_shutdown - internal helper to shutdown the device * @port: tty port to be shut down * @tty: the associated tty * * It is used by tty_port_hangup() and tty_port_close(). Its task is to * shutdown the device if it was initialized (note consoles remain * functioning). It lowers DTR/RTS (if @tty has HUPCL set) and invokes * @port->ops->shutdown(). */static void tty_port_shutdown(struct tty_port *port, struct tty_struct *tty){	guard(mutex)(&port->mutex); 	if (port->console)		return; 	if (!tty_port_initialized(port))		return; 	tty_port_set_initialized(port, false);	/*	 * Drop DTR/RTS if HUPCL is set. This causes any attached	 * modem to hang up the line.	 */	if (tty && C_HUPCL(tty))		tty_port_lower_dtr_rts(port); 	if (port->ops->shutdown)		port->ops->shutdown(port);} /** * tty_port_hangup		-	hangup helper * @port: tty port * * Perform port level tty hangup flag and count changes. Drop the tty * reference. * * Caller holds tty lock. */void tty_port_hangup(struct tty_port *port){	struct tty_struct *tty; 	scoped_guard(spinlock_irqsave, &port->lock) {		port->count = 0;		tty = port->tty;		if (tty)			set_bit(TTY_IO_ERROR, &tty->flags);		port->tty = NULL;	} 	tty_port_set_active(port, false);	tty_port_shutdown(port, tty);	tty_kref_put(tty);	wake_up_interruptible(&port->open_wait);	wake_up_interruptible(&port->delta_msr_wait);}EXPORT_SYMBOL(tty_port_hangup); void __tty_port_tty_hangup(struct tty_port *port, bool check_clocal, bool async){	scoped_guard(tty_port_tty, port) {		struct tty_struct *tty = scoped_tty(); 		if (!check_clocal || !C_CLOCAL(tty)) {			if (async)				tty_hangup(tty);			else				tty_vhangup(tty);		}	}}EXPORT_SYMBOL_GPL(__tty_port_tty_hangup); /** * tty_port_tty_wakeup - helper to wake up a tty * @port: tty port */void tty_port_tty_wakeup(struct tty_port *port){	port->client_ops->write_wakeup(port);}EXPORT_SYMBOL_GPL(tty_port_tty_wakeup); /** * tty_port_carrier_raised	-	carrier raised check * @port: tty port * * Wrapper for the carrier detect logic. For the moment this is used * to hide some internal details. This will eventually become entirely * internal to the tty port. */bool tty_port_carrier_raised(struct tty_port *port){	if (port->ops->carrier_raised == NULL)		return true;	return port->ops->carrier_raised(port);}EXPORT_SYMBOL(tty_port_carrier_raised); /** * tty_port_raise_dtr_rts	-	Raise DTR/RTS * @port: tty port * * Wrapper for the DTR/RTS raise logic. For the moment this is used to hide * some internal details. This will eventually become entirely internal to the * tty port. */void tty_port_raise_dtr_rts(struct tty_port *port){	if (port->ops->dtr_rts)		port->ops->dtr_rts(port, true);}EXPORT_SYMBOL(tty_port_raise_dtr_rts); /** * tty_port_lower_dtr_rts	-	Lower DTR/RTS * @port: tty port * * Wrapper for the DTR/RTS raise logic. For the moment this is used to hide * some internal details. This will eventually become entirely internal to the * tty port. */void tty_port_lower_dtr_rts(struct tty_port *port){	if (port->ops->dtr_rts)		port->ops->dtr_rts(port, false);}EXPORT_SYMBOL(tty_port_lower_dtr_rts); /** * tty_port_block_til_ready	-	Waiting logic for tty open * @port: the tty port being opened * @tty: the tty device being bound * @filp: the file pointer of the opener or %NULL * * Implement the core POSIX/SuS tty behaviour when opening a tty device. * Handles: * *	- hangup (both before and during) *	- non blocking open *	- rts/dtr/dcd *	- signals *	- port flags and counts * * The passed @port must implement the @port->ops->carrier_raised method if it * can do carrier detect and the @port->ops->dtr_rts method if it supports * software management of these lines. Note that the dtr/rts raise is done each * iteration as a hangup may have previously dropped them while we wait. * * Caller holds tty lock. * * Note: May drop and reacquire tty lock when blocking, so @tty and @port may * have changed state (eg., may have been hung up). */int tty_port_block_til_ready(struct tty_port *port,

Lines 1–500 of 777.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t