Blame view

drivers/char/tty_port.c 8.78 KB
9e48565d2   Alan Cox   tty: Split tty_po...
1
2
3
4
5
6
7
8
9
  /*
   * 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>
3e61696bd   Alan Cox   isicom: redo lock...
10
  #include <linux/serial.h>
9e48565d2   Alan Cox   tty: Split tty_po...
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
  #include <linux/timer.h>
  #include <linux/string.h>
  #include <linux/slab.h>
  #include <linux/sched.h>
  #include <linux/init.h>
  #include <linux/wait.h>
  #include <linux/bitops.h>
  #include <linux/delay.h>
  #include <linux/module.h>
  
  void tty_port_init(struct tty_port *port)
  {
  	memset(port, 0, sizeof(*port));
  	init_waitqueue_head(&port->open_wait);
  	init_waitqueue_head(&port->close_wait);
  	mutex_init(&port->mutex);
4a90f09b2   Alan Cox   tty: usb-serial k...
27
  	spin_lock_init(&port->lock);
9e48565d2   Alan Cox   tty: Split tty_po...
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
  	port->close_delay = (50 * HZ) / 100;
  	port->closing_wait = (3000 * HZ) / 100;
  }
  EXPORT_SYMBOL(tty_port_init);
  
  int tty_port_alloc_xmit_buf(struct tty_port *port)
  {
  	/* We may sleep in get_zeroed_page() */
  	mutex_lock(&port->mutex);
  	if (port->xmit_buf == NULL)
  		port->xmit_buf = (unsigned char *)get_zeroed_page(GFP_KERNEL);
  	mutex_unlock(&port->mutex);
  	if (port->xmit_buf == NULL)
  		return -ENOMEM;
  	return 0;
  }
  EXPORT_SYMBOL(tty_port_alloc_xmit_buf);
  
  void tty_port_free_xmit_buf(struct tty_port *port)
  {
  	mutex_lock(&port->mutex);
  	if (port->xmit_buf != NULL) {
  		free_page((unsigned long)port->xmit_buf);
  		port->xmit_buf = NULL;
  	}
  	mutex_unlock(&port->mutex);
  }
  EXPORT_SYMBOL(tty_port_free_xmit_buf);
4a90f09b2   Alan Cox   tty: usb-serial k...
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  /**
   *	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)
  {
  	unsigned long flags;
  	struct tty_struct *tty;
  
  	spin_lock_irqsave(&port->lock, flags);
  	tty = tty_kref_get(port->tty);
  	spin_unlock_irqrestore(&port->lock, flags);
  	return 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)
  {
  	unsigned long flags;
  
  	spin_lock_irqsave(&port->lock, flags);
  	if (port->tty)
  		tty_kref_put(port->tty);
cb4bca354   Alan Cox   tty: Fix tty_port...
92
  	port->tty = tty_kref_get(tty);
4a90f09b2   Alan Cox   tty: usb-serial k...
93
94
95
  	spin_unlock_irqrestore(&port->lock, flags);
  }
  EXPORT_SYMBOL(tty_port_tty_set);
31f35939d   Alan Cox   tty_port: Add a p...
96
97
  
  /**
3e61696bd   Alan Cox   isicom: redo lock...
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
   *	tty_port_hangup		-	hangup helper
   *	@port: tty port
   *
   *	Perform port level tty hangup flag and count changes. Drop the tty
   *	reference.
   */
  
  void tty_port_hangup(struct tty_port *port)
  {
  	unsigned long flags;
  
  	spin_lock_irqsave(&port->lock, flags);
  	port->count = 0;
  	port->flags &= ~ASYNC_NORMAL_ACTIVE;
  	if (port->tty)
  		tty_kref_put(port->tty);
  	port->tty = NULL;
  	spin_unlock_irqrestore(&port->lock, flags);
  	wake_up_interruptible(&port->open_wait);
  }
  EXPORT_SYMBOL(tty_port_hangup);
  
  /**
31f35939d   Alan Cox   tty_port: Add a p...
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
   *	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.
   */
  
  int tty_port_carrier_raised(struct tty_port *port)
  {
  	if (port->ops->carrier_raised == NULL)
  		return 1;
  	return port->ops->carrier_raised(port);
  }
  EXPORT_SYMBOL(tty_port_carrier_raised);
5d951fb45   Alan Cox   tty: Pull the dtr...
136
137
  
  /**
fcc8ac182   Alan Cox   tty: Add carrier ...
138
   *	tty_port_raise_dtr_rts	-	Raise DTR/RTS
5d951fb45   Alan Cox   tty: Pull the dtr...
139
140
141
142
143
144
145
146
147
   *	@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)
  {
fcc8ac182   Alan Cox   tty: Add carrier ...
148
149
  	if (port->ops->dtr_rts)
  		port->ops->dtr_rts(port, 1);
5d951fb45   Alan Cox   tty: Pull the dtr...
150
151
  }
  EXPORT_SYMBOL(tty_port_raise_dtr_rts);
36c621d82   Alan Cox   tty: Introduce a ...
152
153
  
  /**
fcc8ac182   Alan Cox   tty: Add carrier ...
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
   *	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, 0);
  }
  EXPORT_SYMBOL(tty_port_lower_dtr_rts);
  
  /**
36c621d82   Alan Cox   tty: Introduce a ...
170
171
172
173
174
175
176
177
178
179
180
181
182
183
   *	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
   *
   *	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 tty_port must implement the carrier_raised method if it can
fcc8ac182   Alan Cox   tty: Add carrier ...
184
   *	do carrier detect and the dtr_rts method if it supports software
36c621d82   Alan Cox   tty: Introduce a ...
185
186
187
188
189
190
191
192
193
194
195
196
197
198
   *	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.
   */
   
  int tty_port_block_til_ready(struct tty_port *port,
  				struct tty_struct *tty, struct file *filp)
  {
  	int do_clocal = 0, retval;
  	unsigned long flags;
  	DECLARE_WAITQUEUE(wait, current);
  	int cd;
  
  	/* block if port is in the process of being closed */
  	if (tty_hung_up_p(filp) || port->flags & ASYNC_CLOSING) {
5fc5b42a3   Jiri Slaby   tty: remove sleep_on
199
200
  		wait_event_interruptible(port->close_wait,
  				!(port->flags & ASYNC_CLOSING));
36c621d82   Alan Cox   tty: Introduce a ...
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
  		if (port->flags & ASYNC_HUP_NOTIFY)
  			return -EAGAIN;
  		else
  			return -ERESTARTSYS;
  	}
  
  	/* if non-blocking mode is set we can pass directly to open unless
  	   the port has just hung up or is in another error state */
  	if ((filp->f_flags & O_NONBLOCK) ||
  			(tty->flags & (1 << TTY_IO_ERROR))) {
  		port->flags |= ASYNC_NORMAL_ACTIVE;
  		return 0;
  	}
  
  	if (C_CLOCAL(tty))
  		do_clocal = 1;
  
  	/* Block waiting until we can proceed. We may need to wait for the
  	   carrier, but we must also wait for any close that is in progress
  	   before the next open may complete */
  
  	retval = 0;
36c621d82   Alan Cox   tty: Introduce a ...
223
224
225
226
227
228
229
230
231
232
  
  	/* The port lock protects the port counts */
  	spin_lock_irqsave(&port->lock, flags);
  	if (!tty_hung_up_p(filp))
  		port->count--;
  	port->blocked_open++;
  	spin_unlock_irqrestore(&port->lock, flags);
  
  	while (1) {
  		/* Indicate we are open */
7834909f1   Alan Cox   tty: tty port zer...
233
234
  		if (tty->termios->c_cflag & CBAUD)
  			tty_port_raise_dtr_rts(port);
36c621d82   Alan Cox   tty: Introduce a ...
235

3e3b5c087   Jiri Slaby   tty: use prepare/...
236
  		prepare_to_wait(&port->open_wait, &wait, TASK_INTERRUPTIBLE);
36c621d82   Alan Cox   tty: Introduce a ...
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
  		/* Check for a hangup or uninitialised port. Return accordingly */
  		if (tty_hung_up_p(filp) || !(port->flags & ASYNC_INITIALIZED)) {
  			if (port->flags & ASYNC_HUP_NOTIFY)
  				retval = -EAGAIN;
  			else
  				retval = -ERESTARTSYS;
  			break;
  		}
  		/* Probe the carrier. For devices with no carrier detect this
  		   will always return true */
  		cd = tty_port_carrier_raised(port);
  		if (!(port->flags & ASYNC_CLOSING) &&
  				(do_clocal || cd))
  			break;
  		if (signal_pending(current)) {
  			retval = -ERESTARTSYS;
  			break;
  		}
  		schedule();
  	}
3e3b5c087   Jiri Slaby   tty: use prepare/...
257
  	finish_wait(&port->open_wait, &wait);
36c621d82   Alan Cox   tty: Introduce a ...
258
259
260
261
262
263
264
265
266
267
268
269
270
271
  
  	/* Update counts. A parallel hangup will have set count to zero and
  	   we must not mess that up further */
  	spin_lock_irqsave(&port->lock, flags);
  	if (!tty_hung_up_p(filp))
  		port->count++;
  	port->blocked_open--;
  	if (retval == 0)
  		port->flags |= ASYNC_NORMAL_ACTIVE;
  	spin_unlock_irqrestore(&port->lock, flags);
  	return 0;
  	
  }
  EXPORT_SYMBOL(tty_port_block_til_ready);
a6614999e   Alan Cox   tty: Introduce so...
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
  int tty_port_close_start(struct tty_port *port, struct tty_struct *tty, struct file *filp)
  {
  	unsigned long flags;
  
  	spin_lock_irqsave(&port->lock, flags);
  	if (tty_hung_up_p(filp)) {
  		spin_unlock_irqrestore(&port->lock, flags);
  		return 0;
  	}
  
  	if( tty->count == 1 && port->count != 1) {
  		printk(KERN_WARNING
  		    "tty_port_close_start: tty->count = 1 port count = %d.
  ",
  								port->count);
  		port->count = 1;
  	}
  	if (--port->count < 0) {
  		printk(KERN_WARNING "tty_port_close_start: count = %d
  ",
  								port->count);
  		port->count = 0;
  	}
  
  	if (port->count) {
  		spin_unlock_irqrestore(&port->lock, flags);
  		return 0;
  	}
  	port->flags |= ASYNC_CLOSING;
  	tty->closing = 1;
  	spin_unlock_irqrestore(&port->lock, flags);
fba85e013   Alan Cox   tty: use port met...
303
304
305
  	/* Don't block on a stalled port, just pull the chain */
  	if (tty->flow_stopped)
  		tty_driver_flush_buffer(tty);
6ed1dbaea   Alan Cox   tty: Make epca us...
306
307
  	if (port->flags & ASYNC_INITIALIZED &&
  			port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
a6614999e   Alan Cox   tty: Introduce so...
308
  		tty_wait_until_sent(tty, port->closing_wait);
1ec739be7   Alan Cox   tty: Implement a ...
309
310
311
312
313
314
315
316
317
318
319
  	if (port->drain_delay) {
  		unsigned int bps = tty_get_baud_rate(tty);
  		long timeout;
  
  		if (bps > 1200)
  			timeout = max_t(long, (HZ * 10 * port->drain_delay) / bps,
  								HZ / 10);
  		else
  			timeout = 2 * HZ;
  		schedule_timeout_interruptible(timeout);
  	}
a6614999e   Alan Cox   tty: Introduce so...
320
321
322
323
324
325
326
327
328
  	return 1;
  }
  EXPORT_SYMBOL(tty_port_close_start);
  
  void tty_port_close_end(struct tty_port *port, struct tty_struct *tty)
  {
  	unsigned long flags;
  
  	tty_ldisc_flush(tty);
fcc8ac182   Alan Cox   tty: Add carrier ...
329
330
  	if (tty->termios->c_cflag & HUPCL)
  		tty_port_lower_dtr_rts(port);
a6614999e   Alan Cox   tty: Introduce so...
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
  	spin_lock_irqsave(&port->lock, flags);
  	tty->closing = 0;
  
  	if (port->blocked_open) {
  		spin_unlock_irqrestore(&port->lock, flags);
  		if (port->close_delay) {
  			msleep_interruptible(
  				jiffies_to_msecs(port->close_delay));
  		}
  		spin_lock_irqsave(&port->lock, flags);
  		wake_up_interruptible(&port->open_wait);
  	}
  	port->flags &= ~(ASYNC_NORMAL_ACTIVE | ASYNC_CLOSING);
  	wake_up_interruptible(&port->close_wait);
  	spin_unlock_irqrestore(&port->lock, flags);
  }
  EXPORT_SYMBOL(tty_port_close_end);