xref: /openbmc/qemu/hw/scsi/megasas.c (revision f02b664aad8f1aaafbcdf45285f6fcab0a4bd5d0)
1 /*
2  * QEMU MegaRAID SAS 8708EM2 Host Bus Adapter emulation
3  * Based on the linux driver code at drivers/scsi/megaraid
4  *
5  * Copyright (c) 2009-2012 Hannes Reinecke, SUSE Labs
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #include "qemu/osdep.h"
22 #include "qemu-common.h"
23 #include "hw/pci/pci.h"
24 #include "hw/qdev-properties.h"
25 #include "sysemu/dma.h"
26 #include "sysemu/block-backend.h"
27 #include "hw/pci/msi.h"
28 #include "hw/pci/msix.h"
29 #include "qemu/iov.h"
30 #include "qemu/module.h"
31 #include "hw/scsi/scsi.h"
32 #include "scsi/constants.h"
33 #include "trace.h"
34 #include "qapi/error.h"
35 #include "mfi.h"
36 #include "migration/vmstate.h"
37 #include "qom/object.h"
38 
39 #define MEGASAS_VERSION_GEN1 "1.70"
40 #define MEGASAS_VERSION_GEN2 "1.80"
41 #define MEGASAS_MAX_FRAMES 2048         /* Firmware limit at 65535 */
42 #define MEGASAS_DEFAULT_FRAMES 1000     /* Windows requires this */
43 #define MEGASAS_GEN2_DEFAULT_FRAMES 1008     /* Windows requires this */
44 #define MEGASAS_MAX_SGE 128             /* Firmware limit */
45 #define MEGASAS_DEFAULT_SGE 80
46 #define MEGASAS_MAX_SECTORS 0xFFFF      /* No real limit */
47 #define MEGASAS_MAX_ARRAYS 128
48 
49 #define MEGASAS_HBA_SERIAL "QEMU123456"
50 #define NAA_LOCALLY_ASSIGNED_ID 0x3ULL
51 #define IEEE_COMPANY_LOCALLY_ASSIGNED 0x525400
52 
53 #define MEGASAS_FLAG_USE_JBOD      0
54 #define MEGASAS_MASK_USE_JBOD      (1 << MEGASAS_FLAG_USE_JBOD)
55 #define MEGASAS_FLAG_USE_QUEUE64   1
56 #define MEGASAS_MASK_USE_QUEUE64   (1 << MEGASAS_FLAG_USE_QUEUE64)
57 
58 typedef struct MegasasCmd {
59     uint32_t index;
60     uint16_t flags;
61     uint16_t count;
62     uint64_t context;
63 
64     hwaddr pa;
65     hwaddr pa_size;
66     uint32_t dcmd_opcode;
67     union mfi_frame *frame;
68     SCSIRequest *req;
69     QEMUSGList qsg;
70     void *iov_buf;
71     size_t iov_size;
72     size_t iov_offset;
73     struct MegasasState *state;
74 } MegasasCmd;
75 
76 struct MegasasState {
77     /*< private >*/
78     PCIDevice parent_obj;
79     /*< public >*/
80 
81     MemoryRegion mmio_io;
82     MemoryRegion port_io;
83     MemoryRegion queue_io;
84     uint32_t frame_hi;
85 
86     uint32_t fw_state;
87     uint32_t fw_sge;
88     uint32_t fw_cmds;
89     uint32_t flags;
90     uint32_t fw_luns;
91     uint32_t intr_mask;
92     uint32_t doorbell;
93     uint32_t busy;
94     uint32_t diag;
95     uint32_t adp_reset;
96     OnOffAuto msi;
97     OnOffAuto msix;
98 
99     MegasasCmd *event_cmd;
100     uint16_t event_locale;
101     int event_class;
102     uint32_t event_count;
103     uint32_t shutdown_event;
104     uint32_t boot_event;
105 
106     uint64_t sas_addr;
107     char *hba_serial;
108 
109     uint64_t reply_queue_pa;
110     void *reply_queue;
111     uint16_t reply_queue_len;
112     uint32_t reply_queue_head;
113     uint32_t reply_queue_tail;
114     uint64_t consumer_pa;
115     uint64_t producer_pa;
116 
117     MegasasCmd frames[MEGASAS_MAX_FRAMES];
118     DECLARE_BITMAP(frame_map, MEGASAS_MAX_FRAMES);
119     SCSIBus bus;
120 };
121 typedef struct MegasasState MegasasState;
122 
123 struct MegasasBaseClass {
124     PCIDeviceClass parent_class;
125     const char *product_name;
126     const char *product_version;
127     int mmio_bar;
128     int ioport_bar;
129     int osts;
130 };
131 typedef struct MegasasBaseClass MegasasBaseClass;
132 
133 #define TYPE_MEGASAS_BASE "megasas-base"
134 #define TYPE_MEGASAS_GEN1 "megasas"
135 #define TYPE_MEGASAS_GEN2 "megasas-gen2"
136 
137 DECLARE_OBJ_CHECKERS(MegasasState, MegasasBaseClass,
138                      MEGASAS, TYPE_MEGASAS_BASE)
139 
140 
141 #define MEGASAS_INTR_DISABLED_MASK 0xFFFFFFFF
142 
143 static bool megasas_intr_enabled(MegasasState *s)
144 {
145     if ((s->intr_mask & MEGASAS_INTR_DISABLED_MASK) !=
146         MEGASAS_INTR_DISABLED_MASK) {
147         return true;
148     }
149     return false;
150 }
151 
152 static bool megasas_use_queue64(MegasasState *s)
153 {
154     return s->flags & MEGASAS_MASK_USE_QUEUE64;
155 }
156 
157 static bool megasas_use_msix(MegasasState *s)
158 {
159     return s->msix != ON_OFF_AUTO_OFF;
160 }
161 
162 static bool megasas_is_jbod(MegasasState *s)
163 {
164     return s->flags & MEGASAS_MASK_USE_JBOD;
165 }
166 
167 static void megasas_frame_set_cmd_status(MegasasState *s,
168                                          unsigned long frame, uint8_t v)
169 {
170     PCIDevice *pci = &s->parent_obj;
171     stb_pci_dma(pci, frame + offsetof(struct mfi_frame_header, cmd_status),
172                 v, MEMTXATTRS_UNSPECIFIED);
173 }
174 
175 static void megasas_frame_set_scsi_status(MegasasState *s,
176                                           unsigned long frame, uint8_t v)
177 {
178     PCIDevice *pci = &s->parent_obj;
179     stb_pci_dma(pci, frame + offsetof(struct mfi_frame_header, scsi_status),
180                 v, MEMTXATTRS_UNSPECIFIED);
181 }
182 
183 static inline const char *mfi_frame_desc(unsigned int cmd)
184 {
185     static const char *mfi_frame_descs[] = {
186         "MFI init", "LD Read", "LD Write", "LD SCSI", "PD SCSI",
187         "MFI Doorbell", "MFI Abort", "MFI SMP", "MFI Stop"
188     };
189 
190     if (cmd < ARRAY_SIZE(mfi_frame_descs)) {
191         return mfi_frame_descs[cmd];
192     }
193 
194     return "Unknown";
195 }
196 
197 /*
198  * Context is considered opaque, but the HBA firmware is running
199  * in little endian mode. So convert it to little endian, too.
200  */
201 static uint64_t megasas_frame_get_context(MegasasState *s,
202                                           unsigned long frame)
203 {
204     PCIDevice *pci = &s->parent_obj;
205     uint64_t val;
206 
207     ldq_le_pci_dma(pci, frame + offsetof(struct mfi_frame_header, context),
208                    &val, MEMTXATTRS_UNSPECIFIED);
209 
210     return val;
211 }
212 
213 static bool megasas_frame_is_ieee_sgl(MegasasCmd *cmd)
214 {
215     return cmd->flags & MFI_FRAME_IEEE_SGL;
216 }
217 
218 static bool megasas_frame_is_sgl64(MegasasCmd *cmd)
219 {
220     return cmd->flags & MFI_FRAME_SGL64;
221 }
222 
223 static bool megasas_frame_is_sense64(MegasasCmd *cmd)
224 {
225     return cmd->flags & MFI_FRAME_SENSE64;
226 }
227 
228 static uint64_t megasas_sgl_get_addr(MegasasCmd *cmd,
229                                      union mfi_sgl *sgl)
230 {
231     uint64_t addr;
232 
233     if (megasas_frame_is_ieee_sgl(cmd)) {
234         addr = le64_to_cpu(sgl->sg_skinny->addr);
235     } else if (megasas_frame_is_sgl64(cmd)) {
236         addr = le64_to_cpu(sgl->sg64->addr);
237     } else {
238         addr = le32_to_cpu(sgl->sg32->addr);
239     }
240     return addr;
241 }
242 
243 static uint32_t megasas_sgl_get_len(MegasasCmd *cmd,
244                                     union mfi_sgl *sgl)
245 {
246     uint32_t len;
247 
248     if (megasas_frame_is_ieee_sgl(cmd)) {
249         len = le32_to_cpu(sgl->sg_skinny->len);
250     } else if (megasas_frame_is_sgl64(cmd)) {
251         len = le32_to_cpu(sgl->sg64->len);
252     } else {
253         len = le32_to_cpu(sgl->sg32->len);
254     }
255     return len;
256 }
257 
258 static union mfi_sgl *megasas_sgl_next(MegasasCmd *cmd,
259                                        union mfi_sgl *sgl)
260 {
261     uint8_t *next = (uint8_t *)sgl;
262 
263     if (megasas_frame_is_ieee_sgl(cmd)) {
264         next += sizeof(struct mfi_sg_skinny);
265     } else if (megasas_frame_is_sgl64(cmd)) {
266         next += sizeof(struct mfi_sg64);
267     } else {
268         next += sizeof(struct mfi_sg32);
269     }
270 
271     if (next >= (uint8_t *)cmd->frame + cmd->pa_size) {
272         return NULL;
273     }
274     return (union mfi_sgl *)next;
275 }
276 
277 static void megasas_soft_reset(MegasasState *s);
278 
279 static int megasas_map_sgl(MegasasState *s, MegasasCmd *cmd, union mfi_sgl *sgl)
280 {
281     int i;
282     int iov_count = 0;
283     size_t iov_size = 0;
284 
285     cmd->flags = le16_to_cpu(cmd->frame->header.flags);
286     iov_count = cmd->frame->header.sge_count;
287     if (!iov_count || iov_count > MEGASAS_MAX_SGE) {
288         trace_megasas_iovec_sgl_overflow(cmd->index, iov_count,
289                                          MEGASAS_MAX_SGE);
290         return -1;
291     }
292     pci_dma_sglist_init(&cmd->qsg, PCI_DEVICE(s), iov_count);
293     for (i = 0; i < iov_count; i++) {
294         dma_addr_t iov_pa, iov_size_p;
295 
296         if (!sgl) {
297             trace_megasas_iovec_sgl_underflow(cmd->index, i);
298             goto unmap;
299         }
300         iov_pa = megasas_sgl_get_addr(cmd, sgl);
301         iov_size_p = megasas_sgl_get_len(cmd, sgl);
302         if (!iov_pa || !iov_size_p) {
303             trace_megasas_iovec_sgl_invalid(cmd->index, i,
304                                             iov_pa, iov_size_p);
305             goto unmap;
306         }
307         qemu_sglist_add(&cmd->qsg, iov_pa, iov_size_p);
308         sgl = megasas_sgl_next(cmd, sgl);
309         iov_size += (size_t)iov_size_p;
310     }
311     if (cmd->iov_size > iov_size) {
312         trace_megasas_iovec_overflow(cmd->index, iov_size, cmd->iov_size);
313         goto unmap;
314     } else if (cmd->iov_size < iov_size) {
315         trace_megasas_iovec_underflow(cmd->index, iov_size, cmd->iov_size);
316     }
317     cmd->iov_offset = 0;
318     return 0;
319 unmap:
320     qemu_sglist_destroy(&cmd->qsg);
321     return -1;
322 }
323 
324 /*
325  * passthrough sense and io sense are at the same offset
326  */
327 static int megasas_build_sense(MegasasCmd *cmd, uint8_t *sense_ptr,
328     uint8_t sense_len)
329 {
330     PCIDevice *pcid = PCI_DEVICE(cmd->state);
331     uint32_t pa_hi = 0, pa_lo;
332     hwaddr pa;
333     int frame_sense_len;
334 
335     frame_sense_len = cmd->frame->header.sense_len;
336     if (sense_len > frame_sense_len) {
337         sense_len = frame_sense_len;
338     }
339     if (sense_len) {
340         pa_lo = le32_to_cpu(cmd->frame->pass.sense_addr_lo);
341         if (megasas_frame_is_sense64(cmd)) {
342             pa_hi = le32_to_cpu(cmd->frame->pass.sense_addr_hi);
343         }
344         pa = ((uint64_t) pa_hi << 32) | pa_lo;
345         pci_dma_write(pcid, pa, sense_ptr, sense_len);
346         cmd->frame->header.sense_len = sense_len;
347     }
348     return sense_len;
349 }
350 
351 static void megasas_write_sense(MegasasCmd *cmd, SCSISense sense)
352 {
353     uint8_t sense_buf[SCSI_SENSE_BUF_SIZE];
354     uint8_t sense_len = 18;
355 
356     memset(sense_buf, 0, sense_len);
357     sense_buf[0] = 0xf0;
358     sense_buf[2] = sense.key;
359     sense_buf[7] = 10;
360     sense_buf[12] = sense.asc;
361     sense_buf[13] = sense.ascq;
362     megasas_build_sense(cmd, sense_buf, sense_len);
363 }
364 
365 static void megasas_copy_sense(MegasasCmd *cmd)
366 {
367     uint8_t sense_buf[SCSI_SENSE_BUF_SIZE];
368     uint8_t sense_len;
369 
370     sense_len = scsi_req_get_sense(cmd->req, sense_buf,
371                                    SCSI_SENSE_BUF_SIZE);
372     megasas_build_sense(cmd, sense_buf, sense_len);
373 }
374 
375 /*
376  * Format an INQUIRY CDB
377  */
378 static int megasas_setup_inquiry(uint8_t *cdb, int pg, int len)
379 {
380     memset(cdb, 0, 6);
381     cdb[0] = INQUIRY;
382     if (pg > 0) {
383         cdb[1] = 0x1;
384         cdb[2] = pg;
385     }
386     cdb[3] = (len >> 8) & 0xff;
387     cdb[4] = (len & 0xff);
388     return len;
389 }
390 
391 /*
392  * Encode lba and len into a READ_16/WRITE_16 CDB
393  */
394 static void megasas_encode_lba(uint8_t *cdb, uint64_t lba,
395                                uint32_t len, bool is_write)
396 {
397     memset(cdb, 0x0, 16);
398     if (is_write) {
399         cdb[0] = WRITE_16;
400     } else {
401         cdb[0] = READ_16;
402     }
403     cdb[2] = (lba >> 56) & 0xff;
404     cdb[3] = (lba >> 48) & 0xff;
405     cdb[4] = (lba >> 40) & 0xff;
406     cdb[5] = (lba >> 32) & 0xff;
407     cdb[6] = (lba >> 24) & 0xff;
408     cdb[7] = (lba >> 16) & 0xff;
409     cdb[8] = (lba >> 8) & 0xff;
410     cdb[9] = (lba) & 0xff;
411     cdb[10] = (len >> 24) & 0xff;
412     cdb[11] = (len >> 16) & 0xff;
413     cdb[12] = (len >> 8) & 0xff;
414     cdb[13] = (len) & 0xff;
415 }
416 
417 /*
418  * Utility functions
419  */
420 static uint64_t megasas_fw_time(void)
421 {
422     struct tm curtime;
423 
424     qemu_get_timedate(&curtime, 0);
425     return ((uint64_t)curtime.tm_sec & 0xff) << 48 |
426         ((uint64_t)curtime.tm_min & 0xff)  << 40 |
427         ((uint64_t)curtime.tm_hour & 0xff) << 32 |
428         ((uint64_t)curtime.tm_mday & 0xff) << 24 |
429         ((uint64_t)curtime.tm_mon & 0xff)  << 16 |
430         ((uint64_t)(curtime.tm_year + 1900) & 0xffff);
431 }
432 
433 /*
434  * Default disk sata address
435  * 0x1221 is the magic number as
436  * present in real hardware,
437  * so use it here, too.
438  */
439 static uint64_t megasas_get_sata_addr(uint16_t id)
440 {
441     uint64_t addr = (0x1221ULL << 48);
442     return addr | ((uint64_t)id << 24);
443 }
444 
445 /*
446  * Frame handling
447  */
448 static int megasas_next_index(MegasasState *s, int index, int limit)
449 {
450     index++;
451     if (index == limit) {
452         index = 0;
453     }
454     return index;
455 }
456 
457 static MegasasCmd *megasas_lookup_frame(MegasasState *s,
458     hwaddr frame)
459 {
460     MegasasCmd *cmd = NULL;
461     int num = 0, index;
462 
463     index = s->reply_queue_head;
464 
465     while (num < s->fw_cmds && index < MEGASAS_MAX_FRAMES) {
466         if (s->frames[index].pa && s->frames[index].pa == frame) {
467             cmd = &s->frames[index];
468             break;
469         }
470         index = megasas_next_index(s, index, s->fw_cmds);
471         num++;
472     }
473 
474     return cmd;
475 }
476 
477 static void megasas_unmap_frame(MegasasState *s, MegasasCmd *cmd)
478 {
479     PCIDevice *p = PCI_DEVICE(s);
480 
481     if (cmd->pa_size) {
482         pci_dma_unmap(p, cmd->frame, cmd->pa_size, 0, 0);
483     }
484     cmd->frame = NULL;
485     cmd->pa = 0;
486     cmd->pa_size = 0;
487     qemu_sglist_destroy(&cmd->qsg);
488     clear_bit(cmd->index, s->frame_map);
489 }
490 
491 /*
492  * This absolutely needs to be locked if
493  * qemu ever goes multithreaded.
494  */
495 static MegasasCmd *megasas_enqueue_frame(MegasasState *s,
496     hwaddr frame, uint64_t context, int count)
497 {
498     PCIDevice *pcid = PCI_DEVICE(s);
499     MegasasCmd *cmd = NULL;
500     int frame_size = MEGASAS_MAX_SGE * sizeof(union mfi_sgl);
501     hwaddr frame_size_p = frame_size;
502     unsigned long index;
503 
504     index = 0;
505     while (index < s->fw_cmds) {
506         index = find_next_zero_bit(s->frame_map, s->fw_cmds, index);
507         if (!s->frames[index].pa)
508             break;
509         /* Busy frame found */
510         trace_megasas_qf_mapped(index);
511     }
512     if (index >= s->fw_cmds) {
513         /* All frames busy */
514         trace_megasas_qf_busy(frame);
515         return NULL;
516     }
517     cmd = &s->frames[index];
518     set_bit(index, s->frame_map);
519     trace_megasas_qf_new(index, frame);
520 
521     cmd->pa = frame;
522     /* Map all possible frames */
523     cmd->frame = pci_dma_map(pcid, frame, &frame_size_p, 0);
524     if (!cmd->frame || frame_size_p != frame_size) {
525         trace_megasas_qf_map_failed(cmd->index, (unsigned long)frame);
526         if (cmd->frame) {
527             megasas_unmap_frame(s, cmd);
528         }
529         s->event_count++;
530         return NULL;
531     }
532     cmd->pa_size = frame_size_p;
533     cmd->context = context;
534     if (!megasas_use_queue64(s)) {
535         cmd->context &= (uint64_t)0xFFFFFFFF;
536     }
537     cmd->count = count;
538     cmd->dcmd_opcode = -1;
539     s->busy++;
540 
541     if (s->consumer_pa) {
542         ldl_le_pci_dma(pcid, s->consumer_pa, &s->reply_queue_tail,
543                        MEMTXATTRS_UNSPECIFIED);
544     }
545     trace_megasas_qf_enqueue(cmd->index, cmd->count, cmd->context,
546                              s->reply_queue_head, s->reply_queue_tail, s->busy);
547 
548     return cmd;
549 }
550 
551 static void megasas_complete_frame(MegasasState *s, uint64_t context)
552 {
553     const MemTxAttrs attrs = MEMTXATTRS_UNSPECIFIED;
554     PCIDevice *pci_dev = PCI_DEVICE(s);
555     int tail, queue_offset;
556 
557     /* Decrement busy count */
558     s->busy--;
559     if (s->reply_queue_pa) {
560         /*
561          * Put command on the reply queue.
562          * Context is opaque, but emulation is running in
563          * little endian. So convert it.
564          */
565         if (megasas_use_queue64(s)) {
566             queue_offset = s->reply_queue_head * sizeof(uint64_t);
567             stq_le_pci_dma(pci_dev, s->reply_queue_pa + queue_offset,
568                            context, attrs);
569         } else {
570             queue_offset = s->reply_queue_head * sizeof(uint32_t);
571             stl_le_pci_dma(pci_dev, s->reply_queue_pa + queue_offset,
572                            context, attrs);
573         }
574         ldl_le_pci_dma(pci_dev, s->consumer_pa, &s->reply_queue_tail, attrs);
575         trace_megasas_qf_complete(context, s->reply_queue_head,
576                                   s->reply_queue_tail, s->busy);
577     }
578 
579     if (megasas_intr_enabled(s)) {
580         /* Update reply queue pointer */
581         ldl_le_pci_dma(pci_dev, s->consumer_pa, &s->reply_queue_tail, attrs);
582         tail = s->reply_queue_head;
583         s->reply_queue_head = megasas_next_index(s, tail, s->fw_cmds);
584         trace_megasas_qf_update(s->reply_queue_head, s->reply_queue_tail,
585                                 s->busy);
586         stl_le_pci_dma(pci_dev, s->producer_pa, s->reply_queue_head, attrs);
587         /* Notify HBA */
588         if (msix_enabled(pci_dev)) {
589             trace_megasas_msix_raise(0);
590             msix_notify(pci_dev, 0);
591         } else if (msi_enabled(pci_dev)) {
592             trace_megasas_msi_raise(0);
593             msi_notify(pci_dev, 0);
594         } else {
595             s->doorbell++;
596             if (s->doorbell == 1) {
597                 trace_megasas_irq_raise();
598                 pci_irq_assert(pci_dev);
599             }
600         }
601     } else {
602         trace_megasas_qf_complete_noirq(context);
603     }
604 }
605 
606 static void megasas_complete_command(MegasasCmd *cmd)
607 {
608     cmd->iov_size = 0;
609     cmd->iov_offset = 0;
610 
611     cmd->req->hba_private = NULL;
612     scsi_req_unref(cmd->req);
613     cmd->req = NULL;
614 
615     megasas_unmap_frame(cmd->state, cmd);
616     megasas_complete_frame(cmd->state, cmd->context);
617 }
618 
619 static void megasas_reset_frames(MegasasState *s)
620 {
621     int i;
622     MegasasCmd *cmd;
623 
624     for (i = 0; i < s->fw_cmds; i++) {
625         cmd = &s->frames[i];
626         if (cmd->pa) {
627             megasas_unmap_frame(s, cmd);
628         }
629     }
630     bitmap_zero(s->frame_map, MEGASAS_MAX_FRAMES);
631 }
632 
633 static void megasas_abort_command(MegasasCmd *cmd)
634 {
635     /* Never abort internal commands.  */
636     if (cmd->dcmd_opcode != -1) {
637         return;
638     }
639     if (cmd->req != NULL) {
640         scsi_req_cancel(cmd->req);
641     }
642 }
643 
644 static int megasas_init_firmware(MegasasState *s, MegasasCmd *cmd)
645 {
646     const MemTxAttrs attrs = MEMTXATTRS_UNSPECIFIED;
647     PCIDevice *pcid = PCI_DEVICE(s);
648     uint32_t pa_hi, pa_lo;
649     hwaddr iq_pa, initq_size = sizeof(struct mfi_init_qinfo);
650     struct mfi_init_qinfo *initq = NULL;
651     uint32_t flags;
652     int ret = MFI_STAT_OK;
653 
654     if (s->reply_queue_pa) {
655         trace_megasas_initq_mapped(s->reply_queue_pa);
656         goto out;
657     }
658     pa_lo = le32_to_cpu(cmd->frame->init.qinfo_new_addr_lo);
659     pa_hi = le32_to_cpu(cmd->frame->init.qinfo_new_addr_hi);
660     iq_pa = (((uint64_t) pa_hi << 32) | pa_lo);
661     trace_megasas_init_firmware((uint64_t)iq_pa);
662     initq = pci_dma_map(pcid, iq_pa, &initq_size, 0);
663     if (!initq || initq_size != sizeof(*initq)) {
664         trace_megasas_initq_map_failed(cmd->index);
665         s->event_count++;
666         ret = MFI_STAT_MEMORY_NOT_AVAILABLE;
667         goto out;
668     }
669     s->reply_queue_len = le32_to_cpu(initq->rq_entries) & 0xFFFF;
670     if (s->reply_queue_len > s->fw_cmds) {
671         trace_megasas_initq_mismatch(s->reply_queue_len, s->fw_cmds);
672         s->event_count++;
673         ret = MFI_STAT_INVALID_PARAMETER;
674         goto out;
675     }
676     pa_lo = le32_to_cpu(initq->rq_addr_lo);
677     pa_hi = le32_to_cpu(initq->rq_addr_hi);
678     s->reply_queue_pa = ((uint64_t) pa_hi << 32) | pa_lo;
679     pa_lo = le32_to_cpu(initq->ci_addr_lo);
680     pa_hi = le32_to_cpu(initq->ci_addr_hi);
681     s->consumer_pa = ((uint64_t) pa_hi << 32) | pa_lo;
682     pa_lo = le32_to_cpu(initq->pi_addr_lo);
683     pa_hi = le32_to_cpu(initq->pi_addr_hi);
684     s->producer_pa = ((uint64_t) pa_hi << 32) | pa_lo;
685     ldl_le_pci_dma(pcid, s->producer_pa, &s->reply_queue_head, attrs);
686     s->reply_queue_head %= MEGASAS_MAX_FRAMES;
687     ldl_le_pci_dma(pcid, s->consumer_pa, &s->reply_queue_tail, attrs);
688     s->reply_queue_tail %= MEGASAS_MAX_FRAMES;
689     flags = le32_to_cpu(initq->flags);
690     if (flags & MFI_QUEUE_FLAG_CONTEXT64) {
691         s->flags |= MEGASAS_MASK_USE_QUEUE64;
692     }
693     trace_megasas_init_queue((unsigned long)s->reply_queue_pa,
694                              s->reply_queue_len, s->reply_queue_head,
695                              s->reply_queue_tail, flags);
696     megasas_reset_frames(s);
697     s->fw_state = MFI_FWSTATE_OPERATIONAL;
698 out:
699     if (initq) {
700         pci_dma_unmap(pcid, initq, initq_size, 0, 0);
701     }
702     return ret;
703 }
704 
705 static int megasas_map_dcmd(MegasasState *s, MegasasCmd *cmd)
706 {
707     dma_addr_t iov_pa, iov_size;
708     int iov_count;
709 
710     cmd->flags = le16_to_cpu(cmd->frame->header.flags);
711     iov_count = cmd->frame->header.sge_count;
712     if (!iov_count) {
713         trace_megasas_dcmd_zero_sge(cmd->index);
714         cmd->iov_size = 0;
715         return 0;
716     } else if (iov_count > 1) {
717         trace_megasas_dcmd_invalid_sge(cmd->index, iov_count);
718         cmd->iov_size = 0;
719         return -EINVAL;
720     }
721     iov_pa = megasas_sgl_get_addr(cmd, &cmd->frame->dcmd.sgl);
722     iov_size = megasas_sgl_get_len(cmd, &cmd->frame->dcmd.sgl);
723     pci_dma_sglist_init(&cmd->qsg, PCI_DEVICE(s), 1);
724     qemu_sglist_add(&cmd->qsg, iov_pa, iov_size);
725     cmd->iov_size = iov_size;
726     return 0;
727 }
728 
729 static void megasas_finish_dcmd(MegasasCmd *cmd, uint32_t iov_size)
730 {
731     trace_megasas_finish_dcmd(cmd->index, iov_size);
732 
733     if (iov_size > cmd->iov_size) {
734         if (megasas_frame_is_ieee_sgl(cmd)) {
735             cmd->frame->dcmd.sgl.sg_skinny->len = cpu_to_le32(iov_size);
736         } else if (megasas_frame_is_sgl64(cmd)) {
737             cmd->frame->dcmd.sgl.sg64->len = cpu_to_le32(iov_size);
738         } else {
739             cmd->frame->dcmd.sgl.sg32->len = cpu_to_le32(iov_size);
740         }
741     }
742 }
743 
744 static int megasas_ctrl_get_info(MegasasState *s, MegasasCmd *cmd)
745 {
746     PCIDevice *pci_dev = PCI_DEVICE(s);
747     PCIDeviceClass *pci_class = PCI_DEVICE_GET_CLASS(pci_dev);
748     MegasasBaseClass *base_class = MEGASAS_GET_CLASS(s);
749     struct mfi_ctrl_info info;
750     size_t dcmd_size = sizeof(info);
751     BusChild *kid;
752     int num_pd_disks = 0;
753     dma_addr_t residual;
754 
755     memset(&info, 0x0, dcmd_size);
756     if (cmd->iov_size < dcmd_size) {
757         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
758                                             dcmd_size);
759         return MFI_STAT_INVALID_PARAMETER;
760     }
761 
762     info.pci.vendor = cpu_to_le16(pci_class->vendor_id);
763     info.pci.device = cpu_to_le16(pci_class->device_id);
764     info.pci.subvendor = cpu_to_le16(pci_class->subsystem_vendor_id);
765     info.pci.subdevice = cpu_to_le16(pci_class->subsystem_id);
766 
767     /*
768      * For some reason the firmware supports
769      * only up to 8 device ports.
770      * Despite supporting a far larger number
771      * of devices for the physical devices.
772      * So just display the first 8 devices
773      * in the device port list, independent
774      * of how many logical devices are actually
775      * present.
776      */
777     info.host.type = MFI_INFO_HOST_PCIE;
778     info.device.type = MFI_INFO_DEV_SAS3G;
779     info.device.port_count = 8;
780     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
781         SCSIDevice *sdev = SCSI_DEVICE(kid->child);
782         uint16_t pd_id;
783 
784         if (num_pd_disks < 8) {
785             pd_id = ((sdev->id & 0xFF) << 8) | (sdev->lun & 0xFF);
786             info.device.port_addr[num_pd_disks] =
787                 cpu_to_le64(megasas_get_sata_addr(pd_id));
788         }
789         num_pd_disks++;
790     }
791 
792     memcpy(info.product_name, base_class->product_name, 24);
793     snprintf(info.serial_number, 32, "%s", s->hba_serial);
794     snprintf(info.package_version, 0x60, "%s-QEMU", qemu_hw_version());
795     memcpy(info.image_component[0].name, "APP", 3);
796     snprintf(info.image_component[0].version, 10, "%s-QEMU",
797              base_class->product_version);
798     memcpy(info.image_component[0].build_date, "Apr  1 2014", 11);
799     memcpy(info.image_component[0].build_time, "12:34:56", 8);
800     info.image_component_count = 1;
801     if (pci_dev->has_rom) {
802         uint8_t biosver[32];
803         uint8_t *ptr;
804 
805         ptr = memory_region_get_ram_ptr(&pci_dev->rom);
806         memcpy(biosver, ptr + 0x41, 31);
807         biosver[31] = 0;
808         memcpy(info.image_component[1].name, "BIOS", 4);
809         memcpy(info.image_component[1].version, biosver,
810                strlen((const char *)biosver));
811         info.image_component_count++;
812     }
813     info.current_fw_time = cpu_to_le32(megasas_fw_time());
814     info.max_arms = 32;
815     info.max_spans = 8;
816     info.max_arrays = MEGASAS_MAX_ARRAYS;
817     info.max_lds = MFI_MAX_LD;
818     info.max_cmds = cpu_to_le16(s->fw_cmds);
819     info.max_sg_elements = cpu_to_le16(s->fw_sge);
820     info.max_request_size = cpu_to_le32(MEGASAS_MAX_SECTORS);
821     if (!megasas_is_jbod(s))
822         info.lds_present = cpu_to_le16(num_pd_disks);
823     info.pd_present = cpu_to_le16(num_pd_disks);
824     info.pd_disks_present = cpu_to_le16(num_pd_disks);
825     info.hw_present = cpu_to_le32(MFI_INFO_HW_NVRAM |
826                                    MFI_INFO_HW_MEM |
827                                    MFI_INFO_HW_FLASH);
828     info.memory_size = cpu_to_le16(512);
829     info.nvram_size = cpu_to_le16(32);
830     info.flash_size = cpu_to_le16(16);
831     info.raid_levels = cpu_to_le32(MFI_INFO_RAID_0);
832     info.adapter_ops = cpu_to_le32(MFI_INFO_AOPS_RBLD_RATE |
833                                     MFI_INFO_AOPS_SELF_DIAGNOSTIC |
834                                     MFI_INFO_AOPS_MIXED_ARRAY);
835     info.ld_ops = cpu_to_le32(MFI_INFO_LDOPS_DISK_CACHE_POLICY |
836                                MFI_INFO_LDOPS_ACCESS_POLICY |
837                                MFI_INFO_LDOPS_IO_POLICY |
838                                MFI_INFO_LDOPS_WRITE_POLICY |
839                                MFI_INFO_LDOPS_READ_POLICY);
840     info.max_strips_per_io = cpu_to_le16(s->fw_sge);
841     info.stripe_sz_ops.min = 3;
842     info.stripe_sz_ops.max = ctz32(MEGASAS_MAX_SECTORS + 1);
843     info.properties.pred_fail_poll_interval = cpu_to_le16(300);
844     info.properties.intr_throttle_cnt = cpu_to_le16(16);
845     info.properties.intr_throttle_timeout = cpu_to_le16(50);
846     info.properties.rebuild_rate = 30;
847     info.properties.patrol_read_rate = 30;
848     info.properties.bgi_rate = 30;
849     info.properties.cc_rate = 30;
850     info.properties.recon_rate = 30;
851     info.properties.cache_flush_interval = 4;
852     info.properties.spinup_drv_cnt = 2;
853     info.properties.spinup_delay = 6;
854     info.properties.ecc_bucket_size = 15;
855     info.properties.ecc_bucket_leak_rate = cpu_to_le16(1440);
856     info.properties.expose_encl_devices = 1;
857     info.properties.OnOffProperties = cpu_to_le32(MFI_CTRL_PROP_EnableJBOD);
858     info.pd_ops = cpu_to_le32(MFI_INFO_PDOPS_FORCE_ONLINE |
859                                MFI_INFO_PDOPS_FORCE_OFFLINE);
860     info.pd_mix_support = cpu_to_le32(MFI_INFO_PDMIX_SAS |
861                                        MFI_INFO_PDMIX_SATA |
862                                        MFI_INFO_PDMIX_LD);
863 
864     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
865                  MEMTXATTRS_UNSPECIFIED);
866     cmd->iov_size -= residual;
867     return MFI_STAT_OK;
868 }
869 
870 static int megasas_mfc_get_defaults(MegasasState *s, MegasasCmd *cmd)
871 {
872     struct mfi_defaults info;
873     size_t dcmd_size = sizeof(struct mfi_defaults);
874     dma_addr_t residual;
875 
876     memset(&info, 0x0, dcmd_size);
877     if (cmd->iov_size < dcmd_size) {
878         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
879                                             dcmd_size);
880         return MFI_STAT_INVALID_PARAMETER;
881     }
882 
883     info.sas_addr = cpu_to_le64(s->sas_addr);
884     info.stripe_size = 3;
885     info.flush_time = 4;
886     info.background_rate = 30;
887     info.allow_mix_in_enclosure = 1;
888     info.allow_mix_in_ld = 1;
889     info.direct_pd_mapping = 1;
890     /* Enable for BIOS support */
891     info.bios_enumerate_lds = 1;
892     info.disable_ctrl_r = 1;
893     info.expose_enclosure_devices = 1;
894     info.disable_preboot_cli = 1;
895     info.cluster_disable = 1;
896 
897     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
898                  MEMTXATTRS_UNSPECIFIED);
899     cmd->iov_size -= residual;
900     return MFI_STAT_OK;
901 }
902 
903 static int megasas_dcmd_get_bios_info(MegasasState *s, MegasasCmd *cmd)
904 {
905     struct mfi_bios_data info;
906     size_t dcmd_size = sizeof(info);
907     dma_addr_t residual;
908 
909     memset(&info, 0x0, dcmd_size);
910     if (cmd->iov_size < dcmd_size) {
911         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
912                                             dcmd_size);
913         return MFI_STAT_INVALID_PARAMETER;
914     }
915     info.continue_on_error = 1;
916     info.verbose = 1;
917     if (megasas_is_jbod(s)) {
918         info.expose_all_drives = 1;
919     }
920 
921     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
922                  MEMTXATTRS_UNSPECIFIED);
923     cmd->iov_size -= residual;
924     return MFI_STAT_OK;
925 }
926 
927 static int megasas_dcmd_get_fw_time(MegasasState *s, MegasasCmd *cmd)
928 {
929     uint64_t fw_time;
930     size_t dcmd_size = sizeof(fw_time);
931     dma_addr_t residual;
932 
933     fw_time = cpu_to_le64(megasas_fw_time());
934 
935     dma_buf_read(&fw_time, dcmd_size, &residual, &cmd->qsg,
936                  MEMTXATTRS_UNSPECIFIED);
937     cmd->iov_size -= residual;
938     return MFI_STAT_OK;
939 }
940 
941 static int megasas_dcmd_set_fw_time(MegasasState *s, MegasasCmd *cmd)
942 {
943     uint64_t fw_time;
944 
945     /* This is a dummy; setting of firmware time is not allowed */
946     memcpy(&fw_time, cmd->frame->dcmd.mbox, sizeof(fw_time));
947 
948     trace_megasas_dcmd_set_fw_time(cmd->index, fw_time);
949     fw_time = cpu_to_le64(megasas_fw_time());
950     return MFI_STAT_OK;
951 }
952 
953 static int megasas_event_info(MegasasState *s, MegasasCmd *cmd)
954 {
955     struct mfi_evt_log_state info;
956     size_t dcmd_size = sizeof(info);
957     dma_addr_t residual;
958 
959     memset(&info, 0, dcmd_size);
960 
961     info.newest_seq_num = cpu_to_le32(s->event_count);
962     info.shutdown_seq_num = cpu_to_le32(s->shutdown_event);
963     info.boot_seq_num = cpu_to_le32(s->boot_event);
964 
965     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
966                  MEMTXATTRS_UNSPECIFIED);
967     cmd->iov_size -= residual;
968     return MFI_STAT_OK;
969 }
970 
971 static int megasas_event_wait(MegasasState *s, MegasasCmd *cmd)
972 {
973     union mfi_evt event;
974 
975     if (cmd->iov_size < sizeof(struct mfi_evt_detail)) {
976         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
977                                             sizeof(struct mfi_evt_detail));
978         return MFI_STAT_INVALID_PARAMETER;
979     }
980     s->event_count = cpu_to_le32(cmd->frame->dcmd.mbox[0]);
981     event.word = cpu_to_le32(cmd->frame->dcmd.mbox[4]);
982     s->event_locale = event.members.locale;
983     s->event_class = event.members.class;
984     s->event_cmd = cmd;
985     /* Decrease busy count; event frame doesn't count here */
986     s->busy--;
987     cmd->iov_size = sizeof(struct mfi_evt_detail);
988     return MFI_STAT_INVALID_STATUS;
989 }
990 
991 static int megasas_dcmd_pd_get_list(MegasasState *s, MegasasCmd *cmd)
992 {
993     struct mfi_pd_list info;
994     size_t dcmd_size = sizeof(info);
995     BusChild *kid;
996     uint32_t offset, dcmd_limit, num_pd_disks = 0, max_pd_disks;
997     dma_addr_t residual;
998 
999     memset(&info, 0, dcmd_size);
1000     offset = 8;
1001     dcmd_limit = offset + sizeof(struct mfi_pd_address);
1002     if (cmd->iov_size < dcmd_limit) {
1003         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
1004                                             dcmd_limit);
1005         return MFI_STAT_INVALID_PARAMETER;
1006     }
1007 
1008     max_pd_disks = (cmd->iov_size - offset) / sizeof(struct mfi_pd_address);
1009     if (max_pd_disks > MFI_MAX_SYS_PDS) {
1010         max_pd_disks = MFI_MAX_SYS_PDS;
1011     }
1012     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
1013         SCSIDevice *sdev = SCSI_DEVICE(kid->child);
1014         uint16_t pd_id;
1015 
1016         if (num_pd_disks >= max_pd_disks)
1017             break;
1018 
1019         pd_id = ((sdev->id & 0xFF) << 8) | (sdev->lun & 0xFF);
1020         info.addr[num_pd_disks].device_id = cpu_to_le16(pd_id);
1021         info.addr[num_pd_disks].encl_device_id = 0xFFFF;
1022         info.addr[num_pd_disks].encl_index = 0;
1023         info.addr[num_pd_disks].slot_number = sdev->id & 0xFF;
1024         info.addr[num_pd_disks].scsi_dev_type = sdev->type;
1025         info.addr[num_pd_disks].connect_port_bitmap = 0x1;
1026         info.addr[num_pd_disks].sas_addr[0] =
1027             cpu_to_le64(megasas_get_sata_addr(pd_id));
1028         num_pd_disks++;
1029         offset += sizeof(struct mfi_pd_address);
1030     }
1031     trace_megasas_dcmd_pd_get_list(cmd->index, num_pd_disks,
1032                                    max_pd_disks, offset);
1033 
1034     info.size = cpu_to_le32(offset);
1035     info.count = cpu_to_le32(num_pd_disks);
1036 
1037     dma_buf_read(&info, offset, &residual, &cmd->qsg,
1038                  MEMTXATTRS_UNSPECIFIED);
1039     cmd->iov_size -= residual;
1040     return MFI_STAT_OK;
1041 }
1042 
1043 static int megasas_dcmd_pd_list_query(MegasasState *s, MegasasCmd *cmd)
1044 {
1045     uint16_t flags;
1046 
1047     /* mbox0 contains flags */
1048     flags = le16_to_cpu(cmd->frame->dcmd.mbox[0]);
1049     trace_megasas_dcmd_pd_list_query(cmd->index, flags);
1050     if (flags == MR_PD_QUERY_TYPE_ALL ||
1051         megasas_is_jbod(s)) {
1052         return megasas_dcmd_pd_get_list(s, cmd);
1053     }
1054 
1055     return MFI_STAT_OK;
1056 }
1057 
1058 static int megasas_pd_get_info_submit(SCSIDevice *sdev, int lun,
1059                                       MegasasCmd *cmd)
1060 {
1061     struct mfi_pd_info *info = cmd->iov_buf;
1062     size_t dcmd_size = sizeof(struct mfi_pd_info);
1063     uint64_t pd_size;
1064     uint16_t pd_id = ((sdev->id & 0xFF) << 8) | (lun & 0xFF);
1065     uint8_t cmdbuf[6];
1066     size_t len;
1067     dma_addr_t residual;
1068 
1069     if (!cmd->iov_buf) {
1070         cmd->iov_buf = g_malloc0(dcmd_size);
1071         info = cmd->iov_buf;
1072         info->inquiry_data[0] = 0x7f; /* Force PQual 0x3, PType 0x1f */
1073         info->vpd_page83[0] = 0x7f;
1074         megasas_setup_inquiry(cmdbuf, 0, sizeof(info->inquiry_data));
1075         cmd->req = scsi_req_new(sdev, cmd->index, lun, cmdbuf, cmd);
1076         if (!cmd->req) {
1077             trace_megasas_dcmd_req_alloc_failed(cmd->index,
1078                                                 "PD get info std inquiry");
1079             g_free(cmd->iov_buf);
1080             cmd->iov_buf = NULL;
1081             return MFI_STAT_FLASH_ALLOC_FAIL;
1082         }
1083         trace_megasas_dcmd_internal_submit(cmd->index,
1084                                            "PD get info std inquiry", lun);
1085         len = scsi_req_enqueue(cmd->req);
1086         if (len > 0) {
1087             cmd->iov_size = len;
1088             scsi_req_continue(cmd->req);
1089         }
1090         return MFI_STAT_INVALID_STATUS;
1091     } else if (info->inquiry_data[0] != 0x7f && info->vpd_page83[0] == 0x7f) {
1092         megasas_setup_inquiry(cmdbuf, 0x83, sizeof(info->vpd_page83));
1093         cmd->req = scsi_req_new(sdev, cmd->index, lun, cmdbuf, cmd);
1094         if (!cmd->req) {
1095             trace_megasas_dcmd_req_alloc_failed(cmd->index,
1096                                                 "PD get info vpd inquiry");
1097             return MFI_STAT_FLASH_ALLOC_FAIL;
1098         }
1099         trace_megasas_dcmd_internal_submit(cmd->index,
1100                                            "PD get info vpd inquiry", lun);
1101         len = scsi_req_enqueue(cmd->req);
1102         if (len > 0) {
1103             cmd->iov_size = len;
1104             scsi_req_continue(cmd->req);
1105         }
1106         return MFI_STAT_INVALID_STATUS;
1107     }
1108     /* Finished, set FW state */
1109     if ((info->inquiry_data[0] >> 5) == 0) {
1110         if (megasas_is_jbod(cmd->state)) {
1111             info->fw_state = cpu_to_le16(MFI_PD_STATE_SYSTEM);
1112         } else {
1113             info->fw_state = cpu_to_le16(MFI_PD_STATE_ONLINE);
1114         }
1115     } else {
1116         info->fw_state = cpu_to_le16(MFI_PD_STATE_OFFLINE);
1117     }
1118 
1119     info->ref.v.device_id = cpu_to_le16(pd_id);
1120     info->state.ddf.pd_type = cpu_to_le16(MFI_PD_DDF_TYPE_IN_VD|
1121                                           MFI_PD_DDF_TYPE_INTF_SAS);
1122     blk_get_geometry(sdev->conf.blk, &pd_size);
1123     info->raw_size = cpu_to_le64(pd_size);
1124     info->non_coerced_size = cpu_to_le64(pd_size);
1125     info->coerced_size = cpu_to_le64(pd_size);
1126     info->encl_device_id = 0xFFFF;
1127     info->slot_number = (sdev->id & 0xFF);
1128     info->path_info.count = 1;
1129     info->path_info.sas_addr[0] =
1130         cpu_to_le64(megasas_get_sata_addr(pd_id));
1131     info->connected_port_bitmap = 0x1;
1132     info->device_speed = 1;
1133     info->link_speed = 1;
1134     dma_buf_read(cmd->iov_buf, dcmd_size, &residual, &cmd->qsg,
1135                  MEMTXATTRS_UNSPECIFIED);
1136     cmd->iov_size -= residual;
1137     g_free(cmd->iov_buf);
1138     cmd->iov_size = dcmd_size - residual;
1139     cmd->iov_buf = NULL;
1140     return MFI_STAT_OK;
1141 }
1142 
1143 static int megasas_dcmd_pd_get_info(MegasasState *s, MegasasCmd *cmd)
1144 {
1145     size_t dcmd_size = sizeof(struct mfi_pd_info);
1146     uint16_t pd_id;
1147     uint8_t target_id, lun_id;
1148     SCSIDevice *sdev = NULL;
1149     int retval = MFI_STAT_DEVICE_NOT_FOUND;
1150 
1151     if (cmd->iov_size < dcmd_size) {
1152         return MFI_STAT_INVALID_PARAMETER;
1153     }
1154 
1155     /* mbox0 has the ID */
1156     pd_id = le16_to_cpu(cmd->frame->dcmd.mbox[0]);
1157     target_id = (pd_id >> 8) & 0xFF;
1158     lun_id = pd_id & 0xFF;
1159     sdev = scsi_device_find(&s->bus, 0, target_id, lun_id);
1160     trace_megasas_dcmd_pd_get_info(cmd->index, pd_id);
1161 
1162     if (sdev) {
1163         /* Submit inquiry */
1164         retval = megasas_pd_get_info_submit(sdev, pd_id, cmd);
1165     }
1166 
1167     return retval;
1168 }
1169 
1170 static int megasas_dcmd_ld_get_list(MegasasState *s, MegasasCmd *cmd)
1171 {
1172     struct mfi_ld_list info;
1173     size_t dcmd_size = sizeof(info);
1174     dma_addr_t residual;
1175     uint32_t num_ld_disks = 0, max_ld_disks;
1176     uint64_t ld_size;
1177     BusChild *kid;
1178 
1179     memset(&info, 0, dcmd_size);
1180     if (cmd->iov_size > dcmd_size) {
1181         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
1182                                             dcmd_size);
1183         return MFI_STAT_INVALID_PARAMETER;
1184     }
1185 
1186     max_ld_disks = (cmd->iov_size - 8) / 16;
1187     if (megasas_is_jbod(s)) {
1188         max_ld_disks = 0;
1189     }
1190     if (max_ld_disks > MFI_MAX_LD) {
1191         max_ld_disks = MFI_MAX_LD;
1192     }
1193     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
1194         SCSIDevice *sdev = SCSI_DEVICE(kid->child);
1195 
1196         if (num_ld_disks >= max_ld_disks) {
1197             break;
1198         }
1199         /* Logical device size is in blocks */
1200         blk_get_geometry(sdev->conf.blk, &ld_size);
1201         info.ld_list[num_ld_disks].ld.v.target_id = sdev->id;
1202         info.ld_list[num_ld_disks].state = MFI_LD_STATE_OPTIMAL;
1203         info.ld_list[num_ld_disks].size = cpu_to_le64(ld_size);
1204         num_ld_disks++;
1205     }
1206     info.ld_count = cpu_to_le32(num_ld_disks);
1207     trace_megasas_dcmd_ld_get_list(cmd->index, num_ld_disks, max_ld_disks);
1208 
1209     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
1210                  MEMTXATTRS_UNSPECIFIED);
1211     cmd->iov_size = dcmd_size - residual;
1212     return MFI_STAT_OK;
1213 }
1214 
1215 static int megasas_dcmd_ld_list_query(MegasasState *s, MegasasCmd *cmd)
1216 {
1217     uint16_t flags;
1218     struct mfi_ld_targetid_list info;
1219     size_t dcmd_size = sizeof(info);
1220     dma_addr_t residual;
1221     uint32_t num_ld_disks = 0, max_ld_disks = s->fw_luns;
1222     BusChild *kid;
1223 
1224     /* mbox0 contains flags */
1225     flags = le16_to_cpu(cmd->frame->dcmd.mbox[0]);
1226     trace_megasas_dcmd_ld_list_query(cmd->index, flags);
1227     if (flags != MR_LD_QUERY_TYPE_ALL &&
1228         flags != MR_LD_QUERY_TYPE_EXPOSED_TO_HOST) {
1229         max_ld_disks = 0;
1230     }
1231 
1232     memset(&info, 0, dcmd_size);
1233     if (cmd->iov_size < 12) {
1234         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
1235                                             dcmd_size);
1236         return MFI_STAT_INVALID_PARAMETER;
1237     }
1238     dcmd_size = sizeof(uint32_t) * 2 + 3;
1239     max_ld_disks = cmd->iov_size - dcmd_size;
1240     if (megasas_is_jbod(s)) {
1241         max_ld_disks = 0;
1242     }
1243     if (max_ld_disks > MFI_MAX_LD) {
1244         max_ld_disks = MFI_MAX_LD;
1245     }
1246     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
1247         SCSIDevice *sdev = SCSI_DEVICE(kid->child);
1248 
1249         if (num_ld_disks >= max_ld_disks) {
1250             break;
1251         }
1252         info.targetid[num_ld_disks] = sdev->lun;
1253         num_ld_disks++;
1254         dcmd_size++;
1255     }
1256     info.ld_count = cpu_to_le32(num_ld_disks);
1257     info.size = dcmd_size;
1258     trace_megasas_dcmd_ld_get_list(cmd->index, num_ld_disks, max_ld_disks);
1259 
1260     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
1261                  MEMTXATTRS_UNSPECIFIED);
1262     cmd->iov_size = dcmd_size - residual;
1263     return MFI_STAT_OK;
1264 }
1265 
1266 static int megasas_ld_get_info_submit(SCSIDevice *sdev, int lun,
1267                                       MegasasCmd *cmd)
1268 {
1269     struct mfi_ld_info *info = cmd->iov_buf;
1270     size_t dcmd_size = sizeof(struct mfi_ld_info);
1271     uint8_t cdb[6];
1272     ssize_t len;
1273     dma_addr_t residual;
1274     uint16_t sdev_id = ((sdev->id & 0xFF) << 8) | (lun & 0xFF);
1275     uint64_t ld_size;
1276 
1277     if (!cmd->iov_buf) {
1278         cmd->iov_buf = g_malloc0(dcmd_size);
1279         info = cmd->iov_buf;
1280         megasas_setup_inquiry(cdb, 0x83, sizeof(info->vpd_page83));
1281         cmd->req = scsi_req_new(sdev, cmd->index, lun, cdb, cmd);
1282         if (!cmd->req) {
1283             trace_megasas_dcmd_req_alloc_failed(cmd->index,
1284                                                 "LD get info vpd inquiry");
1285             g_free(cmd->iov_buf);
1286             cmd->iov_buf = NULL;
1287             return MFI_STAT_FLASH_ALLOC_FAIL;
1288         }
1289         trace_megasas_dcmd_internal_submit(cmd->index,
1290                                            "LD get info vpd inquiry", lun);
1291         len = scsi_req_enqueue(cmd->req);
1292         if (len > 0) {
1293             cmd->iov_size = len;
1294             scsi_req_continue(cmd->req);
1295         }
1296         return MFI_STAT_INVALID_STATUS;
1297     }
1298 
1299     info->ld_config.params.state = MFI_LD_STATE_OPTIMAL;
1300     info->ld_config.properties.ld.v.target_id = lun;
1301     info->ld_config.params.stripe_size = 3;
1302     info->ld_config.params.num_drives = 1;
1303     info->ld_config.params.is_consistent = 1;
1304     /* Logical device size is in blocks */
1305     blk_get_geometry(sdev->conf.blk, &ld_size);
1306     info->size = cpu_to_le64(ld_size);
1307     memset(info->ld_config.span, 0, sizeof(info->ld_config.span));
1308     info->ld_config.span[0].start_block = 0;
1309     info->ld_config.span[0].num_blocks = info->size;
1310     info->ld_config.span[0].array_ref = cpu_to_le16(sdev_id);
1311 
1312     dma_buf_read(cmd->iov_buf, dcmd_size, &residual, &cmd->qsg,
1313                  MEMTXATTRS_UNSPECIFIED);
1314     g_free(cmd->iov_buf);
1315     cmd->iov_size = dcmd_size - residual;
1316     cmd->iov_buf = NULL;
1317     return MFI_STAT_OK;
1318 }
1319 
1320 static int megasas_dcmd_ld_get_info(MegasasState *s, MegasasCmd *cmd)
1321 {
1322     struct mfi_ld_info info;
1323     size_t dcmd_size = sizeof(info);
1324     uint16_t ld_id;
1325     uint32_t max_ld_disks = s->fw_luns;
1326     SCSIDevice *sdev = NULL;
1327     int retval = MFI_STAT_DEVICE_NOT_FOUND;
1328 
1329     if (cmd->iov_size < dcmd_size) {
1330         return MFI_STAT_INVALID_PARAMETER;
1331     }
1332 
1333     /* mbox0 has the ID */
1334     ld_id = le16_to_cpu(cmd->frame->dcmd.mbox[0]);
1335     trace_megasas_dcmd_ld_get_info(cmd->index, ld_id);
1336 
1337     if (megasas_is_jbod(s)) {
1338         return MFI_STAT_DEVICE_NOT_FOUND;
1339     }
1340 
1341     if (ld_id < max_ld_disks) {
1342         sdev = scsi_device_find(&s->bus, 0, ld_id, 0);
1343     }
1344 
1345     if (sdev) {
1346         retval = megasas_ld_get_info_submit(sdev, ld_id, cmd);
1347     }
1348 
1349     return retval;
1350 }
1351 
1352 static int megasas_dcmd_cfg_read(MegasasState *s, MegasasCmd *cmd)
1353 {
1354     uint8_t data[4096] = { 0 };
1355     struct mfi_config_data *info;
1356     int num_pd_disks = 0, array_offset, ld_offset;
1357     BusChild *kid;
1358     dma_addr_t residual;
1359 
1360     if (cmd->iov_size > 4096) {
1361         return MFI_STAT_INVALID_PARAMETER;
1362     }
1363 
1364     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
1365         num_pd_disks++;
1366     }
1367     info = (struct mfi_config_data *)&data;
1368     /*
1369      * Array mapping:
1370      * - One array per SCSI device
1371      * - One logical drive per SCSI device
1372      *   spanning the entire device
1373      */
1374     info->array_count = num_pd_disks;
1375     info->array_size = sizeof(struct mfi_array) * num_pd_disks;
1376     info->log_drv_count = num_pd_disks;
1377     info->log_drv_size = sizeof(struct mfi_ld_config) * num_pd_disks;
1378     info->spares_count = 0;
1379     info->spares_size = sizeof(struct mfi_spare);
1380     info->size = sizeof(struct mfi_config_data) + info->array_size +
1381         info->log_drv_size;
1382     if (info->size > 4096) {
1383         return MFI_STAT_INVALID_PARAMETER;
1384     }
1385 
1386     array_offset = sizeof(struct mfi_config_data);
1387     ld_offset = array_offset + sizeof(struct mfi_array) * num_pd_disks;
1388 
1389     QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
1390         SCSIDevice *sdev = SCSI_DEVICE(kid->child);
1391         uint16_t sdev_id = ((sdev->id & 0xFF) << 8) | (sdev->lun & 0xFF);
1392         struct mfi_array *array;
1393         struct mfi_ld_config *ld;
1394         uint64_t pd_size;
1395         int i;
1396 
1397         array = (struct mfi_array *)(data + array_offset);
1398         blk_get_geometry(sdev->conf.blk, &pd_size);
1399         array->size = cpu_to_le64(pd_size);
1400         array->num_drives = 1;
1401         array->array_ref = cpu_to_le16(sdev_id);
1402         array->pd[0].ref.v.device_id = cpu_to_le16(sdev_id);
1403         array->pd[0].ref.v.seq_num = 0;
1404         array->pd[0].fw_state = MFI_PD_STATE_ONLINE;
1405         array->pd[0].encl.pd = 0xFF;
1406         array->pd[0].encl.slot = (sdev->id & 0xFF);
1407         for (i = 1; i < MFI_MAX_ROW_SIZE; i++) {
1408             array->pd[i].ref.v.device_id = 0xFFFF;
1409             array->pd[i].ref.v.seq_num = 0;
1410             array->pd[i].fw_state = MFI_PD_STATE_UNCONFIGURED_GOOD;
1411             array->pd[i].encl.pd = 0xFF;
1412             array->pd[i].encl.slot = 0xFF;
1413         }
1414         array_offset += sizeof(struct mfi_array);
1415         ld = (struct mfi_ld_config *)(data + ld_offset);
1416         memset(ld, 0, sizeof(struct mfi_ld_config));
1417         ld->properties.ld.v.target_id = sdev->id;
1418         ld->properties.default_cache_policy = MR_LD_CACHE_READ_AHEAD |
1419             MR_LD_CACHE_READ_ADAPTIVE;
1420         ld->properties.current_cache_policy = MR_LD_CACHE_READ_AHEAD |
1421             MR_LD_CACHE_READ_ADAPTIVE;
1422         ld->params.state = MFI_LD_STATE_OPTIMAL;
1423         ld->params.stripe_size = 3;
1424         ld->params.num_drives = 1;
1425         ld->params.span_depth = 1;
1426         ld->params.is_consistent = 1;
1427         ld->span[0].start_block = 0;
1428         ld->span[0].num_blocks = cpu_to_le64(pd_size);
1429         ld->span[0].array_ref = cpu_to_le16(sdev_id);
1430         ld_offset += sizeof(struct mfi_ld_config);
1431     }
1432 
1433     dma_buf_read(data, info->size, &residual, &cmd->qsg,
1434                  MEMTXATTRS_UNSPECIFIED);
1435     cmd->iov_size -= residual;
1436     return MFI_STAT_OK;
1437 }
1438 
1439 static int megasas_dcmd_get_properties(MegasasState *s, MegasasCmd *cmd)
1440 {
1441     struct mfi_ctrl_props info;
1442     size_t dcmd_size = sizeof(info);
1443     dma_addr_t residual;
1444 
1445     memset(&info, 0x0, dcmd_size);
1446     if (cmd->iov_size < dcmd_size) {
1447         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
1448                                             dcmd_size);
1449         return MFI_STAT_INVALID_PARAMETER;
1450     }
1451     info.pred_fail_poll_interval = cpu_to_le16(300);
1452     info.intr_throttle_cnt = cpu_to_le16(16);
1453     info.intr_throttle_timeout = cpu_to_le16(50);
1454     info.rebuild_rate = 30;
1455     info.patrol_read_rate = 30;
1456     info.bgi_rate = 30;
1457     info.cc_rate = 30;
1458     info.recon_rate = 30;
1459     info.cache_flush_interval = 4;
1460     info.spinup_drv_cnt = 2;
1461     info.spinup_delay = 6;
1462     info.ecc_bucket_size = 15;
1463     info.ecc_bucket_leak_rate = cpu_to_le16(1440);
1464     info.expose_encl_devices = 1;
1465 
1466     dma_buf_read(&info, dcmd_size, &residual, &cmd->qsg,
1467                  MEMTXATTRS_UNSPECIFIED);
1468     cmd->iov_size -= residual;
1469     return MFI_STAT_OK;
1470 }
1471 
1472 static int megasas_cache_flush(MegasasState *s, MegasasCmd *cmd)
1473 {
1474     blk_drain_all();
1475     return MFI_STAT_OK;
1476 }
1477 
1478 static int megasas_ctrl_shutdown(MegasasState *s, MegasasCmd *cmd)
1479 {
1480     s->fw_state = MFI_FWSTATE_READY;
1481     return MFI_STAT_OK;
1482 }
1483 
1484 /* Some implementations use CLUSTER RESET LD to simulate a device reset */
1485 static int megasas_cluster_reset_ld(MegasasState *s, MegasasCmd *cmd)
1486 {
1487     uint16_t target_id;
1488     int i;
1489 
1490     /* mbox0 contains the device index */
1491     target_id = le16_to_cpu(cmd->frame->dcmd.mbox[0]);
1492     trace_megasas_dcmd_reset_ld(cmd->index, target_id);
1493     for (i = 0; i < s->fw_cmds; i++) {
1494         MegasasCmd *tmp_cmd = &s->frames[i];
1495         if (tmp_cmd->req && tmp_cmd->req->dev->id == target_id) {
1496             SCSIDevice *d = tmp_cmd->req->dev;
1497             qdev_reset_all(&d->qdev);
1498         }
1499     }
1500     return MFI_STAT_OK;
1501 }
1502 
1503 static int megasas_dcmd_set_properties(MegasasState *s, MegasasCmd *cmd)
1504 {
1505     struct mfi_ctrl_props info;
1506     size_t dcmd_size = sizeof(info);
1507 
1508     if (cmd->iov_size < dcmd_size) {
1509         trace_megasas_dcmd_invalid_xfer_len(cmd->index, cmd->iov_size,
1510                                             dcmd_size);
1511         return MFI_STAT_INVALID_PARAMETER;
1512     }
1513     dma_buf_write(&info, dcmd_size, NULL, &cmd->qsg, MEMTXATTRS_UNSPECIFIED);
1514     trace_megasas_dcmd_unsupported(cmd->index, cmd->iov_size);
1515     return MFI_STAT_OK;
1516 }
1517 
1518 static int megasas_dcmd_dummy(MegasasState *s, MegasasCmd *cmd)
1519 {
1520     trace_megasas_dcmd_dummy(cmd->index, cmd->iov_size);
1521     return MFI_STAT_OK;
1522 }
1523 
1524 static const struct dcmd_cmd_tbl_t {
1525     int opcode;
1526     const char *desc;
1527     int (*func)(MegasasState *s, MegasasCmd *cmd);
1528 } dcmd_cmd_tbl[] = {
1529     { MFI_DCMD_CTRL_MFI_HOST_MEM_ALLOC, "CTRL_HOST_MEM_ALLOC",
1530       megasas_dcmd_dummy },
1531     { MFI_DCMD_CTRL_GET_INFO, "CTRL_GET_INFO",
1532       megasas_ctrl_get_info },
1533     { MFI_DCMD_CTRL_GET_PROPERTIES, "CTRL_GET_PROPERTIES",
1534       megasas_dcmd_get_properties },
1535     { MFI_DCMD_CTRL_SET_PROPERTIES, "CTRL_SET_PROPERTIES",
1536       megasas_dcmd_set_properties },
1537     { MFI_DCMD_CTRL_ALARM_GET, "CTRL_ALARM_GET",
1538       megasas_dcmd_dummy },
1539     { MFI_DCMD_CTRL_ALARM_ENABLE, "CTRL_ALARM_ENABLE",
1540       megasas_dcmd_dummy },
1541     { MFI_DCMD_CTRL_ALARM_DISABLE, "CTRL_ALARM_DISABLE",
1542       megasas_dcmd_dummy },
1543     { MFI_DCMD_CTRL_ALARM_SILENCE, "CTRL_ALARM_SILENCE",
1544       megasas_dcmd_dummy },
1545     { MFI_DCMD_CTRL_ALARM_TEST, "CTRL_ALARM_TEST",
1546       megasas_dcmd_dummy },
1547     { MFI_DCMD_CTRL_EVENT_GETINFO, "CTRL_EVENT_GETINFO",
1548       megasas_event_info },
1549     { MFI_DCMD_CTRL_EVENT_GET, "CTRL_EVENT_GET",
1550       megasas_dcmd_dummy },
1551     { MFI_DCMD_CTRL_EVENT_WAIT, "CTRL_EVENT_WAIT",
1552       megasas_event_wait },
1553     { MFI_DCMD_CTRL_SHUTDOWN, "CTRL_SHUTDOWN",
1554       megasas_ctrl_shutdown },
1555     { MFI_DCMD_HIBERNATE_STANDBY, "CTRL_STANDBY",
1556       megasas_dcmd_dummy },
1557     { MFI_DCMD_CTRL_GET_TIME, "CTRL_GET_TIME",
1558       megasas_dcmd_get_fw_time },
1559     { MFI_DCMD_CTRL_SET_TIME, "CTRL_SET_TIME",
1560       megasas_dcmd_set_fw_time },
1561     { MFI_DCMD_CTRL_BIOS_DATA_GET, "CTRL_BIOS_DATA_GET",
1562       megasas_dcmd_get_bios_info },
1563     { MFI_DCMD_CTRL_FACTORY_DEFAULTS, "CTRL_FACTORY_DEFAULTS",
1564       megasas_dcmd_dummy },
1565     { MFI_DCMD_CTRL_MFC_DEFAULTS_GET, "CTRL_MFC_DEFAULTS_GET",
1566       megasas_mfc_get_defaults },
1567     { MFI_DCMD_CTRL_MFC_DEFAULTS_SET, "CTRL_MFC_DEFAULTS_SET",
1568       megasas_dcmd_dummy },
1569     { MFI_DCMD_CTRL_CACHE_FLUSH, "CTRL_CACHE_FLUSH",
1570       megasas_cache_flush },
1571     { MFI_DCMD_PD_GET_LIST, "PD_GET_LIST",
1572       megasas_dcmd_pd_get_list },
1573     { MFI_DCMD_PD_LIST_QUERY, "PD_LIST_QUERY",
1574       megasas_dcmd_pd_list_query },
1575     { MFI_DCMD_PD_GET_INFO, "PD_GET_INFO",
1576       megasas_dcmd_pd_get_info },
1577     { MFI_DCMD_PD_STATE_SET, "PD_STATE_SET",
1578       megasas_dcmd_dummy },
1579     { MFI_DCMD_PD_REBUILD, "PD_REBUILD",
1580       megasas_dcmd_dummy },
1581     { MFI_DCMD_PD_BLINK, "PD_BLINK",
1582       megasas_dcmd_dummy },
1583     { MFI_DCMD_PD_UNBLINK, "PD_UNBLINK",
1584       megasas_dcmd_dummy },
1585     { MFI_DCMD_LD_GET_LIST, "LD_GET_LIST",
1586       megasas_dcmd_ld_get_list},
1587     { MFI_DCMD_LD_LIST_QUERY, "LD_LIST_QUERY",
1588       megasas_dcmd_ld_list_query },
1589     { MFI_DCMD_LD_GET_INFO, "LD_GET_INFO",
1590       megasas_dcmd_ld_get_info },
1591     { MFI_DCMD_LD_GET_PROP, "LD_GET_PROP",
1592       megasas_dcmd_dummy },
1593     { MFI_DCMD_LD_SET_PROP, "LD_SET_PROP",
1594       megasas_dcmd_dummy },
1595     { MFI_DCMD_LD_DELETE, "LD_DELETE",
1596       megasas_dcmd_dummy },
1597     { MFI_DCMD_CFG_READ, "CFG_READ",
1598       megasas_dcmd_cfg_read },
1599     { MFI_DCMD_CFG_ADD, "CFG_ADD",
1600       megasas_dcmd_dummy },
1601     { MFI_DCMD_CFG_CLEAR, "CFG_CLEAR",
1602       megasas_dcmd_dummy },
1603     { MFI_DCMD_CFG_FOREIGN_READ, "CFG_FOREIGN_READ",
1604       megasas_dcmd_dummy },
1605     { MFI_DCMD_CFG_FOREIGN_IMPORT, "CFG_FOREIGN_IMPORT",
1606       megasas_dcmd_dummy },
1607     { MFI_DCMD_BBU_STATUS, "BBU_STATUS",
1608       megasas_dcmd_dummy },
1609     { MFI_DCMD_BBU_CAPACITY_INFO, "BBU_CAPACITY_INFO",
1610       megasas_dcmd_dummy },
1611     { MFI_DCMD_BBU_DESIGN_INFO, "BBU_DESIGN_INFO",
1612       megasas_dcmd_dummy },
1613     { MFI_DCMD_BBU_PROP_GET, "BBU_PROP_GET",
1614       megasas_dcmd_dummy },
1615     { MFI_DCMD_CLUSTER, "CLUSTER",
1616       megasas_dcmd_dummy },
1617     { MFI_DCMD_CLUSTER_RESET_ALL, "CLUSTER_RESET_ALL",
1618       megasas_dcmd_dummy },
1619     { MFI_DCMD_CLUSTER_RESET_LD, "CLUSTER_RESET_LD",
1620       megasas_cluster_reset_ld },
1621     { -1, NULL, NULL }
1622 };
1623 
1624 static int megasas_handle_dcmd(MegasasState *s, MegasasCmd *cmd)
1625 {
1626     int retval = 0;
1627     size_t len;
1628     const struct dcmd_cmd_tbl_t *cmdptr = dcmd_cmd_tbl;
1629 
1630     cmd->dcmd_opcode = le32_to_cpu(cmd->frame->dcmd.opcode);
1631     trace_megasas_handle_dcmd(cmd->index, cmd->dcmd_opcode);
1632     if (megasas_map_dcmd(s, cmd) < 0) {
1633         return MFI_STAT_MEMORY_NOT_AVAILABLE;
1634     }
1635     while (cmdptr->opcode != -1 && cmdptr->opcode != cmd->dcmd_opcode) {
1636         cmdptr++;
1637     }
1638     len = cmd->iov_size;
1639     if (cmdptr->opcode == -1) {
1640         trace_megasas_dcmd_unhandled(cmd->index, cmd->dcmd_opcode, len);
1641         retval = megasas_dcmd_dummy(s, cmd);
1642     } else {
1643         trace_megasas_dcmd_enter(cmd->index, cmdptr->desc, len);
1644         retval = cmdptr->func(s, cmd);
1645     }
1646     if (retval != MFI_STAT_INVALID_STATUS) {
1647         megasas_finish_dcmd(cmd, len);
1648     }
1649     return retval;
1650 }
1651 
1652 static int megasas_finish_internal_dcmd(MegasasCmd *cmd,
1653                                         SCSIRequest *req, dma_addr_t residual)
1654 {
1655     int retval = MFI_STAT_OK;
1656     int lun = req->lun;
1657 
1658     trace_megasas_dcmd_internal_finish(cmd->index, cmd->dcmd_opcode, lun);
1659     cmd->iov_size -= residual;
1660     switch (cmd->dcmd_opcode) {
1661     case MFI_DCMD_PD_GET_INFO:
1662         retval = megasas_pd_get_info_submit(req->dev, lun, cmd);
1663         break;
1664     case MFI_DCMD_LD_GET_INFO:
1665         retval = megasas_ld_get_info_submit(req->dev, lun, cmd);
1666         break;
1667     default:
1668         trace_megasas_dcmd_internal_invalid(cmd->index, cmd->dcmd_opcode);
1669         retval = MFI_STAT_INVALID_DCMD;
1670         break;
1671     }
1672     if (retval != MFI_STAT_INVALID_STATUS) {
1673         megasas_finish_dcmd(cmd, cmd->iov_size);
1674     }
1675     return retval;
1676 }
1677 
1678 static int megasas_enqueue_req(MegasasCmd *cmd, bool is_write)
1679 {
1680     int len;
1681 
1682     len = scsi_req_enqueue(cmd->req);
1683     if (len < 0) {
1684         len = -len;
1685     }
1686     if (len > 0) {
1687         if (len > cmd->iov_size) {
1688             if (is_write) {
1689                 trace_megasas_iov_write_overflow(cmd->index, len,
1690                                                  cmd->iov_size);
1691             } else {
1692                 trace_megasas_iov_read_overflow(cmd->index, len,
1693                                                 cmd->iov_size);
1694             }
1695         }
1696         if (len < cmd->iov_size) {
1697             if (is_write) {
1698                 trace_megasas_iov_write_underflow(cmd->index, len,
1699                                                   cmd->iov_size);
1700             } else {
1701                 trace_megasas_iov_read_underflow(cmd->index, len,
1702                                                  cmd->iov_size);
1703             }
1704             cmd->iov_size = len;
1705         }
1706         scsi_req_continue(cmd->req);
1707     }
1708     return len;
1709 }
1710 
1711 static int megasas_handle_scsi(MegasasState *s, MegasasCmd *cmd,
1712                                int frame_cmd)
1713 {
1714     uint8_t *cdb;
1715     int target_id, lun_id, cdb_len;
1716     bool is_write;
1717     struct SCSIDevice *sdev = NULL;
1718     bool is_logical = (frame_cmd == MFI_CMD_LD_SCSI_IO);
1719 
1720     cdb = cmd->frame->pass.cdb;
1721     target_id = cmd->frame->header.target_id;
1722     lun_id = cmd->frame->header.lun_id;
1723     cdb_len = cmd->frame->header.cdb_len;
1724 
1725     if (is_logical) {
1726         if (target_id >= MFI_MAX_LD || lun_id != 0) {
1727             trace_megasas_scsi_target_not_present(
1728                 mfi_frame_desc(frame_cmd), is_logical, target_id, lun_id);
1729             return MFI_STAT_DEVICE_NOT_FOUND;
1730         }
1731     }
1732     sdev = scsi_device_find(&s->bus, 0, target_id, lun_id);
1733 
1734     cmd->iov_size = le32_to_cpu(cmd->frame->header.data_len);
1735     trace_megasas_handle_scsi(mfi_frame_desc(frame_cmd), is_logical,
1736                               target_id, lun_id, sdev, cmd->iov_size);
1737 
1738     if (!sdev || (megasas_is_jbod(s) && is_logical)) {
1739         trace_megasas_scsi_target_not_present(
1740             mfi_frame_desc(frame_cmd), is_logical, target_id, lun_id);
1741         return MFI_STAT_DEVICE_NOT_FOUND;
1742     }
1743 
1744     if (cdb_len > 16) {
1745         trace_megasas_scsi_invalid_cdb_len(
1746                 mfi_frame_desc(frame_cmd), is_logical,
1747                 target_id, lun_id, cdb_len);
1748         megasas_write_sense(cmd, SENSE_CODE(INVALID_OPCODE));
1749         cmd->frame->header.scsi_status = CHECK_CONDITION;
1750         s->event_count++;
1751         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1752     }
1753 
1754     if (megasas_map_sgl(s, cmd, &cmd->frame->pass.sgl)) {
1755         megasas_write_sense(cmd, SENSE_CODE(TARGET_FAILURE));
1756         cmd->frame->header.scsi_status = CHECK_CONDITION;
1757         s->event_count++;
1758         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1759     }
1760 
1761     cmd->req = scsi_req_new(sdev, cmd->index, lun_id, cdb, cmd);
1762     if (!cmd->req) {
1763         trace_megasas_scsi_req_alloc_failed(
1764                 mfi_frame_desc(frame_cmd), target_id, lun_id);
1765         megasas_write_sense(cmd, SENSE_CODE(NO_SENSE));
1766         cmd->frame->header.scsi_status = BUSY;
1767         s->event_count++;
1768         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1769     }
1770 
1771     is_write = (cmd->req->cmd.mode == SCSI_XFER_TO_DEV);
1772     if (cmd->iov_size) {
1773         if (is_write) {
1774             trace_megasas_scsi_write_start(cmd->index, cmd->iov_size);
1775         } else {
1776             trace_megasas_scsi_read_start(cmd->index, cmd->iov_size);
1777         }
1778     } else {
1779         trace_megasas_scsi_nodata(cmd->index);
1780     }
1781     megasas_enqueue_req(cmd, is_write);
1782     return MFI_STAT_INVALID_STATUS;
1783 }
1784 
1785 static int megasas_handle_io(MegasasState *s, MegasasCmd *cmd, int frame_cmd)
1786 {
1787     uint32_t lba_count, lba_start_hi, lba_start_lo;
1788     uint64_t lba_start;
1789     bool is_write = (frame_cmd == MFI_CMD_LD_WRITE);
1790     uint8_t cdb[16];
1791     int len;
1792     struct SCSIDevice *sdev = NULL;
1793     int target_id, lun_id, cdb_len;
1794 
1795     lba_count = le32_to_cpu(cmd->frame->io.header.data_len);
1796     lba_start_lo = le32_to_cpu(cmd->frame->io.lba_lo);
1797     lba_start_hi = le32_to_cpu(cmd->frame->io.lba_hi);
1798     lba_start = ((uint64_t)lba_start_hi << 32) | lba_start_lo;
1799 
1800     target_id = cmd->frame->header.target_id;
1801     lun_id = cmd->frame->header.lun_id;
1802     cdb_len = cmd->frame->header.cdb_len;
1803 
1804     if (target_id < MFI_MAX_LD && lun_id == 0) {
1805         sdev = scsi_device_find(&s->bus, 0, target_id, lun_id);
1806     }
1807 
1808     trace_megasas_handle_io(cmd->index,
1809                             mfi_frame_desc(frame_cmd), target_id, lun_id,
1810                             (unsigned long)lba_start, (unsigned long)lba_count);
1811     if (!sdev) {
1812         trace_megasas_io_target_not_present(cmd->index,
1813             mfi_frame_desc(frame_cmd), target_id, lun_id);
1814         return MFI_STAT_DEVICE_NOT_FOUND;
1815     }
1816 
1817     if (cdb_len > 16) {
1818         trace_megasas_scsi_invalid_cdb_len(
1819             mfi_frame_desc(frame_cmd), 1, target_id, lun_id, cdb_len);
1820         megasas_write_sense(cmd, SENSE_CODE(INVALID_OPCODE));
1821         cmd->frame->header.scsi_status = CHECK_CONDITION;
1822         s->event_count++;
1823         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1824     }
1825 
1826     cmd->iov_size = lba_count * sdev->blocksize;
1827     if (megasas_map_sgl(s, cmd, &cmd->frame->io.sgl)) {
1828         megasas_write_sense(cmd, SENSE_CODE(TARGET_FAILURE));
1829         cmd->frame->header.scsi_status = CHECK_CONDITION;
1830         s->event_count++;
1831         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1832     }
1833 
1834     megasas_encode_lba(cdb, lba_start, lba_count, is_write);
1835     cmd->req = scsi_req_new(sdev, cmd->index,
1836                             lun_id, cdb, cmd);
1837     if (!cmd->req) {
1838         trace_megasas_scsi_req_alloc_failed(
1839             mfi_frame_desc(frame_cmd), target_id, lun_id);
1840         megasas_write_sense(cmd, SENSE_CODE(NO_SENSE));
1841         cmd->frame->header.scsi_status = BUSY;
1842         s->event_count++;
1843         return MFI_STAT_SCSI_DONE_WITH_ERROR;
1844     }
1845     len = megasas_enqueue_req(cmd, is_write);
1846     if (len > 0) {
1847         if (is_write) {
1848             trace_megasas_io_write_start(cmd->index, lba_start, lba_count, len);
1849         } else {
1850             trace_megasas_io_read_start(cmd->index, lba_start, lba_count, len);
1851         }
1852     }
1853     return MFI_STAT_INVALID_STATUS;
1854 }
1855 
1856 static QEMUSGList *megasas_get_sg_list(SCSIRequest *req)
1857 {
1858     MegasasCmd *cmd = req->hba_private;
1859 
1860     if (cmd->dcmd_opcode != -1) {
1861         return NULL;
1862     } else {
1863         return &cmd->qsg;
1864     }
1865 }
1866 
1867 static void megasas_xfer_complete(SCSIRequest *req, uint32_t len)
1868 {
1869     MegasasCmd *cmd = req->hba_private;
1870     uint8_t *buf;
1871 
1872     trace_megasas_io_complete(cmd->index, len);
1873 
1874     if (cmd->dcmd_opcode != -1) {
1875         scsi_req_continue(req);
1876         return;
1877     }
1878 
1879     buf = scsi_req_get_buf(req);
1880     if (cmd->dcmd_opcode == MFI_DCMD_PD_GET_INFO && cmd->iov_buf) {
1881         struct mfi_pd_info *info = cmd->iov_buf;
1882 
1883         if (info->inquiry_data[0] == 0x7f) {
1884             memset(info->inquiry_data, 0, sizeof(info->inquiry_data));
1885             memcpy(info->inquiry_data, buf, len);
1886         } else if (info->vpd_page83[0] == 0x7f) {
1887             memset(info->vpd_page83, 0, sizeof(info->vpd_page83));
1888             memcpy(info->vpd_page83, buf, len);
1889         }
1890         scsi_req_continue(req);
1891     } else if (cmd->dcmd_opcode == MFI_DCMD_LD_GET_INFO) {
1892         struct mfi_ld_info *info = cmd->iov_buf;
1893 
1894         if (cmd->iov_buf) {
1895             memcpy(info->vpd_page83, buf, sizeof(info->vpd_page83));
1896             scsi_req_continue(req);
1897         }
1898     }
1899 }
1900 
1901 static void megasas_command_complete(SCSIRequest *req, size_t residual)
1902 {
1903     MegasasCmd *cmd = req->hba_private;
1904     uint8_t cmd_status = MFI_STAT_OK;
1905 
1906     trace_megasas_command_complete(cmd->index, req->status, residual);
1907 
1908     if (req->io_canceled) {
1909         return;
1910     }
1911 
1912     if (cmd->dcmd_opcode != -1) {
1913         /*
1914          * Internal command complete
1915          */
1916         cmd_status = megasas_finish_internal_dcmd(cmd, req, residual);
1917         if (cmd_status == MFI_STAT_INVALID_STATUS) {
1918             return;
1919         }
1920     } else {
1921         trace_megasas_scsi_complete(cmd->index, req->status,
1922                                     cmd->iov_size, req->cmd.xfer);
1923         if (req->status != GOOD) {
1924             cmd_status = MFI_STAT_SCSI_DONE_WITH_ERROR;
1925         }
1926         if (req->status == CHECK_CONDITION) {
1927             megasas_copy_sense(cmd);
1928         }
1929 
1930         cmd->frame->header.scsi_status = req->status;
1931     }
1932     cmd->frame->header.cmd_status = cmd_status;
1933     megasas_complete_command(cmd);
1934 }
1935 
1936 static void megasas_command_cancelled(SCSIRequest *req)
1937 {
1938     MegasasCmd *cmd = req->hba_private;
1939 
1940     if (!cmd) {
1941         return;
1942     }
1943     cmd->frame->header.cmd_status = MFI_STAT_SCSI_IO_FAILED;
1944     megasas_complete_command(cmd);
1945 }
1946 
1947 static int megasas_handle_abort(MegasasState *s, MegasasCmd *cmd)
1948 {
1949     uint64_t abort_ctx = le64_to_cpu(cmd->frame->abort.abort_context);
1950     hwaddr abort_addr, addr_hi, addr_lo;
1951     MegasasCmd *abort_cmd;
1952 
1953     addr_hi = le32_to_cpu(cmd->frame->abort.abort_mfi_addr_hi);
1954     addr_lo = le32_to_cpu(cmd->frame->abort.abort_mfi_addr_lo);
1955     abort_addr = ((uint64_t)addr_hi << 32) | addr_lo;
1956 
1957     abort_cmd = megasas_lookup_frame(s, abort_addr);
1958     if (!abort_cmd) {
1959         trace_megasas_abort_no_cmd(cmd->index, abort_ctx);
1960         s->event_count++;
1961         return MFI_STAT_OK;
1962     }
1963     if (!megasas_use_queue64(s)) {
1964         abort_ctx &= (uint64_t)0xFFFFFFFF;
1965     }
1966     if (abort_cmd->context != abort_ctx) {
1967         trace_megasas_abort_invalid_context(cmd->index, abort_cmd->context,
1968                                             abort_cmd->index);
1969         s->event_count++;
1970         return MFI_STAT_ABORT_NOT_POSSIBLE;
1971     }
1972     trace_megasas_abort_frame(cmd->index, abort_cmd->index);
1973     megasas_abort_command(abort_cmd);
1974     if (!s->event_cmd || abort_cmd != s->event_cmd) {
1975         s->event_cmd = NULL;
1976     }
1977     s->event_count++;
1978     return MFI_STAT_OK;
1979 }
1980 
1981 static void megasas_handle_frame(MegasasState *s, uint64_t frame_addr,
1982                                  uint32_t frame_count)
1983 {
1984     uint8_t frame_status = MFI_STAT_INVALID_CMD;
1985     uint64_t frame_context;
1986     int frame_cmd;
1987     MegasasCmd *cmd;
1988 
1989     /*
1990      * Always read 64bit context, top bits will be
1991      * masked out if required in megasas_enqueue_frame()
1992      */
1993     frame_context = megasas_frame_get_context(s, frame_addr);
1994 
1995     cmd = megasas_enqueue_frame(s, frame_addr, frame_context, frame_count);
1996     if (!cmd) {
1997         /* reply queue full */
1998         trace_megasas_frame_busy(frame_addr);
1999         megasas_frame_set_scsi_status(s, frame_addr, BUSY);
2000         megasas_frame_set_cmd_status(s, frame_addr, MFI_STAT_SCSI_DONE_WITH_ERROR);
2001         megasas_complete_frame(s, frame_context);
2002         s->event_count++;
2003         return;
2004     }
2005     frame_cmd = cmd->frame->header.frame_cmd;
2006     switch (frame_cmd) {
2007     case MFI_CMD_INIT:
2008         frame_status = megasas_init_firmware(s, cmd);
2009         break;
2010     case MFI_CMD_DCMD:
2011         frame_status = megasas_handle_dcmd(s, cmd);
2012         break;
2013     case MFI_CMD_ABORT:
2014         frame_status = megasas_handle_abort(s, cmd);
2015         break;
2016     case MFI_CMD_PD_SCSI_IO:
2017     case MFI_CMD_LD_SCSI_IO:
2018         frame_status = megasas_handle_scsi(s, cmd, frame_cmd);
2019         break;
2020     case MFI_CMD_LD_READ:
2021     case MFI_CMD_LD_WRITE:
2022         frame_status = megasas_handle_io(s, cmd, frame_cmd);
2023         break;
2024     default:
2025         trace_megasas_unhandled_frame_cmd(cmd->index, frame_cmd);
2026         s->event_count++;
2027         break;
2028     }
2029     if (frame_status != MFI_STAT_INVALID_STATUS) {
2030         if (cmd->frame) {
2031             cmd->frame->header.cmd_status = frame_status;
2032         } else {
2033             megasas_frame_set_cmd_status(s, frame_addr, frame_status);
2034         }
2035         megasas_unmap_frame(s, cmd);
2036         megasas_complete_frame(s, cmd->context);
2037     }
2038 }
2039 
2040 static uint64_t megasas_mmio_read(void *opaque, hwaddr addr,
2041                                   unsigned size)
2042 {
2043     MegasasState *s = opaque;
2044     PCIDevice *pci_dev = PCI_DEVICE(s);
2045     MegasasBaseClass *base_class = MEGASAS_GET_CLASS(s);
2046     uint32_t retval = 0;
2047 
2048     switch (addr) {
2049     case MFI_IDB:
2050         retval = 0;
2051         trace_megasas_mmio_readl("MFI_IDB", retval);
2052         break;
2053     case MFI_OMSG0:
2054     case MFI_OSP0:
2055         retval = (msix_present(pci_dev) ? MFI_FWSTATE_MSIX_SUPPORTED : 0) |
2056             (s->fw_state & MFI_FWSTATE_MASK) |
2057             ((s->fw_sge & 0xff) << 16) |
2058             (s->fw_cmds & 0xFFFF);
2059         trace_megasas_mmio_readl(addr == MFI_OMSG0 ? "MFI_OMSG0" : "MFI_OSP0",
2060                                  retval);
2061         break;
2062     case MFI_OSTS:
2063         if (megasas_intr_enabled(s) && s->doorbell) {
2064             retval = base_class->osts;
2065         }
2066         trace_megasas_mmio_readl("MFI_OSTS", retval);
2067         break;
2068     case MFI_OMSK:
2069         retval = s->intr_mask;
2070         trace_megasas_mmio_readl("MFI_OMSK", retval);
2071         break;
2072     case MFI_ODCR0:
2073         retval = s->doorbell ? 1 : 0;
2074         trace_megasas_mmio_readl("MFI_ODCR0", retval);
2075         break;
2076     case MFI_DIAG:
2077         retval = s->diag;
2078         trace_megasas_mmio_readl("MFI_DIAG", retval);
2079         break;
2080     case MFI_OSP1:
2081         retval = 15;
2082         trace_megasas_mmio_readl("MFI_OSP1", retval);
2083         break;
2084     default:
2085         trace_megasas_mmio_invalid_readl(addr);
2086         break;
2087     }
2088     return retval;
2089 }
2090 
2091 static int adp_reset_seq[] = {0x00, 0x04, 0x0b, 0x02, 0x07, 0x0d};
2092 
2093 static void megasas_mmio_write(void *opaque, hwaddr addr,
2094                                uint64_t val, unsigned size)
2095 {
2096     MegasasState *s = opaque;
2097     PCIDevice *pci_dev = PCI_DEVICE(s);
2098     uint64_t frame_addr;
2099     uint32_t frame_count;
2100     int i;
2101 
2102     switch (addr) {
2103     case MFI_IDB:
2104         trace_megasas_mmio_writel("MFI_IDB", val);
2105         if (val & MFI_FWINIT_ABORT) {
2106             /* Abort all pending cmds */
2107             for (i = 0; i < s->fw_cmds; i++) {
2108                 megasas_abort_command(&s->frames[i]);
2109             }
2110         }
2111         if (val & MFI_FWINIT_READY) {
2112             /* move to FW READY */
2113             megasas_soft_reset(s);
2114         }
2115         if (val & MFI_FWINIT_MFIMODE) {
2116             /* discard MFIs */
2117         }
2118         if (val & MFI_FWINIT_STOP_ADP) {
2119             /* Terminal error, stop processing */
2120             s->fw_state = MFI_FWSTATE_FAULT;
2121         }
2122         break;
2123     case MFI_OMSK:
2124         trace_megasas_mmio_writel("MFI_OMSK", val);
2125         s->intr_mask = val;
2126         if (!megasas_intr_enabled(s) &&
2127             !msi_enabled(pci_dev) &&
2128             !msix_enabled(pci_dev)) {
2129             trace_megasas_irq_lower();
2130             pci_irq_deassert(pci_dev);
2131         }
2132         if (megasas_intr_enabled(s)) {
2133             if (msix_enabled(pci_dev)) {
2134                 trace_megasas_msix_enabled(0);
2135             } else if (msi_enabled(pci_dev)) {
2136                 trace_megasas_msi_enabled(0);
2137             } else {
2138                 trace_megasas_intr_enabled();
2139             }
2140         } else {
2141             trace_megasas_intr_disabled();
2142             megasas_soft_reset(s);
2143         }
2144         break;
2145     case MFI_ODCR0:
2146         trace_megasas_mmio_writel("MFI_ODCR0", val);
2147         s->doorbell = 0;
2148         if (megasas_intr_enabled(s)) {
2149             if (!msix_enabled(pci_dev) && !msi_enabled(pci_dev)) {
2150                 trace_megasas_irq_lower();
2151                 pci_irq_deassert(pci_dev);
2152             }
2153         }
2154         break;
2155     case MFI_IQPH:
2156         trace_megasas_mmio_writel("MFI_IQPH", val);
2157         /* Received high 32 bits of a 64 bit MFI frame address */
2158         s->frame_hi = val;
2159         break;
2160     case MFI_IQPL:
2161         trace_megasas_mmio_writel("MFI_IQPL", val);
2162         /* Received low 32 bits of a 64 bit MFI frame address */
2163         /* Fallthrough */
2164     case MFI_IQP:
2165         if (addr == MFI_IQP) {
2166             trace_megasas_mmio_writel("MFI_IQP", val);
2167             /* Received 64 bit MFI frame address */
2168             s->frame_hi = 0;
2169         }
2170         frame_addr = (val & ~0x1F);
2171         /* Add possible 64 bit offset */
2172         frame_addr |= ((uint64_t)s->frame_hi << 32);
2173         s->frame_hi = 0;
2174         frame_count = (val >> 1) & 0xF;
2175         megasas_handle_frame(s, frame_addr, frame_count);
2176         break;
2177     case MFI_SEQ:
2178         trace_megasas_mmio_writel("MFI_SEQ", val);
2179         /* Magic sequence to start ADP reset */
2180         if (adp_reset_seq[s->adp_reset++] == val) {
2181             if (s->adp_reset == 6) {
2182                 s->adp_reset = 0;
2183                 s->diag = MFI_DIAG_WRITE_ENABLE;
2184             }
2185         } else {
2186             s->adp_reset = 0;
2187             s->diag = 0;
2188         }
2189         break;
2190     case MFI_DIAG:
2191         trace_megasas_mmio_writel("MFI_DIAG", val);
2192         /* ADP reset */
2193         if ((s->diag & MFI_DIAG_WRITE_ENABLE) &&
2194             (val & MFI_DIAG_RESET_ADP)) {
2195             s->diag |= MFI_DIAG_RESET_ADP;
2196             megasas_soft_reset(s);
2197             s->adp_reset = 0;
2198             s->diag = 0;
2199         }
2200         break;
2201     default:
2202         trace_megasas_mmio_invalid_writel(addr, val);
2203         break;
2204     }
2205 }
2206 
2207 static const MemoryRegionOps megasas_mmio_ops = {
2208     .read = megasas_mmio_read,
2209     .write = megasas_mmio_write,
2210     .endianness = DEVICE_LITTLE_ENDIAN,
2211     .impl = {
2212         .min_access_size = 8,
2213         .max_access_size = 8,
2214     }
2215 };
2216 
2217 static uint64_t megasas_port_read(void *opaque, hwaddr addr,
2218                                   unsigned size)
2219 {
2220     return megasas_mmio_read(opaque, addr & 0xff, size);
2221 }
2222 
2223 static void megasas_port_write(void *opaque, hwaddr addr,
2224                                uint64_t val, unsigned size)
2225 {
2226     megasas_mmio_write(opaque, addr & 0xff, val, size);
2227 }
2228 
2229 static const MemoryRegionOps megasas_port_ops = {
2230     .read = megasas_port_read,
2231     .write = megasas_port_write,
2232     .endianness = DEVICE_LITTLE_ENDIAN,
2233     .impl = {
2234         .min_access_size = 4,
2235         .max_access_size = 4,
2236     }
2237 };
2238 
2239 static uint64_t megasas_queue_read(void *opaque, hwaddr addr,
2240                                    unsigned size)
2241 {
2242     return 0;
2243 }
2244 
2245 static void megasas_queue_write(void *opaque, hwaddr addr,
2246                                uint64_t val, unsigned size)
2247 {
2248     return;
2249 }
2250 
2251 static const MemoryRegionOps megasas_queue_ops = {
2252     .read = megasas_queue_read,
2253     .write = megasas_queue_write,
2254     .endianness = DEVICE_LITTLE_ENDIAN,
2255     .impl = {
2256         .min_access_size = 8,
2257         .max_access_size = 8,
2258     }
2259 };
2260 
2261 static void megasas_soft_reset(MegasasState *s)
2262 {
2263     int i;
2264     MegasasCmd *cmd;
2265 
2266     trace_megasas_reset(s->fw_state);
2267     for (i = 0; i < s->fw_cmds; i++) {
2268         cmd = &s->frames[i];
2269         megasas_abort_command(cmd);
2270     }
2271     if (s->fw_state == MFI_FWSTATE_READY) {
2272         BusChild *kid;
2273 
2274         /*
2275          * The EFI firmware doesn't handle UA,
2276          * so we need to clear the Power On/Reset UA
2277          * after the initial reset.
2278          */
2279         QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
2280             SCSIDevice *sdev = SCSI_DEVICE(kid->child);
2281 
2282             sdev->unit_attention = SENSE_CODE(NO_SENSE);
2283             scsi_device_unit_attention_reported(sdev);
2284         }
2285     }
2286     megasas_reset_frames(s);
2287     s->reply_queue_len = s->fw_cmds;
2288     s->reply_queue_pa = 0;
2289     s->consumer_pa = 0;
2290     s->producer_pa = 0;
2291     s->fw_state = MFI_FWSTATE_READY;
2292     s->doorbell = 0;
2293     s->intr_mask = MEGASAS_INTR_DISABLED_MASK;
2294     s->frame_hi = 0;
2295     s->flags &= ~MEGASAS_MASK_USE_QUEUE64;
2296     s->event_count++;
2297     s->boot_event = s->event_count;
2298 }
2299 
2300 static void megasas_scsi_reset(DeviceState *dev)
2301 {
2302     MegasasState *s = MEGASAS(dev);
2303 
2304     megasas_soft_reset(s);
2305 }
2306 
2307 static const VMStateDescription vmstate_megasas_gen1 = {
2308     .name = "megasas",
2309     .version_id = 0,
2310     .minimum_version_id = 0,
2311     .fields = (VMStateField[]) {
2312         VMSTATE_PCI_DEVICE(parent_obj, MegasasState),
2313         VMSTATE_MSIX(parent_obj, MegasasState),
2314 
2315         VMSTATE_UINT32(fw_state, MegasasState),
2316         VMSTATE_UINT32(intr_mask, MegasasState),
2317         VMSTATE_UINT32(doorbell, MegasasState),
2318         VMSTATE_UINT64(reply_queue_pa, MegasasState),
2319         VMSTATE_UINT64(consumer_pa, MegasasState),
2320         VMSTATE_UINT64(producer_pa, MegasasState),
2321         VMSTATE_END_OF_LIST()
2322     }
2323 };
2324 
2325 static const VMStateDescription vmstate_megasas_gen2 = {
2326     .name = "megasas-gen2",
2327     .version_id = 0,
2328     .minimum_version_id = 0,
2329     .minimum_version_id_old = 0,
2330     .fields      = (VMStateField[]) {
2331         VMSTATE_PCI_DEVICE(parent_obj, MegasasState),
2332         VMSTATE_MSIX(parent_obj, MegasasState),
2333 
2334         VMSTATE_UINT32(fw_state, MegasasState),
2335         VMSTATE_UINT32(intr_mask, MegasasState),
2336         VMSTATE_UINT32(doorbell, MegasasState),
2337         VMSTATE_UINT64(reply_queue_pa, MegasasState),
2338         VMSTATE_UINT64(consumer_pa, MegasasState),
2339         VMSTATE_UINT64(producer_pa, MegasasState),
2340         VMSTATE_END_OF_LIST()
2341     }
2342 };
2343 
2344 static void megasas_scsi_uninit(PCIDevice *d)
2345 {
2346     MegasasState *s = MEGASAS(d);
2347 
2348     if (megasas_use_msix(s)) {
2349         msix_uninit(d, &s->mmio_io, &s->mmio_io);
2350     }
2351     msi_uninit(d);
2352 }
2353 
2354 static const struct SCSIBusInfo megasas_scsi_info = {
2355     .tcq = true,
2356     .max_target = MFI_MAX_LD,
2357     .max_lun = 255,
2358 
2359     .transfer_data = megasas_xfer_complete,
2360     .get_sg_list = megasas_get_sg_list,
2361     .complete = megasas_command_complete,
2362     .cancel = megasas_command_cancelled,
2363 };
2364 
2365 static void megasas_scsi_realize(PCIDevice *dev, Error **errp)
2366 {
2367     MegasasState *s = MEGASAS(dev);
2368     MegasasBaseClass *b = MEGASAS_GET_CLASS(s);
2369     uint8_t *pci_conf;
2370     int i, bar_type;
2371     Error *err = NULL;
2372     int ret;
2373 
2374     pci_conf = dev->config;
2375 
2376     /* PCI latency timer = 0 */
2377     pci_conf[PCI_LATENCY_TIMER] = 0;
2378     /* Interrupt pin 1 */
2379     pci_conf[PCI_INTERRUPT_PIN] = 0x01;
2380 
2381     if (s->msi != ON_OFF_AUTO_OFF) {
2382         ret = msi_init(dev, 0x50, 1, true, false, &err);
2383         /* Any error other than -ENOTSUP(board's MSI support is broken)
2384          * is a programming error */
2385         assert(!ret || ret == -ENOTSUP);
2386         if (ret && s->msi == ON_OFF_AUTO_ON) {
2387             /* Can't satisfy user's explicit msi=on request, fail */
2388             error_append_hint(&err, "You have to use msi=auto (default) or "
2389                     "msi=off with this machine type.\n");
2390             error_propagate(errp, err);
2391             return;
2392         } else if (ret) {
2393             /* With msi=auto, we fall back to MSI off silently */
2394             s->msi = ON_OFF_AUTO_OFF;
2395             error_free(err);
2396         }
2397     }
2398 
2399     memory_region_init_io(&s->mmio_io, OBJECT(s), &megasas_mmio_ops, s,
2400                           "megasas-mmio", 0x4000);
2401     memory_region_init_io(&s->port_io, OBJECT(s), &megasas_port_ops, s,
2402                           "megasas-io", 256);
2403     memory_region_init_io(&s->queue_io, OBJECT(s), &megasas_queue_ops, s,
2404                           "megasas-queue", 0x40000);
2405 
2406     if (megasas_use_msix(s) &&
2407         msix_init(dev, 15, &s->mmio_io, b->mmio_bar, 0x2000,
2408                   &s->mmio_io, b->mmio_bar, 0x3800, 0x68, NULL)) {
2409         /* TODO: check msix_init's error, and should fail on msix=on */
2410         s->msix = ON_OFF_AUTO_OFF;
2411     }
2412 
2413     if (pci_is_express(dev)) {
2414         pcie_endpoint_cap_init(dev, 0xa0);
2415     }
2416 
2417     bar_type = PCI_BASE_ADDRESS_SPACE_MEMORY | PCI_BASE_ADDRESS_MEM_TYPE_64;
2418     pci_register_bar(dev, b->ioport_bar,
2419                      PCI_BASE_ADDRESS_SPACE_IO, &s->port_io);
2420     pci_register_bar(dev, b->mmio_bar, bar_type, &s->mmio_io);
2421     pci_register_bar(dev, 3, bar_type, &s->queue_io);
2422 
2423     if (megasas_use_msix(s)) {
2424         msix_vector_use(dev, 0);
2425     }
2426 
2427     s->fw_state = MFI_FWSTATE_READY;
2428     if (!s->sas_addr) {
2429         s->sas_addr = ((NAA_LOCALLY_ASSIGNED_ID << 24) |
2430                        IEEE_COMPANY_LOCALLY_ASSIGNED) << 36;
2431         s->sas_addr |= pci_dev_bus_num(dev) << 16;
2432         s->sas_addr |= PCI_SLOT(dev->devfn) << 8;
2433         s->sas_addr |= PCI_FUNC(dev->devfn);
2434     }
2435     if (!s->hba_serial) {
2436         s->hba_serial = g_strdup(MEGASAS_HBA_SERIAL);
2437     }
2438     if (s->fw_sge >= MEGASAS_MAX_SGE - MFI_PASS_FRAME_SIZE) {
2439         s->fw_sge = MEGASAS_MAX_SGE - MFI_PASS_FRAME_SIZE;
2440     } else if (s->fw_sge >= 128 - MFI_PASS_FRAME_SIZE) {
2441         s->fw_sge = 128 - MFI_PASS_FRAME_SIZE;
2442     } else {
2443         s->fw_sge = 64 - MFI_PASS_FRAME_SIZE;
2444     }
2445     if (s->fw_cmds > MEGASAS_MAX_FRAMES) {
2446         s->fw_cmds = MEGASAS_MAX_FRAMES;
2447     }
2448     trace_megasas_init(s->fw_sge, s->fw_cmds,
2449                        megasas_is_jbod(s) ? "jbod" : "raid");
2450 
2451     if (megasas_is_jbod(s)) {
2452         s->fw_luns = MFI_MAX_SYS_PDS;
2453     } else {
2454         s->fw_luns = MFI_MAX_LD;
2455     }
2456     s->producer_pa = 0;
2457     s->consumer_pa = 0;
2458     for (i = 0; i < s->fw_cmds; i++) {
2459         s->frames[i].index = i;
2460         s->frames[i].context = -1;
2461         s->frames[i].pa = 0;
2462         s->frames[i].state = s;
2463     }
2464 
2465     scsi_bus_init(&s->bus, sizeof(s->bus), DEVICE(dev), &megasas_scsi_info);
2466 }
2467 
2468 static Property megasas_properties_gen1[] = {
2469     DEFINE_PROP_UINT32("max_sge", MegasasState, fw_sge,
2470                        MEGASAS_DEFAULT_SGE),
2471     DEFINE_PROP_UINT32("max_cmds", MegasasState, fw_cmds,
2472                        MEGASAS_DEFAULT_FRAMES),
2473     DEFINE_PROP_STRING("hba_serial", MegasasState, hba_serial),
2474     DEFINE_PROP_UINT64("sas_address", MegasasState, sas_addr, 0),
2475     DEFINE_PROP_ON_OFF_AUTO("msi", MegasasState, msi, ON_OFF_AUTO_AUTO),
2476     DEFINE_PROP_ON_OFF_AUTO("msix", MegasasState, msix, ON_OFF_AUTO_AUTO),
2477     DEFINE_PROP_BIT("use_jbod", MegasasState, flags,
2478                     MEGASAS_FLAG_USE_JBOD, false),
2479     DEFINE_PROP_END_OF_LIST(),
2480 };
2481 
2482 static Property megasas_properties_gen2[] = {
2483     DEFINE_PROP_UINT32("max_sge", MegasasState, fw_sge,
2484                        MEGASAS_DEFAULT_SGE),
2485     DEFINE_PROP_UINT32("max_cmds", MegasasState, fw_cmds,
2486                        MEGASAS_GEN2_DEFAULT_FRAMES),
2487     DEFINE_PROP_STRING("hba_serial", MegasasState, hba_serial),
2488     DEFINE_PROP_UINT64("sas_address", MegasasState, sas_addr, 0),
2489     DEFINE_PROP_ON_OFF_AUTO("msi", MegasasState, msi, ON_OFF_AUTO_AUTO),
2490     DEFINE_PROP_ON_OFF_AUTO("msix", MegasasState, msix, ON_OFF_AUTO_AUTO),
2491     DEFINE_PROP_BIT("use_jbod", MegasasState, flags,
2492                     MEGASAS_FLAG_USE_JBOD, false),
2493     DEFINE_PROP_END_OF_LIST(),
2494 };
2495 
2496 typedef struct MegasasInfo {
2497     const char *name;
2498     const char *desc;
2499     const char *product_name;
2500     const char *product_version;
2501     uint16_t device_id;
2502     uint16_t subsystem_id;
2503     int ioport_bar;
2504     int mmio_bar;
2505     int osts;
2506     const VMStateDescription *vmsd;
2507     Property *props;
2508     InterfaceInfo *interfaces;
2509 } MegasasInfo;
2510 
2511 static struct MegasasInfo megasas_devices[] = {
2512     {
2513         .name = TYPE_MEGASAS_GEN1,
2514         .desc = "LSI MegaRAID SAS 1078",
2515         .product_name = "LSI MegaRAID SAS 8708EM2",
2516         .product_version = MEGASAS_VERSION_GEN1,
2517         .device_id = PCI_DEVICE_ID_LSI_SAS1078,
2518         .subsystem_id = 0x1013,
2519         .ioport_bar = 2,
2520         .mmio_bar = 0,
2521         .osts = MFI_1078_RM | 1,
2522         .vmsd = &vmstate_megasas_gen1,
2523         .props = megasas_properties_gen1,
2524         .interfaces = (InterfaceInfo[]) {
2525             { INTERFACE_CONVENTIONAL_PCI_DEVICE },
2526             { },
2527         },
2528     },{
2529         .name = TYPE_MEGASAS_GEN2,
2530         .desc = "LSI MegaRAID SAS 2108",
2531         .product_name = "LSI MegaRAID SAS 9260-8i",
2532         .product_version = MEGASAS_VERSION_GEN2,
2533         .device_id = PCI_DEVICE_ID_LSI_SAS0079,
2534         .subsystem_id = 0x9261,
2535         .ioport_bar = 0,
2536         .mmio_bar = 1,
2537         .osts = MFI_GEN2_RM,
2538         .vmsd = &vmstate_megasas_gen2,
2539         .props = megasas_properties_gen2,
2540         .interfaces = (InterfaceInfo[]) {
2541             { INTERFACE_PCIE_DEVICE },
2542             { }
2543         },
2544     }
2545 };
2546 
2547 static void megasas_class_init(ObjectClass *oc, void *data)
2548 {
2549     DeviceClass *dc = DEVICE_CLASS(oc);
2550     PCIDeviceClass *pc = PCI_DEVICE_CLASS(oc);
2551     MegasasBaseClass *e = MEGASAS_CLASS(oc);
2552     const MegasasInfo *info = data;
2553 
2554     pc->realize = megasas_scsi_realize;
2555     pc->exit = megasas_scsi_uninit;
2556     pc->vendor_id = PCI_VENDOR_ID_LSI_LOGIC;
2557     pc->device_id = info->device_id;
2558     pc->subsystem_vendor_id = PCI_VENDOR_ID_LSI_LOGIC;
2559     pc->subsystem_id = info->subsystem_id;
2560     pc->class_id = PCI_CLASS_STORAGE_RAID;
2561     e->mmio_bar = info->mmio_bar;
2562     e->ioport_bar = info->ioport_bar;
2563     e->osts = info->osts;
2564     e->product_name = info->product_name;
2565     e->product_version = info->product_version;
2566     device_class_set_props(dc, info->props);
2567     dc->reset = megasas_scsi_reset;
2568     dc->vmsd = info->vmsd;
2569     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
2570     dc->desc = info->desc;
2571 }
2572 
2573 static const TypeInfo megasas_info = {
2574     .name  = TYPE_MEGASAS_BASE,
2575     .parent = TYPE_PCI_DEVICE,
2576     .instance_size = sizeof(MegasasState),
2577     .class_size = sizeof(MegasasBaseClass),
2578     .abstract = true,
2579 };
2580 
2581 static void megasas_register_types(void)
2582 {
2583     int i;
2584 
2585     type_register_static(&megasas_info);
2586     for (i = 0; i < ARRAY_SIZE(megasas_devices); i++) {
2587         const MegasasInfo *info = &megasas_devices[i];
2588         TypeInfo type_info = {};
2589 
2590         type_info.name = info->name;
2591         type_info.parent = TYPE_MEGASAS_BASE;
2592         type_info.class_data = (void *)info;
2593         type_info.class_init = megasas_class_init;
2594         type_info.interfaces = info->interfaces;
2595 
2596         type_register(&type_info);
2597     }
2598 }
2599 
2600 type_init(megasas_register_types)
2601