ce2b27bec977925b296a5ce00d8ae43fb79bbecc
[dragonfly.git] / sys / dev / disk / sym / sym_hipd.c
1 /*-
2  *  Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
3  *  PCI-SCSI controllers.
4  *
5  *  Copyright (C) 1999-2001  Gerard Roudier <groudier@free.fr>
6  *
7  *  This driver also supports the following Symbios/LSI PCI-SCSI chips:
8  *      53C810A, 53C825A, 53C860, 53C875, 53C876, 53C885, 53C895,
9  *      53C810,  53C815,  53C825 and the 53C1510D is 53C8XX mode.
10  *
11  *
12  *  This driver for FreeBSD-CAM is derived from the Linux sym53c8xx driver.
13  *  Copyright (C) 1998-1999  Gerard Roudier
14  *
15  *  The sym53c8xx driver is derived from the ncr53c8xx driver that had been
16  *  a port of the FreeBSD ncr driver to Linux-1.2.13.
17  *
18  *  The original ncr driver has been written for 386bsd and FreeBSD by
19  *          Wolfgang Stanglmeier        <wolf@cologne.de>
20  *          Stefan Esser                <se@mi.Uni-Koeln.de>
21  *  Copyright (C) 1994  Wolfgang Stanglmeier
22  *
23  *  The initialisation code, and part of the code that addresses
24  *  FreeBSD-CAM services is based on the aic7xxx driver for FreeBSD-CAM
25  *  written by Justin T. Gibbs.
26  *
27  *  Other major contributions:
28  *
29  *  NVRAM detection and reading.
30  *  Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
31  *
32  *-----------------------------------------------------------------------------
33  *
34  * Redistribution and use in source and binary forms, with or without
35  * modification, are permitted provided that the following conditions
36  * are met:
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in the
41  *    documentation and/or other materials provided with the distribution.
42  * 3. The name of the author may not be used to endorse or promote products
43  *    derived from this software without specific prior written permission.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
49  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  *
57  * $FreeBSD: src/sys/dev/sym/sym_hipd.c,v 1.76 2011/10/07 08:59:54 marius Exp $
58  */
59
60 #define SYM_DRIVER_NAME "sym-1.6.5-20000902"
61
62 /* #define SYM_DEBUG_GENERIC_SUPPORT */
63
64 #include <sys/param.h>
65
66 /*
67  *  Driver configuration options.
68  */
69 #include "opt_sym.h"
70 #include <dev/disk/sym/sym_conf.h>
71
72
73 #include <sys/systm.h>
74 #include <sys/malloc.h>
75 #include <sys/endian.h>
76 #include <sys/kernel.h>
77 #include <sys/lock.h>
78 #include <sys/mutex.h>
79 #include <sys/module.h>
80 #include <sys/bus.h>
81
82 #include <sys/proc.h>
83
84 #include <bus/pci/pcireg.h>
85 #include <bus/pci/pcivar.h>
86
87 #ifdef __sparc64__
88 #include <dev/ofw/openfirm.h>
89 #include <machine/ofw_machdep.h>
90 #endif
91
92 #include <sys/rman.h>
93
94 #include <bus/cam/cam.h>
95 #include <bus/cam/cam_ccb.h>
96 #include <bus/cam/cam_sim.h>
97 #include <bus/cam/cam_xpt_sim.h>
98 #include <bus/cam/cam_debug.h>
99
100 #include <bus/cam/scsi/scsi_all.h>
101 #include <bus/cam/scsi/scsi_message.h>
102
103 /* Short and quite clear integer types */
104 typedef int8_t    s8;
105 typedef int16_t   s16;
106 typedef int32_t   s32;
107 typedef u_int8_t  u8;
108 typedef u_int16_t u16;
109 typedef u_int32_t u32;
110
111 /*
112  *  Driver definitions.
113  */
114 #include <dev/disk/sym/sym_defs.h>
115 #include <dev/disk/sym/sym_fw.h>
116
117 /*
118  *  IA32 architecture does not reorder STORES and prevents
119  *  LOADS from passing STORES. It is called `program order'
120  *  by Intel and allows device drivers to deal with memory
121  *  ordering by only ensuring that the code is not reordered
122  *  by the compiler when ordering is required.
123  *  Other architectures implement a weaker ordering that
124  *  requires memory barriers (and also IO barriers when they
125  *  make sense) to be used.
126  */
127
128 #if     defined __i386__ || defined __x86_64__
129 #define MEMORY_BARRIER()        do { ; } while(0)
130 #elif   defined __powerpc__
131 #define MEMORY_BARRIER()        __asm__ volatile("eieio; sync" : : : "memory")
132 #elif   defined __ia64__
133 #define MEMORY_BARRIER()        __asm__ volatile("mf.a; mf" : : : "memory")
134 #elif   defined __sparc64__
135 #define MEMORY_BARRIER()        __asm__ volatile("membar #Sync" : : : "memory")
136 #else
137 #error  "Not supported platform"
138 #endif
139
140 /*
141  *  A la VMS/CAM-3 queue management.
142  */
143
144 typedef struct sym_quehead {
145         struct sym_quehead *flink;      /* Forward  pointer */
146         struct sym_quehead *blink;      /* Backward pointer */
147 } SYM_QUEHEAD;
148
149 #define sym_que_init(ptr) do { \
150         (ptr)->flink = (ptr); (ptr)->blink = (ptr); \
151 } while (0)
152
153 static __inline struct sym_quehead *sym_que_first(struct sym_quehead *head)
154 {
155         return (head->flink == head) ? NULL : head->flink;
156 }
157
158 static __inline struct sym_quehead *sym_que_last(struct sym_quehead *head)
159 {
160         return (head->blink == head) ? NULL : head->blink;
161 }
162
163 static __inline void __sym_que_add(struct sym_quehead * new,
164         struct sym_quehead * blink,
165         struct sym_quehead * flink)
166 {
167         flink->blink    = new;
168         new->flink      = flink;
169         new->blink      = blink;
170         blink->flink    = new;
171 }
172
173 static __inline void __sym_que_del(struct sym_quehead * blink,
174         struct sym_quehead * flink)
175 {
176         flink->blink = blink;
177         blink->flink = flink;
178 }
179
180 static __inline int sym_que_empty(struct sym_quehead *head)
181 {
182         return head->flink == head;
183 }
184
185 static __inline void sym_que_splice(struct sym_quehead *list,
186         struct sym_quehead *head)
187 {
188         struct sym_quehead *first = list->flink;
189
190         if (first != list) {
191                 struct sym_quehead *last = list->blink;
192                 struct sym_quehead *at   = head->flink;
193
194                 first->blink = head;
195                 head->flink  = first;
196
197                 last->flink = at;
198                 at->blink   = last;
199         }
200 }
201
202 #define sym_que_entry(ptr, type, member) \
203         ((type *)((char *)(ptr)-(size_t)(&((type *)0)->member)))
204
205
206 #define sym_insque(new, pos)            __sym_que_add(new, pos, (pos)->flink)
207
208 #define sym_remque(el)                  __sym_que_del((el)->blink, (el)->flink)
209
210 #define sym_insque_head(new, head)      __sym_que_add(new, head, (head)->flink)
211
212 static __inline struct sym_quehead *sym_remque_head(struct sym_quehead *head)
213 {
214         struct sym_quehead *elem = head->flink;
215
216         if (elem != head)
217                 __sym_que_del(head, elem->flink);
218         else
219                 elem = NULL;
220         return elem;
221 }
222
223 #define sym_insque_tail(new, head)      __sym_que_add(new, (head)->blink, head)
224
225 static __inline struct sym_quehead *sym_remque_tail(struct sym_quehead *head)
226 {
227         struct sym_quehead *elem = head->blink;
228
229         if (elem != head)
230                 __sym_que_del(elem->blink, head);
231         else
232                 elem = NULL;
233         return elem;
234 }
235
236 /*
237  *  This one may be useful.
238  */
239 #define FOR_EACH_QUEUED_ELEMENT(head, qp) \
240         for (qp = (head)->flink; qp != (head); qp = qp->flink)
241 /*
242  *  FreeBSD does not offer our kind of queue in the CAM CCB.
243  *  So, we have to cast.
244  */
245 #define sym_qptr(p)     ((struct sym_quehead *) (p))
246
247 /*
248  *  Simple bitmap operations.
249  */
250 #define sym_set_bit(p, n)       (((u32 *)(p))[(n)>>5] |=  (1<<((n)&0x1f)))
251 #define sym_clr_bit(p, n)       (((u32 *)(p))[(n)>>5] &= ~(1<<((n)&0x1f)))
252 #define sym_is_bit(p, n)        (((u32 *)(p))[(n)>>5] &   (1<<((n)&0x1f)))
253
254 /*
255  *  Number of tasks per device we want to handle.
256  */
257 #if     SYM_CONF_MAX_TAG_ORDER > 8
258 #error  "more than 256 tags per logical unit not allowed."
259 #endif
260 #define SYM_CONF_MAX_TASK       (1<<SYM_CONF_MAX_TAG_ORDER)
261
262 /*
263  *  Donnot use more tasks that we can handle.
264  */
265 #ifndef SYM_CONF_MAX_TAG
266 #define SYM_CONF_MAX_TAG        SYM_CONF_MAX_TASK
267 #endif
268 #if     SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
269 #undef  SYM_CONF_MAX_TAG
270 #define SYM_CONF_MAX_TAG        SYM_CONF_MAX_TASK
271 #endif
272
273 /*
274  *    This one means 'NO TAG for this job'
275  */
276 #define NO_TAG  (256)
277
278 /*
279  *  Number of SCSI targets.
280  */
281 #if     SYM_CONF_MAX_TARGET > 16
282 #error  "more than 16 targets not allowed."
283 #endif
284
285 /*
286  *  Number of logical units per target.
287  */
288 #if     SYM_CONF_MAX_LUN > 64
289 #error  "more than 64 logical units per target not allowed."
290 #endif
291
292 /*
293  *    Asynchronous pre-scaler (ns). Shall be 40 for
294  *    the SCSI timings to be compliant.
295  */
296 #define SYM_CONF_MIN_ASYNC (40)
297
298 /*
299  *  Number of entries in the START and DONE queues.
300  *
301  *  We limit to 1 PAGE in order to succeed allocation of
302  *  these queues. Each entry is 8 bytes long (2 DWORDS).
303  */
304 #ifdef  SYM_CONF_MAX_START
305 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
306 #else
307 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
308 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
309 #endif
310
311 #if     SYM_CONF_MAX_QUEUE > PAGE_SIZE/8
312 #undef  SYM_CONF_MAX_QUEUE
313 #define SYM_CONF_MAX_QUEUE   PAGE_SIZE/8
314 #undef  SYM_CONF_MAX_START
315 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
316 #endif
317
318 /*
319  *  For this one, we want a short name :-)
320  */
321 #define MAX_QUEUE       SYM_CONF_MAX_QUEUE
322
323 /*
324  *  Active debugging tags and verbosity.
325  */
326 #define DEBUG_ALLOC     (0x0001)
327 #define DEBUG_PHASE     (0x0002)
328 #define DEBUG_POLL      (0x0004)
329 #define DEBUG_QUEUE     (0x0008)
330 #define DEBUG_RESULT    (0x0010)
331 #define DEBUG_SCATTER   (0x0020)
332 #define DEBUG_SCRIPT    (0x0040)
333 #define DEBUG_TINY      (0x0080)
334 #define DEBUG_TIMING    (0x0100)
335 #define DEBUG_NEGO      (0x0200)
336 #define DEBUG_TAGS      (0x0400)
337 #define DEBUG_POINTER   (0x0800)
338
339 #if 0
340 static int sym_debug = 0;
341         #define DEBUG_FLAGS sym_debug
342 #else
343 /*      #define DEBUG_FLAGS (0x0631) */
344         #define DEBUG_FLAGS (0x0000)
345
346 #endif
347 #define sym_verbose     (np->verbose)
348
349 /*
350  *  Insert a delay in micro-seconds and milli-seconds.
351  */
352 static void UDELAY(int us) { DELAY(us); }
353 static void MDELAY(int ms) { while (ms--) UDELAY(1000); }
354
355 /*
356  *  Simple power of two buddy-like allocator.
357  *
358  *  This simple code is not intended to be fast, but to
359  *  provide power of 2 aligned memory allocations.
360  *  Since the SCRIPTS processor only supplies 8 bit arithmetic,
361  *  this allocator allows simple and fast address calculations
362  *  from the SCRIPTS code. In addition, cache line alignment
363  *  is guaranteed for power of 2 cache line size.
364  *
365  *  This allocator has been developed for the Linux sym53c8xx
366  *  driver, since this O/S does not provide naturally aligned
367  *  allocations.
368  *  It has the advantage of allowing the driver to use private
369  *  pages of memory that will be useful if we ever need to deal
370  *  with IO MMUs for PCI.
371  */
372
373 #define MEMO_SHIFT      4       /* 16 bytes minimum memory chunk */
374 #define MEMO_PAGE_ORDER 0       /* 1 PAGE  maximum */
375 #if 0
376 #define MEMO_FREE_UNUSED        /* Free unused pages immediately */
377 #endif
378 #define MEMO_WARN       1
379 #define MEMO_CLUSTER_SHIFT      (PAGE_SHIFT+MEMO_PAGE_ORDER)
380 #define MEMO_CLUSTER_SIZE       (1UL << MEMO_CLUSTER_SHIFT)
381 #define MEMO_CLUSTER_MASK       (MEMO_CLUSTER_SIZE-1)
382
383 #define get_pages()             kmalloc(MEMO_CLUSTER_SIZE, M_DEVBUF, M_INTWAIT)
384 #define free_pages(p)           kfree((p), M_DEVBUF)
385
386 typedef u_long m_addr_t;        /* Enough bits to bit-hack addresses */
387
388 typedef struct m_link {         /* Link between free memory chunks */
389         struct m_link *next;
390 } m_link_s;
391
392 typedef struct m_vtob {         /* Virtual to Bus address translation */
393         struct m_vtob   *next;
394         bus_dmamap_t    dmamap; /* Map for this chunk */
395         m_addr_t        vaddr;  /* Virtual address */
396         m_addr_t        baddr;  /* Bus physical address */
397 } m_vtob_s;
398 /* Hash this stuff a bit to speed up translations */
399 #define VTOB_HASH_SHIFT         5
400 #define VTOB_HASH_SIZE          (1UL << VTOB_HASH_SHIFT)
401 #define VTOB_HASH_MASK          (VTOB_HASH_SIZE-1)
402 #define VTOB_HASH_CODE(m)       \
403         ((((m_addr_t) (m)) >> MEMO_CLUSTER_SHIFT) & VTOB_HASH_MASK)
404
405 typedef struct m_pool {         /* Memory pool of a given kind */
406         bus_dma_tag_t    dev_dmat;      /* Identifies the pool */
407         bus_dma_tag_t    dmat;          /* Tag for our fixed allocations */
408         m_addr_t (*getp)(struct m_pool *);
409 #ifdef  MEMO_FREE_UNUSED
410         void (*freep)(struct m_pool *, m_addr_t);
411 #endif
412 #define M_GETP()                mp->getp(mp)
413 #define M_FREEP(p)              mp->freep(mp, p)
414         int nump;
415         m_vtob_s *(vtob[VTOB_HASH_SIZE]);
416         struct m_pool *next;
417         struct m_link h[MEMO_CLUSTER_SHIFT - MEMO_SHIFT + 1];
418 } m_pool_s;
419
420 static void *___sym_malloc(m_pool_s *mp, int size)
421 {
422         int i = 0;
423         int s = (1 << MEMO_SHIFT);
424         int j;
425         m_addr_t a;
426         m_link_s *h = mp->h;
427
428         if (size > MEMO_CLUSTER_SIZE)
429                 return NULL;
430
431         while (size > s) {
432                 s <<= 1;
433                 ++i;
434         }
435
436         j = i;
437         while (!h[j].next) {
438                 if (s == MEMO_CLUSTER_SIZE) {
439                         h[j].next = (m_link_s *) M_GETP();
440                         if (h[j].next)
441                                 h[j].next->next = NULL;
442                         break;
443                 }
444                 ++j;
445                 s <<= 1;
446         }
447         a = (m_addr_t) h[j].next;
448         if (a) {
449                 h[j].next = h[j].next->next;
450                 while (j > i) {
451                         j -= 1;
452                         s >>= 1;
453                         h[j].next = (m_link_s *) (a+s);
454                         h[j].next->next = NULL;
455                 }
456         }
457 #ifdef DEBUG
458         kprintf("___sym_malloc(%d) = %p\n", size, (void *) a);
459 #endif
460         return (void *) a;
461 }
462
463 static void ___sym_mfree(m_pool_s *mp, void *ptr, int size)
464 {
465         int i = 0;
466         int s = (1 << MEMO_SHIFT);
467         m_link_s *q;
468         m_addr_t a, b;
469         m_link_s *h = mp->h;
470
471 #ifdef DEBUG
472         kprintf("___sym_mfree(%p, %d)\n", ptr, size);
473 #endif
474
475         if (size > MEMO_CLUSTER_SIZE)
476                 return;
477
478         while (size > s) {
479                 s <<= 1;
480                 ++i;
481         }
482
483         a = (m_addr_t) ptr;
484
485         while (1) {
486 #ifdef MEMO_FREE_UNUSED
487                 if (s == MEMO_CLUSTER_SIZE) {
488                         M_FREEP(a);
489                         break;
490                 }
491 #endif
492                 b = a ^ s;
493                 q = &h[i];
494                 while (q->next && q->next != (m_link_s *) b) {
495                         q = q->next;
496                 }
497                 if (!q->next) {
498                         ((m_link_s *) a)->next = h[i].next;
499                         h[i].next = (m_link_s *) a;
500                         break;
501                 }
502                 q->next = q->next->next;
503                 a = a & b;
504                 s <<= 1;
505                 ++i;
506         }
507 }
508
509 static void *__sym_calloc2(m_pool_s *mp, int size, char *name, int uflags)
510 {
511         void *p;
512
513         p = ___sym_malloc(mp, size);
514
515         if (DEBUG_FLAGS & DEBUG_ALLOC)
516                 kprintf ("new %-10s[%4d] @%p.\n", name, size, p);
517
518         if (p)
519                 bzero(p, size);
520         else if (uflags & MEMO_WARN)
521                 kprintf ("__sym_calloc2: failed to allocate %s[%d]\n", name, size);
522
523         return p;
524 }
525
526 #define __sym_calloc(mp, s, n)  __sym_calloc2(mp, s, n, MEMO_WARN)
527
528 static void __sym_mfree(m_pool_s *mp, void *ptr, int size, char *name)
529 {
530         if (DEBUG_FLAGS & DEBUG_ALLOC)
531                 kprintf ("freeing %-10s[%4d] @%p.\n", name, size, ptr);
532
533         ___sym_mfree(mp, ptr, size);
534
535 }
536
537 /*
538  * Default memory pool we donnot need to involve in DMA.
539  */
540 /*
541  * With the `bus dma abstraction', we use a separate pool for
542  * memory we donnot need to involve in DMA.
543  */
544 static m_addr_t ___mp0_getp(m_pool_s *mp)
545 {
546         m_addr_t m = (m_addr_t) get_pages();
547         if (m)
548                 ++mp->nump;
549         return m;
550 }
551
552 #ifdef  MEMO_FREE_UNUSED
553 static void ___mp0_freep(m_pool_s *mp, m_addr_t m)
554 {
555         free_pages(m);
556         --mp->nump;
557 }
558 #endif
559
560 #ifdef  MEMO_FREE_UNUSED
561 static m_pool_s mp0 = {0, 0, ___mp0_getp, ___mp0_freep};
562 #else
563 static m_pool_s mp0 = {0, 0, ___mp0_getp};
564 #endif
565
566
567 /*
568  * Actual memory allocation routine for non-DMAed memory.
569  */
570 static void *sym_calloc(int size, char *name)
571 {
572         void *m;
573         /* Lock */
574         m = __sym_calloc(&mp0, size, name);
575         /* Unlock */
576         return m;
577 }
578
579 /*
580  * Actual memory allocation routine for non-DMAed memory.
581  */
582 static void sym_mfree(void *ptr, int size, char *name)
583 {
584         /* Lock */
585         __sym_mfree(&mp0, ptr, size, name);
586         /* Unlock */
587 }
588
589 /*
590  * DMAable pools.
591  */
592 /*
593  * With `bus dma abstraction', we use a separate pool per parent
594  * BUS handle. A reverse table (hashed) is maintained for virtual
595  * to BUS address translation.
596  */
597 static void getbaddrcb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
598 {
599         bus_addr_t *baddr;
600         baddr = (bus_addr_t *)arg;
601         *baddr = segs->ds_addr;
602 }
603
604 static m_addr_t ___dma_getp(m_pool_s *mp)
605 {
606         m_vtob_s *vbp;
607         void *vaddr = NULL;
608         bus_addr_t baddr = 0;
609
610         vbp = __sym_calloc(&mp0, sizeof(*vbp), "VTOB");
611         if (!vbp)
612                 goto out_err;
613
614         if (bus_dmamem_alloc(mp->dmat, &vaddr,
615                         BUS_DMA_COHERENT | BUS_DMA_WAITOK, &vbp->dmamap))
616                 goto out_err;
617         bus_dmamap_load(mp->dmat, vbp->dmamap, vaddr,
618                         MEMO_CLUSTER_SIZE, getbaddrcb, &baddr, BUS_DMA_NOWAIT);
619         if (baddr) {
620                 int hc = VTOB_HASH_CODE(vaddr);
621                 vbp->vaddr = (m_addr_t) vaddr;
622                 vbp->baddr = (m_addr_t) baddr;
623                 vbp->next = mp->vtob[hc];
624                 mp->vtob[hc] = vbp;
625                 ++mp->nump;
626                 return (m_addr_t) vaddr;
627         }
628 out_err:
629         if (baddr)
630                 bus_dmamap_unload(mp->dmat, vbp->dmamap);
631         if (vaddr)
632                 bus_dmamem_free(mp->dmat, vaddr, vbp->dmamap);
633         if (vbp) {
634                 if (vbp->dmamap)
635                         bus_dmamap_destroy(mp->dmat, vbp->dmamap);
636                 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
637         }
638         return 0;
639 }
640
641 #ifdef  MEMO_FREE_UNUSED
642 static void ___dma_freep(m_pool_s *mp, m_addr_t m)
643 {
644         m_vtob_s **vbpp, *vbp;
645         int hc = VTOB_HASH_CODE(m);
646
647         vbpp = &mp->vtob[hc];
648         while (*vbpp && (*vbpp)->vaddr != m)
649                 vbpp = &(*vbpp)->next;
650         if (*vbpp) {
651                 vbp = *vbpp;
652                 *vbpp = (*vbpp)->next;
653                 bus_dmamap_unload(mp->dmat, vbp->dmamap);
654                 bus_dmamem_free(mp->dmat, (void *) vbp->vaddr, vbp->dmamap);
655                 bus_dmamap_destroy(mp->dmat, vbp->dmamap);
656                 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
657                 --mp->nump;
658         }
659 }
660 #endif
661
662 static __inline m_pool_s *___get_dma_pool(bus_dma_tag_t dev_dmat)
663 {
664         m_pool_s *mp;
665         for (mp = mp0.next; mp && mp->dev_dmat != dev_dmat; mp = mp->next);
666         return mp;
667 }
668
669 static m_pool_s *___cre_dma_pool(bus_dma_tag_t dev_dmat)
670 {
671         m_pool_s *mp = NULL;
672
673         mp = __sym_calloc(&mp0, sizeof(*mp), "MPOOL");
674         if (mp) {
675                 mp->dev_dmat = dev_dmat;
676                 if (!bus_dma_tag_create(dev_dmat, 1, MEMO_CLUSTER_SIZE,
677                                BUS_SPACE_MAXADDR_32BIT,
678                                BUS_SPACE_MAXADDR,
679                                NULL, NULL, MEMO_CLUSTER_SIZE, 1,
680                                MEMO_CLUSTER_SIZE, 0,
681                                &mp->dmat)) {
682                         mp->getp = ___dma_getp;
683 #ifdef  MEMO_FREE_UNUSED
684                         mp->freep = ___dma_freep;
685 #endif
686                         mp->next = mp0.next;
687                         mp0.next = mp;
688                         return mp;
689                 }
690         }
691         if (mp)
692                 __sym_mfree(&mp0, mp, sizeof(*mp), "MPOOL");
693         return NULL;
694 }
695
696 #ifdef  MEMO_FREE_UNUSED
697 static void ___del_dma_pool(m_pool_s *p)
698 {
699         struct m_pool **pp = &mp0.next;
700
701         while (*pp && *pp != p)
702                 pp = &(*pp)->next;
703         if (*pp) {
704                 *pp = (*pp)->next;
705                 bus_dma_tag_destroy(p->dmat);
706                 __sym_mfree(&mp0, p, sizeof(*p), "MPOOL");
707         }
708 }
709 #endif
710
711 static void *__sym_calloc_dma(bus_dma_tag_t dev_dmat, int size, char *name)
712 {
713         struct m_pool *mp;
714         void *m = NULL;
715
716         /* Lock */
717         mp = ___get_dma_pool(dev_dmat);
718         if (!mp)
719                 mp = ___cre_dma_pool(dev_dmat);
720         if (mp)
721                 m = __sym_calloc(mp, size, name);
722 #ifdef  MEMO_FREE_UNUSED
723         if (mp && !mp->nump)
724                 ___del_dma_pool(mp);
725 #endif
726         /* Unlock */
727
728         return m;
729 }
730
731 static void
732 __sym_mfree_dma(bus_dma_tag_t dev_dmat, void *m, int size, char *name)
733 {
734         struct m_pool *mp;
735
736         /* Lock */
737         mp = ___get_dma_pool(dev_dmat);
738         if (mp)
739                 __sym_mfree(mp, m, size, name);
740 #ifdef  MEMO_FREE_UNUSED
741         if (mp && !mp->nump)
742                 ___del_dma_pool(mp);
743 #endif
744         /* Unlock */
745 }
746
747 static m_addr_t __vtobus(bus_dma_tag_t dev_dmat, void *m)
748 {
749         m_pool_s *mp;
750         int hc = VTOB_HASH_CODE(m);
751         m_vtob_s *vp = NULL;
752         m_addr_t a = ((m_addr_t) m) & ~MEMO_CLUSTER_MASK;
753
754         /* Lock */
755         mp = ___get_dma_pool(dev_dmat);
756         if (mp) {
757                 vp = mp->vtob[hc];
758                 while (vp && vp->vaddr != a)
759                         vp = vp->next;
760         }
761         /* Unlock */
762         if (!vp)
763                 panic("sym: VTOBUS FAILED!");
764         return vp ? vp->baddr + (((m_addr_t) m) - a) : 0;
765 }
766
767
768 /*
769  * Verbs for DMAable memory handling.
770  * The _uvptv_ macro avoids a nasty warning about pointer to volatile
771  * being discarded.
772  */
773 #define _uvptv_(p) ((void *)((vm_offset_t)(p)))
774 #define _sym_calloc_dma(np, s, n)       __sym_calloc_dma(np->bus_dmat, s, n)
775 #define _sym_mfree_dma(np, p, s, n)     \
776                                 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), s, n)
777 #define sym_calloc_dma(s, n)            _sym_calloc_dma(np, s, n)
778 #define sym_mfree_dma(p, s, n)          _sym_mfree_dma(np, p, s, n)
779 #define _vtobus(np, p)                  __vtobus(np->bus_dmat, _uvptv_(p))
780 #define vtobus(p)                       _vtobus(np, p)
781
782
783 /*
784  *  Print a buffer in hexadecimal format.
785  */
786 static void sym_printb_hex (u_char *p, int n)
787 {
788         while (n-- > 0)
789                 kprintf (" %x", *p++);
790 }
791
792 /*
793  *  Same with a label at beginning and .\n at end.
794  */
795 static void sym_printl_hex (char *label, u_char *p, int n)
796 {
797         kprintf ("%s", label);
798         sym_printb_hex (p, n);
799         kprintf (".\n");
800 }
801
802 /*
803  *  Return a string for SCSI BUS mode.
804  */
805 static const char *sym_scsi_bus_mode(int mode)
806 {
807         switch(mode) {
808         case SMODE_HVD: return "HVD";
809         case SMODE_SE:  return "SE";
810         case SMODE_LVD: return "LVD";
811         }
812         return "??";
813 }
814
815 /*
816  *  Some poor and bogus sync table that refers to Tekram NVRAM layout.
817  */
818 #ifdef SYM_CONF_NVRAM_SUPPORT
819 static const u_char Tekram_sync[16] =
820         {25,31,37,43, 50,62,75,125, 12,15,18,21, 6,7,9,10};
821 #endif
822
823 /*
824  *  Union of supported NVRAM formats.
825  */
826 struct sym_nvram {
827         int type;
828 #define SYM_SYMBIOS_NVRAM       (1)
829 #define SYM_TEKRAM_NVRAM        (2)
830 #ifdef  SYM_CONF_NVRAM_SUPPORT
831         union {
832                 Symbios_nvram Symbios;
833                 Tekram_nvram Tekram;
834         } data;
835 #endif
836 };
837
838 /*
839  *  This one is hopefully useless, but actually useful. :-)
840  */
841 #ifndef assert
842 #define assert(expression) { \
843         if (!(expression)) { \
844                 (void)panic( \
845                         "assertion \"%s\" failed: file \"%s\", line %d", \
846                         #expression, \
847                         __FILE__, __LINE__); \
848         } \
849 }
850 #endif
851
852 /*
853  *  Some provision for a possible big endian mode supported by
854  *  Symbios chips (never seen, by the way).
855  *  For now, this stuff does not deserve any comments. :)
856  */
857
858 #define sym_offb(o)     (o)
859 #define sym_offw(o)     (o)
860
861 /*
862  *  Some provision for support for BIG ENDIAN CPU.
863  */
864
865 #define cpu_to_scr(dw)  htole32(dw)
866 #define scr_to_cpu(dw)  le32toh(dw)
867
868 /*
869  *  Access to the chip IO registers and on-chip RAM.
870  *  We use the `bus space' interface under FreeBSD-4 and
871  *  later kernel versions.
872  */
873
874
875 #if defined(SYM_CONF_IOMAPPED)
876
877 #define INB_OFF(o)      bus_read_1(np->io_res, (o))
878 #define INW_OFF(o)      bus_read_2(np->io_res, (o))
879 #define INL_OFF(o)      bus_read_4(np->io_res, (o))
880
881 #define OUTB_OFF(o, v)  bus_write_1(np->io_res, (o), (v))
882 #define OUTW_OFF(o, v)  bus_write_2(np->io_res, (o), (v))
883 #define OUTL_OFF(o, v)  bus_write_4(np->io_res, (o), (v))
884
885 #else   /* Memory mapped IO */
886
887 #define INB_OFF(o)      bus_read_1(np->mmio_res, (o))
888 #define INW_OFF(o)      bus_read_2(np->mmio_res, (o))
889 #define INL_OFF(o)      bus_read_4(np->mmio_res, (o))
890
891 #define OUTB_OFF(o, v)  bus_write_1(np->mmio_res, (o), (v))
892 #define OUTW_OFF(o, v)  bus_write_2(np->mmio_res, (o), (v))
893 #define OUTL_OFF(o, v)  bus_write_4(np->mmio_res, (o), (v))
894
895 #endif  /* SYM_CONF_IOMAPPED */
896
897 #define OUTRAM_OFF(o, a, l)     \
898         bus_write_region_1(np->ram_res, (o), (a), (l))
899
900
901 /*
902  *  Common definitions for both bus space and legacy IO methods.
903  */
904 #define INB(r)          INB_OFF(offsetof(struct sym_reg,r))
905 #define INW(r)          INW_OFF(offsetof(struct sym_reg,r))
906 #define INL(r)          INL_OFF(offsetof(struct sym_reg,r))
907
908 #define OUTB(r, v)      OUTB_OFF(offsetof(struct sym_reg,r), (v))
909 #define OUTW(r, v)      OUTW_OFF(offsetof(struct sym_reg,r), (v))
910 #define OUTL(r, v)      OUTL_OFF(offsetof(struct sym_reg,r), (v))
911
912 #define OUTONB(r, m)    OUTB(r, INB(r) | (m))
913 #define OUTOFFB(r, m)   OUTB(r, INB(r) & ~(m))
914 #define OUTONW(r, m)    OUTW(r, INW(r) | (m))
915 #define OUTOFFW(r, m)   OUTW(r, INW(r) & ~(m))
916 #define OUTONL(r, m)    OUTL(r, INL(r) | (m))
917 #define OUTOFFL(r, m)   OUTL(r, INL(r) & ~(m))
918
919 /*
920  *  We normally want the chip to have a consistent view
921  *  of driver internal data structures when we restart it.
922  *  Thus these macros.
923  */
924 #define OUTL_DSP(v)                             \
925         do {                                    \
926                 MEMORY_BARRIER();               \
927                 OUTL (nc_dsp, (v));             \
928         } while (0)
929
930 #define OUTONB_STD()                            \
931         do {                                    \
932                 MEMORY_BARRIER();               \
933                 OUTONB (nc_dcntl, (STD|NOCOM)); \
934         } while (0)
935
936 /*
937  *  Command control block states.
938  */
939 #define HS_IDLE         (0)
940 #define HS_BUSY         (1)
941 #define HS_NEGOTIATE    (2)     /* sync/wide data transfer*/
942 #define HS_DISCONNECT   (3)     /* Disconnected by target */
943 #define HS_WAIT         (4)     /* waiting for resource   */
944
945 #define HS_DONEMASK     (0x80)
946 #define HS_COMPLETE     (4|HS_DONEMASK)
947 #define HS_SEL_TIMEOUT  (5|HS_DONEMASK) /* Selection timeout      */
948 #define HS_UNEXPECTED   (6|HS_DONEMASK) /* Unexpected disconnect  */
949 #define HS_COMP_ERR     (7|HS_DONEMASK) /* Completed with error   */
950
951 /*
952  *  Software Interrupt Codes
953  */
954 #define SIR_BAD_SCSI_STATUS     (1)
955 #define SIR_SEL_ATN_NO_MSG_OUT  (2)
956 #define SIR_MSG_RECEIVED        (3)
957 #define SIR_MSG_WEIRD           (4)
958 #define SIR_NEGO_FAILED         (5)
959 #define SIR_NEGO_PROTO          (6)
960 #define SIR_SCRIPT_STOPPED      (7)
961 #define SIR_REJECT_TO_SEND      (8)
962 #define SIR_SWIDE_OVERRUN       (9)
963 #define SIR_SODL_UNDERRUN       (10)
964 #define SIR_RESEL_NO_MSG_IN     (11)
965 #define SIR_RESEL_NO_IDENTIFY   (12)
966 #define SIR_RESEL_BAD_LUN       (13)
967 #define SIR_TARGET_SELECTED     (14)
968 #define SIR_RESEL_BAD_I_T_L     (15)
969 #define SIR_RESEL_BAD_I_T_L_Q   (16)
970 #define SIR_ABORT_SENT          (17)
971 #define SIR_RESEL_ABORTED       (18)
972 #define SIR_MSG_OUT_DONE        (19)
973 #define SIR_COMPLETE_ERROR      (20)
974 #define SIR_DATA_OVERRUN        (21)
975 #define SIR_BAD_PHASE           (22)
976 #define SIR_MAX                 (22)
977
978 /*
979  *  Extended error bit codes.
980  *  xerr_status field of struct sym_ccb.
981  */
982 #define XE_EXTRA_DATA   (1)     /* unexpected data phase         */
983 #define XE_BAD_PHASE    (1<<1)  /* illegal phase (4/5)           */
984 #define XE_PARITY_ERR   (1<<2)  /* unrecovered SCSI parity error */
985 #define XE_SODL_UNRUN   (1<<3)  /* ODD transfer in DATA OUT phase */
986 #define XE_SWIDE_OVRUN  (1<<4)  /* ODD transfer in DATA IN phase */
987
988 /*
989  *  Negotiation status.
990  *  nego_status field of struct sym_ccb.
991  */
992 #define NS_SYNC         (1)
993 #define NS_WIDE         (2)
994 #define NS_PPR          (3)
995
996 /*
997  *  A CCB hashed table is used to retrieve CCB address
998  *  from DSA value.
999  */
1000 #define CCB_HASH_SHIFT          8
1001 #define CCB_HASH_SIZE           (1UL << CCB_HASH_SHIFT)
1002 #define CCB_HASH_MASK           (CCB_HASH_SIZE-1)
1003 #define CCB_HASH_CODE(dsa)      (((dsa) >> 9) & CCB_HASH_MASK)
1004
1005 /*
1006  *  Device flags.
1007  */
1008 #define SYM_DISC_ENABLED        (1)
1009 #define SYM_TAGS_ENABLED        (1<<1)
1010 #define SYM_SCAN_BOOT_DISABLED  (1<<2)
1011 #define SYM_SCAN_LUNS_DISABLED  (1<<3)
1012
1013 /*
1014  *  Host adapter miscellaneous flags.
1015  */
1016 #define SYM_AVOID_BUS_RESET     (1)
1017 #define SYM_SCAN_TARGETS_HILO   (1<<1)
1018
1019 /*
1020  *  Device quirks.
1021  *  Some devices, for example the CHEETAH 2 LVD, disconnects without
1022  *  saving the DATA POINTER then reselects and terminates the IO.
1023  *  On reselection, the automatic RESTORE DATA POINTER makes the
1024  *  CURRENT DATA POINTER not point at the end of the IO.
1025  *  This behaviour just breaks our calculation of the residual.
1026  *  For now, we just force an AUTO SAVE on disconnection and will
1027  *  fix that in a further driver version.
1028  */
1029 #define SYM_QUIRK_AUTOSAVE 1
1030
1031 /*
1032  *  Misc.
1033  */
1034 #define SYM_LOCK()              lockmgr(&np->lock, LK_EXCLUSIVE)
1035 #define SYM_LOCK_ASSERT(_what)  KKASSERT(lockstatus(&np->lock, curthread) == (_what));
1036 #define SYM_LOCK_DESTROY()      lockuninit(&np->lock)
1037 #define SYM_LOCK_INIT()         lockinit(&np->lock, "sym_lock", 0, LK_CANRECURSE)
1038 #if 0 /* XXX swildner */
1039 #define SYM_LOCK_INITIALIZED()  mtx_initialized(&np->lock)
1040 #endif
1041 #define SYM_UNLOCK()            lockmgr(&np->lock, LK_RELEASE)
1042
1043 #define SYM_SNOOP_TIMEOUT (10000000)
1044 #define SYM_PCI_IO      PCIR_BAR(0)
1045 #define SYM_PCI_MMIO    PCIR_BAR(1)
1046 #define SYM_PCI_RAM     PCIR_BAR(2)
1047 #define SYM_PCI_RAM64   PCIR_BAR(3)
1048
1049 /*
1050  *  Back-pointer from the CAM CCB to our data structures.
1051  */
1052 #define sym_hcb_ptr     spriv_ptr0
1053 /* #define sym_ccb_ptr  spriv_ptr1 */
1054
1055 /*
1056  *  We mostly have to deal with pointers.
1057  *  Thus these typedef's.
1058  */
1059 typedef struct sym_tcb *tcb_p;
1060 typedef struct sym_lcb *lcb_p;
1061 typedef struct sym_ccb *ccb_p;
1062 typedef struct sym_hcb *hcb_p;
1063
1064 /*
1065  *  Gather negotiable parameters value
1066  */
1067 struct sym_trans {
1068         u8 scsi_version;
1069         u8 spi_version;
1070         u8 period;
1071         u8 offset;
1072         u8 width;
1073         u8 options;     /* PPR options */
1074 };
1075
1076 struct sym_tinfo {
1077         struct sym_trans current;
1078         struct sym_trans goal;
1079         struct sym_trans user;
1080 };
1081
1082 #define BUS_8_BIT       MSG_EXT_WDTR_BUS_8_BIT
1083 #define BUS_16_BIT      MSG_EXT_WDTR_BUS_16_BIT
1084
1085 /*
1086  *  Global TCB HEADER.
1087  *
1088  *  Due to lack of indirect addressing on earlier NCR chips,
1089  *  this substructure is copied from the TCB to a global
1090  *  address after selection.
1091  *  For SYMBIOS chips that support LOAD/STORE this copy is
1092  *  not needed and thus not performed.
1093  */
1094 struct sym_tcbh {
1095         /*
1096          *  Scripts bus addresses of LUN table accessed from scripts.
1097          *  LUN #0 is a special case, since multi-lun devices are rare,
1098          *  and we we want to speed-up the general case and not waste
1099          *  resources.
1100          */
1101         u32     luntbl_sa;      /* bus address of this table    */
1102         u32     lun0_sa;        /* bus address of LCB #0        */
1103         /*
1104          *  Actual SYNC/WIDE IO registers value for this target.
1105          *  'sval', 'wval' and 'uval' are read from SCRIPTS and
1106          *  so have alignment constraints.
1107          */
1108 /*0*/   u_char  uval;           /* -> SCNTL4 register           */
1109 /*1*/   u_char  sval;           /* -> SXFER  io register        */
1110 /*2*/   u_char  filler1;
1111 /*3*/   u_char  wval;           /* -> SCNTL3 io register        */
1112 };
1113
1114 /*
1115  *  Target Control Block
1116  */
1117 struct sym_tcb {
1118         /*
1119          *  TCB header.
1120          *  Assumed at offset 0.
1121          */
1122 /*0*/   struct sym_tcbh head;
1123
1124         /*
1125          *  LUN table used by the SCRIPTS processor.
1126          *  An array of bus addresses is used on reselection.
1127          */
1128         u32     *luntbl;        /* LCBs bus address table       */
1129
1130         /*
1131          *  LUN table used by the C code.
1132          */
1133         lcb_p   lun0p;          /* LCB of LUN #0 (usual case)   */
1134 #if SYM_CONF_MAX_LUN > 1
1135         lcb_p   *lunmp;         /* Other LCBs [1..MAX_LUN]      */
1136 #endif
1137
1138         /*
1139          *  Bitmap that tells about LUNs that succeeded at least
1140          *  1 IO and therefore assumed to be a real device.
1141          *  Avoid useless allocation of the LCB structure.
1142          */
1143         u32     lun_map[(SYM_CONF_MAX_LUN+31)/32];
1144
1145         /*
1146          *  Bitmap that tells about LUNs that haven't yet an LCB
1147          *  allocated (not discovered or LCB allocation failed).
1148          */
1149         u32     busy0_map[(SYM_CONF_MAX_LUN+31)/32];
1150
1151         /*
1152          *  Transfer capabilities (SIP)
1153          */
1154         struct sym_tinfo tinfo;
1155
1156         /*
1157          * Keep track of the CCB used for the negotiation in order
1158          * to ensure that only 1 negotiation is queued at a time.
1159          */
1160         ccb_p   nego_cp;        /* CCB used for the nego                */
1161
1162         /*
1163          *  Set when we want to reset the device.
1164          */
1165         u_char  to_reset;
1166
1167         /*
1168          *  Other user settable limits and options.
1169          *  These limits are read from the NVRAM if present.
1170          */
1171         u_char  usrflags;
1172         u_short usrtags;
1173 };
1174
1175 /*
1176  *  Global LCB HEADER.
1177  *
1178  *  Due to lack of indirect addressing on earlier NCR chips,
1179  *  this substructure is copied from the LCB to a global
1180  *  address after selection.
1181  *  For SYMBIOS chips that support LOAD/STORE this copy is
1182  *  not needed and thus not performed.
1183  */
1184 struct sym_lcbh {
1185         /*
1186          *  SCRIPTS address jumped by SCRIPTS on reselection.
1187          *  For not probed logical units, this address points to
1188          *  SCRIPTS that deal with bad LU handling (must be at
1189          *  offset zero of the LCB for that reason).
1190          */
1191 /*0*/   u32     resel_sa;
1192
1193         /*
1194          *  Task (bus address of a CCB) read from SCRIPTS that points
1195          *  to the unique ITL nexus allowed to be disconnected.
1196          */
1197         u32     itl_task_sa;
1198
1199         /*
1200          *  Task table bus address (read from SCRIPTS).
1201          */
1202         u32     itlq_tbl_sa;
1203 };
1204
1205 /*
1206  *  Logical Unit Control Block
1207  */
1208 struct sym_lcb {
1209         /*
1210          *  TCB header.
1211          *  Assumed at offset 0.
1212          */
1213 /*0*/   struct sym_lcbh head;
1214
1215         /*
1216          *  Task table read from SCRIPTS that contains pointers to
1217          *  ITLQ nexuses. The bus address read from SCRIPTS is
1218          *  inside the header.
1219          */
1220         u32     *itlq_tbl;      /* Kernel virtual address       */
1221
1222         /*
1223          *  Busy CCBs management.
1224          */
1225         u_short busy_itlq;      /* Number of busy tagged CCBs   */
1226         u_short busy_itl;       /* Number of busy untagged CCBs */
1227
1228         /*
1229          *  Circular tag allocation buffer.
1230          */
1231         u_short ia_tag;         /* Tag allocation index         */
1232         u_short if_tag;         /* Tag release index            */
1233         u_char  *cb_tags;       /* Circular tags buffer         */
1234
1235         /*
1236          *  Set when we want to clear all tasks.
1237          */
1238         u_char to_clear;
1239
1240         /*
1241          *  Capabilities.
1242          */
1243         u_char  user_flags;
1244         u_char  current_flags;
1245 };
1246
1247 /*
1248  *  Action from SCRIPTS on a task.
1249  *  Is part of the CCB, but is also used separately to plug
1250  *  error handling action to perform from SCRIPTS.
1251  */
1252 struct sym_actscr {
1253         u32     start;          /* Jumped by SCRIPTS after selection    */
1254         u32     restart;        /* Jumped by SCRIPTS on relection       */
1255 };
1256
1257 /*
1258  *  Phase mismatch context.
1259  *
1260  *  It is part of the CCB and is used as parameters for the
1261  *  DATA pointer. We need two contexts to handle correctly the
1262  *  SAVED DATA POINTER.
1263  */
1264 struct sym_pmc {
1265         struct  sym_tblmove sg; /* Updated interrupted SG block */
1266         u32     ret;            /* SCRIPT return address        */
1267 };
1268
1269 /*
1270  *  LUN control block lookup.
1271  *  We use a direct pointer for LUN #0, and a table of
1272  *  pointers which is only allocated for devices that support
1273  *  LUN(s) > 0.
1274  */
1275 #if SYM_CONF_MAX_LUN <= 1
1276 #define sym_lp(np, tp, lun) (!lun) ? (tp)->lun0p : 0
1277 #else
1278 #define sym_lp(np, tp, lun) \
1279         (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : 0
1280 #endif
1281
1282 /*
1283  *  Status are used by the host and the script processor.
1284  *
1285  *  The last four bytes (status[4]) are copied to the
1286  *  scratchb register (declared as scr0..scr3) just after the
1287  *  select/reselect, and copied back just after disconnecting.
1288  *  Inside the script the XX_REG are used.
1289  */
1290
1291 /*
1292  *  Last four bytes (script)
1293  */
1294 #define  QU_REG scr0
1295 #define  HS_REG scr1
1296 #define  HS_PRT nc_scr1
1297 #define  SS_REG scr2
1298 #define  SS_PRT nc_scr2
1299 #define  HF_REG scr3
1300 #define  HF_PRT nc_scr3
1301
1302 /*
1303  *  Last four bytes (host)
1304  */
1305 #define  actualquirks  phys.head.status[0]
1306 #define  host_status   phys.head.status[1]
1307 #define  ssss_status   phys.head.status[2]
1308 #define  host_flags    phys.head.status[3]
1309
1310 /*
1311  *  Host flags
1312  */
1313 #define HF_IN_PM0       1u
1314 #define HF_IN_PM1       (1u<<1)
1315 #define HF_ACT_PM       (1u<<2)
1316 #define HF_DP_SAVED     (1u<<3)
1317 #define HF_SENSE        (1u<<4)
1318 #define HF_EXT_ERR      (1u<<5)
1319 #define HF_DATA_IN      (1u<<6)
1320 #ifdef SYM_CONF_IARB_SUPPORT
1321 #define HF_HINT_IARB    (1u<<7)
1322 #endif
1323
1324 /*
1325  *  Global CCB HEADER.
1326  *
1327  *  Due to lack of indirect addressing on earlier NCR chips,
1328  *  this substructure is copied from the ccb to a global
1329  *  address after selection (or reselection) and copied back
1330  *  before disconnect.
1331  *  For SYMBIOS chips that support LOAD/STORE this copy is
1332  *  not needed and thus not performed.
1333  */
1334
1335 struct sym_ccbh {
1336         /*
1337          *  Start and restart SCRIPTS addresses (must be at 0).
1338          */
1339 /*0*/   struct sym_actscr go;
1340
1341         /*
1342          *  SCRIPTS jump address that deal with data pointers.
1343          *  'savep' points to the position in the script responsible
1344          *  for the actual transfer of data.
1345          *  It's written on reception of a SAVE_DATA_POINTER message.
1346          */
1347         u32     savep;          /* Jump address to saved data pointer   */
1348         u32     lastp;          /* SCRIPTS address at end of data       */
1349         u32     goalp;          /* Not accessed for now from SCRIPTS    */
1350
1351         /*
1352          *  Status fields.
1353          */
1354         u8      status[4];
1355 };
1356
1357 /*
1358  *  Data Structure Block
1359  *
1360  *  During execution of a ccb by the script processor, the
1361  *  DSA (data structure address) register points to this
1362  *  substructure of the ccb.
1363  */
1364 struct sym_dsb {
1365         /*
1366          *  CCB header.
1367          *  Also assumed at offset 0 of the sym_ccb structure.
1368          */
1369 /*0*/   struct sym_ccbh head;
1370
1371         /*
1372          *  Phase mismatch contexts.
1373          *  We need two to handle correctly the SAVED DATA POINTER.
1374          *  MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic
1375          *  for address calculation from SCRIPTS.
1376          */
1377         struct sym_pmc pm0;
1378         struct sym_pmc pm1;
1379
1380         /*
1381          *  Table data for Script
1382          */
1383         struct sym_tblsel  select;
1384         struct sym_tblmove smsg;
1385         struct sym_tblmove smsg_ext;
1386         struct sym_tblmove cmd;
1387         struct sym_tblmove sense;
1388         struct sym_tblmove wresid;
1389         struct sym_tblmove data [SYM_CONF_MAX_SG];
1390 };
1391
1392 /*
1393  *  Our Command Control Block
1394  */
1395 struct sym_ccb {
1396         /*
1397          *  This is the data structure which is pointed by the DSA
1398          *  register when it is executed by the script processor.
1399          *  It must be the first entry.
1400          */
1401         struct sym_dsb phys;
1402
1403         /*
1404          *  Pointer to CAM ccb and related stuff.
1405          */
1406         struct callout ch;      /* callout handle               */
1407         union ccb *cam_ccb;     /* CAM scsiio ccb               */
1408         u8      cdb_buf[16];    /* Copy of CDB                  */
1409         u8      *sns_bbuf;      /* Bounce buffer for sense data */
1410 #define SYM_SNS_BBUF_LEN        sizeof(struct scsi_sense_data)
1411         int     data_len;       /* Total data length            */
1412         int     segments;       /* Number of SG segments        */
1413
1414         /*
1415          *  Miscellaneous status'.
1416          */
1417         u_char  nego_status;    /* Negotiation status           */
1418         u_char  xerr_status;    /* Extended error flags         */
1419         u32     extra_bytes;    /* Extraneous bytes transferred */
1420
1421         /*
1422          *  Message areas.
1423          *  We prepare a message to be sent after selection.
1424          *  We may use a second one if the command is rescheduled
1425          *  due to CHECK_CONDITION or COMMAND TERMINATED.
1426          *  Contents are IDENTIFY and SIMPLE_TAG.
1427          *  While negotiating sync or wide transfer,
1428          *  a SDTR or WDTR message is appended.
1429          */
1430         u_char  scsi_smsg [12];
1431         u_char  scsi_smsg2[12];
1432
1433         /*
1434          *  Auto request sense related fields.
1435          */
1436         u_char  sensecmd[6];    /* Request Sense command        */
1437         u_char  sv_scsi_status; /* Saved SCSI status            */
1438         u_char  sv_xerr_status; /* Saved extended status        */
1439         int     sv_resid;       /* Saved residual               */
1440
1441         /*
1442          *  Map for the DMA of user data.
1443          */
1444         void            *arg;   /* Argument for some callback   */
1445         bus_dmamap_t    dmamap; /* DMA map for user data        */
1446         u_char          dmamapped;
1447 #define SYM_DMA_NONE    0
1448 #define SYM_DMA_READ    1
1449 #define SYM_DMA_WRITE   2
1450         /*
1451          *  Other fields.
1452          */
1453         u32     ccb_ba;         /* BUS address of this CCB      */
1454         u_short tag;            /* Tag for this transfer        */
1455                                 /*  NO_TAG means no tag         */
1456         u_char  target;
1457         u_char  lun;
1458         ccb_p   link_ccbh;      /* Host adapter CCB hash chain  */
1459         SYM_QUEHEAD
1460                 link_ccbq;      /* Link to free/busy CCB queue  */
1461         u32     startp;         /* Initial data pointer         */
1462         int     ext_sg;         /* Extreme data pointer, used   */
1463         int     ext_ofs;        /*  to calculate the residual.  */
1464         u_char  to_abort;       /* Want this IO to be aborted   */
1465 };
1466
1467 #define CCB_BA(cp,lbl)  (cp->ccb_ba + offsetof(struct sym_ccb, lbl))
1468
1469 /*
1470  *  Host Control Block
1471  */
1472 struct sym_hcb {
1473         struct lock     lock;
1474
1475         /*
1476          *  Global headers.
1477          *  Due to poorness of addressing capabilities, earlier
1478          *  chips (810, 815, 825) copy part of the data structures
1479          *  (CCB, TCB and LCB) in fixed areas.
1480          */
1481 #ifdef  SYM_CONF_GENERIC_SUPPORT
1482         struct sym_ccbh ccb_head;
1483         struct sym_tcbh tcb_head;
1484         struct sym_lcbh lcb_head;
1485 #endif
1486         /*
1487          *  Idle task and invalid task actions and
1488          *  their bus addresses.
1489          */
1490         struct sym_actscr idletask, notask, bad_itl, bad_itlq;
1491         vm_offset_t idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
1492
1493         /*
1494          *  Dummy lun table to protect us against target
1495          *  returning bad lun number on reselection.
1496          */
1497         u32     *badluntbl;     /* Table physical address       */
1498         u32     badlun_sa;      /* SCRIPT handler BUS address   */
1499
1500         /*
1501          *  Bus address of this host control block.
1502          */
1503         u32     hcb_ba;
1504
1505         /*
1506          *  Bit 32-63 of the on-chip RAM bus address in LE format.
1507          *  The START_RAM64 script loads the MMRS and MMWS from this
1508          *  field.
1509          */
1510         u32     scr_ram_seg;
1511
1512         /*
1513          *  Chip and controller indentification.
1514          */
1515         device_t device;
1516
1517         /*
1518          *  Initial value of some IO register bits.
1519          *  These values are assumed to have been set by BIOS, and may
1520          *  be used to probe adapter implementation differences.
1521          */
1522         u_char  sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
1523                 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
1524                 sv_stest1;
1525
1526         /*
1527          *  Actual initial value of IO register bits used by the
1528          *  driver. They are loaded at initialisation according to
1529          *  features that are to be enabled/disabled.
1530          */
1531         u_char  rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4,
1532                 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
1533
1534         /*
1535          *  Target data.
1536          */
1537 #ifdef __x86_64__
1538         struct sym_tcb  *target;
1539 #else
1540         struct sym_tcb  target[SYM_CONF_MAX_TARGET];
1541 #endif
1542
1543         /*
1544          *  Target control block bus address array used by the SCRIPT
1545          *  on reselection.
1546          */
1547         u32             *targtbl;
1548         u32             targtbl_ba;
1549
1550         /*
1551          *  CAM SIM information for this instance.
1552          */
1553         struct          cam_sim  *sim;
1554         struct          cam_path *path;
1555
1556         /*
1557          *  Allocated hardware resources.
1558          */
1559         struct resource *irq_res;
1560         struct resource *io_res;
1561         struct resource *mmio_res;
1562         struct resource *ram_res;
1563         int             ram_id;
1564         void *intr;
1565
1566         /*
1567          *  Bus stuff.
1568          *
1569          *  My understanding of PCI is that all agents must share the
1570          *  same addressing range and model.
1571          *  But some hardware architecture guys provide complex and
1572          *  brain-deaded stuff that makes shit.
1573          *  This driver only support PCI compliant implementations and
1574          *  deals with part of the BUS stuff complexity only to fit O/S
1575          *  requirements.
1576          */
1577
1578         /*
1579          *  DMA stuff.
1580          */
1581         bus_dma_tag_t   bus_dmat;       /* DMA tag from parent BUS      */
1582         bus_dma_tag_t   data_dmat;      /* DMA tag for user data        */
1583         /*
1584          *  BUS addresses of the chip
1585          */
1586         vm_offset_t     mmio_ba;        /* MMIO BUS address             */
1587         int             mmio_ws;        /* MMIO Window size             */
1588
1589         vm_offset_t     ram_ba;         /* RAM BUS address              */
1590         int             ram_ws;         /* RAM window size              */
1591
1592         /*
1593          *  SCRIPTS virtual and physical bus addresses.
1594          *  'script'  is loaded in the on-chip RAM if present.
1595          *  'scripth' stays in main memory for all chips except the
1596          *  53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
1597          */
1598         u_char          *scripta0;      /* Copies of script and scripth */
1599         u_char          *scriptb0;      /* Copies of script and scripth */
1600         vm_offset_t     scripta_ba;     /* Actual script and scripth    */
1601         vm_offset_t     scriptb_ba;     /*  bus addresses.              */
1602         vm_offset_t     scriptb0_ba;
1603         u_short         scripta_sz;     /* Actual size of script A      */
1604         u_short         scriptb_sz;     /* Actual size of script B      */
1605
1606         /*
1607          *  Bus addresses, setup and patch methods for
1608          *  the selected firmware.
1609          */
1610         struct sym_fwa_ba fwa_bas;      /* Useful SCRIPTA bus addresses */
1611         struct sym_fwb_ba fwb_bas;      /* Useful SCRIPTB bus addresses */
1612         void            (*fw_setup)(hcb_p np, const struct sym_fw *fw);
1613         void            (*fw_patch)(hcb_p np);
1614         const char      *fw_name;
1615
1616         /*
1617          *  General controller parameters and configuration.
1618          */
1619         u_short device_id;      /* PCI device id                */
1620         u_char  revision_id;    /* PCI device revision id       */
1621         u_int   features;       /* Chip features map            */
1622         u_char  myaddr;         /* SCSI id of the adapter       */
1623         u_char  maxburst;       /* log base 2 of dwords burst   */
1624         u_char  maxwide;        /* Maximum transfer width       */
1625         u_char  minsync;        /* Min sync period factor (ST)  */
1626         u_char  maxsync;        /* Max sync period factor (ST)  */
1627         u_char  maxoffs;        /* Max scsi offset        (ST)  */
1628         u_char  minsync_dt;     /* Min sync period factor (DT)  */
1629         u_char  maxsync_dt;     /* Max sync period factor (DT)  */
1630         u_char  maxoffs_dt;     /* Max scsi offset        (DT)  */
1631         u_char  multiplier;     /* Clock multiplier (1,2,4)     */
1632         u_char  clock_divn;     /* Number of clock divisors     */
1633         u32     clock_khz;      /* SCSI clock frequency in KHz  */
1634         u32     pciclk_khz;     /* Estimated PCI clock  in KHz  */
1635         /*
1636          *  Start queue management.
1637          *  It is filled up by the host processor and accessed by the
1638          *  SCRIPTS processor in order to start SCSI commands.
1639          */
1640         volatile                /* Prevent code optimizations   */
1641         u32     *squeue;        /* Start queue virtual address  */
1642         u32     squeue_ba;      /* Start queue BUS address      */
1643         u_short squeueput;      /* Next free slot of the queue  */
1644         u_short actccbs;        /* Number of allocated CCBs     */
1645
1646         /*
1647          *  Command completion queue.
1648          *  It is the same size as the start queue to avoid overflow.
1649          */
1650         u_short dqueueget;      /* Next position to scan        */
1651         volatile                /* Prevent code optimizations   */
1652         u32     *dqueue;        /* Completion (done) queue      */
1653         u32     dqueue_ba;      /* Done queue BUS address       */
1654
1655         /*
1656          *  Miscellaneous buffers accessed by the scripts-processor.
1657          *  They shall be DWORD aligned, because they may be read or
1658          *  written with a script command.
1659          */
1660         u_char          msgout[8];      /* Buffer for MESSAGE OUT       */
1661         u_char          msgin [8];      /* Buffer for MESSAGE IN        */
1662         u32             lastmsg;        /* Last SCSI message sent       */
1663         u_char          scratch;        /* Scratch for SCSI receive     */
1664
1665         /*
1666          *  Miscellaneous configuration and status parameters.
1667          */
1668         u_char          usrflags;       /* Miscellaneous user flags     */
1669         u_char          scsi_mode;      /* Current SCSI BUS mode        */
1670         u_char          verbose;        /* Verbosity for this controller*/
1671         u32             cache;          /* Used for cache test at init. */
1672
1673         /*
1674          *  CCB lists and queue.
1675          */
1676         ccb_p ccbh[CCB_HASH_SIZE];      /* CCB hashed by DSA value      */
1677         SYM_QUEHEAD     free_ccbq;      /* Queue of available CCBs      */
1678         SYM_QUEHEAD     busy_ccbq;      /* Queue of busy CCBs           */
1679
1680         /*
1681          *  During error handling and/or recovery,
1682          *  active CCBs that are to be completed with
1683          *  error or requeued are moved from the busy_ccbq
1684          *  to the comp_ccbq prior to completion.
1685          */
1686         SYM_QUEHEAD     comp_ccbq;
1687
1688         /*
1689          *  CAM CCB pending queue.
1690          */
1691         SYM_QUEHEAD     cam_ccbq;
1692
1693         /*
1694          *  IMMEDIATE ARBITRATION (IARB) control.
1695          *
1696          *  We keep track in 'last_cp' of the last CCB that has been
1697          *  queued to the SCRIPTS processor and clear 'last_cp' when
1698          *  this CCB completes. If last_cp is not zero at the moment
1699          *  we queue a new CCB, we set a flag in 'last_cp' that is
1700          *  used by the SCRIPTS as a hint for setting IARB.
1701          *  We donnot set more than 'iarb_max' consecutive hints for
1702          *  IARB in order to leave devices a chance to reselect.
1703          *  By the way, any non zero value of 'iarb_max' is unfair. :)
1704          */
1705 #ifdef SYM_CONF_IARB_SUPPORT
1706         u_short         iarb_max;       /* Max. # consecutive IARB hints*/
1707         u_short         iarb_count;     /* Actual # of these hints      */
1708         ccb_p           last_cp;
1709 #endif
1710
1711         /*
1712          *  Command abort handling.
1713          *  We need to synchronize tightly with the SCRIPTS
1714          *  processor in order to handle things correctly.
1715          */
1716         u_char          abrt_msg[4];    /* Message to send buffer       */
1717         struct sym_tblmove abrt_tbl;    /* Table for the MOV of it      */
1718         struct sym_tblsel  abrt_sel;    /* Sync params for selection    */
1719         u_char          istat_sem;      /* Tells the chip to stop (SEM) */
1720 };
1721
1722 #define HCB_BA(np, lbl)     (np->hcb_ba      + offsetof(struct sym_hcb, lbl))
1723
1724 /*
1725  *  Return the name of the controller.
1726  */
1727 static __inline const char *sym_name(hcb_p np)
1728 {
1729         return device_get_nameunit(np->device);
1730 }
1731
1732 /*--------------------------------------------------------------------------*/
1733 /*------------------------------ FIRMWARES ---------------------------------*/
1734 /*--------------------------------------------------------------------------*/
1735
1736 /*
1737  *  This stuff will be moved to a separate source file when
1738  *  the driver will be broken into several source modules.
1739  */
1740
1741 /*
1742  *  Macros used for all firmwares.
1743  */
1744 #define SYM_GEN_A(s, label)     ((short) offsetof(s, label)),
1745 #define SYM_GEN_B(s, label)     ((short) offsetof(s, label)),
1746 #define PADDR_A(label)          SYM_GEN_PADDR_A(struct SYM_FWA_SCR, label)
1747 #define PADDR_B(label)          SYM_GEN_PADDR_B(struct SYM_FWB_SCR, label)
1748
1749
1750 #ifdef  SYM_CONF_GENERIC_SUPPORT
1751 /*
1752  *  Allocate firmware #1 script area.
1753  */
1754 #define SYM_FWA_SCR             sym_fw1a_scr
1755 #define SYM_FWB_SCR             sym_fw1b_scr
1756 #include <dev/disk/sym/sym_fw1.h>
1757 static const struct sym_fwa_ofs sym_fw1a_ofs = {
1758         SYM_GEN_FW_A(struct SYM_FWA_SCR)
1759 };
1760 static const struct sym_fwb_ofs sym_fw1b_ofs = {
1761         SYM_GEN_FW_B(struct SYM_FWB_SCR)
1762 };
1763 #undef  SYM_FWA_SCR
1764 #undef  SYM_FWB_SCR
1765 #endif  /* SYM_CONF_GENERIC_SUPPORT */
1766
1767 /*
1768  *  Allocate firmware #2 script area.
1769  */
1770 #define SYM_FWA_SCR             sym_fw2a_scr
1771 #define SYM_FWB_SCR             sym_fw2b_scr
1772 #include <dev/disk/sym/sym_fw2.h>
1773 static const struct sym_fwa_ofs sym_fw2a_ofs = {
1774         SYM_GEN_FW_A(struct SYM_FWA_SCR)
1775 };
1776 static const struct sym_fwb_ofs sym_fw2b_ofs = {
1777         SYM_GEN_FW_B(struct SYM_FWB_SCR)
1778         SYM_GEN_B(struct SYM_FWB_SCR, start64)
1779         SYM_GEN_B(struct SYM_FWB_SCR, pm_handle)
1780 };
1781 #undef  SYM_FWA_SCR
1782 #undef  SYM_FWB_SCR
1783
1784 #undef  SYM_GEN_A
1785 #undef  SYM_GEN_B
1786 #undef  PADDR_A
1787 #undef  PADDR_B
1788
1789 #ifdef  SYM_CONF_GENERIC_SUPPORT
1790 /*
1791  *  Patch routine for firmware #1.
1792  */
1793 static void
1794 sym_fw1_patch(hcb_p np)
1795 {
1796         struct sym_fw1a_scr *scripta0;
1797         struct sym_fw1b_scr *scriptb0;
1798
1799         scripta0 = (struct sym_fw1a_scr *) np->scripta0;
1800         scriptb0 = (struct sym_fw1b_scr *) np->scriptb0;
1801
1802         /*
1803          *  Remove LED support if not needed.
1804          */
1805         if (!(np->features & FE_LED0)) {
1806                 scripta0->idle[0]       = cpu_to_scr(SCR_NO_OP);
1807                 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
1808                 scripta0->start[0]      = cpu_to_scr(SCR_NO_OP);
1809         }
1810
1811 #ifdef SYM_CONF_IARB_SUPPORT
1812         /*
1813          *    If user does not want to use IMMEDIATE ARBITRATION
1814          *    when we are reselected while attempting to arbitrate,
1815          *    patch the SCRIPTS accordingly with a SCRIPT NO_OP.
1816          */
1817         if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
1818                 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
1819 #endif
1820         /*
1821          *  Patch some data in SCRIPTS.
1822          *  - start and done queue initial bus address.
1823          *  - target bus address table bus address.
1824          */
1825         scriptb0->startpos[0]   = cpu_to_scr(np->squeue_ba);
1826         scriptb0->done_pos[0]   = cpu_to_scr(np->dqueue_ba);
1827         scriptb0->targtbl[0]    = cpu_to_scr(np->targtbl_ba);
1828 }
1829 #endif  /* SYM_CONF_GENERIC_SUPPORT */
1830
1831 /*
1832  *  Patch routine for firmware #2.
1833  */
1834 static void
1835 sym_fw2_patch(hcb_p np)
1836 {
1837         struct sym_fw2a_scr *scripta0;
1838         struct sym_fw2b_scr *scriptb0;
1839
1840         scripta0 = (struct sym_fw2a_scr *) np->scripta0;
1841         scriptb0 = (struct sym_fw2b_scr *) np->scriptb0;
1842
1843         /*
1844          *  Remove LED support if not needed.
1845          */
1846         if (!(np->features & FE_LED0)) {
1847                 scripta0->idle[0]       = cpu_to_scr(SCR_NO_OP);
1848                 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
1849                 scripta0->start[0]      = cpu_to_scr(SCR_NO_OP);
1850         }
1851
1852 #ifdef SYM_CONF_IARB_SUPPORT
1853         /*
1854          *    If user does not want to use IMMEDIATE ARBITRATION
1855          *    when we are reselected while attempting to arbitrate,
1856          *    patch the SCRIPTS accordingly with a SCRIPT NO_OP.
1857          */
1858         if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
1859                 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
1860 #endif
1861         /*
1862          *  Patch some variable in SCRIPTS.
1863          *  - start and done queue initial bus address.
1864          *  - target bus address table bus address.
1865          */
1866         scriptb0->startpos[0]   = cpu_to_scr(np->squeue_ba);
1867         scriptb0->done_pos[0]   = cpu_to_scr(np->dqueue_ba);
1868         scriptb0->targtbl[0]    = cpu_to_scr(np->targtbl_ba);
1869
1870         /*
1871          *  Remove the load of SCNTL4 on reselection if not a C10.
1872          */
1873         if (!(np->features & FE_C10)) {
1874                 scripta0->resel_scntl4[0] = cpu_to_scr(SCR_NO_OP);
1875                 scripta0->resel_scntl4[1] = cpu_to_scr(0);
1876         }
1877
1878         /*
1879          *  Remove a couple of work-arounds specific to C1010 if
1880          *  they are not desirable. See `sym_fw2.h' for more details.
1881          */
1882         if (!(np->device_id == PCI_ID_LSI53C1010_2 &&
1883               np->revision_id < 0x1 &&
1884               np->pciclk_khz < 60000)) {
1885                 scripta0->datao_phase[0] = cpu_to_scr(SCR_NO_OP);
1886                 scripta0->datao_phase[1] = cpu_to_scr(0);
1887         }
1888         if (!(np->device_id == PCI_ID_LSI53C1010 &&
1889               /* np->revision_id < 0xff */ 1)) {
1890                 scripta0->sel_done[0] = cpu_to_scr(SCR_NO_OP);
1891                 scripta0->sel_done[1] = cpu_to_scr(0);
1892         }
1893
1894         /*
1895          *  Patch some other variables in SCRIPTS.
1896          *  These ones are loaded by the SCRIPTS processor.
1897          */
1898         scriptb0->pm0_data_addr[0] =
1899                 cpu_to_scr(np->scripta_ba +
1900                            offsetof(struct sym_fw2a_scr, pm0_data));
1901         scriptb0->pm1_data_addr[0] =
1902                 cpu_to_scr(np->scripta_ba +
1903                            offsetof(struct sym_fw2a_scr, pm1_data));
1904 }
1905
1906 /*
1907  *  Fill the data area in scripts.
1908  *  To be done for all firmwares.
1909  */
1910 static void
1911 sym_fw_fill_data (u32 *in, u32 *out)
1912 {
1913         int     i;
1914
1915         for (i = 0; i < SYM_CONF_MAX_SG; i++) {
1916                 *in++  = SCR_CHMOV_TBL ^ SCR_DATA_IN;
1917                 *in++  = offsetof (struct sym_dsb, data[i]);
1918                 *out++ = SCR_CHMOV_TBL ^ SCR_DATA_OUT;
1919                 *out++ = offsetof (struct sym_dsb, data[i]);
1920         }
1921 }
1922
1923 /*
1924  *  Setup useful script bus addresses.
1925  *  To be done for all firmwares.
1926  */
1927 static void
1928 sym_fw_setup_bus_addresses(hcb_p np, const struct sym_fw *fw)
1929 {
1930         u32 *pa;
1931         const u_short *po;
1932         int i;
1933
1934         /*
1935          *  Build the bus address table for script A
1936          *  from the script A offset table.
1937          */
1938         po = (const u_short *) fw->a_ofs;
1939         pa = (u32 *) &np->fwa_bas;
1940         for (i = 0 ; i < sizeof(np->fwa_bas)/sizeof(u32) ; i++)
1941                 pa[i] = np->scripta_ba + po[i];
1942
1943         /*
1944          *  Same for script B.
1945          */
1946         po = (const u_short *) fw->b_ofs;
1947         pa = (u32 *) &np->fwb_bas;
1948         for (i = 0 ; i < sizeof(np->fwb_bas)/sizeof(u32) ; i++)
1949                 pa[i] = np->scriptb_ba + po[i];
1950 }
1951
1952 #ifdef  SYM_CONF_GENERIC_SUPPORT
1953 /*
1954  *  Setup routine for firmware #1.
1955  */
1956 static void
1957 sym_fw1_setup(hcb_p np, const struct sym_fw *fw)
1958 {
1959         struct sym_fw1a_scr *scripta0;
1960
1961         scripta0 = (struct sym_fw1a_scr *) np->scripta0;
1962
1963         /*
1964          *  Fill variable parts in scripts.
1965          */
1966         sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
1967
1968         /*
1969          *  Setup bus addresses used from the C code..
1970          */
1971         sym_fw_setup_bus_addresses(np, fw);
1972 }
1973 #endif  /* SYM_CONF_GENERIC_SUPPORT */
1974
1975 /*
1976  *  Setup routine for firmware #2.
1977  */
1978 static void
1979 sym_fw2_setup(hcb_p np, const struct sym_fw *fw)
1980 {
1981         struct sym_fw2a_scr *scripta0;
1982
1983         scripta0 = (struct sym_fw2a_scr *) np->scripta0;
1984
1985         /*
1986          *  Fill variable parts in scripts.
1987          */
1988         sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
1989
1990         /*
1991          *  Setup bus addresses used from the C code..
1992          */
1993         sym_fw_setup_bus_addresses(np, fw);
1994 }
1995
1996 /*
1997  *  Allocate firmware descriptors.
1998  */
1999 #ifdef  SYM_CONF_GENERIC_SUPPORT
2000 static const struct sym_fw sym_fw1 = SYM_FW_ENTRY(sym_fw1, "NCR-generic");
2001 #endif  /* SYM_CONF_GENERIC_SUPPORT */
2002 static const struct sym_fw sym_fw2 = SYM_FW_ENTRY(sym_fw2, "LOAD/STORE-based");
2003
2004 /*
2005  *  Find the most appropriate firmware for a chip.
2006  */
2007 static const struct sym_fw *
2008 sym_find_firmware(const struct sym_pci_chip *chip)
2009 {
2010         if (chip->features & FE_LDSTR)
2011                 return &sym_fw2;
2012 #ifdef  SYM_CONF_GENERIC_SUPPORT
2013         else if (!(chip->features & (FE_PFEN|FE_NOPM|FE_DAC)))
2014                 return &sym_fw1;
2015 #endif
2016         else
2017                 return NULL;
2018 }
2019
2020 /*
2021  *  Bind a script to physical addresses.
2022  */
2023 static void sym_fw_bind_script (hcb_p np, u32 *start, int len)
2024 {
2025         u32 opcode, new, old, tmp1, tmp2;
2026         u32 *end, *cur;
2027         int relocs;
2028
2029         cur = start;
2030         end = start + len/4;
2031
2032         while (cur < end) {
2033
2034                 opcode = *cur;
2035
2036                 /*
2037                  *  If we forget to change the length
2038                  *  in scripts, a field will be
2039                  *  padded with 0. This is an illegal
2040                  *  command.
2041                  */
2042                 if (opcode == 0) {
2043                         kprintf ("%s: ERROR0 IN SCRIPT at %d.\n",
2044                                 sym_name(np), (int) (cur-start));
2045                         MDELAY (10000);
2046                         ++cur;
2047                         continue;
2048                 };
2049
2050                 /*
2051                  *  We use the bogus value 0xf00ff00f ;-)
2052                  *  to reserve data area in SCRIPTS.
2053                  */
2054                 if (opcode == SCR_DATA_ZERO) {
2055                         *cur++ = 0;
2056                         continue;
2057                 }
2058
2059                 if (DEBUG_FLAGS & DEBUG_SCRIPT)
2060                         kprintf ("%d:  <%x>\n", (int) (cur-start),
2061                                 (unsigned)opcode);
2062
2063                 /*
2064                  *  We don't have to decode ALL commands
2065                  */
2066                 switch (opcode >> 28) {
2067                 case 0xf:
2068                         /*
2069                          *  LOAD / STORE DSA relative, don't relocate.
2070                          */
2071                         relocs = 0;
2072                         break;
2073                 case 0xe:
2074                         /*
2075                          *  LOAD / STORE absolute.
2076                          */
2077                         relocs = 1;
2078                         break;
2079                 case 0xc:
2080                         /*
2081                          *  COPY has TWO arguments.
2082                          */
2083                         relocs = 2;
2084                         tmp1 = cur[1];
2085                         tmp2 = cur[2];
2086                         if ((tmp1 ^ tmp2) & 3) {
2087                                 kprintf ("%s: ERROR1 IN SCRIPT at %d.\n",
2088                                         sym_name(np), (int) (cur-start));
2089                                 MDELAY (10000);
2090                         }
2091                         /*
2092                          *  If PREFETCH feature not enabled, remove
2093                          *  the NO FLUSH bit if present.
2094                          */
2095                         if ((opcode & SCR_NO_FLUSH) &&
2096                             !(np->features & FE_PFEN)) {
2097                                 opcode = (opcode & ~SCR_NO_FLUSH);
2098                         }
2099                         break;
2100                 case 0x0:
2101                         /*
2102                          *  MOVE/CHMOV (absolute address)
2103                          */
2104                         if (!(np->features & FE_WIDE))
2105                                 opcode = (opcode | OPC_MOVE);
2106                         relocs = 1;
2107                         break;
2108                 case 0x1:
2109                         /*
2110                          *  MOVE/CHMOV (table indirect)
2111                          */
2112                         if (!(np->features & FE_WIDE))
2113                                 opcode = (opcode | OPC_MOVE);
2114                         relocs = 0;
2115                         break;
2116                 case 0x8:
2117                         /*
2118                          *  JUMP / CALL
2119                          *  dont't relocate if relative :-)
2120                          */
2121                         if (opcode & 0x00800000)
2122                                 relocs = 0;
2123                         else if ((opcode & 0xf8400000) == 0x80400000)/*JUMP64*/
2124                                 relocs = 2;
2125                         else
2126                                 relocs = 1;
2127                         break;
2128                 case 0x4:
2129                 case 0x5:
2130                 case 0x6:
2131                 case 0x7:
2132                         relocs = 1;
2133                         break;
2134                 default:
2135                         relocs = 0;
2136                         break;
2137                 };
2138
2139                 /*
2140                  *  Scriptify:) the opcode.
2141                  */
2142                 *cur++ = cpu_to_scr(opcode);
2143
2144                 /*
2145                  *  If no relocation, assume 1 argument
2146                  *  and just scriptize:) it.
2147                  */
2148                 if (!relocs) {
2149                         *cur = cpu_to_scr(*cur);
2150                         ++cur;
2151                         continue;
2152                 }
2153
2154                 /*
2155                  *  Otherwise performs all needed relocations.
2156                  */
2157                 while (relocs--) {
2158                         old = *cur;
2159
2160                         switch (old & RELOC_MASK) {
2161                         case RELOC_REGISTER:
2162                                 new = (old & ~RELOC_MASK) + np->mmio_ba;
2163                                 break;
2164                         case RELOC_LABEL_A:
2165                                 new = (old & ~RELOC_MASK) + np->scripta_ba;
2166                                 break;
2167                         case RELOC_LABEL_B:
2168                                 new = (old & ~RELOC_MASK) + np->scriptb_ba;
2169                                 break;
2170                         case RELOC_SOFTC:
2171                                 new = (old & ~RELOC_MASK) + np->hcb_ba;
2172                                 break;
2173                         case 0:
2174                                 /*
2175                                  *  Don't relocate a 0 address.
2176                                  *  They are mostly used for patched or
2177                                  *  script self-modified areas.
2178                                  */
2179                                 if (old == 0) {
2180                                         new = old;
2181                                         break;
2182                                 }
2183                                 /* fall through */
2184                         default:
2185                                 new = 0;
2186                                 panic("sym_fw_bind_script: "
2187                                       "weird relocation %x\n", old);
2188                                 break;
2189                         }
2190
2191                         *cur++ = cpu_to_scr(new);
2192                 }
2193         };
2194 }
2195
2196 /*---------------------------------------------------------------------------*/
2197 /*--------------------------- END OF FIRMWARES  -----------------------------*/
2198 /*---------------------------------------------------------------------------*/
2199
2200 /*
2201  *  Function prototypes.
2202  */
2203 static void sym_save_initial_setting (hcb_p np);
2204 static int  sym_prepare_setting (hcb_p np, struct sym_nvram *nvram);
2205 static int  sym_prepare_nego (hcb_p np, ccb_p cp, int nego, u_char *msgptr);
2206 static void sym_put_start_queue (hcb_p np, ccb_p cp);
2207 static void sym_chip_reset (hcb_p np);
2208 static void sym_soft_reset (hcb_p np);
2209 static void sym_start_reset (hcb_p np);
2210 static int  sym_reset_scsi_bus (hcb_p np, int enab_int);
2211 static int  sym_wakeup_done (hcb_p np);
2212 static void sym_flush_busy_queue (hcb_p np, int cam_status);
2213 static void sym_flush_comp_queue (hcb_p np, int cam_status);
2214 static void sym_init (hcb_p np, int reason);
2215 static int  sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp,
2216                         u_char *fakp);
2217 static void sym_setsync (hcb_p np, ccb_p cp, u_char ofs, u_char per,
2218                          u_char div, u_char fak);
2219 static void sym_setwide (hcb_p np, ccb_p cp, u_char wide);
2220 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2221                          u_char per, u_char wide, u_char div, u_char fak);
2222 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2223                          u_char per, u_char wide, u_char div, u_char fak);
2224 static void sym_log_hard_error (hcb_p np, u_short sist, u_char dstat);
2225 static void sym_intr (void *arg);
2226 static void sym_poll (struct cam_sim *sim);
2227 static void sym_recover_scsi_int (hcb_p np, u_char hsts);
2228 static void sym_int_sto (hcb_p np);
2229 static void sym_int_udc (hcb_p np);
2230 static void sym_int_sbmc (hcb_p np);
2231 static void sym_int_par (hcb_p np, u_short sist);
2232 static void sym_int_ma (hcb_p np);
2233 static int  sym_dequeue_from_squeue(hcb_p np, int i, int target, int lun,
2234                                     int task);
2235 static void sym_sir_bad_scsi_status (hcb_p np, int num, ccb_p cp);
2236 static int  sym_clear_tasks (hcb_p np, int status, int targ, int lun, int task);
2237 static void sym_sir_task_recovery (hcb_p np, int num);
2238 static int  sym_evaluate_dp (hcb_p np, ccb_p cp, u32 scr, int *ofs);
2239 static void sym_modify_dp (hcb_p np, tcb_p tp, ccb_p cp, int ofs);
2240 static int  sym_compute_residual (hcb_p np, ccb_p cp);
2241 static int  sym_show_msg (u_char * msg);
2242 static void sym_print_msg (ccb_p cp, char *label, u_char *msg);
2243 static void sym_sync_nego (hcb_p np, tcb_p tp, ccb_p cp);
2244 static void sym_ppr_nego (hcb_p np, tcb_p tp, ccb_p cp);
2245 static void sym_wide_nego (hcb_p np, tcb_p tp, ccb_p cp);
2246 static void sym_nego_default (hcb_p np, tcb_p tp, ccb_p cp);
2247 static void sym_nego_rejected (hcb_p np, tcb_p tp, ccb_p cp);
2248 static void sym_int_sir (hcb_p np);
2249 static void sym_free_ccb (hcb_p np, ccb_p cp);
2250 static ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order);
2251 static ccb_p sym_alloc_ccb (hcb_p np);
2252 static ccb_p sym_ccb_from_dsa (hcb_p np, u32 dsa);
2253 static lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln);
2254 static void sym_alloc_lcb_tags (hcb_p np, u_char tn, u_char ln);
2255 static int  sym_snooptest (hcb_p np);
2256 static void sym_selectclock(hcb_p np, u_char scntl3);
2257 static void sym_getclock (hcb_p np, int mult);
2258 static int  sym_getpciclock (hcb_p np);
2259 static void sym_complete_ok (hcb_p np, ccb_p cp);
2260 static void sym_complete_error (hcb_p np, ccb_p cp);
2261 static void sym_callout (void *arg);
2262 static int  sym_abort_scsiio (hcb_p np, union ccb *ccb, int timed_out);
2263 static void sym_reset_dev (hcb_p np, union ccb *ccb);
2264 static void sym_action (struct cam_sim *sim, union ccb *ccb);
2265 static int  sym_setup_cdb (hcb_p np, struct ccb_scsiio *csio, ccb_p cp);
2266 static void sym_setup_data_and_start (hcb_p np, struct ccb_scsiio *csio,
2267                                       ccb_p cp);
2268 static int sym_fast_scatter_sg_physical(hcb_p np, ccb_p cp,
2269                                         bus_dma_segment_t *psegs, int nsegs);
2270 static int sym_scatter_sg_physical (hcb_p np, ccb_p cp,
2271                                     bus_dma_segment_t *psegs, int nsegs);
2272 static void sym_action2 (struct cam_sim *sim, union ccb *ccb);
2273 static void sym_update_trans (hcb_p np, tcb_p tp, struct sym_trans *tip,
2274                               struct ccb_trans_settings *cts);
2275 static void sym_update_dflags(hcb_p np, u_char *flags,
2276                               struct ccb_trans_settings *cts);
2277
2278 static const struct sym_pci_chip *sym_find_pci_chip (device_t dev);
2279 static int  sym_pci_probe (device_t dev);
2280 static int  sym_pci_attach (device_t dev);
2281
2282 static void sym_pci_free (hcb_p np);
2283 static int  sym_cam_attach (hcb_p np);
2284 static void sym_cam_free (hcb_p np);
2285
2286 static void sym_nvram_setup_host (hcb_p np, struct sym_nvram *nvram);
2287 static void sym_nvram_setup_target (hcb_p np, int targ, struct sym_nvram *nvp);
2288 static int sym_read_nvram (hcb_p np, struct sym_nvram *nvp);
2289
2290 /*
2291  *  Print something which allows to retrieve the controller type,
2292  *  unit, target, lun concerned by a kernel message.
2293  */
2294 static void PRINT_TARGET (hcb_p np, int target)
2295 {
2296         kprintf ("%s:%d:", sym_name(np), target);
2297 }
2298
2299 static void PRINT_LUN(hcb_p np, int target, int lun)
2300 {
2301         kprintf ("%s:%d:%d:", sym_name(np), target, lun);
2302 }
2303
2304 static void PRINT_ADDR (ccb_p cp)
2305 {
2306         if (cp && cp->cam_ccb)
2307                 xpt_print_path(cp->cam_ccb->ccb_h.path);
2308 }
2309
2310 /*
2311  *  Take into account this ccb in the freeze count.
2312  */
2313 static void sym_freeze_cam_ccb(union ccb *ccb)
2314 {
2315         if (!(ccb->ccb_h.flags & CAM_DEV_QFRZDIS)) {
2316                 if (!(ccb->ccb_h.status & CAM_DEV_QFRZN)) {
2317                         ccb->ccb_h.status |= CAM_DEV_QFRZN;
2318                         xpt_freeze_devq(ccb->ccb_h.path, 1);
2319                 }
2320         }
2321 }
2322
2323 /*
2324  *  Set the status field of a CAM CCB.
2325  */
2326 static __inline void sym_set_cam_status(union ccb *ccb, cam_status status)
2327 {
2328         ccb->ccb_h.status &= ~CAM_STATUS_MASK;
2329         ccb->ccb_h.status |= status;
2330 }
2331
2332 /*
2333  *  Get the status field of a CAM CCB.
2334  */
2335 static __inline int sym_get_cam_status(union ccb *ccb)
2336 {
2337         return ccb->ccb_h.status & CAM_STATUS_MASK;
2338 }
2339
2340 /*
2341  *  Enqueue a CAM CCB.
2342  */
2343 static void sym_enqueue_cam_ccb(ccb_p cp)
2344 {
2345         hcb_p np;
2346         union ccb *ccb;
2347
2348         ccb = cp->cam_ccb;
2349         np = (hcb_p) cp->arg;
2350
2351         assert(!(ccb->ccb_h.status & CAM_SIM_QUEUED));
2352         ccb->ccb_h.status = CAM_REQ_INPROG;
2353
2354         callout_reset(&cp->ch, ccb->ccb_h.timeout * hz / 1000, sym_callout,
2355                         (caddr_t) ccb);
2356         ccb->ccb_h.status |= CAM_SIM_QUEUED;
2357         ccb->ccb_h.sym_hcb_ptr = np;
2358
2359         sym_insque_tail(sym_qptr(&ccb->ccb_h.sim_links), &np->cam_ccbq);
2360 }
2361
2362 /*
2363  *  Complete a pending CAM CCB.
2364  */
2365 static void _sym_xpt_done(hcb_p np, union ccb *ccb)
2366 {
2367         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2368
2369         KASSERT((ccb->ccb_h.status & CAM_SIM_QUEUED) == 0,
2370                         ("%s: status=CAM_SIM_QUEUED", __func__));
2371
2372         if (ccb->ccb_h.flags & CAM_DEV_QFREEZE)
2373                 sym_freeze_cam_ccb(ccb);
2374         xpt_done(ccb);
2375 }
2376
2377 static void sym_xpt_done(hcb_p np, union ccb *ccb, ccb_p cp)
2378 {
2379         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2380
2381         if (ccb->ccb_h.status & CAM_SIM_QUEUED) {
2382                 callout_stop(&cp->ch);
2383                 sym_remque(sym_qptr(&ccb->ccb_h.sim_links));
2384                 ccb->ccb_h.status &= ~CAM_SIM_QUEUED;
2385                 ccb->ccb_h.sym_hcb_ptr = NULL;
2386         }
2387         _sym_xpt_done(np, ccb);
2388 }
2389
2390 static void sym_xpt_done2(hcb_p np, union ccb *ccb, int cam_status)
2391 {
2392         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2393
2394         sym_set_cam_status(ccb, cam_status);
2395         _sym_xpt_done(np, ccb);
2396 }
2397
2398 /*
2399  *  SYMBIOS chip clock divisor table.
2400  *
2401  *  Divisors are multiplied by 10,000,000 in order to make
2402  *  calculations more simple.
2403  */
2404 #define _5M 5000000
2405 static const u32 div_10M[] =
2406         {2*_5M, 3*_5M, 4*_5M, 6*_5M, 8*_5M, 12*_5M, 16*_5M};
2407
2408 /*
2409  *  SYMBIOS chips allow burst lengths of 2, 4, 8, 16, 32, 64,
2410  *  128 transfers. All chips support at least 16 transfers
2411  *  bursts. The 825A, 875 and 895 chips support bursts of up
2412  *  to 128 transfers and the 895A and 896 support bursts of up
2413  *  to 64 transfers. All other chips support up to 16
2414  *  transfers bursts.
2415  *
2416  *  For PCI 32 bit data transfers each transfer is a DWORD.
2417  *  It is a QUADWORD (8 bytes) for PCI 64 bit data transfers.
2418  *
2419  *  We use log base 2 (burst length) as internal code, with
2420  *  value 0 meaning "burst disabled".
2421  */
2422
2423 /*
2424  *  Burst length from burst code.
2425  */
2426 #define burst_length(bc) (!(bc))? 0 : 1 << (bc)
2427
2428 /*
2429  *  Burst code from io register bits.
2430  */
2431 #define burst_code(dmode, ctest4, ctest5) \
2432         (ctest4) & 0x80? 0 : (((dmode) & 0xc0) >> 6) + ((ctest5) & 0x04) + 1
2433
2434 /*
2435  *  Set initial io register bits from burst code.
2436  */
2437 static __inline void sym_init_burst(hcb_p np, u_char bc)
2438 {
2439         np->rv_ctest4   &= ~0x80;
2440         np->rv_dmode    &= ~(0x3 << 6);
2441         np->rv_ctest5   &= ~0x4;
2442
2443         if (!bc) {
2444                 np->rv_ctest4   |= 0x80;
2445         }
2446         else {
2447                 --bc;
2448                 np->rv_dmode    |= ((bc & 0x3) << 6);
2449                 np->rv_ctest5   |= (bc & 0x4);
2450         }
2451 }
2452
2453
2454 /*
2455  * Print out the list of targets that have some flag disabled by user.
2456  */
2457 static void sym_print_targets_flag(hcb_p np, int mask, char *msg)
2458 {
2459         int cnt;
2460         int i;
2461
2462         for (cnt = 0, i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2463                 if (i == np->myaddr)
2464                         continue;
2465                 if (np->target[i].usrflags & mask) {
2466                         if (!cnt++)
2467                                 kprintf("%s: %s disabled for targets",
2468                                         sym_name(np), msg);
2469                         kprintf(" %d", i);
2470                 }
2471         }
2472         if (cnt)
2473                 kprintf(".\n");
2474 }
2475
2476 /*
2477  *  Save initial settings of some IO registers.
2478  *  Assumed to have been set by BIOS.
2479  *  We cannot reset the chip prior to reading the
2480  *  IO registers, since informations will be lost.
2481  *  Since the SCRIPTS processor may be running, this
2482  *  is not safe on paper, but it seems to work quite
2483  *  well. :)
2484  */
2485 static void sym_save_initial_setting (hcb_p np)
2486 {
2487         np->sv_scntl0   = INB(nc_scntl0) & 0x0a;
2488         np->sv_scntl3   = INB(nc_scntl3) & 0x07;
2489         np->sv_dmode    = INB(nc_dmode)  & 0xce;
2490         np->sv_dcntl    = INB(nc_dcntl)  & 0xa8;
2491         np->sv_ctest3   = INB(nc_ctest3) & 0x01;
2492         np->sv_ctest4   = INB(nc_ctest4) & 0x80;
2493         np->sv_gpcntl   = INB(nc_gpcntl);
2494         np->sv_stest1   = INB(nc_stest1);
2495         np->sv_stest2   = INB(nc_stest2) & 0x20;
2496         np->sv_stest4   = INB(nc_stest4);
2497         if (np->features & FE_C10) {    /* Always large DMA fifo + ultra3 */
2498                 np->sv_scntl4   = INB(nc_scntl4);
2499                 np->sv_ctest5   = INB(nc_ctest5) & 0x04;
2500         }
2501         else
2502                 np->sv_ctest5   = INB(nc_ctest5) & 0x24;
2503 }
2504
2505 /*
2506  *  Prepare io register values used by sym_init() according
2507  *  to selected and supported features.
2508  */
2509 static int sym_prepare_setting(hcb_p np, struct sym_nvram *nvram)
2510 {
2511         u_char  burst_max;
2512         u32     period;
2513         int i;
2514
2515         /*
2516          *  Wide ?
2517          */
2518         np->maxwide     = (np->features & FE_WIDE)? 1 : 0;
2519
2520         /*
2521          *  Get the frequency of the chip's clock.
2522          */
2523         if      (np->features & FE_QUAD)
2524                 np->multiplier  = 4;
2525         else if (np->features & FE_DBLR)
2526                 np->multiplier  = 2;
2527         else
2528                 np->multiplier  = 1;
2529
2530         np->clock_khz   = (np->features & FE_CLK80)? 80000 : 40000;
2531         np->clock_khz   *= np->multiplier;
2532
2533         if (np->clock_khz != 40000)
2534                 sym_getclock(np, np->multiplier);
2535
2536         /*
2537          * Divisor to be used for async (timer pre-scaler).
2538          */
2539         i = np->clock_divn - 1;
2540         while (--i >= 0) {
2541                 if (10ul * SYM_CONF_MIN_ASYNC * np->clock_khz > div_10M[i]) {
2542                         ++i;
2543                         break;
2544                 }
2545         }
2546         np->rv_scntl3 = i+1;
2547
2548         /*
2549          * The C1010 uses hardwired divisors for async.
2550          * So, we just throw away, the async. divisor.:-)
2551          */
2552         if (np->features & FE_C10)
2553                 np->rv_scntl3 = 0;
2554
2555         /*
2556          * Minimum synchronous period factor supported by the chip.
2557          * Btw, 'period' is in tenths of nanoseconds.
2558          */
2559         period = (4 * div_10M[0] + np->clock_khz - 1) / np->clock_khz;
2560         if      (period <= 250)         np->minsync = 10;
2561         else if (period <= 303)         np->minsync = 11;
2562         else if (period <= 500)         np->minsync = 12;
2563         else                            np->minsync = (period + 40 - 1) / 40;
2564
2565         /*
2566          * Check against chip SCSI standard support (SCSI-2,ULTRA,ULTRA2).
2567          */
2568         if      (np->minsync < 25 &&
2569                  !(np->features & (FE_ULTRA|FE_ULTRA2|FE_ULTRA3)))
2570                 np->minsync = 25;
2571         else if (np->minsync < 12 &&
2572                  !(np->features & (FE_ULTRA2|FE_ULTRA3)))
2573                 np->minsync = 12;
2574
2575         /*
2576          * Maximum synchronous period factor supported by the chip.
2577          */
2578         period = (11 * div_10M[np->clock_divn - 1]) / (4 * np->clock_khz);
2579         np->maxsync = period > 2540 ? 254 : period / 10;
2580
2581         /*
2582          * If chip is a C1010, guess the sync limits in DT mode.
2583          */
2584         if ((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3)) {
2585                 if (np->clock_khz == 160000) {
2586                         np->minsync_dt = 9;
2587                         np->maxsync_dt = 50;
2588                         np->maxoffs_dt = 62;
2589                 }
2590         }
2591
2592         /*
2593          *  64 bit addressing  (895A/896/1010) ?
2594          */
2595         if (np->features & FE_DAC)
2596 #ifdef __LP64__
2597                 np->rv_ccntl1   |= (XTIMOD | EXTIBMV);
2598 #else
2599                 np->rv_ccntl1   |= (DDAC);
2600 #endif
2601
2602         /*
2603          *  Phase mismatch handled by SCRIPTS (895A/896/1010) ?
2604          */
2605         if (np->features & FE_NOPM)
2606                 np->rv_ccntl0   |= (ENPMJ);
2607
2608         /*
2609          *  C1010 Errata.
2610          *  In dual channel mode, contention occurs if internal cycles
2611          *  are used. Disable internal cycles.
2612          */
2613         if (np->device_id == PCI_ID_LSI53C1010 &&
2614             np->revision_id < 0x2)
2615                 np->rv_ccntl0   |=  DILS;
2616
2617         /*
2618          *  Select burst length (dwords)
2619          */
2620         burst_max       = SYM_SETUP_BURST_ORDER;
2621         if (burst_max == 255)
2622                 burst_max = burst_code(np->sv_dmode, np->sv_ctest4,
2623                                        np->sv_ctest5);
2624         if (burst_max > 7)
2625                 burst_max = 7;
2626         if (burst_max > np->maxburst)
2627                 burst_max = np->maxburst;
2628
2629         /*
2630          *  DEL 352 - 53C810 Rev x11 - Part Number 609-0392140 - ITEM 2.
2631          *  This chip and the 860 Rev 1 may wrongly use PCI cache line
2632          *  based transactions on LOAD/STORE instructions. So we have
2633          *  to prevent these chips from using such PCI transactions in
2634          *  this driver. The generic ncr driver that does not use
2635          *  LOAD/STORE instructions does not need this work-around.
2636          */
2637         if ((np->device_id == PCI_ID_SYM53C810 &&
2638              np->revision_id >= 0x10 && np->revision_id <= 0x11) ||
2639             (np->device_id == PCI_ID_SYM53C860 &&
2640              np->revision_id <= 0x1))
2641                 np->features &= ~(FE_WRIE|FE_ERL|FE_ERMP);
2642
2643         /*
2644          *  Select all supported special features.
2645          *  If we are using on-board RAM for scripts, prefetch (PFEN)
2646          *  does not help, but burst op fetch (BOF) does.
2647          *  Disabling PFEN makes sure BOF will be used.
2648          */
2649         if (np->features & FE_ERL)
2650                 np->rv_dmode    |= ERL;         /* Enable Read Line */
2651         if (np->features & FE_BOF)
2652                 np->rv_dmode    |= BOF;         /* Burst Opcode Fetch */
2653         if (np->features & FE_ERMP)
2654                 np->rv_dmode    |= ERMP;        /* Enable Read Multiple */
2655 #if 1
2656         if ((np->features & FE_PFEN) && !np->ram_ba)
2657 #else
2658         if (np->features & FE_PFEN)
2659 #endif
2660                 np->rv_dcntl    |= PFEN;        /* Prefetch Enable */
2661         if (np->features & FE_CLSE)
2662                 np->rv_dcntl    |= CLSE;        /* Cache Line Size Enable */
2663         if (np->features & FE_WRIE)
2664                 np->rv_ctest3   |= WRIE;        /* Write and Invalidate */
2665         if (np->features & FE_DFS)
2666                 np->rv_ctest5   |= DFS;         /* Dma Fifo Size */
2667
2668         /*
2669          *  Select some other
2670          */
2671         if (SYM_SETUP_PCI_PARITY)
2672                 np->rv_ctest4   |= MPEE; /* Master parity checking */
2673         if (SYM_SETUP_SCSI_PARITY)
2674                 np->rv_scntl0   |= 0x0a; /*  full arb., ena parity, par->ATN  */
2675
2676         /*
2677          *  Get parity checking, host ID and verbose mode from NVRAM
2678          */
2679         np->myaddr = 255;
2680         sym_nvram_setup_host (np, nvram);
2681 #ifdef __sparc64__
2682         np->myaddr = OF_getscsinitid(np->device);
2683 #endif
2684
2685         /*
2686          *  Get SCSI addr of host adapter (set by bios?).
2687          */
2688         if (np->myaddr == 255) {
2689                 np->myaddr = INB(nc_scid) & 0x07;
2690                 if (!np->myaddr)
2691                         np->myaddr = SYM_SETUP_HOST_ID;
2692         }
2693
2694         /*
2695          *  Prepare initial io register bits for burst length
2696          */
2697         sym_init_burst(np, burst_max);
2698
2699         /*
2700          *  Set SCSI BUS mode.
2701          *  - LVD capable chips (895/895A/896/1010) report the
2702          *    current BUS mode through the STEST4 IO register.
2703          *  - For previous generation chips (825/825A/875),
2704          *    user has to tell us how to check against HVD,
2705          *    since a 100% safe algorithm is not possible.
2706          */
2707         np->scsi_mode = SMODE_SE;
2708         if (np->features & (FE_ULTRA2|FE_ULTRA3))
2709                 np->scsi_mode = (np->sv_stest4 & SMODE);
2710         else if (np->features & FE_DIFF) {
2711                 if (SYM_SETUP_SCSI_DIFF == 1) {
2712                         if (np->sv_scntl3) {
2713                                 if (np->sv_stest2 & 0x20)
2714                                         np->scsi_mode = SMODE_HVD;
2715                         }
2716                         else if (nvram->type == SYM_SYMBIOS_NVRAM) {
2717                                 if (!(INB(nc_gpreg) & 0x08))
2718                                         np->scsi_mode = SMODE_HVD;
2719                         }
2720                 }
2721                 else if (SYM_SETUP_SCSI_DIFF == 2)
2722                         np->scsi_mode = SMODE_HVD;
2723         }
2724         if (np->scsi_mode == SMODE_HVD)
2725                 np->rv_stest2 |= 0x20;
2726
2727         /*
2728          *  Set LED support from SCRIPTS.
2729          *  Ignore this feature for boards known to use a
2730          *  specific GPIO wiring and for the 895A, 896
2731          *  and 1010 that drive the LED directly.
2732          */
2733         if ((SYM_SETUP_SCSI_LED ||
2734              (nvram->type == SYM_SYMBIOS_NVRAM ||
2735               (nvram->type == SYM_TEKRAM_NVRAM &&
2736                np->device_id == PCI_ID_SYM53C895))) &&
2737             !(np->features & FE_LEDC) && !(np->sv_gpcntl & 0x01))
2738                 np->features |= FE_LED0;
2739
2740         /*
2741          *  Set irq mode.
2742          */
2743         switch(SYM_SETUP_IRQ_MODE & 3) {
2744         case 2:
2745                 np->rv_dcntl    |= IRQM;
2746                 break;
2747         case 1:
2748                 np->rv_dcntl    |= (np->sv_dcntl & IRQM);
2749                 break;
2750         default:
2751                 break;
2752         }
2753
2754         /*
2755          *  Configure targets according to driver setup.
2756          *  If NVRAM present get targets setup from NVRAM.
2757          */
2758         for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2759                 tcb_p tp = &np->target[i];
2760
2761                 tp->tinfo.user.scsi_version = tp->tinfo.current.scsi_version= 2;
2762                 tp->tinfo.user.spi_version  = tp->tinfo.current.spi_version = 2;
2763                 tp->tinfo.user.period = np->minsync;
2764                 if (np->features & FE_ULTRA3)
2765                         tp->tinfo.user.period = np->minsync_dt;
2766                 tp->tinfo.user.offset = np->maxoffs;
2767                 tp->tinfo.user.width  = np->maxwide ? BUS_16_BIT : BUS_8_BIT;
2768                 tp->usrflags |= (SYM_DISC_ENABLED | SYM_TAGS_ENABLED);
2769                 tp->usrtags = SYM_SETUP_MAX_TAG;
2770
2771                 sym_nvram_setup_target (np, i, nvram);
2772
2773                 /*
2774                  *  For now, guess PPR/DT support from the period
2775                  *  and BUS width.
2776                  */
2777                 if (np->features & FE_ULTRA3) {
2778                         if (tp->tinfo.user.period <= 9  &&
2779                             tp->tinfo.user.width == BUS_16_BIT) {
2780                                 tp->tinfo.user.options |= PPR_OPT_DT;
2781                                 tp->tinfo.user.offset   = np->maxoffs_dt;
2782                                 tp->tinfo.user.spi_version = 3;
2783                         }
2784                 }
2785
2786                 if (!tp->usrtags)
2787                         tp->usrflags &= ~SYM_TAGS_ENABLED;
2788         }
2789
2790         /*
2791          *  Let user know about the settings.
2792          */
2793         i = nvram->type;
2794         kprintf("%s: %s NVRAM, ID %d, Fast-%d, %s, %s\n", sym_name(np),
2795                 i  == SYM_SYMBIOS_NVRAM ? "Symbios" :
2796                 (i == SYM_TEKRAM_NVRAM  ? "Tekram" : "No"),
2797                 np->myaddr,
2798                 (np->features & FE_ULTRA3) ? 80 :
2799                 (np->features & FE_ULTRA2) ? 40 :
2800                 (np->features & FE_ULTRA)  ? 20 : 10,
2801                 sym_scsi_bus_mode(np->scsi_mode),
2802                 (np->rv_scntl0 & 0xa)   ? "parity checking" : "NO parity");
2803         /*
2804          *  Tell him more on demand.
2805          */
2806         if (sym_verbose) {
2807                 kprintf("%s: %s IRQ line driver%s\n",
2808                         sym_name(np),
2809                         np->rv_dcntl & IRQM ? "totem pole" : "open drain",
2810                         np->ram_ba ? ", using on-chip SRAM" : "");
2811                 kprintf("%s: using %s firmware.\n", sym_name(np), np->fw_name);
2812                 if (np->features & FE_NOPM)
2813                         kprintf("%s: handling phase mismatch from SCRIPTS.\n",
2814                                sym_name(np));
2815         }
2816         /*
2817          *  And still more.
2818          */
2819         if (sym_verbose > 1) {
2820                 kprintf ("%s: initial SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
2821                         "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
2822                         sym_name(np), np->sv_scntl3, np->sv_dmode, np->sv_dcntl,
2823                         np->sv_ctest3, np->sv_ctest4, np->sv_ctest5);
2824
2825                 kprintf ("%s: final   SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
2826                         "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
2827                         sym_name(np), np->rv_scntl3, np->rv_dmode, np->rv_dcntl,
2828                         np->rv_ctest3, np->rv_ctest4, np->rv_ctest5);
2829         }
2830         /*
2831          *  Let user be aware of targets that have some disable flags set.
2832          */
2833         sym_print_targets_flag(np, SYM_SCAN_BOOT_DISABLED, "SCAN AT BOOT");
2834         if (sym_verbose)
2835                 sym_print_targets_flag(np, SYM_SCAN_LUNS_DISABLED,
2836                                        "SCAN FOR LUNS");
2837
2838         return 0;
2839 }
2840
2841 /*
2842  *  Prepare the next negotiation message if needed.
2843  *
2844  *  Fill in the part of message buffer that contains the
2845  *  negotiation and the nego_status field of the CCB.
2846  *  Returns the size of the message in bytes.
2847  */
2848
2849 static int sym_prepare_nego(hcb_p np, ccb_p cp, int nego, u_char *msgptr)
2850 {
2851         tcb_p tp = &np->target[cp->target];
2852         int msglen = 0;
2853
2854         /*
2855          *  Early C1010 chips need a work-around for DT
2856          *  data transfer to work.
2857          */
2858         if (!(np->features & FE_U3EN))
2859                 tp->tinfo.goal.options = 0;
2860         /*
2861          *  negotiate using PPR ?
2862          */
2863         if (tp->tinfo.goal.options & PPR_OPT_MASK)
2864                 nego = NS_PPR;
2865         /*
2866          *  negotiate wide transfers ?
2867          */
2868         else if (tp->tinfo.current.width != tp->tinfo.goal.width)
2869                 nego = NS_WIDE;
2870         /*
2871          *  negotiate synchronous transfers?
2872          */
2873         else if (tp->tinfo.current.period != tp->tinfo.goal.period ||
2874                  tp->tinfo.current.offset != tp->tinfo.goal.offset)
2875                 nego = NS_SYNC;
2876
2877         switch (nego) {
2878         case NS_SYNC:
2879                 msgptr[msglen++] = M_EXTENDED;
2880                 msgptr[msglen++] = 3;
2881                 msgptr[msglen++] = M_X_SYNC_REQ;
2882                 msgptr[msglen++] = tp->tinfo.goal.period;
2883                 msgptr[msglen++] = tp->tinfo.goal.offset;
2884                 break;
2885         case NS_WIDE:
2886                 msgptr[msglen++] = M_EXTENDED;
2887                 msgptr[msglen++] = 2;
2888                 msgptr[msglen++] = M_X_WIDE_REQ;
2889                 msgptr[msglen++] = tp->tinfo.goal.width;
2890                 break;
2891         case NS_PPR:
2892                 msgptr[msglen++] = M_EXTENDED;
2893                 msgptr[msglen++] = 6;
2894                 msgptr[msglen++] = M_X_PPR_REQ;
2895                 msgptr[msglen++] = tp->tinfo.goal.period;
2896                 msgptr[msglen++] = 0;
2897                 msgptr[msglen++] = tp->tinfo.goal.offset;
2898                 msgptr[msglen++] = tp->tinfo.goal.width;
2899                 msgptr[msglen++] = tp->tinfo.goal.options & PPR_OPT_DT;
2900                 break;
2901         };
2902
2903         cp->nego_status = nego;
2904
2905         if (nego) {
2906                 tp->nego_cp = cp; /* Keep track a nego will be performed */
2907                 if (DEBUG_FLAGS & DEBUG_NEGO) {
2908                         sym_print_msg(cp, nego == NS_SYNC ? "sync msgout" :
2909                                           nego == NS_WIDE ? "wide msgout" :
2910                                           "ppr msgout", msgptr);
2911                 };
2912         };
2913
2914         return msglen;
2915 }
2916
2917 /*
2918  *  Insert a job into the start queue.
2919  */
2920 static void sym_put_start_queue(hcb_p np, ccb_p cp)
2921 {
2922         u_short qidx;
2923
2924 #ifdef SYM_CONF_IARB_SUPPORT
2925         /*
2926          *  If the previously queued CCB is not yet done,
2927          *  set the IARB hint. The SCRIPTS will go with IARB
2928          *  for this job when starting the previous one.
2929          *  We leave devices a chance to win arbitration by
2930          *  not using more than 'iarb_max' consecutive
2931          *  immediate arbitrations.
2932          */
2933         if (np->last_cp && np->iarb_count < np->iarb_max) {
2934                 np->last_cp->host_flags |= HF_HINT_IARB;
2935                 ++np->iarb_count;
2936         }
2937         else
2938                 np->iarb_count = 0;
2939         np->last_cp = cp;
2940 #endif
2941
2942         /*
2943          *  Insert first the idle task and then our job.
2944          *  The MB should ensure proper ordering.
2945          */
2946         qidx = np->squeueput + 2;
2947         if (qidx >= MAX_QUEUE*2) qidx = 0;
2948
2949         np->squeue [qidx]          = cpu_to_scr(np->idletask_ba);
2950         MEMORY_BARRIER();
2951         np->squeue [np->squeueput] = cpu_to_scr(cp->ccb_ba);
2952
2953         np->squeueput = qidx;
2954
2955         if (DEBUG_FLAGS & DEBUG_QUEUE)
2956                 kprintf ("%s: queuepos=%d.\n", sym_name (np), np->squeueput);
2957
2958         /*
2959          *  Script processor may be waiting for reselect.
2960          *  Wake it up.
2961          */
2962         MEMORY_BARRIER();
2963         OUTB (nc_istat, SIGP|np->istat_sem);
2964 }
2965
2966
2967 /*
2968  *  Soft reset the chip.
2969  *
2970  *  Raising SRST when the chip is running may cause
2971  *  problems on dual function chips (see below).
2972  *  On the other hand, LVD devices need some delay
2973  *  to settle and report actual BUS mode in STEST4.
2974  */
2975 static void sym_chip_reset (hcb_p np)
2976 {
2977         OUTB (nc_istat, SRST);
2978         UDELAY (10);
2979         OUTB (nc_istat, 0);
2980         UDELAY(2000);   /* For BUS MODE to settle */
2981 }
2982
2983 /*
2984  *  Soft reset the chip.
2985  *
2986  *  Some 896 and 876 chip revisions may hang-up if we set
2987  *  the SRST (soft reset) bit at the wrong time when SCRIPTS
2988  *  are running.
2989  *  So, we need to abort the current operation prior to
2990  *  soft resetting the chip.
2991  */
2992 static void sym_soft_reset (hcb_p np)
2993 {
2994         u_char istat;
2995         int i;
2996
2997         OUTB (nc_istat, CABRT);
2998         for (i = 1000000 ; i ; --i) {
2999                 istat = INB (nc_istat);
3000                 if (istat & SIP) {
3001                         INW (nc_sist);
3002                         continue;
3003                 }
3004                 if (istat & DIP) {
3005                         OUTB (nc_istat, 0);
3006                         INB (nc_dstat);
3007                         break;
3008                 }
3009         }
3010         if (!i)
3011                 kprintf("%s: unable to abort current chip operation.\n",
3012                         sym_name(np));
3013         sym_chip_reset (np);
3014 }
3015
3016 /*
3017  *  Start reset process.
3018  *
3019  *  The interrupt handler will reinitialize the chip.
3020  */
3021 static void sym_start_reset(hcb_p np)
3022 {
3023         (void) sym_reset_scsi_bus(np, 1);
3024 }
3025
3026 static int sym_reset_scsi_bus(hcb_p np, int enab_int)
3027 {
3028         u32 term;
3029         int retv = 0;
3030
3031         sym_soft_reset(np);     /* Soft reset the chip */
3032         if (enab_int)
3033                 OUTW (nc_sien, RST);
3034         /*
3035          *  Enable Tolerant, reset IRQD if present and
3036          *  properly set IRQ mode, prior to resetting the bus.
3037          */
3038         OUTB (nc_stest3, TE);
3039         OUTB (nc_dcntl, (np->rv_dcntl & IRQM));
3040         OUTB (nc_scntl1, CRST);
3041         UDELAY (200);
3042
3043         if (!SYM_SETUP_SCSI_BUS_CHECK)
3044                 goto out;
3045         /*
3046          *  Check for no terminators or SCSI bus shorts to ground.
3047          *  Read SCSI data bus, data parity bits and control signals.
3048          *  We are expecting RESET to be TRUE and other signals to be
3049          *  FALSE.
3050          */
3051         term =  INB(nc_sstat0);
3052         term =  ((term & 2) << 7) + ((term & 1) << 17); /* rst sdp0 */
3053         term |= ((INB(nc_sstat2) & 0x01) << 26) |       /* sdp1     */
3054                 ((INW(nc_sbdl) & 0xff)   << 9)  |       /* d7-0     */
3055                 ((INW(nc_sbdl) & 0xff00) << 10) |       /* d15-8    */
3056                 INB(nc_sbcl);   /* req ack bsy sel atn msg cd io    */
3057
3058         if (!(np->features & FE_WIDE))
3059                 term &= 0x3ffff;
3060
3061         if (term != (2<<7)) {
3062                 kprintf("%s: suspicious SCSI data while resetting the BUS.\n",
3063                         sym_name(np));
3064                 kprintf("%s: %sdp0,d7-0,rst,req,ack,bsy,sel,atn,msg,c/d,i/o = "
3065                         "0x%lx, expecting 0x%lx\n",
3066                         sym_name(np),
3067                         (np->features & FE_WIDE) ? "dp1,d15-8," : "",
3068                         (u_long)term, (u_long)(2<<7));
3069                 if (SYM_SETUP_SCSI_BUS_CHECK == 1)
3070                         retv = 1;
3071         }
3072 out:
3073         OUTB (nc_scntl1, 0);
3074         /* MDELAY(100); */
3075         return retv;
3076 }
3077
3078 /*
3079  *  The chip may have completed jobs. Look at the DONE QUEUE.
3080  *
3081  *  On architectures that may reorder LOAD/STORE operations,
3082  *  a memory barrier may be needed after the reading of the
3083  *  so-called `flag' and prior to dealing with the data.
3084  */
3085 static int sym_wakeup_done (hcb_p np)
3086 {
3087         ccb_p cp;
3088         int i, n;
3089         u32 dsa;
3090
3091         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3092
3093         n = 0;
3094         i = np->dqueueget;
3095         while (1) {
3096                 dsa = scr_to_cpu(np->dqueue[i]);
3097                 if (!dsa)
3098                         break;
3099                 np->dqueue[i] = 0;
3100                 if ((i = i+2) >= MAX_QUEUE*2)
3101                         i = 0;
3102
3103                 cp = sym_ccb_from_dsa(np, dsa);
3104                 if (cp) {
3105                         MEMORY_BARRIER();
3106                         sym_complete_ok (np, cp);
3107                         ++n;
3108                 }
3109                 else
3110                         kprintf ("%s: bad DSA (%x) in done queue.\n",
3111                                 sym_name(np), (u_int) dsa);
3112         }
3113         np->dqueueget = i;
3114
3115         return n;
3116 }
3117
3118 /*
3119  *  Complete all active CCBs with error.
3120  *  Used on CHIP/SCSI RESET.
3121  */
3122 static void sym_flush_busy_queue (hcb_p np, int cam_status)
3123 {
3124         /*
3125          *  Move all active CCBs to the COMP queue
3126          *  and flush this queue.
3127          */
3128         sym_que_splice(&np->busy_ccbq, &np->comp_ccbq);
3129         sym_que_init(&np->busy_ccbq);
3130         sym_flush_comp_queue(np, cam_status);
3131 }
3132
3133 /*
3134  *  Start chip.
3135  *
3136  *  'reason' means:
3137  *     0: initialisation.
3138  *     1: SCSI BUS RESET delivered or received.
3139  *     2: SCSI BUS MODE changed.
3140  */
3141 static void sym_init (hcb_p np, int reason)
3142 {
3143         int     i;
3144         u32     phys;
3145
3146         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3147
3148         /*
3149          *  Reset chip if asked, otherwise just clear fifos.
3150          */
3151         if (reason == 1)
3152                 sym_soft_reset(np);
3153         else {
3154                 OUTB (nc_stest3, TE|CSF);
3155                 OUTONB (nc_ctest3, CLF);
3156         }
3157
3158         /*
3159          *  Clear Start Queue
3160          */
3161         phys = np->squeue_ba;
3162         for (i = 0; i < MAX_QUEUE*2; i += 2) {
3163                 np->squeue[i]   = cpu_to_scr(np->idletask_ba);
3164                 np->squeue[i+1] = cpu_to_scr(phys + (i+2)*4);
3165         }
3166         np->squeue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3167
3168         /*
3169          *  Start at first entry.
3170          */
3171         np->squeueput = 0;
3172
3173         /*
3174          *  Clear Done Queue
3175          */
3176         phys = np->dqueue_ba;
3177         for (i = 0; i < MAX_QUEUE*2; i += 2) {
3178                 np->dqueue[i]   = 0;
3179                 np->dqueue[i+1] = cpu_to_scr(phys + (i+2)*4);
3180         }
3181         np->dqueue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3182
3183         /*
3184          *  Start at first entry.
3185          */
3186         np->dqueueget = 0;
3187
3188         /*
3189          *  Install patches in scripts.
3190          *  This also let point to first position the start
3191          *  and done queue pointers used from SCRIPTS.
3192          */
3193         np->fw_patch(np);
3194
3195         /*
3196          *  Wakeup all pending jobs.
3197          */
3198         sym_flush_busy_queue(np, CAM_SCSI_BUS_RESET);
3199
3200         /*
3201          *  Init chip.
3202          */
3203         OUTB (nc_istat,  0x00   );      /*  Remove Reset, abort */
3204         UDELAY (2000);  /* The 895 needs time for the bus mode to settle */
3205
3206         OUTB (nc_scntl0, np->rv_scntl0 | 0xc0);
3207                                         /*  full arb., ena parity, par->ATN  */
3208         OUTB (nc_scntl1, 0x00);         /*  odd parity, and remove CRST!! */
3209
3210         sym_selectclock(np, np->rv_scntl3);     /* Select SCSI clock */
3211
3212         OUTB (nc_scid  , RRE|np->myaddr);       /* Adapter SCSI address */
3213         OUTW (nc_respid, 1ul<<np->myaddr);      /* Id to respond to */
3214         OUTB (nc_istat , SIGP   );              /*  Signal Process */
3215         OUTB (nc_dmode , np->rv_dmode);         /* Burst length, dma mode */
3216         OUTB (nc_ctest5, np->rv_ctest5);        /* Large fifo + large burst */
3217
3218         OUTB (nc_dcntl , NOCOM|np->rv_dcntl);   /* Protect SFBR */
3219         OUTB (nc_ctest3, np->rv_ctest3);        /* Write and invalidate */
3220         OUTB (nc_ctest4, np->rv_ctest4);        /* Master parity checking */
3221
3222         /* Extended Sreq/Sack filtering not supported on the C10 */
3223         if (np->features & FE_C10)
3224                 OUTB (nc_stest2, np->rv_stest2);
3225         else
3226                 OUTB (nc_stest2, EXT|np->rv_stest2);
3227
3228         OUTB (nc_stest3, TE);                   /* TolerANT enable */
3229         OUTB (nc_stime0, 0x0c);                 /* HTH disabled  STO 0.25 sec */
3230
3231         /*
3232          *  For now, disable AIP generation on C1010-66.
3233          */
3234         if (np->device_id == PCI_ID_LSI53C1010_2)
3235                 OUTB (nc_aipcntl1, DISAIP);
3236
3237         /*
3238          *  C10101 Errata.
3239          *  Errant SGE's when in narrow. Write bits 4 & 5 of
3240          *  STEST1 register to disable SGE. We probably should do
3241          *  that from SCRIPTS for each selection/reselection, but
3242          *  I just don't want. :)
3243          */
3244         if (np->device_id == PCI_ID_LSI53C1010 &&
3245             /* np->revision_id < 0xff */ 1)
3246                 OUTB (nc_stest1, INB(nc_stest1) | 0x30);
3247
3248         /*
3249          *  DEL 441 - 53C876 Rev 5 - Part Number 609-0392787/2788 - ITEM 2.
3250          *  Disable overlapped arbitration for some dual function devices,
3251          *  regardless revision id (kind of post-chip-design feature. ;-))
3252          */
3253         if (np->device_id == PCI_ID_SYM53C875)
3254                 OUTB (nc_ctest0, (1<<5));
3255         else if (np->device_id == PCI_ID_SYM53C896)
3256                 np->rv_ccntl0 |= DPR;
3257
3258         /*
3259          *  Write CCNTL0/CCNTL1 for chips capable of 64 bit addressing
3260          *  and/or hardware phase mismatch, since only such chips
3261          *  seem to support those IO registers.
3262          */
3263         if (np->features & (FE_DAC|FE_NOPM)) {
3264                 OUTB (nc_ccntl0, np->rv_ccntl0);
3265                 OUTB (nc_ccntl1, np->rv_ccntl1);
3266         }
3267
3268         /*
3269          *  If phase mismatch handled by scripts (895A/896/1010),
3270          *  set PM jump addresses.
3271          */
3272         if (np->features & FE_NOPM) {
3273                 OUTL (nc_pmjad1, SCRIPTB_BA (np, pm_handle));
3274                 OUTL (nc_pmjad2, SCRIPTB_BA (np, pm_handle));
3275         }
3276
3277         /*
3278          *    Enable GPIO0 pin for writing if LED support from SCRIPTS.
3279          *    Also set GPIO5 and clear GPIO6 if hardware LED control.
3280          */
3281         if (np->features & FE_LED0)
3282                 OUTB(nc_gpcntl, INB(nc_gpcntl) & ~0x01);
3283         else if (np->features & FE_LEDC)
3284                 OUTB(nc_gpcntl, (INB(nc_gpcntl) & ~0x41) | 0x20);
3285
3286         /*
3287          *      enable ints
3288          */
3289         OUTW (nc_sien , STO|HTH|MA|SGE|UDC|RST|PAR);
3290         OUTB (nc_dien , MDPE|BF|SSI|SIR|IID);
3291
3292         /*
3293          *  For 895/6 enable SBMC interrupt and save current SCSI bus mode.
3294          *  Try to eat the spurious SBMC interrupt that may occur when
3295          *  we reset the chip but not the SCSI BUS (at initialization).
3296          */
3297         if (np->features & (FE_ULTRA2|FE_ULTRA3)) {
3298                 OUTONW (nc_sien, SBMC);
3299                 if (reason == 0) {
3300                         MDELAY(100);
3301                         INW (nc_sist);
3302                 }
3303                 np->scsi_mode = INB (nc_stest4) & SMODE;
3304         }
3305
3306         /*
3307          *  Fill in target structure.
3308          *  Reinitialize usrsync.
3309          *  Reinitialize usrwide.
3310          *  Prepare sync negotiation according to actual SCSI bus mode.
3311          */
3312         for (i=0;i<SYM_CONF_MAX_TARGET;i++) {
3313                 tcb_p tp = &np->target[i];
3314
3315                 tp->to_reset  = 0;
3316                 tp->head.sval = 0;
3317                 tp->head.wval = np->rv_scntl3;
3318                 tp->head.uval = 0;
3319
3320                 tp->tinfo.current.period = 0;
3321                 tp->tinfo.current.offset = 0;
3322                 tp->tinfo.current.width  = BUS_8_BIT;
3323                 tp->tinfo.current.options = 0;
3324         }
3325
3326         /*
3327          *  Download SCSI SCRIPTS to on-chip RAM if present,
3328          *  and start script processor.
3329          */
3330         if (np->ram_ba) {
3331                 if (sym_verbose > 1)
3332                         kprintf ("%s: Downloading SCSI SCRIPTS.\n",
3333                                 sym_name(np));
3334                 if (np->ram_ws == 8192) {
3335                         OUTRAM_OFF(4096, np->scriptb0, np->scriptb_sz);
3336                         OUTL (nc_mmws, np->scr_ram_seg);
3337                         OUTL (nc_mmrs, np->scr_ram_seg);
3338                         OUTL (nc_sfs,  np->scr_ram_seg);
3339                         phys = SCRIPTB_BA (np, start64);
3340                 }
3341                 else
3342                         phys = SCRIPTA_BA (np, init);
3343                 OUTRAM_OFF(0, np->scripta0, np->scripta_sz);
3344         }
3345         else
3346                 phys = SCRIPTA_BA (np, init);
3347
3348         np->istat_sem = 0;
3349
3350         OUTL (nc_dsa, np->hcb_ba);
3351         OUTL_DSP (phys);
3352
3353         /*
3354          *  Notify the XPT about the RESET condition.
3355          */
3356         if (reason != 0)
3357                 xpt_async(AC_BUS_RESET, np->path, NULL);
3358 }
3359
3360 /*
3361  *  Get clock factor and sync divisor for a given
3362  *  synchronous factor period.
3363  */
3364 static int
3365 sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp, u_char *fakp)
3366 {
3367         u32     clk = np->clock_khz;    /* SCSI clock frequency in kHz  */
3368         int     div = np->clock_divn;   /* Number of divisors supported */
3369         u32     fak;                    /* Sync factor in sxfer         */
3370         u32     per;                    /* Period in tenths of ns       */
3371         u32     kpc;                    /* (per * clk)                  */
3372         int     ret;
3373
3374         /*
3375          *  Compute the synchronous period in tenths of nano-seconds
3376          */
3377         if (dt && sfac <= 9)    per = 125;
3378         else if (sfac <= 10)    per = 250;
3379         else if (sfac == 11)    per = 303;
3380         else if (sfac == 12)    per = 500;
3381         else                    per = 40 * sfac;
3382         ret = per;
3383
3384         kpc = per * clk;
3385         if (dt)
3386                 kpc <<= 1;
3387
3388         /*
3389          *  For earliest C10 revision 0, we cannot use extra
3390          *  clocks for the setting of the SCSI clocking.
3391          *  Note that this limits the lowest sync data transfer
3392          *  to 5 Mega-transfers per second and may result in
3393          *  using higher clock divisors.
3394          */
3395 #if 1
3396         if ((np->features & (FE_C10|FE_U3EN)) == FE_C10) {
3397                 /*
3398                  *  Look for the lowest clock divisor that allows an
3399                  *  output speed not faster than the period.
3400                  */
3401                 while (div > 0) {
3402                         --div;
3403                         if (kpc > (div_10M[div] << 2)) {
3404                                 ++div;
3405                                 break;
3406                         }
3407                 }
3408                 fak = 0;                        /* No extra clocks */
3409                 if (div == np->clock_divn) {    /* Are we too fast ? */
3410                         ret = -1;
3411                 }
3412                 *divp = div;
3413                 *fakp = fak;
3414                 return ret;
3415         }
3416 #endif
3417
3418         /*
3419          *  Look for the greatest clock divisor that allows an
3420          *  input speed faster than the period.
3421          */
3422         while (div-- > 0)
3423                 if (kpc >= (div_10M[div] << 2)) break;
3424
3425         /*
3426          *  Calculate the lowest clock factor that allows an output
3427          *  speed not faster than the period, and the max output speed.
3428          *  If fak >= 1 we will set both XCLKH_ST and XCLKH_DT.
3429          *  If fak >= 2 we will also set XCLKS_ST and XCLKS_DT.
3430          */
3431         if (dt) {
3432                 fak = (kpc - 1) / (div_10M[div] << 1) + 1 - 2;
3433                 /* ret = ((2+fak)*div_10M[div])/np->clock_khz; */
3434         }
3435         else {
3436                 fak = (kpc - 1) / div_10M[div] + 1 - 4;
3437                 /* ret = ((4+fak)*div_10M[div])/np->clock_khz; */
3438         }
3439
3440         /*
3441          *  Check against our hardware limits, or bugs :).
3442          */
3443         if (fak < 0)    {fak = 0; ret = -1;}
3444         if (fak > 2)    {fak = 2; ret = -1;}
3445
3446         /*
3447          *  Compute and return sync parameters.
3448          */
3449         *divp = div;
3450         *fakp = fak;
3451
3452         return ret;
3453 }
3454
3455 /*
3456  *  Tell the SCSI layer about the new transfer parameters.
3457  */
3458 static void
3459 sym_xpt_async_transfer_neg(hcb_p np, int target, u_int spi_valid)
3460 {
3461         struct ccb_trans_settings cts;
3462         struct cam_path *path;
3463         int sts;
3464         tcb_p tp = &np->target[target];
3465
3466         sts = xpt_create_path(&path, NULL, cam_sim_path(np->sim), target,
3467                               CAM_LUN_WILDCARD);
3468         if (sts != CAM_REQ_CMP)
3469                 return;
3470
3471         bzero(&cts, sizeof(cts));
3472
3473 #define cts__scsi (cts.proto_specific.scsi)
3474 #define cts__spi  (cts.xport_specific.spi)
3475
3476         cts.type      = CTS_TYPE_CURRENT_SETTINGS;
3477         cts.protocol  = PROTO_SCSI;
3478         cts.transport = XPORT_SPI;
3479         cts.protocol_version  = tp->tinfo.current.scsi_version;
3480         cts.transport_version = tp->tinfo.current.spi_version;
3481
3482         cts__spi.valid = spi_valid;
3483         if (spi_valid & CTS_SPI_VALID_SYNC_RATE)
3484                 cts__spi.sync_period = tp->tinfo.current.period;
3485         if (spi_valid & CTS_SPI_VALID_SYNC_OFFSET)
3486                 cts__spi.sync_offset = tp->tinfo.current.offset;
3487         if (spi_valid & CTS_SPI_VALID_BUS_WIDTH)
3488                 cts__spi.bus_width   = tp->tinfo.current.width;
3489         if (spi_valid & CTS_SPI_VALID_PPR_OPTIONS)
3490                 cts__spi.ppr_options = tp->tinfo.current.options;
3491 #undef cts__spi
3492 #undef cts__scsi
3493         xpt_setup_ccb(&cts.ccb_h, path, /*priority*/1);
3494         xpt_async(AC_TRANSFER_NEG, path, &cts);
3495         xpt_free_path(path);
3496 }
3497
3498 #define SYM_SPI_VALID_WDTR              \
3499         CTS_SPI_VALID_BUS_WIDTH |       \
3500         CTS_SPI_VALID_SYNC_RATE |       \
3501         CTS_SPI_VALID_SYNC_OFFSET
3502 #define SYM_SPI_VALID_SDTR              \
3503         CTS_SPI_VALID_SYNC_RATE |       \
3504         CTS_SPI_VALID_SYNC_OFFSET
3505 #define SYM_SPI_VALID_PPR               \
3506         CTS_SPI_VALID_PPR_OPTIONS |     \
3507         CTS_SPI_VALID_BUS_WIDTH |       \
3508         CTS_SPI_VALID_SYNC_RATE |       \
3509         CTS_SPI_VALID_SYNC_OFFSET
3510
3511 /*
3512  *  We received a WDTR.
3513  *  Let everything be aware of the changes.
3514  */
3515 static void sym_setwide(hcb_p np, ccb_p cp, u_char wide)
3516 {
3517         tcb_p tp = &np->target[cp->target];
3518
3519         sym_settrans(np, cp, 0, 0, 0, wide, 0, 0);
3520
3521         /*
3522          *  Tell the SCSI layer about the new transfer parameters.
3523          */
3524         tp->tinfo.goal.width = tp->tinfo.current.width = wide;
3525         tp->tinfo.current.offset = 0;
3526         tp->tinfo.current.period = 0;
3527         tp->tinfo.current.options = 0;
3528
3529         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_WDTR);
3530 }
3531
3532 /*
3533  *  We received a SDTR.
3534  *  Let everything be aware of the changes.
3535  */
3536 static void
3537 sym_setsync(hcb_p np, ccb_p cp, u_char ofs, u_char per, u_char div, u_char fak)
3538 {
3539         tcb_p tp = &np->target[cp->target];
3540         u_char wide = (cp->phys.select.sel_scntl3 & EWS) ? 1 : 0;
3541
3542         sym_settrans(np, cp, 0, ofs, per, wide, div, fak);
3543
3544         /*
3545          *  Tell the SCSI layer about the new transfer parameters.
3546          */
3547         tp->tinfo.goal.period   = tp->tinfo.current.period  = per;
3548         tp->tinfo.goal.offset   = tp->tinfo.current.offset  = ofs;
3549         tp->tinfo.goal.options  = tp->tinfo.current.options = 0;
3550
3551         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_SDTR);
3552 }
3553
3554 /*
3555  *  We received a PPR.
3556  *  Let everything be aware of the changes.
3557  */
3558 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3559                          u_char per, u_char wide, u_char div, u_char fak)
3560 {
3561         tcb_p tp = &np->target[cp->target];
3562
3563         sym_settrans(np, cp, dt, ofs, per, wide, div, fak);
3564
3565         /*
3566          *  Tell the SCSI layer about the new transfer parameters.
3567          */
3568         tp->tinfo.goal.width    = tp->tinfo.current.width  = wide;
3569         tp->tinfo.goal.period   = tp->tinfo.current.period = per;
3570         tp->tinfo.goal.offset   = tp->tinfo.current.offset = ofs;
3571         tp->tinfo.goal.options  = tp->tinfo.current.options = dt;
3572
3573         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_PPR);
3574 }
3575
3576 /*
3577  *  Switch trans mode for current job and it's target.
3578  */
3579 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3580                          u_char per, u_char wide, u_char div, u_char fak)
3581 {
3582         SYM_QUEHEAD *qp;
3583         union   ccb *ccb;
3584         tcb_p tp;
3585         u_char target = INB (nc_sdid) & 0x0f;
3586         u_char sval, wval, uval;
3587
3588         assert (cp);
3589         if (!cp) return;
3590         ccb = cp->cam_ccb;
3591         assert (ccb);
3592         if (!ccb) return;
3593         assert (target == (cp->target & 0xf));
3594         tp = &np->target[target];
3595
3596         sval = tp->head.sval;
3597         wval = tp->head.wval;
3598         uval = tp->head.uval;
3599
3600 #if 0
3601         kprintf("XXXX sval=%x wval=%x uval=%x (%x)\n",
3602                 sval, wval, uval, np->rv_scntl3);
3603 #endif
3604         /*
3605          *  Set the offset.
3606          */
3607         if (!(np->features & FE_C10))
3608                 sval = (sval & ~0x1f) | ofs;
3609         else
3610                 sval = (sval & ~0x3f) | ofs;
3611
3612         /*
3613          *  Set the sync divisor and extra clock factor.
3614          */
3615         if (ofs != 0) {
3616                 wval = (wval & ~0x70) | ((div+1) << 4);
3617                 if (!(np->features & FE_C10))
3618                         sval = (sval & ~0xe0) | (fak << 5);
3619                 else {
3620                         uval = uval & ~(XCLKH_ST|XCLKH_DT|XCLKS_ST|XCLKS_DT);
3621                         if (fak >= 1) uval |= (XCLKH_ST|XCLKH_DT);
3622                         if (fak >= 2) uval |= (XCLKS_ST|XCLKS_DT);
3623                 }
3624         }
3625
3626         /*
3627          *  Set the bus width.
3628          */
3629         wval = wval & ~EWS;
3630         if (wide != 0)
3631                 wval |= EWS;
3632
3633         /*
3634          *  Set misc. ultra enable bits.
3635          */
3636         if (np->features & FE_C10) {
3637                 uval = uval & ~(U3EN|AIPCKEN);
3638                 if (dt) {
3639                         assert(np->features & FE_U3EN);
3640                         uval |= U3EN;
3641                 }
3642         }
3643         else {
3644                 wval = wval & ~ULTRA;
3645                 if (per <= 12)  wval |= ULTRA;
3646         }
3647
3648         /*
3649          *   Stop there if sync parameters are unchanged.
3650          */
3651         if (tp->head.sval == sval &&
3652             tp->head.wval == wval &&
3653             tp->head.uval == uval)
3654                 return;
3655         tp->head.sval = sval;
3656         tp->head.wval = wval;
3657         tp->head.uval = uval;
3658
3659         /*
3660          *  Disable extended Sreq/Sack filtering if per < 50.
3661          *  Not supported on the C1010.
3662          */
3663         if (per < 50 && !(np->features & FE_C10))
3664                 OUTOFFB (nc_stest2, EXT);
3665
3666         /*
3667          *  set actual value and sync_status
3668          */
3669         OUTB (nc_sxfer,  tp->head.sval);
3670         OUTB (nc_scntl3, tp->head.wval);
3671
3672         if (np->features & FE_C10) {
3673                 OUTB (nc_scntl4, tp->head.uval);
3674         }
3675
3676         /*
3677          *  patch ALL busy ccbs of this target.
3678          */
3679         FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
3680                 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
3681                 if (cp->target != target)
3682                         continue;
3683                 cp->phys.select.sel_scntl3 = tp->head.wval;
3684                 cp->phys.select.sel_sxfer  = tp->head.sval;
3685                 if (np->features & FE_C10) {
3686                         cp->phys.select.sel_scntl4 = tp->head.uval;
3687                 }
3688         }
3689 }
3690
3691 /*
3692  *  log message for real hard errors
3693  *
3694  *  sym0 targ 0?: ERROR (ds:si) (so-si-sd) (sxfer/scntl3) @ name (dsp:dbc).
3695  *            reg: r0 r1 r2 r3 r4 r5 r6 ..... rf.
3696  *
3697  *  exception register:
3698  *      ds:     dstat
3699  *      si:     sist
3700  *
3701  *  SCSI bus lines:
3702  *      so:     control lines as driven by chip.
3703  *      si:     control lines as seen by chip.
3704  *      sd:     scsi data lines as seen by chip.
3705  *
3706  *  wide/fastmode:
3707  *      sxfer:  (see the manual)
3708  *      scntl3: (see the manual)
3709  *
3710  *  current script command:
3711  *      dsp:    script address (relative to start of script).
3712  *      dbc:    first word of script command.
3713  *
3714  *  First 24 register of the chip:
3715  *      r0..rf
3716  */
3717 static void sym_log_hard_error(hcb_p np, u_short sist, u_char dstat)
3718 {
3719         u32     dsp;
3720         int     script_ofs;
3721         int     script_size;
3722         char    *script_name;
3723         u_char  *script_base;
3724         int     i;
3725
3726         dsp     = INL (nc_dsp);
3727
3728         if      (dsp > np->scripta_ba &&
3729                  dsp <= np->scripta_ba + np->scripta_sz) {
3730                 script_ofs      = dsp - np->scripta_ba;
3731                 script_size     = np->scripta_sz;
3732                 script_base     = np->scripta0;
3733                 script_name     = "scripta";
3734         }
3735         else if (np->scriptb_ba < dsp &&
3736                  dsp <= np->scriptb_ba + np->scriptb_sz) {
3737                 script_ofs      = dsp - np->scriptb_ba;
3738                 script_size     = np->scriptb_sz;
3739                 script_base     = np->scriptb0;
3740                 script_name     = "scriptb";
3741         } else {
3742                 script_ofs      = dsp;
3743                 script_size     = 0;
3744                 script_base     = NULL;
3745                 script_name     = "mem";
3746         }
3747
3748         kprintf ("%s:%d: ERROR (%x:%x) (%x-%x-%x) (%x/%x) @ (%s %x:%08x).\n",
3749                 sym_name (np), (unsigned)INB (nc_sdid)&0x0f, dstat, sist,
3750                 (unsigned)INB (nc_socl), (unsigned)INB (nc_sbcl),
3751                 (unsigned)INB (nc_sbdl), (unsigned)INB (nc_sxfer),
3752                 (unsigned)INB (nc_scntl3), script_name, script_ofs,
3753                 (unsigned)INL (nc_dbc));
3754
3755         if (((script_ofs & 3) == 0) &&
3756             (unsigned)script_ofs < script_size) {
3757                 kprintf ("%s: script cmd = %08x\n", sym_name(np),
3758                         scr_to_cpu((int) *(u32 *)(script_base + script_ofs)));
3759         }
3760
3761         kprintf ("%s: regdump:", sym_name(np));
3762         for (i=0; i<24;i++)
3763             kprintf (" %02x", (unsigned)INB_OFF(i));
3764         kprintf (".\n");
3765
3766         /*
3767          *  PCI BUS error, read the PCI ststus register.
3768          */
3769         if (dstat & (MDPE|BF)) {
3770                 u_short pci_sts;
3771                 pci_sts = pci_read_config(np->device, PCIR_STATUS, 2);
3772                 if (pci_sts & 0xf900) {
3773                         pci_write_config(np->device, PCIR_STATUS, pci_sts, 2);
3774                         kprintf("%s: PCI STATUS = 0x%04x\n",
3775                                 sym_name(np), pci_sts & 0xf900);
3776                 }
3777         }
3778 }
3779
3780 /*
3781  *  chip interrupt handler
3782  *
3783  *  In normal situations, interrupt conditions occur one at
3784  *  a time. But when something bad happens on the SCSI BUS,
3785  *  the chip may raise several interrupt flags before
3786  *  stopping and interrupting the CPU. The additionnal
3787  *  interrupt flags are stacked in some extra registers
3788  *  after the SIP and/or DIP flag has been raised in the
3789  *  ISTAT. After the CPU has read the interrupt condition
3790  *  flag from SIST or DSTAT, the chip unstacks the other
3791  *  interrupt flags and sets the corresponding bits in
3792  *  SIST or DSTAT. Since the chip starts stacking once the
3793  *  SIP or DIP flag is set, there is a small window of time
3794  *  where the stacking does not occur.
3795  *
3796  *  Typically, multiple interrupt conditions may happen in
3797  *  the following situations:
3798  *
3799  *  - SCSI parity error + Phase mismatch  (PAR|MA)
3800  *    When a parity error is detected in input phase
3801  *    and the device switches to msg-in phase inside a
3802  *    block MOV.
3803  *  - SCSI parity error + Unexpected disconnect (PAR|UDC)
3804  *    When a stupid device does not want to handle the
3805  *    recovery of an SCSI parity error.
3806  *  - Some combinations of STO, PAR, UDC, ...
3807  *    When using non compliant SCSI stuff, when user is
3808  *    doing non compliant hot tampering on the BUS, when
3809  *    something really bad happens to a device, etc ...
3810  *
3811  *  The heuristic suggested by SYMBIOS to handle
3812  *  multiple interrupts is to try unstacking all
3813  *  interrupts conditions and to handle them on some
3814  *  priority based on error severity.
3815  *  This will work when the unstacking has been
3816  *  successful, but we cannot be 100 % sure of that,
3817  *  since the CPU may have been faster to unstack than
3818  *  the chip is able to stack. Hmmm ... But it seems that
3819  *  such a situation is very unlikely to happen.
3820  *
3821  *  If this happen, for example STO caught by the CPU
3822  *  then UDC happenning before the CPU have restarted
3823  *  the SCRIPTS, the driver may wrongly complete the
3824  *  same command on UDC, since the SCRIPTS didn't restart
3825  *  and the DSA still points to the same command.
3826  *  We avoid this situation by setting the DSA to an
3827  *  invalid value when the CCB is completed and before
3828  *  restarting the SCRIPTS.
3829  *
3830  *  Another issue is that we need some section of our
3831  *  recovery procedures to be somehow uninterruptible but
3832  *  the SCRIPTS processor does not provides such a
3833  *  feature. For this reason, we handle recovery preferently
3834  *  from the C code and check against some SCRIPTS critical
3835  *  sections from the C code.
3836  *
3837  *  Hopefully, the interrupt handling of the driver is now
3838  *  able to resist to weird BUS error conditions, but donnot
3839  *  ask me for any guarantee that it will never fail. :-)
3840  *  Use at your own decision and risk.
3841  */
3842
3843 static void sym_intr1 (hcb_p np)
3844 {
3845         u_char  istat, istatc;
3846         u_char  dstat;
3847         u_short sist;
3848
3849         SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3850
3851         /*
3852          *  interrupt on the fly ?
3853          *
3854          *  A `dummy read' is needed to ensure that the
3855          *  clear of the INTF flag reaches the device
3856          *  before the scanning of the DONE queue.
3857          */
3858         istat = INB (nc_istat);
3859         if (istat & INTF) {
3860                 OUTB (nc_istat, (istat & SIGP) | INTF | np->istat_sem);
3861                 istat = INB (nc_istat);         /* DUMMY READ */
3862                 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("F ");
3863                 (void)sym_wakeup_done (np);
3864         };
3865
3866         if (!(istat & (SIP|DIP)))
3867                 return;
3868
3869 #if 0   /* We should never get this one */
3870         if (istat & CABRT)
3871                 OUTB (nc_istat, CABRT);
3872 #endif
3873
3874         /*
3875          *  PAR and MA interrupts may occur at the same time,
3876          *  and we need to know of both in order to handle
3877          *  this situation properly. We try to unstack SCSI
3878          *  interrupts for that reason. BTW, I dislike a LOT
3879          *  such a loop inside the interrupt routine.
3880          *  Even if DMA interrupt stacking is very unlikely to
3881          *  happen, we also try unstacking these ones, since
3882          *  this has no performance impact.
3883          */
3884         sist    = 0;
3885         dstat   = 0;
3886         istatc  = istat;
3887         do {
3888                 if (istatc & SIP)
3889                         sist  |= INW (nc_sist);
3890                 if (istatc & DIP)
3891                         dstat |= INB (nc_dstat);
3892                 istatc = INB (nc_istat);
3893                 istat |= istatc;
3894         } while (istatc & (SIP|DIP));
3895
3896         if (DEBUG_FLAGS & DEBUG_TINY)
3897                 kprintf ("<%d|%x:%x|%x:%x>",
3898                         (int)INB(nc_scr0),
3899                         dstat,sist,
3900                         (unsigned)INL(nc_dsp),
3901                         (unsigned)INL(nc_dbc));
3902         /*
3903          *  On paper, a memory barrier may be needed here.
3904          *  And since we are paranoid ... :)
3905          */
3906         MEMORY_BARRIER();
3907
3908         /*
3909          *  First, interrupts we want to service cleanly.
3910          *
3911          *  Phase mismatch (MA) is the most frequent interrupt
3912          *  for chip earlier than the 896 and so we have to service
3913          *  it as quickly as possible.
3914          *  A SCSI parity error (PAR) may be combined with a phase
3915          *  mismatch condition (MA).
3916          *  Programmed interrupts (SIR) are used to call the C code
3917          *  from SCRIPTS.
3918          *  The single step interrupt (SSI) is not used in this
3919          *  driver.
3920          */
3921         if (!(sist  & (STO|GEN|HTH|SGE|UDC|SBMC|RST)) &&
3922             !(dstat & (MDPE|BF|ABRT|IID))) {
3923                 if      (sist & PAR)    sym_int_par (np, sist);
3924                 else if (sist & MA)     sym_int_ma (np);
3925                 else if (dstat & SIR)   sym_int_sir (np);
3926                 else if (dstat & SSI)   OUTONB_STD ();
3927                 else                    goto unknown_int;
3928                 return;
3929         };
3930
3931         /*
3932          *  Now, interrupts that donnot happen in normal
3933          *  situations and that we may need to recover from.
3934          *
3935          *  On SCSI RESET (RST), we reset everything.
3936          *  On SCSI BUS MODE CHANGE (SBMC), we complete all
3937          *  active CCBs with RESET status, prepare all devices
3938          *  for negotiating again and restart the SCRIPTS.
3939          *  On STO and UDC, we complete the CCB with the corres-
3940          *  ponding status and restart the SCRIPTS.
3941          */
3942         if (sist & RST) {
3943                 xpt_print_path(np->path);
3944                 kprintf("SCSI BUS reset detected.\n");
3945                 sym_init (np, 1);
3946                 return;
3947         };
3948
3949         OUTB (nc_ctest3, np->rv_ctest3 | CLF);  /* clear dma fifo  */
3950         OUTB (nc_stest3, TE|CSF);               /* clear scsi fifo */
3951
3952         if (!(sist  & (GEN|HTH|SGE)) &&
3953             !(dstat & (MDPE|BF|ABRT|IID))) {
3954                 if      (sist & SBMC)   sym_int_sbmc (np);
3955                 else if (sist & STO)    sym_int_sto (np);
3956                 else if (sist & UDC)    sym_int_udc (np);
3957                 else                    goto unknown_int;
3958                 return;
3959         };
3960
3961         /*
3962          *  Now, interrupts we are not able to recover cleanly.
3963          *
3964          *  Log message for hard errors.
3965          *  Reset everything.
3966          */
3967
3968         sym_log_hard_error(np, sist, dstat);
3969
3970         if ((sist & (GEN|HTH|SGE)) ||
3971                 (dstat & (MDPE|BF|ABRT|IID))) {
3972                 sym_start_reset(np);
3973                 return;
3974         };
3975
3976 unknown_int:
3977         /*
3978          *  We just miss the cause of the interrupt. :(
3979          *  Print a message. The timeout will do the real work.
3980          */
3981         kprintf(        "%s: unknown interrupt(s) ignored, "
3982                 "ISTAT=0x%x DSTAT=0x%x SIST=0x%x\n",
3983                 sym_name(np), istat, dstat, sist);
3984 }
3985
3986 static void sym_intr(void *arg)
3987 {
3988         hcb_p np = arg;
3989
3990         SYM_LOCK();
3991
3992         if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("[");
3993         sym_intr1((hcb_p) arg);
3994         if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("]");
3995
3996         SYM_UNLOCK();
3997 }
3998
3999 static void sym_poll(struct cam_sim *sim)
4000 {
4001         sym_intr1(cam_sim_softc(sim));
4002 }
4003