2 * QEMU IDE Emulation: microdrive (CF / PCMCIA)
4 * Copyright (c) 2003 Fabrice Bellard
5 * Copyright (c) 2006 Openedhand Ltd.
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
27 #include "hw/pcmcia.h"
28 #include "sysemu/dma.h"
30 #include "hw/ide/internal.h"
32 #define TYPE_MICRODRIVE "microdrive"
33 #define MICRODRIVE(obj) OBJECT_CHECK(MicroDriveState, (obj), TYPE_MICRODRIVE)
35 /***********************************************************/
36 /* CF-ATA Microdrive */
38 #define METADATA_SIZE 0x20
40 /* DSCM-1XXXX Microdrive hard disk with CF+ II / PCMCIA interface. */
42 typedef struct MicroDriveState {
44 PCMCIACardState parent_obj;
61 /* Register bitfields */
88 static inline void md_interrupt_update(MicroDriveState *s)
90 PCMCIACardState *card = PCMCIA_CARD(s);
92 if (card->slot == NULL) {
96 qemu_set_irq(card->slot->irq,
97 !(s->stat & STAT_INT) && /* Inverted */
98 !(s->ctrl & (CTRL_IEN | CTRL_SRST)) &&
99 !(s->opt & OPT_SRESET));
102 static void md_set_irq(void *opaque, int irq, int level)
104 MicroDriveState *s = opaque;
109 s->stat &= ~STAT_INT;
112 md_interrupt_update(s);
115 static void md_reset(DeviceState *dev)
117 MicroDriveState *s = MICRODRIVE(dev);
119 s->opt = OPT_MODE_MMAP;
124 ide_bus_reset(&s->bus);
127 static uint8_t md_attr_read(PCMCIACardState *card, uint32_t at)
129 MicroDriveState *s = MICRODRIVE(card);
130 PCMCIACardClass *pcc = PCMCIA_CARD_GET_CLASS(card);
132 if (at < s->attr_base) {
133 if (at < pcc->cis_len) {
143 case 0x00: /* Configuration Option Register */
145 case 0x02: /* Card Configuration Status Register */
146 if (s->ctrl & CTRL_IEN) {
147 return s->stat & ~STAT_INT;
151 case 0x04: /* Pin Replacement Register */
152 return (s->pins & PINS_CRDY) | 0x0c;
153 case 0x06: /* Socket and Copy Register */
157 printf("%s: Bad attribute space register %02x\n", __func__, at);
164 static void md_attr_write(PCMCIACardState *card, uint32_t at, uint8_t value)
166 MicroDriveState *s = MICRODRIVE(card);
171 case 0x00: /* Configuration Option Register */
172 s->opt = value & 0xcf;
173 if (value & OPT_SRESET) {
174 device_reset(DEVICE(s));
176 md_interrupt_update(s);
178 case 0x02: /* Card Configuration Status Register */
179 if ((s->stat ^ value) & STAT_PWRDWN) {
180 s->pins |= PINS_CRDY;
183 s->stat |= value & 0x74;
184 md_interrupt_update(s);
185 /* Word 170 in Identify Device must be equal to STAT_XE */
187 case 0x04: /* Pin Replacement Register */
188 s->pins &= PINS_CRDY;
189 s->pins |= value & PINS_MRDY;
191 case 0x06: /* Socket and Copy Register */
194 printf("%s: Bad attribute space register %02x\n", __func__, at);
198 static uint16_t md_common_read(PCMCIACardState *card, uint32_t at)
200 MicroDriveState *s = MICRODRIVE(card);
205 switch (s->opt & OPT_MODE) {
207 if ((at & ~0x3ff) == 0x400) {
211 case OPT_MODE_IOMAP16:
214 case OPT_MODE_IOMAP1:
215 if ((at & ~0xf) == 0x3f0) {
217 } else if ((at & ~0xf) == 0x1f0) {
221 case OPT_MODE_IOMAP2:
222 if ((at & ~0xf) == 0x370) {
224 } else if ((at & ~0xf) == 0x170) {
230 case 0x0: /* Even RD Data */
232 return ide_data_readw(&s->bus, 0);
234 /* TODO: 8-bit accesses */
238 s->io = ide_data_readw(&s->bus, 0);
241 s->cycle = !s->cycle;
243 case 0x9: /* Odd RD Data */
245 case 0xd: /* Error */
246 return ide_ioport_read(&s->bus, 0x1);
247 case 0xe: /* Alternate Status */
248 ifs = idebus_active_if(&s->bus);
254 case 0xf: /* Device Address */
255 ifs = idebus_active_if(&s->bus);
256 return 0xc2 | ((~ifs->select << 2) & 0x3c);
258 return ide_ioport_read(&s->bus, at);
264 static void md_common_write(PCMCIACardState *card, uint32_t at, uint16_t value)
266 MicroDriveState *s = MICRODRIVE(card);
269 switch (s->opt & OPT_MODE) {
271 if ((at & ~0x3ff) == 0x400) {
275 case OPT_MODE_IOMAP16:
278 case OPT_MODE_IOMAP1:
279 if ((at & ~0xf) == 0x3f0) {
281 } else if ((at & ~0xf) == 0x1f0) {
285 case OPT_MODE_IOMAP2:
286 if ((at & ~0xf) == 0x370) {
288 } else if ((at & ~0xf) == 0x170) {
294 case 0x0: /* Even WR Data */
296 ide_data_writew(&s->bus, 0, value);
299 /* TODO: 8-bit accesses */
301 ide_data_writew(&s->bus, 0, s->io | (value << 8));
303 s->io = value & 0xff;
305 s->cycle = !s->cycle;
308 s->io = value & 0xff;
309 s->cycle = !s->cycle;
311 case 0xd: /* Features */
312 ide_ioport_write(&s->bus, 0x1, value);
314 case 0xe: /* Device Control */
316 if (value & CTRL_SRST) {
317 device_reset(DEVICE(s));
319 md_interrupt_update(s);
322 if (s->stat & STAT_PWRDWN) {
323 s->pins |= PINS_CRDY;
324 s->stat &= ~STAT_PWRDWN;
326 ide_ioport_write(&s->bus, at, value);
330 static const VMStateDescription vmstate_microdrive = {
331 .name = "microdrive",
333 .minimum_version_id = 0,
334 .fields = (VMStateField[]) {
335 VMSTATE_UINT8(opt, MicroDriveState),
336 VMSTATE_UINT8(stat, MicroDriveState),
337 VMSTATE_UINT8(pins, MicroDriveState),
338 VMSTATE_UINT8(ctrl, MicroDriveState),
339 VMSTATE_UINT16(io, MicroDriveState),
340 VMSTATE_UINT8(cycle, MicroDriveState),
341 VMSTATE_IDE_BUS(bus, MicroDriveState),
342 VMSTATE_IDE_DRIVES(bus.ifs, MicroDriveState),
343 VMSTATE_END_OF_LIST()
347 static const uint8_t dscm1xxxx_cis[0x14a] = {
348 [0x000] = CISTPL_DEVICE, /* 5V Device Information */
349 [0x002] = 0x03, /* Tuple length = 4 bytes */
350 [0x004] = 0xdb, /* ID: DTYPE_FUNCSPEC, non WP, DSPEED_150NS */
351 [0x006] = 0x01, /* Size = 2K bytes */
352 [0x008] = CISTPL_ENDMARK,
354 [0x00a] = CISTPL_DEVICE_OC, /* Additional Device Information */
355 [0x00c] = 0x04, /* Tuple length = 4 byest */
356 [0x00e] = 0x03, /* Conditions: Ext = 0, Vcc 3.3V, MWAIT = 1 */
357 [0x010] = 0xdb, /* ID: DTYPE_FUNCSPEC, non WP, DSPEED_150NS */
358 [0x012] = 0x01, /* Size = 2K bytes */
359 [0x014] = CISTPL_ENDMARK,
361 [0x016] = CISTPL_JEDEC_C, /* JEDEC ID */
362 [0x018] = 0x02, /* Tuple length = 2 bytes */
363 [0x01a] = 0xdf, /* PC Card ATA with no Vpp required */
366 [0x01e] = CISTPL_MANFID, /* Manufacture ID */
367 [0x020] = 0x04, /* Tuple length = 4 bytes */
368 [0x022] = 0xa4, /* TPLMID_MANF = 00a4 (IBM) */
370 [0x026] = 0x00, /* PLMID_CARD = 0000 */
373 [0x02a] = CISTPL_VERS_1, /* Level 1 Version */
374 [0x02c] = 0x12, /* Tuple length = 23 bytes */
375 [0x02e] = 0x04, /* Major Version = JEIDA 4.2 / PCMCIA 2.1 */
376 [0x030] = 0x01, /* Minor Version = 1 */
392 [0x050] = CISTPL_ENDMARK,
394 [0x052] = CISTPL_FUNCID, /* Function ID */
395 [0x054] = 0x02, /* Tuple length = 2 bytes */
396 [0x056] = 0x04, /* TPLFID_FUNCTION = Fixed Disk */
397 [0x058] = 0x01, /* TPLFID_SYSINIT: POST = 1, ROM = 0 */
399 [0x05a] = CISTPL_FUNCE, /* Function Extension */
400 [0x05c] = 0x02, /* Tuple length = 2 bytes */
401 [0x05e] = 0x01, /* TPLFE_TYPE = Disk Device Interface */
402 [0x060] = 0x01, /* TPLFE_DATA = PC Card ATA Interface */
404 [0x062] = CISTPL_FUNCE, /* Function Extension */
405 [0x064] = 0x03, /* Tuple length = 3 bytes */
406 [0x066] = 0x02, /* TPLFE_TYPE = Basic PC Card ATA Interface */
407 [0x068] = 0x08, /* TPLFE_DATA: Rotating, Unique, Single */
408 [0x06a] = 0x0f, /* TPLFE_DATA: Sleep, Standby, Idle, Auto */
410 [0x06c] = CISTPL_CONFIG, /* Configuration */
411 [0x06e] = 0x05, /* Tuple length = 5 bytes */
412 [0x070] = 0x01, /* TPCC_RASZ = 2 bytes, TPCC_RMSZ = 1 byte */
413 [0x072] = 0x07, /* TPCC_LAST = 7 */
414 [0x074] = 0x00, /* TPCC_RADR = 0200 */
416 [0x078] = 0x0f, /* TPCC_RMSK = 200, 202, 204, 206 */
418 [0x07a] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
419 [0x07c] = 0x0b, /* Tuple length = 11 bytes */
420 [0x07e] = 0xc0, /* TPCE_INDX = Memory Mode, Default, Iface */
421 [0x080] = 0xc0, /* TPCE_IF = Memory, no BVDs, no WP, READY */
422 [0x082] = 0xa1, /* TPCE_FS = Vcc only, no I/O, Memory, Misc */
423 [0x084] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
424 [0x086] = 0x55, /* NomV: 5.0 V */
425 [0x088] = 0x4d, /* MinV: 4.5 V */
426 [0x08a] = 0x5d, /* MaxV: 5.5 V */
427 [0x08c] = 0x4e, /* Peakl: 450 mA */
428 [0x08e] = 0x08, /* TPCE_MS = 1 window, 1 byte, Host address */
429 [0x090] = 0x00, /* Window descriptor: Window length = 0 */
430 [0x092] = 0x20, /* TPCE_MI: support power down mode, RW */
432 [0x094] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
433 [0x096] = 0x06, /* Tuple length = 6 bytes */
434 [0x098] = 0x00, /* TPCE_INDX = Memory Mode, no Default */
435 [0x09a] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
436 [0x09c] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
437 [0x09e] = 0xb5, /* NomV: 3.3 V */
439 [0x0a2] = 0x3e, /* Peakl: 350 mA */
441 [0x0a4] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
442 [0x0a6] = 0x0d, /* Tuple length = 13 bytes */
443 [0x0a8] = 0xc1, /* TPCE_INDX = I/O and Memory Mode, Default */
444 [0x0aa] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
445 [0x0ac] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
446 [0x0ae] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
447 [0x0b0] = 0x55, /* NomV: 5.0 V */
448 [0x0b2] = 0x4d, /* MinV: 4.5 V */
449 [0x0b4] = 0x5d, /* MaxV: 5.5 V */
450 [0x0b6] = 0x4e, /* Peakl: 450 mA */
451 [0x0b8] = 0x64, /* TPCE_IO = 16-byte boundary, 16/8 accesses */
452 [0x0ba] = 0xf0, /* TPCE_IR = MASK, Level, Pulse, Share */
453 [0x0bc] = 0xff, /* IRQ0..IRQ7 supported */
454 [0x0be] = 0xff, /* IRQ8..IRQ15 supported */
455 [0x0c0] = 0x20, /* TPCE_MI = support power down mode */
457 [0x0c2] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
458 [0x0c4] = 0x06, /* Tuple length = 6 bytes */
459 [0x0c6] = 0x01, /* TPCE_INDX = I/O and Memory Mode */
460 [0x0c8] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
461 [0x0ca] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
462 [0x0cc] = 0xb5, /* NomV: 3.3 V */
464 [0x0d0] = 0x3e, /* Peakl: 350 mA */
466 [0x0d2] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
467 [0x0d4] = 0x12, /* Tuple length = 18 bytes */
468 [0x0d6] = 0xc2, /* TPCE_INDX = I/O Primary Mode */
469 [0x0d8] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
470 [0x0da] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
471 [0x0dc] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
472 [0x0de] = 0x55, /* NomV: 5.0 V */
473 [0x0e0] = 0x4d, /* MinV: 4.5 V */
474 [0x0e2] = 0x5d, /* MaxV: 5.5 V */
475 [0x0e4] = 0x4e, /* Peakl: 450 mA */
476 [0x0e6] = 0xea, /* TPCE_IO = 1K boundary, 16/8 access, Range */
477 [0x0e8] = 0x61, /* Range: 2 fields, 2 bytes addr, 1 byte len */
478 [0x0ea] = 0xf0, /* Field 1 address = 0x01f0 */
480 [0x0ee] = 0x07, /* Address block length = 8 */
481 [0x0f0] = 0xf6, /* Field 2 address = 0x03f6 */
483 [0x0f4] = 0x01, /* Address block length = 2 */
484 [0x0f6] = 0xee, /* TPCE_IR = IRQ E, Level, Pulse, Share */
485 [0x0f8] = 0x20, /* TPCE_MI = support power down mode */
487 [0x0fa] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
488 [0x0fc] = 0x06, /* Tuple length = 6 bytes */
489 [0x0fe] = 0x02, /* TPCE_INDX = I/O Primary Mode, no Default */
490 [0x100] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
491 [0x102] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
492 [0x104] = 0xb5, /* NomV: 3.3 V */
494 [0x108] = 0x3e, /* Peakl: 350 mA */
496 [0x10a] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
497 [0x10c] = 0x12, /* Tuple length = 18 bytes */
498 [0x10e] = 0xc3, /* TPCE_INDX = I/O Secondary Mode, Default */
499 [0x110] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
500 [0x112] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
501 [0x114] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
502 [0x116] = 0x55, /* NomV: 5.0 V */
503 [0x118] = 0x4d, /* MinV: 4.5 V */
504 [0x11a] = 0x5d, /* MaxV: 5.5 V */
505 [0x11c] = 0x4e, /* Peakl: 450 mA */
506 [0x11e] = 0xea, /* TPCE_IO = 1K boundary, 16/8 access, Range */
507 [0x120] = 0x61, /* Range: 2 fields, 2 byte addr, 1 byte len */
508 [0x122] = 0x70, /* Field 1 address = 0x0170 */
510 [0x126] = 0x07, /* Address block length = 8 */
511 [0x128] = 0x76, /* Field 2 address = 0x0376 */
513 [0x12c] = 0x01, /* Address block length = 2 */
514 [0x12e] = 0xee, /* TPCE_IR = IRQ E, Level, Pulse, Share */
515 [0x130] = 0x20, /* TPCE_MI = support power down mode */
517 [0x132] = CISTPL_CFTABLE_ENTRY, /* 16-bit PC Card Configuration */
518 [0x134] = 0x06, /* Tuple length = 6 bytes */
519 [0x136] = 0x03, /* TPCE_INDX = I/O Secondary Mode */
520 [0x138] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
521 [0x13a] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
522 [0x13c] = 0xb5, /* NomV: 3.3 V */
524 [0x140] = 0x3e, /* Peakl: 350 mA */
526 [0x142] = CISTPL_NO_LINK, /* No Link */
527 [0x144] = 0x00, /* Tuple length = 0 bytes */
529 [0x146] = CISTPL_END, /* Tuple End */
532 #define TYPE_DSCM1XXXX "dscm1xxxx"
534 static int dscm1xxxx_attach(PCMCIACardState *card)
536 MicroDriveState *md = MICRODRIVE(card);
537 PCMCIACardClass *pcc = PCMCIA_CARD_GET_CLASS(card);
539 md->attr_base = pcc->cis[0x74] | (pcc->cis[0x76] << 8);
542 device_reset(DEVICE(md));
543 md_interrupt_update(md);
548 static int dscm1xxxx_detach(PCMCIACardState *card)
550 MicroDriveState *md = MICRODRIVE(card);
552 device_reset(DEVICE(md));
556 PCMCIACardState *dscm1xxxx_init(DriveInfo *dinfo)
560 md = MICRODRIVE(object_new(TYPE_DSCM1XXXX));
561 qdev_init_nofail(DEVICE(md));
564 ide_create_drive(&md->bus, 0, dinfo);
566 md->bus.ifs[0].drive_kind = IDE_CFATA;
567 md->bus.ifs[0].mdata_size = METADATA_SIZE;
568 md->bus.ifs[0].mdata_storage = g_malloc0(METADATA_SIZE);
570 return PCMCIA_CARD(md);
573 static void dscm1xxxx_class_init(ObjectClass *oc, void *data)
575 PCMCIACardClass *pcc = PCMCIA_CARD_CLASS(oc);
576 DeviceClass *dc = DEVICE_CLASS(oc);
578 pcc->cis = dscm1xxxx_cis;
579 pcc->cis_len = sizeof(dscm1xxxx_cis);
581 pcc->attach = dscm1xxxx_attach;
582 pcc->detach = dscm1xxxx_detach;
583 /* Reason: Needs to be wired-up in code, see dscm1xxxx_init() */
584 dc->user_creatable = false;
587 static const TypeInfo dscm1xxxx_type_info = {
588 .name = TYPE_DSCM1XXXX,
589 .parent = TYPE_MICRODRIVE,
590 .class_init = dscm1xxxx_class_init,
593 static void microdrive_realize(DeviceState *dev, Error **errp)
595 MicroDriveState *md = MICRODRIVE(dev);
597 ide_init2(&md->bus, qemu_allocate_irq(md_set_irq, md, 0));
600 static void microdrive_init(Object *obj)
602 MicroDriveState *md = MICRODRIVE(obj);
604 ide_bus_new(&md->bus, sizeof(md->bus), DEVICE(obj), 0, 1);
607 static void microdrive_class_init(ObjectClass *oc, void *data)
609 DeviceClass *dc = DEVICE_CLASS(oc);
610 PCMCIACardClass *pcc = PCMCIA_CARD_CLASS(oc);
612 pcc->attr_read = md_attr_read;
613 pcc->attr_write = md_attr_write;
614 pcc->common_read = md_common_read;
615 pcc->common_write = md_common_write;
616 pcc->io_read = md_common_read;
617 pcc->io_write = md_common_write;
619 dc->realize = microdrive_realize;
620 dc->reset = md_reset;
621 dc->vmsd = &vmstate_microdrive;
624 static const TypeInfo microdrive_type_info = {
625 .name = TYPE_MICRODRIVE,
626 .parent = TYPE_PCMCIA_CARD,
627 .instance_size = sizeof(MicroDriveState),
628 .instance_init = microdrive_init,
630 .class_init = microdrive_class_init,
633 static void microdrive_register_types(void)
635 type_register_static(µdrive_type_info);
636 type_register_static(&dscm1xxxx_type_info);
639 type_init(microdrive_register_types)