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 "hw/ide/internal.h"
27 #include "hw/scsi/scsi.h"
28 #include "sysemu/block-backend.h"
30 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret);
32 static void padstr8(uint8_t *buf, int buf_size, const char *src)
35 for(i = 0; i < buf_size; i++) {
43 static inline void cpu_to_ube16(uint8_t *buf, int val)
49 static inline void cpu_to_ube32(uint8_t *buf, unsigned int val)
57 static inline int ube16_to_cpu(const uint8_t *buf)
59 return (buf[0] << 8) | buf[1];
62 static inline int ube32_to_cpu(const uint8_t *buf)
64 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
67 static void lba_to_msf(uint8_t *buf, int lba)
70 buf[0] = (lba / 75) / 60;
71 buf[1] = (lba / 75) % 60;
75 static inline int media_present(IDEState *s)
77 return !s->tray_open && s->nb_sectors > 0;
80 /* XXX: DVDs that could fit on a CD will be reported as a CD */
81 static inline int media_is_dvd(IDEState *s)
83 return (media_present(s) && s->nb_sectors > CD_MAX_SECTORS);
86 static inline int media_is_cd(IDEState *s)
88 return (media_present(s) && s->nb_sectors <= CD_MAX_SECTORS);
91 static void cd_data_to_raw(uint8_t *buf, int lba)
95 memset(buf + 1, 0xff, 10);
100 buf[3] = 0x01; /* mode 1 data */
104 /* XXX: ECC not computed */
109 cd_read_sector_sync(IDEState *s)
112 block_acct_start(blk_get_stats(s->blk), &s->acct,
113 4 * BDRV_SECTOR_SIZE, BLOCK_ACCT_READ);
115 #ifdef DEBUG_IDE_ATAPI
116 printf("cd_read_sector_sync: lba=%d\n", s->lba);
119 switch (s->cd_sector_size) {
121 ret = blk_read(s->blk, (int64_t)s->lba << 2,
125 ret = blk_read(s->blk, (int64_t)s->lba << 2,
126 s->io_buffer + 16, 4);
128 cd_data_to_raw(s->io_buffer, s->lba);
132 block_acct_invalid(blk_get_stats(s->blk), BLOCK_ACCT_READ);
137 block_acct_failed(blk_get_stats(s->blk), &s->acct);
139 block_acct_done(blk_get_stats(s->blk), &s->acct);
141 s->io_buffer_index = 0;
147 static void cd_read_sector_cb(void *opaque, int ret)
149 IDEState *s = opaque;
151 block_acct_done(blk_get_stats(s->blk), &s->acct);
153 #ifdef DEBUG_IDE_ATAPI
154 printf("cd_read_sector_cb: lba=%d ret=%d\n", s->lba, ret);
158 ide_atapi_io_error(s, ret);
162 if (s->cd_sector_size == 2352) {
163 cd_data_to_raw(s->io_buffer, s->lba);
167 s->io_buffer_index = 0;
168 s->status &= ~BUSY_STAT;
170 ide_atapi_cmd_reply_end(s);
173 static int cd_read_sector(IDEState *s)
175 if (s->cd_sector_size != 2048 && s->cd_sector_size != 2352) {
179 s->iov.iov_base = (s->cd_sector_size == 2352) ?
180 s->io_buffer + 16 : s->io_buffer;
182 s->iov.iov_len = 4 * BDRV_SECTOR_SIZE;
183 qemu_iovec_init_external(&s->qiov, &s->iov, 1);
185 #ifdef DEBUG_IDE_ATAPI
186 printf("cd_read_sector: lba=%d\n", s->lba);
189 block_acct_start(blk_get_stats(s->blk), &s->acct,
190 4 * BDRV_SECTOR_SIZE, BLOCK_ACCT_READ);
192 ide_buffered_readv(s, (int64_t)s->lba << 2, &s->qiov, 4,
193 cd_read_sector_cb, s);
195 s->status |= BUSY_STAT;
199 void ide_atapi_cmd_ok(IDEState *s)
202 s->status = READY_STAT | SEEK_STAT;
203 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
204 ide_transfer_stop(s);
208 void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc)
210 #ifdef DEBUG_IDE_ATAPI
211 printf("atapi_cmd_error: sense=0x%x asc=0x%x\n", sense_key, asc);
213 s->error = sense_key << 4;
214 s->status = READY_STAT | ERR_STAT;
215 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
216 s->sense_key = sense_key;
218 ide_transfer_stop(s);
222 void ide_atapi_io_error(IDEState *s, int ret)
224 /* XXX: handle more errors */
225 if (ret == -ENOMEDIUM) {
226 ide_atapi_cmd_error(s, NOT_READY,
227 ASC_MEDIUM_NOT_PRESENT);
229 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
230 ASC_LOGICAL_BLOCK_OOR);
234 static uint16_t atapi_byte_count_limit(IDEState *s)
238 bcl = s->lcyl | (s->hcyl << 8);
245 /* The whole ATAPI transfer logic is handled in this function */
246 void ide_atapi_cmd_reply_end(IDEState *s)
248 int byte_count_limit, size, ret;
249 #ifdef DEBUG_IDE_ATAPI
250 printf("reply: tx_size=%d elem_tx_size=%d index=%d\n",
251 s->packet_transfer_size,
252 s->elementary_transfer_size,
255 if (s->packet_transfer_size <= 0) {
256 /* end of transfer */
259 #ifdef DEBUG_IDE_ATAPI
260 printf("end of transfer, status=0x%x\n", s->status);
263 /* see if a new sector must be read */
264 if (s->lba != -1 && s->io_buffer_index >= s->cd_sector_size) {
265 if (!s->elementary_transfer_size) {
266 ret = cd_read_sector(s);
268 ide_atapi_io_error(s, ret);
272 /* rebuffering within an elementary transfer is
273 * only possible with a sync request because we
274 * end up with a race condition otherwise */
275 ret = cd_read_sector_sync(s);
277 ide_atapi_io_error(s, ret);
282 if (s->elementary_transfer_size > 0) {
283 /* there are some data left to transmit in this elementary
285 size = s->cd_sector_size - s->io_buffer_index;
286 if (size > s->elementary_transfer_size)
287 size = s->elementary_transfer_size;
288 s->packet_transfer_size -= size;
289 s->elementary_transfer_size -= size;
290 s->io_buffer_index += size;
291 ide_transfer_start(s, s->io_buffer + s->io_buffer_index - size,
292 size, ide_atapi_cmd_reply_end);
294 /* a new transfer is needed */
295 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO;
296 byte_count_limit = atapi_byte_count_limit(s);
297 #ifdef DEBUG_IDE_ATAPI
298 printf("byte_count_limit=%d\n", byte_count_limit);
300 size = s->packet_transfer_size;
301 if (size > byte_count_limit) {
302 /* byte count limit must be even if this case */
303 if (byte_count_limit & 1)
305 size = byte_count_limit;
309 s->elementary_transfer_size = size;
310 /* we cannot transmit more than one sector at a time */
312 if (size > (s->cd_sector_size - s->io_buffer_index))
313 size = (s->cd_sector_size - s->io_buffer_index);
315 s->packet_transfer_size -= size;
316 s->elementary_transfer_size -= size;
317 s->io_buffer_index += size;
318 ide_transfer_start(s, s->io_buffer + s->io_buffer_index - size,
319 size, ide_atapi_cmd_reply_end);
321 #ifdef DEBUG_IDE_ATAPI
322 printf("status=0x%x\n", s->status);
328 /* send a reply of 'size' bytes in s->io_buffer to an ATAPI command */
329 static void ide_atapi_cmd_reply(IDEState *s, int size, int max_size)
333 s->lba = -1; /* no sector read */
334 s->packet_transfer_size = size;
335 s->io_buffer_size = size; /* dma: send the reply data as one chunk */
336 s->elementary_transfer_size = 0;
339 block_acct_start(blk_get_stats(s->blk), &s->acct, size,
341 s->status = READY_STAT | SEEK_STAT | DRQ_STAT;
342 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
344 s->status = READY_STAT | SEEK_STAT;
345 s->io_buffer_index = 0;
346 ide_atapi_cmd_reply_end(s);
350 /* start a CD-CDROM read command */
351 static void ide_atapi_cmd_read_pio(IDEState *s, int lba, int nb_sectors,
355 s->packet_transfer_size = nb_sectors * sector_size;
356 s->elementary_transfer_size = 0;
357 s->io_buffer_index = sector_size;
358 s->cd_sector_size = sector_size;
360 ide_atapi_cmd_reply_end(s);
363 static void ide_atapi_cmd_check_status(IDEState *s)
365 #ifdef DEBUG_IDE_ATAPI
366 printf("atapi_cmd_check_status\n");
368 s->error = MC_ERR | (UNIT_ATTENTION << 4);
369 s->status = ERR_STAT;
373 /* ATAPI DMA support */
375 /* XXX: handle read errors */
376 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret)
378 IDEState *s = opaque;
382 ide_atapi_io_error(s, ret);
386 if (s->io_buffer_size > 0) {
388 * For a cdrom read sector command (s->lba != -1),
389 * adjust the lba for the next s->io_buffer_size chunk
390 * and dma the current chunk.
391 * For a command != read (s->lba == -1), just transfer
395 if (s->cd_sector_size == 2352) {
397 cd_data_to_raw(s->io_buffer, s->lba);
399 n = s->io_buffer_size >> 11;
403 s->packet_transfer_size -= s->io_buffer_size;
404 if (s->bus->dma->ops->rw_buf(s->bus->dma, 1) == 0)
408 if (s->packet_transfer_size <= 0) {
409 s->status = READY_STAT | SEEK_STAT;
410 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
415 s->io_buffer_index = 0;
416 if (s->cd_sector_size == 2352) {
418 s->io_buffer_size = s->cd_sector_size;
421 n = s->packet_transfer_size >> 11;
422 if (n > (IDE_DMA_BUF_SECTORS / 4))
423 n = (IDE_DMA_BUF_SECTORS / 4);
424 s->io_buffer_size = n * 2048;
428 printf("aio_read_cd: lba=%u n=%d\n", s->lba, n);
431 s->bus->dma->iov.iov_base = (void *)(s->io_buffer + data_offset);
432 s->bus->dma->iov.iov_len = n * 4 * 512;
433 qemu_iovec_init_external(&s->bus->dma->qiov, &s->bus->dma->iov, 1);
435 s->bus->dma->aiocb = ide_buffered_readv(s, (int64_t)s->lba << 2,
436 &s->bus->dma->qiov, n * 4,
437 ide_atapi_cmd_read_dma_cb, s);
442 block_acct_failed(blk_get_stats(s->blk), &s->acct);
444 block_acct_done(blk_get_stats(s->blk), &s->acct);
446 ide_set_inactive(s, false);
449 /* start a CD-CDROM read command with DMA */
450 /* XXX: test if DMA is available */
451 static void ide_atapi_cmd_read_dma(IDEState *s, int lba, int nb_sectors,
455 s->packet_transfer_size = nb_sectors * sector_size;
456 s->io_buffer_size = 0;
457 s->cd_sector_size = sector_size;
459 block_acct_start(blk_get_stats(s->blk), &s->acct, s->packet_transfer_size,
462 /* XXX: check if BUSY_STAT should be set */
463 s->status = READY_STAT | SEEK_STAT | DRQ_STAT | BUSY_STAT;
464 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
467 static void ide_atapi_cmd_read(IDEState *s, int lba, int nb_sectors,
470 #ifdef DEBUG_IDE_ATAPI
471 printf("read %s: LBA=%d nb_sectors=%d\n", s->atapi_dma ? "dma" : "pio",
475 ide_atapi_cmd_read_dma(s, lba, nb_sectors, sector_size);
477 ide_atapi_cmd_read_pio(s, lba, nb_sectors, sector_size);
482 /* Called by *_restart_bh when the transfer function points
485 void ide_atapi_dma_restart(IDEState *s)
488 * I'm not sure we have enough stored to restart the command
489 * safely, so give the guest an error it should recover from.
490 * I'm assuming most guests will try to recover from something
491 * listed as a medium error on a CD; it seems to work on Linux.
492 * This would be more of a problem if we did any other type of
495 ide_atapi_cmd_error(s, MEDIUM_ERROR, ASC_NO_SEEK_COMPLETE);
498 static inline uint8_t ide_atapi_set_profile(uint8_t *buf, uint8_t *index,
501 uint8_t *buf_profile = buf + 12; /* start of profiles */
503 buf_profile += ((*index) * 4); /* start of indexed profile */
504 cpu_to_ube16 (buf_profile, profile);
505 buf_profile[2] = ((buf_profile[0] == buf[6]) && (buf_profile[1] == buf[7]));
507 /* each profile adds 4 bytes to the response */
509 buf[11] += 4; /* Additional Length */
514 static int ide_dvd_read_structure(IDEState *s, int format,
515 const uint8_t *packet, uint8_t *buf)
518 case 0x0: /* Physical format information */
520 int layer = packet[6];
521 uint64_t total_sectors;
524 return -ASC_INV_FIELD_IN_CMD_PACKET;
526 total_sectors = s->nb_sectors >> 2;
527 if (total_sectors == 0) {
528 return -ASC_MEDIUM_NOT_PRESENT;
531 buf[4] = 1; /* DVD-ROM, part version 1 */
532 buf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
533 buf[6] = 1; /* one layer, read-only (per MMC-2 spec) */
534 buf[7] = 0; /* default densities */
536 /* FIXME: 0x30000 per spec? */
537 cpu_to_ube32(buf + 8, 0); /* start sector */
538 cpu_to_ube32(buf + 12, total_sectors - 1); /* end sector */
539 cpu_to_ube32(buf + 16, total_sectors - 1); /* l0 end sector */
541 /* Size of buffer, not including 2 byte size field */
542 stw_be_p(buf, 2048 + 2);
544 /* 2k data + 4 byte header */
548 case 0x01: /* DVD copyright information */
549 buf[4] = 0; /* no copyright data */
550 buf[5] = 0; /* no region restrictions */
552 /* Size of buffer, not including 2 byte size field */
553 stw_be_p(buf, 4 + 2);
555 /* 4 byte header + 4 byte data */
558 case 0x03: /* BCA information - invalid field for no BCA info */
559 return -ASC_INV_FIELD_IN_CMD_PACKET;
561 case 0x04: /* DVD disc manufacturing information */
562 /* Size of buffer, not including 2 byte size field */
563 stw_be_p(buf, 2048 + 2);
565 /* 2k data + 4 byte header */
570 * This lists all the command capabilities above. Add new ones
571 * in order and update the length and buffer return values.
574 buf[4] = 0x00; /* Physical format */
575 buf[5] = 0x40; /* Not writable, is readable */
576 stw_be_p(buf + 6, 2048 + 4);
578 buf[8] = 0x01; /* Copyright info */
579 buf[9] = 0x40; /* Not writable, is readable */
580 stw_be_p(buf + 10, 4 + 4);
582 buf[12] = 0x03; /* BCA info */
583 buf[13] = 0x40; /* Not writable, is readable */
584 stw_be_p(buf + 14, 188 + 4);
586 buf[16] = 0x04; /* Manufacturing info */
587 buf[17] = 0x40; /* Not writable, is readable */
588 stw_be_p(buf + 18, 2048 + 4);
590 /* Size of buffer, not including 2 byte size field */
591 stw_be_p(buf, 16 + 2);
593 /* data written + 4 byte header */
596 default: /* TODO: formats beyond DVD-ROM requires */
597 return -ASC_INV_FIELD_IN_CMD_PACKET;
601 static unsigned int event_status_media(IDEState *s,
604 uint8_t event_code, media_status;
608 media_status = MS_TRAY_OPEN;
609 } else if (blk_is_inserted(s->blk)) {
610 media_status = MS_MEDIA_PRESENT;
613 /* Event notification descriptor */
614 event_code = MEC_NO_CHANGE;
615 if (media_status != MS_TRAY_OPEN) {
616 if (s->events.new_media) {
617 event_code = MEC_NEW_MEDIA;
618 s->events.new_media = false;
619 } else if (s->events.eject_request) {
620 event_code = MEC_EJECT_REQUESTED;
621 s->events.eject_request = false;
626 buf[5] = media_status;
628 /* These fields are reserved, just clear them. */
632 return 8; /* We wrote to 4 extra bytes from the header */
635 static void cmd_get_event_status_notification(IDEState *s,
638 const uint8_t *packet = buf;
642 uint8_t polled; /* lsb bit is polled; others are reserved */
643 uint8_t reserved2[2];
645 uint8_t reserved3[2];
648 } QEMU_PACKED *gesn_cdb;
652 uint8_t notification_class;
653 uint8_t supported_events;
654 } QEMU_PACKED *gesn_event_header;
655 unsigned int max_len, used_len;
657 gesn_cdb = (void *)packet;
658 gesn_event_header = (void *)buf;
660 max_len = be16_to_cpu(gesn_cdb->len);
662 /* It is fine by the MMC spec to not support async mode operations */
663 if (!(gesn_cdb->polled & 0x01)) { /* asynchronous mode */
664 /* Only polling is supported, asynchronous mode is not. */
665 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
666 ASC_INV_FIELD_IN_CMD_PACKET);
670 /* polling mode operation */
673 * These are the supported events.
675 * We currently only support requests of the 'media' type.
676 * Notification class requests and supported event classes are bitmasks,
677 * but they are build from the same values as the "notification class"
680 gesn_event_header->supported_events = 1 << GESN_MEDIA;
683 * We use |= below to set the class field; other bits in this byte
684 * are reserved now but this is useful to do if we have to use the
685 * reserved fields later.
687 gesn_event_header->notification_class = 0;
690 * Responses to requests are to be based on request priority. The
691 * notification_class_request_type enum above specifies the
692 * priority: upper elements are higher prio than lower ones.
694 if (gesn_cdb->class & (1 << GESN_MEDIA)) {
695 gesn_event_header->notification_class |= GESN_MEDIA;
696 used_len = event_status_media(s, buf);
698 gesn_event_header->notification_class = 0x80; /* No event available */
699 used_len = sizeof(*gesn_event_header);
701 gesn_event_header->len = cpu_to_be16(used_len
702 - sizeof(*gesn_event_header));
703 ide_atapi_cmd_reply(s, used_len, max_len);
706 static void cmd_request_sense(IDEState *s, uint8_t *buf)
708 int max_len = buf[4];
711 buf[0] = 0x70 | (1 << 7);
712 buf[2] = s->sense_key;
716 if (s->sense_key == UNIT_ATTENTION) {
717 s->sense_key = NO_SENSE;
720 ide_atapi_cmd_reply(s, 18, max_len);
723 static void cmd_inquiry(IDEState *s, uint8_t *buf)
725 uint8_t page_code = buf[2];
726 int max_len = buf[4];
730 unsigned preamble_len;
732 /* If the EVPD (Enable Vital Product Data) bit is set in byte 1,
733 * we are being asked for a specific page of info indicated by byte 2. */
738 buf[idx++] = 0x05; /* CD-ROM */
739 buf[idx++] = page_code; /* Page Code */
740 buf[idx++] = 0x00; /* reserved */
741 idx++; /* length (set later) */
745 /* Supported Pages: List of supported VPD responses. */
746 buf[idx++] = 0x00; /* 0x00: Supported Pages, and: */
747 buf[idx++] = 0x83; /* 0x83: Device Identification. */
751 /* Device Identification. Each entry is optional, but the entries
752 * included here are modeled after libata's VPD responses.
753 * If the response is given, at least one entry must be present. */
755 /* Entry 1: Serial */
756 if (idx + 24 > max_len) {
757 /* Not enough room for even the first entry: */
758 /* 4 byte header + 20 byte string */
759 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
760 ASC_DATA_PHASE_ERROR);
763 buf[idx++] = 0x02; /* Ascii */
764 buf[idx++] = 0x00; /* Vendor Specific */
766 buf[idx++] = 20; /* Remaining length */
767 padstr8(buf + idx, 20, s->drive_serial_str);
770 /* Entry 2: Drive Model and Serial */
771 if (idx + 72 > max_len) {
772 /* 4 (header) + 8 (vendor) + 60 (model & serial) */
775 buf[idx++] = 0x02; /* Ascii */
776 buf[idx++] = 0x01; /* T10 Vendor */
779 padstr8(buf + idx, 8, "ATA"); /* Generic T10 vendor */
781 padstr8(buf + idx, 40, s->drive_model_str);
783 padstr8(buf + idx, 20, s->drive_serial_str);
787 if (s->wwn && (idx + 12 <= max_len)) {
788 /* 4 byte header + 8 byte wwn */
789 buf[idx++] = 0x01; /* Binary */
790 buf[idx++] = 0x03; /* NAA */
793 stq_be_p(&buf[idx], s->wwn);
799 /* SPC-3, revision 23 sec. 6.4 */
800 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
801 ASC_INV_FIELD_IN_CMD_PACKET);
808 buf[0] = 0x05; /* CD-ROM */
809 buf[1] = 0x80; /* removable */
810 buf[2] = 0x00; /* ISO */
811 buf[3] = 0x21; /* ATAPI-2 (XXX: put ATAPI-4 ?) */
812 /* buf[size_idx] set below. */
813 buf[5] = 0; /* reserved */
814 buf[6] = 0; /* reserved */
815 buf[7] = 0; /* reserved */
816 padstr8(buf + 8, 8, "QEMU");
817 padstr8(buf + 16, 16, "QEMU DVD-ROM");
818 padstr8(buf + 32, 4, s->version);
823 buf[size_idx] = idx - preamble_len;
824 ide_atapi_cmd_reply(s, idx, max_len);
828 static void cmd_get_configuration(IDEState *s, uint8_t *buf)
834 /* only feature 0 is supported */
835 if (buf[2] != 0 || buf[3] != 0) {
836 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
837 ASC_INV_FIELD_IN_CMD_PACKET);
841 /* XXX: could result in alignment problems in some architectures */
842 max_len = ube16_to_cpu(buf + 7);
845 * XXX: avoid overflow for io_buffer if max_len is bigger than
846 * the size of that buffer (dimensioned to max number of
847 * sectors to transfer at once)
849 * Only a problem if the feature/profiles grow.
852 /* XXX: assume 1 sector */
856 memset(buf, 0, max_len);
858 * the number of sectors from the media tells us which profile
859 * to use as current. 0 means there is no media
861 if (media_is_dvd(s)) {
862 cpu_to_ube16(buf + 6, MMC_PROFILE_DVD_ROM);
863 } else if (media_is_cd(s)) {
864 cpu_to_ube16(buf + 6, MMC_PROFILE_CD_ROM);
867 buf[10] = 0x02 | 0x01; /* persistent and current */
868 len = 12; /* headers: 8 + 4 */
869 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_DVD_ROM);
870 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_CD_ROM);
871 cpu_to_ube32(buf, len - 4); /* data length */
873 ide_atapi_cmd_reply(s, len, max_len);
876 static void cmd_mode_sense(IDEState *s, uint8_t *buf)
881 max_len = ube16_to_cpu(buf + 7);
882 action = buf[2] >> 6;
883 code = buf[2] & 0x3f;
886 case 0: /* current values */
888 case MODE_PAGE_R_W_ERROR: /* error recovery */
889 cpu_to_ube16(&buf[0], 16 - 2);
897 buf[8] = MODE_PAGE_R_W_ERROR;
905 ide_atapi_cmd_reply(s, 16, max_len);
907 case MODE_PAGE_AUDIO_CTL:
908 cpu_to_ube16(&buf[0], 24 - 2);
916 buf[8] = MODE_PAGE_AUDIO_CTL;
918 /* Fill with CDROM audio volume */
924 ide_atapi_cmd_reply(s, 24, max_len);
926 case MODE_PAGE_CAPABILITIES:
927 cpu_to_ube16(&buf[0], 30 - 2);
935 buf[8] = MODE_PAGE_CAPABILITIES;
937 buf[10] = 0x3b; /* read CDR/CDRW/DVDROM/DVDR/DVDRAM */
940 /* Claim PLAY_AUDIO capability (0x01) since some Linux
941 code checks for this to automount media. */
944 buf[14] = (1 << 0) | (1 << 3) | (1 << 5);
945 if (s->tray_locked) {
948 buf[15] = 0x00; /* No volume & mute control, no changer */
949 cpu_to_ube16(&buf[16], 704); /* 4x read speed */
950 buf[18] = 0; /* Two volume levels */
952 cpu_to_ube16(&buf[20], 512); /* 512k buffer */
953 cpu_to_ube16(&buf[22], 704); /* 4x read speed current */
960 ide_atapi_cmd_reply(s, 30, max_len);
966 case 1: /* changeable values */
968 case 2: /* default values */
971 case 3: /* saved values */
972 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
973 ASC_SAVING_PARAMETERS_NOT_SUPPORTED);
979 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_INV_FIELD_IN_CMD_PACKET);
982 static void cmd_test_unit_ready(IDEState *s, uint8_t *buf)
984 /* Not Ready Conditions are already handled in ide_atapi_cmd(), so if we
985 * come here, we know that it's ready. */
989 static void cmd_prevent_allow_medium_removal(IDEState *s, uint8_t* buf)
991 s->tray_locked = buf[4] & 1;
992 blk_lock_medium(s->blk, buf[4] & 1);
996 static void cmd_read(IDEState *s, uint8_t* buf)
1000 if (buf[0] == GPCMD_READ_10) {
1001 nb_sectors = ube16_to_cpu(buf + 7);
1003 nb_sectors = ube32_to_cpu(buf + 6);
1006 lba = ube32_to_cpu(buf + 2);
1007 if (nb_sectors == 0) {
1008 ide_atapi_cmd_ok(s);
1012 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1015 static void cmd_read_cd(IDEState *s, uint8_t* buf)
1017 int nb_sectors, lba, transfer_request;
1019 nb_sectors = (buf[6] << 16) | (buf[7] << 8) | buf[8];
1020 lba = ube32_to_cpu(buf + 2);
1022 if (nb_sectors == 0) {
1023 ide_atapi_cmd_ok(s);
1027 transfer_request = buf[9];
1028 switch(transfer_request & 0xf8) {
1031 ide_atapi_cmd_ok(s);
1035 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1039 ide_atapi_cmd_read(s, lba, nb_sectors, 2352);
1042 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1043 ASC_INV_FIELD_IN_CMD_PACKET);
1048 static void cmd_seek(IDEState *s, uint8_t* buf)
1051 uint64_t total_sectors = s->nb_sectors >> 2;
1053 lba = ube32_to_cpu(buf + 2);
1054 if (lba >= total_sectors) {
1055 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_LOGICAL_BLOCK_OOR);
1059 ide_atapi_cmd_ok(s);
1062 static void cmd_start_stop_unit(IDEState *s, uint8_t* buf)
1065 bool start = buf[4] & 1;
1066 bool loej = buf[4] & 2; /* load on start, eject on !start */
1067 int pwrcnd = buf[4] & 0xf0;
1070 /* eject/load only happens for power condition == 0 */
1071 ide_atapi_cmd_ok(s);
1076 if (!start && !s->tray_open && s->tray_locked) {
1077 sense = blk_is_inserted(s->blk)
1078 ? NOT_READY : ILLEGAL_REQUEST;
1079 ide_atapi_cmd_error(s, sense, ASC_MEDIA_REMOVAL_PREVENTED);
1083 if (s->tray_open != !start) {
1084 blk_eject(s->blk, !start);
1085 s->tray_open = !start;
1089 ide_atapi_cmd_ok(s);
1092 static void cmd_mechanism_status(IDEState *s, uint8_t* buf)
1094 int max_len = ube16_to_cpu(buf + 8);
1096 cpu_to_ube16(buf, 0);
1097 /* no current LBA */
1102 cpu_to_ube16(buf + 6, 0);
1103 ide_atapi_cmd_reply(s, 8, max_len);
1106 static void cmd_read_toc_pma_atip(IDEState *s, uint8_t* buf)
1108 int format, msf, start_track, len;
1110 uint64_t total_sectors = s->nb_sectors >> 2;
1112 max_len = ube16_to_cpu(buf + 7);
1113 format = buf[9] >> 6;
1114 msf = (buf[1] >> 1) & 1;
1115 start_track = buf[6];
1119 len = cdrom_read_toc(total_sectors, buf, msf, start_track);
1122 ide_atapi_cmd_reply(s, len, max_len);
1125 /* multi session : only a single session defined */
1130 ide_atapi_cmd_reply(s, 12, max_len);
1133 len = cdrom_read_toc_raw(total_sectors, buf, msf, start_track);
1136 ide_atapi_cmd_reply(s, len, max_len);
1140 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1141 ASC_INV_FIELD_IN_CMD_PACKET);
1145 static void cmd_read_cdvd_capacity(IDEState *s, uint8_t* buf)
1147 uint64_t total_sectors = s->nb_sectors >> 2;
1149 /* NOTE: it is really the number of sectors minus 1 */
1150 cpu_to_ube32(buf, total_sectors - 1);
1151 cpu_to_ube32(buf + 4, 2048);
1152 ide_atapi_cmd_reply(s, 8, 8);
1155 static void cmd_read_disc_information(IDEState *s, uint8_t* buf)
1157 uint8_t type = buf[1] & 7;
1158 uint32_t max_len = ube16_to_cpu(buf + 7);
1160 /* Types 1/2 are only defined for Blu-Ray. */
1162 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1163 ASC_INV_FIELD_IN_CMD_PACKET);
1169 buf[2] = 0xe; /* last session complete, disc finalized */
1170 buf[3] = 1; /* first track on disc */
1171 buf[4] = 1; /* # of sessions */
1172 buf[5] = 1; /* first track of last session */
1173 buf[6] = 1; /* last track of last session */
1174 buf[7] = 0x20; /* unrestricted use */
1175 buf[8] = 0x00; /* CD-ROM or DVD-ROM */
1176 /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
1177 /* 12-23: not meaningful for CD-ROM or DVD-ROM */
1178 /* 24-31: disc bar code */
1179 /* 32: disc application code */
1180 /* 33: number of OPC tables */
1182 ide_atapi_cmd_reply(s, 34, max_len);
1185 static void cmd_read_dvd_structure(IDEState *s, uint8_t* buf)
1189 int format = buf[7];
1192 max_len = ube16_to_cpu(buf + 8);
1194 if (format < 0xff) {
1195 if (media_is_cd(s)) {
1196 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1197 ASC_INCOMPATIBLE_FORMAT);
1199 } else if (!media_present(s)) {
1200 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1201 ASC_INV_FIELD_IN_CMD_PACKET);
1206 memset(buf, 0, max_len > IDE_DMA_BUF_SECTORS * 512 + 4 ?
1207 IDE_DMA_BUF_SECTORS * 512 + 4 : max_len);
1213 ret = ide_dvd_read_structure(s, format, buf, buf);
1216 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, -ret);
1218 ide_atapi_cmd_reply(s, ret, max_len);
1223 /* TODO: BD support, fall through for now */
1225 /* Generic disk structures */
1226 case 0x80: /* TODO: AACS volume identifier */
1227 case 0x81: /* TODO: AACS media serial number */
1228 case 0x82: /* TODO: AACS media identifier */
1229 case 0x83: /* TODO: AACS media key block */
1230 case 0x90: /* TODO: List of recognized format layers */
1231 case 0xc0: /* TODO: Write protection status */
1233 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1234 ASC_INV_FIELD_IN_CMD_PACKET);
1239 static void cmd_set_speed(IDEState *s, uint8_t* buf)
1241 ide_atapi_cmd_ok(s);
1246 * Only commands flagged as ALLOW_UA are allowed to run under a
1247 * unit attention condition. (See MMC-5, section 4.1.6.1)
1252 * Commands flagged with CHECK_READY can only execute if a medium is present.
1253 * Otherwise they report the Not Ready Condition. (See MMC-5, section
1259 * Commands flagged with NONDATA do not in any circumstances return
1260 * any data via ide_atapi_cmd_reply. These commands are exempt from
1261 * the normal byte_count_limit constraints.
1262 * See ATA8-ACS3 "7.21.5 Byte Count Limit"
1267 static const struct AtapiCmd {
1268 void (*handler)(IDEState *s, uint8_t *buf);
1270 } atapi_cmd_table[0x100] = {
1271 [ 0x00 ] = { cmd_test_unit_ready, CHECK_READY | NONDATA },
1272 [ 0x03 ] = { cmd_request_sense, ALLOW_UA },
1273 [ 0x12 ] = { cmd_inquiry, ALLOW_UA },
1274 [ 0x1b ] = { cmd_start_stop_unit, NONDATA }, /* [1] */
1275 [ 0x1e ] = { cmd_prevent_allow_medium_removal, NONDATA },
1276 [ 0x25 ] = { cmd_read_cdvd_capacity, CHECK_READY },
1277 [ 0x28 ] = { cmd_read, /* (10) */ CHECK_READY },
1278 [ 0x2b ] = { cmd_seek, CHECK_READY | NONDATA },
1279 [ 0x43 ] = { cmd_read_toc_pma_atip, CHECK_READY },
1280 [ 0x46 ] = { cmd_get_configuration, ALLOW_UA },
1281 [ 0x4a ] = { cmd_get_event_status_notification, ALLOW_UA },
1282 [ 0x51 ] = { cmd_read_disc_information, CHECK_READY },
1283 [ 0x5a ] = { cmd_mode_sense, /* (10) */ 0 },
1284 [ 0xa8 ] = { cmd_read, /* (12) */ CHECK_READY },
1285 [ 0xad ] = { cmd_read_dvd_structure, CHECK_READY },
1286 [ 0xbb ] = { cmd_set_speed, NONDATA },
1287 [ 0xbd ] = { cmd_mechanism_status, 0 },
1288 [ 0xbe ] = { cmd_read_cd, CHECK_READY },
1289 /* [1] handler detects and reports not ready condition itself */
1292 void ide_atapi_cmd(IDEState *s)
1294 uint8_t *buf = s->io_buffer;
1295 const struct AtapiCmd *cmd = &atapi_cmd_table[s->io_buffer[0]];
1297 #ifdef DEBUG_IDE_ATAPI
1300 printf("ATAPI limit=0x%x packet:", s->lcyl | (s->hcyl << 8));
1301 for(i = 0; i < ATAPI_PACKET_SIZE; i++) {
1302 printf(" %02x", buf[i]);
1309 * If there's a UNIT_ATTENTION condition pending, only command flagged with
1310 * ALLOW_UA are allowed to complete. with other commands getting a CHECK
1311 * condition response unless a higher priority status, defined by the drive
1314 if (s->sense_key == UNIT_ATTENTION && !(cmd->flags & ALLOW_UA)) {
1315 ide_atapi_cmd_check_status(s);
1319 * When a CD gets changed, we have to report an ejected state and
1320 * then a loaded state to guests so that they detect tray
1321 * open/close and media change events. Guests that do not use
1322 * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
1323 * states rely on this behavior.
1325 if (!(cmd->flags & ALLOW_UA) &&
1326 !s->tray_open && blk_is_inserted(s->blk) && s->cdrom_changed) {
1328 if (s->cdrom_changed == 1) {
1329 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1330 s->cdrom_changed = 2;
1332 ide_atapi_cmd_error(s, UNIT_ATTENTION, ASC_MEDIUM_MAY_HAVE_CHANGED);
1333 s->cdrom_changed = 0;
1339 /* Report a Not Ready condition if appropriate for the command */
1340 if ((cmd->flags & CHECK_READY) &&
1341 (!media_present(s) || !blk_is_inserted(s->blk)))
1343 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1347 /* Nondata commands permit the byte_count_limit to be 0.
1348 * If this is a data-transferring PIO command and BCL is 0,
1349 * we abort at the /ATA/ level, not the ATAPI level.
1350 * See ATA8 ACS3 section 7.17.6.49 and 7.21.5 */
1351 if (cmd->handler && !(cmd->flags & NONDATA)) {
1352 /* TODO: Check IDENTIFY data word 125 for default BCL (currently 0) */
1353 if (!(atapi_byte_count_limit(s) || s->atapi_dma)) {
1354 /* TODO: Move abort back into core.c and make static inline again */
1355 ide_abort_command(s);
1360 /* Execute the command */
1362 cmd->handler(s, buf);
1366 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_ILLEGAL_OPCODE);