Merge git://git.kernel.org/pub/scm/linux/kernel/git/mingo/linux-2.6-sched
[linux-2.6] / drivers / scsi / NCR_D700.c
1 /* -*- mode: c; c-basic-offset: 8 -*- */
2
3 /* NCR Dual 700 MCA SCSI Driver
4  *
5  * Copyright (C) 2001 by James.Bottomley@HansenPartnership.com
6 **-----------------------------------------------------------------------------
7 **  
8 **  This program is free software; you can redistribute it and/or modify
9 **  it under the terms of the GNU General Public License as published by
10 **  the Free Software Foundation; either version 2 of the License, or
11 **  (at your option) any later version.
12 **
13 **  This program is distributed in the hope that it will be useful,
14 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
15 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 **  GNU General Public License for more details.
17 **
18 **  You should have received a copy of the GNU General Public License
19 **  along with this program; if not, write to the Free Software
20 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 **
22 **-----------------------------------------------------------------------------
23  */
24
25 /* Notes:
26  *
27  * Most of the work is done in the chip specific module, 53c700.o
28  *
29  * TODO List:
30  *
31  * 1. Extract the SCSI ID from the voyager CMOS table (necessary to
32  *    support multi-host environments.
33  *
34  * */
35
36
37 /* CHANGELOG 
38  *
39  * Version 2.2
40  *
41  * Added mca_set_adapter_name().
42  *
43  * Version 2.1
44  *
45  * Modularise the driver into a Board piece (this file) and a chip
46  * piece 53c700.[ch] and 53c700.scr, added module options.  You can
47  * now specify the scsi id by the parameters
48  *
49  * NCR_D700=slot:<n> [siop:<n>] id:<n> ....
50  *
51  * They need to be comma separated if compiled into the kernel
52  *
53  * Version 2.0
54  *
55  * Initial implementation of TCQ (Tag Command Queueing).  TCQ is full
56  * featured and uses the clock algorithm to keep track of outstanding
57  * tags and guard against individual tag starvation.  Also fixed a bug
58  * in all of the 1.x versions where the D700_data_residue() function
59  * was returning results off by 32 bytes (and thus causing the same 32
60  * bytes to be written twice corrupting the data block).  It turns out
61  * the 53c700 only has a 6 bit DBC and DFIFO registers not 7 bit ones
62  * like the 53c710 (The 710 is the only data manual still available,
63  * which I'd been using to program the 700).
64  *
65  * Version 1.2
66  *
67  * Much improved message handling engine
68  *
69  * Version 1.1
70  *
71  * Add code to handle selection reasonably correctly.  By the time we
72  * get the selection interrupt, we've already responded, but drop off the
73  * bus and hope the selector will go away.
74  *
75  * Version 1.0:
76  *
77  *   Initial release.  Fully functional except for procfs and tag
78  * command queueing.  Has only been tested on cards with 53c700-66
79  * chips and only single ended. Features are
80  *
81  * 1. Synchronous data transfers to offset 8 (limit of 700-66) and
82  *    100ns (10MHz) limit of SCSI-2
83  *
84  * 2. Disconnection and reselection
85  *
86  * Testing:
87  * 
88  *  I've only really tested this with the 700-66 chip, but have done
89  * soak tests in multi-device environments to verify that
90  * disconnections and reselections are being processed correctly.
91  * */
92
93 #define NCR_D700_VERSION "2.2"
94
95 #include <linux/blkdev.h>
96 #include <linux/interrupt.h>
97 #include <linux/kernel.h>
98 #include <linux/module.h>
99 #include <linux/mca.h>
100 #include <asm/io.h>
101 #include <scsi/scsi_host.h>
102 #include <scsi/scsi_device.h>
103 #include <scsi/scsi_transport.h>
104 #include <scsi/scsi_transport_spi.h>
105
106 #include "53c700.h"
107 #include "NCR_D700.h"
108
109 static char *NCR_D700;          /* command line from insmod */
110
111 MODULE_AUTHOR("James Bottomley");
112 MODULE_DESCRIPTION("NCR Dual700 SCSI Driver");
113 MODULE_LICENSE("GPL");
114 module_param(NCR_D700, charp, 0);
115
116 static __u8 __devinitdata id_array[2*(MCA_MAX_SLOT_NR + 1)] =
117         { [0 ... 2*(MCA_MAX_SLOT_NR + 1)-1] = 7 };
118
119 #ifdef MODULE
120 #define ARG_SEP ' '
121 #else
122 #define ARG_SEP ','
123 #endif
124
125 static int __init
126 param_setup(char *string)
127 {
128         char *pos = string, *next;
129         int slot = -1, siop = -1;
130
131         while(pos != NULL && (next = strchr(pos, ':')) != NULL) {
132                 int val = (int)simple_strtoul(++next, NULL, 0);
133
134                 if(!strncmp(pos, "slot:", 5))
135                         slot = val;
136                 else if(!strncmp(pos, "siop:", 5))
137                         siop = val;
138                 else if(!strncmp(pos, "id:", 3)) {
139                         if(slot == -1) {
140                                 printk(KERN_WARNING "NCR D700: Must specify slot for id parameter\n");
141                         } else if(slot > MCA_MAX_SLOT_NR) {
142                                 printk(KERN_WARNING "NCR D700: Illegal slot %d for id %d\n", slot, val);
143                         } else {
144                                 if(siop != 0 && siop != 1) {
145                                         id_array[slot*2] = val;
146                                         id_array[slot*2 + 1] =val;
147                                 } else {
148                                         id_array[slot*2 + siop] = val;
149                                 }
150                         }
151                 }
152                 if((pos = strchr(pos, ARG_SEP)) != NULL)
153                         pos++;
154         }
155         return 1;
156 }
157
158 /* Host template.  The 53c700 routine NCR_700_detect will
159  * fill in all of the missing routines */
160 static struct scsi_host_template NCR_D700_driver_template = {
161         .module                 = THIS_MODULE,
162         .name                   = "NCR Dual 700 MCA",
163         .proc_name              = "NCR_D700",
164         .this_id                = 7,
165 };
166
167 /* We needs this helper because we have two hosts per struct device */
168 struct NCR_D700_private {
169         struct device           *dev;
170         struct Scsi_Host        *hosts[2];
171         char                    name[30];
172         char                    pad;
173 };
174
175 static int __devinit
176 NCR_D700_probe_one(struct NCR_D700_private *p, int siop, int irq,
177                    int slot, u32 region, int differential)
178 {
179         struct NCR_700_Host_Parameters *hostdata;
180         struct Scsi_Host *host;
181         int ret;
182
183         hostdata = kzalloc(sizeof(*hostdata), GFP_KERNEL);
184         if (!hostdata) {
185                 printk(KERN_ERR "NCR D700: SIOP%d: Failed to allocate host"
186                        "data, detatching\n", siop);
187                 return -ENOMEM;
188         }
189
190         if (!request_region(region, 64, "NCR_D700")) {
191                 printk(KERN_ERR "NCR D700: Failed to reserve IO region 0x%x\n",
192                                 region);
193                 ret = -ENODEV;
194                 goto region_failed;
195         }
196                 
197         /* Fill in the three required pieces of hostdata */
198         hostdata->base = ioport_map(region, 64);
199         hostdata->differential = (((1<<siop) & differential) != 0);
200         hostdata->clock = NCR_D700_CLOCK_MHZ;
201         hostdata->burst_length = 8;
202
203         /* and register the siop */
204         host = NCR_700_detect(&NCR_D700_driver_template, hostdata, p->dev);
205         if (!host) {
206                 ret = -ENOMEM;
207                 goto detect_failed;
208         }
209
210         p->hosts[siop] = host;
211         /* FIXME: read this from SUS */
212         host->this_id = id_array[slot * 2 + siop];
213         host->irq = irq;
214         host->base = region;
215         scsi_scan_host(host);
216
217         return 0;
218
219  detect_failed:
220         release_region(region, 64);
221  region_failed:
222         kfree(hostdata);
223
224         return ret;
225 }
226
227 static int
228 NCR_D700_intr(int irq, void *data)
229 {
230         struct NCR_D700_private *p = (struct NCR_D700_private *)data;
231         int i, found = 0;
232
233         for (i = 0; i < 2; i++)
234                 if (p->hosts[i] &&
235                     NCR_700_intr(irq, p->hosts[i]) == IRQ_HANDLED)
236                         found++;
237
238         return found ? IRQ_HANDLED : IRQ_NONE;
239 }
240
241 /* Detect a D700 card.  Note, because of the setup --- the chips are
242  * essentially connectecd to the MCA bus independently, it is easier
243  * to set them up as two separate host adapters, rather than one
244  * adapter with two channels */
245 static int __devinit
246 NCR_D700_probe(struct device *dev)
247 {
248         struct NCR_D700_private *p;
249         int differential;
250         static int banner = 1;
251         struct mca_device *mca_dev = to_mca_device(dev);
252         int slot = mca_dev->slot;
253         int found = 0;
254         int irq, i;
255         int pos3j, pos3k, pos3a, pos3b, pos4;
256         __u32 base_addr, offset_addr;
257
258         /* enable board interrupt */
259         pos4 = mca_device_read_pos(mca_dev, 4);
260         pos4 |= 0x4;
261         mca_device_write_pos(mca_dev, 4, pos4);
262
263         mca_device_write_pos(mca_dev, 6, 9);
264         pos3j = mca_device_read_pos(mca_dev, 3);
265         mca_device_write_pos(mca_dev, 6, 10);
266         pos3k = mca_device_read_pos(mca_dev, 3);
267         mca_device_write_pos(mca_dev, 6, 0);
268         pos3a = mca_device_read_pos(mca_dev, 3);
269         mca_device_write_pos(mca_dev, 6, 1);
270         pos3b = mca_device_read_pos(mca_dev, 3);
271
272         base_addr = ((pos3j << 8) | pos3k) & 0xfffffff0;
273         offset_addr = ((pos3a << 8) | pos3b) & 0xffffff70;
274
275         irq = (pos4 & 0x3) + 11;
276         if(irq >= 13)
277                 irq++;
278         if(banner) {
279                 printk(KERN_NOTICE "NCR D700: Driver Version " NCR_D700_VERSION "\n"
280                        "NCR D700:  Copyright (c) 2001 by James.Bottomley@HansenPartnership.com\n"
281                        "NCR D700:\n");
282                 banner = 0;
283         }
284         /* now do the bus related transforms */
285         irq = mca_device_transform_irq(mca_dev, irq);
286         base_addr = mca_device_transform_ioport(mca_dev, base_addr);
287         offset_addr = mca_device_transform_ioport(mca_dev, offset_addr);
288
289         printk(KERN_NOTICE "NCR D700: found in slot %d  irq = %d  I/O base = 0x%x\n", slot, irq, offset_addr);
290
291         /*outb(BOARD_RESET, base_addr);*/
292
293         /* clear any pending interrupts */
294         (void)inb(base_addr + 0x08);
295         /* get modctl, used later for setting diff bits */
296         switch(differential = (inb(base_addr + 0x08) >> 6)) {
297         case 0x00:
298                 /* only SIOP1 differential */
299                 differential = 0x02;
300                 break;
301         case 0x01:
302                 /* Both SIOPs differential */
303                 differential = 0x03;
304                 break;
305         case 0x03:
306                 /* No SIOPs differential */
307                 differential = 0x00;
308                 break;
309         default:
310                 printk(KERN_ERR "D700: UNEXPECTED DIFFERENTIAL RESULT 0x%02x\n",
311                        differential);
312                 differential = 0x00;
313                 break;
314         }
315
316         p = kzalloc(sizeof(*p), GFP_KERNEL);
317         if (!p)
318                 return -ENOMEM;
319
320         p->dev = dev;
321         snprintf(p->name, sizeof(p->name), "D700(%s)", dev->bus_id);
322         if (request_irq(irq, NCR_D700_intr, IRQF_SHARED, p->name, p)) {
323                 printk(KERN_ERR "D700: request_irq failed\n");
324                 kfree(p);
325                 return -EBUSY;
326         }
327         /* plumb in both 700 chips */
328         for (i = 0; i < 2; i++) {
329                 int err;
330
331                 if ((err = NCR_D700_probe_one(p, i, irq, slot,
332                                               offset_addr + (0x80 * i),
333                                               differential)) != 0)
334                         printk("D700: SIOP%d: probe failed, error = %d\n",
335                                i, err);
336                 else
337                         found++;
338         }
339
340         if (!found) {
341                 kfree(p);
342                 return -ENODEV;
343         }
344
345         mca_device_set_claim(mca_dev, 1);
346         mca_device_set_name(mca_dev, "NCR_D700");
347         dev_set_drvdata(dev, p);
348         return 0;
349 }
350
351 static void __devexit
352 NCR_D700_remove_one(struct Scsi_Host *host)
353 {
354         scsi_remove_host(host);
355         NCR_700_release(host);
356         kfree((struct NCR_700_Host_Parameters *)host->hostdata[0]);
357         free_irq(host->irq, host);
358         release_region(host->base, 64);
359 }
360
361 static int __devexit
362 NCR_D700_remove(struct device *dev)
363 {
364         struct NCR_D700_private *p = dev_get_drvdata(dev);
365         int i;
366
367         for (i = 0; i < 2; i++)
368                 NCR_D700_remove_one(p->hosts[i]);
369
370         kfree(p);
371         return 0;
372 }
373
374 static short NCR_D700_id_table[] = { NCR_D700_MCA_ID, 0 };
375
376 static struct mca_driver NCR_D700_driver = {
377         .id_table = NCR_D700_id_table,
378         .driver = {
379                 .name           = "NCR_D700",
380                 .bus            = &mca_bus_type,
381                 .probe          = NCR_D700_probe,
382                 .remove         = __devexit_p(NCR_D700_remove),
383         },
384 };
385
386 static int __init NCR_D700_init(void)
387 {
388 #ifdef MODULE
389         if (NCR_D700)
390                 param_setup(NCR_D700);
391 #endif
392
393         return mca_register_driver(&NCR_D700_driver);
394 }
395
396 static void __exit NCR_D700_exit(void)
397 {
398         mca_unregister_driver(&NCR_D700_driver);
399 }
400
401 module_init(NCR_D700_init);
402 module_exit(NCR_D700_exit);
403
404 __setup("NCR_D700=", param_setup);