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/ide/internal.h"
28 #include "hw/scsi/scsi.h"
29 #include "sysemu/block-backend.h"
31 #define ATAPI_SECTOR_BITS (2 + BDRV_SECTOR_BITS)
32 #define ATAPI_SECTOR_SIZE (1 << ATAPI_SECTOR_BITS)
34 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret);
36 static void padstr8(uint8_t *buf, int buf_size, const char *src)
39 for(i = 0; i < buf_size; i++) {
47 static inline void cpu_to_ube16(uint8_t *buf, int val)
53 static inline void cpu_to_ube32(uint8_t *buf, unsigned int val)
61 static inline int ube16_to_cpu(const uint8_t *buf)
63 return (buf[0] << 8) | buf[1];
66 static inline int ube32_to_cpu(const uint8_t *buf)
68 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
71 static void lba_to_msf(uint8_t *buf, int lba)
74 buf[0] = (lba / 75) / 60;
75 buf[1] = (lba / 75) % 60;
79 static inline int media_present(IDEState *s)
81 return !s->tray_open && s->nb_sectors > 0;
84 /* XXX: DVDs that could fit on a CD will be reported as a CD */
85 static inline int media_is_dvd(IDEState *s)
87 return (media_present(s) && s->nb_sectors > CD_MAX_SECTORS);
90 static inline int media_is_cd(IDEState *s)
92 return (media_present(s) && s->nb_sectors <= CD_MAX_SECTORS);
95 static void cd_data_to_raw(uint8_t *buf, int lba)
99 memset(buf + 1, 0xff, 10);
103 lba_to_msf(buf, lba);
104 buf[3] = 0x01; /* mode 1 data */
108 /* XXX: ECC not computed */
113 cd_read_sector_sync(IDEState *s)
116 block_acct_start(blk_get_stats(s->blk), &s->acct,
117 ATAPI_SECTOR_SIZE, BLOCK_ACCT_READ);
119 #ifdef DEBUG_IDE_ATAPI
120 printf("cd_read_sector_sync: lba=%d\n", s->lba);
123 switch (s->cd_sector_size) {
125 ret = blk_pread(s->blk, (int64_t)s->lba << ATAPI_SECTOR_BITS,
126 s->io_buffer, ATAPI_SECTOR_SIZE);
129 ret = blk_pread(s->blk, (int64_t)s->lba << ATAPI_SECTOR_BITS,
130 s->io_buffer + 16, ATAPI_SECTOR_SIZE);
132 cd_data_to_raw(s->io_buffer, s->lba);
136 block_acct_invalid(blk_get_stats(s->blk), BLOCK_ACCT_READ);
141 block_acct_failed(blk_get_stats(s->blk), &s->acct);
143 block_acct_done(blk_get_stats(s->blk), &s->acct);
145 s->io_buffer_index = 0;
151 static void cd_read_sector_cb(void *opaque, int ret)
153 IDEState *s = opaque;
155 #ifdef DEBUG_IDE_ATAPI
156 printf("cd_read_sector_cb: lba=%d ret=%d\n", s->lba, ret);
160 block_acct_failed(blk_get_stats(s->blk), &s->acct);
161 ide_atapi_io_error(s, ret);
165 block_acct_done(blk_get_stats(s->blk), &s->acct);
167 if (s->cd_sector_size == 2352) {
168 cd_data_to_raw(s->io_buffer, s->lba);
172 s->io_buffer_index = 0;
173 s->status &= ~BUSY_STAT;
175 ide_atapi_cmd_reply_end(s);
178 static int cd_read_sector(IDEState *s)
180 if (s->cd_sector_size != 2048 && s->cd_sector_size != 2352) {
181 block_acct_invalid(blk_get_stats(s->blk), BLOCK_ACCT_READ);
185 s->iov.iov_base = (s->cd_sector_size == 2352) ?
186 s->io_buffer + 16 : s->io_buffer;
188 s->iov.iov_len = ATAPI_SECTOR_SIZE;
189 qemu_iovec_init_external(&s->qiov, &s->iov, 1);
191 #ifdef DEBUG_IDE_ATAPI
192 printf("cd_read_sector: lba=%d\n", s->lba);
195 block_acct_start(blk_get_stats(s->blk), &s->acct,
196 ATAPI_SECTOR_SIZE, BLOCK_ACCT_READ);
198 ide_buffered_readv(s, (int64_t)s->lba << 2, &s->qiov, 4,
199 cd_read_sector_cb, s);
201 s->status |= BUSY_STAT;
205 void ide_atapi_cmd_ok(IDEState *s)
208 s->status = READY_STAT | SEEK_STAT;
209 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
210 ide_transfer_stop(s);
214 void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc)
216 #ifdef DEBUG_IDE_ATAPI
217 printf("atapi_cmd_error: sense=0x%x asc=0x%x\n", sense_key, asc);
219 s->error = sense_key << 4;
220 s->status = READY_STAT | ERR_STAT;
221 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
222 s->sense_key = sense_key;
224 ide_transfer_stop(s);
228 void ide_atapi_io_error(IDEState *s, int ret)
230 /* XXX: handle more errors */
231 if (ret == -ENOMEDIUM) {
232 ide_atapi_cmd_error(s, NOT_READY,
233 ASC_MEDIUM_NOT_PRESENT);
235 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
236 ASC_LOGICAL_BLOCK_OOR);
240 static uint16_t atapi_byte_count_limit(IDEState *s)
244 bcl = s->lcyl | (s->hcyl << 8);
251 /* The whole ATAPI transfer logic is handled in this function */
252 void ide_atapi_cmd_reply_end(IDEState *s)
254 int byte_count_limit, size, ret;
255 #ifdef DEBUG_IDE_ATAPI
256 printf("reply: tx_size=%d elem_tx_size=%d index=%d\n",
257 s->packet_transfer_size,
258 s->elementary_transfer_size,
261 if (s->packet_transfer_size <= 0) {
262 /* end of transfer */
265 #ifdef DEBUG_IDE_ATAPI
266 printf("end of transfer, status=0x%x\n", s->status);
269 /* see if a new sector must be read */
270 if (s->lba != -1 && s->io_buffer_index >= s->cd_sector_size) {
271 if (!s->elementary_transfer_size) {
272 ret = cd_read_sector(s);
274 ide_atapi_io_error(s, ret);
278 /* rebuffering within an elementary transfer is
279 * only possible with a sync request because we
280 * end up with a race condition otherwise */
281 ret = cd_read_sector_sync(s);
283 ide_atapi_io_error(s, ret);
288 if (s->elementary_transfer_size > 0) {
289 /* there are some data left to transmit in this elementary
291 size = s->cd_sector_size - s->io_buffer_index;
292 if (size > s->elementary_transfer_size)
293 size = s->elementary_transfer_size;
294 s->packet_transfer_size -= size;
295 s->elementary_transfer_size -= size;
296 s->io_buffer_index += size;
297 ide_transfer_start(s, s->io_buffer + s->io_buffer_index - size,
298 size, ide_atapi_cmd_reply_end);
300 /* a new transfer is needed */
301 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO;
302 byte_count_limit = atapi_byte_count_limit(s);
303 #ifdef DEBUG_IDE_ATAPI
304 printf("byte_count_limit=%d\n", byte_count_limit);
306 size = s->packet_transfer_size;
307 if (size > byte_count_limit) {
308 /* byte count limit must be even if this case */
309 if (byte_count_limit & 1)
311 size = byte_count_limit;
315 s->elementary_transfer_size = size;
316 /* we cannot transmit more than one sector at a time */
318 if (size > (s->cd_sector_size - s->io_buffer_index))
319 size = (s->cd_sector_size - s->io_buffer_index);
321 s->packet_transfer_size -= size;
322 s->elementary_transfer_size -= size;
323 s->io_buffer_index += size;
324 ide_transfer_start(s, s->io_buffer + s->io_buffer_index - size,
325 size, ide_atapi_cmd_reply_end);
327 #ifdef DEBUG_IDE_ATAPI
328 printf("status=0x%x\n", s->status);
334 /* send a reply of 'size' bytes in s->io_buffer to an ATAPI command */
335 static void ide_atapi_cmd_reply(IDEState *s, int size, int max_size)
339 s->lba = -1; /* no sector read */
340 s->packet_transfer_size = size;
341 s->io_buffer_size = size; /* dma: send the reply data as one chunk */
342 s->elementary_transfer_size = 0;
345 block_acct_start(blk_get_stats(s->blk), &s->acct, size,
347 s->status = READY_STAT | SEEK_STAT | DRQ_STAT;
348 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
350 s->status = READY_STAT | SEEK_STAT;
351 s->io_buffer_index = 0;
352 ide_atapi_cmd_reply_end(s);
356 /* start a CD-CDROM read command */
357 static void ide_atapi_cmd_read_pio(IDEState *s, int lba, int nb_sectors,
361 s->packet_transfer_size = nb_sectors * sector_size;
362 s->elementary_transfer_size = 0;
363 s->io_buffer_index = sector_size;
364 s->cd_sector_size = sector_size;
366 ide_atapi_cmd_reply_end(s);
369 static void ide_atapi_cmd_check_status(IDEState *s)
371 #ifdef DEBUG_IDE_ATAPI
372 printf("atapi_cmd_check_status\n");
374 s->error = MC_ERR | (UNIT_ATTENTION << 4);
375 s->status = ERR_STAT;
379 /* ATAPI DMA support */
381 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret)
383 IDEState *s = opaque;
387 if (ide_handle_rw_error(s, -ret, ide_dma_cmd_to_retry(s->dma_cmd))) {
388 if (s->bus->error_status) {
395 if (s->io_buffer_size > 0) {
397 * For a cdrom read sector command (s->lba != -1),
398 * adjust the lba for the next s->io_buffer_size chunk
399 * and dma the current chunk.
400 * For a command != read (s->lba == -1), just transfer
404 if (s->cd_sector_size == 2352) {
406 cd_data_to_raw(s->io_buffer, s->lba);
408 n = s->io_buffer_size >> 11;
412 s->packet_transfer_size -= s->io_buffer_size;
413 if (s->bus->dma->ops->rw_buf(s->bus->dma, 1) == 0)
417 if (s->packet_transfer_size <= 0) {
418 s->status = READY_STAT | SEEK_STAT;
419 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
424 s->io_buffer_index = 0;
425 if (s->cd_sector_size == 2352) {
427 s->io_buffer_size = s->cd_sector_size;
430 n = s->packet_transfer_size >> 11;
431 if (n > (IDE_DMA_BUF_SECTORS / 4))
432 n = (IDE_DMA_BUF_SECTORS / 4);
433 s->io_buffer_size = n * 2048;
437 printf("aio_read_cd: lba=%u n=%d\n", s->lba, n);
440 s->bus->dma->iov.iov_base = (void *)(s->io_buffer + data_offset);
441 s->bus->dma->iov.iov_len = n * ATAPI_SECTOR_SIZE;
442 qemu_iovec_init_external(&s->bus->dma->qiov, &s->bus->dma->iov, 1);
444 s->bus->dma->aiocb = ide_buffered_readv(s, (int64_t)s->lba << 2,
445 &s->bus->dma->qiov, n * 4,
446 ide_atapi_cmd_read_dma_cb, s);
451 block_acct_failed(blk_get_stats(s->blk), &s->acct);
453 block_acct_done(blk_get_stats(s->blk), &s->acct);
455 ide_set_inactive(s, false);
458 /* start a CD-CDROM read command with DMA */
459 /* XXX: test if DMA is available */
460 static void ide_atapi_cmd_read_dma(IDEState *s, int lba, int nb_sectors,
464 s->packet_transfer_size = nb_sectors * sector_size;
465 s->io_buffer_size = 0;
466 s->cd_sector_size = sector_size;
468 block_acct_start(blk_get_stats(s->blk), &s->acct, s->packet_transfer_size,
471 /* XXX: check if BUSY_STAT should be set */
472 s->status = READY_STAT | SEEK_STAT | DRQ_STAT | BUSY_STAT;
473 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
476 static void ide_atapi_cmd_read(IDEState *s, int lba, int nb_sectors,
479 #ifdef DEBUG_IDE_ATAPI
480 printf("read %s: LBA=%d nb_sectors=%d\n", s->atapi_dma ? "dma" : "pio",
484 ide_atapi_cmd_read_dma(s, lba, nb_sectors, sector_size);
486 ide_atapi_cmd_read_pio(s, lba, nb_sectors, sector_size);
490 void ide_atapi_dma_restart(IDEState *s)
493 * At this point we can just re-evaluate the packet command and start over.
494 * The presence of ->dma_cb callback in the pre_save ensures that the packet
495 * command has been completely sent and we can safely restart command.
497 s->unit = s->bus->retry_unit;
498 s->bus->dma->ops->restart_dma(s->bus->dma);
502 static inline uint8_t ide_atapi_set_profile(uint8_t *buf, uint8_t *index,
505 uint8_t *buf_profile = buf + 12; /* start of profiles */
507 buf_profile += ((*index) * 4); /* start of indexed profile */
508 cpu_to_ube16 (buf_profile, profile);
509 buf_profile[2] = ((buf_profile[0] == buf[6]) && (buf_profile[1] == buf[7]));
511 /* each profile adds 4 bytes to the response */
513 buf[11] += 4; /* Additional Length */
518 static int ide_dvd_read_structure(IDEState *s, int format,
519 const uint8_t *packet, uint8_t *buf)
522 case 0x0: /* Physical format information */
524 int layer = packet[6];
525 uint64_t total_sectors;
528 return -ASC_INV_FIELD_IN_CMD_PACKET;
530 total_sectors = s->nb_sectors >> 2;
531 if (total_sectors == 0) {
532 return -ASC_MEDIUM_NOT_PRESENT;
535 buf[4] = 1; /* DVD-ROM, part version 1 */
536 buf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
537 buf[6] = 1; /* one layer, read-only (per MMC-2 spec) */
538 buf[7] = 0; /* default densities */
540 /* FIXME: 0x30000 per spec? */
541 cpu_to_ube32(buf + 8, 0); /* start sector */
542 cpu_to_ube32(buf + 12, total_sectors - 1); /* end sector */
543 cpu_to_ube32(buf + 16, total_sectors - 1); /* l0 end sector */
545 /* Size of buffer, not including 2 byte size field */
546 stw_be_p(buf, 2048 + 2);
548 /* 2k data + 4 byte header */
552 case 0x01: /* DVD copyright information */
553 buf[4] = 0; /* no copyright data */
554 buf[5] = 0; /* no region restrictions */
556 /* Size of buffer, not including 2 byte size field */
557 stw_be_p(buf, 4 + 2);
559 /* 4 byte header + 4 byte data */
562 case 0x03: /* BCA information - invalid field for no BCA info */
563 return -ASC_INV_FIELD_IN_CMD_PACKET;
565 case 0x04: /* DVD disc manufacturing information */
566 /* Size of buffer, not including 2 byte size field */
567 stw_be_p(buf, 2048 + 2);
569 /* 2k data + 4 byte header */
574 * This lists all the command capabilities above. Add new ones
575 * in order and update the length and buffer return values.
578 buf[4] = 0x00; /* Physical format */
579 buf[5] = 0x40; /* Not writable, is readable */
580 stw_be_p(buf + 6, 2048 + 4);
582 buf[8] = 0x01; /* Copyright info */
583 buf[9] = 0x40; /* Not writable, is readable */
584 stw_be_p(buf + 10, 4 + 4);
586 buf[12] = 0x03; /* BCA info */
587 buf[13] = 0x40; /* Not writable, is readable */
588 stw_be_p(buf + 14, 188 + 4);
590 buf[16] = 0x04; /* Manufacturing info */
591 buf[17] = 0x40; /* Not writable, is readable */
592 stw_be_p(buf + 18, 2048 + 4);
594 /* Size of buffer, not including 2 byte size field */
595 stw_be_p(buf, 16 + 2);
597 /* data written + 4 byte header */
600 default: /* TODO: formats beyond DVD-ROM requires */
601 return -ASC_INV_FIELD_IN_CMD_PACKET;
605 static unsigned int event_status_media(IDEState *s,
608 uint8_t event_code, media_status;
612 media_status = MS_TRAY_OPEN;
613 } else if (blk_is_inserted(s->blk)) {
614 media_status = MS_MEDIA_PRESENT;
617 /* Event notification descriptor */
618 event_code = MEC_NO_CHANGE;
619 if (media_status != MS_TRAY_OPEN) {
620 if (s->events.new_media) {
621 event_code = MEC_NEW_MEDIA;
622 s->events.new_media = false;
623 } else if (s->events.eject_request) {
624 event_code = MEC_EJECT_REQUESTED;
625 s->events.eject_request = false;
630 buf[5] = media_status;
632 /* These fields are reserved, just clear them. */
636 return 8; /* We wrote to 4 extra bytes from the header */
639 static void cmd_get_event_status_notification(IDEState *s,
642 const uint8_t *packet = buf;
646 uint8_t polled; /* lsb bit is polled; others are reserved */
647 uint8_t reserved2[2];
649 uint8_t reserved3[2];
652 } QEMU_PACKED *gesn_cdb;
656 uint8_t notification_class;
657 uint8_t supported_events;
658 } QEMU_PACKED *gesn_event_header;
659 unsigned int max_len, used_len;
661 gesn_cdb = (void *)packet;
662 gesn_event_header = (void *)buf;
664 max_len = be16_to_cpu(gesn_cdb->len);
666 /* It is fine by the MMC spec to not support async mode operations */
667 if (!(gesn_cdb->polled & 0x01)) { /* asynchronous mode */
668 /* Only polling is supported, asynchronous mode is not. */
669 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
670 ASC_INV_FIELD_IN_CMD_PACKET);
674 /* polling mode operation */
677 * These are the supported events.
679 * We currently only support requests of the 'media' type.
680 * Notification class requests and supported event classes are bitmasks,
681 * but they are build from the same values as the "notification class"
684 gesn_event_header->supported_events = 1 << GESN_MEDIA;
687 * We use |= below to set the class field; other bits in this byte
688 * are reserved now but this is useful to do if we have to use the
689 * reserved fields later.
691 gesn_event_header->notification_class = 0;
694 * Responses to requests are to be based on request priority. The
695 * notification_class_request_type enum above specifies the
696 * priority: upper elements are higher prio than lower ones.
698 if (gesn_cdb->class & (1 << GESN_MEDIA)) {
699 gesn_event_header->notification_class |= GESN_MEDIA;
700 used_len = event_status_media(s, buf);
702 gesn_event_header->notification_class = 0x80; /* No event available */
703 used_len = sizeof(*gesn_event_header);
705 gesn_event_header->len = cpu_to_be16(used_len
706 - sizeof(*gesn_event_header));
707 ide_atapi_cmd_reply(s, used_len, max_len);
710 static void cmd_request_sense(IDEState *s, uint8_t *buf)
712 int max_len = buf[4];
715 buf[0] = 0x70 | (1 << 7);
716 buf[2] = s->sense_key;
720 if (s->sense_key == UNIT_ATTENTION) {
721 s->sense_key = NO_SENSE;
724 ide_atapi_cmd_reply(s, 18, max_len);
727 static void cmd_inquiry(IDEState *s, uint8_t *buf)
729 uint8_t page_code = buf[2];
730 int max_len = buf[4];
734 unsigned preamble_len;
736 /* If the EVPD (Enable Vital Product Data) bit is set in byte 1,
737 * we are being asked for a specific page of info indicated by byte 2. */
742 buf[idx++] = 0x05; /* CD-ROM */
743 buf[idx++] = page_code; /* Page Code */
744 buf[idx++] = 0x00; /* reserved */
745 idx++; /* length (set later) */
749 /* Supported Pages: List of supported VPD responses. */
750 buf[idx++] = 0x00; /* 0x00: Supported Pages, and: */
751 buf[idx++] = 0x83; /* 0x83: Device Identification. */
755 /* Device Identification. Each entry is optional, but the entries
756 * included here are modeled after libata's VPD responses.
757 * If the response is given, at least one entry must be present. */
759 /* Entry 1: Serial */
760 if (idx + 24 > max_len) {
761 /* Not enough room for even the first entry: */
762 /* 4 byte header + 20 byte string */
763 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
764 ASC_DATA_PHASE_ERROR);
767 buf[idx++] = 0x02; /* Ascii */
768 buf[idx++] = 0x00; /* Vendor Specific */
770 buf[idx++] = 20; /* Remaining length */
771 padstr8(buf + idx, 20, s->drive_serial_str);
774 /* Entry 2: Drive Model and Serial */
775 if (idx + 72 > max_len) {
776 /* 4 (header) + 8 (vendor) + 60 (model & serial) */
779 buf[idx++] = 0x02; /* Ascii */
780 buf[idx++] = 0x01; /* T10 Vendor */
783 padstr8(buf + idx, 8, "ATA"); /* Generic T10 vendor */
785 padstr8(buf + idx, 40, s->drive_model_str);
787 padstr8(buf + idx, 20, s->drive_serial_str);
791 if (s->wwn && (idx + 12 <= max_len)) {
792 /* 4 byte header + 8 byte wwn */
793 buf[idx++] = 0x01; /* Binary */
794 buf[idx++] = 0x03; /* NAA */
797 stq_be_p(&buf[idx], s->wwn);
803 /* SPC-3, revision 23 sec. 6.4 */
804 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
805 ASC_INV_FIELD_IN_CMD_PACKET);
812 buf[0] = 0x05; /* CD-ROM */
813 buf[1] = 0x80; /* removable */
814 buf[2] = 0x00; /* ISO */
815 buf[3] = 0x21; /* ATAPI-2 (XXX: put ATAPI-4 ?) */
816 /* buf[size_idx] set below. */
817 buf[5] = 0; /* reserved */
818 buf[6] = 0; /* reserved */
819 buf[7] = 0; /* reserved */
820 padstr8(buf + 8, 8, "QEMU");
821 padstr8(buf + 16, 16, "QEMU DVD-ROM");
822 padstr8(buf + 32, 4, s->version);
827 buf[size_idx] = idx - preamble_len;
828 ide_atapi_cmd_reply(s, idx, max_len);
831 static void cmd_get_configuration(IDEState *s, uint8_t *buf)
837 /* only feature 0 is supported */
838 if (buf[2] != 0 || buf[3] != 0) {
839 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
840 ASC_INV_FIELD_IN_CMD_PACKET);
844 /* XXX: could result in alignment problems in some architectures */
845 max_len = ube16_to_cpu(buf + 7);
848 * XXX: avoid overflow for io_buffer if max_len is bigger than
849 * the size of that buffer (dimensioned to max number of
850 * sectors to transfer at once)
852 * Only a problem if the feature/profiles grow.
855 /* XXX: assume 1 sector */
859 memset(buf, 0, max_len);
861 * the number of sectors from the media tells us which profile
862 * to use as current. 0 means there is no media
864 if (media_is_dvd(s)) {
865 cpu_to_ube16(buf + 6, MMC_PROFILE_DVD_ROM);
866 } else if (media_is_cd(s)) {
867 cpu_to_ube16(buf + 6, MMC_PROFILE_CD_ROM);
870 buf[10] = 0x02 | 0x01; /* persistent and current */
871 len = 12; /* headers: 8 + 4 */
872 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_DVD_ROM);
873 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_CD_ROM);
874 cpu_to_ube32(buf, len - 4); /* data length */
876 ide_atapi_cmd_reply(s, len, max_len);
879 static void cmd_mode_sense(IDEState *s, uint8_t *buf)
884 max_len = ube16_to_cpu(buf + 7);
885 action = buf[2] >> 6;
886 code = buf[2] & 0x3f;
889 case 0: /* current values */
891 case MODE_PAGE_R_W_ERROR: /* error recovery */
892 cpu_to_ube16(&buf[0], 16 - 2);
900 buf[8] = MODE_PAGE_R_W_ERROR;
908 ide_atapi_cmd_reply(s, 16, max_len);
910 case MODE_PAGE_AUDIO_CTL:
911 cpu_to_ube16(&buf[0], 24 - 2);
919 buf[8] = MODE_PAGE_AUDIO_CTL;
921 /* Fill with CDROM audio volume */
927 ide_atapi_cmd_reply(s, 24, max_len);
929 case MODE_PAGE_CAPABILITIES:
930 cpu_to_ube16(&buf[0], 30 - 2);
938 buf[8] = MODE_PAGE_CAPABILITIES;
940 buf[10] = 0x3b; /* read CDR/CDRW/DVDROM/DVDR/DVDRAM */
943 /* Claim PLAY_AUDIO capability (0x01) since some Linux
944 code checks for this to automount media. */
947 buf[14] = (1 << 0) | (1 << 3) | (1 << 5);
948 if (s->tray_locked) {
951 buf[15] = 0x00; /* No volume & mute control, no changer */
952 cpu_to_ube16(&buf[16], 704); /* 4x read speed */
953 buf[18] = 0; /* Two volume levels */
955 cpu_to_ube16(&buf[20], 512); /* 512k buffer */
956 cpu_to_ube16(&buf[22], 704); /* 4x read speed current */
963 ide_atapi_cmd_reply(s, 30, max_len);
969 case 1: /* changeable values */
971 case 2: /* default values */
974 case 3: /* saved values */
975 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
976 ASC_SAVING_PARAMETERS_NOT_SUPPORTED);
982 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_INV_FIELD_IN_CMD_PACKET);
985 static void cmd_test_unit_ready(IDEState *s, uint8_t *buf)
987 /* Not Ready Conditions are already handled in ide_atapi_cmd(), so if we
988 * come here, we know that it's ready. */
992 static void cmd_prevent_allow_medium_removal(IDEState *s, uint8_t* buf)
994 s->tray_locked = buf[4] & 1;
995 blk_lock_medium(s->blk, buf[4] & 1);
999 static void cmd_read(IDEState *s, uint8_t* buf)
1001 int nb_sectors, lba;
1003 if (buf[0] == GPCMD_READ_10) {
1004 nb_sectors = ube16_to_cpu(buf + 7);
1006 nb_sectors = ube32_to_cpu(buf + 6);
1009 lba = ube32_to_cpu(buf + 2);
1010 if (nb_sectors == 0) {
1011 ide_atapi_cmd_ok(s);
1015 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1018 static void cmd_read_cd(IDEState *s, uint8_t* buf)
1020 int nb_sectors, lba, transfer_request;
1022 nb_sectors = (buf[6] << 16) | (buf[7] << 8) | buf[8];
1023 lba = ube32_to_cpu(buf + 2);
1025 if (nb_sectors == 0) {
1026 ide_atapi_cmd_ok(s);
1030 transfer_request = buf[9];
1031 switch(transfer_request & 0xf8) {
1034 ide_atapi_cmd_ok(s);
1038 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1042 ide_atapi_cmd_read(s, lba, nb_sectors, 2352);
1045 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1046 ASC_INV_FIELD_IN_CMD_PACKET);
1051 static void cmd_seek(IDEState *s, uint8_t* buf)
1054 uint64_t total_sectors = s->nb_sectors >> 2;
1056 lba = ube32_to_cpu(buf + 2);
1057 if (lba >= total_sectors) {
1058 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_LOGICAL_BLOCK_OOR);
1062 ide_atapi_cmd_ok(s);
1065 static void cmd_start_stop_unit(IDEState *s, uint8_t* buf)
1068 bool start = buf[4] & 1;
1069 bool loej = buf[4] & 2; /* load on start, eject on !start */
1070 int pwrcnd = buf[4] & 0xf0;
1073 /* eject/load only happens for power condition == 0 */
1074 ide_atapi_cmd_ok(s);
1079 if (!start && !s->tray_open && s->tray_locked) {
1080 sense = blk_is_inserted(s->blk)
1081 ? NOT_READY : ILLEGAL_REQUEST;
1082 ide_atapi_cmd_error(s, sense, ASC_MEDIA_REMOVAL_PREVENTED);
1086 if (s->tray_open != !start) {
1087 blk_eject(s->blk, !start);
1088 s->tray_open = !start;
1092 ide_atapi_cmd_ok(s);
1095 static void cmd_mechanism_status(IDEState *s, uint8_t* buf)
1097 int max_len = ube16_to_cpu(buf + 8);
1099 cpu_to_ube16(buf, 0);
1100 /* no current LBA */
1105 cpu_to_ube16(buf + 6, 0);
1106 ide_atapi_cmd_reply(s, 8, max_len);
1109 static void cmd_read_toc_pma_atip(IDEState *s, uint8_t* buf)
1111 int format, msf, start_track, len;
1113 uint64_t total_sectors = s->nb_sectors >> 2;
1115 max_len = ube16_to_cpu(buf + 7);
1116 format = buf[9] >> 6;
1117 msf = (buf[1] >> 1) & 1;
1118 start_track = buf[6];
1122 len = cdrom_read_toc(total_sectors, buf, msf, start_track);
1125 ide_atapi_cmd_reply(s, len, max_len);
1128 /* multi session : only a single session defined */
1133 ide_atapi_cmd_reply(s, 12, max_len);
1136 len = cdrom_read_toc_raw(total_sectors, buf, msf, start_track);
1139 ide_atapi_cmd_reply(s, len, max_len);
1143 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1144 ASC_INV_FIELD_IN_CMD_PACKET);
1148 static void cmd_read_cdvd_capacity(IDEState *s, uint8_t* buf)
1150 uint64_t total_sectors = s->nb_sectors >> 2;
1152 /* NOTE: it is really the number of sectors minus 1 */
1153 cpu_to_ube32(buf, total_sectors - 1);
1154 cpu_to_ube32(buf + 4, 2048);
1155 ide_atapi_cmd_reply(s, 8, 8);
1158 static void cmd_read_disc_information(IDEState *s, uint8_t* buf)
1160 uint8_t type = buf[1] & 7;
1161 uint32_t max_len = ube16_to_cpu(buf + 7);
1163 /* Types 1/2 are only defined for Blu-Ray. */
1165 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1166 ASC_INV_FIELD_IN_CMD_PACKET);
1172 buf[2] = 0xe; /* last session complete, disc finalized */
1173 buf[3] = 1; /* first track on disc */
1174 buf[4] = 1; /* # of sessions */
1175 buf[5] = 1; /* first track of last session */
1176 buf[6] = 1; /* last track of last session */
1177 buf[7] = 0x20; /* unrestricted use */
1178 buf[8] = 0x00; /* CD-ROM or DVD-ROM */
1179 /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
1180 /* 12-23: not meaningful for CD-ROM or DVD-ROM */
1181 /* 24-31: disc bar code */
1182 /* 32: disc application code */
1183 /* 33: number of OPC tables */
1185 ide_atapi_cmd_reply(s, 34, max_len);
1188 static void cmd_read_dvd_structure(IDEState *s, uint8_t* buf)
1192 int format = buf[7];
1195 max_len = ube16_to_cpu(buf + 8);
1197 if (format < 0xff) {
1198 if (media_is_cd(s)) {
1199 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1200 ASC_INCOMPATIBLE_FORMAT);
1202 } else if (!media_present(s)) {
1203 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1204 ASC_INV_FIELD_IN_CMD_PACKET);
1209 memset(buf, 0, max_len > IDE_DMA_BUF_SECTORS * 512 + 4 ?
1210 IDE_DMA_BUF_SECTORS * 512 + 4 : max_len);
1216 ret = ide_dvd_read_structure(s, format, buf, buf);
1219 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, -ret);
1221 ide_atapi_cmd_reply(s, ret, max_len);
1226 /* TODO: BD support, fall through for now */
1228 /* Generic disk structures */
1229 case 0x80: /* TODO: AACS volume identifier */
1230 case 0x81: /* TODO: AACS media serial number */
1231 case 0x82: /* TODO: AACS media identifier */
1232 case 0x83: /* TODO: AACS media key block */
1233 case 0x90: /* TODO: List of recognized format layers */
1234 case 0xc0: /* TODO: Write protection status */
1236 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1237 ASC_INV_FIELD_IN_CMD_PACKET);
1242 static void cmd_set_speed(IDEState *s, uint8_t* buf)
1244 ide_atapi_cmd_ok(s);
1249 * Only commands flagged as ALLOW_UA are allowed to run under a
1250 * unit attention condition. (See MMC-5, section 4.1.6.1)
1255 * Commands flagged with CHECK_READY can only execute if a medium is present.
1256 * Otherwise they report the Not Ready Condition. (See MMC-5, section
1262 * Commands flagged with NONDATA do not in any circumstances return
1263 * any data via ide_atapi_cmd_reply. These commands are exempt from
1264 * the normal byte_count_limit constraints.
1265 * See ATA8-ACS3 "7.21.5 Byte Count Limit"
1270 static const struct AtapiCmd {
1271 void (*handler)(IDEState *s, uint8_t *buf);
1273 } atapi_cmd_table[0x100] = {
1274 [ 0x00 ] = { cmd_test_unit_ready, CHECK_READY | NONDATA },
1275 [ 0x03 ] = { cmd_request_sense, ALLOW_UA },
1276 [ 0x12 ] = { cmd_inquiry, ALLOW_UA },
1277 [ 0x1b ] = { cmd_start_stop_unit, NONDATA }, /* [1] */
1278 [ 0x1e ] = { cmd_prevent_allow_medium_removal, NONDATA },
1279 [ 0x25 ] = { cmd_read_cdvd_capacity, CHECK_READY },
1280 [ 0x28 ] = { cmd_read, /* (10) */ CHECK_READY },
1281 [ 0x2b ] = { cmd_seek, CHECK_READY | NONDATA },
1282 [ 0x43 ] = { cmd_read_toc_pma_atip, CHECK_READY },
1283 [ 0x46 ] = { cmd_get_configuration, ALLOW_UA },
1284 [ 0x4a ] = { cmd_get_event_status_notification, ALLOW_UA },
1285 [ 0x51 ] = { cmd_read_disc_information, CHECK_READY },
1286 [ 0x5a ] = { cmd_mode_sense, /* (10) */ 0 },
1287 [ 0xa8 ] = { cmd_read, /* (12) */ CHECK_READY },
1288 [ 0xad ] = { cmd_read_dvd_structure, CHECK_READY },
1289 [ 0xbb ] = { cmd_set_speed, NONDATA },
1290 [ 0xbd ] = { cmd_mechanism_status, 0 },
1291 [ 0xbe ] = { cmd_read_cd, CHECK_READY },
1292 /* [1] handler detects and reports not ready condition itself */
1295 void ide_atapi_cmd(IDEState *s)
1297 uint8_t *buf = s->io_buffer;
1298 const struct AtapiCmd *cmd = &atapi_cmd_table[s->io_buffer[0]];
1300 #ifdef DEBUG_IDE_ATAPI
1303 printf("ATAPI limit=0x%x packet:", s->lcyl | (s->hcyl << 8));
1304 for(i = 0; i < ATAPI_PACKET_SIZE; i++) {
1305 printf(" %02x", buf[i]);
1312 * If there's a UNIT_ATTENTION condition pending, only command flagged with
1313 * ALLOW_UA are allowed to complete. with other commands getting a CHECK
1314 * condition response unless a higher priority status, defined by the drive
1317 if (s->sense_key == UNIT_ATTENTION && !(cmd->flags & ALLOW_UA)) {
1318 ide_atapi_cmd_check_status(s);
1322 * When a CD gets changed, we have to report an ejected state and
1323 * then a loaded state to guests so that they detect tray
1324 * open/close and media change events. Guests that do not use
1325 * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
1326 * states rely on this behavior.
1328 if (!(cmd->flags & ALLOW_UA) &&
1329 !s->tray_open && blk_is_inserted(s->blk) && s->cdrom_changed) {
1331 if (s->cdrom_changed == 1) {
1332 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1333 s->cdrom_changed = 2;
1335 ide_atapi_cmd_error(s, UNIT_ATTENTION, ASC_MEDIUM_MAY_HAVE_CHANGED);
1336 s->cdrom_changed = 0;
1342 /* Report a Not Ready condition if appropriate for the command */
1343 if ((cmd->flags & CHECK_READY) &&
1344 (!media_present(s) || !blk_is_inserted(s->blk)))
1346 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1350 /* Nondata commands permit the byte_count_limit to be 0.
1351 * If this is a data-transferring PIO command and BCL is 0,
1352 * we abort at the /ATA/ level, not the ATAPI level.
1353 * See ATA8 ACS3 section 7.17.6.49 and 7.21.5 */
1354 if (cmd->handler && !(cmd->flags & NONDATA)) {
1355 /* TODO: Check IDENTIFY data word 125 for default BCL (currently 0) */
1356 if (!(atapi_byte_count_limit(s) || s->atapi_dma)) {
1357 /* TODO: Move abort back into core.c and make static inline again */
1358 ide_abort_command(s);
1363 /* Execute the command */
1365 cmd->handler(s, buf);
1369 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_ILLEGAL_OPCODE);