1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for Western Digital WD7193, WD7197 and WD7296 SCSI cards
4 * Copyright 2013 Ondrej Zary
7 * Aaron Dewell <dewell@woods.net>
8 * Gaerti <Juergen.Gaertner@mbox.si.uni-hannover.de>
10 * HW documentation available in book:
12 * SPIDER Command Protocol
14 * SCSI Storage Products (MCP)
15 * Western Digital Corporation
18 * http://web.archive.org/web/20070717175254/http://sun1.rrzn.uni-hannover.de/gaertner.juergen/wd719x/Linux/Docu/Spider/
23 * 1. SCSI command is transformed to SCB (Spider Control Block) by the
24 * queuecommand function.
25 * 2. The address of the SCB is stored in a list to be able to access it, if
26 * something goes wrong.
27 * 3. The address of the SCB is written to the Controller, which loads the SCB
28 * via BM-DMA and processes it.
29 * 4. After it has finished, it generates an interrupt, and sets registers.
32 * - abort/reset functions
38 #include <linux/interrupt.h>
39 #include <linux/module.h>
40 #include <linux/delay.h>
41 #include <linux/pci.h>
42 #include <linux/firmware.h>
43 #include <linux/eeprom_93cx6.h>
44 #include <scsi/scsi_cmnd.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_host.h>
49 /* low-level register access */
50 static inline u8
wd719x_readb(struct wd719x
*wd
, u8 reg
)
52 return ioread8(wd
->base
+ reg
);
55 static inline u32
wd719x_readl(struct wd719x
*wd
, u8 reg
)
57 return ioread32(wd
->base
+ reg
);
60 static inline void wd719x_writeb(struct wd719x
*wd
, u8 reg
, u8 val
)
62 iowrite8(val
, wd
->base
+ reg
);
65 static inline void wd719x_writew(struct wd719x
*wd
, u8 reg
, u16 val
)
67 iowrite16(val
, wd
->base
+ reg
);
70 static inline void wd719x_writel(struct wd719x
*wd
, u8 reg
, u32 val
)
72 iowrite32(val
, wd
->base
+ reg
);
75 /* wait until the command register is ready */
76 static inline int wd719x_wait_ready(struct wd719x
*wd
)
81 if (wd719x_readb(wd
, WD719X_AMR_COMMAND
) == WD719X_CMD_READY
)
84 } while (i
++ < WD719X_WAIT_FOR_CMD_READY
);
86 dev_err(&wd
->pdev
->dev
, "command register is not ready: 0x%02x\n",
87 wd719x_readb(wd
, WD719X_AMR_COMMAND
));
92 /* poll interrupt status register until command finishes */
93 static inline int wd719x_wait_done(struct wd719x
*wd
, int timeout
)
98 status
= wd719x_readb(wd
, WD719X_AMR_INT_STATUS
);
106 dev_err(&wd
->pdev
->dev
, "direct command timed out\n");
110 if (status
!= WD719X_INT_NOERRORS
) {
111 u8 sue
= wd719x_readb(wd
, WD719X_AMR_SCB_ERROR
);
112 /* we get this after wd719x_dev_reset, it's not an error */
113 if (sue
== WD719X_SUE_TERM
)
115 /* we get this after wd719x_bus_reset, it's not an error */
116 if (sue
== WD719X_SUE_RESET
)
118 dev_err(&wd
->pdev
->dev
, "direct command failed, status 0x%02x, SUE 0x%02x\n",
126 static int wd719x_direct_cmd(struct wd719x
*wd
, u8 opcode
, u8 dev
, u8 lun
,
127 u8 tag
, dma_addr_t data
, int timeout
)
131 /* clear interrupt status register (allow command register to clear) */
132 wd719x_writeb(wd
, WD719X_AMR_INT_STATUS
, WD719X_INT_NONE
);
134 /* Wait for the Command register to become free */
135 if (wd719x_wait_ready(wd
))
138 /* disable interrupts except for RESET/ABORT (it breaks them) */
139 if (opcode
!= WD719X_CMD_BUSRESET
&& opcode
!= WD719X_CMD_ABORT
&&
140 opcode
!= WD719X_CMD_ABORT_TAG
&& opcode
!= WD719X_CMD_RESET
)
141 dev
|= WD719X_DISABLE_INT
;
142 wd719x_writeb(wd
, WD719X_AMR_CMD_PARAM
, dev
);
143 wd719x_writeb(wd
, WD719X_AMR_CMD_PARAM_2
, lun
);
144 wd719x_writeb(wd
, WD719X_AMR_CMD_PARAM_3
, tag
);
146 wd719x_writel(wd
, WD719X_AMR_SCB_IN
, data
);
148 /* clear interrupt status register again */
149 wd719x_writeb(wd
, WD719X_AMR_INT_STATUS
, WD719X_INT_NONE
);
151 /* Now, write the command */
152 wd719x_writeb(wd
, WD719X_AMR_COMMAND
, opcode
);
154 if (timeout
) /* wait for the command to complete */
155 ret
= wd719x_wait_done(wd
, timeout
);
157 /* clear interrupt status register (clean up) */
158 if (opcode
!= WD719X_CMD_READ_FIRMVER
)
159 wd719x_writeb(wd
, WD719X_AMR_INT_STATUS
, WD719X_INT_NONE
);
164 static void wd719x_destroy(struct wd719x
*wd
)
167 if (wd719x_direct_cmd(wd
, WD719X_CMD_SLEEP
, 0, 0, 0, 0,
168 WD719X_WAIT_FOR_RISC
))
169 dev_warn(&wd
->pdev
->dev
, "RISC sleep command failed\n");
171 wd719x_writeb(wd
, WD719X_PCI_MODE_SELECT
, 0);
173 WARN_ON_ONCE(!list_empty(&wd
->active_scbs
));
175 /* free internal buffers */
176 dma_free_coherent(&wd
->pdev
->dev
, wd
->fw_size
, wd
->fw_virt
,
179 dma_free_coherent(&wd
->pdev
->dev
, WD719X_HASH_TABLE_SIZE
, wd
->hash_virt
,
181 wd
->hash_virt
= NULL
;
182 dma_free_coherent(&wd
->pdev
->dev
, sizeof(struct wd719x_host_param
),
183 wd
->params
, wd
->params_phys
);
185 free_irq(wd
->pdev
->irq
, wd
);
188 /* finish a SCSI command, unmap buffers */
189 static void wd719x_finish_cmd(struct wd719x_scb
*scb
, int result
)
191 struct scsi_cmnd
*cmd
= scb
->cmd
;
192 struct wd719x
*wd
= shost_priv(cmd
->device
->host
);
194 list_del(&scb
->list
);
196 dma_unmap_single(&wd
->pdev
->dev
, scb
->phys
,
197 sizeof(struct wd719x_scb
), DMA_BIDIRECTIONAL
);
199 dma_unmap_single(&wd
->pdev
->dev
, scb
->dma_handle
,
200 SCSI_SENSE_BUFFERSIZE
, DMA_FROM_DEVICE
);
202 cmd
->result
= result
<< 16;
206 /* Build a SCB and send it to the card */
207 static int wd719x_queuecommand(struct Scsi_Host
*sh
, struct scsi_cmnd
*cmd
)
211 struct wd719x_scb
*scb
= scsi_cmd_priv(cmd
);
212 struct wd719x
*wd
= shost_priv(sh
);
216 scb
->CDB_tag
= 0; /* Tagged queueing not supported yet */
217 scb
->devid
= cmd
->device
->id
;
218 scb
->lun
= cmd
->device
->lun
;
220 /* copy the command */
221 memcpy(scb
->CDB
, cmd
->cmnd
, cmd
->cmd_len
);
224 scb
->phys
= dma_map_single(&wd
->pdev
->dev
, scb
, sizeof(*scb
),
227 if (dma_mapping_error(&wd
->pdev
->dev
, scb
->phys
))
230 /* map sense buffer */
231 scb
->sense_buf_length
= SCSI_SENSE_BUFFERSIZE
;
232 scb
->dma_handle
= dma_map_single(&wd
->pdev
->dev
, cmd
->sense_buffer
,
233 SCSI_SENSE_BUFFERSIZE
, DMA_FROM_DEVICE
);
234 if (dma_mapping_error(&wd
->pdev
->dev
, scb
->dma_handle
))
236 scb
->sense_buf
= cpu_to_le32(scb
->dma_handle
);
238 /* request autosense */
239 scb
->SCB_options
|= WD719X_SCB_FLAGS_AUTO_REQUEST_SENSE
;
241 /* check direction */
242 if (cmd
->sc_data_direction
== DMA_TO_DEVICE
)
243 scb
->SCB_options
|= WD719X_SCB_FLAGS_CHECK_DIRECTION
244 | WD719X_SCB_FLAGS_PCI_TO_SCSI
;
245 else if (cmd
->sc_data_direction
== DMA_FROM_DEVICE
)
246 scb
->SCB_options
|= WD719X_SCB_FLAGS_CHECK_DIRECTION
;
249 count_sg
= scsi_dma_map(cmd
);
251 goto out_unmap_sense
;
252 BUG_ON(count_sg
> WD719X_SG
);
255 struct scatterlist
*sg
;
257 scb
->data_length
= cpu_to_le32(count_sg
*
258 sizeof(struct wd719x_sglist
));
259 scb
->data_p
= cpu_to_le32(scb
->phys
+
260 offsetof(struct wd719x_scb
, sg_list
));
262 scsi_for_each_sg(cmd
, sg
, count_sg
, i
) {
263 scb
->sg_list
[i
].ptr
= cpu_to_le32(sg_dma_address(sg
));
264 scb
->sg_list
[i
].length
= cpu_to_le32(sg_dma_len(sg
));
266 scb
->SCB_options
|= WD719X_SCB_FLAGS_DO_SCATTER_GATHER
;
267 } else { /* zero length */
268 scb
->data_length
= 0;
272 spin_lock_irqsave(wd
->sh
->host_lock
, flags
);
274 /* check if the Command register is free */
275 if (wd719x_readb(wd
, WD719X_AMR_COMMAND
) != WD719X_CMD_READY
) {
276 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
277 return SCSI_MLQUEUE_HOST_BUSY
;
280 list_add(&scb
->list
, &wd
->active_scbs
);
282 /* write pointer to the AMR */
283 wd719x_writel(wd
, WD719X_AMR_SCB_IN
, scb
->phys
);
284 /* send SCB opcode */
285 wd719x_writeb(wd
, WD719X_AMR_COMMAND
, WD719X_CMD_PROCESS_SCB
);
287 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
291 dma_unmap_single(&wd
->pdev
->dev
, scb
->dma_handle
,
292 SCSI_SENSE_BUFFERSIZE
, DMA_FROM_DEVICE
);
294 dma_unmap_single(&wd
->pdev
->dev
, scb
->phys
, sizeof(*scb
),
297 cmd
->result
= DID_ERROR
<< 16;
302 static int wd719x_chip_init(struct wd719x
*wd
)
306 const struct firmware
*fw_wcs
, *fw_risc
;
307 const char fwname_wcs
[] = "wd719x-wcs.bin";
308 const char fwname_risc
[] = "wd719x-risc.bin";
310 memset(wd
->hash_virt
, 0, WD719X_HASH_TABLE_SIZE
);
312 /* WCS (sequencer) firmware */
313 ret
= request_firmware(&fw_wcs
, fwname_wcs
, &wd
->pdev
->dev
);
315 dev_err(&wd
->pdev
->dev
, "Unable to load firmware %s: %d\n",
320 ret
= request_firmware(&fw_risc
, fwname_risc
, &wd
->pdev
->dev
);
322 dev_err(&wd
->pdev
->dev
, "Unable to load firmware %s: %d\n",
324 release_firmware(fw_wcs
);
327 wd
->fw_size
= ALIGN(fw_wcs
->size
, 4) + fw_risc
->size
;
330 wd
->fw_virt
= dma_alloc_coherent(&wd
->pdev
->dev
, wd
->fw_size
,
331 &wd
->fw_phys
, GFP_KERNEL
);
334 goto wd719x_init_end
;
337 /* make a fresh copy of WCS and RISC code */
338 memcpy(wd
->fw_virt
, fw_wcs
->data
, fw_wcs
->size
);
339 memcpy(wd
->fw_virt
+ ALIGN(fw_wcs
->size
, 4), fw_risc
->data
,
342 /* Reset the Spider Chip and adapter itself */
343 wd719x_writeb(wd
, WD719X_PCI_PORT_RESET
, WD719X_PCI_RESET
);
344 udelay(WD719X_WAIT_FOR_RISC
);
345 /* Clear PIO mode bits set by BIOS */
346 wd719x_writeb(wd
, WD719X_AMR_CMD_PARAM
, 0);
347 /* ensure RISC is not running */
348 wd719x_writeb(wd
, WD719X_PCI_MODE_SELECT
, 0);
349 /* ensure command port is ready */
350 wd719x_writeb(wd
, WD719X_AMR_COMMAND
, 0);
351 if (wd719x_wait_ready(wd
)) {
353 goto wd719x_init_end
;
356 /* Transfer the first 2K words of RISC code to kick start the uP */
357 risc_init
[0] = wd
->fw_phys
; /* WCS FW */
358 risc_init
[1] = wd
->fw_phys
+ ALIGN(fw_wcs
->size
, 4); /* RISC FW */
359 risc_init
[2] = wd
->hash_phys
; /* hash table */
361 /* clear DMA status */
362 wd719x_writeb(wd
, WD719X_PCI_CHANNEL2_3STATUS
, 0);
364 /* address to read firmware from */
365 wd719x_writel(wd
, WD719X_PCI_EXTERNAL_ADDR
, risc_init
[1]);
366 /* base address to write firmware to (on card) */
367 wd719x_writew(wd
, WD719X_PCI_INTERNAL_ADDR
, WD719X_PRAM_BASE_ADDR
);
368 /* size: first 2K words */
369 wd719x_writew(wd
, WD719X_PCI_DMA_TRANSFER_SIZE
, 2048 * 2);
371 wd719x_writeb(wd
, WD719X_PCI_CHANNEL2_3CMD
, WD719X_START_CHANNEL2_3DMA
);
373 /* wait for DMA to complete */
374 i
= WD719X_WAIT_FOR_RISC
;
376 u8 status
= wd719x_readb(wd
, WD719X_PCI_CHANNEL2_3STATUS
);
377 if (status
== WD719X_START_CHANNEL2_3DONE
)
379 if (status
== WD719X_START_CHANNEL2_3ABORT
) {
380 dev_warn(&wd
->pdev
->dev
, "RISC bootstrap failed: DMA aborted\n");
382 goto wd719x_init_end
;
387 dev_warn(&wd
->pdev
->dev
, "RISC bootstrap failed: DMA timeout\n");
389 goto wd719x_init_end
;
392 /* firmware is loaded, now initialize and wake up the RISC */
393 /* write RISC initialization long words to Spider */
394 wd719x_writel(wd
, WD719X_AMR_SCB_IN
, risc_init
[0]);
395 wd719x_writel(wd
, WD719X_AMR_SCB_IN
+ 4, risc_init
[1]);
396 wd719x_writel(wd
, WD719X_AMR_SCB_IN
+ 8, risc_init
[2]);
398 /* disable interrupts during initialization of RISC */
399 wd719x_writeb(wd
, WD719X_AMR_CMD_PARAM
, WD719X_DISABLE_INT
);
401 /* issue INITIALIZE RISC comand */
402 wd719x_writeb(wd
, WD719X_AMR_COMMAND
, WD719X_CMD_INIT_RISC
);
403 /* enable advanced mode (wake up RISC) */
404 wd719x_writeb(wd
, WD719X_PCI_MODE_SELECT
, WD719X_ENABLE_ADVANCE_MODE
);
405 udelay(WD719X_WAIT_FOR_RISC
);
407 ret
= wd719x_wait_done(wd
, WD719X_WAIT_FOR_RISC
);
408 /* clear interrupt status register */
409 wd719x_writeb(wd
, WD719X_AMR_INT_STATUS
, WD719X_INT_NONE
);
411 dev_warn(&wd
->pdev
->dev
, "Unable to initialize RISC\n");
412 goto wd719x_init_end
;
414 /* RISC is up and running */
416 /* Read FW version from RISC */
417 ret
= wd719x_direct_cmd(wd
, WD719X_CMD_READ_FIRMVER
, 0, 0, 0, 0,
418 WD719X_WAIT_FOR_RISC
);
420 dev_warn(&wd
->pdev
->dev
, "Unable to read firmware version\n");
421 goto wd719x_init_end
;
423 dev_info(&wd
->pdev
->dev
, "RISC initialized with firmware version %.2x.%.2x\n",
424 wd719x_readb(wd
, WD719X_AMR_SCB_OUT
+ 1),
425 wd719x_readb(wd
, WD719X_AMR_SCB_OUT
));
428 ret
= wd719x_direct_cmd(wd
, WD719X_CMD_BUSRESET
, 0, 0, 0, 0,
429 WD719X_WAIT_FOR_SCSI_RESET
);
431 dev_warn(&wd
->pdev
->dev
, "SCSI bus reset failed\n");
432 goto wd719x_init_end
;
435 /* use HostParameter structure to set Spider's Host Parameter Block */
436 ret
= wd719x_direct_cmd(wd
, WD719X_CMD_SET_PARAM
, 0,
437 sizeof(struct wd719x_host_param
), 0,
438 wd
->params_phys
, WD719X_WAIT_FOR_RISC
);
440 dev_warn(&wd
->pdev
->dev
, "Failed to set HOST PARAMETERS\n");
441 goto wd719x_init_end
;
444 /* initiate SCAM (does nothing if disabled in BIOS) */
445 /* bug?: we should pass a mask of static IDs which we don't have */
446 ret
= wd719x_direct_cmd(wd
, WD719X_CMD_INIT_SCAM
, 0, 0, 0, 0,
447 WD719X_WAIT_FOR_SCSI_RESET
);
449 dev_warn(&wd
->pdev
->dev
, "SCAM initialization failed\n");
450 goto wd719x_init_end
;
453 /* clear AMR_BIOS_SHARE_INT register */
454 wd719x_writeb(wd
, WD719X_AMR_BIOS_SHARE_INT
, 0);
457 release_firmware(fw_wcs
);
458 release_firmware(fw_risc
);
463 static int wd719x_abort(struct scsi_cmnd
*cmd
)
467 struct wd719x_scb
*scb
= scsi_cmd_priv(cmd
);
468 struct wd719x
*wd
= shost_priv(cmd
->device
->host
);
469 struct device
*dev
= &wd
->pdev
->dev
;
471 dev_info(dev
, "abort command, tag: %x\n", scsi_cmd_to_rq(cmd
)->tag
);
473 action
= WD719X_CMD_ABORT
;
475 spin_lock_irqsave(wd
->sh
->host_lock
, flags
);
476 result
= wd719x_direct_cmd(wd
, action
, cmd
->device
->id
,
477 cmd
->device
->lun
, scsi_cmd_to_rq(cmd
)->tag
,
479 wd719x_finish_cmd(scb
, DID_ABORT
);
480 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
487 static int wd719x_reset(struct scsi_cmnd
*cmd
, u8 opcode
, u8 device
)
491 struct wd719x
*wd
= shost_priv(cmd
->device
->host
);
492 struct wd719x_scb
*scb
, *tmp
;
494 dev_info(&wd
->pdev
->dev
, "%s reset requested\n",
495 (opcode
== WD719X_CMD_BUSRESET
) ? "bus" : "device");
497 spin_lock_irqsave(wd
->sh
->host_lock
, flags
);
498 result
= wd719x_direct_cmd(wd
, opcode
, device
, 0, 0, 0,
499 WD719X_WAIT_FOR_SCSI_RESET
);
500 /* flush all SCBs (or all for a device if dev_reset) */
501 list_for_each_entry_safe(scb
, tmp
, &wd
->active_scbs
, list
) {
502 if (opcode
== WD719X_CMD_BUSRESET
||
503 scb
->cmd
->device
->id
== device
)
504 wd719x_finish_cmd(scb
, DID_RESET
);
506 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
513 static int wd719x_dev_reset(struct scsi_cmnd
*cmd
)
515 return wd719x_reset(cmd
, WD719X_CMD_RESET
, cmd
->device
->id
);
518 static int wd719x_bus_reset(struct scsi_cmnd
*cmd
)
520 return wd719x_reset(cmd
, WD719X_CMD_BUSRESET
, 0);
523 static int wd719x_host_reset(struct scsi_cmnd
*cmd
)
525 struct wd719x
*wd
= shost_priv(cmd
->device
->host
);
526 struct wd719x_scb
*scb
, *tmp
;
529 dev_info(&wd
->pdev
->dev
, "host reset requested\n");
530 spin_lock_irqsave(wd
->sh
->host_lock
, flags
);
532 if (wd719x_direct_cmd(wd
, WD719X_CMD_SLEEP
, 0, 0, 0, 0,
533 WD719X_WAIT_FOR_RISC
))
534 dev_warn(&wd
->pdev
->dev
, "RISC sleep command failed\n");
536 wd719x_writeb(wd
, WD719X_PCI_MODE_SELECT
, 0);
539 list_for_each_entry_safe(scb
, tmp
, &wd
->active_scbs
, list
)
540 wd719x_finish_cmd(scb
, DID_RESET
);
541 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
543 /* Try to reinit the RISC */
544 return wd719x_chip_init(wd
) == 0 ? SUCCESS
: FAILED
;
547 static int wd719x_biosparam(struct scsi_device
*sdev
, struct block_device
*bdev
,
548 sector_t capacity
, int geom
[])
550 if (capacity
>= 0x200000) {
551 geom
[0] = 255; /* heads */
552 geom
[1] = 63; /* sectors */
554 geom
[0] = 64; /* heads */
555 geom
[1] = 32; /* sectors */
557 geom
[2] = sector_div(capacity
, geom
[0] * geom
[1]); /* cylinders */
562 /* process a SCB-completion interrupt */
563 static inline void wd719x_interrupt_SCB(struct wd719x
*wd
,
564 union wd719x_regs regs
,
565 struct wd719x_scb
*scb
)
569 /* now have to find result from card */
570 switch (regs
.bytes
.SUE
) {
571 case WD719X_SUE_NOERRORS
:
574 case WD719X_SUE_REJECTED
:
575 dev_err(&wd
->pdev
->dev
, "command rejected\n");
578 case WD719X_SUE_SCBQFULL
:
579 dev_err(&wd
->pdev
->dev
, "SCB queue is full\n");
582 case WD719X_SUE_TERM
:
583 dev_dbg(&wd
->pdev
->dev
, "SCB terminated by direct command\n");
584 result
= DID_ABORT
; /* or DID_RESET? */
586 case WD719X_SUE_CHAN1ABORT
:
587 case WD719X_SUE_CHAN23ABORT
:
589 dev_err(&wd
->pdev
->dev
, "DMA abort\n");
591 case WD719X_SUE_CHAN1PAR
:
592 case WD719X_SUE_CHAN23PAR
:
594 dev_err(&wd
->pdev
->dev
, "DMA parity error\n");
596 case WD719X_SUE_TIMEOUT
:
597 result
= DID_TIME_OUT
;
598 dev_dbg(&wd
->pdev
->dev
, "selection timeout\n");
600 case WD719X_SUE_RESET
:
601 dev_dbg(&wd
->pdev
->dev
, "bus reset occurred\n");
604 case WD719X_SUE_BUSERROR
:
605 dev_dbg(&wd
->pdev
->dev
, "SCSI bus error\n");
608 case WD719X_SUE_WRONGWAY
:
609 dev_err(&wd
->pdev
->dev
, "wrong data transfer direction\n");
612 case WD719X_SUE_BADPHASE
:
613 dev_err(&wd
->pdev
->dev
, "invalid SCSI phase\n");
616 case WD719X_SUE_TOOLONG
:
617 dev_err(&wd
->pdev
->dev
, "record too long\n");
620 case WD719X_SUE_BUSFREE
:
621 dev_err(&wd
->pdev
->dev
, "unexpected bus free\n");
622 result
= DID_NO_CONNECT
; /* or DID_ERROR ???*/
624 case WD719X_SUE_ARSDONE
:
625 dev_dbg(&wd
->pdev
->dev
, "auto request sense\n");
626 if (regs
.bytes
.SCSI
== 0)
631 case WD719X_SUE_IGNORED
:
632 dev_err(&wd
->pdev
->dev
, "target id %d ignored command\n",
633 scb
->cmd
->device
->id
);
634 result
= DID_NO_CONNECT
;
636 case WD719X_SUE_WRONGTAGS
:
637 dev_err(&wd
->pdev
->dev
, "reversed tags\n");
640 case WD719X_SUE_BADTAGS
:
641 dev_err(&wd
->pdev
->dev
, "tag type not supported by target\n");
644 case WD719X_SUE_NOSCAMID
:
645 dev_err(&wd
->pdev
->dev
, "no SCAM soft ID available\n");
649 dev_warn(&wd
->pdev
->dev
, "unknown SUE error code: 0x%x\n",
655 wd719x_finish_cmd(scb
, result
);
658 static irqreturn_t
wd719x_interrupt(int irq
, void *dev_id
)
660 struct wd719x
*wd
= dev_id
;
661 union wd719x_regs regs
;
665 spin_lock_irqsave(wd
->sh
->host_lock
, flags
);
666 /* read SCB pointer back from card */
667 SCB_out
= wd719x_readl(wd
, WD719X_AMR_SCB_OUT
);
668 /* read all status info at once */
669 regs
.all
= cpu_to_le32(wd719x_readl(wd
, WD719X_AMR_OP_CODE
));
671 switch (regs
.bytes
.INT
) {
672 case WD719X_INT_NONE
:
673 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
675 case WD719X_INT_LINKNOSTATUS
:
676 dev_err(&wd
->pdev
->dev
, "linked command completed with no status\n");
678 case WD719X_INT_BADINT
:
679 dev_err(&wd
->pdev
->dev
, "unsolicited interrupt\n");
681 case WD719X_INT_NOERRORS
:
682 case WD719X_INT_LINKNOERRORS
:
683 case WD719X_INT_ERRORSLOGGED
:
684 case WD719X_INT_SPIDERFAILED
:
685 /* was the cmd completed a direct or SCB command? */
686 if (regs
.bytes
.OPC
== WD719X_CMD_PROCESS_SCB
) {
687 struct wd719x_scb
*scb
;
688 list_for_each_entry(scb
, &wd
->active_scbs
, list
)
689 if (SCB_out
== scb
->phys
)
691 if (SCB_out
== scb
->phys
)
692 wd719x_interrupt_SCB(wd
, regs
, scb
);
694 dev_err(&wd
->pdev
->dev
, "card returned invalid SCB pointer\n");
696 dev_dbg(&wd
->pdev
->dev
, "direct command 0x%x completed\n",
699 case WD719X_INT_PIOREADY
:
700 dev_err(&wd
->pdev
->dev
, "card indicates PIO data ready but we never use PIO\n");
701 /* interrupt will not be cleared until all data is read */
704 dev_err(&wd
->pdev
->dev
, "unknown interrupt reason: %d\n",
708 /* clear interrupt so another can happen */
709 wd719x_writeb(wd
, WD719X_AMR_INT_STATUS
, WD719X_INT_NONE
);
710 spin_unlock_irqrestore(wd
->sh
->host_lock
, flags
);
715 static void wd719x_eeprom_reg_read(struct eeprom_93cx6
*eeprom
)
717 struct wd719x
*wd
= eeprom
->data
;
718 u8 reg
= wd719x_readb(wd
, WD719X_PCI_GPIO_DATA
);
720 eeprom
->reg_data_out
= reg
& WD719X_EE_DO
;
723 static void wd719x_eeprom_reg_write(struct eeprom_93cx6
*eeprom
)
725 struct wd719x
*wd
= eeprom
->data
;
728 if (eeprom
->reg_data_in
)
730 if (eeprom
->reg_data_clock
)
731 reg
|= WD719X_EE_CLK
;
732 if (eeprom
->reg_chip_select
)
735 wd719x_writeb(wd
, WD719X_PCI_GPIO_DATA
, reg
);
738 /* read config from EEPROM so it can be downloaded by the RISC on (re-)init */
739 static void wd719x_read_eeprom(struct wd719x
*wd
)
741 struct eeprom_93cx6 eeprom
;
743 struct wd719x_eeprom_header header
;
746 eeprom
.register_read
= wd719x_eeprom_reg_read
;
747 eeprom
.register_write
= wd719x_eeprom_reg_write
;
748 eeprom
.width
= PCI_EEPROM_WIDTH_93C46
;
750 /* set all outputs to low */
751 wd719x_writeb(wd
, WD719X_PCI_GPIO_DATA
, 0);
752 /* configure GPIO pins */
753 gpio
= wd719x_readb(wd
, WD719X_PCI_GPIO_CONTROL
);
755 gpio
&= (~(WD719X_EE_CLK
| WD719X_EE_DI
| WD719X_EE_CS
));
757 gpio
|= WD719X_EE_DO
;
758 wd719x_writeb(wd
, WD719X_PCI_GPIO_CONTROL
, gpio
);
760 /* read EEPROM header */
761 eeprom_93cx6_multireadb(&eeprom
, 0, (u8
*)&header
, sizeof(header
));
763 if (header
.sig1
== 'W' && header
.sig2
== 'D')
764 eeprom_93cx6_multireadb(&eeprom
, header
.cfg_offset
,
766 sizeof(struct wd719x_host_param
));
767 else { /* default EEPROM values */
768 dev_warn(&wd
->pdev
->dev
, "EEPROM signature is invalid (0x%02x 0x%02x), using default values\n",
769 header
.sig1
, header
.sig2
);
770 wd
->params
->ch_1_th
= 0x10; /* 16 DWs = 64 B */
771 wd
->params
->scsi_conf
= 0x4c; /* 48ma, spue, parity check */
772 wd
->params
->own_scsi_id
= 0x07; /* ID 7, SCAM disabled */
773 wd
->params
->sel_timeout
= 0x4d; /* 250 ms */
774 wd
->params
->sleep_timer
= 0x01;
775 wd
->params
->cdb_size
= cpu_to_le16(0x5555); /* all 6 B */
776 wd
->params
->scsi_pad
= 0x1b;
777 if (wd
->type
== WD719X_TYPE_7193
) /* narrow card - disable */
778 wd
->params
->wide
= cpu_to_le32(0x00000000);
779 else /* initiate & respond to WIDE messages */
780 wd
->params
->wide
= cpu_to_le32(0xffffffff);
781 wd
->params
->sync
= cpu_to_le32(0xffffffff);
782 wd
->params
->soft_mask
= 0x00; /* all disabled */
783 wd
->params
->unsol_mask
= 0x00; /* all disabled */
785 /* disable TAGGED messages */
786 wd
->params
->tag_en
= cpu_to_le16(0x0000);
789 /* Read card type from GPIO bits 1 and 3 */
790 static enum wd719x_card_type
wd719x_detect_type(struct wd719x
*wd
)
792 u8 card
= wd719x_readb(wd
, WD719X_PCI_GPIO_CONTROL
);
794 card
|= WD719X_GPIO_ID_BITS
;
795 wd719x_writeb(wd
, WD719X_PCI_GPIO_CONTROL
, card
);
796 card
= wd719x_readb(wd
, WD719X_PCI_GPIO_DATA
) & WD719X_GPIO_ID_BITS
;
799 return WD719X_TYPE_7193
;
801 return WD719X_TYPE_7197
;
803 return WD719X_TYPE_7296
;
805 dev_warn(&wd
->pdev
->dev
, "unknown card type 0x%x\n", card
);
806 return WD719X_TYPE_UNKNOWN
;
810 static int wd719x_board_found(struct Scsi_Host
*sh
)
812 struct wd719x
*wd
= shost_priv(sh
);
813 static const char * const card_types
[] = {
814 "Unknown card", "WD7193", "WD7197", "WD7296"
818 INIT_LIST_HEAD(&wd
->active_scbs
);
820 sh
->base
= pci_resource_start(wd
->pdev
, 0);
822 wd
->type
= wd719x_detect_type(wd
);
825 sh
->irq
= wd
->pdev
->irq
;
828 /* memory area for host (EEPROM) parameters */
829 wd
->params
= dma_alloc_coherent(&wd
->pdev
->dev
,
830 sizeof(struct wd719x_host_param
),
831 &wd
->params_phys
, GFP_KERNEL
);
833 dev_warn(&wd
->pdev
->dev
, "unable to allocate parameter buffer\n");
837 /* memory area for the RISC for hash table of outstanding requests */
838 wd
->hash_virt
= dma_alloc_coherent(&wd
->pdev
->dev
,
839 WD719X_HASH_TABLE_SIZE
,
840 &wd
->hash_phys
, GFP_KERNEL
);
841 if (!wd
->hash_virt
) {
842 dev_warn(&wd
->pdev
->dev
, "unable to allocate hash buffer\n");
844 goto fail_free_params
;
847 ret
= request_irq(wd
->pdev
->irq
, wd719x_interrupt
, IRQF_SHARED
,
850 dev_warn(&wd
->pdev
->dev
, "unable to assign IRQ %d\n",
855 /* read parameters from EEPROM */
856 wd719x_read_eeprom(wd
);
858 ret
= wd719x_chip_init(wd
);
862 sh
->this_id
= wd
->params
->own_scsi_id
& WD719X_EE_SCSI_ID_MASK
;
864 dev_info(&wd
->pdev
->dev
, "%s at I/O 0x%lx, IRQ %u, SCSI ID %d\n",
865 card_types
[wd
->type
], sh
->base
, sh
->irq
, sh
->this_id
);
870 free_irq(wd
->pdev
->irq
, wd
);
872 dma_free_coherent(&wd
->pdev
->dev
, WD719X_HASH_TABLE_SIZE
, wd
->hash_virt
,
875 dma_free_coherent(&wd
->pdev
->dev
, sizeof(struct wd719x_host_param
),
876 wd
->params
, wd
->params_phys
);
881 static const struct scsi_host_template wd719x_template
= {
882 .module
= THIS_MODULE
,
883 .name
= "Western Digital 719x",
884 .cmd_size
= sizeof(struct wd719x_scb
),
885 .queuecommand
= wd719x_queuecommand
,
886 .eh_abort_handler
= wd719x_abort
,
887 .eh_device_reset_handler
= wd719x_dev_reset
,
888 .eh_bus_reset_handler
= wd719x_bus_reset
,
889 .eh_host_reset_handler
= wd719x_host_reset
,
890 .bios_param
= wd719x_biosparam
,
891 .proc_name
= "wd719x",
894 .sg_tablesize
= WD719X_SG
,
897 static int wd719x_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*d
)
900 struct Scsi_Host
*sh
;
903 err
= pci_enable_device(pdev
);
907 err
= dma_set_mask(&pdev
->dev
, DMA_BIT_MASK(32));
909 dev_warn(&pdev
->dev
, "Unable to set 32-bit DMA mask\n");
913 err
= pci_request_regions(pdev
, "wd719x");
916 pci_set_master(pdev
);
919 if (pci_resource_len(pdev
, 0) == 0)
923 sh
= scsi_host_alloc(&wd719x_template
, sizeof(struct wd719x
));
928 wd
->base
= pci_iomap(pdev
, 0, 0);
933 err
= wd719x_board_found(sh
);
937 err
= scsi_add_host(sh
, &wd
->pdev
->dev
);
943 pci_set_drvdata(pdev
, sh
);
949 pci_iounmap(pdev
, wd
->base
);
953 pci_release_regions(pdev
);
955 pci_disable_device(pdev
);
961 static void wd719x_pci_remove(struct pci_dev
*pdev
)
963 struct Scsi_Host
*sh
= pci_get_drvdata(pdev
);
964 struct wd719x
*wd
= shost_priv(sh
);
966 scsi_remove_host(sh
);
968 pci_iounmap(pdev
, wd
->base
);
969 pci_release_regions(pdev
);
970 pci_disable_device(pdev
);
975 static const struct pci_device_id wd719x_pci_table
[] = {
976 { PCI_DEVICE(PCI_VENDOR_ID_WD
, 0x3296) },
980 MODULE_DEVICE_TABLE(pci
, wd719x_pci_table
);
982 static struct pci_driver wd719x_pci_driver
= {
984 .id_table
= wd719x_pci_table
,
985 .probe
= wd719x_pci_probe
,
986 .remove
= wd719x_pci_remove
,
989 module_pci_driver(wd719x_pci_driver
);
991 MODULE_DESCRIPTION("Western Digital WD7193/7197/7296 SCSI driver");
992 MODULE_AUTHOR("Ondrej Zary, Aaron Dewell, Juergen Gaertner");
993 MODULE_LICENSE("GPL");
994 MODULE_FIRMWARE("wd719x-wcs.bin");
995 MODULE_FIRMWARE("wd719x-risc.bin");