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
26 #include "qemu/osdep.h"
27 #include "hw/pcmcia.h"
28 #include "migration/vmstate.h"
29 #include "qemu/module.h"
30 #include "sysemu/dma.h"
32 #include "hw/ide/internal.h"
34 #define TYPE_MICRODRIVE "microdrive"
35 #define MICRODRIVE(obj) OBJECT_CHECK(MicroDriveState, (obj), TYPE_MICRODRIVE)
37 /***********************************************************/
38 /* CF-ATA Microdrive */
40 #define METADATA_SIZE 0x20
42 /* DSCM-1XXXX Microdrive hard disk with CF+ II / PCMCIA interface. */
44 typedef struct MicroDriveState
{
46 PCMCIACardState parent_obj
;
63 /* Register bitfields */
90 static inline void md_interrupt_update(MicroDriveState
*s
)
92 PCMCIACardState
*card
= PCMCIA_CARD(s
);
94 if (card
->slot
== NULL
) {
98 qemu_set_irq(card
->slot
->irq
,
99 !(s
->stat
& STAT_INT
) && /* Inverted */
100 !(s
->ctrl
& (CTRL_IEN
| CTRL_SRST
)) &&
101 !(s
->opt
& OPT_SRESET
));
104 static void md_set_irq(void *opaque
, int irq
, int level
)
106 MicroDriveState
*s
= opaque
;
111 s
->stat
&= ~STAT_INT
;
114 md_interrupt_update(s
);
117 static void md_reset(DeviceState
*dev
)
119 MicroDriveState
*s
= MICRODRIVE(dev
);
121 s
->opt
= OPT_MODE_MMAP
;
126 ide_bus_reset(&s
->bus
);
129 static uint8_t md_attr_read(PCMCIACardState
*card
, uint32_t at
)
131 MicroDriveState
*s
= MICRODRIVE(card
);
132 PCMCIACardClass
*pcc
= PCMCIA_CARD_GET_CLASS(card
);
134 if (at
< s
->attr_base
) {
135 if (at
< pcc
->cis_len
) {
145 case 0x00: /* Configuration Option Register */
147 case 0x02: /* Card Configuration Status Register */
148 if (s
->ctrl
& CTRL_IEN
) {
149 return s
->stat
& ~STAT_INT
;
153 case 0x04: /* Pin Replacement Register */
154 return (s
->pins
& PINS_CRDY
) | 0x0c;
155 case 0x06: /* Socket and Copy Register */
159 printf("%s: Bad attribute space register %02x\n", __func__
, at
);
166 static void md_attr_write(PCMCIACardState
*card
, uint32_t at
, uint8_t value
)
168 MicroDriveState
*s
= MICRODRIVE(card
);
173 case 0x00: /* Configuration Option Register */
174 s
->opt
= value
& 0xcf;
175 if (value
& OPT_SRESET
) {
176 device_legacy_reset(DEVICE(s
));
178 md_interrupt_update(s
);
180 case 0x02: /* Card Configuration Status Register */
181 if ((s
->stat
^ value
) & STAT_PWRDWN
) {
182 s
->pins
|= PINS_CRDY
;
185 s
->stat
|= value
& 0x74;
186 md_interrupt_update(s
);
187 /* Word 170 in Identify Device must be equal to STAT_XE */
189 case 0x04: /* Pin Replacement Register */
190 s
->pins
&= PINS_CRDY
;
191 s
->pins
|= value
& PINS_MRDY
;
193 case 0x06: /* Socket and Copy Register */
196 printf("%s: Bad attribute space register %02x\n", __func__
, at
);
200 static uint16_t md_common_read(PCMCIACardState
*card
, uint32_t at
)
202 MicroDriveState
*s
= MICRODRIVE(card
);
207 switch (s
->opt
& OPT_MODE
) {
209 if ((at
& ~0x3ff) == 0x400) {
213 case OPT_MODE_IOMAP16
:
216 case OPT_MODE_IOMAP1
:
217 if ((at
& ~0xf) == 0x3f0) {
219 } else if ((at
& ~0xf) == 0x1f0) {
223 case OPT_MODE_IOMAP2
:
224 if ((at
& ~0xf) == 0x370) {
226 } else if ((at
& ~0xf) == 0x170) {
232 case 0x0: /* Even RD Data */
234 return ide_data_readw(&s
->bus
, 0);
236 /* TODO: 8-bit accesses */
240 s
->io
= ide_data_readw(&s
->bus
, 0);
243 s
->cycle
= !s
->cycle
;
245 case 0x9: /* Odd RD Data */
247 case 0xd: /* Error */
248 return ide_ioport_read(&s
->bus
, 0x1);
249 case 0xe: /* Alternate Status */
250 ifs
= idebus_active_if(&s
->bus
);
256 case 0xf: /* Device Address */
257 ifs
= idebus_active_if(&s
->bus
);
258 return 0xc2 | ((~ifs
->select
<< 2) & 0x3c);
260 return ide_ioport_read(&s
->bus
, at
);
266 static void md_common_write(PCMCIACardState
*card
, uint32_t at
, uint16_t value
)
268 MicroDriveState
*s
= MICRODRIVE(card
);
271 switch (s
->opt
& OPT_MODE
) {
273 if ((at
& ~0x3ff) == 0x400) {
277 case OPT_MODE_IOMAP16
:
280 case OPT_MODE_IOMAP1
:
281 if ((at
& ~0xf) == 0x3f0) {
283 } else if ((at
& ~0xf) == 0x1f0) {
287 case OPT_MODE_IOMAP2
:
288 if ((at
& ~0xf) == 0x370) {
290 } else if ((at
& ~0xf) == 0x170) {
296 case 0x0: /* Even WR Data */
298 ide_data_writew(&s
->bus
, 0, value
);
301 /* TODO: 8-bit accesses */
303 ide_data_writew(&s
->bus
, 0, s
->io
| (value
<< 8));
305 s
->io
= value
& 0xff;
307 s
->cycle
= !s
->cycle
;
310 s
->io
= value
& 0xff;
311 s
->cycle
= !s
->cycle
;
313 case 0xd: /* Features */
314 ide_ioport_write(&s
->bus
, 0x1, value
);
316 case 0xe: /* Device Control */
318 if (value
& CTRL_SRST
) {
319 device_legacy_reset(DEVICE(s
));
321 md_interrupt_update(s
);
324 if (s
->stat
& STAT_PWRDWN
) {
325 s
->pins
|= PINS_CRDY
;
326 s
->stat
&= ~STAT_PWRDWN
;
328 ide_ioport_write(&s
->bus
, at
, value
);
332 static const VMStateDescription vmstate_microdrive
= {
333 .name
= "microdrive",
335 .minimum_version_id
= 0,
336 .fields
= (VMStateField
[]) {
337 VMSTATE_UINT8(opt
, MicroDriveState
),
338 VMSTATE_UINT8(stat
, MicroDriveState
),
339 VMSTATE_UINT8(pins
, MicroDriveState
),
340 VMSTATE_UINT8(ctrl
, MicroDriveState
),
341 VMSTATE_UINT16(io
, MicroDriveState
),
342 VMSTATE_UINT8(cycle
, MicroDriveState
),
343 VMSTATE_IDE_BUS(bus
, MicroDriveState
),
344 VMSTATE_IDE_DRIVES(bus
.ifs
, MicroDriveState
),
345 VMSTATE_END_OF_LIST()
349 static const uint8_t dscm1xxxx_cis
[0x14a] = {
350 [0x000] = CISTPL_DEVICE
, /* 5V Device Information */
351 [0x002] = 0x03, /* Tuple length = 4 bytes */
352 [0x004] = 0xdb, /* ID: DTYPE_FUNCSPEC, non WP, DSPEED_150NS */
353 [0x006] = 0x01, /* Size = 2K bytes */
354 [0x008] = CISTPL_ENDMARK
,
356 [0x00a] = CISTPL_DEVICE_OC
, /* Additional Device Information */
357 [0x00c] = 0x04, /* Tuple length = 4 byest */
358 [0x00e] = 0x03, /* Conditions: Ext = 0, Vcc 3.3V, MWAIT = 1 */
359 [0x010] = 0xdb, /* ID: DTYPE_FUNCSPEC, non WP, DSPEED_150NS */
360 [0x012] = 0x01, /* Size = 2K bytes */
361 [0x014] = CISTPL_ENDMARK
,
363 [0x016] = CISTPL_JEDEC_C
, /* JEDEC ID */
364 [0x018] = 0x02, /* Tuple length = 2 bytes */
365 [0x01a] = 0xdf, /* PC Card ATA with no Vpp required */
368 [0x01e] = CISTPL_MANFID
, /* Manufacture ID */
369 [0x020] = 0x04, /* Tuple length = 4 bytes */
370 [0x022] = 0xa4, /* TPLMID_MANF = 00a4 (IBM) */
372 [0x026] = 0x00, /* PLMID_CARD = 0000 */
375 [0x02a] = CISTPL_VERS_1
, /* Level 1 Version */
376 [0x02c] = 0x12, /* Tuple length = 23 bytes */
377 [0x02e] = 0x04, /* Major Version = JEIDA 4.2 / PCMCIA 2.1 */
378 [0x030] = 0x01, /* Minor Version = 1 */
394 [0x050] = CISTPL_ENDMARK
,
396 [0x052] = CISTPL_FUNCID
, /* Function ID */
397 [0x054] = 0x02, /* Tuple length = 2 bytes */
398 [0x056] = 0x04, /* TPLFID_FUNCTION = Fixed Disk */
399 [0x058] = 0x01, /* TPLFID_SYSINIT: POST = 1, ROM = 0 */
401 [0x05a] = CISTPL_FUNCE
, /* Function Extension */
402 [0x05c] = 0x02, /* Tuple length = 2 bytes */
403 [0x05e] = 0x01, /* TPLFE_TYPE = Disk Device Interface */
404 [0x060] = 0x01, /* TPLFE_DATA = PC Card ATA Interface */
406 [0x062] = CISTPL_FUNCE
, /* Function Extension */
407 [0x064] = 0x03, /* Tuple length = 3 bytes */
408 [0x066] = 0x02, /* TPLFE_TYPE = Basic PC Card ATA Interface */
409 [0x068] = 0x08, /* TPLFE_DATA: Rotating, Unique, Single */
410 [0x06a] = 0x0f, /* TPLFE_DATA: Sleep, Standby, Idle, Auto */
412 [0x06c] = CISTPL_CONFIG
, /* Configuration */
413 [0x06e] = 0x05, /* Tuple length = 5 bytes */
414 [0x070] = 0x01, /* TPCC_RASZ = 2 bytes, TPCC_RMSZ = 1 byte */
415 [0x072] = 0x07, /* TPCC_LAST = 7 */
416 [0x074] = 0x00, /* TPCC_RADR = 0200 */
418 [0x078] = 0x0f, /* TPCC_RMSK = 200, 202, 204, 206 */
420 [0x07a] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
421 [0x07c] = 0x0b, /* Tuple length = 11 bytes */
422 [0x07e] = 0xc0, /* TPCE_INDX = Memory Mode, Default, Iface */
423 [0x080] = 0xc0, /* TPCE_IF = Memory, no BVDs, no WP, READY */
424 [0x082] = 0xa1, /* TPCE_FS = Vcc only, no I/O, Memory, Misc */
425 [0x084] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
426 [0x086] = 0x55, /* NomV: 5.0 V */
427 [0x088] = 0x4d, /* MinV: 4.5 V */
428 [0x08a] = 0x5d, /* MaxV: 5.5 V */
429 [0x08c] = 0x4e, /* Peakl: 450 mA */
430 [0x08e] = 0x08, /* TPCE_MS = 1 window, 1 byte, Host address */
431 [0x090] = 0x00, /* Window descriptor: Window length = 0 */
432 [0x092] = 0x20, /* TPCE_MI: support power down mode, RW */
434 [0x094] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
435 [0x096] = 0x06, /* Tuple length = 6 bytes */
436 [0x098] = 0x00, /* TPCE_INDX = Memory Mode, no Default */
437 [0x09a] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
438 [0x09c] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
439 [0x09e] = 0xb5, /* NomV: 3.3 V */
441 [0x0a2] = 0x3e, /* Peakl: 350 mA */
443 [0x0a4] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
444 [0x0a6] = 0x0d, /* Tuple length = 13 bytes */
445 [0x0a8] = 0xc1, /* TPCE_INDX = I/O and Memory Mode, Default */
446 [0x0aa] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
447 [0x0ac] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
448 [0x0ae] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
449 [0x0b0] = 0x55, /* NomV: 5.0 V */
450 [0x0b2] = 0x4d, /* MinV: 4.5 V */
451 [0x0b4] = 0x5d, /* MaxV: 5.5 V */
452 [0x0b6] = 0x4e, /* Peakl: 450 mA */
453 [0x0b8] = 0x64, /* TPCE_IO = 16-byte boundary, 16/8 accesses */
454 [0x0ba] = 0xf0, /* TPCE_IR = MASK, Level, Pulse, Share */
455 [0x0bc] = 0xff, /* IRQ0..IRQ7 supported */
456 [0x0be] = 0xff, /* IRQ8..IRQ15 supported */
457 [0x0c0] = 0x20, /* TPCE_MI = support power down mode */
459 [0x0c2] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
460 [0x0c4] = 0x06, /* Tuple length = 6 bytes */
461 [0x0c6] = 0x01, /* TPCE_INDX = I/O and Memory Mode */
462 [0x0c8] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
463 [0x0ca] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
464 [0x0cc] = 0xb5, /* NomV: 3.3 V */
466 [0x0d0] = 0x3e, /* Peakl: 350 mA */
468 [0x0d2] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
469 [0x0d4] = 0x12, /* Tuple length = 18 bytes */
470 [0x0d6] = 0xc2, /* TPCE_INDX = I/O Primary Mode */
471 [0x0d8] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
472 [0x0da] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
473 [0x0dc] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
474 [0x0de] = 0x55, /* NomV: 5.0 V */
475 [0x0e0] = 0x4d, /* MinV: 4.5 V */
476 [0x0e2] = 0x5d, /* MaxV: 5.5 V */
477 [0x0e4] = 0x4e, /* Peakl: 450 mA */
478 [0x0e6] = 0xea, /* TPCE_IO = 1K boundary, 16/8 access, Range */
479 [0x0e8] = 0x61, /* Range: 2 fields, 2 bytes addr, 1 byte len */
480 [0x0ea] = 0xf0, /* Field 1 address = 0x01f0 */
482 [0x0ee] = 0x07, /* Address block length = 8 */
483 [0x0f0] = 0xf6, /* Field 2 address = 0x03f6 */
485 [0x0f4] = 0x01, /* Address block length = 2 */
486 [0x0f6] = 0xee, /* TPCE_IR = IRQ E, Level, Pulse, Share */
487 [0x0f8] = 0x20, /* TPCE_MI = support power down mode */
489 [0x0fa] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
490 [0x0fc] = 0x06, /* Tuple length = 6 bytes */
491 [0x0fe] = 0x02, /* TPCE_INDX = I/O Primary Mode, no Default */
492 [0x100] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
493 [0x102] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
494 [0x104] = 0xb5, /* NomV: 3.3 V */
496 [0x108] = 0x3e, /* Peakl: 350 mA */
498 [0x10a] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
499 [0x10c] = 0x12, /* Tuple length = 18 bytes */
500 [0x10e] = 0xc3, /* TPCE_INDX = I/O Secondary Mode, Default */
501 [0x110] = 0x41, /* TPCE_IF = I/O and Memory, no BVD, no WP */
502 [0x112] = 0x99, /* TPCE_FS = Vcc only, I/O, Interrupt, Misc */
503 [0x114] = 0x27, /* NomV = 1, MinV = 1, MaxV = 1, Peakl = 1 */
504 [0x116] = 0x55, /* NomV: 5.0 V */
505 [0x118] = 0x4d, /* MinV: 4.5 V */
506 [0x11a] = 0x5d, /* MaxV: 5.5 V */
507 [0x11c] = 0x4e, /* Peakl: 450 mA */
508 [0x11e] = 0xea, /* TPCE_IO = 1K boundary, 16/8 access, Range */
509 [0x120] = 0x61, /* Range: 2 fields, 2 byte addr, 1 byte len */
510 [0x122] = 0x70, /* Field 1 address = 0x0170 */
512 [0x126] = 0x07, /* Address block length = 8 */
513 [0x128] = 0x76, /* Field 2 address = 0x0376 */
515 [0x12c] = 0x01, /* Address block length = 2 */
516 [0x12e] = 0xee, /* TPCE_IR = IRQ E, Level, Pulse, Share */
517 [0x130] = 0x20, /* TPCE_MI = support power down mode */
519 [0x132] = CISTPL_CFTABLE_ENTRY
, /* 16-bit PC Card Configuration */
520 [0x134] = 0x06, /* Tuple length = 6 bytes */
521 [0x136] = 0x03, /* TPCE_INDX = I/O Secondary Mode */
522 [0x138] = 0x01, /* TPCE_FS = Vcc only, no I/O, no Memory */
523 [0x13a] = 0x21, /* NomV = 1, MinV = 0, MaxV = 0, Peakl = 1 */
524 [0x13c] = 0xb5, /* NomV: 3.3 V */
526 [0x140] = 0x3e, /* Peakl: 350 mA */
528 [0x142] = CISTPL_NO_LINK
, /* No Link */
529 [0x144] = 0x00, /* Tuple length = 0 bytes */
531 [0x146] = CISTPL_END
, /* Tuple End */
534 #define TYPE_DSCM1XXXX "dscm1xxxx"
536 static int dscm1xxxx_attach(PCMCIACardState
*card
)
538 MicroDriveState
*md
= MICRODRIVE(card
);
539 PCMCIACardClass
*pcc
= PCMCIA_CARD_GET_CLASS(card
);
541 md
->attr_base
= pcc
->cis
[0x74] | (pcc
->cis
[0x76] << 8);
544 device_legacy_reset(DEVICE(md
));
545 md_interrupt_update(md
);
550 static int dscm1xxxx_detach(PCMCIACardState
*card
)
552 MicroDriveState
*md
= MICRODRIVE(card
);
554 device_legacy_reset(DEVICE(md
));
558 PCMCIACardState
*dscm1xxxx_init(DriveInfo
*dinfo
)
562 md
= MICRODRIVE(object_new(TYPE_DSCM1XXXX
));
563 qdev_init_nofail(DEVICE(md
));
566 ide_create_drive(&md
->bus
, 0, dinfo
);
568 md
->bus
.ifs
[0].drive_kind
= IDE_CFATA
;
569 md
->bus
.ifs
[0].mdata_size
= METADATA_SIZE
;
570 md
->bus
.ifs
[0].mdata_storage
= g_malloc0(METADATA_SIZE
);
572 return PCMCIA_CARD(md
);
575 static void dscm1xxxx_class_init(ObjectClass
*oc
, void *data
)
577 PCMCIACardClass
*pcc
= PCMCIA_CARD_CLASS(oc
);
578 DeviceClass
*dc
= DEVICE_CLASS(oc
);
580 pcc
->cis
= dscm1xxxx_cis
;
581 pcc
->cis_len
= sizeof(dscm1xxxx_cis
);
583 pcc
->attach
= dscm1xxxx_attach
;
584 pcc
->detach
= dscm1xxxx_detach
;
585 /* Reason: Needs to be wired-up in code, see dscm1xxxx_init() */
586 dc
->user_creatable
= false;
589 static const TypeInfo dscm1xxxx_type_info
= {
590 .name
= TYPE_DSCM1XXXX
,
591 .parent
= TYPE_MICRODRIVE
,
592 .class_init
= dscm1xxxx_class_init
,
595 static void microdrive_realize(DeviceState
*dev
, Error
**errp
)
597 MicroDriveState
*md
= MICRODRIVE(dev
);
599 ide_init2(&md
->bus
, qemu_allocate_irq(md_set_irq
, md
, 0));
602 static void microdrive_init(Object
*obj
)
604 MicroDriveState
*md
= MICRODRIVE(obj
);
606 ide_bus_new(&md
->bus
, sizeof(md
->bus
), DEVICE(obj
), 0, 1);
609 static void microdrive_class_init(ObjectClass
*oc
, void *data
)
611 DeviceClass
*dc
= DEVICE_CLASS(oc
);
612 PCMCIACardClass
*pcc
= PCMCIA_CARD_CLASS(oc
);
614 pcc
->attr_read
= md_attr_read
;
615 pcc
->attr_write
= md_attr_write
;
616 pcc
->common_read
= md_common_read
;
617 pcc
->common_write
= md_common_write
;
618 pcc
->io_read
= md_common_read
;
619 pcc
->io_write
= md_common_write
;
621 dc
->realize
= microdrive_realize
;
622 dc
->reset
= md_reset
;
623 dc
->vmsd
= &vmstate_microdrive
;
626 static const TypeInfo microdrive_type_info
= {
627 .name
= TYPE_MICRODRIVE
,
628 .parent
= TYPE_PCMCIA_CARD
,
629 .instance_size
= sizeof(MicroDriveState
),
630 .instance_init
= microdrive_init
,
632 .class_init
= microdrive_class_init
,
635 static void microdrive_register_types(void)
637 type_register_static(µdrive_type_info
);
638 type_register_static(&dscm1xxxx_type_info
);
641 type_init(microdrive_register_types
)