2 * Driver for Western Digital WD7193, WD7197 and WD7296 SCSI cards
3 * Copyright 2013 Ondrej Zary
6 * Aaron Dewell <dewell@woods.net>
7 * Gaerti <Juergen.Gaertner@mbox.si.uni-hannover.de>
9 * HW documentation available in book:
11 * SPIDER Command Protocol
13 * SCSI Storage Products (MCP)
14 * Western Digital Corporation
17 * http://web.archive.org/web/20070717175254/http://sun1.rrzn.uni-hannover.de/gaertner.juergen/wd719x/Linux/Docu/Spider/
22 * 1. SCSI command is transformed to SCB (Spider Control Block) by the
23 * queuecommand function.
24 * 2. The address of the SCB is stored in a list to be able to access it, if
25 * something goes wrong.
26 * 3. The address of the SCB is written to the Controller, which loads the SCB
27 * via BM-DMA and processes it.
28 * 4. After it has finished, it generates an interrupt, and sets registers.
31 * - abort/reset functions
37 #include <linux/interrupt.h>
38 #include <linux/module.h>
39 #include <linux/delay.h>
40 #include <linux/pci.h>
41 #include <linux/firmware.h>
42 #include <linux/eeprom_93cx6.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <scsi/scsi_device.h>
45 #include <scsi/scsi_host.h>
48 /* low-level register access */
49 static inline u8 wd719x_readb(struct wd719x *wd, u8 reg)
51 return ioread8(wd->base + reg);
54 static inline u32 wd719x_readl(struct wd719x *wd, u8 reg)
56 return ioread32(wd->base + reg);
59 static inline void wd719x_writeb(struct wd719x *wd, u8 reg, u8 val)
61 iowrite8(val, wd->base + reg);
64 static inline void wd719x_writew(struct wd719x *wd, u8 reg, u16 val)
66 iowrite16(val, wd->base + reg);
69 static inline void wd719x_writel(struct wd719x *wd, u8 reg, u32 val)
71 iowrite32(val, wd->base + reg);
74 /* wait until the command register is ready */
75 static inline int wd719x_wait_ready(struct wd719x *wd)
80 if (wd719x_readb(wd, WD719X_AMR_COMMAND) == WD719X_CMD_READY)
83 } while (i++ < WD719X_WAIT_FOR_CMD_READY);
85 dev_err(&wd->pdev->dev, "command register is not ready: 0x%02x\n",
86 wd719x_readb(wd, WD719X_AMR_COMMAND));
91 /* poll interrupt status register until command finishes */
92 static inline int wd719x_wait_done(struct wd719x *wd, int timeout)
97 status = wd719x_readb(wd, WD719X_AMR_INT_STATUS);
105 dev_err(&wd->pdev->dev, "direct command timed out\n");
109 if (status != WD719X_INT_NOERRORS) {
110 dev_err(&wd->pdev->dev, "direct command failed, status 0x%02x, SUE 0x%02x\n",
111 status, wd719x_readb(wd, WD719X_AMR_SCB_ERROR));
118 static int wd719x_direct_cmd(struct wd719x *wd, u8 opcode, u8 dev, u8 lun,
119 u8 tag, dma_addr_t data, int timeout)
123 /* clear interrupt status register (allow command register to clear) */
124 wd719x_writeb(wd, WD719X_AMR_INT_STATUS, WD719X_INT_NONE);
126 /* Wait for the Command register to become free */
127 if (wd719x_wait_ready(wd))
130 /* make sure we get NO interrupts */
131 dev |= WD719X_DISABLE_INT;
132 wd719x_writeb(wd, WD719X_AMR_CMD_PARAM, dev);
133 wd719x_writeb(wd, WD719X_AMR_CMD_PARAM_2, lun);
134 wd719x_writeb(wd, WD719X_AMR_CMD_PARAM_3, tag);
136 wd719x_writel(wd, WD719X_AMR_SCB_IN, data);
138 /* clear interrupt status register again */
139 wd719x_writeb(wd, WD719X_AMR_INT_STATUS, WD719X_INT_NONE);
141 /* Now, write the command */
142 wd719x_writeb(wd, WD719X_AMR_COMMAND, opcode);
144 if (timeout) /* wait for the command to complete */
145 ret = wd719x_wait_done(wd, timeout);
147 /* clear interrupt status register (clean up) */
148 if (opcode != WD719X_CMD_READ_FIRMVER)
149 wd719x_writeb(wd, WD719X_AMR_INT_STATUS, WD719X_INT_NONE);
154 static void wd719x_destroy(struct wd719x *wd)
156 struct wd719x_scb *scb;
159 if (wd719x_direct_cmd(wd, WD719X_CMD_SLEEP, 0, 0, 0, 0,
160 WD719X_WAIT_FOR_RISC))
161 dev_warn(&wd->pdev->dev, "RISC sleep command failed\n");
163 wd719x_writeb(wd, WD719X_PCI_MODE_SELECT, 0);
165 WARN_ON_ONCE(!list_empty(&wd->active_scbs));
168 list_for_each_entry(scb, &wd->free_scbs, list)
169 pci_free_consistent(wd->pdev, sizeof(struct wd719x_scb), scb,
171 /* free internal buffers */
172 pci_free_consistent(wd->pdev, wd->fw_size, wd->fw_virt, wd->fw_phys);
174 pci_free_consistent(wd->pdev, WD719X_HASH_TABLE_SIZE, wd->hash_virt,
176 wd->hash_virt = NULL;
177 pci_free_consistent(wd->pdev, sizeof(struct wd719x_host_param),
178 wd->params, wd->params_phys);
180 free_irq(wd->pdev->irq, wd);
183 /* finish a SCSI command, mark SCB (if any) as free, unmap buffers */
184 static void wd719x_finish_cmd(struct scsi_cmnd *cmd, int result)
186 struct wd719x *wd = shost_priv(cmd->device->host);
187 struct wd719x_scb *scb = (struct wd719x_scb *) cmd->host_scribble;
190 list_move(&scb->list, &wd->free_scbs);
191 dma_unmap_single(&wd->pdev->dev, cmd->SCp.dma_handle,
192 SCSI_SENSE_BUFFERSIZE, DMA_FROM_DEVICE);
195 cmd->result = result << 16;
199 /* Build a SCB and send it to the card */
200 static int wd719x_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *cmd)
204 struct wd719x_scb *scb;
205 struct wd719x *wd = shost_priv(sh);
208 cmd->host_scribble = NULL;
210 /* get a free SCB - either from existing ones or allocate a new one */
211 spin_lock_irqsave(wd->sh->host_lock, flags);
212 scb = list_first_entry_or_null(&wd->free_scbs, struct wd719x_scb, list);
214 list_del(&scb->list);
217 spin_unlock_irqrestore(wd->sh->host_lock, flags);
218 scb = pci_alloc_consistent(wd->pdev, sizeof(struct wd719x_scb),
220 spin_lock_irqsave(wd->sh->host_lock, flags);
222 dev_err(&wd->pdev->dev, "unable to allocate SCB\n");
223 wd719x_finish_cmd(cmd, DID_ERROR);
224 spin_unlock_irqrestore(wd->sh->host_lock, flags);
228 memset(scb, 0, sizeof(struct wd719x_scb));
229 list_add(&scb->list, &wd->active_scbs);
233 cmd->host_scribble = (char *) scb;
235 scb->CDB_tag = 0; /* Tagged queueing not supported yet */
236 scb->devid = cmd->device->id;
237 scb->lun = cmd->device->lun;
239 /* copy the command */
240 memcpy(scb->CDB, cmd->cmnd, cmd->cmd_len);
242 /* map sense buffer */
243 scb->sense_buf_length = SCSI_SENSE_BUFFERSIZE;
244 cmd->SCp.dma_handle = dma_map_single(&wd->pdev->dev, cmd->sense_buffer,
245 SCSI_SENSE_BUFFERSIZE, DMA_FROM_DEVICE);
246 scb->sense_buf = cpu_to_le32(cmd->SCp.dma_handle);
248 /* request autosense */
249 scb->SCB_options |= WD719X_SCB_FLAGS_AUTO_REQUEST_SENSE;
251 /* check direction */
252 if (cmd->sc_data_direction == DMA_TO_DEVICE)
253 scb->SCB_options |= WD719X_SCB_FLAGS_CHECK_DIRECTION
254 | WD719X_SCB_FLAGS_PCI_TO_SCSI;
255 else if (cmd->sc_data_direction == DMA_FROM_DEVICE)
256 scb->SCB_options |= WD719X_SCB_FLAGS_CHECK_DIRECTION;
259 count_sg = scsi_dma_map(cmd);
261 wd719x_finish_cmd(cmd, DID_ERROR);
262 spin_unlock_irqrestore(wd->sh->host_lock, flags);
265 BUG_ON(count_sg > WD719X_SG);
268 struct scatterlist *sg;
270 scb->data_length = cpu_to_le32(count_sg *
271 sizeof(struct wd719x_sglist));
272 scb->data_p = cpu_to_le32(scb->phys +
273 offsetof(struct wd719x_scb, sg_list));
275 scsi_for_each_sg(cmd, sg, count_sg, i) {
276 scb->sg_list[i].ptr = cpu_to_le32(sg_dma_address(sg));
277 scb->sg_list[i].length = cpu_to_le32(sg_dma_len(sg));
279 scb->SCB_options |= WD719X_SCB_FLAGS_DO_SCATTER_GATHER;
280 } else { /* zero length */
281 scb->data_length = 0;
285 /* check if the Command register is free */
286 if (wd719x_readb(wd, WD719X_AMR_COMMAND) != WD719X_CMD_READY) {
287 spin_unlock_irqrestore(wd->sh->host_lock, flags);
288 return SCSI_MLQUEUE_HOST_BUSY;
291 /* write pointer to the AMR */
292 wd719x_writel(wd, WD719X_AMR_SCB_IN, scb->phys);
293 /* send SCB opcode */
294 wd719x_writeb(wd, WD719X_AMR_COMMAND, WD719X_CMD_PROCESS_SCB);
296 spin_unlock_irqrestore(wd->sh->host_lock, flags);
301 static int wd719x_chip_init(struct wd719x *wd)
305 const struct firmware *fw_wcs, *fw_risc;
306 const char fwname_wcs[] = "wd719x-wcs.bin";
307 const char fwname_risc[] = "wd719x-risc.bin";
309 memset(wd->hash_virt, 0, WD719X_HASH_TABLE_SIZE);
311 /* WCS (sequencer) firmware */
312 ret = request_firmware(&fw_wcs, fwname_wcs, &wd->pdev->dev);
314 dev_err(&wd->pdev->dev, "Unable to load firmware %s: %d\n",
319 ret = request_firmware(&fw_risc, fwname_risc, &wd->pdev->dev);
321 dev_err(&wd->pdev->dev, "Unable to load firmware %s: %d\n",
323 release_firmware(fw_wcs);
326 wd->fw_size = ALIGN(fw_wcs->size, 4) + fw_risc->size;
329 wd->fw_virt = pci_alloc_consistent(wd->pdev, wd->fw_size,
333 goto wd719x_init_end;
336 /* make a fresh copy of WCS and RISC code */
337 memcpy(wd->fw_virt, fw_wcs->data, fw_wcs->size);
338 memcpy(wd->fw_virt + ALIGN(fw_wcs->size, 4), fw_risc->data,
341 /* Reset the Spider Chip and adapter itself */
342 wd719x_writeb(wd, WD719X_PCI_PORT_RESET, WD719X_PCI_RESET);
343 udelay(WD719X_WAIT_FOR_RISC);
344 /* Clear PIO mode bits set by BIOS */
345 wd719x_writeb(wd, WD719X_AMR_CMD_PARAM, 0);
346 /* ensure RISC is not running */
347 wd719x_writeb(wd, WD719X_PCI_MODE_SELECT, 0);
348 /* ensure command port is ready */
349 wd719x_writeb(wd, WD719X_AMR_COMMAND, 0);
350 if (wd719x_wait_ready(wd)) {
352 goto wd719x_init_end;
355 /* Transfer the first 2K words of RISC code to kick start the uP */
356 risc_init[0] = wd->fw_phys; /* WCS FW */
357 risc_init[1] = wd->fw_phys + ALIGN(fw_wcs->size, 4); /* RISC FW */
358 risc_init[2] = wd->hash_phys; /* hash table */
360 /* clear DMA status */
361 wd719x_writeb(wd, WD719X_PCI_CHANNEL2_3STATUS, 0);
363 /* address to read firmware from */
364 wd719x_writel(wd, WD719X_PCI_EXTERNAL_ADDR, risc_init[1]);
365 /* base address to write firmware to (on card) */
366 wd719x_writew(wd, WD719X_PCI_INTERNAL_ADDR, WD719X_PRAM_BASE_ADDR);
367 /* size: first 2K words */
368 wd719x_writew(wd, WD719X_PCI_DMA_TRANSFER_SIZE, 2048 * 2);
370 wd719x_writeb(wd, WD719X_PCI_CHANNEL2_3CMD, WD719X_START_CHANNEL2_3DMA);
372 /* wait for DMA to complete */
373 i = WD719X_WAIT_FOR_RISC;
375 u8 status = wd719x_readb(wd, WD719X_PCI_CHANNEL2_3STATUS);
376 if (status == WD719X_START_CHANNEL2_3DONE)
378 if (status == WD719X_START_CHANNEL2_3ABORT) {
379 dev_warn(&wd->pdev->dev, "RISC bootstrap failed: DMA aborted\n");
381 goto wd719x_init_end;
386 dev_warn(&wd->pdev->dev, "RISC bootstrap failed: DMA timeout\n");
388 goto wd719x_init_end;
391 /* firmware is loaded, now initialize and wake up the RISC */
392 /* write RISC initialization long words to Spider */
393 wd719x_writel(wd, WD719X_AMR_SCB_IN, risc_init[0]);
394 wd719x_writel(wd, WD719X_AMR_SCB_IN + 4, risc_init[1]);
395 wd719x_writel(wd, WD719X_AMR_SCB_IN + 8, risc_init[2]);
397 /* disable interrupts during initialization of RISC */
398 wd719x_writeb(wd, WD719X_AMR_CMD_PARAM, WD719X_DISABLE_INT);
400 /* issue INITIALIZE RISC comand */
401 wd719x_writeb(wd, WD719X_AMR_COMMAND, WD719X_CMD_INIT_RISC);
402 /* enable advanced mode (wake up RISC) */
403 wd719x_writeb(wd, WD719X_PCI_MODE_SELECT, WD719X_ENABLE_ADVANCE_MODE);
404 udelay(WD719X_WAIT_FOR_RISC);
406 ret = wd719x_wait_done(wd, WD719X_WAIT_FOR_RISC);
407 /* clear interrupt status register */
408 wd719x_writeb(wd, WD719X_AMR_INT_STATUS, WD719X_INT_NONE);
410 dev_warn(&wd->pdev->dev, "Unable to initialize RISC\n");
411 goto wd719x_init_end;
413 /* RISC is up and running */
415 /* Read FW version from RISC */
416 ret = wd719x_direct_cmd(wd, WD719X_CMD_READ_FIRMVER, 0, 0, 0, 0,
417 WD719X_WAIT_FOR_RISC);
419 dev_warn(&wd->pdev->dev, "Unable to read firmware version\n");
420 goto wd719x_init_end;
422 dev_info(&wd->pdev->dev, "RISC initialized with firmware version %.2x.%.2x\n",
423 wd719x_readb(wd, WD719X_AMR_SCB_OUT + 1),
424 wd719x_readb(wd, WD719X_AMR_SCB_OUT));
427 ret = wd719x_direct_cmd(wd, WD719X_CMD_BUSRESET, 0, 0, 0, 0,
428 WD719X_WAIT_FOR_SCSI_RESET);
430 dev_warn(&wd->pdev->dev, "SCSI bus reset failed\n");
431 goto wd719x_init_end;
434 /* use HostParameter structure to set Spider's Host Parameter Block */
435 ret = wd719x_direct_cmd(wd, WD719X_CMD_SET_PARAM, 0,
436 sizeof(struct wd719x_host_param), 0,
437 wd->params_phys, WD719X_WAIT_FOR_RISC);
439 dev_warn(&wd->pdev->dev, "Failed to set HOST PARAMETERS\n");
440 goto wd719x_init_end;
443 /* initiate SCAM (does nothing if disabled in BIOS) */
444 /* bug?: we should pass a mask of static IDs which we don't have */
445 ret = wd719x_direct_cmd(wd, WD719X_CMD_INIT_SCAM, 0, 0, 0, 0,
446 WD719X_WAIT_FOR_SCSI_RESET);
448 dev_warn(&wd->pdev->dev, "SCAM initialization failed\n");
449 goto wd719x_init_end;
452 /* clear AMR_BIOS_SHARE_INT register */
453 wd719x_writeb(wd, WD719X_AMR_BIOS_SHARE_INT, 0);
456 release_firmware(fw_wcs);
457 release_firmware(fw_risc);
462 static int wd719x_abort(struct scsi_cmnd *cmd)
466 struct wd719x_scb *scb = (struct wd719x_scb *)cmd->host_scribble;
467 struct wd719x *wd = shost_priv(cmd->device->host);
469 dev_info(&wd->pdev->dev, "abort command, tag: %x\n", cmd->tag);
471 action = /*cmd->tag ? WD719X_CMD_ABORT_TAG : */WD719X_CMD_ABORT;
473 spin_lock_irqsave(wd->sh->host_lock, flags);
474 result = wd719x_direct_cmd(wd, action, cmd->device->id,
475 cmd->device->lun, cmd->tag, scb->phys, 0);
476 spin_unlock_irqrestore(wd->sh->host_lock, flags);
483 static int wd719x_reset(struct scsi_cmnd *cmd, u8 opcode, u8 device)
487 struct wd719x *wd = shost_priv(cmd->device->host);
489 dev_info(&wd->pdev->dev, "%s reset requested\n",
490 (opcode == WD719X_CMD_BUSRESET) ? "bus" : "device");
492 spin_lock_irqsave(wd->sh->host_lock, flags);
493 result = wd719x_direct_cmd(wd, opcode, device, 0, 0, 0,
494 WD719X_WAIT_FOR_SCSI_RESET);
495 spin_unlock_irqrestore(wd->sh->host_lock, flags);
502 static int wd719x_dev_reset(struct scsi_cmnd *cmd)
504 return wd719x_reset(cmd, WD719X_CMD_RESET, cmd->device->id);
507 static int wd719x_bus_reset(struct scsi_cmnd *cmd)
509 return wd719x_reset(cmd, WD719X_CMD_BUSRESET, 0);
512 static int wd719x_host_reset(struct scsi_cmnd *cmd)
514 struct wd719x *wd = shost_priv(cmd->device->host);
515 struct wd719x_scb *scb, *tmp;
519 dev_info(&wd->pdev->dev, "host reset requested\n");
520 spin_lock_irqsave(wd->sh->host_lock, flags);
521 /* Try to reinit the RISC */
522 if (wd719x_chip_init(wd) == 0)
528 list_for_each_entry_safe(scb, tmp, &wd->active_scbs, list) {
529 struct scsi_cmnd *tmp_cmd = scb->cmd;
530 wd719x_finish_cmd(tmp_cmd, result);
532 spin_unlock_irqrestore(wd->sh->host_lock, flags);
537 static int wd719x_biosparam(struct scsi_device *sdev, struct block_device *bdev,
538 sector_t capacity, int geom[])
540 if (capacity >= 0x200000) {
541 geom[0] = 255; /* heads */
542 geom[1] = 63; /* sectors */
544 geom[0] = 64; /* heads */
545 geom[1] = 32; /* sectors */
547 geom[2] = sector_div(capacity, geom[0] * geom[1]); /* cylinders */
552 /* process a SCB-completion interrupt */
553 static inline void wd719x_interrupt_SCB(struct wd719x *wd,
554 union wd719x_regs regs,
555 struct wd719x_scb *scb)
557 struct scsi_cmnd *cmd;
560 /* now have to find result from card */
561 switch (regs.bytes.SUE) {
562 case WD719X_SUE_NOERRORS:
565 case WD719X_SUE_REJECTED:
566 dev_err(&wd->pdev->dev, "command rejected\n");
569 case WD719X_SUE_SCBQFULL:
570 dev_err(&wd->pdev->dev, "SCB queue is full\n");
573 case WD719X_SUE_TERM:
574 dev_dbg(&wd->pdev->dev, "SCB terminated by direct command\n");
575 result = DID_ABORT; /* or DID_RESET? */
577 case WD719X_SUE_CHAN1ABORT:
578 case WD719X_SUE_CHAN23ABORT:
580 dev_err(&wd->pdev->dev, "DMA abort\n");
582 case WD719X_SUE_CHAN1PAR:
583 case WD719X_SUE_CHAN23PAR:
585 dev_err(&wd->pdev->dev, "DMA parity error\n");
587 case WD719X_SUE_TIMEOUT:
588 result = DID_TIME_OUT;
589 dev_dbg(&wd->pdev->dev, "selection timeout\n");
591 case WD719X_SUE_RESET:
592 dev_dbg(&wd->pdev->dev, "bus reset occurred\n");
595 case WD719X_SUE_BUSERROR:
596 dev_dbg(&wd->pdev->dev, "SCSI bus error\n");
599 case WD719X_SUE_WRONGWAY:
600 dev_err(&wd->pdev->dev, "wrong data transfer direction\n");
603 case WD719X_SUE_BADPHASE:
604 dev_err(&wd->pdev->dev, "invalid SCSI phase\n");
607 case WD719X_SUE_TOOLONG:
608 dev_err(&wd->pdev->dev, "record too long\n");
611 case WD719X_SUE_BUSFREE:
612 dev_err(&wd->pdev->dev, "unexpected bus free\n");
613 result = DID_NO_CONNECT; /* or DID_ERROR ???*/
615 case WD719X_SUE_ARSDONE:
616 dev_dbg(&wd->pdev->dev, "auto request sense\n");
617 if (regs.bytes.SCSI == 0)
622 case WD719X_SUE_IGNORED:
623 dev_err(&wd->pdev->dev, "target id %d ignored command\n",
624 scb->cmd->device->id);
625 result = DID_NO_CONNECT;
627 case WD719X_SUE_WRONGTAGS:
628 dev_err(&wd->pdev->dev, "reversed tags\n");
631 case WD719X_SUE_BADTAGS:
632 dev_err(&wd->pdev->dev, "tag type not supported by target\n");
635 case WD719X_SUE_NOSCAMID:
636 dev_err(&wd->pdev->dev, "no SCAM soft ID available\n");
640 dev_warn(&wd->pdev->dev, "unknown SUE error code: 0x%x\n",
647 wd719x_finish_cmd(cmd, result);
650 static irqreturn_t wd719x_interrupt(int irq, void *dev_id)
652 struct wd719x *wd = dev_id;
653 union wd719x_regs regs;
657 spin_lock_irqsave(wd->sh->host_lock, flags);
658 /* read SCB pointer back from card */
659 SCB_out = wd719x_readl(wd, WD719X_AMR_SCB_OUT);
660 /* read all status info at once */
661 regs.all = cpu_to_le32(wd719x_readl(wd, WD719X_AMR_OP_CODE));
663 switch (regs.bytes.INT) {
664 case WD719X_INT_NONE:
665 spin_unlock_irqrestore(wd->sh->host_lock, flags);
667 case WD719X_INT_LINKNOSTATUS:
668 dev_err(&wd->pdev->dev, "linked command completed with no status\n");
670 case WD719X_INT_BADINT:
671 dev_err(&wd->pdev->dev, "unsolicited interrupt\n");
673 case WD719X_INT_NOERRORS:
674 case WD719X_INT_LINKNOERRORS:
675 case WD719X_INT_ERRORSLOGGED:
676 case WD719X_INT_SPIDERFAILED:
677 /* was the cmd completed a direct or SCB command? */
678 if (regs.bytes.OPC == WD719X_CMD_PROCESS_SCB) {
679 struct wd719x_scb *scb;
680 list_for_each_entry(scb, &wd->active_scbs, list)
681 if (SCB_out == scb->phys)
683 if (SCB_out == scb->phys)
684 wd719x_interrupt_SCB(wd, regs, scb);
686 dev_err(&wd->pdev->dev, "card returned invalid SCB pointer\n");
688 dev_warn(&wd->pdev->dev, "direct command 0x%x completed\n",
691 case WD719X_INT_PIOREADY:
692 dev_err(&wd->pdev->dev, "card indicates PIO data ready but we never use PIO\n");
693 /* interrupt will not be cleared until all data is read */
696 dev_err(&wd->pdev->dev, "unknown interrupt reason: %d\n",
700 /* clear interrupt so another can happen */
701 wd719x_writeb(wd, WD719X_AMR_INT_STATUS, WD719X_INT_NONE);
702 spin_unlock_irqrestore(wd->sh->host_lock, flags);
707 static void wd719x_eeprom_reg_read(struct eeprom_93cx6 *eeprom)
709 struct wd719x *wd = eeprom->data;
710 u8 reg = wd719x_readb(wd, WD719X_PCI_GPIO_DATA);
712 eeprom->reg_data_out = reg & WD719X_EE_DO;
715 static void wd719x_eeprom_reg_write(struct eeprom_93cx6 *eeprom)
717 struct wd719x *wd = eeprom->data;
720 if (eeprom->reg_data_in)
722 if (eeprom->reg_data_clock)
723 reg |= WD719X_EE_CLK;
724 if (eeprom->reg_chip_select)
727 wd719x_writeb(wd, WD719X_PCI_GPIO_DATA, reg);
730 /* read config from EEPROM so it can be downloaded by the RISC on (re-)init */
731 static void wd719x_read_eeprom(struct wd719x *wd)
733 struct eeprom_93cx6 eeprom;
735 struct wd719x_eeprom_header header;
738 eeprom.register_read = wd719x_eeprom_reg_read;
739 eeprom.register_write = wd719x_eeprom_reg_write;
740 eeprom.width = PCI_EEPROM_WIDTH_93C46;
742 /* set all outputs to low */
743 wd719x_writeb(wd, WD719X_PCI_GPIO_DATA, 0);
744 /* configure GPIO pins */
745 gpio = wd719x_readb(wd, WD719X_PCI_GPIO_CONTROL);
747 gpio &= (~(WD719X_EE_CLK | WD719X_EE_DI | WD719X_EE_CS));
749 gpio |= WD719X_EE_DO;
750 wd719x_writeb(wd, WD719X_PCI_GPIO_CONTROL, gpio);
752 /* read EEPROM header */
753 eeprom_93cx6_multireadb(&eeprom, 0, (u8 *)&header, sizeof(header));
755 if (header.sig1 == 'W' && header.sig2 == 'D')
756 eeprom_93cx6_multireadb(&eeprom, header.cfg_offset,
758 sizeof(struct wd719x_host_param));
759 else { /* default EEPROM values */
760 dev_warn(&wd->pdev->dev, "EEPROM signature is invalid (0x%02x 0x%02x), using default values\n",
761 header.sig1, header.sig2);
762 wd->params->ch_1_th = 0x10; /* 16 DWs = 64 B */
763 wd->params->scsi_conf = 0x4c; /* 48ma, spue, parity check */
764 wd->params->own_scsi_id = 0x07; /* ID 7, SCAM disabled */
765 wd->params->sel_timeout = 0x4d; /* 250 ms */
766 wd->params->sleep_timer = 0x01;
767 wd->params->cdb_size = cpu_to_le16(0x5555); /* all 6 B */
768 wd->params->scsi_pad = 0x1b;
769 if (wd->type == WD719X_TYPE_7193) /* narrow card - disable */
770 wd->params->wide = cpu_to_le32(0x00000000);
771 else /* initiate & respond to WIDE messages */
772 wd->params->wide = cpu_to_le32(0xffffffff);
773 wd->params->sync = cpu_to_le32(0xffffffff);
774 wd->params->soft_mask = 0x00; /* all disabled */
775 wd->params->unsol_mask = 0x00; /* all disabled */
777 /* disable TAGGED messages */
778 wd->params->tag_en = cpu_to_le16(0x0000);
781 /* Read card type from GPIO bits 1 and 3 */
782 static enum wd719x_card_type wd719x_detect_type(struct wd719x *wd)
784 u8 card = wd719x_readb(wd, WD719X_PCI_GPIO_CONTROL);
786 card |= WD719X_GPIO_ID_BITS;
787 wd719x_writeb(wd, WD719X_PCI_GPIO_CONTROL, card);
788 card = wd719x_readb(wd, WD719X_PCI_GPIO_DATA) & WD719X_GPIO_ID_BITS;
791 return WD719X_TYPE_7193;
793 return WD719X_TYPE_7197;
795 return WD719X_TYPE_7296;
797 dev_warn(&wd->pdev->dev, "unknown card type 0x%x\n", card);
798 return WD719X_TYPE_UNKNOWN;
802 static int wd719x_board_found(struct Scsi_Host *sh)
804 struct wd719x *wd = shost_priv(sh);
805 static const char * const card_types[] = {
806 "Unknown card", "WD7193", "WD7197", "WD7296"
810 INIT_LIST_HEAD(&wd->active_scbs);
811 INIT_LIST_HEAD(&wd->free_scbs);
813 sh->base = pci_resource_start(wd->pdev, 0);
815 wd->type = wd719x_detect_type(wd);
818 sh->irq = wd->pdev->irq;
821 /* memory area for host (EEPROM) parameters */
822 wd->params = pci_alloc_consistent(wd->pdev,
823 sizeof(struct wd719x_host_param),
826 dev_warn(&wd->pdev->dev, "unable to allocate parameter buffer\n");
830 /* memory area for the RISC for hash table of outstanding requests */
831 wd->hash_virt = pci_alloc_consistent(wd->pdev, WD719X_HASH_TABLE_SIZE,
833 if (!wd->hash_virt) {
834 dev_warn(&wd->pdev->dev, "unable to allocate hash buffer\n");
836 goto fail_free_params;
839 ret = request_irq(wd->pdev->irq, wd719x_interrupt, IRQF_SHARED,
842 dev_warn(&wd->pdev->dev, "unable to assign IRQ %d\n",
847 /* read parameters from EEPROM */
848 wd719x_read_eeprom(wd);
850 ret = wd719x_chip_init(wd);
854 sh->this_id = wd->params->own_scsi_id & WD719X_EE_SCSI_ID_MASK;
856 dev_info(&wd->pdev->dev, "%s at I/O 0x%lx, IRQ %u, SCSI ID %d\n",
857 card_types[wd->type], sh->base, sh->irq, sh->this_id);
862 free_irq(wd->pdev->irq, wd);
864 pci_free_consistent(wd->pdev, WD719X_HASH_TABLE_SIZE, wd->hash_virt,
867 pci_free_consistent(wd->pdev, sizeof(struct wd719x_host_param),
868 wd->params, wd->params_phys);
873 static struct scsi_host_template wd719x_template = {
874 .module = THIS_MODULE,
875 .name = "Western Digital 719x",
876 .queuecommand = wd719x_queuecommand,
877 .eh_abort_handler = wd719x_abort,
878 .eh_device_reset_handler = wd719x_dev_reset,
879 .eh_bus_reset_handler = wd719x_bus_reset,
880 .eh_host_reset_handler = wd719x_host_reset,
881 .bios_param = wd719x_biosparam,
882 .proc_name = "wd719x",
885 .sg_tablesize = WD719X_SG,
886 .use_clustering = ENABLE_CLUSTERING,
889 static int wd719x_pci_probe(struct pci_dev *pdev, const struct pci_device_id *d)
892 struct Scsi_Host *sh;
895 err = pci_enable_device(pdev);
899 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32))) {
900 dev_warn(&pdev->dev, "Unable to set 32-bit DMA mask\n");
904 err = pci_request_regions(pdev, "wd719x");
907 pci_set_master(pdev);
910 if (pci_resource_len(pdev, 0) == 0)
914 sh = scsi_host_alloc(&wd719x_template, sizeof(struct wd719x));
919 wd->base = pci_iomap(pdev, 0, 0);
924 err = wd719x_board_found(sh);
928 err = scsi_add_host(sh, &wd->pdev->dev);
934 pci_set_drvdata(pdev, sh);
940 pci_iounmap(pdev, wd->base);
944 pci_release_regions(pdev);
946 pci_disable_device(pdev);
952 static void wd719x_pci_remove(struct pci_dev *pdev)
954 struct Scsi_Host *sh = pci_get_drvdata(pdev);
955 struct wd719x *wd = shost_priv(sh);
957 scsi_remove_host(sh);
959 pci_iounmap(pdev, wd->base);
960 pci_release_regions(pdev);
961 pci_disable_device(pdev);
966 static const struct pci_device_id wd719x_pci_table[] = {
967 { PCI_DEVICE(PCI_VENDOR_ID_WD, 0x3296) },
971 MODULE_DEVICE_TABLE(pci, wd719x_pci_table);
973 static struct pci_driver wd719x_pci_driver = {
975 .id_table = wd719x_pci_table,
976 .probe = wd719x_pci_probe,
977 .remove = wd719x_pci_remove,
980 module_pci_driver(wd719x_pci_driver);
982 MODULE_DESCRIPTION("Western Digital WD7193/7197/7296 SCSI driver");
983 MODULE_AUTHOR("Ondrej Zary, Aaron Dewell, Juergen Gaertner");
984 MODULE_LICENSE("GPL");
985 MODULE_FIRMWARE("wd719x-wcs.bin");
986 MODULE_FIRMWARE("wd719x-risc.bin");