xen: fix invalid assertion
[qemu/ar7.git] / hw / scsi / spapr_vscsi.c
blobf4f5140a4a350ede7547e9f5ea5a63bd45a7a0aa
1 /*
2 * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
4 * PAPR Virtual SCSI, aka ibmvscsi
6 * Copyright (c) 2010,2011 Benjamin Herrenschmidt, IBM Corporation.
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
26 * TODO:
28 * - Cleanups :-)
29 * - Sort out better how to assign devices to VSCSI instances
30 * - Fix residual counts
31 * - Add indirect descriptors support
32 * - Maybe do autosense (PAPR seems to mandate it, linux doesn't care)
34 #include "hw/hw.h"
35 #include "hw/scsi/scsi.h"
36 #include "block/scsi.h"
37 #include "srp.h"
38 #include "hw/qdev.h"
39 #include "hw/ppc/spapr.h"
40 #include "hw/ppc/spapr_vio.h"
41 #include "viosrp.h"
43 #include <libfdt.h>
45 /*#define DEBUG_VSCSI*/
47 #ifdef DEBUG_VSCSI
48 #define DPRINTF(fmt, ...) \
49 do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
50 #else
51 #define DPRINTF(fmt, ...) \
52 do { } while (0)
53 #endif
56 * Virtual SCSI device
59 /* Random numbers */
60 #define VSCSI_MAX_SECTORS 4096
61 #define VSCSI_REQ_LIMIT 24
63 #define SRP_RSP_SENSE_DATA_LEN 18
65 #define SRP_REPORT_LUNS_WLUN 0xc10100000000000ULL
67 typedef union vscsi_crq {
68 struct viosrp_crq s;
69 uint8_t raw[16];
70 } vscsi_crq;
72 typedef struct vscsi_req {
73 vscsi_crq crq;
74 union viosrp_iu iu;
76 /* SCSI request tracking */
77 SCSIRequest *sreq;
78 uint32_t qtag; /* qemu tag != srp tag */
79 bool active;
80 bool writing;
81 bool dma_error;
82 uint32_t data_len;
83 uint32_t senselen;
84 uint8_t sense[SCSI_SENSE_BUF_SIZE];
86 /* RDMA related bits */
87 uint8_t dma_fmt;
88 uint16_t local_desc;
89 uint16_t total_desc;
90 uint16_t cdb_offset;
91 uint16_t cur_desc_num;
92 uint16_t cur_desc_offset;
93 } vscsi_req;
95 #define TYPE_VIO_SPAPR_VSCSI_DEVICE "spapr-vscsi"
96 #define VIO_SPAPR_VSCSI_DEVICE(obj) \
97 OBJECT_CHECK(VSCSIState, (obj), TYPE_VIO_SPAPR_VSCSI_DEVICE)
99 typedef struct {
100 VIOsPAPRDevice vdev;
101 SCSIBus bus;
102 vscsi_req reqs[VSCSI_REQ_LIMIT];
103 } VSCSIState;
105 static struct vscsi_req *vscsi_get_req(VSCSIState *s)
107 vscsi_req *req;
108 int i;
110 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
111 req = &s->reqs[i];
112 if (!req->active) {
113 memset(req, 0, sizeof(*req));
114 req->qtag = i;
115 req->active = 1;
116 return req;
119 return NULL;
122 static struct vscsi_req *vscsi_find_req(VSCSIState *s, uint64_t srp_tag)
124 vscsi_req *req;
125 int i;
127 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
128 req = &s->reqs[i];
129 if (req->iu.srp.cmd.tag == srp_tag) {
130 return req;
133 return NULL;
136 static void vscsi_put_req(vscsi_req *req)
138 if (req->sreq != NULL) {
139 scsi_req_unref(req->sreq);
141 req->sreq = NULL;
142 req->active = 0;
145 static SCSIDevice *vscsi_device_find(SCSIBus *bus, uint64_t srp_lun, int *lun)
147 int channel = 0, id = 0;
149 retry:
150 switch (srp_lun >> 62) {
151 case 0:
152 if ((srp_lun >> 56) != 0) {
153 channel = (srp_lun >> 56) & 0x3f;
154 id = (srp_lun >> 48) & 0xff;
155 srp_lun <<= 16;
156 goto retry;
158 *lun = (srp_lun >> 48) & 0xff;
159 break;
161 case 1:
162 *lun = (srp_lun >> 48) & 0x3fff;
163 break;
164 case 2:
165 channel = (srp_lun >> 53) & 0x7;
166 id = (srp_lun >> 56) & 0x3f;
167 *lun = (srp_lun >> 48) & 0x1f;
168 break;
169 case 3:
170 *lun = -1;
171 return NULL;
172 default:
173 abort();
176 return scsi_device_find(bus, channel, id, *lun);
179 static int vscsi_send_iu(VSCSIState *s, vscsi_req *req,
180 uint64_t length, uint8_t format)
182 long rc, rc1;
184 /* First copy the SRP */
185 rc = spapr_vio_dma_write(&s->vdev, req->crq.s.IU_data_ptr,
186 &req->iu, length);
187 if (rc) {
188 fprintf(stderr, "vscsi_send_iu: DMA write failure !\n");
191 req->crq.s.valid = 0x80;
192 req->crq.s.format = format;
193 req->crq.s.reserved = 0x00;
194 req->crq.s.timeout = cpu_to_be16(0x0000);
195 req->crq.s.IU_length = cpu_to_be16(length);
196 req->crq.s.IU_data_ptr = req->iu.srp.rsp.tag; /* right byte order */
198 if (rc == 0) {
199 req->crq.s.status = VIOSRP_OK;
200 } else {
201 req->crq.s.status = VIOSRP_ADAPTER_FAIL;
204 rc1 = spapr_vio_send_crq(&s->vdev, req->crq.raw);
205 if (rc1) {
206 fprintf(stderr, "vscsi_send_iu: Error sending response\n");
207 return rc1;
210 return rc;
213 static void vscsi_makeup_sense(VSCSIState *s, vscsi_req *req,
214 uint8_t key, uint8_t asc, uint8_t ascq)
216 req->senselen = SRP_RSP_SENSE_DATA_LEN;
218 /* Valid bit and 'current errors' */
219 req->sense[0] = (0x1 << 7 | 0x70);
220 /* Sense key */
221 req->sense[2] = key;
222 /* Additional sense length */
223 req->sense[7] = 0xa; /* 10 bytes */
224 /* Additional sense code */
225 req->sense[12] = asc;
226 req->sense[13] = ascq;
229 static int vscsi_send_rsp(VSCSIState *s, vscsi_req *req,
230 uint8_t status, int32_t res_in, int32_t res_out)
232 union viosrp_iu *iu = &req->iu;
233 uint64_t tag = iu->srp.rsp.tag;
234 int total_len = sizeof(iu->srp.rsp);
235 uint8_t sol_not = iu->srp.cmd.sol_not;
237 DPRINTF("VSCSI: Sending resp status: 0x%x, "
238 "res_in: %d, res_out: %d\n", status, res_in, res_out);
240 memset(iu, 0, sizeof(struct srp_rsp));
241 iu->srp.rsp.opcode = SRP_RSP;
242 iu->srp.rsp.req_lim_delta = cpu_to_be32(1);
243 iu->srp.rsp.tag = tag;
245 /* Handle residuals */
246 if (res_in < 0) {
247 iu->srp.rsp.flags |= SRP_RSP_FLAG_DIUNDER;
248 res_in = -res_in;
249 } else if (res_in) {
250 iu->srp.rsp.flags |= SRP_RSP_FLAG_DIOVER;
252 if (res_out < 0) {
253 iu->srp.rsp.flags |= SRP_RSP_FLAG_DOUNDER;
254 res_out = -res_out;
255 } else if (res_out) {
256 iu->srp.rsp.flags |= SRP_RSP_FLAG_DOOVER;
258 iu->srp.rsp.data_in_res_cnt = cpu_to_be32(res_in);
259 iu->srp.rsp.data_out_res_cnt = cpu_to_be32(res_out);
261 /* We don't do response data */
262 /* iu->srp.rsp.flags &= ~SRP_RSP_FLAG_RSPVALID; */
263 iu->srp.rsp.resp_data_len = cpu_to_be32(0);
265 /* Handle success vs. failure */
266 iu->srp.rsp.status = status;
267 if (status) {
268 iu->srp.rsp.sol_not = (sol_not & 0x04) >> 2;
269 if (req->senselen) {
270 req->iu.srp.rsp.flags |= SRP_RSP_FLAG_SNSVALID;
271 req->iu.srp.rsp.sense_data_len = cpu_to_be32(req->senselen);
272 memcpy(req->iu.srp.rsp.data, req->sense, req->senselen);
273 total_len += req->senselen;
275 } else {
276 iu->srp.rsp.sol_not = (sol_not & 0x02) >> 1;
279 vscsi_send_iu(s, req, total_len, VIOSRP_SRP_FORMAT);
280 return 0;
283 static inline struct srp_direct_buf vscsi_swap_desc(struct srp_direct_buf desc)
285 desc.va = be64_to_cpu(desc.va);
286 desc.len = be32_to_cpu(desc.len);
287 return desc;
290 static int vscsi_fetch_desc(VSCSIState *s, struct vscsi_req *req,
291 unsigned n, unsigned buf_offset,
292 struct srp_direct_buf *ret)
294 struct srp_cmd *cmd = &req->iu.srp.cmd;
296 switch (req->dma_fmt) {
297 case SRP_NO_DATA_DESC: {
298 DPRINTF("VSCSI: no data descriptor\n");
299 return 0;
301 case SRP_DATA_DESC_DIRECT: {
302 memcpy(ret, cmd->add_data + req->cdb_offset, sizeof(*ret));
303 assert(req->cur_desc_num == 0);
304 DPRINTF("VSCSI: direct segment\n");
305 break;
307 case SRP_DATA_DESC_INDIRECT: {
308 struct srp_indirect_buf *tmp = (struct srp_indirect_buf *)
309 (cmd->add_data + req->cdb_offset);
310 if (n < req->local_desc) {
311 *ret = tmp->desc_list[n];
312 DPRINTF("VSCSI: indirect segment local tag=0x%x desc#%d/%d\n",
313 req->qtag, n, req->local_desc);
315 } else if (n < req->total_desc) {
316 int rc;
317 struct srp_direct_buf tbl_desc = vscsi_swap_desc(tmp->table_desc);
318 unsigned desc_offset = n * sizeof(struct srp_direct_buf);
320 if (desc_offset >= tbl_desc.len) {
321 DPRINTF("VSCSI: #%d is ouf of range (%d bytes)\n",
322 n, desc_offset);
323 return -1;
325 rc = spapr_vio_dma_read(&s->vdev, tbl_desc.va + desc_offset,
326 ret, sizeof(struct srp_direct_buf));
327 if (rc) {
328 DPRINTF("VSCSI: spapr_vio_dma_read -> %d reading ext_desc\n",
329 rc);
330 return -1;
332 DPRINTF("VSCSI: indirect segment ext. tag=0x%x desc#%d/%d { va=%"PRIx64" len=%x }\n",
333 req->qtag, n, req->total_desc, tbl_desc.va, tbl_desc.len);
334 } else {
335 DPRINTF("VSCSI: Out of descriptors !\n");
336 return 0;
338 break;
340 default:
341 fprintf(stderr, "VSCSI: Unknown format %x\n", req->dma_fmt);
342 return -1;
345 *ret = vscsi_swap_desc(*ret);
346 if (buf_offset > ret->len) {
347 DPRINTF(" offset=%x is out of a descriptor #%d boundary=%x\n",
348 buf_offset, req->cur_desc_num, ret->len);
349 return -1;
351 ret->va += buf_offset;
352 ret->len -= buf_offset;
354 DPRINTF(" cur=%d offs=%x ret { va=%"PRIx64" len=%x }\n",
355 req->cur_desc_num, req->cur_desc_offset, ret->va, ret->len);
357 return ret->len ? 1 : 0;
360 static int vscsi_srp_direct_data(VSCSIState *s, vscsi_req *req,
361 uint8_t *buf, uint32_t len)
363 struct srp_direct_buf md;
364 uint32_t llen;
365 int rc = 0;
367 rc = vscsi_fetch_desc(s, req, req->cur_desc_num, req->cur_desc_offset, &md);
368 if (rc < 0) {
369 return -1;
370 } else if (rc == 0) {
371 return 0;
374 llen = MIN(len, md.len);
375 if (llen) {
376 if (req->writing) { /* writing = to device = reading from memory */
377 rc = spapr_vio_dma_read(&s->vdev, md.va, buf, llen);
378 } else {
379 rc = spapr_vio_dma_write(&s->vdev, md.va, buf, llen);
383 if (rc) {
384 return -1;
386 req->cur_desc_offset += llen;
388 return llen;
391 static int vscsi_srp_indirect_data(VSCSIState *s, vscsi_req *req,
392 uint8_t *buf, uint32_t len)
394 struct srp_direct_buf md;
395 int rc = 0;
396 uint32_t llen, total = 0;
398 DPRINTF("VSCSI: indirect segment 0x%x bytes\n", len);
400 /* While we have data ... */
401 while (len) {
402 rc = vscsi_fetch_desc(s, req, req->cur_desc_num, req->cur_desc_offset, &md);
403 if (rc < 0) {
404 return -1;
405 } else if (rc == 0) {
406 break;
409 /* Perform transfer */
410 llen = MIN(len, md.len);
411 if (req->writing) { /* writing = to device = reading from memory */
412 rc = spapr_vio_dma_read(&s->vdev, md.va, buf, llen);
413 } else {
414 rc = spapr_vio_dma_write(&s->vdev, md.va, buf, llen);
416 if (rc) {
417 DPRINTF("VSCSI: spapr_vio_dma_r/w(%d) -> %d\n", req->writing, rc);
418 break;
420 DPRINTF("VSCSI: data: %02x %02x %02x %02x...\n",
421 buf[0], buf[1], buf[2], buf[3]);
423 len -= llen;
424 buf += llen;
426 total += llen;
428 /* Update current position in the current descriptor */
429 req->cur_desc_offset += llen;
430 if (md.len == llen) {
431 /* Go to the next descriptor if the current one finished */
432 ++req->cur_desc_num;
433 req->cur_desc_offset = 0;
437 return rc ? -1 : total;
440 static int vscsi_srp_transfer_data(VSCSIState *s, vscsi_req *req,
441 int writing, uint8_t *buf, uint32_t len)
443 int err = 0;
445 switch (req->dma_fmt) {
446 case SRP_NO_DATA_DESC:
447 DPRINTF("VSCSI: no data desc transfer, skipping 0x%x bytes\n", len);
448 break;
449 case SRP_DATA_DESC_DIRECT:
450 err = vscsi_srp_direct_data(s, req, buf, len);
451 break;
452 case SRP_DATA_DESC_INDIRECT:
453 err = vscsi_srp_indirect_data(s, req, buf, len);
454 break;
456 return err;
459 /* Bits from linux srp */
460 static int data_out_desc_size(struct srp_cmd *cmd)
462 int size = 0;
463 uint8_t fmt = cmd->buf_fmt >> 4;
465 switch (fmt) {
466 case SRP_NO_DATA_DESC:
467 break;
468 case SRP_DATA_DESC_DIRECT:
469 size = sizeof(struct srp_direct_buf);
470 break;
471 case SRP_DATA_DESC_INDIRECT:
472 size = sizeof(struct srp_indirect_buf) +
473 sizeof(struct srp_direct_buf)*cmd->data_out_desc_cnt;
474 break;
475 default:
476 break;
478 return size;
481 static int vscsi_preprocess_desc(vscsi_req *req)
483 struct srp_cmd *cmd = &req->iu.srp.cmd;
485 req->cdb_offset = cmd->add_cdb_len & ~3;
487 if (req->writing) {
488 req->dma_fmt = cmd->buf_fmt >> 4;
489 } else {
490 req->cdb_offset += data_out_desc_size(cmd);
491 req->dma_fmt = cmd->buf_fmt & ((1U << 4) - 1);
494 switch (req->dma_fmt) {
495 case SRP_NO_DATA_DESC:
496 break;
497 case SRP_DATA_DESC_DIRECT:
498 req->total_desc = req->local_desc = 1;
499 break;
500 case SRP_DATA_DESC_INDIRECT: {
501 struct srp_indirect_buf *ind_tmp = (struct srp_indirect_buf *)
502 (cmd->add_data + req->cdb_offset);
504 req->total_desc = be32_to_cpu(ind_tmp->table_desc.len) /
505 sizeof(struct srp_direct_buf);
506 req->local_desc = req->writing ? cmd->data_out_desc_cnt :
507 cmd->data_in_desc_cnt;
508 break;
510 default:
511 fprintf(stderr,
512 "vscsi_preprocess_desc: Unknown format %x\n", req->dma_fmt);
513 return -1;
516 return 0;
519 /* Callback to indicate that the SCSI layer has completed a transfer. */
520 static void vscsi_transfer_data(SCSIRequest *sreq, uint32_t len)
522 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(sreq->bus->qbus.parent);
523 vscsi_req *req = sreq->hba_private;
524 uint8_t *buf;
525 int rc = 0;
527 DPRINTF("VSCSI: SCSI xfer complete tag=0x%x len=0x%x, req=%p\n",
528 sreq->tag, len, req);
529 if (req == NULL) {
530 fprintf(stderr, "VSCSI: Can't find request for tag 0x%x\n", sreq->tag);
531 return;
534 if (len) {
535 buf = scsi_req_get_buf(sreq);
536 rc = vscsi_srp_transfer_data(s, req, req->writing, buf, len);
538 if (rc < 0) {
539 fprintf(stderr, "VSCSI: RDMA error rc=%d!\n", rc);
540 req->dma_error = true;
541 scsi_req_cancel(req->sreq);
542 return;
545 /* Start next chunk */
546 req->data_len -= rc;
547 scsi_req_continue(sreq);
550 /* Callback to indicate that the SCSI layer has completed a transfer. */
551 static void vscsi_command_complete(SCSIRequest *sreq, uint32_t status, size_t resid)
553 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(sreq->bus->qbus.parent);
554 vscsi_req *req = sreq->hba_private;
555 int32_t res_in = 0, res_out = 0;
557 DPRINTF("VSCSI: SCSI cmd complete, tag=0x%x status=0x%x, req=%p\n",
558 sreq->tag, status, req);
559 if (req == NULL) {
560 fprintf(stderr, "VSCSI: Can't find request for tag 0x%x\n", sreq->tag);
561 return;
564 if (status == CHECK_CONDITION) {
565 req->senselen = scsi_req_get_sense(req->sreq, req->sense,
566 sizeof(req->sense));
567 DPRINTF("VSCSI: Sense data, %d bytes:\n", req->senselen);
568 DPRINTF(" %02x %02x %02x %02x %02x %02x %02x %02x\n",
569 req->sense[0], req->sense[1], req->sense[2], req->sense[3],
570 req->sense[4], req->sense[5], req->sense[6], req->sense[7]);
571 DPRINTF(" %02x %02x %02x %02x %02x %02x %02x %02x\n",
572 req->sense[8], req->sense[9], req->sense[10], req->sense[11],
573 req->sense[12], req->sense[13], req->sense[14], req->sense[15]);
576 DPRINTF("VSCSI: Command complete err=%d\n", status);
577 if (status == 0) {
578 /* We handle overflows, not underflows for normal commands,
579 * but hopefully nobody cares
581 if (req->writing) {
582 res_out = req->data_len;
583 } else {
584 res_in = req->data_len;
587 vscsi_send_rsp(s, req, status, res_in, res_out);
588 vscsi_put_req(req);
591 static void vscsi_request_cancelled(SCSIRequest *sreq)
593 vscsi_req *req = sreq->hba_private;
595 if (req->dma_error) {
596 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(sreq->bus->qbus.parent);
598 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
599 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
601 vscsi_put_req(req);
604 static const VMStateDescription vmstate_spapr_vscsi_req = {
605 .name = "spapr_vscsi_req",
606 .version_id = 1,
607 .minimum_version_id = 1,
608 .fields = (VMStateField[]) {
609 VMSTATE_BUFFER(crq.raw, vscsi_req),
610 VMSTATE_BUFFER(iu.srp.reserved, vscsi_req),
611 VMSTATE_UINT32(qtag, vscsi_req),
612 VMSTATE_BOOL(active, vscsi_req),
613 VMSTATE_UINT32(data_len, vscsi_req),
614 VMSTATE_BOOL(writing, vscsi_req),
615 VMSTATE_UINT32(senselen, vscsi_req),
616 VMSTATE_BUFFER(sense, vscsi_req),
617 VMSTATE_UINT8(dma_fmt, vscsi_req),
618 VMSTATE_UINT16(local_desc, vscsi_req),
619 VMSTATE_UINT16(total_desc, vscsi_req),
620 VMSTATE_UINT16(cdb_offset, vscsi_req),
621 /*Restart SCSI request from the beginning for now */
622 /*VMSTATE_UINT16(cur_desc_num, vscsi_req),
623 VMSTATE_UINT16(cur_desc_offset, vscsi_req),*/
624 VMSTATE_END_OF_LIST()
628 static void vscsi_save_request(QEMUFile *f, SCSIRequest *sreq)
630 vscsi_req *req = sreq->hba_private;
631 assert(req->active);
633 vmstate_save_state(f, &vmstate_spapr_vscsi_req, req, NULL);
635 DPRINTF("VSCSI: saving tag=%u, current desc#%d, offset=%x\n",
636 req->qtag, req->cur_desc_num, req->cur_desc_offset);
639 static void *vscsi_load_request(QEMUFile *f, SCSIRequest *sreq)
641 SCSIBus *bus = sreq->bus;
642 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(bus->qbus.parent);
643 vscsi_req *req;
644 int rc;
646 assert(sreq->tag < VSCSI_REQ_LIMIT);
647 req = &s->reqs[sreq->tag];
648 assert(!req->active);
650 memset(req, 0, sizeof(*req));
651 rc = vmstate_load_state(f, &vmstate_spapr_vscsi_req, req, 1);
652 if (rc) {
653 fprintf(stderr, "VSCSI: failed loading request tag#%u\n", sreq->tag);
654 return NULL;
656 assert(req->active);
658 req->sreq = scsi_req_ref(sreq);
660 DPRINTF("VSCSI: restoring tag=%u, current desc#%d, offset=%x\n",
661 req->qtag, req->cur_desc_num, req->cur_desc_offset);
663 return req;
666 static void vscsi_process_login(VSCSIState *s, vscsi_req *req)
668 union viosrp_iu *iu = &req->iu;
669 struct srp_login_rsp *rsp = &iu->srp.login_rsp;
670 uint64_t tag = iu->srp.rsp.tag;
672 DPRINTF("VSCSI: Got login, sendin response !\n");
674 /* TODO handle case that requested size is wrong and
675 * buffer format is wrong
677 memset(iu, 0, sizeof(struct srp_login_rsp));
678 rsp->opcode = SRP_LOGIN_RSP;
679 /* Don't advertise quite as many request as we support to
680 * keep room for management stuff etc...
682 rsp->req_lim_delta = cpu_to_be32(VSCSI_REQ_LIMIT-2);
683 rsp->tag = tag;
684 rsp->max_it_iu_len = cpu_to_be32(sizeof(union srp_iu));
685 rsp->max_ti_iu_len = cpu_to_be32(sizeof(union srp_iu));
686 /* direct and indirect */
687 rsp->buf_fmt = cpu_to_be16(SRP_BUF_FORMAT_DIRECT | SRP_BUF_FORMAT_INDIRECT);
689 vscsi_send_iu(s, req, sizeof(*rsp), VIOSRP_SRP_FORMAT);
692 static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
694 uint8_t *cdb = req->iu.srp.cmd.cdb;
695 uint8_t resp_data[36];
696 int rc, len, alen;
698 /* We dont do EVPD. Also check that page_code is 0 */
699 if ((cdb[1] & 0x01) || cdb[2] != 0) {
700 /* Send INVALID FIELD IN CDB */
701 vscsi_makeup_sense(s, req, ILLEGAL_REQUEST, 0x24, 0);
702 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
703 return;
705 alen = cdb[3];
706 alen = (alen << 8) | cdb[4];
707 len = MIN(alen, 36);
709 /* Fake up inquiry using PQ=3 */
710 memset(resp_data, 0, 36);
711 resp_data[0] = 0x7f; /* Not capable of supporting a device here */
712 resp_data[2] = 0x06; /* SPS-4 */
713 resp_data[3] = 0x02; /* Resp data format */
714 resp_data[4] = 36 - 5; /* Additional length */
715 resp_data[7] = 0x10; /* Sync transfers */
716 memcpy(&resp_data[16], "QEMU EMPTY ", 16);
717 memcpy(&resp_data[8], "QEMU ", 8);
719 req->writing = 0;
720 vscsi_preprocess_desc(req);
721 rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
722 if (rc < 0) {
723 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
724 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
725 } else {
726 vscsi_send_rsp(s, req, 0, 36 - rc, 0);
730 static void vscsi_report_luns(VSCSIState *s, vscsi_req *req)
732 BusChild *kid;
733 int i, len, n, rc;
734 uint8_t *resp_data;
735 bool found_lun0;
737 n = 0;
738 found_lun0 = false;
739 QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
740 SCSIDevice *dev = SCSI_DEVICE(kid->child);
742 n += 8;
743 if (dev->channel == 0 && dev->id == 0 && dev->lun == 0) {
744 found_lun0 = true;
747 if (!found_lun0) {
748 n += 8;
750 len = n+8;
752 resp_data = g_malloc0(len);
753 stl_be_p(resp_data, n);
754 i = found_lun0 ? 8 : 16;
755 QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
756 DeviceState *qdev = kid->child;
757 SCSIDevice *dev = SCSI_DEVICE(qdev);
759 if (dev->id == 0 && dev->channel == 0) {
760 resp_data[i] = 0; /* Use simple LUN for 0 (SAM5 4.7.7.1) */
761 } else {
762 resp_data[i] = (2 << 6); /* Otherwise LUN addressing (4.7.7.4) */
764 resp_data[i] |= dev->id;
765 resp_data[i+1] = (dev->channel << 5);
766 resp_data[i+1] |= dev->lun;
767 i += 8;
770 vscsi_preprocess_desc(req);
771 rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
772 g_free(resp_data);
773 if (rc < 0) {
774 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
775 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
776 } else {
777 vscsi_send_rsp(s, req, 0, len - rc, 0);
781 static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
783 union srp_iu *srp = &req->iu.srp;
784 SCSIDevice *sdev;
785 int n, lun;
787 if ((srp->cmd.lun == 0 || be64_to_cpu(srp->cmd.lun) == SRP_REPORT_LUNS_WLUN)
788 && srp->cmd.cdb[0] == REPORT_LUNS) {
789 vscsi_report_luns(s, req);
790 return 0;
793 sdev = vscsi_device_find(&s->bus, be64_to_cpu(srp->cmd.lun), &lun);
794 if (!sdev) {
795 DPRINTF("VSCSI: Command for lun %08" PRIx64 " with no drive\n",
796 be64_to_cpu(srp->cmd.lun));
797 if (srp->cmd.cdb[0] == INQUIRY) {
798 vscsi_inquiry_no_target(s, req);
799 } else {
800 vscsi_makeup_sense(s, req, ILLEGAL_REQUEST, 0x24, 0x00);
801 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
802 } return 1;
805 req->sreq = scsi_req_new(sdev, req->qtag, lun, srp->cmd.cdb, req);
806 n = scsi_req_enqueue(req->sreq);
808 DPRINTF("VSCSI: Queued command tag 0x%x CMD 0x%x=%s LUN %d ret: %d\n",
809 req->qtag, srp->cmd.cdb[0], scsi_command_name(srp->cmd.cdb[0]),
810 lun, n);
812 if (n) {
813 /* Transfer direction must be set before preprocessing the
814 * descriptors
816 req->writing = (n < 1);
818 /* Preprocess RDMA descriptors */
819 vscsi_preprocess_desc(req);
821 /* Get transfer direction and initiate transfer */
822 if (n > 0) {
823 req->data_len = n;
824 } else if (n < 0) {
825 req->data_len = -n;
827 scsi_req_continue(req->sreq);
829 /* Don't touch req here, it may have been recycled already */
831 return 0;
834 static int vscsi_process_tsk_mgmt(VSCSIState *s, vscsi_req *req)
836 union viosrp_iu *iu = &req->iu;
837 vscsi_req *tmpreq;
838 int i, lun = 0, resp = SRP_TSK_MGMT_COMPLETE;
839 SCSIDevice *d;
840 uint64_t tag = iu->srp.rsp.tag;
841 uint8_t sol_not = iu->srp.cmd.sol_not;
843 fprintf(stderr, "vscsi_process_tsk_mgmt %02x\n",
844 iu->srp.tsk_mgmt.tsk_mgmt_func);
846 d = vscsi_device_find(&s->bus, be64_to_cpu(req->iu.srp.tsk_mgmt.lun), &lun);
847 if (!d) {
848 resp = SRP_TSK_MGMT_FIELDS_INVALID;
849 } else {
850 switch (iu->srp.tsk_mgmt.tsk_mgmt_func) {
851 case SRP_TSK_ABORT_TASK:
852 if (d->lun != lun) {
853 resp = SRP_TSK_MGMT_FIELDS_INVALID;
854 break;
857 tmpreq = vscsi_find_req(s, req->iu.srp.tsk_mgmt.task_tag);
858 if (tmpreq && tmpreq->sreq) {
859 assert(tmpreq->sreq->hba_private);
860 scsi_req_cancel(tmpreq->sreq);
862 break;
864 case SRP_TSK_LUN_RESET:
865 if (d->lun != lun) {
866 resp = SRP_TSK_MGMT_FIELDS_INVALID;
867 break;
870 qdev_reset_all(&d->qdev);
871 break;
873 case SRP_TSK_ABORT_TASK_SET:
874 case SRP_TSK_CLEAR_TASK_SET:
875 if (d->lun != lun) {
876 resp = SRP_TSK_MGMT_FIELDS_INVALID;
877 break;
880 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
881 tmpreq = &s->reqs[i];
882 if (tmpreq->iu.srp.cmd.lun != req->iu.srp.tsk_mgmt.lun) {
883 continue;
885 if (!tmpreq->active || !tmpreq->sreq) {
886 continue;
888 assert(tmpreq->sreq->hba_private);
889 scsi_req_cancel(tmpreq->sreq);
891 break;
893 case SRP_TSK_CLEAR_ACA:
894 resp = SRP_TSK_MGMT_NOT_SUPPORTED;
895 break;
897 default:
898 resp = SRP_TSK_MGMT_FIELDS_INVALID;
899 break;
903 /* Compose the response here as */
904 memset(iu, 0, sizeof(struct srp_rsp) + 4);
905 iu->srp.rsp.opcode = SRP_RSP;
906 iu->srp.rsp.req_lim_delta = cpu_to_be32(1);
907 iu->srp.rsp.tag = tag;
908 iu->srp.rsp.flags |= SRP_RSP_FLAG_RSPVALID;
909 iu->srp.rsp.resp_data_len = cpu_to_be32(4);
910 if (resp) {
911 iu->srp.rsp.sol_not = (sol_not & 0x04) >> 2;
912 } else {
913 iu->srp.rsp.sol_not = (sol_not & 0x02) >> 1;
916 iu->srp.rsp.status = GOOD;
917 iu->srp.rsp.data[3] = resp;
919 vscsi_send_iu(s, req, sizeof(iu->srp.rsp) + 4, VIOSRP_SRP_FORMAT);
921 return 1;
924 static int vscsi_handle_srp_req(VSCSIState *s, vscsi_req *req)
926 union srp_iu *srp = &req->iu.srp;
927 int done = 1;
928 uint8_t opcode = srp->rsp.opcode;
930 switch (opcode) {
931 case SRP_LOGIN_REQ:
932 vscsi_process_login(s, req);
933 break;
934 case SRP_TSK_MGMT:
935 done = vscsi_process_tsk_mgmt(s, req);
936 break;
937 case SRP_CMD:
938 done = vscsi_queue_cmd(s, req);
939 break;
940 case SRP_LOGIN_RSP:
941 case SRP_I_LOGOUT:
942 case SRP_T_LOGOUT:
943 case SRP_RSP:
944 case SRP_CRED_REQ:
945 case SRP_CRED_RSP:
946 case SRP_AER_REQ:
947 case SRP_AER_RSP:
948 fprintf(stderr, "VSCSI: Unsupported opcode %02x\n", opcode);
949 break;
950 default:
951 fprintf(stderr, "VSCSI: Unknown type %02x\n", opcode);
954 return done;
957 static int vscsi_send_adapter_info(VSCSIState *s, vscsi_req *req)
959 struct viosrp_adapter_info *sinfo;
960 struct mad_adapter_info_data info;
961 int rc;
963 sinfo = &req->iu.mad.adapter_info;
965 #if 0 /* What for ? */
966 rc = spapr_vio_dma_read(&s->vdev, be64_to_cpu(sinfo->buffer),
967 &info, be16_to_cpu(sinfo->common.length));
968 if (rc) {
969 fprintf(stderr, "vscsi_send_adapter_info: DMA read failure !\n");
971 #endif
972 memset(&info, 0, sizeof(info));
973 strcpy(info.srp_version, SRP_VERSION);
974 memcpy(info.partition_name, "qemu", sizeof("qemu"));
975 info.partition_number = cpu_to_be32(0);
976 info.mad_version = cpu_to_be32(1);
977 info.os_type = cpu_to_be32(2);
978 info.port_max_txu[0] = cpu_to_be32(VSCSI_MAX_SECTORS << 9);
980 rc = spapr_vio_dma_write(&s->vdev, be64_to_cpu(sinfo->buffer),
981 &info, be16_to_cpu(sinfo->common.length));
982 if (rc) {
983 fprintf(stderr, "vscsi_send_adapter_info: DMA write failure !\n");
986 sinfo->common.status = rc ? cpu_to_be32(1) : 0;
988 return vscsi_send_iu(s, req, sizeof(*sinfo), VIOSRP_MAD_FORMAT);
991 static int vscsi_send_capabilities(VSCSIState *s, vscsi_req *req)
993 struct viosrp_capabilities *vcap;
994 struct capabilities cap = { };
995 uint16_t len, req_len;
996 uint64_t buffer;
997 int rc;
999 vcap = &req->iu.mad.capabilities;
1000 req_len = len = be16_to_cpu(vcap->common.length);
1001 buffer = be64_to_cpu(vcap->buffer);
1002 if (len > sizeof(cap)) {
1003 fprintf(stderr, "vscsi_send_capabilities: capabilities size mismatch !\n");
1006 * Just read and populate the structure that is known.
1007 * Zero rest of the structure.
1009 len = sizeof(cap);
1011 rc = spapr_vio_dma_read(&s->vdev, buffer, &cap, len);
1012 if (rc) {
1013 fprintf(stderr, "vscsi_send_capabilities: DMA read failure !\n");
1017 * Current implementation does not suppport any migration or
1018 * reservation capabilities. Construct the response telling the
1019 * guest not to use them.
1021 cap.flags = 0;
1022 cap.migration.ecl = 0;
1023 cap.reserve.type = 0;
1024 cap.migration.common.server_support = 0;
1025 cap.reserve.common.server_support = 0;
1027 rc = spapr_vio_dma_write(&s->vdev, buffer, &cap, len);
1028 if (rc) {
1029 fprintf(stderr, "vscsi_send_capabilities: DMA write failure !\n");
1031 if (req_len > len) {
1033 * Being paranoid and lets not worry about the error code
1034 * here. Actual write of the cap is done above.
1036 spapr_vio_dma_set(&s->vdev, (buffer + len), 0, (req_len - len));
1038 vcap->common.status = rc ? cpu_to_be32(1) : 0;
1039 return vscsi_send_iu(s, req, sizeof(*vcap), VIOSRP_MAD_FORMAT);
1042 static int vscsi_handle_mad_req(VSCSIState *s, vscsi_req *req)
1044 union mad_iu *mad = &req->iu.mad;
1045 bool request_handled = false;
1046 uint64_t retlen = 0;
1048 switch (be32_to_cpu(mad->empty_iu.common.type)) {
1049 case VIOSRP_EMPTY_IU_TYPE:
1050 fprintf(stderr, "Unsupported EMPTY MAD IU\n");
1051 retlen = sizeof(mad->empty_iu);
1052 break;
1053 case VIOSRP_ERROR_LOG_TYPE:
1054 fprintf(stderr, "Unsupported ERROR LOG MAD IU\n");
1055 retlen = sizeof(mad->error_log);
1056 break;
1057 case VIOSRP_ADAPTER_INFO_TYPE:
1058 vscsi_send_adapter_info(s, req);
1059 request_handled = true;
1060 break;
1061 case VIOSRP_HOST_CONFIG_TYPE:
1062 retlen = sizeof(mad->host_config);
1063 break;
1064 case VIOSRP_CAPABILITIES_TYPE:
1065 vscsi_send_capabilities(s, req);
1066 request_handled = true;
1067 break;
1068 default:
1069 fprintf(stderr, "VSCSI: Unknown MAD type %02x\n",
1070 be32_to_cpu(mad->empty_iu.common.type));
1072 * PAPR+ says that "The length field is set to the length
1073 * of the data structure(s) used in the command".
1074 * As we did not recognize the request type, put zero there.
1076 retlen = 0;
1079 if (!request_handled) {
1080 mad->empty_iu.common.status = cpu_to_be16(VIOSRP_MAD_NOT_SUPPORTED);
1081 vscsi_send_iu(s, req, retlen, VIOSRP_MAD_FORMAT);
1084 return 1;
1087 static void vscsi_got_payload(VSCSIState *s, vscsi_crq *crq)
1089 vscsi_req *req;
1090 int done;
1092 req = vscsi_get_req(s);
1093 if (req == NULL) {
1094 fprintf(stderr, "VSCSI: Failed to get a request !\n");
1095 return;
1098 /* We only support a limited number of descriptors, we know
1099 * the ibmvscsi driver uses up to 10 max, so it should fit
1100 * in our 256 bytes IUs. If not we'll have to increase the size
1101 * of the structure.
1103 if (crq->s.IU_length > sizeof(union viosrp_iu)) {
1104 fprintf(stderr, "VSCSI: SRP IU too long (%d bytes) !\n",
1105 crq->s.IU_length);
1106 vscsi_put_req(req);
1107 return;
1110 /* XXX Handle failure differently ? */
1111 if (spapr_vio_dma_read(&s->vdev, crq->s.IU_data_ptr, &req->iu,
1112 crq->s.IU_length)) {
1113 fprintf(stderr, "vscsi_got_payload: DMA read failure !\n");
1114 vscsi_put_req(req);
1115 return;
1117 memcpy(&req->crq, crq, sizeof(vscsi_crq));
1119 if (crq->s.format == VIOSRP_MAD_FORMAT) {
1120 done = vscsi_handle_mad_req(s, req);
1121 } else {
1122 done = vscsi_handle_srp_req(s, req);
1125 if (done) {
1126 vscsi_put_req(req);
1131 static int vscsi_do_crq(struct VIOsPAPRDevice *dev, uint8_t *crq_data)
1133 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(dev);
1134 vscsi_crq crq;
1136 memcpy(crq.raw, crq_data, 16);
1137 crq.s.timeout = be16_to_cpu(crq.s.timeout);
1138 crq.s.IU_length = be16_to_cpu(crq.s.IU_length);
1139 crq.s.IU_data_ptr = be64_to_cpu(crq.s.IU_data_ptr);
1141 DPRINTF("VSCSI: do_crq %02x %02x ...\n", crq.raw[0], crq.raw[1]);
1143 switch (crq.s.valid) {
1144 case 0xc0: /* Init command/response */
1146 /* Respond to initialization request */
1147 if (crq.s.format == 0x01) {
1148 memset(crq.raw, 0, 16);
1149 crq.s.valid = 0xc0;
1150 crq.s.format = 0x02;
1151 spapr_vio_send_crq(dev, crq.raw);
1154 /* Note that in hotplug cases, we might get a 0x02
1155 * as a result of us emitting the init request
1158 break;
1159 case 0xff: /* Link event */
1161 /* Not handled for now */
1163 break;
1164 case 0x80: /* Payloads */
1165 switch (crq.s.format) {
1166 case VIOSRP_SRP_FORMAT: /* AKA VSCSI request */
1167 case VIOSRP_MAD_FORMAT: /* AKA VSCSI response */
1168 vscsi_got_payload(s, &crq);
1169 break;
1170 case VIOSRP_OS400_FORMAT:
1171 case VIOSRP_AIX_FORMAT:
1172 case VIOSRP_LINUX_FORMAT:
1173 case VIOSRP_INLINE_FORMAT:
1174 fprintf(stderr, "vscsi_do_srq: Unsupported payload format %02x\n",
1175 crq.s.format);
1176 break;
1177 default:
1178 fprintf(stderr, "vscsi_do_srq: Unknown payload format %02x\n",
1179 crq.s.format);
1181 break;
1182 default:
1183 fprintf(stderr, "vscsi_do_crq: unknown CRQ %02x %02x ...\n",
1184 crq.raw[0], crq.raw[1]);
1187 return 0;
1190 static const struct SCSIBusInfo vscsi_scsi_info = {
1191 .tcq = true,
1192 .max_channel = 7, /* logical unit addressing format */
1193 .max_target = 63,
1194 .max_lun = 31,
1196 .transfer_data = vscsi_transfer_data,
1197 .complete = vscsi_command_complete,
1198 .cancel = vscsi_request_cancelled,
1199 .save_request = vscsi_save_request,
1200 .load_request = vscsi_load_request,
1203 static void spapr_vscsi_reset(VIOsPAPRDevice *dev)
1205 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(dev);
1206 int i;
1208 memset(s->reqs, 0, sizeof(s->reqs));
1209 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
1210 s->reqs[i].qtag = i;
1214 static void spapr_vscsi_realize(VIOsPAPRDevice *dev, Error **errp)
1216 VSCSIState *s = VIO_SPAPR_VSCSI_DEVICE(dev);
1218 dev->crq.SendFunc = vscsi_do_crq;
1220 scsi_bus_new(&s->bus, sizeof(s->bus), DEVICE(dev),
1221 &vscsi_scsi_info, NULL);
1222 if (!dev->qdev.hotplugged) {
1223 scsi_bus_legacy_handle_cmdline(&s->bus, errp);
1227 void spapr_vscsi_create(VIOsPAPRBus *bus)
1229 DeviceState *dev;
1231 dev = qdev_create(&bus->bus, "spapr-vscsi");
1233 qdev_init_nofail(dev);
1236 static int spapr_vscsi_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
1238 int ret;
1240 ret = fdt_setprop_cell(fdt, node_off, "#address-cells", 2);
1241 if (ret < 0) {
1242 return ret;
1245 ret = fdt_setprop_cell(fdt, node_off, "#size-cells", 0);
1246 if (ret < 0) {
1247 return ret;
1250 return 0;
1253 static Property spapr_vscsi_properties[] = {
1254 DEFINE_SPAPR_PROPERTIES(VSCSIState, vdev),
1255 DEFINE_PROP_END_OF_LIST(),
1258 static const VMStateDescription vmstate_spapr_vscsi = {
1259 .name = "spapr_vscsi",
1260 .version_id = 1,
1261 .minimum_version_id = 1,
1262 .fields = (VMStateField[]) {
1263 VMSTATE_SPAPR_VIO(vdev, VSCSIState),
1264 /* VSCSI state */
1265 /* ???? */
1267 VMSTATE_END_OF_LIST()
1271 static void spapr_vscsi_class_init(ObjectClass *klass, void *data)
1273 DeviceClass *dc = DEVICE_CLASS(klass);
1274 VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
1276 k->realize = spapr_vscsi_realize;
1277 k->reset = spapr_vscsi_reset;
1278 k->devnode = spapr_vscsi_devnode;
1279 k->dt_name = "v-scsi";
1280 k->dt_type = "vscsi";
1281 k->dt_compatible = "IBM,v-scsi";
1282 k->signal_mask = 0x00000001;
1283 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
1284 dc->props = spapr_vscsi_properties;
1285 k->rtce_window_size = 0x10000000;
1286 dc->vmsd = &vmstate_spapr_vscsi;
1289 static const TypeInfo spapr_vscsi_info = {
1290 .name = TYPE_VIO_SPAPR_VSCSI_DEVICE,
1291 .parent = TYPE_VIO_SPAPR_DEVICE,
1292 .instance_size = sizeof(VSCSIState),
1293 .class_init = spapr_vscsi_class_init,
1296 static void spapr_vscsi_register_types(void)
1298 type_register_static(&spapr_vscsi_info);
1301 type_init(spapr_vscsi_register_types)