Merge git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[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 <linux/interrupt.h>
101 #include <asm/io.h>
102 #include <scsi/scsi_host.h>
103 #include <scsi/scsi_device.h>
104 #include <scsi/scsi_transport.h>
105 #include <scsi/scsi_transport_spi.h>
106
107 #include "53c700.h"
108 #include "NCR_D700.h"
109
110 static char *NCR_D700;          /* command line from insmod */
111
112 MODULE_AUTHOR("James Bottomley");
113 MODULE_DESCRIPTION("NCR Dual700 SCSI Driver");
114 MODULE_LICENSE("GPL");
115 module_param(NCR_D700, charp, 0);
116
117 static __u8 __devinitdata id_array[2*(MCA_MAX_SLOT_NR + 1)] =
118         { [0 ... 2*(MCA_MAX_SLOT_NR + 1)-1] = 7 };
119
120 #ifdef MODULE
121 #define ARG_SEP ' '
122 #else
123 #define ARG_SEP ','
124 #endif
125
126 static int __init
127 param_setup(char *string)
128 {
129         char *pos = string, *next;
130         int slot = -1, siop = -1;
131
132         while(pos != NULL && (next = strchr(pos, ':')) != NULL) {
133                 int val = (int)simple_strtoul(++next, NULL, 0);
134
135                 if(!strncmp(pos, "slot:", 5))
136                         slot = val;
137                 else if(!strncmp(pos, "siop:", 5))
138                         siop = val;
139                 else if(!strncmp(pos, "id:", 3)) {
140                         if(slot == -1) {
141                                 printk(KERN_WARNING "NCR D700: Must specify slot for id parameter\n");
142                         } else if(slot > MCA_MAX_SLOT_NR) {
143                                 printk(KERN_WARNING "NCR D700: Illegal slot %d for id %d\n", slot, val);
144                         } else {
145                                 if(siop != 0 && siop != 1) {
146                                         id_array[slot*2] = val;
147                                         id_array[slot*2 + 1] =val;
148                                 } else {
149                                         id_array[slot*2 + siop] = val;
150                                 }
151                         }
152                 }
153                 if((pos = strchr(pos, ARG_SEP)) != NULL)
154                         pos++;
155         }
156         return 1;
157 }
158
159 /* Host template.  The 53c700 routine NCR_700_detect will
160  * fill in all of the missing routines */
161 static struct scsi_host_template NCR_D700_driver_template = {
162         .module                 = THIS_MODULE,
163         .name                   = "NCR Dual 700 MCA",
164         .proc_name              = "NCR_D700",
165         .this_id                = 7,
166 };
167
168 /* We needs this helper because we have two hosts per struct device */
169 struct NCR_D700_private {
170         struct device           *dev;
171         struct Scsi_Host        *hosts[2];
172         char                    name[30];
173         char                    pad;
174 };
175
176 static int __devinit
177 NCR_D700_probe_one(struct NCR_D700_private *p, int siop, int irq,
178                    int slot, u32 region, int differential)
179 {
180         struct NCR_700_Host_Parameters *hostdata;
181         struct Scsi_Host *host;
182         int ret;
183
184         hostdata = kmalloc(sizeof(*hostdata), GFP_KERNEL);
185         if (!hostdata) {
186                 printk(KERN_ERR "NCR D700: SIOP%d: Failed to allocate host"
187                        "data, detatching\n", siop);
188                 return -ENOMEM;
189         }
190         memset(hostdata, 0, sizeof(*hostdata));
191
192         if (!request_region(region, 64, "NCR_D700")) {
193                 printk(KERN_ERR "NCR D700: Failed to reserve IO region 0x%x\n",
194                                 region);
195                 ret = -ENODEV;
196                 goto region_failed;
197         }
198                 
199         /* Fill in the three required pieces of hostdata */
200         hostdata->base = ioport_map(region, 64);
201         hostdata->differential = (((1<<siop) & differential) != 0);
202         hostdata->clock = NCR_D700_CLOCK_MHZ;
203         hostdata->burst_length = 8;
204
205         /* and register the siop */
206         host = NCR_700_detect(&NCR_D700_driver_template, hostdata, p->dev);
207         if (!host) {
208                 ret = -ENOMEM;
209                 goto detect_failed;
210         }
211
212         p->hosts[siop] = host;
213         /* FIXME: read this from SUS */
214         host->this_id = id_array[slot * 2 + siop];
215         host->irq = irq;
216         host->base = region;
217         scsi_scan_host(host);
218
219         return 0;
220
221  detect_failed:
222         release_region(region, 64);
223  region_failed:
224         kfree(hostdata);
225
226         return ret;
227 }
228
229 static int
230 NCR_D700_intr(int irq, void *data)
231 {
232         struct NCR_D700_private *p = (struct NCR_D700_private *)data;
233         int i, found = 0;
234
235         for (i = 0; i < 2; i++)
236                 if (p->hosts[i] &&
237                     NCR_700_intr(irq, p->hosts[i]) == IRQ_HANDLED)
238                         found++;
239
240         return found ? IRQ_HANDLED : IRQ_NONE;
241 }
242
243 /* Detect a D700 card.  Note, because of the setup --- the chips are
244  * essentially connectecd to the MCA bus independently, it is easier
245  * to set them up as two separate host adapters, rather than one
246  * adapter with two channels */
247 static int __devinit
248 NCR_D700_probe(struct device *dev)
249 {
250         struct NCR_D700_private *p;
251         int differential;
252         static int banner = 1;
253         struct mca_device *mca_dev = to_mca_device(dev);
254         int slot = mca_dev->slot;
255         int found = 0;
256         int irq, i;
257         int pos3j, pos3k, pos3a, pos3b, pos4;
258         __u32 base_addr, offset_addr;
259
260         /* enable board interrupt */
261         pos4 = mca_device_read_pos(mca_dev, 4);
262         pos4 |= 0x4;
263         mca_device_write_pos(mca_dev, 4, pos4);
264
265         mca_device_write_pos(mca_dev, 6, 9);
266         pos3j = mca_device_read_pos(mca_dev, 3);
267         mca_device_write_pos(mca_dev, 6, 10);
268         pos3k = mca_device_read_pos(mca_dev, 3);
269         mca_device_write_pos(mca_dev, 6, 0);
270         pos3a = mca_device_read_pos(mca_dev, 3);
271         mca_device_write_pos(mca_dev, 6, 1);
272         pos3b = mca_device_read_pos(mca_dev, 3);
273
274         base_addr = ((pos3j << 8) | pos3k) & 0xfffffff0;
275         offset_addr = ((pos3a << 8) | pos3b) & 0xffffff70;
276
277         irq = (pos4 & 0x3) + 11;
278         if(irq >= 13)
279                 irq++;
280         if(banner) {
281                 printk(KERN_NOTICE "NCR D700: Driver Version " NCR_D700_VERSION "\n"
282                        "NCR D700:  Copyright (c) 2001 by James.Bottomley@HansenPartnership.com\n"
283                        "NCR D700:\n");
284                 banner = 0;
285         }
286         /* now do the bus related transforms */
287         irq = mca_device_transform_irq(mca_dev, irq);
288         base_addr = mca_device_transform_ioport(mca_dev, base_addr);
289         offset_addr = mca_device_transform_ioport(mca_dev, offset_addr);
290
291         printk(KERN_NOTICE "NCR D700: found in slot %d  irq = %d  I/O base = 0x%x\n", slot, irq, offset_addr);
292
293         /*outb(BOARD_RESET, base_addr);*/
294
295         /* clear any pending interrupts */
296         (void)inb(base_addr + 0x08);
297         /* get modctl, used later for setting diff bits */
298         switch(differential = (inb(base_addr + 0x08) >> 6)) {
299         case 0x00:
300                 /* only SIOP1 differential */
301                 differential = 0x02;
302                 break;
303         case 0x01:
304                 /* Both SIOPs differential */
305                 differential = 0x03;
306                 break;
307         case 0x03:
308                 /* No SIOPs differential */
309                 differential = 0x00;
310                 break;
311         default:
312                 printk(KERN_ERR "D700: UNEXPECTED DIFFERENTIAL RESULT 0x%02x\n",
313                        differential);
314                 differential = 0x00;
315                 break;
316         }
317
318         p = kmalloc(sizeof(*p), GFP_KERNEL);
319         if (!p)
320                 return -ENOMEM;
321         memset(p, '\0', sizeof(*p));
322         p->dev = dev;
323         snprintf(p->name, sizeof(p->name), "D700(%s)", dev->bus_id);
324         if (request_irq(irq, NCR_D700_intr, IRQF_SHARED, p->name, p)) {
325                 printk(KERN_ERR "D700: request_irq failed\n");
326                 kfree(p);
327                 return -EBUSY;
328         }
329         /* plumb in both 700 chips */
330         for (i = 0; i < 2; i++) {
331                 int err;
332
333                 if ((err = NCR_D700_probe_one(p, i, irq, slot,
334                                               offset_addr + (0x80 * i),
335                                               differential)) != 0)
336                         printk("D700: SIOP%d: probe failed, error = %d\n",
337                                i, err);
338                 else
339                         found++;
340         }
341
342         if (!found) {
343                 kfree(p);
344                 return -ENODEV;
345         }
346
347         mca_device_set_claim(mca_dev, 1);
348         mca_device_set_name(mca_dev, "NCR_D700");
349         dev_set_drvdata(dev, p);
350         return 0;
351 }
352
353 static void __devexit
354 NCR_D700_remove_one(struct Scsi_Host *host)
355 {
356         scsi_remove_host(host);
357         NCR_700_release(host);
358         kfree((struct NCR_700_Host_Parameters *)host->hostdata[0]);
359         free_irq(host->irq, host);
360         release_region(host->base, 64);
361 }
362
363 static int __devexit
364 NCR_D700_remove(struct device *dev)
365 {
366         struct NCR_D700_private *p = dev_get_drvdata(dev);
367         int i;
368
369         for (i = 0; i < 2; i++)
370                 NCR_D700_remove_one(p->hosts[i]);
371
372         kfree(p);
373         return 0;
374 }
375
376 static short NCR_D700_id_table[] = { NCR_D700_MCA_ID, 0 };
377
378 static struct mca_driver NCR_D700_driver = {
379         .id_table = NCR_D700_id_table,
380         .driver = {
381                 .name           = "NCR_D700",
382                 .bus            = &mca_bus_type,
383                 .probe          = NCR_D700_probe,
384                 .remove         = __devexit_p(NCR_D700_remove),
385         },
386 };
387
388 static int __init NCR_D700_init(void)
389 {
390 #ifdef MODULE
391         if (NCR_D700)
392                 param_setup(NCR_D700);
393 #endif
394
395         return mca_register_driver(&NCR_D700_driver);
396 }
397
398 static void __exit NCR_D700_exit(void)
399 {
400         mca_unregister_driver(&NCR_D700_driver);
401 }
402
403 module_init(NCR_D700_init);
404 module_exit(NCR_D700_exit);
405
406 __setup("NCR_D700=", param_setup);