Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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
58 /* $FreeBSD: src/sys/dev/sym/sym_hipd.c,v 1.6.2.12 2001/12/02 19:01:10 groudier Exp $ */
59 /* $DragonFly: src/sys/dev/disk/sym/sym_hipd.c,v 1.2 2003/06/17 04:28:31 dillon Exp $ */
60
61 #define SYM_DRIVER_NAME "sym-1.6.5-20000902"
62
63 /* #define SYM_DEBUG_GENERIC_SUPPORT */
64 /* #define CAM_NEW_TRAN_CODE */
65
66 #include <pci.h>
67 #include <sys/param.h>
68
69 /*
70  *  Only use the BUS stuff for PCI under FreeBSD 4 and later versions.
71  *  Note that the old BUS stuff also works for FreeBSD 4 and spares 
72  *  about 1 KB for the driver object file.
73  */
74 #if     __FreeBSD_version >= 400000
75 #define FreeBSD_Bus_Dma_Abstraction
76 #define FreeBSD_Bus_Io_Abstraction
77 #define FreeBSD_Bus_Space_Abstraction
78 #endif
79
80 /*
81  *  Driver configuration options.
82  */
83 #include "opt_sym.h"
84 #include <dev/sym/sym_conf.h>
85
86 #ifndef FreeBSD_Bus_Io_Abstraction
87 #include "ncr.h"        /* To know if the ncr has been configured */
88 #endif
89
90 #include <sys/systm.h>
91 #include <sys/malloc.h>
92 #include <sys/kernel.h>
93 #ifdef FreeBSD_Bus_Io_Abstraction
94 #include <sys/module.h>
95 #include <sys/bus.h>
96 #endif
97
98 #include <sys/proc.h>
99
100 #include <pci/pcireg.h>
101 #include <pci/pcivar.h>
102
103 #ifdef  FreeBSD_Bus_Space_Abstraction
104 #include <machine/bus_memio.h>
105 /*
106  *  Only include bus_pio if needed.
107  *  This avoids bus space primitives to be uselessly bloated 
108  *  by out-of-age PIO operations.
109  */
110 #ifdef  SYM_CONF_IOMAPPED
111 #include <machine/bus_pio.h>
112 #endif
113 #endif
114 #include <machine/bus.h>
115
116 #ifdef FreeBSD_Bus_Io_Abstraction
117 #include <machine/resource.h>
118 #include <sys/rman.h>
119 #endif
120 #include <machine/clock.h>
121
122 #include <cam/cam.h>
123 #include <cam/cam_ccb.h>
124 #include <cam/cam_sim.h>
125 #include <cam/cam_xpt_sim.h>
126 #include <cam/cam_debug.h>
127
128 #include <cam/scsi/scsi_all.h>
129 #include <cam/scsi/scsi_message.h>
130
131 #include <vm/vm.h>
132 #include <vm/vm_param.h>
133 #include <vm/pmap.h>
134
135 /* Short and quite clear integer types */
136 typedef int8_t    s8;
137 typedef int16_t   s16;
138 typedef int32_t   s32;
139 typedef u_int8_t  u8;
140 typedef u_int16_t u16;
141 typedef u_int32_t u32;
142
143 /*
144  *  From 'cam.error_recovery_diffs.20010313.context' patch.
145  */
146 #ifdef  CAM_NEW_TRAN_CODE
147 #define FreeBSD_New_Tran_Settings
148 #endif  /* CAM_NEW_TRAN_CODE */
149
150 /*
151  *  Driver definitions.
152  */
153 #include <dev/sym/sym_defs.h>
154 #include <dev/sym/sym_fw.h>
155
156 /*
157  *  IA32 architecture does not reorder STORES and prevents
158  *  LOADS from passing STORES. It is called `program order' 
159  *  by Intel and allows device drivers to deal with memory 
160  *  ordering by only ensuring that the code is not reordered  
161  *  by the compiler when ordering is required.
162  *  Other architectures implement a weaker ordering that 
163  *  requires memory barriers (and also IO barriers when they 
164  *  make sense) to be used.
165  */
166
167 #if     defined __i386__
168 #define MEMORY_BARRIER()        do { ; } while(0)
169 #elif   defined __alpha__
170 #define MEMORY_BARRIER()        alpha_mb()
171 #elif   defined __powerpc__
172 #define MEMORY_BARRIER()        __asm__ volatile("eieio; sync" : : : "memory")
173 #elif   defined __ia64__
174 #define MEMORY_BARRIER()        __asm__ volatile("mf.a; mf" : : : "memory")
175 #elif   defined __sparc64__
176 #define MEMORY_BARRIER()        __asm__ volatile("membar #Sync" : : : "memory")
177 #else
178 #error  "Not supported platform"
179 #endif
180
181 /*
182  *  Portable but silly implemented byte order primitives.
183  *  We define the primitives we need, since FreeBSD doesn't 
184  *  seem to have them yet.
185  */
186 #if     BYTE_ORDER == BIG_ENDIAN
187
188 #define __revb16(x) (   (((u16)(x) & (u16)0x00ffU) << 8) | \
189                         (((u16)(x) & (u16)0xff00U) >> 8)        )
190 #define __revb32(x) (   (((u32)(x) & 0x000000ffU) << 24) | \
191                         (((u32)(x) & 0x0000ff00U) <<  8) | \
192                         (((u32)(x) & 0x00ff0000U) >>  8) | \
193                         (((u32)(x) & 0xff000000U) >> 24)        )
194
195 #define __htole16(v)    __revb16(v)
196 #define __htole32(v)    __revb32(v)
197 #define __le16toh(v)    __htole16(v)
198 #define __le32toh(v)    __htole32(v)
199
200 static __inline u16     _htole16(u16 v) { return __htole16(v); }
201 static __inline u32     _htole32(u32 v) { return __htole32(v); }
202 #define _le16toh        _htole16
203 #define _le32toh        _htole32
204
205 #else   /* LITTLE ENDIAN */
206
207 #define __htole16(v)    (v)
208 #define __htole32(v)    (v)
209 #define __le16toh(v)    (v)
210 #define __le32toh(v)    (v)
211
212 #define _htole16(v)     (v)
213 #define _htole32(v)     (v)
214 #define _le16toh(v)     (v)
215 #define _le32toh(v)     (v)
216
217 #endif  /* BYTE_ORDER */
218
219 /*
220  *  A la VMS/CAM-3 queue management.
221  */
222
223 typedef struct sym_quehead {
224         struct sym_quehead *flink;      /* Forward  pointer */
225         struct sym_quehead *blink;      /* Backward pointer */
226 } SYM_QUEHEAD;
227
228 #define sym_que_init(ptr) do { \
229         (ptr)->flink = (ptr); (ptr)->blink = (ptr); \
230 } while (0)
231
232 static __inline struct sym_quehead *sym_que_first(struct sym_quehead *head)
233 {
234         return (head->flink == head) ? 0 : head->flink;
235 }
236
237 static __inline struct sym_quehead *sym_que_last(struct sym_quehead *head)
238 {
239         return (head->blink == head) ? 0 : head->blink;
240 }
241
242 static __inline void __sym_que_add(struct sym_quehead * new,
243         struct sym_quehead * blink,
244         struct sym_quehead * flink)
245 {
246         flink->blink    = new;
247         new->flink      = flink;
248         new->blink      = blink;
249         blink->flink    = new;
250 }
251
252 static __inline void __sym_que_del(struct sym_quehead * blink,
253         struct sym_quehead * flink)
254 {
255         flink->blink = blink;
256         blink->flink = flink;
257 }
258
259 static __inline int sym_que_empty(struct sym_quehead *head)
260 {
261         return head->flink == head;
262 }
263
264 static __inline void sym_que_splice(struct sym_quehead *list,
265         struct sym_quehead *head)
266 {
267         struct sym_quehead *first = list->flink;
268
269         if (first != list) {
270                 struct sym_quehead *last = list->blink;
271                 struct sym_quehead *at   = head->flink;
272
273                 first->blink = head;
274                 head->flink  = first;
275
276                 last->flink = at;
277                 at->blink   = last;
278         }
279 }
280
281 #define sym_que_entry(ptr, type, member) \
282         ((type *)((char *)(ptr)-(unsigned int)(&((type *)0)->member)))
283
284
285 #define sym_insque(new, pos)            __sym_que_add(new, pos, (pos)->flink)
286
287 #define sym_remque(el)                  __sym_que_del((el)->blink, (el)->flink)
288
289 #define sym_insque_head(new, head)      __sym_que_add(new, head, (head)->flink)
290
291 static __inline struct sym_quehead *sym_remque_head(struct sym_quehead *head)
292 {
293         struct sym_quehead *elem = head->flink;
294
295         if (elem != head)
296                 __sym_que_del(head, elem->flink);
297         else
298                 elem = 0;
299         return elem;
300 }
301
302 #define sym_insque_tail(new, head)      __sym_que_add(new, (head)->blink, head)
303
304 static __inline struct sym_quehead *sym_remque_tail(struct sym_quehead *head)
305 {
306         struct sym_quehead *elem = head->blink;
307
308         if (elem != head)
309                 __sym_que_del(elem->blink, head);
310         else
311                 elem = 0;
312         return elem;
313 }
314
315 /*
316  *  This one may be useful.
317  */
318 #define FOR_EACH_QUEUED_ELEMENT(head, qp) \
319         for (qp = (head)->flink; qp != (head); qp = qp->flink)
320 /*
321  *  FreeBSD does not offer our kind of queue in the CAM CCB.
322  *  So, we have to cast.
323  */
324 #define sym_qptr(p)     ((struct sym_quehead *) (p))
325
326 /*
327  *  Simple bitmap operations.
328  */ 
329 #define sym_set_bit(p, n)       (((u32 *)(p))[(n)>>5] |=  (1<<((n)&0x1f)))
330 #define sym_clr_bit(p, n)       (((u32 *)(p))[(n)>>5] &= ~(1<<((n)&0x1f)))
331 #define sym_is_bit(p, n)        (((u32 *)(p))[(n)>>5] &   (1<<((n)&0x1f)))
332
333 /*
334  *  Number of tasks per device we want to handle.
335  */
336 #if     SYM_CONF_MAX_TAG_ORDER > 8
337 #error  "more than 256 tags per logical unit not allowed."
338 #endif
339 #define SYM_CONF_MAX_TASK       (1<<SYM_CONF_MAX_TAG_ORDER)
340
341 /*
342  *  Donnot use more tasks that we can handle.
343  */
344 #ifndef SYM_CONF_MAX_TAG
345 #define SYM_CONF_MAX_TAG        SYM_CONF_MAX_TASK
346 #endif
347 #if     SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
348 #undef  SYM_CONF_MAX_TAG
349 #define SYM_CONF_MAX_TAG        SYM_CONF_MAX_TASK
350 #endif
351
352 /*
353  *    This one means 'NO TAG for this job'
354  */
355 #define NO_TAG  (256)
356
357 /*
358  *  Number of SCSI targets.
359  */
360 #if     SYM_CONF_MAX_TARGET > 16
361 #error  "more than 16 targets not allowed."
362 #endif
363
364 /*
365  *  Number of logical units per target.
366  */
367 #if     SYM_CONF_MAX_LUN > 64
368 #error  "more than 64 logical units per target not allowed."
369 #endif
370
371 /*
372  *    Asynchronous pre-scaler (ns). Shall be 40 for 
373  *    the SCSI timings to be compliant.
374  */
375 #define SYM_CONF_MIN_ASYNC (40)
376
377 /*
378  *  Number of entries in the START and DONE queues.
379  *
380  *  We limit to 1 PAGE in order to succeed allocation of 
381  *  these queues. Each entry is 8 bytes long (2 DWORDS).
382  */
383 #ifdef  SYM_CONF_MAX_START
384 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
385 #else
386 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
387 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
388 #endif
389
390 #if     SYM_CONF_MAX_QUEUE > PAGE_SIZE/8
391 #undef  SYM_CONF_MAX_QUEUE
392 #define SYM_CONF_MAX_QUEUE   PAGE_SIZE/8
393 #undef  SYM_CONF_MAX_START
394 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
395 #endif
396
397 /*
398  *  For this one, we want a short name :-)
399  */
400 #define MAX_QUEUE       SYM_CONF_MAX_QUEUE
401
402 /*
403  *  These ones should have been already defined.
404  */
405 #ifndef MIN
406 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
407 #endif
408
409 /*
410  *  Active debugging tags and verbosity.
411  */
412 #define DEBUG_ALLOC     (0x0001)
413 #define DEBUG_PHASE     (0x0002)
414 #define DEBUG_POLL      (0x0004)
415 #define DEBUG_QUEUE     (0x0008)
416 #define DEBUG_RESULT    (0x0010)
417 #define DEBUG_SCATTER   (0x0020)
418 #define DEBUG_SCRIPT    (0x0040)
419 #define DEBUG_TINY      (0x0080)
420 #define DEBUG_TIMING    (0x0100)
421 #define DEBUG_NEGO      (0x0200)
422 #define DEBUG_TAGS      (0x0400)
423 #define DEBUG_POINTER   (0x0800)
424
425 #if 0
426 static int sym_debug = 0;
427         #define DEBUG_FLAGS sym_debug
428 #else
429 /*      #define DEBUG_FLAGS (0x0631) */
430         #define DEBUG_FLAGS (0x0000)
431
432 #endif
433 #define sym_verbose     (np->verbose)
434
435 /*
436  *  Insert a delay in micro-seconds and milli-seconds.
437  */
438 static void UDELAY(int us) { DELAY(us); }
439 static void MDELAY(int ms) { while (ms--) UDELAY(1000); }
440
441 /*
442  *  Simple power of two buddy-like allocator.
443  *
444  *  This simple code is not intended to be fast, but to 
445  *  provide power of 2 aligned memory allocations.
446  *  Since the SCRIPTS processor only supplies 8 bit arithmetic, 
447  *  this allocator allows simple and fast address calculations  
448  *  from the SCRIPTS code. In addition, cache line alignment 
449  *  is guaranteed for power of 2 cache line size.
450  *
451  *  This allocator has been developped for the Linux sym53c8xx  
452  *  driver, since this O/S does not provide naturally aligned 
453  *  allocations.
454  *  It has the advantage of allowing the driver to use private 
455  *  pages of memory that will be useful if we ever need to deal 
456  *  with IO MMUs for PCI.
457  */
458
459 #define MEMO_SHIFT      4       /* 16 bytes minimum memory chunk */
460 #define MEMO_PAGE_ORDER 0       /* 1 PAGE  maximum */
461 #if 0
462 #define MEMO_FREE_UNUSED        /* Free unused pages immediately */
463 #endif
464 #define MEMO_WARN       1
465 #define MEMO_CLUSTER_SHIFT      (PAGE_SHIFT+MEMO_PAGE_ORDER)
466 #define MEMO_CLUSTER_SIZE       (1UL << MEMO_CLUSTER_SHIFT)
467 #define MEMO_CLUSTER_MASK       (MEMO_CLUSTER_SIZE-1)
468
469 #define get_pages()             malloc(MEMO_CLUSTER_SIZE, M_DEVBUF, M_NOWAIT)
470 #define free_pages(p)           free((p), M_DEVBUF)
471
472 typedef u_long m_addr_t;        /* Enough bits to bit-hack addresses */
473
474 typedef struct m_link {         /* Link between free memory chunks */
475         struct m_link *next;
476 } m_link_s;
477
478 #ifdef  FreeBSD_Bus_Dma_Abstraction
479 typedef struct m_vtob {         /* Virtual to Bus address translation */
480         struct m_vtob   *next;
481         bus_dmamap_t    dmamap; /* Map for this chunk */
482         m_addr_t        vaddr;  /* Virtual address */
483         m_addr_t        baddr;  /* Bus physical address */
484 } m_vtob_s;
485 /* Hash this stuff a bit to speed up translations */
486 #define VTOB_HASH_SHIFT         5
487 #define VTOB_HASH_SIZE          (1UL << VTOB_HASH_SHIFT)
488 #define VTOB_HASH_MASK          (VTOB_HASH_SIZE-1)
489 #define VTOB_HASH_CODE(m)       \
490         ((((m_addr_t) (m)) >> MEMO_CLUSTER_SHIFT) & VTOB_HASH_MASK)
491 #endif
492
493 typedef struct m_pool {         /* Memory pool of a given kind */
494 #ifdef  FreeBSD_Bus_Dma_Abstraction
495         bus_dma_tag_t    dev_dmat;      /* Identifies the pool */
496         bus_dma_tag_t    dmat;          /* Tag for our fixed allocations */
497         m_addr_t (*getp)(struct m_pool *);
498 #ifdef  MEMO_FREE_UNUSED
499         void (*freep)(struct m_pool *, m_addr_t);
500 #endif
501 #define M_GETP()                mp->getp(mp)
502 #define M_FREEP(p)              mp->freep(mp, p)
503         int nump;
504         m_vtob_s *(vtob[VTOB_HASH_SIZE]);
505         struct m_pool *next;
506 #else
507 #define M_GETP()                get_pages()
508 #define M_FREEP(p)              free_pages(p)
509 #endif  /* FreeBSD_Bus_Dma_Abstraction */
510         struct m_link h[MEMO_CLUSTER_SHIFT - MEMO_SHIFT + 1];
511 } m_pool_s;
512
513 static void *___sym_malloc(m_pool_s *mp, int size)
514 {
515         int i = 0;
516         int s = (1 << MEMO_SHIFT);
517         int j;
518         m_addr_t a;
519         m_link_s *h = mp->h;
520
521         if (size > MEMO_CLUSTER_SIZE)
522                 return 0;
523
524         while (size > s) {
525                 s <<= 1;
526                 ++i;
527         }
528
529         j = i;
530         while (!h[j].next) {
531                 if (s == MEMO_CLUSTER_SIZE) {
532                         h[j].next = (m_link_s *) M_GETP();
533                         if (h[j].next)
534                                 h[j].next->next = 0;
535                         break;
536                 }
537                 ++j;
538                 s <<= 1;
539         }
540         a = (m_addr_t) h[j].next;
541         if (a) {
542                 h[j].next = h[j].next->next;
543                 while (j > i) {
544                         j -= 1;
545                         s >>= 1;
546                         h[j].next = (m_link_s *) (a+s);
547                         h[j].next->next = 0;
548                 }
549         }
550 #ifdef DEBUG
551         printf("___sym_malloc(%d) = %p\n", size, (void *) a);
552 #endif
553         return (void *) a;
554 }
555
556 static void ___sym_mfree(m_pool_s *mp, void *ptr, int size)
557 {
558         int i = 0;
559         int s = (1 << MEMO_SHIFT);
560         m_link_s *q;
561         m_addr_t a, b;
562         m_link_s *h = mp->h;
563
564 #ifdef DEBUG
565         printf("___sym_mfree(%p, %d)\n", ptr, size);
566 #endif
567
568         if (size > MEMO_CLUSTER_SIZE)
569                 return;
570
571         while (size > s) {
572                 s <<= 1;
573                 ++i;
574         }
575
576         a = (m_addr_t) ptr;
577
578         while (1) {
579 #ifdef MEMO_FREE_UNUSED
580                 if (s == MEMO_CLUSTER_SIZE) {
581                         M_FREEP(a);
582                         break;
583                 }
584 #endif
585                 b = a ^ s;
586                 q = &h[i];
587                 while (q->next && q->next != (m_link_s *) b) {
588                         q = q->next;
589                 }
590                 if (!q->next) {
591                         ((m_link_s *) a)->next = h[i].next;
592                         h[i].next = (m_link_s *) a;
593                         break;
594                 }
595                 q->next = q->next->next;
596                 a = a & b;
597                 s <<= 1;
598                 ++i;
599         }
600 }
601
602 static void *__sym_calloc2(m_pool_s *mp, int size, char *name, int uflags)
603 {
604         void *p;
605
606         p = ___sym_malloc(mp, size);
607
608         if (DEBUG_FLAGS & DEBUG_ALLOC)
609                 printf ("new %-10s[%4d] @%p.\n", name, size, p);
610
611         if (p)
612                 bzero(p, size);
613         else if (uflags & MEMO_WARN)
614                 printf ("__sym_calloc2: failed to allocate %s[%d]\n", name, size);
615
616         return p;
617 }
618
619 #define __sym_calloc(mp, s, n)  __sym_calloc2(mp, s, n, MEMO_WARN)
620
621 static void __sym_mfree(m_pool_s *mp, void *ptr, int size, char *name)
622 {
623         if (DEBUG_FLAGS & DEBUG_ALLOC)
624                 printf ("freeing %-10s[%4d] @%p.\n", name, size, ptr);
625
626         ___sym_mfree(mp, ptr, size);
627
628 }
629
630 /*
631  * Default memory pool we donnot need to involve in DMA.
632  */
633 #ifndef FreeBSD_Bus_Dma_Abstraction
634 /*
635  * Without the `bus dma abstraction', all the memory is assumed 
636  * DMAable and a single pool is all what we need.
637  */
638 static m_pool_s mp0;
639
640 #else
641 /*
642  * With the `bus dma abstraction', we use a separate pool for 
643  * memory we donnot need to involve in DMA.
644  */
645 static m_addr_t ___mp0_getp(m_pool_s *mp)
646 {
647         m_addr_t m = (m_addr_t) get_pages();
648         if (m)
649                 ++mp->nump;
650         return m;
651 }
652
653 #ifdef  MEMO_FREE_UNUSED
654 static void ___mp0_freep(m_pool_s *mp, m_addr_t m)
655 {
656         free_pages(m);
657         --mp->nump;
658 }
659 #endif
660
661 #ifdef  MEMO_FREE_UNUSED
662 static m_pool_s mp0 = {0, 0, ___mp0_getp, ___mp0_freep};
663 #else
664 static m_pool_s mp0 = {0, 0, ___mp0_getp};
665 #endif
666
667 #endif  /* FreeBSD_Bus_Dma_Abstraction */
668
669 /*
670  * Actual memory allocation routine for non-DMAed memory.
671  */
672 static void *sym_calloc(int size, char *name)
673 {
674         void *m;
675         /* Lock */
676         m = __sym_calloc(&mp0, size, name);
677         /* Unlock */
678         return m;
679 }
680
681 /*
682  * Actual memory allocation routine for non-DMAed memory.
683  */
684 static void sym_mfree(void *ptr, int size, char *name)
685 {
686         /* Lock */
687         __sym_mfree(&mp0, ptr, size, name);
688         /* Unlock */
689 }
690
691 /*
692  * DMAable pools.
693  */
694 #ifndef FreeBSD_Bus_Dma_Abstraction
695 /*
696  * Without `bus dma abstraction', all the memory is DMAable, and 
697  * only a single pool is needed (vtophys() is our friend).
698  */
699 #define __sym_calloc_dma(b, s, n)       sym_calloc(s, n)
700 #define __sym_mfree_dma(b, p, s, n)     sym_mfree(p, s, n)
701 #ifdef  __alpha__
702 #define __vtobus(b, p)  alpha_XXX_dmamap((vm_offset_t)(p))
703 #else /*__i386__, __sparc64__*/
704 #define __vtobus(b, p)  vtophys(p)
705 #endif
706
707 #else
708 /*
709  * With `bus dma abstraction', we use a separate pool per parent 
710  * BUS handle. A reverse table (hashed) is maintained for virtual 
711  * to BUS address translation.
712  */
713 static void getbaddrcb(void *arg, bus_dma_segment_t *segs, int nseg, int error) 
714 {
715         bus_addr_t *baddr;
716         baddr = (bus_addr_t *)arg;
717         *baddr = segs->ds_addr;
718 }
719
720 static m_addr_t ___dma_getp(m_pool_s *mp)
721 {
722         m_vtob_s *vbp;
723         void *vaddr = 0;
724         bus_addr_t baddr = 0;
725
726         vbp = __sym_calloc(&mp0, sizeof(*vbp), "VTOB");
727         if (!vbp)
728                 goto out_err;
729
730         if (bus_dmamem_alloc(mp->dmat, &vaddr,
731                               BUS_DMA_NOWAIT, &vbp->dmamap))
732                 goto out_err;
733         bus_dmamap_load(mp->dmat, vbp->dmamap, vaddr,
734                         MEMO_CLUSTER_SIZE, getbaddrcb, &baddr, 0);
735         if (baddr) {
736                 int hc = VTOB_HASH_CODE(vaddr);
737                 vbp->vaddr = (m_addr_t) vaddr;
738                 vbp->baddr = (m_addr_t) baddr;
739                 vbp->next = mp->vtob[hc];
740                 mp->vtob[hc] = vbp;
741                 ++mp->nump;
742                 return (m_addr_t) vaddr;
743         }
744 out_err:
745         if (baddr)
746                 bus_dmamap_unload(mp->dmat, vbp->dmamap);
747         if (vaddr)
748                 bus_dmamem_free(mp->dmat, vaddr, vbp->dmamap);
749         if (vbp->dmamap)
750                 bus_dmamap_destroy(mp->dmat, vbp->dmamap);
751         if (vbp)
752                 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
753         return 0;
754 }
755
756 #ifdef  MEMO_FREE_UNUSED
757 static void ___dma_freep(m_pool_s *mp, m_addr_t m)
758 {
759         m_vtob_s **vbpp, *vbp;
760         int hc = VTOB_HASH_CODE(m);
761
762         vbpp = &mp->vtob[hc];
763         while (*vbpp && (*vbpp)->vaddr != m)
764                 vbpp = &(*vbpp)->next;
765         if (*vbpp) {
766                 vbp = *vbpp;
767                 *vbpp = (*vbpp)->next;
768                 bus_dmamap_unload(mp->dmat, vbp->dmamap);
769                 bus_dmamem_free(mp->dmat, (void *) vbp->vaddr, vbp->dmamap);
770                 bus_dmamap_destroy(mp->dmat, vbp->dmamap);
771                 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
772                 --mp->nump;
773         }
774 }
775 #endif
776
777 static __inline m_pool_s *___get_dma_pool(bus_dma_tag_t dev_dmat)
778 {
779         m_pool_s *mp;
780         for (mp = mp0.next; mp && mp->dev_dmat != dev_dmat; mp = mp->next);
781         return mp;
782 }
783
784 static m_pool_s *___cre_dma_pool(bus_dma_tag_t dev_dmat)
785 {
786         m_pool_s *mp = 0;
787
788         mp = __sym_calloc(&mp0, sizeof(*mp), "MPOOL");
789         if (mp) {
790                 mp->dev_dmat = dev_dmat;
791                 if (!bus_dma_tag_create(dev_dmat, 1, MEMO_CLUSTER_SIZE,
792                                BUS_SPACE_MAXADDR_32BIT,
793                                BUS_SPACE_MAXADDR_32BIT,
794                                NULL, NULL, MEMO_CLUSTER_SIZE, 1,
795                                MEMO_CLUSTER_SIZE, 0, &mp->dmat)) {
796                         mp->getp = ___dma_getp;
797 #ifdef  MEMO_FREE_UNUSED
798                         mp->freep = ___dma_freep;
799 #endif
800                         mp->next = mp0.next;
801                         mp0.next = mp;
802                         return mp;
803                 }
804         }
805         if (mp)
806                 __sym_mfree(&mp0, mp, sizeof(*mp), "MPOOL");
807         return 0;
808 }
809
810 #ifdef  MEMO_FREE_UNUSED
811 static void ___del_dma_pool(m_pool_s *p)
812 {
813         struct m_pool **pp = &mp0.next;
814
815         while (*pp && *pp != p)
816                 pp = &(*pp)->next;
817         if (*pp) {
818                 *pp = (*pp)->next;
819                 bus_dma_tag_destroy(p->dmat);
820                 __sym_mfree(&mp0, p, sizeof(*p), "MPOOL");
821         }
822 }
823 #endif
824
825 static void *__sym_calloc_dma(bus_dma_tag_t dev_dmat, int size, char *name)
826 {
827         struct m_pool *mp;
828         void *m = 0;
829
830         /* Lock */
831         mp = ___get_dma_pool(dev_dmat);
832         if (!mp)
833                 mp = ___cre_dma_pool(dev_dmat);
834         if (mp)
835                 m = __sym_calloc(mp, size, name);
836 #ifdef  MEMO_FREE_UNUSED
837         if (mp && !mp->nump)
838                 ___del_dma_pool(mp);
839 #endif
840         /* Unlock */
841
842         return m;
843 }
844
845 static void 
846 __sym_mfree_dma(bus_dma_tag_t dev_dmat, void *m, int size, char *name)
847 {
848         struct m_pool *mp;
849
850         /* Lock */
851         mp = ___get_dma_pool(dev_dmat);
852         if (mp)
853                 __sym_mfree(mp, m, size, name);
854 #ifdef  MEMO_FREE_UNUSED
855         if (mp && !mp->nump)
856                 ___del_dma_pool(mp);
857 #endif
858         /* Unlock */
859 }
860
861 static m_addr_t __vtobus(bus_dma_tag_t dev_dmat, void *m)
862 {
863         m_pool_s *mp;
864         int hc = VTOB_HASH_CODE(m);
865         m_vtob_s *vp = 0;
866         m_addr_t a = ((m_addr_t) m) & ~MEMO_CLUSTER_MASK;
867
868         /* Lock */
869         mp = ___get_dma_pool(dev_dmat);
870         if (mp) {
871                 vp = mp->vtob[hc];
872                 while (vp && (m_addr_t) vp->vaddr != a)
873                         vp = vp->next;
874         }
875         /* Unlock */
876         if (!vp)
877                 panic("sym: VTOBUS FAILED!\n");
878         return vp ? vp->baddr + (((m_addr_t) m) - a) : 0;
879 }
880
881 #endif  /* FreeBSD_Bus_Dma_Abstraction */
882
883 /*
884  * Verbs for DMAable memory handling.
885  * The _uvptv_ macro avoids a nasty warning about pointer to volatile 
886  * being discarded.
887  */
888 #define _uvptv_(p) ((void *)((vm_offset_t)(p)))
889 #define _sym_calloc_dma(np, s, n)       __sym_calloc_dma(np->bus_dmat, s, n)
890 #define _sym_mfree_dma(np, p, s, n)     \
891                                 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), s, n)
892 #define sym_calloc_dma(s, n)            _sym_calloc_dma(np, s, n)
893 #define sym_mfree_dma(p, s, n)          _sym_mfree_dma(np, p, s, n)
894 #define _vtobus(np, p)                  __vtobus(np->bus_dmat, _uvptv_(p))
895 #define vtobus(p)                       _vtobus(np, p)
896
897
898 /*
899  *  Print a buffer in hexadecimal format.
900  */
901 static void sym_printb_hex (u_char *p, int n)
902 {
903         while (n-- > 0)
904                 printf (" %x", *p++);
905 }
906
907 /*
908  *  Same with a label at beginning and .\n at end.
909  */
910 static void sym_printl_hex (char *label, u_char *p, int n)
911 {
912         printf ("%s", label);
913         sym_printb_hex (p, n);
914         printf (".\n");
915 }
916
917 /*
918  *  Return a string for SCSI BUS mode.
919  */
920 static char *sym_scsi_bus_mode(int mode)
921 {
922         switch(mode) {
923         case SMODE_HVD: return "HVD";
924         case SMODE_SE:  return "SE";
925         case SMODE_LVD: return "LVD";
926         }
927         return "??";
928 }
929
930 /*
931  *  Some poor and bogus sync table that refers to Tekram NVRAM layout.
932  */
933 #ifdef SYM_CONF_NVRAM_SUPPORT
934 static u_char Tekram_sync[16] =
935         {25,31,37,43, 50,62,75,125, 12,15,18,21, 6,7,9,10};
936 #endif
937
938 /*
939  *  Union of supported NVRAM formats.
940  */
941 struct sym_nvram {
942         int type;
943 #define SYM_SYMBIOS_NVRAM       (1)
944 #define SYM_TEKRAM_NVRAM        (2)
945 #ifdef  SYM_CONF_NVRAM_SUPPORT
946         union {
947                 Symbios_nvram Symbios;
948                 Tekram_nvram Tekram;
949         } data;
950 #endif
951 };
952
953 /*
954  *  This one is hopefully useless, but actually useful. :-)
955  */
956 #ifndef assert
957 #define assert(expression) { \
958         if (!(expression)) { \
959                 (void)panic( \
960                         "assertion \"%s\" failed: file \"%s\", line %d\n", \
961                         #expression, \
962                         __FILE__, __LINE__); \
963         } \
964 }
965 #endif
966
967 /*
968  *  Some provision for a possible big endian mode supported by 
969  *  Symbios chips (never seen, by the way).
970  *  For now, this stuff does not deserve any comments. :)
971  */
972
973 #define sym_offb(o)     (o)
974 #define sym_offw(o)     (o)
975
976 /*
977  *  Some provision for support for BIG ENDIAN CPU.
978  *  Btw, FreeBSD does not seem to be ready yet for big endian.
979  */
980
981 #if     BYTE_ORDER == BIG_ENDIAN
982 #define cpu_to_scr(dw)  _htole32(dw)
983 #define scr_to_cpu(dw)  _le32toh(dw)
984 #else
985 #define cpu_to_scr(dw)  (dw)
986 #define scr_to_cpu(dw)  (dw)
987 #endif
988
989 /*
990  *  Access to the chip IO registers and on-chip RAM.
991  *  We use the `bus space' interface under FreeBSD-4 and 
992  *  later kernel versions.
993  */
994
995 #ifdef  FreeBSD_Bus_Space_Abstraction
996
997 #if defined(SYM_CONF_IOMAPPED)
998
999 #define INB_OFF(o)      bus_space_read_1(np->io_tag, np->io_bsh, o)
1000 #define INW_OFF(o)      bus_space_read_2(np->io_tag, np->io_bsh, o)
1001 #define INL_OFF(o)      bus_space_read_4(np->io_tag, np->io_bsh, o)
1002
1003 #define OUTB_OFF(o, v)  bus_space_write_1(np->io_tag, np->io_bsh, o, (v))
1004 #define OUTW_OFF(o, v)  bus_space_write_2(np->io_tag, np->io_bsh, o, (v))
1005 #define OUTL_OFF(o, v)  bus_space_write_4(np->io_tag, np->io_bsh, o, (v))
1006
1007 #else   /* Memory mapped IO */
1008
1009 #define INB_OFF(o)      bus_space_read_1(np->mmio_tag, np->mmio_bsh, o)
1010 #define INW_OFF(o)      bus_space_read_2(np->mmio_tag, np->mmio_bsh, o)
1011 #define INL_OFF(o)      bus_space_read_4(np->mmio_tag, np->mmio_bsh, o)
1012
1013 #define OUTB_OFF(o, v)  bus_space_write_1(np->mmio_tag, np->mmio_bsh, o, (v))
1014 #define OUTW_OFF(o, v)  bus_space_write_2(np->mmio_tag, np->mmio_bsh, o, (v))
1015 #define OUTL_OFF(o, v)  bus_space_write_4(np->mmio_tag, np->mmio_bsh, o, (v))
1016
1017 #endif  /* SYM_CONF_IOMAPPED */
1018
1019 #define OUTRAM_OFF(o, a, l)     \
1020         bus_space_write_region_1(np->ram_tag, np->ram_bsh, o, (a), (l))
1021
1022 #else   /* not defined FreeBSD_Bus_Space_Abstraction */
1023
1024 #if     BYTE_ORDER == BIG_ENDIAN
1025 #error  "BIG ENDIAN support requires bus space kernel interface"
1026 #endif
1027
1028 /*
1029  *  Access to the chip IO registers and on-chip RAM.
1030  *  We use legacy MMIO and IO interface for FreeBSD 3.X versions.
1031  */
1032
1033 /*
1034  *  Define some understable verbs for IO and MMIO.
1035  */
1036 #define io_read8(p)      scr_to_cpu(inb((p)))
1037 #define io_read16(p)     scr_to_cpu(inw((p)))
1038 #define io_read32(p)     scr_to_cpu(inl((p)))
1039 #define io_write8(p, v)  outb((p), cpu_to_scr(v))
1040 #define io_write16(p, v) outw((p), cpu_to_scr(v))
1041 #define io_write32(p, v) outl((p), cpu_to_scr(v))
1042
1043 #ifdef  __alpha__
1044
1045 #define mmio_read8(a)        readb(a)
1046 #define mmio_read16(a)       readw(a)
1047 #define mmio_read32(a)       readl(a)
1048 #define mmio_write8(a, b)    writeb(a, b)
1049 #define mmio_write16(a, b)   writew(a, b)
1050 #define mmio_write32(a, b)   writel(a, b)
1051 #define memcpy_to_pci(d, s, n)  memcpy_toio((u32)(d), (void *)(s), (n))
1052
1053 #else /*__i386__, __sparc64__*/
1054
1055 #define mmio_read8(a)        scr_to_cpu((*(volatile unsigned char *) (a)))
1056 #define mmio_read16(a)       scr_to_cpu((*(volatile unsigned short *) (a)))
1057 #define mmio_read32(a)       scr_to_cpu((*(volatile unsigned int *) (a)))
1058 #define mmio_write8(a, b)   (*(volatile unsigned char *) (a)) = cpu_to_scr(b)
1059 #define mmio_write16(a, b)  (*(volatile unsigned short *) (a)) = cpu_to_scr(b)
1060 #define mmio_write32(a, b)  (*(volatile unsigned int *) (a)) = cpu_to_scr(b)
1061 #define memcpy_to_pci(d, s, n)  bcopy((s), (void *)(d), (n))
1062
1063 #endif
1064
1065 /*
1066  *  Normal IO
1067  */
1068 #if defined(SYM_CONF_IOMAPPED)
1069
1070 #define INB_OFF(o)      io_read8(np->io_port + sym_offb(o))
1071 #define OUTB_OFF(o, v)  io_write8(np->io_port + sym_offb(o), (v))
1072
1073 #define INW_OFF(o)      io_read16(np->io_port + sym_offw(o))
1074 #define OUTW_OFF(o, v)  io_write16(np->io_port + sym_offw(o), (v))
1075
1076 #define INL_OFF(o)      io_read32(np->io_port + (o))
1077 #define OUTL_OFF(o, v)  io_write32(np->io_port + (o), (v))
1078
1079 #else   /* Memory mapped IO */
1080
1081 #define INB_OFF(o)      mmio_read8(np->mmio_va + sym_offb(o))
1082 #define OUTB_OFF(o, v)  mmio_write8(np->mmio_va + sym_offb(o), (v))
1083
1084 #define INW_OFF(o)      mmio_read16(np->mmio_va + sym_offw(o))
1085 #define OUTW_OFF(o, v)  mmio_write16(np->mmio_va + sym_offw(o), (v))
1086
1087 #define INL_OFF(o)      mmio_read32(np->mmio_va + (o))
1088 #define OUTL_OFF(o, v)  mmio_write32(np->mmio_va + (o), (v))
1089
1090 #endif
1091
1092 #define OUTRAM_OFF(o, a, l) memcpy_to_pci(np->ram_va + (o), (a), (l))
1093
1094 #endif  /* FreeBSD_Bus_Space_Abstraction */
1095
1096 /*
1097  *  Common definitions for both bus space and legacy IO methods.
1098  */
1099 #define INB(r)          INB_OFF(offsetof(struct sym_reg,r))
1100 #define INW(r)          INW_OFF(offsetof(struct sym_reg,r))
1101 #define INL(r)          INL_OFF(offsetof(struct sym_reg,r))
1102
1103 #define OUTB(r, v)      OUTB_OFF(offsetof(struct sym_reg,r), (v))
1104 #define OUTW(r, v)      OUTW_OFF(offsetof(struct sym_reg,r), (v))
1105 #define OUTL(r, v)      OUTL_OFF(offsetof(struct sym_reg,r), (v))
1106
1107 #define OUTONB(r, m)    OUTB(r, INB(r) | (m))
1108 #define OUTOFFB(r, m)   OUTB(r, INB(r) & ~(m))
1109 #define OUTONW(r, m)    OUTW(r, INW(r) | (m))
1110 #define OUTOFFW(r, m)   OUTW(r, INW(r) & ~(m))
1111 #define OUTONL(r, m)    OUTL(r, INL(r) | (m))
1112 #define OUTOFFL(r, m)   OUTL(r, INL(r) & ~(m))
1113
1114 /*
1115  *  We normally want the chip to have a consistent view
1116  *  of driver internal data structures when we restart it.
1117  *  Thus these macros.
1118  */
1119 #define OUTL_DSP(v)                             \
1120         do {                                    \
1121                 MEMORY_BARRIER();               \
1122                 OUTL (nc_dsp, (v));             \
1123         } while (0)
1124
1125 #define OUTONB_STD()                            \
1126         do {                                    \
1127                 MEMORY_BARRIER();               \
1128                 OUTONB (nc_dcntl, (STD|NOCOM)); \
1129         } while (0)
1130
1131 /*
1132  *  Command control block states.
1133  */
1134 #define HS_IDLE         (0)
1135 #define HS_BUSY         (1)
1136 #define HS_NEGOTIATE    (2)     /* sync/wide data transfer*/
1137 #define HS_DISCONNECT   (3)     /* Disconnected by target */
1138 #define HS_WAIT         (4)     /* waiting for resource   */
1139
1140 #define HS_DONEMASK     (0x80)
1141 #define HS_COMPLETE     (4|HS_DONEMASK)
1142 #define HS_SEL_TIMEOUT  (5|HS_DONEMASK) /* Selection timeout      */
1143 #define HS_UNEXPECTED   (6|HS_DONEMASK) /* Unexpected disconnect  */
1144 #define HS_COMP_ERR     (7|HS_DONEMASK) /* Completed with error   */
1145
1146 /*
1147  *  Software Interrupt Codes
1148  */
1149 #define SIR_BAD_SCSI_STATUS     (1)
1150 #define SIR_SEL_ATN_NO_MSG_OUT  (2)
1151 #define SIR_MSG_RECEIVED        (3)
1152 #define SIR_MSG_WEIRD           (4)
1153 #define SIR_NEGO_FAILED         (5)
1154 #define SIR_NEGO_PROTO          (6)
1155 #define SIR_SCRIPT_STOPPED      (7)
1156 #define SIR_REJECT_TO_SEND      (8)
1157 #define SIR_SWIDE_OVERRUN       (9)
1158 #define SIR_SODL_UNDERRUN       (10)
1159 #define SIR_RESEL_NO_MSG_IN     (11)
1160 #define SIR_RESEL_NO_IDENTIFY   (12)
1161 #define SIR_RESEL_BAD_LUN       (13)
1162 #define SIR_TARGET_SELECTED     (14)
1163 #define SIR_RESEL_BAD_I_T_L     (15)
1164 #define SIR_RESEL_BAD_I_T_L_Q   (16)
1165 #define SIR_ABORT_SENT          (17)
1166 #define SIR_RESEL_ABORTED       (18)
1167 #define SIR_MSG_OUT_DONE        (19)
1168 #define SIR_COMPLETE_ERROR      (20)
1169 #define SIR_DATA_OVERRUN        (21)
1170 #define SIR_BAD_PHASE           (22)
1171 #define SIR_MAX                 (22)
1172
1173 /*
1174  *  Extended error bit codes.
1175  *  xerr_status field of struct sym_ccb.
1176  */
1177 #define XE_EXTRA_DATA   (1)     /* unexpected data phase         */
1178 #define XE_BAD_PHASE    (1<<1)  /* illegal phase (4/5)           */
1179 #define XE_PARITY_ERR   (1<<2)  /* unrecovered SCSI parity error */
1180 #define XE_SODL_UNRUN   (1<<3)  /* ODD transfer in DATA OUT phase */
1181 #define XE_SWIDE_OVRUN  (1<<4)  /* ODD transfer in DATA IN phase */
1182
1183 /*
1184  *  Negotiation status.
1185  *  nego_status field of struct sym_ccb.
1186  */
1187 #define NS_SYNC         (1)
1188 #define NS_WIDE         (2)
1189 #define NS_PPR          (3)
1190
1191 /*
1192  *  A CCB hashed table is used to retrieve CCB address 
1193  *  from DSA value.
1194  */
1195 #define CCB_HASH_SHIFT          8
1196 #define CCB_HASH_SIZE           (1UL << CCB_HASH_SHIFT)
1197 #define CCB_HASH_MASK           (CCB_HASH_SIZE-1)
1198 #define CCB_HASH_CODE(dsa)      (((dsa) >> 9) & CCB_HASH_MASK)
1199
1200 /*
1201  *  Device flags.
1202  */
1203 #define SYM_DISC_ENABLED        (1)
1204 #define SYM_TAGS_ENABLED        (1<<1)
1205 #define SYM_SCAN_BOOT_DISABLED  (1<<2)
1206 #define SYM_SCAN_LUNS_DISABLED  (1<<3)
1207
1208 /*
1209  *  Host adapter miscellaneous flags.
1210  */
1211 #define SYM_AVOID_BUS_RESET     (1)
1212 #define SYM_SCAN_TARGETS_HILO   (1<<1)
1213
1214 /*
1215  *  Device quirks.
1216  *  Some devices, for example the CHEETAH 2 LVD, disconnects without 
1217  *  saving the DATA POINTER then reselects and terminates the IO.
1218  *  On reselection, the automatic RESTORE DATA POINTER makes the 
1219  *  CURRENT DATA POINTER not point at the end of the IO.
1220  *  This behaviour just breaks our calculation of the residual.
1221  *  For now, we just force an AUTO SAVE on disconnection and will 
1222  *  fix that in a further driver version.
1223  */
1224 #define SYM_QUIRK_AUTOSAVE 1
1225
1226 /*
1227  *  Misc.
1228  */
1229 #define SYM_SNOOP_TIMEOUT (10000000)
1230 #define SYM_PCI_IO      PCIR_MAPS
1231 #define SYM_PCI_MMIO    (PCIR_MAPS + 4)
1232 #define SYM_PCI_RAM     (PCIR_MAPS + 8)
1233 #define SYM_PCI_RAM64   (PCIR_MAPS + 12)
1234
1235 /*
1236  *  Back-pointer from the CAM CCB to our data structures.
1237  */
1238 #define sym_hcb_ptr     spriv_ptr0
1239 /* #define sym_ccb_ptr  spriv_ptr1 */
1240
1241 /*
1242  *  We mostly have to deal with pointers.
1243  *  Thus these typedef's.
1244  */
1245 typedef struct sym_tcb *tcb_p;
1246 typedef struct sym_lcb *lcb_p;
1247 typedef struct sym_ccb *ccb_p;
1248 typedef struct sym_hcb *hcb_p;
1249
1250 /*
1251  *  Gather negotiable parameters value
1252  */
1253 struct sym_trans {
1254 #ifdef  FreeBSD_New_Tran_Settings
1255         u8 scsi_version;
1256         u8 spi_version;
1257 #endif
1258         u8 period;
1259         u8 offset;
1260         u8 width;
1261         u8 options;     /* PPR options */
1262 };
1263
1264 struct sym_tinfo {
1265         struct sym_trans current;
1266         struct sym_trans goal;
1267         struct sym_trans user;
1268 };
1269
1270 #define BUS_8_BIT       MSG_EXT_WDTR_BUS_8_BIT
1271 #define BUS_16_BIT      MSG_EXT_WDTR_BUS_16_BIT
1272
1273 /*
1274  *  Global TCB HEADER.
1275  *
1276  *  Due to lack of indirect addressing on earlier NCR chips,
1277  *  this substructure is copied from the TCB to a global 
1278  *  address after selection.
1279  *  For SYMBIOS chips that support LOAD/STORE this copy is 
1280  *  not needed and thus not performed.
1281  */
1282 struct sym_tcbh {
1283         /*
1284          *  Scripts bus addresses of LUN table accessed from scripts.
1285          *  LUN #0 is a special case, since multi-lun devices are rare, 
1286          *  and we we want to speed-up the general case and not waste 
1287          *  resources.
1288          */
1289         u32     luntbl_sa;      /* bus address of this table    */
1290         u32     lun0_sa;        /* bus address of LCB #0        */
1291         /*
1292          *  Actual SYNC/WIDE IO registers value for this target.
1293          *  'sval', 'wval' and 'uval' are read from SCRIPTS and 
1294          *  so have alignment constraints.
1295          */
1296 /*0*/   u_char  uval;           /* -> SCNTL4 register           */
1297 /*1*/   u_char  sval;           /* -> SXFER  io register        */
1298 /*2*/   u_char  filler1;
1299 /*3*/   u_char  wval;           /* -> SCNTL3 io register        */
1300 };
1301
1302 /*
1303  *  Target Control Block
1304  */
1305 struct sym_tcb {
1306         /*
1307          *  TCB header.
1308          *  Assumed at offset 0.
1309          */
1310 /*0*/   struct sym_tcbh head;
1311
1312         /*
1313          *  LUN table used by the SCRIPTS processor.
1314          *  An array of bus addresses is used on reselection.
1315          */
1316         u32     *luntbl;        /* LCBs bus address table       */
1317
1318         /*
1319          *  LUN table used by the C code.
1320          */
1321         lcb_p   lun0p;          /* LCB of LUN #0 (usual case)   */
1322 #if SYM_CONF_MAX_LUN > 1
1323         lcb_p   *lunmp;         /* Other LCBs [1..MAX_LUN]      */
1324 #endif
1325
1326         /*
1327          *  Bitmap that tells about LUNs that succeeded at least 
1328          *  1 IO and therefore assumed to be a real device.
1329          *  Avoid useless allocation of the LCB structure.
1330          */
1331         u32     lun_map[(SYM_CONF_MAX_LUN+31)/32];
1332
1333         /*
1334          *  Bitmap that tells about LUNs that haven't yet an LCB 
1335          *  allocated (not discovered or LCB allocation failed).
1336          */
1337         u32     busy0_map[(SYM_CONF_MAX_LUN+31)/32];
1338
1339         /*
1340          *  Transfer capabilities (SIP)
1341          */
1342         struct sym_tinfo tinfo;
1343
1344         /*
1345          * Keep track of the CCB used for the negotiation in order
1346          * to ensure that only 1 negotiation is queued at a time.
1347          */
1348         ccb_p   nego_cp;        /* CCB used for the nego                */
1349
1350         /*
1351          *  Set when we want to reset the device.
1352          */
1353         u_char  to_reset;
1354
1355         /*
1356          *  Other user settable limits and options.
1357          *  These limits are read from the NVRAM if present.
1358          */
1359         u_char  usrflags;
1360         u_short usrtags;
1361 };
1362
1363 /*
1364  *  Global LCB HEADER.
1365  *
1366  *  Due to lack of indirect addressing on earlier NCR chips,
1367  *  this substructure is copied from the LCB to a global 
1368  *  address after selection.
1369  *  For SYMBIOS chips that support LOAD/STORE this copy is 
1370  *  not needed and thus not performed.
1371  */
1372 struct sym_lcbh {
1373         /*
1374          *  SCRIPTS address jumped by SCRIPTS on reselection.
1375          *  For not probed logical units, this address points to 
1376          *  SCRIPTS that deal with bad LU handling (must be at 
1377          *  offset zero of the LCB for that reason).
1378          */
1379 /*0*/   u32     resel_sa;
1380
1381         /*
1382          *  Task (bus address of a CCB) read from SCRIPTS that points 
1383          *  to the unique ITL nexus allowed to be disconnected.
1384          */
1385         u32     itl_task_sa;
1386
1387         /*
1388          *  Task table bus address (read from SCRIPTS).
1389          */
1390         u32     itlq_tbl_sa;
1391 };
1392
1393 /*
1394  *  Logical Unit Control Block
1395  */
1396 struct sym_lcb {
1397         /*
1398          *  TCB header.
1399          *  Assumed at offset 0.
1400          */
1401 /*0*/   struct sym_lcbh head;
1402
1403         /*
1404          *  Task table read from SCRIPTS that contains pointers to 
1405          *  ITLQ nexuses. The bus address read from SCRIPTS is 
1406          *  inside the header.
1407          */
1408         u32     *itlq_tbl;      /* Kernel virtual address       */
1409
1410         /*
1411          *  Busy CCBs management.
1412          */
1413         u_short busy_itlq;      /* Number of busy tagged CCBs   */
1414         u_short busy_itl;       /* Number of busy untagged CCBs */
1415
1416         /*
1417          *  Circular tag allocation buffer.
1418          */
1419         u_short ia_tag;         /* Tag allocation index         */
1420         u_short if_tag;         /* Tag release index            */
1421         u_char  *cb_tags;       /* Circular tags buffer         */
1422
1423         /*
1424          *  Set when we want to clear all tasks.
1425          */
1426         u_char to_clear;
1427
1428         /*
1429          *  Capabilities.
1430          */
1431         u_char  user_flags;
1432         u_char  current_flags;
1433 };
1434
1435 /*
1436  *  Action from SCRIPTS on a task.
1437  *  Is part of the CCB, but is also used separately to plug 
1438  *  error handling action to perform from SCRIPTS.
1439  */
1440 struct sym_actscr {
1441         u32     start;          /* Jumped by SCRIPTS after selection    */
1442         u32     restart;        /* Jumped by SCRIPTS on relection       */
1443 };
1444
1445 /*
1446  *  Phase mismatch context.
1447  *
1448  *  It is part of the CCB and is used as parameters for the 
1449  *  DATA pointer. We need two contexts to handle correctly the 
1450  *  SAVED DATA POINTER.
1451  */
1452 struct sym_pmc {
1453         struct  sym_tblmove sg; /* Updated interrupted SG block */
1454         u32     ret;            /* SCRIPT return address        */
1455 };
1456
1457 /*
1458  *  LUN control block lookup.
1459  *  We use a direct pointer for LUN #0, and a table of 
1460  *  pointers which is only allocated for devices that support 
1461  *  LUN(s) > 0.
1462  */
1463 #if SYM_CONF_MAX_LUN <= 1
1464 #define sym_lp(np, tp, lun) (!lun) ? (tp)->lun0p : 0
1465 #else
1466 #define sym_lp(np, tp, lun) \
1467         (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : 0
1468 #endif
1469
1470 /*
1471  *  Status are used by the host and the script processor.
1472  *
1473  *  The last four bytes (status[4]) are copied to the 
1474  *  scratchb register (declared as scr0..scr3) just after the 
1475  *  select/reselect, and copied back just after disconnecting.
1476  *  Inside the script the XX_REG are used.
1477  */
1478
1479 /*
1480  *  Last four bytes (script)
1481  */
1482 #define  QU_REG scr0
1483 #define  HS_REG scr1
1484 #define  HS_PRT nc_scr1
1485 #define  SS_REG scr2
1486 #define  SS_PRT nc_scr2
1487 #define  HF_REG scr3
1488 #define  HF_PRT nc_scr3
1489
1490 /*
1491  *  Last four bytes (host)
1492  */
1493 #define  actualquirks  phys.head.status[0]
1494 #define  host_status   phys.head.status[1]
1495 #define  ssss_status   phys.head.status[2]
1496 #define  host_flags    phys.head.status[3]
1497
1498 /*
1499  *  Host flags
1500  */
1501 #define HF_IN_PM0       1u
1502 #define HF_IN_PM1       (1u<<1)
1503 #define HF_ACT_PM       (1u<<2)
1504 #define HF_DP_SAVED     (1u<<3)
1505 #define HF_SENSE        (1u<<4)
1506 #define HF_EXT_ERR      (1u<<5)
1507 #define HF_DATA_IN      (1u<<6)
1508 #ifdef SYM_CONF_IARB_SUPPORT
1509 #define HF_HINT_IARB    (1u<<7)
1510 #endif
1511
1512 /*
1513  *  Global CCB HEADER.
1514  *
1515  *  Due to lack of indirect addressing on earlier NCR chips,
1516  *  this substructure is copied from the ccb to a global 
1517  *  address after selection (or reselection) and copied back 
1518  *  before disconnect.
1519  *  For SYMBIOS chips that support LOAD/STORE this copy is 
1520  *  not needed and thus not performed.
1521  */
1522
1523 struct sym_ccbh {
1524         /*
1525          *  Start and restart SCRIPTS addresses (must be at 0).
1526          */
1527 /*0*/   struct sym_actscr go;
1528
1529         /*
1530          *  SCRIPTS jump address that deal with data pointers.
1531          *  'savep' points to the position in the script responsible 
1532          *  for the actual transfer of data.
1533          *  It's written on reception of a SAVE_DATA_POINTER message.
1534          */
1535         u32     savep;          /* Jump address to saved data pointer   */
1536         u32     lastp;          /* SCRIPTS address at end of data       */
1537         u32     goalp;          /* Not accessed for now from SCRIPTS    */
1538
1539         /*
1540          *  Status fields.
1541          */
1542         u8      status[4];
1543 };
1544
1545 /*
1546  *  Data Structure Block
1547  *
1548  *  During execution of a ccb by the script processor, the 
1549  *  DSA (data structure address) register points to this 
1550  *  substructure of the ccb.
1551  */
1552 struct sym_dsb {
1553         /*
1554          *  CCB header.
1555          *  Also assumed at offset 0 of the sym_ccb structure.
1556          */
1557 /*0*/   struct sym_ccbh head;
1558
1559         /*
1560          *  Phase mismatch contexts.
1561          *  We need two to handle correctly the SAVED DATA POINTER.
1562          *  MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic 
1563          *  for address calculation from SCRIPTS.
1564          */
1565         struct sym_pmc pm0;
1566         struct sym_pmc pm1;
1567
1568         /*
1569          *  Table data for Script
1570          */
1571         struct sym_tblsel  select;
1572         struct sym_tblmove smsg;
1573         struct sym_tblmove smsg_ext;
1574         struct sym_tblmove cmd;
1575         struct sym_tblmove sense;
1576         struct sym_tblmove wresid;
1577         struct sym_tblmove data [SYM_CONF_MAX_SG];
1578 };
1579
1580 /*
1581  *  Our Command Control Block
1582  */
1583 struct sym_ccb {
1584         /*
1585          *  This is the data structure which is pointed by the DSA 
1586          *  register when it is executed by the script processor.
1587          *  It must be the first entry.
1588          */
1589         struct sym_dsb phys;
1590
1591         /*
1592          *  Pointer to CAM ccb and related stuff.
1593          */
1594         union ccb *cam_ccb;     /* CAM scsiio ccb               */
1595         u8      cdb_buf[16];    /* Copy of CDB                  */
1596         u8      *sns_bbuf;      /* Bounce buffer for sense data */
1597 #define SYM_SNS_BBUF_LEN        sizeof(struct scsi_sense_data)
1598         int     data_len;       /* Total data length            */
1599         int     segments;       /* Number of SG segments        */
1600
1601         /*
1602          *  Miscellaneous status'.
1603          */
1604         u_char  nego_status;    /* Negotiation status           */
1605         u_char  xerr_status;    /* Extended error flags         */
1606         u32     extra_bytes;    /* Extraneous bytes transferred */
1607
1608         /*
1609          *  Message areas.
1610          *  We prepare a message to be sent after selection.
1611          *  We may use a second one if the command is rescheduled 
1612          *  due to CHECK_CONDITION or COMMAND TERMINATED.
1613          *  Contents are IDENTIFY and SIMPLE_TAG.
1614          *  While negotiating sync or wide transfer,
1615          *  a SDTR or WDTR message is appended.
1616          */
1617         u_char  scsi_smsg [12];
1618         u_char  scsi_smsg2[12];
1619
1620         /*
1621          *  Auto request sense related fields.
1622          */
1623         u_char  sensecmd[6];    /* Request Sense command        */
1624         u_char  sv_scsi_status; /* Saved SCSI status            */
1625         u_char  sv_xerr_status; /* Saved extended status        */
1626         int     sv_resid;       /* Saved residual               */
1627
1628         /*
1629          *  Map for the DMA of user data.
1630          */
1631 #ifdef  FreeBSD_Bus_Dma_Abstraction
1632         void            *arg;   /* Argument for some callback   */
1633         bus_dmamap_t    dmamap; /* DMA map for user data        */
1634         u_char          dmamapped;
1635 #define SYM_DMA_NONE    0
1636 #define SYM_DMA_READ    1
1637 #define SYM_DMA_WRITE   2
1638 #endif
1639         /*
1640          *  Other fields.
1641          */
1642         u32     ccb_ba;         /* BUS address of this CCB      */
1643         u_short tag;            /* Tag for this transfer        */
1644                                 /*  NO_TAG means no tag         */
1645         u_char  target;
1646         u_char  lun;
1647         ccb_p   link_ccbh;      /* Host adapter CCB hash chain  */
1648         SYM_QUEHEAD
1649                 link_ccbq;      /* Link to free/busy CCB queue  */
1650         u32     startp;         /* Initial data pointer         */
1651         int     ext_sg;         /* Extreme data pointer, used   */
1652         int     ext_ofs;        /*  to calculate the residual.  */
1653         u_char  to_abort;       /* Want this IO to be aborted   */
1654 };
1655
1656 #define CCB_BA(cp,lbl)  (cp->ccb_ba + offsetof(struct sym_ccb, lbl))
1657
1658 /*
1659  *  Host Control Block
1660  */
1661 struct sym_hcb {
1662         /*
1663          *  Global headers.
1664          *  Due to poorness of addressing capabilities, earlier 
1665          *  chips (810, 815, 825) copy part of the data structures 
1666          *  (CCB, TCB and LCB) in fixed areas.
1667          */
1668 #ifdef  SYM_CONF_GENERIC_SUPPORT
1669         struct sym_ccbh ccb_head;
1670         struct sym_tcbh tcb_head;
1671         struct sym_lcbh lcb_head;
1672 #endif
1673         /*
1674          *  Idle task and invalid task actions and 
1675          *  their bus addresses.
1676          */
1677         struct sym_actscr idletask, notask, bad_itl, bad_itlq;
1678         vm_offset_t idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
1679
1680         /*
1681          *  Dummy lun table to protect us against target 
1682          *  returning bad lun number on reselection.
1683          */
1684         u32     *badluntbl;     /* Table physical address       */
1685         u32     badlun_sa;      /* SCRIPT handler BUS address   */
1686
1687         /*
1688          *  Bus address of this host control block.
1689          */
1690         u32     hcb_ba;
1691
1692         /*
1693          *  Bit 32-63 of the on-chip RAM bus address in LE format.
1694          *  The START_RAM64 script loads the MMRS and MMWS from this 
1695          *  field.
1696          */
1697         u32     scr_ram_seg;
1698
1699         /*
1700          *  Chip and controller indentification.
1701          */
1702 #ifdef FreeBSD_Bus_Io_Abstraction
1703         device_t device;
1704 #else
1705         pcici_t pci_tag;
1706 #endif
1707         int     unit;
1708         char    inst_name[8];
1709
1710         /*
1711          *  Initial value of some IO register bits.
1712          *  These values are assumed to have been set by BIOS, and may 
1713          *  be used to probe adapter implementation differences.
1714          */
1715         u_char  sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
1716                 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
1717                 sv_stest1;
1718
1719         /*
1720          *  Actual initial value of IO register bits used by the 
1721          *  driver. They are loaded at initialisation according to  
1722          *  features that are to be enabled/disabled.
1723          */
1724         u_char  rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4, 
1725                 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
1726
1727         /*
1728          *  Target data.
1729          */
1730         struct sym_tcb  target[SYM_CONF_MAX_TARGET];
1731
1732         /*
1733          *  Target control block bus address array used by the SCRIPT 
1734          *  on reselection.
1735          */
1736         u32             *targtbl;
1737         u32             targtbl_ba;
1738
1739         /*
1740          *  CAM SIM information for this instance.
1741          */
1742         struct          cam_sim  *sim;
1743         struct          cam_path *path;
1744
1745         /*
1746          *  Allocated hardware resources.
1747          */
1748 #ifdef FreeBSD_Bus_Io_Abstraction
1749         struct resource *irq_res;
1750         struct resource *io_res;
1751         struct resource *mmio_res;
1752         struct resource *ram_res;
1753         int             ram_id;
1754         void *intr;
1755 #endif
1756
1757         /*
1758          *  Bus stuff.
1759          *
1760          *  My understanding of PCI is that all agents must share the 
1761          *  same addressing range and model.
1762          *  But some hardware architecture guys provide complex and  
1763          *  brain-deaded stuff that makes shit.
1764          *  This driver only support PCI compliant implementations and 
1765          *  deals with part of the BUS stuff complexity only to fit O/S 
1766          *  requirements.
1767          */
1768 #ifdef FreeBSD_Bus_Io_Abstraction
1769         bus_space_handle_t      io_bsh;
1770         bus_space_tag_t         io_tag;
1771         bus_space_handle_t      mmio_bsh;
1772         bus_space_tag_t         mmio_tag;
1773         bus_space_handle_t      ram_bsh;
1774         bus_space_tag_t         ram_tag;
1775 #endif
1776
1777         /*
1778          *  DMA stuff.
1779          */
1780 #ifdef  FreeBSD_Bus_Dma_Abstraction
1781         bus_dma_tag_t   bus_dmat;       /* DMA tag from parent BUS      */
1782         bus_dma_tag_t   data_dmat;      /* DMA tag for user data        */
1783 #endif
1784         /*
1785          *  Virtual and physical bus addresses of the chip.
1786          */
1787         vm_offset_t     mmio_va;        /* MMIO kernel virtual address  */
1788         vm_offset_t     mmio_pa;        /* MMIO CPU physical address    */
1789         vm_offset_t     mmio_ba;        /* MMIO BUS address             */
1790         int             mmio_ws;        /* MMIO Window size             */
1791
1792         vm_offset_t     ram_va;         /* RAM kernel virtual address   */
1793         vm_offset_t     ram_pa;         /* RAM CPU physical address     */
1794         vm_offset_t     ram_ba;         /* RAM BUS address              */
1795         int             ram_ws;         /* RAM window size              */
1796         u32             io_port;        /* IO port address              */
1797
1798         /*
1799          *  SCRIPTS virtual and physical bus addresses.
1800          *  'script'  is loaded in the on-chip RAM if present.
1801          *  'scripth' stays in main memory for all chips except the 
1802          *  53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
1803          */
1804         u_char          *scripta0;      /* Copies of script and scripth */
1805         u_char          *scriptb0;      /* Copies of script and scripth */
1806         vm_offset_t     scripta_ba;     /* Actual script and scripth    */
1807         vm_offset_t     scriptb_ba;     /*  bus addresses.              */
1808         vm_offset_t     scriptb0_ba;
1809         u_short         scripta_sz;     /* Actual size of script A      */
1810         u_short         scriptb_sz;     /* Actual size of script B      */
1811
1812         /*
1813          *  Bus addresses, setup and patch methods for 
1814          *  the selected firmware.
1815          */
1816         struct sym_fwa_ba fwa_bas;      /* Useful SCRIPTA bus addresses */
1817         struct sym_fwb_ba fwb_bas;      /* Useful SCRIPTB bus addresses */
1818         void            (*fw_setup)(hcb_p np, struct sym_fw *fw);
1819         void            (*fw_patch)(hcb_p np);
1820         char            *fw_name;
1821
1822         /*
1823          *  General controller parameters and configuration.
1824          */
1825         u_short device_id;      /* PCI device id                */
1826         u_char  revision_id;    /* PCI device revision id       */
1827         u_int   features;       /* Chip features map            */
1828         u_char  myaddr;         /* SCSI id of the adapter       */
1829         u_char  maxburst;       /* log base 2 of dwords burst   */
1830         u_char  maxwide;        /* Maximum transfer width       */
1831         u_char  minsync;        /* Min sync period factor (ST)  */
1832         u_char  maxsync;        /* Max sync period factor (ST)  */
1833         u_char  maxoffs;        /* Max scsi offset        (ST)  */
1834         u_char  minsync_dt;     /* Min sync period factor (DT)  */
1835         u_char  maxsync_dt;     /* Max sync period factor (DT)  */
1836         u_char  maxoffs_dt;     /* Max scsi offset        (DT)  */
1837         u_char  multiplier;     /* Clock multiplier (1,2,4)     */
1838         u_char  clock_divn;     /* Number of clock divisors     */
1839         u32     clock_khz;      /* SCSI clock frequency in KHz  */
1840         u32     pciclk_khz;     /* Estimated PCI clock  in KHz  */
1841         /*
1842          *  Start queue management.
1843          *  It is filled up by the host processor and accessed by the 
1844          *  SCRIPTS processor in order to start SCSI commands.
1845          */
1846         volatile                /* Prevent code optimizations   */
1847         u32     *squeue;        /* Start queue virtual address  */
1848         u32     squeue_ba;      /* Start queue BUS address      */
1849         u_short squeueput;      /* Next free slot of the queue  */
1850         u_short actccbs;        /* Number of allocated CCBs     */
1851
1852         /*
1853          *  Command completion queue.
1854          *  It is the same size as the start queue to avoid overflow.
1855          */
1856         u_short dqueueget;      /* Next position to scan        */
1857         volatile                /* Prevent code optimizations   */
1858         u32     *dqueue;        /* Completion (done) queue      */
1859         u32     dqueue_ba;      /* Done queue BUS address       */
1860
1861         /*
1862          *  Miscellaneous buffers accessed by the scripts-processor.
1863          *  They shall be DWORD aligned, because they may be read or 
1864          *  written with a script command.
1865          */
1866         u_char          msgout[8];      /* Buffer for MESSAGE OUT       */
1867         u_char          msgin [8];      /* Buffer for MESSAGE IN        */
1868         u32             lastmsg;        /* Last SCSI message sent       */
1869         u_char          scratch;        /* Scratch for SCSI receive     */
1870
1871         /*
1872          *  Miscellaneous configuration and status parameters.
1873          */
1874         u_char          usrflags;       /* Miscellaneous user flags     */
1875         u_char          scsi_mode;      /* Current SCSI BUS mode        */
1876         u_char          verbose;        /* Verbosity for this controller*/
1877         u32             cache;          /* Used for cache test at init. */
1878
1879         /*
1880          *  CCB lists and queue.
1881          */
1882         ccb_p ccbh[CCB_HASH_SIZE];      /* CCB hashed by DSA value      */
1883         SYM_QUEHEAD     free_ccbq;      /* Queue of available CCBs      */
1884         SYM_QUEHEAD     busy_ccbq;      /* Queue of busy CCBs           */
1885
1886         /*
1887          *  During error handling and/or recovery,
1888          *  active CCBs that are to be completed with 
1889          *  error or requeued are moved from the busy_ccbq
1890          *  to the comp_ccbq prior to completion.
1891          */
1892         SYM_QUEHEAD     comp_ccbq;
1893
1894         /*
1895          *  CAM CCB pending queue.
1896          */
1897         SYM_QUEHEAD     cam_ccbq;
1898
1899         /*
1900          *  IMMEDIATE ARBITRATION (IARB) control.
1901          *
1902          *  We keep track in 'last_cp' of the last CCB that has been 
1903          *  queued to the SCRIPTS processor and clear 'last_cp' when 
1904          *  this CCB completes. If last_cp is not zero at the moment 
1905          *  we queue a new CCB, we set a flag in 'last_cp' that is 
1906          *  used by the SCRIPTS as a hint for setting IARB.
1907          *  We donnot set more than 'iarb_max' consecutive hints for 
1908          *  IARB in order to leave devices a chance to reselect.
1909          *  By the way, any non zero value of 'iarb_max' is unfair. :)
1910          */
1911 #ifdef SYM_CONF_IARB_SUPPORT
1912         u_short         iarb_max;       /* Max. # consecutive IARB hints*/
1913         u_short         iarb_count;     /* Actual # of these hints      */
1914         ccb_p           last_cp;
1915 #endif
1916
1917         /*
1918          *  Command abort handling.
1919          *  We need to synchronize tightly with the SCRIPTS 
1920          *  processor in order to handle things correctly.
1921          */
1922         u_char          abrt_msg[4];    /* Message to send buffer       */
1923         struct sym_tblmove abrt_tbl;    /* Table for the MOV of it      */
1924         struct sym_tblsel  abrt_sel;    /* Sync params for selection    */
1925         u_char          istat_sem;      /* Tells the chip to stop (SEM) */
1926 };
1927
1928 #define HCB_BA(np, lbl)     (np->hcb_ba      + offsetof(struct sym_hcb, lbl))
1929
1930 /*
1931  *  Return the name of the controller.
1932  */
1933 static __inline char *sym_name(hcb_p np)
1934 {
1935         return np->inst_name;
1936 }
1937
1938 /*--------------------------------------------------------------------------*/
1939 /*------------------------------ FIRMWARES ---------------------------------*/
1940 /*--------------------------------------------------------------------------*/
1941
1942 /*
1943  *  This stuff will be moved to a separate source file when
1944  *  the driver will be broken into several source modules.
1945  */
1946
1947 /*
1948  *  Macros used for all firmwares.
1949  */
1950 #define SYM_GEN_A(s, label)     ((short) offsetof(s, label)),
1951 #define SYM_GEN_B(s, label)     ((short) offsetof(s, label)),
1952 #define PADDR_A(label)          SYM_GEN_PADDR_A(struct SYM_FWA_SCR, label)
1953 #define PADDR_B(label)          SYM_GEN_PADDR_B(struct SYM_FWB_SCR, label)
1954
1955
1956 #ifdef  SYM_CONF_GENERIC_SUPPORT
1957 /*
1958  *  Allocate firmware #1 script area.
1959  */
1960 #define SYM_FWA_SCR             sym_fw1a_scr
1961 #define SYM_FWB_SCR             sym_fw1b_scr
1962 #include <dev/sym/sym_fw1.h>
1963 struct sym_fwa_ofs sym_fw1a_ofs = {
1964         SYM_GEN_FW_A(struct SYM_FWA_SCR)
1965 };
1966 struct sym_fwb_ofs sym_fw1b_ofs = {
1967         SYM_GEN_FW_B(struct SYM_FWB_SCR)
1968 };
1969 #undef  SYM_FWA_SCR
1970 #undef  SYM_FWB_SCR
1971 #endif  /* SYM_CONF_GENERIC_SUPPORT */
1972
1973 /*
1974  *  Allocate firmware #2 script area.
1975  */
1976 #define SYM_FWA_SCR             sym_fw2a_scr
1977 #define SYM_FWB_SCR             sym_fw2b_scr
1978 #include <dev/sym/sym_fw2.h>
1979 struct sym_fwa_ofs sym_fw2a_ofs = {
1980         SYM_GEN_FW_A(struct SYM_FWA_SCR)
1981 };
1982 struct sym_fwb_ofs sym_fw2b_ofs = {
1983         SYM_GEN_FW_B(struct SYM_FWB_SCR)
1984         SYM_GEN_B(struct SYM_FWB_SCR, start64)
1985         SYM_GEN_B(struct SYM_FWB_SCR, pm_handle)
1986 };
1987 #undef  SYM_FWA_SCR
1988 #undef  SYM_FWB_SCR
1989
1990 #undef  SYM_GEN_A
1991 #undef  SYM_GEN_B
1992 #undef  PADDR_A
1993 #undef  PADDR_B
1994
1995 #ifdef  SYM_CONF_GENERIC_SUPPORT
1996 /*
1997  *  Patch routine for firmware #1.
1998  */
1999 static void
2000 sym_fw1_patch(hcb_p np)
2001 {
2002         struct sym_fw1a_scr *scripta0;
2003         struct sym_fw1b_scr *scriptb0;
2004
2005         scripta0 = (struct sym_fw1a_scr *) np->scripta0;
2006         scriptb0 = (struct sym_fw1b_scr *) np->scriptb0;
2007
2008         /*
2009          *  Remove LED support if not needed.
2010          */
2011         if (!(np->features & FE_LED0)) {
2012                 scripta0->idle[0]       = cpu_to_scr(SCR_NO_OP);
2013                 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
2014                 scripta0->start[0]      = cpu_to_scr(SCR_NO_OP);
2015         }
2016
2017 #ifdef SYM_CONF_IARB_SUPPORT
2018         /*
2019          *    If user does not want to use IMMEDIATE ARBITRATION
2020          *    when we are reselected while attempting to arbitrate,
2021          *    patch the SCRIPTS accordingly with a SCRIPT NO_OP.
2022          */
2023         if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
2024                 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
2025 #endif
2026         /*
2027          *  Patch some data in SCRIPTS.
2028          *  - start and done queue initial bus address.
2029          *  - target bus address table bus address.
2030          */
2031         scriptb0->startpos[0]   = cpu_to_scr(np->squeue_ba);
2032         scriptb0->done_pos[0]   = cpu_to_scr(np->dqueue_ba);
2033         scriptb0->targtbl[0]    = cpu_to_scr(np->targtbl_ba);
2034 }
2035 #endif  /* SYM_CONF_GENERIC_SUPPORT */
2036
2037 /*
2038  *  Patch routine for firmware #2.
2039  */
2040 static void
2041 sym_fw2_patch(hcb_p np)
2042 {
2043         struct sym_fw2a_scr *scripta0;
2044         struct sym_fw2b_scr *scriptb0;
2045
2046         scripta0 = (struct sym_fw2a_scr *) np->scripta0;
2047         scriptb0 = (struct sym_fw2b_scr *) np->scriptb0;
2048
2049         /*
2050          *  Remove LED support if not needed.
2051          */
2052         if (!(np->features & FE_LED0)) {
2053                 scripta0->idle[0]       = cpu_to_scr(SCR_NO_OP);
2054                 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
2055                 scripta0->start[0]      = cpu_to_scr(SCR_NO_OP);
2056         }
2057
2058 #ifdef SYM_CONF_IARB_SUPPORT
2059         /*
2060          *    If user does not want to use IMMEDIATE ARBITRATION
2061          *    when we are reselected while attempting to arbitrate,
2062          *    patch the SCRIPTS accordingly with a SCRIPT NO_OP.
2063          */
2064         if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
2065                 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
2066 #endif
2067         /*
2068          *  Patch some variable in SCRIPTS.
2069          *  - start and done queue initial bus address.
2070          *  - target bus address table bus address.
2071          */
2072         scriptb0->startpos[0]   = cpu_to_scr(np->squeue_ba);
2073         scriptb0->done_pos[0]   = cpu_to_scr(np->dqueue_ba);
2074         scriptb0->targtbl[0]    = cpu_to_scr(np->targtbl_ba);
2075
2076         /*
2077          *  Remove the load of SCNTL4 on reselection if not a C10.
2078          */
2079         if (!(np->features & FE_C10)) {
2080                 scripta0->resel_scntl4[0] = cpu_to_scr(SCR_NO_OP);
2081                 scripta0->resel_scntl4[1] = cpu_to_scr(0);
2082         }
2083
2084         /*
2085          *  Remove a couple of work-arounds specific to C1010 if 
2086          *  they are not desirable. See `sym_fw2.h' for more details.
2087          */
2088         if (!(np->device_id == PCI_ID_LSI53C1010_2 &&
2089               np->revision_id < 0x1 &&
2090               np->pciclk_khz < 60000)) {
2091                 scripta0->datao_phase[0] = cpu_to_scr(SCR_NO_OP);
2092                 scripta0->datao_phase[1] = cpu_to_scr(0);
2093         }
2094         if (!(np->device_id == PCI_ID_LSI53C1010 &&
2095               /* np->revision_id < 0xff */ 1)) {
2096                 scripta0->sel_done[0] = cpu_to_scr(SCR_NO_OP);
2097                 scripta0->sel_done[1] = cpu_to_scr(0);
2098         }
2099
2100         /*
2101          *  Patch some other variables in SCRIPTS.
2102          *  These ones are loaded by the SCRIPTS processor.
2103          */
2104         scriptb0->pm0_data_addr[0] =
2105                 cpu_to_scr(np->scripta_ba + 
2106                            offsetof(struct sym_fw2a_scr, pm0_data));
2107         scriptb0->pm1_data_addr[0] =
2108                 cpu_to_scr(np->scripta_ba + 
2109                            offsetof(struct sym_fw2a_scr, pm1_data));
2110 }
2111
2112 /*
2113  *  Fill the data area in scripts.
2114  *  To be done for all firmwares.
2115  */
2116 static void
2117 sym_fw_fill_data (u32 *in, u32 *out)
2118 {
2119         int     i;
2120
2121         for (i = 0; i < SYM_CONF_MAX_SG; i++) {
2122                 *in++  = SCR_CHMOV_TBL ^ SCR_DATA_IN;
2123                 *in++  = offsetof (struct sym_dsb, data[i]);
2124                 *out++ = SCR_CHMOV_TBL ^ SCR_DATA_OUT;
2125                 *out++ = offsetof (struct sym_dsb, data[i]);
2126         }
2127 }
2128
2129 /*
2130  *  Setup useful script bus addresses.
2131  *  To be done for all firmwares.
2132  */
2133 static void 
2134 sym_fw_setup_bus_addresses(hcb_p np, struct sym_fw *fw)
2135 {
2136         u32 *pa;
2137         u_short *po;
2138         int i;
2139
2140         /*
2141          *  Build the bus address table for script A 
2142          *  from the script A offset table.
2143          */
2144         po = (u_short *) fw->a_ofs;
2145         pa = (u32 *) &np->fwa_bas;
2146         for (i = 0 ; i < sizeof(np->fwa_bas)/sizeof(u32) ; i++)
2147                 pa[i] = np->scripta_ba + po[i];
2148
2149         /*
2150          *  Same for script B.
2151          */
2152         po = (u_short *) fw->b_ofs;
2153         pa = (u32 *) &np->fwb_bas;
2154         for (i = 0 ; i < sizeof(np->fwb_bas)/sizeof(u32) ; i++)
2155                 pa[i] = np->scriptb_ba + po[i];
2156 }
2157
2158 #ifdef  SYM_CONF_GENERIC_SUPPORT
2159 /*
2160  *  Setup routine for firmware #1.
2161  */
2162 static void 
2163 sym_fw1_setup(hcb_p np, struct sym_fw *fw)
2164 {
2165         struct sym_fw1a_scr *scripta0;
2166         struct sym_fw1b_scr *scriptb0;
2167
2168         scripta0 = (struct sym_fw1a_scr *) np->scripta0;
2169         scriptb0 = (struct sym_fw1b_scr *) np->scriptb0;
2170
2171         /*
2172          *  Fill variable parts in scripts.
2173          */
2174         sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
2175
2176         /*
2177          *  Setup bus addresses used from the C code..
2178          */
2179         sym_fw_setup_bus_addresses(np, fw);
2180 }
2181 #endif  /* SYM_CONF_GENERIC_SUPPORT */
2182
2183 /*
2184  *  Setup routine for firmware #2.
2185  */
2186 static void 
2187 sym_fw2_setup(hcb_p np, struct sym_fw *fw)
2188 {
2189         struct sym_fw2a_scr *scripta0;
2190         struct sym_fw2b_scr *scriptb0;
2191
2192         scripta0 = (struct sym_fw2a_scr *) np->scripta0;
2193         scriptb0 = (struct sym_fw2b_scr *) np->scriptb0;
2194
2195         /*
2196          *  Fill variable parts in scripts.
2197          */
2198         sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
2199
2200         /*
2201          *  Setup bus addresses used from the C code..
2202          */
2203         sym_fw_setup_bus_addresses(np, fw);
2204 }
2205
2206 /*
2207  *  Allocate firmware descriptors.
2208  */
2209 #ifdef  SYM_CONF_GENERIC_SUPPORT
2210 static struct sym_fw sym_fw1 = SYM_FW_ENTRY(sym_fw1, "NCR-generic");
2211 #endif  /* SYM_CONF_GENERIC_SUPPORT */
2212 static struct sym_fw sym_fw2 = SYM_FW_ENTRY(sym_fw2, "LOAD/STORE-based");
2213
2214 /*
2215  *  Find the most appropriate firmware for a chip.
2216  */
2217 static struct sym_fw * 
2218 sym_find_firmware(struct sym_pci_chip *chip)
2219 {
2220         if (chip->features & FE_LDSTR)
2221                 return &sym_fw2;
2222 #ifdef  SYM_CONF_GENERIC_SUPPORT
2223         else if (!(chip->features & (FE_PFEN|FE_NOPM|FE_DAC)))
2224                 return &sym_fw1;
2225 #endif
2226         else
2227                 return 0;
2228 }
2229
2230 /*
2231  *  Bind a script to physical addresses.
2232  */
2233 static void sym_fw_bind_script (hcb_p np, u32 *start, int len)
2234 {
2235         u32 opcode, new, old, tmp1, tmp2;
2236         u32 *end, *cur;
2237         int relocs;
2238
2239         cur = start;
2240         end = start + len/4;
2241
2242         while (cur < end) {
2243
2244                 opcode = *cur;
2245
2246                 /*
2247                  *  If we forget to change the length
2248                  *  in scripts, a field will be
2249                  *  padded with 0. This is an illegal
2250                  *  command.
2251                  */
2252                 if (opcode == 0) {
2253                         printf ("%s: ERROR0 IN SCRIPT at %d.\n",
2254                                 sym_name(np), (int) (cur-start));
2255                         MDELAY (10000);
2256                         ++cur;
2257                         continue;
2258                 };
2259
2260                 /*
2261                  *  We use the bogus value 0xf00ff00f ;-)
2262                  *  to reserve data area in SCRIPTS.
2263                  */
2264                 if (opcode == SCR_DATA_ZERO) {
2265                         *cur++ = 0;
2266                         continue;
2267                 }
2268
2269                 if (DEBUG_FLAGS & DEBUG_SCRIPT)
2270                         printf ("%d:  <%x>\n", (int) (cur-start),
2271                                 (unsigned)opcode);
2272
2273                 /*
2274                  *  We don't have to decode ALL commands
2275                  */
2276                 switch (opcode >> 28) {
2277                 case 0xf:
2278                         /*
2279                          *  LOAD / STORE DSA relative, don't relocate.
2280                          */
2281                         relocs = 0;
2282                         break;
2283                 case 0xe:
2284                         /*
2285                          *  LOAD / STORE absolute.
2286                          */
2287                         relocs = 1;
2288                         break;
2289                 case 0xc:
2290                         /*
2291                          *  COPY has TWO arguments.
2292                          */
2293                         relocs = 2;
2294                         tmp1 = cur[1];
2295                         tmp2 = cur[2];
2296                         if ((tmp1 ^ tmp2) & 3) {
2297                                 printf ("%s: ERROR1 IN SCRIPT at %d.\n",
2298                                         sym_name(np), (int) (cur-start));
2299                                 MDELAY (10000);
2300                         }
2301                         /*
2302                          *  If PREFETCH feature not enabled, remove 
2303                          *  the NO FLUSH bit if present.
2304                          */
2305                         if ((opcode & SCR_NO_FLUSH) &&
2306                             !(np->features & FE_PFEN)) {
2307                                 opcode = (opcode & ~SCR_NO_FLUSH);
2308                         }
2309                         break;
2310                 case 0x0:
2311                         /*
2312                          *  MOVE/CHMOV (absolute address)
2313                          */
2314                         if (!(np->features & FE_WIDE))
2315                                 opcode = (opcode | OPC_MOVE);
2316                         relocs = 1;
2317                         break;
2318                 case 0x1:
2319                         /*
2320                          *  MOVE/CHMOV (table indirect)
2321                          */
2322                         if (!(np->features & FE_WIDE))
2323                                 opcode = (opcode | OPC_MOVE);
2324                         relocs = 0;
2325                         break;
2326                 case 0x8:
2327                         /*
2328                          *  JUMP / CALL
2329                          *  dont't relocate if relative :-)
2330                          */
2331                         if (opcode & 0x00800000)
2332                                 relocs = 0;
2333                         else if ((opcode & 0xf8400000) == 0x80400000)/*JUMP64*/
2334                                 relocs = 2;
2335                         else
2336                                 relocs = 1;
2337                         break;
2338                 case 0x4:
2339                 case 0x5:
2340                 case 0x6:
2341                 case 0x7:
2342                         relocs = 1;
2343                         break;
2344                 default:
2345                         relocs = 0;
2346                         break;
2347                 };
2348
2349                 /*
2350                  *  Scriptify:) the opcode.
2351                  */
2352                 *cur++ = cpu_to_scr(opcode);
2353
2354                 /*
2355                  *  If no relocation, assume 1 argument 
2356                  *  and just scriptize:) it.
2357                  */
2358                 if (!relocs) {
2359                         *cur = cpu_to_scr(*cur);
2360                         ++cur;
2361                         continue;
2362                 }
2363
2364                 /*
2365                  *  Otherwise performs all needed relocations.
2366                  */
2367                 while (relocs--) {
2368                         old = *cur;
2369
2370                         switch (old & RELOC_MASK) {
2371                         case RELOC_REGISTER:
2372                                 new = (old & ~RELOC_MASK) + np->mmio_ba;
2373                                 break;
2374                         case RELOC_LABEL_A:
2375                                 new = (old & ~RELOC_MASK) + np->scripta_ba;
2376                                 break;
2377                         case RELOC_LABEL_B:
2378                                 new = (old & ~RELOC_MASK) + np->scriptb_ba;
2379                                 break;
2380                         case RELOC_SOFTC:
2381                                 new = (old & ~RELOC_MASK) + np->hcb_ba;
2382                                 break;
2383                         case 0:
2384                                 /*
2385                                  *  Don't relocate a 0 address.
2386                                  *  They are mostly used for patched or 
2387                                  *  script self-modified areas.
2388                                  */
2389                                 if (old == 0) {
2390                                         new = old;
2391                                         break;
2392                                 }
2393                                 /* fall through */
2394                         default:
2395                                 new = 0;
2396                                 panic("sym_fw_bind_script: "
2397                                       "weird relocation %x\n", old);
2398                                 break;
2399                         }
2400
2401                         *cur++ = cpu_to_scr(new);
2402                 }
2403         };
2404 }
2405
2406 /*--------------------------------------------------------------------------*/
2407 /*--------------------------- END OF FIRMARES  -----------------------------*/
2408 /*--------------------------------------------------------------------------*/
2409
2410 /*
2411  *  Function prototypes.
2412  */
2413 static void sym_save_initial_setting (hcb_p np);
2414 static int  sym_prepare_setting (hcb_p np, struct sym_nvram *nvram);
2415 static int  sym_prepare_nego (hcb_p np, ccb_p cp, int nego, u_char *msgptr);
2416 static void sym_put_start_queue (hcb_p np, ccb_p cp);
2417 static void sym_chip_reset (hcb_p np);
2418 static void sym_soft_reset (hcb_p np);
2419 static void sym_start_reset (hcb_p np);
2420 static int  sym_reset_scsi_bus (hcb_p np, int enab_int);
2421 static int  sym_wakeup_done (hcb_p np);
2422 static void sym_flush_busy_queue (hcb_p np, int cam_status);
2423 static void sym_flush_comp_queue (hcb_p np, int cam_status);
2424 static void sym_init (hcb_p np, int reason);
2425 static int  sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp,
2426                         u_char *fakp);
2427 static void sym_setsync (hcb_p np, ccb_p cp, u_char ofs, u_char per,
2428                          u_char div, u_char fak);
2429 static void sym_setwide (hcb_p np, ccb_p cp, u_char wide);
2430 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2431                          u_char per, u_char wide, u_char div, u_char fak);
2432 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2433                          u_char per, u_char wide, u_char div, u_char fak);
2434 static void sym_log_hard_error (hcb_p np, u_short sist, u_char dstat);
2435 static void sym_intr (void *arg);
2436 static void sym_poll (struct cam_sim *sim);
2437 static void sym_recover_scsi_int (hcb_p np, u_char hsts);
2438 static void sym_int_sto (hcb_p np);
2439 static void sym_int_udc (hcb_p np);
2440 static void sym_int_sbmc (hcb_p np);
2441 static void sym_int_par (hcb_p np, u_short sist);
2442 static void sym_int_ma (hcb_p np);
2443 static int  sym_dequeue_from_squeue(hcb_p np, int i, int target, int lun, 
2444                                     int task);
2445 static void sym_sir_bad_scsi_status (hcb_p np, int num, ccb_p cp);
2446 static int  sym_clear_tasks (hcb_p np, int status, int targ, int lun, int task);
2447 static void sym_sir_task_recovery (hcb_p np, int num);
2448 static int  sym_evaluate_dp (hcb_p np, ccb_p cp, u32 scr, int *ofs);
2449 static void sym_modify_dp (hcb_p np, tcb_p tp, ccb_p cp, int ofs);
2450 static int  sym_compute_residual (hcb_p np, ccb_p cp);
2451 static int  sym_show_msg (u_char * msg);
2452 static void sym_print_msg (ccb_p cp, char *label, u_char *msg);
2453 static void sym_sync_nego (hcb_p np, tcb_p tp, ccb_p cp);
2454 static void sym_ppr_nego (hcb_p np, tcb_p tp, ccb_p cp);
2455 static void sym_wide_nego (hcb_p np, tcb_p tp, ccb_p cp);
2456 static void sym_nego_default (hcb_p np, tcb_p tp, ccb_p cp);
2457 static void sym_nego_rejected (hcb_p np, tcb_p tp, ccb_p cp);
2458 static void sym_int_sir (hcb_p np);
2459 static void sym_free_ccb (hcb_p np, ccb_p cp);
2460 static ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order);
2461 static ccb_p sym_alloc_ccb (hcb_p np);
2462 static ccb_p sym_ccb_from_dsa (hcb_p np, u32 dsa);
2463 static lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln);
2464 static void sym_alloc_lcb_tags (hcb_p np, u_char tn, u_char ln);
2465 static int  sym_snooptest (hcb_p np);
2466 static void sym_selectclock(hcb_p np, u_char scntl3);
2467 static void sym_getclock (hcb_p np, int mult);
2468 static int  sym_getpciclock (hcb_p np);
2469 static void sym_complete_ok (hcb_p np, ccb_p cp);
2470 static void sym_complete_error (hcb_p np, ccb_p cp);
2471 static void sym_timeout (void *arg);
2472 static int  sym_abort_scsiio (hcb_p np, union ccb *ccb, int timed_out);
2473 static void sym_reset_dev (hcb_p np, union ccb *ccb);
2474 static void sym_action (struct cam_sim *sim, union ccb *ccb);
2475 static void sym_action1 (struct cam_sim *sim, union ccb *ccb);
2476 static int  sym_setup_cdb (hcb_p np, struct ccb_scsiio *csio, ccb_p cp);
2477 static void sym_setup_data_and_start (hcb_p np, struct ccb_scsiio *csio,
2478                                       ccb_p cp);
2479 #ifdef  FreeBSD_Bus_Dma_Abstraction
2480 static int sym_fast_scatter_sg_physical(hcb_p np, ccb_p cp, 
2481                                         bus_dma_segment_t *psegs, int nsegs);
2482 #else
2483 static int  sym_scatter_virtual (hcb_p np, ccb_p cp, vm_offset_t vaddr,
2484                                  vm_size_t len);
2485 static int  sym_scatter_sg_virtual (hcb_p np, ccb_p cp, 
2486                                     bus_dma_segment_t *psegs, int nsegs);
2487 static int  sym_scatter_physical (hcb_p np, ccb_p cp, vm_offset_t paddr,
2488                                   vm_size_t len);
2489 #endif
2490 static int sym_scatter_sg_physical (hcb_p np, ccb_p cp, 
2491                                     bus_dma_segment_t *psegs, int nsegs);
2492 static void sym_action2 (struct cam_sim *sim, union ccb *ccb);
2493 static void sym_update_trans (hcb_p np, tcb_p tp, struct sym_trans *tip,
2494                               struct ccb_trans_settings *cts);
2495 static void sym_update_dflags(hcb_p np, u_char *flags,
2496                               struct ccb_trans_settings *cts);
2497
2498 #ifdef FreeBSD_Bus_Io_Abstraction
2499 static struct sym_pci_chip *sym_find_pci_chip (device_t dev);
2500 static int  sym_pci_probe (device_t dev);
2501 static int  sym_pci_attach (device_t dev);
2502 #else
2503 static struct sym_pci_chip *sym_find_pci_chip (pcici_t tag);
2504 static const char *sym_pci_probe (pcici_t tag, pcidi_t type);
2505 static void sym_pci_attach (pcici_t tag, int unit);
2506 static int sym_pci_attach2 (pcici_t tag, int unit);
2507 #endif
2508
2509 static void sym_pci_free (hcb_p np);
2510 static int  sym_cam_attach (hcb_p np);
2511 static void sym_cam_free (hcb_p np);
2512
2513 static void sym_nvram_setup_host (hcb_p np, struct sym_nvram *nvram);
2514 static void sym_nvram_setup_target (hcb_p np, int targ, struct sym_nvram *nvp);
2515 static int sym_read_nvram (hcb_p np, struct sym_nvram *nvp);
2516
2517 /*
2518  *  Print something which allows to retrieve the controler type, 
2519  *  unit, target, lun concerned by a kernel message.
2520  */
2521 static void PRINT_TARGET (hcb_p np, int target)
2522 {
2523         printf ("%s:%d:", sym_name(np), target);
2524 }
2525
2526 static void PRINT_LUN(hcb_p np, int target, int lun)
2527 {
2528         printf ("%s:%d:%d:", sym_name(np), target, lun);
2529 }
2530
2531 static void PRINT_ADDR (ccb_p cp)
2532 {
2533         if (cp && cp->cam_ccb)
2534                 xpt_print_path(cp->cam_ccb->ccb_h.path);
2535 }
2536
2537 /*
2538  *  Take into account this ccb in the freeze count.
2539  */     
2540 static void sym_freeze_cam_ccb(union ccb *ccb)
2541 {
2542         if (!(ccb->ccb_h.flags & CAM_DEV_QFRZDIS)) {
2543                 if (!(ccb->ccb_h.status & CAM_DEV_QFRZN)) {
2544                         ccb->ccb_h.status |= CAM_DEV_QFRZN;
2545                         xpt_freeze_devq(ccb->ccb_h.path, 1);
2546                 }
2547         }
2548 }
2549
2550 /*
2551  *  Set the status field of a CAM CCB.
2552  */
2553 static __inline void sym_set_cam_status(union ccb *ccb, cam_status status)
2554 {
2555         ccb->ccb_h.status &= ~CAM_STATUS_MASK;
2556         ccb->ccb_h.status |= status;
2557 }
2558
2559 /*
2560  *  Get the status field of a CAM CCB.
2561  */
2562 static __inline int sym_get_cam_status(union ccb *ccb)
2563 {
2564         return ccb->ccb_h.status & CAM_STATUS_MASK;
2565 }
2566
2567 /*
2568  *  Enqueue a CAM CCB.
2569  */
2570 static void sym_enqueue_cam_ccb(hcb_p np, union ccb *ccb)
2571 {
2572         assert(!(ccb->ccb_h.status & CAM_SIM_QUEUED));
2573         ccb->ccb_h.status = CAM_REQ_INPROG;
2574
2575         ccb->ccb_h.timeout_ch = timeout(sym_timeout, (caddr_t) ccb,
2576                                        ccb->ccb_h.timeout*hz/1000);
2577         ccb->ccb_h.status |= CAM_SIM_QUEUED;
2578         ccb->ccb_h.sym_hcb_ptr = np;
2579
2580         sym_insque_tail(sym_qptr(&ccb->ccb_h.sim_links), &np->cam_ccbq);
2581 }
2582
2583 /*
2584  *  Complete a pending CAM CCB.
2585  */
2586 static void sym_xpt_done(hcb_p np, union ccb *ccb)
2587 {
2588         if (ccb->ccb_h.status & CAM_SIM_QUEUED) {
2589                 untimeout(sym_timeout, (caddr_t) ccb, ccb->ccb_h.timeout_ch);
2590                 sym_remque(sym_qptr(&ccb->ccb_h.sim_links));
2591                 ccb->ccb_h.status &= ~CAM_SIM_QUEUED;
2592                 ccb->ccb_h.sym_hcb_ptr = 0;
2593         }
2594         if (ccb->ccb_h.flags & CAM_DEV_QFREEZE)
2595                 sym_freeze_cam_ccb(ccb);
2596         xpt_done(ccb);
2597 }
2598
2599 static void sym_xpt_done2(hcb_p np, union ccb *ccb, int cam_status)
2600 {
2601         sym_set_cam_status(ccb, cam_status);
2602         sym_xpt_done(np, ccb);
2603 }
2604
2605 /*
2606  *  SYMBIOS chip clock divisor table.
2607  *
2608  *  Divisors are multiplied by 10,000,000 in order to make 
2609  *  calculations more simple.
2610  */
2611 #define _5M 5000000
2612 static u32 div_10M[] = {2*_5M, 3*_5M, 4*_5M, 6*_5M, 8*_5M, 12*_5M, 16*_5M};
2613
2614 /*
2615  *  SYMBIOS chips allow burst lengths of 2, 4, 8, 16, 32, 64,
2616  *  128 transfers. All chips support at least 16 transfers 
2617  *  bursts. The 825A, 875 and 895 chips support bursts of up 
2618  *  to 128 transfers and the 895A and 896 support bursts of up
2619  *  to 64 transfers. All other chips support up to 16 
2620  *  transfers bursts.
2621  *
2622  *  For PCI 32 bit data transfers each transfer is a DWORD.
2623  *  It is a QUADWORD (8 bytes) for PCI 64 bit data transfers.
2624  *
2625  *  We use log base 2 (burst length) as internal code, with 
2626  *  value 0 meaning "burst disabled".
2627  */
2628
2629 /*
2630  *  Burst length from burst code.
2631  */
2632 #define burst_length(bc) (!(bc))? 0 : 1 << (bc)
2633
2634 /*
2635  *  Burst code from io register bits.
2636  */
2637 #define burst_code(dmode, ctest4, ctest5) \
2638         (ctest4) & 0x80? 0 : (((dmode) & 0xc0) >> 6) + ((ctest5) & 0x04) + 1
2639
2640 /*
2641  *  Set initial io register bits from burst code.
2642  */
2643 static __inline void sym_init_burst(hcb_p np, u_char bc)
2644 {
2645         np->rv_ctest4   &= ~0x80;
2646         np->rv_dmode    &= ~(0x3 << 6);
2647         np->rv_ctest5   &= ~0x4;
2648
2649         if (!bc) {
2650                 np->rv_ctest4   |= 0x80;
2651         }
2652         else {
2653                 --bc;
2654                 np->rv_dmode    |= ((bc & 0x3) << 6);
2655                 np->rv_ctest5   |= (bc & 0x4);
2656         }
2657 }
2658
2659
2660 /*
2661  * Print out the list of targets that have some flag disabled by user.
2662  */
2663 static void sym_print_targets_flag(hcb_p np, int mask, char *msg)
2664 {
2665         int cnt;
2666         int i;
2667
2668         for (cnt = 0, i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2669                 if (i == np->myaddr)
2670                         continue;
2671                 if (np->target[i].usrflags & mask) {
2672                         if (!cnt++)
2673                                 printf("%s: %s disabled for targets",
2674                                         sym_name(np), msg);
2675                         printf(" %d", i);
2676                 }
2677         }
2678         if (cnt)
2679                 printf(".\n");
2680 }
2681
2682 /*
2683  *  Save initial settings of some IO registers.
2684  *  Assumed to have been set by BIOS.
2685  *  We cannot reset the chip prior to reading the 
2686  *  IO registers, since informations will be lost.
2687  *  Since the SCRIPTS processor may be running, this 
2688  *  is not safe on paper, but it seems to work quite 
2689  *  well. :)
2690  */
2691 static void sym_save_initial_setting (hcb_p np)
2692 {
2693         np->sv_scntl0   = INB(nc_scntl0) & 0x0a;
2694         np->sv_scntl3   = INB(nc_scntl3) & 0x07;
2695         np->sv_dmode    = INB(nc_dmode)  & 0xce;
2696         np->sv_dcntl    = INB(nc_dcntl)  & 0xa8;
2697         np->sv_ctest3   = INB(nc_ctest3) & 0x01;
2698         np->sv_ctest4   = INB(nc_ctest4) & 0x80;
2699         np->sv_gpcntl   = INB(nc_gpcntl);
2700         np->sv_stest1   = INB(nc_stest1);
2701         np->sv_stest2   = INB(nc_stest2) & 0x20;
2702         np->sv_stest4   = INB(nc_stest4);
2703         if (np->features & FE_C10) {    /* Always large DMA fifo + ultra3 */
2704                 np->sv_scntl4   = INB(nc_scntl4);
2705                 np->sv_ctest5   = INB(nc_ctest5) & 0x04;
2706         }
2707         else
2708                 np->sv_ctest5   = INB(nc_ctest5) & 0x24;
2709 }
2710
2711 /*
2712  *  Prepare io register values used by sym_init() according 
2713  *  to selected and supported features.
2714  */
2715 static int sym_prepare_setting(hcb_p np, struct sym_nvram *nvram)
2716 {
2717         u_char  burst_max;
2718         u32     period;
2719         int i;
2720
2721         /*
2722          *  Wide ?
2723          */
2724         np->maxwide     = (np->features & FE_WIDE)? 1 : 0;
2725
2726         /*
2727          *  Get the frequency of the chip's clock.
2728          */
2729         if      (np->features & FE_QUAD)
2730                 np->multiplier  = 4;
2731         else if (np->features & FE_DBLR)
2732                 np->multiplier  = 2;
2733         else
2734                 np->multiplier  = 1;
2735
2736         np->clock_khz   = (np->features & FE_CLK80)? 80000 : 40000;
2737         np->clock_khz   *= np->multiplier;
2738
2739         if (np->clock_khz != 40000)
2740                 sym_getclock(np, np->multiplier);
2741
2742         /*
2743          * Divisor to be used for async (timer pre-scaler).
2744          */
2745         i = np->clock_divn - 1;
2746         while (--i >= 0) {
2747                 if (10ul * SYM_CONF_MIN_ASYNC * np->clock_khz > div_10M[i]) {
2748                         ++i;
2749                         break;
2750                 }
2751         }
2752         np->rv_scntl3 = i+1;
2753
2754         /*
2755          * The C1010 uses hardwired divisors for async.
2756          * So, we just throw away, the async. divisor.:-)
2757          */
2758         if (np->features & FE_C10)
2759                 np->rv_scntl3 = 0;
2760
2761         /*
2762          * Minimum synchronous period factor supported by the chip.
2763          * Btw, 'period' is in tenths of nanoseconds.
2764          */
2765         period = (4 * div_10M[0] + np->clock_khz - 1) / np->clock_khz;
2766         if      (period <= 250)         np->minsync = 10;
2767         else if (period <= 303)         np->minsync = 11;
2768         else if (period <= 500)         np->minsync = 12;
2769         else                            np->minsync = (period + 40 - 1) / 40;
2770
2771         /*
2772          * Check against chip SCSI standard support (SCSI-2,ULTRA,ULTRA2).
2773          */
2774         if      (np->minsync < 25 &&
2775                  !(np->features & (FE_ULTRA|FE_ULTRA2|FE_ULTRA3)))
2776                 np->minsync = 25;
2777         else if (np->minsync < 12 &&
2778                  !(np->features & (FE_ULTRA2|FE_ULTRA3)))
2779                 np->minsync = 12;
2780
2781         /*
2782          * Maximum synchronous period factor supported by the chip.
2783          */
2784         period = (11 * div_10M[np->clock_divn - 1]) / (4 * np->clock_khz);
2785         np->maxsync = period > 2540 ? 254 : period / 10;
2786
2787         /*
2788          * If chip is a C1010, guess the sync limits in DT mode.
2789          */
2790         if ((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3)) {
2791                 if (np->clock_khz == 160000) {
2792                         np->minsync_dt = 9;
2793                         np->maxsync_dt = 50;
2794                         np->maxoffs_dt = 62;
2795                 }
2796         }
2797         
2798         /*
2799          *  64 bit addressing  (895A/896/1010) ?
2800          */
2801         if (np->features & FE_DAC)
2802 #if BITS_PER_LONG > 32
2803                 np->rv_ccntl1   |= (XTIMOD | EXTIBMV);
2804 #else
2805                 np->rv_ccntl1   |= (DDAC);
2806 #endif
2807
2808         /*
2809          *  Phase mismatch handled by SCRIPTS (895A/896/1010) ?
2810          */
2811         if (np->features & FE_NOPM)
2812                 np->rv_ccntl0   |= (ENPMJ);
2813
2814         /*
2815          *  C1010 Errata.
2816          *  In dual channel mode, contention occurs if internal cycles
2817          *  are used. Disable internal cycles.
2818          */
2819         if (np->device_id == PCI_ID_LSI53C1010 &&
2820             np->revision_id < 0x2)
2821                 np->rv_ccntl0   |=  DILS;
2822
2823         /*
2824          *  Select burst length (dwords)
2825          */
2826         burst_max       = SYM_SETUP_BURST_ORDER;
2827         if (burst_max == 255)
2828                 burst_max = burst_code(np->sv_dmode, np->sv_ctest4,
2829                                        np->sv_ctest5);
2830         if (burst_max > 7)
2831                 burst_max = 7;
2832         if (burst_max > np->maxburst)
2833                 burst_max = np->maxburst;
2834
2835         /*
2836          *  DEL 352 - 53C810 Rev x11 - Part Number 609-0392140 - ITEM 2.
2837          *  This chip and the 860 Rev 1 may wrongly use PCI cache line 
2838          *  based transactions on LOAD/STORE instructions. So we have 
2839          *  to prevent these chips from using such PCI transactions in 
2840          *  this driver. The generic ncr driver that does not use 
2841          *  LOAD/STORE instructions does not need this work-around.
2842          */
2843         if ((np->device_id == PCI_ID_SYM53C810 &&
2844              np->revision_id >= 0x10 && np->revision_id <= 0x11) ||
2845             (np->device_id == PCI_ID_SYM53C860 &&
2846              np->revision_id <= 0x1))
2847                 np->features &= ~(FE_WRIE|FE_ERL|FE_ERMP);
2848
2849         /*
2850          *  Select all supported special features.
2851          *  If we are using on-board RAM for scripts, prefetch (PFEN) 
2852          *  does not help, but burst op fetch (BOF) does.
2853          *  Disabling PFEN makes sure BOF will be used.
2854          */
2855         if (np->features & FE_ERL)
2856                 np->rv_dmode    |= ERL;         /* Enable Read Line */
2857         if (np->features & FE_BOF)
2858                 np->rv_dmode    |= BOF;         /* Burst Opcode Fetch */
2859         if (np->features & FE_ERMP)
2860                 np->rv_dmode    |= ERMP;        /* Enable Read Multiple */
2861 #if 1
2862         if ((np->features & FE_PFEN) && !np->ram_ba)
2863 #else
2864         if (np->features & FE_PFEN)
2865 #endif
2866                 np->rv_dcntl    |= PFEN;        /* Prefetch Enable */
2867         if (np->features & FE_CLSE)
2868                 np->rv_dcntl    |= CLSE;        /* Cache Line Size Enable */
2869         if (np->features & FE_WRIE)
2870                 np->rv_ctest3   |= WRIE;        /* Write and Invalidate */
2871         if (np->features & FE_DFS)
2872                 np->rv_ctest5   |= DFS;         /* Dma Fifo Size */
2873
2874         /*
2875          *  Select some other
2876          */
2877         if (SYM_SETUP_PCI_PARITY)
2878                 np->rv_ctest4   |= MPEE; /* Master parity checking */
2879         if (SYM_SETUP_SCSI_PARITY)
2880                 np->rv_scntl0   |= 0x0a; /*  full arb., ena parity, par->ATN  */
2881
2882         /*
2883          *  Get parity checking, host ID and verbose mode from NVRAM
2884          */
2885         np->myaddr = 255;
2886         sym_nvram_setup_host (np, nvram);
2887
2888         /*
2889          *  Get SCSI addr of host adapter (set by bios?).
2890          */
2891         if (np->myaddr == 255) {
2892                 np->myaddr = INB(nc_scid) & 0x07;
2893                 if (!np->myaddr)
2894                         np->myaddr = SYM_SETUP_HOST_ID;
2895         }
2896
2897         /*
2898          *  Prepare initial io register bits for burst length
2899          */
2900         sym_init_burst(np, burst_max);
2901
2902         /*
2903          *  Set SCSI BUS mode.
2904          *  - LVD capable chips (895/895A/896/1010) report the 
2905          *    current BUS mode through the STEST4 IO register.
2906          *  - For previous generation chips (825/825A/875), 
2907          *    user has to tell us how to check against HVD, 
2908          *    since a 100% safe algorithm is not possible.
2909          */
2910         np->scsi_mode = SMODE_SE;
2911         if (np->features & (FE_ULTRA2|FE_ULTRA3))
2912                 np->scsi_mode = (np->sv_stest4 & SMODE);
2913         else if (np->features & FE_DIFF) {
2914                 if (SYM_SETUP_SCSI_DIFF == 1) {
2915                         if (np->sv_scntl3) {
2916                                 if (np->sv_stest2 & 0x20)
2917                                         np->scsi_mode = SMODE_HVD;
2918                         }
2919                         else if (nvram->type == SYM_SYMBIOS_NVRAM) {
2920                                 if (!(INB(nc_gpreg) & 0x08))
2921                                         np->scsi_mode = SMODE_HVD;
2922                         }
2923                 }
2924                 else if (SYM_SETUP_SCSI_DIFF == 2)
2925                         np->scsi_mode = SMODE_HVD;
2926         }
2927         if (np->scsi_mode == SMODE_HVD)
2928                 np->rv_stest2 |= 0x20;
2929
2930         /*
2931          *  Set LED support from SCRIPTS.
2932          *  Ignore this feature for boards known to use a 
2933          *  specific GPIO wiring and for the 895A, 896 
2934          *  and 1010 that drive the LED directly.
2935          */
2936         if ((SYM_SETUP_SCSI_LED || 
2937              (nvram->type == SYM_SYMBIOS_NVRAM ||
2938               (nvram->type == SYM_TEKRAM_NVRAM &&
2939                np->device_id == PCI_ID_SYM53C895))) &&
2940             !(np->features & FE_LEDC) && !(np->sv_gpcntl & 0x01))
2941                 np->features |= FE_LED0;
2942
2943         /*
2944          *  Set irq mode.
2945          */
2946         switch(SYM_SETUP_IRQ_MODE & 3) {
2947         case 2:
2948                 np->rv_dcntl    |= IRQM;
2949                 break;
2950         case 1:
2951                 np->rv_dcntl    |= (np->sv_dcntl & IRQM);
2952                 break;
2953         default:
2954                 break;
2955         }
2956
2957         /*
2958          *  Configure targets according to driver setup.
2959          *  If NVRAM present get targets setup from NVRAM.
2960          */
2961         for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2962                 tcb_p tp = &np->target[i];
2963
2964 #ifdef  FreeBSD_New_Tran_Settings
2965                 tp->tinfo.user.scsi_version = tp->tinfo.current.scsi_version= 2;
2966                 tp->tinfo.user.spi_version  = tp->tinfo.current.spi_version = 2;
2967 #endif
2968                 tp->tinfo.user.period = np->minsync;
2969                 tp->tinfo.user.offset = np->maxoffs;
2970                 tp->tinfo.user.width  = np->maxwide ? BUS_16_BIT : BUS_8_BIT;
2971                 tp->usrflags |= (SYM_DISC_ENABLED | SYM_TAGS_ENABLED);
2972                 tp->usrtags = SYM_SETUP_MAX_TAG;
2973
2974                 sym_nvram_setup_target (np, i, nvram);
2975
2976                 /*
2977                  *  For now, guess PPR/DT support from the period 
2978                  *  and BUS width.
2979                  */
2980                 if (np->features & FE_ULTRA3) {
2981                         if (tp->tinfo.user.period <= 9  &&
2982                             tp->tinfo.user.width == BUS_16_BIT) {
2983                                 tp->tinfo.user.options |= PPR_OPT_DT;
2984                                 tp->tinfo.user.offset   = np->maxoffs_dt;
2985 #ifdef  FreeBSD_New_Tran_Settings
2986                                 tp->tinfo.user.spi_version = 3;
2987 #endif
2988                         }
2989                 }
2990
2991                 if (!tp->usrtags)
2992                         tp->usrflags &= ~SYM_TAGS_ENABLED;
2993         }
2994
2995         /*
2996          *  Let user know about the settings.
2997          */
2998         i = nvram->type;
2999         printf("%s: %s NVRAM, ID %d, Fast-%d, %s, %s\n", sym_name(np),
3000                 i  == SYM_SYMBIOS_NVRAM ? "Symbios" :
3001                 (i == SYM_TEKRAM_NVRAM  ? "Tekram" : "No"),
3002                 np->myaddr,
3003                 (np->features & FE_ULTRA3) ? 80 : 
3004                 (np->features & FE_ULTRA2) ? 40 : 
3005                 (np->features & FE_ULTRA)  ? 20 : 10,
3006                 sym_scsi_bus_mode(np->scsi_mode),
3007                 (np->rv_scntl0 & 0xa)   ? "parity checking" : "NO parity");
3008         /*
3009          *  Tell him more on demand.
3010          */
3011         if (sym_verbose) {
3012                 printf("%s: %s IRQ line driver%s\n",
3013                         sym_name(np),
3014                         np->rv_dcntl & IRQM ? "totem pole" : "open drain",
3015                         np->ram_ba ? ", using on-chip SRAM" : "");
3016                 printf("%s: using %s firmware.\n", sym_name(np), np->fw_name);
3017                 if (np->features & FE_NOPM)
3018                         printf("%s: handling phase mismatch from SCRIPTS.\n", 
3019                                sym_name(np));
3020         }
3021         /*
3022          *  And still more.
3023          */
3024         if (sym_verbose > 1) {
3025                 printf ("%s: initial SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
3026                         "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
3027                         sym_name(np), np->sv_scntl3, np->sv_dmode, np->sv_dcntl,
3028                         np->sv_ctest3, np->sv_ctest4, np->sv_ctest5);
3029
3030                 printf ("%s: final   SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
3031                         "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
3032                         sym_name(np), np->rv_scntl3, np->rv_dmode, np->rv_dcntl,
3033                         np->rv_ctest3, np->rv_ctest4, np->rv_ctest5);
3034         }
3035         /*
3036          *  Let user be aware of targets that have some disable flags set.
3037          */
3038         sym_print_targets_flag(np, SYM_SCAN_BOOT_DISABLED, "SCAN AT BOOT");
3039         if (sym_verbose)
3040                 sym_print_targets_flag(np, SYM_SCAN_LUNS_DISABLED,
3041                                        "SCAN FOR LUNS");
3042
3043         return 0;
3044 }
3045
3046 /*
3047  *  Prepare the next negotiation message if needed.
3048  *
3049  *  Fill in the part of message buffer that contains the 
3050  *  negotiation and the nego_status field of the CCB.
3051  *  Returns the size of the message in bytes.
3052  */
3053
3054 static int sym_prepare_nego(hcb_p np, ccb_p cp, int nego, u_char *msgptr)
3055 {
3056         tcb_p tp = &np->target[cp->target];
3057         int msglen = 0;
3058
3059         /*
3060          *  Early C1010 chips need a work-around for DT 
3061          *  data transfer to work.
3062          */
3063         if (!(np->features & FE_U3EN))
3064                 tp->tinfo.goal.options = 0;
3065         /*
3066          *  negotiate using PPR ?
3067          */
3068         if (tp->tinfo.goal.options & PPR_OPT_MASK)
3069                 nego = NS_PPR;
3070         /*
3071          *  negotiate wide transfers ?
3072          */
3073         else if (tp->tinfo.current.width != tp->tinfo.goal.width)
3074                 nego = NS_WIDE;
3075         /*
3076          *  negotiate synchronous transfers?
3077          */
3078         else if (tp->tinfo.current.period != tp->tinfo.goal.period ||
3079                  tp->tinfo.current.offset != tp->tinfo.goal.offset)
3080                 nego = NS_SYNC;
3081
3082         switch (nego) {
3083         case NS_SYNC:
3084                 msgptr[msglen++] = M_EXTENDED;
3085                 msgptr[msglen++] = 3;
3086                 msgptr[msglen++] = M_X_SYNC_REQ;
3087                 msgptr[msglen++] = tp->tinfo.goal.period;
3088                 msgptr[msglen++] = tp->tinfo.goal.offset;
3089                 break;
3090         case NS_WIDE:
3091                 msgptr[msglen++] = M_EXTENDED;
3092                 msgptr[msglen++] = 2;
3093                 msgptr[msglen++] = M_X_WIDE_REQ;
3094                 msgptr[msglen++] = tp->tinfo.goal.width;
3095                 break;
3096         case NS_PPR:
3097                 msgptr[msglen++] = M_EXTENDED;
3098                 msgptr[msglen++] = 6;
3099                 msgptr[msglen++] = M_X_PPR_REQ;
3100                 msgptr[msglen++] = tp->tinfo.goal.period;
3101                 msgptr[msglen++] = 0;
3102                 msgptr[msglen++] = tp->tinfo.goal.offset;
3103                 msgptr[msglen++] = tp->tinfo.goal.width;
3104                 msgptr[msglen++] = tp->tinfo.goal.options & PPR_OPT_DT;
3105                 break;
3106         };
3107
3108         cp->nego_status = nego;
3109
3110         if (nego) {
3111                 tp->nego_cp = cp; /* Keep track a nego will be performed */
3112                 if (DEBUG_FLAGS & DEBUG_NEGO) {
3113                         sym_print_msg(cp, nego == NS_SYNC ? "sync msgout" :
3114                                           nego == NS_WIDE ? "wide msgout" :
3115                                           "ppr msgout", msgptr);
3116                 };
3117         };
3118
3119         return msglen;
3120 }
3121
3122 /*
3123  *  Insert a job into the start queue.
3124  */
3125 static void sym_put_start_queue(hcb_p np, ccb_p cp)
3126 {
3127         u_short qidx;
3128
3129 #ifdef SYM_CONF_IARB_SUPPORT
3130         /*
3131          *  If the previously queued CCB is not yet done, 
3132          *  set the IARB hint. The SCRIPTS will go with IARB 
3133          *  for this job when starting the previous one.
3134          *  We leave devices a chance to win arbitration by 
3135          *  not using more than 'iarb_max' consecutive 
3136          *  immediate arbitrations.
3137          */
3138         if (np->last_cp && np->iarb_count < np->iarb_max) {
3139                 np->last_cp->host_flags |= HF_HINT_IARB;
3140                 ++np->iarb_count;
3141         }
3142         else
3143                 np->iarb_count = 0;
3144         np->last_cp = cp;
3145 #endif
3146         
3147         /*
3148          *  Insert first the idle task and then our job.
3149          *  The MB should ensure proper ordering.
3150          */
3151         qidx = np->squeueput + 2;
3152         if (qidx >= MAX_QUEUE*2) qidx = 0;
3153
3154         np->squeue [qidx]          = cpu_to_scr(np->idletask_ba);
3155         MEMORY_BARRIER();
3156         np->squeue [np->squeueput] = cpu_to_scr(cp->ccb_ba);
3157
3158         np->squeueput = qidx;
3159
3160         if (DEBUG_FLAGS & DEBUG_QUEUE)
3161                 printf ("%s: queuepos=%d.\n", sym_name (np), np->squeueput);
3162
3163         /*
3164          *  Script processor may be waiting for reselect.
3165          *  Wake it up.
3166          */
3167         MEMORY_BARRIER();
3168         OUTB (nc_istat, SIGP|np->istat_sem);
3169 }
3170
3171
3172 /*
3173  *  Soft reset the chip.
3174  *
3175  *  Raising SRST when the chip is running may cause 
3176  *  problems on dual function chips (see below).
3177  *  On the other hand, LVD devices need some delay 
3178  *  to settle and report actual BUS mode in STEST4.
3179  */
3180 static void sym_chip_reset (hcb_p np)
3181 {
3182         OUTB (nc_istat, SRST);
3183         UDELAY (10);
3184         OUTB (nc_istat, 0);
3185         UDELAY(2000);   /* For BUS MODE to settle */
3186 }
3187
3188 /*
3189  *  Soft reset the chip.
3190  *
3191  *  Some 896 and 876 chip revisions may hang-up if we set 
3192  *  the SRST (soft reset) bit at the wrong time when SCRIPTS 
3193  *  are running.
3194  *  So, we need to abort the current operation prior to 
3195  *  soft resetting the chip.
3196  */
3197 static void sym_soft_reset (hcb_p np)
3198 {
3199         u_char istat;
3200         int i;
3201
3202         OUTB (nc_istat, CABRT);
3203         for (i = 1000000 ; i ; --i) {
3204                 istat = INB (nc_istat);
3205                 if (istat & SIP) {
3206                         INW (nc_sist);
3207                         continue;
3208                 }
3209                 if (istat & DIP) {
3210                         OUTB (nc_istat, 0);
3211                         INB (nc_dstat);
3212                         break;
3213                 }
3214         }
3215         if (!i)
3216                 printf("%s: unable to abort current chip operation.\n",
3217                         sym_name(np));
3218         sym_chip_reset (np);
3219 }
3220
3221 /*
3222  *  Start reset process.
3223  *
3224  *  The interrupt handler will reinitialize the chip.
3225  */
3226 static void sym_start_reset(hcb_p np)
3227 {
3228         (void) sym_reset_scsi_bus(np, 1);
3229 }
3230  
3231 static int sym_reset_scsi_bus(hcb_p np, int enab_int)
3232 {
3233         u32 term;
3234         int retv = 0;
3235
3236         sym_soft_reset(np);     /* Soft reset the chip */
3237         if (enab_int)
3238                 OUTW (nc_sien, RST);
3239         /*
3240          *  Enable Tolerant, reset IRQD if present and 
3241          *  properly set IRQ mode, prior to resetting the bus.
3242          */
3243         OUTB (nc_stest3, TE);
3244         OUTB (nc_dcntl, (np->rv_dcntl & IRQM));
3245         OUTB (nc_scntl1, CRST);
3246         UDELAY (200);
3247
3248         if (!SYM_SETUP_SCSI_BUS_CHECK)
3249                 goto out;
3250         /*
3251          *  Check for no terminators or SCSI bus shorts to ground.
3252          *  Read SCSI data bus, data parity bits and control signals.
3253          *  We are expecting RESET to be TRUE and other signals to be 
3254          *  FALSE.
3255          */
3256         term =  INB(nc_sstat0);
3257         term =  ((term & 2) << 7) + ((term & 1) << 17); /* rst sdp0 */
3258         term |= ((INB(nc_sstat2) & 0x01) << 26) |       /* sdp1     */
3259                 ((INW(nc_sbdl) & 0xff)   << 9)  |       /* d7-0     */
3260                 ((INW(nc_sbdl) & 0xff00) << 10) |       /* d15-8    */
3261                 INB(nc_sbcl);   /* req ack bsy sel atn msg cd io    */
3262
3263         if (!(np->features & FE_WIDE))
3264                 term &= 0x3ffff;
3265
3266         if (term != (2<<7)) {
3267                 printf("%s: suspicious SCSI data while resetting the BUS.\n",
3268                         sym_name(np));
3269                 printf("%s: %sdp0,d7-0,rst,req,ack,bsy,sel,atn,msg,c/d,i/o = "
3270                         "0x%lx, expecting 0x%lx\n",
3271                         sym_name(np),
3272                         (np->features & FE_WIDE) ? "dp1,d15-8," : "",
3273                         (u_long)term, (u_long)(2<<7));
3274                 if (SYM_SETUP_SCSI_BUS_CHECK == 1)
3275                         retv = 1;
3276         }
3277 out:
3278         OUTB (nc_scntl1, 0);
3279         /* MDELAY(100); */
3280         return retv;
3281 }
3282
3283 /*
3284  *  The chip may have completed jobs. Look at the DONE QUEUE.
3285  *
3286  *  On architectures that may reorder LOAD/STORE operations, 
3287  *  a memory barrier may be needed after the reading of the 
3288  *  so-called `flag' and prior to dealing with the data.
3289  */
3290 static int sym_wakeup_done (hcb_p np)
3291 {
3292         ccb_p cp;
3293         int i, n;
3294         u32 dsa;
3295
3296         n = 0;
3297         i = np->dqueueget;
3298         while (1) {
3299                 dsa = scr_to_cpu(np->dqueue[i]);
3300                 if (!dsa)
3301                         break;
3302                 np->dqueue[i] = 0;
3303                 if ((i = i+2) >= MAX_QUEUE*2)
3304                         i = 0;
3305
3306                 cp = sym_ccb_from_dsa(np, dsa);
3307                 if (cp) {
3308                         MEMORY_BARRIER();
3309                         sym_complete_ok (np, cp);
3310                         ++n;
3311                 }
3312                 else
3313                         printf ("%s: bad DSA (%x) in done queue.\n",
3314                                 sym_name(np), (u_int) dsa);
3315         }
3316         np->dqueueget = i;
3317
3318         return n;
3319 }
3320
3321 /*
3322  *  Complete all active CCBs with error.
3323  *  Used on CHIP/SCSI RESET.
3324  */
3325 static void sym_flush_busy_queue (hcb_p np, int cam_status)
3326 {
3327         /*
3328          *  Move all active CCBs to the COMP queue 
3329          *  and flush this queue.
3330          */
3331         sym_que_splice(&np->busy_ccbq, &np->comp_ccbq);
3332         sym_que_init(&np->busy_ccbq);
3333         sym_flush_comp_queue(np, cam_status);
3334 }
3335
3336 /*
3337  *  Start chip.
3338  *
3339  *  'reason' means:
3340  *     0: initialisation.
3341  *     1: SCSI BUS RESET delivered or received.
3342  *     2: SCSI BUS MODE changed.
3343  */
3344 static void sym_init (hcb_p np, int reason)
3345 {
3346         int     i;
3347         u32     phys;
3348
3349         /*
3350          *  Reset chip if asked, otherwise just clear fifos.
3351          */
3352         if (reason == 1)
3353                 sym_soft_reset(np);
3354         else {
3355                 OUTB (nc_stest3, TE|CSF);
3356                 OUTONB (nc_ctest3, CLF);
3357         }
3358  
3359         /*
3360          *  Clear Start Queue
3361          */
3362         phys = np->squeue_ba;
3363         for (i = 0; i < MAX_QUEUE*2; i += 2) {
3364                 np->squeue[i]   = cpu_to_scr(np->idletask_ba);
3365                 np->squeue[i+1] = cpu_to_scr(phys + (i+2)*4);
3366         }
3367         np->squeue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3368
3369         /*
3370          *  Start at first entry.
3371          */
3372         np->squeueput = 0;
3373
3374         /*
3375          *  Clear Done Queue
3376          */
3377         phys = np->dqueue_ba;
3378         for (i = 0; i < MAX_QUEUE*2; i += 2) {
3379                 np->dqueue[i]   = 0;
3380                 np->dqueue[i+1] = cpu_to_scr(phys + (i+2)*4);
3381         }
3382         np->dqueue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3383
3384         /*
3385          *  Start at first entry.
3386          */
3387         np->dqueueget = 0;
3388
3389         /*
3390          *  Install patches in scripts.
3391          *  This also let point to first position the start 
3392          *  and done queue pointers used from SCRIPTS.
3393          */
3394         np->fw_patch(np);
3395
3396         /*
3397          *  Wakeup all pending jobs.
3398          */
3399         sym_flush_busy_queue(np, CAM_SCSI_BUS_RESET);
3400
3401         /*
3402          *  Init chip.
3403          */
3404         OUTB (nc_istat,  0x00   );      /*  Remove Reset, abort */
3405         UDELAY (2000);  /* The 895 needs time for the bus mode to settle */
3406
3407         OUTB (nc_scntl0, np->rv_scntl0 | 0xc0);
3408                                         /*  full arb., ena parity, par->ATN  */
3409         OUTB (nc_scntl1, 0x00);         /*  odd parity, and remove CRST!! */
3410
3411         sym_selectclock(np, np->rv_scntl3);     /* Select SCSI clock */
3412
3413         OUTB (nc_scid  , RRE|np->myaddr);       /* Adapter SCSI address */
3414         OUTW (nc_respid, 1ul<<np->myaddr);      /* Id to respond to */
3415         OUTB (nc_istat , SIGP   );              /*  Signal Process */
3416         OUTB (nc_dmode , np->rv_dmode);         /* Burst length, dma mode */
3417         OUTB (nc_ctest5, np->rv_ctest5);        /* Large fifo + large burst */
3418
3419         OUTB (nc_dcntl , NOCOM|np->rv_dcntl);   /* Protect SFBR */
3420         OUTB (nc_ctest3, np->rv_ctest3);        /* Write and invalidate */
3421         OUTB (nc_ctest4, np->rv_ctest4);        /* Master parity checking */
3422
3423         /* Extended Sreq/Sack filtering not supported on the C10 */
3424         if (np->features & FE_C10)
3425                 OUTB (nc_stest2, np->rv_stest2);
3426         else
3427                 OUTB (nc_stest2, EXT|np->rv_stest2);
3428
3429         OUTB (nc_stest3, TE);                   /* TolerANT enable */
3430         OUTB (nc_stime0, 0x0c);                 /* HTH disabled  STO 0.25 sec */
3431
3432         /*
3433          *  For now, disable AIP generation on C1010-66.
3434          */
3435         if (np->device_id == PCI_ID_LSI53C1010_2)
3436                 OUTB (nc_aipcntl1, DISAIP);
3437
3438         /*
3439          *  C10101 Errata.
3440          *  Errant SGE's when in narrow. Write bits 4 & 5 of
3441          *  STEST1 register to disable SGE. We probably should do 
3442          *  that from SCRIPTS for each selection/reselection, but 
3443          *  I just don't want. :)
3444          */
3445         if (np->device_id == PCI_ID_LSI53C1010 &&
3446             /* np->revision_id < 0xff */ 1)
3447                 OUTB (nc_stest1, INB(nc_stest1) | 0x30);
3448
3449         /*
3450          *  DEL 441 - 53C876 Rev 5 - Part Number 609-0392787/2788 - ITEM 2.
3451          *  Disable overlapped arbitration for some dual function devices, 
3452          *  regardless revision id (kind of post-chip-design feature. ;-))
3453          */
3454         if (np->device_id == PCI_ID_SYM53C875)
3455                 OUTB (nc_ctest0, (1<<5));
3456         else if (np->device_id == PCI_ID_SYM53C896)
3457                 np->rv_ccntl0 |= DPR;
3458
3459         /*
3460          *  Write CCNTL0/CCNTL1 for chips capable of 64 bit addressing 
3461          *  and/or hardware phase mismatch, since only such chips 
3462          *  seem to support those IO registers.
3463          */
3464         if (np->features & (FE_DAC|FE_NOPM)) {
3465                 OUTB (nc_ccntl0, np->rv_ccntl0);
3466                 OUTB (nc_ccntl1, np->rv_ccntl1);
3467         }
3468
3469         /*
3470          *  If phase mismatch handled by scripts (895A/896/1010),
3471          *  set PM jump addresses.
3472          */
3473         if (np->features & FE_NOPM) {
3474                 OUTL (nc_pmjad1, SCRIPTB_BA (np, pm_handle));
3475                 OUTL (nc_pmjad2, SCRIPTB_BA (np, pm_handle));
3476         }
3477
3478         /*
3479          *    Enable GPIO0 pin for writing if LED support from SCRIPTS.
3480          *    Also set GPIO5 and clear GPIO6 if hardware LED control.
3481          */
3482         if (np->features & FE_LED0)
3483                 OUTB(nc_gpcntl, INB(nc_gpcntl) & ~0x01);
3484         else if (np->features & FE_LEDC)
3485                 OUTB(nc_gpcntl, (INB(nc_gpcntl) & ~0x41) | 0x20);
3486
3487         /*
3488          *      enable ints
3489          */
3490         OUTW (nc_sien , STO|HTH|MA|SGE|UDC|RST|PAR);
3491         OUTB (nc_dien , MDPE|BF|SSI|SIR|IID);
3492
3493         /*
3494          *  For 895/6 enable SBMC interrupt and save current SCSI bus mode.
3495          *  Try to eat the spurious SBMC interrupt that may occur when 
3496          *  we reset the chip but not the SCSI BUS (at initialization).
3497          */
3498         if (np->features & (FE_ULTRA2|FE_ULTRA3)) {
3499                 OUTONW (nc_sien, SBMC);
3500                 if (reason == 0) {
3501                         MDELAY(100);
3502                         INW (nc_sist);
3503                 }
3504                 np->scsi_mode = INB (nc_stest4) & SMODE;
3505         }
3506
3507         /*
3508          *  Fill in target structure.
3509          *  Reinitialize usrsync.
3510          *  Reinitialize usrwide.
3511          *  Prepare sync negotiation according to actual SCSI bus mode.
3512          */
3513         for (i=0;i<SYM_CONF_MAX_TARGET;i++) {
3514                 tcb_p tp = &np->target[i];
3515
3516                 tp->to_reset  = 0;
3517                 tp->head.sval = 0;
3518                 tp->head.wval = np->rv_scntl3;
3519                 tp->head.uval = 0;
3520
3521                 tp->tinfo.current.period = 0;
3522                 tp->tinfo.current.offset = 0;
3523                 tp->tinfo.current.width  = BUS_8_BIT;
3524                 tp->tinfo.current.options = 0;
3525         }
3526
3527         /*
3528          *  Download SCSI SCRIPTS to on-chip RAM if present,
3529          *  and start script processor.
3530          */
3531         if (np->ram_ba) {
3532                 if (sym_verbose > 1)
3533                         printf ("%s: Downloading SCSI SCRIPTS.\n",
3534                                 sym_name(np));
3535                 if (np->ram_ws == 8192) {
3536                         OUTRAM_OFF(4096, np->scriptb0, np->scriptb_sz);
3537                         OUTL (nc_mmws, np->scr_ram_seg);
3538                         OUTL (nc_mmrs, np->scr_ram_seg);
3539                         OUTL (nc_sfs,  np->scr_ram_seg);
3540                         phys = SCRIPTB_BA (np, start64);
3541                 }
3542                 else
3543                         phys = SCRIPTA_BA (np, init);
3544                 OUTRAM_OFF(0, np->scripta0, np->scripta_sz);
3545         }
3546         else
3547                 phys = SCRIPTA_BA (np, init);
3548
3549         np->istat_sem = 0;
3550
3551         OUTL (nc_dsa, np->hcb_ba);
3552         OUTL_DSP (phys);
3553
3554         /*
3555          *  Notify the XPT about the RESET condition.
3556          */
3557         if (reason != 0)
3558                 xpt_async(AC_BUS_RESET, np->path, NULL);
3559 }
3560
3561 /*
3562  *  Get clock factor and sync divisor for a given 
3563  *  synchronous factor period.
3564  */
3565 static int 
3566 sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp, u_char *fakp)
3567 {
3568         u32     clk = np->clock_khz;    /* SCSI clock frequency in kHz  */
3569         int     div = np->clock_divn;   /* Number of divisors supported */
3570         u32     fak;                    /* Sync factor in sxfer         */
3571         u32     per;                    /* Period in tenths of ns       */
3572         u32     kpc;                    /* (per * clk)                  */
3573         int     ret;
3574
3575         /*
3576          *  Compute the synchronous period in tenths of nano-seconds
3577          */
3578         if (dt && sfac <= 9)    per = 125;
3579         else if (sfac <= 10)    per = 250;
3580         else if (sfac == 11)    per = 303;
3581         else if (sfac == 12)    per = 500;
3582         else                    per = 40 * sfac;
3583         ret = per;
3584
3585         kpc = per * clk;
3586         if (dt)
3587                 kpc <<= 1;
3588
3589         /*
3590          *  For earliest C10 revision 0, we cannot use extra 
3591          *  clocks for the setting of the SCSI clocking.
3592          *  Note that this limits the lowest sync data transfer 
3593          *  to 5 Mega-transfers per second and may result in
3594          *  using higher clock divisors.
3595          */
3596 #if 1
3597         if ((np->features & (FE_C10|FE_U3EN)) == FE_C10) {
3598                 /*
3599                  *  Look for the lowest clock divisor that allows an 
3600                  *  output speed not faster than the period.
3601                  */
3602                 while (div > 0) {
3603                         --div;
3604                         if (kpc > (div_10M[div] << 2)) {
3605                                 ++div;
3606                                 break;
3607                         }
3608                 }
3609                 fak = 0;                        /* No extra clocks */
3610                 if (div == np->clock_divn) {    /* Are we too fast ? */
3611                         ret = -1;
3612                 }
3613                 *divp = div;
3614                 *fakp = fak;
3615                 return ret;
3616         }
3617 #endif
3618
3619         /*
3620          *  Look for the greatest clock divisor that allows an 
3621          *  input speed faster than the period.
3622          */
3623         while (div-- > 0)
3624                 if (kpc >= (div_10M[div] << 2)) break;
3625
3626         /*
3627          *  Calculate the lowest clock factor that allows an output 
3628          *  speed not faster than the period, and the max output speed.
3629          *  If fak >= 1 we will set both XCLKH_ST and XCLKH_DT.
3630          *  If fak >= 2 we will also set XCLKS_ST and XCLKS_DT.
3631          */
3632         if (dt) {
3633                 fak = (kpc - 1) / (div_10M[div] << 1) + 1 - 2;
3634                 /* ret = ((2+fak)*div_10M[div])/np->clock_khz; */
3635         }
3636         else {
3637                 fak = (kpc - 1) / div_10M[div] + 1 - 4;
3638                 /* ret = ((4+fak)*div_10M[div])/np->clock_khz; */
3639         }
3640
3641         /*
3642          *  Check against our hardware limits, or bugs :).
3643          */
3644         if (fak < 0)    {fak = 0; ret = -1;}
3645         if (fak > 2)    {fak = 2; ret = -1;}
3646
3647         /*
3648          *  Compute and return sync parameters.
3649          */
3650         *divp = div;
3651         *fakp = fak;
3652
3653         return ret;
3654 }
3655
3656 /*
3657  *  Tell the SCSI layer about the new transfer parameters.
3658  */
3659 static void 
3660 sym_xpt_async_transfer_neg(hcb_p np, int target, u_int spi_valid)
3661 {
3662         struct ccb_trans_settings cts;
3663         struct cam_path *path;
3664         int sts;
3665         tcb_p tp = &np->target[target];
3666
3667         sts = xpt_create_path(&path, NULL, cam_sim_path(np->sim), target,
3668                               CAM_LUN_WILDCARD);
3669         if (sts != CAM_REQ_CMP)
3670                 return;
3671
3672         bzero(&cts, sizeof(cts));
3673
3674 #ifdef  FreeBSD_New_Tran_Settings
3675 #define cts__scsi (cts.proto_specific.scsi)
3676 #define cts__spi  (cts.xport_specific.spi)
3677
3678         cts.type      = CTS_TYPE_CURRENT_SETTINGS;
3679         cts.protocol  = PROTO_SCSI;
3680         cts.transport = XPORT_SPI;
3681         cts.protocol_version  = tp->tinfo.current.scsi_version;
3682         cts.transport_version = tp->tinfo.current.spi_version;
3683
3684         cts__spi.valid = spi_valid;
3685         if (spi_valid & CTS_SPI_VALID_SYNC_RATE)
3686                 cts__spi.sync_period = tp->tinfo.current.period;
3687         if (spi_valid & CTS_SPI_VALID_SYNC_OFFSET)
3688                 cts__spi.sync_offset = tp->tinfo.current.offset;
3689         if (spi_valid & CTS_SPI_VALID_BUS_WIDTH)
3690                 cts__spi.bus_width   = tp->tinfo.current.width;
3691         if (spi_valid & CTS_SPI_VALID_PPR_OPTIONS)
3692                 cts__spi.ppr_options = tp->tinfo.current.options;
3693 #undef cts__spi
3694 #undef cts__scsi
3695 #else
3696         cts.valid = spi_valid;
3697         if (spi_valid & CCB_TRANS_SYNC_RATE_VALID)
3698                 cts.sync_period = tp->tinfo.current.period;
3699         if (spi_valid & CCB_TRANS_SYNC_OFFSET_VALID)
3700                 cts.sync_offset = tp->tinfo.current.offset;
3701         if (spi_valid & CCB_TRANS_BUS_WIDTH_VALID)
3702                 cts.bus_width   = tp->tinfo.current.width;
3703 #endif
3704         xpt_setup_ccb(&cts.ccb_h, path, /*priority*/1);
3705         xpt_async(AC_TRANSFER_NEG, path, &cts);
3706         xpt_free_path(path);
3707 }
3708
3709 #ifdef  FreeBSD_New_Tran_Settings
3710 #define SYM_SPI_VALID_WDTR              \
3711         CTS_SPI_VALID_BUS_WIDTH |       \
3712         CTS_SPI_VALID_SYNC_RATE |       \
3713         CTS_SPI_VALID_SYNC_OFFSET
3714 #define SYM_SPI_VALID_SDTR              \
3715         CTS_SPI_VALID_SYNC_RATE |       \
3716         CTS_SPI_VALID_SYNC_OFFSET
3717 #define SYM_SPI_VALID_PPR               \
3718         CTS_SPI_VALID_PPR_OPTIONS |     \
3719         CTS_SPI_VALID_BUS_WIDTH |       \
3720         CTS_SPI_VALID_SYNC_RATE |       \
3721         CTS_SPI_VALID_SYNC_OFFSET
3722 #else
3723 #define SYM_SPI_VALID_WDTR              \
3724         CCB_TRANS_BUS_WIDTH_VALID |     \
3725         CCB_TRANS_SYNC_RATE_VALID |     \
3726         CCB_TRANS_SYNC_OFFSET_VALID
3727 #define SYM_SPI_VALID_SDTR              \
3728         CCB_TRANS_SYNC_RATE_VALID |     \
3729         CCB_TRANS_SYNC_OFFSET_VALID
3730 #define SYM_SPI_VALID_PPR               \
3731         CCB_TRANS_BUS_WIDTH_VALID |     \
3732         CCB_TRANS_SYNC_RATE_VALID |     \
3733         CCB_TRANS_SYNC_OFFSET_VALID
3734 #endif
3735
3736 /*
3737  *  We received a WDTR.
3738  *  Let everything be aware of the changes.
3739  */
3740 static void sym_setwide(hcb_p np, ccb_p cp, u_char wide)
3741 {
3742         tcb_p tp = &np->target[cp->target];
3743
3744         sym_settrans(np, cp, 0, 0, 0, wide, 0, 0);
3745
3746         /*
3747          *  Tell the SCSI layer about the new transfer parameters.
3748          */
3749         tp->tinfo.goal.width = tp->tinfo.current.width = wide;
3750         tp->tinfo.current.offset = 0;
3751         tp->tinfo.current.period = 0;
3752         tp->tinfo.current.options = 0;
3753
3754         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_WDTR);
3755 }
3756
3757 /*
3758  *  We received a SDTR.
3759  *  Let everything be aware of the changes.
3760  */
3761 static void
3762 sym_setsync(hcb_p np, ccb_p cp, u_char ofs, u_char per, u_char div, u_char fak)
3763 {
3764         tcb_p tp = &np->target[cp->target];
3765         u_char wide = (cp->phys.select.sel_scntl3 & EWS) ? 1 : 0;
3766
3767         sym_settrans(np, cp, 0, ofs, per, wide, div, fak);
3768
3769         /*
3770          *  Tell the SCSI layer about the new transfer parameters.
3771          */
3772         tp->tinfo.goal.period   = tp->tinfo.current.period  = per;
3773         tp->tinfo.goal.offset   = tp->tinfo.current.offset  = ofs;
3774         tp->tinfo.goal.options  = tp->tinfo.current.options = 0;
3775
3776         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_SDTR);
3777 }
3778
3779 /*
3780  *  We received a PPR.
3781  *  Let everything be aware of the changes.
3782  */
3783 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3784                          u_char per, u_char wide, u_char div, u_char fak)
3785 {
3786         tcb_p tp = &np->target[cp->target];
3787
3788         sym_settrans(np, cp, dt, ofs, per, wide, div, fak);
3789
3790         /*
3791          *  Tell the SCSI layer about the new transfer parameters.
3792          */
3793         tp->tinfo.goal.width    = tp->tinfo.current.width  = wide;
3794         tp->tinfo.goal.period   = tp->tinfo.current.period = per;
3795         tp->tinfo.goal.offset   = tp->tinfo.current.offset = ofs;
3796         tp->tinfo.goal.options  = tp->tinfo.current.options = dt;
3797
3798         sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_PPR);
3799 }
3800
3801 /*
3802  *  Switch trans mode for current job and it's target.
3803  */
3804 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3805                          u_char per, u_char wide, u_char div, u_char fak)
3806 {
3807         SYM_QUEHEAD *qp;
3808         union   ccb *ccb;
3809         tcb_p tp;
3810         u_char target = INB (nc_sdid) & 0x0f;
3811         u_char sval, wval, uval;
3812
3813         assert (cp);
3814         if (!cp) return;
3815         ccb = cp->cam_ccb;
3816         assert (ccb);
3817         if (!ccb) return;
3818         assert (target == (cp->target & 0xf));
3819         tp = &np->target[target];
3820
3821         sval = tp->head.sval;
3822         wval = tp->head.wval;
3823         uval = tp->head.uval;
3824
3825 #if 0
3826         printf("XXXX sval=%x wval=%x uval=%x (%x)\n", 
3827                 sval, wval, uval, np->rv_scntl3);
3828 #endif
3829         /*
3830          *  Set the offset.
3831          */
3832         if (!(np->features & FE_C10))
3833                 sval = (sval & ~0x1f) | ofs;
3834         else
3835                 sval = (sval & ~0x3f) | ofs;
3836
3837         /*
3838          *  Set the sync divisor and extra clock factor.
3839          */
3840         if (ofs != 0) {
3841                 wval = (wval & ~0x70) | ((div+1) << 4);
3842                 if (!(np->features & FE_C10))
3843                         sval = (sval & ~0xe0) | (fak << 5);
3844                 else {
3845                         uval = uval & ~(XCLKH_ST|XCLKH_DT|XCLKS_ST|XCLKS_DT);
3846                         if (fak >= 1) uval |= (XCLKH_ST|XCLKH_DT);
3847                         if (fak >= 2) uval |= (XCLKS_ST|XCLKS_DT);
3848                 }
3849         }
3850
3851         /*
3852          *  Set the bus width.
3853          */
3854         wval = wval & ~EWS;
3855         if (wide != 0)
3856                 wval |= EWS;
3857
3858         /*
3859          *  Set misc. ultra enable bits.
3860          */
3861         if (np->features & FE_C10) {
3862                 uval = uval & ~(U3EN|AIPCKEN);
3863                 if (dt) {
3864                         assert(np->features & FE_U3EN);
3865                         uval |= U3EN;
3866                 }
3867         }
3868         else {
3869                 wval = wval & ~ULTRA;
3870                 if (per <= 12)  wval |= ULTRA;
3871         }
3872
3873         /*
3874          *   Stop there if sync parameters are unchanged.
3875          */
3876         if (tp->head.sval == sval && 
3877             tp->head.wval == wval &&
3878             tp->head.uval == uval)
3879                 return;
3880         tp->head.sval = sval;
3881         tp->head.wval = wval;
3882         tp->head.uval = uval;
3883
3884         /*
3885          *  Disable extended Sreq/Sack filtering if per < 50.
3886          *  Not supported on the C1010.
3887          */
3888         if (per < 50 && !(np->features & FE_C10))
3889                 OUTOFFB (nc_stest2, EXT);
3890
3891         /*
3892          *  set actual value and sync_status
3893          */
3894         OUTB (nc_sxfer,  tp->head.sval);
3895         OUTB (nc_scntl3, tp->head.wval);
3896
3897         if (np->features & FE_C10) {
3898                 OUTB (nc_scntl4, tp->head.uval);
3899         }
3900
3901         /*
3902          *  patch ALL busy ccbs of this target.
3903          */
3904         FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
3905                 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
3906                 if (cp->target != target)
3907                         continue;
3908                 cp->phys.select.sel_scntl3 = tp->head.wval;
3909                 cp->phys.select.sel_sxfer  = tp->head.sval;
3910                 if (np->features & FE_C10) {
3911                         cp->phys.select.sel_scntl4 = tp->head.uval;
3912                 }
3913         }
3914 }
3915
3916 /*
3917  *  log message for real hard errors
3918  *
3919  *  sym0 targ 0?: ERROR (ds:si) (so-si-sd) (sxfer/scntl3) @ name (dsp:dbc).
3920  *            reg: r0 r1 r2 r3 r4 r5 r6 ..... rf.
3921  *
3922  *  exception register:
3923  *      ds:     dstat
3924  *      si:     sist
3925  *
3926  *  SCSI bus lines:
3927  *      so:     control lines as driven by chip.
3928  *      si:     control lines as seen by chip.
3929  *      sd:     scsi data lines as seen by chip.
3930  *
3931  *  wide/fastmode:
3932  *      sxfer:  (see the manual)
3933  *      scntl3: (see the manual)
3934  *
3935  *  current script command:
3936  *      dsp:    script adress (relative to start of script).
3937  *      dbc:    first word of script command.
3938  *
3939  *  First 24 register of the chip:
3940  *      r0..rf
3941  */
3942 static void sym_log_hard_error(hcb_p np, u_short sist, u_char dstat)
3943 {
3944         u32     dsp;
3945         int     script_ofs;
3946         int     script_size;
3947         char    *script_name;
3948         u_char  *script_base;
3949         int     i;
3950
3951         dsp     = INL (nc_dsp);
3952
3953         if      (dsp > np->scripta_ba &&
3954                  dsp <= np->scripta_ba + np->scripta_sz) {
3955                 script_ofs      = dsp - np->scripta_ba;
3956                 script_size     = np->scripta_sz;
3957                 script_base     = (u_char *) np->scripta0;
3958                 script_name     = "scripta";
3959         }
3960         else if (np->scriptb_ba < dsp && 
3961                  dsp <= np->scriptb_ba + np->scriptb_sz) {
3962                 script_ofs      = dsp - np->scriptb_ba;
3963                 script_size     = np->scriptb_sz;
3964                 script_base     = (u_char *) np->scriptb0;
3965                 script_name     = "scriptb";
3966         } else {
3967                 script_ofs      = dsp;
3968                 script_size     = 0;
3969                 script_base     = 0;
3970                 script_name     = "mem";
3971         }
3972
3973         printf ("%s:%d: ERROR (%x:%x) (%x-%x-%x) (%x/%x) @ (%s %x:%08x).\n",
3974                 sym_name (np), (unsigned)INB (nc_sdid)&0x0f, dstat, sist,
3975                 (unsigned)INB (nc_socl), (unsigned)INB (nc_sbcl),
3976                 (unsigned)INB (nc_sbdl), (unsigned)INB (nc_sxfer),
3977                 (unsigned)INB (nc_scntl3), script_name, script_ofs,
3978                 (unsigned)INL (nc_dbc));
3979
3980         if (((script_ofs & 3) == 0) &&
3981             (unsigned)script_ofs < script_size) {
3982                 printf ("%s: script cmd = %08x\n", sym_name(np),
3983                         scr_to_cpu((int) *(u32 *)(script_base + script_ofs)));
3984         }
3985
3986         printf ("%s: regdump:", sym_name(np));
3987         for (i=0; i<24;i++)
3988             printf (" %02x", (unsigned)INB_OFF(i));
3989         printf (".\n");
3990
3991         /*
3992          *  PCI BUS error, read the PCI ststus register.
3993          */
3994         if (dstat & (MDPE|BF)) {
3995                 u_short pci_sts;
3996 #ifdef FreeBSD_Bus_Io_Abstraction
3997                 pci_sts = pci_read_config(np->device, PCIR_STATUS, 2);
3998 #else
3999                 pci_sts = pci_cfgread(np->pci_tag, PCIR_STATUS, 2);
4000 #endif
4001                 if (pci_sts & 0xf900) {
4002 #ifdef FreeBSD_Bus_Io_Abstraction
4003                         pci_write_config(np->device, PCIR_STATUS, pci_sts, 2);
4004 #else
4005                         pci_cfgwrite(np->pci_tag, PCIR_STATUS, pci_sts, 2);
4006 #endif
4007                         printf("%s: PCI STATUS = 0x%04x\n",
4008                                 sym_name(np), pci_sts & 0xf900);
4009                 }
4010         }
4011 }
4012
4013 /*
4014  *  chip interrupt handler
4015  *
4016  *  In normal situations, interrupt conditions occur one at 
4017  *  a time. But when something bad happens on the SCSI BUS, 
4018  *  the chip may raise several interrupt flags before 
4019  *  stopping and interrupting the CPU. The additionnal 
4020  *  interrupt flags are stacked in some extra registers 
4021  *  after the SIP and/or DIP flag has been raised in the 
4022  *  ISTAT. After the CPU has read the interrupt condition 
4023  *  flag from SIST or DSTAT, the chip unstacks the other 
4024  *  interrupt flags and sets the corresponding bits in 
4025  *  SIST or DSTAT. Since the chip starts stacking once the 
4026  *  SIP or DIP flag is set, there is a small window of time 
4027  *  where the stacking does not occur.
4028  *
4029  *  Typically, multiple interrupt conditions may happen in 
4030  *  the following situations:
4031  *
4032  *  - SCSI parity error + Phase mismatch  (PAR|MA)
4033  *    When an parity error is detected in input phase 
4034  *    and the device switches to msg-in phase inside a 
4035  *    block MOV.
4036  *  - SCSI parity error + Unexpected disconnect (PAR|UDC)
4037  *    When a stupid device does not want to handle the 
4038  *    recovery of an SCSI parity error.
4039  *  - Some combinations of STO, PAR, UDC, ...
4040  *    When using non compliant SCSI stuff, when user is 
4041  *    doing non compliant hot tampering on the BUS, when 
4042  *    something really bad happens to a device, etc ...
4043  *
4044  *  The heuristic suggested by SYMBIOS to handle 
4045  *  multiple interrupts is to try unstacking all 
4046  *  interrupts conditions and to handle them on some 
4047  *  priority based on error severity.
4048  *  This will work when the unstacking has been 
4049  *  successful, but we cannot be 100 % sure of that, 
4050  *  since the CPU may have been faster to unstack than 
4051  *  the chip is able to stack. Hmmm ... But it seems that 
4052  *  such a situation is very unlikely to happen.
4053  *
4054  *  If this happen, for example STO caught by the CPU 
4055  *  then UDC happenning before the CPU have restarted 
4056  *  the SCRIPTS, the driver may wrongly complete the 
4057  *  same command on UDC, since the SCRIPTS didn't restart 
4058  *  and the DSA still points to the same command.
4059  *  We avoid this situation by setting the DSA to an 
4060  *  invalid value when the CCB is completed and before 
4061  *  restarting the SCRIPTS.
4062  *
4063  *  Another issue is that we need some section of our 
4064  *  recovery procedures to be somehow uninterruptible but 
4065  *  the SCRIPTS processor does not provides such a 
4066  *  feature. For this reason, we handle recovery preferently 
4067  *  from the C code and check against some SCRIPTS critical 
4068  *  sections from the C code.
4069  *
4070  *  Hopefully, the interrupt handling of the driver is now 
4071  *  able to resist to weird BUS error conditions, but donnot 
4072  *  ask me for any guarantee that it will never fail. :-)
4073  *  Use at your own decision and risk.
4074  */
4075
4076 static void sym_intr1 (hcb_p np)
4077 {
4078         u_char  istat, istatc;
4079         u_char  dstat;
4080         u_short sist;
4081
4082         /*
4083          *  interrupt on the fly ?
4084          *
4085          *  A `dummy read' is needed to ensure that the 
4086          *  clear of the INTF flag reaches the device 
4087          *  before the scanning of the DONE queue.
4088          */
4089         istat = INB (nc_istat);
4090         if (istat & INTF) {
4091                 OUTB (nc_istat, (istat & SIGP) | INTF | np->istat_sem);
4092                 istat = INB (nc_istat);         /* DUMMY READ */
4093                 if (DEBUG_FLAGS & DEBUG_TINY) printf ("F ");
4094                 (void)sym_wakeup_done (np);
4095         };
4096
4097         if (!(istat & (SIP|DIP)))
4098                 return;
4099
4100 #if 0   /* We should never get this one */
4101         if (istat & CABRT)
4102                 OUTB (nc_istat, CABRT);
4103 #endif
4104
4105         /*
4106          *  PAR and MA interrupts may occur at the same time,
4107          *  and we need to know of both in order to handle 
4108          *  this situation properly. We try to unstack SCSI 
4109          *  interrupts for that reason. BTW, I dislike a LOT 
4110          *  such a loop inside the interrupt routine.
4111          *  Even if DMA interrupt stacking is very unlikely to 
4112          *  happen, we also try unstacking these ones, since 
4113          *  this has no performance impact.
4114          */
4115         sist    = 0;
4116         dstat   = 0;
4117         istatc  = istat;
4118         do {
4119                 if (istatc & SIP)
4120                         sist  |= INW (nc_sist);
4121                 if (istatc & DIP)
4122                         dstat |= INB (nc_dstat);
4123                 istatc = INB (nc_istat);
4124                 istat |= istatc;
4125         } while (istatc & (SIP|DIP));
4126
4127         if (DEBUG_FLAGS & DEBUG_TINY)
4128                 printf ("<%d|%x:%x|%x:%x>",
4129                         (int)INB(nc_scr0),
4130                         dstat,sist,
4131                         (unsigned)INL(nc_dsp),
4132                         (unsigned)INL(nc_dbc));
4133         /*
4134          *  On paper, a memory barrier may be needed here.
4135          *  And since we are paranoid ... :)
4136          */
4137         MEMORY_BARRIER();
4138
4139         /*
4140          *  First, interrupts we want to service cleanly.
4141          *
4142          *  Phase mismatch (MA) is the most frequent interrupt 
4143          *  for chip earlier than the 896 and so we have to service 
4144          *  it as quickly as possible.
4145          *  A SCSI parity error (PAR) may be combined with a phase 
4146          *  mismatch condition (MA).
4147          *  Programmed interrupts (SIR) are used to call the C code 
4148          *  from SCRIPTS.
4149          *  The single step interrupt (SSI) is not used in this 
4150          *  driver.
4151          */
4152         if (!(sist  & (STO|GEN|HTH|SGE|UDC|SBMC|RST)) &&
4153             !(dstat & (MDPE|BF|ABRT|IID))) {
4154                 if      (sist & PAR)    sym_int_par (np, sist);
4155                 else if (sist & MA)     sym_int_ma (np);
4156                 else if (dstat & SIR)   sym_int_sir (np);
4157                 else if (dstat & SSI)   OUTONB_STD ();
4158                 else                    goto unknown_int;
4159                 return;
4160         };
4161
4162         /*
4163          *  Now, interrupts that donnot happen in normal 
4164          *  situations and that we may need to recover from.
4165          *
4166          *  On SCSI RESET (RST), we reset everything.
4167          *  On SCSI BUS MODE CHANGE (SBMC), we complete all 
4168          *  active CCBs with RESET status, prepare all devices 
4169          *  for negotiating again and restart the SCRIPTS.
4170          *  On STO and UDC, we complete the CCB with the corres- 
4171          *  ponding status and restart the SCRIPTS.
4172          */
4173         if (sist & RST) {
4174                 xpt_print_path(np->path);
4175                 printf("SCSI BUS reset detected.\n");
4176                 sym_init (np, 1);
4177                 return;
4178         };
4179
4180         OUTB (nc_ctest3, np->rv_ctest3 | CLF);  /* clear dma fifo  */
4181         OUTB (nc_stest3, TE|CSF);               /* clear scsi fifo */
4182
4183         if (!(sist  & (GEN|HTH|SGE)) &&
4184             !(dstat & (MDPE|BF|ABRT|IID))) {
4185                 if      (sist & SBMC)   sym_int_sbmc (np);
4186                 else if (sist & STO)    sym_int_sto (np);
4187                 else if (sist & UDC)    sym_int_udc (np);
4188                 else                    goto unknown_int;
4189                 return;
4190         };
4191
4192         /*
4193          *  Now, interrupts we are not able to recover cleanly.
4194          *
4195          *  Log message for hard errors.
4196          *  Reset everything.
4197          */
4198
4199         sym_log_hard_error(np, sist, dstat);
4200
4201         if ((sist & (GEN|HTH|SGE)) ||
4202                 (dstat & (MDPE|BF|ABRT|IID))) {
4203                 sym_start_reset(np);
4204                 return;
4205         };
4206
4207 unknown_int:
4208         /*
4209          *  We just miss the cause of the interrupt. :(
4210          *  Print a message. The timeout will do the real work.
4211          */
4212         printf( "%s: unknown interrupt(s) ignored, "
4213                 "ISTAT=0x%x DSTAT=0x%x SIST=0x%x\n",
4214                 sym_name(np), istat, dstat, sist);
4215 }
4216
4217 static void sym_intr(void *arg)
4218 {
4219         if (DEBUG_FLAGS & DEBUG_TINY) printf ("[");
4220         sym_intr1((hcb_p) arg);
4221         if (DEBUG_FLAGS & DEBUG_TINY) printf ("]");
4222         return;
4223 }
4224
4225 static void sym_poll(struct cam_sim *sim)
4226 {
4227         int s = splcam();
4228         sym_intr(cam_sim_softc(sim));  
4229         splx(s);
4230 }
4231
4232
4233 /*
4234  *  generic recovery from scsi interrupt
4235  *
4236  *  The doc says that when the chip gets an SCSI interrupt,
4237  *  it tries to stop in an orderly fashion, by completing 
4238  *  an instruction fetch that had started or by flushing 
4239  *  the DMA fifo for a write to memory that was executing.
4240  *  Such a fashion is not enough to know if the instruction 
4241  *  that was just before the current DSP value has been 
4242  *  executed or not.
4243  *
4244  *  There are some small SCRIPTS sections that deal with 
4245  *  the start queue and the done queue that may break any 
4246  *  assomption from the C code if we are interrupted 
4247  *  inside, so we reset if this happens. Btw, since these 
4248  *  SCRIPTS sections are executed while the SCRIPTS hasn't 
4249  *  started SCSI operations, it is very unlikely to happen.
4250  *
4251  *  All the driver data structures are supposed to be 
4252  *  allocated from the same 4 GB memory window, so there 
4253  *  is a 1 to 1 relationship between DSA and driver data 
4254  *  structures. Since we are careful :) to invalidate the 
4255  *  DSA when we complete a command or when the SCRIPTS 
4256  *  pushes a DSA into a queue, we can trust it when it 
4257  *  points to a CCB.
4258  */
4259 static void sym_recover_scsi_int (hcb_p np, u_char hsts)
4260 {
4261         u32     dsp     = INL (nc_dsp);
4262         u32     dsa     = INL (nc_dsa);
4263         ccb_p cp        = sym_ccb_from_dsa(np, dsa);
4264
4265         /*
4266          *  If we haven't been interrupted inside the SCRIPTS 
4267          *  critical pathes, we can safely restart the SCRIPTS 
4268          *  and trust the DSA value if it matches a CCB.
4269          */
4270         if ((!(dsp > SCRIPTA_BA (np, getjob_begin) &&
4271                dsp < SCRIPTA_BA (np, getjob_end) + 1)) &&
4272             (!(dsp > SCRIPTA_BA (np, ungetjob) &&
4273                dsp < SCRIPTA_BA (np, reselect) + 1)) &&
4274             (!(dsp > SCRIPTB_BA (np, sel_for_abort) &&
4275                dsp < SCRIPTB_BA (np, sel_for_abort_1) + 1)) &&
4276             (!(dsp > SCRIPTA_BA (np, done) &&
4277                dsp < SCRIPTA_BA (np, done_end) + 1))) {
4278                 OUTB (nc_ctest3, np->rv_ctest3 | CLF);  /* clear dma fifo  */
4279                 OUTB (nc_stest3, TE|CSF);               /* clear scsi fifo */
4280                 /*
4281                  *  If we have a CCB, let the SCRIPTS call us back for 
4282                  *  the handling of the error with SCRATCHA filled with 
4283                  *  STARTPOS. This way, we will be able to freeze the 
4284                  *  device queue and requeue awaiting IOs.
4285                  */
4286                 if (cp) {
4287                         cp->host_status = hsts;
4288                         OUTL_DSP (SCRIPTA_BA (np, complete_error));
4289                 }
4290                 /*
4291                  *  Otherwise just restart the SCRIPTS.
4292                  */
4293                 else {
4294                         OUTL (nc_dsa, 0xffffff);
4295                         OUTL_DSP (SCRIPTA_BA (np, start));
4296                 }
4297         }
4298         else
4299                 goto reset_all;
4300
4301         return;
4302
4303 reset_all:
4304         sym_start_reset(np);
4305 }
4306
4307 /*
4308  *  chip exception handler for selection timeout
4309  */
4310 void sym_int_sto (hcb_p np)
4311 {
4312         u32 dsp = INL (nc_dsp);
4313
4314         if (DEBUG_FLAGS & DEBUG_TINY) printf ("T");
4315
4316         if (dsp == SCRIPTA_BA (np, wf_sel_done) + 8)
4317                 sym_recover_scsi_int(np, HS_SEL_TIMEOUT);
4318         else
4319                 sym_start_reset(np);
4320 }
4321
4322 /*
4323  *  chip exception handler for unexpected disconnect
4324  */
4325 void sym_int_udc (hcb_p np)
4326 {
4327         printf ("%s: unexpected disconnect\n", sym_name(np));
4328         sym_recover_scsi_int(np, HS_UNEXPECTED);
4329 }
4330
4331 /*
4332  *  chip exception handler for SCSI bus mode change
4333  *
4334  *  spi2-r12 11.2.3 says a transceiver mode change must 
4335  *  generate a reset event and a device that detects a reset 
4336  *  event shall initiate a hard reset. It says also that a
4337  *  device that detects a mode change shall set data transfer 
4338  *  mode to eight bit asynchronous, etc...
4339  *  So, just reinitializing all except chip should be enough.
4340  */
4341 static void sym_int_sbmc (hcb_p np)
4342 {
4343         u_char scsi_mode = INB (nc_stest4) & SMODE;
4344
4345         /*
4346          *  Notify user.
4347          */
4348         xpt_print_path(np->path);
4349         printf("SCSI BUS mode change from %s to %s.\n",
4350                 sym_scsi_bus_mode(np->scsi_mode), sym_scsi_bus_mode(scsi_mode));
4351
4352         /*
4353          *  Should suspend command processing for a few seconds and 
4354          *  reinitialize all except the chip.
4355          */
4356         sym_init (np, 2);
4357 }
4358
4359 /*
4360  *  chip exception handler for SCSI parity error.
4361  *
4362  *  When the chip detects a SCSI parity error and is 
4363  *  currently executing a (CH)MOV instruction, it does 
4364  *  not interrupt immediately, but tries to finish the 
4365  *  transfer of the current scatter entry before 
4366  *  interrupting. The following situations may occur:
4367  *
4368  *  - The complete scatter entry has been transferred 
4369  *    without the device having changed phase.
4370  *    The chip will then interrupt with the DSP pointing 
4371  *    to the instruction that follows the MOV.
4372  *
4373  *  - A phase mismatch occurs before the MOV finished 
4374  *    and phase errors are to be handled by the C code.
4375  *    The chip will then interrupt with both PAR and MA 
4376  *    conditions set.
4377  *
4378  *  - A phase mismatch occurs before the MOV finished and 
4379  *    phase errors are to be handled by SCRIPTS.
4380  *    The chip will load the DSP with the phase mismatch 
4381  *    JUMP address and interrupt the host processor.
4382  */
4383 static void sym_int_par (hcb_p np, u_short sist)
4384 {
4385         u_char  hsts    = INB (HS_PRT);
4386         u32     dsp     = INL (nc_dsp);
4387         u32     dbc     = INL (nc_dbc);
4388         u32     dsa     = INL (nc_dsa);
4389         u_char  sbcl    = INB (nc_sbcl);
4390         u_char  cmd     = dbc >> 24;
4391         int phase       = cmd & 7;
4392         ccb_p   cp      = sym_ccb_from_dsa(np, dsa);
4393
4394         printf("%s: SCSI parity error detected: SCR1=%d DBC=%x SBCL=%x\n",
4395                 sym_name(np), hsts, dbc, sbcl);
4396
4397         /*
4398          *  Check that the chip is connected to the SCSI BUS.
4399          */
4400         if (!(INB (nc_scntl1) & ISCON)) {
4401                 sym_recover_scsi_int(np, HS_UNEXPECTED);
4402                 return;
4403         }
4404
4405         /*
4406          *  If the nexus is not clearly identified, reset the bus.
4407          *  We will try to do better later.
4408          */
4409         if (!cp)
4410                 goto reset_all;
4411
4412         /*
4413          *  Check instruction was a MOV, direction was INPUT and 
4414          *  ATN is asserted.
4415          */
4416         if ((cmd & 0xc0) || !(phase & 1) || !(sbcl & 0x8))
4417                 goto reset_all;
4418
4419         /*
4420          *  Keep track of the parity error.
4421          */
4422         OUTONB (HF_PRT, HF_EXT_ERR);
4423         cp->xerr_status |= XE_PARITY_ERR;
4424
4425         /*
4426          *  Prepare the message to send to the device.
4427          */
4428         np->msgout[0] = (phase == 7) ? M_PARITY : M_ID_ERROR;
4429
4430         /*
4431          *  If the old phase was DATA IN phase, we have to deal with
4432          *  the 3 situations described above.
4433          *  For other input phases (MSG IN and STATUS), the device 
4434          *  must resend the whole thing that failed parity checking 
4435          *  or signal error. So, jumping to dispatcher should be OK.
4436          */
4437         if (phase == 1 || phase == 5) {
4438                 /* Phase mismatch handled by SCRIPTS */
4439                 if (dsp == SCRIPTB_BA (np, pm_handle))
4440                         OUTL_DSP (dsp);
4441                 /* Phase mismatch handled by the C code */
4442                 else if (sist & MA)
4443                         sym_int_ma (np);
4444                 /* No phase mismatch occurred */
4445                 else {
4446                         OUTL (nc_temp, dsp);
4447                         OUTL_DSP (SCRIPTA_BA (np, dispatch));
4448                 }
4449         }
4450         else 
4451                 OUTL_DSP (SCRIPTA_BA (np, clrack));
4452         return;
4453
4454 reset_all:
4455         sym_start_reset(np);
4456         return;
4457 }
4458
4459 /*
4460  *  chip exception handler for phase errors.
4461  *
4462  *  We have to construct a new transfer descriptor,
4463  *  to transfer the rest of the current block.
4464  */
4465 static void sym_int_ma (hcb_p np)
4466 {
4467         u32     dbc;
4468         u32     rest;
4469         u32     dsp;
4470         u32     dsa;
4471         u32     nxtdsp;
4472         u32     *vdsp;
4473         u32     oadr, olen;
4474         u32     *tblp;
4475         u32     newcmd;
4476         u_int   delta;
4477         u_char  cmd;
4478         u_char  hflags, hflags0;
4479         struct  sym_pmc *pm;
4480         ccb_p   cp;
4481
4482         dsp     = INL (nc_dsp);
4483         dbc     = INL (nc_dbc);
4484         dsa     = INL (nc_dsa);
4485
4486         cmd     = dbc >> 24;
4487         rest    = dbc & 0xffffff;
4488         delta   = 0;
4489
4490         /*
4491          *  locate matching cp if any.
4492          */
4493         cp = sym_ccb_from_dsa(np, dsa);
4494
4495         /*
4496          *  Donnot take into account dma fifo and various buffers in 
4497          *  INPUT phase since the chip flushes everything before 
4498          *  raising the MA interrupt for interrupted INPUT phases.
4499          *  For DATA IN phase, we will check for the SWIDE later.
4500          */
4501         if ((cmd & 7) != 1 && (cmd & 7) != 5) {
4502                 u_char ss0, ss2;
4503
4504                 if (np->features & FE_DFBC)
4505                         delta = INW (nc_dfbc);
4506                 else {
4507                         u32 dfifo;
4508
4509                         /*
4510                          * Read DFIFO, CTEST[4-6] using 1 PCI bus ownership.
4511                          */
4512                         dfifo = INL(nc_dfifo);
4513
4514                         /*
4515                          *  Calculate remaining bytes in DMA fifo.
4516                          *  (CTEST5 = dfifo >> 16)
4517                          */
4518                         if (dfifo & (DFS << 16))
4519                                 delta = ((((dfifo >> 8) & 0x300) |
4520                                           (dfifo & 0xff)) - rest) & 0x3ff;
4521                         else
4522                                 delta = ((dfifo & 0xff) - rest) & 0x7f;
4523                 }
4524
4525                 /*
4526                  *  The data in the dma fifo has not been transfered to
4527                  *  the target -> add the amount to the rest
4528                  *  and clear the data.
4529                  *  Check the sstat2 register in case of wide transfer.
4530                  */
4531                 rest += delta;
4532                 ss0  = INB (nc_sstat0);
4533                 if (ss0 & OLF) rest++;
4534                 if (!(np->features & FE_C10))
4535                         if (ss0 & ORF) rest++;
4536                 if (cp && (cp->phys.select.sel_scntl3 & EWS)) {
4537                         ss2 = INB (nc_sstat2);
4538                         if (ss2 & OLF1) rest++;
4539                         if (!(np->features & FE_C10))
4540                                 if (ss2 & ORF1) rest++;
4541                 };
4542
4543                 /*
4544                  *  Clear fifos.
4545                  */
4546                 OUTB (nc_ctest3, np->rv_ctest3 | CLF);  /* dma fifo  */
4547                 OUTB (nc_stest3, TE|CSF);               /* scsi fifo */
4548         }
4549
4550         /*
4551          *  log the information
4552          */
4553         if (DEBUG_FLAGS & (DEBUG_TINY|DEBUG_PHASE))
4554                 printf ("P%x%x RL=%d D=%d ", cmd&7, INB(nc_sbcl)&7,
4555                         (unsigned) rest, (unsigned) delta);
4556
4557         /*
4558          *  try to find the interrupted script command,
4559          *  and the address at which to continue.
4560          */
4561         vdsp    = 0;
4562         nxtdsp  = 0;
4563         if      (dsp >  np->scripta_ba &&
4564                  dsp <= np->scripta_ba + np->scripta_sz) {
4565                 vdsp = (u32 *)((char*)np->scripta0 + (dsp-np->scripta_ba-8));
4566                 nxtdsp = dsp;
4567         }
4568         else if (dsp >  np->scriptb_ba &&
4569                  dsp <= np->scriptb_ba + np->scriptb_sz) {
4570                 vdsp = (u32 *)((char*)np->scriptb0 + (dsp-np->scriptb_ba-8));
4571                 nxtdsp = dsp;
4572         }
4573
4574         /*
4575          *  log the information
4576          */
4577         if (DEBUG_FLAGS & DEBUG_PHASE) {
4578                 printf ("\nCP=%p DSP=%x NXT=%x VDSP=%p CMD=%x ",
4579                         cp, (unsigned)dsp, (unsigned)nxtdsp, vdsp, cmd);
4580         };
4581
4582         if (!vdsp) {
4583                 printf ("%s: interrupted SCRIPT address not found.\n", 
4584                         sym_name (np));
4585                 goto reset_all;
4586         }
4587
4588         if (!cp) {
4589                 printf ("%s: SCSI phase error fixup: CCB already dequeued.\n", 
4590                         sym_name (np));
4591                 goto reset_all;
4592         }
4593
4594         /*
4595          *  get old startaddress and old length.
4596          */
4597         oadr = scr_to_cpu(vdsp[1]);
4598
4599         if (cmd & 0x10) {       /* Table indirect */
4600                 tblp = (u32 *) ((char*) &cp->phys + oadr);
4601                 olen = scr_to_cpu(tblp[0]);
4602                 oadr = scr_to_cpu(tblp[1]);
4603         } else {
4604                 tblp = (u32 *) 0;
4605                 olen = scr_to_cpu(vdsp[0]) & 0xffffff;
4606         };
4607
4608         if (DEBUG_FLAGS & DEBUG_PHASE) {
4609                 printf ("OCMD=%x\nTBLP=%p OLEN=%x OADR=%x\n",
4610                         (unsigned) (scr_to_cpu(vdsp[0]) >> 24),
4611                         tblp,
4612                         (unsigned) olen,
4613                         (unsigned) oadr);
4614         };
4615
4616         /*
4617          *  check cmd against assumed interrupted script command.
4618          *  If dt data phase, the MOVE instruction hasn't bit 4 of 
4619          *  the phase.
4620          */
4621         if (((cmd & 2) ? cmd : (cmd & ~4)) != (scr_to_cpu(vdsp[0]) >> 24)) {
4622                 PRINT_ADDR(cp);
4623                 printf ("internal error: cmd=%02x != %02x=(vdsp[0] >> 24)\n",
4624                         (unsigned)cmd, (unsigned)scr_to_cpu(vdsp[0]) >> 24);
4625
4626                 goto reset_all;
4627         };
4628
4629         /*
4630          *  if old phase not dataphase, leave here.
4631          */
4632         if (cmd & 2) {
4633                 PRINT_ADDR(cp);
4634                 printf ("phase change %x-%x %d@%08x resid=%d.\n",
4635                         cmd&7, INB(nc_sbcl)&7, (unsigned)olen,
4636                         (unsigned)oadr, (unsigned)rest);
4637                 goto unexpected_phase;
4638         };
4639
4640         /*
4641          *  Choose the correct PM save area.
4642          *
4643          *  Look at the PM_SAVE SCRIPT if you want to understand 
4644          *  this stuff. The equivalent code is implemented in 
4645          *  SCRIPTS for the 895A, 896 and 1010 that are able to 
4646          *  handle PM from the SCRIPTS processor.
4647          */
4648         hflags0 = INB (HF_PRT);
4649         hflags = hflags0;
4650
4651         if (hflags & (HF_IN_PM0 | HF_IN_PM1 | HF_DP_SAVED)) {
4652                 if (hflags & HF_IN_PM0)
4653                         nxtdsp = scr_to_cpu(cp->phys.pm0.ret);
4654                 else if (hflags & HF_IN_PM1)
4655                         nxtdsp = scr_to_cpu(cp->phys.pm1.ret);
4656
4657                 if (hflags & HF_DP_SAVED)
4658                         hflags ^= HF_ACT_PM;
4659         }
4660
4661         if (!(hflags & HF_ACT_PM)) {
4662                 pm = &cp->phys.pm0;
4663                 newcmd = SCRIPTA_BA (np, pm0_data);
4664         }
4665         else {
4666                 pm = &cp->phys.pm1;
4667                 newcmd = SCRIPTA_BA (np, pm1_data);
4668         }
4669
4670         hflags &= ~(HF_IN_PM0 | HF_IN_PM1 | HF_DP_SAVED);
4671         if (hflags != hflags0)
4672                 OUTB (HF_PRT, hflags);
4673
4674         /*
4675          *  fillin the phase mismatch context
4676          */
4677         pm->sg.addr = cpu_to_scr(oadr + olen - rest);
4678         pm->sg.size = cpu_to_scr(rest);
4679         pm->ret     = cpu_to_scr(nxtdsp);
4680
4681         /*
4682          *  If we have a SWIDE,
4683          *  - prepare the address to write the SWIDE from SCRIPTS,
4684          *  - compute the SCRIPTS address to restart from,
4685          *  - move current data pointer context by one byte.
4686          */
4687         nxtdsp = SCRIPTA_BA (np, dispatch);
4688         if ((cmd & 7) == 1 && cp && (cp->phys.select.sel_scntl3 & EWS) &&
4689             (INB (nc_scntl2) & WSR)) {
4690                 u32 tmp;
4691
4692                 /*
4693                  *  Set up the table indirect for the MOVE
4694                  *  of the residual byte and adjust the data 
4695                  *  pointer context.
4696                  */
4697                 tmp = scr_to_cpu(pm->sg.addr);
4698                 cp->phys.wresid.addr = cpu_to_scr(tmp);
4699                 pm->sg.addr = cpu_to_scr(tmp + 1);
4700                 tmp = scr_to_cpu(pm->sg.size);
4701                 cp->phys.wresid.size = cpu_to_scr((tmp&0xff000000) | 1);
4702                 pm->sg.size = cpu_to_scr(tmp - 1);
4703
4704                 /*
4705                  *  If only the residual byte is to be moved, 
4706                  *  no PM context is needed.
4707                  */
4708                 if ((tmp&0xffffff) == 1)
4709                         newcmd = pm->ret;
4710
4711                 /*
4712                  *  Prepare the address of SCRIPTS that will 
4713                  *  move the residual byte to memory.
4714                  */
4715                 nxtdsp = SCRIPTB_BA (np, wsr_ma_helper);
4716         }
4717
4718         if (DEBUG_FLAGS & DEBUG_PHASE) {
4719                 PRINT_ADDR(cp);
4720                 printf ("PM %x %x %x / %x %x %x.\n",
4721                         hflags0, hflags, newcmd,
4722                         (unsigned)scr_to_cpu(pm->sg.addr),
4723                         (unsigned)scr_to_cpu(pm->sg.size),
4724                         (unsigned)scr_to_cpu(pm->ret));
4725         }
4726
4727         /*
4728          *  Restart the SCRIPTS processor.
4729          */
4730         OUTL (nc_temp, newcmd);
4731         OUTL_DSP (nxtdsp);
4732         return;
4733
4734         /*
4735          *  Unexpected phase changes that occurs when the current phase 
4736          *  is not a DATA IN or DATA OUT phase are due to error conditions.
4737          *  Such event may only happen when the SCRIPTS is using a 
4738          *  multibyte SCSI MOVE.
4739          *
4740          *  Phase change                Some possible cause
4741          *
4742          *  COMMAND  --> MSG IN SCSI parity error detected by target.
4743          *  COMMAND  --> STATUS Bad command or refused by target.
4744          *  MSG OUT  --> MSG IN     Message rejected by target.
4745          *  MSG OUT  --> COMMAND    Bogus target that discards extended
4746          *                      negotiation messages.
4747          *
4748          *  The code below does not care of the new phase and so 
4749          *  trusts the target. Why to annoy it ?
4750          *  If the interrupted phase is COMMAND phase, we restart at
4751          *  dispatcher.
4752          *  If a target does not get all the messages after selection, 
4753          *  the code assumes blindly that the target discards extended 
4754          *  messages and clears the negotiation status.
4755          *  If the target does not want all our response to negotiation,
4756          *  we force a SIR_NEGO_PROTO interrupt (it is a hack that avoids 
4757          *  bloat for such a should_not_happen situation).
4758          *  In all other situation, we reset the BUS.
4759          *  Are these assumptions reasonnable ? (Wait and see ...)
4760          */
4761 unexpected_phase:
4762         dsp -= 8;
4763         nxtdsp = 0;
4764
4765         switch (cmd & 7) {
4766         case 2: /* COMMAND phase */
4767                 nxtdsp = SCRIPTA_BA (np, dispatch);
4768                 break;
4769 #if 0
4770         case 3: /* STATUS  phase */
4771                 nxtdsp = SCRIPTA_BA (np, dispatch);
4772                 break;
4773 #endif
4774         case 6: /* MSG OUT phase */
4775                 /*
4776                  *  If the device may want to use untagged when we want 
4777                  *  tagged, we prepare an IDENTIFY without disc. granted, 
4778                  *  since we will not be able to handle reselect.
4779                  *  Otherwise, we just don't care.
4780                  */
4781                 if      (dsp == SCRIPTA_BA (np, send_ident)) {
4782                         if (cp->tag != NO_TAG && olen - rest <= 3) {
4783                                 cp->host_status = HS_BUSY;
4784                                 np->msgout[0] = M_IDENTIFY | cp->lun;
4785                                 nxtdsp = SCRIPTB_BA (np, ident_break_atn);
4786                         }
4787                         else
4788                                 nxtdsp = SCRIPTB_BA (np, ident_break);
4789                 }
4790                 else if (dsp == SCRIPTB_BA (np, send_wdtr) ||
4791                          dsp == SCRIPTB_BA (np, send_sdtr) ||
4792                          dsp == SCRIPTB_BA (np, send_ppr)) {
4793                         nxtdsp = SCRIPTB_BA (np, nego_bad_phase);
4794                 }
4795                 break;
4796 #if 0
4797         case 7: /* MSG IN  phase */
4798                 nxtdsp = SCRIPTA_BA (np, clrack);
4799                 break;
4800 #endif
4801         }
4802
4803         if (nxtdsp) {
4804                 OUTL_DSP (nxtdsp);
4805                 return;
4806         }
4807
4808 reset_all:
4809         sym_start_reset(np);
4810 }
4811
4812 /*
4813  *  Dequeue from the START queue all CCBs that match 
4814  *  a given target/lun/task condition (-1 means all),
4815  *  and move them from the BUSY queue to the COMP queue 
4816  *  with CAM_REQUEUE_REQ status condition.
4817  *  This function is used during error handling/recovery.
4818  *  It is called with SCRIPTS not running.
4819  */
4820 static int
4821 sym_dequeue_from_squeue(hcb_p np, int i, int target, int lun, int task)
4822 {
4823         int j;
4824         ccb_p cp;
4825
4826         /*
4827          *  Make sure the starting index is within range.
4828          */
4829         assert((i >= 0) && (i < 2*MAX_QUEUE));
4830
4831         /*
4832          *  Walk until end of START queue and dequeue every job 
4833          *  that matches the target/lun/task condition.
4834          */
4835         j = i;
4836         while (i != np->squeueput) {
4837                 cp = sym_ccb_from_dsa(np, scr_to_cpu(np->squeue[i]));
4838                 assert(cp);
4839 #ifdef SYM_CONF_IARB_SUPPORT
4840                 /* Forget hints for IARB, they may be no longer relevant */
4841                 cp->host_flags &= ~HF_HINT_IARB;
4842 #endif
4843                 if ((target == -1 || cp->target == target) &&
4844                     (lun    == -1 || cp->lun    == lun)    &&
4845                     (task   == -1 || cp->tag    == task)) {
4846                         sym_set_cam_status(cp->cam_ccb, CAM_REQUEUE_REQ);
4847                         sym_remque(&cp->link_ccbq);
4848                         sym_insque_tail(&cp->link_ccbq, &np->comp_ccbq);
4849                 }
4850                 else {
4851                         if (i != j)
4852                                 np->squeue[j] = np->squeue[i];
4853                         if ((j += 2) >= MAX_QUEUE*2) j = 0;
4854                 }
4855                 if ((i += 2) >= MAX_QUEUE*2) i = 0;
4856         }
4857         if (i != j)             /* Copy back the idle task if needed */
4858                 np->squeue[j] = np->squeue[i];
4859         np->squeueput = j;      /* Update our current start queue pointer */
4860
4861         return (i - j) / 2;
4862 }
4863
4864 /*
4865  *  Complete all CCBs queued to the COMP queue.
4866  *
4867  *  These CCBs are assumed:
4868  *  - Not to be referenced either by devices or 
4869  *    SCRIPTS-related queues and datas.
4870  *  - To have to be completed with an error condition 
4871  *    or requeued.
4872  *
4873  *  The device queue freeze count is incremented 
4874  *  for each CCB that does not prevent this.
4875  *  This function is called when all CCBs involved 
4876  *  in error handling/recovery have been reaped.
4877  */
4878 static void
4879 sym_flush_comp_queue(hcb_p np, int cam_status)
4880 {
4881         SYM_QUEHEAD *qp;
4882         ccb_p cp;
4883
4884         while ((qp = sym_remque_head(&np->comp_ccbq)) != 0) {
4885                 union ccb *ccb;
4886                 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
4887                 sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
4888                 /* Leave quiet CCBs waiting for resources */
4889                 if (cp->host_status == HS_WAIT)
4890                         continue;
4891                 ccb = cp->cam_ccb;
4892                 if (cam_status)
4893                         sym_set_cam_status(ccb, cam_status);
4894                 sym_free_ccb(np, cp);
4895                 sym_freeze_cam_ccb(ccb);
4896                 sym_xpt_done(np, ccb);
4897         }
4898 }
4899
4900 /*
4901  *  chip handler for bad SCSI status condition
4902  *
4903  *  In case of bad SCSI status, we unqueue all the tasks 
4904  *  currently queued to the controller but not yet started 
4905  *  and then restart the SCRIPTS processor immediately.
4906  *
4907  *  QUEUE FULL and BUSY conditions are handled the same way.
4908  *  Basically all the not yet started tasks are requeued in 
4909  *  device queue and the queue is frozen until a completion.
4910  *
4911  *  For CHECK CONDITION and COMMAND TERMINATED status, we use 
4912  *  the CCB of the failed command to prepare a REQUEST SENSE 
4913  *  SCSI command and queue it to the controller queue.
4914  *
4915  *  SCRATCHA is assumed to have been loaded with STARTPOS 
4916  *  before the SCRIPTS called the C code.
4917  */
4918 static void sym_sir_bad_scsi_status(hcb_p np, int num, ccb_p cp)
4919 {
4920         tcb_p tp        = &np->target[cp->target];
4921         u32             startp;
4922         u_char          s_status = cp->ssss_status;
4923         u_char          h_flags  = cp->host_flags;
4924         int             msglen;
4925         int             nego;
4926         int             i;
4927
4928         /*
4929          *  Compute the index of the next job to start from SCRIPTS.
4930          */
4931         i = (INL (nc_scratcha) - np->squeue_ba) / 4;
4932
4933         /*
4934          *  The last CCB queued used for IARB hint may be 
4935          *  no longer relevant. Forget it.
4936          */
4937 #ifdef SYM_CONF_IARB_SUPPORT
4938         if (np->last_cp)
4939                 np->last_cp = 0;
4940 #endif
4941
4942         /*
4943          *  Now deal with the SCSI status.
4944          */
4945         switch(s_status) {
4946         case S_BUSY:
4947         case S_QUEUE_FULL:
4948                 if (sym_verbose >= 2) {
4949                         PRINT_ADDR(cp);
4950                         printf (s_status == S_BUSY ? "BUSY" : "QUEUE FULL\n");
4951                 }
4952         default:        /* S_INT, S_INT_COND_MET, S_CONFLICT */
4953                 sym_complete_error (np, cp);
4954                 break;
4955         case S_TERMINATED:
4956         case S_CHECK_COND:
4957                 /*
4958                  *  If we get an SCSI error when requesting sense, give up.
4959                  */
4960                 if (h_flags & HF_SENSE) {
4961                         sym_complete_error (np, cp);
4962                         break;
4963                 }
4964
4965                 /*
4966                  *  Dequeue all queued CCBs for that device not yet started,
4967                  *  and restart the SCRIPTS processor immediately.
4968                  */
4969                 (void) sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
4970                 OUTL_DSP (SCRIPTA_BA (np, start));
4971
4972                 /*
4973                  *  Save some info of the actual IO.
4974                  *  Compute the data residual.
4975                  */
4976                 cp->sv_scsi_status = cp->ssss_status;
4977                 cp->sv_xerr_status = cp->xerr_status;
4978                 cp->sv_resid = sym_compute_residual(np, cp);
4979
4980                 /*
4981                  *  Prepare all needed data structures for 
4982                  *  requesting sense data.
4983                  */
4984
4985                 /*
4986                  *  identify message
4987                  */
4988                 cp->scsi_smsg2[0] = M_IDENTIFY | cp->lun;
4989                 msglen = 1;
4990
4991                 /*
4992                  *  If we are currently using anything different from 
4993                  *  async. 8 bit data transfers with that target,
4994                  *  start a negotiation, since the device may want 
4995                  *  to report us a UNIT ATTENTION condition due to 
4996                  *  a cause we currently ignore, and we donnot want 
4997                  *  to be stuck with WIDE and/or SYNC data transfer.
4998                  *
4999                  *  cp->nego_status is filled by sym_prepare_nego().
5000                  */
5001                 cp->nego_status = 0;
5002                 nego = 0;
5003                 if      (tp->tinfo.current.options & PPR_OPT_MASK)
5004                         nego = NS_PPR;
5005                 else if (tp->tinfo.current.width != BUS_8_BIT)
5006                         nego = NS_WIDE;
5007                 else if (tp->tinfo.current.offset != 0)
5008                         nego = NS_SYNC;
5009                 if (nego)
5010                         msglen +=
5011                         sym_prepare_nego (np,cp, nego, &cp->scsi_smsg2[msglen]);
5012                 /*
5013                  *  Message table indirect structure.
5014                  */
5015                 cp->phys.smsg.addr      = cpu_to_scr(CCB_BA (cp, scsi_smsg2));
5016                 cp->phys.smsg.size      = cpu_to_scr(msglen);
5017
5018                 /*
5019                  *  sense command
5020                  */
5021                 cp->phys.cmd.addr       = cpu_to_scr(CCB_BA (cp, sensecmd));
5022                 cp->phys.cmd.size       = cpu_to_scr(6);
5023
5024                 /*
5025                  *  patch requested size into sense command
5026                  */
5027                 cp->sensecmd[0]         = 0x03;
5028                 cp->sensecmd[1]         = cp->lun << 5;
5029 #ifdef  FreeBSD_New_Tran_Settings
5030                 if (tp->tinfo.current.scsi_version > 2 || cp->lun > 7)
5031                         cp->sensecmd[1] = 0;
5032 #endif
5033                 cp->sensecmd[4]         = SYM_SNS_BBUF_LEN;
5034                 cp->data_len            = SYM_SNS_BBUF_LEN;
5035
5036                 /*
5037                  *  sense data
5038                  */
5039                 bzero(cp->sns_bbuf, SYM_SNS_BBUF_LEN);
5040                 cp->phys.sense.addr     = cpu_to_scr(vtobus(cp->sns_bbuf));
5041                 cp->phys.sense.size     = cpu_to_scr(SYM_SNS_BBUF_LEN);
5042
5043                 /*
5044                  *  requeue the command.
5045                  */
5046                 startp = SCRIPTB_BA (np, sdata_in);
5047
5048                 cp->phys.head.savep     = cpu_to_scr(startp);
5049                 cp->phys.head.goalp     = cpu_to_scr(startp + 16);
5050                 cp->phys.head.lastp     = cpu_to_scr(startp);
5051                 cp->startp      = cpu_to_scr(startp);
5052
5053                 cp->actualquirks = SYM_QUIRK_AUTOSAVE;
5054                 cp->host_status = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
5055                 cp->ssss_status = S_ILLEGAL;
5056                 cp->host_flags  = (HF_SENSE|HF_DATA_IN);
5057                 cp->xerr_status = 0;
5058                 cp->extra_bytes = 0;
5059
5060                 cp->phys.head.go.start = cpu_to_scr(SCRIPTA_BA (np, select));
5061
5062                 /*
5063                  *  Requeue the command.
5064                  */
5065                 sym_put_start_queue(np, cp);
5066
5067                 /*
5068                  *  Give back to upper layer everything we have dequeued.
5069                  */
5070                 sym_flush_comp_queue(np, 0);
5071                 break;
5072         }
5073 }
5074
5075 /*
5076  *  After a device has accepted some management message 
5077  *  as BUS DEVICE RESET, ABORT TASK, etc ..., or when 
5078  *  a device signals a UNIT ATTENTION condition, some 
5079  *  tasks are thrown away by the device. We are required 
5080  *  to reflect that on our tasks list since the device 
5081  *  will never complete these tasks.
5082  *
5083  *  This function move from the BUSY queue to the COMP 
5084  *  queue all disconnected CCBs for a given target that 
5085  *  match the following criteria:
5086  *  - lun=-1  means any logical UNIT otherwise a given one.
5087  *  - task=-1 means any task, otherwise a given one.
5088  */
5089 static int 
5090 sym_clear_tasks(hcb_p np, int cam_status, int target, int lun, int task)
5091 {
5092         SYM_QUEHEAD qtmp, *qp;
5093         int i = 0;
5094         ccb_p cp;
5095
5096         /*
5097          *  Move the entire BUSY queue to our temporary queue.
5098          */
5099         sym_que_init(&qtmp);
5100         sym_que_splice(&np->busy_ccbq, &qtmp);
5101         sym_que_init(&np->busy_ccbq);
5102
5103         /*
5104          *  Put all CCBs that matches our criteria into 
5105          *  the COMP queue and put back other ones into 
5106          *  the BUSY queue.
5107          */
5108         while ((qp = sym_remque_head(&qtmp)) != 0) {
5109                 union ccb *ccb;
5110                 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
5111                 ccb = cp->cam_ccb;
5112                 if (cp->host_status != HS_DISCONNECT ||
5113                     cp->target != target             ||
5114                     (lun  != -1 && cp->lun != lun)   ||
5115                     (task != -1 && 
5116                         (cp->tag != NO_TAG && cp->scsi_smsg[2] != task))) {
5117                         sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
5118                         continue;
5119                 }
5120                 sym_insque_tail(&cp->link_ccbq, &np->comp_ccbq);
5121
5122                 /* Preserve the software timeout condition */
5123                 if (sym_get_cam_status(ccb) != CAM_CMD_TIMEOUT)
5124                         sym_set_cam_status(ccb, cam_status);
5125                 ++i;
5126 #if 0
5127 printf("XXXX TASK @%p CLEARED\n", cp);
5128 #endif
5129         }
5130         return i;
5131 }
5132
5133 /*
5134  *  chip handler for TASKS recovery
5135  *
5136  *  We cannot safely abort a command, while the SCRIPTS 
5137  *  processor is running, since we just would be in race 
5138  *  with it.
5139  *
5140  *  As long as we have tasks to abort, we keep the SEM 
5141  *  bit set in the ISTAT. When this bit is set, the 
5142  *  SCRIPTS processor interrupts (SIR_SCRIPT_STOPPED) 
5143  *  each time it enters the scheduler.
5144  *
5145  *  If we have to reset a target, clear tasks of a unit,
5146  *  or to perform the abort of a disconnected job, we 
5147  *  restart the SCRIPTS for selecting the target. Once 
5148  *  selected, the SCRIPTS interrupts (SIR_TARGET_SELECTED).
5149  *  If it loses arbitration, the SCRIPTS will interrupt again 
5150  *  the next time it will enter its scheduler, and so on ...
5151  *
5152  *  On SIR_TARGET_SELECTED, we scan for the more 
5153  *  appropriate thing to do:
5154  *
5155  *  - If nothing, we just sent a M_ABORT message to the 
5156  *    target to get rid of the useless SCSI bus ownership.
5157  *    According to the specs, no tasks shall be affected.
5158  *  - If the target is to be reset, we send it a M_RESET 
5159  *    message.
5160  *  - If a logical UNIT is to be cleared , we send the 
5161  *    IDENTIFY(lun) + M_ABORT.
5162  *  - If an untagged task is to be aborted, we send the 
5163  *    IDENTIFY(lun) + M_ABORT.
5164  *  - If a tagged task is to be aborted, we send the 
5165  *    IDENTIFY(lun) + task attributes + M_ABORT_TAG.
5166  *
5167  *  Once our 'kiss of death' :) message has been accepted 
5168  *  by the target, the SCRIPTS interrupts again 
5169  *  (SIR_ABORT_SENT). On this interrupt, we complete 
5170  *  all the CCBs that should have been aborted by the 
5171  *  target according to our message.
5172  */
5173 static void sym_sir_task_recovery(hcb_p np, int num)
5174 {
5175         SYM_QUEHEAD *qp;
5176         ccb_p cp;
5177         tcb_p tp;
5178         int target=-1, lun=-1, task;
5179         int i, k;
5180
5181         switch(num) {
5182         /*
5183          *  The SCRIPTS processor stopped before starting
5184          *  the next command in order to allow us to perform 
5185          *  some task recovery.
5186          */
5187         case SIR_SCRIPT_STOPPED:
5188                 /*
5189                  *  Do we have any target to reset or unit to clear ?
5190                  */
5191                 for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
5192                         tp = &np->target[i];
5193                         if (tp->to_reset || 
5194                             (tp->lun0p && tp->lun0p->to_clear)) {
5195                                 target = i;
5196                                 break;
5197                         }
5198                         if (!tp->lunmp)
5199                                 continue;
5200                         for (k = 1 ; k < SYM_CONF_MAX_LUN ; k++) {
5201                                 if (tp->lunmp[k] && tp->lunmp[k]->to_clear) {
5202                                         target  = i;
5203                                         break;
5204                                 }
5205                         }
5206                         if (target != -1)
5207                                 break;
5208                 }
5209
5210                 /*
5211                  *  If not, walk the busy queue for any 
5212                  *  disconnected CCB to be aborted.
5213                  */
5214                 if (target == -1) {
5215                         FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
5216                                 cp = sym_que_entry(qp,struct sym_ccb,link_ccbq);
5217                                 if (cp->host_status != HS_DISCONNECT)
5218                                         continue;
5219                                 if (cp->to_abort) {
5220                                         target = cp->target;
5221                                         break;
5222                                 }
5223                         }
5224                 }
5225
5226                 /*
5227                  *  If some target is to be selected, 
5228                  *  prepare and start the selection.
5229                  */
5230                 if (target != -1) {
5231                         tp = &np->target[target];
5232                         np->abrt_sel.sel_id     = target;
5233                         np->abrt_sel.sel_scntl3 = tp->head.wval;
5234                         np->abrt_sel.sel_sxfer  = tp->head.sval;
5235                         OUTL(nc_dsa, np->hcb_ba);
5236                         OUTL_DSP (SCRIPTB_BA (np, sel_for_abort));
5237                         return;
5238                 }
5239
5240                 /*
5241                  *  Now look for a CCB to abort that haven't started yet.
5242                  *  Btw, the SCRIPTS processor is still stopped, so 
5243                  *  we are not in race.
5244                  */
5245                 i = 0;
5246                 cp = 0;
5247                 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
5248                         cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
5249                         if (cp->host_status != HS_BUSY &&
5250                             cp->host_status != HS_NEGOTIATE)
5251                                 continue;
5252                         if (!cp->to_abort)
5253                                 continue;
5254 #ifdef SYM_CONF_IARB_SUPPORT
5255                         /*
5256                          *    If we are using IMMEDIATE ARBITRATION, we donnot 
5257                          *    want to cancel the last queued CCB, since the 
5258                          *    SCRIPTS may have anticipated the selection.
5259                          */
5260                         if (cp == np->last_cp) {
5261                                 cp->to_abort = 0;
5262                                 continue;
5263                         }
5264 #endif
5265                         i = 1;  /* Means we have found some */
5266                         break;
5267                 }
5268                 if (!i) {
5269                         /*
5270                          *  We are done, so we donnot need 
5271                          *  to synchronize with the SCRIPTS anylonger.
5272                          *  Remove the SEM flag from the ISTAT.
5273                          */
5274                         np->istat_sem = 0;
5275                         OUTB (nc_istat, SIGP);
5276                         break;
5277                 }
5278                 /*
5279                  *  Compute index of next position in the start 
5280                  *  queue the SCRIPTS intends to start and dequeue 
5281                  *  all CCBs for that device that haven't been started.
5282                  */
5283                 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
5284                 i = sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
5285
5286                 /*
5287                  *  Make sure at least our IO to abort has been dequeued.
5288                  */
5289                 assert(i && sym_get_cam_status(cp->cam_ccb) == CAM_REQUEUE_REQ);
5290
5291                 /*
5292                  *  Keep track in cam status of the reason of the abort.
5293                  */
5294                 if (cp->to_abort == 2)
5295                         sym_set_cam_status(cp->cam_ccb, CAM_CMD_TIMEOUT);
5296                 else
5297                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_ABORTED);
5298
5299                 /*
5300                  *  Complete with error everything that we have dequeued.
5301                  */
5302                 sym_flush_comp_queue(np, 0);
5303                 break;
5304         /*
5305          *  The SCRIPTS processor has selected a target 
5306          *  we may have some manual recovery to perform for.
5307          */
5308         case SIR_TARGET_SELECTED:
5309                 target = (INB (nc_sdid) & 0xf);
5310                 tp = &np->target[target];
5311
5312                 np->abrt_tbl.addr = cpu_to_scr(vtobus(np->abrt_msg));
5313
5314                 /*
5315                  *  If the target is to be reset, prepare a 
5316                  *  M_RESET message and clear the to_reset flag 
5317                  *  since we donnot expect this operation to fail.
5318                  */
5319                 if (tp->to_reset) {
5320                         np->abrt_msg[0] = M_RESET;
5321                         np->abrt_tbl.size = 1;
5322                         tp->to_reset = 0;
5323                         break;
5324                 }
5325
5326                 /*
5327                  *  Otherwise, look for some logical unit to be cleared.
5328                  */
5329                 if (tp->lun0p && tp->lun0p->to_clear)
5330                         lun = 0;
5331                 else if (tp->lunmp) {
5332                         for (k = 1 ; k < SYM_CONF_MAX_LUN ; k++) {
5333                                 if (tp->lunmp[k] && tp->lunmp[k]->to_clear) {
5334                                         lun = k;
5335                                         break;
5336                                 }
5337                         }
5338                 }
5339
5340                 /*
5341                  *  If a logical unit is to be cleared, prepare 
5342                  *  an IDENTIFY(lun) + ABORT MESSAGE.
5343                  */
5344                 if (lun != -1) {
5345                         lcb_p lp = sym_lp(np, tp, lun);
5346                         lp->to_clear = 0; /* We donnot expect to fail here */
5347                         np->abrt_msg[0] = M_IDENTIFY | lun;
5348                         np->abrt_msg[1] = M_ABORT;
5349                         np->abrt_tbl.size = 2;
5350                         break;
5351                 }
5352
5353                 /*
5354                  *  Otherwise, look for some disconnected job to 
5355                  *  abort for this target.
5356                  */
5357                 i = 0;
5358                 cp = 0;
5359                 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
5360                         cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
5361                         if (cp->host_status != HS_DISCONNECT)
5362                                 continue;
5363                         if (cp->target != target)
5364                                 continue;
5365                         if (!cp->to_abort)
5366                                 continue;
5367                         i = 1;  /* Means we have some */
5368                         break;
5369                 }
5370
5371                 /*
5372                  *  If we have none, probably since the device has 
5373                  *  completed the command before we won abitration,
5374                  *  send a M_ABORT message without IDENTIFY.
5375                  *  According to the specs, the device must just 
5376                  *  disconnect the BUS and not abort any task.
5377                  */
5378                 if (!i) {
5379                         np->abrt_msg[0] = M_ABORT;
5380                         np->abrt_tbl.size = 1;
5381                         break;
5382                 }
5383
5384                 /*
5385                  *  We have some task to abort.
5386                  *  Set the IDENTIFY(lun)
5387                  */
5388                 np->abrt_msg[0] = M_IDENTIFY | cp->lun;
5389
5390                 /*
5391                  *  If we want to abort an untagged command, we 
5392                  *  will send a IDENTIFY + M_ABORT.
5393                  *  Otherwise (tagged command), we will send 
5394                  *  a IDENTITFY + task attributes + ABORT TAG.
5395                  */
5396                 if (cp->tag == NO_TAG) {
5397                         np->abrt_msg[1] = M_ABORT;
5398                         np->abrt_tbl.size = 2;
5399                 }
5400                 else {
5401                         np->abrt_msg[1] = cp->scsi_smsg[1];
5402                         np->abrt_msg[2] = cp->scsi_smsg[2];
5403                         np->abrt_msg[3] = M_ABORT_TAG;
5404                         np->abrt_tbl.size = 4;
5405                 }
5406                 /*
5407                  *  Keep track of software timeout condition, since the 
5408                  *  peripheral driver may not count retries on abort 
5409                  *  conditions not due to timeout.
5410                  */
5411                 if (cp->to_abort == 2)
5412                         sym_set_cam_status(cp->cam_ccb, CAM_CMD_TIMEOUT);
5413                 cp->to_abort = 0; /* We donnot expect to fail here */
5414                 break;
5415
5416         /*
5417          *  The target has accepted our message and switched 
5418          *  to BUS FREE phase as we expected.
5419          */
5420         case SIR_ABORT_SENT:
5421                 target = (INB (nc_sdid) & 0xf);
5422                 tp = &np->target[target];
5423                 
5424                 /*
5425                 **  If we didn't abort anything, leave here.
5426                 */
5427                 if (np->abrt_msg[0] == M_ABORT)
5428                         break;
5429
5430                 /*
5431                  *  If we sent a M_RESET, then a hardware reset has 
5432                  *  been performed by the target.
5433                  *  - Reset everything to async 8 bit
5434                  *  - Tell ourself to negotiate next time :-)
5435                  *  - Prepare to clear all disconnected CCBs for 
5436                  *    this target from our task list (lun=task=-1)
5437                  */
5438                 lun = -1;
5439                 task = -1;
5440                 if (np->abrt_msg[0] == M_RESET) {
5441                         tp->head.sval = 0;
5442                         tp->head.wval = np->rv_scntl3;
5443                         tp->head.uval = 0;
5444                         tp->tinfo.current.period = 0;
5445                         tp->tinfo.current.offset = 0;
5446                         tp->tinfo.current.width  = BUS_8_BIT;
5447                         tp->tinfo.current.options = 0;
5448                 }
5449
5450                 /*
5451                  *  Otherwise, check for the LUN and TASK(s) 
5452                  *  concerned by the cancelation.
5453                  *  If it is not ABORT_TAG then it is CLEAR_QUEUE 
5454                  *  or an ABORT message :-)
5455                  */
5456                 else {
5457                         lun = np->abrt_msg[0] & 0x3f;
5458                         if (np->abrt_msg[1] == M_ABORT_TAG)
5459                                 task = np->abrt_msg[2];
5460                 }
5461
5462                 /*
5463                  *  Complete all the CCBs the device should have 
5464                  *  aborted due to our 'kiss of death' message.
5465                  */
5466                 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
5467                 (void) sym_dequeue_from_squeue(np, i, target, lun, -1);
5468                 (void) sym_clear_tasks(np, CAM_REQ_ABORTED, target, lun, task);
5469                 sym_flush_comp_queue(np, 0);
5470
5471                 /*
5472                  *  If we sent a BDR, make uper layer aware of that.
5473                  */
5474                 if (np->abrt_msg[0] == M_RESET)
5475                         xpt_async(AC_SENT_BDR, np->path, NULL);
5476                 break;
5477         }
5478
5479         /*
5480          *  Print to the log the message we intend to send.
5481          */
5482         if (num == SIR_TARGET_SELECTED) {
5483                 PRINT_TARGET(np, target);
5484                 sym_printl_hex("control msgout:", np->abrt_msg,
5485                               np->abrt_tbl.size);
5486                 np->abrt_tbl.size = cpu_to_scr(np->abrt_tbl.size);
5487         }
5488
5489         /*
5490          *  Let the SCRIPTS processor continue.
5491          */
5492         OUTONB_STD ();
5493 }
5494
5495 /*
5496  *  Gerard's alchemy:) that deals with with the data 
5497  *  pointer for both MDP and the residual calculation.
5498  *
5499  *  I didn't want to bloat the code by more than 200 
5500  *  lignes for the handling of both MDP and the residual.
5501  *  This has been achieved by using a data pointer 
5502  *  representation consisting in an index in the data 
5503  *  array (dp_sg) and a negative offset (dp_ofs) that 
5504  *  have the following meaning:
5505  *
5506  *  - dp_sg = SYM_CONF_MAX_SG
5507  *    we are at the end of the data script.
5508  *  - dp_sg < SYM_CONF_MAX_SG
5509  *    dp_sg points to the next entry of the scatter array 
5510  *    we want to transfer.
5511  *  - dp_ofs < 0
5512  *    dp_ofs represents the residual of bytes of the 
5513  *    previous entry scatter entry we will send first.
5514  *  - dp_ofs = 0
5515  *    no residual to send first.
5516  *
5517  *  The function sym_evaluate_dp() accepts an arbitray 
5518  *  offset (basically from the MDP message) and returns 
5519  *  the corresponding values of dp_sg and dp_ofs.
5520  */
5521
5522 static int sym_evaluate_dp(hcb_p np, ccb_p cp, u32 scr, int *ofs)
5523 {
5524         u32     dp_scr;
5525         int     dp_ofs, dp_sg, dp_sgmin;
5526         int     tmp;
5527         struct sym_pmc *pm;
5528
5529         /*
5530          *  Compute the resulted data pointer in term of a script 
5531          *  address within some DATA script and a signed byte offset.
5532          */
5533         dp_scr = scr;
5534         dp_ofs = *ofs;
5535         if      (dp_scr == SCRIPTA_BA (np, pm0_data))
5536                 pm = &cp->phys.pm0;
5537         else if (dp_scr == SCRIPTA_BA (np, pm1_data))
5538                 pm = &cp->phys.pm1;
5539         else
5540                 pm = 0;
5541
5542         if (pm) {
5543                 dp_scr  = scr_to_cpu(pm->ret);
5544                 dp_ofs -= scr_to_cpu(pm->sg.size);
5545         }
5546
5547         /*
5548          *  If we are auto-sensing, then we are done.
5549          */
5550         if (cp->host_flags & HF_SENSE) {
5551                 *ofs = dp_ofs;
5552                 return 0;
5553         }
5554
5555         /*
5556          *  Deduce the index of the sg entry.
5557          *  Keep track of the index of the first valid entry.
5558          *  If result is dp_sg = SYM_CONF_MAX_SG, then we are at the 
5559          *  end of the data.
5560          */
5561         tmp = scr_to_cpu(cp->phys.head.goalp);
5562         dp_sg = SYM_CONF_MAX_SG;
5563         if (dp_scr != tmp)
5564                 dp_sg -= (tmp - 8 - (int)dp_scr) / (2*4);
5565         dp_sgmin = SYM_CONF_MAX_SG - cp->segments;
5566
5567         /*
5568          *  Move to the sg entry the data pointer belongs to.
5569          *
5570          *  If we are inside the data area, we expect result to be:
5571          *
5572          *  Either,
5573          *      dp_ofs = 0 and dp_sg is the index of the sg entry
5574          *      the data pointer belongs to (or the end of the data)
5575          *  Or,
5576          *      dp_ofs < 0 and dp_sg is the index of the sg entry 
5577          *      the data pointer belongs to + 1.
5578          */
5579         if (dp_ofs < 0) {
5580                 int n;
5581                 while (dp_sg > dp_sgmin) {
5582                         --dp_sg;
5583                         tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5584                         n = dp_ofs + (tmp & 0xffffff);
5585                         if (n > 0) {
5586                                 ++dp_sg;
5587                                 break;
5588                         }
5589                         dp_ofs = n;
5590                 }
5591         }
5592         else if (dp_ofs > 0) {
5593                 while (dp_sg < SYM_CONF_MAX_SG) {
5594                         tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5595                         dp_ofs -= (tmp & 0xffffff);
5596                         ++dp_sg;
5597                         if (dp_ofs <= 0)
5598                                 break;
5599                 }
5600         }
5601
5602         /*
5603          *  Make sure the data pointer is inside the data area.
5604          *  If not, return some error.
5605          */
5606         if      (dp_sg < dp_sgmin || (dp_sg == dp_sgmin && dp_ofs < 0))
5607                 goto out_err;
5608         else if (dp_sg > SYM_CONF_MAX_SG ||
5609                  (dp_sg == SYM_CONF_MAX_SG && dp_ofs > 0))
5610                 goto out_err;
5611
5612         /*
5613          *  Save the extreme pointer if needed.
5614          */
5615         if (dp_sg > cp->ext_sg ||
5616             (dp_sg == cp->ext_sg && dp_ofs > cp->ext_ofs)) {
5617                 cp->ext_sg  = dp_sg;
5618                 cp->ext_ofs = dp_ofs;
5619         }
5620
5621         /*
5622          *  Return data.
5623          */
5624         *ofs = dp_ofs;
5625         return dp_sg;
5626
5627 out_err:
5628         return -1;
5629 }
5630
5631 /*
5632  *  chip handler for MODIFY DATA POINTER MESSAGE
5633  *
5634  *  We also call this function on IGNORE WIDE RESIDUE 
5635  *  messages that do not match a SWIDE full condition.
5636  *  Btw, we assume in that situation that such a message 
5637  *  is equivalent to a MODIFY DATA POINTER (offset=-1).
5638  */
5639
5640 static void sym_modify_dp(hcb_p np, tcb_p tp, ccb_p cp, int ofs)
5641 {
5642         int dp_ofs      = ofs;
5643         u32     dp_scr  = INL (nc_temp);
5644         u32     dp_ret;
5645         u32     tmp;
5646         u_char  hflags;
5647         int     dp_sg;
5648         struct  sym_pmc *pm;
5649
5650         /*
5651          *  Not supported for auto-sense.
5652          */
5653         if (cp->host_flags & HF_SENSE)
5654                 goto out_reject;
5655
5656         /*
5657          *  Apply our alchemy:) (see comments in sym_evaluate_dp()), 
5658          *  to the resulted data pointer.
5659          */
5660         dp_sg = sym_evaluate_dp(np, cp, dp_scr, &dp_ofs);
5661         if (dp_sg < 0)
5662                 goto out_reject;
5663
5664         /*
5665          *  And our alchemy:) allows to easily calculate the data 
5666          *  script address we want to return for the next data phase.
5667          */
5668         dp_ret = cpu_to_scr(cp->phys.head.goalp);
5669         dp_ret = dp_ret - 8 - (SYM_CONF_MAX_SG - dp_sg) * (2*4);
5670
5671         /*
5672          *  If offset / scatter entry is zero we donnot need 
5673          *  a context for the new current data pointer.
5674          */
5675         if (dp_ofs == 0) {
5676                 dp_scr = dp_ret;
5677                 goto out_ok;
5678         }
5679
5680         /*
5681          *  Get a context for the new current data pointer.
5682          */
5683         hflags = INB (HF_PRT);
5684
5685         if (hflags & HF_DP_SAVED)
5686                 hflags ^= HF_ACT_PM;
5687
5688         if (!(hflags & HF_ACT_PM)) {
5689                 pm  = &cp->phys.pm0;
5690                 dp_scr = SCRIPTA_BA (np, pm0_data);
5691         }
5692         else {
5693                 pm = &cp->phys.pm1;
5694                 dp_scr = SCRIPTA_BA (np, pm1_data);
5695         }
5696
5697         hflags &= ~(HF_DP_SAVED);
5698
5699         OUTB (HF_PRT, hflags);
5700
5701         /*
5702          *  Set up the new current data pointer.
5703          *  ofs < 0 there, and for the next data phase, we 
5704          *  want to transfer part of the data of the sg entry 
5705          *  corresponding to index dp_sg-1 prior to returning 
5706          *  to the main data script.
5707          */
5708         pm->ret = cpu_to_scr(dp_ret);
5709         tmp  = scr_to_cpu(cp->phys.data[dp_sg-1].addr);
5710         tmp += scr_to_cpu(cp->phys.data[dp_sg-1].size) + dp_ofs;
5711         pm->sg.addr = cpu_to_scr(tmp);
5712         pm->sg.size = cpu_to_scr(-dp_ofs);
5713
5714 out_ok:
5715         OUTL (nc_temp, dp_scr);
5716         OUTL_DSP (SCRIPTA_BA (np, clrack));
5717         return;
5718
5719 out_reject:
5720         OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5721 }
5722
5723
5724 /*
5725  *  chip calculation of the data residual.
5726  *
5727  *  As I used to say, the requirement of data residual 
5728  *  in SCSI is broken, useless and cannot be achieved 
5729  *  without huge complexity.
5730  *  But most OSes and even the official CAM require it.
5731  *  When stupidity happens to be so widely spread inside 
5732  *  a community, it gets hard to convince.
5733  *
5734  *  Anyway, I don't care, since I am not going to use 
5735  *  any software that considers this data residual as 
5736  *  a relevant information. :)
5737  */
5738
5739 static int sym_compute_residual(hcb_p np, ccb_p cp)
5740 {
5741         int dp_sg, dp_sgmin, resid = 0;
5742         int dp_ofs = 0;
5743
5744         /*
5745          *  Check for some data lost or just thrown away.
5746          *  We are not required to be quite accurate in this 
5747          *  situation. Btw, if we are odd for output and the 
5748          *  device claims some more data, it may well happen 
5749          *  than our residual be zero. :-)
5750          */
5751         if (cp->xerr_status & (XE_EXTRA_DATA|XE_SODL_UNRUN|XE_SWIDE_OVRUN)) {
5752                 if (cp->xerr_status & XE_EXTRA_DATA)
5753                         resid -= cp->extra_bytes;
5754                 if (cp->xerr_status & XE_SODL_UNRUN)
5755                         ++resid;
5756                 if (cp->xerr_status & XE_SWIDE_OVRUN)
5757                         --resid;
5758         }
5759
5760         /*
5761          *  If all data has been transferred,
5762          *  there is no residual.
5763          */
5764         if (cp->phys.head.lastp == cp->phys.head.goalp)
5765                 return resid;
5766
5767         /*
5768          *  If no data transfer occurs, or if the data
5769          *  pointer is weird, return full residual.
5770          */
5771         if (cp->startp == cp->phys.head.lastp ||
5772             sym_evaluate_dp(np, cp, scr_to_cpu(cp->phys.head.lastp),
5773                             &dp_ofs) < 0) {
5774                 return cp->data_len;
5775         }
5776
5777         /*
5778          *  If we were auto-sensing, then we are done.
5779          */
5780         if (cp->host_flags & HF_SENSE) {
5781                 return -dp_ofs;
5782         }
5783
5784         /*
5785          *  We are now full comfortable in the computation 
5786          *  of the data residual (2's complement).
5787          */
5788         dp_sgmin = SYM_CONF_MAX_SG - cp->segments;
5789         resid = -cp->ext_ofs;
5790         for (dp_sg = cp->ext_sg; dp_sg < SYM_CONF_MAX_SG; ++dp_sg) {
5791                 u_int tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5792                 resid += (tmp & 0xffffff);
5793         }
5794
5795         /*
5796          *  Hopefully, the result is not too wrong.
5797          */
5798         return resid;
5799 }
5800
5801 /*
5802  *  Print out the content of a SCSI message.
5803  */
5804
5805 static int sym_show_msg (u_char * msg)
5806 {
5807         u_char i;
5808         printf ("%x",*msg);
5809         if (*msg==M_EXTENDED) {
5810                 for (i=1;i<8;i++) {
5811                         if (i-1>msg[1]) break;
5812                         printf ("-%x",msg[i]);
5813                 };
5814                 return (i+1);
5815         } else if ((*msg & 0xf0) == 0x20) {
5816                 printf ("-%x",msg[1]);
5817                 return (2);
5818         };
5819         return (1);
5820 }
5821
5822 static void sym_print_msg (ccb_p cp, char *label, u_char *msg)
5823 {
5824         PRINT_ADDR(cp);
5825         if (label)
5826                 printf ("%s: ", label);
5827
5828         (void) sym_show_msg (msg);
5829         printf (".\n");
5830 }
5831
5832 /*
5833  *  Negotiation for WIDE and SYNCHRONOUS DATA TRANSFER.
5834  *
5835  *  When we try to negotiate, we append the negotiation message
5836  *  to the identify and (maybe) simple tag message.
5837  *  The host status field is set to HS_NEGOTIATE to mark this
5838  *  situation.
5839  *
5840  *  If the target doesn't answer this message immediately
5841  *  (as required by the standard), the SIR_NEGO_FAILED interrupt
5842  *  will be raised eventually.
5843  *  The handler removes the HS_NEGOTIATE status, and sets the
5844  *  negotiated value to the default (async / nowide).
5845  *
5846  *  If we receive a matching answer immediately, we check it
5847  *  for validity, and set the values.
5848  *
5849  *  If we receive a Reject message immediately, we assume the
5850  *  negotiation has failed, and fall back to standard values.
5851  *
5852  *  If we receive a negotiation message while not in HS_NEGOTIATE
5853  *  state, it's a target initiated negotiation. We prepare a
5854  *  (hopefully) valid answer, set our parameters, and send back 
5855  *  this answer to the target.
5856  *
5857  *  If the target doesn't fetch the answer (no message out phase),
5858  *  we assume the negotiation has failed, and fall back to default
5859  *  settings (SIR_NEGO_PROTO interrupt).
5860  *
5861  *  When we set the values, we adjust them in all ccbs belonging 
5862  *  to this target, in the controller's register, and in the "phys"
5863  *  field of the controller's struct sym_hcb.
5864  */
5865
5866 /*
5867  *  chip handler for SYNCHRONOUS DATA TRANSFER REQUEST (SDTR) message.
5868  */
5869 static void sym_sync_nego(hcb_p np, tcb_p tp, ccb_p cp)
5870 {
5871         u_char  chg, ofs, per, fak, div;
5872         int     req = 1;
5873
5874         /*
5875          *  Synchronous request message received.
5876          */
5877         if (DEBUG_FLAGS & DEBUG_NEGO) {
5878                 sym_print_msg(cp, "sync msgin", np->msgin);
5879         };
5880
5881         /*
5882          * request or answer ?
5883          */
5884         if (INB (HS_PRT) == HS_NEGOTIATE) {
5885                 OUTB (HS_PRT, HS_BUSY);
5886                 if (cp->nego_status && cp->nego_status != NS_SYNC)
5887                         goto reject_it;
5888                 req = 0;
5889         }
5890
5891         /*
5892          *  get requested values.
5893          */
5894         chg = 0;
5895         per = np->msgin[3];
5896         ofs = np->msgin[4];
5897
5898         /*
5899          *  check values against our limits.
5900          */
5901         if (ofs) {
5902                 if (ofs > np->maxoffs)
5903                         {chg = 1; ofs = np->maxoffs;}
5904                 if (req) {
5905                         if (ofs > tp->tinfo.user.offset)
5906                                 {chg = 1; ofs = tp->tinfo.user.offset;}
5907                 }
5908         }
5909
5910         if (ofs) {
5911                 if (per < np->minsync)
5912                         {chg = 1; per = np->minsync;}
5913                 if (req) {
5914                         if (per < tp->tinfo.user.period)
5915                                 {chg = 1; per = tp->tinfo.user.period;}
5916                 }
5917         }
5918
5919         div = fak = 0;
5920         if (ofs && sym_getsync(np, 0, per, &div, &fak) < 0)
5921                 goto reject_it;
5922
5923         if (DEBUG_FLAGS & DEBUG_NEGO) {
5924                 PRINT_ADDR(cp);
5925                 printf ("sdtr: ofs=%d per=%d div=%d fak=%d chg=%d.\n",
5926                         ofs, per, div, fak, chg);
5927         }
5928
5929         /*
5930          *  This was an answer message
5931          */
5932         if (req == 0) {
5933                 if (chg)        /* Answer wasn't acceptable. */
5934                         goto reject_it;
5935                 sym_setsync (np, cp, ofs, per, div, fak);
5936                 OUTL_DSP (SCRIPTA_BA (np, clrack));
5937                 return;
5938         }
5939
5940         /*
5941          *  It was a request. Set value and
5942          *  prepare an answer message
5943          */
5944         sym_setsync (np, cp, ofs, per, div, fak);
5945
5946         np->msgout[0] = M_EXTENDED;
5947         np->msgout[1] = 3;
5948         np->msgout[2] = M_X_SYNC_REQ;
5949         np->msgout[3] = per;
5950         np->msgout[4] = ofs;
5951
5952         cp->nego_status = NS_SYNC;
5953
5954         if (DEBUG_FLAGS & DEBUG_NEGO) {
5955                 sym_print_msg(cp, "sync msgout", np->msgout);
5956         }
5957
5958         np->msgin [0] = M_NOOP;
5959
5960         OUTL_DSP (SCRIPTB_BA (np, sdtr_resp));
5961         return;
5962 reject_it:
5963         sym_setsync (np, cp, 0, 0, 0, 0);
5964         OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5965 }
5966
5967 /*
5968  *  chip handler for PARALLEL PROTOCOL REQUEST (PPR) message.
5969  */
5970 static void sym_ppr_nego(hcb_p np, tcb_p tp, ccb_p cp)
5971 {
5972         u_char  chg, ofs, per, fak, dt, div, wide;
5973         int     req = 1;
5974
5975         /*
5976          * Synchronous request message received.
5977          */
5978         if (DEBUG_FLAGS & DEBUG_NEGO) {
5979                 sym_print_msg(cp, "ppr msgin", np->msgin);
5980         };
5981
5982         /*
5983          *  get requested values.
5984          */
5985         chg  = 0;
5986         per  = np->msgin[3];
5987         ofs  = np->msgin[5];
5988         wide = np->msgin[6];
5989         dt   = np->msgin[7] & PPR_OPT_DT;
5990
5991         /*
5992          * request or answer ?
5993          */
5994         if (INB (HS_PRT) == HS_NEGOTIATE) {
5995                 OUTB (HS_PRT, HS_BUSY);
5996                 if (cp->nego_status && cp->nego_status != NS_PPR)
5997                         goto reject_it;
5998                 req = 0;
5999         }
6000
6001         /*
6002          *  check values against our limits.
6003          */
6004         if (wide > np->maxwide)
6005                 {chg = 1; wide = np->maxwide;}
6006         if (!wide || !(np->features & FE_ULTRA3))
6007                 dt &= ~PPR_OPT_DT;
6008         if (req) {
6009                 if (wide > tp->tinfo.user.width)
6010                         {chg = 1; wide = tp->tinfo.user.width;}
6011         }
6012
6013         if (!(np->features & FE_U3EN))  /* Broken U3EN bit not supported */
6014                 dt &= ~PPR_OPT_DT;
6015
6016         if (dt != (np->msgin[7] & PPR_OPT_MASK)) chg = 1;
6017
6018         if (ofs) {
6019                 if (dt) {
6020                         if (ofs > np->maxoffs_dt)
6021                                 {chg = 1; ofs = np->maxoffs_dt;}
6022                 }
6023                 else if (ofs > np->maxoffs)
6024                         {chg = 1; ofs = np->maxoffs;}
6025                 if (req) {
6026                         if (ofs > tp->tinfo.user.offset)
6027                                 {chg = 1; ofs = tp->tinfo.user.offset;}
6028                 }
6029         }
6030
6031         if (ofs) {
6032                 if (dt) {
6033                         if (per < np->minsync_dt)
6034                                 {chg = 1; per = np->minsync_dt;}
6035                 }
6036                 else if (per < np->minsync)
6037                         {chg = 1; per = np->minsync;}
6038                 if (req) {
6039                         if (per < tp->tinfo.user.period)
6040                                 {chg = 1; per = tp->tinfo.user.period;}
6041                 }
6042         }
6043
6044         div = fak = 0;
6045         if (ofs && sym_getsync(np, dt, per, &div, &fak) < 0)
6046                 goto reject_it;
6047         
6048         if (DEBUG_FLAGS & DEBUG_NEGO) {
6049                 PRINT_ADDR(cp);
6050                 printf ("ppr: "
6051                         "dt=%x ofs=%d per=%d wide=%d div=%d fak=%d chg=%d.\n",
6052                         dt, ofs, per, wide, div, fak, chg);
6053         }
6054
6055         /*
6056          *  It was an answer.
6057          */
6058         if (req == 0) {
6059                 if (chg)        /* Answer wasn't acceptable */
6060                         goto reject_it;
6061                 sym_setpprot (np, cp, dt, ofs, per, wide, div, fak);
6062                 OUTL_DSP (SCRIPTA_BA (np, clrack));
6063                 return;
6064         }
6065
6066         /*
6067          *  It was a request. Set value and
6068          *  prepare an answer message
6069          */
6070         sym_setpprot (np, cp, dt, ofs, per, wide, div, fak);
6071
6072         np->msgout[0] = M_EXTENDED;
6073         np->msgout[1] = 6;
6074         np->msgout[2] = M_X_PPR_REQ;
6075         np->msgout[3] = per;
6076         np->msgout[4] = 0;
6077         np->msgout[5] = ofs;
6078         np->msgout[6] = wide;
6079         np->msgout[7] = dt;
6080
6081         cp->nego_status = NS_PPR;
6082
6083         if (DEBUG_FLAGS & DEBUG_NEGO) {
6084                 sym_print_msg(cp, "ppr msgout", np->msgout);
6085         }
6086
6087         np->msgin [0] = M_NOOP;
6088
6089         OUTL_DSP (SCRIPTB_BA (np, ppr_resp));
6090         return;
6091 reject_it:
6092         sym_setpprot (np, cp, 0, 0, 0, 0, 0, 0);
6093         OUTL_DSP (SCRIPTB_BA (np, msg_bad));
6094         /*
6095          *  If it was a device response that should result in  
6096          *  ST, we may want to try a legacy negotiation later.
6097          */
6098         if (!req && !dt) {
6099                 tp->tinfo.goal.options = 0;
6100                 tp->tinfo.goal.width   = wide;
6101                 tp->tinfo.goal.period  = per;
6102                 tp->tinfo.goal.offset  = ofs;
6103         }
6104         return;
6105 }
6106
6107 /*
6108  *  chip handler for WIDE DATA TRANSFER REQUEST (WDTR) message.
6109  */
6110 static void sym_wide_nego(hcb_p np, tcb_p tp, ccb_p cp)
6111 {
6112         u_char  chg, wide;
6113         int     req = 1;
6114
6115         /*
6116          *  Wide request message received.
6117          */
6118         if (DEBUG_FLAGS & DEBUG_NEGO) {
6119                 sym_print_msg(cp, "wide msgin", np->msgin);
6120         };
6121
6122         /*
6123          * Is it an request from the device?
6124          */
6125         if (INB (HS_PRT) == HS_NEGOTIATE) {
6126                 OUTB (HS_PRT, HS_BUSY);
6127                 if (cp->nego_status && cp->nego_status != NS_WIDE)
6128                         goto reject_it;
6129                 req = 0;
6130         }
6131
6132         /*
6133          *  get requested values.
6134          */
6135         chg  = 0;
6136         wide = np->msgin[3];
6137
6138         /*
6139          *  check values against driver limits.
6140          */
6141         if (wide > np->maxwide)
6142                 {chg = 1; wide = np->maxwide;}
6143         if (req) {
6144                 if (wide > tp->tinfo.user.width)
6145                         {chg = 1; wide = tp->tinfo.user.width;}
6146         }
6147
6148         if (DEBUG_FLAGS & DEBUG_NEGO) {
6149                 PRINT_ADDR(cp);
6150                 printf ("wdtr: wide=%d chg=%d.\n", wide, chg);
6151         }
6152
6153         /*
6154          * This was an answer message
6155          */
6156         if (req == 0) {
6157                 if (chg)        /*  Answer wasn't acceptable. */
6158                         goto reject_it;
6159                 sym_setwide (np, cp, wide);
6160
6161                 /*
6162                  * Negotiate for SYNC immediately after WIDE response.
6163                  * This allows to negotiate for both WIDE and SYNC on 
6164                  * a single SCSI command (Suggested by Justin Gibbs).
6165                  */
6166                 if (tp->tinfo.goal.offset) {
6167                         np->msgout[0] = M_EXTENDED;
6168                         np->msgout[1] = 3;
6169                         np->msgout[2] = M_X_SYNC_REQ;
6170                         np->msgout[3] = tp->tinfo.goal.period;
6171                         np->msgout[4] = tp->tinfo.goal.offset;
6172
6173                         if (DEBUG_FLAGS & DEBUG_NEGO) {
6174                                 sym_print_msg(cp, "sync msgout", np->msgout);
6175                         }
6176
6177                         cp->nego_status = NS_SYNC;
6178                         OUTB (HS_PRT, HS_NEGOTIATE);
6179                         OUTL_DSP (SCRIPTB_BA (np, sdtr_resp));
6180                         return;
6181                 }
6182
6183                 OUTL_DSP (SCRIPTA_BA (np, clrack));
6184                 return;
6185         };
6186
6187         /*
6188          *  It was a request, set value and
6189          *  prepare an answer message
6190          */
6191         sym_setwide (np, cp, wide);
6192
6193         np->msgout[0] = M_EXTENDED;
6194         np->msgout[1] = 2;
6195         np->msgout[2] = M_X_WIDE_REQ;
6196         np->msgout[3] = wide;
6197
6198         np->msgin [0] = M_NOOP;
6199
6200         cp->nego_status = NS_WIDE;
6201
6202         if (DEBUG_FLAGS & DEBUG_NEGO) {
6203                 sym_print_msg(cp, "wide msgout", np->msgout);
6204         }
6205
6206         OUTL_DSP (SCRIPTB_BA (np, wdtr_resp));
6207         return;
6208 reject_it:
6209         OUTL_DSP (SCRIPTB_BA (np, msg_bad));
6210 }
6211
6212 /*
6213  *  Reset SYNC or WIDE to default settings.
6214  *
6215  *  Called when a negotiation does not succeed either 
6216  *  on rejection or on protocol error.
6217  *
6218  *  If it was a PPR that made problems, we may want to 
6219  *  try a legacy negotiation later.
6220  */
6221 static void sym_nego_default(hcb_p np, tcb_p tp, ccb_p cp)
6222 {
6223         /*
6224          *  any error in negotiation:
6225          *  fall back to default mode.
6226          */
6227         switch (cp->nego_status) {
6228         case NS_PPR:
6229 #if 0
6230                 sym_setpprot (np, cp, 0, 0, 0, 0, 0, 0);
6231 #else
6232                 tp->tinfo.goal.options = 0;
6233                 if (tp->tinfo.goal.period < np->minsync)
6234                         tp->tinfo.goal.period = np->minsync;
6235                 if (tp->tinfo.goal.offset > np->maxoffs)
6236                         tp->tinfo.goal.offset = np->maxoffs;
6237 #endif
6238                 break;
6239         case NS_SYNC:
6240                 sym_setsync (np, cp, 0, 0, 0, 0);
6241                 break;
6242         case NS_WIDE:
6243                 sym_setwide (np, cp, 0);
6244                 break;
6245         };
6246         np->msgin [0] = M_NOOP;
6247         np->msgout[0] = M_NOOP;
6248         cp->nego_status = 0;
6249 }
6250
6251 /*
6252  *  chip handler for MESSAGE REJECT received in response to 
6253  *  a WIDE or SYNCHRONOUS negotiation.
6254  */
6255 static void sym_nego_rejected(hcb_p np, tcb_p tp, ccb_p cp)
6256 {
6257         sym_nego_default(np, tp, cp);
6258         OUTB (HS_PRT, HS_BUSY);
6259 }
6260
6261 /*
6262  *  chip exception handler for programmed interrupts.
6263  */
6264 void sym_int_sir (hcb_p np)
6265 {
6266         u_char  num     = INB (nc_dsps);
6267         u32     dsa     = INL (nc_dsa);
6268         ccb_p   cp      = sym_ccb_from_dsa(np, dsa);
6269         u_char  target  = INB (nc_sdid) & 0x0f;
6270         tcb_p   tp      = &np->target[target];
6271         int     tmp;
6272
6273         if (DEBUG_FLAGS & DEBUG_TINY) printf ("I#%d", num);
6274
6275         switch (num) {
6276         /*
6277          *  Command has been completed with error condition 
6278          *  or has been auto-sensed.
6279          */
6280         case SIR_COMPLETE_ERROR:
6281                 sym_complete_error(np, cp);
6282                 return;
6283         /*
6284          *  The C code is currently trying to recover from something.
6285          *  Typically, user want to abort some command.
6286          */
6287         case SIR_SCRIPT_STOPPED:
6288         case SIR_TARGET_SELECTED:
6289         case SIR_ABORT_SENT:
6290                 sym_sir_task_recovery(np, num);
6291                 return;
6292         /*
6293          *  The device didn't go to MSG OUT phase after having 
6294          *  been selected with ATN. We donnot want to handle 
6295          *  that.
6296          */
6297         case SIR_SEL_ATN_NO_MSG_OUT:
6298                 printf ("%s:%d: No MSG OUT phase after selection with ATN.\n",
6299                         sym_name (np), target);
6300                 goto out_stuck;
6301         /*
6302          *  The device didn't switch to MSG IN phase after 
6303          *  having reseleted the initiator.
6304          */
6305         case SIR_RESEL_NO_MSG_IN:
6306                 printf ("%s:%d: No MSG IN phase after reselection.\n",
6307                         sym_name (np), target);
6308                 goto out_stuck;
6309         /*
6310          *  After reselection, the device sent a message that wasn't 
6311          *  an IDENTIFY.
6312          */
6313         case SIR_RESEL_NO_IDENTIFY:
6314                 printf ("%s:%d: No IDENTIFY after reselection.\n",
6315                         sym_name (np), target);
6316                 goto out_stuck;
6317         /*
6318          *  The device reselected a LUN we donnot know about.
6319          */
6320         case SIR_RESEL_BAD_LUN:
6321                 np->msgout[0] = M_RESET;
6322                 goto out;
6323         /*
6324          *  The device reselected for an untagged nexus and we 
6325          *  haven't any.
6326          */
6327         case SIR_RESEL_BAD_I_T_L:
6328                 np->msgout[0] = M_ABORT;
6329                 goto out;
6330         /*
6331          *  The device reselected for a tagged nexus that we donnot 
6332          *  have.
6333          */
6334         case SIR_RESEL_BAD_I_T_L_Q:
6335                 np->msgout[0] = M_ABORT_TAG;
6336                 goto out;
6337         /*
6338          *  The SCRIPTS let us know that the device has grabbed 
6339          *  our message and will abort the job.
6340          */
6341         case SIR_RESEL_ABORTED:
6342                 np->lastmsg = np->msgout[0];
6343                 np->msgout[0] = M_NOOP;
6344                 printf ("%s:%d: message %x sent on bad reselection.\n",
6345                         sym_name (np), target, np->lastmsg);
6346                 goto out;
6347         /*
6348          *  The SCRIPTS let us know that a message has been 
6349          *  successfully sent to the device.
6350          */
6351         case SIR_MSG_OUT_DONE:
6352                 np->lastmsg = np->msgout[0];
6353                 np->msgout[0] = M_NOOP;
6354                 /* Should we really care of that */
6355                 if (np->lastmsg == M_PARITY || np->lastmsg == M_ID_ERROR) {
6356                         if (cp) {
6357                                 cp->xerr_status &= ~XE_PARITY_ERR;
6358                                 if (!cp->xerr_status)
6359                                         OUTOFFB (HF_PRT, HF_EXT_ERR);
6360                         }
6361                 }
6362                 goto out;
6363         /*
6364          *  The device didn't send a GOOD SCSI status.
6365          *  We may have some work to do prior to allow 
6366          *  the SCRIPTS processor to continue.
6367          */
6368         case SIR_BAD_SCSI_STATUS:
6369                 if (!cp)
6370                         goto out;
6371                 sym_sir_bad_scsi_status(np, num, cp);
6372                 return;
6373         /*
6374          *  We are asked by the SCRIPTS to prepare a 
6375          *  REJECT message.
6376          */
6377         case SIR_REJECT_TO_SEND:
6378                 sym_print_msg(cp, "M_REJECT to send for ", np->msgin);
6379                 np->msgout[0] = M_REJECT;
6380                 goto out;
6381         /*
6382          *  We have been ODD at the end of a DATA IN 
6383          *  transfer and the device didn't send a 
6384          *  IGNORE WIDE RESIDUE message.
6385          *  It is a data overrun condition.
6386          */
6387         case SIR_SWIDE_OVERRUN:
6388                 if (cp) {
6389                         OUTONB (HF_PRT, HF_EXT_ERR);
6390                         cp->xerr_status |= XE_SWIDE_OVRUN;
6391                 }
6392                 goto out;
6393         /*
6394          *  We have been ODD at the end of a DATA OUT 
6395          *  transfer.
6396          *  It is a data underrun condition.
6397          */
6398         case SIR_SODL_UNDERRUN:
6399                 if (cp) {
6400                         OUTONB (HF_PRT, HF_EXT_ERR);
6401                         cp->xerr_status |= XE_SODL_UNRUN;
6402                 }
6403                 goto out;
6404         /*
6405          *  The device wants us to tranfer more data than 
6406          *  expected or in the wrong direction.
6407          *  The number of extra bytes is in scratcha.
6408          *  It is a data overrun condition.
6409          */
6410         case SIR_DATA_OVERRUN:
6411                 if (cp) {
6412                         OUTONB (HF_PRT, HF_EXT_ERR);
6413                         cp->xerr_status |= XE_EXTRA_DATA;
6414                         cp->extra_bytes += INL (nc_scratcha);
6415                 }
6416                 goto out;
6417         /*
6418          *  The device switched to an illegal phase (4/5).
6419          */
6420         case SIR_BAD_PHASE:
6421                 if (cp) {
6422                         OUTONB (HF_PRT, HF_EXT_ERR);
6423                         cp->xerr_status |= XE_BAD_PHASE;
6424                 }
6425                 goto out;
6426         /*
6427          *  We received a message.
6428          */
6429         case SIR_MSG_RECEIVED:
6430                 if (!cp)
6431                         goto out_stuck;
6432                 switch (np->msgin [0]) {
6433                 /*
6434                  *  We received an extended message.
6435                  *  We handle MODIFY DATA POINTER, SDTR, WDTR 
6436                  *  and reject all other extended messages.
6437                  */
6438                 case M_EXTENDED:
6439                         switch (np->msgin [2]) {
6440                         case M_X_MODIFY_DP:
6441                                 if (DEBUG_FLAGS & DEBUG_POINTER)
6442                                         sym_print_msg(cp,"modify DP",np->msgin);
6443                                 tmp = (np->msgin[3]<<24) + (np->msgin[4]<<16) + 
6444                                       (np->msgin[5]<<8)  + (np->msgin[6]);
6445                                 sym_modify_dp(np, tp, cp, tmp);
6446                                 return;
6447                         case M_X_SYNC_REQ:
6448                                 sym_sync_nego(np, tp, cp);
6449                                 return;
6450                         case M_X_PPR_REQ:
6451                                 sym_ppr_nego(np, tp, cp);
6452                                 return;
6453                         case M_X_WIDE_REQ:
6454                                 sym_wide_nego(np, tp, cp);
6455                                 return;
6456                         default:
6457                                 goto out_reject;
6458                         }
6459                         break;
6460                 /*
6461                  *  We received a 1/2 byte message not handled from SCRIPTS.
6462                  *  We are only expecting MESSAGE REJECT and IGNORE WIDE 
6463                  *  RESIDUE messages that haven't been anticipated by 
6464                  *  SCRIPTS on SWIDE full condition. Unanticipated IGNORE 
6465                  *  WIDE RESIDUE messages are aliased as MODIFY DP (-1).
6466                  */
6467                 case M_IGN_RESIDUE:
6468                         if (DEBUG_FLAGS & DEBUG_POINTER)
6469                                 sym_print_msg(cp,"ign wide residue", np->msgin);
6470                         sym_modify_dp(np, tp, cp, -1);
6471                         return;
6472                 case M_REJECT:
6473                         if (INB (HS_PRT) == HS_NEGOTIATE)
6474                                 sym_nego_rejected(np, tp, cp);
6475                         else {
6476                                 PRINT_ADDR(cp);
6477                                 printf ("M_REJECT received (%x:%x).\n",
6478                                         scr_to_cpu(np->lastmsg), np->msgout[0]);
6479                         }
6480                         goto out_clrack;
6481                         break;
6482                 default:
6483                         goto out_reject;
6484                 }
6485                 break;
6486         /*
6487          *  We received an unknown message.
6488          *  Ignore all MSG IN phases and reject it.
6489          */
6490         case SIR_MSG_WEIRD:
6491                 sym_print_msg(cp, "WEIRD message received", np->msgin);
6492                 OUTL_DSP (SCRIPTB_BA (np, msg_weird));
6493                 return;
6494         /*
6495          *  Negotiation failed.
6496          *  Target does not send us the reply.
6497          *  Remove the HS_NEGOTIATE status.
6498          */
6499         case SIR_NEGO_FAILED:
6500                 OUTB (HS_PRT, HS_BUSY);
6501         /*
6502          *  Negotiation failed.
6503          *  Target does not want answer message.
6504          */
6505         case SIR_NEGO_PROTO:
6506                 sym_nego_default(np, tp, cp);
6507                 goto out;
6508         };
6509
6510 out:
6511         OUTONB_STD ();
6512         return;
6513 out_reject:
6514         OUTL_DSP (SCRIPTB_BA (np, msg_bad));
6515         return;
6516 out_clrack:
6517         OUTL_DSP (SCRIPTA_BA (np, clrack));
6518         return;
6519 out_stuck:
6520 }
6521
6522 /*
6523  *  Acquire a control block
6524  */
6525 static  ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order)
6526 {
6527         tcb_p tp = &np->target[tn];
6528         lcb_p lp = sym_lp(np, tp, ln);
6529         u_short tag = NO_TAG;
6530         SYM_QUEHEAD *qp;
6531         ccb_p cp = (ccb_p) 0;
6532
6533         /*
6534          *  Look for a free CCB
6535          */
6536         if (sym_que_empty(&np->free_ccbq))
6537                 (void) sym_alloc_ccb(np);
6538         qp = sym_remque_head(&np->free_ccbq);
6539         if (!qp)
6540                 goto out;
6541         cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
6542
6543         /*
6544          *  If the LCB is not yet available and the LUN
6545          *  has been probed ok, try to allocate the LCB.
6546          */
6547         if (!lp && sym_is_bit(tp->lun_map, ln)) {
6548                 lp = sym_alloc_lcb(np, tn, ln);
6549                 if (!lp)
6550                         goto out_free;
6551         }
6552
6553         /*
6554          *  If the LCB is not available here, then the 
6555          *  logical unit is not yet discovered. For those 
6556          *  ones only accept 1 SCSI IO per logical unit, 
6557          *  since we cannot allow disconnections.
6558          */
6559         if (!lp) {
6560                 if (!sym_is_bit(tp->busy0_map, ln))
6561                         sym_set_bit(tp->busy0_map, ln);
6562                 else
6563                         goto out_free;
6564         } else {
6565                 /*
6566                  *  If we have been asked for a tagged command.
6567                  */
6568                 if (tag_order) {
6569                         /*
6570                          *  Debugging purpose.
6571                          */
6572                         assert(lp->busy_itl == 0);
6573                         /*
6574                          *  Allocate resources for tags if not yet.
6575                          */
6576                         if (!lp->cb_tags) {
6577                                 sym_alloc_lcb_tags(np, tn, ln);
6578                                 if (!lp->cb_tags)
6579                                         goto out_free;
6580                         }
6581                         /*
6582                          *  Get a tag for this SCSI IO and set up
6583                          *  the CCB bus address for reselection, 
6584                          *  and count it for this LUN.
6585                          *  Toggle reselect path to tagged.
6586                          */
6587                         if (lp->busy_itlq < SYM_CONF_MAX_TASK) {
6588                                 tag = lp->cb_tags[lp->ia_tag];
6589                                 if (++lp->ia_tag == SYM_CONF_MAX_TASK)
6590                                         lp->ia_tag = 0;
6591                                 lp->itlq_tbl[tag] = cpu_to_scr(cp->ccb_ba);
6592                                 ++lp->busy_itlq;
6593                                 lp->head.resel_sa =
6594                                         cpu_to_scr(SCRIPTA_BA (np, resel_tag));
6595                         }
6596                         else
6597                                 goto out_free;
6598                 }
6599                 /*
6600                  *  This command will not be tagged.
6601                  *  If we already have either a tagged or untagged 
6602                  *  one, refuse to overlap this untagged one.
6603                  */
6604                 else {
6605                         /*
6606                          *  Debugging purpose.
6607                          */
6608                         assert(lp->busy_itl == 0 && lp->busy_itlq == 0);
6609                         /*
6610                          *  Count this nexus for this LUN.
6611                          *  Set up the CCB bus address for reselection.
6612                          *  Toggle reselect path to untagged.
6613                          */
6614                         if (++lp->busy_itl == 1) {
6615                                 lp->head.itl_task_sa = cpu_to_scr(cp->ccb_ba);
6616                                 lp->head.resel_sa =
6617                                       cpu_to_scr(SCRIPTA_BA (np, resel_no_tag));
6618                         }
6619                         else
6620                                 goto out_free;
6621                 }
6622         }
6623         /*
6624          *  Put the CCB into the busy queue.
6625          */
6626         sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
6627
6628         /*
6629          *  Remember all informations needed to free this CCB.
6630          */
6631         cp->to_abort = 0;
6632         cp->tag    = tag;
6633         cp->target = tn;
6634         cp->lun    = ln;
6635
6636         if (DEBUG_FLAGS & DEBUG_TAGS) {
6637                 PRINT_LUN(np, tn, ln);
6638                 printf ("ccb @%p using tag %d.\n", cp, tag);
6639         }
6640
6641 out:
6642         return cp;
6643 out_free:
6644         sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6645         return (ccb_p) 0;
6646 }
6647
6648 /*
6649  *  Release one control block
6650  */
6651 static void sym_free_ccb (hcb_p np, ccb_p cp)
6652 {
6653         tcb_p tp = &np->target[cp->target];
6654         lcb_p lp = sym_lp(np, tp, cp->lun);
6655
6656         if (DEBUG_FLAGS & DEBUG_TAGS) {
6657                 PRINT_LUN(np, cp->target, cp->lun);
6658                 printf ("ccb @%p freeing tag %d.\n", cp, cp->tag);
6659         }
6660
6661         /*
6662          *  If LCB available,
6663          */
6664         if (lp) {
6665                 /*
6666                  *  If tagged, release the tag, set the relect path 
6667                  */
6668                 if (cp->tag != NO_TAG) {
6669                         /*
6670                          *  Free the tag value.
6671                          */
6672                         lp->cb_tags[lp->if_tag] = cp->tag;
6673                         if (++lp->if_tag == SYM_CONF_MAX_TASK)
6674                                 lp->if_tag = 0;
6675                         /*
6676                          *  Make the reselect path invalid, 
6677                          *  and uncount this CCB.
6678                          */
6679                         lp->itlq_tbl[cp->tag] = cpu_to_scr(np->bad_itlq_ba);
6680                         --lp->busy_itlq;
6681                 } else {        /* Untagged */
6682                         /*
6683                          *  Make the reselect path invalid, 
6684                          *  and uncount this CCB.
6685                          */
6686                         lp->head.itl_task_sa = cpu_to_scr(np->bad_itl_ba);
6687                         --lp->busy_itl;
6688                 }
6689                 /*
6690                  *  If no JOB active, make the LUN reselect path invalid.
6691                  */
6692                 if (lp->busy_itlq == 0 && lp->busy_itl == 0)
6693                         lp->head.resel_sa =
6694                                 cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
6695         }
6696         /*
6697          *  Otherwise, we only accept 1 IO per LUN.
6698          *  Clear the bit that keeps track of this IO.
6699          */
6700         else
6701                 sym_clr_bit(tp->busy0_map, cp->lun);
6702
6703         /*
6704          *  We donnot queue more than 1 ccb per target 
6705          *  with negotiation at any time. If this ccb was 
6706          *  used for negotiation, clear this info in the tcb.
6707          */
6708         if (cp == tp->nego_cp)
6709                 tp->nego_cp = 0;
6710
6711 #ifdef SYM_CONF_IARB_SUPPORT
6712         /*
6713          *  If we just complete the last queued CCB,
6714          *  clear this info that is no longer relevant.
6715          */
6716         if (cp == np->last_cp)
6717                 np->last_cp = 0;
6718 #endif
6719
6720 #ifdef  FreeBSD_Bus_Dma_Abstraction
6721         /*
6722          *  Unmap user data from DMA map if needed.
6723          */
6724         if (cp->dmamapped) {
6725                 bus_dmamap_unload(np->data_dmat, cp->dmamap);
6726                 cp->dmamapped = 0;
6727         }
6728 #endif
6729
6730         /*
6731          *  Make this CCB available.
6732          */
6733         cp->cam_ccb = 0;
6734         cp->host_status = HS_IDLE;
6735         sym_remque(&cp->link_ccbq);
6736         sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6737 }
6738
6739 /*
6740  *  Allocate a CCB from memory and initialize its fixed part.
6741  */
6742 static ccb_p sym_alloc_ccb(hcb_p np)
6743 {
6744         ccb_p cp = 0;
6745         int hcode;
6746
6747         /*
6748          *  Prevent from allocating more CCBs than we can 
6749          *  queue to the controller.
6750          */
6751         if (np->actccbs >= SYM_CONF_MAX_START)
6752                 return 0;
6753
6754         /*
6755          *  Allocate memory for this CCB.
6756          */
6757         cp = sym_calloc_dma(sizeof(struct sym_ccb), "CCB");
6758         if (!cp)
6759                 goto out_free;
6760
6761         /*
6762          *  Allocate a bounce buffer for sense data.
6763          */
6764         cp->sns_bbuf = sym_calloc_dma(SYM_SNS_BBUF_LEN, "SNS_BBUF");
6765         if (!cp->sns_bbuf)
6766                 goto out_free;
6767
6768         /*
6769          *  Allocate a map for the DMA of user data.
6770          */
6771 #ifdef  FreeBSD_Bus_Dma_Abstraction
6772         if (bus_dmamap_create(np->data_dmat, 0, &cp->dmamap))
6773                 goto out_free;
6774 #endif
6775         /*
6776          *  Count it.
6777          */
6778         np->actccbs++;
6779
6780         /*
6781          *  Compute the bus address of this ccb.
6782          */
6783         cp->ccb_ba = vtobus(cp);
6784
6785         /*
6786          *  Insert this ccb into the hashed list.
6787          */
6788         hcode = CCB_HASH_CODE(cp->ccb_ba);
6789         cp->link_ccbh = np->ccbh[hcode];
6790         np->ccbh[hcode] = cp;
6791
6792         /*
6793          *  Initialyze the start and restart actions.
6794          */
6795         cp->phys.head.go.start   = cpu_to_scr(SCRIPTA_BA (np, idle));
6796         cp->phys.head.go.restart = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
6797
6798         /*
6799          *  Initilialyze some other fields.
6800          */
6801         cp->phys.smsg_ext.addr = cpu_to_scr(HCB_BA(np, msgin[2]));
6802
6803         /*
6804          *  Chain into free ccb queue.
6805          */
6806         sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6807
6808         return cp;
6809 out_free:
6810         if (cp) {
6811                 if (cp->sns_bbuf)
6812                         sym_mfree_dma(cp->sns_bbuf,SYM_SNS_BBUF_LEN,"SNS_BBUF");
6813                 sym_mfree_dma(cp, sizeof(*cp), "CCB");
6814         }
6815         return 0;
6816 }
6817
6818 /*
6819  *  Look up a CCB from a DSA value.
6820  */
6821 static ccb_p sym_ccb_from_dsa(hcb_p np, u32 dsa)
6822 {
6823         int hcode;
6824         ccb_p cp;
6825
6826         hcode = CCB_HASH_CODE(dsa);
6827         cp = np->ccbh[hcode];
6828         while (cp) {
6829                 if (cp->ccb_ba == dsa)
6830                         break;
6831                 cp = cp->link_ccbh;
6832         }
6833
6834         return cp;
6835 }
6836
6837 /*
6838  *  Target control block initialisation.
6839  *  Nothing important to do at the moment.
6840  */
6841 static void sym_init_tcb (hcb_p np, u_char tn)
6842 {
6843         /*
6844          *  Check some alignments required by the chip.
6845          */     
6846         assert (((offsetof(struct sym_reg, nc_sxfer) ^
6847                 offsetof(struct sym_tcb, head.sval)) &3) == 0);
6848         assert (((offsetof(struct sym_reg, nc_scntl3) ^
6849                 offsetof(struct sym_tcb, head.wval)) &3) == 0);
6850 }
6851
6852 /*
6853  *  Lun control block allocation and initialization.
6854  */
6855 static lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln)
6856 {
6857         tcb_p tp = &np->target[tn];
6858         lcb_p lp = sym_lp(np, tp, ln);
6859
6860         /*
6861          *  Already done, just return.
6862          */
6863         if (lp)
6864                 return lp;
6865         /*
6866          *  Check against some race.
6867          */
6868         assert(!sym_is_bit(tp->busy0_map, ln));
6869
6870         /*
6871          *  Initialize the target control block if not yet.
6872          */
6873         sym_init_tcb (np, tn);
6874
6875         /*
6876          *  Allocate the LCB bus address array.
6877          *  Compute the bus address of this table.
6878          */
6879         if (ln && !tp->luntbl) {
6880                 int i;
6881
6882                 tp->luntbl = sym_calloc_dma(256, "LUNTBL");
6883                 if (!tp->luntbl)
6884                         goto fail;
6885                 for (i = 0 ; i < 64 ; i++)
6886                         tp->luntbl[i] = cpu_to_scr(vtobus(&np->badlun_sa));
6887                 tp->head.luntbl_sa = cpu_to_scr(vtobus(tp->luntbl));
6888         }
6889
6890         /*
6891          *  Allocate the table of pointers for LUN(s) > 0, if needed.
6892          */
6893         if (ln && !tp->lunmp) {
6894                 tp->lunmp = sym_calloc(SYM_CONF_MAX_LUN * sizeof(lcb_p),
6895                                    "LUNMP");
6896                 if (!tp->lunmp)
6897                         goto fail;
6898         }
6899
6900         /*
6901          *  Allocate the lcb.
6902          *  Make it available to the chip.
6903          */
6904         lp = sym_calloc_dma(sizeof(struct sym_lcb), "LCB");
6905         if (!lp)
6906                 goto fail;
6907         if (ln) {
6908                 tp->lunmp[ln] = lp;
6909                 tp->luntbl[ln] = cpu_to_scr(vtobus(lp));
6910         }
6911         else {
6912                 tp->lun0p = lp;
6913                 tp->head.lun0_sa = cpu_to_scr(vtobus(lp));
6914         }
6915
6916         /*
6917          *  Let the itl task point to error handling.
6918          */
6919         lp->head.itl_task_sa = cpu_to_scr(np->bad_itl_ba);
6920
6921         /*
6922          *  Set the reselect pattern to our default. :)
6923          */
6924         lp->head.resel_sa = cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
6925
6926         /*
6927          *  Set user capabilities.
6928          */
6929         lp->user_flags = tp->usrflags & (SYM_DISC_ENABLED | SYM_TAGS_ENABLED);
6930
6931 fail:
6932         return lp;
6933 }
6934
6935 /*
6936  *  Allocate LCB resources for tagged command queuing.
6937  */
6938 static void sym_alloc_lcb_tags (hcb_p np, u_char tn, u_char ln)
6939 {
6940         tcb_p tp = &np->target[tn];
6941         lcb_p lp = sym_lp(np, tp, ln);
6942         int i;
6943
6944         /*
6945          *  If LCB not available, try to allocate it.
6946          */
6947         if (!lp && !(lp = sym_alloc_lcb(np, tn, ln)))
6948                 goto fail;
6949
6950         /*
6951          *  Allocate the task table and and the tag allocation 
6952          *  circular buffer. We want both or none.
6953          */
6954         lp->itlq_tbl = sym_calloc_dma(SYM_CONF_MAX_TASK*4, "ITLQ_TBL");
6955         if (!lp->itlq_tbl)
6956                 goto fail;
6957         lp->cb_tags = sym_calloc(SYM_CONF_MAX_TASK, "CB_TAGS");
6958         if (!lp->cb_tags) {
6959                 sym_mfree_dma(lp->itlq_tbl, SYM_CONF_MAX_TASK*4, "ITLQ_TBL");
6960                 lp->itlq_tbl = 0;
6961                 goto fail;
6962         }
6963
6964         /*
6965          *  Initialize the task table with invalid entries.
6966          */
6967         for (i = 0 ; i < SYM_CONF_MAX_TASK ; i++)
6968                 lp->itlq_tbl[i] = cpu_to_scr(np->notask_ba);
6969
6970         /*
6971          *  Fill up the tag buffer with tag numbers.
6972          */
6973         for (i = 0 ; i < SYM_CONF_MAX_TASK ; i++)
6974                 lp->cb_tags[i] = i;
6975
6976         /*
6977          *  Make the task table available to SCRIPTS, 
6978          *  And accept tagged commands now.
6979          */
6980         lp->head.itlq_tbl_sa = cpu_to_scr(vtobus(lp->itlq_tbl));
6981
6982         return;
6983 fail:
6984 }
6985
6986 /*
6987  *  Test the pci bus snoop logic :-(
6988  *
6989  *  Has to be called with interrupts disabled.
6990  */
6991 #ifndef SYM_CONF_IOMAPPED
6992 static int sym_regtest (hcb_p np)
6993 {
6994         register volatile u32 data;
6995         /*
6996          *  chip registers may NOT be cached.
6997          *  write 0xffffffff to a read only register area,
6998          *  and try to read it back.
6999          */
7000         data = 0xffffffff;
7001         OUTL_OFF(offsetof(struct sym_reg, nc_dstat), data);
7002         data = INL_OFF(offsetof(struct sym_reg, nc_dstat));
7003 #if 1
7004         if (data == 0xffffffff) {
7005 #else
7006         if ((data & 0xe2f0fffd) != 0x02000080) {
7007 #endif
7008                 printf ("CACHE TEST FAILED: reg dstat-sstat2 readback %x.\n",
7009                         (unsigned) data);
7010                 return (0x10);
7011         };
7012         return (0);
7013 }
7014 #endif
7015
7016 static int sym_snooptest (hcb_p np)
7017 {
7018         u32     sym_rd, sym_wr, sym_bk, host_rd, host_wr, pc, dstat;
7019         int     i, err=0;
7020 #ifndef SYM_CONF_IOMAPPED
7021         err |= sym_regtest (np);
7022         if (err) return (err);
7023 #endif
7024 restart_test:
7025         /*
7026          *  Enable Master Parity Checking as we intend 
7027          *  to enable it for normal operations.
7028          */
7029         OUTB (nc_ctest4, (np->rv_ctest4 & MPEE));
7030         /*
7031          *  init
7032          */
7033         pc  = SCRIPTB0_BA (np, snooptest);
7034         host_wr = 1;
7035         sym_wr  = 2;
7036         /*
7037          *  Set memory and register.
7038          */
7039         np->cache = cpu_to_scr(host_wr);
7040         OUTL (nc_temp, sym_wr);
7041         /*
7042          *  Start script (exchange values)
7043          */
7044         OUTL (nc_dsa, np->hcb_ba);
7045         OUTL_DSP (pc);
7046         /*
7047          *  Wait 'til done (with timeout)
7048          */
7049         for (i=0; i<SYM_SNOOP_TIMEOUT; i++)
7050                 if (INB(nc_istat) & (INTF|SIP|DIP))
7051                         break;
7052         if (i>=SYM_SNOOP_TIMEOUT) {
7053                 printf ("CACHE TEST FAILED: timeout.\n");
7054                 return (0x20);
7055         };
7056         /*
7057          *  Check for fatal DMA errors.
7058          */
7059         dstat = INB (nc_dstat);
7060 #if 1   /* Band aiding for broken hardwares that fail PCI parity */
7061         if ((dstat & MDPE) && (np->rv_ctest4 & MPEE)) {
7062                 printf ("%s: PCI DATA PARITY ERROR DETECTED - "
7063                         "DISABLING MASTER DATA PARITY CHECKING.\n",
7064                         sym_name(np));
7065                 np->rv_ctest4 &= ~MPEE;
7066                 goto restart_test;
7067         }
7068 #endif
7069         if (dstat & (MDPE|BF|IID)) {
7070                 printf ("CACHE TEST FAILED: DMA error (dstat=0x%02x).", dstat);
7071                 return (0x80);
7072         }
7073         /*
7074          *  Save termination position.
7075          */
7076         pc = INL (nc_dsp);
7077         /*
7078          *  Read memory and register.
7079          */
7080         host_rd = scr_to_cpu(np->cache);
7081         sym_rd  = INL (nc_scratcha);
7082         sym_bk  = INL (nc_temp);
7083
7084         /*
7085          *  Check termination position.
7086          */
7087         if (pc != SCRIPTB0_BA (np, snoopend)+8) {
7088                 printf ("CACHE TEST FAILED: script execution failed.\n");
7089                 printf ("start=%08lx, pc=%08lx, end=%08lx\n", 
7090                         (u_long) SCRIPTB0_BA (np, snooptest), (u_long) pc,
7091                         (u_long) SCRIPTB0_BA (np, snoopend) +8);
7092                 return (0x40);
7093         };
7094         /*
7095          *  Show results.
7096          */
7097         if (host_wr != sym_rd) {
7098                 printf ("CACHE TEST FAILED: host wrote %d, chip read %d.\n",
7099                         (int) host_wr, (int) sym_rd);
7100                 err |= 1;
7101         };
7102         if (host_rd != sym_wr) {
7103                 printf ("CACHE TEST FAILED: chip wrote %d, host read %d.\n",
7104                         (int) sym_wr, (int) host_rd);
7105                 err |= 2;
7106         };
7107         if (sym_bk != sym_wr) {
7108                 printf ("CACHE TEST FAILED: chip wrote %d, read back %d.\n",
7109                         (int) sym_wr, (int) sym_bk);
7110                 err |= 4;
7111         };
7112
7113         return (err);
7114 }
7115
7116 /*
7117  *  Determine the chip's clock frequency.
7118  *
7119  *  This is essential for the negotiation of the synchronous 
7120  *  transfer rate.
7121  *
7122  *  Note: we have to return the correct value.
7123  *  THERE IS NO SAFE DEFAULT VALUE.
7124  *
7125  *  Most NCR/SYMBIOS boards are delivered with a 40 Mhz clock.
7126  *  53C860 and 53C875 rev. 1 support fast20 transfers but 
7127  *  do not have a clock doubler and so are provided with a 
7128  *  80 MHz clock. All other fast20 boards incorporate a doubler 
7129  *  and so should be delivered with a 40 MHz clock.
7130  *  The recent fast40 chips (895/896/895A/1010) use a 40 Mhz base 
7131  *  clock and provide a clock quadrupler (160 Mhz).
7132  */
7133
7134 /*
7135  *  Select SCSI clock frequency
7136  */
7137 static void sym_selectclock(hcb_p np, u_char scntl3)
7138 {
7139         /*
7140          *  If multiplier not present or not selected, leave here.
7141          */
7142         if (np->multiplier <= 1) {
7143                 OUTB(nc_scntl3, scntl3);
7144                 return;
7145         }
7146
7147         if (sym_verbose >= 2)
7148                 printf ("%s: enabling clock multiplier\n", sym_name(np));
7149
7150         OUTB(nc_stest1, DBLEN);    /* Enable clock multiplier             */
7151         /*
7152          *  Wait for the LCKFRQ bit to be set if supported by the chip.
7153          *  Otherwise wait 20 micro-seconds.
7154          */
7155         if (np->features & FE_LCKFRQ) {
7156                 int i = 20;
7157                 while (!(INB(nc_stest4) & LCKFRQ) && --i > 0)
7158                         UDELAY (20);
7159                 if (!i)
7160                         printf("%s: the chip cannot lock the frequency\n",
7161                                 sym_name(np));
7162         } else
7163                 UDELAY (20);
7164         OUTB(nc_stest3, HSC);           /* Halt the scsi clock          */
7165         OUTB(nc_scntl3, scntl3);
7166         OUTB(nc_stest1, (DBLEN|DBLSEL));/* Select clock multiplier      */
7167         OUTB(nc_stest3, 0x00);          /* Restart scsi clock           */
7168 }
7169
7170 /*
7171  *  calculate SCSI clock frequency (in KHz)
7172  */
7173 static unsigned getfreq (hcb_p np, int gen)
7174 {
7175         unsigned int ms = 0;
7176         unsigned int f;
7177
7178         /*
7179          * Measure GEN timer delay in order 
7180          * to calculate SCSI clock frequency
7181          *
7182          * This code will never execute too
7183          * many loop iterations (if DELAY is 
7184          * reasonably correct). It could get
7185          * too low a delay (too high a freq.)
7186          * if the CPU is slow executing the 
7187          * loop for some reason (an NMI, for
7188          * example). For this reason we will
7189          * if multiple measurements are to be 
7190          * performed trust the higher delay 
7191          * (lower frequency returned).
7192          */
7193         OUTW (nc_sien , 0);     /* mask all scsi interrupts */
7194         (void) INW (nc_sist);   /* clear pending scsi interrupt */
7195         OUTB (nc_dien , 0);     /* mask all dma interrupts */
7196         (void) INW (nc_sist);   /* another one, just to be sure :) */
7197         OUTB (nc_scntl3, 4);    /* set pre-scaler to divide by 3 */
7198         OUTB (nc_stime1, 0);    /* disable general purpose timer */
7199         OUTB (nc_stime1, gen);  /* set to nominal delay of 1<<gen * 125us */
7200         while (!(INW(nc_sist) & GEN) && ms++ < 100000)
7201                 UDELAY (1000);  /* count ms */
7202         OUTB (nc_stime1, 0);    /* disable general purpose timer */
7203         /*
7204          * set prescaler to divide by whatever 0 means
7205          * 0 ought to choose divide by 2, but appears
7206          * to set divide by 3.5 mode in my 53c810 ...
7207          */
7208         OUTB (nc_scntl3, 0);
7209
7210         /*
7211          * adjust for prescaler, and convert into KHz 
7212          */
7213         f = ms ? ((1 << gen) * 4340) / ms : 0;
7214
7215         if (sym_verbose >= 2)
7216                 printf ("%s: Delay (GEN=%d): %u msec, %u KHz\n",
7217                         sym_name(np), gen, ms, f);
7218
7219         return f;
7220 }
7221
7222 static unsigned sym_getfreq (hcb_p np)
7223 {
7224         u_int f1, f2;
7225         int gen = 11;
7226
7227         (void) getfreq (np, gen);       /* throw away first result */
7228         f1 = getfreq (np, gen);
7229         f2 = getfreq (np, gen);
7230         if (f1 > f2) f1 = f2;           /* trust lower result   */
7231         return f1;
7232 }
7233
7234 /*
7235  *  Get/probe chip SCSI clock frequency
7236  */
7237 static void sym_getclock (hcb_p np, int mult)
7238 {
7239         unsigned char scntl3 = np->sv_scntl3;
7240         unsigned char stest1 = np->sv_stest1;
7241         unsigned f1;
7242
7243         /*
7244          *  For the C10 core, assume 40 MHz.
7245          */
7246         if (np->features & FE_C10) {
7247                 np->multiplier = mult;
7248                 np->clock_khz = 40000 * mult;
7249                 return;
7250         }
7251
7252         np->multiplier = 1;
7253         f1 = 40000;
7254         /*
7255          *  True with 875/895/896/895A with clock multiplier selected
7256          */
7257         if (mult > 1 && (stest1 & (DBLEN+DBLSEL)) == DBLEN+DBLSEL) {
7258                 if (sym_verbose >= 2)
7259                         printf ("%s: clock multiplier found\n", sym_name(np));
7260                 np->multiplier = mult;
7261         }
7262
7263         /*
7264          *  If multiplier not found or scntl3 not 7,5,3,
7265          *  reset chip and get frequency from general purpose timer.
7266          *  Otherwise trust scntl3 BIOS setting.
7267          */
7268         if (np->multiplier != mult || (scntl3 & 7) < 3 || !(scntl3 & 1)) {
7269                 OUTB (nc_stest1, 0);            /* make sure doubler is OFF */
7270                 f1 = sym_getfreq (np);
7271
7272                 if (sym_verbose)
7273                         printf ("%s: chip clock is %uKHz\n", sym_name(np), f1);
7274
7275                 if      (f1 <   45000)          f1 =  40000;
7276                 else if (f1 <   55000)          f1 =  50000;
7277                 else                            f1 =  80000;
7278
7279                 if (f1 < 80000 && mult > 1) {
7280                         if (sym_verbose >= 2)
7281                                 printf ("%s: clock multiplier assumed\n",
7282                                         sym_name(np));
7283                         np->multiplier  = mult;
7284                 }
7285         } else {
7286                 if      ((scntl3 & 7) == 3)     f1 =  40000;
7287                 else if ((scntl3 & 7) == 5)     f1 =  80000;
7288                 else                            f1 = 160000;
7289
7290                 f1 /= np->multiplier;
7291         }
7292
7293         /*
7294          *  Compute controller synchronous parameters.
7295          */
7296         f1              *= np->multiplier;
7297         np->clock_khz   = f1;
7298 }
7299
7300 /*
7301  *  Get/probe PCI clock frequency
7302  */
7303 static int sym_getpciclock (hcb_p np)
7304 {
7305         int f = 0;
7306
7307         /*
7308          *  For the C1010-33, this doesn't work.
7309          *  For the C1010-66, this will be tested when I'll have 
7310          *  such a beast to play with.
7311          */
7312         if (!(np->features & FE_C10)) {
7313                 OUTB (nc_stest1, SCLK); /* Use the PCI clock as SCSI clock */
7314                 f = (int) sym_getfreq (np);
7315                 OUTB (nc_stest1, 0);
7316         }
7317         np->pciclk_khz = f;
7318
7319         return f;
7320 }
7321
7322 /*============= DRIVER ACTION/COMPLETION ====================*/
7323
7324 /*
7325  *  Print something that tells about extended errors.
7326  */
7327 static void sym_print_xerr(ccb_p cp, int x_status)
7328 {
7329         if (x_status & XE_PARITY_ERR) {
7330                 PRINT_ADDR(cp);
7331                 printf ("unrecovered SCSI parity error.\n");
7332         }
7333         if (x_status & XE_EXTRA_DATA) {
7334                 PRINT_ADDR(cp);
7335                 printf ("extraneous data discarded.\n");
7336         }
7337         if (x_status & XE_BAD_PHASE) {
7338                 PRINT_ADDR(cp);
7339                 printf ("illegal scsi phase (4/5).\n");
7340         }
7341         if (x_status & XE_SODL_UNRUN) {
7342                 PRINT_ADDR(cp);
7343                 printf ("ODD transfer in DATA OUT phase.\n");
7344         }
7345         if (x_status & XE_SWIDE_OVRUN) {
7346                 PRINT_ADDR(cp);
7347                 printf ("ODD transfer in DATA IN phase.\n");
7348         }
7349 }
7350
7351 /*
7352  *  Choose the more appropriate CAM status if 
7353  *  the IO encountered an extended error.
7354  */
7355 static int sym_xerr_cam_status(int cam_status, int x_status)
7356 {
7357         if (x_status) {
7358                 if      (x_status & XE_PARITY_ERR)
7359                         cam_status = CAM_UNCOR_PARITY;
7360                 else if (x_status &(XE_EXTRA_DATA|XE_SODL_UNRUN|XE_SWIDE_OVRUN))
7361                         cam_status = CAM_DATA_RUN_ERR;
7362                 else if (x_status & XE_BAD_PHASE)
7363                         cam_status = CAM_REQ_CMP_ERR;
7364                 else
7365                         cam_status = CAM_REQ_CMP_ERR;
7366         }
7367         return cam_status;
7368 }
7369
7370 /*
7371  *  Complete execution of a SCSI command with extented 
7372  *  error, SCSI status error, or having been auto-sensed.
7373  *
7374  *  The SCRIPTS processor is not running there, so we 
7375  *  can safely access IO registers and remove JOBs from  
7376  *  the START queue.
7377  *  SCRATCHA is assumed to have been loaded with STARTPOS 
7378  *  before the SCRIPTS called the C code.
7379  */
7380 static void sym_complete_error (hcb_p np, ccb_p cp)
7381 {
7382         struct ccb_scsiio *csio;
7383         u_int cam_status;
7384         int i;
7385
7386         /*
7387          *  Paranoid check. :)
7388          */
7389         if (!cp || !cp->cam_ccb)
7390                 return;
7391
7392         if (DEBUG_FLAGS & (DEBUG_TINY|DEBUG_RESULT)) {
7393                 printf ("CCB=%lx STAT=%x/%x/%x DEV=%d/%d\n", (unsigned long)cp,
7394                         cp->host_status, cp->ssss_status, cp->host_flags,
7395                         cp->target, cp->lun);
7396                 MDELAY(100);
7397         }
7398
7399         /*
7400          *  Get CAM command pointer.
7401          */
7402         csio = &cp->cam_ccb->csio;
7403
7404         /*
7405          *  Check for extended errors.
7406          */
7407         if (cp->xerr_status) {
7408                 if (sym_verbose)
7409                         sym_print_xerr(cp, cp->xerr_status);
7410                 if (cp->host_status == HS_COMPLETE)
7411                         cp->host_status = HS_COMP_ERR;
7412         }
7413
7414         /*
7415          *  Calculate the residual.
7416          */
7417         csio->sense_resid = 0;
7418         csio->resid = sym_compute_residual(np, cp);
7419
7420         if (!SYM_CONF_RESIDUAL_SUPPORT) {/* If user does not want residuals */
7421                 csio->resid  = 0;       /* throw them away. :)             */
7422                 cp->sv_resid = 0;
7423         }
7424
7425         if (cp->host_flags & HF_SENSE) {                /* Auto sense     */
7426                 csio->scsi_status = cp->sv_scsi_status; /* Restore status */
7427                 csio->sense_resid = csio->resid;        /* Swap residuals */
7428                 csio->resid       = cp->sv_resid;
7429                 cp->sv_resid      = 0;
7430                 if (sym_verbose && cp->sv_xerr_status)
7431                         sym_print_xerr(cp, cp->sv_xerr_status);
7432                 if (cp->host_status == HS_COMPLETE &&
7433                     cp->ssss_status == S_GOOD &&
7434                     cp->xerr_status == 0) {
7435                         cam_status = sym_xerr_cam_status(CAM_SCSI_STATUS_ERROR,
7436                                                          cp->sv_xerr_status);
7437                         cam_status |= CAM_AUTOSNS_VALID;
7438                         /*
7439                          *  Bounce back the sense data to user and 
7440                          *  fix the residual.
7441                          */
7442                         bzero(&csio->sense_data, csio->sense_len);
7443                         bcopy(cp->sns_bbuf, &csio->sense_data,
7444                               MIN(csio->sense_len, SYM_SNS_BBUF_LEN));
7445                         csio->sense_resid += csio->sense_len;
7446                         csio->sense_resid -= SYM_SNS_BBUF_LEN;
7447 #if 0
7448                         /*
7449                          *  If the device reports a UNIT ATTENTION condition 
7450                          *  due to a RESET condition, we should consider all 
7451                          *  disconnect CCBs for this unit as aborted.
7452                          */
7453                         if (1) {
7454                                 u_char *p;
7455                                 p  = (u_char *) csio->sense_data;
7456                                 if (p[0]==0x70 && p[2]==0x6 && p[12]==0x29)
7457                                         sym_clear_tasks(np, CAM_REQ_ABORTED,
7458                                                         cp->target,cp->lun, -1);
7459                         }
7460 #endif
7461                 }
7462                 else
7463                         cam_status = CAM_AUTOSENSE_FAIL;
7464         }
7465         else if (cp->host_status == HS_COMPLETE) {      /* Bad SCSI status */
7466                 csio->scsi_status = cp->ssss_status;
7467                 cam_status = CAM_SCSI_STATUS_ERROR;
7468         }
7469         else if (cp->host_status == HS_SEL_TIMEOUT)     /* Selection timeout */
7470                 cam_status = CAM_SEL_TIMEOUT;
7471         else if (cp->host_status == HS_UNEXPECTED)      /* Unexpected BUS FREE*/
7472                 cam_status = CAM_UNEXP_BUSFREE;
7473         else {                                          /* Extended error */
7474                 if (sym_verbose) {
7475                         PRINT_ADDR(cp);
7476                         printf ("COMMAND FAILED (%x %x %x).\n",
7477                                 cp->host_status, cp->ssss_status,
7478                                 cp->xerr_status);
7479                 }
7480                 csio->scsi_status = cp->ssss_status;
7481                 /*
7482                  *  Set the most appropriate value for CAM status.
7483                  */
7484                 cam_status = sym_xerr_cam_status(CAM_REQ_CMP_ERR,
7485                                                  cp->xerr_status);
7486         }
7487
7488         /*
7489          *  Dequeue all queued CCBs for that device 
7490          *  not yet started by SCRIPTS.
7491          */
7492         i = (INL (nc_scratcha) - np->squeue_ba) / 4;
7493         (void) sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
7494
7495         /*
7496          *  Restart the SCRIPTS processor.
7497          */
7498         OUTL_DSP (SCRIPTA_BA (np, start));
7499
7500 #ifdef  FreeBSD_Bus_Dma_Abstraction
7501         /*
7502          *  Synchronize DMA map if needed.
7503          */
7504         if (cp->dmamapped) {
7505                 bus_dmamap_sync(np->data_dmat, cp->dmamap,
7506                         (bus_dmasync_op_t)(cp->dmamapped == SYM_DMA_READ ? 
7507                                 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE));
7508         }
7509 #endif
7510         /*
7511          *  Add this one to the COMP queue.
7512          *  Complete all those commands with either error 
7513          *  or requeue condition.
7514          */
7515         sym_set_cam_status((union ccb *) csio, cam_status);
7516         sym_remque(&cp->link_ccbq);
7517         sym_insque_head(&cp->link_ccbq, &np->comp_ccbq);
7518         sym_flush_comp_queue(np, 0);
7519 }
7520
7521 /*
7522  *  Complete execution of a successful SCSI command.
7523  *
7524  *  Only successful commands go to the DONE queue, 
7525  *  since we need to have the SCRIPTS processor 
7526  *  stopped on any error condition.
7527  *  The SCRIPTS processor is running while we are 
7528  *  completing successful commands.
7529  */
7530 static void sym_complete_ok (hcb_p np, ccb_p cp)
7531 {
7532         struct ccb_scsiio *csio;
7533         tcb_p tp;
7534         lcb_p lp;
7535
7536         /*
7537          *  Paranoid check. :)
7538          */
7539         if (!cp || !cp->cam_ccb)
7540                 return;
7541         assert (cp->host_status == HS_COMPLETE);
7542
7543         /*
7544          *  Get command, target and lun pointers.
7545          */
7546         csio = &cp->cam_ccb->csio;
7547         tp = &np->target[cp->target];
7548         lp = sym_lp(np, tp, cp->lun);
7549
7550         /*
7551          *  Assume device discovered on first success.
7552          */
7553         if (!lp)
7554                 sym_set_bit(tp->lun_map, cp->lun);
7555
7556         /*
7557          *  If all data have been transferred, given than no
7558          *  extended error did occur, there is no residual.
7559          */
7560         csio->resid = 0;
7561         if (cp->phys.head.lastp != cp->phys.head.goalp)
7562                 csio->resid = sym_compute_residual(np, cp);
7563
7564         /*
7565          *  Wrong transfer residuals may be worse than just always 
7566          *  returning zero. User can disable this feature from 
7567          *  sym_conf.h. Residual support is enabled by default.
7568          */
7569         if (!SYM_CONF_RESIDUAL_SUPPORT)
7570                 csio->resid  = 0;
7571
7572 #ifdef  FreeBSD_Bus_Dma_Abstraction
7573         /*
7574          *  Synchronize DMA map if needed.
7575          */
7576         if (cp->dmamapped) {
7577                 bus_dmamap_sync(np->data_dmat, cp->dmamap,
7578                         (bus_dmasync_op_t)(cp->dmamapped == SYM_DMA_READ ? 
7579                                 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE));
7580         }
7581 #endif
7582         /*
7583          *  Set status and complete the command.
7584          */
7585         csio->scsi_status = cp->ssss_status;
7586         sym_set_cam_status((union ccb *) csio, CAM_REQ_CMP);
7587         sym_free_ccb (np, cp);
7588         sym_xpt_done(np, (union ccb *) csio);
7589 }
7590
7591 /*
7592  *  Our timeout handler.
7593  */
7594 static void sym_timeout1(void *arg)
7595 {
7596         union ccb *ccb = (union ccb *) arg;
7597         hcb_p np = ccb->ccb_h.sym_hcb_ptr;
7598
7599         /*
7600          *  Check that the CAM CCB is still queued.
7601          */
7602         if (!np)
7603                 return;
7604
7605         switch(ccb->ccb_h.func_code) {
7606         case XPT_SCSI_IO:
7607                 (void) sym_abort_scsiio(np, ccb, 1);
7608                 break;
7609         default:
7610                 break;
7611         }
7612 }
7613
7614 static void sym_timeout(void *arg)
7615 {
7616         int s = splcam();
7617         sym_timeout1(arg);
7618         splx(s);
7619 }
7620
7621 /*
7622  *  Abort an SCSI IO.
7623  */
7624 static int sym_abort_scsiio(hcb_p np, union ccb *ccb, int timed_out)
7625 {
7626         ccb_p cp;
7627         SYM_QUEHEAD *qp;
7628
7629         /*
7630          *  Look up our CCB control block.
7631          */
7632         cp = 0;
7633         FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
7634                 ccb_p cp2 = sym_que_entry(qp, struct sym_ccb, link_ccbq);
7635                 if (cp2->cam_ccb == ccb) {
7636                         cp = cp2;
7637                         break;
7638                 }
7639         }
7640         if (!cp || cp->host_status == HS_WAIT)
7641                 return -1;
7642
7643         /*
7644          *  If a previous abort didn't succeed in time,
7645          *  perform a BUS reset.
7646          */
7647         if (cp->to_abort) {
7648                 sym_reset_scsi_bus(np, 1);
7649                 return 0;
7650         }
7651
7652         /*
7653          *  Mark the CCB for abort and allow time for.
7654          */
7655         cp->to_abort = timed_out ? 2 : 1;
7656         ccb->ccb_h.timeout_ch = timeout(sym_timeout, (caddr_t) ccb, 10*hz);
7657
7658         /*
7659          *  Tell the SCRIPTS processor to stop and synchronize with us.
7660          */
7661         np->istat_sem = SEM;
7662         OUTB (nc_istat, SIGP|SEM);
7663         return 0;
7664 }
7665
7666 /*
7667  *  Reset a SCSI device (all LUNs of a target).
7668  */
7669 static void sym_reset_dev(hcb_p np, union ccb *ccb)
7670 {
7671         tcb_p tp;
7672         struct ccb_hdr *ccb_h = &ccb->ccb_h;
7673
7674         if (ccb_h->target_id   == np->myaddr ||
7675             ccb_h->target_id   >= SYM_CONF_MAX_TARGET ||
7676             ccb_h->target_lun  >= SYM_CONF_MAX_LUN) {
7677                 sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7678                 return;
7679         }
7680
7681         tp = &np->target[ccb_h->target_id];
7682
7683         tp->to_reset = 1;
7684         sym_xpt_done2(np, ccb, CAM_REQ_CMP);
7685
7686         np->istat_sem = SEM;
7687         OUTB (nc_istat, SIGP|SEM);
7688         return;
7689 }
7690
7691 /*
7692  *  SIM action entry point.
7693  */
7694 static void sym_action(struct cam_sim *sim, union ccb *ccb)
7695 {
7696         int s = splcam();
7697         sym_action1(sim, ccb);
7698         splx(s);
7699 }
7700
7701 static void sym_action1(struct cam_sim *sim, union ccb *ccb)
7702 {
7703         hcb_p   np;
7704         tcb_p   tp;
7705         lcb_p   lp;
7706         ccb_p   cp;
7707         int     tmp;
7708         u_char  idmsg, *msgptr;
7709         u_int   msglen;
7710         struct  ccb_scsiio *csio;
7711         struct  ccb_hdr  *ccb_h;
7712
7713         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE, ("sym_action\n"));
7714
7715         /*
7716          *  Retrieve our controller data structure.
7717          */
7718         np = (hcb_p) cam_sim_softc(sim);
7719
7720         /*
7721          *  The common case is SCSI IO.
7722          *  We deal with other ones elsewhere.
7723          */
7724         if (ccb->ccb_h.func_code != XPT_SCSI_IO) {
7725                 sym_action2(sim, ccb);
7726                 return;
7727         }
7728         csio  = &ccb->csio;
7729         ccb_h = &csio->ccb_h;
7730
7731         /*
7732          *  Work around races.
7733          */
7734         if ((ccb_h->status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
7735                 xpt_done(ccb);
7736                 return;
7737         }
7738
7739         /*
7740          *  Minimal checkings, so that we will not 
7741          *  go outside our tables.
7742          */
7743         if (ccb_h->target_id   == np->myaddr ||
7744             ccb_h->target_id   >= SYM_CONF_MAX_TARGET ||
7745             ccb_h->target_lun  >= SYM_CONF_MAX_LUN) {
7746                 sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7747                 return;
7748         }
7749
7750         /*
7751          *  Retreive the target and lun descriptors.
7752          */
7753         tp = &np->target[ccb_h->target_id];
7754         lp = sym_lp(np, tp, ccb_h->target_lun);
7755
7756         /*
7757          *  Complete the 1st INQUIRY command with error 
7758          *  condition if the device is flagged NOSCAN 
7759          *  at BOOT in the NVRAM. This may speed up 
7760          *  the boot and maintain coherency with BIOS 
7761          *  device numbering. Clearing the flag allows 
7762          *  user to rescan skipped devices later.
7763          *  We also return error for devices not flagged 
7764          *  for SCAN LUNS in the NVRAM since some mono-lun 
7765          *  devices behave badly when asked for some non 
7766          *  zero LUN. Btw, this is an absolute hack.:-)
7767          */
7768         if (!(ccb_h->flags & CAM_CDB_PHYS) &&
7769             (0x12 == ((ccb_h->flags & CAM_CDB_POINTER) ?
7770                   csio->cdb_io.cdb_ptr[0] : csio->cdb_io.cdb_bytes[0]))) {
7771                 if ((tp->usrflags & SYM_SCAN_BOOT_DISABLED) ||
7772                     ((tp->usrflags & SYM_SCAN_LUNS_DISABLED) && 
7773                      ccb_h->target_lun != 0)) {
7774                         tp->usrflags &= ~SYM_SCAN_BOOT_DISABLED;
7775                         sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7776                         return;
7777                 }
7778         }
7779
7780         /*
7781          *  Get a control block for this IO.
7782          */
7783         tmp = ((ccb_h->flags & CAM_TAG_ACTION_VALID) != 0);
7784         cp = sym_get_ccb(np, ccb_h->target_id, ccb_h->target_lun, tmp);
7785         if (!cp) {
7786                 sym_xpt_done2(np, ccb, CAM_RESRC_UNAVAIL);
7787                 return;
7788         }
7789
7790         /*
7791          *  Keep track of the IO in our CCB.
7792          */
7793         cp->cam_ccb = ccb;
7794
7795         /*
7796          *  Build the IDENTIFY message.
7797          */
7798         idmsg = M_IDENTIFY | cp->lun;
7799         if (cp->tag != NO_TAG || (lp && (lp->current_flags & SYM_DISC_ENABLED)))
7800                 idmsg |= 0x40;
7801
7802         msgptr = cp->scsi_smsg;
7803         msglen = 0;
7804         msgptr[msglen++] = idmsg;
7805
7806         /*
7807          *  Build the tag message if present.
7808          */
7809         if (cp->tag != NO_TAG) {
7810                 u_char order = csio->tag_action;
7811
7812                 switch(order) {
7813                 case M_ORDERED_TAG:
7814                         break;
7815                 case M_HEAD_TAG:
7816                         break;
7817                 default:
7818                         order = M_SIMPLE_TAG;
7819                 }
7820                 msgptr[msglen++] = order;
7821
7822                 /*
7823                  *  For less than 128 tags, actual tags are numbered 
7824                  *  1,3,5,..2*MAXTAGS+1,since we may have to deal 
7825                  *  with devices that have problems with #TAG 0 or too 
7826                  *  great #TAG numbers. For more tags (up to 256), 
7827                  *  we use directly our tag number.
7828                  */
7829 #if SYM_CONF_MAX_TASK > (512/4)
7830                 msgptr[msglen++] = cp->tag;
7831 #else
7832                 msgptr[msglen++] = (cp->tag << 1) + 1;
7833 #endif
7834         }
7835
7836         /*
7837          *  Build a negotiation message if needed.
7838          *  (nego_status is filled by sym_prepare_nego())
7839          */
7840         cp->nego_status = 0;
7841         if (tp->tinfo.current.width   != tp->tinfo.goal.width  ||
7842             tp->tinfo.current.period  != tp->tinfo.goal.period ||
7843             tp->tinfo.current.offset  != tp->tinfo.goal.offset ||
7844             tp->tinfo.current.options != tp->tinfo.goal.options) {
7845                 if (!tp->nego_cp && lp)
7846                         msglen += sym_prepare_nego(np, cp, 0, msgptr + msglen);
7847         }
7848
7849         /*
7850          *  Fill in our ccb
7851          */
7852
7853         /*
7854          *  Startqueue
7855          */
7856         cp->phys.head.go.start   = cpu_to_scr(SCRIPTA_BA (np, select));
7857         cp->phys.head.go.restart = cpu_to_scr(SCRIPTA_BA (np, resel_dsa));
7858
7859         /*
7860          *  select
7861          */
7862         cp->phys.select.sel_id          = cp->target;
7863         cp->phys.select.sel_scntl3      = tp->head.wval;
7864         cp->phys.select.sel_sxfer       = tp->head.sval;
7865         cp->phys.select.sel_scntl4      = tp->head.uval;
7866
7867         /*
7868          *  message
7869          */
7870         cp->phys.smsg.addr      = cpu_to_scr(CCB_BA (cp, scsi_smsg));
7871         cp->phys.smsg.size      = cpu_to_scr(msglen);
7872
7873         /*
7874          *  command
7875          */
7876         if (sym_setup_cdb(np, csio, cp) < 0) {
7877                 sym_free_ccb(np, cp);
7878                 sym_xpt_done(np, ccb);
7879                 return;
7880         }
7881
7882         /*
7883          *  status
7884          */
7885 #if     0       /* Provision */
7886         cp->actualquirks        = tp->quirks;
7887 #endif
7888         cp->actualquirks        = SYM_QUIRK_AUTOSAVE;
7889         cp->host_status         = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
7890         cp->ssss_status         = S_ILLEGAL;
7891         cp->xerr_status         = 0;
7892         cp->host_flags          = 0;
7893         cp->extra_bytes         = 0;
7894
7895         /*
7896          *  extreme data pointer.
7897          *  shall be positive, so -1 is lower than lowest.:)
7898          */
7899         cp->ext_sg  = -1;
7900         cp->ext_ofs = 0;
7901
7902         /*
7903          *  Build the data descriptor block 
7904          *  and start the IO.
7905          */
7906         sym_setup_data_and_start(np, csio, cp);
7907 }
7908
7909 /*
7910  *  Setup buffers and pointers that address the CDB.
7911  *  I bet, physical CDBs will never be used on the planet, 
7912  *  since they can be bounced without significant overhead.
7913  */
7914 static int sym_setup_cdb(hcb_p np, struct ccb_scsiio *csio, ccb_p cp)
7915 {
7916         struct ccb_hdr *ccb_h;
7917         u32     cmd_ba;
7918         int     cmd_len;
7919         
7920         ccb_h = &csio->ccb_h;
7921
7922         /*
7923          *  CDB is 16 bytes max.
7924          */
7925         if (csio->cdb_len > sizeof(cp->cdb_buf)) {
7926                 sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7927                 return -1;
7928         }
7929         cmd_len = csio->cdb_len;
7930
7931         if (ccb_h->flags & CAM_CDB_POINTER) {
7932                 /* CDB is a pointer */
7933                 if (!(ccb_h->flags & CAM_CDB_PHYS)) {
7934                         /* CDB pointer is virtual */
7935                         bcopy(csio->cdb_io.cdb_ptr, cp->cdb_buf, cmd_len);
7936                         cmd_ba = CCB_BA (cp, cdb_buf[0]);
7937                 } else {
7938                         /* CDB pointer is physical */
7939 #if 0
7940                         cmd_ba = ((u32)csio->cdb_io.cdb_ptr) & 0xffffffff;
7941 #else
7942                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7943                         return -1;
7944 #endif
7945                 }
7946         } else {
7947                 /* CDB is in the CAM ccb (buffer) */
7948                 bcopy(csio->cdb_io.cdb_bytes, cp->cdb_buf, cmd_len);
7949                 cmd_ba = CCB_BA (cp, cdb_buf[0]);
7950         }
7951
7952         cp->phys.cmd.addr       = cpu_to_scr(cmd_ba);
7953         cp->phys.cmd.size       = cpu_to_scr(cmd_len);
7954
7955         return 0;
7956 }
7957
7958 /*
7959  *  Set up data pointers used by SCRIPTS.
7960  */
7961 static void __inline 
7962 sym_setup_data_pointers(hcb_p np, ccb_p cp, int dir)
7963 {
7964         u32 lastp, goalp;
7965
7966         /*
7967          *  No segments means no data.
7968          */
7969         if (!cp->segments)
7970                 dir = CAM_DIR_NONE;
7971
7972         /*
7973          *  Set the data pointer.
7974          */
7975         switch(dir) {
7976         case CAM_DIR_OUT:
7977                 goalp = SCRIPTA_BA (np, data_out2) + 8;
7978                 lastp = goalp - 8 - (cp->segments * (2*4));
7979                 break;
7980         case CAM_DIR_IN:
7981                 cp->host_flags |= HF_DATA_IN;
7982                 goalp = SCRIPTA_BA (np, data_in2) + 8;
7983                 lastp = goalp - 8 - (cp->segments * (2*4));
7984                 break;
7985         case CAM_DIR_NONE:
7986         default:
7987                 lastp = goalp = SCRIPTB_BA (np, no_data);
7988                 break;
7989         }
7990
7991         cp->phys.head.lastp = cpu_to_scr(lastp);
7992         cp->phys.head.goalp = cpu_to_scr(goalp);
7993         cp->phys.head.savep = cpu_to_scr(lastp);
7994         cp->startp          = cp->phys.head.savep;
7995 }
7996
7997
7998 #ifdef  FreeBSD_Bus_Dma_Abstraction
7999 /*
8000  *  Call back routine for the DMA map service.
8001  *  If bounce buffers are used (why ?), we may sleep and then 
8002  *  be called there in another context.
8003  */
8004 static void
8005 sym_execute_ccb(void *arg, bus_dma_segment_t *psegs, int nsegs, int error)
8006 {
8007         ccb_p   cp;
8008         hcb_p   np;
8009         union   ccb *ccb;
8010         int     s;
8011
8012         s = splcam();
8013
8014         cp  = (ccb_p) arg;
8015         ccb = cp->cam_ccb;
8016         np  = (hcb_p) cp->arg;
8017
8018         /*
8019          *  Deal with weird races.
8020          */
8021         if (sym_get_cam_status(ccb) != CAM_REQ_INPROG)
8022                 goto out_abort;
8023
8024         /*
8025          *  Deal with weird errors.
8026          */
8027         if (error) {
8028                 cp->dmamapped = 0;
8029                 sym_set_cam_status(cp->cam_ccb, CAM_REQ_ABORTED);
8030                 goto out_abort;
8031         }
8032
8033         /*
8034          *  Build the data descriptor for the chip.
8035          */
8036         if (nsegs) {
8037                 int retv;
8038                 /* 896 rev 1 requires to be careful about boundaries */
8039                 if (np->device_id == PCI_ID_SYM53C896 && np->revision_id <= 1)
8040                         retv = sym_scatter_sg_physical(np, cp, psegs, nsegs);
8041                 else
8042                         retv = sym_fast_scatter_sg_physical(np,cp, psegs,nsegs);
8043                 if (retv < 0) {
8044                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_TOO_BIG);
8045                         goto out_abort;
8046                 }
8047         }
8048
8049         /*
8050          *  Synchronize the DMA map only if we have 
8051          *  actually mapped the data.
8052          */
8053         if (cp->dmamapped) {
8054                 bus_dmamap_sync(np->data_dmat, cp->dmamap,
8055                         (bus_dmasync_op_t)(cp->dmamapped == SYM_DMA_READ ? 
8056                                 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE));
8057         }
8058
8059         /*
8060          *  Set host status to busy state.
8061          *  May have been set back to HS_WAIT to avoid a race.
8062          */
8063         cp->host_status = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
8064
8065         /*
8066          *  Set data pointers.
8067          */
8068         sym_setup_data_pointers(np, cp,  (ccb->ccb_h.flags & CAM_DIR_MASK));
8069
8070         /*
8071          *  Enqueue this IO in our pending queue.
8072          */
8073         sym_enqueue_cam_ccb(np, ccb);
8074
8075         /*
8076          *  When `#ifed 1', the code below makes the driver 
8077          *  panic on the first attempt to write to a SCSI device.
8078          *  It is the first test we want to do after a driver 
8079          *  change that does not seem obviously safe. :)
8080          */
8081 #if 0
8082         switch (cp->cdb_buf[0]) {
8083         case 0x0A: case 0x2A: case 0xAA:
8084                 panic("XXXXXXXXXXXXX WRITE NOT YET ALLOWED XXXXXXXXXXXXXX\n");
8085                 MDELAY(10000);
8086                 break;
8087         default:
8088                 break;
8089         }
8090 #endif
8091         /*
8092          *  Activate this job.
8093          */
8094         sym_put_start_queue(np, cp);
8095 out:
8096         splx(s);
8097         return;
8098 out_abort:
8099         sym_free_ccb(np, cp);
8100         sym_xpt_done(np, ccb);
8101         goto out;
8102 }
8103
8104 /*
8105  *  How complex it gets to deal with the data in CAM.
8106  *  The Bus Dma stuff makes things still more complex.
8107  */
8108 static void 
8109 sym_setup_data_and_start(hcb_p np, struct ccb_scsiio *csio, ccb_p cp)
8110 {
8111         struct ccb_hdr *ccb_h;
8112         int dir, retv;
8113         
8114         ccb_h = &csio->ccb_h;
8115
8116         /*
8117          *  Now deal with the data.
8118          */
8119         cp->data_len = csio->dxfer_len;
8120         cp->arg      = np;
8121
8122         /*
8123          *  No direction means no data.
8124          */
8125         dir = (ccb_h->flags & CAM_DIR_MASK);
8126         if (dir == CAM_DIR_NONE) {
8127                 sym_execute_ccb(cp, NULL, 0, 0);
8128                 return;
8129         }
8130
8131         if (!(ccb_h->flags & CAM_SCATTER_VALID)) {
8132                 /* Single buffer */
8133                 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
8134                         /* Buffer is virtual */
8135                         int s;
8136
8137                         cp->dmamapped = (dir == CAM_DIR_IN) ? 
8138                                                 SYM_DMA_READ : SYM_DMA_WRITE;
8139                         s = splsoftvm();
8140                         retv = bus_dmamap_load(np->data_dmat, cp->dmamap,
8141                                                csio->data_ptr, csio->dxfer_len,
8142                                                sym_execute_ccb, cp, 0);
8143                         if (retv == EINPROGRESS) {
8144                                 cp->host_status = HS_WAIT;
8145                                 xpt_freeze_simq(np->sim, 1);
8146                                 csio->ccb_h.status |= CAM_RELEASE_SIMQ;
8147                         }
8148                         splx(s);
8149                 } else {
8150                         /* Buffer is physical */
8151                         struct bus_dma_segment seg;
8152
8153                         seg.ds_addr = (bus_addr_t) csio->data_ptr;
8154                         sym_execute_ccb(cp, &seg, 1, 0);
8155                 }
8156         } else {
8157                 /* Scatter/gather list */
8158                 struct bus_dma_segment *segs;
8159
8160                 if ((ccb_h->flags & CAM_SG_LIST_PHYS) != 0) {
8161                         /* The SG list pointer is physical */
8162                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
8163                         goto out_abort;
8164                 }
8165
8166                 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
8167                         /* SG buffer pointers are virtual */
8168                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
8169                         goto out_abort;
8170                 }
8171
8172                 /* SG buffer pointers are physical */
8173                 segs  = (struct bus_dma_segment *)csio->data_ptr;
8174                 sym_execute_ccb(cp, segs, csio->sglist_cnt, 0);
8175         }
8176         return;
8177 out_abort:
8178         sym_free_ccb(np, cp);
8179         sym_xpt_done(np, (union ccb *) csio);
8180 }
8181
8182 /*
8183  *  Move the scatter list to our data block.
8184  */
8185 static int 
8186 sym_fast_scatter_sg_physical(hcb_p np, ccb_p cp, 
8187                              bus_dma_segment_t *psegs, int nsegs)
8188 {
8189         struct sym_tblmove *data;
8190         bus_dma_segment_t *psegs2;
8191
8192         if (nsegs > SYM_CONF_MAX_SG)
8193                 return -1;
8194
8195         data   = &cp->phys.data[SYM_CONF_MAX_SG-1];
8196         psegs2 = &psegs[nsegs-1];
8197         cp->segments = nsegs;
8198
8199         while (1) {
8200                 data->addr = cpu_to_scr(psegs2->ds_addr);
8201                 data->size = cpu_to_scr(psegs2->ds_len);
8202                 if (DEBUG_FLAGS & DEBUG_SCATTER) {
8203                         printf ("%s scatter: paddr=%lx len=%ld\n",
8204                                 sym_name(np), (long) psegs2->ds_addr,
8205                                 (long) psegs2->ds_len);
8206                 }
8207                 if (psegs2 != psegs) {
8208                         --data;
8209                         --psegs2;
8210                         continue;
8211                 }
8212                 break;
8213         }
8214         return 0;
8215 }
8216
8217 #else   /* FreeBSD_Bus_Dma_Abstraction */
8218
8219 /*
8220  *  How complex it gets to deal with the data in CAM.
8221  *  Variant without the Bus Dma Abstraction option.
8222  */
8223 static void 
8224 sym_setup_data_and_start(hcb_p np, struct ccb_scsiio *csio, ccb_p cp)
8225 {
8226         struct ccb_hdr *ccb_h;
8227         int dir, retv;
8228         
8229         ccb_h = &csio->ccb_h;
8230
8231         /*
8232          *  Now deal with the data.
8233          */
8234         cp->data_len = 0;
8235         cp->segments = 0;
8236
8237         /*
8238          *  No direction means no data.
8239          */
8240         dir = (ccb_h->flags & CAM_DIR_MASK);
8241         if (dir == CAM_DIR_NONE)
8242                 goto end_scatter;
8243
8244         if (!(ccb_h->flags & CAM_SCATTER_VALID)) {
8245                 /* Single buffer */
8246                 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
8247                         /* Buffer is virtual */
8248                         retv = sym_scatter_virtual(np, cp,
8249                                                 (vm_offset_t) csio->data_ptr, 
8250                                                 (vm_size_t) csio->dxfer_len);
8251                 } else {
8252                         /* Buffer is physical */
8253                         retv = sym_scatter_physical(np, cp,
8254                                                 (vm_offset_t) csio->data_ptr, 
8255                                                 (vm_size_t) csio->dxfer_len);
8256                 }
8257         } else {
8258                 /* Scatter/gather list */
8259                 int nsegs;
8260                 struct bus_dma_segment *segs;
8261                 segs  = (struct bus_dma_segment *)csio->data_ptr;
8262                 nsegs = csio->sglist_cnt;
8263
8264                 if ((ccb_h->flags & CAM_SG_LIST_PHYS) != 0) {
8265                         /* The SG list pointer is physical */
8266                         sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
8267                         goto out_abort;
8268                 }
8269                 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
8270                         /* SG buffer pointers are virtual */
8271                         retv = sym_scatter_sg_virtual(np, cp, segs, nsegs); 
8272                 } else {
8273                         /* SG buffer pointers are physical */
8274                         retv = sym_scatter_sg_physical(np, cp, segs, nsegs);
8275                 }
8276         }
8277         if (retv < 0) {
8278                 sym_set_cam_status(cp->cam_ccb, CAM_REQ_TOO_BIG);
8279                 goto out_abort;
8280         }
8281
8282 end_scatter:
8283         /*
8284          *  Set data pointers.
8285          */
8286         sym_setup_data_pointers(np, cp, dir);
8287
8288         /*
8289          *  Enqueue this IO in our pending queue.
8290          */
8291         sym_enqueue_cam_ccb(np, (union ccb *) csio);
8292
8293         /*
8294          *  Activate this job.
8295          */
8296         sym_put_start_queue(np, cp);
8297
8298         /*
8299          *  Command is successfully queued.
8300          */
8301         return;
8302 out_abort:
8303         sym_free_ccb(np, cp);
8304         sym_xpt_done(np, (union ccb *) csio);
8305 }
8306
8307 /*
8308  *  Scatter a virtual buffer into bus addressable chunks.
8309  */
8310 static int
8311 sym_scatter_virtual(hcb_p np, ccb_p cp, vm_offset_t vaddr, vm_size_t len)
8312 {
8313         u_long  pe, pn;
8314         u_long  n, k; 
8315         int s;
8316
8317         cp->data_len += len;
8318
8319         pe = vaddr + len;
8320         n  = len;
8321         s  = SYM_CONF_MAX_SG - 1 - cp->segments;
8322
8323         while (n && s >= 0) {
8324                 pn = (pe - 1) & ~PAGE_MASK;
8325                 k = pe - pn;
8326                 if (k > n) {
8327                         k  = n;
8328                         pn = pe - n;
8329                 }
8330                 if (DEBUG_FLAGS & DEBUG_SCATTER) {
8331                         printf ("%s scatter: va=%lx pa=%lx siz=%ld\n",
8332                                 sym_name(np), pn, (u_long) vtobus(pn), k);
8333                 }
8334                 cp->phys.data[s].addr = cpu_to_scr(vtobus(pn));
8335                 cp->phys.data[s].size = cpu_to_scr(k);
8336                 pe = pn;
8337                 n -= k;
8338                 --s;
8339         }
8340         cp->segments = SYM_CONF_MAX_SG - 1 - s;
8341
8342         return n ? -1 : 0;
8343 }
8344
8345 /*
8346  *  Scatter a SG list with virtual addresses into bus addressable chunks.
8347  */
8348 static int
8349 sym_scatter_sg_virtual(hcb_p np, ccb_p cp, bus_dma_segment_t *psegs, int nsegs)
8350 {
8351         int i, retv = 0;
8352
8353         for (i = nsegs - 1 ;  i >= 0 ; --i) {
8354                 retv = sym_scatter_virtual(np, cp,
8355                                            psegs[i].ds_addr, psegs[i].ds_len);
8356                 if (retv < 0)
8357                         break;
8358         }
8359         return retv;
8360 }
8361
8362 /*
8363  *  Scatter a physical buffer into bus addressable chunks.
8364  */
8365 static int
8366 sym_scatter_physical(hcb_p np, ccb_p cp, vm_offset_t paddr, vm_size_t len)
8367 {
8368         struct bus_dma_segment seg;
8369
8370         seg.ds_addr = paddr;
8371         seg.ds_len  = len;
8372         return sym_scatter_sg_physical(np, cp, &seg, 1);
8373 }
8374
8375 #endif  /* FreeBSD_Bus_Dma_Abstraction */
8376
8377 /*
8378  *  Scatter a SG list with physical addresses into bus addressable chunks.
8379  *  We need to ensure 16MB boundaries not to be crossed during DMA of 
8380  *  each segment, due to some chips being flawed.
8381  */
8382 #define BOUND_MASK ((1UL<<24)-1)
8383 static int
8384 sym_scatter_sg_physical(hcb_p np, ccb_p cp, bus_dma_segment_t *psegs, int nsegs)
8385 {
8386         u_long  ps, pe, pn;
8387         u_long  k; 
8388         int s, t;
8389
8390 #ifndef FreeBSD_Bus_Dma_Abstraction
8391         s  = SYM_CONF_MAX_SG - 1 - cp->segments;
8392 #else
8393         s  = SYM_CONF_MAX_SG - 1;
8394 #endif
8395         t  = nsegs - 1;
8396         ps = psegs[t].ds_addr;
8397         pe = ps + psegs[t].ds_len;
8398
8399         while (s >= 0) {
8400                 pn = (pe - 1) & ~BOUND_MASK;
8401                 if (pn <= ps)
8402                         pn = ps;
8403                 k = pe - pn;
8404                 if (DEBUG_FLAGS & DEBUG_SCATTER) {
8405                         printf ("%s scatter: paddr=%lx len=%ld\n",
8406                                 sym_name(np), pn, k);
8407                 }
8408                 cp->phys.data[s].addr = cpu_to_scr(pn);
8409                 cp->phys.data[s].size = cpu_to_scr(k);
8410 #ifndef FreeBSD_Bus_Dma_Abstraction
8411                 cp->data_len += k;
8412 #endif
8413                 --s;
8414                 if (pn == ps) {
8415                         if (--t < 0)
8416                                 break;
8417                         ps = psegs[t].ds_addr;
8418                         pe = ps + psegs[t].ds_len;
8419                 }
8420                 else
8421                         pe = pn;
8422         }
8423
8424         cp->segments = SYM_CONF_MAX_SG - 1 - s;
8425
8426         return t >= 0 ? -1 : 0;
8427 }
8428 #undef BOUND_MASK
8429
8430 /*
8431  *  SIM action for non performance critical stuff.
8432  */
8433 static void sym_action2(struct cam_sim *sim, union ccb *ccb)
8434 {
8435         hcb_p   np;
8436         tcb_p   tp;
8437         lcb_p   lp;
8438         struct  ccb_hdr  *ccb_h;
8439
8440         /*
8441          *  Retrieve our controller data structure.
8442          */
8443         np = (hcb_p) cam_sim_softc(sim);
8444
8445         ccb_h = &ccb->ccb_h;
8446
8447         switch (ccb_h->func_code) {
8448         case XPT_SET_TRAN_SETTINGS:
8449         {
8450                 struct ccb_trans_settings *cts;
8451
8452                 cts  = &ccb->cts;
8453                 tp = &np->target[ccb_h->target_id];
8454
8455                 /*
8456                  *  Update SPI transport settings in TARGET control block.
8457                  *  Update SCSI device settings in LUN control block.
8458                  */
8459                 lp = sym_lp(np, tp, ccb_h->target_lun);
8460 #ifdef  FreeBSD_New_Tran_Settings
8461                 if (cts->type == CTS_TYPE_CURRENT_SETTINGS) {
8462 #else
8463                 if ((cts->flags & CCB_TRANS_CURRENT_SETTINGS) != 0) {
8464 #endif
8465                         sym_update_trans(np, tp, &tp->tinfo.goal, cts);
8466                         if (lp)
8467                                 sym_update_dflags(np, &lp->current_flags, cts);
8468                 }
8469 #ifdef  FreeBSD_New_Tran_Settings
8470                 if (cts->type == CTS_TYPE_USER_SETTINGS) {
8471 #else
8472                 if ((cts->flags & CCB_TRANS_USER_SETTINGS) != 0) {
8473 #endif
8474                         sym_update_trans(np, tp, &tp->tinfo.user, cts);
8475                         if (lp)
8476                                 sym_update_dflags(np, &lp->user_flags, cts);
8477                 }
8478
8479                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8480                 break;
8481         }
8482         case XPT_GET_TRAN_SETTINGS:
8483         {
8484                 struct ccb_trans_settings *cts;
8485                 struct sym_trans *tip;
8486                 u_char dflags;
8487
8488                 cts = &ccb->cts;
8489                 tp = &np->target[ccb_h->target_id];
8490                 lp = sym_lp(np, tp, ccb_h->target_lun);
8491
8492 #ifdef  FreeBSD_New_Tran_Settings
8493 #define cts__scsi (&cts->proto_specific.scsi)
8494 #define cts__spi  (&cts->xport_specific.spi)
8495                 if (cts->type == CTS_TYPE_CURRENT_SETTINGS) {
8496                         tip = &tp->tinfo.current;
8497                         dflags = lp ? lp->current_flags : 0;
8498                 }
8499                 else {
8500                         tip = &tp->tinfo.user;
8501                         dflags = lp ? lp->user_flags : tp->usrflags;
8502                 }
8503
8504                 cts->protocol  = PROTO_SCSI;
8505                 cts->transport = XPORT_SPI;
8506                 cts->protocol_version  = tip->scsi_version;
8507                 cts->transport_version = tip->spi_version;
8508                 
8509                 cts__spi->sync_period = tip->period;
8510                 cts__spi->sync_offset = tip->offset;
8511                 cts__spi->bus_width   = tip->width;
8512                 cts__spi->ppr_options = tip->options;
8513
8514                 cts__spi->valid = CTS_SPI_VALID_SYNC_RATE
8515                                 | CTS_SPI_VALID_SYNC_OFFSET
8516                                 | CTS_SPI_VALID_BUS_WIDTH
8517                                 | CTS_SPI_VALID_PPR_OPTIONS;
8518  
8519                 cts__spi->flags &= ~CTS_SPI_FLAGS_DISC_ENB;
8520                 if (dflags & SYM_DISC_ENABLED)
8521                         cts__spi->flags |= CTS_SPI_FLAGS_DISC_ENB;
8522                 cts__spi->valid |= CTS_SPI_VALID_DISC;
8523
8524                 cts__scsi->flags &= ~CTS_SCSI_FLAGS_TAG_ENB;
8525                 if (dflags & SYM_TAGS_ENABLED)
8526                         cts__scsi->flags |= CTS_SCSI_FLAGS_TAG_ENB;
8527                 cts__scsi->valid |= CTS_SCSI_VALID_TQ;
8528 #undef  cts__spi
8529 #undef  cts__scsi
8530 #else
8531                 if ((cts->flags & CCB_TRANS_CURRENT_SETTINGS) != 0) {
8532                         tip = &tp->tinfo.current;
8533                         dflags = lp ? lp->current_flags : 0;
8534                 }
8535                 else {
8536                         tip = &tp->tinfo.user;
8537                         dflags = lp ? lp->user_flags : tp->usrflags;
8538                 }
8539                 
8540                 cts->sync_period = tip->period;
8541                 cts->sync_offset = tip->offset;
8542                 cts->bus_width   = tip->width;
8543
8544                 cts->valid = CCB_TRANS_SYNC_RATE_VALID
8545                            | CCB_TRANS_SYNC_OFFSET_VALID
8546                            | CCB_TRANS_BUS_WIDTH_VALID;
8547
8548                 cts->flags &= ~(CCB_TRANS_DISC_ENB|CCB_TRANS_TAG_ENB);
8549
8550                 if (dflags & SYM_DISC_ENABLED)
8551                         cts->flags |= CCB_TRANS_DISC_ENB;
8552
8553                 if (dflags & SYM_TAGS_ENABLED)
8554                         cts->flags |= CCB_TRANS_TAG_ENB;
8555
8556                 cts->valid |= CCB_TRANS_DISC_VALID;
8557                 cts->valid |= CCB_TRANS_TQ_VALID;
8558 #endif
8559                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8560                 break;
8561         }
8562         case XPT_CALC_GEOMETRY:
8563         {
8564                 struct ccb_calc_geometry *ccg;
8565                 u32 size_mb;
8566                 u32 secs_per_cylinder;
8567                 int extended;
8568
8569                 /*
8570                  *  Silly DOS geometry.  
8571                  */
8572                 ccg = &ccb->ccg;
8573                 size_mb = ccg->volume_size
8574                         / ((1024L * 1024L) / ccg->block_size);
8575                 extended = 1;
8576                 
8577                 if (size_mb > 1024 && extended) {
8578                         ccg->heads = 255;
8579                         ccg->secs_per_track = 63;
8580                 } else {
8581                         ccg->heads = 64;
8582                         ccg->secs_per_track = 32;
8583                 }
8584                 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
8585                 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
8586                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8587                 break;
8588         }
8589         case XPT_PATH_INQ:
8590         {
8591                 struct ccb_pathinq *cpi = &ccb->cpi;
8592                 cpi->version_num = 1;
8593                 cpi->hba_inquiry = PI_MDP_ABLE|PI_SDTR_ABLE|PI_TAG_ABLE;
8594                 if ((np->features & FE_WIDE) != 0)
8595                         cpi->hba_inquiry |= PI_WIDE_16;
8596                 cpi->target_sprt = 0;
8597                 cpi->hba_misc = 0;
8598                 if (np->usrflags & SYM_SCAN_TARGETS_HILO)
8599                         cpi->hba_misc |= PIM_SCANHILO;
8600                 if (np->usrflags & SYM_AVOID_BUS_RESET)
8601                         cpi->hba_misc |= PIM_NOBUSRESET;
8602                 cpi->hba_eng_cnt = 0;
8603                 cpi->max_target = (np->features & FE_WIDE) ? 15 : 7;
8604                 /* Semantic problem:)LUN number max = max number of LUNs - 1 */
8605                 cpi->max_lun = SYM_CONF_MAX_LUN-1;
8606                 if (SYM_SETUP_MAX_LUN < SYM_CONF_MAX_LUN)
8607                         cpi->max_lun = SYM_SETUP_MAX_LUN-1;
8608                 cpi->bus_id = cam_sim_bus(sim);
8609                 cpi->initiator_id = np->myaddr;
8610                 cpi->base_transfer_speed = 3300;
8611                 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
8612                 strncpy(cpi->hba_vid, "Symbios", HBA_IDLEN);
8613                 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
8614                 cpi->unit_number = cam_sim_unit(sim);
8615
8616 #ifdef  FreeBSD_New_Tran_Settings
8617                 cpi->protocol = PROTO_SCSI;
8618                 cpi->protocol_version = SCSI_REV_2;
8619                 cpi->transport = XPORT_SPI;
8620                 cpi->transport_version = 2;
8621                 cpi->xport_specific.spi.ppr_options = SID_SPI_CLOCK_ST;
8622                 if (np->features & FE_ULTRA3) {
8623                         cpi->transport_version = 3;
8624                         cpi->xport_specific.spi.ppr_options =
8625                             SID_SPI_CLOCK_DT_ST;
8626                 }
8627 #endif
8628                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8629                 break;
8630         }
8631         case XPT_ABORT:
8632         {
8633                 union ccb *abort_ccb = ccb->cab.abort_ccb;
8634                 switch(abort_ccb->ccb_h.func_code) {
8635                 case XPT_SCSI_IO:
8636                         if (sym_abort_scsiio(np, abort_ccb, 0) == 0) {
8637                                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8638                                 break;
8639                         }
8640                 default:
8641                         sym_xpt_done2(np, ccb, CAM_UA_ABORT);
8642                         break;
8643                 }
8644                 break;
8645         }
8646         case XPT_RESET_DEV:
8647         {
8648                 sym_reset_dev(np, ccb);
8649                 break;
8650         }
8651         case XPT_RESET_BUS:
8652         {
8653                 sym_reset_scsi_bus(np, 0);
8654                 if (sym_verbose) {
8655                         xpt_print_path(np->path);
8656                         printf("SCSI BUS reset delivered.\n");
8657                 }
8658                 sym_init (np, 1);
8659                 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8660                 break;
8661         }
8662         case XPT_ACCEPT_TARGET_IO:
8663         case XPT_CONT_TARGET_IO:
8664         case XPT_EN_LUN:
8665         case XPT_NOTIFY_ACK:
8666         case XPT_IMMED_NOTIFY:
8667         case XPT_TERM_IO:
8668         default:
8669                 sym_xpt_done2(np, ccb, CAM_REQ_INVALID);
8670                 break;
8671         }
8672 }
8673
8674 /*
8675  *  Asynchronous notification handler.
8676  */
8677 static void
8678 sym_async(void *cb_arg, u32 code, struct cam_path *path, void *arg)
8679 {
8680         hcb_p np;
8681         struct cam_sim *sim;
8682         u_int tn;
8683         tcb_p tp;
8684         int s;
8685
8686         s = splcam();
8687
8688         sim = (struct cam_sim *) cb_arg;
8689         np  = (hcb_p) cam_sim_softc(sim);
8690
8691         switch (code) {
8692         case AC_LOST_DEVICE:
8693                 tn = xpt_path_target_id(path);
8694                 if (tn >= SYM_CONF_MAX_TARGET)
8695                         break;
8696
8697                 tp = &np->target[tn];
8698
8699                 tp->to_reset  = 0;
8700                 tp->head.sval = 0;
8701                 tp->head.wval = np->rv_scntl3;
8702                 tp->head.uval = 0;
8703
8704                 tp->tinfo.current.period  = tp->tinfo.goal.period = 0;
8705                 tp->tinfo.current.offset  = tp->tinfo.goal.offset = 0;
8706                 tp->tinfo.current.width   = tp->tinfo.goal.width  = BUS_8_BIT;
8707                 tp->tinfo.current.options = tp->tinfo.goal.options = 0;
8708
8709                 break;
8710         default:
8711                 break;
8712         }
8713
8714         splx(s);
8715 }
8716
8717 /*
8718  *  Update transfer settings of a target.
8719  */
8720 static void sym_update_trans(hcb_p np, tcb_p tp, struct sym_trans *tip,
8721                             struct ccb_trans_settings *cts)
8722 {
8723         /*
8724          *  Update the infos.
8725          */
8726 #ifdef  FreeBSD_New_Tran_Settings
8727 #define cts__spi (&cts->xport_specific.spi)
8728         if ((cts__spi->valid & CTS_SPI_VALID_BUS_WIDTH) != 0)
8729                 tip->width = cts__spi->bus_width;
8730         if ((cts__spi->valid & CTS_SPI_VALID_SYNC_OFFSET) != 0)
8731                 tip->offset = cts__spi->sync_offset;
8732         if ((cts__spi->valid & CTS_SPI_VALID_SYNC_RATE) != 0)
8733                 tip->period = cts__spi->sync_period;
8734         if ((cts__spi->valid & CTS_SPI_VALID_PPR_OPTIONS) != 0)
8735                 tip->options = (cts__spi->ppr_options & PPR_OPT_DT);
8736         if (cts->protocol_version != PROTO_VERSION_UNSPECIFIED &&
8737             cts->protocol_version != PROTO_VERSION_UNKNOWN)
8738                 tip->scsi_version = cts->protocol_version;
8739         if (cts->transport_version != XPORT_VERSION_UNSPECIFIED &&
8740             cts->transport_version != XPORT_VERSION_UNKNOWN)
8741                 tip->spi_version = cts->transport_version;
8742 #undef cts__spi
8743 #else
8744         if ((cts->valid & CCB_TRANS_BUS_WIDTH_VALID) != 0)
8745                 tip->width = cts->bus_width;
8746         if ((cts->valid & CCB_TRANS_SYNC_OFFSET_VALID) != 0)
8747                 tip->offset = cts->sync_offset;
8748         if ((cts->valid & CCB_TRANS_SYNC_RATE_VALID) != 0)
8749                 tip->period = cts->sync_period;
8750 #endif
8751         /*
8752          *  Scale against driver configuration limits.
8753          */
8754         if (tip->width  > SYM_SETUP_MAX_WIDE) tip->width  = SYM_SETUP_MAX_WIDE;
8755         if (tip->offset > SYM_SETUP_MAX_OFFS) tip->offset = SYM_SETUP_MAX_OFFS;
8756         if (tip->period < SYM_SETUP_MIN_SYNC) tip->period = SYM_SETUP_MIN_SYNC;
8757
8758         /*
8759          *  Scale against actual controller BUS width.
8760          */
8761         if (tip->width > np->maxwide)
8762                 tip->width  = np->maxwide;
8763
8764 #ifdef  FreeBSD_New_Tran_Settings
8765         /*
8766          *  Only accept DT if controller supports and SYNC/WIDE asked.
8767          */
8768         if (!((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3)) ||
8769             !(tip->width == BUS_16_BIT && tip->offset)) {
8770                 tip->options &= ~PPR_OPT_DT;
8771         }
8772 #else
8773         /*
8774          *  For now, only assume DT if period <= 9, BUS 16 and offset != 0.
8775          */
8776         tip->options = 0;
8777         if ((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3) &&
8778             tip->period <= 9 && tip->width == BUS_16_BIT && tip->offset) {
8779                 tip->options |= PPR_OPT_DT;
8780         }
8781 #endif
8782
8783         /*
8784          *  Scale period factor and offset against controller limits.
8785          */
8786         if (tip->options & PPR_OPT_DT) {
8787                 if (tip->period < np->minsync_dt)
8788                         tip->period = np->minsync_dt;
8789                 if (tip->period > np->maxsync_dt)
8790                         tip->period = np->maxsync_dt;
8791                 if (tip->offset > np->maxoffs_dt)
8792                         tip->offset = np->maxoffs_dt;
8793         }
8794         else {
8795                 if (tip->period < np->minsync)
8796                         tip->period = np->minsync;
8797                 if (tip->period > np->maxsync)
8798                         tip->period = np->maxsync;
8799                 if (tip->offset > np->maxoffs)
8800                         tip->offset = np->maxoffs;
8801         }
8802 }
8803
8804 /*
8805  *  Update flags for a device (logical unit).
8806  */
8807 static void 
8808 sym_update_dflags(hcb_p np, u_char *flags, struct ccb_trans_settings *cts)
8809 {
8810 #ifdef  FreeBSD_New_Tran_Settings
8811 #define cts__scsi (&cts->proto_specific.scsi)
8812 #define cts__spi  (&cts->xport_specific.spi)
8813         if ((cts__spi->valid & CTS_SPI_VALID_DISC) != 0) {
8814                 if ((cts__spi->flags & CTS_SPI_FLAGS_DISC_ENB) != 0)
8815                         *flags |= SYM_DISC_ENABLED;
8816                 else
8817                         *flags &= ~SYM_DISC_ENABLED;
8818         }
8819
8820         if ((cts__scsi->valid & CTS_SCSI_VALID_TQ) != 0) {
8821                 if ((cts__scsi->flags & CTS_SCSI_FLAGS_TAG_ENB) != 0)
8822                         *flags |= SYM_TAGS_ENABLED;
8823                 else
8824                         *flags &= ~SYM_TAGS_ENABLED;
8825         }
8826 #undef  cts__spi
8827 #undef  cts__scsi
8828 #else
8829         if ((cts->valid & CCB_TRANS_DISC_VALID) != 0) {
8830                 if ((cts->flags & CCB_TRANS_DISC_ENB) != 0)
8831                         *flags |= SYM_DISC_ENABLED;
8832                 else
8833                         *flags &= ~SYM_DISC_ENABLED;
8834         }
8835
8836         if ((cts->valid & CCB_TRANS_TQ_VALID) != 0) {
8837                 if ((cts->flags & CCB_TRANS_TAG_ENB) != 0)
8838                         *flags |= SYM_TAGS_ENABLED;
8839                 else
8840                         *flags &= ~SYM_TAGS_ENABLED;
8841         }
8842 #endif
8843 }
8844
8845
8846 /*============= DRIVER INITIALISATION ==================*/
8847
8848 #ifdef FreeBSD_Bus_Io_Abstraction
8849
8850 static device_method_t sym_pci_methods[] = {
8851         DEVMETHOD(device_probe,  sym_pci_probe),
8852         DEVMETHOD(device_attach, sym_pci_attach),
8853         { 0, 0 }
8854 };
8855
8856 static driver_t sym_pci_driver = {
8857         "sym",
8858         sym_pci_methods,
8859         sizeof(struct sym_hcb)
8860 };
8861
8862 static devclass_t sym_devclass;
8863
8864 DRIVER_MODULE(sym, pci, sym_pci_driver, sym_devclass, 0, 0);
8865
8866 #else   /* Pre-FreeBSD_Bus_Io_Abstraction */
8867
8868 static u_long sym_unit;
8869
8870 static struct   pci_device sym_pci_driver = {
8871         "sym",
8872         sym_pci_probe,
8873         sym_pci_attach,
8874         &sym_unit,
8875         NULL
8876 }; 
8877
8878 #if     __FreeBSD_version >= 400000
8879 COMPAT_PCI_DRIVER (sym, sym_pci_driver);
8880 #else
8881 DATA_SET (pcidevice_set, sym_pci_driver);
8882 #endif
8883
8884 #endif /* FreeBSD_Bus_Io_Abstraction */
8885
8886 static struct sym_pci_chip sym_pci_dev_table[] = {
8887  {PCI_ID_SYM53C810, 0x0f, "810", 4, 8, 4, 64,
8888  FE_ERL}
8889  ,
8890 #ifdef SYM_DEBUG_GENERIC_SUPPORT
8891  {PCI_ID_SYM53C810, 0xff, "810a", 4,  8, 4, 1,
8892  FE_BOF}
8893  ,
8894 #else
8895  {PCI_ID_SYM53C810, 0xff, "810a", 4,  8, 4, 1,
8896  FE_CACHE_SET|FE_LDSTR|FE_PFEN|FE_BOF}
8897  ,
8898 #endif
8899  {PCI_ID_SYM53C815, 0xff, "815", 4,  8, 4, 64,
8900  FE_BOF|FE_ERL}
8901  ,
8902  {PCI_ID_SYM53C825, 0x0f, "825", 6,  8, 4, 64,
8903  FE_WIDE|FE_BOF|FE_ERL|FE_DIFF}
8904  ,
8905  {PCI_ID_SYM53C825, 0xff, "825a", 6,  8, 4, 2,
8906  FE_WIDE|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|FE_RAM|FE_DIFF}
8907  ,
8908  {PCI_ID_SYM53C860, 0xff, "860", 4,  8, 5, 1,
8909  FE_ULTRA|FE_CLK80|FE_CACHE_SET|FE_BOF|FE_LDSTR|FE_PFEN}
8910  ,
8911  {PCI_ID_SYM53C875, 0x01, "875", 6, 16, 5, 2,
8912  FE_WIDE|FE_ULTRA|FE_CLK80|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8913  FE_RAM|FE_DIFF}
8914  ,
8915  {PCI_ID_SYM53C875, 0xff, "875", 6, 16, 5, 2,
8916  FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8917  FE_RAM|FE_DIFF}
8918  ,
8919  {PCI_ID_SYM53C875_2, 0xff, "875", 6, 16, 5, 2,
8920  FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8921  FE_RAM|FE_DIFF}
8922  ,
8923  {PCI_ID_SYM53C885, 0xff, "885", 6, 16, 5, 2,
8924  FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8925  FE_RAM|FE_DIFF}
8926  ,
8927 #ifdef SYM_DEBUG_GENERIC_SUPPORT
8928  {PCI_ID_SYM53C895, 0xff, "895", 6, 31, 7, 2,
8929  FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|
8930  FE_RAM|FE_LCKFRQ}
8931  ,
8932 #else
8933  {PCI_ID_SYM53C895, 0xff, "895", 6, 31, 7, 2,
8934  FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8935  FE_RAM|FE_LCKFRQ}
8936  ,
8937 #endif
8938  {PCI_ID_SYM53C896, 0xff, "896", 6, 31, 7, 4,
8939  FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8940  FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_LCKFRQ}
8941  ,
8942  {PCI_ID_SYM53C895A, 0xff, "895a", 6, 31, 7, 4,
8943  FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8944  FE_RAM|FE_RAM8K|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_LCKFRQ}
8945  ,
8946  {PCI_ID_LSI53C1010, 0x00, "1010-33", 6, 31, 7, 8,
8947  FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8948  FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_CRC|
8949  FE_C10}
8950  ,
8951  {PCI_ID_LSI53C1010, 0xff, "1010-33", 6, 31, 7, 8,
8952  FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8953  FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_CRC|
8954  FE_C10|FE_U3EN}
8955  ,
8956  {PCI_ID_LSI53C1010_2, 0xff, "1010-66", 6, 31, 7, 8,
8957  FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8958  FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_66MHZ|FE_CRC|
8959  FE_C10|FE_U3EN}
8960  ,
8961  {PCI_ID_LSI53C1510D, 0xff, "1510d", 6, 31, 7, 4,
8962  FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8963  FE_RAM|FE_IO256|FE_LEDC}
8964 };
8965
8966 #define sym_pci_num_devs \
8967         (sizeof(sym_pci_dev_table) / sizeof(sym_pci_dev_table[0]))
8968
8969 /*
8970  *  Look up the chip table.
8971  *
8972  *  Return a pointer to the chip entry if found, 
8973  *  zero otherwise.
8974  */
8975 static struct sym_pci_chip *
8976 #ifdef FreeBSD_Bus_Io_Abstraction
8977 sym_find_pci_chip(device_t dev)
8978 #else
8979 sym_find_pci_chip(pcici_t pci_tag)
8980 #endif
8981 {
8982         struct  sym_pci_chip *chip;
8983         int     i;
8984         u_short device_id;
8985         u_char  revision;
8986
8987 #ifdef FreeBSD_Bus_Io_Abstraction
8988         if (pci_get_vendor(dev) != PCI_VENDOR_NCR)
8989                 return 0;
8990
8991         device_id = pci_get_device(dev);
8992         revision  = pci_get_revid(dev);
8993 #else
8994         if (pci_cfgread(pci_tag, PCIR_VENDOR, 2) != PCI_VENDOR_NCR)
8995                 return 0;
8996
8997         device_id = pci_cfgread(pci_tag, PCIR_DEVICE, 2);
8998         revision  = pci_cfgread(pci_tag, PCIR_REVID,  1);
8999 #endif
9000
9001         for (i = 0; i < sym_pci_num_devs; i++) {
9002                 chip = &sym_pci_dev_table[i];
9003                 if (device_id != chip->device_id)
9004                         continue;
9005                 if (revision > chip->revision_id)
9006                         continue;
9007                 return chip;
9008         }
9009
9010         return 0;
9011 }
9012
9013 /*
9014  *  Tell upper layer if the chip is supported.
9015  */
9016 #ifdef FreeBSD_Bus_Io_Abstraction
9017 static int
9018 sym_pci_probe(device_t dev)
9019 {
9020         struct  sym_pci_chip *chip;
9021
9022         chip = sym_find_pci_chip(dev);
9023         if (chip && sym_find_firmware(chip)) {
9024                 device_set_desc(dev, chip->name);
9025                 return (chip->lp_probe_bit & SYM_SETUP_LP_PROBE_MAP)? -2000 : 0;
9026         }
9027         return ENXIO;
9028 }
9029 #else /* Pre-FreeBSD_Bus_Io_Abstraction */
9030 static const char *
9031 sym_pci_probe(pcici_t pci_tag, pcidi_t type)
9032 {
9033         struct  sym_pci_chip *chip;
9034
9035         chip = sym_find_pci_chip(pci_tag);
9036         if (chip && sym_find_firmware(chip)) {
9037 #if NNCR > 0
9038         /* Only claim chips we are allowed to take precedence over the ncr */
9039         if (!(chip->lp_probe_bit & SYM_SETUP_LP_PROBE_MAP))
9040 #else
9041         if (1)
9042 #endif
9043                 return chip->name;
9044         }
9045         return 0;
9046 }
9047 #endif
9048
9049 /*
9050  *  Attach a sym53c8xx device.
9051  */
9052 #ifdef FreeBSD_Bus_Io_Abstraction
9053 static int
9054 sym_pci_attach(device_t dev)
9055 #else
9056 static void
9057 sym_pci_attach(pcici_t pci_tag, int unit)
9058 {
9059         int err = sym_pci_attach2(pci_tag, unit);
9060         if (err)
9061                 printf("sym: failed to attach unit %d - err=%d.\n", unit, err);
9062 }
9063 static int
9064 sym_pci_attach2(pcici_t pci_tag, int unit)
9065 #endif
9066 {
9067         struct  sym_pci_chip *chip;
9068         u_short command;
9069         u_char  cachelnsz;
9070         struct  sym_hcb *np = 0;
9071         struct  sym_nvram nvram;
9072         struct  sym_fw *fw = 0;
9073         int     i;
9074 #ifdef  FreeBSD_Bus_Dma_Abstraction
9075         bus_dma_tag_t   bus_dmat;
9076
9077         /*
9078          *  I expected to be told about a parent 
9079          *  DMA tag, but didn't find any.
9080          */
9081         bus_dmat = NULL;
9082 #endif
9083
9084         /*
9085          *  Only probed devices should be attached.
9086          *  We just enjoy being paranoid. :)
9087          */
9088 #ifdef FreeBSD_Bus_Io_Abstraction
9089         chip = sym_find_pci_chip(dev);
9090 #else
9091         chip = sym_find_pci_chip(pci_tag);
9092 #endif
9093         if (chip == NULL || (fw = sym_find_firmware(chip)) == NULL)
9094                 return (ENXIO);
9095
9096         /*
9097          *  Allocate immediately the host control block, 
9098          *  since we are only expecting to succeed. :)
9099          *  We keep track in the HCB of all the resources that 
9100          *  are to be released on error.
9101          */
9102 #ifdef  FreeBSD_Bus_Dma_Abstraction
9103         np = __sym_calloc_dma(bus_dmat, sizeof(*np), "HCB");
9104         if (np)
9105                 np->bus_dmat = bus_dmat;
9106         else
9107                 goto attach_failed;
9108 #else
9109         np = sym_calloc_dma(sizeof(*np), "HCB");
9110         if (!np)
9111                 goto attach_failed;
9112 #endif
9113
9114         /*
9115          *  Copy some useful infos to the HCB.
9116          */
9117         np->hcb_ba       = vtobus(np);
9118         np->verbose      = bootverbose;
9119 #ifdef FreeBSD_Bus_Io_Abstraction
9120         np->device       = dev;
9121         np->unit         = device_get_unit(dev);
9122         np->device_id    = pci_get_device(dev);
9123         np->revision_id  = pci_get_revid(dev);
9124 #else
9125         np->pci_tag      = pci_tag;
9126         np->unit         = unit;
9127         np->device_id    = pci_cfgread(pci_tag, PCIR_DEVICE, 2);
9128         np->revision_id  = pci_cfgread(pci_tag, PCIR_REVID,  1);
9129 #endif
9130         np->features     = chip->features;
9131         np->clock_divn   = chip->nr_divisor;
9132         np->maxoffs      = chip->offset_max;
9133         np->maxburst     = chip->burst_max;
9134         np->scripta_sz   = fw->a_size;
9135         np->scriptb_sz   = fw->b_size;
9136         np->fw_setup     = fw->setup;
9137         np->fw_patch     = fw->patch;
9138         np->fw_name      = fw->name;
9139
9140         /*
9141          * Edit its name.
9142          */
9143         snprintf(np->inst_name, sizeof(np->inst_name), "sym%d", np->unit);
9144
9145         /*
9146          *  Initialyze the CCB free and busy queues.
9147          */
9148         sym_que_init(&np->free_ccbq);
9149         sym_que_init(&np->busy_ccbq);
9150         sym_que_init(&np->comp_ccbq);
9151         sym_que_init(&np->cam_ccbq);
9152
9153         /*
9154          *  Allocate a tag for the DMA of user data.
9155          */
9156 #ifdef  FreeBSD_Bus_Dma_Abstraction
9157         if (bus_dma_tag_create(np->bus_dmat, 1, (1<<24),
9158                                 BUS_SPACE_MAXADDR, BUS_SPACE_MAXADDR,
9159                                 NULL, NULL,
9160                                 BUS_SPACE_MAXSIZE, SYM_CONF_MAX_SG,
9161                                 (1<<24), 0, &np->data_dmat)) {
9162                 device_printf(dev, "failed to create DMA tag.\n");
9163                 goto attach_failed;
9164         }
9165 #endif
9166         /*
9167          *  Read and apply some fix-ups to the PCI COMMAND 
9168          *  register. We want the chip to be enabled for:
9169          *  - BUS mastering
9170          *  - PCI parity checking (reporting would also be fine)
9171          *  - Write And Invalidate.
9172          */
9173 #ifdef FreeBSD_Bus_Io_Abstraction
9174         command = pci_read_config(dev, PCIR_COMMAND, 2);
9175 #else
9176         command = pci_cfgread(pci_tag, PCIR_COMMAND, 2);
9177 #endif
9178         command |= PCIM_CMD_BUSMASTEREN;
9179         command |= PCIM_CMD_PERRESPEN;
9180         command |= /* PCIM_CMD_MWIEN */ 0x0010;
9181 #ifdef FreeBSD_Bus_Io_Abstraction
9182         pci_write_config(dev, PCIR_COMMAND, command, 2);
9183 #else
9184         pci_cfgwrite(pci_tag, PCIR_COMMAND, command, 2);
9185 #endif
9186
9187         /*
9188          *  Let the device know about the cache line size, 
9189          *  if it doesn't yet.
9190          */
9191 #ifdef FreeBSD_Bus_Io_Abstraction
9192         cachelnsz = pci_read_config(dev, PCIR_CACHELNSZ, 1);
9193 #else
9194         cachelnsz = pci_cfgread(pci_tag, PCIR_CACHELNSZ, 1);
9195 #endif
9196         if (!cachelnsz) {
9197                 cachelnsz = 8;
9198 #ifdef FreeBSD_Bus_Io_Abstraction
9199                 pci_write_config(dev, PCIR_CACHELNSZ, cachelnsz, 1);
9200 #else
9201                 pci_cfgwrite(pci_tag, PCIR_CACHELNSZ, cachelnsz, 1);
9202 #endif
9203         }
9204
9205         /*
9206          *  Alloc/get/map/retrieve everything that deals with MMIO.
9207          */
9208 #ifdef FreeBSD_Bus_Io_Abstraction
9209         if ((command & PCIM_CMD_MEMEN) != 0) {
9210                 int regs_id = SYM_PCI_MMIO;
9211                 np->mmio_res = bus_alloc_resource(dev, SYS_RES_MEMORY, &regs_id,
9212                                                   0, ~0, 1, RF_ACTIVE);
9213         }
9214         if (!np->mmio_res) {
9215                 device_printf(dev, "failed to allocate MMIO resources\n");
9216                 goto attach_failed;
9217         }
9218         np->mmio_bsh = rman_get_bushandle(np->mmio_res);
9219         np->mmio_tag = rman_get_bustag(np->mmio_res);
9220         np->mmio_pa  = rman_get_start(np->mmio_res);
9221         np->mmio_va  = (vm_offset_t) rman_get_virtual(np->mmio_res);
9222         np->mmio_ba  = np->mmio_pa;
9223 #else
9224         if ((command & PCIM_CMD_MEMEN) != 0) {
9225                 vm_offset_t vaddr, paddr;
9226                 if (!pci_map_mem(pci_tag, SYM_PCI_MMIO, &vaddr, &paddr)) {
9227                         printf("%s: failed to map MMIO window\n", sym_name(np));
9228                         goto attach_failed;
9229                 }
9230                 np->mmio_va = vaddr;
9231                 np->mmio_pa = paddr;
9232                 np->mmio_ba = paddr;
9233         }
9234 #endif
9235
9236         /*
9237          *  Allocate the IRQ.
9238          */
9239 #ifdef FreeBSD_Bus_Io_Abstraction
9240         i = 0;
9241         np->irq_res = bus_alloc_resource(dev, SYS_RES_IRQ, &i,
9242                                          0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
9243         if (!np->irq_res) {
9244                 device_printf(dev, "failed to allocate IRQ resource\n");
9245                 goto attach_failed;
9246         }
9247 #endif
9248
9249 #ifdef  SYM_CONF_IOMAPPED
9250         /*
9251          *  User want us to use normal IO with PCI.
9252          *  Alloc/get/map/retrieve everything that deals with IO.
9253          */
9254 #ifdef FreeBSD_Bus_Io_Abstraction
9255         if ((command & PCI_COMMAND_IO_ENABLE) != 0) {
9256                 int regs_id = SYM_PCI_IO;
9257                 np->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &regs_id,
9258                                                 0, ~0, 1, RF_ACTIVE);
9259         }
9260         if (!np->io_res) {
9261                 device_printf(dev, "failed to allocate IO resources\n");
9262                 goto attach_failed;
9263         }
9264         np->io_bsh  = rman_get_bushandle(np->io_res);
9265         np->io_tag  = rman_get_bustag(np->io_res);
9266         np->io_port = rman_get_start(np->io_res);
9267 #else
9268         if ((command & PCI_COMMAND_IO_ENABLE) != 0) {
9269                 pci_port_t io_port;
9270                 if (!pci_map_port (pci_tag, SYM_PCI_IO, &io_port)) {
9271                         printf("%s: failed to map IO window\n", sym_name(np));
9272                         goto attach_failed;
9273                 }
9274                 np->io_port = io_port;
9275         }
9276 #endif
9277
9278 #endif /* SYM_CONF_IOMAPPED */
9279
9280         /*
9281          *  If the chip has RAM.
9282          *  Alloc/get/map/retrieve the corresponding resources.
9283          */
9284         if ((np->features & (FE_RAM|FE_RAM8K)) &&
9285             (command & PCIM_CMD_MEMEN) != 0) {
9286 #ifdef FreeBSD_Bus_Io_Abstraction
9287                 int regs_id = SYM_PCI_RAM;
9288                 if (np->features & FE_64BIT)
9289                         regs_id = SYM_PCI_RAM64;
9290                 np->ram_res = bus_alloc_resource(dev, SYS_RES_MEMORY, &regs_id,
9291                                                  0, ~0, 1, RF_ACTIVE);
9292                 if (!np->ram_res) {
9293                         device_printf(dev,"failed to allocate RAM resources\n");
9294                         goto attach_failed;
9295                 }
9296                 np->ram_id  = regs_id;
9297                 np->ram_bsh = rman_get_bushandle(np->ram_res);
9298                 np->ram_tag = rman_get_bustag(np->ram_res);
9299                 np->ram_pa  = rman_get_start(np->ram_res);
9300                 np->ram_va  = (vm_offset_t) rman_get_virtual(np->ram_res);
9301                 np->ram_ba  = np->ram_pa;
9302 #else
9303                 vm_offset_t vaddr, paddr;
9304                 int regs_id = SYM_PCI_RAM;
9305                 if (np->features & FE_64BIT)
9306                         regs_id = SYM_PCI_RAM64;
9307                 if (!pci_map_mem(pci_tag, regs_id, &vaddr, &paddr)) {
9308                         printf("%s: failed to map RAM window\n", sym_name(np));
9309                         goto attach_failed;
9310                 }
9311                 np->ram_va = vaddr;
9312                 np->ram_pa = paddr;
9313                 np->ram_ba = paddr;
9314 #endif
9315         }
9316
9317         /*
9318          *  Save setting of some IO registers, so we will 
9319          *  be able to probe specific implementations.
9320          */
9321         sym_save_initial_setting (np);
9322
9323         /*
9324          *  Reset the chip now, since it has been reported 
9325          *  that SCSI clock calibration may not work properly 
9326          *  if the chip is currently active.
9327          */
9328         sym_chip_reset (np);
9329
9330         /*
9331          *  Try to read the user set-up.
9332          */
9333         (void) sym_read_nvram(np, &nvram);
9334
9335         /*
9336          *  Prepare controller and devices settings, according 
9337          *  to chip features, user set-up and driver set-up.
9338          */
9339         (void) sym_prepare_setting(np, &nvram);
9340
9341         /*
9342          *  Check the PCI clock frequency.
9343          *  Must be performed after prepare_setting since it destroys 
9344          *  STEST1 that is used to probe for the clock doubler.
9345          */
9346         i = sym_getpciclock(np);
9347         if (i > 37000)
9348 #ifdef FreeBSD_Bus_Io_Abstraction
9349                 device_printf(dev, "PCI BUS clock seems too high: %u KHz.\n",i);
9350 #else
9351                 printf("%s: PCI BUS clock seems too high: %u KHz.\n",
9352                         sym_name(np), i);
9353 #endif
9354
9355         /*
9356          *  Allocate the start queue.
9357          */
9358         np->squeue = (u32 *) sym_calloc_dma(sizeof(u32)*(MAX_QUEUE*2),"SQUEUE");
9359         if (!np->squeue)
9360                 goto attach_failed;
9361         np->squeue_ba = vtobus(np->squeue);
9362
9363         /*
9364          *  Allocate the done queue.
9365          */
9366         np->dqueue = (u32 *) sym_calloc_dma(sizeof(u32)*(MAX_QUEUE*2),"DQUEUE");
9367         if (!np->dqueue)
9368                 goto attach_failed;
9369         np->dqueue_ba = vtobus(np->dqueue);
9370
9371         /*
9372          *  Allocate the target bus address array.
9373          */
9374         np->targtbl = (u32 *) sym_calloc_dma(256, "TARGTBL");
9375         if (!np->targtbl)
9376                 goto attach_failed;
9377         np->targtbl_ba = vtobus(np->targtbl);
9378
9379         /*
9380          *  Allocate SCRIPTS areas.
9381          */
9382         np->scripta0 = sym_calloc_dma(np->scripta_sz, "SCRIPTA0");
9383         np->scriptb0 = sym_calloc_dma(np->scriptb_sz, "SCRIPTB0");
9384         if (!np->scripta0 || !np->scriptb0)
9385                 goto attach_failed;
9386
9387         /*
9388          *  Allocate some CCB. We need at least ONE.
9389          */
9390         if (!sym_alloc_ccb(np))
9391                 goto attach_failed;
9392
9393         /*
9394          *  Calculate BUS addresses where we are going 
9395          *  to load the SCRIPTS.
9396          */
9397         np->scripta_ba  = vtobus(np->scripta0);
9398         np->scriptb_ba  = vtobus(np->scriptb0);
9399         np->scriptb0_ba = np->scriptb_ba;
9400
9401         if (np->ram_ba) {
9402                 np->scripta_ba  = np->ram_ba;
9403                 if (np->features & FE_RAM8K) {
9404                         np->ram_ws = 8192;
9405                         np->scriptb_ba = np->scripta_ba + 4096;
9406 #if BITS_PER_LONG > 32
9407                         np->scr_ram_seg = cpu_to_scr(np->scripta_ba >> 32);
9408 #endif
9409                 }
9410                 else
9411                         np->ram_ws = 4096;
9412         }
9413
9414         /*
9415          *  Copy scripts to controller instance.
9416          */
9417         bcopy(fw->a_base, np->scripta0, np->scripta_sz);
9418         bcopy(fw->b_base, np->scriptb0, np->scriptb_sz);
9419
9420         /*
9421          *  Setup variable parts in scripts and compute
9422          *  scripts bus addresses used from the C code.
9423          */
9424         np->fw_setup(np, fw);
9425
9426         /*
9427          *  Bind SCRIPTS with physical addresses usable by the 
9428          *  SCRIPTS processor (as seen from the BUS = BUS addresses).
9429          */
9430         sym_fw_bind_script(np, (u32 *) np->scripta0, np->scripta_sz);
9431         sym_fw_bind_script(np, (u32 *) np->scriptb0, np->scriptb_sz);
9432
9433 #ifdef SYM_CONF_IARB_SUPPORT
9434         /*
9435          *    If user wants IARB to be set when we win arbitration 
9436          *    and have other jobs, compute the max number of consecutive 
9437          *    settings of IARB hints before we leave devices a chance to 
9438          *    arbitrate for reselection.
9439          */
9440 #ifdef  SYM_SETUP_IARB_MAX
9441         np->iarb_max = SYM_SETUP_IARB_MAX;
9442 #else
9443         np->iarb_max = 4;
9444 #endif
9445 #endif
9446
9447         /*
9448          *  Prepare the idle and invalid task actions.
9449          */
9450         np->idletask.start      = cpu_to_scr(SCRIPTA_BA (np, idle));
9451         np->idletask.restart    = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
9452         np->idletask_ba         = vtobus(&np->idletask);
9453
9454         np->notask.start        = cpu_to_scr(SCRIPTA_BA (np, idle));
9455         np->notask.restart      = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
9456         np->notask_ba           = vtobus(&np->notask);
9457
9458         np->bad_itl.start       = cpu_to_scr(SCRIPTA_BA (np, idle));
9459         np->bad_itl.restart     = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
9460         np->bad_itl_ba          = vtobus(&np->bad_itl);
9461
9462         np->bad_itlq.start      = cpu_to_scr(SCRIPTA_BA (np, idle));
9463         np->bad_itlq.restart    = cpu_to_scr(SCRIPTB_BA (np,bad_i_t_l_q));
9464         np->bad_itlq_ba         = vtobus(&np->bad_itlq);
9465
9466         /*
9467          *  Allocate and prepare the lun JUMP table that is used 
9468          *  for a target prior the probing of devices (bad lun table).
9469          *  A private table will be allocated for the target on the 
9470          *  first INQUIRY response received.
9471          */
9472         np->badluntbl = sym_calloc_dma(256, "BADLUNTBL");
9473         if (!np->badluntbl)
9474                 goto attach_failed;
9475
9476         np->badlun_sa = cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
9477         for (i = 0 ; i < 64 ; i++)      /* 64 luns/target, no less */
9478                 np->badluntbl[i] = cpu_to_scr(vtobus(&np->badlun_sa));
9479
9480         /*
9481          *  Prepare the bus address array that contains the bus 
9482          *  address of each target control block.
9483          *  For now, assume all logical units are wrong. :)
9484          */
9485         for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
9486                 np->targtbl[i] = cpu_to_scr(vtobus(&np->target[i]));
9487                 np->target[i].head.luntbl_sa =
9488                                 cpu_to_scr(vtobus(np->badluntbl));
9489                 np->target[i].head.lun0_sa =
9490                                 cpu_to_scr(vtobus(&np->badlun_sa));
9491         }
9492
9493         /*
9494          *  Now check the cache handling of the pci chipset.
9495          */
9496         if (sym_snooptest (np)) {
9497 #ifdef FreeBSD_Bus_Io_Abstraction
9498                 device_printf(dev, "CACHE INCORRECTLY CONFIGURED.\n");
9499 #else
9500                 printf("%s: CACHE INCORRECTLY CONFIGURED.\n", sym_name(np));
9501 #endif
9502                 goto attach_failed;
9503         };
9504
9505         /*
9506          *  Now deal with CAM.
9507          *  Hopefully, we will succeed with that one.:)
9508          */
9509         if (!sym_cam_attach(np))
9510                 goto attach_failed;
9511
9512         /*
9513          *  Sigh! we are done.
9514          */
9515         return 0;
9516
9517         /*
9518          *  We have failed.
9519          *  We will try to free all the resources we have 
9520          *  allocated, but if we are a boot device, this 
9521          *  will not help that much.;)
9522          */
9523 attach_failed:
9524         if (np)
9525                 sym_pci_free(np);
9526         return ENXIO;
9527 }
9528
9529 /*
9530  *  Free everything that have been allocated for this device.
9531  */
9532 static void sym_pci_free(hcb_p np)
9533 {
9534         SYM_QUEHEAD *qp;
9535         ccb_p cp;
9536         tcb_p tp;
9537         lcb_p lp;
9538         int target, lun;
9539         int s;
9540
9541         /*
9542          *  First free CAM resources.
9543          */
9544         s = splcam();
9545         sym_cam_free(np);
9546         splx(s);
9547
9548         /*
9549          *  Now every should be quiet for us to 
9550          *  free other resources.
9551          */
9552 #ifdef FreeBSD_Bus_Io_Abstraction
9553         if (np->ram_res)
9554                 bus_release_resource(np->device, SYS_RES_MEMORY, 
9555                                      np->ram_id, np->ram_res);
9556         if (np->mmio_res)
9557                 bus_release_resource(np->device, SYS_RES_MEMORY, 
9558                                      SYM_PCI_MMIO, np->mmio_res);
9559         if (np->io_res)
9560                 bus_release_resource(np->device, SYS_RES_IOPORT, 
9561                                      SYM_PCI_IO, np->io_res);
9562         if (np->irq_res)
9563                 bus_release_resource(np->device, SYS_RES_IRQ, 
9564                                      0, np->irq_res);
9565 #else
9566         /*
9567          *  YEAH!!!
9568          *  It seems there is no means to free MMIO resources.
9569          */
9570 #endif
9571
9572         if (np->scriptb0)
9573                 sym_mfree_dma(np->scriptb0, np->scriptb_sz, "SCRIPTB0");
9574         if (np->scripta0)
9575                 sym_mfree_dma(np->scripta0, np->scripta_sz, "SCRIPTA0");
9576         if (np->squeue)
9577                 sym_mfree_dma(np->squeue, sizeof(u32)*(MAX_QUEUE*2), "SQUEUE");
9578         if (np->dqueue)
9579                 sym_mfree_dma(np->dqueue, sizeof(u32)*(MAX_QUEUE*2), "DQUEUE");
9580
9581         while ((qp = sym_remque_head(&np->free_ccbq)) != 0) {
9582                 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
9583 #ifdef  FreeBSD_Bus_Dma_Abstraction
9584                 bus_dmamap_destroy(np->data_dmat, cp->dmamap);
9585 #endif
9586                 sym_mfree_dma(cp->sns_bbuf, SYM_SNS_BBUF_LEN, "SNS_BBUF");
9587                 sym_mfree_dma(cp, sizeof(*cp), "CCB");
9588         }
9589
9590         if (np->badluntbl)
9591                 sym_mfree_dma(np->badluntbl, 256,"BADLUNTBL");
9592
9593         for (target = 0; target < SYM_CONF_MAX_TARGET ; target++) {
9594                 tp = &np->target[target];
9595                 for (lun = 0 ; lun < SYM_CONF_MAX_LUN ; lun++) {
9596                         lp = sym_lp(np, tp, lun);
9597                         if (!lp)
9598                                 continue;
9599                         if (lp->itlq_tbl)
9600                                 sym_mfree_dma(lp->itlq_tbl, SYM_CONF_MAX_TASK*4,
9601                                        "ITLQ_TBL");
9602                         if (lp->cb_tags)
9603                                 sym_mfree(lp->cb_tags, SYM_CONF_MAX_TASK,
9604                                        "CB_TAGS");
9605                         sym_mfree_dma(lp, sizeof(*lp), "LCB");
9606                 }
9607 #if SYM_CONF_MAX_LUN > 1
9608                 if (tp->lunmp)
9609                         sym_mfree(tp->lunmp, SYM_CONF_MAX_LUN*sizeof(lcb_p),
9610                                "LUNMP");
9611 #endif 
9612         }
9613         if (np->targtbl)
9614                 sym_mfree_dma(np->targtbl, 256, "TARGTBL");
9615 #ifdef  FreeBSD_Bus_Dma_Abstraction
9616         if (np->data_dmat)
9617                 bus_dma_tag_destroy(np->data_dmat);
9618 #endif
9619         sym_mfree_dma(np, sizeof(*np), "HCB");
9620 }
9621
9622 /*
9623  *  Allocate CAM resources and register a bus to CAM.
9624  */
9625 int sym_cam_attach(hcb_p np)
9626 {
9627         struct cam_devq *devq = 0;
9628         struct cam_sim *sim = 0;
9629         struct cam_path *path = 0;
9630         struct ccb_setasync csa;
9631         int err, s;
9632
9633         s = splcam();
9634
9635         /*
9636          *  Establish our interrupt handler.
9637          */
9638 #ifdef FreeBSD_Bus_Io_Abstraction
9639         err = bus_setup_intr(np->device, np->irq_res, INTR_TYPE_CAM,
9640                              sym_intr, np, &np->intr);
9641         if (err) {
9642                 device_printf(np->device, "bus_setup_intr() failed: %d\n",
9643                               err);
9644                 goto fail;
9645         }
9646 #else
9647         err = 0;
9648         if (!pci_map_int (np->pci_tag, sym_intr, np, &cam_imask)) {
9649                 printf("%s: failed to map interrupt\n", sym_name(np));
9650                 goto fail;
9651         }
9652 #endif
9653
9654         /*
9655          *  Create the device queue for our sym SIM.
9656          */
9657         devq = cam_simq_alloc(SYM_CONF_MAX_START);
9658         if (!devq)
9659                 goto fail;
9660
9661         /*
9662          *  Construct our SIM entry.
9663          */
9664         sim = cam_sim_alloc(sym_action, sym_poll, "sym", np, np->unit,
9665                             1, SYM_SETUP_MAX_TAG, devq);
9666         if (!sim)
9667                 goto fail;
9668         devq = 0;
9669
9670         if (xpt_bus_register(sim, 0) != CAM_SUCCESS)
9671                 goto fail;
9672         np->sim = sim;
9673         sim = 0;
9674
9675         if (xpt_create_path(&path, 0,
9676                             cam_sim_path(np->sim), CAM_TARGET_WILDCARD,
9677                             CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
9678                 goto fail;
9679         }
9680         np->path = path;
9681
9682         /*
9683          *  Hmmm... This should be useful, but I donnot want to 
9684          *  know about.
9685          */
9686 #if     __FreeBSD_version < 400000
9687 #ifdef  __alpha__
9688 #ifdef  FreeBSD_Bus_Io_Abstraction
9689         alpha_register_pci_scsi(pci_get_bus(np->device),
9690                                 pci_get_slot(np->device), np->sim);
9691 #else
9692         alpha_register_pci_scsi(pci_tag->bus, pci_tag->slot, np->sim);
9693 #endif
9694 #endif
9695 #endif
9696
9697         /*
9698          *  Establish our async notification handler.
9699          */
9700         xpt_setup_ccb(&csa.ccb_h, np->path, 5);
9701         csa.ccb_h.func_code = XPT_SASYNC_CB;
9702         csa.event_enable    = AC_LOST_DEVICE;
9703         csa.callback        = sym_async;
9704         csa.callback_arg    = np->sim;
9705         xpt_action((union ccb *)&csa);
9706
9707         /*
9708          *  Start the chip now, without resetting the BUS, since  
9709          *  it seems that this must stay under control of CAM.
9710          *  With LVD/SE capable chips and BUS in SE mode, we may 
9711          *  get a spurious SMBC interrupt.
9712          */
9713         sym_init (np, 0);
9714
9715         splx(s);
9716         return 1;
9717 fail:
9718         if (sim)
9719                 cam_sim_free(sim, FALSE);
9720         if (devq)
9721                 cam_simq_free(devq);
9722
9723         sym_cam_free(np);
9724
9725         splx(s);
9726         return 0;
9727 }
9728
9729 /*
9730  *  Free everything that deals with CAM.
9731  */
9732 void sym_cam_free(hcb_p np)
9733 {
9734 #ifdef FreeBSD_Bus_Io_Abstraction
9735         if (np->intr)
9736                 bus_teardown_intr(np->device, np->irq_res, np->intr);
9737 #else
9738         /* pci_unmap_int(np->pci_tag); */       /* Does nothing */
9739 #endif
9740         
9741         if (np->sim) {
9742                 xpt_bus_deregister(cam_sim_path(np->sim));
9743                 cam_sim_free(np->sim, /*free_devq*/ TRUE);
9744         }
9745         if (np->path)
9746                 xpt_free_path(np->path);
9747 }
9748
9749 /*============ OPTIONNAL NVRAM SUPPORT =================*/
9750
9751 /*
9752  *  Get host setup from NVRAM.
9753  */
9754 static void sym_nvram_setup_host (hcb_p np, struct sym_nvram *nvram)
9755 {
9756 #ifdef SYM_CONF_NVRAM_SUPPORT
9757         /*
9758          *  Get parity checking, host ID, verbose mode 
9759          *  and miscellaneous host flags from NVRAM.
9760          */
9761         switch(nvram->type) {
9762         case SYM_SYMBIOS_NVRAM:
9763                 if (!(nvram->data.Symbios.flags & SYMBIOS_PARITY_ENABLE))
9764                         np->rv_scntl0  &= ~0x0a;
9765                 np->myaddr = nvram->data.Symbios.host_id & 0x0f;
9766                 if (nvram->data.Symbios.flags & SYMBIOS_VERBOSE_MSGS)
9767                         np->verbose += 1;
9768                 if (nvram->data.Symbios.flags1 & SYMBIOS_SCAN_HI_LO)
9769                         np->usrflags |= SYM_SCAN_TARGETS_HILO;
9770                 if (nvram->data.Symbios.flags2 & SYMBIOS_AVOID_BUS_RESET)
9771                         np->usrflags |= SYM_AVOID_BUS_RESET;
9772                 break;
9773         case SYM_TEKRAM_NVRAM:
9774                 np->myaddr = nvram->data.Tekram.host_id & 0x0f;
9775                 break;
9776         default:
9777                 break;
9778         }
9779 #endif
9780 }
9781
9782 /*
9783  *  Get target setup from NVRAM.
9784  */
9785 #ifdef SYM_CONF_NVRAM_SUPPORT
9786 static void sym_Symbios_setup_target(hcb_p np,int target, Symbios_nvram *nvram);
9787 static void sym_Tekram_setup_target(hcb_p np,int target, Tekram_nvram *nvram);
9788 #endif
9789
9790 static void
9791 sym_nvram_setup_target (hcb_p np, int target, struct sym_nvram *nvp)
9792 {
9793 #ifdef SYM_CONF_NVRAM_SUPPORT
9794         switch(nvp->type) {
9795         case SYM_SYMBIOS_NVRAM:
9796                 sym_Symbios_setup_target (np, target, &nvp->data.Symbios);
9797                 break;
9798         case SYM_TEKRAM_NVRAM:
9799                 sym_Tekram_setup_target (np, target, &nvp->data.Tekram);
9800                 break;
9801         default:
9802                 break;
9803         }
9804 #endif
9805 }
9806
9807 #ifdef SYM_CONF_NVRAM_SUPPORT
9808 /*
9809  *  Get target set-up from Symbios format NVRAM.
9810  */
9811 static void
9812 sym_Symbios_setup_target(hcb_p np, int target, Symbios_nvram *nvram)
9813 {
9814         tcb_p tp = &np->target[target];
9815         Symbios_target *tn = &nvram->target[target];
9816
9817         tp->tinfo.user.period = tn->sync_period ? (tn->sync_period + 3) / 4 : 0;
9818         tp->tinfo.user.width  = tn->bus_width == 0x10 ? BUS_16_BIT : BUS_8_BIT;
9819         tp->usrtags =
9820                 (tn->flags & SYMBIOS_QUEUE_TAGS_ENABLED)? SYM_SETUP_MAX_TAG : 0;
9821
9822         if (!(tn->flags & SYMBIOS_DISCONNECT_ENABLE))
9823                 tp->usrflags &= ~SYM_DISC_ENABLED;
9824         if (!(tn->flags & SYMBIOS_SCAN_AT_BOOT_TIME))
9825                 tp->usrflags |= SYM_SCAN_BOOT_DISABLED;
9826         if (!(tn->flags & SYMBIOS_SCAN_LUNS))
9827                 tp->usrflags |= SYM_SCAN_LUNS_DISABLED;
9828 }
9829
9830 /*
9831  *  Get target set-up from Tekram format NVRAM.
9832  */
9833 static void
9834 sym_Tekram_setup_target(hcb_p np, int target, Tekram_nvram *nvram)
9835 {
9836         tcb_p tp = &np->target[target];
9837         struct Tekram_target *tn = &nvram->target[target];
9838         int i;
9839
9840         if (tn->flags & TEKRAM_SYNC_NEGO) {
9841                 i = tn->sync_index & 0xf;
9842                 tp->tinfo.user.period = Tekram_sync[i];
9843         }
9844
9845         tp->tinfo.user.width =
9846                 (tn->flags & TEKRAM_WIDE_NEGO) ? BUS_16_BIT : BUS_8_BIT;
9847
9848         if (tn->flags & TEKRAM_TAGGED_COMMANDS) {
9849                 tp->usrtags = 2 << nvram->max_tags_index;
9850         }
9851
9852         if (tn->flags & TEKRAM_DISCONNECT_ENABLE)
9853                 tp->usrflags |= SYM_DISC_ENABLED;
9854  
9855         /* If any device does not support parity, we will not use this option */
9856         if (!(tn->flags & TEKRAM_PARITY_CHECK))
9857                 np->rv_scntl0  &= ~0x0a; /* SCSI parity checking disabled */
9858 }
9859
9860 #ifdef  SYM_CONF_DEBUG_NVRAM
9861 /*
9862  *  Dump Symbios format NVRAM for debugging purpose.
9863  */
9864 static void sym_display_Symbios_nvram(hcb_p np, Symbios_nvram *nvram)
9865 {
9866         int i;
9867
9868         /* display Symbios nvram host data */
9869         printf("%s: HOST ID=%d%s%s%s%s%s%s\n",
9870                 sym_name(np), nvram->host_id & 0x0f,
9871                 (nvram->flags  & SYMBIOS_SCAM_ENABLE)   ? " SCAM"       :"",
9872                 (nvram->flags  & SYMBIOS_PARITY_ENABLE) ? " PARITY"     :"",
9873                 (nvram->flags  & SYMBIOS_VERBOSE_MSGS)  ? " VERBOSE"    :"", 
9874                 (nvram->flags  & SYMBIOS_CHS_MAPPING)   ? " CHS_ALT"    :"", 
9875                 (nvram->flags2 & SYMBIOS_AVOID_BUS_RESET)?" NO_RESET"   :"",
9876                 (nvram->flags1 & SYMBIOS_SCAN_HI_LO)    ? " HI_LO"      :"");
9877
9878         /* display Symbios nvram drive data */
9879         for (i = 0 ; i < 15 ; i++) {
9880                 struct Symbios_target *tn = &nvram->target[i];
9881                 printf("%s-%d:%s%s%s%s WIDTH=%d SYNC=%d TMO=%d\n",
9882                 sym_name(np), i,
9883                 (tn->flags & SYMBIOS_DISCONNECT_ENABLE) ? " DISC"       : "",
9884                 (tn->flags & SYMBIOS_SCAN_AT_BOOT_TIME) ? " SCAN_BOOT"  : "",
9885                 (tn->flags & SYMBIOS_SCAN_LUNS)         ? " SCAN_LUNS"  : "",
9886                 (tn->flags & SYMBIOS_QUEUE_TAGS_ENABLED)? " TCQ"        : "",
9887                 tn->bus_width,
9888                 tn->sync_period / 4,
9889                 tn->timeout);
9890         }
9891 }
9892
9893 /*
9894  *  Dump TEKRAM format NVRAM for debugging purpose.
9895  */
9896 static u_char Tekram_boot_delay[7] = {3, 5, 10, 20, 30, 60, 120};
9897 static void sym_display_Tekram_nvram(hcb_p np, Tekram_nvram *nvram)
9898 {
9899         int i, tags, boot_delay;
9900         char *rem;
9901
9902         /* display Tekram nvram host data */
9903         tags = 2 << nvram->max_tags_index;
9904         boot_delay = 0;
9905         if (nvram->boot_delay_index < 6)
9906                 boot_delay = Tekram_boot_delay[nvram->boot_delay_index];
9907         switch((nvram->flags & TEKRAM_REMOVABLE_FLAGS) >> 6) {
9908         default:
9909         case 0: rem = "";                       break;
9910         case 1: rem = " REMOVABLE=boot device"; break;
9911         case 2: rem = " REMOVABLE=all";         break;
9912         }
9913
9914         printf("%s: HOST ID=%d%s%s%s%s%s%s%s%s%s BOOT DELAY=%d tags=%d\n",
9915                 sym_name(np), nvram->host_id & 0x0f,
9916                 (nvram->flags1 & SYMBIOS_SCAM_ENABLE)   ? " SCAM"       :"",
9917                 (nvram->flags & TEKRAM_MORE_THAN_2_DRIVES) ? " >2DRIVES"        :"",
9918                 (nvram->flags & TEKRAM_DRIVES_SUP_1GB)  ? " >1GB"       :"",
9919                 (nvram->flags & TEKRAM_RESET_ON_POWER_ON) ? " RESET"    :"",
9920                 (nvram->flags & TEKRAM_ACTIVE_NEGATION) ? " ACT_NEG"    :"",
9921                 (nvram->flags & TEKRAM_IMMEDIATE_SEEK)  ? " IMM_SEEK"   :"",
9922                 (nvram->flags & TEKRAM_SCAN_LUNS)       ? " SCAN_LUNS"  :"",
9923                 (nvram->flags1 & TEKRAM_F2_F6_ENABLED)  ? " F2_F6"      :"",
9924                 rem, boot_delay, tags);
9925
9926         /* display Tekram nvram drive data */
9927         for (i = 0; i <= 15; i++) {
9928                 int sync, j;
9929                 struct Tekram_target *tn = &nvram->target[i];
9930                 j = tn->sync_index & 0xf;
9931                 sync = Tekram_sync[j];
9932                 printf("%s-%d:%s%s%s%s%s%s PERIOD=%d\n",
9933                 sym_name(np), i,
9934                 (tn->flags & TEKRAM_PARITY_CHECK)       ? " PARITY"     : "",
9935                 (tn->flags & TEKRAM_SYNC_NEGO)          ? " SYNC"       : "",
9936                 (tn->flags & TEKRAM_DISCONNECT_ENABLE)  ? " DISC"       : "",
9937                 (tn->flags & TEKRAM_START_CMD)          ? " START"      : "",
9938                 (tn->flags & TEKRAM_TAGGED_COMMANDS)    ? " TCQ"        : "",
9939                 (tn->flags & TEKRAM_WIDE_NEGO)          ? " WIDE"       : "",
9940                 sync);
9941         }
9942 }
9943 #endif  /* SYM_CONF_DEBUG_NVRAM */
9944 #endif  /* SYM_CONF_NVRAM_SUPPORT */
9945
9946
9947 /*
9948  *  Try reading Symbios or Tekram NVRAM
9949  */
9950 #ifdef SYM_CONF_NVRAM_SUPPORT
9951 static int sym_read_Symbios_nvram (hcb_p np, Symbios_nvram *nvram);
9952 static int sym_read_Tekram_nvram  (hcb_p np, Tekram_nvram *nvram);
9953 #endif
9954
9955 int sym_read_nvram(hcb_p np, struct sym_nvram *nvp)
9956 {
9957 #ifdef SYM_CONF_NVRAM_SUPPORT
9958         /*
9959          *  Try to read SYMBIOS nvram.
9960          *  Try to read TEKRAM nvram if Symbios nvram not found.
9961          */
9962         if      (SYM_SETUP_SYMBIOS_NVRAM &&
9963                  !sym_read_Symbios_nvram (np, &nvp->data.Symbios)) {
9964                 nvp->type = SYM_SYMBIOS_NVRAM;
9965 #ifdef SYM_CONF_DEBUG_NVRAM
9966                 sym_display_Symbios_nvram(np, &nvp->data.Symbios);
9967 #endif
9968         }
9969         else if (SYM_SETUP_TEKRAM_NVRAM &&
9970                  !sym_read_Tekram_nvram (np, &nvp->data.Tekram)) {
9971                 nvp->type = SYM_TEKRAM_NVRAM;
9972 #ifdef SYM_CONF_DEBUG_NVRAM
9973                 sym_display_Tekram_nvram(np, &nvp->data.Tekram);
9974 #endif
9975         }
9976         else
9977                 nvp->type = 0;
9978 #else
9979         nvp->type = 0;
9980 #endif
9981         return nvp->type;
9982 }
9983
9984
9985 #ifdef SYM_CONF_NVRAM_SUPPORT
9986 /*
9987  *  24C16 EEPROM reading.
9988  *
9989  *  GPOI0 - data in/data out
9990  *  GPIO1 - clock
9991  *  Symbios NVRAM wiring now also used by Tekram.
9992  */
9993
9994 #define SET_BIT 0
9995 #define CLR_BIT 1
9996 #define SET_CLK 2
9997 #define CLR_CLK 3
9998
9999 /*
10000  *  Set/clear data/clock bit in GPIO0
10001  */
10002 static void S24C16_set_bit(hcb_p np, u_char write_bit, u_char *gpreg, 
10003                           int bit_mode)
10004 {
10005         UDELAY (5);
10006         switch (bit_mode){
10007         case SET_BIT:
10008                 *gpreg |= write_bit;
10009                 break;
10010         case CLR_BIT:
10011                 *gpreg &= 0xfe;
10012                 break;
10013         case SET_CLK:
10014                 *gpreg |= 0x02;
10015                 break;
10016         case CLR_CLK:
10017                 *gpreg &= 0xfd;
10018                 break;
10019
10020         }
10021         OUTB (nc_gpreg, *gpreg);
10022         UDELAY (5);
10023 }
10024
10025 /*
10026  *  Send START condition to NVRAM to wake it up.
10027  */
10028 static void S24C16_start(hcb_p np, u_char *gpreg)
10029 {
10030         S24C16_set_bit(np, 1, gpreg, SET_BIT);
10031         S24C16_set_bit(np, 0, gpreg, SET_CLK);
10032         S24C16_set_bit(np, 0, gpreg, CLR_BIT);
10033         S24C16_set_bit(np, 0, gpreg, CLR_CLK);
10034 }
10035
10036 /*
10037  *  Send STOP condition to NVRAM - puts NVRAM to sleep... ZZzzzz!!
10038  */
10039 static void S24C16_stop(hcb_p np, u_char *gpreg)
10040 {
10041         S24C16_set_bit(np, 0, gpreg, SET_CLK);
10042         S24C16_set_bit(np, 1, gpreg, SET_BIT);
10043 }
10044
10045 /*
10046  *  Read or write a bit to the NVRAM,
10047  *  read if GPIO0 input else write if GPIO0 output
10048  */
10049 static void S24C16_do_bit(hcb_p np, u_char *read_bit, u_char write_bit, 
10050                          u_char *gpreg)
10051 {
10052         S24C16_set_bit(np, write_bit, gpreg, SET_BIT);
10053         S24C16_set_bit(np, 0, gpreg, SET_CLK);
10054         if (read_bit)
10055                 *read_bit = INB (nc_gpreg);
10056         S24C16_set_bit(np, 0, gpreg, CLR_CLK);
10057         S24C16_set_bit(np, 0, gpreg, CLR_BIT);
10058 }
10059
10060 /*
10061  *  Output an ACK to the NVRAM after reading,
10062  *  change GPIO0 to output and when done back to an input
10063  */
10064 static void S24C16_write_ack(hcb_p np, u_char write_bit, u_char *gpreg, 
10065                             u_char *gpcntl)
10066 {
10067         OUTB (nc_gpcntl, *gpcntl & 0xfe);
10068         S24C16_do_bit(np, 0, write_bit, gpreg);
10069         OUTB (nc_gpcntl, *gpcntl);
10070 }
10071
10072 /*
10073  *  Input an ACK from NVRAM after writing,
10074  *  change GPIO0 to input and when done back to an output
10075  */
10076 static void S24C16_read_ack(hcb_p np, u_char *read_bit, u_char *gpreg, 
10077                            u_char *gpcntl)
10078 {
10079         OUTB (nc_gpcntl, *gpcntl | 0x01);
10080         S24C16_do_bit(np, read_bit, 1, gpreg);
10081         OUTB (nc_gpcntl, *gpcntl);
10082 }
10083
10084 /*
10085  *  WRITE a byte to the NVRAM and then get an ACK to see it was accepted OK,
10086  *  GPIO0 must already be set as an output
10087  */
10088 static void S24C16_write_byte(hcb_p np, u_char *ack_data, u_char write_data, 
10089                              u_char *gpreg, u_char *gpcntl)
10090 {
10091         int x;
10092         
10093         for (x = 0; x < 8; x++)
10094                 S24C16_do_bit(np, 0, (write_data >> (7 - x)) & 0x01, gpreg);
10095                 
10096         S24C16_read_ack(np, ack_data, gpreg, gpcntl);
10097 }
10098
10099 /*
10100  *  READ a byte from the NVRAM and then send an ACK to say we have got it,
10101  *  GPIO0 must already be set as an input
10102  */
10103 static void S24C16_read_byte(hcb_p np, u_char *read_data, u_char ack_data, 
10104                             u_char *gpreg, u_char *gpcntl)
10105 {
10106         int x;
10107         u_char read_bit;
10108
10109         *read_data = 0;
10110         for (x = 0; x < 8; x++) {
10111                 S24C16_do_bit(np, &read_bit, 1, gpreg);
10112                 *read_data |= ((read_bit & 0x01) << (7 - x));
10113         }
10114
10115         S24C16_write_ack(np, ack_data, gpreg, gpcntl);
10116 }
10117
10118 /*
10119  *  Read 'len' bytes starting at 'offset'.
10120  */
10121 static int sym_read_S24C16_nvram (hcb_p np, int offset, u_char *data, int len)
10122 {
10123         u_char  gpcntl, gpreg;
10124         u_char  old_gpcntl, old_gpreg;
10125         u_char  ack_data;
10126         int     retv = 1;
10127         int     x;
10128
10129         /* save current state of GPCNTL and GPREG */
10130         old_gpreg       = INB (nc_gpreg);
10131         old_gpcntl      = INB (nc_gpcntl);
10132         gpcntl          = old_gpcntl & 0x1c;
10133
10134         /* set up GPREG & GPCNTL to set GPIO0 and GPIO1 in to known state */
10135         OUTB (nc_gpreg,  old_gpreg);
10136         OUTB (nc_gpcntl, gpcntl);
10137
10138         /* this is to set NVRAM into a known state with GPIO0/1 both low */
10139         gpreg = old_gpreg;
10140         S24C16_set_bit(np, 0, &gpreg, CLR_CLK);
10141         S24C16_set_bit(np, 0, &gpreg, CLR_BIT);
10142                 
10143         /* now set NVRAM inactive with GPIO0/1 both high */
10144         S24C16_stop(np, &gpreg);
10145         
10146         /* activate NVRAM */
10147         S24C16_start(np, &gpreg);
10148
10149         /* write device code and random address MSB */
10150         S24C16_write_byte(np, &ack_data,
10151                 0xa0 | ((offset >> 7) & 0x0e), &gpreg, &gpcntl);
10152         if (ack_data & 0x01)
10153                 goto out;
10154
10155         /* write random address LSB */
10156         S24C16_write_byte(np, &ack_data,
10157                 offset & 0xff, &gpreg, &gpcntl);
10158         if (ack_data & 0x01)
10159                 goto out;
10160
10161         /* regenerate START state to set up for reading */
10162         S24C16_start(np, &gpreg);
10163         
10164         /* rewrite device code and address MSB with read bit set (lsb = 0x01) */
10165         S24C16_write_byte(np, &ack_data,
10166                 0xa1 | ((offset >> 7) & 0x0e), &gpreg, &gpcntl);
10167         if (ack_data & 0x01)
10168                 goto out;
10169
10170         /* now set up GPIO0 for inputting data */
10171         gpcntl |= 0x01;
10172         OUTB (nc_gpcntl, gpcntl);
10173                 
10174         /* input all requested data - only part of total NVRAM */
10175         for (x = 0; x < len; x++) 
10176                 S24C16_read_byte(np, &data[x], (x == (len-1)), &gpreg, &gpcntl);
10177
10178         /* finally put NVRAM back in inactive mode */
10179         gpcntl &= 0xfe;
10180         OUTB (nc_gpcntl, gpcntl);
10181         S24C16_stop(np, &gpreg);
10182         retv = 0;
10183 out:
10184         /* return GPIO0/1 to original states after having accessed NVRAM */
10185         OUTB (nc_gpcntl, old_gpcntl);
10186         OUTB (nc_gpreg,  old_gpreg);
10187
10188         return retv;
10189 }
10190
10191 #undef SET_BIT 0
10192 #undef CLR_BIT 1
10193 #undef SET_CLK 2
10194 #undef CLR_CLK 3
10195
10196 /*
10197  *  Try reading Symbios NVRAM.
10198  *  Return 0 if OK.
10199  */
10200 static int sym_read_Symbios_nvram (hcb_p np, Symbios_nvram *nvram)
10201 {
10202         static u_char Symbios_trailer[6] = {0xfe, 0xfe, 0, 0, 0, 0};
10203         u_char *data = (u_char *) nvram;
10204         int len  = sizeof(*nvram);
10205         u_short csum;
10206         int x;
10207
10208         /* probe the 24c16 and read the SYMBIOS 24c16 area */
10209         if (sym_read_S24C16_nvram (np, SYMBIOS_NVRAM_ADDRESS, data, len))
10210                 return 1;
10211
10212         /* check valid NVRAM signature, verify byte count and checksum */
10213         if (nvram->type != 0 ||
10214             bcmp(nvram->trailer, Symbios_trailer, 6) ||
10215             nvram->byte_count != len - 12)
10216                 return 1;
10217
10218         /* verify checksum */
10219         for (x = 6, csum = 0; x < len - 6; x++)
10220                 csum += data[x];
10221         if (csum != nvram->checksum)
10222                 return 1;
10223
10224         return 0;
10225 }
10226
10227 /*
10228  *  93C46 EEPROM reading.
10229  *
10230  *  GPOI0 - data in
10231  *  GPIO1 - data out
10232  *  GPIO2 - clock
10233  *  GPIO4 - chip select
10234  *
10235  *  Used by Tekram.
10236  */
10237
10238 /*
10239  *  Pulse clock bit in GPIO0
10240  */
10241 static void T93C46_Clk(hcb_p np, u_char *gpreg)
10242 {
10243         OUTB (nc_gpreg, *gpreg | 0x04);
10244         UDELAY (2);
10245         OUTB (nc_gpreg, *gpreg);
10246 }
10247
10248 /* 
10249  *  Read bit from NVRAM
10250  */
10251 static void T93C46_Read_Bit(hcb_p np, u_char *read_bit, u_char *gpreg)
10252 {
10253         UDELAY (2);
10254         T93C46_Clk(np, gpreg);
10255         *read_bit = INB (nc_gpreg);
10256 }
10257
10258 /*
10259  *  Write bit to GPIO0
10260  */
10261 static void T93C46_Write_Bit(hcb_p np, u_char write_bit, u_char *gpreg)
10262 {
10263         if (write_bit & 0x01)
10264                 *gpreg |= 0x02;
10265         else
10266                 *gpreg &= 0xfd;
10267                 
10268         *gpreg |= 0x10;
10269                 
10270         OUTB (nc_gpreg, *gpreg);
10271         UDELAY (2);
10272
10273         T93C46_Clk(np, gpreg);
10274 }
10275
10276 /*
10277  *  Send STOP condition to NVRAM - puts NVRAM to sleep... ZZZzzz!!
10278  */
10279 static void T93C46_Stop(hcb_p np, u_char *gpreg)
10280 {
10281         *gpreg &= 0xef;
10282         OUTB (nc_gpreg, *gpreg);
10283         UDELAY (2);
10284
10285         T93C46_Clk(np, gpreg);
10286 }
10287
10288 /*
10289  *  Send read command and address to NVRAM
10290  */
10291 static void T93C46_Send_Command(hcb_p np, u_short write_data, 
10292                                 u_char *read_bit, u_char *gpreg)
10293 {
10294         int x;
10295
10296         /* send 9 bits, start bit (1), command (2), address (6)  */
10297         for (x = 0; x < 9; x++)
10298                 T93C46_Write_Bit(np, (u_char) (write_data >> (8 - x)), gpreg);
10299
10300         *read_bit = INB (nc_gpreg);
10301 }
10302
10303 /*
10304  *  READ 2 bytes from the NVRAM
10305  */
10306 static void T93C46_Read_Word(hcb_p np, u_short *nvram_data, u_char *gpreg)
10307 {
10308         int x;
10309         u_char read_bit;
10310
10311         *nvram_data = 0;
10312         for (x = 0; x < 16; x++) {
10313                 T93C46_Read_Bit(np, &read_bit, gpreg);
10314
10315                 if (read_bit & 0x01)
10316                         *nvram_data |=  (0x01 << (15 - x));
10317                 else
10318                         *nvram_data &= ~(0x01 << (15 - x));
10319         }
10320 }
10321
10322 /*
10323  *  Read Tekram NvRAM data.
10324  */
10325 static int T93C46_Read_Data(hcb_p np, u_short *data,int len,u_char *gpreg)
10326 {
10327         u_char  read_bit;
10328         int     x;
10329
10330         for (x = 0; x < len; x++)  {
10331
10332                 /* output read command and address */
10333                 T93C46_Send_Command(np, 0x180 | x, &read_bit, gpreg);
10334                 if (read_bit & 0x01)
10335                         return 1; /* Bad */
10336                 T93C46_Read_Word(np, &data[x], gpreg);
10337                 T93C46_Stop(np, gpreg);
10338         }
10339
10340         return 0;
10341 }
10342
10343 /*
10344  *  Try reading 93C46 Tekram NVRAM.
10345  */
10346 static int sym_read_T93C46_nvram (hcb_p np, Tekram_nvram *nvram)
10347 {
10348         u_char gpcntl, gpreg;
10349         u_char old_gpcntl, old_gpreg;
10350         int retv = 1;
10351
10352         /* save current state of GPCNTL and GPREG */
10353         old_gpreg       = INB (nc_gpreg);
10354         old_gpcntl      = INB (nc_gpcntl);
10355
10356         /* set up GPREG & GPCNTL to set GPIO0/1/2/4 in to known state, 0 in,
10357            1/2/4 out */
10358         gpreg = old_gpreg & 0xe9;
10359         OUTB (nc_gpreg, gpreg);
10360         gpcntl = (old_gpcntl & 0xe9) | 0x09;
10361         OUTB (nc_gpcntl, gpcntl);
10362
10363         /* input all of NVRAM, 64 words */
10364         retv = T93C46_Read_Data(np, (u_short *) nvram,
10365                                 sizeof(*nvram) / sizeof(short), &gpreg);
10366         
10367         /* return GPIO0/1/2/4 to original states after having accessed NVRAM */
10368         OUTB (nc_gpcntl, old_gpcntl);
10369         OUTB (nc_gpreg,  old_gpreg);
10370
10371         return retv;
10372 }
10373
10374 /*
10375  *  Try reading Tekram NVRAM.
10376  *  Return 0 if OK.
10377  */
10378 static int sym_read_Tekram_nvram (hcb_p np, Tekram_nvram *nvram)
10379 {
10380         u_char *data = (u_char *) nvram;
10381         int len = sizeof(*nvram);
10382         u_short csum;
10383         int x;
10384
10385         switch (np->device_id) {
10386         case PCI_ID_SYM53C885:
10387         case PCI_ID_SYM53C895:
10388         case PCI_ID_SYM53C896:
10389                 x = sym_read_S24C16_nvram(np, TEKRAM_24C16_NVRAM_ADDRESS,
10390                                           data, len);
10391                 break;
10392         case PCI_ID_SYM53C875:
10393                 x = sym_read_S24C16_nvram(np, TEKRAM_24C16_NVRAM_ADDRESS,
10394                                           data, len);
10395                 if (!x)
10396                         break;
10397         default:
10398                 x = sym_read_T93C46_nvram(np, nvram);
10399                 break;
10400         }
10401         if (x)
10402                 return 1;
10403
10404         /* verify checksum */
10405         for (x = 0, csum = 0; x < len - 1; x += 2)
10406                 csum += data[x] + (data[x+1] << 8);
10407         if (csum != 0x1234)
10408                 return 1;
10409
10410         return 0;
10411 }
10412
10413 #endif  /* SYM_CONF_NVRAM_SUPPORT */