uart_pty: Added a debug terminal
[simavr] / examples / parts / uart_pty.c
1 /*
2         uart_pty.c
3
4         Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
5
6         This file is part of simavr.
7
8         simavr is free software: you can redistribute it and/or modify
9         it under the terms of the GNU General Public License as published by
10         the Free Software Foundation, either version 3 of the License, or
11         (at your option) any later version.
12
13         simavr is distributed in the hope that it will be useful,
14         but WITHOUT ANY WARRANTY; without even the implied warranty of
15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16         GNU General Public License for more details.
17
18         You should have received a copy of the GNU General Public License
19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <sys/select.h>
23 #include <stdlib.h>
24 #include <pthread.h>
25 #include <string.h>
26 #include <stdio.h>
27 #include <errno.h>
28 #include <unistd.h>
29 #include <pty.h>
30 #include <signal.h>
31
32 #include "uart_pty.h"
33 #include "avr_uart.h"
34 #include "sim_hex.h"
35
36 DEFINE_FIFO(uint8_t,uart_pty_fifo);
37
38 /*
39  * called when a byte is send via the uart on the AVR
40  */
41 static void uart_pty_in_hook(struct avr_irq_t * irq, uint32_t value, void * param)
42 {
43         uart_pty_t * p = (uart_pty_t*)param;
44         //printf("uart_pty_in_hook %02x\n", value);
45         uart_pty_fifo_write(&p->in, value);
46 }
47
48 // try to empty our fifo, the uart_pty_xoff_hook() will be called when
49 // other side is full
50 static void  uart_pty_flush_incoming(uart_pty_t * p)
51 {
52         while (p->xon && !uart_pty_fifo_isempty(&p->out)) {
53                 uint8_t byte = uart_pty_fifo_read(&p->out);
54         //      printf("uart_pty_flush_incoming send %02x\n", byte);
55                 avr_raise_irq(p->irq + IRQ_UART_PTY_BYTE_OUT, byte);
56         }
57 }
58
59 /*
60  * Called when the uart has room in it's input buffer. This is called repeateadly
61  * if necessary, while the xoff is called only when the uart fifo is FULL
62  */
63 static void uart_pty_xon_hook(struct avr_irq_t * irq, uint32_t value, void * param)
64 {
65         uart_pty_t * p = (uart_pty_t*)param;
66         if (!p->xon)
67                 printf("uart_pty_xon_hook\n");
68         p->xon = 1;
69         uart_pty_flush_incoming(p);
70 }
71
72 /*
73  * Called when the uart ran out of room in it's input buffer
74  */
75 static void uart_pty_xoff_hook(struct avr_irq_t * irq, uint32_t value, void * param)
76 {
77         uart_pty_t * p = (uart_pty_t*)param;
78         if (p->xon)
79                 printf("uart_pty_xoff_hook\n");
80         p->xon = 0;
81 }
82
83 static void * uart_pty_thread(void * param)
84 {
85         uart_pty_t * p = (uart_pty_t*)param;
86
87         while (1) {
88                 fd_set read_set, write_set;
89                 int max = p->s + 1;
90                 FD_ZERO(&read_set);
91                 FD_ZERO(&write_set);
92
93                 // read more only if buffer was flushed
94                 if (p->buffer_len == p->buffer_done)
95                         FD_SET(p->s, &read_set);
96                 if (!uart_pty_fifo_isempty(&p->in))
97                         FD_SET(p->s, &write_set);
98
99                 struct timeval timo = { 0, 500 };       // short, but not too short interval
100                 int ret = select(max, &read_set, &write_set, NULL, &timo);
101
102                 if (!ret)
103                         continue;
104                 if (ret < 0)
105                         break;
106
107                 if (FD_ISSET(p->s, &read_set)) {
108                         ssize_t r = read(p->s, p->buffer, sizeof(p->buffer)-1);
109                         p->buffer_len = r;
110                         p->buffer_done = 0;
111                 //      hdump("pty recv", p->buffer, r);
112                 }
113                 if (p->buffer_done < p->buffer_len) {
114                         // write them in fifo
115                         while (p->buffer_done < p->buffer_len && !uart_pty_fifo_isfull(&p->out))
116                                 uart_pty_fifo_write(&p->out, p->buffer[p->buffer_done++]);
117                 }
118                 if (FD_ISSET(p->s, &write_set)) {
119                         uint8_t buffer[512];
120                         // write them in fifo
121                         uint8_t * dst = buffer;
122                         while (!uart_pty_fifo_isempty(&p->in) && dst < (buffer+sizeof(buffer)))
123                                 *dst++ = uart_pty_fifo_read(&p->in);
124                         size_t len = dst - buffer;
125                         size_t r = write(p->s, buffer, len);
126                 //      hdump("pty send", buffer, r);
127                 }
128         //      uart_pty_flush_incoming(p);
129         }
130         return NULL;
131 }
132
133 static const char * irq_names[IRQ_UART_PTY_COUNT] = {
134         [IRQ_UART_PTY_BYTE_IN] = "8<uart_pty.in",
135         [IRQ_UART_PTY_BYTE_OUT] = "8>uart_pty.out",
136 };
137
138 void uart_pty_init(struct avr_t * avr, uart_pty_t * p)
139 {
140         p->avr = avr;
141         p->irq = avr_alloc_irq(&avr->irq_pool, 0, IRQ_UART_PTY_COUNT, irq_names);
142         avr_irq_register_notify(p->irq + IRQ_UART_PTY_BYTE_IN, uart_pty_in_hook, p);
143
144         int m, s;
145
146         if (openpty(&m, &s, p->slavename, NULL, NULL) < 0) {
147                 fprintf(stderr, "%s: Can't create pty: %s", __FUNCTION__, strerror(errno));
148                 return ;
149         }
150         p->s = m;
151
152         printf("uart_pty_init bridge on port *** %s ***\n", p->slavename);
153
154         pthread_create(&p->thread, NULL, uart_pty_thread, p);
155
156 }
157
158 void uart_pty_stop(uart_pty_t * p)
159 {
160         puts(__func__);
161         pthread_kill(p->thread, SIGINT);
162         close(p->s);
163         void * ret;
164         pthread_join(p->thread, &ret);
165 }
166
167 void uart_pty_connect(uart_pty_t * p, char uart)
168 {
169         // disable the stdio dump, as we are sending binary there
170         uint32_t f = 0;
171         avr_ioctl(p->avr, AVR_IOCTL_UART_GET_FLAGS(uart), &f);
172         f &= ~AVR_UART_FLAG_STDIO;
173         avr_ioctl(p->avr, AVR_IOCTL_UART_SET_FLAGS(uart), &f);
174
175         avr_irq_t * src = avr_io_getirq(p->avr, AVR_IOCTL_UART_GETIRQ(uart), UART_IRQ_OUTPUT);
176         avr_irq_t * dst = avr_io_getirq(p->avr, AVR_IOCTL_UART_GETIRQ(uart), UART_IRQ_INPUT);
177         avr_irq_t * xon = avr_io_getirq(p->avr, AVR_IOCTL_UART_GETIRQ(uart), UART_IRQ_OUT_XON);
178         avr_irq_t * xoff = avr_io_getirq(p->avr, AVR_IOCTL_UART_GETIRQ(uart), UART_IRQ_OUT_XOFF);
179         if (src && dst) {
180                 avr_connect_irq(src, p->irq + IRQ_UART_PTY_BYTE_IN);
181                 avr_connect_irq(p->irq + IRQ_UART_PTY_BYTE_OUT, dst);
182         }
183         if (xon)
184                 avr_irq_register_notify(xon, uart_pty_xon_hook, p);
185         if (xoff)
186                 avr_irq_register_notify(xoff, uart_pty_xoff_hook, p);
187
188         char link[128];
189         sprintf(link, "/tmp/simavr-uart%c", uart);
190         unlink(link);
191         if (symlink(p->slavename, link) != 0) {
192                 fprintf(stderr, "WARN %s: Can't create %s: %s", __func__, link, strerror(errno));
193         } else {
194                 printf("%s: %s now points to %s\n", __func__, link, p->slavename);
195         }
196         if (getenv("SIMAVR_UART_XTERM")) {
197                 char cmd[256];
198                 sprintf(cmd, "nohup xterm -e picocom -b 115200 %s >/dev/null 2>&1 &", p->slavename);
199                 system(cmd);
200         }
201 }
202