Linux Audio

Check our new training course

Yocto / OpenEmbedded training

Feb 10-13, 2025
Register
Loading...
v3.5.6
  1/*
  2 * Copyright (C) 2001 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
  3 * Licensed under the GPL
  4 */
  5
  6#include "linux/irqreturn.h"
  7#include "linux/kd.h"
  8#include "linux/sched.h"
  9#include "linux/slab.h"
 10#include "chan.h"
 11#include "irq_kern.h"
 12#include "irq_user.h"
 13#include "kern_util.h"
 14#include "os.h"
 15
 16#define LINE_BUFSIZE 4096
 17
 18static irqreturn_t line_interrupt(int irq, void *data)
 19{
 20	struct chan *chan = data;
 21	struct line *line = chan->line;
 22
 23	if (line)
 24		chan_interrupt(line, line->tty, irq);
 
 25	return IRQ_HANDLED;
 26}
 27
 28/*
 29 * Returns the free space inside the ring buffer of this line.
 30 *
 31 * Should be called while holding line->lock (this does not modify data).
 32 */
 33static int write_room(struct line *line)
 34{
 35	int n;
 36
 37	if (line->buffer == NULL)
 38		return LINE_BUFSIZE - 1;
 39
 40	/* This is for the case where the buffer is wrapped! */
 41	n = line->head - line->tail;
 42
 43	if (n <= 0)
 44		n += LINE_BUFSIZE; /* The other case */
 45	return n - 1;
 46}
 47
 48int line_write_room(struct tty_struct *tty)
 49{
 50	struct line *line = tty->driver_data;
 51	unsigned long flags;
 52	int room;
 53
 54	spin_lock_irqsave(&line->lock, flags);
 55	room = write_room(line);
 56	spin_unlock_irqrestore(&line->lock, flags);
 57
 58	return room;
 59}
 60
 61int line_chars_in_buffer(struct tty_struct *tty)
 62{
 63	struct line *line = tty->driver_data;
 64	unsigned long flags;
 65	int ret;
 66
 67	spin_lock_irqsave(&line->lock, flags);
 68	/* write_room subtracts 1 for the needed NULL, so we readd it.*/
 69	ret = LINE_BUFSIZE - (write_room(line) + 1);
 70	spin_unlock_irqrestore(&line->lock, flags);
 71
 72	return ret;
 73}
 74
 75/*
 76 * This copies the content of buf into the circular buffer associated with
 77 * this line.
 78 * The return value is the number of characters actually copied, i.e. the ones
 79 * for which there was space: this function is not supposed to ever flush out
 80 * the circular buffer.
 81 *
 82 * Must be called while holding line->lock!
 83 */
 84static int buffer_data(struct line *line, const char *buf, int len)
 85{
 86	int end, room;
 87
 88	if (line->buffer == NULL) {
 89		line->buffer = kmalloc(LINE_BUFSIZE, GFP_ATOMIC);
 90		if (line->buffer == NULL) {
 91			printk(KERN_ERR "buffer_data - atomic allocation "
 92			       "failed\n");
 93			return 0;
 94		}
 95		line->head = line->buffer;
 96		line->tail = line->buffer;
 97	}
 98
 99	room = write_room(line);
100	len = (len > room) ? room : len;
101
102	end = line->buffer + LINE_BUFSIZE - line->tail;
103
104	if (len < end) {
105		memcpy(line->tail, buf, len);
106		line->tail += len;
107	}
108	else {
109		/* The circular buffer is wrapping */
110		memcpy(line->tail, buf, end);
111		buf += end;
112		memcpy(line->buffer, buf, len - end);
113		line->tail = line->buffer + len - end;
114	}
115
116	return len;
117}
118
119/*
120 * Flushes the ring buffer to the output channels. That is, write_chan is
121 * called, passing it line->head as buffer, and an appropriate count.
122 *
123 * On exit, returns 1 when the buffer is empty,
124 * 0 when the buffer is not empty on exit,
125 * and -errno when an error occurred.
126 *
127 * Must be called while holding line->lock!*/
128static int flush_buffer(struct line *line)
129{
130	int n, count;
131
132	if ((line->buffer == NULL) || (line->head == line->tail))
133		return 1;
134
135	if (line->tail < line->head) {
136		/* line->buffer + LINE_BUFSIZE is the end of the buffer! */
137		count = line->buffer + LINE_BUFSIZE - line->head;
138
139		n = write_chan(line->chan_out, line->head, count,
140			       line->driver->write_irq);
141		if (n < 0)
142			return n;
143		if (n == count) {
144			/*
145			 * We have flushed from ->head to buffer end, now we
146			 * must flush only from the beginning to ->tail.
147			 */
148			line->head = line->buffer;
149		} else {
150			line->head += n;
151			return 0;
152		}
153	}
154
155	count = line->tail - line->head;
156	n = write_chan(line->chan_out, line->head, count,
157		       line->driver->write_irq);
158
159	if (n < 0)
160		return n;
161
162	line->head += n;
163	return line->head == line->tail;
164}
165
166void line_flush_buffer(struct tty_struct *tty)
167{
168	struct line *line = tty->driver_data;
169	unsigned long flags;
170
171	spin_lock_irqsave(&line->lock, flags);
172	flush_buffer(line);
173	spin_unlock_irqrestore(&line->lock, flags);
174}
175
176/*
177 * We map both ->flush_chars and ->put_char (which go in pair) onto
178 * ->flush_buffer and ->write. Hope it's not that bad.
179 */
180void line_flush_chars(struct tty_struct *tty)
181{
182	line_flush_buffer(tty);
183}
184
185int line_put_char(struct tty_struct *tty, unsigned char ch)
186{
187	return line_write(tty, &ch, sizeof(ch));
188}
189
190int line_write(struct tty_struct *tty, const unsigned char *buf, int len)
191{
192	struct line *line = tty->driver_data;
193	unsigned long flags;
194	int n, ret = 0;
195
196	spin_lock_irqsave(&line->lock, flags);
197	if (line->head != line->tail)
198		ret = buffer_data(line, buf, len);
199	else {
200		n = write_chan(line->chan_out, buf, len,
201			       line->driver->write_irq);
202		if (n < 0) {
203			ret = n;
204			goto out_up;
205		}
206
207		len -= n;
208		ret += n;
209		if (len > 0)
210			ret += buffer_data(line, buf + n, len);
211	}
212out_up:
213	spin_unlock_irqrestore(&line->lock, flags);
214	return ret;
215}
216
217void line_set_termios(struct tty_struct *tty, struct ktermios * old)
218{
219	/* nothing */
220}
221
222static const struct {
223	int  cmd;
224	char *level;
225	char *name;
226} tty_ioctls[] = {
227	/* don't print these, they flood the log ... */
228	{ TCGETS,      NULL,       "TCGETS"      },
229	{ TCSETS,      NULL,       "TCSETS"      },
230	{ TCSETSW,     NULL,       "TCSETSW"     },
231	{ TCFLSH,      NULL,       "TCFLSH"      },
232	{ TCSBRK,      NULL,       "TCSBRK"      },
233
234	/* general tty stuff */
235	{ TCSETSF,     KERN_DEBUG, "TCSETSF"     },
236	{ TCGETA,      KERN_DEBUG, "TCGETA"      },
237	{ TIOCMGET,    KERN_DEBUG, "TIOCMGET"    },
238	{ TCSBRKP,     KERN_DEBUG, "TCSBRKP"     },
239	{ TIOCMSET,    KERN_DEBUG, "TIOCMSET"    },
240
241	/* linux-specific ones */
242	{ TIOCLINUX,   KERN_INFO,  "TIOCLINUX"   },
243	{ KDGKBMODE,   KERN_INFO,  "KDGKBMODE"   },
244	{ KDGKBTYPE,   KERN_INFO,  "KDGKBTYPE"   },
245	{ KDSIGACCEPT, KERN_INFO,  "KDSIGACCEPT" },
246};
247
248int line_ioctl(struct tty_struct *tty, unsigned int cmd,
249				unsigned long arg)
250{
251	int ret;
252	int i;
253
254	ret = 0;
255	switch(cmd) {
256#ifdef TIOCGETP
257	case TIOCGETP:
258	case TIOCSETP:
259	case TIOCSETN:
260#endif
261#ifdef TIOCGETC
262	case TIOCGETC:
263	case TIOCSETC:
264#endif
265#ifdef TIOCGLTC
266	case TIOCGLTC:
267	case TIOCSLTC:
268#endif
269	/* Note: these are out of date as we now have TCGETS2 etc but this
270	   whole lot should probably go away */
271	case TCGETS:
272	case TCSETSF:
273	case TCSETSW:
274	case TCSETS:
275	case TCGETA:
276	case TCSETAF:
277	case TCSETAW:
278	case TCSETA:
279	case TCXONC:
280	case TCFLSH:
281	case TIOCOUTQ:
282	case TIOCINQ:
283	case TIOCGLCKTRMIOS:
284	case TIOCSLCKTRMIOS:
285	case TIOCPKT:
286	case TIOCGSOFTCAR:
287	case TIOCSSOFTCAR:
288		return -ENOIOCTLCMD;
289#if 0
290	case TCwhatever:
291		/* do something */
292		break;
293#endif
294	default:
295		for (i = 0; i < ARRAY_SIZE(tty_ioctls); i++)
296			if (cmd == tty_ioctls[i].cmd)
297				break;
298		if (i == ARRAY_SIZE(tty_ioctls)) {
299			printk(KERN_ERR "%s: %s: unknown ioctl: 0x%x\n",
300			       __func__, tty->name, cmd);
301		}
302		ret = -ENOIOCTLCMD;
303		break;
304	}
305	return ret;
306}
307
308void line_throttle(struct tty_struct *tty)
309{
310	struct line *line = tty->driver_data;
311
312	deactivate_chan(line->chan_in, line->driver->read_irq);
313	line->throttled = 1;
314}
315
316void line_unthrottle(struct tty_struct *tty)
317{
318	struct line *line = tty->driver_data;
319
320	line->throttled = 0;
321	chan_interrupt(line, tty, line->driver->read_irq);
322
323	/*
324	 * Maybe there is enough stuff pending that calling the interrupt
325	 * throttles us again.  In this case, line->throttled will be 1
326	 * again and we shouldn't turn the interrupt back on.
327	 */
328	if (!line->throttled)
329		reactivate_chan(line->chan_in, line->driver->read_irq);
330}
331
332static irqreturn_t line_write_interrupt(int irq, void *data)
333{
334	struct chan *chan = data;
335	struct line *line = chan->line;
336	struct tty_struct *tty = line->tty;
337	int err;
338
339	/*
340	 * Interrupts are disabled here because genirq keep irqs disabled when
341	 * calling the action handler.
342	 */
343
344	spin_lock(&line->lock);
345	err = flush_buffer(line);
346	if (err == 0) {
347		spin_unlock(&line->lock);
348		return IRQ_NONE;
349	} else if (err < 0) {
350		line->head = line->buffer;
351		line->tail = line->buffer;
352	}
353	spin_unlock(&line->lock);
354
355	if (tty == NULL)
356		return IRQ_NONE;
357
358	tty_wakeup(tty);
359	return IRQ_HANDLED;
360}
361
362int line_setup_irq(int fd, int input, int output, struct line *line, void *data)
363{
364	const struct line_driver *driver = line->driver;
365	int err = 0, flags = IRQF_SHARED | IRQF_SAMPLE_RANDOM;
366
367	if (input)
368		err = um_request_irq(driver->read_irq, fd, IRQ_READ,
369				       line_interrupt, flags,
370				       driver->read_irq_name, data);
371	if (err)
372		return err;
373	if (output)
374		err = um_request_irq(driver->write_irq, fd, IRQ_WRITE,
375					line_write_interrupt, flags,
376					driver->write_irq_name, data);
377	return err;
378}
379
380/*
381 * Normally, a driver like this can rely mostly on the tty layer
382 * locking, particularly when it comes to the driver structure.
383 * However, in this case, mconsole requests can come in "from the
384 * side", and race with opens and closes.
385 *
386 * mconsole config requests will want to be sure the device isn't in
387 * use, and get_config, open, and close will want a stable
388 * configuration.  The checking and modification of the configuration
389 * is done under a spinlock.  Checking whether the device is in use is
390 * line->tty->count > 1, also under the spinlock.
391 *
392 * line->count serves to decide whether the device should be enabled or
393 * disabled on the host.  If it's equal to 0, then we are doing the
394 * first open or last close.  Otherwise, open and close just return.
395 */
396
397int line_open(struct line *lines, struct tty_struct *tty)
398{
399	struct line *line = &lines[tty->index];
400	int err = -ENODEV;
401
402	mutex_lock(&line->count_lock);
403	if (!line->valid)
404		goto out_unlock;
405
406	err = 0;
407	if (line->count++)
408		goto out_unlock;
409
410	BUG_ON(tty->driver_data);
411	tty->driver_data = line;
412	line->tty = tty;
413
414	err = enable_chan(line);
415	if (err) /* line_close() will be called by our caller */
416		goto out_unlock;
417
418	if (!line->sigio) {
419		chan_enable_winch(line->chan_out, tty);
420		line->sigio = 1;
421	}
422
423	chan_window_size(line, &tty->winsize.ws_row,
424			 &tty->winsize.ws_col);
425out_unlock:
426	mutex_unlock(&line->count_lock);
427	return err;
428}
429
430static void unregister_winch(struct tty_struct *tty);
431
432void line_close(struct tty_struct *tty, struct file * filp)
433{
 
434	struct line *line = tty->driver_data;
435
436	/*
437	 * If line_open fails (and tty->driver_data is never set),
438	 * tty_open will call line_close.  So just return in this case.
439	 */
440	if (line == NULL)
441		return;
442
443	/* We ignore the error anyway! */
444	flush_buffer(line);
 
 
445
446	mutex_lock(&line->count_lock);
447	BUG_ON(!line->valid);
 
448
449	if (--line->count)
450		goto out_unlock;
451
452	line->tty = NULL;
453	tty->driver_data = NULL;
 
 
454
455	if (line->sigio) {
456		unregister_winch(tty);
457		line->sigio = 0;
458	}
459
460out_unlock:
461	mutex_unlock(&line->count_lock);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
462}
463
464void close_lines(struct line *lines, int nlines)
465{
466	int i;
467
468	for(i = 0; i < nlines; i++)
469		close_chan(&lines[i]);
470}
471
472int setup_one_line(struct line *lines, int n, char *init,
473		   const struct chan_opts *opts, char **error_out)
474{
475	struct line *line = &lines[n];
476	struct tty_driver *driver = line->driver->driver;
477	int err = -EINVAL;
478
479	mutex_lock(&line->count_lock);
480
481	if (line->count) {
482		*error_out = "Device is already open";
483		goto out;
484	}
485
486	if (!strcmp(init, "none")) {
487		if (line->valid) {
488			line->valid = 0;
489			kfree(line->init_str);
490			tty_unregister_device(driver, n);
491			parse_chan_pair(NULL, line, n, opts, error_out);
492			err = 0;
493		}
494	} else {
495		char *new = kstrdup(init, GFP_KERNEL);
496		if (!new) {
497			*error_out = "Failed to allocate memory";
498			return -ENOMEM;
499		}
500		if (line->valid) {
501			tty_unregister_device(driver, n);
502			kfree(line->init_str);
503		}
504		line->init_str = new;
505		line->valid = 1;
506		err = parse_chan_pair(new, line, n, opts, error_out);
507		if (!err) {
508			struct device *d = tty_register_device(driver, n, NULL);
 
509			if (IS_ERR(d)) {
510				*error_out = "Failed to register device";
511				err = PTR_ERR(d);
512				parse_chan_pair(NULL, line, n, opts, error_out);
513			}
514		}
515		if (err) {
516			line->init_str = NULL;
517			line->valid = 0;
518			kfree(new);
519		}
520	}
521out:
522	mutex_unlock(&line->count_lock);
523	return err;
524}
525
526/*
527 * Common setup code for both startup command line and mconsole initialization.
528 * @lines contains the array (of size @num) to modify;
529 * @init is the setup string;
530 * @error_out is an error string in the case of failure;
531 */
532
533int line_setup(char **conf, unsigned int num, char **def,
534	       char *init, char *name)
535{
536	char *error;
537
538	if (*init == '=') {
539		/*
540		 * We said con=/ssl= instead of con#=, so we are configuring all
541		 * consoles at once.
542		 */
543		*def = init + 1;
544	} else {
545		char *end;
546		unsigned n = simple_strtoul(init, &end, 0);
547
548		if (*end != '=') {
549			error = "Couldn't parse device number";
550			goto out;
551		}
552		if (n >= num) {
553			error = "Device number out of range";
554			goto out;
555		}
556		conf[n] = end + 1;
557	}
558	return 0;
559
560out:
561	printk(KERN_ERR "Failed to set up %s with "
562	       "configuration string \"%s\" : %s\n", name, init, error);
563	return -EINVAL;
564}
565
566int line_config(struct line *lines, unsigned int num, char *str,
567		const struct chan_opts *opts, char **error_out)
568{
569	char *end;
570	int n;
571
572	if (*str == '=') {
573		*error_out = "Can't configure all devices from mconsole";
574		return -EINVAL;
575	}
576
577	n = simple_strtoul(str, &end, 0);
578	if (*end++ != '=') {
579		*error_out = "Couldn't parse device number";
580		return -EINVAL;
581	}
582	if (n >= num) {
583		*error_out = "Device number out of range";
584		return -EINVAL;
585	}
586
587	return setup_one_line(lines, n, end, opts, error_out);
588}
589
590int line_get_config(char *name, struct line *lines, unsigned int num, char *str,
591		    int size, char **error_out)
592{
593	struct line *line;
594	char *end;
595	int dev, n = 0;
596
597	dev = simple_strtoul(name, &end, 0);
598	if ((*end != '\0') || (end == name)) {
599		*error_out = "line_get_config failed to parse device number";
600		return 0;
601	}
602
603	if ((dev < 0) || (dev >= num)) {
604		*error_out = "device number out of range";
605		return 0;
606	}
607
608	line = &lines[dev];
609
610	mutex_lock(&line->count_lock);
611	if (!line->valid)
612		CONFIG_CHUNK(str, size, n, "none", 1);
613	else if (line->tty == NULL)
614		CONFIG_CHUNK(str, size, n, line->init_str, 1);
615	else n = chan_config_string(line, str, size, error_out);
616	mutex_unlock(&line->count_lock);
 
 
 
 
 
617
618	return n;
619}
620
621int line_id(char **str, int *start_out, int *end_out)
622{
623	char *end;
624	int n;
625
626	n = simple_strtoul(*str, &end, 0);
627	if ((*end != '\0') || (end == *str))
628		return -1;
629
630	*str = end;
631	*start_out = n;
632	*end_out = n;
633	return n;
634}
635
636int line_remove(struct line *lines, unsigned int num, int n, char **error_out)
637{
638	if (n >= num) {
639		*error_out = "Device number out of range";
640		return -EINVAL;
641	}
642	return setup_one_line(lines, n, "none", NULL, error_out);
643}
644
645int register_lines(struct line_driver *line_driver,
646		   const struct tty_operations *ops,
647		   struct line *lines, int nlines)
648{
649	struct tty_driver *driver = alloc_tty_driver(nlines);
650	int err;
651	int i;
652
653	if (!driver)
654		return -ENOMEM;
655
656	driver->driver_name = line_driver->name;
657	driver->name = line_driver->device_name;
658	driver->major = line_driver->major;
659	driver->minor_start = line_driver->minor_start;
660	driver->type = line_driver->type;
661	driver->subtype = line_driver->subtype;
662	driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
663	driver->init_termios = tty_std_termios;
664	
665	for (i = 0; i < nlines; i++) {
 
 
666		spin_lock_init(&lines[i].lock);
667		mutex_init(&lines[i].count_lock);
668		lines[i].driver = line_driver;
669		INIT_LIST_HEAD(&lines[i].chan_list);
670	}
671	tty_set_operations(driver, ops);
672
673	err = tty_register_driver(driver);
674	if (err) {
675		printk(KERN_ERR "register_lines : can't register %s driver\n",
676		       line_driver->name);
677		put_tty_driver(driver);
 
 
678		return err;
679	}
680
681	line_driver->driver = driver;
682	mconsole_register_dev(&line_driver->mc);
683	return 0;
684}
685
686static DEFINE_SPINLOCK(winch_handler_lock);
687static LIST_HEAD(winch_handlers);
688
689struct winch {
690	struct list_head list;
691	int fd;
692	int tty_fd;
693	int pid;
694	struct tty_struct *tty;
695	unsigned long stack;
696	struct work_struct work;
697};
698
699static void __free_winch(struct work_struct *work)
700{
701	struct winch *winch = container_of(work, struct winch, work);
702	um_free_irq(WINCH_IRQ, winch);
703
704	if (winch->pid != -1)
705		os_kill_process(winch->pid, 1);
706	if (winch->stack != 0)
707		free_stack(winch->stack, 0);
708	kfree(winch);
709}
710
711static void free_winch(struct winch *winch)
712{
713	int fd = winch->fd;
714	winch->fd = -1;
715	if (fd != -1)
716		os_close_file(fd);
717	list_del(&winch->list);
718	__free_winch(&winch->work);
719}
720
721static irqreturn_t winch_interrupt(int irq, void *data)
722{
723	struct winch *winch = data;
724	struct tty_struct *tty;
725	struct line *line;
726	int fd = winch->fd;
727	int err;
728	char c;
 
729
730	if (fd != -1) {
731		err = generic_read(fd, &c, NULL);
732		if (err < 0) {
733			if (err != -EAGAIN) {
734				winch->fd = -1;
735				list_del(&winch->list);
736				os_close_file(fd);
737				printk(KERN_ERR "winch_interrupt : "
738				       "read failed, errno = %d\n", -err);
739				printk(KERN_ERR "fd %d is losing SIGWINCH "
740				       "support\n", winch->tty_fd);
741				INIT_WORK(&winch->work, __free_winch);
742				schedule_work(&winch->work);
743				return IRQ_HANDLED;
744			}
745			goto out;
746		}
747	}
748	tty = winch->tty;
749	if (tty != NULL) {
750		line = tty->driver_data;
751		if (line != NULL) {
752			chan_window_size(line, &tty->winsize.ws_row,
753					 &tty->winsize.ws_col);
754			kill_pgrp(tty->pgrp, SIGWINCH, 1);
 
 
 
755		}
 
756	}
757 out:
758	if (winch->fd != -1)
759		reactivate_fd(winch->fd, WINCH_IRQ);
760	return IRQ_HANDLED;
761}
762
763void register_winch_irq(int fd, int tty_fd, int pid, struct tty_struct *tty,
764			unsigned long stack)
765{
766	struct winch *winch;
767
768	winch = kmalloc(sizeof(*winch), GFP_KERNEL);
769	if (winch == NULL) {
770		printk(KERN_ERR "register_winch_irq - kmalloc failed\n");
771		goto cleanup;
772	}
773
774	*winch = ((struct winch) { .list  	= LIST_HEAD_INIT(winch->list),
775				   .fd  	= fd,
776				   .tty_fd 	= tty_fd,
777				   .pid  	= pid,
778				   .tty 	= tty,
779				   .stack	= stack });
780
781	if (um_request_irq(WINCH_IRQ, fd, IRQ_READ, winch_interrupt,
782			   IRQF_SHARED | IRQF_SAMPLE_RANDOM,
783			   "winch", winch) < 0) {
784		printk(KERN_ERR "register_winch_irq - failed to register "
785		       "IRQ\n");
786		goto out_free;
787	}
788
789	spin_lock(&winch_handler_lock);
790	list_add(&winch->list, &winch_handlers);
791	spin_unlock(&winch_handler_lock);
792
793	return;
794
795 out_free:
796	kfree(winch);
797 cleanup:
798	os_kill_process(pid, 1);
799	os_close_file(fd);
800	if (stack != 0)
801		free_stack(stack, 0);
802}
803
804static void unregister_winch(struct tty_struct *tty)
805{
806	struct list_head *ele, *next;
807	struct winch *winch;
 
808
809	spin_lock(&winch_handler_lock);
810
811	list_for_each_safe(ele, next, &winch_handlers) {
812		winch = list_entry(ele, struct winch, list);
813		if (winch->tty == tty) {
 
814			free_winch(winch);
815			break;
816		}
 
817	}
818	spin_unlock(&winch_handler_lock);
819}
820
821static void winch_cleanup(void)
822{
823	struct list_head *ele, *next;
824	struct winch *winch;
825
826	spin_lock(&winch_handler_lock);
827
828	list_for_each_safe(ele, next, &winch_handlers) {
829		winch = list_entry(ele, struct winch, list);
830		free_winch(winch);
831	}
832
833	spin_unlock(&winch_handler_lock);
834}
835__uml_exitcall(winch_cleanup);
836
837char *add_xterm_umid(char *base)
838{
839	char *umid, *title;
840	int len;
841
842	umid = get_umid();
843	if (*umid == '\0')
844		return base;
845
846	len = strlen(base) + strlen(" ()") + strlen(umid) + 1;
847	title = kmalloc(len, GFP_KERNEL);
848	if (title == NULL) {
849		printk(KERN_ERR "Failed to allocate buffer for xterm title\n");
850		return base;
851	}
852
853	snprintf(title, len, "%s (%s)", base, umid);
854	return title;
855}
v4.6
  1/*
  2 * Copyright (C) 2001 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
  3 * Licensed under the GPL
  4 */
  5
  6#include <linux/irqreturn.h>
  7#include <linux/kd.h>
  8#include <linux/sched.h>
  9#include <linux/slab.h>
 10#include "chan.h"
 11#include <irq_kern.h>
 12#include <irq_user.h>
 13#include <kern_util.h>
 14#include <os.h>
 15
 16#define LINE_BUFSIZE 4096
 17
 18static irqreturn_t line_interrupt(int irq, void *data)
 19{
 20	struct chan *chan = data;
 21	struct line *line = chan->line;
 22
 23	if (line)
 24		chan_interrupt(line, irq);
 25
 26	return IRQ_HANDLED;
 27}
 28
 29/*
 30 * Returns the free space inside the ring buffer of this line.
 31 *
 32 * Should be called while holding line->lock (this does not modify data).
 33 */
 34static int write_room(struct line *line)
 35{
 36	int n;
 37
 38	if (line->buffer == NULL)
 39		return LINE_BUFSIZE - 1;
 40
 41	/* This is for the case where the buffer is wrapped! */
 42	n = line->head - line->tail;
 43
 44	if (n <= 0)
 45		n += LINE_BUFSIZE; /* The other case */
 46	return n - 1;
 47}
 48
 49int line_write_room(struct tty_struct *tty)
 50{
 51	struct line *line = tty->driver_data;
 52	unsigned long flags;
 53	int room;
 54
 55	spin_lock_irqsave(&line->lock, flags);
 56	room = write_room(line);
 57	spin_unlock_irqrestore(&line->lock, flags);
 58
 59	return room;
 60}
 61
 62int line_chars_in_buffer(struct tty_struct *tty)
 63{
 64	struct line *line = tty->driver_data;
 65	unsigned long flags;
 66	int ret;
 67
 68	spin_lock_irqsave(&line->lock, flags);
 69	/* write_room subtracts 1 for the needed NULL, so we readd it.*/
 70	ret = LINE_BUFSIZE - (write_room(line) + 1);
 71	spin_unlock_irqrestore(&line->lock, flags);
 72
 73	return ret;
 74}
 75
 76/*
 77 * This copies the content of buf into the circular buffer associated with
 78 * this line.
 79 * The return value is the number of characters actually copied, i.e. the ones
 80 * for which there was space: this function is not supposed to ever flush out
 81 * the circular buffer.
 82 *
 83 * Must be called while holding line->lock!
 84 */
 85static int buffer_data(struct line *line, const char *buf, int len)
 86{
 87	int end, room;
 88
 89	if (line->buffer == NULL) {
 90		line->buffer = kmalloc(LINE_BUFSIZE, GFP_ATOMIC);
 91		if (line->buffer == NULL) {
 92			printk(KERN_ERR "buffer_data - atomic allocation "
 93			       "failed\n");
 94			return 0;
 95		}
 96		line->head = line->buffer;
 97		line->tail = line->buffer;
 98	}
 99
100	room = write_room(line);
101	len = (len > room) ? room : len;
102
103	end = line->buffer + LINE_BUFSIZE - line->tail;
104
105	if (len < end) {
106		memcpy(line->tail, buf, len);
107		line->tail += len;
108	}
109	else {
110		/* The circular buffer is wrapping */
111		memcpy(line->tail, buf, end);
112		buf += end;
113		memcpy(line->buffer, buf, len - end);
114		line->tail = line->buffer + len - end;
115	}
116
117	return len;
118}
119
120/*
121 * Flushes the ring buffer to the output channels. That is, write_chan is
122 * called, passing it line->head as buffer, and an appropriate count.
123 *
124 * On exit, returns 1 when the buffer is empty,
125 * 0 when the buffer is not empty on exit,
126 * and -errno when an error occurred.
127 *
128 * Must be called while holding line->lock!*/
129static int flush_buffer(struct line *line)
130{
131	int n, count;
132
133	if ((line->buffer == NULL) || (line->head == line->tail))
134		return 1;
135
136	if (line->tail < line->head) {
137		/* line->buffer + LINE_BUFSIZE is the end of the buffer! */
138		count = line->buffer + LINE_BUFSIZE - line->head;
139
140		n = write_chan(line->chan_out, line->head, count,
141			       line->driver->write_irq);
142		if (n < 0)
143			return n;
144		if (n == count) {
145			/*
146			 * We have flushed from ->head to buffer end, now we
147			 * must flush only from the beginning to ->tail.
148			 */
149			line->head = line->buffer;
150		} else {
151			line->head += n;
152			return 0;
153		}
154	}
155
156	count = line->tail - line->head;
157	n = write_chan(line->chan_out, line->head, count,
158		       line->driver->write_irq);
159
160	if (n < 0)
161		return n;
162
163	line->head += n;
164	return line->head == line->tail;
165}
166
167void line_flush_buffer(struct tty_struct *tty)
168{
169	struct line *line = tty->driver_data;
170	unsigned long flags;
171
172	spin_lock_irqsave(&line->lock, flags);
173	flush_buffer(line);
174	spin_unlock_irqrestore(&line->lock, flags);
175}
176
177/*
178 * We map both ->flush_chars and ->put_char (which go in pair) onto
179 * ->flush_buffer and ->write. Hope it's not that bad.
180 */
181void line_flush_chars(struct tty_struct *tty)
182{
183	line_flush_buffer(tty);
184}
185
186int line_put_char(struct tty_struct *tty, unsigned char ch)
187{
188	return line_write(tty, &ch, sizeof(ch));
189}
190
191int line_write(struct tty_struct *tty, const unsigned char *buf, int len)
192{
193	struct line *line = tty->driver_data;
194	unsigned long flags;
195	int n, ret = 0;
196
197	spin_lock_irqsave(&line->lock, flags);
198	if (line->head != line->tail)
199		ret = buffer_data(line, buf, len);
200	else {
201		n = write_chan(line->chan_out, buf, len,
202			       line->driver->write_irq);
203		if (n < 0) {
204			ret = n;
205			goto out_up;
206		}
207
208		len -= n;
209		ret += n;
210		if (len > 0)
211			ret += buffer_data(line, buf + n, len);
212	}
213out_up:
214	spin_unlock_irqrestore(&line->lock, flags);
215	return ret;
216}
217
218void line_set_termios(struct tty_struct *tty, struct ktermios * old)
219{
220	/* nothing */
221}
222
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
223void line_throttle(struct tty_struct *tty)
224{
225	struct line *line = tty->driver_data;
226
227	deactivate_chan(line->chan_in, line->driver->read_irq);
228	line->throttled = 1;
229}
230
231void line_unthrottle(struct tty_struct *tty)
232{
233	struct line *line = tty->driver_data;
234
235	line->throttled = 0;
236	chan_interrupt(line, line->driver->read_irq);
237
238	/*
239	 * Maybe there is enough stuff pending that calling the interrupt
240	 * throttles us again.  In this case, line->throttled will be 1
241	 * again and we shouldn't turn the interrupt back on.
242	 */
243	if (!line->throttled)
244		reactivate_chan(line->chan_in, line->driver->read_irq);
245}
246
247static irqreturn_t line_write_interrupt(int irq, void *data)
248{
249	struct chan *chan = data;
250	struct line *line = chan->line;
 
251	int err;
252
253	/*
254	 * Interrupts are disabled here because genirq keep irqs disabled when
255	 * calling the action handler.
256	 */
257
258	spin_lock(&line->lock);
259	err = flush_buffer(line);
260	if (err == 0) {
261		spin_unlock(&line->lock);
262		return IRQ_NONE;
263	} else if (err < 0) {
264		line->head = line->buffer;
265		line->tail = line->buffer;
266	}
267	spin_unlock(&line->lock);
268
269	tty_port_tty_wakeup(&line->port);
 
270
 
271	return IRQ_HANDLED;
272}
273
274int line_setup_irq(int fd, int input, int output, struct line *line, void *data)
275{
276	const struct line_driver *driver = line->driver;
277	int err = 0;
278
279	if (input)
280		err = um_request_irq(driver->read_irq, fd, IRQ_READ,
281				     line_interrupt, IRQF_SHARED,
282				     driver->read_irq_name, data);
283	if (err)
284		return err;
285	if (output)
286		err = um_request_irq(driver->write_irq, fd, IRQ_WRITE,
287				     line_write_interrupt, IRQF_SHARED,
288				     driver->write_irq_name, data);
289	return err;
290}
291
292static int line_activate(struct tty_port *port, struct tty_struct *tty)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
293{
294	int ret;
295	struct line *line = tty->driver_data;
 
 
 
 
 
 
 
 
 
 
 
 
296
297	ret = enable_chan(line);
298	if (ret)
299		return ret;
300
301	if (!line->sigio) {
302		chan_enable_winch(line->chan_out, port);
303		line->sigio = 1;
304	}
305
306	chan_window_size(line, &tty->winsize.ws_row,
307		&tty->winsize.ws_col);
308
309	return 0;
 
310}
311
312static void unregister_winch(struct tty_struct *tty);
313
314static void line_destruct(struct tty_port *port)
315{
316	struct tty_struct *tty = tty_port_tty_get(port);
317	struct line *line = tty->driver_data;
318
319	if (line->sigio) {
320		unregister_winch(tty);
321		line->sigio = 0;
322	}
323}
 
324
325static const struct tty_port_operations line_port_ops = {
326	.activate = line_activate,
327	.destruct = line_destruct,
328};
329
330int line_open(struct tty_struct *tty, struct file *filp)
331{
332	struct line *line = tty->driver_data;
333
334	return tty_port_open(&line->port, tty, filp);
335}
336
337int line_install(struct tty_driver *driver, struct tty_struct *tty,
338		 struct line *line)
339{
340	int ret;
341
342	ret = tty_standard_install(driver, tty);
343	if (ret)
344		return ret;
 
345
346	tty->driver_data = line;
347
348	return 0;
349}
350
351void line_close(struct tty_struct *tty, struct file * filp)
352{
353	struct line *line = tty->driver_data;
354
355	tty_port_close(&line->port, tty, filp);
356}
357
358void line_hangup(struct tty_struct *tty)
359{
360	struct line *line = tty->driver_data;
361
362	tty_port_hangup(&line->port);
363}
364
365void close_lines(struct line *lines, int nlines)
366{
367	int i;
368
369	for(i = 0; i < nlines; i++)
370		close_chan(&lines[i]);
371}
372
373int setup_one_line(struct line *lines, int n, char *init,
374		   const struct chan_opts *opts, char **error_out)
375{
376	struct line *line = &lines[n];
377	struct tty_driver *driver = line->driver->driver;
378	int err = -EINVAL;
379
380	if (line->port.count) {
 
 
381		*error_out = "Device is already open";
382		goto out;
383	}
384
385	if (!strcmp(init, "none")) {
386		if (line->valid) {
387			line->valid = 0;
388			kfree(line->init_str);
389			tty_unregister_device(driver, n);
390			parse_chan_pair(NULL, line, n, opts, error_out);
391			err = 0;
392		}
393	} else {
394		char *new = kstrdup(init, GFP_KERNEL);
395		if (!new) {
396			*error_out = "Failed to allocate memory";
397			return -ENOMEM;
398		}
399		if (line->valid) {
400			tty_unregister_device(driver, n);
401			kfree(line->init_str);
402		}
403		line->init_str = new;
404		line->valid = 1;
405		err = parse_chan_pair(new, line, n, opts, error_out);
406		if (!err) {
407			struct device *d = tty_port_register_device(&line->port,
408					driver, n, NULL);
409			if (IS_ERR(d)) {
410				*error_out = "Failed to register device";
411				err = PTR_ERR(d);
412				parse_chan_pair(NULL, line, n, opts, error_out);
413			}
414		}
415		if (err) {
416			line->init_str = NULL;
417			line->valid = 0;
418			kfree(new);
419		}
420	}
421out:
 
422	return err;
423}
424
425/*
426 * Common setup code for both startup command line and mconsole initialization.
427 * @lines contains the array (of size @num) to modify;
428 * @init is the setup string;
429 * @error_out is an error string in the case of failure;
430 */
431
432int line_setup(char **conf, unsigned int num, char **def,
433	       char *init, char *name)
434{
435	char *error;
436
437	if (*init == '=') {
438		/*
439		 * We said con=/ssl= instead of con#=, so we are configuring all
440		 * consoles at once.
441		 */
442		*def = init + 1;
443	} else {
444		char *end;
445		unsigned n = simple_strtoul(init, &end, 0);
446
447		if (*end != '=') {
448			error = "Couldn't parse device number";
449			goto out;
450		}
451		if (n >= num) {
452			error = "Device number out of range";
453			goto out;
454		}
455		conf[n] = end + 1;
456	}
457	return 0;
458
459out:
460	printk(KERN_ERR "Failed to set up %s with "
461	       "configuration string \"%s\" : %s\n", name, init, error);
462	return -EINVAL;
463}
464
465int line_config(struct line *lines, unsigned int num, char *str,
466		const struct chan_opts *opts, char **error_out)
467{
468	char *end;
469	int n;
470
471	if (*str == '=') {
472		*error_out = "Can't configure all devices from mconsole";
473		return -EINVAL;
474	}
475
476	n = simple_strtoul(str, &end, 0);
477	if (*end++ != '=') {
478		*error_out = "Couldn't parse device number";
479		return -EINVAL;
480	}
481	if (n >= num) {
482		*error_out = "Device number out of range";
483		return -EINVAL;
484	}
485
486	return setup_one_line(lines, n, end, opts, error_out);
487}
488
489int line_get_config(char *name, struct line *lines, unsigned int num, char *str,
490		    int size, char **error_out)
491{
492	struct line *line;
493	char *end;
494	int dev, n = 0;
495
496	dev = simple_strtoul(name, &end, 0);
497	if ((*end != '\0') || (end == name)) {
498		*error_out = "line_get_config failed to parse device number";
499		return 0;
500	}
501
502	if ((dev < 0) || (dev >= num)) {
503		*error_out = "device number out of range";
504		return 0;
505	}
506
507	line = &lines[dev];
508
 
509	if (!line->valid)
510		CONFIG_CHUNK(str, size, n, "none", 1);
511	else {
512		struct tty_struct *tty = tty_port_tty_get(&line->port);
513		if (tty == NULL) {
514			CONFIG_CHUNK(str, size, n, line->init_str, 1);
515		} else {
516			n = chan_config_string(line, str, size, error_out);
517			tty_kref_put(tty);
518		}
519	}
520
521	return n;
522}
523
524int line_id(char **str, int *start_out, int *end_out)
525{
526	char *end;
527	int n;
528
529	n = simple_strtoul(*str, &end, 0);
530	if ((*end != '\0') || (end == *str))
531		return -1;
532
533	*str = end;
534	*start_out = n;
535	*end_out = n;
536	return n;
537}
538
539int line_remove(struct line *lines, unsigned int num, int n, char **error_out)
540{
541	if (n >= num) {
542		*error_out = "Device number out of range";
543		return -EINVAL;
544	}
545	return setup_one_line(lines, n, "none", NULL, error_out);
546}
547
548int register_lines(struct line_driver *line_driver,
549		   const struct tty_operations *ops,
550		   struct line *lines, int nlines)
551{
552	struct tty_driver *driver = alloc_tty_driver(nlines);
553	int err;
554	int i;
555
556	if (!driver)
557		return -ENOMEM;
558
559	driver->driver_name = line_driver->name;
560	driver->name = line_driver->device_name;
561	driver->major = line_driver->major;
562	driver->minor_start = line_driver->minor_start;
563	driver->type = line_driver->type;
564	driver->subtype = line_driver->subtype;
565	driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
566	driver->init_termios = tty_std_termios;
567	
568	for (i = 0; i < nlines; i++) {
569		tty_port_init(&lines[i].port);
570		lines[i].port.ops = &line_port_ops;
571		spin_lock_init(&lines[i].lock);
 
572		lines[i].driver = line_driver;
573		INIT_LIST_HEAD(&lines[i].chan_list);
574	}
575	tty_set_operations(driver, ops);
576
577	err = tty_register_driver(driver);
578	if (err) {
579		printk(KERN_ERR "register_lines : can't register %s driver\n",
580		       line_driver->name);
581		put_tty_driver(driver);
582		for (i = 0; i < nlines; i++)
583			tty_port_destroy(&lines[i].port);
584		return err;
585	}
586
587	line_driver->driver = driver;
588	mconsole_register_dev(&line_driver->mc);
589	return 0;
590}
591
592static DEFINE_SPINLOCK(winch_handler_lock);
593static LIST_HEAD(winch_handlers);
594
595struct winch {
596	struct list_head list;
597	int fd;
598	int tty_fd;
599	int pid;
600	struct tty_port *port;
601	unsigned long stack;
602	struct work_struct work;
603};
604
605static void __free_winch(struct work_struct *work)
606{
607	struct winch *winch = container_of(work, struct winch, work);
608	um_free_irq(WINCH_IRQ, winch);
609
610	if (winch->pid != -1)
611		os_kill_process(winch->pid, 1);
612	if (winch->stack != 0)
613		free_stack(winch->stack, 0);
614	kfree(winch);
615}
616
617static void free_winch(struct winch *winch)
618{
619	int fd = winch->fd;
620	winch->fd = -1;
621	if (fd != -1)
622		os_close_file(fd);
623	list_del(&winch->list);
624	__free_winch(&winch->work);
625}
626
627static irqreturn_t winch_interrupt(int irq, void *data)
628{
629	struct winch *winch = data;
630	struct tty_struct *tty;
631	struct line *line;
632	int fd = winch->fd;
633	int err;
634	char c;
635	struct pid *pgrp;
636
637	if (fd != -1) {
638		err = generic_read(fd, &c, NULL);
639		if (err < 0) {
640			if (err != -EAGAIN) {
641				winch->fd = -1;
642				list_del(&winch->list);
643				os_close_file(fd);
644				printk(KERN_ERR "winch_interrupt : "
645				       "read failed, errno = %d\n", -err);
646				printk(KERN_ERR "fd %d is losing SIGWINCH "
647				       "support\n", winch->tty_fd);
648				INIT_WORK(&winch->work, __free_winch);
649				schedule_work(&winch->work);
650				return IRQ_HANDLED;
651			}
652			goto out;
653		}
654	}
655	tty = tty_port_tty_get(winch->port);
656	if (tty != NULL) {
657		line = tty->driver_data;
658		if (line != NULL) {
659			chan_window_size(line, &tty->winsize.ws_row,
660					 &tty->winsize.ws_col);
661			pgrp = tty_get_pgrp(tty);
662			if (pgrp)
663				kill_pgrp(pgrp, SIGWINCH, 1);
664			put_pid(pgrp);
665		}
666		tty_kref_put(tty);
667	}
668 out:
669	if (winch->fd != -1)
670		reactivate_fd(winch->fd, WINCH_IRQ);
671	return IRQ_HANDLED;
672}
673
674void register_winch_irq(int fd, int tty_fd, int pid, struct tty_port *port,
675			unsigned long stack)
676{
677	struct winch *winch;
678
679	winch = kmalloc(sizeof(*winch), GFP_KERNEL);
680	if (winch == NULL) {
681		printk(KERN_ERR "register_winch_irq - kmalloc failed\n");
682		goto cleanup;
683	}
684
685	*winch = ((struct winch) { .list  	= LIST_HEAD_INIT(winch->list),
686				   .fd  	= fd,
687				   .tty_fd 	= tty_fd,
688				   .pid  	= pid,
689				   .port 	= port,
690				   .stack	= stack });
691
692	if (um_request_irq(WINCH_IRQ, fd, IRQ_READ, winch_interrupt,
693			   IRQF_SHARED, "winch", winch) < 0) {
 
694		printk(KERN_ERR "register_winch_irq - failed to register "
695		       "IRQ\n");
696		goto out_free;
697	}
698
699	spin_lock(&winch_handler_lock);
700	list_add(&winch->list, &winch_handlers);
701	spin_unlock(&winch_handler_lock);
702
703	return;
704
705 out_free:
706	kfree(winch);
707 cleanup:
708	os_kill_process(pid, 1);
709	os_close_file(fd);
710	if (stack != 0)
711		free_stack(stack, 0);
712}
713
714static void unregister_winch(struct tty_struct *tty)
715{
716	struct list_head *ele, *next;
717	struct winch *winch;
718	struct tty_struct *wtty;
719
720	spin_lock(&winch_handler_lock);
721
722	list_for_each_safe(ele, next, &winch_handlers) {
723		winch = list_entry(ele, struct winch, list);
724		wtty = tty_port_tty_get(winch->port);
725		if (wtty == tty) {
726			free_winch(winch);
727			break;
728		}
729		tty_kref_put(wtty);
730	}
731	spin_unlock(&winch_handler_lock);
732}
733
734static void winch_cleanup(void)
735{
736	struct list_head *ele, *next;
737	struct winch *winch;
738
739	spin_lock(&winch_handler_lock);
740
741	list_for_each_safe(ele, next, &winch_handlers) {
742		winch = list_entry(ele, struct winch, list);
743		free_winch(winch);
744	}
745
746	spin_unlock(&winch_handler_lock);
747}
748__uml_exitcall(winch_cleanup);
749
750char *add_xterm_umid(char *base)
751{
752	char *umid, *title;
753	int len;
754
755	umid = get_umid();
756	if (*umid == '\0')
757		return base;
758
759	len = strlen(base) + strlen(" ()") + strlen(umid) + 1;
760	title = kmalloc(len, GFP_KERNEL);
761	if (title == NULL) {
762		printk(KERN_ERR "Failed to allocate buffer for xterm title\n");
763		return base;
764	}
765
766	snprintf(title, len, "%s (%s)", base, umid);
767	return title;
768}