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