[SCSI] small cleanups
[linux-2.6] / drivers / scsi / a100u2w.c
1 /*
2  * Initio A100 device driver for Linux.
3  *
4  * Copyright (c) 1994-1998 Initio Corporation
5  * Copyright (c) 2003-2004 Christoph Hellwig
6  * All rights reserved.
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, or (at your option)
11  * 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; see the file COPYING.  If not, write to
20  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
26  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 /*
36  * Revision History:
37  * 07/02/98 hl  - v.91n Initial drivers.
38  * 09/14/98 hl - v1.01 Support new Kernel.
39  * 09/22/98 hl - v1.01a Support reset.
40  * 09/24/98 hl - v1.01b Fixed reset.
41  * 10/05/98 hl - v1.02 split the source code and release.
42  * 12/19/98 bv - v1.02a Use spinlocks for 2.1.95 and up
43  * 01/31/99 bv - v1.02b Use mdelay instead of waitForPause
44  * 08/08/99 bv - v1.02c Use waitForPause again.
45  * 06/25/02 Doug Ledford <dledford@redhat.com> - v1.02d
46  *          - Remove limit on number of controllers
47  *          - Port to DMA mapping API
48  *          - Clean up interrupt handler registration
49  *          - Fix memory leaks
50  *          - Fix allocation of scsi host structs and private data
51  * 11/18/03 Christoph Hellwig <hch@lst.de>
52  *          - Port to new probing API
53  *          - Fix some more leaks in init failure cases
54  * 9/28/04 Christoph Hellwig <hch@lst.de>
55  *          - merge the two source files
56  *          - remove internal queueing code
57  * 14/06/07 Alan Cox <alan@redhat.com>
58  *       - Grand cleanup and Linuxisation
59  */
60
61 #include <linux/module.h>
62 #include <linux/errno.h>
63 #include <linux/delay.h>
64 #include <linux/interrupt.h>
65 #include <linux/pci.h>
66 #include <linux/init.h>
67 #include <linux/blkdev.h>
68 #include <linux/spinlock.h>
69 #include <linux/kernel.h>
70 #include <linux/string.h>
71 #include <linux/ioport.h>
72 #include <linux/slab.h>
73 #include <linux/dma-mapping.h>
74
75 #include <asm/io.h>
76 #include <asm/irq.h>
77
78 #include <scsi/scsi.h>
79 #include <scsi/scsi_cmnd.h>
80 #include <scsi/scsi_device.h>
81 #include <scsi/scsi_host.h>
82
83 #include "a100u2w.h"
84
85
86 static struct orc_scb *__orc_alloc_scb(struct orc_host * host);
87 static void inia100_scb_handler(struct orc_host *host, struct orc_scb *scb);
88
89 static struct orc_nvram nvram, *nvramp = &nvram;
90
91 static u8 default_nvram[64] =
92 {
93 /*----------header -------------*/
94         0x01,                   /* 0x00: Sub System Vendor ID 0 */
95         0x11,                   /* 0x01: Sub System Vendor ID 1 */
96         0x60,                   /* 0x02: Sub System ID 0        */
97         0x10,                   /* 0x03: Sub System ID 1        */
98         0x00,                   /* 0x04: SubClass               */
99         0x01,                   /* 0x05: Vendor ID 0            */
100         0x11,                   /* 0x06: Vendor ID 1            */
101         0x60,                   /* 0x07: Device ID 0            */
102         0x10,                   /* 0x08: Device ID 1            */
103         0x00,                   /* 0x09: Reserved               */
104         0x00,                   /* 0x0A: Reserved               */
105         0x01,                   /* 0x0B: Revision of Data Structure     */
106                                 /* -- Host Adapter Structure --- */
107         0x01,                   /* 0x0C: Number Of SCSI Channel */
108         0x01,                   /* 0x0D: BIOS Configuration 1   */
109         0x00,                   /* 0x0E: BIOS Configuration 2   */
110         0x00,                   /* 0x0F: BIOS Configuration 3   */
111                                 /* --- SCSI Channel 0 Configuration --- */
112         0x07,                   /* 0x10: H/A ID                 */
113         0x83,                   /* 0x11: Channel Configuration  */
114         0x20,                   /* 0x12: MAX TAG per target     */
115         0x0A,                   /* 0x13: SCSI Reset Recovering time     */
116         0x00,                   /* 0x14: Channel Configuration4 */
117         0x00,                   /* 0x15: Channel Configuration5 */
118                                 /* SCSI Channel 0 Target Configuration  */
119                                 /* 0x16-0x25                    */
120         0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8,
121         0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8,
122                                 /* --- SCSI Channel 1 Configuration --- */
123         0x07,                   /* 0x26: H/A ID                 */
124         0x83,                   /* 0x27: Channel Configuration  */
125         0x20,                   /* 0x28: MAX TAG per target     */
126         0x0A,                   /* 0x29: SCSI Reset Recovering time     */
127         0x00,                   /* 0x2A: Channel Configuration4 */
128         0x00,                   /* 0x2B: Channel Configuration5 */
129                                 /* SCSI Channel 1 Target Configuration  */
130                                 /* 0x2C-0x3B                    */
131         0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8,
132         0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8, 0xC8,
133         0x00,                   /* 0x3C: Reserved               */
134         0x00,                   /* 0x3D: Reserved               */
135         0x00,                   /* 0x3E: Reserved               */
136         0x00                    /* 0x3F: Checksum               */
137 };
138
139
140 static u8 wait_chip_ready(struct orc_host * host)
141 {
142         int i;
143
144         for (i = 0; i < 10; i++) {      /* Wait 1 second for report timeout     */
145                 if (inb(host->base + ORC_HCTRL) & HOSTSTOP)     /* Wait HOSTSTOP set */
146                         return 1;
147                 mdelay(100);
148         }
149         return 0;
150 }
151
152 static u8 wait_firmware_ready(struct orc_host * host)
153 {
154         int i;
155
156         for (i = 0; i < 10; i++) {      /* Wait 1 second for report timeout     */
157                 if (inb(host->base + ORC_HSTUS) & RREADY)               /* Wait READY set */
158                         return 1;
159                 mdelay(100);    /* wait 100ms before try again  */
160         }
161         return 0;
162 }
163
164 /***************************************************************************/
165 static u8 wait_scsi_reset_done(struct orc_host * host)
166 {
167         int i;
168
169         for (i = 0; i < 10; i++) {      /* Wait 1 second for report timeout     */
170                 if (!(inb(host->base + ORC_HCTRL) & SCSIRST))   /* Wait SCSIRST done */
171                         return 1;
172                 mdelay(100);    /* wait 100ms before try again  */
173         }
174         return 0;
175 }
176
177 /***************************************************************************/
178 static u8 wait_HDO_off(struct orc_host * host)
179 {
180         int i;
181
182         for (i = 0; i < 10; i++) {      /* Wait 1 second for report timeout     */
183                 if (!(inb(host->base + ORC_HCTRL) & HDO))               /* Wait HDO off */
184                         return 1;
185                 mdelay(100);    /* wait 100ms before try again  */
186         }
187         return 0;
188 }
189
190 /***************************************************************************/
191 static u8 wait_hdi_set(struct orc_host * host, u8 * data)
192 {
193         int i;
194
195         for (i = 0; i < 10; i++) {      /* Wait 1 second for report timeout     */
196                 if ((*data = inb(host->base + ORC_HSTUS)) & HDI)
197                         return 1;       /* Wait HDI set */
198                 mdelay(100);    /* wait 100ms before try again  */
199         }
200         return 0;
201 }
202
203 /***************************************************************************/
204 static unsigned short orc_read_fwrev(struct orc_host * host)
205 {
206         u16 version;
207         u8 data;
208
209         outb(ORC_CMD_VERSION, host->base + ORC_HDATA);
210         outb(HDO, host->base + ORC_HCTRL);
211         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
212                 return 0;
213
214         if (wait_hdi_set(host, &data) == 0)     /* Wait HDI set   */
215                 return 0;
216         version = inb(host->base + ORC_HDATA);
217         outb(data, host->base + ORC_HSTUS);     /* Clear HDI            */
218
219         if (wait_hdi_set(host, &data) == 0)     /* Wait HDI set   */
220                 return 0;
221         version |= inb(host->base + ORC_HDATA) << 8;
222         outb(data, host->base + ORC_HSTUS);     /* Clear HDI            */
223
224         return version;
225 }
226
227 /***************************************************************************/
228 static u8 orc_nv_write(struct orc_host * host, unsigned char address, unsigned char value)
229 {
230         outb(ORC_CMD_SET_NVM, host->base + ORC_HDATA);  /* Write command */
231         outb(HDO, host->base + ORC_HCTRL);
232         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
233                 return 0;
234
235         outb(address, host->base + ORC_HDATA);  /* Write address */
236         outb(HDO, host->base + ORC_HCTRL);
237         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
238                 return 0;
239
240         outb(value, host->base + ORC_HDATA);    /* Write value  */
241         outb(HDO, host->base + ORC_HCTRL);
242         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
243                 return 0;
244
245         return 1;
246 }
247
248 /***************************************************************************/
249 static u8 orc_nv_read(struct orc_host * host, u8 address, u8 *ptr)
250 {
251         unsigned char data;
252
253         outb(ORC_CMD_GET_NVM, host->base + ORC_HDATA);  /* Write command */
254         outb(HDO, host->base + ORC_HCTRL);
255         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
256                 return 0;
257
258         outb(address, host->base + ORC_HDATA);  /* Write address */
259         outb(HDO, host->base + ORC_HCTRL);
260         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
261                 return 0;
262
263         if (wait_hdi_set(host, &data) == 0)     /* Wait HDI set   */
264                 return 0;
265         *ptr = inb(host->base + ORC_HDATA);
266         outb(data, host->base + ORC_HSTUS);     /* Clear HDI    */
267
268         return 1;
269
270 }
271
272 /**
273  *      orc_exec_sb             -       Queue an SCB with the HA
274  *      @host: host adapter the SCB belongs to
275  *      @scb: SCB to queue for execution
276  */
277
278 static void orc_exec_scb(struct orc_host * host, struct orc_scb * scb)
279 {
280         scb->status = ORCSCB_POST;
281         outb(scb->scbidx, host->base + ORC_PQUEUE);
282 }
283
284
285 /**
286  *      se2_rd_all      -       read SCSI parameters from EEPROM
287  *      @host: Host whose EEPROM is being loaded
288  *
289  *      Read SCSI H/A configuration parameters from serial EEPROM
290  */
291
292 static int se2_rd_all(struct orc_host * host)
293 {
294         int i;
295         u8 *np, chksum = 0;
296
297         np = (u8 *) nvramp;
298         for (i = 0; i < 64; i++, np++) {        /* <01> */
299                 if (orc_nv_read(host, (u8) i, np) == 0)
300                         return -1;
301         }
302
303         /*------ Is ckecksum ok ? ------*/
304         np = (u8 *) nvramp;
305         for (i = 0; i < 63; i++)
306                 chksum += *np++;
307
308         if (nvramp->CheckSum != (u8) chksum)
309                 return -1;
310         return 1;
311 }
312
313 /**
314  *      se2_update_all          -       update the EEPROM
315  *      @host: Host whose EEPROM is being updated
316  *
317  *      Update changed bytes in the EEPROM image.
318  */
319
320 static void se2_update_all(struct orc_host * host)
321 {                               /* setup default pattern  */
322         int i;
323         u8 *np, *np1, chksum = 0;
324
325         /* Calculate checksum first   */
326         np = (u8 *) default_nvram;
327         for (i = 0; i < 63; i++)
328                 chksum += *np++;
329         *np = chksum;
330
331         np = (u8 *) default_nvram;
332         np1 = (u8 *) nvramp;
333         for (i = 0; i < 64; i++, np++, np1++) {
334                 if (*np != *np1)
335                         orc_nv_write(host, (u8) i, *np);
336         }
337 }
338
339 /**
340  *      read_eeprom             -       load EEPROM
341  *      @host: Host EEPROM to read
342  *
343  *      Read the EEPROM for a given host. If it is invalid or fails
344  *      the restore the defaults and use them.
345  */
346
347 static void read_eeprom(struct orc_host * host)
348 {
349         if (se2_rd_all(host) != 1) {
350                 se2_update_all(host);   /* setup default pattern        */
351                 se2_rd_all(host);       /* load again                   */
352         }
353 }
354
355
356 /**
357  *      orc_load_firmware       -       initialise firmware
358  *      @host: Host to set up
359  *
360  *      Load the firmware from the EEPROM into controller SRAM. This
361  *      is basically a 4K block copy and then a 4K block read to check
362  *      correctness. The rest is convulted by the indirect interfaces
363  *      in the hardware
364  */
365
366 static u8 orc_load_firmware(struct orc_host * host)
367 {
368         u32 data32;
369         u16 bios_addr;
370         u16 i;
371         u8 *data32_ptr, data;
372
373
374         /* Set up the EEPROM for access */
375
376         data = inb(host->base + ORC_GCFG);
377         outb(data | EEPRG, host->base + ORC_GCFG);      /* Enable EEPROM programming */
378         outb(0x00, host->base + ORC_EBIOSADR2);
379         outw(0x0000, host->base + ORC_EBIOSADR0);
380         if (inb(host->base + ORC_EBIOSDATA) != 0x55) {
381                 outb(data, host->base + ORC_GCFG);      /* Disable EEPROM programming */
382                 return 0;
383         }
384         outw(0x0001, host->base + ORC_EBIOSADR0);
385         if (inb(host->base + ORC_EBIOSDATA) != 0xAA) {
386                 outb(data, host->base + ORC_GCFG);      /* Disable EEPROM programming */
387                 return 0;
388         }
389
390         outb(PRGMRST | DOWNLOAD, host->base + ORC_RISCCTL);     /* Enable SRAM programming */
391         data32_ptr = (u8 *) & data32;
392         data32 = 0;             /* Initial FW address to 0 */
393         outw(0x0010, host->base + ORC_EBIOSADR0);
394         *data32_ptr = inb(host->base + ORC_EBIOSDATA);          /* Read from BIOS */
395         outw(0x0011, host->base + ORC_EBIOSADR0);
396         *(data32_ptr + 1) = inb(host->base + ORC_EBIOSDATA);    /* Read from BIOS */
397         outw(0x0012, host->base + ORC_EBIOSADR0);
398         *(data32_ptr + 2) = inb(host->base + ORC_EBIOSDATA);    /* Read from BIOS */
399         outw(*(data32_ptr + 2), host->base + ORC_EBIOSADR2);
400         outl(data32, host->base + ORC_FWBASEADR);               /* Write FW address */
401
402         /* Copy the code from the BIOS to the SRAM */
403
404         bios_addr = (u16) data32;       /* FW code locate at BIOS address + ? */
405         for (i = 0, data32_ptr = (u8 *) & data32;       /* Download the code    */
406              i < 0x1000;        /* Firmware code size = 4K      */
407              i++, bios_addr++) {
408                 outw(bios_addr, host->base + ORC_EBIOSADR0);
409                 *data32_ptr++ = inb(host->base + ORC_EBIOSDATA);        /* Read from BIOS */
410                 if ((i % 4) == 3) {
411                         outl(data32, host->base + ORC_RISCRAM); /* Write every 4 bytes */
412                         data32_ptr = (u8 *) & data32;
413                 }
414         }
415
416         /* Go back and check they match */
417
418         outb(PRGMRST | DOWNLOAD, host->base + ORC_RISCCTL);     /* Reset program count 0 */
419         bios_addr -= 0x1000;    /* Reset the BIOS adddress      */
420         for (i = 0, data32_ptr = (u8 *) & data32;       /* Check the code       */
421              i < 0x1000;        /* Firmware code size = 4K      */
422              i++, bios_addr++) {
423                 outw(bios_addr, host->base + ORC_EBIOSADR0);
424                 *data32_ptr++ = inb(host->base + ORC_EBIOSDATA);        /* Read from BIOS */
425                 if ((i % 4) == 3) {
426                         if (inl(host->base + ORC_RISCRAM) != data32) {
427                                 outb(PRGMRST, host->base + ORC_RISCCTL);        /* Reset program to 0 */
428                                 outb(data, host->base + ORC_GCFG);      /*Disable EEPROM programming */
429                                 return 0;
430                         }
431                         data32_ptr = (u8 *) & data32;
432                 }
433         }
434
435         /* Success */
436         outb(PRGMRST, host->base + ORC_RISCCTL);        /* Reset program to 0   */
437         outb(data, host->base + ORC_GCFG);      /* Disable EEPROM programming */
438         return 1;
439 }
440
441 /***************************************************************************/
442 static void setup_SCBs(struct orc_host * host)
443 {
444         struct orc_scb *scb;
445         int i;
446         struct orc_extended_scb *escb;
447         dma_addr_t escb_phys;
448
449         /* Setup SCB base and SCB Size registers */
450         outb(ORC_MAXQUEUE, host->base + ORC_SCBSIZE);   /* Total number of SCBs */
451         /* SCB base address 0      */
452         outl(host->scb_phys, host->base + ORC_SCBBASE0);
453         /* SCB base address 1      */
454         outl(host->scb_phys, host->base + ORC_SCBBASE1);
455
456         /* setup scatter list address with one buffer */
457         scb = host->scb_virt;
458         escb = host->escb_virt;
459
460         for (i = 0; i < ORC_MAXQUEUE; i++) {
461                 escb_phys = (host->escb_phys + (sizeof(struct orc_extended_scb) * i));
462                 scb->sg_addr = (u32) escb_phys;
463                 scb->sense_addr = (u32) escb_phys;
464                 scb->escb = escb;
465                 scb->scbidx = i;
466                 scb++;
467                 escb++;
468         }
469 }
470
471 /**
472  *      init_alloc_map          -       initialise allocation map
473  *      @host: host map to configure
474  *
475  *      Initialise the allocation maps for this device. If the device
476  *      is not quiescent the caller must hold the allocation lock
477  */
478
479 static void init_alloc_map(struct orc_host * host)
480 {
481         u8 i, j;
482
483         for (i = 0; i < MAX_CHANNELS; i++) {
484                 for (j = 0; j < 8; j++) {
485                         host->allocation_map[i][j] = 0xffffffff;
486                 }
487         }
488 }
489
490 /**
491  *      init_orchid             -       initialise the host adapter
492  *      @host:host adapter to initialise
493  *
494  *      Initialise the controller and if neccessary load the firmware.
495  *
496  *      Returns -1 if the initialisation fails.
497  */
498
499 static int init_orchid(struct orc_host * host)
500 {
501         u8 *ptr;
502         u16 revision;
503         u8 i;
504
505         init_alloc_map(host);
506         outb(0xFF, host->base + ORC_GIMSK);     /* Disable all interrupts */
507
508         if (inb(host->base + ORC_HSTUS) & RREADY) {     /* Orchid is ready */
509                 revision = orc_read_fwrev(host);
510                 if (revision == 0xFFFF) {
511                         outb(DEVRST, host->base + ORC_HCTRL);   /* Reset Host Adapter   */
512                         if (wait_chip_ready(host) == 0)
513                                 return -1;
514                         orc_load_firmware(host);        /* Download FW                  */
515                         setup_SCBs(host);       /* Setup SCB base and SCB Size registers */
516                         outb(0x00, host->base + ORC_HCTRL);     /* clear HOSTSTOP       */
517                         if (wait_firmware_ready(host) == 0)
518                                 return -1;
519                         /* Wait for firmware ready     */
520                 } else {
521                         setup_SCBs(host);       /* Setup SCB base and SCB Size registers */
522                 }
523         } else {                /* Orchid is not Ready          */
524                 outb(DEVRST, host->base + ORC_HCTRL);   /* Reset Host Adapter   */
525                 if (wait_chip_ready(host) == 0)
526                         return -1;
527                 orc_load_firmware(host);        /* Download FW                  */
528                 setup_SCBs(host);       /* Setup SCB base and SCB Size registers */
529                 outb(HDO, host->base + ORC_HCTRL);      /* Do Hardware Reset &  */
530
531                 /*     clear HOSTSTOP  */
532                 if (wait_firmware_ready(host) == 0)             /* Wait for firmware ready      */
533                         return -1;
534         }
535
536         /* Load an EEProm copy into RAM */
537         /* Assumes single threaded at this point */
538         read_eeprom(host);
539
540         if (nvramp->revision != 1)
541                 return -1;
542
543         host->scsi_id = nvramp->scsi_id;
544         host->BIOScfg = nvramp->BIOSConfig1;
545         host->max_targets = MAX_TARGETS;
546         ptr = (u8 *) & (nvramp->Target00Config);
547         for (i = 0; i < 16; ptr++, i++) {
548                 host->target_flag[i] = *ptr;
549                 host->max_tags[i] = ORC_MAXTAGS;
550         }
551
552         if (nvramp->SCSI0Config & NCC_BUSRESET)
553                 host->flags |= HCF_SCSI_RESET;
554         outb(0xFB, host->base + ORC_GIMSK);     /* enable RP FIFO interrupt     */
555         return 0;
556 }
557
558 /**
559  *      orc_reset_scsi_bus              -       perform bus reset
560  *      @host: host being reset
561  *
562  *      Perform a full bus reset on the adapter.
563  */
564
565 static int orc_reset_scsi_bus(struct orc_host * host)
566 {                               /* I need Host Control Block Information */
567         unsigned long flags;
568
569         spin_lock_irqsave(&host->allocation_lock, flags);
570
571         init_alloc_map(host);
572         /* reset scsi bus */
573         outb(SCSIRST, host->base + ORC_HCTRL);
574         /* FIXME: We can spend up to a second with the lock held and
575            interrupts off here */
576         if (wait_scsi_reset_done(host) == 0) {
577                 spin_unlock_irqrestore(&host->allocation_lock, flags);
578                 return FAILED;
579         } else {
580                 spin_unlock_irqrestore(&host->allocation_lock, flags);
581                 return SUCCESS;
582         }
583 }
584
585 /**
586  *      orc_device_reset        -       device reset handler
587  *      @host: host to reset
588  *      @cmd: command causing the reset
589  *      @target; target device
590  *
591  *      Reset registers, reset a hanging bus and kill active and disconnected
592  *      commands for target w/o soft reset
593  */
594
595 static int orc_device_reset(struct orc_host * host, struct scsi_cmnd *cmd, unsigned int target)
596 {                               /* I need Host Control Block Information */
597         struct orc_scb *scb;
598         struct orc_extended_scb *escb;
599         struct orc_scb *host_scb;
600         u8 i;
601         unsigned long flags;
602
603         spin_lock_irqsave(&(host->allocation_lock), flags);
604         scb = (struct orc_scb *) NULL;
605         escb = (struct orc_extended_scb *) NULL;
606
607         /* setup scatter list address with one buffer */
608         host_scb = host->scb_virt;
609
610         /* FIXME: is this safe if we then fail to issue the reset or race
611            a completion ? */
612         init_alloc_map(host);
613
614         /* Find the scb corresponding to the command */
615         for (i = 0; i < ORC_MAXQUEUE; i++) {
616                 escb = host_scb->escb;
617                 if (host_scb->status && escb->srb == cmd)
618                         break;
619                 host_scb++;
620         }
621
622         if (i == ORC_MAXQUEUE) {
623                 printk(KERN_ERR "Unable to Reset - No SCB Found\n");
624                 spin_unlock_irqrestore(&(host->allocation_lock), flags);
625                 return FAILED;
626         }
627
628         /* Allocate a new SCB for the reset command to the firmware */
629         if ((scb = __orc_alloc_scb(host)) == NULL) {
630                 /* Can't happen.. */
631                 spin_unlock_irqrestore(&(host->allocation_lock), flags);
632                 return FAILED;
633         }
634
635         /* Reset device is handled by the firmare, we fill in an SCB and
636            fire it at the controller, it does the rest */
637         scb->opcode = ORC_BUSDEVRST;
638         scb->target = target;
639         scb->hastat = 0;
640         scb->tastat = 0;
641         scb->status = 0x0;
642         scb->link = 0xFF;
643         scb->reserved0 = 0;
644         scb->reserved1 = 0;
645         scb->xferlen = 0;
646         scb->sg_len = 0;
647
648         escb->srb = NULL;
649         escb->srb = cmd;
650         orc_exec_scb(host, scb);        /* Start execute SCB            */
651         spin_unlock_irqrestore(&host->allocation_lock, flags);
652         return SUCCESS;
653 }
654
655 /**
656  *      __orc_alloc_scb         -               allocate an SCB
657  *      @host: host to allocate from
658  *
659  *      Allocate an SCB and return a pointer to the SCB object. NULL
660  *      is returned if no SCB is free. The caller must already hold
661  *      the allocator lock at this point.
662  */
663
664
665 static struct orc_scb *__orc_alloc_scb(struct orc_host * host)
666 {
667         u8 channel;
668         unsigned long idx;
669         u8 index;
670         u8 i;
671
672         channel = host->index;
673         for (i = 0; i < 8; i++) {
674                 for (index = 0; index < 32; index++) {
675                         if ((host->allocation_map[channel][i] >> index) & 0x01) {
676                                 host->allocation_map[channel][i] &= ~(1 << index);
677                                 break;
678                         }
679                 }
680                 idx = index + 32 * i;
681                 /* Translate the index to a structure instance */
682                 return (struct orc_scb *) ((unsigned long) host->scb_virt + (idx * sizeof(struct orc_scb)));
683         }
684         return NULL;
685 }
686
687 /**
688  *      orc_alloc_scb           -               allocate an SCB
689  *      @host: host to allocate from
690  *
691  *      Allocate an SCB and return a pointer to the SCB object. NULL
692  *      is returned if no SCB is free.
693  */
694
695 static struct orc_scb *orc_alloc_scb(struct orc_host * host)
696 {
697         struct orc_scb *scb;
698         unsigned long flags;
699
700         spin_lock_irqsave(&host->allocation_lock, flags);
701         scb = __orc_alloc_scb(host);
702         spin_unlock_irqrestore(&host->allocation_lock, flags);
703         return scb;
704 }
705
706 /**
707  *      orc_release_scb                 -       release an SCB
708  *      @host: host owning the SCB
709  *      @scb: SCB that is now free
710  *
711  *      Called to return a completed SCB to the allocation pool. Before
712  *      calling the SCB must be out of use on both the host and the HA.
713  */
714
715 static void orc_release_scb(struct orc_host *host, struct orc_scb *scb)
716 {
717         unsigned long flags;
718         u8 index, i, channel;
719
720         spin_lock_irqsave(&(host->allocation_lock), flags);
721         channel = host->index;  /* Channel */
722         index = scb->scbidx;
723         i = index / 32;
724         index %= 32;
725         host->allocation_map[channel][i] |= (1 << index);
726         spin_unlock_irqrestore(&(host->allocation_lock), flags);
727 }
728
729 /**
730  *      orchid_abort_scb        -       abort a command
731  *
732  *      Abort a queued command that has been passed to the firmware layer
733  *      if possible. This is all handled by the firmware. We aks the firmware
734  *      and it either aborts the command or fails
735  */
736
737 static int orchid_abort_scb(struct orc_host * host, struct orc_scb * scb)
738 {
739         unsigned char data, status;
740
741         outb(ORC_CMD_ABORT_SCB, host->base + ORC_HDATA);        /* Write command */
742         outb(HDO, host->base + ORC_HCTRL);
743         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
744                 return 0;
745
746         outb(scb->scbidx, host->base + ORC_HDATA);      /* Write address */
747         outb(HDO, host->base + ORC_HCTRL);
748         if (wait_HDO_off(host) == 0)    /* Wait HDO off   */
749                 return 0;
750
751         if (wait_hdi_set(host, &data) == 0)     /* Wait HDI set   */
752                 return 0;
753         status = inb(host->base + ORC_HDATA);
754         outb(data, host->base + ORC_HSTUS);     /* Clear HDI    */
755
756         if (status == 1)        /* 0 - Successfully               */
757                 return 0;       /* 1 - Fail                     */
758         return 1;
759 }
760
761 static int inia100_abort_cmd(struct orc_host * host, struct scsi_cmnd *cmd)
762 {
763         struct orc_extended_scb *escb;
764         struct orc_scb *scb;
765         u8 i;
766         unsigned long flags;
767
768         spin_lock_irqsave(&(host->allocation_lock), flags);
769
770         scb = host->scb_virt;
771
772         /* Walk the queue until we find the SCB that belongs to the command
773            block. This isn't a performance critical path so a walk in the park
774            here does no harm */
775
776         for (i = 0; i < ORC_MAXQUEUE; i++, scb++) {
777                 escb = scb->escb;
778                 if (scb->status && escb->srb == cmd) {
779                         if (scb->tag_msg == 0) {
780                                 goto out;
781                         } else {
782                                 /* Issue an ABORT to the firmware */
783                                 if (orchid_abort_scb(host, scb)) {
784                                         escb->srb = NULL;
785                                         spin_unlock_irqrestore(&host->allocation_lock, flags);
786                                         return SUCCESS;
787                                 } else
788                                         goto out;
789                         }
790                 }
791         }
792 out:
793         spin_unlock_irqrestore(&host->allocation_lock, flags);
794         return FAILED;
795 }
796
797 /**
798  *      orc_interrupt           -       IRQ processing
799  *      @host: Host causing the interrupt
800  *
801  *      This function is called from the IRQ handler and protected
802  *      by the host lock. While the controller reports that there are
803  *      scb's for processing we pull them off the controller, turn the
804  *      index into a host address pointer to the scb and call the scb
805  *      handler.
806  *
807  *      Returns IRQ_HANDLED if any SCBs were processed, IRQ_NONE otherwise
808  */
809
810 static irqreturn_t orc_interrupt(struct orc_host * host)
811 {
812         u8 scb_index;
813         struct orc_scb *scb;
814
815         /* Check if we have an SCB queued for servicing */
816         if (inb(host->base + ORC_RQUEUECNT) == 0)
817                 return IRQ_NONE;
818
819         do {
820                 /* Get the SCB index of the SCB to service */
821                 scb_index = inb(host->base + ORC_RQUEUE);
822
823                 /* Translate it back to a host pointer */
824                 scb = (struct orc_scb *) ((unsigned long) host->scb_virt + (unsigned long) (sizeof(struct orc_scb) * scb_index));
825                 scb->status = 0x0;
826                 /* Process the SCB */
827                 inia100_scb_handler(host, scb);
828         } while (inb(host->base + ORC_RQUEUECNT));
829         return IRQ_HANDLED;
830 }                               /* End of I1060Interrupt() */
831
832 /**
833  *      inia100_build_scb       -       build SCB
834  *      @host: host owing the control block
835  *      @scb: control block to use
836  *      @cmd: Mid layer command
837  *
838  *      Build a host adapter control block from the SCSI mid layer command
839  */
840
841 static void inia100_build_scb(struct orc_host * host, struct orc_scb * scb, struct scsi_cmnd * cmd)
842 {                               /* Create corresponding SCB     */
843         struct scatterlist *sg;
844         struct orc_sgent *sgent;                /* Pointer to SG list           */
845         int i, count_sg;
846         struct orc_extended_scb *escb;
847
848         /* Links between the escb, scb and Linux scsi midlayer cmd */
849         escb = scb->escb;
850         escb->srb = cmd;
851         sgent = NULL;
852
853         /* Set up the SCB to do a SCSI command block */
854         scb->opcode = ORC_EXECSCSI;
855         scb->flags = SCF_NO_DCHK;       /* Clear done bit               */
856         scb->target = cmd->device->id;
857         scb->lun = cmd->device->lun;
858         scb->reserved0 = 0;
859         scb->reserved1 = 0;
860         scb->sg_len = 0;
861
862         scb->xferlen = (u32) scsi_bufflen(cmd);
863         sgent = (struct orc_sgent *) & escb->sglist[0];
864
865         count_sg = scsi_dma_map(cmd);
866         BUG_ON(count_sg < 0);
867
868         /* Build the scatter gather lists */
869         if (count_sg) {
870                 scb->sg_len = (u32) (count_sg * 8);
871                 scsi_for_each_sg(cmd, sg, count_sg, i) {
872                         sgent->base = (u32) sg_dma_address(sg);
873                         sgent->length = (u32) sg_dma_len(sg);
874                         sgent++;
875                 }
876         } else {
877                 scb->sg_len = 0;
878                 sgent->base = 0;
879                 sgent->length = 0;
880         }
881         scb->sg_addr = (u32) scb->sense_addr;
882         scb->hastat = 0;
883         scb->tastat = 0;
884         scb->link = 0xFF;
885         scb->sense_len = SENSE_SIZE;
886         scb->cdb_len = cmd->cmd_len;
887         if (scb->cdb_len >= IMAX_CDB) {
888                 printk("max cdb length= %x\b", cmd->cmd_len);
889                 scb->cdb_len = IMAX_CDB;
890         }
891         scb->ident = cmd->device->lun | DISC_ALLOW;
892         if (cmd->device->tagged_supported) {    /* Tag Support                  */
893                 scb->tag_msg = SIMPLE_QUEUE_TAG;        /* Do simple tag only   */
894         } else {
895                 scb->tag_msg = 0;       /* No tag support               */
896         }
897         memcpy(&scb->cdb[0], &cmd->cmnd, scb->cdb_len);
898 }
899
900 /**
901  *      inia100_queue           -       queue command with host
902  *      @cmd: Command block
903  *      @done: Completion function
904  *
905  *      Called by the mid layer to queue a command. Process the command
906  *      block, build the host specific scb structures and if there is room
907  *      queue the command down to the controller
908  */
909
910 static int inia100_queue(struct scsi_cmnd * cmd, void (*done) (struct scsi_cmnd *))
911 {
912         struct orc_scb *scb;
913         struct orc_host *host;          /* Point to Host adapter control block */
914
915         host = (struct orc_host *) cmd->device->host->hostdata;
916         cmd->scsi_done = done;
917         /* Get free SCSI control block  */
918         if ((scb = orc_alloc_scb(host)) == NULL)
919                 return SCSI_MLQUEUE_HOST_BUSY;
920
921         inia100_build_scb(host, scb, cmd);
922         orc_exec_scb(host, scb);        /* Start execute SCB            */
923         return 0;
924 }
925
926 /*****************************************************************************
927  Function name  : inia100_abort
928  Description    : Abort a queued command.
929                          (commands that are on the bus can't be aborted easily)
930  Input          : host  -       Pointer to host adapter structure
931  Output         : None.
932  Return         : pSRB  -       Pointer to SCSI request block.
933 *****************************************************************************/
934 static int inia100_abort(struct scsi_cmnd * cmd)
935 {
936         struct orc_host *host;
937
938         host = (struct orc_host *) cmd->device->host->hostdata;
939         return inia100_abort_cmd(host, cmd);
940 }
941
942 /*****************************************************************************
943  Function name  : inia100_reset
944  Description    : Reset registers, reset a hanging bus and
945                   kill active and disconnected commands for target w/o soft reset
946  Input          : host  -       Pointer to host adapter structure
947  Output         : None.
948  Return         : pSRB  -       Pointer to SCSI request block.
949 *****************************************************************************/
950 static int inia100_bus_reset(struct scsi_cmnd * cmd)
951 {                               /* I need Host Control Block Information */
952         struct orc_host *host;
953         host = (struct orc_host *) cmd->device->host->hostdata;
954         return orc_reset_scsi_bus(host);
955 }
956
957 /*****************************************************************************
958  Function name  : inia100_device_reset
959  Description    : Reset the device
960  Input          : host  -       Pointer to host adapter structure
961  Output         : None.
962  Return         : pSRB  -       Pointer to SCSI request block.
963 *****************************************************************************/
964 static int inia100_device_reset(struct scsi_cmnd * cmd)
965 {                               /* I need Host Control Block Information */
966         struct orc_host *host;
967         host = (struct orc_host *) cmd->device->host->hostdata;
968         return orc_device_reset(host, cmd, scmd_id(cmd));
969
970 }
971
972 /**
973  *      inia100_scb_handler     -       interrupt callback
974  *      @host: Host causing the interrupt
975  *      @scb: SCB the controller returned as needing processing
976  *
977  *      Perform completion processing on a control block. Do the conversions
978  *      from host to SCSI midlayer error coding, save any sense data and
979  *      the complete with the midlayer and recycle the scb.
980  */
981
982 static void inia100_scb_handler(struct orc_host *host, struct orc_scb *scb)
983 {
984         struct scsi_cmnd *cmd;  /* Pointer to SCSI request block */
985         struct orc_extended_scb *escb;
986
987         escb = scb->escb;
988         if ((cmd = (struct scsi_cmnd *) escb->srb) == NULL) {
989                 printk(KERN_ERR "inia100_scb_handler: SRB pointer is empty\n");
990                 orc_release_scb(host, scb);     /* Release SCB for current channel */
991                 return;
992         }
993         escb->srb = NULL;
994
995         switch (scb->hastat) {
996         case 0x0:
997         case 0xa:               /* Linked command complete without error and linked normally */
998         case 0xb:               /* Linked command complete without error interrupt generated */
999                 scb->hastat = 0;
1000                 break;
1001
1002         case 0x11:              /* Selection time out-The initiator selection or target
1003                                    reselection was not complete within the SCSI Time out period */
1004                 scb->hastat = DID_TIME_OUT;
1005                 break;
1006
1007         case 0x14:              /* Target bus phase sequence failure-An invalid bus phase or bus
1008                                    phase sequence was requested by the target. The host adapter
1009                                    will generate a SCSI Reset Condition, notifying the host with
1010                                    a SCRD interrupt */
1011                 scb->hastat = DID_RESET;
1012                 break;
1013
1014         case 0x1a:              /* SCB Aborted. 07/21/98 */
1015                 scb->hastat = DID_ABORT;
1016                 break;
1017
1018         case 0x12:              /* Data overrun/underrun-The target attempted to transfer more data
1019                                    than was allocated by the Data Length field or the sum of the
1020                                    Scatter / Gather Data Length fields. */
1021         case 0x13:              /* Unexpected bus free-The target dropped the SCSI BSY at an unexpected time. */
1022         case 0x16:              /* Invalid CCB Operation Code-The first byte of the CCB was invalid. */
1023
1024         default:
1025                 printk(KERN_DEBUG "inia100: %x %x\n", scb->hastat, scb->tastat);
1026                 scb->hastat = DID_ERROR;        /* Couldn't find any better */
1027                 break;
1028         }
1029
1030         if (scb->tastat == 2) { /* Check condition              */
1031                 memcpy((unsigned char *) &cmd->sense_buffer[0],
1032                    (unsigned char *) &escb->sglist[0], SENSE_SIZE);
1033         }
1034         cmd->result = scb->tastat | (scb->hastat << 16);
1035         scsi_dma_unmap(cmd);
1036         cmd->scsi_done(cmd);    /* Notify system DONE           */
1037         orc_release_scb(host, scb);     /* Release SCB for current channel */
1038 }
1039
1040 /**
1041  *      inia100_intr            -       interrupt handler
1042  *      @irqno: Interrupt value
1043  *      @devid: Host adapter
1044  *
1045  *      Entry point for IRQ handling. All the real work is performed
1046  *      by orc_interrupt.
1047  */
1048 static irqreturn_t inia100_intr(int irqno, void *devid)
1049 {
1050         struct Scsi_Host *shost = (struct Scsi_Host *)devid;
1051         struct orc_host *host = (struct orc_host *)shost->hostdata;
1052         unsigned long flags;
1053         irqreturn_t res;
1054
1055         spin_lock_irqsave(shost->host_lock, flags);
1056         res = orc_interrupt(host);
1057         spin_unlock_irqrestore(shost->host_lock, flags);
1058
1059         return res;
1060 }
1061
1062 static struct scsi_host_template inia100_template = {
1063         .proc_name              = "inia100",
1064         .name                   = inia100_REVID,
1065         .queuecommand           = inia100_queue,
1066         .eh_abort_handler       = inia100_abort,
1067         .eh_bus_reset_handler   = inia100_bus_reset,
1068         .eh_device_reset_handler = inia100_device_reset,
1069         .can_queue              = 1,
1070         .this_id                = 1,
1071         .sg_tablesize           = SG_ALL,
1072         .cmd_per_lun            = 1,
1073         .use_clustering         = ENABLE_CLUSTERING,
1074 };
1075
1076 static int __devinit inia100_probe_one(struct pci_dev *pdev,
1077                 const struct pci_device_id *id)
1078 {
1079         struct Scsi_Host *shost;
1080         struct orc_host *host;
1081         unsigned long port, bios;
1082         int error = -ENODEV;
1083         u32 sz;
1084         unsigned long biosaddr;
1085         char *bios_phys;
1086
1087         if (pci_enable_device(pdev))
1088                 goto out;
1089         if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
1090                 printk(KERN_WARNING "Unable to set 32bit DMA "
1091                                     "on inia100 adapter, ignoring.\n");
1092                 goto out_disable_device;
1093         }
1094
1095         pci_set_master(pdev);
1096
1097         port = pci_resource_start(pdev, 0);
1098         if (!request_region(port, 256, "inia100")) {
1099                 printk(KERN_WARNING "inia100: io port 0x%lx, is busy.\n", port);
1100                 goto out_disable_device;
1101         }
1102
1103         /* <02> read from base address + 0x50 offset to get the bios value. */
1104         bios = inw(port + 0x50);
1105
1106
1107         shost = scsi_host_alloc(&inia100_template, sizeof(struct orc_host));
1108         if (!shost)
1109                 goto out_release_region;
1110
1111         host = (struct orc_host *)shost->hostdata;
1112         host->pdev = pdev;
1113         host->base = port;
1114         host->BIOScfg = bios;
1115         spin_lock_init(&host->allocation_lock);
1116
1117         /* Get total memory needed for SCB */
1118         sz = ORC_MAXQUEUE * sizeof(struct orc_scb);
1119         host->scb_virt = pci_alloc_consistent(pdev, sz,
1120                         &host->scb_phys);
1121         if (!host->scb_virt) {
1122                 printk("inia100: SCB memory allocation error\n");
1123                 goto out_host_put;
1124         }
1125         memset(host->scb_virt, 0, sz);
1126
1127         /* Get total memory needed for ESCB */
1128         sz = ORC_MAXQUEUE * sizeof(struct orc_extended_scb);
1129         host->escb_virt = pci_alloc_consistent(pdev, sz,
1130                         &host->escb_phys);
1131         if (!host->escb_virt) {
1132                 printk("inia100: ESCB memory allocation error\n");
1133                 goto out_free_scb_array;
1134         }
1135         memset(host->escb_virt, 0, sz);
1136
1137         biosaddr = host->BIOScfg;
1138         biosaddr = (biosaddr << 4);
1139         bios_phys = phys_to_virt(biosaddr);
1140         if (init_orchid(host)) {        /* Initialize orchid chip */
1141                 printk("inia100: initial orchid fail!!\n");
1142                 goto out_free_escb_array;
1143         }
1144
1145         shost->io_port = host->base;
1146         shost->n_io_port = 0xff;
1147         shost->can_queue = ORC_MAXQUEUE;
1148         shost->unique_id = shost->io_port;
1149         shost->max_id = host->max_targets;
1150         shost->max_lun = 16;
1151         shost->irq = pdev->irq;
1152         shost->this_id = host->scsi_id; /* Assign HCS index */
1153         shost->sg_tablesize = TOTAL_SG_ENTRY;
1154
1155         /* Initial orc chip           */
1156         error = request_irq(pdev->irq, inia100_intr, IRQF_SHARED,
1157                         "inia100", shost);
1158         if (error < 0) {
1159                 printk(KERN_WARNING "inia100: unable to get irq %d\n",
1160                                 pdev->irq);
1161                 goto out_free_escb_array;
1162         }
1163
1164         pci_set_drvdata(pdev, shost);
1165
1166         error = scsi_add_host(shost, &pdev->dev);
1167         if (error)
1168                 goto out_free_irq;
1169
1170         scsi_scan_host(shost);
1171         return 0;
1172
1173 out_free_irq:
1174         free_irq(shost->irq, shost);
1175 out_free_escb_array:
1176         pci_free_consistent(pdev, ORC_MAXQUEUE * sizeof(struct orc_extended_scb),
1177                         host->escb_virt, host->escb_phys);
1178 out_free_scb_array:
1179         pci_free_consistent(pdev, ORC_MAXQUEUE * sizeof(struct orc_scb),
1180                         host->scb_virt, host->scb_phys);
1181 out_host_put:
1182         scsi_host_put(shost);
1183 out_release_region:
1184         release_region(port, 256);
1185 out_disable_device:
1186         pci_disable_device(pdev);
1187 out:
1188         return error;
1189 }
1190
1191 static void __devexit inia100_remove_one(struct pci_dev *pdev)
1192 {
1193         struct Scsi_Host *shost = pci_get_drvdata(pdev);
1194         struct orc_host *host = (struct orc_host *)shost->hostdata;
1195
1196         scsi_remove_host(shost);
1197
1198         free_irq(shost->irq, shost);
1199         pci_free_consistent(pdev, ORC_MAXQUEUE * sizeof(struct orc_extended_scb),
1200                         host->escb_virt, host->escb_phys);
1201         pci_free_consistent(pdev, ORC_MAXQUEUE * sizeof(struct orc_scb),
1202                         host->scb_virt, host->scb_phys);
1203         release_region(shost->io_port, 256);
1204
1205         scsi_host_put(shost);
1206
1207
1208 static struct pci_device_id inia100_pci_tbl[] = {
1209         {PCI_VENDOR_ID_INIT, 0x1060, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
1210         {0,}
1211 };
1212 MODULE_DEVICE_TABLE(pci, inia100_pci_tbl);
1213
1214 static struct pci_driver inia100_pci_driver = {
1215         .name           = "inia100",
1216         .id_table       = inia100_pci_tbl,
1217         .probe          = inia100_probe_one,
1218         .remove         = __devexit_p(inia100_remove_one),
1219 };
1220
1221 static int __init inia100_init(void)
1222 {
1223         return pci_register_driver(&inia100_pci_driver);
1224 }
1225
1226 static void __exit inia100_exit(void)
1227 {
1228         pci_unregister_driver(&inia100_pci_driver);
1229 }
1230
1231 MODULE_DESCRIPTION("Initio A100U2W SCSI driver");
1232 MODULE_AUTHOR("Initio Corporation");
1233 MODULE_LICENSE("Dual BSD/GPL");
1234
1235 module_init(inia100_init);
1236 module_exit(inia100_exit);