scsi: Use 'SCSIRequest' directly
[qemu/ar7.git] / hw / spapr_vscsi.c
blob36dd7445afdfb2bec0a373217a2459f425708596
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.h"
35 #include "scsi.h"
36 #include "scsi-defs.h"
37 #include "net.h" /* Remove that when we can */
38 #include "srp.h"
39 #include "hw/qdev.h"
40 #include "hw/spapr.h"
41 #include "hw/spapr_vio.h"
42 #include "hw/ppc-viosrp.h"
44 #include <libfdt.h>
46 /*#define DEBUG_VSCSI*/
48 #ifdef DEBUG_VSCSI
49 #define dprintf(fmt, ...) \
50 do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
51 #else
52 #define dprintf(fmt, ...) \
53 do { } while (0)
54 #endif
57 * Virtual SCSI device
60 /* Random numbers */
61 #define VSCSI_MAX_SECTORS 4096
62 #define VSCSI_REQ_LIMIT 24
64 #define SCSI_SENSE_BUF_SIZE 96
65 #define SRP_RSP_SENSE_DATA_LEN 18
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 SCSIDevice *sdev;
78 SCSIRequest *sreq;
79 uint32_t qtag; /* qemu tag != srp tag */
80 int lun;
81 int active;
82 long data_len;
83 int writing;
84 int sensing;
85 int senselen;
86 uint8_t sense[SCSI_SENSE_BUF_SIZE];
88 /* RDMA related bits */
89 uint8_t dma_fmt;
90 struct srp_direct_buf ext_desc;
91 struct srp_direct_buf *cur_desc;
92 struct srp_indirect_buf *ind_desc;
93 int local_desc;
94 int total_desc;
95 } vscsi_req;
98 typedef struct {
99 VIOsPAPRDevice vdev;
100 SCSIBus bus;
101 vscsi_req reqs[VSCSI_REQ_LIMIT];
102 } VSCSIState;
104 /* XXX Debug only */
105 static VSCSIState *dbg_vscsi_state;
108 static struct vscsi_req *vscsi_get_req(VSCSIState *s)
110 vscsi_req *req;
111 int i;
113 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
114 req = &s->reqs[i];
115 if (!req->active) {
116 memset(req, 0, sizeof(*req));
117 req->qtag = i;
118 req->active = 1;
119 return req;
122 return NULL;
125 static void vscsi_put_req(VSCSIState *s, vscsi_req *req)
127 if (req->sreq != NULL) {
128 scsi_req_unref(req->sreq);
130 req->sreq = NULL;
131 req->active = 0;
134 static vscsi_req *vscsi_find_req(VSCSIState *s, SCSIRequest *req)
136 uint32_t tag = req->tag;
137 if (tag >= VSCSI_REQ_LIMIT || !s->reqs[tag].active) {
138 return NULL;
140 return &s->reqs[tag];
143 static void vscsi_decode_id_lun(uint64_t srp_lun, int *id, int *lun)
145 /* XXX Figure that one out properly ! This is crackpot */
146 *id = (srp_lun >> 56) & 0x7f;
147 *lun = (srp_lun >> 48) & 0xff;
150 static int vscsi_send_iu(VSCSIState *s, vscsi_req *req,
151 uint64_t length, uint8_t format)
153 long rc, rc1;
155 /* First copy the SRP */
156 rc = spapr_tce_dma_write(&s->vdev, req->crq.s.IU_data_ptr,
157 &req->iu, length);
158 if (rc) {
159 fprintf(stderr, "vscsi_send_iu: DMA write failure !\n");
162 req->crq.s.valid = 0x80;
163 req->crq.s.format = format;
164 req->crq.s.reserved = 0x00;
165 req->crq.s.timeout = cpu_to_be16(0x0000);
166 req->crq.s.IU_length = cpu_to_be16(length);
167 req->crq.s.IU_data_ptr = req->iu.srp.rsp.tag; /* right byte order */
169 if (rc == 0) {
170 req->crq.s.status = 0x99; /* Just needs to be non-zero */
171 } else {
172 req->crq.s.status = 0x00;
175 rc1 = spapr_vio_send_crq(&s->vdev, req->crq.raw);
176 if (rc1) {
177 fprintf(stderr, "vscsi_send_iu: Error sending response\n");
178 return rc1;
181 return rc;
184 static void vscsi_makeup_sense(VSCSIState *s, vscsi_req *req,
185 uint8_t key, uint8_t asc, uint8_t ascq)
187 req->senselen = SRP_RSP_SENSE_DATA_LEN;
189 /* Valid bit and 'current errors' */
190 req->sense[0] = (0x1 << 7 | 0x70);
191 /* Sense key */
192 req->sense[2] = key;
193 /* Additional sense length */
194 req->sense[7] = 0xa; /* 10 bytes */
195 /* Additional sense code */
196 req->sense[12] = asc;
197 req->sense[13] = ascq;
200 static int vscsi_send_rsp(VSCSIState *s, vscsi_req *req,
201 uint8_t status, int32_t res_in, int32_t res_out)
203 union viosrp_iu *iu = &req->iu;
204 uint64_t tag = iu->srp.rsp.tag;
205 int total_len = sizeof(iu->srp.rsp);
207 dprintf("VSCSI: Sending resp status: 0x%x, "
208 "res_in: %d, res_out: %d\n", status, res_in, res_out);
210 memset(iu, 0, sizeof(struct srp_rsp));
211 iu->srp.rsp.opcode = SRP_RSP;
212 iu->srp.rsp.req_lim_delta = cpu_to_be32(1);
213 iu->srp.rsp.tag = tag;
215 /* Handle residuals */
216 if (res_in < 0) {
217 iu->srp.rsp.flags |= SRP_RSP_FLAG_DIUNDER;
218 res_in = -res_in;
219 } else if (res_in) {
220 iu->srp.rsp.flags |= SRP_RSP_FLAG_DIOVER;
222 if (res_out < 0) {
223 iu->srp.rsp.flags |= SRP_RSP_FLAG_DOUNDER;
224 res_out = -res_out;
225 } else if (res_out) {
226 iu->srp.rsp.flags |= SRP_RSP_FLAG_DOOVER;
228 iu->srp.rsp.data_in_res_cnt = cpu_to_be32(res_in);
229 iu->srp.rsp.data_out_res_cnt = cpu_to_be32(res_out);
231 /* We don't do response data */
232 /* iu->srp.rsp.flags &= ~SRP_RSP_FLAG_RSPVALID; */
233 iu->srp.rsp.resp_data_len = cpu_to_be32(0);
235 /* Handle success vs. failure */
236 iu->srp.rsp.status = status;
237 if (status) {
238 iu->srp.rsp.sol_not = (iu->srp.cmd.sol_not & 0x04) >> 2;
239 if (req->senselen) {
240 req->iu.srp.rsp.flags |= SRP_RSP_FLAG_SNSVALID;
241 req->iu.srp.rsp.sense_data_len = cpu_to_be32(req->senselen);
242 memcpy(req->iu.srp.rsp.data, req->sense, req->senselen);
243 total_len += req->senselen;
245 } else {
246 iu->srp.rsp.sol_not = (iu->srp.cmd.sol_not & 0x02) >> 1;
249 vscsi_send_iu(s, req, total_len, VIOSRP_SRP_FORMAT);
250 return 0;
253 static inline void vscsi_swap_desc(struct srp_direct_buf *desc)
255 desc->va = be64_to_cpu(desc->va);
256 desc->len = be32_to_cpu(desc->len);
259 static int vscsi_srp_direct_data(VSCSIState *s, vscsi_req *req,
260 uint8_t *buf, uint32_t len)
262 struct srp_direct_buf *md = req->cur_desc;
263 uint32_t llen;
264 int rc = 0;
266 dprintf("VSCSI: direct segment 0x%x bytes, va=0x%llx desc len=0x%x\n",
267 len, (unsigned long long)md->va, md->len);
269 llen = MIN(len, md->len);
270 if (llen) {
271 if (req->writing) { /* writing = to device = reading from memory */
272 rc = spapr_tce_dma_read(&s->vdev, md->va, buf, llen);
273 } else {
274 rc = spapr_tce_dma_write(&s->vdev, md->va, buf, llen);
277 md->len -= llen;
278 md->va += llen;
280 if (rc) {
281 return -1;
283 return llen;
286 static int vscsi_srp_indirect_data(VSCSIState *s, vscsi_req *req,
287 uint8_t *buf, uint32_t len)
289 struct srp_direct_buf *td = &req->ind_desc->table_desc;
290 struct srp_direct_buf *md = req->cur_desc;
291 int rc = 0;
292 uint32_t llen, total = 0;
294 dprintf("VSCSI: indirect segment 0x%x bytes, td va=0x%llx len=0x%x\n",
295 len, (unsigned long long)td->va, td->len);
297 /* While we have data ... */
298 while (len) {
299 /* If we have a descriptor but it's empty, go fetch a new one */
300 if (md && md->len == 0) {
301 /* More local available, use one */
302 if (req->local_desc) {
303 md = ++req->cur_desc;
304 --req->local_desc;
305 --req->total_desc;
306 td->va += sizeof(struct srp_direct_buf);
307 } else {
308 md = req->cur_desc = NULL;
311 /* No descriptor at hand, fetch one */
312 if (!md) {
313 if (!req->total_desc) {
314 dprintf("VSCSI: Out of descriptors !\n");
315 break;
317 md = req->cur_desc = &req->ext_desc;
318 dprintf("VSCSI: Reading desc from 0x%llx\n",
319 (unsigned long long)td->va);
320 rc = spapr_tce_dma_read(&s->vdev, td->va, md,
321 sizeof(struct srp_direct_buf));
322 if (rc) {
323 dprintf("VSCSI: tce_dma_read -> %d reading ext_desc\n", rc);
324 break;
326 vscsi_swap_desc(md);
327 td->va += sizeof(struct srp_direct_buf);
328 --req->total_desc;
330 dprintf("VSCSI: [desc va=0x%llx,len=0x%x] remaining=0x%x\n",
331 (unsigned long long)md->va, md->len, len);
333 /* Perform transfer */
334 llen = MIN(len, md->len);
335 if (req->writing) { /* writing = to device = reading from memory */
336 rc = spapr_tce_dma_read(&s->vdev, md->va, buf, llen);
337 } else {
338 rc = spapr_tce_dma_write(&s->vdev, md->va, buf, llen);
340 if (rc) {
341 dprintf("VSCSI: tce_dma_r/w(%d) -> %d\n", req->writing, rc);
342 break;
344 dprintf("VSCSI: data: %02x %02x %02x %02x...\n",
345 buf[0], buf[1], buf[2], buf[3]);
347 len -= llen;
348 buf += llen;
349 total += llen;
350 md->va += llen;
351 md->len -= llen;
353 return rc ? -1 : total;
356 static int vscsi_srp_transfer_data(VSCSIState *s, vscsi_req *req,
357 int writing, uint8_t *buf, uint32_t len)
359 int err = 0;
361 switch (req->dma_fmt) {
362 case SRP_NO_DATA_DESC:
363 dprintf("VSCSI: no data desc transfer, skipping 0x%x bytes\n", len);
364 break;
365 case SRP_DATA_DESC_DIRECT:
366 err = vscsi_srp_direct_data(s, req, buf, len);
367 break;
368 case SRP_DATA_DESC_INDIRECT:
369 err = vscsi_srp_indirect_data(s, req, buf, len);
370 break;
372 return err;
375 /* Bits from linux srp */
376 static int data_out_desc_size(struct srp_cmd *cmd)
378 int size = 0;
379 uint8_t fmt = cmd->buf_fmt >> 4;
381 switch (fmt) {
382 case SRP_NO_DATA_DESC:
383 break;
384 case SRP_DATA_DESC_DIRECT:
385 size = sizeof(struct srp_direct_buf);
386 break;
387 case SRP_DATA_DESC_INDIRECT:
388 size = sizeof(struct srp_indirect_buf) +
389 sizeof(struct srp_direct_buf)*cmd->data_out_desc_cnt;
390 break;
391 default:
392 break;
394 return size;
397 static int vscsi_preprocess_desc(vscsi_req *req)
399 struct srp_cmd *cmd = &req->iu.srp.cmd;
400 int offset, i;
402 offset = cmd->add_cdb_len & ~3;
404 if (req->writing) {
405 req->dma_fmt = cmd->buf_fmt >> 4;
406 } else {
407 offset += data_out_desc_size(cmd);
408 req->dma_fmt = cmd->buf_fmt & ((1U << 4) - 1);
411 switch (req->dma_fmt) {
412 case SRP_NO_DATA_DESC:
413 break;
414 case SRP_DATA_DESC_DIRECT:
415 req->cur_desc = (struct srp_direct_buf *)(cmd->add_data + offset);
416 req->total_desc = req->local_desc = 1;
417 vscsi_swap_desc(req->cur_desc);
418 dprintf("VSCSI: using direct RDMA %s, 0x%x bytes MD: 0x%llx\n",
419 req->writing ? "write" : "read",
420 req->cur_desc->len, (unsigned long long)req->cur_desc->va);
421 break;
422 case SRP_DATA_DESC_INDIRECT:
423 req->ind_desc = (struct srp_indirect_buf *)(cmd->add_data + offset);
424 vscsi_swap_desc(&req->ind_desc->table_desc);
425 req->total_desc = req->ind_desc->table_desc.len /
426 sizeof(struct srp_direct_buf);
427 req->local_desc = req->writing ? cmd->data_out_desc_cnt :
428 cmd->data_in_desc_cnt;
429 for (i = 0; i < req->local_desc; i++) {
430 vscsi_swap_desc(&req->ind_desc->desc_list[i]);
432 req->cur_desc = req->local_desc ? &req->ind_desc->desc_list[0] : NULL;
433 dprintf("VSCSI: using indirect RDMA %s, 0x%x bytes %d descs "
434 "(%d local) VA: 0x%llx\n",
435 req->writing ? "read" : "write",
436 be32_to_cpu(req->ind_desc->len),
437 req->total_desc, req->local_desc,
438 (unsigned long long)req->ind_desc->table_desc.va);
439 break;
440 default:
441 fprintf(stderr,
442 "vscsi_preprocess_desc: Unknown format %x\n", req->dma_fmt);
443 return -1;
446 return 0;
449 static void vscsi_send_request_sense(VSCSIState *s, vscsi_req *req)
451 SCSIDevice *sdev = req->sdev;
452 uint8_t *cdb = req->iu.srp.cmd.cdb;
453 int n;
455 cdb[0] = 3;
456 cdb[1] = 0;
457 cdb[2] = 0;
458 cdb[3] = 0;
459 cdb[4] = 96;
460 cdb[5] = 0;
461 req->sensing = 1;
462 n = sdev->info->send_command(req->sreq, cdb);
463 dprintf("VSCSI: Queued request sense tag 0x%x\n", req->qtag);
464 if (n < 0) {
465 fprintf(stderr, "VSCSI: REQUEST_SENSE wants write data !?!?!?\n");
466 sdev->info->cancel_io(req->sreq);
467 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
468 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
469 vscsi_put_req(s, req);
470 return;
471 } else if (n == 0) {
472 return;
474 sdev->info->read_data(req->sreq);
477 /* Callback to indicate that the SCSI layer has completed a transfer. */
478 static void vscsi_command_complete(SCSIRequest *sreq, int reason, uint32_t arg)
480 VSCSIState *s = DO_UPCAST(VSCSIState, vdev.qdev, sreq->bus->qbus.parent);
481 vscsi_req *req = vscsi_find_req(s, sreq);
482 SCSIDevice *sdev;
483 uint8_t *buf;
484 int32_t res_in = 0, res_out = 0;
485 int len, rc = 0;
487 dprintf("VSCSI: SCSI cmd complete, r=0x%x tag=0x%x arg=0x%x, req=%p\n",
488 reason, sreq->tag, arg, req);
489 if (req == NULL) {
490 fprintf(stderr, "VSCSI: Can't find request for tag 0x%x\n", sreq->tag);
491 return;
493 sdev = req->sdev;
495 if (req->sensing) {
496 if (reason == SCSI_REASON_DONE) {
497 dprintf("VSCSI: Sense done !\n");
498 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
499 vscsi_put_req(s, req);
500 } else {
501 uint8_t *buf = sdev->info->get_buf(sreq);
503 len = MIN(arg, SCSI_SENSE_BUF_SIZE);
504 dprintf("VSCSI: Sense data, %d bytes:\n", len);
505 dprintf(" %02x %02x %02x %02x %02x %02x %02x %02x\n",
506 buf[0], buf[1], buf[2], buf[3],
507 buf[4], buf[5], buf[6], buf[7]);
508 dprintf(" %02x %02x %02x %02x %02x %02x %02x %02x\n",
509 buf[8], buf[9], buf[10], buf[11],
510 buf[12], buf[13], buf[14], buf[15]);
511 memcpy(req->sense, buf, len);
512 req->senselen = len;
513 sdev->info->read_data(sreq);
515 return;
518 if (reason == SCSI_REASON_DONE) {
519 dprintf("VSCSI: Command complete err=%d\n", arg);
520 if (arg == 0) {
521 /* We handle overflows, not underflows for normal commands,
522 * but hopefully nobody cares
524 if (req->writing) {
525 res_out = req->data_len;
526 } else {
527 res_in = req->data_len;
529 vscsi_send_rsp(s, req, 0, res_in, res_out);
530 } else if (arg == CHECK_CONDITION) {
531 dprintf("VSCSI: Got CHECK_CONDITION, requesting sense...\n");
532 vscsi_send_request_sense(s, req);
533 return;
534 } else {
535 vscsi_send_rsp(s, req, arg, 0, 0);
537 vscsi_put_req(s, req);
538 return;
541 /* "arg" is how much we have read for reads and how much we want
542 * to write for writes (ie, how much is to be DMA'd)
544 if (arg) {
545 buf = sdev->info->get_buf(sreq);
546 rc = vscsi_srp_transfer_data(s, req, req->writing, buf, arg);
548 if (rc < 0) {
549 fprintf(stderr, "VSCSI: RDMA error rc=%d!\n", rc);
550 sdev->info->cancel_io(sreq);
551 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
552 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
553 vscsi_put_req(s, req);
554 return;
557 /* Start next chunk */
558 req->data_len -= rc;
559 if (req->writing) {
560 sdev->info->write_data(sreq);
561 } else {
562 sdev->info->read_data(sreq);
566 static void vscsi_process_login(VSCSIState *s, vscsi_req *req)
568 union viosrp_iu *iu = &req->iu;
569 struct srp_login_rsp *rsp = &iu->srp.login_rsp;
570 uint64_t tag = iu->srp.rsp.tag;
572 dprintf("VSCSI: Got login, sendin response !\n");
574 /* TODO handle case that requested size is wrong and
575 * buffer format is wrong
577 memset(iu, 0, sizeof(struct srp_login_rsp));
578 rsp->opcode = SRP_LOGIN_RSP;
579 /* Don't advertise quite as many request as we support to
580 * keep room for management stuff etc...
582 rsp->req_lim_delta = cpu_to_be32(VSCSI_REQ_LIMIT-2);
583 rsp->tag = tag;
584 rsp->max_it_iu_len = cpu_to_be32(sizeof(union srp_iu));
585 rsp->max_ti_iu_len = cpu_to_be32(sizeof(union srp_iu));
586 /* direct and indirect */
587 rsp->buf_fmt = cpu_to_be16(SRP_BUF_FORMAT_DIRECT | SRP_BUF_FORMAT_INDIRECT);
589 vscsi_send_iu(s, req, sizeof(*rsp), VIOSRP_SRP_FORMAT);
592 static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
594 uint8_t *cdb = req->iu.srp.cmd.cdb;
595 uint8_t resp_data[36];
596 int rc, len, alen;
598 /* We dont do EVPD. Also check that page_code is 0 */
599 if ((cdb[1] & 0x01) || (cdb[1] & 0x01) || cdb[2] != 0) {
600 /* Send INVALID FIELD IN CDB */
601 vscsi_makeup_sense(s, req, ILLEGAL_REQUEST, 0x24, 0);
602 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
603 return;
605 alen = cdb[3];
606 alen = (alen << 8) | cdb[4];
607 len = MIN(alen, 36);
609 /* Fake up inquiry using PQ=3 */
610 memset(resp_data, 0, 36);
611 resp_data[0] = 0x7f; /* Not capable of supporting a device here */
612 resp_data[2] = 0x06; /* SPS-4 */
613 resp_data[3] = 0x02; /* Resp data format */
614 resp_data[4] = 36 - 5; /* Additional length */
615 resp_data[7] = 0x10; /* Sync transfers */
616 memcpy(&resp_data[16], "QEMU EMPTY ", 16);
617 memcpy(&resp_data[8], "QEMU ", 8);
619 req->writing = 0;
620 vscsi_preprocess_desc(req);
621 rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
622 if (rc < 0) {
623 vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
624 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
625 } else {
626 vscsi_send_rsp(s, req, 0, 36 - rc, 0);
630 static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
632 union srp_iu *srp = &req->iu.srp;
633 SCSIDevice *sdev;
634 int n, id, lun;
636 vscsi_decode_id_lun(be64_to_cpu(srp->cmd.lun), &id, &lun);
638 /* Qemu vs. linux issue with LUNs to be sorted out ... */
639 sdev = (id < 8 && lun < 16) ? s->bus.devs[id] : NULL;
640 if (!sdev) {
641 dprintf("VSCSI: Command for id %d with no drive\n", id);
642 if (srp->cmd.cdb[0] == INQUIRY) {
643 vscsi_inquiry_no_target(s, req);
644 } else {
645 vscsi_makeup_sense(s, req, ILLEGAL_REQUEST, 0x24, 0x00);
646 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
647 } return 1;
650 req->sdev = sdev;
651 req->lun = lun;
652 req->sreq = sdev->info->alloc_req(sdev, req->qtag, lun);
653 n = sdev->info->send_command(req->sreq, srp->cmd.cdb);
655 dprintf("VSCSI: Queued command tag 0x%x CMD 0x%x ID %d LUN %d ret: %d\n",
656 req->qtag, srp->cmd.cdb[0], id, lun, n);
658 if (n) {
659 /* Transfer direction must be set before preprocessing the
660 * descriptors
662 req->writing = (n < 1);
664 /* Preprocess RDMA descriptors */
665 vscsi_preprocess_desc(req);
668 /* Get transfer direction and initiate transfer */
669 if (n > 0) {
670 req->data_len = n;
671 sdev->info->read_data(req->sreq);
672 } else if (n < 0) {
673 req->data_len = -n;
674 sdev->info->write_data(req->sreq);
676 /* Don't touch req here, it may have been recycled already */
678 return 0;
681 static int vscsi_process_tsk_mgmt(VSCSIState *s, vscsi_req *req)
683 union viosrp_iu *iu = &req->iu;
684 int fn;
686 fprintf(stderr, "vscsi_process_tsk_mgmt %02x\n",
687 iu->srp.tsk_mgmt.tsk_mgmt_func);
689 switch (iu->srp.tsk_mgmt.tsk_mgmt_func) {
690 #if 0 /* We really don't deal with these for now */
691 case SRP_TSK_ABORT_TASK:
692 fn = ABORT_TASK;
693 break;
694 case SRP_TSK_ABORT_TASK_SET:
695 fn = ABORT_TASK_SET;
696 break;
697 case SRP_TSK_CLEAR_TASK_SET:
698 fn = CLEAR_TASK_SET;
699 break;
700 case SRP_TSK_LUN_RESET:
701 fn = LOGICAL_UNIT_RESET;
702 break;
703 case SRP_TSK_CLEAR_ACA:
704 fn = CLEAR_ACA;
705 break;
706 #endif
707 default:
708 fn = 0;
710 if (fn) {
711 /* XXX Send/Handle target task management */
713 } else {
714 vscsi_makeup_sense(s, req, ILLEGAL_REQUEST, 0x20, 0);
715 vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
717 return !fn;
720 static int vscsi_handle_srp_req(VSCSIState *s, vscsi_req *req)
722 union srp_iu *srp = &req->iu.srp;
723 int done = 1;
724 uint8_t opcode = srp->rsp.opcode;
726 switch (opcode) {
727 case SRP_LOGIN_REQ:
728 vscsi_process_login(s, req);
729 break;
730 case SRP_TSK_MGMT:
731 done = vscsi_process_tsk_mgmt(s, req);
732 break;
733 case SRP_CMD:
734 done = vscsi_queue_cmd(s, req);
735 break;
736 case SRP_LOGIN_RSP:
737 case SRP_I_LOGOUT:
738 case SRP_T_LOGOUT:
739 case SRP_RSP:
740 case SRP_CRED_REQ:
741 case SRP_CRED_RSP:
742 case SRP_AER_REQ:
743 case SRP_AER_RSP:
744 fprintf(stderr, "VSCSI: Unsupported opcode %02x\n", opcode);
745 break;
746 default:
747 fprintf(stderr, "VSCSI: Unknown type %02x\n", opcode);
750 return done;
753 static int vscsi_send_adapter_info(VSCSIState *s, vscsi_req *req)
755 struct viosrp_adapter_info *sinfo;
756 struct mad_adapter_info_data info;
757 int rc;
759 sinfo = &req->iu.mad.adapter_info;
761 #if 0 /* What for ? */
762 rc = spapr_tce_dma_read(&s->vdev, be64_to_cpu(sinfo->buffer),
763 &info, be16_to_cpu(sinfo->common.length));
764 if (rc) {
765 fprintf(stderr, "vscsi_send_adapter_info: DMA read failure !\n");
767 #endif
768 memset(&info, 0, sizeof(info));
769 strcpy(info.srp_version, SRP_VERSION);
770 strncpy(info.partition_name, "qemu", sizeof("qemu"));
771 info.partition_number = cpu_to_be32(0);
772 info.mad_version = cpu_to_be32(1);
773 info.os_type = cpu_to_be32(2);
774 info.port_max_txu[0] = cpu_to_be32(VSCSI_MAX_SECTORS << 9);
776 rc = spapr_tce_dma_write(&s->vdev, be64_to_cpu(sinfo->buffer),
777 &info, be16_to_cpu(sinfo->common.length));
778 if (rc) {
779 fprintf(stderr, "vscsi_send_adapter_info: DMA write failure !\n");
782 sinfo->common.status = rc ? cpu_to_be32(1) : 0;
784 return vscsi_send_iu(s, req, sizeof(*sinfo), VIOSRP_MAD_FORMAT);
787 static int vscsi_handle_mad_req(VSCSIState *s, vscsi_req *req)
789 union mad_iu *mad = &req->iu.mad;
791 switch (be32_to_cpu(mad->empty_iu.common.type)) {
792 case VIOSRP_EMPTY_IU_TYPE:
793 fprintf(stderr, "Unsupported EMPTY MAD IU\n");
794 break;
795 case VIOSRP_ERROR_LOG_TYPE:
796 fprintf(stderr, "Unsupported ERROR LOG MAD IU\n");
797 mad->error_log.common.status = cpu_to_be16(1);
798 vscsi_send_iu(s, req, sizeof(mad->error_log), VIOSRP_MAD_FORMAT);
799 break;
800 case VIOSRP_ADAPTER_INFO_TYPE:
801 vscsi_send_adapter_info(s, req);
802 break;
803 case VIOSRP_HOST_CONFIG_TYPE:
804 mad->host_config.common.status = cpu_to_be16(1);
805 vscsi_send_iu(s, req, sizeof(mad->host_config), VIOSRP_MAD_FORMAT);
806 break;
807 default:
808 fprintf(stderr, "VSCSI: Unknown MAD type %02x\n",
809 be32_to_cpu(mad->empty_iu.common.type));
812 return 1;
815 static void vscsi_got_payload(VSCSIState *s, vscsi_crq *crq)
817 vscsi_req *req;
818 int done;
820 req = vscsi_get_req(s);
821 if (req == NULL) {
822 fprintf(stderr, "VSCSI: Failed to get a request !\n");
823 return;
826 /* We only support a limited number of descriptors, we know
827 * the ibmvscsi driver uses up to 10 max, so it should fit
828 * in our 256 bytes IUs. If not we'll have to increase the size
829 * of the structure.
831 if (crq->s.IU_length > sizeof(union viosrp_iu)) {
832 fprintf(stderr, "VSCSI: SRP IU too long (%d bytes) !\n",
833 crq->s.IU_length);
834 return;
837 /* XXX Handle failure differently ? */
838 if (spapr_tce_dma_read(&s->vdev, crq->s.IU_data_ptr, &req->iu,
839 crq->s.IU_length)) {
840 fprintf(stderr, "vscsi_got_payload: DMA read failure !\n");
841 qemu_free(req);
843 memcpy(&req->crq, crq, sizeof(vscsi_crq));
845 if (crq->s.format == VIOSRP_MAD_FORMAT) {
846 done = vscsi_handle_mad_req(s, req);
847 } else {
848 done = vscsi_handle_srp_req(s, req);
851 if (done) {
852 vscsi_put_req(s, req);
857 static int vscsi_do_crq(struct VIOsPAPRDevice *dev, uint8_t *crq_data)
859 VSCSIState *s = DO_UPCAST(VSCSIState, vdev, dev);
860 vscsi_crq crq;
862 memcpy(crq.raw, crq_data, 16);
863 crq.s.timeout = be16_to_cpu(crq.s.timeout);
864 crq.s.IU_length = be16_to_cpu(crq.s.IU_length);
865 crq.s.IU_data_ptr = be64_to_cpu(crq.s.IU_data_ptr);
867 dprintf("VSCSI: do_crq %02x %02x ...\n", crq.raw[0], crq.raw[1]);
869 switch (crq.s.valid) {
870 case 0xc0: /* Init command/response */
872 /* Respond to initialization request */
873 if (crq.s.format == 0x01) {
874 memset(crq.raw, 0, 16);
875 crq.s.valid = 0xc0;
876 crq.s.format = 0x02;
877 spapr_vio_send_crq(dev, crq.raw);
880 /* Note that in hotplug cases, we might get a 0x02
881 * as a result of us emitting the init request
884 break;
885 case 0xff: /* Link event */
887 /* Not handled for now */
889 break;
890 case 0x80: /* Payloads */
891 switch (crq.s.format) {
892 case VIOSRP_SRP_FORMAT: /* AKA VSCSI request */
893 case VIOSRP_MAD_FORMAT: /* AKA VSCSI response */
894 vscsi_got_payload(s, &crq);
895 break;
896 case VIOSRP_OS400_FORMAT:
897 case VIOSRP_AIX_FORMAT:
898 case VIOSRP_LINUX_FORMAT:
899 case VIOSRP_INLINE_FORMAT:
900 fprintf(stderr, "vscsi_do_srq: Unsupported payload format %02x\n",
901 crq.s.format);
902 break;
903 default:
904 fprintf(stderr, "vscsi_do_srq: Unknown payload format %02x\n",
905 crq.s.format);
907 break;
908 default:
909 fprintf(stderr, "vscsi_do_crq: unknown CRQ %02x %02x ...\n",
910 crq.raw[0], crq.raw[1]);
913 return 0;
916 static const struct SCSIBusOps vscsi_scsi_ops = {
917 .complete = vscsi_command_complete
920 static int spapr_vscsi_init(VIOsPAPRDevice *dev)
922 VSCSIState *s = DO_UPCAST(VSCSIState, vdev, dev);
923 int i;
925 dbg_vscsi_state = s;
927 /* Initialize qemu request tags */
928 memset(s->reqs, 0, sizeof(s->reqs));
929 for (i = 0; i < VSCSI_REQ_LIMIT; i++) {
930 s->reqs[i].qtag = i;
933 dev->crq.SendFunc = vscsi_do_crq;
935 scsi_bus_new(&s->bus, &dev->qdev, 1, VSCSI_REQ_LIMIT,
936 &vscsi_scsi_ops);
937 if (!dev->qdev.hotplugged) {
938 scsi_bus_legacy_handle_cmdline(&s->bus);
941 return 0;
944 void spapr_vscsi_create(VIOsPAPRBus *bus, uint32_t reg,
945 qemu_irq qirq, uint32_t vio_irq_num)
947 DeviceState *dev;
948 VIOsPAPRDevice *sdev;
950 dev = qdev_create(&bus->bus, "spapr-vscsi");
951 qdev_prop_set_uint32(dev, "reg", reg);
953 qdev_init_nofail(dev);
955 sdev = (VIOsPAPRDevice *)dev;
956 sdev->qirq = qirq;
957 sdev->vio_irq_num = vio_irq_num;
960 static int spapr_vscsi_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
962 int ret;
964 ret = fdt_setprop_cell(fdt, node_off, "#address-cells", 2);
965 if (ret < 0) {
966 return ret;
969 ret = fdt_setprop_cell(fdt, node_off, "#size-cells", 0);
970 if (ret < 0) {
971 return ret;
974 return 0;
977 static VIOsPAPRDeviceInfo spapr_vscsi = {
978 .init = spapr_vscsi_init,
979 .devnode = spapr_vscsi_devnode,
980 .dt_name = "v-scsi",
981 .dt_type = "vscsi",
982 .dt_compatible = "IBM,v-scsi",
983 .signal_mask = 0x00000001,
984 .qdev.name = "spapr-vscsi",
985 .qdev.size = sizeof(VSCSIState),
986 .qdev.props = (Property[]) {
987 DEFINE_PROP_UINT32("reg", VIOsPAPRDevice, reg, 0x2000),
988 DEFINE_PROP_UINT32("dma-window", VIOsPAPRDevice,
989 rtce_window_size, 0x10000000),
990 DEFINE_PROP_END_OF_LIST(),
994 static void spapr_vscsi_register(void)
996 spapr_vio_bus_register_withprop(&spapr_vscsi);
998 device_init(spapr_vscsi_register);