Linux Audio

Check our new training course

Loading...
v6.8
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Tty port functions
  4 */
  5
  6#include <linux/types.h>
  7#include <linux/errno.h>
  8#include <linux/tty.h>
  9#include <linux/tty_driver.h>
 10#include <linux/tty_flip.h>
 11#include <linux/serial.h>
 12#include <linux/timer.h>
 13#include <linux/string.h>
 14#include <linux/slab.h>
 15#include <linux/sched/signal.h>
 16#include <linux/wait.h>
 17#include <linux/bitops.h>
 18#include <linux/delay.h>
 19#include <linux/module.h>
 20#include <linux/serdev.h>
 21#include "tty.h"
 22
 23static size_t tty_port_default_receive_buf(struct tty_port *port, const u8 *p,
 24					   const u8 *f, size_t count)
 
 25{
 
 26	struct tty_struct *tty;
 27	struct tty_ldisc *ld;
 28
 29	tty = READ_ONCE(port->itty);
 30	if (!tty)
 31		return 0;
 32
 33	ld = tty_ldisc_ref(tty);
 34	if (!ld)
 35		return 0;
 36
 37	count = tty_ldisc_receive_buf(ld, p, f, count);
 38
 39	tty_ldisc_deref(ld);
 40
 41	return count;
 42}
 43
 44static void tty_port_default_lookahead_buf(struct tty_port *port, const u8 *p,
 45					   const u8 *f, size_t count)
 46{
 47	struct tty_struct *tty;
 48	struct tty_ldisc *ld;
 49
 50	tty = READ_ONCE(port->itty);
 51	if (!tty)
 52		return;
 53
 54	ld = tty_ldisc_ref(tty);
 55	if (!ld)
 56		return;
 57
 58	if (ld->ops->lookahead_buf)
 59		ld->ops->lookahead_buf(ld->tty, p, f, count);
 60
 61	tty_ldisc_deref(ld);
 62}
 63
 64static void tty_port_default_wakeup(struct tty_port *port)
 65{
 66	struct tty_struct *tty = tty_port_tty_get(port);
 67
 68	if (tty) {
 69		tty_wakeup(tty);
 70		tty_kref_put(tty);
 71	}
 72}
 73
 74const struct tty_port_client_operations tty_port_default_client_ops = {
 75	.receive_buf = tty_port_default_receive_buf,
 76	.lookahead_buf = tty_port_default_lookahead_buf,
 77	.write_wakeup = tty_port_default_wakeup,
 78};
 79EXPORT_SYMBOL_GPL(tty_port_default_client_ops);
 80
 81/**
 82 * tty_port_init - initialize tty_port
 83 * @port: tty_port to initialize
 84 *
 85 * Initializes the state of struct tty_port. When a port was initialized using
 86 * this function, one has to destroy the port by tty_port_destroy(). Either
 87 * indirectly by using &tty_port refcounting (tty_port_put()) or directly if
 88 * refcounting is not used.
 89 */
 90void tty_port_init(struct tty_port *port)
 91{
 92	memset(port, 0, sizeof(*port));
 93	tty_buffer_init(port);
 94	init_waitqueue_head(&port->open_wait);
 95	init_waitqueue_head(&port->delta_msr_wait);
 96	mutex_init(&port->mutex);
 97	mutex_init(&port->buf_mutex);
 98	spin_lock_init(&port->lock);
 99	port->close_delay = (50 * HZ) / 100;
100	port->closing_wait = (3000 * HZ) / 100;
101	port->client_ops = &tty_port_default_client_ops;
102	kref_init(&port->kref);
103}
104EXPORT_SYMBOL(tty_port_init);
105
106/**
107 * tty_port_link_device - link tty and tty_port
108 * @port: tty_port of the device
109 * @driver: tty_driver for this device
110 * @index: index of the tty
111 *
112 * Provide the tty layer with a link from a tty (specified by @index) to a
113 * tty_port (@port). Use this only if neither tty_port_register_device() nor
114 * tty_port_install() is used in the driver. If used, this has to be called
115 * before tty_register_driver().
116 */
117void tty_port_link_device(struct tty_port *port,
118		struct tty_driver *driver, unsigned index)
119{
120	if (WARN_ON(index >= driver->num))
121		return;
122	driver->ports[index] = port;
123}
124EXPORT_SYMBOL_GPL(tty_port_link_device);
125
126/**
127 * tty_port_register_device - register tty device
128 * @port: tty_port of the device
129 * @driver: tty_driver for this device
130 * @index: index of the tty
131 * @device: parent if exists, otherwise NULL
132 *
133 * It is the same as tty_register_device() except the provided @port is linked
134 * to a concrete tty specified by @index. Use this or tty_port_install() (or
135 * both). Call tty_port_link_device() as a last resort.
136 */
137struct device *tty_port_register_device(struct tty_port *port,
138		struct tty_driver *driver, unsigned index,
139		struct device *device)
140{
141	return tty_port_register_device_attr(port, driver, index, device, NULL, NULL);
142}
143EXPORT_SYMBOL_GPL(tty_port_register_device);
144
145/**
146 * tty_port_register_device_attr - register tty device
147 * @port: tty_port of the device
148 * @driver: tty_driver for this device
149 * @index: index of the tty
150 * @device: parent if exists, otherwise NULL
151 * @drvdata: Driver data to be set to device.
152 * @attr_grp: Attribute group to be set on device.
153 *
154 * It is the same as tty_register_device_attr() except the provided @port is
155 * linked to a concrete tty specified by @index. Use this or tty_port_install()
156 * (or both). Call tty_port_link_device() as a last resort.
157 */
158struct device *tty_port_register_device_attr(struct tty_port *port,
159		struct tty_driver *driver, unsigned index,
160		struct device *device, void *drvdata,
161		const struct attribute_group **attr_grp)
162{
163	tty_port_link_device(port, driver, index);
164	return tty_register_device_attr(driver, index, device, drvdata,
165			attr_grp);
166}
167EXPORT_SYMBOL_GPL(tty_port_register_device_attr);
168
169/**
170 * tty_port_register_device_attr_serdev - register tty or serdev device
171 * @port: tty_port of the device
172 * @driver: tty_driver for this device
173 * @index: index of the tty
174 * @host: serial port hardware device
175 * @parent: parent if exists, otherwise NULL
176 * @drvdata: driver data for the device
177 * @attr_grp: attribute group for the device
178 *
179 * Register a serdev or tty device depending on if the parent device has any
180 * defined serdev clients or not.
181 */
182struct device *tty_port_register_device_attr_serdev(struct tty_port *port,
183		struct tty_driver *driver, unsigned index,
184		struct device *host, struct device *parent, void *drvdata,
185		const struct attribute_group **attr_grp)
186{
187	struct device *dev;
188
189	tty_port_link_device(port, driver, index);
190
191	dev = serdev_tty_port_register(port, host, parent, driver, index);
192	if (PTR_ERR(dev) != -ENODEV) {
193		/* Skip creating cdev if we registered a serdev device */
194		return dev;
195	}
196
197	return tty_register_device_attr(driver, index, parent, drvdata,
198			attr_grp);
199}
200EXPORT_SYMBOL_GPL(tty_port_register_device_attr_serdev);
201
202/**
203 * tty_port_register_device_serdev - register tty or serdev device
204 * @port: tty_port of the device
205 * @driver: tty_driver for this device
206 * @index: index of the tty
207 * @host: serial port hardware controller device
208 * @parent: parent if exists, otherwise NULL
209 *
210 * Register a serdev or tty device depending on if the parent device has any
211 * defined serdev clients or not.
212 */
213struct device *tty_port_register_device_serdev(struct tty_port *port,
214		struct tty_driver *driver, unsigned index,
215		struct device *host, struct device *parent)
216{
217	return tty_port_register_device_attr_serdev(port, driver, index,
218			host, parent, NULL, NULL);
219}
220EXPORT_SYMBOL_GPL(tty_port_register_device_serdev);
221
222/**
223 * tty_port_unregister_device - deregister a tty or serdev device
224 * @port: tty_port of the device
225 * @driver: tty_driver for this device
226 * @index: index of the tty
227 *
228 * If a tty or serdev device is registered with a call to
229 * tty_port_register_device_serdev() then this function must be called when
230 * the device is gone.
231 */
232void tty_port_unregister_device(struct tty_port *port,
233		struct tty_driver *driver, unsigned index)
234{
235	int ret;
236
237	ret = serdev_tty_port_unregister(port);
238	if (ret == 0)
239		return;
240
241	tty_unregister_device(driver, index);
242}
243EXPORT_SYMBOL_GPL(tty_port_unregister_device);
244
245int tty_port_alloc_xmit_buf(struct tty_port *port)
246{
247	/* We may sleep in get_zeroed_page() */
248	mutex_lock(&port->buf_mutex);
249	if (port->xmit_buf == NULL) {
250		port->xmit_buf = (u8 *)get_zeroed_page(GFP_KERNEL);
251		if (port->xmit_buf)
252			kfifo_init(&port->xmit_fifo, port->xmit_buf, PAGE_SIZE);
253	}
254	mutex_unlock(&port->buf_mutex);
255	if (port->xmit_buf == NULL)
256		return -ENOMEM;
257	return 0;
258}
259EXPORT_SYMBOL(tty_port_alloc_xmit_buf);
260
261void tty_port_free_xmit_buf(struct tty_port *port)
262{
263	mutex_lock(&port->buf_mutex);
264	free_page((unsigned long)port->xmit_buf);
265	port->xmit_buf = NULL;
266	INIT_KFIFO(port->xmit_fifo);
 
267	mutex_unlock(&port->buf_mutex);
268}
269EXPORT_SYMBOL(tty_port_free_xmit_buf);
270
271/**
272 * tty_port_destroy - destroy inited port
273 * @port: tty port to be destroyed
274 *
275 * When a port was initialized using tty_port_init(), one has to destroy the
276 * port by this function. Either indirectly by using &tty_port refcounting
277 * (tty_port_put()) or directly if refcounting is not used.
278 */
279void tty_port_destroy(struct tty_port *port)
280{
281	tty_buffer_cancel_work(port);
282	tty_buffer_free_all(port);
283}
284EXPORT_SYMBOL(tty_port_destroy);
285
286static void tty_port_destructor(struct kref *kref)
287{
288	struct tty_port *port = container_of(kref, struct tty_port, kref);
289
290	/* check if last port ref was dropped before tty release */
291	if (WARN_ON(port->itty))
292		return;
293	free_page((unsigned long)port->xmit_buf);
 
294	tty_port_destroy(port);
295	if (port->ops && port->ops->destruct)
296		port->ops->destruct(port);
297	else
298		kfree(port);
299}
300
301/**
302 * tty_port_put - drop a reference to tty_port
303 * @port: port to drop a reference of (can be NULL)
304 *
305 * The final put will destroy and free up the @port using
306 * @port->ops->destruct() hook, or using kfree() if not provided.
307 */
308void tty_port_put(struct tty_port *port)
309{
310	if (port)
311		kref_put(&port->kref, tty_port_destructor);
312}
313EXPORT_SYMBOL(tty_port_put);
314
315/**
316 * tty_port_tty_get	-	get a tty reference
317 * @port: tty port
318 *
319 * Return a refcount protected tty instance or %NULL if the port is not
320 * associated with a tty (eg due to close or hangup).
321 */
322struct tty_struct *tty_port_tty_get(struct tty_port *port)
323{
324	unsigned long flags;
325	struct tty_struct *tty;
326
327	spin_lock_irqsave(&port->lock, flags);
328	tty = tty_kref_get(port->tty);
329	spin_unlock_irqrestore(&port->lock, flags);
330	return tty;
331}
332EXPORT_SYMBOL(tty_port_tty_get);
333
334/**
335 * tty_port_tty_set	-	set the tty of a port
336 * @port: tty port
337 * @tty: the tty
338 *
339 * Associate the port and tty pair. Manages any internal refcounts. Pass %NULL
340 * to deassociate a port.
341 */
342void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty)
343{
344	unsigned long flags;
345
346	spin_lock_irqsave(&port->lock, flags);
347	tty_kref_put(port->tty);
348	port->tty = tty_kref_get(tty);
349	spin_unlock_irqrestore(&port->lock, flags);
350}
351EXPORT_SYMBOL(tty_port_tty_set);
352
353/**
354 * tty_port_shutdown - internal helper to shutdown the device
355 * @port: tty port to be shut down
356 * @tty: the associated tty
357 *
358 * It is used by tty_port_hangup() and tty_port_close(). Its task is to
359 * shutdown the device if it was initialized (note consoles remain
360 * functioning). It lowers DTR/RTS (if @tty has HUPCL set) and invokes
361 * @port->ops->shutdown().
362 */
363static void tty_port_shutdown(struct tty_port *port, struct tty_struct *tty)
364{
365	mutex_lock(&port->mutex);
366	if (port->console)
367		goto out;
368
369	if (tty_port_initialized(port)) {
370		tty_port_set_initialized(port, false);
371		/*
372		 * Drop DTR/RTS if HUPCL is set. This causes any attached
373		 * modem to hang up the line.
374		 */
375		if (tty && C_HUPCL(tty))
376			tty_port_lower_dtr_rts(port);
377
378		if (port->ops->shutdown)
379			port->ops->shutdown(port);
380	}
381out:
382	mutex_unlock(&port->mutex);
383}
384
385/**
386 * tty_port_hangup		-	hangup helper
387 * @port: tty port
388 *
389 * Perform port level tty hangup flag and count changes. Drop the tty
390 * reference.
391 *
392 * Caller holds tty lock.
393 */
394void tty_port_hangup(struct tty_port *port)
395{
396	struct tty_struct *tty;
397	unsigned long flags;
398
399	spin_lock_irqsave(&port->lock, flags);
400	port->count = 0;
401	tty = port->tty;
402	if (tty)
403		set_bit(TTY_IO_ERROR, &tty->flags);
404	port->tty = NULL;
405	spin_unlock_irqrestore(&port->lock, flags);
406	tty_port_set_active(port, false);
407	tty_port_shutdown(port, tty);
408	tty_kref_put(tty);
409	wake_up_interruptible(&port->open_wait);
410	wake_up_interruptible(&port->delta_msr_wait);
411}
412EXPORT_SYMBOL(tty_port_hangup);
413
414/**
415 * tty_port_tty_hangup - helper to hang up a tty
 
416 * @port: tty port
417 * @check_clocal: hang only ttys with %CLOCAL unset?
418 */
419void tty_port_tty_hangup(struct tty_port *port, bool check_clocal)
420{
421	struct tty_struct *tty = tty_port_tty_get(port);
422
423	if (tty && (!check_clocal || !C_CLOCAL(tty)))
424		tty_hangup(tty);
425	tty_kref_put(tty);
426}
427EXPORT_SYMBOL_GPL(tty_port_tty_hangup);
428
429/**
430 * tty_port_tty_wakeup - helper to wake up a tty
 
431 * @port: tty port
432 */
433void tty_port_tty_wakeup(struct tty_port *port)
434{
435	port->client_ops->write_wakeup(port);
436}
437EXPORT_SYMBOL_GPL(tty_port_tty_wakeup);
438
439/**
440 * tty_port_carrier_raised	-	carrier raised check
441 * @port: tty port
442 *
443 * Wrapper for the carrier detect logic. For the moment this is used
444 * to hide some internal details. This will eventually become entirely
445 * internal to the tty port.
446 */
447bool tty_port_carrier_raised(struct tty_port *port)
448{
449	if (port->ops->carrier_raised == NULL)
450		return true;
451	return port->ops->carrier_raised(port);
452}
453EXPORT_SYMBOL(tty_port_carrier_raised);
454
455/**
456 * tty_port_raise_dtr_rts	-	Raise DTR/RTS
457 * @port: tty port
458 *
459 * Wrapper for the DTR/RTS raise logic. For the moment this is used to hide
460 * some internal details. This will eventually become entirely internal to the
461 * tty port.
462 */
463void tty_port_raise_dtr_rts(struct tty_port *port)
464{
465	if (port->ops->dtr_rts)
466		port->ops->dtr_rts(port, true);
467}
468EXPORT_SYMBOL(tty_port_raise_dtr_rts);
469
470/**
471 * tty_port_lower_dtr_rts	-	Lower DTR/RTS
472 * @port: tty port
473 *
474 * Wrapper for the DTR/RTS raise logic. For the moment this is used to hide
475 * some internal details. This will eventually become entirely internal to the
476 * tty port.
477 */
478void tty_port_lower_dtr_rts(struct tty_port *port)
479{
480	if (port->ops->dtr_rts)
481		port->ops->dtr_rts(port, false);
482}
483EXPORT_SYMBOL(tty_port_lower_dtr_rts);
484
485/**
486 * tty_port_block_til_ready	-	Waiting logic for tty open
487 * @port: the tty port being opened
488 * @tty: the tty device being bound
489 * @filp: the file pointer of the opener or %NULL
490 *
491 * Implement the core POSIX/SuS tty behaviour when opening a tty device.
492 * Handles:
493 *
494 *	- hangup (both before and during)
495 *	- non blocking open
496 *	- rts/dtr/dcd
497 *	- signals
498 *	- port flags and counts
499 *
500 * The passed @port must implement the @port->ops->carrier_raised method if it
501 * can do carrier detect and the @port->ops->dtr_rts method if it supports
502 * software management of these lines. Note that the dtr/rts raise is done each
503 * iteration as a hangup may have previously dropped them while we wait.
504 *
505 * Caller holds tty lock.
506 *
507 * Note: May drop and reacquire tty lock when blocking, so @tty and @port may
508 * have changed state (eg., may have been hung up).
509 */
510int tty_port_block_til_ready(struct tty_port *port,
511				struct tty_struct *tty, struct file *filp)
512{
513	int do_clocal = 0, retval;
514	unsigned long flags;
515	DEFINE_WAIT(wait);
516
517	/* if non-blocking mode is set we can pass directly to open unless
518	 * the port has just hung up or is in another error state.
519	 */
520	if (tty_io_error(tty)) {
521		tty_port_set_active(port, true);
522		return 0;
523	}
524	if (filp == NULL || (filp->f_flags & O_NONBLOCK)) {
525		/* Indicate we are open */
526		if (C_BAUD(tty))
527			tty_port_raise_dtr_rts(port);
528		tty_port_set_active(port, true);
529		return 0;
530	}
531
532	if (C_CLOCAL(tty))
533		do_clocal = 1;
534
535	/* Block waiting until we can proceed. We may need to wait for the
536	 * carrier, but we must also wait for any close that is in progress
537	 * before the next open may complete.
538	 */
539
540	retval = 0;
541
542	/* The port lock protects the port counts */
543	spin_lock_irqsave(&port->lock, flags);
544	port->count--;
545	port->blocked_open++;
546	spin_unlock_irqrestore(&port->lock, flags);
547
548	while (1) {
549		/* Indicate we are open */
550		if (C_BAUD(tty) && tty_port_initialized(port))
551			tty_port_raise_dtr_rts(port);
552
553		prepare_to_wait(&port->open_wait, &wait, TASK_INTERRUPTIBLE);
554		/* Check for a hangup or uninitialised port.
555		 * Return accordingly.
556		 */
557		if (tty_hung_up_p(filp) || !tty_port_initialized(port)) {
558			if (port->flags & ASYNC_HUP_NOTIFY)
559				retval = -EAGAIN;
560			else
561				retval = -ERESTARTSYS;
562			break;
563		}
564		/*
565		 * Probe the carrier. For devices with no carrier detect
566		 * tty_port_carrier_raised will always return true.
567		 * Never ask drivers if CLOCAL is set, this causes troubles
568		 * on some hardware.
569		 */
570		if (do_clocal || tty_port_carrier_raised(port))
571			break;
572		if (signal_pending(current)) {
573			retval = -ERESTARTSYS;
574			break;
575		}
576		tty_unlock(tty);
577		schedule();
578		tty_lock(tty);
579	}
580	finish_wait(&port->open_wait, &wait);
581
582	/* Update counts. A parallel hangup will have set count to zero and
583	 * we must not mess that up further.
584	 */
585	spin_lock_irqsave(&port->lock, flags);
586	if (!tty_hung_up_p(filp))
587		port->count++;
588	port->blocked_open--;
589	spin_unlock_irqrestore(&port->lock, flags);
590	if (retval == 0)
591		tty_port_set_active(port, true);
592	return retval;
593}
594EXPORT_SYMBOL(tty_port_block_til_ready);
595
596static void tty_port_drain_delay(struct tty_port *port, struct tty_struct *tty)
597{
598	unsigned int bps = tty_get_baud_rate(tty);
599	long timeout;
600
601	if (bps > 1200) {
602		timeout = (HZ * 10 * port->drain_delay) / bps;
603		timeout = max_t(long, timeout, HZ / 10);
604	} else {
605		timeout = 2 * HZ;
606	}
607	schedule_timeout_interruptible(timeout);
608}
609
610/**
611 * tty_port_close_start - helper for tty->ops->close, part 1/2
612 * @port: tty_port of the device
613 * @tty: tty being closed
614 * @filp: passed file pointer
615 *
616 * Decrements and checks open count. Flushes the port if this is the last
617 * close. That means, dropping the data from the outpu buffer on the device and
618 * waiting for sending logic to finish. The rest of close handling is performed
619 * in tty_port_close_end().
620 *
621 * Locking: Caller holds tty lock.
622 *
623 * Return: 1 if this is the last close, otherwise 0
624 */
625int tty_port_close_start(struct tty_port *port,
626				struct tty_struct *tty, struct file *filp)
627{
628	unsigned long flags;
629
630	if (tty_hung_up_p(filp))
631		return 0;
632
633	spin_lock_irqsave(&port->lock, flags);
634	if (tty->count == 1 && port->count != 1) {
635		tty_warn(tty, "%s: tty->count = 1 port count = %d\n", __func__,
636			 port->count);
637		port->count = 1;
638	}
639	if (--port->count < 0) {
640		tty_warn(tty, "%s: bad port count (%d)\n", __func__,
641			 port->count);
642		port->count = 0;
643	}
644
645	if (port->count) {
646		spin_unlock_irqrestore(&port->lock, flags);
647		return 0;
648	}
649	spin_unlock_irqrestore(&port->lock, flags);
650
651	tty->closing = 1;
652
653	if (tty_port_initialized(port)) {
654		/* Don't block on a stalled port, just pull the chain */
655		if (tty->flow.tco_stopped)
656			tty_driver_flush_buffer(tty);
657		if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
658			tty_wait_until_sent(tty, port->closing_wait);
659		if (port->drain_delay)
660			tty_port_drain_delay(port, tty);
661	}
662	/* Flush the ldisc buffering */
663	tty_ldisc_flush(tty);
664
665	/* Report to caller this is the last port reference */
666	return 1;
667}
668EXPORT_SYMBOL(tty_port_close_start);
669
670/**
671 * tty_port_close_end - helper for tty->ops->close, part 2/2
672 * @port: tty_port of the device
673 * @tty: tty being closed
674 *
675 * This is a continuation of the first part: tty_port_close_start(). This
676 * should be called after turning off the device. It flushes the data from the
677 * line discipline and delays the close by @port->close_delay.
678 *
679 * Locking: Caller holds tty lock.
680 */
681void tty_port_close_end(struct tty_port *port, struct tty_struct *tty)
682{
683	unsigned long flags;
684
685	tty_ldisc_flush(tty);
686	tty->closing = 0;
687
688	spin_lock_irqsave(&port->lock, flags);
689
690	if (port->blocked_open) {
691		spin_unlock_irqrestore(&port->lock, flags);
692		if (port->close_delay)
693			msleep_interruptible(jiffies_to_msecs(port->close_delay));
694		spin_lock_irqsave(&port->lock, flags);
695		wake_up_interruptible(&port->open_wait);
696	}
697	spin_unlock_irqrestore(&port->lock, flags);
698	tty_port_set_active(port, false);
699}
700EXPORT_SYMBOL(tty_port_close_end);
701
702/**
703 * tty_port_close - generic tty->ops->close handler
704 * @port: tty_port of the device
705 * @tty: tty being closed
706 * @filp: passed file pointer
707 *
708 * It is a generic helper to be used in driver's @tty->ops->close. It wraps a
709 * sequence of tty_port_close_start(), tty_port_shutdown(), and
710 * tty_port_close_end(). The latter two are called only if this is the last
711 * close. See the respective functions for the details.
712 *
713 * Locking: Caller holds tty lock
714 */
715void tty_port_close(struct tty_port *port, struct tty_struct *tty,
716							struct file *filp)
717{
718	if (tty_port_close_start(port, tty, filp) == 0)
719		return;
720	tty_port_shutdown(port, tty);
721	if (!port->console)
722		set_bit(TTY_IO_ERROR, &tty->flags);
723	tty_port_close_end(port, tty);
724	tty_port_tty_set(port, NULL);
725}
726EXPORT_SYMBOL(tty_port_close);
727
728/**
729 * tty_port_install - generic tty->ops->install handler
730 * @port: tty_port of the device
731 * @driver: tty_driver for this device
732 * @tty: tty to be installed
733 *
734 * It is the same as tty_standard_install() except the provided @port is linked
735 * to a concrete tty specified by @tty. Use this or tty_port_register_device()
736 * (or both). Call tty_port_link_device() as a last resort.
737 */
738int tty_port_install(struct tty_port *port, struct tty_driver *driver,
739		struct tty_struct *tty)
740{
741	tty->port = port;
742	return tty_standard_install(driver, tty);
743}
744EXPORT_SYMBOL_GPL(tty_port_install);
745
746/**
747 * tty_port_open - generic tty->ops->open handler
748 * @port: tty_port of the device
749 * @tty: tty to be opened
750 * @filp: passed file pointer
751 *
752 * It is a generic helper to be used in driver's @tty->ops->open. It activates
753 * the devices using @port->ops->activate if not active already. And waits for
754 * the device to be ready using tty_port_block_til_ready() (e.g.  raises
755 * DTR/CTS and waits for carrier).
756 *
757 * Note that @port->ops->shutdown is not called when @port->ops->activate
758 * returns an error (on the contrary, @tty->ops->close is).
759 *
760 * Locking: Caller holds tty lock.
761 *
762 * Note: may drop and reacquire tty lock (in tty_port_block_til_ready()) so
763 * @tty and @port may have changed state (eg., may be hung up now).
764 */
765int tty_port_open(struct tty_port *port, struct tty_struct *tty,
766							struct file *filp)
767{
768	spin_lock_irq(&port->lock);
769	++port->count;
770	spin_unlock_irq(&port->lock);
771	tty_port_tty_set(port, tty);
772
773	/*
774	 * Do the device-specific open only if the hardware isn't
775	 * already initialized. Serialize open and shutdown using the
776	 * port mutex.
777	 */
778
779	mutex_lock(&port->mutex);
780
781	if (!tty_port_initialized(port)) {
782		clear_bit(TTY_IO_ERROR, &tty->flags);
783		if (port->ops->activate) {
784			int retval = port->ops->activate(port, tty);
785
786			if (retval) {
787				mutex_unlock(&port->mutex);
788				return retval;
789			}
790		}
791		tty_port_set_initialized(port, true);
792	}
793	mutex_unlock(&port->mutex);
794	return tty_port_block_til_ready(port, tty, filp);
795}
 
796EXPORT_SYMBOL(tty_port_open);
v5.9
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Tty port functions
  4 */
  5
  6#include <linux/types.h>
  7#include <linux/errno.h>
  8#include <linux/tty.h>
  9#include <linux/tty_driver.h>
 10#include <linux/tty_flip.h>
 11#include <linux/serial.h>
 12#include <linux/timer.h>
 13#include <linux/string.h>
 14#include <linux/slab.h>
 15#include <linux/sched/signal.h>
 16#include <linux/wait.h>
 17#include <linux/bitops.h>
 18#include <linux/delay.h>
 19#include <linux/module.h>
 20#include <linux/serdev.h>
 
 21
 22static int tty_port_default_receive_buf(struct tty_port *port,
 23					const unsigned char *p,
 24					const unsigned char *f, size_t count)
 25{
 26	int ret;
 27	struct tty_struct *tty;
 28	struct tty_ldisc *disc;
 29
 30	tty = READ_ONCE(port->itty);
 31	if (!tty)
 32		return 0;
 33
 34	disc = tty_ldisc_ref(tty);
 35	if (!disc)
 36		return 0;
 37
 38	ret = tty_ldisc_receive_buf(disc, p, (char *)f, count);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 39
 40	tty_ldisc_deref(disc);
 
 41
 42	return ret;
 43}
 44
 45static void tty_port_default_wakeup(struct tty_port *port)
 46{
 47	struct tty_struct *tty = tty_port_tty_get(port);
 48
 49	if (tty) {
 50		tty_wakeup(tty);
 51		tty_kref_put(tty);
 52	}
 53}
 54
 55const struct tty_port_client_operations tty_port_default_client_ops = {
 56	.receive_buf = tty_port_default_receive_buf,
 
 57	.write_wakeup = tty_port_default_wakeup,
 58};
 59EXPORT_SYMBOL_GPL(tty_port_default_client_ops);
 60
 
 
 
 
 
 
 
 
 
 61void tty_port_init(struct tty_port *port)
 62{
 63	memset(port, 0, sizeof(*port));
 64	tty_buffer_init(port);
 65	init_waitqueue_head(&port->open_wait);
 66	init_waitqueue_head(&port->delta_msr_wait);
 67	mutex_init(&port->mutex);
 68	mutex_init(&port->buf_mutex);
 69	spin_lock_init(&port->lock);
 70	port->close_delay = (50 * HZ) / 100;
 71	port->closing_wait = (3000 * HZ) / 100;
 72	port->client_ops = &tty_port_default_client_ops;
 73	kref_init(&port->kref);
 74}
 75EXPORT_SYMBOL(tty_port_init);
 76
 77/**
 78 * tty_port_link_device - link tty and tty_port
 79 * @port: tty_port of the device
 80 * @driver: tty_driver for this device
 81 * @index: index of the tty
 82 *
 83 * Provide the tty layer with a link from a tty (specified by @index) to a
 84 * tty_port (@port). Use this only if neither tty_port_register_device nor
 85 * tty_port_install is used in the driver. If used, this has to be called before
 86 * tty_register_driver.
 87 */
 88void tty_port_link_device(struct tty_port *port,
 89		struct tty_driver *driver, unsigned index)
 90{
 91	if (WARN_ON(index >= driver->num))
 92		return;
 93	driver->ports[index] = port;
 94}
 95EXPORT_SYMBOL_GPL(tty_port_link_device);
 96
 97/**
 98 * tty_port_register_device - register tty device
 99 * @port: tty_port of the device
100 * @driver: tty_driver for this device
101 * @index: index of the tty
102 * @device: parent if exists, otherwise NULL
103 *
104 * It is the same as tty_register_device except the provided @port is linked to
105 * a concrete tty specified by @index. Use this or tty_port_install (or both).
106 * Call tty_port_link_device as a last resort.
107 */
108struct device *tty_port_register_device(struct tty_port *port,
109		struct tty_driver *driver, unsigned index,
110		struct device *device)
111{
112	return tty_port_register_device_attr(port, driver, index, device, NULL, NULL);
113}
114EXPORT_SYMBOL_GPL(tty_port_register_device);
115
116/**
117 * tty_port_register_device_attr - register tty device
118 * @port: tty_port of the device
119 * @driver: tty_driver for this device
120 * @index: index of the tty
121 * @device: parent if exists, otherwise NULL
122 * @drvdata: Driver data to be set to device.
123 * @attr_grp: Attribute group to be set on device.
124 *
125 * It is the same as tty_register_device_attr except the provided @port is
126 * linked to a concrete tty specified by @index. Use this or tty_port_install
127 * (or both). Call tty_port_link_device as a last resort.
128 */
129struct device *tty_port_register_device_attr(struct tty_port *port,
130		struct tty_driver *driver, unsigned index,
131		struct device *device, void *drvdata,
132		const struct attribute_group **attr_grp)
133{
134	tty_port_link_device(port, driver, index);
135	return tty_register_device_attr(driver, index, device, drvdata,
136			attr_grp);
137}
138EXPORT_SYMBOL_GPL(tty_port_register_device_attr);
139
140/**
141 * tty_port_register_device_attr_serdev - register tty or serdev device
142 * @port: tty_port of the device
143 * @driver: tty_driver for this device
144 * @index: index of the tty
145 * @device: parent if exists, otherwise NULL
 
146 * @drvdata: driver data for the device
147 * @attr_grp: attribute group for the device
148 *
149 * Register a serdev or tty device depending on if the parent device has any
150 * defined serdev clients or not.
151 */
152struct device *tty_port_register_device_attr_serdev(struct tty_port *port,
153		struct tty_driver *driver, unsigned index,
154		struct device *device, void *drvdata,
155		const struct attribute_group **attr_grp)
156{
157	struct device *dev;
158
159	tty_port_link_device(port, driver, index);
160
161	dev = serdev_tty_port_register(port, device, driver, index);
162	if (PTR_ERR(dev) != -ENODEV) {
163		/* Skip creating cdev if we registered a serdev device */
164		return dev;
165	}
166
167	return tty_register_device_attr(driver, index, device, drvdata,
168			attr_grp);
169}
170EXPORT_SYMBOL_GPL(tty_port_register_device_attr_serdev);
171
172/**
173 * tty_port_register_device_serdev - register tty or serdev device
174 * @port: tty_port of the device
175 * @driver: tty_driver for this device
176 * @index: index of the tty
177 * @device: parent if exists, otherwise NULL
 
178 *
179 * Register a serdev or tty device depending on if the parent device has any
180 * defined serdev clients or not.
181 */
182struct device *tty_port_register_device_serdev(struct tty_port *port,
183		struct tty_driver *driver, unsigned index,
184		struct device *device)
185{
186	return tty_port_register_device_attr_serdev(port, driver, index,
187			device, NULL, NULL);
188}
189EXPORT_SYMBOL_GPL(tty_port_register_device_serdev);
190
191/**
192 * tty_port_unregister_device - deregister a tty or serdev device
193 * @port: tty_port of the device
194 * @driver: tty_driver for this device
195 * @index: index of the tty
196 *
197 * If a tty or serdev device is registered with a call to
198 * tty_port_register_device_serdev() then this function must be called when
199 * the device is gone.
200 */
201void tty_port_unregister_device(struct tty_port *port,
202		struct tty_driver *driver, unsigned index)
203{
204	int ret;
205
206	ret = serdev_tty_port_unregister(port);
207	if (ret == 0)
208		return;
209
210	tty_unregister_device(driver, index);
211}
212EXPORT_SYMBOL_GPL(tty_port_unregister_device);
213
214int tty_port_alloc_xmit_buf(struct tty_port *port)
215{
216	/* We may sleep in get_zeroed_page() */
217	mutex_lock(&port->buf_mutex);
218	if (port->xmit_buf == NULL)
219		port->xmit_buf = (unsigned char *)get_zeroed_page(GFP_KERNEL);
 
 
 
220	mutex_unlock(&port->buf_mutex);
221	if (port->xmit_buf == NULL)
222		return -ENOMEM;
223	return 0;
224}
225EXPORT_SYMBOL(tty_port_alloc_xmit_buf);
226
227void tty_port_free_xmit_buf(struct tty_port *port)
228{
229	mutex_lock(&port->buf_mutex);
230	if (port->xmit_buf != NULL) {
231		free_page((unsigned long)port->xmit_buf);
232		port->xmit_buf = NULL;
233	}
234	mutex_unlock(&port->buf_mutex);
235}
236EXPORT_SYMBOL(tty_port_free_xmit_buf);
237
238/**
239 * tty_port_destroy -- destroy inited port
240 * @port: tty port to be destroyed
241 *
242 * When a port was initialized using tty_port_init, one has to destroy the
243 * port by this function. Either indirectly by using tty_port refcounting
244 * (tty_port_put) or directly if refcounting is not used.
245 */
246void tty_port_destroy(struct tty_port *port)
247{
248	tty_buffer_cancel_work(port);
249	tty_buffer_free_all(port);
250}
251EXPORT_SYMBOL(tty_port_destroy);
252
253static void tty_port_destructor(struct kref *kref)
254{
255	struct tty_port *port = container_of(kref, struct tty_port, kref);
256
257	/* check if last port ref was dropped before tty release */
258	if (WARN_ON(port->itty))
259		return;
260	if (port->xmit_buf)
261		free_page((unsigned long)port->xmit_buf);
262	tty_port_destroy(port);
263	if (port->ops && port->ops->destruct)
264		port->ops->destruct(port);
265	else
266		kfree(port);
267}
268
 
 
 
 
 
 
 
269void tty_port_put(struct tty_port *port)
270{
271	if (port)
272		kref_put(&port->kref, tty_port_destructor);
273}
274EXPORT_SYMBOL(tty_port_put);
275
276/**
277 *	tty_port_tty_get	-	get a tty reference
278 *	@port: tty port
279 *
280 *	Return a refcount protected tty instance or NULL if the port is not
281 *	associated with a tty (eg due to close or hangup)
282 */
283struct tty_struct *tty_port_tty_get(struct tty_port *port)
284{
285	unsigned long flags;
286	struct tty_struct *tty;
287
288	spin_lock_irqsave(&port->lock, flags);
289	tty = tty_kref_get(port->tty);
290	spin_unlock_irqrestore(&port->lock, flags);
291	return tty;
292}
293EXPORT_SYMBOL(tty_port_tty_get);
294
295/**
296 *	tty_port_tty_set	-	set the tty of a port
297 *	@port: tty port
298 *	@tty: the tty
299 *
300 *	Associate the port and tty pair. Manages any internal refcounts.
301 *	Pass NULL to deassociate a port
302 */
303void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty)
304{
305	unsigned long flags;
306
307	spin_lock_irqsave(&port->lock, flags);
308	tty_kref_put(port->tty);
309	port->tty = tty_kref_get(tty);
310	spin_unlock_irqrestore(&port->lock, flags);
311}
312EXPORT_SYMBOL(tty_port_tty_set);
313
 
 
 
 
 
 
 
 
 
 
314static void tty_port_shutdown(struct tty_port *port, struct tty_struct *tty)
315{
316	mutex_lock(&port->mutex);
317	if (port->console)
318		goto out;
319
320	if (tty_port_initialized(port)) {
321		tty_port_set_initialized(port, 0);
322		/*
323		 * Drop DTR/RTS if HUPCL is set. This causes any attached
324		 * modem to hang up the line.
325		 */
326		if (tty && C_HUPCL(tty))
327			tty_port_lower_dtr_rts(port);
328
329		if (port->ops->shutdown)
330			port->ops->shutdown(port);
331	}
332out:
333	mutex_unlock(&port->mutex);
334}
335
336/**
337 *	tty_port_hangup		-	hangup helper
338 *	@port: tty port
339 *
340 *	Perform port level tty hangup flag and count changes. Drop the tty
341 *	reference.
342 *
343 *	Caller holds tty lock.
344 */
345void tty_port_hangup(struct tty_port *port)
346{
347	struct tty_struct *tty;
348	unsigned long flags;
349
350	spin_lock_irqsave(&port->lock, flags);
351	port->count = 0;
352	tty = port->tty;
353	if (tty)
354		set_bit(TTY_IO_ERROR, &tty->flags);
355	port->tty = NULL;
356	spin_unlock_irqrestore(&port->lock, flags);
357	tty_port_set_active(port, 0);
358	tty_port_shutdown(port, tty);
359	tty_kref_put(tty);
360	wake_up_interruptible(&port->open_wait);
361	wake_up_interruptible(&port->delta_msr_wait);
362}
363EXPORT_SYMBOL(tty_port_hangup);
364
365/**
366 * tty_port_tty_hangup - helper to hang up a tty
367 *
368 * @port: tty port
369 * @check_clocal: hang only ttys with CLOCAL unset?
370 */
371void tty_port_tty_hangup(struct tty_port *port, bool check_clocal)
372{
373	struct tty_struct *tty = tty_port_tty_get(port);
374
375	if (tty && (!check_clocal || !C_CLOCAL(tty)))
376		tty_hangup(tty);
377	tty_kref_put(tty);
378}
379EXPORT_SYMBOL_GPL(tty_port_tty_hangup);
380
381/**
382 * tty_port_tty_wakeup - helper to wake up a tty
383 *
384 * @port: tty port
385 */
386void tty_port_tty_wakeup(struct tty_port *port)
387{
388	port->client_ops->write_wakeup(port);
389}
390EXPORT_SYMBOL_GPL(tty_port_tty_wakeup);
391
392/**
393 *	tty_port_carrier_raised	-	carrier raised check
394 *	@port: tty port
395 *
396 *	Wrapper for the carrier detect logic. For the moment this is used
397 *	to hide some internal details. This will eventually become entirely
398 *	internal to the tty port.
399 */
400int tty_port_carrier_raised(struct tty_port *port)
401{
402	if (port->ops->carrier_raised == NULL)
403		return 1;
404	return port->ops->carrier_raised(port);
405}
406EXPORT_SYMBOL(tty_port_carrier_raised);
407
408/**
409 *	tty_port_raise_dtr_rts	-	Raise DTR/RTS
410 *	@port: tty port
411 *
412 *	Wrapper for the DTR/RTS raise logic. For the moment this is used
413 *	to hide some internal details. This will eventually become entirely
414 *	internal to the tty port.
415 */
416void tty_port_raise_dtr_rts(struct tty_port *port)
417{
418	if (port->ops->dtr_rts)
419		port->ops->dtr_rts(port, 1);
420}
421EXPORT_SYMBOL(tty_port_raise_dtr_rts);
422
423/**
424 *	tty_port_lower_dtr_rts	-	Lower DTR/RTS
425 *	@port: tty port
426 *
427 *	Wrapper for the DTR/RTS raise logic. For the moment this is used
428 *	to hide some internal details. This will eventually become entirely
429 *	internal to the tty port.
430 */
431void tty_port_lower_dtr_rts(struct tty_port *port)
432{
433	if (port->ops->dtr_rts)
434		port->ops->dtr_rts(port, 0);
435}
436EXPORT_SYMBOL(tty_port_lower_dtr_rts);
437
438/**
439 *	tty_port_block_til_ready	-	Waiting logic for tty open
440 *	@port: the tty port being opened
441 *	@tty: the tty device being bound
442 *	@filp: the file pointer of the opener or NULL
443 *
444 *	Implement the core POSIX/SuS tty behaviour when opening a tty device.
445 *	Handles:
446 *		- hangup (both before and during)
447 *		- non blocking open
448 *		- rts/dtr/dcd
449 *		- signals
450 *		- port flags and counts
451 *
452 *	The passed tty_port must implement the carrier_raised method if it can
453 *	do carrier detect and the dtr_rts method if it supports software
454 *	management of these lines. Note that the dtr/rts raise is done each
455 *	iteration as a hangup may have previously dropped them while we wait.
 
456 *
457 *	Caller holds tty lock.
458 *
459 *      NB: May drop and reacquire tty lock when blocking, so tty and tty_port
460 *      may have changed state (eg., may have been hung up).
461 */
462int tty_port_block_til_ready(struct tty_port *port,
463				struct tty_struct *tty, struct file *filp)
464{
465	int do_clocal = 0, retval;
466	unsigned long flags;
467	DEFINE_WAIT(wait);
468
469	/* if non-blocking mode is set we can pass directly to open unless
470	   the port has just hung up or is in another error state */
 
471	if (tty_io_error(tty)) {
472		tty_port_set_active(port, 1);
473		return 0;
474	}
475	if (filp == NULL || (filp->f_flags & O_NONBLOCK)) {
476		/* Indicate we are open */
477		if (C_BAUD(tty))
478			tty_port_raise_dtr_rts(port);
479		tty_port_set_active(port, 1);
480		return 0;
481	}
482
483	if (C_CLOCAL(tty))
484		do_clocal = 1;
485
486	/* Block waiting until we can proceed. We may need to wait for the
487	   carrier, but we must also wait for any close that is in progress
488	   before the next open may complete */
 
489
490	retval = 0;
491
492	/* The port lock protects the port counts */
493	spin_lock_irqsave(&port->lock, flags);
494	port->count--;
495	port->blocked_open++;
496	spin_unlock_irqrestore(&port->lock, flags);
497
498	while (1) {
499		/* Indicate we are open */
500		if (C_BAUD(tty) && tty_port_initialized(port))
501			tty_port_raise_dtr_rts(port);
502
503		prepare_to_wait(&port->open_wait, &wait, TASK_INTERRUPTIBLE);
504		/* Check for a hangup or uninitialised port.
505							Return accordingly */
 
506		if (tty_hung_up_p(filp) || !tty_port_initialized(port)) {
507			if (port->flags & ASYNC_HUP_NOTIFY)
508				retval = -EAGAIN;
509			else
510				retval = -ERESTARTSYS;
511			break;
512		}
513		/*
514		 * Probe the carrier. For devices with no carrier detect
515		 * tty_port_carrier_raised will always return true.
516		 * Never ask drivers if CLOCAL is set, this causes troubles
517		 * on some hardware.
518		 */
519		if (do_clocal || tty_port_carrier_raised(port))
520			break;
521		if (signal_pending(current)) {
522			retval = -ERESTARTSYS;
523			break;
524		}
525		tty_unlock(tty);
526		schedule();
527		tty_lock(tty);
528	}
529	finish_wait(&port->open_wait, &wait);
530
531	/* Update counts. A parallel hangup will have set count to zero and
532	   we must not mess that up further */
 
533	spin_lock_irqsave(&port->lock, flags);
534	if (!tty_hung_up_p(filp))
535		port->count++;
536	port->blocked_open--;
537	spin_unlock_irqrestore(&port->lock, flags);
538	if (retval == 0)
539		tty_port_set_active(port, 1);
540	return retval;
541}
542EXPORT_SYMBOL(tty_port_block_til_ready);
543
544static void tty_port_drain_delay(struct tty_port *port, struct tty_struct *tty)
545{
546	unsigned int bps = tty_get_baud_rate(tty);
547	long timeout;
548
549	if (bps > 1200) {
550		timeout = (HZ * 10 * port->drain_delay) / bps;
551		timeout = max_t(long, timeout, HZ / 10);
552	} else {
553		timeout = 2 * HZ;
554	}
555	schedule_timeout_interruptible(timeout);
556}
557
558/* Caller holds tty lock. */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
559int tty_port_close_start(struct tty_port *port,
560				struct tty_struct *tty, struct file *filp)
561{
562	unsigned long flags;
563
564	if (tty_hung_up_p(filp))
565		return 0;
566
567	spin_lock_irqsave(&port->lock, flags);
568	if (tty->count == 1 && port->count != 1) {
569		tty_warn(tty, "%s: tty->count = 1 port count = %d\n", __func__,
570			 port->count);
571		port->count = 1;
572	}
573	if (--port->count < 0) {
574		tty_warn(tty, "%s: bad port count (%d)\n", __func__,
575			 port->count);
576		port->count = 0;
577	}
578
579	if (port->count) {
580		spin_unlock_irqrestore(&port->lock, flags);
581		return 0;
582	}
583	spin_unlock_irqrestore(&port->lock, flags);
584
585	tty->closing = 1;
586
587	if (tty_port_initialized(port)) {
588		/* Don't block on a stalled port, just pull the chain */
589		if (tty->flow_stopped)
590			tty_driver_flush_buffer(tty);
591		if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
592			tty_wait_until_sent(tty, port->closing_wait);
593		if (port->drain_delay)
594			tty_port_drain_delay(port, tty);
595	}
596	/* Flush the ldisc buffering */
597	tty_ldisc_flush(tty);
598
599	/* Report to caller this is the last port reference */
600	return 1;
601}
602EXPORT_SYMBOL(tty_port_close_start);
603
604/* Caller holds tty lock */
 
 
 
 
 
 
 
 
 
 
605void tty_port_close_end(struct tty_port *port, struct tty_struct *tty)
606{
607	unsigned long flags;
608
609	tty_ldisc_flush(tty);
610	tty->closing = 0;
611
612	spin_lock_irqsave(&port->lock, flags);
613
614	if (port->blocked_open) {
615		spin_unlock_irqrestore(&port->lock, flags);
616		if (port->close_delay)
617			msleep_interruptible(jiffies_to_msecs(port->close_delay));
618		spin_lock_irqsave(&port->lock, flags);
619		wake_up_interruptible(&port->open_wait);
620	}
621	spin_unlock_irqrestore(&port->lock, flags);
622	tty_port_set_active(port, 0);
623}
624EXPORT_SYMBOL(tty_port_close_end);
625
626/**
627 * tty_port_close
 
 
 
628 *
629 * Caller holds tty lock
 
 
 
 
 
630 */
631void tty_port_close(struct tty_port *port, struct tty_struct *tty,
632							struct file *filp)
633{
634	if (tty_port_close_start(port, tty, filp) == 0)
635		return;
636	tty_port_shutdown(port, tty);
637	if (!port->console)
638		set_bit(TTY_IO_ERROR, &tty->flags);
639	tty_port_close_end(port, tty);
640	tty_port_tty_set(port, NULL);
641}
642EXPORT_SYMBOL(tty_port_close);
643
644/**
645 * tty_port_install - generic tty->ops->install handler
646 * @port: tty_port of the device
647 * @driver: tty_driver for this device
648 * @tty: tty to be installed
649 *
650 * It is the same as tty_standard_install except the provided @port is linked
651 * to a concrete tty specified by @tty. Use this or tty_port_register_device
652 * (or both). Call tty_port_link_device as a last resort.
653 */
654int tty_port_install(struct tty_port *port, struct tty_driver *driver,
655		struct tty_struct *tty)
656{
657	tty->port = port;
658	return tty_standard_install(driver, tty);
659}
660EXPORT_SYMBOL_GPL(tty_port_install);
661
662/**
663 * tty_port_open
 
 
 
 
 
 
 
 
 
 
 
664 *
665 * Caller holds tty lock.
666 *
667 * NB: may drop and reacquire tty lock (in tty_port_block_til_ready()) so
668 * tty and tty_port may have changed state (eg., may be hung up now)
669 */
670int tty_port_open(struct tty_port *port, struct tty_struct *tty,
671							struct file *filp)
672{
673	spin_lock_irq(&port->lock);
674	++port->count;
675	spin_unlock_irq(&port->lock);
676	tty_port_tty_set(port, tty);
677
678	/*
679	 * Do the device-specific open only if the hardware isn't
680	 * already initialized. Serialize open and shutdown using the
681	 * port mutex.
682	 */
683
684	mutex_lock(&port->mutex);
685
686	if (!tty_port_initialized(port)) {
687		clear_bit(TTY_IO_ERROR, &tty->flags);
688		if (port->ops->activate) {
689			int retval = port->ops->activate(port, tty);
 
690			if (retval) {
691				mutex_unlock(&port->mutex);
692				return retval;
693			}
694		}
695		tty_port_set_initialized(port, 1);
696	}
697	mutex_unlock(&port->mutex);
698	return tty_port_block_til_ready(port, tty, filp);
699}
700
701EXPORT_SYMBOL(tty_port_open);