hw/ide/macio.c

   1 /*
   2  * QEMU IDE Emulation: MacIO support.
   3  *
   4  * Copyright (c) 2003 Fabrice Bellard
   5  * Copyright (c) 2006 Openedhand Ltd.
   6  *
   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  */
  25 #include "qemu/osdep.h"
  26 #include "hw/hw.h"
  27 #include "hw/ppc/mac.h"
  28 #include "hw/ppc/mac_dbdma.h"
  29 #include "sysemu/block-backend.h"
  30 #include "sysemu/dma.h"
  31
  32 #include <hw/ide/internal.h>
  33
  34 /* debug MACIO */
  35 // #define DEBUG_MACIO
  36
  37 #ifdef DEBUG_MACIO
  38 static const int debug_macio = 1;
  39 #else
  40 static const int debug_macio = 0;
  41 #endif
  42
  43 #define MACIO_DPRINTF(fmt, ...) do { \
  44         if (debug_macio) { \
  45             printf(fmt , ## __VA_ARGS__); \
  46         } \
  47     } while (0)
  48
  49
  50 /***********************************************************/
  51 /* MacIO based PowerPC IDE */
  52
  53 #define MACIO_PAGE_SIZE 4096
  54
  55 /*
  56  * Unaligned DMA read/write access functions required for OS X/Darwin which
  57  * don't perform DMA transactions on sector boundaries. These functions are
  58  * modelled on bdrv_co_preadv()/bdrv_co_pwritev() and so should be easy to
  59  * remove if the unaligned block APIs are ever exposed.
  60  */
  61
  62 static void pmac_dma_read(BlockBackend *blk,
  63                           int64_t offset, unsigned int bytes,
  64                           void (*cb)(void *opaque, int ret), void *opaque)
  65 {
  66     DBDMA_io *io = opaque;
  67     MACIOIDEState *m = io->opaque;
  68     IDEState *s = idebus_active_if(&m->bus);
  69     dma_addr_t dma_addr;
  70     int64_t sector_num;
  71     int nsector;
  72     uint64_t align = BDRV_SECTOR_SIZE;
  73     size_t head_bytes, tail_bytes;
  74
  75     qemu_iovec_destroy(&io->iov);
  76     qemu_iovec_init(&io->iov, io->len / MACIO_PAGE_SIZE + 1);
  77
  78     sector_num = (offset >> 9);
  79     nsector = (io->len >> 9);
  80
  81     MACIO_DPRINTF("--- DMA read transfer (0x%" HWADDR_PRIx ",0x%x): "
  82                   "sector_num: %" PRId64 ", nsector: %d\n", io->addr, io->len,
  83                   sector_num, nsector);
  84
  85     dma_addr = io->addr;
  86     io->dir = DMA_DIRECTION_FROM_DEVICE;
  87     io->dma_len = io->len;
  88     io->dma_mem = dma_memory_map(&address_space_memory, dma_addr, &io->dma_len,
  89                                  io->dir);
  90
  91     if (offset & (align - 1)) {
  92         head_bytes = offset & (align - 1);
  93
  94         MACIO_DPRINTF("--- DMA unaligned head: sector %" PRId64 ", "
  95                       "discarding %zu bytes\n", sector_num, head_bytes);
  96
  97         qemu_iovec_add(&io->iov, &io->head_remainder, head_bytes);
  98
  99         bytes += offset & (align - 1);
 100         offset = offset & ~(align - 1);
 101     }
 102
 103     qemu_iovec_add(&io->iov, io->dma_mem, io->len);
 104
 105     if ((offset + bytes) & (align - 1)) {
 106         tail_bytes = (offset + bytes) & (align - 1);
 107
 108         MACIO_DPRINTF("--- DMA unaligned tail: sector %" PRId64 ", "
 109                       "discarding bytes %zu\n", sector_num, tail_bytes);
 110
 111         qemu_iovec_add(&io->iov, &io->tail_remainder, align - tail_bytes);
 112         bytes = ROUND_UP(bytes, align);
 113     }
 114
 115     s->io_buffer_size -= io->len;
 116     s->io_buffer_index += io->len;
 117
 118     io->len = 0;
 119
 120     MACIO_DPRINTF("--- Block read transfer - sector_num: %" PRIx64 "  "
 121                   "nsector: %x\n", (offset >> 9), (bytes >> 9));
 122
 123     s->bus->dma->aiocb = blk_aio_preadv(blk, offset, &io->iov, 0, cb, io);
 124 }
 125
 126 static void pmac_dma_write(BlockBackend *blk,
 127                          int64_t offset, int bytes,
 128                          void (*cb)(void *opaque, int ret), void *opaque)
 129 {
 130     DBDMA_io *io = opaque;
 131     MACIOIDEState *m = io->opaque;
 132     IDEState *s = idebus_active_if(&m->bus);
 133     dma_addr_t dma_addr;
 134     int64_t sector_num;
 135     int nsector;
 136     uint64_t align = BDRV_SECTOR_SIZE;
 137     size_t head_bytes, tail_bytes;
 138     bool unaligned_head = false, unaligned_tail = false;
 139
 140     qemu_iovec_destroy(&io->iov);
 141     qemu_iovec_init(&io->iov, io->len / MACIO_PAGE_SIZE + 1);
 142
 143     sector_num = (offset >> 9);
 144     nsector = (io->len >> 9);
 145
 146     MACIO_DPRINTF("--- DMA write transfer (0x%" HWADDR_PRIx ",0x%x): "
 147                   "sector_num: %" PRId64 ", nsector: %d\n", io->addr, io->len,
 148                   sector_num, nsector);
 149
 150     dma_addr = io->addr;
 151     io->dir = DMA_DIRECTION_TO_DEVICE;
 152     io->dma_len = io->len;
 153     io->dma_mem = dma_memory_map(&address_space_memory, dma_addr, &io->dma_len,
 154                                  io->dir);
 155
 156     if (offset & (align - 1)) {
 157         head_bytes = offset & (align - 1);
 158         sector_num = ((offset & ~(align - 1)) >> 9);
 159
 160         MACIO_DPRINTF("--- DMA unaligned head: pre-reading head sector %"
 161                       PRId64 "\n", sector_num);
 162
 163         blk_pread(s->blk, (sector_num << 9), &io->head_remainder, align);
 164
 165         qemu_iovec_add(&io->iov, &io->head_remainder, head_bytes);
 166         qemu_iovec_add(&io->iov, io->dma_mem, io->len);
 167
 168         bytes += offset & (align - 1);
 169         offset = offset & ~(align - 1);
 170
 171         unaligned_head = true;
 172     }
 173
 174     if ((offset + bytes) & (align - 1)) {
 175         tail_bytes = (offset + bytes) & (align - 1);
 176         sector_num = (((offset + bytes) & ~(align - 1)) >> 9);
 177
 178         MACIO_DPRINTF("--- DMA unaligned tail: pre-reading tail sector %"
 179                       PRId64 "\n", sector_num);
 180
 181         blk_pread(s->blk, (sector_num << 9), &io->tail_remainder, align);
 182
 183         if (!unaligned_head) {
 184             qemu_iovec_add(&io->iov, io->dma_mem, io->len);
 185         }
 186
 187         qemu_iovec_add(&io->iov, &io->tail_remainder + tail_bytes,
 188                        align - tail_bytes);
 189
 190         bytes = ROUND_UP(bytes, align);
 191
 192         unaligned_tail = true;
 193     }
 194
 195     if (!unaligned_head && !unaligned_tail) {
 196         qemu_iovec_add(&io->iov, io->dma_mem, io->len);
 197     }
 198
 199     s->io_buffer_size -= io->len;
 200     s->io_buffer_index += io->len;
 201
 202     io->len = 0;
 203
 204     MACIO_DPRINTF("--- Block write transfer - sector_num: %" PRIx64 "  "
 205                   "nsector: %x\n", (offset >> 9), (bytes >> 9));
 206
 207     s->bus->dma->aiocb = blk_aio_pwritev(blk, offset, &io->iov, 0, cb, io);
 208 }
 209
 210 static void pmac_dma_trim(BlockBackend *blk,
 211                         int64_t offset, int bytes,
 212                         void (*cb)(void *opaque, int ret), void *opaque)
 213 {
 214     DBDMA_io *io = opaque;
 215     MACIOIDEState *m = io->opaque;
 216     IDEState *s = idebus_active_if(&m->bus);
 217     dma_addr_t dma_addr;
 218
 219     qemu_iovec_destroy(&io->iov);
 220     qemu_iovec_init(&io->iov, io->len / MACIO_PAGE_SIZE + 1);
 221
 222     dma_addr = io->addr;
 223     io->dir = DMA_DIRECTION_TO_DEVICE;
 224     io->dma_len = io->len;
 225     io->dma_mem = dma_memory_map(&address_space_memory, dma_addr, &io->dma_len,
 226                                  io->dir);
 227
 228     qemu_iovec_add(&io->iov, io->dma_mem, io->len);
 229     s->io_buffer_size -= io->len;
 230     s->io_buffer_index += io->len;
 231     io->len = 0;
 232
 233     s->bus->dma->aiocb = ide_issue_trim(offset, &io->iov, cb, io, blk);
 234 }
 235
 236 static void pmac_ide_atapi_transfer_cb(void *opaque, int ret)
 237 {
 238     DBDMA_io *io = opaque;
 239     MACIOIDEState *m = io->opaque;
 240     IDEState *s = idebus_active_if(&m->bus);
 241     int64_t offset;
 242
 243     MACIO_DPRINTF("pmac_ide_atapi_transfer_cb\n");
 244
 245     if (ret < 0) {
 246         MACIO_DPRINTF("DMA error: %d\n", ret);
 247         ide_atapi_io_error(s, ret);
 248         goto done;
 249     }
 250
 251     if (!m->dma_active) {
 252         MACIO_DPRINTF("waiting for data (%#x - %#x - %x)\n",
 253                       s->nsector, io->len, s->status);
 254         /* data not ready yet, wait for the channel to get restarted */
 255         io->processing = false;
 256         return;
 257     }
 258
 259     if (s->io_buffer_size <= 0) {
 260         MACIO_DPRINTF("End of IDE transfer\n");
 261         ide_atapi_cmd_ok(s);
 262         m->dma_active = false;
 263         goto done;
 264     }
 265
 266     if (io->len == 0) {
 267         MACIO_DPRINTF("End of DMA transfer\n");
 268         goto done;
 269     }
 270
 271     if (s->lba == -1) {
 272         /* Non-block ATAPI transfer - just copy to RAM */
 273         s->io_buffer_size = MIN(s->io_buffer_size, io->len);
 274         dma_memory_write(&address_space_memory, io->addr, s->io_buffer,
 275                          s->io_buffer_size);
 276         ide_atapi_cmd_ok(s);
 277         m->dma_active = false;
 278         goto done;
 279     }
 280
 281     /* Calculate current offset */
 282     offset = ((int64_t)s->lba << 11) + s->io_buffer_index;
 283
 284     pmac_dma_read(s->blk, offset, io->len, pmac_ide_atapi_transfer_cb, io);
 285     return;
 286
 287 done:
 288     dma_memory_unmap(&address_space_memory, io->dma_mem, io->dma_len,
 289                      io->dir, io->dma_len);
 290
 291     if (ret < 0) {
 292         block_acct_failed(blk_get_stats(s->blk), &s->acct);
 293     } else {
 294         block_acct_done(blk_get_stats(s->blk), &s->acct);
 295     }
 296
 297     ide_set_inactive(s, false);
 298     io->dma_end(opaque);
 299 }
 300
 301 static void pmac_ide_transfer_cb(void *opaque, int ret)
 302 {
 303     DBDMA_io *io = opaque;
 304     MACIOIDEState *m = io->opaque;
 305     IDEState *s = idebus_active_if(&m->bus);
 306     int64_t offset;
 307
 308     MACIO_DPRINTF("pmac_ide_transfer_cb\n");
 309
 310     if (ret < 0) {
 311         MACIO_DPRINTF("DMA error: %d\n", ret);
 312         ide_dma_error(s);
 313         goto done;
 314     }
 315
 316     if (!m->dma_active) {
 317         MACIO_DPRINTF("waiting for data (%#x - %#x - %x)\n",
 318                       s->nsector, io->len, s->status);
 319         /* data not ready yet, wait for the channel to get restarted */
 320         io->processing = false;
 321         return;
 322     }
 323
 324     if (s->io_buffer_size <= 0) {
 325         MACIO_DPRINTF("End of IDE transfer\n");
 326         s->status = READY_STAT | SEEK_STAT;
 327         ide_set_irq(s->bus);
 328         m->dma_active = false;
 329         goto done;
 330     }
 331
 332     if (io->len == 0) {
 333         MACIO_DPRINTF("End of DMA transfer\n");
 334         goto done;
 335     }
 336
 337     /* Calculate number of sectors */
 338     offset = (ide_get_sector(s) << 9) + s->io_buffer_index;
 339
 340     switch (s->dma_cmd) {
 341     case IDE_DMA_READ:
 342         pmac_dma_read(s->blk, offset, io->len, pmac_ide_transfer_cb, io);
 343         break;
 344     case IDE_DMA_WRITE:
 345         pmac_dma_write(s->blk, offset, io->len, pmac_ide_transfer_cb, io);
 346         break;
 347     case IDE_DMA_TRIM:
 348         pmac_dma_trim(s->blk, offset, io->len, pmac_ide_transfer_cb, io);
 349         break;
 350     default:
 351         abort();
 352     }
 353
 354     return;
 355
 356 done:
 357     dma_memory_unmap(&address_space_memory, io->dma_mem, io->dma_len,
 358                      io->dir, io->dma_len);
 359
 360     if (s->dma_cmd == IDE_DMA_READ || s->dma_cmd == IDE_DMA_WRITE) {
 361         if (ret < 0) {
 362             block_acct_failed(blk_get_stats(s->blk), &s->acct);
 363         } else {
 364             block_acct_done(blk_get_stats(s->blk), &s->acct);
 365         }
 366     }
 367
 368     ide_set_inactive(s, false);
 369     io->dma_end(opaque);
 370 }
 371
 372 static void pmac_ide_transfer(DBDMA_io *io)
 373 {
 374     MACIOIDEState *m = io->opaque;
 375     IDEState *s = idebus_active_if(&m->bus);
 376
 377     MACIO_DPRINTF("\n");
 378
 379     if (s->drive_kind == IDE_CD) {
 380         block_acct_start(blk_get_stats(s->blk), &s->acct, io->len,
 381                          BLOCK_ACCT_READ);
 382
 383         pmac_ide_atapi_transfer_cb(io, 0);
 384         return;
 385     }
 386
 387     switch (s->dma_cmd) {
 388     case IDE_DMA_READ:
 389         block_acct_start(blk_get_stats(s->blk), &s->acct, io->len,
 390                          BLOCK_ACCT_READ);
 391         break;
 392     case IDE_DMA_WRITE:
 393         block_acct_start(blk_get_stats(s->blk), &s->acct, io->len,
 394                          BLOCK_ACCT_WRITE);
 395         break;
 396     default:
 397         break;
 398     }
 399
 400     pmac_ide_transfer_cb(io, 0);
 401 }
 402
 403 static void pmac_ide_flush(DBDMA_io *io)
 404 {
 405     MACIOIDEState *m = io->opaque;
 406     IDEState *s = idebus_active_if(&m->bus);
 407
 408     if (s->bus->dma->aiocb) {
 409         blk_drain_all();
 410     }
 411 }
 412
 413 /* PowerMac IDE memory IO */
 414 static void pmac_ide_writeb (void *opaque,
 415                              hwaddr addr, uint32_t val)
 416 {
 417     MACIOIDEState *d = opaque;
 418
 419     addr = (addr & 0xFFF) >> 4;
 420     switch (addr) {
 421     case 1 ... 7:
 422         ide_ioport_write(&d->bus, addr, val);
 423         break;
 424     case 8:
 425     case 22:
 426         ide_cmd_write(&d->bus, 0, val);
 427         break;
 428     default:
 429         break;
 430     }
 431 }
 432
 433 static uint32_t pmac_ide_readb (void *opaque,hwaddr addr)
 434 {
 435     uint8_t retval;
 436     MACIOIDEState *d = opaque;
 437
 438     addr = (addr & 0xFFF) >> 4;
 439     switch (addr) {
 440     case 1 ... 7:
 441         retval = ide_ioport_read(&d->bus, addr);
 442         break;
 443     case 8:
 444     case 22:
 445         retval = ide_status_read(&d->bus, 0);
 446         break;
 447     default:
 448         retval = 0xFF;
 449         break;
 450     }
 451     return retval;
 452 }
 453
 454 static void pmac_ide_writew (void *opaque,
 455                              hwaddr addr, uint32_t val)
 456 {
 457     MACIOIDEState *d = opaque;
 458
 459     addr = (addr & 0xFFF) >> 4;
 460     val = bswap16(val);
 461     if (addr == 0) {
 462         ide_data_writew(&d->bus, 0, val);
 463     }
 464 }
 465
 466 static uint32_t pmac_ide_readw (void *opaque,hwaddr addr)
 467 {
 468     uint16_t retval;
 469     MACIOIDEState *d = opaque;
 470
 471     addr = (addr & 0xFFF) >> 4;
 472     if (addr == 0) {
 473         retval = ide_data_readw(&d->bus, 0);
 474     } else {
 475         retval = 0xFFFF;
 476     }
 477     retval = bswap16(retval);
 478     return retval;
 479 }
 480
 481 static void pmac_ide_writel (void *opaque,
 482                              hwaddr addr, uint32_t val)
 483 {
 484     MACIOIDEState *d = opaque;
 485
 486     addr = (addr & 0xFFF) >> 4;
 487     val = bswap32(val);
 488     if (addr == 0) {
 489         ide_data_writel(&d->bus, 0, val);
 490     }
 491 }
 492
 493 static uint32_t pmac_ide_readl (void *opaque,hwaddr addr)
 494 {
 495     uint32_t retval;
 496     MACIOIDEState *d = opaque;
 497
 498     addr = (addr & 0xFFF) >> 4;
 499     if (addr == 0) {
 500         retval = ide_data_readl(&d->bus, 0);
 501     } else {
 502         retval = 0xFFFFFFFF;
 503     }
 504     retval = bswap32(retval);
 505     return retval;
 506 }
 507
 508 static const MemoryRegionOps pmac_ide_ops = {
 509     .old_mmio = {
 510         .write = {
 511             pmac_ide_writeb,
 512             pmac_ide_writew,
 513             pmac_ide_writel,
 514         },
 515         .read = {
 516             pmac_ide_readb,
 517             pmac_ide_readw,
 518             pmac_ide_readl,
 519         },
 520     },
 521     .endianness = DEVICE_NATIVE_ENDIAN,
 522 };
 523
 524 static const VMStateDescription vmstate_pmac = {
 525     .name = "ide",
 526     .version_id = 4,
 527     .minimum_version_id = 0,
 528     .fields = (VMStateField[]) {
 529         VMSTATE_IDE_BUS(bus, MACIOIDEState),
 530         VMSTATE_IDE_DRIVES(bus.ifs, MACIOIDEState),
 531         VMSTATE_BOOL(dma_active, MACIOIDEState),
 532         VMSTATE_END_OF_LIST()
 533     }
 534 };
 535
 536 static void macio_ide_reset(DeviceState *dev)
 537 {
 538     MACIOIDEState *d = MACIO_IDE(dev);
 539
 540     ide_bus_reset(&d->bus);
 541 }
 542
 543 static int ide_nop_int(IDEDMA *dma, int x)
 544 {
 545     return 0;
 546 }
 547
 548 static int32_t ide_nop_int32(IDEDMA *dma, int32_t l)
 549 {
 550     return 0;
 551 }
 552
 553 static void ide_dbdma_start(IDEDMA *dma, IDEState *s,
 554                             BlockCompletionFunc *cb)
 555 {
 556     MACIOIDEState *m = container_of(dma, MACIOIDEState, dma);
 557
 558     s->io_buffer_index = 0;
 559     if (s->drive_kind == IDE_CD) {
 560         s->io_buffer_size = s->packet_transfer_size;
 561     } else {
 562         s->io_buffer_size = s->nsector * BDRV_SECTOR_SIZE;
 563     }
 564
 565     MACIO_DPRINTF("\n\n------------ IDE transfer\n");
 566     MACIO_DPRINTF("buffer_size: %x   buffer_index: %x\n",
 567                   s->io_buffer_size, s->io_buffer_index);
 568     MACIO_DPRINTF("lba: %x    size: %x\n", s->lba, s->io_buffer_size);
 569     MACIO_DPRINTF("-------------------------\n");
 570
 571     m->dma_active = true;
 572     DBDMA_kick(m->dbdma);
 573 }
 574
 575 static const IDEDMAOps dbdma_ops = {
 576     .start_dma      = ide_dbdma_start,
 577     .prepare_buf    = ide_nop_int32,
 578     .rw_buf         = ide_nop_int,
 579 };
 580
 581 static void macio_ide_realizefn(DeviceState *dev, Error **errp)
 582 {
 583     MACIOIDEState *s = MACIO_IDE(dev);
 584
 585     ide_init2(&s->bus, s->irq);
 586
 587     /* Register DMA callbacks */
 588     s->dma.ops = &dbdma_ops;
 589     s->bus.dma = &s->dma;
 590 }
 591
 592 static void macio_ide_initfn(Object *obj)
 593 {
 594     SysBusDevice *d = SYS_BUS_DEVICE(obj);
 595     MACIOIDEState *s = MACIO_IDE(obj);
 596
 597     ide_bus_new(&s->bus, sizeof(s->bus), DEVICE(obj), 0, 2);
 598     memory_region_init_io(&s->mem, obj, &pmac_ide_ops, s, "pmac-ide", 0x1000);
 599     sysbus_init_mmio(d, &s->mem);
 600     sysbus_init_irq(d, &s->irq);
 601     sysbus_init_irq(d, &s->dma_irq);
 602 }
 603
 604 static void macio_ide_class_init(ObjectClass *oc, void *data)
 605 {
 606     DeviceClass *dc = DEVICE_CLASS(oc);
 607
 608     dc->realize = macio_ide_realizefn;
 609     dc->reset = macio_ide_reset;
 610     dc->vmsd = &vmstate_pmac;
 611     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 612 }
 613
 614 static const TypeInfo macio_ide_type_info = {
 615     .name = TYPE_MACIO_IDE,
 616     .parent = TYPE_SYS_BUS_DEVICE,
 617     .instance_size = sizeof(MACIOIDEState),
 618     .instance_init = macio_ide_initfn,
 619     .class_init = macio_ide_class_init,
 620 };
 621
 622 static void macio_ide_register_types(void)
 623 {
 624     type_register_static(&macio_ide_type_info);
 625 }
 626
 627 /* hd_table must contain 2 block drivers */
 628 void macio_ide_init_drives(MACIOIDEState *s, DriveInfo **hd_table)
 629 {
 630     int i;
 631
 632     for (i = 0; i < 2; i++) {
 633         if (hd_table[i]) {
 634             ide_create_drive(&s->bus, i, hd_table[i]);
 635         }
 636     }
 637 }
 638
 639 void macio_ide_register_dma(MACIOIDEState *s, void *dbdma, int channel)
 640 {
 641     s->dbdma = dbdma;
 642     DBDMA_register_channel(dbdma, channel, s->dma_irq,
 643                            pmac_ide_transfer, pmac_ide_flush, s);
 644 }
 645
 646 type_init(macio_ide_register_types)