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