]> git.proxmox.com Git - qemu.git/blame - hw/char/serial.c
Open 2.0 development tree
[qemu.git] / hw / char / 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 */
488cb996 25
0d09e41a 26#include "hw/char/serial.h"
dccfcd0e 27#include "sysemu/char.h"
1de7afc9 28#include "qemu/timer.h"
022c62cb 29#include "exec/address-spaces.h"
4a44d85e 30#include "qemu/error-report.h"
80cabfad
FB
31
32//#define DEBUG_SERIAL
33
34#define UART_LCR_DLAB 0x80 /* Divisor latch access bit */
35
36#define UART_IER_MSI 0x08 /* Enable Modem status interrupt */
37#define UART_IER_RLSI 0x04 /* Enable receiver line status interrupt */
38#define UART_IER_THRI 0x02 /* Enable Transmitter holding register int. */
39#define UART_IER_RDI 0x01 /* Enable receiver data interrupt */
40
41#define UART_IIR_NO_INT 0x01 /* No interrupts pending */
42#define UART_IIR_ID 0x06 /* Mask for the interrupt ID */
43
44#define UART_IIR_MSI 0x00 /* Modem status interrupt */
45#define UART_IIR_THRI 0x02 /* Transmitter holding register empty */
46#define UART_IIR_RDI 0x04 /* Receiver data interrupt */
47#define UART_IIR_RLSI 0x06 /* Receiver line status interrupt */
81174dae
AL
48#define UART_IIR_CTI 0x0C /* Character Timeout Indication */
49
50#define UART_IIR_FENF 0x80 /* Fifo enabled, but not functionning */
51#define UART_IIR_FE 0xC0 /* Fifo enabled */
80cabfad
FB
52
53/*
54 * These are the definitions for the Modem Control Register
55 */
56#define UART_MCR_LOOP 0x10 /* Enable loopback test mode */
57#define UART_MCR_OUT2 0x08 /* Out2 complement */
58#define UART_MCR_OUT1 0x04 /* Out1 complement */
59#define UART_MCR_RTS 0x02 /* RTS complement */
60#define UART_MCR_DTR 0x01 /* DTR complement */
61
62/*
63 * These are the definitions for the Modem Status Register
64 */
65#define UART_MSR_DCD 0x80 /* Data Carrier Detect */
66#define UART_MSR_RI 0x40 /* Ring Indicator */
67#define UART_MSR_DSR 0x20 /* Data Set Ready */
68#define UART_MSR_CTS 0x10 /* Clear to Send */
69#define UART_MSR_DDCD 0x08 /* Delta DCD */
70#define UART_MSR_TERI 0x04 /* Trailing edge ring indicator */
71#define UART_MSR_DDSR 0x02 /* Delta DSR */
72#define UART_MSR_DCTS 0x01 /* Delta CTS */
73#define UART_MSR_ANY_DELTA 0x0F /* Any of the delta bits! */
74
75#define UART_LSR_TEMT 0x40 /* Transmitter empty */
76#define UART_LSR_THRE 0x20 /* Transmit-hold-register empty */
77#define UART_LSR_BI 0x10 /* Break interrupt indicator */
78#define UART_LSR_FE 0x08 /* Frame error indicator */
79#define UART_LSR_PE 0x04 /* Parity error indicator */
80#define UART_LSR_OE 0x02 /* Overrun error indicator */
81#define UART_LSR_DR 0x01 /* Receiver data ready */
81174dae 82#define UART_LSR_INT_ANY 0x1E /* Any of the lsr-interrupt-triggering status bits */
80cabfad 83
81174dae
AL
84/* Interrupt trigger levels. The byte-counts are for 16550A - in newer UARTs the byte-count for each ITL is higher. */
85
86#define UART_FCR_ITL_1 0x00 /* 1 byte ITL */
87#define UART_FCR_ITL_2 0x40 /* 4 bytes ITL */
88#define UART_FCR_ITL_3 0x80 /* 8 bytes ITL */
89#define UART_FCR_ITL_4 0xC0 /* 14 bytes ITL */
90
91#define UART_FCR_DMS 0x08 /* DMA Mode Select */
92#define UART_FCR_XFR 0x04 /* XMIT Fifo Reset */
93#define UART_FCR_RFR 0x02 /* RCVR Fifo Reset */
94#define UART_FCR_FE 0x01 /* FIFO Enable */
95
81174dae
AL
96#define MAX_XMIT_RETRY 4
97
b6601141
MN
98#ifdef DEBUG_SERIAL
99#define DPRINTF(fmt, ...) \
46411f86 100do { fprintf(stderr, "serial: " fmt , ## __VA_ARGS__); } while (0)
b6601141
MN
101#else
102#define DPRINTF(fmt, ...) \
46411f86 103do {} while (0)
b6601141
MN
104#endif
105
81174dae 106static void serial_receive1(void *opaque, const uint8_t *buf, int size);
b2a5160c 107
8e8638fa 108static inline void recv_fifo_put(SerialState *s, uint8_t chr)
80cabfad 109{
71e605f8 110 /* Receive overruns do not overwrite FIFO contents. */
8e8638fa
PC
111 if (!fifo8_is_full(&s->recv_fifo)) {
112 fifo8_push(&s->recv_fifo, chr);
113 } else {
71e605f8 114 s->lsr |= UART_LSR_OE;
8e8638fa 115 }
81174dae 116}
6936bfe5 117
81174dae
AL
118static void serial_update_irq(SerialState *s)
119{
120 uint8_t tmp_iir = UART_IIR_NO_INT;
121
81174dae
AL
122 if ((s->ier & UART_IER_RLSI) && (s->lsr & UART_LSR_INT_ANY)) {
123 tmp_iir = UART_IIR_RLSI;
5628a626 124 } else if ((s->ier & UART_IER_RDI) && s->timeout_ipending) {
c9a33054
AZ
125 /* Note that(s->ier & UART_IER_RDI) can mask this interrupt,
126 * this is not in the specification but is observed on existing
127 * hardware. */
81174dae 128 tmp_iir = UART_IIR_CTI;
2d6ee8e7
JL
129 } else if ((s->ier & UART_IER_RDI) && (s->lsr & UART_LSR_DR) &&
130 (!(s->fcr & UART_FCR_FE) ||
8e8638fa 131 s->recv_fifo.num >= s->recv_fifo_itl)) {
2d6ee8e7 132 tmp_iir = UART_IIR_RDI;
81174dae
AL
133 } else if ((s->ier & UART_IER_THRI) && s->thr_ipending) {
134 tmp_iir = UART_IIR_THRI;
135 } else if ((s->ier & UART_IER_MSI) && (s->msr & UART_MSR_ANY_DELTA)) {
136 tmp_iir = UART_IIR_MSI;
137 }
138
139 s->iir = tmp_iir | (s->iir & 0xF0);
140
141 if (tmp_iir != UART_IIR_NO_INT) {
142 qemu_irq_raise(s->irq);
143 } else {
144 qemu_irq_lower(s->irq);
6936bfe5 145 }
6936bfe5
AJ
146}
147
f8d179e3
FB
148static void serial_update_parameters(SerialState *s)
149{
81174dae 150 int speed, parity, data_bits, stop_bits, frame_size;
2122c51a 151 QEMUSerialSetParams ssp;
f8d179e3 152
81174dae
AL
153 if (s->divider == 0)
154 return;
155
718b8aec 156 /* Start bit. */
81174dae 157 frame_size = 1;
f8d179e3 158 if (s->lcr & 0x08) {
718b8aec
SW
159 /* Parity bit. */
160 frame_size++;
f8d179e3
FB
161 if (s->lcr & 0x10)
162 parity = 'E';
163 else
164 parity = 'O';
165 } else {
166 parity = 'N';
167 }
5fafdf24 168 if (s->lcr & 0x04)
f8d179e3
FB
169 stop_bits = 2;
170 else
171 stop_bits = 1;
81174dae 172
f8d179e3 173 data_bits = (s->lcr & 0x03) + 5;
81174dae 174 frame_size += data_bits + stop_bits;
b6cd0ea1 175 speed = s->baudbase / s->divider;
2122c51a
FB
176 ssp.speed = speed;
177 ssp.parity = parity;
178 ssp.data_bits = data_bits;
179 ssp.stop_bits = stop_bits;
6ee093c9 180 s->char_transmit_time = (get_ticks_per_sec() / speed) * frame_size;
41084f1b 181 qemu_chr_fe_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_PARAMS, &ssp);
b6601141
MN
182
183 DPRINTF("speed=%d parity=%c data=%d stop=%d\n",
f8d179e3 184 speed, parity, data_bits, stop_bits);
f8d179e3
FB
185}
186
81174dae
AL
187static void serial_update_msl(SerialState *s)
188{
189 uint8_t omsr;
190 int flags;
191
bc72ad67 192 timer_del(s->modem_status_poll);
81174dae 193
41084f1b 194 if (qemu_chr_fe_ioctl(s->chr,CHR_IOCTL_SERIAL_GET_TIOCM, &flags) == -ENOTSUP) {
81174dae
AL
195 s->poll_msl = -1;
196 return;
197 }
198
199 omsr = s->msr;
200
201 s->msr = (flags & CHR_TIOCM_CTS) ? s->msr | UART_MSR_CTS : s->msr & ~UART_MSR_CTS;
202 s->msr = (flags & CHR_TIOCM_DSR) ? s->msr | UART_MSR_DSR : s->msr & ~UART_MSR_DSR;
203 s->msr = (flags & CHR_TIOCM_CAR) ? s->msr | UART_MSR_DCD : s->msr & ~UART_MSR_DCD;
204 s->msr = (flags & CHR_TIOCM_RI) ? s->msr | UART_MSR_RI : s->msr & ~UART_MSR_RI;
205
206 if (s->msr != omsr) {
207 /* Set delta bits */
208 s->msr = s->msr | ((s->msr >> 4) ^ (omsr >> 4));
209 /* UART_MSR_TERI only if change was from 1 -> 0 */
210 if ((s->msr & UART_MSR_TERI) && !(omsr & UART_MSR_RI))
211 s->msr &= ~UART_MSR_TERI;
212 serial_update_irq(s);
213 }
214
215 /* The real 16550A apparently has a 250ns response latency to line status changes.
216 We'll be lazy and poll only every 10ms, and only poll it at all if MSI interrupts are turned on */
217
218 if (s->poll_msl)
bc72ad67 219 timer_mod(s->modem_status_poll, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + get_ticks_per_sec() / 100);
81174dae
AL
220}
221
fcfb4d6a 222static gboolean serial_xmit(GIOChannel *chan, GIOCondition cond, void *opaque)
81174dae
AL
223{
224 SerialState *s = opaque;
81174dae
AL
225
226 if (s->tsr_retry <= 0) {
227 if (s->fcr & UART_FCR_FE) {
8e8638fa
PC
228 s->tsr = fifo8_is_full(&s->xmit_fifo) ?
229 0 : fifo8_pop(&s->xmit_fifo);
230 if (!s->xmit_fifo.num) {
81174dae 231 s->lsr |= UART_LSR_THRE;
7f4f0a22 232 }
fcfb4d6a
AL
233 } else if ((s->lsr & UART_LSR_THRE)) {
234 return FALSE;
81174dae
AL
235 } else {
236 s->tsr = s->thr;
237 s->lsr |= UART_LSR_THRE;
dfe844c9 238 s->lsr &= ~UART_LSR_TEMT;
81174dae
AL
239 }
240 }
241
242 if (s->mcr & UART_MCR_LOOP) {
243 /* in loopback mode, say that we just received a char */
244 serial_receive1(s, &s->tsr, 1);
2cc6e0a1 245 } else if (qemu_chr_fe_write(s->chr, &s->tsr, 1) != 1) {
fcfb4d6a
AL
246 if (s->tsr_retry >= 0 && s->tsr_retry < MAX_XMIT_RETRY &&
247 qemu_chr_fe_add_watch(s->chr, G_IO_OUT, serial_xmit, s) > 0) {
81174dae 248 s->tsr_retry++;
fcfb4d6a 249 return FALSE;
81174dae 250 }
fcfb4d6a
AL
251 s->tsr_retry = 0;
252 } else {
81174dae
AL
253 s->tsr_retry = 0;
254 }
255
bc72ad67 256 s->last_xmit_ts = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
81174dae
AL
257
258 if (s->lsr & UART_LSR_THRE) {
259 s->lsr |= UART_LSR_TEMT;
260 s->thr_ipending = 1;
261 serial_update_irq(s);
262 }
fcfb4d6a
AL
263
264 return FALSE;
81174dae
AL
265}
266
267
5ec3a23e
AG
268static void serial_ioport_write(void *opaque, hwaddr addr, uint64_t val,
269 unsigned size)
80cabfad 270{
b41a2cd1 271 SerialState *s = opaque;
3b46e624 272
80cabfad 273 addr &= 7;
8b4a8988 274 DPRINTF("write addr=0x%" HWADDR_PRIx " val=0x%" PRIx64 "\n", addr, val);
80cabfad
FB
275 switch(addr) {
276 default:
277 case 0:
278 if (s->lcr & UART_LCR_DLAB) {
279 s->divider = (s->divider & 0xff00) | val;
f8d179e3 280 serial_update_parameters(s);
80cabfad 281 } else {
81174dae
AL
282 s->thr = (uint8_t) val;
283 if(s->fcr & UART_FCR_FE) {
8e8638fa
PC
284 /* xmit overruns overwrite data, so make space if needed */
285 if (fifo8_is_full(&s->xmit_fifo)) {
286 fifo8_pop(&s->xmit_fifo);
287 }
288 fifo8_push(&s->xmit_fifo, s->thr);
2f4f22bd 289 s->lsr &= ~UART_LSR_TEMT;
6936bfe5 290 }
b5601df7
PC
291 s->thr_ipending = 0;
292 s->lsr &= ~UART_LSR_THRE;
293 serial_update_irq(s);
fcfb4d6a 294 serial_xmit(NULL, G_IO_OUT, s);
80cabfad
FB
295 }
296 break;
297 case 1:
298 if (s->lcr & UART_LCR_DLAB) {
299 s->divider = (s->divider & 0x00ff) | (val << 8);
f8d179e3 300 serial_update_parameters(s);
80cabfad 301 } else {
60e336db 302 s->ier = val & 0x0f;
81174dae
AL
303 /* If the backend device is a real serial port, turn polling of the modem
304 status lines on physical port on or off depending on UART_IER_MSI state */
305 if (s->poll_msl >= 0) {
306 if (s->ier & UART_IER_MSI) {
307 s->poll_msl = 1;
308 serial_update_msl(s);
309 } else {
bc72ad67 310 timer_del(s->modem_status_poll);
81174dae
AL
311 s->poll_msl = 0;
312 }
313 }
60e336db
FB
314 if (s->lsr & UART_LSR_THRE) {
315 s->thr_ipending = 1;
81174dae 316 serial_update_irq(s);
60e336db 317 }
80cabfad
FB
318 }
319 break;
320 case 2:
81174dae
AL
321 val = val & 0xFF;
322
323 if (s->fcr == val)
324 break;
325
326 /* Did the enable/disable flag change? If so, make sure FIFOs get flushed */
327 if ((val ^ s->fcr) & UART_FCR_FE)
328 val |= UART_FCR_XFR | UART_FCR_RFR;
329
330 /* FIFO clear */
331
332 if (val & UART_FCR_RFR) {
bc72ad67 333 timer_del(s->fifo_timeout_timer);
81174dae 334 s->timeout_ipending=0;
8e8638fa 335 fifo8_reset(&s->recv_fifo);
81174dae
AL
336 }
337
338 if (val & UART_FCR_XFR) {
8e8638fa 339 fifo8_reset(&s->xmit_fifo);
81174dae
AL
340 }
341
342 if (val & UART_FCR_FE) {
343 s->iir |= UART_IIR_FE;
8e8638fa 344 /* Set recv_fifo trigger Level */
81174dae
AL
345 switch (val & 0xC0) {
346 case UART_FCR_ITL_1:
8e8638fa 347 s->recv_fifo_itl = 1;
81174dae
AL
348 break;
349 case UART_FCR_ITL_2:
8e8638fa 350 s->recv_fifo_itl = 4;
81174dae
AL
351 break;
352 case UART_FCR_ITL_3:
8e8638fa 353 s->recv_fifo_itl = 8;
81174dae
AL
354 break;
355 case UART_FCR_ITL_4:
8e8638fa 356 s->recv_fifo_itl = 14;
81174dae
AL
357 break;
358 }
359 } else
360 s->iir &= ~UART_IIR_FE;
361
362 /* Set fcr - or at least the bits in it that are supposed to "stick" */
363 s->fcr = val & 0xC9;
364 serial_update_irq(s);
80cabfad
FB
365 break;
366 case 3:
f8d179e3
FB
367 {
368 int break_enable;
369 s->lcr = val;
370 serial_update_parameters(s);
371 break_enable = (val >> 6) & 1;
372 if (break_enable != s->last_break_enable) {
373 s->last_break_enable = break_enable;
41084f1b 374 qemu_chr_fe_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_BREAK,
2122c51a 375 &break_enable);
f8d179e3
FB
376 }
377 }
80cabfad
FB
378 break;
379 case 4:
81174dae
AL
380 {
381 int flags;
382 int old_mcr = s->mcr;
383 s->mcr = val & 0x1f;
384 if (val & UART_MCR_LOOP)
385 break;
386
387 if (s->poll_msl >= 0 && old_mcr != s->mcr) {
388
41084f1b 389 qemu_chr_fe_ioctl(s->chr,CHR_IOCTL_SERIAL_GET_TIOCM, &flags);
81174dae
AL
390
391 flags &= ~(CHR_TIOCM_RTS | CHR_TIOCM_DTR);
392
393 if (val & UART_MCR_RTS)
394 flags |= CHR_TIOCM_RTS;
395 if (val & UART_MCR_DTR)
396 flags |= CHR_TIOCM_DTR;
397
41084f1b 398 qemu_chr_fe_ioctl(s->chr,CHR_IOCTL_SERIAL_SET_TIOCM, &flags);
81174dae
AL
399 /* Update the modem status after a one-character-send wait-time, since there may be a response
400 from the device/computer at the other end of the serial line */
bc72ad67 401 timer_mod(s->modem_status_poll, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + s->char_transmit_time);
81174dae
AL
402 }
403 }
80cabfad
FB
404 break;
405 case 5:
406 break;
407 case 6:
80cabfad
FB
408 break;
409 case 7:
410 s->scr = val;
411 break;
412 }
413}
414
5ec3a23e 415static uint64_t serial_ioport_read(void *opaque, hwaddr addr, unsigned size)
80cabfad 416{
b41a2cd1 417 SerialState *s = opaque;
80cabfad
FB
418 uint32_t ret;
419
420 addr &= 7;
421 switch(addr) {
422 default:
423 case 0:
424 if (s->lcr & UART_LCR_DLAB) {
5fafdf24 425 ret = s->divider & 0xff;
80cabfad 426 } else {
81174dae 427 if(s->fcr & UART_FCR_FE) {
b165b0d8 428 ret = fifo8_is_empty(&s->recv_fifo) ?
8e8638fa
PC
429 0 : fifo8_pop(&s->recv_fifo);
430 if (s->recv_fifo.num == 0) {
81174dae 431 s->lsr &= ~(UART_LSR_DR | UART_LSR_BI);
7f4f0a22 432 } else {
bc72ad67 433 timer_mod(s->fifo_timeout_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + s->char_transmit_time * 4);
7f4f0a22 434 }
81174dae
AL
435 s->timeout_ipending = 0;
436 } else {
437 ret = s->rbr;
438 s->lsr &= ~(UART_LSR_DR | UART_LSR_BI);
439 }
b41a2cd1 440 serial_update_irq(s);
b2a5160c
AZ
441 if (!(s->mcr & UART_MCR_LOOP)) {
442 /* in loopback mode, don't receive any data */
443 qemu_chr_accept_input(s->chr);
444 }
80cabfad
FB
445 }
446 break;
447 case 1:
448 if (s->lcr & UART_LCR_DLAB) {
449 ret = (s->divider >> 8) & 0xff;
450 } else {
451 ret = s->ier;
452 }
453 break;
454 case 2:
455 ret = s->iir;
cdee7bdf 456 if ((ret & UART_IIR_ID) == UART_IIR_THRI) {
80cabfad 457 s->thr_ipending = 0;
71e605f8
JG
458 serial_update_irq(s);
459 }
80cabfad
FB
460 break;
461 case 3:
462 ret = s->lcr;
463 break;
464 case 4:
465 ret = s->mcr;
466 break;
467 case 5:
468 ret = s->lsr;
71e605f8
JG
469 /* Clear break and overrun interrupts */
470 if (s->lsr & (UART_LSR_BI|UART_LSR_OE)) {
471 s->lsr &= ~(UART_LSR_BI|UART_LSR_OE);
81174dae
AL
472 serial_update_irq(s);
473 }
80cabfad
FB
474 break;
475 case 6:
476 if (s->mcr & UART_MCR_LOOP) {
477 /* in loopback, the modem output pins are connected to the
478 inputs */
479 ret = (s->mcr & 0x0c) << 4;
480 ret |= (s->mcr & 0x02) << 3;
481 ret |= (s->mcr & 0x01) << 5;
482 } else {
81174dae
AL
483 if (s->poll_msl >= 0)
484 serial_update_msl(s);
80cabfad 485 ret = s->msr;
81174dae
AL
486 /* Clear delta bits & msr int after read, if they were set */
487 if (s->msr & UART_MSR_ANY_DELTA) {
488 s->msr &= 0xF0;
489 serial_update_irq(s);
490 }
80cabfad
FB
491 }
492 break;
493 case 7:
494 ret = s->scr;
495 break;
496 }
8b4a8988 497 DPRINTF("read addr=0x%" HWADDR_PRIx " val=0x%02x\n", addr, ret);
80cabfad
FB
498 return ret;
499}
500
82c643ff 501static int serial_can_receive(SerialState *s)
80cabfad 502{
81174dae 503 if(s->fcr & UART_FCR_FE) {
8e8638fa 504 if (s->recv_fifo.num < UART_FIFO_LENGTH) {
7f4f0a22
PC
505 /*
506 * Advertise (fifo.itl - fifo.count) bytes when count < ITL, and 1
507 * if above. If UART_FIFO_LENGTH - fifo.count is advertised the
508 * effect will be to almost always fill the fifo completely before
509 * the guest has a chance to respond, effectively overriding the ITL
510 * that the guest has set.
511 */
8e8638fa
PC
512 return (s->recv_fifo.num <= s->recv_fifo_itl) ?
513 s->recv_fifo_itl - s->recv_fifo.num : 1;
7f4f0a22
PC
514 } else {
515 return 0;
516 }
81174dae 517 } else {
7f4f0a22 518 return !(s->lsr & UART_LSR_DR);
81174dae 519 }
80cabfad
FB
520}
521
82c643ff 522static void serial_receive_break(SerialState *s)
80cabfad 523{
80cabfad 524 s->rbr = 0;
40ff1624 525 /* When the LSR_DR is set a null byte is pushed into the fifo */
8e8638fa 526 recv_fifo_put(s, '\0');
80cabfad 527 s->lsr |= UART_LSR_BI | UART_LSR_DR;
b41a2cd1 528 serial_update_irq(s);
80cabfad
FB
529}
530
81174dae
AL
531/* There's data in recv_fifo and s->rbr has not been read for 4 char transmit times */
532static void fifo_timeout_int (void *opaque) {
533 SerialState *s = opaque;
8e8638fa 534 if (s->recv_fifo.num) {
81174dae
AL
535 s->timeout_ipending = 1;
536 serial_update_irq(s);
537 }
538}
539
b41a2cd1 540static int serial_can_receive1(void *opaque)
80cabfad 541{
b41a2cd1
FB
542 SerialState *s = opaque;
543 return serial_can_receive(s);
544}
545
546static void serial_receive1(void *opaque, const uint8_t *buf, int size)
547{
548 SerialState *s = opaque;
9826fd59
GH
549
550 if (s->wakeup) {
551 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER);
552 }
81174dae
AL
553 if(s->fcr & UART_FCR_FE) {
554 int i;
555 for (i = 0; i < size; i++) {
8e8638fa 556 recv_fifo_put(s, buf[i]);
81174dae
AL
557 }
558 s->lsr |= UART_LSR_DR;
559 /* call the timeout receive callback in 4 char transmit time */
bc72ad67 560 timer_mod(s->fifo_timeout_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + s->char_transmit_time * 4);
81174dae 561 } else {
71e605f8
JG
562 if (s->lsr & UART_LSR_DR)
563 s->lsr |= UART_LSR_OE;
81174dae
AL
564 s->rbr = buf[0];
565 s->lsr |= UART_LSR_DR;
566 }
567 serial_update_irq(s);
b41a2cd1 568}
80cabfad 569
82c643ff
FB
570static void serial_event(void *opaque, int event)
571{
572 SerialState *s = opaque;
b6601141 573 DPRINTF("event %x\n", event);
82c643ff
FB
574 if (event == CHR_EVENT_BREAK)
575 serial_receive_break(s);
576}
577
d4bfa4d7 578static void serial_pre_save(void *opaque)
8738a8d0 579{
d4bfa4d7 580 SerialState *s = opaque;
747791f1 581 s->fcr_vmstate = s->fcr;
8738a8d0
FB
582}
583
e59fb374 584static int serial_post_load(void *opaque, int version_id)
747791f1
JQ
585{
586 SerialState *s = opaque;
81174dae 587
4c18ce94
JQ
588 if (version_id < 3) {
589 s->fcr_vmstate = 0;
590 }
81174dae 591 /* Initialize fcr via setter to perform essential side-effects */
5ec3a23e 592 serial_ioport_write(s, 0x02, s->fcr_vmstate, 1);
9a7c4878 593 serial_update_parameters(s);
8738a8d0
FB
594 return 0;
595}
596
488cb996 597const VMStateDescription vmstate_serial = {
747791f1
JQ
598 .name = "serial",
599 .version_id = 3,
600 .minimum_version_id = 2,
601 .pre_save = serial_pre_save,
747791f1
JQ
602 .post_load = serial_post_load,
603 .fields = (VMStateField []) {
604 VMSTATE_UINT16_V(divider, SerialState, 2),
605 VMSTATE_UINT8(rbr, SerialState),
606 VMSTATE_UINT8(ier, SerialState),
607 VMSTATE_UINT8(iir, SerialState),
608 VMSTATE_UINT8(lcr, SerialState),
609 VMSTATE_UINT8(mcr, SerialState),
610 VMSTATE_UINT8(lsr, SerialState),
611 VMSTATE_UINT8(msr, SerialState),
612 VMSTATE_UINT8(scr, SerialState),
613 VMSTATE_UINT8_V(fcr_vmstate, SerialState, 3),
614 VMSTATE_END_OF_LIST()
615 }
616};
617
b2a5160c
AZ
618static void serial_reset(void *opaque)
619{
620 SerialState *s = opaque;
621
b2a5160c
AZ
622 s->rbr = 0;
623 s->ier = 0;
624 s->iir = UART_IIR_NO_INT;
625 s->lcr = 0;
b2a5160c
AZ
626 s->lsr = UART_LSR_TEMT | UART_LSR_THRE;
627 s->msr = UART_MSR_DCD | UART_MSR_DSR | UART_MSR_CTS;
718b8aec 628 /* Default to 9600 baud, 1 start bit, 8 data bits, 1 stop bit, no parity. */
81174dae
AL
629 s->divider = 0x0C;
630 s->mcr = UART_MCR_OUT2;
b2a5160c 631 s->scr = 0;
81174dae 632 s->tsr_retry = 0;
718b8aec 633 s->char_transmit_time = (get_ticks_per_sec() / 9600) * 10;
81174dae
AL
634 s->poll_msl = 0;
635
8e8638fa
PC
636 fifo8_reset(&s->recv_fifo);
637 fifo8_reset(&s->xmit_fifo);
81174dae 638
bc72ad67 639 s->last_xmit_ts = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
b2a5160c
AZ
640
641 s->thr_ipending = 0;
642 s->last_break_enable = 0;
643 qemu_irq_lower(s->irq);
644}
645
db895a1e 646void serial_realize_core(SerialState *s, Error **errp)
81174dae 647{
ac0be998 648 if (!s->chr) {
db895a1e
AF
649 error_setg(errp, "Can't create serial device, empty char device");
650 return;
387f4a5a
AJ
651 }
652
bc72ad67 653 s->modem_status_poll = timer_new_ns(QEMU_CLOCK_VIRTUAL, (QEMUTimerCB *) serial_update_msl, s);
81174dae 654
bc72ad67 655 s->fifo_timeout_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, (QEMUTimerCB *) fifo_timeout_int, s);
a08d4367 656 qemu_register_reset(serial_reset, s);
81174dae 657
b47543c4
AJ
658 qemu_chr_add_handlers(s->chr, serial_can_receive1, serial_receive1,
659 serial_event, s);
8e8638fa
PC
660 fifo8_create(&s->recv_fifo, UART_FIFO_LENGTH);
661 fifo8_create(&s->xmit_fifo, UART_FIFO_LENGTH);
81174dae
AL
662}
663
419ad672
GH
664void serial_exit_core(SerialState *s)
665{
666 qemu_chr_add_handlers(s->chr, NULL, NULL, NULL, NULL);
667 qemu_unregister_reset(serial_reset, s);
668}
669
038eaf82
SW
670/* Change the main reference oscillator frequency. */
671void serial_set_frequency(SerialState *s, uint32_t frequency)
672{
673 s->baudbase = frequency;
674 serial_update_parameters(s);
675}
676
488cb996 677const MemoryRegionOps serial_io_ops = {
5ec3a23e
AG
678 .read = serial_ioport_read,
679 .write = serial_ioport_write,
680 .impl = {
681 .min_access_size = 1,
682 .max_access_size = 1,
683 },
684 .endianness = DEVICE_LITTLE_ENDIAN,
a941ae45
RH
685};
686
b6cd0ea1 687SerialState *serial_init(int base, qemu_irq irq, int baudbase,
568fd159 688 CharDriverState *chr, MemoryRegion *system_io)
b41a2cd1
FB
689{
690 SerialState *s;
db895a1e 691 Error *err = NULL;
b41a2cd1 692
7267c094 693 s = g_malloc0(sizeof(SerialState));
6936bfe5 694
ac0be998
GH
695 s->irq = irq;
696 s->baudbase = baudbase;
697 s->chr = chr;
db895a1e
AF
698 serial_realize_core(s, &err);
699 if (err != NULL) {
4a44d85e 700 error_report("%s", error_get_pretty(err));
db895a1e
AF
701 error_free(err);
702 exit(1);
703 }
b41a2cd1 704
0be71e32 705 vmstate_register(NULL, base, &vmstate_serial, s);
8738a8d0 706
2c9b15ca 707 memory_region_init_io(&s->io, NULL, &serial_io_ops, s, "serial", 8);
568fd159 708 memory_region_add_subregion(system_io, base, &s->io);
5ec3a23e 709
b41a2cd1 710 return s;
80cabfad 711}
e5d13e2f
FB
712
713/* Memory mapped interface */
a8170e5e 714static uint64_t serial_mm_read(void *opaque, hwaddr addr,
8e8ffc44 715 unsigned size)
e5d13e2f
FB
716{
717 SerialState *s = opaque;
5ec3a23e 718 return serial_ioport_read(s, addr >> s->it_shift, 1);
e5d13e2f
FB
719}
720
a8170e5e 721static void serial_mm_write(void *opaque, hwaddr addr,
8e8ffc44 722 uint64_t value, unsigned size)
2d48377a
BS
723{
724 SerialState *s = opaque;
8e8ffc44 725 value &= ~0u >> (32 - (size * 8));
5ec3a23e 726 serial_ioport_write(s, addr >> s->it_shift, value, 1);
2d48377a
BS
727}
728
8e8ffc44
RH
729static const MemoryRegionOps serial_mm_ops[3] = {
730 [DEVICE_NATIVE_ENDIAN] = {
731 .read = serial_mm_read,
732 .write = serial_mm_write,
733 .endianness = DEVICE_NATIVE_ENDIAN,
734 },
735 [DEVICE_LITTLE_ENDIAN] = {
736 .read = serial_mm_read,
737 .write = serial_mm_write,
738 .endianness = DEVICE_LITTLE_ENDIAN,
739 },
740 [DEVICE_BIG_ENDIAN] = {
741 .read = serial_mm_read,
742 .write = serial_mm_write,
743 .endianness = DEVICE_BIG_ENDIAN,
744 },
e5d13e2f
FB
745};
746
39186d8a 747SerialState *serial_mm_init(MemoryRegion *address_space,
a8170e5e 748 hwaddr base, int it_shift,
39186d8a
RH
749 qemu_irq irq, int baudbase,
750 CharDriverState *chr, enum device_endian end)
e5d13e2f
FB
751{
752 SerialState *s;
db895a1e 753 Error *err = NULL;
e5d13e2f 754
7267c094 755 s = g_malloc0(sizeof(SerialState));
81174dae 756
e5d13e2f 757 s->it_shift = it_shift;
ac0be998
GH
758 s->irq = irq;
759 s->baudbase = baudbase;
760 s->chr = chr;
e5d13e2f 761
db895a1e
AF
762 serial_realize_core(s, &err);
763 if (err != NULL) {
4a44d85e 764 error_report("%s", error_get_pretty(err));
db895a1e
AF
765 error_free(err);
766 exit(1);
767 }
0be71e32 768 vmstate_register(NULL, base, &vmstate_serial, s);
e5d13e2f 769
2c9b15ca 770 memory_region_init_io(&s->io, NULL, &serial_mm_ops[end], s,
8e8ffc44 771 "serial", 8 << it_shift);
39186d8a 772 memory_region_add_subregion(address_space, base, &s->io);
2ff0c7c3 773
81174dae 774 serial_update_msl(s);
e5d13e2f
FB
775 return s;
776}