hw/serial.c

   1 /*
   2  * QEMU 16450 UART emulation
   3  *
   4  * Copyright (c) 2003-2004 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "hw.h"
  25 #include "qemu-char.h"
  26 #include "isa.h"
  27 #include "pc.h"
  28
  29 //#define DEBUG_SERIAL
  30
  31 #define UART_LCR_DLAB   0x80    /* Divisor latch access bit */
  32
  33 #define UART_IER_MSI    0x08    /* Enable Modem status interrupt */
  34 #define UART_IER_RLSI   0x04    /* Enable receiver line status interrupt */
  35 #define UART_IER_THRI   0x02    /* Enable Transmitter holding register int. */
  36 #define UART_IER_RDI    0x01    /* Enable receiver data interrupt */
  37
  38 #define UART_IIR_NO_INT 0x01    /* No interrupts pending */
  39 #define UART_IIR_ID     0x06    /* Mask for the interrupt ID */
  40
  41 #define UART_IIR_MSI    0x00    /* Modem status interrupt */
  42 #define UART_IIR_THRI   0x02    /* Transmitter holding register empty */
  43 #define UART_IIR_RDI    0x04    /* Receiver data interrupt */
  44 #define UART_IIR_RLSI   0x06    /* Receiver line status interrupt */
  45
  46 /*
  47  * These are the definitions for the Modem Control Register
  48  */
  49 #define UART_MCR_LOOP   0x10    /* Enable loopback test mode */
  50 #define UART_MCR_OUT2   0x08    /* Out2 complement */
  51 #define UART_MCR_OUT1   0x04    /* Out1 complement */
  52 #define UART_MCR_RTS    0x02    /* RTS complement */
  53 #define UART_MCR_DTR    0x01    /* DTR complement */
  54
  55 /*
  56  * These are the definitions for the Modem Status Register
  57  */
  58 #define UART_MSR_DCD    0x80    /* Data Carrier Detect */
  59 #define UART_MSR_RI     0x40    /* Ring Indicator */
  60 #define UART_MSR_DSR    0x20    /* Data Set Ready */
  61 #define UART_MSR_CTS    0x10    /* Clear to Send */
  62 #define UART_MSR_DDCD   0x08    /* Delta DCD */
  63 #define UART_MSR_TERI   0x04    /* Trailing edge ring indicator */
  64 #define UART_MSR_DDSR   0x02    /* Delta DSR */
  65 #define UART_MSR_DCTS   0x01    /* Delta CTS */
  66 #define UART_MSR_ANY_DELTA 0x0F /* Any of the delta bits! */
  67
  68 #define UART_LSR_TEMT   0x40    /* Transmitter empty */
  69 #define UART_LSR_THRE   0x20    /* Transmit-hold-register empty */
  70 #define UART_LSR_BI     0x10    /* Break interrupt indicator */
  71 #define UART_LSR_FE     0x08    /* Frame error indicator */
  72 #define UART_LSR_PE     0x04    /* Parity error indicator */
  73 #define UART_LSR_OE     0x02    /* Overrun error indicator */
  74 #define UART_LSR_DR     0x01    /* Receiver data ready */
  75
  76 struct SerialState {
  77     uint16_t divider;
  78     uint8_t rbr; /* receive register */
  79     uint8_t ier;
  80     uint8_t iir; /* read only */
  81     uint8_t lcr;
  82     uint8_t mcr;
  83     uint8_t lsr; /* read only */
  84     uint8_t msr; /* read only */
  85     uint8_t scr;
  86     /* NOTE: this hidden state is necessary for tx irq generation as
  87        it can be reset while reading iir */
  88     int thr_ipending;
  89     qemu_irq irq;
  90     CharDriverState *chr;
  91     int last_break_enable;
  92     target_phys_addr_t base;
  93     int it_shift;
  94 };
  95
  96 static void serial_update_irq(SerialState *s)
  97 {
  98     if ((s->lsr & UART_LSR_DR) && (s->ier & UART_IER_RDI)) {
  99         s->iir = UART_IIR_RDI;
 100     } else if (s->thr_ipending && (s->ier & UART_IER_THRI)) {
 101         s->iir = UART_IIR_THRI;
 102     } else {
 103         s->iir = UART_IIR_NO_INT;
 104     }
 105     if (s->iir != UART_IIR_NO_INT) {
 106         qemu_irq_raise(s->irq);
 107     } else {
 108         qemu_irq_lower(s->irq);
 109     }
 110 }
 111
 112 static void serial_update_parameters(SerialState *s)
 113 {
 114     int speed, parity, data_bits, stop_bits;
 115     QEMUSerialSetParams ssp;
 116
 117     if (s->lcr & 0x08) {
 118         if (s->lcr & 0x10)
 119             parity = 'E';
 120         else
 121             parity = 'O';
 122     } else {
 123             parity = 'N';
 124     }
 125     if (s->lcr & 0x04)
 126         stop_bits = 2;
 127     else
 128         stop_bits = 1;
 129     data_bits = (s->lcr & 0x03) + 5;
 130     if (s->divider == 0)
 131         return;
 132     speed = 115200 / s->divider;
 133     ssp.speed = speed;
 134     ssp.parity = parity;
 135     ssp.data_bits = data_bits;
 136     ssp.stop_bits = stop_bits;
 137     qemu_chr_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_PARAMS, &ssp);
 138 #if 0
 139     printf("speed=%d parity=%c data=%d stop=%d\n",
 140            speed, parity, data_bits, stop_bits);
 141 #endif
 142 }
 143
 144 static void serial_ioport_write(void *opaque, uint32_t addr, uint32_t val)
 145 {
 146     SerialState *s = opaque;
 147     unsigned char ch;
 148
 149     addr &= 7;
 150 #ifdef DEBUG_SERIAL
 151     printf("serial: write addr=0x%02x val=0x%02x\n", addr, val);
 152 #endif
 153     switch(addr) {
 154     default:
 155     case 0:
 156         if (s->lcr & UART_LCR_DLAB) {
 157             s->divider = (s->divider & 0xff00) | val;
 158             serial_update_parameters(s);
 159         } else {
 160             s->thr_ipending = 0;
 161             s->lsr &= ~UART_LSR_THRE;
 162             serial_update_irq(s);
 163             ch = val;
 164             qemu_chr_write(s->chr, &ch, 1);
 165             s->thr_ipending = 1;
 166             s->lsr |= UART_LSR_THRE;
 167             s->lsr |= UART_LSR_TEMT;
 168             serial_update_irq(s);
 169         }
 170         break;
 171     case 1:
 172         if (s->lcr & UART_LCR_DLAB) {
 173             s->divider = (s->divider & 0x00ff) | (val << 8);
 174             serial_update_parameters(s);
 175         } else {
 176             s->ier = val & 0x0f;
 177             if (s->lsr & UART_LSR_THRE) {
 178                 s->thr_ipending = 1;
 179             }
 180             serial_update_irq(s);
 181         }
 182         break;
 183     case 2:
 184         break;
 185     case 3:
 186         {
 187             int break_enable;
 188             s->lcr = val;
 189             serial_update_parameters(s);
 190             break_enable = (val >> 6) & 1;
 191             if (break_enable != s->last_break_enable) {
 192                 s->last_break_enable = break_enable;
 193                 qemu_chr_ioctl(s->chr, CHR_IOCTL_SERIAL_SET_BREAK,
 194                                &break_enable);
 195             }
 196         }
 197         break;
 198     case 4:
 199         s->mcr = val & 0x1f;
 200         break;
 201     case 5:
 202         break;
 203     case 6:
 204         break;
 205     case 7:
 206         s->scr = val;
 207         break;
 208     }
 209 }
 210
 211 static uint32_t serial_ioport_read(void *opaque, uint32_t addr)
 212 {
 213     SerialState *s = opaque;
 214     uint32_t ret;
 215
 216     addr &= 7;
 217     switch(addr) {
 218     default:
 219     case 0:
 220         if (s->lcr & UART_LCR_DLAB) {
 221             ret = s->divider & 0xff;
 222         } else {
 223             ret = s->rbr;
 224             s->lsr &= ~(UART_LSR_DR | UART_LSR_BI);
 225             serial_update_irq(s);
 226         }
 227         break;
 228     case 1:
 229         if (s->lcr & UART_LCR_DLAB) {
 230             ret = (s->divider >> 8) & 0xff;
 231         } else {
 232             ret = s->ier;
 233         }
 234         break;
 235     case 2:
 236         ret = s->iir;
 237         /* reset THR pending bit */
 238         if ((ret & 0x7) == UART_IIR_THRI)
 239             s->thr_ipending = 0;
 240         serial_update_irq(s);
 241         break;
 242     case 3:
 243         ret = s->lcr;
 244         break;
 245     case 4:
 246         ret = s->mcr;
 247         break;
 248     case 5:
 249         ret = s->lsr;
 250         break;
 251     case 6:
 252         if (s->mcr & UART_MCR_LOOP) {
 253             /* in loopback, the modem output pins are connected to the
 254                inputs */
 255             ret = (s->mcr & 0x0c) << 4;
 256             ret |= (s->mcr & 0x02) << 3;
 257             ret |= (s->mcr & 0x01) << 5;
 258         } else {
 259             ret = s->msr;
 260         }
 261         break;
 262     case 7:
 263         ret = s->scr;
 264         break;
 265     }
 266 #ifdef DEBUG_SERIAL
 267     printf("serial: read addr=0x%02x val=0x%02x\n", addr, ret);
 268 #endif
 269     return ret;
 270 }
 271
 272 static int serial_can_receive(SerialState *s)
 273 {
 274     return !(s->lsr & UART_LSR_DR);
 275 }
 276
 277 static void serial_receive_byte(SerialState *s, int ch)
 278 {
 279     s->rbr = ch;
 280     s->lsr |= UART_LSR_DR;
 281     serial_update_irq(s);
 282 }
 283
 284 static void serial_receive_break(SerialState *s)
 285 {
 286     s->rbr = 0;
 287     s->lsr |= UART_LSR_BI | UART_LSR_DR;
 288     serial_update_irq(s);
 289 }
 290
 291 static int serial_can_receive1(void *opaque)
 292 {
 293     SerialState *s = opaque;
 294     return serial_can_receive(s);
 295 }
 296
 297 static void serial_receive1(void *opaque, const uint8_t *buf, int size)
 298 {
 299     SerialState *s = opaque;
 300     serial_receive_byte(s, buf[0]);
 301 }
 302
 303 static void serial_event(void *opaque, int event)
 304 {
 305     SerialState *s = opaque;
 306     if (event == CHR_EVENT_BREAK)
 307         serial_receive_break(s);
 308 }
 309
 310 static void serial_save(QEMUFile *f, void *opaque)
 311 {
 312     SerialState *s = opaque;
 313
 314     qemu_put_be16s(f,&s->divider);
 315     qemu_put_8s(f,&s->rbr);
 316     qemu_put_8s(f,&s->ier);
 317     qemu_put_8s(f,&s->iir);
 318     qemu_put_8s(f,&s->lcr);
 319     qemu_put_8s(f,&s->mcr);
 320     qemu_put_8s(f,&s->lsr);
 321     qemu_put_8s(f,&s->msr);
 322     qemu_put_8s(f,&s->scr);
 323 }
 324
 325 static int serial_load(QEMUFile *f, void *opaque, int version_id)
 326 {
 327     SerialState *s = opaque;
 328
 329     if(version_id > 2)
 330         return -EINVAL;
 331
 332     if (version_id >= 2)
 333         qemu_get_be16s(f, &s->divider);
 334     else
 335         s->divider = qemu_get_byte(f);
 336     qemu_get_8s(f,&s->rbr);
 337     qemu_get_8s(f,&s->ier);
 338     qemu_get_8s(f,&s->iir);
 339     qemu_get_8s(f,&s->lcr);
 340     qemu_get_8s(f,&s->mcr);
 341     qemu_get_8s(f,&s->lsr);
 342     qemu_get_8s(f,&s->msr);
 343     qemu_get_8s(f,&s->scr);
 344
 345     return 0;
 346 }
 347
 348 /* If fd is zero, it means that the serial device uses the console */
 349 SerialState *serial_init(int base, qemu_irq irq, CharDriverState *chr)
 350 {
 351     SerialState *s;
 352
 353     s = qemu_mallocz(sizeof(SerialState));
 354     if (!s)
 355         return NULL;
 356     s->irq = irq;
 357     s->lsr = UART_LSR_TEMT | UART_LSR_THRE;
 358     s->iir = UART_IIR_NO_INT;
 359     s->msr = UART_MSR_DCD | UART_MSR_DSR | UART_MSR_CTS;
 360
 361     register_savevm("serial", base, 2, serial_save, serial_load, s);
 362
 363     register_ioport_write(base, 8, 1, serial_ioport_write, s);
 364     register_ioport_read(base, 8, 1, serial_ioport_read, s);
 365     s->chr = chr;
 366     qemu_chr_add_handlers(chr, serial_can_receive1, serial_receive1,
 367                           serial_event, s);
 368     return s;
 369 }
 370
 371 /* Memory mapped interface */
 372 uint32_t serial_mm_readb (void *opaque, target_phys_addr_t addr)
 373 {
 374     SerialState *s = opaque;
 375
 376     return serial_ioport_read(s, (addr - s->base) >> s->it_shift) & 0xFF;
 377 }
 378
 379 void serial_mm_writeb (void *opaque,
 380                        target_phys_addr_t addr, uint32_t value)
 381 {
 382     SerialState *s = opaque;
 383
 384     serial_ioport_write(s, (addr - s->base) >> s->it_shift, value & 0xFF);
 385 }
 386
 387 uint32_t serial_mm_readw (void *opaque, target_phys_addr_t addr)
 388 {
 389     SerialState *s = opaque;
 390     uint32_t val;
 391
 392     val = serial_ioport_read(s, (addr - s->base) >> s->it_shift) & 0xFFFF;
 393 #ifdef TARGET_WORDS_BIGENDIAN
 394     val = bswap16(val);
 395 #endif
 396     return val;
 397 }
 398
 399 void serial_mm_writew (void *opaque,
 400                        target_phys_addr_t addr, uint32_t value)
 401 {
 402     SerialState *s = opaque;
 403 #ifdef TARGET_WORDS_BIGENDIAN
 404     value = bswap16(value);
 405 #endif
 406     serial_ioport_write(s, (addr - s->base) >> s->it_shift, value & 0xFFFF);
 407 }
 408
 409 uint32_t serial_mm_readl (void *opaque, target_phys_addr_t addr)
 410 {
 411     SerialState *s = opaque;
 412     uint32_t val;
 413
 414     val = serial_ioport_read(s, (addr - s->base) >> s->it_shift);
 415 #ifdef TARGET_WORDS_BIGENDIAN
 416     val = bswap32(val);
 417 #endif
 418     return val;
 419 }
 420
 421 void serial_mm_writel (void *opaque,
 422                        target_phys_addr_t addr, uint32_t value)
 423 {
 424     SerialState *s = opaque;
 425 #ifdef TARGET_WORDS_BIGENDIAN
 426     value = bswap32(value);
 427 #endif
 428     serial_ioport_write(s, (addr - s->base) >> s->it_shift, value);
 429 }
 430
 431 static CPUReadMemoryFunc *serial_mm_read[] = {
 432     &serial_mm_readb,
 433     &serial_mm_readw,
 434     &serial_mm_readl,
 435 };
 436
 437 static CPUWriteMemoryFunc *serial_mm_write[] = {
 438     &serial_mm_writeb,
 439     &serial_mm_writew,
 440     &serial_mm_writel,
 441 };
 442
 443 SerialState *serial_mm_init (target_phys_addr_t base, int it_shift,
 444                              qemu_irq irq, CharDriverState *chr,
 445                              int ioregister)
 446 {
 447     SerialState *s;
 448     int s_io_memory;
 449
 450     s = qemu_mallocz(sizeof(SerialState));
 451     if (!s)
 452         return NULL;
 453     s->irq = irq;
 454     s->lsr = UART_LSR_TEMT | UART_LSR_THRE;
 455     s->iir = UART_IIR_NO_INT;
 456     s->msr = UART_MSR_DCD | UART_MSR_DSR | UART_MSR_CTS;
 457     s->base = base;
 458     s->it_shift = it_shift;
 459
 460     register_savevm("serial", base, 2, serial_save, serial_load, s);
 461
 462     if (ioregister) {
 463         s_io_memory = cpu_register_io_memory(0, serial_mm_read,
 464                                              serial_mm_write, s);
 465         cpu_register_physical_memory(base, 8 << it_shift, s_io_memory);
 466     }
 467     s->chr = chr;
 468     qemu_chr_add_handlers(chr, serial_can_receive1, serial_receive1,
 469                           serial_event, s);
 470     return s;
 471 }