2 * SCSI low-level driver for the 53c94 SCSI bus adaptor found
3 * on Power Macintosh computers, controlling the external SCSI chain.
4 * We assume the 53c94 is connected to a DBDMA (descriptor-based DMA)
7 * Paul Mackerras, August 1996.
8 * Copyright (C) 1996 Paul Mackerras.
10 #include <linux/kernel.h>
11 #include <linux/delay.h>
12 #include <linux/types.h>
13 #include <linux/string.h>
14 #include <linux/slab.h>
15 #include <linux/blkdev.h>
16 #include <linux/proc_fs.h>
17 #include <linux/stat.h>
18 #include <linux/spinlock.h>
19 #include <linux/interrupt.h>
20 #include <asm/dbdma.h>
22 #include <asm/pgtable.h>
24 #include <asm/system.h>
25 #include <asm/pci-bridge.h>
26 #include <asm/macio.h>
28 #include <scsi/scsi.h>
29 #include <scsi/scsi_cmnd.h>
30 #include <scsi/scsi_device.h>
31 #include <scsi/scsi_host.h>
44 struct mac53c94_regs __iomem *regs;
46 struct dbdma_regs __iomem *dma;
49 struct Scsi_Host *host;
50 struct scsi_cmnd *request_q;
51 struct scsi_cmnd *request_qtail;
52 struct scsi_cmnd *current_req; /* req we're currently working on */
53 enum fsc_phase phase; /* what we're currently trying to do */
54 struct dbdma_cmd *dma_cmds; /* space for dbdma commands, aligned */
58 struct macio_dev *mdev;
61 static void mac53c94_init(struct fsc_state *);
62 static void mac53c94_start(struct fsc_state *);
63 static void mac53c94_interrupt(int, void *);
64 static irqreturn_t do_mac53c94_interrupt(int, void *);
65 static void cmd_done(struct fsc_state *, int result);
66 static void set_dma_cmds(struct fsc_state *, struct scsi_cmnd *);
69 static int mac53c94_queue(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
71 struct fsc_state *state;
74 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
76 printk(KERN_DEBUG "mac53c94_queue %p: command is", cmd);
77 for (i = 0; i < cmd->cmd_len; ++i)
78 printk(" %.2x", cmd->cmnd[i]);
79 printk("\n" KERN_DEBUG "use_sg=%d request_bufflen=%d request_buffer=%p\n",
80 scsi_sg_count(cmd), scsi_bufflen(cmd), scsi_sglist(cmd));
84 cmd->scsi_done = done;
85 cmd->host_scribble = NULL;
87 state = (struct fsc_state *) cmd->device->host->hostdata;
89 if (state->request_q == NULL)
90 state->request_q = cmd;
92 state->request_qtail->host_scribble = (void *) cmd;
93 state->request_qtail = cmd;
95 if (state->phase == idle)
96 mac53c94_start(state);
101 static int mac53c94_host_reset(struct scsi_cmnd *cmd)
103 struct fsc_state *state = (struct fsc_state *) cmd->device->host->hostdata;
104 struct mac53c94_regs __iomem *regs = state->regs;
105 struct dbdma_regs __iomem *dma = state->dma;
108 spin_lock_irqsave(cmd->device->host->host_lock, flags);
110 writel((RUN|PAUSE|FLUSH|WAKE) << 16, &dma->control);
111 writeb(CMD_SCSI_RESET, ®s->command); /* assert RST */
112 udelay(100); /* leave it on for a while (>= 25us) */
113 writeb(CMD_RESET, ®s->command);
115 mac53c94_init(state);
116 writeb(CMD_NOP, ®s->command);
118 spin_unlock_irqrestore(cmd->device->host->host_lock, flags);
122 static void mac53c94_init(struct fsc_state *state)
124 struct mac53c94_regs __iomem *regs = state->regs;
125 struct dbdma_regs __iomem *dma = state->dma;
128 writeb(state->host->this_id | CF1_PAR_ENABLE, ®s->config1);
129 writeb(TIMO_VAL(250), ®s->sel_timeout); /* 250ms */
130 writeb(CLKF_VAL(state->clk_freq), ®s->clk_factor);
131 writeb(CF2_FEATURE_EN, ®s->config2);
132 writeb(0, ®s->config3);
133 writeb(0, ®s->sync_period);
134 writeb(0, ®s->sync_offset);
135 x = readb(®s->interrupt);
136 writel((RUN|PAUSE|FLUSH|WAKE) << 16, &dma->control);
140 * Start the next command for a 53C94.
141 * Should be called with interrupts disabled.
143 static void mac53c94_start(struct fsc_state *state)
145 struct scsi_cmnd *cmd;
146 struct mac53c94_regs __iomem *regs = state->regs;
149 if (state->phase != idle || state->current_req != NULL)
150 panic("inappropriate mac53c94_start (state=%p)", state);
151 if (state->request_q == NULL)
153 state->current_req = cmd = state->request_q;
154 state->request_q = (struct scsi_cmnd *) cmd->host_scribble;
157 writeb(0, ®s->count_lo);
158 writeb(0, ®s->count_mid);
159 writeb(0, ®s->count_hi);
160 writeb(CMD_NOP + CMD_DMA_MODE, ®s->command);
162 writeb(CMD_FLUSH, ®s->command);
164 writeb(cmd->device->id, ®s->dest_id);
165 writeb(0, ®s->sync_period);
166 writeb(0, ®s->sync_offset);
168 /* load the command into the FIFO */
169 for (i = 0; i < cmd->cmd_len; ++i)
170 writeb(cmd->cmnd[i], ®s->fifo);
172 /* do select without ATN XXX */
173 writeb(CMD_SELECT, ®s->command);
174 state->phase = selecting;
176 set_dma_cmds(state, cmd);
179 static irqreturn_t do_mac53c94_interrupt(int irq, void *dev_id)
182 struct Scsi_Host *dev = ((struct fsc_state *) dev_id)->current_req->device->host;
184 spin_lock_irqsave(dev->host_lock, flags);
185 mac53c94_interrupt(irq, dev_id);
186 spin_unlock_irqrestore(dev->host_lock, flags);
190 static void mac53c94_interrupt(int irq, void *dev_id)
192 struct fsc_state *state = (struct fsc_state *) dev_id;
193 struct mac53c94_regs __iomem *regs = state->regs;
194 struct dbdma_regs __iomem *dma = state->dma;
195 struct scsi_cmnd *cmd = state->current_req;
196 int nb, stat, seq, intr;
197 static int mac53c94_errors;
200 * Apparently, reading the interrupt register unlatches
201 * the status and sequence step registers.
203 seq = readb(®s->seqstep);
204 stat = readb(®s->status);
205 intr = readb(®s->interrupt);
208 printk(KERN_DEBUG "mac53c94_intr, intr=%x stat=%x seq=%x phase=%d\n",
209 intr, stat, seq, state->phase);
212 if (intr & INTR_RESET) {
213 /* SCSI bus was reset */
214 printk(KERN_INFO "external SCSI bus reset detected\n");
215 writeb(CMD_NOP, ®s->command);
216 writel(RUN << 16, &dma->control); /* stop dma */
217 cmd_done(state, DID_RESET << 16);
220 if (intr & INTR_ILL_CMD) {
221 printk(KERN_ERR "53c94: invalid cmd, intr=%x stat=%x seq=%x phase=%d\n",
222 intr, stat, seq, state->phase);
223 cmd_done(state, DID_ERROR << 16);
226 if (stat & STAT_ERROR) {
228 /* XXX these seem to be harmless? */
229 printk("53c94: bad error, intr=%x stat=%x seq=%x phase=%d\n",
230 intr, stat, seq, state->phase);
233 writeb(CMD_NOP + CMD_DMA_MODE, ®s->command);
236 printk(KERN_DEBUG "53c94: interrupt with no command active?\n");
239 if (stat & STAT_PARITY) {
240 printk(KERN_ERR "mac53c94: parity error\n");
241 cmd_done(state, DID_PARITY << 16);
244 switch (state->phase) {
246 if (intr & INTR_DISCONNECT) {
247 /* selection timed out */
248 cmd_done(state, DID_BAD_TARGET << 16);
251 if (intr != INTR_BUS_SERV + INTR_DONE) {
252 printk(KERN_DEBUG "got intr %x during selection\n", intr);
253 cmd_done(state, DID_ERROR << 16);
256 if ((seq & SS_MASK) != SS_DONE) {
257 printk(KERN_DEBUG "seq step %x after command\n", seq);
258 cmd_done(state, DID_ERROR << 16);
261 writeb(CMD_NOP, ®s->command);
262 /* set DMA controller going if any data to transfer */
263 if ((stat & (STAT_MSG|STAT_CD)) == 0
264 && (scsi_sg_count(cmd) > 0 || scsi_bufflen(cmd))) {
265 nb = cmd->SCp.this_residual;
268 cmd->SCp.this_residual -= nb;
269 writeb(nb, ®s->count_lo);
270 writeb(nb >> 8, ®s->count_mid);
271 writeb(CMD_DMA_MODE + CMD_NOP, ®s->command);
272 writel(virt_to_phys(state->dma_cmds), &dma->cmdptr);
273 writel((RUN << 16) | RUN, &dma->control);
274 writeb(CMD_DMA_MODE + CMD_XFER_DATA, ®s->command);
275 state->phase = dataing;
277 } else if ((stat & STAT_PHASE) == STAT_CD + STAT_IO) {
278 /* up to status phase already */
279 writeb(CMD_I_COMPLETE, ®s->command);
280 state->phase = completing;
282 printk(KERN_DEBUG "in unexpected phase %x after cmd\n",
284 cmd_done(state, DID_ERROR << 16);
290 if (intr != INTR_BUS_SERV) {
291 printk(KERN_DEBUG "got intr %x before status\n", intr);
292 cmd_done(state, DID_ERROR << 16);
295 if (cmd->SCp.this_residual != 0
296 && (stat & (STAT_MSG|STAT_CD)) == 0) {
297 /* Set up the count regs to transfer more */
298 nb = cmd->SCp.this_residual;
301 cmd->SCp.this_residual -= nb;
302 writeb(nb, ®s->count_lo);
303 writeb(nb >> 8, ®s->count_mid);
304 writeb(CMD_DMA_MODE + CMD_NOP, ®s->command);
305 writeb(CMD_DMA_MODE + CMD_XFER_DATA, ®s->command);
308 if ((stat & STAT_PHASE) != STAT_CD + STAT_IO) {
309 printk(KERN_DEBUG "intr %x before data xfer complete\n", intr);
311 writel(RUN << 16, &dma->control); /* stop dma */
313 /* should check dma status */
314 writeb(CMD_I_COMPLETE, ®s->command);
315 state->phase = completing;
318 if (intr != INTR_DONE) {
319 printk(KERN_DEBUG "got intr %x on completion\n", intr);
320 cmd_done(state, DID_ERROR << 16);
323 cmd->SCp.Status = readb(®s->fifo);
324 cmd->SCp.Message = readb(®s->fifo);
325 cmd->result = CMD_ACCEPT_MSG;
326 writeb(CMD_ACCEPT_MSG, ®s->command);
327 state->phase = busfreeing;
330 if (intr != INTR_DISCONNECT) {
331 printk(KERN_DEBUG "got intr %x when expected disconnect\n", intr);
333 cmd_done(state, (DID_OK << 16) + (cmd->SCp.Message << 8)
337 printk(KERN_DEBUG "don't know about phase %d\n", state->phase);
341 static void cmd_done(struct fsc_state *state, int result)
343 struct scsi_cmnd *cmd;
345 cmd = state->current_req;
347 cmd->result = result;
348 (*cmd->scsi_done)(cmd);
349 state->current_req = NULL;
352 mac53c94_start(state);
356 * Set up DMA commands for transferring data.
358 static void set_dma_cmds(struct fsc_state *state, struct scsi_cmnd *cmd)
360 int i, dma_cmd, total, nseg;
361 struct scatterlist *scl;
362 struct dbdma_cmd *dcmds;
366 nseg = scsi_dma_map(cmd);
371 dma_cmd = cmd->sc_data_direction == DMA_TO_DEVICE ?
372 OUTPUT_MORE : INPUT_MORE;
373 dcmds = state->dma_cmds;
376 scsi_for_each_sg(cmd, scl, nseg, i) {
377 dma_addr = sg_dma_address(scl);
378 dma_len = sg_dma_len(scl);
379 if (dma_len > 0xffff)
380 panic("mac53c94: scatterlist element >= 64k");
382 st_le16(&dcmds->req_count, dma_len);
383 st_le16(&dcmds->command, dma_cmd);
384 st_le32(&dcmds->phy_addr, dma_addr);
385 dcmds->xfer_status = 0;
389 dma_cmd += OUTPUT_LAST - OUTPUT_MORE;
390 st_le16(&dcmds[-1].command, dma_cmd);
391 st_le16(&dcmds->command, DBDMA_STOP);
392 cmd->SCp.this_residual = total;
395 static struct scsi_host_template mac53c94_template = {
396 .proc_name = "53c94",
398 .queuecommand = mac53c94_queue,
399 .eh_host_reset_handler = mac53c94_host_reset,
402 .sg_tablesize = SG_ALL,
404 .use_clustering = DISABLE_CLUSTERING,
407 static int mac53c94_probe(struct macio_dev *mdev, const struct of_device_id *match)
409 struct device_node *node = macio_get_of_node(mdev);
410 struct pci_dev *pdev = macio_get_pci_dev(mdev);
411 struct fsc_state *state;
412 struct Scsi_Host *host;
414 const unsigned char *clkprop;
415 int proplen, rc = -ENODEV;
417 if (macio_resource_count(mdev) != 2 || macio_irq_count(mdev) != 2) {
418 printk(KERN_ERR "mac53c94: expected 2 addrs and intrs"
420 macio_resource_count(mdev), macio_irq_count(mdev));
424 if (macio_request_resources(mdev, "mac53c94") != 0) {
425 printk(KERN_ERR "mac53c94: unable to request memory resources");
429 host = scsi_host_alloc(&mac53c94_template, sizeof(struct fsc_state));
431 printk(KERN_ERR "mac53c94: couldn't register host");
436 state = (struct fsc_state *) host->hostdata;
437 macio_set_drvdata(mdev, state);
442 state->regs = (struct mac53c94_regs __iomem *)
443 ioremap(macio_resource_start(mdev, 0), 0x1000);
444 state->intr = macio_irq(mdev, 0);
445 state->dma = (struct dbdma_regs __iomem *)
446 ioremap(macio_resource_start(mdev, 1), 0x1000);
447 state->dmaintr = macio_irq(mdev, 1);
448 if (state->regs == NULL || state->dma == NULL) {
449 printk(KERN_ERR "mac53c94: ioremap failed for %s\n",
454 clkprop = of_get_property(node, "clock-frequency", &proplen);
455 if (clkprop == NULL || proplen != sizeof(int)) {
456 printk(KERN_ERR "%s: can't get clock frequency, "
457 "assuming 25MHz\n", node->full_name);
458 state->clk_freq = 25000000;
460 state->clk_freq = *(int *)clkprop;
462 /* Space for dma command list: +1 for stop command,
463 * +1 to allow for aligning.
464 * XXX FIXME: Use DMA consistent routines
466 dma_cmd_space = kmalloc((host->sg_tablesize + 2) *
467 sizeof(struct dbdma_cmd), GFP_KERNEL);
468 if (dma_cmd_space == 0) {
469 printk(KERN_ERR "mac53c94: couldn't allocate dma "
470 "command space for %s\n", node->full_name);
474 state->dma_cmds = (struct dbdma_cmd *)DBDMA_ALIGN(dma_cmd_space);
475 memset(state->dma_cmds, 0, (host->sg_tablesize + 1)
476 * sizeof(struct dbdma_cmd));
477 state->dma_cmd_space = dma_cmd_space;
479 mac53c94_init(state);
481 if (request_irq(state->intr, do_mac53c94_interrupt, 0, "53C94",state)) {
482 printk(KERN_ERR "mac53C94: can't get irq %d for %s\n",
483 state->intr, node->full_name);
487 rc = scsi_add_host(host, &mdev->ofdev.dev);
489 goto out_release_irq;
491 scsi_scan_host(host);
495 free_irq(state->intr, state);
497 kfree(state->dma_cmd_space);
499 if (state->dma != NULL)
501 if (state->regs != NULL)
502 iounmap(state->regs);
505 macio_release_resources(mdev);
510 static int mac53c94_remove(struct macio_dev *mdev)
512 struct fsc_state *fp = (struct fsc_state *)macio_get_drvdata(mdev);
513 struct Scsi_Host *host = fp->host;
515 scsi_remove_host(host);
517 free_irq(fp->intr, fp);
523 kfree(fp->dma_cmd_space);
527 macio_release_resources(mdev);
533 static struct of_device_id mac53c94_match[] =
540 MODULE_DEVICE_TABLE (of, mac53c94_match);
542 static struct macio_driver mac53c94_driver =
545 .match_table = mac53c94_match,
546 .probe = mac53c94_probe,
547 .remove = mac53c94_remove,
551 static int __init init_mac53c94(void)
553 return macio_register_driver(&mac53c94_driver);
556 static void __exit exit_mac53c94(void)
558 return macio_unregister_driver(&mac53c94_driver);
561 module_init(init_mac53c94);
562 module_exit(exit_mac53c94);
564 MODULE_DESCRIPTION("PowerMac 53c94 SCSI driver");
565 MODULE_AUTHOR("Paul Mackerras <paulus@samba.org>");
566 MODULE_LICENSE("GPL");