]> git.proxmox.com Git - mirror_qemu.git/blame - hw/serial.c
fix typo in configure --help
[mirror_qemu.git] / hw / serial.c
CommitLineData
80cabfad 1/*
81174dae 2 * QEMU 16550A UART emulation
5fafdf24 3 *
80cabfad 4 * Copyright (c) 2003-2004 Fabrice Bellard
81174dae 5 * Copyright (c) 2008 Citrix Systems, Inc.
5fafdf24 6 *
80cabfad
FB
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
87ecb68b
PB
25#include "hw.h"
26#include "qemu-char.h"
27#include "isa.h"
28#include "pc.h"
6936bfe5 29#include "qemu-timer.h"
80cabfad
FB
30
31//#define DEBUG_SERIAL
32
33#define UART_LCR_DLAB 0x80 /* Divisor latch access bit */
34
35#define UART_IER_MSI 0x08 /* Enable Modem status interrupt */
36#define UART_IER_RLSI 0x04 /* Enable receiver line status interrupt */
37#define UART_IER_THRI 0x02 /* Enable Transmitter holding register int. */
38#define UART_IER_RDI 0x01 /* Enable receiver data interrupt */
39
40#define UART_IIR_NO_INT 0x01 /* No interrupts pending */
41#define UART_IIR_ID 0x06 /* Mask for the interrupt ID */
42
43#define UART_IIR_MSI 0x00 /* Modem status interrupt */
44#define UART_IIR_THRI 0x02 /* Transmitter holding register empty */
45#define UART_IIR_RDI 0x04 /* Receiver data interrupt */
46#define UART_IIR_RLSI 0x06 /* Receiver line status interrupt */
81174dae
AL
47#define UART_IIR_CTI 0x0C /* Character Timeout Indication */
48
49#define UART_IIR_FENF 0x80 /* Fifo enabled, but not functionning */
50#define UART_IIR_FE 0xC0 /* Fifo enabled */
80cabfad
FB
51
52/*
53 * These are the definitions for the Modem Control Register
54 */
55#define UART_MCR_LOOP 0x10 /* Enable loopback test mode */
56#define UART_MCR_OUT2 0x08 /* Out2 complement */
57#define UART_MCR_OUT1 0x04 /* Out1 complement */
58#define UART_MCR_RTS 0x02 /* RTS complement */
59#define UART_MCR_DTR 0x01 /* DTR complement */
60
61/*
62 * These are the definitions for the Modem Status Register
63 */
64#define UART_MSR_DCD 0x80 /* Data Carrier Detect */
65#define UART_MSR_RI 0x40 /* Ring Indicator */
66#define UART_MSR_DSR 0x20 /* Data Set Ready */
67#define UART_MSR_CTS 0x10 /* Clear to Send */
68#define UART_MSR_DDCD 0x08 /* Delta DCD */
69#define UART_MSR_TERI 0x04 /* Trailing edge ring indicator */
70#define UART_MSR_DDSR 0x02 /* Delta DSR */
71#define UART_MSR_DCTS 0x01 /* Delta CTS */
72#define UART_MSR_ANY_DELTA 0x0F /* Any of the delta bits! */
73
74#define UART_LSR_TEMT 0x40 /* Transmitter empty */
75#define UART_LSR_THRE 0x20 /* Transmit-hold-register empty */
76#define UART_LSR_BI 0x10 /* Break interrupt indicator */
77#define UART_LSR_FE 0x08 /* Frame error indicator */
78#define UART_LSR_PE 0x04 /* Parity error indicator */
79#define UART_LSR_OE 0x02 /* Overrun error indicator */
80#define UART_LSR_DR 0x01 /* Receiver data ready */
81174dae 81#define UART_LSR_INT_ANY 0x1E /* Any of the lsr-interrupt-triggering status bits */
80cabfad 82
81174dae
AL
83/* Interrupt trigger levels. The byte-counts are for 16550A - in newer UARTs the byte-count for each ITL is higher. */
84
85#define UART_FCR_ITL_1 0x00 /* 1 byte ITL */
86#define UART_FCR_ITL_2 0x40 /* 4 bytes ITL */
87#define UART_FCR_ITL_3 0x80 /* 8 bytes ITL */
88#define UART_FCR_ITL_4 0xC0 /* 14 bytes ITL */
89
90#define UART_FCR_DMS 0x08 /* DMA Mode Select */
91#define UART_FCR_XFR 0x04 /* XMIT Fifo Reset */
92#define UART_FCR_RFR 0x02 /* RCVR Fifo Reset */
93#define UART_FCR_FE 0x01 /* FIFO Enable */
94
95#define UART_FIFO_LENGTH 16 /* 16550A Fifo Length */
96
97#define XMIT_FIFO 0
98#define RECV_FIFO 1
99#define MAX_XMIT_RETRY 4
100
101struct SerialFIFO {
102 uint8_t data[UART_FIFO_LENGTH];
103 uint8_t count;
104 uint8_t itl; /* Interrupt Trigger Level */
105 uint8_t tail;
106 uint8_t head;
107} typedef SerialFIFO;
6936bfe5 108
b41a2cd1 109struct SerialState {
508d92d0 110 uint16_t divider;
80cabfad 111 uint8_t rbr; /* receive register */
81174dae
AL
112 uint8_t thr; /* transmit holding register */
113 uint8_t tsr; /* transmit shift register */
80cabfad
FB
114 uint8_t ier;
115 uint8_t iir; /* read only */
116 uint8_t lcr;
117 uint8_t mcr;
118 uint8_t lsr; /* read only */
3e749fe1 119 uint8_t msr; /* read only */
80cabfad 120 uint8_t scr;
81174dae 121 uint8_t fcr;
747791f1
JQ
122 uint8_t fcr_vmstate; /* we can't write directly this value
123 it has side effects */
80cabfad
FB
124 /* NOTE: this hidden state is necessary for tx irq generation as
125 it can be reset while reading iir */
126 int thr_ipending;
d537cf6c 127 qemu_irq irq;
82c643ff 128 CharDriverState *chr;
f8d179e3 129 int last_break_enable;
e5d13e2f 130 int it_shift;
b6cd0ea1 131 int baudbase;
81174dae
AL
132 int tsr_retry;
133
134 uint64_t last_xmit_ts; /* Time when the last byte was successfully sent out of the tsr */
135 SerialFIFO recv_fifo;
136 SerialFIFO xmit_fifo;
137
138 struct QEMUTimer *fifo_timeout_timer;
139 int timeout_ipending; /* timeout interrupt pending state */
140 struct QEMUTimer *transmit_timer;
141
142
143 uint64_t char_transmit_time; /* time to transmit a char in ticks*/
144 int poll_msl;
145
146 struct QEMUTimer *modem_status_poll;
b41a2cd1 147};
80cabfad 148
81174dae 149static void serial_receive1(void *opaque, const uint8_t *buf, int size);
b2a5160c 150
81174dae 151static void fifo_clear(SerialState *s, int fifo)
80cabfad 152{
81174dae
AL
153 SerialFIFO *f = (fifo) ? &s->recv_fifo : &s->xmit_fifo;
154 memset(f->data, 0, UART_FIFO_LENGTH);
155 f->count = 0;
156 f->head = 0;
157 f->tail = 0;
80cabfad
FB
158}
159
81174dae 160static int fifo_put(SerialState *s, int fifo, uint8_t chr)
6936bfe5 161{
81174dae 162 SerialFIFO *f = (fifo) ? &s->recv_fifo : &s->xmit_fifo;
6936bfe5 163
81174dae 164 f->data[f->head++] = chr;
6936bfe5 165
81174dae
AL
166 if (f->head == UART_FIFO_LENGTH)
167 f->head = 0;
168 f->count++;
169
170 return 1;
171}
172
173static uint8_t fifo_get(SerialState *s, int fifo)
174{
175 SerialFIFO *f = (fifo) ? &s->recv_fifo : &s->xmit_fifo;
176 uint8_t c;
177
178 if(f->count == 0)
179 return 0;
180
181 c = f->data[f->tail++];
182 if (f->tail == UART_FIFO_LENGTH)
183 f->tail = 0;
184 f->count--;
185
186 return c;
187}
6936bfe5 188
81174dae
AL
189static void serial_update_irq(SerialState *s)
190{
191 uint8_t tmp_iir = UART_IIR_NO_INT;
192
81174dae
AL
193 if ((s->ier & UART_IER_RLSI) && (s->lsr & UART_LSR_INT_ANY)) {
194 tmp_iir = UART_IIR_RLSI;
5628a626 195 } else if ((s->ier & UART_IER_RDI) && s->timeout_ipending) {
c9a33054
AZ
196 /* Note that(s->ier & UART_IER_RDI) can mask this interrupt,
197 * this is not in the specification but is observed on existing
198 * hardware. */
81174dae
AL
199 tmp_iir = UART_IIR_CTI;
200 } else if ((s->ier & UART_IER_RDI) && (s->lsr & UART_LSR_DR)) {
201 if (!(s->fcr & UART_FCR_FE)) {
202 tmp_iir = UART_IIR_RDI;
203 } else if (s->recv_fifo.count >= s->recv_fifo.itl) {
204 tmp_iir = UART_IIR_RDI;
205 }
206 } else if ((s->ier & UART_IER_THRI) && s->thr_ipending) {
207 tmp_iir = UART_IIR_THRI;
208 } else if ((s->ier & UART_IER_MSI) && (s->msr & UART_MSR_ANY_DELTA)) {
209 tmp_iir = UART_IIR_MSI;
210 }
211
212 s->iir = tmp_iir | (s->iir & 0xF0);
213
214 if (tmp_iir != UART_IIR_NO_INT) {
215 qemu_irq_raise(s->irq);
216 } else {
217 qemu_irq_lower(s->irq);
6936bfe5 218 }
6936bfe5
AJ
219}
220
f8d179e3
FB
221static void serial_update_parameters(SerialState *s)
222{
81174dae 223 int speed, parity, data_bits, stop_bits, frame_size;
2122c51a 224 QEMUSerialSetParams ssp;
f8d179e3 225
81174dae
AL
226 if (s->divider == 0)
227 return;
228
229 frame_size = 1;
f8d179e3
FB
230 if (s->lcr & 0x08) {
231 if (s->lcr & 0x10)
232 parity = 'E';
233 else
234 parity = 'O';
235 } else {
236 parity = 'N';
81174dae 237 frame_size = 0;
f8d179e3 238 }
5fafdf24 239 if (s->lcr & 0x04)
f8d179e3
FB
240 stop_bits = 2;
241 else
242 stop_bits = 1;
81174dae 243
f8d179e3 244 data_bits = (s->lcr & 0x03) + 5;
81174dae 245 frame_size += data_bits + stop_bits;
b6cd0ea1 246 speed = s->baudbase / s->divider;
2122c51a
FB
247 ssp.speed = speed;
248 ssp.parity = parity;
249 ssp.data_bits = data_bits;
250 ssp.stop_bits = stop_bits;
6ee093c9 251 s->char_transmit_time = (get_ticks_per_sec() / speed) * frame_size;
2122c51a
FB
252 qemu_chr_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_PARAMS, &ssp);
253#if 0
5fafdf24 254 printf("speed=%d parity=%c data=%d stop=%d\n",
f8d179e3
FB
255 speed, parity, data_bits, stop_bits);
256#endif
257}
258
81174dae
AL
259static void serial_update_msl(SerialState *s)
260{
261 uint8_t omsr;
262 int flags;
263
264 qemu_del_timer(s->modem_status_poll);
265
266 if (qemu_chr_ioctl(s->chr,CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) {
267 s->poll_msl = -1;
268 return;
269 }
270
271 omsr = s->msr;
272
273 s->msr = (flags & CHR_TIOCM_CTS) ? s->msr | UART_MSR_CTS : s->msr & ~UART_MSR_CTS;
274 s->msr = (flags & CHR_TIOCM_DSR) ? s->msr | UART_MSR_DSR : s->msr & ~UART_MSR_DSR;
275 s->msr = (flags & CHR_TIOCM_CAR) ? s->msr | UART_MSR_DCD : s->msr & ~UART_MSR_DCD;
276 s->msr = (flags & CHR_TIOCM_RI) ? s->msr | UART_MSR_RI : s->msr & ~UART_MSR_RI;
277
278 if (s->msr != omsr) {
279 /* Set delta bits */
280 s->msr = s->msr | ((s->msr >> 4) ^ (omsr >> 4));
281 /* UART_MSR_TERI only if change was from 1 -> 0 */
282 if ((s->msr & UART_MSR_TERI) && !(omsr & UART_MSR_RI))
283 s->msr &= ~UART_MSR_TERI;
284 serial_update_irq(s);
285 }
286
287 /* The real 16550A apparently has a 250ns response latency to line status changes.
288 We'll be lazy and poll only every 10ms, and only poll it at all if MSI interrupts are turned on */
289
290 if (s->poll_msl)
6ee093c9 291 qemu_mod_timer(s->modem_status_poll, qemu_get_clock(vm_clock) + get_ticks_per_sec() / 100);
81174dae
AL
292}
293
294static void serial_xmit(void *opaque)
295{
296 SerialState *s = opaque;
297 uint64_t new_xmit_ts = qemu_get_clock(vm_clock);
298
299 if (s->tsr_retry <= 0) {
300 if (s->fcr & UART_FCR_FE) {
301 s->tsr = fifo_get(s,XMIT_FIFO);
302 if (!s->xmit_fifo.count)
303 s->lsr |= UART_LSR_THRE;
304 } else {
305 s->tsr = s->thr;
306 s->lsr |= UART_LSR_THRE;
307 }
308 }
309
310 if (s->mcr & UART_MCR_LOOP) {
311 /* in loopback mode, say that we just received a char */
312 serial_receive1(s, &s->tsr, 1);
313 } else if (qemu_chr_write(s->chr, &s->tsr, 1) != 1) {
314 if ((s->tsr_retry > 0) && (s->tsr_retry <= MAX_XMIT_RETRY)) {
315 s->tsr_retry++;
316 qemu_mod_timer(s->transmit_timer, new_xmit_ts + s->char_transmit_time);
317 return;
318 } else if (s->poll_msl < 0) {
319 /* If we exceed MAX_XMIT_RETRY and the backend is not a real serial port, then
320 drop any further failed writes instantly, until we get one that goes through.
321 This is to prevent guests that log to unconnected pipes or pty's from stalling. */
322 s->tsr_retry = -1;
323 }
324 }
325 else {
326 s->tsr_retry = 0;
327 }
328
329 s->last_xmit_ts = qemu_get_clock(vm_clock);
330 if (!(s->lsr & UART_LSR_THRE))
331 qemu_mod_timer(s->transmit_timer, s->last_xmit_ts + s->char_transmit_time);
332
333 if (s->lsr & UART_LSR_THRE) {
334 s->lsr |= UART_LSR_TEMT;
335 s->thr_ipending = 1;
336 serial_update_irq(s);
337 }
338}
339
340
b41a2cd1 341static void serial_ioport_write(void *opaque, uint32_t addr, uint32_t val)
80cabfad 342{
b41a2cd1 343 SerialState *s = opaque;
3b46e624 344
80cabfad
FB
345 addr &= 7;
346#ifdef DEBUG_SERIAL
347 printf("serial: write addr=0x%02x val=0x%02x\n", addr, val);
348#endif
349 switch(addr) {
350 default:
351 case 0:
352 if (s->lcr & UART_LCR_DLAB) {
353 s->divider = (s->divider & 0xff00) | val;
f8d179e3 354 serial_update_parameters(s);
80cabfad 355 } else {
81174dae
AL
356 s->thr = (uint8_t) val;
357 if(s->fcr & UART_FCR_FE) {
358 fifo_put(s, XMIT_FIFO, s->thr);
80cabfad 359 s->thr_ipending = 0;
81174dae 360 s->lsr &= ~UART_LSR_TEMT;
80cabfad 361 s->lsr &= ~UART_LSR_THRE;
b41a2cd1 362 serial_update_irq(s);
6936bfe5 363 } else {
81174dae
AL
364 s->thr_ipending = 0;
365 s->lsr &= ~UART_LSR_THRE;
366 serial_update_irq(s);
6936bfe5 367 }
81174dae 368 serial_xmit(s);
80cabfad
FB
369 }
370 break;
371 case 1:
372 if (s->lcr & UART_LCR_DLAB) {
373 s->divider = (s->divider & 0x00ff) | (val << 8);
f8d179e3 374 serial_update_parameters(s);
80cabfad 375 } else {
60e336db 376 s->ier = val & 0x0f;
81174dae
AL
377 /* If the backend device is a real serial port, turn polling of the modem
378 status lines on physical port on or off depending on UART_IER_MSI state */
379 if (s->poll_msl >= 0) {
380 if (s->ier & UART_IER_MSI) {
381 s->poll_msl = 1;
382 serial_update_msl(s);
383 } else {
384 qemu_del_timer(s->modem_status_poll);
385 s->poll_msl = 0;
386 }
387 }
60e336db
FB
388 if (s->lsr & UART_LSR_THRE) {
389 s->thr_ipending = 1;
81174dae 390 serial_update_irq(s);
60e336db 391 }
80cabfad
FB
392 }
393 break;
394 case 2:
81174dae
AL
395 val = val & 0xFF;
396
397 if (s->fcr == val)
398 break;
399
400 /* Did the enable/disable flag change? If so, make sure FIFOs get flushed */
401 if ((val ^ s->fcr) & UART_FCR_FE)
402 val |= UART_FCR_XFR | UART_FCR_RFR;
403
404 /* FIFO clear */
405
406 if (val & UART_FCR_RFR) {
407 qemu_del_timer(s->fifo_timeout_timer);
408 s->timeout_ipending=0;
409 fifo_clear(s,RECV_FIFO);
410 }
411
412 if (val & UART_FCR_XFR) {
413 fifo_clear(s,XMIT_FIFO);
414 }
415
416 if (val & UART_FCR_FE) {
417 s->iir |= UART_IIR_FE;
418 /* Set RECV_FIFO trigger Level */
419 switch (val & 0xC0) {
420 case UART_FCR_ITL_1:
421 s->recv_fifo.itl = 1;
422 break;
423 case UART_FCR_ITL_2:
424 s->recv_fifo.itl = 4;
425 break;
426 case UART_FCR_ITL_3:
427 s->recv_fifo.itl = 8;
428 break;
429 case UART_FCR_ITL_4:
430 s->recv_fifo.itl = 14;
431 break;
432 }
433 } else
434 s->iir &= ~UART_IIR_FE;
435
436 /* Set fcr - or at least the bits in it that are supposed to "stick" */
437 s->fcr = val & 0xC9;
438 serial_update_irq(s);
80cabfad
FB
439 break;
440 case 3:
f8d179e3
FB
441 {
442 int break_enable;
443 s->lcr = val;
444 serial_update_parameters(s);
445 break_enable = (val >> 6) & 1;
446 if (break_enable != s->last_break_enable) {
447 s->last_break_enable = break_enable;
5fafdf24 448 qemu_chr_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_BREAK,
2122c51a 449 &break_enable);
f8d179e3
FB
450 }
451 }
80cabfad
FB
452 break;
453 case 4:
81174dae
AL
454 {
455 int flags;
456 int old_mcr = s->mcr;
457 s->mcr = val & 0x1f;
458 if (val & UART_MCR_LOOP)
459 break;
460
461 if (s->poll_msl >= 0 && old_mcr != s->mcr) {
462
463 qemu_chr_ioctl(s->chr,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
464
465 flags &= ~(CHR_TIOCM_RTS | CHR_TIOCM_DTR);
466
467 if (val & UART_MCR_RTS)
468 flags |= CHR_TIOCM_RTS;
469 if (val & UART_MCR_DTR)
470 flags |= CHR_TIOCM_DTR;
471
472 qemu_chr_ioctl(s->chr,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
473 /* Update the modem status after a one-character-send wait-time, since there may be a response
474 from the device/computer at the other end of the serial line */
475 qemu_mod_timer(s->modem_status_poll, qemu_get_clock(vm_clock) + s->char_transmit_time);
476 }
477 }
80cabfad
FB
478 break;
479 case 5:
480 break;
481 case 6:
80cabfad
FB
482 break;
483 case 7:
484 s->scr = val;
485 break;
486 }
487}
488
b41a2cd1 489static uint32_t serial_ioport_read(void *opaque, uint32_t addr)
80cabfad 490{
b41a2cd1 491 SerialState *s = opaque;
80cabfad
FB
492 uint32_t ret;
493
494 addr &= 7;
495 switch(addr) {
496 default:
497 case 0:
498 if (s->lcr & UART_LCR_DLAB) {
5fafdf24 499 ret = s->divider & 0xff;
80cabfad 500 } else {
81174dae
AL
501 if(s->fcr & UART_FCR_FE) {
502 ret = fifo_get(s,RECV_FIFO);
503 if (s->recv_fifo.count == 0)
504 s->lsr &= ~(UART_LSR_DR | UART_LSR_BI);
505 else
506 qemu_mod_timer(s->fifo_timeout_timer, qemu_get_clock (vm_clock) + s->char_transmit_time * 4);
507 s->timeout_ipending = 0;
508 } else {
509 ret = s->rbr;
510 s->lsr &= ~(UART_LSR_DR | UART_LSR_BI);
511 }
b41a2cd1 512 serial_update_irq(s);
b2a5160c
AZ
513 if (!(s->mcr & UART_MCR_LOOP)) {
514 /* in loopback mode, don't receive any data */
515 qemu_chr_accept_input(s->chr);
516 }
80cabfad
FB
517 }
518 break;
519 case 1:
520 if (s->lcr & UART_LCR_DLAB) {
521 ret = (s->divider >> 8) & 0xff;
522 } else {
523 ret = s->ier;
524 }
525 break;
526 case 2:
527 ret = s->iir;
80cabfad 528 s->thr_ipending = 0;
b41a2cd1 529 serial_update_irq(s);
80cabfad
FB
530 break;
531 case 3:
532 ret = s->lcr;
533 break;
534 case 4:
535 ret = s->mcr;
536 break;
537 case 5:
538 ret = s->lsr;
81174dae
AL
539 /* Clear break interrupt */
540 if (s->lsr & UART_LSR_BI) {
541 s->lsr &= ~UART_LSR_BI;
542 serial_update_irq(s);
543 }
80cabfad
FB
544 break;
545 case 6:
546 if (s->mcr & UART_MCR_LOOP) {
547 /* in loopback, the modem output pins are connected to the
548 inputs */
549 ret = (s->mcr & 0x0c) << 4;
550 ret |= (s->mcr & 0x02) << 3;
551 ret |= (s->mcr & 0x01) << 5;
552 } else {
81174dae
AL
553 if (s->poll_msl >= 0)
554 serial_update_msl(s);
80cabfad 555 ret = s->msr;
81174dae
AL
556 /* Clear delta bits & msr int after read, if they were set */
557 if (s->msr & UART_MSR_ANY_DELTA) {
558 s->msr &= 0xF0;
559 serial_update_irq(s);
560 }
80cabfad
FB
561 }
562 break;
563 case 7:
564 ret = s->scr;
565 break;
566 }
567#ifdef DEBUG_SERIAL
568 printf("serial: read addr=0x%02x val=0x%02x\n", addr, ret);
569#endif
570 return ret;
571}
572
82c643ff 573static int serial_can_receive(SerialState *s)
80cabfad 574{
81174dae
AL
575 if(s->fcr & UART_FCR_FE) {
576 if(s->recv_fifo.count < UART_FIFO_LENGTH)
577 /* Advertise (fifo.itl - fifo.count) bytes when count < ITL, and 1 if above. If UART_FIFO_LENGTH - fifo.count is
578 advertised the effect will be to almost always fill the fifo completely before the guest has a chance to respond,
579 effectively overriding the ITL that the guest has set. */
580 return (s->recv_fifo.count <= s->recv_fifo.itl) ? s->recv_fifo.itl - s->recv_fifo.count : 1;
581 else
582 return 0;
583 } else {
80cabfad 584 return !(s->lsr & UART_LSR_DR);
81174dae 585 }
80cabfad
FB
586}
587
82c643ff 588static void serial_receive_break(SerialState *s)
80cabfad 589{
80cabfad 590 s->rbr = 0;
40ff1624
JW
591 /* When the LSR_DR is set a null byte is pushed into the fifo */
592 fifo_put(s, RECV_FIFO, '\0');
80cabfad 593 s->lsr |= UART_LSR_BI | UART_LSR_DR;
b41a2cd1 594 serial_update_irq(s);
80cabfad
FB
595}
596
81174dae
AL
597/* There's data in recv_fifo and s->rbr has not been read for 4 char transmit times */
598static void fifo_timeout_int (void *opaque) {
599 SerialState *s = opaque;
600 if (s->recv_fifo.count) {
601 s->timeout_ipending = 1;
602 serial_update_irq(s);
603 }
604}
605
b41a2cd1 606static int serial_can_receive1(void *opaque)
80cabfad 607{
b41a2cd1
FB
608 SerialState *s = opaque;
609 return serial_can_receive(s);
610}
611
612static void serial_receive1(void *opaque, const uint8_t *buf, int size)
613{
614 SerialState *s = opaque;
81174dae
AL
615 if(s->fcr & UART_FCR_FE) {
616 int i;
617 for (i = 0; i < size; i++) {
618 fifo_put(s, RECV_FIFO, buf[i]);
619 }
620 s->lsr |= UART_LSR_DR;
621 /* call the timeout receive callback in 4 char transmit time */
622 qemu_mod_timer(s->fifo_timeout_timer, qemu_get_clock (vm_clock) + s->char_transmit_time * 4);
623 } else {
624 s->rbr = buf[0];
625 s->lsr |= UART_LSR_DR;
626 }
627 serial_update_irq(s);
b41a2cd1 628}
80cabfad 629
82c643ff
FB
630static void serial_event(void *opaque, int event)
631{
632 SerialState *s = opaque;
81174dae
AL
633#ifdef DEBUG_SERIAL
634 printf("serial: event %x\n", event);
635#endif
82c643ff
FB
636 if (event == CHR_EVENT_BREAK)
637 serial_receive_break(s);
638}
639
747791f1 640static void serial_pre_save(const void *opaque)
8738a8d0 641{
747791f1
JQ
642 SerialState *s = (void *)opaque;
643 s->fcr_vmstate = s->fcr;
8738a8d0
FB
644}
645
747791f1 646static int serial_pre_load(void *opaque)
8738a8d0
FB
647{
648 SerialState *s = opaque;
747791f1
JQ
649 s->fcr_vmstate = 0;
650 return 0;
651}
8738a8d0 652
747791f1
JQ
653static int serial_post_load(void *opaque)
654{
655 SerialState *s = opaque;
81174dae
AL
656
657 /* Initialize fcr via setter to perform essential side-effects */
747791f1 658 serial_ioport_write(s, 0x02, s->fcr_vmstate);
8738a8d0
FB
659 return 0;
660}
661
747791f1
JQ
662static const VMStateDescription vmstate_serial = {
663 .name = "serial",
664 .version_id = 3,
665 .minimum_version_id = 2,
666 .pre_save = serial_pre_save,
667 .pre_load = serial_pre_load,
668 .post_load = serial_post_load,
669 .fields = (VMStateField []) {
670 VMSTATE_UINT16_V(divider, SerialState, 2),
671 VMSTATE_UINT8(rbr, SerialState),
672 VMSTATE_UINT8(ier, SerialState),
673 VMSTATE_UINT8(iir, SerialState),
674 VMSTATE_UINT8(lcr, SerialState),
675 VMSTATE_UINT8(mcr, SerialState),
676 VMSTATE_UINT8(lsr, SerialState),
677 VMSTATE_UINT8(msr, SerialState),
678 VMSTATE_UINT8(scr, SerialState),
679 VMSTATE_UINT8_V(fcr_vmstate, SerialState, 3),
680 VMSTATE_END_OF_LIST()
681 }
682};
683
b2a5160c
AZ
684static void serial_reset(void *opaque)
685{
686 SerialState *s = opaque;
687
b2a5160c
AZ
688 s->rbr = 0;
689 s->ier = 0;
690 s->iir = UART_IIR_NO_INT;
691 s->lcr = 0;
b2a5160c
AZ
692 s->lsr = UART_LSR_TEMT | UART_LSR_THRE;
693 s->msr = UART_MSR_DCD | UART_MSR_DSR | UART_MSR_CTS;
81174dae
AL
694 /* Default to 9600 baud, no parity, one stop bit */
695 s->divider = 0x0C;
696 s->mcr = UART_MCR_OUT2;
b2a5160c 697 s->scr = 0;
81174dae 698 s->tsr_retry = 0;
6ee093c9 699 s->char_transmit_time = (get_ticks_per_sec() / 9600) * 9;
81174dae
AL
700 s->poll_msl = 0;
701
702 fifo_clear(s,RECV_FIFO);
703 fifo_clear(s,XMIT_FIFO);
704
705 s->last_xmit_ts = qemu_get_clock(vm_clock);
b2a5160c
AZ
706
707 s->thr_ipending = 0;
708 s->last_break_enable = 0;
709 qemu_irq_lower(s->irq);
710}
711
81174dae
AL
712static void serial_init_core(SerialState *s, qemu_irq irq, int baudbase,
713 CharDriverState *chr)
714{
387f4a5a
AJ
715 if (!chr) {
716 fprintf(stderr, "Can't create serial device, empty char device\n");
717 exit(1);
718 }
719
81174dae
AL
720 s->irq = irq;
721 s->baudbase = baudbase;
387f4a5a 722 s->chr = chr;
81174dae
AL
723
724 s->modem_status_poll = qemu_new_timer(vm_clock, (QEMUTimerCB *) serial_update_msl, s);
725
726 s->fifo_timeout_timer = qemu_new_timer(vm_clock, (QEMUTimerCB *) fifo_timeout_int, s);
727 s->transmit_timer = qemu_new_timer(vm_clock, (QEMUTimerCB *) serial_xmit, s);
728
a08d4367 729 qemu_register_reset(serial_reset, s);
81174dae
AL
730 serial_reset(s);
731
b47543c4
AJ
732 qemu_chr_add_handlers(s->chr, serial_can_receive1, serial_receive1,
733 serial_event, s);
81174dae
AL
734}
735
b41a2cd1 736/* If fd is zero, it means that the serial device uses the console */
b6cd0ea1
AJ
737SerialState *serial_init(int base, qemu_irq irq, int baudbase,
738 CharDriverState *chr)
b41a2cd1
FB
739{
740 SerialState *s;
741
742 s = qemu_mallocz(sizeof(SerialState));
6936bfe5 743
81174dae 744 serial_init_core(s, irq, baudbase, chr);
b41a2cd1 745
747791f1 746 vmstate_register(base, &vmstate_serial, s);
8738a8d0 747
b41a2cd1
FB
748 register_ioport_write(base, 8, 1, serial_ioport_write, s);
749 register_ioport_read(base, 8, 1, serial_ioport_read, s);
b41a2cd1 750 return s;
80cabfad 751}
e5d13e2f
FB
752
753/* Memory mapped interface */
802670e6 754static uint32_t serial_mm_readb(void *opaque, target_phys_addr_t addr)
e5d13e2f
FB
755{
756 SerialState *s = opaque;
757
8da3ff18 758 return serial_ioport_read(s, addr >> s->it_shift) & 0xFF;
e5d13e2f
FB
759}
760
802670e6
BS
761static void serial_mm_writeb(void *opaque, target_phys_addr_t addr,
762 uint32_t value)
e5d13e2f
FB
763{
764 SerialState *s = opaque;
765
8da3ff18 766 serial_ioport_write(s, addr >> s->it_shift, value & 0xFF);
e5d13e2f
FB
767}
768
802670e6 769static uint32_t serial_mm_readw(void *opaque, target_phys_addr_t addr)
e5d13e2f
FB
770{
771 SerialState *s = opaque;
e918ee04 772 uint32_t val;
e5d13e2f 773
8da3ff18 774 val = serial_ioport_read(s, addr >> s->it_shift) & 0xFFFF;
e918ee04
TS
775#ifdef TARGET_WORDS_BIGENDIAN
776 val = bswap16(val);
777#endif
778 return val;
e5d13e2f
FB
779}
780
802670e6
BS
781static void serial_mm_writew(void *opaque, target_phys_addr_t addr,
782 uint32_t value)
e5d13e2f
FB
783{
784 SerialState *s = opaque;
e918ee04
TS
785#ifdef TARGET_WORDS_BIGENDIAN
786 value = bswap16(value);
787#endif
8da3ff18 788 serial_ioport_write(s, addr >> s->it_shift, value & 0xFFFF);
e5d13e2f
FB
789}
790
802670e6 791static uint32_t serial_mm_readl(void *opaque, target_phys_addr_t addr)
e5d13e2f
FB
792{
793 SerialState *s = opaque;
e918ee04 794 uint32_t val;
e5d13e2f 795
8da3ff18 796 val = serial_ioport_read(s, addr >> s->it_shift);
e918ee04
TS
797#ifdef TARGET_WORDS_BIGENDIAN
798 val = bswap32(val);
799#endif
800 return val;
e5d13e2f
FB
801}
802
802670e6
BS
803static void serial_mm_writel(void *opaque, target_phys_addr_t addr,
804 uint32_t value)
e5d13e2f
FB
805{
806 SerialState *s = opaque;
e918ee04
TS
807#ifdef TARGET_WORDS_BIGENDIAN
808 value = bswap32(value);
809#endif
8da3ff18 810 serial_ioport_write(s, addr >> s->it_shift, value);
e5d13e2f
FB
811}
812
d60efc6b 813static CPUReadMemoryFunc * const serial_mm_read[] = {
e5d13e2f
FB
814 &serial_mm_readb,
815 &serial_mm_readw,
816 &serial_mm_readl,
817};
818
d60efc6b 819static CPUWriteMemoryFunc * const serial_mm_write[] = {
e5d13e2f
FB
820 &serial_mm_writeb,
821 &serial_mm_writew,
822 &serial_mm_writel,
823};
824
71db710f 825SerialState *serial_mm_init (target_phys_addr_t base, int it_shift,
b6cd0ea1
AJ
826 qemu_irq irq, int baudbase,
827 CharDriverState *chr, int ioregister)
e5d13e2f
FB
828{
829 SerialState *s;
830 int s_io_memory;
831
832 s = qemu_mallocz(sizeof(SerialState));
81174dae 833
e5d13e2f
FB
834 s->it_shift = it_shift;
835
81174dae 836 serial_init_core(s, irq, baudbase, chr);
747791f1 837 vmstate_register(base, &vmstate_serial, s);
e5d13e2f 838
a4bc3afc 839 if (ioregister) {
1eed09cb 840 s_io_memory = cpu_register_io_memory(serial_mm_read,
a4bc3afc
TS
841 serial_mm_write, s);
842 cpu_register_physical_memory(base, 8 << it_shift, s_io_memory);
843 }
81174dae 844 serial_update_msl(s);
e5d13e2f
FB
845 return s;
846}