scripts/qemu.py: use a more consistent docstring style
[qemu/ar7.git] / hw / ide / atapi.c
blob39e473f9c2ce04680967c8021489bb30a5e3157a
1 /*
2 * QEMU ATAPI Emulation
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
23 * THE SOFTWARE.
26 #include "qemu/osdep.h"
27 #include "hw/ide/internal.h"
28 #include "hw/scsi/scsi.h"
29 #include "sysemu/block-backend.h"
30 #include "trace.h"
32 #define ATAPI_SECTOR_BITS (2 + BDRV_SECTOR_BITS)
33 #define ATAPI_SECTOR_SIZE (1 << ATAPI_SECTOR_BITS)
35 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret);
37 static void padstr8(uint8_t *buf, int buf_size, const char *src)
39 int i;
40 for(i = 0; i < buf_size; i++) {
41 if (*src)
42 buf[i] = *src++;
43 else
44 buf[i] = ' ';
48 static inline void cpu_to_ube16(uint8_t *buf, int val)
50 buf[0] = val >> 8;
51 buf[1] = val & 0xff;
54 static inline void cpu_to_ube32(uint8_t *buf, unsigned int val)
56 buf[0] = val >> 24;
57 buf[1] = val >> 16;
58 buf[2] = val >> 8;
59 buf[3] = val & 0xff;
62 static inline int ube16_to_cpu(const uint8_t *buf)
64 return (buf[0] << 8) | buf[1];
67 static inline int ube32_to_cpu(const uint8_t *buf)
69 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
72 static void lba_to_msf(uint8_t *buf, int lba)
74 lba += 150;
75 buf[0] = (lba / 75) / 60;
76 buf[1] = (lba / 75) % 60;
77 buf[2] = lba % 75;
80 static inline int media_present(IDEState *s)
82 return !s->tray_open && s->nb_sectors > 0;
85 /* XXX: DVDs that could fit on a CD will be reported as a CD */
86 static inline int media_is_dvd(IDEState *s)
88 return (media_present(s) && s->nb_sectors > CD_MAX_SECTORS);
91 static inline int media_is_cd(IDEState *s)
93 return (media_present(s) && s->nb_sectors <= CD_MAX_SECTORS);
96 static void cd_data_to_raw(uint8_t *buf, int lba)
98 /* sync bytes */
99 buf[0] = 0x00;
100 memset(buf + 1, 0xff, 10);
101 buf[11] = 0x00;
102 buf += 12;
103 /* MSF */
104 lba_to_msf(buf, lba);
105 buf[3] = 0x01; /* mode 1 data */
106 buf += 4;
107 /* data */
108 buf += 2048;
109 /* XXX: ECC not computed */
110 memset(buf, 0, 288);
113 static int
114 cd_read_sector_sync(IDEState *s)
116 int ret;
117 block_acct_start(blk_get_stats(s->blk), &s->acct,
118 ATAPI_SECTOR_SIZE, BLOCK_ACCT_READ);
120 trace_cd_read_sector_sync(s->lba);
122 switch (s->cd_sector_size) {
123 case 2048:
124 ret = blk_pread(s->blk, (int64_t)s->lba << ATAPI_SECTOR_BITS,
125 s->io_buffer, ATAPI_SECTOR_SIZE);
126 break;
127 case 2352:
128 ret = blk_pread(s->blk, (int64_t)s->lba << ATAPI_SECTOR_BITS,
129 s->io_buffer + 16, ATAPI_SECTOR_SIZE);
130 if (ret >= 0) {
131 cd_data_to_raw(s->io_buffer, s->lba);
133 break;
134 default:
135 block_acct_invalid(blk_get_stats(s->blk), BLOCK_ACCT_READ);
136 return -EIO;
139 if (ret < 0) {
140 block_acct_failed(blk_get_stats(s->blk), &s->acct);
141 } else {
142 block_acct_done(blk_get_stats(s->blk), &s->acct);
143 s->lba++;
144 s->io_buffer_index = 0;
147 return ret;
150 static void cd_read_sector_cb(void *opaque, int ret)
152 IDEState *s = opaque;
154 trace_cd_read_sector_cb(s->lba, ret);
156 if (ret < 0) {
157 block_acct_failed(blk_get_stats(s->blk), &s->acct);
158 ide_atapi_io_error(s, ret);
159 return;
162 block_acct_done(blk_get_stats(s->blk), &s->acct);
164 if (s->cd_sector_size == 2352) {
165 cd_data_to_raw(s->io_buffer, s->lba);
168 s->lba++;
169 s->io_buffer_index = 0;
170 s->status &= ~BUSY_STAT;
172 ide_atapi_cmd_reply_end(s);
175 static int cd_read_sector(IDEState *s)
177 if (s->cd_sector_size != 2048 && s->cd_sector_size != 2352) {
178 block_acct_invalid(blk_get_stats(s->blk), BLOCK_ACCT_READ);
179 return -EINVAL;
182 s->iov.iov_base = (s->cd_sector_size == 2352) ?
183 s->io_buffer + 16 : s->io_buffer;
185 s->iov.iov_len = ATAPI_SECTOR_SIZE;
186 qemu_iovec_init_external(&s->qiov, &s->iov, 1);
188 trace_cd_read_sector(s->lba);
190 block_acct_start(blk_get_stats(s->blk), &s->acct,
191 ATAPI_SECTOR_SIZE, BLOCK_ACCT_READ);
193 ide_buffered_readv(s, (int64_t)s->lba << 2, &s->qiov, 4,
194 cd_read_sector_cb, s);
196 s->status |= BUSY_STAT;
197 return 0;
200 void ide_atapi_cmd_ok(IDEState *s)
202 s->error = 0;
203 s->status = READY_STAT | SEEK_STAT;
204 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
205 ide_transfer_stop(s);
206 ide_set_irq(s->bus);
209 void ide_atapi_cmd_error(IDEState *s, int sense_key, int asc)
211 trace_ide_atapi_cmd_error(s, sense_key, asc);
212 s->error = sense_key << 4;
213 s->status = READY_STAT | ERR_STAT;
214 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
215 s->sense_key = sense_key;
216 s->asc = asc;
217 ide_transfer_stop(s);
218 ide_set_irq(s->bus);
221 void ide_atapi_io_error(IDEState *s, int ret)
223 /* XXX: handle more errors */
224 if (ret == -ENOMEDIUM) {
225 ide_atapi_cmd_error(s, NOT_READY,
226 ASC_MEDIUM_NOT_PRESENT);
227 } else {
228 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
229 ASC_LOGICAL_BLOCK_OOR);
233 static uint16_t atapi_byte_count_limit(IDEState *s)
235 uint16_t bcl;
237 bcl = s->lcyl | (s->hcyl << 8);
238 if (bcl == 0xffff) {
239 return 0xfffe;
241 return bcl;
244 /* The whole ATAPI transfer logic is handled in this function */
245 void ide_atapi_cmd_reply_end(IDEState *s)
247 int byte_count_limit, size, ret;
248 while (s->packet_transfer_size > 0) {
249 trace_ide_atapi_cmd_reply_end(s, s->packet_transfer_size,
250 s->elementary_transfer_size,
251 s->io_buffer_index);
253 /* see if a new sector must be read */
254 if (s->lba != -1 && s->io_buffer_index >= s->cd_sector_size) {
255 if (!s->elementary_transfer_size) {
256 ret = cd_read_sector(s);
257 if (ret < 0) {
258 ide_atapi_io_error(s, ret);
260 return;
261 } else {
262 /* rebuffering within an elementary transfer is
263 * only possible with a sync request because we
264 * end up with a race condition otherwise */
265 ret = cd_read_sector_sync(s);
266 if (ret < 0) {
267 ide_atapi_io_error(s, ret);
268 return;
272 if (s->elementary_transfer_size > 0) {
273 /* there are some data left to transmit in this elementary
274 transfer */
275 size = s->cd_sector_size - s->io_buffer_index;
276 if (size > s->elementary_transfer_size)
277 size = s->elementary_transfer_size;
278 } else {
279 /* a new transfer is needed */
280 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO;
281 ide_set_irq(s->bus);
282 byte_count_limit = atapi_byte_count_limit(s);
283 trace_ide_atapi_cmd_reply_end_bcl(s, byte_count_limit);
284 size = s->packet_transfer_size;
285 if (size > byte_count_limit) {
286 /* byte count limit must be even if this case */
287 if (byte_count_limit & 1)
288 byte_count_limit--;
289 size = byte_count_limit;
291 s->lcyl = size;
292 s->hcyl = size >> 8;
293 s->elementary_transfer_size = size;
294 /* we cannot transmit more than one sector at a time */
295 if (s->lba != -1) {
296 if (size > (s->cd_sector_size - s->io_buffer_index))
297 size = (s->cd_sector_size - s->io_buffer_index);
299 trace_ide_atapi_cmd_reply_end_new(s, s->status);
301 s->packet_transfer_size -= size;
302 s->elementary_transfer_size -= size;
303 s->io_buffer_index += size;
305 /* Some adapters process PIO data right away. In that case, we need
306 * to avoid mutual recursion between ide_transfer_start
307 * and ide_atapi_cmd_reply_end.
309 if (!ide_transfer_start_norecurse(s,
310 s->io_buffer + s->io_buffer_index - size,
311 size, ide_atapi_cmd_reply_end)) {
312 return;
316 /* end of transfer */
317 trace_ide_atapi_cmd_reply_end_eot(s, s->status);
318 ide_atapi_cmd_ok(s);
319 ide_set_irq(s->bus);
322 /* send a reply of 'size' bytes in s->io_buffer to an ATAPI command */
323 static void ide_atapi_cmd_reply(IDEState *s, int size, int max_size)
325 if (size > max_size)
326 size = max_size;
327 s->lba = -1; /* no sector read */
328 s->packet_transfer_size = size;
329 s->io_buffer_size = size; /* dma: send the reply data as one chunk */
330 s->elementary_transfer_size = 0;
332 if (s->atapi_dma) {
333 block_acct_start(blk_get_stats(s->blk), &s->acct, size,
334 BLOCK_ACCT_READ);
335 s->status = READY_STAT | SEEK_STAT | DRQ_STAT;
336 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
337 } else {
338 s->status = READY_STAT | SEEK_STAT;
339 s->io_buffer_index = 0;
340 ide_atapi_cmd_reply_end(s);
344 /* start a CD-CDROM read command */
345 static void ide_atapi_cmd_read_pio(IDEState *s, int lba, int nb_sectors,
346 int sector_size)
348 s->lba = lba;
349 s->packet_transfer_size = nb_sectors * sector_size;
350 s->elementary_transfer_size = 0;
351 s->io_buffer_index = sector_size;
352 s->cd_sector_size = sector_size;
354 ide_atapi_cmd_reply_end(s);
357 static void ide_atapi_cmd_check_status(IDEState *s)
359 trace_ide_atapi_cmd_check_status(s);
360 s->error = MC_ERR | (UNIT_ATTENTION << 4);
361 s->status = ERR_STAT;
362 s->nsector = 0;
363 ide_set_irq(s->bus);
365 /* ATAPI DMA support */
367 static void ide_atapi_cmd_read_dma_cb(void *opaque, int ret)
369 IDEState *s = opaque;
370 int data_offset, n;
372 if (ret < 0) {
373 if (ide_handle_rw_error(s, -ret, ide_dma_cmd_to_retry(s->dma_cmd))) {
374 if (s->bus->error_status) {
375 s->bus->dma->aiocb = NULL;
376 return;
378 goto eot;
382 if (s->io_buffer_size > 0) {
384 * For a cdrom read sector command (s->lba != -1),
385 * adjust the lba for the next s->io_buffer_size chunk
386 * and dma the current chunk.
387 * For a command != read (s->lba == -1), just transfer
388 * the reply data.
390 if (s->lba != -1) {
391 if (s->cd_sector_size == 2352) {
392 n = 1;
393 cd_data_to_raw(s->io_buffer, s->lba);
394 } else {
395 n = s->io_buffer_size >> 11;
397 s->lba += n;
399 s->packet_transfer_size -= s->io_buffer_size;
400 if (s->bus->dma->ops->rw_buf(s->bus->dma, 1) == 0)
401 goto eot;
404 if (s->packet_transfer_size <= 0) {
405 s->status = READY_STAT | SEEK_STAT;
406 s->nsector = (s->nsector & ~7) | ATAPI_INT_REASON_IO | ATAPI_INT_REASON_CD;
407 ide_set_irq(s->bus);
408 goto eot;
411 s->io_buffer_index = 0;
412 if (s->cd_sector_size == 2352) {
413 n = 1;
414 s->io_buffer_size = s->cd_sector_size;
415 data_offset = 16;
416 } else {
417 n = s->packet_transfer_size >> 11;
418 if (n > (IDE_DMA_BUF_SECTORS / 4))
419 n = (IDE_DMA_BUF_SECTORS / 4);
420 s->io_buffer_size = n * 2048;
421 data_offset = 0;
423 trace_ide_atapi_cmd_read_dma_cb_aio(s, s->lba, n);
424 s->bus->dma->iov.iov_base = (void *)(s->io_buffer + data_offset);
425 s->bus->dma->iov.iov_len = n * ATAPI_SECTOR_SIZE;
426 qemu_iovec_init_external(&s->bus->dma->qiov, &s->bus->dma->iov, 1);
428 s->bus->dma->aiocb = ide_buffered_readv(s, (int64_t)s->lba << 2,
429 &s->bus->dma->qiov, n * 4,
430 ide_atapi_cmd_read_dma_cb, s);
431 return;
433 eot:
434 if (ret < 0) {
435 block_acct_failed(blk_get_stats(s->blk), &s->acct);
436 } else {
437 block_acct_done(blk_get_stats(s->blk), &s->acct);
439 ide_set_inactive(s, false);
442 /* start a CD-CDROM read command with DMA */
443 /* XXX: test if DMA is available */
444 static void ide_atapi_cmd_read_dma(IDEState *s, int lba, int nb_sectors,
445 int sector_size)
447 s->lba = lba;
448 s->packet_transfer_size = nb_sectors * sector_size;
449 s->io_buffer_size = 0;
450 s->cd_sector_size = sector_size;
452 block_acct_start(blk_get_stats(s->blk), &s->acct, s->packet_transfer_size,
453 BLOCK_ACCT_READ);
455 /* XXX: check if BUSY_STAT should be set */
456 s->status = READY_STAT | SEEK_STAT | DRQ_STAT | BUSY_STAT;
457 ide_start_dma(s, ide_atapi_cmd_read_dma_cb);
460 static void ide_atapi_cmd_read(IDEState *s, int lba, int nb_sectors,
461 int sector_size)
463 trace_ide_atapi_cmd_read(s, s->atapi_dma ? "dma" : "pio",
464 lba, nb_sectors);
465 if (s->atapi_dma) {
466 ide_atapi_cmd_read_dma(s, lba, nb_sectors, sector_size);
467 } else {
468 ide_atapi_cmd_read_pio(s, lba, nb_sectors, sector_size);
472 void ide_atapi_dma_restart(IDEState *s)
475 * At this point we can just re-evaluate the packet command and start over.
476 * The presence of ->dma_cb callback in the pre_save ensures that the packet
477 * command has been completely sent and we can safely restart command.
479 s->unit = s->bus->retry_unit;
480 s->bus->dma->ops->restart_dma(s->bus->dma);
481 ide_atapi_cmd(s);
484 static inline uint8_t ide_atapi_set_profile(uint8_t *buf, uint8_t *index,
485 uint16_t profile)
487 uint8_t *buf_profile = buf + 12; /* start of profiles */
489 buf_profile += ((*index) * 4); /* start of indexed profile */
490 cpu_to_ube16 (buf_profile, profile);
491 buf_profile[2] = ((buf_profile[0] == buf[6]) && (buf_profile[1] == buf[7]));
493 /* each profile adds 4 bytes to the response */
494 (*index)++;
495 buf[11] += 4; /* Additional Length */
497 return 4;
500 static int ide_dvd_read_structure(IDEState *s, int format,
501 const uint8_t *packet, uint8_t *buf)
503 switch (format) {
504 case 0x0: /* Physical format information */
506 int layer = packet[6];
507 uint64_t total_sectors;
509 if (layer != 0)
510 return -ASC_INV_FIELD_IN_CMD_PACKET;
512 total_sectors = s->nb_sectors >> 2;
513 if (total_sectors == 0) {
514 return -ASC_MEDIUM_NOT_PRESENT;
517 buf[4] = 1; /* DVD-ROM, part version 1 */
518 buf[5] = 0xf; /* 120mm disc, minimum rate unspecified */
519 buf[6] = 1; /* one layer, read-only (per MMC-2 spec) */
520 buf[7] = 0; /* default densities */
522 /* FIXME: 0x30000 per spec? */
523 cpu_to_ube32(buf + 8, 0); /* start sector */
524 cpu_to_ube32(buf + 12, total_sectors - 1); /* end sector */
525 cpu_to_ube32(buf + 16, total_sectors - 1); /* l0 end sector */
527 /* Size of buffer, not including 2 byte size field */
528 stw_be_p(buf, 2048 + 2);
530 /* 2k data + 4 byte header */
531 return (2048 + 4);
534 case 0x01: /* DVD copyright information */
535 buf[4] = 0; /* no copyright data */
536 buf[5] = 0; /* no region restrictions */
538 /* Size of buffer, not including 2 byte size field */
539 stw_be_p(buf, 4 + 2);
541 /* 4 byte header + 4 byte data */
542 return (4 + 4);
544 case 0x03: /* BCA information - invalid field for no BCA info */
545 return -ASC_INV_FIELD_IN_CMD_PACKET;
547 case 0x04: /* DVD disc manufacturing information */
548 /* Size of buffer, not including 2 byte size field */
549 stw_be_p(buf, 2048 + 2);
551 /* 2k data + 4 byte header */
552 return (2048 + 4);
554 case 0xff:
556 * This lists all the command capabilities above. Add new ones
557 * in order and update the length and buffer return values.
560 buf[4] = 0x00; /* Physical format */
561 buf[5] = 0x40; /* Not writable, is readable */
562 stw_be_p(buf + 6, 2048 + 4);
564 buf[8] = 0x01; /* Copyright info */
565 buf[9] = 0x40; /* Not writable, is readable */
566 stw_be_p(buf + 10, 4 + 4);
568 buf[12] = 0x03; /* BCA info */
569 buf[13] = 0x40; /* Not writable, is readable */
570 stw_be_p(buf + 14, 188 + 4);
572 buf[16] = 0x04; /* Manufacturing info */
573 buf[17] = 0x40; /* Not writable, is readable */
574 stw_be_p(buf + 18, 2048 + 4);
576 /* Size of buffer, not including 2 byte size field */
577 stw_be_p(buf, 16 + 2);
579 /* data written + 4 byte header */
580 return (16 + 4);
582 default: /* TODO: formats beyond DVD-ROM requires */
583 return -ASC_INV_FIELD_IN_CMD_PACKET;
587 static unsigned int event_status_media(IDEState *s,
588 uint8_t *buf)
590 uint8_t event_code, media_status;
592 media_status = 0;
593 if (s->tray_open) {
594 media_status = MS_TRAY_OPEN;
595 } else if (blk_is_inserted(s->blk)) {
596 media_status = MS_MEDIA_PRESENT;
599 /* Event notification descriptor */
600 event_code = MEC_NO_CHANGE;
601 if (media_status != MS_TRAY_OPEN) {
602 if (s->events.new_media) {
603 event_code = MEC_NEW_MEDIA;
604 s->events.new_media = false;
605 } else if (s->events.eject_request) {
606 event_code = MEC_EJECT_REQUESTED;
607 s->events.eject_request = false;
611 buf[4] = event_code;
612 buf[5] = media_status;
614 /* These fields are reserved, just clear them. */
615 buf[6] = 0;
616 buf[7] = 0;
618 return 8; /* We wrote to 4 extra bytes from the header */
622 * Before transferring data or otherwise signalling acceptance of a command
623 * marked CONDDATA, we must check the validity of the byte_count_limit.
625 static bool validate_bcl(IDEState *s)
627 /* TODO: Check IDENTIFY data word 125 for defacult BCL (currently 0) */
628 if (s->atapi_dma || atapi_byte_count_limit(s)) {
629 return true;
632 /* TODO: Move abort back into core.c and introduce proper error flow between
633 * ATAPI layer and IDE core layer */
634 ide_abort_command(s);
635 return false;
638 static void cmd_get_event_status_notification(IDEState *s,
639 uint8_t *buf)
641 const uint8_t *packet = buf;
643 struct {
644 uint8_t opcode;
645 uint8_t polled; /* lsb bit is polled; others are reserved */
646 uint8_t reserved2[2];
647 uint8_t class;
648 uint8_t reserved3[2];
649 uint16_t len;
650 uint8_t control;
651 } QEMU_PACKED *gesn_cdb;
653 struct {
654 uint16_t len;
655 uint8_t notification_class;
656 uint8_t supported_events;
657 } QEMU_PACKED *gesn_event_header;
658 unsigned int max_len, used_len;
660 gesn_cdb = (void *)packet;
661 gesn_event_header = (void *)buf;
663 max_len = be16_to_cpu(gesn_cdb->len);
665 /* It is fine by the MMC spec to not support async mode operations */
666 if (!(gesn_cdb->polled & 0x01)) { /* asynchronous mode */
667 /* Only polling is supported, asynchronous mode is not. */
668 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
669 ASC_INV_FIELD_IN_CMD_PACKET);
670 return;
673 /* polling mode operation */
676 * These are the supported events.
678 * We currently only support requests of the 'media' type.
679 * Notification class requests and supported event classes are bitmasks,
680 * but they are build from the same values as the "notification class"
681 * field.
683 gesn_event_header->supported_events = 1 << GESN_MEDIA;
686 * We use |= below to set the class field; other bits in this byte
687 * are reserved now but this is useful to do if we have to use the
688 * reserved fields later.
690 gesn_event_header->notification_class = 0;
693 * Responses to requests are to be based on request priority. The
694 * notification_class_request_type enum above specifies the
695 * priority: upper elements are higher prio than lower ones.
697 if (gesn_cdb->class & (1 << GESN_MEDIA)) {
698 gesn_event_header->notification_class |= GESN_MEDIA;
699 used_len = event_status_media(s, buf);
700 } else {
701 gesn_event_header->notification_class = 0x80; /* No event available */
702 used_len = sizeof(*gesn_event_header);
704 gesn_event_header->len = cpu_to_be16(used_len
705 - sizeof(*gesn_event_header));
706 ide_atapi_cmd_reply(s, used_len, max_len);
709 static void cmd_request_sense(IDEState *s, uint8_t *buf)
711 int max_len = buf[4];
713 memset(buf, 0, 18);
714 buf[0] = 0x70 | (1 << 7);
715 buf[2] = s->sense_key;
716 buf[7] = 10;
717 buf[12] = s->asc;
719 if (s->sense_key == UNIT_ATTENTION) {
720 s->sense_key = NO_SENSE;
723 ide_atapi_cmd_reply(s, 18, max_len);
726 static void cmd_inquiry(IDEState *s, uint8_t *buf)
728 uint8_t page_code = buf[2];
729 int max_len = buf[4];
731 unsigned idx = 0;
732 unsigned size_idx;
733 unsigned preamble_len;
735 /* If the EVPD (Enable Vital Product Data) bit is set in byte 1,
736 * we are being asked for a specific page of info indicated by byte 2. */
737 if (buf[1] & 0x01) {
738 preamble_len = 4;
739 size_idx = 3;
741 buf[idx++] = 0x05; /* CD-ROM */
742 buf[idx++] = page_code; /* Page Code */
743 buf[idx++] = 0x00; /* reserved */
744 idx++; /* length (set later) */
746 switch (page_code) {
747 case 0x00:
748 /* Supported Pages: List of supported VPD responses. */
749 buf[idx++] = 0x00; /* 0x00: Supported Pages, and: */
750 buf[idx++] = 0x83; /* 0x83: Device Identification. */
751 break;
753 case 0x83:
754 /* Device Identification. Each entry is optional, but the entries
755 * included here are modeled after libata's VPD responses.
756 * If the response is given, at least one entry must be present. */
758 /* Entry 1: Serial */
759 if (idx + 24 > max_len) {
760 /* Not enough room for even the first entry: */
761 /* 4 byte header + 20 byte string */
762 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
763 ASC_DATA_PHASE_ERROR);
764 return;
766 buf[idx++] = 0x02; /* Ascii */
767 buf[idx++] = 0x00; /* Vendor Specific */
768 buf[idx++] = 0x00;
769 buf[idx++] = 20; /* Remaining length */
770 padstr8(buf + idx, 20, s->drive_serial_str);
771 idx += 20;
773 /* Entry 2: Drive Model and Serial */
774 if (idx + 72 > max_len) {
775 /* 4 (header) + 8 (vendor) + 60 (model & serial) */
776 goto out;
778 buf[idx++] = 0x02; /* Ascii */
779 buf[idx++] = 0x01; /* T10 Vendor */
780 buf[idx++] = 0x00;
781 buf[idx++] = 68;
782 padstr8(buf + idx, 8, "ATA"); /* Generic T10 vendor */
783 idx += 8;
784 padstr8(buf + idx, 40, s->drive_model_str);
785 idx += 40;
786 padstr8(buf + idx, 20, s->drive_serial_str);
787 idx += 20;
789 /* Entry 3: WWN */
790 if (s->wwn && (idx + 12 <= max_len)) {
791 /* 4 byte header + 8 byte wwn */
792 buf[idx++] = 0x01; /* Binary */
793 buf[idx++] = 0x03; /* NAA */
794 buf[idx++] = 0x00;
795 buf[idx++] = 0x08;
796 stq_be_p(&buf[idx], s->wwn);
797 idx += 8;
799 break;
801 default:
802 /* SPC-3, revision 23 sec. 6.4 */
803 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
804 ASC_INV_FIELD_IN_CMD_PACKET);
805 return;
807 } else {
808 preamble_len = 5;
809 size_idx = 4;
811 buf[0] = 0x05; /* CD-ROM */
812 buf[1] = 0x80; /* removable */
813 buf[2] = 0x00; /* ISO */
814 buf[3] = 0x21; /* ATAPI-2 (XXX: put ATAPI-4 ?) */
815 /* buf[size_idx] set below. */
816 buf[5] = 0; /* reserved */
817 buf[6] = 0; /* reserved */
818 buf[7] = 0; /* reserved */
819 padstr8(buf + 8, 8, "QEMU");
820 padstr8(buf + 16, 16, "QEMU DVD-ROM");
821 padstr8(buf + 32, 4, s->version);
822 idx = 36;
825 out:
826 buf[size_idx] = idx - preamble_len;
827 ide_atapi_cmd_reply(s, idx, max_len);
830 static void cmd_get_configuration(IDEState *s, uint8_t *buf)
832 uint32_t len;
833 uint8_t index = 0;
834 int max_len;
836 /* only feature 0 is supported */
837 if (buf[2] != 0 || buf[3] != 0) {
838 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
839 ASC_INV_FIELD_IN_CMD_PACKET);
840 return;
843 /* XXX: could result in alignment problems in some architectures */
844 max_len = ube16_to_cpu(buf + 7);
847 * XXX: avoid overflow for io_buffer if max_len is bigger than
848 * the size of that buffer (dimensioned to max number of
849 * sectors to transfer at once)
851 * Only a problem if the feature/profiles grow.
853 if (max_len > 512) {
854 /* XXX: assume 1 sector */
855 max_len = 512;
858 memset(buf, 0, max_len);
860 * the number of sectors from the media tells us which profile
861 * to use as current. 0 means there is no media
863 if (media_is_dvd(s)) {
864 cpu_to_ube16(buf + 6, MMC_PROFILE_DVD_ROM);
865 } else if (media_is_cd(s)) {
866 cpu_to_ube16(buf + 6, MMC_PROFILE_CD_ROM);
869 buf[10] = 0x02 | 0x01; /* persistent and current */
870 len = 12; /* headers: 8 + 4 */
871 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_DVD_ROM);
872 len += ide_atapi_set_profile(buf, &index, MMC_PROFILE_CD_ROM);
873 cpu_to_ube32(buf, len - 4); /* data length */
875 ide_atapi_cmd_reply(s, len, max_len);
878 static void cmd_mode_sense(IDEState *s, uint8_t *buf)
880 int action, code;
881 int max_len;
883 max_len = ube16_to_cpu(buf + 7);
884 action = buf[2] >> 6;
885 code = buf[2] & 0x3f;
887 switch(action) {
888 case 0: /* current values */
889 switch(code) {
890 case MODE_PAGE_R_W_ERROR: /* error recovery */
891 cpu_to_ube16(&buf[0], 16 - 2);
892 buf[2] = 0x70;
893 buf[3] = 0;
894 buf[4] = 0;
895 buf[5] = 0;
896 buf[6] = 0;
897 buf[7] = 0;
899 buf[8] = MODE_PAGE_R_W_ERROR;
900 buf[9] = 16 - 10;
901 buf[10] = 0x00;
902 buf[11] = 0x05;
903 buf[12] = 0x00;
904 buf[13] = 0x00;
905 buf[14] = 0x00;
906 buf[15] = 0x00;
907 ide_atapi_cmd_reply(s, 16, max_len);
908 break;
909 case MODE_PAGE_AUDIO_CTL:
910 cpu_to_ube16(&buf[0], 24 - 2);
911 buf[2] = 0x70;
912 buf[3] = 0;
913 buf[4] = 0;
914 buf[5] = 0;
915 buf[6] = 0;
916 buf[7] = 0;
918 buf[8] = MODE_PAGE_AUDIO_CTL;
919 buf[9] = 24 - 10;
920 /* Fill with CDROM audio volume */
921 buf[17] = 0;
922 buf[19] = 0;
923 buf[21] = 0;
924 buf[23] = 0;
926 ide_atapi_cmd_reply(s, 24, max_len);
927 break;
928 case MODE_PAGE_CAPABILITIES:
929 cpu_to_ube16(&buf[0], 30 - 2);
930 buf[2] = 0x70;
931 buf[3] = 0;
932 buf[4] = 0;
933 buf[5] = 0;
934 buf[6] = 0;
935 buf[7] = 0;
937 buf[8] = MODE_PAGE_CAPABILITIES;
938 buf[9] = 30 - 10;
939 buf[10] = 0x3b; /* read CDR/CDRW/DVDROM/DVDR/DVDRAM */
940 buf[11] = 0x00;
942 /* Claim PLAY_AUDIO capability (0x01) since some Linux
943 code checks for this to automount media. */
944 buf[12] = 0x71;
945 buf[13] = 3 << 5;
946 buf[14] = (1 << 0) | (1 << 3) | (1 << 5);
947 if (s->tray_locked) {
948 buf[14] |= 1 << 1;
950 buf[15] = 0x00; /* No volume & mute control, no changer */
951 cpu_to_ube16(&buf[16], 704); /* 4x read speed */
952 buf[18] = 0; /* Two volume levels */
953 buf[19] = 2;
954 cpu_to_ube16(&buf[20], 512); /* 512k buffer */
955 cpu_to_ube16(&buf[22], 704); /* 4x read speed current */
956 buf[24] = 0;
957 buf[25] = 0;
958 buf[26] = 0;
959 buf[27] = 0;
960 buf[28] = 0;
961 buf[29] = 0;
962 ide_atapi_cmd_reply(s, 30, max_len);
963 break;
964 default:
965 goto error_cmd;
967 break;
968 case 1: /* changeable values */
969 goto error_cmd;
970 case 2: /* default values */
971 goto error_cmd;
972 default:
973 case 3: /* saved values */
974 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
975 ASC_SAVING_PARAMETERS_NOT_SUPPORTED);
976 break;
978 return;
980 error_cmd:
981 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_INV_FIELD_IN_CMD_PACKET);
984 static void cmd_test_unit_ready(IDEState *s, uint8_t *buf)
986 /* Not Ready Conditions are already handled in ide_atapi_cmd(), so if we
987 * come here, we know that it's ready. */
988 ide_atapi_cmd_ok(s);
991 static void cmd_prevent_allow_medium_removal(IDEState *s, uint8_t* buf)
993 s->tray_locked = buf[4] & 1;
994 blk_lock_medium(s->blk, buf[4] & 1);
995 ide_atapi_cmd_ok(s);
998 static void cmd_read(IDEState *s, uint8_t* buf)
1000 int nb_sectors, lba;
1002 if (buf[0] == GPCMD_READ_10) {
1003 nb_sectors = ube16_to_cpu(buf + 7);
1004 } else {
1005 nb_sectors = ube32_to_cpu(buf + 6);
1008 lba = ube32_to_cpu(buf + 2);
1009 if (nb_sectors == 0) {
1010 ide_atapi_cmd_ok(s);
1011 return;
1014 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1017 static void cmd_read_cd(IDEState *s, uint8_t* buf)
1019 int nb_sectors, lba, transfer_request;
1021 nb_sectors = (buf[6] << 16) | (buf[7] << 8) | buf[8];
1022 lba = ube32_to_cpu(buf + 2);
1024 if (nb_sectors == 0) {
1025 ide_atapi_cmd_ok(s);
1026 return;
1029 transfer_request = buf[9] & 0xf8;
1030 if (transfer_request == 0x00) {
1031 /* nothing */
1032 ide_atapi_cmd_ok(s);
1033 return;
1036 /* Check validity of BCL before transferring data */
1037 if (!validate_bcl(s)) {
1038 return;
1041 switch (transfer_request) {
1042 case 0x10:
1043 /* normal read */
1044 ide_atapi_cmd_read(s, lba, nb_sectors, 2048);
1045 break;
1046 case 0xf8:
1047 /* read all data */
1048 ide_atapi_cmd_read(s, lba, nb_sectors, 2352);
1049 break;
1050 default:
1051 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1052 ASC_INV_FIELD_IN_CMD_PACKET);
1053 break;
1057 static void cmd_seek(IDEState *s, uint8_t* buf)
1059 unsigned int lba;
1060 uint64_t total_sectors = s->nb_sectors >> 2;
1062 lba = ube32_to_cpu(buf + 2);
1063 if (lba >= total_sectors) {
1064 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_LOGICAL_BLOCK_OOR);
1065 return;
1068 ide_atapi_cmd_ok(s);
1071 static void cmd_start_stop_unit(IDEState *s, uint8_t* buf)
1073 int sense;
1074 bool start = buf[4] & 1;
1075 bool loej = buf[4] & 2; /* load on start, eject on !start */
1076 int pwrcnd = buf[4] & 0xf0;
1078 if (pwrcnd) {
1079 /* eject/load only happens for power condition == 0 */
1080 ide_atapi_cmd_ok(s);
1081 return;
1084 if (loej) {
1085 if (!start && !s->tray_open && s->tray_locked) {
1086 sense = blk_is_inserted(s->blk)
1087 ? NOT_READY : ILLEGAL_REQUEST;
1088 ide_atapi_cmd_error(s, sense, ASC_MEDIA_REMOVAL_PREVENTED);
1089 return;
1092 if (s->tray_open != !start) {
1093 blk_eject(s->blk, !start);
1094 s->tray_open = !start;
1098 ide_atapi_cmd_ok(s);
1101 static void cmd_mechanism_status(IDEState *s, uint8_t* buf)
1103 int max_len = ube16_to_cpu(buf + 8);
1105 cpu_to_ube16(buf, 0);
1106 /* no current LBA */
1107 buf[2] = 0;
1108 buf[3] = 0;
1109 buf[4] = 0;
1110 buf[5] = 1;
1111 cpu_to_ube16(buf + 6, 0);
1112 ide_atapi_cmd_reply(s, 8, max_len);
1115 static void cmd_read_toc_pma_atip(IDEState *s, uint8_t* buf)
1117 int format, msf, start_track, len;
1118 int max_len;
1119 uint64_t total_sectors = s->nb_sectors >> 2;
1121 max_len = ube16_to_cpu(buf + 7);
1122 format = buf[9] >> 6;
1123 msf = (buf[1] >> 1) & 1;
1124 start_track = buf[6];
1126 switch(format) {
1127 case 0:
1128 len = cdrom_read_toc(total_sectors, buf, msf, start_track);
1129 if (len < 0)
1130 goto error_cmd;
1131 ide_atapi_cmd_reply(s, len, max_len);
1132 break;
1133 case 1:
1134 /* multi session : only a single session defined */
1135 memset(buf, 0, 12);
1136 buf[1] = 0x0a;
1137 buf[2] = 0x01;
1138 buf[3] = 0x01;
1139 ide_atapi_cmd_reply(s, 12, max_len);
1140 break;
1141 case 2:
1142 len = cdrom_read_toc_raw(total_sectors, buf, msf, start_track);
1143 if (len < 0)
1144 goto error_cmd;
1145 ide_atapi_cmd_reply(s, len, max_len);
1146 break;
1147 default:
1148 error_cmd:
1149 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1150 ASC_INV_FIELD_IN_CMD_PACKET);
1154 static void cmd_read_cdvd_capacity(IDEState *s, uint8_t* buf)
1156 uint64_t total_sectors = s->nb_sectors >> 2;
1158 /* NOTE: it is really the number of sectors minus 1 */
1159 cpu_to_ube32(buf, total_sectors - 1);
1160 cpu_to_ube32(buf + 4, 2048);
1161 ide_atapi_cmd_reply(s, 8, 8);
1164 static void cmd_read_disc_information(IDEState *s, uint8_t* buf)
1166 uint8_t type = buf[1] & 7;
1167 uint32_t max_len = ube16_to_cpu(buf + 7);
1169 /* Types 1/2 are only defined for Blu-Ray. */
1170 if (type != 0) {
1171 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1172 ASC_INV_FIELD_IN_CMD_PACKET);
1173 return;
1176 memset(buf, 0, 34);
1177 buf[1] = 32;
1178 buf[2] = 0xe; /* last session complete, disc finalized */
1179 buf[3] = 1; /* first track on disc */
1180 buf[4] = 1; /* # of sessions */
1181 buf[5] = 1; /* first track of last session */
1182 buf[6] = 1; /* last track of last session */
1183 buf[7] = 0x20; /* unrestricted use */
1184 buf[8] = 0x00; /* CD-ROM or DVD-ROM */
1185 /* 9-10-11: most significant byte corresponding bytes 4-5-6 */
1186 /* 12-23: not meaningful for CD-ROM or DVD-ROM */
1187 /* 24-31: disc bar code */
1188 /* 32: disc application code */
1189 /* 33: number of OPC tables */
1191 ide_atapi_cmd_reply(s, 34, max_len);
1194 static void cmd_read_dvd_structure(IDEState *s, uint8_t* buf)
1196 int max_len;
1197 int media = buf[1];
1198 int format = buf[7];
1199 int ret;
1201 max_len = ube16_to_cpu(buf + 8);
1203 if (format < 0xff) {
1204 if (media_is_cd(s)) {
1205 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1206 ASC_INCOMPATIBLE_FORMAT);
1207 return;
1208 } else if (!media_present(s)) {
1209 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1210 ASC_INV_FIELD_IN_CMD_PACKET);
1211 return;
1215 memset(buf, 0, max_len > IDE_DMA_BUF_SECTORS * 512 + 4 ?
1216 IDE_DMA_BUF_SECTORS * 512 + 4 : max_len);
1218 switch (format) {
1219 case 0x00 ... 0x7f:
1220 case 0xff:
1221 if (media == 0) {
1222 ret = ide_dvd_read_structure(s, format, buf, buf);
1224 if (ret < 0) {
1225 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, -ret);
1226 } else {
1227 ide_atapi_cmd_reply(s, ret, max_len);
1230 break;
1232 /* TODO: BD support, fall through for now */
1234 /* Generic disk structures */
1235 case 0x80: /* TODO: AACS volume identifier */
1236 case 0x81: /* TODO: AACS media serial number */
1237 case 0x82: /* TODO: AACS media identifier */
1238 case 0x83: /* TODO: AACS media key block */
1239 case 0x90: /* TODO: List of recognized format layers */
1240 case 0xc0: /* TODO: Write protection status */
1241 default:
1242 ide_atapi_cmd_error(s, ILLEGAL_REQUEST,
1243 ASC_INV_FIELD_IN_CMD_PACKET);
1244 break;
1248 static void cmd_set_speed(IDEState *s, uint8_t* buf)
1250 ide_atapi_cmd_ok(s);
1253 enum {
1255 * Only commands flagged as ALLOW_UA are allowed to run under a
1256 * unit attention condition. (See MMC-5, section 4.1.6.1)
1258 ALLOW_UA = 0x01,
1261 * Commands flagged with CHECK_READY can only execute if a medium is present.
1262 * Otherwise they report the Not Ready Condition. (See MMC-5, section
1263 * 4.1.8)
1265 CHECK_READY = 0x02,
1268 * Commands flagged with NONDATA do not in any circumstances return
1269 * any data via ide_atapi_cmd_reply. These commands are exempt from
1270 * the normal byte_count_limit constraints.
1271 * See ATA8-ACS3 "7.21.5 Byte Count Limit"
1273 NONDATA = 0x04,
1276 * CONDDATA implies a command that transfers data only conditionally based
1277 * on the presence of suboptions. It should be exempt from the BCL check at
1278 * command validation time, but it needs to be checked at the command
1279 * handler level instead.
1281 CONDDATA = 0x08,
1284 static const struct AtapiCmd {
1285 void (*handler)(IDEState *s, uint8_t *buf);
1286 int flags;
1287 } atapi_cmd_table[0x100] = {
1288 [ 0x00 ] = { cmd_test_unit_ready, CHECK_READY | NONDATA },
1289 [ 0x03 ] = { cmd_request_sense, ALLOW_UA },
1290 [ 0x12 ] = { cmd_inquiry, ALLOW_UA },
1291 [ 0x1b ] = { cmd_start_stop_unit, NONDATA }, /* [1] */
1292 [ 0x1e ] = { cmd_prevent_allow_medium_removal, NONDATA },
1293 [ 0x25 ] = { cmd_read_cdvd_capacity, CHECK_READY },
1294 [ 0x28 ] = { cmd_read, /* (10) */ CHECK_READY },
1295 [ 0x2b ] = { cmd_seek, CHECK_READY | NONDATA },
1296 [ 0x43 ] = { cmd_read_toc_pma_atip, CHECK_READY },
1297 [ 0x46 ] = { cmd_get_configuration, ALLOW_UA },
1298 [ 0x4a ] = { cmd_get_event_status_notification, ALLOW_UA },
1299 [ 0x51 ] = { cmd_read_disc_information, CHECK_READY },
1300 [ 0x5a ] = { cmd_mode_sense, /* (10) */ 0 },
1301 [ 0xa8 ] = { cmd_read, /* (12) */ CHECK_READY },
1302 [ 0xad ] = { cmd_read_dvd_structure, CHECK_READY },
1303 [ 0xbb ] = { cmd_set_speed, NONDATA },
1304 [ 0xbd ] = { cmd_mechanism_status, 0 },
1305 [ 0xbe ] = { cmd_read_cd, CHECK_READY | CONDDATA },
1306 /* [1] handler detects and reports not ready condition itself */
1309 void ide_atapi_cmd(IDEState *s)
1311 uint8_t *buf = s->io_buffer;
1312 const struct AtapiCmd *cmd = &atapi_cmd_table[s->io_buffer[0]];
1314 trace_ide_atapi_cmd(s, s->io_buffer[0]);
1316 if (trace_event_get_state_backends(TRACE_IDE_ATAPI_CMD_PACKET)) {
1317 /* Each pretty-printed byte needs two bytes and a space; */
1318 char *ppacket = g_malloc(ATAPI_PACKET_SIZE * 3 + 1);
1319 int i;
1320 for (i = 0; i < ATAPI_PACKET_SIZE; i++) {
1321 sprintf(ppacket + (i * 3), "%02x ", buf[i]);
1323 trace_ide_atapi_cmd_packet(s, s->lcyl | (s->hcyl << 8), ppacket);
1324 g_free(ppacket);
1328 * If there's a UNIT_ATTENTION condition pending, only command flagged with
1329 * ALLOW_UA are allowed to complete. with other commands getting a CHECK
1330 * condition response unless a higher priority status, defined by the drive
1331 * here, is pending.
1333 if (s->sense_key == UNIT_ATTENTION && !(cmd->flags & ALLOW_UA)) {
1334 ide_atapi_cmd_check_status(s);
1335 return;
1338 * When a CD gets changed, we have to report an ejected state and
1339 * then a loaded state to guests so that they detect tray
1340 * open/close and media change events. Guests that do not use
1341 * GET_EVENT_STATUS_NOTIFICATION to detect such tray open/close
1342 * states rely on this behavior.
1344 if (!(cmd->flags & ALLOW_UA) &&
1345 !s->tray_open && blk_is_inserted(s->blk) && s->cdrom_changed) {
1347 if (s->cdrom_changed == 1) {
1348 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1349 s->cdrom_changed = 2;
1350 } else {
1351 ide_atapi_cmd_error(s, UNIT_ATTENTION, ASC_MEDIUM_MAY_HAVE_CHANGED);
1352 s->cdrom_changed = 0;
1355 return;
1358 /* Report a Not Ready condition if appropriate for the command */
1359 if ((cmd->flags & CHECK_READY) &&
1360 (!media_present(s) || !blk_is_inserted(s->blk)))
1362 ide_atapi_cmd_error(s, NOT_READY, ASC_MEDIUM_NOT_PRESENT);
1363 return;
1366 /* Commands that don't transfer DATA permit the byte_count_limit to be 0.
1367 * If this is a data-transferring PIO command and BCL is 0,
1368 * we abort at the /ATA/ level, not the ATAPI level.
1369 * See ATA8 ACS3 section 7.17.6.49 and 7.21.5 */
1370 if (cmd->handler && !(cmd->flags & (NONDATA | CONDDATA))) {
1371 if (!validate_bcl(s)) {
1372 return;
1376 /* Execute the command */
1377 if (cmd->handler) {
1378 cmd->handler(s, buf);
1379 return;
1382 ide_atapi_cmd_error(s, ILLEGAL_REQUEST, ASC_ILLEGAL_OPCODE);