2 * Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
3 * PCI-SCSI controllers.
5 * Copyright (C) 1999-2001 Gerard Roudier <groudier@free.fr>
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.
12 * This driver for FreeBSD-CAM is derived from the Linux sym53c8xx driver.
13 * Copyright (C) 1998-1999 Gerard Roudier
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.
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
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.
27 * Other major contributions:
29 * NVRAM detection and reading.
30 * Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
32 *-----------------------------------------------------------------------------
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
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.
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
57 * $FreeBSD: src/sys/dev/sym/sym_hipd.c,v 1.76 2011/10/07 08:59:54 marius Exp $
60 #define SYM_DRIVER_NAME "sym-1.6.5-20000902"
62 /* #define SYM_DEBUG_GENERIC_SUPPORT */
64 #include <sys/param.h>
67 * Driver configuration options.
70 #include <dev/disk/sym/sym_conf.h>
73 #include <sys/systm.h>
74 #include <sys/malloc.h>
75 #include <sys/endian.h>
76 #include <sys/kernel.h>
78 #include <sys/mutex.h>
79 #include <sys/module.h>
84 #include <bus/pci/pcireg.h>
85 #include <bus/pci/pcivar.h>
88 #include <dev/ofw/openfirm.h>
89 #include <machine/ofw_machdep.h>
94 #include <bus/cam/cam.h>
95 #include <bus/cam/cam_ccb.h>
96 #include <bus/cam/cam_sim.h>
97 #include <bus/cam/cam_xpt_sim.h>
98 #include <bus/cam/cam_debug.h>
100 #include <bus/cam/scsi/scsi_all.h>
101 #include <bus/cam/scsi/scsi_message.h>
103 /* Short and quite clear integer types */
108 typedef u_int16_t u16;
109 typedef u_int32_t u32;
112 * Driver definitions.
114 #include <dev/disk/sym/sym_defs.h>
115 #include <dev/disk/sym/sym_fw.h>
118 * IA32 architecture does not reorder STORES and prevents
119 * LOADS from passing STORES. It is called `program order'
120 * by Intel and allows device drivers to deal with memory
121 * ordering by only ensuring that the code is not reordered
122 * by the compiler when ordering is required.
123 * Other architectures implement a weaker ordering that
124 * requires memory barriers (and also IO barriers when they
125 * make sense) to be used.
128 #if defined __i386__ || defined __x86_64__
129 #define MEMORY_BARRIER() do { ; } while(0)
130 #elif defined __powerpc__
131 #define MEMORY_BARRIER() __asm__ volatile("eieio; sync" : : : "memory")
132 #elif defined __ia64__
133 #define MEMORY_BARRIER() __asm__ volatile("mf.a; mf" : : : "memory")
134 #elif defined __sparc64__
135 #define MEMORY_BARRIER() __asm__ volatile("membar #Sync" : : : "memory")
137 #error "Not supported platform"
141 * A la VMS/CAM-3 queue management.
144 typedef struct sym_quehead {
145 struct sym_quehead *flink; /* Forward pointer */
146 struct sym_quehead *blink; /* Backward pointer */
149 #define sym_que_init(ptr) do { \
150 (ptr)->flink = (ptr); (ptr)->blink = (ptr); \
153 static __inline struct sym_quehead *sym_que_first(struct sym_quehead *head)
155 return (head->flink == head) ? NULL : head->flink;
158 static __inline struct sym_quehead *sym_que_last(struct sym_quehead *head)
160 return (head->blink == head) ? NULL : head->blink;
163 static __inline void __sym_que_add(struct sym_quehead * new,
164 struct sym_quehead * blink,
165 struct sym_quehead * flink)
173 static __inline void __sym_que_del(struct sym_quehead * blink,
174 struct sym_quehead * flink)
176 flink->blink = blink;
177 blink->flink = flink;
180 static __inline int sym_que_empty(struct sym_quehead *head)
182 return head->flink == head;
185 static __inline void sym_que_splice(struct sym_quehead *list,
186 struct sym_quehead *head)
188 struct sym_quehead *first = list->flink;
191 struct sym_quehead *last = list->blink;
192 struct sym_quehead *at = head->flink;
202 #define sym_que_entry(ptr, type, member) \
203 ((type *)((char *)(ptr)-(size_t)(&((type *)0)->member)))
206 #define sym_insque(new, pos) __sym_que_add(new, pos, (pos)->flink)
208 #define sym_remque(el) __sym_que_del((el)->blink, (el)->flink)
210 #define sym_insque_head(new, head) __sym_que_add(new, head, (head)->flink)
212 static __inline struct sym_quehead *sym_remque_head(struct sym_quehead *head)
214 struct sym_quehead *elem = head->flink;
217 __sym_que_del(head, elem->flink);
223 #define sym_insque_tail(new, head) __sym_que_add(new, (head)->blink, head)
225 static __inline struct sym_quehead *sym_remque_tail(struct sym_quehead *head)
227 struct sym_quehead *elem = head->blink;
230 __sym_que_del(elem->blink, head);
237 * This one may be useful.
239 #define FOR_EACH_QUEUED_ELEMENT(head, qp) \
240 for (qp = (head)->flink; qp != (head); qp = qp->flink)
242 * FreeBSD does not offer our kind of queue in the CAM CCB.
243 * So, we have to cast.
245 #define sym_qptr(p) ((struct sym_quehead *) (p))
248 * Simple bitmap operations.
250 #define sym_set_bit(p, n) (((u32 *)(p))[(n)>>5] |= (1<<((n)&0x1f)))
251 #define sym_clr_bit(p, n) (((u32 *)(p))[(n)>>5] &= ~(1<<((n)&0x1f)))
252 #define sym_is_bit(p, n) (((u32 *)(p))[(n)>>5] & (1<<((n)&0x1f)))
255 * Number of tasks per device we want to handle.
257 #if SYM_CONF_MAX_TAG_ORDER > 8
258 #error "more than 256 tags per logical unit not allowed."
260 #define SYM_CONF_MAX_TASK (1<<SYM_CONF_MAX_TAG_ORDER)
263 * Donnot use more tasks that we can handle.
265 #ifndef SYM_CONF_MAX_TAG
266 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
268 #if SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
269 #undef SYM_CONF_MAX_TAG
270 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
274 * This one means 'NO TAG for this job'
279 * Number of SCSI targets.
281 #if SYM_CONF_MAX_TARGET > 16
282 #error "more than 16 targets not allowed."
286 * Number of logical units per target.
288 #if SYM_CONF_MAX_LUN > 64
289 #error "more than 64 logical units per target not allowed."
293 * Asynchronous pre-scaler (ns). Shall be 40 for
294 * the SCSI timings to be compliant.
296 #define SYM_CONF_MIN_ASYNC (40)
299 * Number of entries in the START and DONE queues.
301 * We limit to 1 PAGE in order to succeed allocation of
302 * these queues. Each entry is 8 bytes long (2 DWORDS).
304 #ifdef SYM_CONF_MAX_START
305 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
307 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
308 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
311 #if SYM_CONF_MAX_QUEUE > PAGE_SIZE/8
312 #undef SYM_CONF_MAX_QUEUE
313 #define SYM_CONF_MAX_QUEUE PAGE_SIZE/8
314 #undef SYM_CONF_MAX_START
315 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
319 * For this one, we want a short name :-)
321 #define MAX_QUEUE SYM_CONF_MAX_QUEUE
324 * Active debugging tags and verbosity.
326 #define DEBUG_ALLOC (0x0001)
327 #define DEBUG_PHASE (0x0002)
328 #define DEBUG_POLL (0x0004)
329 #define DEBUG_QUEUE (0x0008)
330 #define DEBUG_RESULT (0x0010)
331 #define DEBUG_SCATTER (0x0020)
332 #define DEBUG_SCRIPT (0x0040)
333 #define DEBUG_TINY (0x0080)
334 #define DEBUG_TIMING (0x0100)
335 #define DEBUG_NEGO (0x0200)
336 #define DEBUG_TAGS (0x0400)
337 #define DEBUG_POINTER (0x0800)
340 static int sym_debug = 0;
341 #define DEBUG_FLAGS sym_debug
343 /* #define DEBUG_FLAGS (0x0631) */
344 #define DEBUG_FLAGS (0x0000)
347 #define sym_verbose (np->verbose)
350 * Insert a delay in micro-seconds and milli-seconds.
352 static void UDELAY(int us) { DELAY(us); }
353 static void MDELAY(int ms) { while (ms--) UDELAY(1000); }
356 * Simple power of two buddy-like allocator.
358 * This simple code is not intended to be fast, but to
359 * provide power of 2 aligned memory allocations.
360 * Since the SCRIPTS processor only supplies 8 bit arithmetic,
361 * this allocator allows simple and fast address calculations
362 * from the SCRIPTS code. In addition, cache line alignment
363 * is guaranteed for power of 2 cache line size.
365 * This allocator has been developed for the Linux sym53c8xx
366 * driver, since this O/S does not provide naturally aligned
368 * It has the advantage of allowing the driver to use private
369 * pages of memory that will be useful if we ever need to deal
370 * with IO MMUs for PCI.
373 #define MEMO_SHIFT 4 /* 16 bytes minimum memory chunk */
374 #define MEMO_PAGE_ORDER 0 /* 1 PAGE maximum */
376 #define MEMO_FREE_UNUSED /* Free unused pages immediately */
379 #define MEMO_CLUSTER_SHIFT (PAGE_SHIFT+MEMO_PAGE_ORDER)
380 #define MEMO_CLUSTER_SIZE (1UL << MEMO_CLUSTER_SHIFT)
381 #define MEMO_CLUSTER_MASK (MEMO_CLUSTER_SIZE-1)
383 #define get_pages() kmalloc(MEMO_CLUSTER_SIZE, M_DEVBUF, M_INTWAIT)
384 #define free_pages(p) kfree((p), M_DEVBUF)
386 typedef u_long m_addr_t; /* Enough bits to bit-hack addresses */
388 typedef struct m_link { /* Link between free memory chunks */
392 typedef struct m_vtob { /* Virtual to Bus address translation */
394 bus_dmamap_t dmamap; /* Map for this chunk */
395 m_addr_t vaddr; /* Virtual address */
396 m_addr_t baddr; /* Bus physical address */
398 /* Hash this stuff a bit to speed up translations */
399 #define VTOB_HASH_SHIFT 5
400 #define VTOB_HASH_SIZE (1UL << VTOB_HASH_SHIFT)
401 #define VTOB_HASH_MASK (VTOB_HASH_SIZE-1)
402 #define VTOB_HASH_CODE(m) \
403 ((((m_addr_t) (m)) >> MEMO_CLUSTER_SHIFT) & VTOB_HASH_MASK)
405 typedef struct m_pool { /* Memory pool of a given kind */
406 bus_dma_tag_t dev_dmat; /* Identifies the pool */
407 bus_dma_tag_t dmat; /* Tag for our fixed allocations */
408 m_addr_t (*getp)(struct m_pool *);
409 #ifdef MEMO_FREE_UNUSED
410 void (*freep)(struct m_pool *, m_addr_t);
412 #define M_GETP() mp->getp(mp)
413 #define M_FREEP(p) mp->freep(mp, p)
415 m_vtob_s *(vtob[VTOB_HASH_SIZE]);
417 struct m_link h[MEMO_CLUSTER_SHIFT - MEMO_SHIFT + 1];
420 static void *___sym_malloc(m_pool_s *mp, int size)
423 int s = (1 << MEMO_SHIFT);
428 if (size > MEMO_CLUSTER_SIZE)
438 if (s == MEMO_CLUSTER_SIZE) {
439 h[j].next = (m_link_s *) M_GETP();
441 h[j].next->next = NULL;
447 a = (m_addr_t) h[j].next;
449 h[j].next = h[j].next->next;
453 h[j].next = (m_link_s *) (a+s);
454 h[j].next->next = NULL;
458 kprintf("___sym_malloc(%d) = %p\n", size, (void *) a);
463 static void ___sym_mfree(m_pool_s *mp, void *ptr, int size)
466 int s = (1 << MEMO_SHIFT);
472 kprintf("___sym_mfree(%p, %d)\n", ptr, size);
475 if (size > MEMO_CLUSTER_SIZE)
486 #ifdef MEMO_FREE_UNUSED
487 if (s == MEMO_CLUSTER_SIZE) {
494 while (q->next && q->next != (m_link_s *) b) {
498 ((m_link_s *) a)->next = h[i].next;
499 h[i].next = (m_link_s *) a;
502 q->next = q->next->next;
509 static void *__sym_calloc2(m_pool_s *mp, int size, char *name, int uflags)
513 p = ___sym_malloc(mp, size);
515 if (DEBUG_FLAGS & DEBUG_ALLOC)
516 kprintf ("new %-10s[%4d] @%p.\n", name, size, p);
520 else if (uflags & MEMO_WARN)
521 kprintf ("__sym_calloc2: failed to allocate %s[%d]\n", name, size);
526 #define __sym_calloc(mp, s, n) __sym_calloc2(mp, s, n, MEMO_WARN)
528 static void __sym_mfree(m_pool_s *mp, void *ptr, int size, char *name)
530 if (DEBUG_FLAGS & DEBUG_ALLOC)
531 kprintf ("freeing %-10s[%4d] @%p.\n", name, size, ptr);
533 ___sym_mfree(mp, ptr, size);
538 * Default memory pool we donnot need to involve in DMA.
541 * With the `bus dma abstraction', we use a separate pool for
542 * memory we donnot need to involve in DMA.
544 static m_addr_t ___mp0_getp(m_pool_s *mp)
546 m_addr_t m = (m_addr_t) get_pages();
552 #ifdef MEMO_FREE_UNUSED
553 static void ___mp0_freep(m_pool_s *mp, m_addr_t m)
560 #ifdef MEMO_FREE_UNUSED
561 static m_pool_s mp0 = {0, 0, ___mp0_getp, ___mp0_freep};
563 static m_pool_s mp0 = {0, 0, ___mp0_getp};
568 * Actual memory allocation routine for non-DMAed memory.
570 static void *sym_calloc(int size, char *name)
574 m = __sym_calloc(&mp0, size, name);
580 * Actual memory allocation routine for non-DMAed memory.
582 static void sym_mfree(void *ptr, int size, char *name)
585 __sym_mfree(&mp0, ptr, size, name);
593 * With `bus dma abstraction', we use a separate pool per parent
594 * BUS handle. A reverse table (hashed) is maintained for virtual
595 * to BUS address translation.
597 static void getbaddrcb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
600 baddr = (bus_addr_t *)arg;
601 *baddr = segs->ds_addr;
604 static m_addr_t ___dma_getp(m_pool_s *mp)
608 bus_addr_t baddr = 0;
610 vbp = __sym_calloc(&mp0, sizeof(*vbp), "VTOB");
614 if (bus_dmamem_alloc(mp->dmat, &vaddr,
615 BUS_DMA_COHERENT | BUS_DMA_WAITOK, &vbp->dmamap))
617 bus_dmamap_load(mp->dmat, vbp->dmamap, vaddr,
618 MEMO_CLUSTER_SIZE, getbaddrcb, &baddr, BUS_DMA_NOWAIT);
620 int hc = VTOB_HASH_CODE(vaddr);
621 vbp->vaddr = (m_addr_t) vaddr;
622 vbp->baddr = (m_addr_t) baddr;
623 vbp->next = mp->vtob[hc];
626 return (m_addr_t) vaddr;
630 bus_dmamap_unload(mp->dmat, vbp->dmamap);
632 bus_dmamem_free(mp->dmat, vaddr, vbp->dmamap);
635 bus_dmamap_destroy(mp->dmat, vbp->dmamap);
636 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
641 #ifdef MEMO_FREE_UNUSED
642 static void ___dma_freep(m_pool_s *mp, m_addr_t m)
644 m_vtob_s **vbpp, *vbp;
645 int hc = VTOB_HASH_CODE(m);
647 vbpp = &mp->vtob[hc];
648 while (*vbpp && (*vbpp)->vaddr != m)
649 vbpp = &(*vbpp)->next;
652 *vbpp = (*vbpp)->next;
653 bus_dmamap_unload(mp->dmat, vbp->dmamap);
654 bus_dmamem_free(mp->dmat, (void *) vbp->vaddr, vbp->dmamap);
655 bus_dmamap_destroy(mp->dmat, vbp->dmamap);
656 __sym_mfree(&mp0, vbp, sizeof(*vbp), "VTOB");
662 static __inline m_pool_s *___get_dma_pool(bus_dma_tag_t dev_dmat)
665 for (mp = mp0.next; mp && mp->dev_dmat != dev_dmat; mp = mp->next);
669 static m_pool_s *___cre_dma_pool(bus_dma_tag_t dev_dmat)
673 mp = __sym_calloc(&mp0, sizeof(*mp), "MPOOL");
675 mp->dev_dmat = dev_dmat;
676 if (!bus_dma_tag_create(dev_dmat, 1, MEMO_CLUSTER_SIZE,
677 BUS_SPACE_MAXADDR_32BIT,
679 NULL, NULL, MEMO_CLUSTER_SIZE, 1,
680 MEMO_CLUSTER_SIZE, 0,
682 mp->getp = ___dma_getp;
683 #ifdef MEMO_FREE_UNUSED
684 mp->freep = ___dma_freep;
692 __sym_mfree(&mp0, mp, sizeof(*mp), "MPOOL");
696 #ifdef MEMO_FREE_UNUSED
697 static void ___del_dma_pool(m_pool_s *p)
699 struct m_pool **pp = &mp0.next;
701 while (*pp && *pp != p)
705 bus_dma_tag_destroy(p->dmat);
706 __sym_mfree(&mp0, p, sizeof(*p), "MPOOL");
711 static void *__sym_calloc_dma(bus_dma_tag_t dev_dmat, int size, char *name)
717 mp = ___get_dma_pool(dev_dmat);
719 mp = ___cre_dma_pool(dev_dmat);
721 m = __sym_calloc(mp, size, name);
722 #ifdef MEMO_FREE_UNUSED
732 __sym_mfree_dma(bus_dma_tag_t dev_dmat, void *m, int size, char *name)
737 mp = ___get_dma_pool(dev_dmat);
739 __sym_mfree(mp, m, size, name);
740 #ifdef MEMO_FREE_UNUSED
747 static m_addr_t __vtobus(bus_dma_tag_t dev_dmat, void *m)
750 int hc = VTOB_HASH_CODE(m);
752 m_addr_t a = ((m_addr_t) m) & ~MEMO_CLUSTER_MASK;
755 mp = ___get_dma_pool(dev_dmat);
758 while (vp && vp->vaddr != a)
763 panic("sym: VTOBUS FAILED!");
764 return vp ? vp->baddr + (((m_addr_t) m) - a) : 0;
769 * Verbs for DMAable memory handling.
770 * The _uvptv_ macro avoids a nasty warning about pointer to volatile
773 #define _uvptv_(p) ((void *)((vm_offset_t)(p)))
774 #define _sym_calloc_dma(np, s, n) __sym_calloc_dma(np->bus_dmat, s, n)
775 #define _sym_mfree_dma(np, p, s, n) \
776 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), s, n)
777 #define sym_calloc_dma(s, n) _sym_calloc_dma(np, s, n)
778 #define sym_mfree_dma(p, s, n) _sym_mfree_dma(np, p, s, n)
779 #define _vtobus(np, p) __vtobus(np->bus_dmat, _uvptv_(p))
780 #define vtobus(p) _vtobus(np, p)
784 * Print a buffer in hexadecimal format.
786 static void sym_printb_hex (u_char *p, int n)
789 kprintf (" %x", *p++);
793 * Same with a label at beginning and .\n at end.
795 static void sym_printl_hex (char *label, u_char *p, int n)
797 kprintf ("%s", label);
798 sym_printb_hex (p, n);
803 * Return a string for SCSI BUS mode.
805 static const char *sym_scsi_bus_mode(int mode)
808 case SMODE_HVD: return "HVD";
809 case SMODE_SE: return "SE";
810 case SMODE_LVD: return "LVD";
816 * Some poor and bogus sync table that refers to Tekram NVRAM layout.
818 #ifdef SYM_CONF_NVRAM_SUPPORT
819 static const u_char Tekram_sync[16] =
820 {25,31,37,43, 50,62,75,125, 12,15,18,21, 6,7,9,10};
824 * Union of supported NVRAM formats.
828 #define SYM_SYMBIOS_NVRAM (1)
829 #define SYM_TEKRAM_NVRAM (2)
830 #ifdef SYM_CONF_NVRAM_SUPPORT
832 Symbios_nvram Symbios;
839 * This one is hopefully useless, but actually useful. :-)
842 #define assert(expression) { \
843 if (!(expression)) { \
845 "assertion \"%s\" failed: file \"%s\", line %d", \
847 __FILE__, __LINE__); \
853 * Some provision for a possible big endian mode supported by
854 * Symbios chips (never seen, by the way).
855 * For now, this stuff does not deserve any comments. :)
858 #define sym_offb(o) (o)
859 #define sym_offw(o) (o)
862 * Some provision for support for BIG ENDIAN CPU.
865 #define cpu_to_scr(dw) htole32(dw)
866 #define scr_to_cpu(dw) le32toh(dw)
869 * Access to the chip IO registers and on-chip RAM.
870 * We use the `bus space' interface under FreeBSD-4 and
871 * later kernel versions.
875 #if defined(SYM_CONF_IOMAPPED)
877 #define INB_OFF(o) bus_read_1(np->io_res, (o))
878 #define INW_OFF(o) bus_read_2(np->io_res, (o))
879 #define INL_OFF(o) bus_read_4(np->io_res, (o))
881 #define OUTB_OFF(o, v) bus_write_1(np->io_res, (o), (v))
882 #define OUTW_OFF(o, v) bus_write_2(np->io_res, (o), (v))
883 #define OUTL_OFF(o, v) bus_write_4(np->io_res, (o), (v))
885 #else /* Memory mapped IO */
887 #define INB_OFF(o) bus_read_1(np->mmio_res, (o))
888 #define INW_OFF(o) bus_read_2(np->mmio_res, (o))
889 #define INL_OFF(o) bus_read_4(np->mmio_res, (o))
891 #define OUTB_OFF(o, v) bus_write_1(np->mmio_res, (o), (v))
892 #define OUTW_OFF(o, v) bus_write_2(np->mmio_res, (o), (v))
893 #define OUTL_OFF(o, v) bus_write_4(np->mmio_res, (o), (v))
895 #endif /* SYM_CONF_IOMAPPED */
897 #define OUTRAM_OFF(o, a, l) \
898 bus_write_region_1(np->ram_res, (o), (a), (l))
902 * Common definitions for both bus space and legacy IO methods.
904 #define INB(r) INB_OFF(offsetof(struct sym_reg,r))
905 #define INW(r) INW_OFF(offsetof(struct sym_reg,r))
906 #define INL(r) INL_OFF(offsetof(struct sym_reg,r))
908 #define OUTB(r, v) OUTB_OFF(offsetof(struct sym_reg,r), (v))
909 #define OUTW(r, v) OUTW_OFF(offsetof(struct sym_reg,r), (v))
910 #define OUTL(r, v) OUTL_OFF(offsetof(struct sym_reg,r), (v))
912 #define OUTONB(r, m) OUTB(r, INB(r) | (m))
913 #define OUTOFFB(r, m) OUTB(r, INB(r) & ~(m))
914 #define OUTONW(r, m) OUTW(r, INW(r) | (m))
915 #define OUTOFFW(r, m) OUTW(r, INW(r) & ~(m))
916 #define OUTONL(r, m) OUTL(r, INL(r) | (m))
917 #define OUTOFFL(r, m) OUTL(r, INL(r) & ~(m))
920 * We normally want the chip to have a consistent view
921 * of driver internal data structures when we restart it.
924 #define OUTL_DSP(v) \
927 OUTL (nc_dsp, (v)); \
930 #define OUTONB_STD() \
933 OUTONB (nc_dcntl, (STD|NOCOM)); \
937 * Command control block states.
941 #define HS_NEGOTIATE (2) /* sync/wide data transfer*/
942 #define HS_DISCONNECT (3) /* Disconnected by target */
943 #define HS_WAIT (4) /* waiting for resource */
945 #define HS_DONEMASK (0x80)
946 #define HS_COMPLETE (4|HS_DONEMASK)
947 #define HS_SEL_TIMEOUT (5|HS_DONEMASK) /* Selection timeout */
948 #define HS_UNEXPECTED (6|HS_DONEMASK) /* Unexpected disconnect */
949 #define HS_COMP_ERR (7|HS_DONEMASK) /* Completed with error */
952 * Software Interrupt Codes
954 #define SIR_BAD_SCSI_STATUS (1)
955 #define SIR_SEL_ATN_NO_MSG_OUT (2)
956 #define SIR_MSG_RECEIVED (3)
957 #define SIR_MSG_WEIRD (4)
958 #define SIR_NEGO_FAILED (5)
959 #define SIR_NEGO_PROTO (6)
960 #define SIR_SCRIPT_STOPPED (7)
961 #define SIR_REJECT_TO_SEND (8)
962 #define SIR_SWIDE_OVERRUN (9)
963 #define SIR_SODL_UNDERRUN (10)
964 #define SIR_RESEL_NO_MSG_IN (11)
965 #define SIR_RESEL_NO_IDENTIFY (12)
966 #define SIR_RESEL_BAD_LUN (13)
967 #define SIR_TARGET_SELECTED (14)
968 #define SIR_RESEL_BAD_I_T_L (15)
969 #define SIR_RESEL_BAD_I_T_L_Q (16)
970 #define SIR_ABORT_SENT (17)
971 #define SIR_RESEL_ABORTED (18)
972 #define SIR_MSG_OUT_DONE (19)
973 #define SIR_COMPLETE_ERROR (20)
974 #define SIR_DATA_OVERRUN (21)
975 #define SIR_BAD_PHASE (22)
979 * Extended error bit codes.
980 * xerr_status field of struct sym_ccb.
982 #define XE_EXTRA_DATA (1) /* unexpected data phase */
983 #define XE_BAD_PHASE (1<<1) /* illegal phase (4/5) */
984 #define XE_PARITY_ERR (1<<2) /* unrecovered SCSI parity error */
985 #define XE_SODL_UNRUN (1<<3) /* ODD transfer in DATA OUT phase */
986 #define XE_SWIDE_OVRUN (1<<4) /* ODD transfer in DATA IN phase */
989 * Negotiation status.
990 * nego_status field of struct sym_ccb.
997 * A CCB hashed table is used to retrieve CCB address
1000 #define CCB_HASH_SHIFT 8
1001 #define CCB_HASH_SIZE (1UL << CCB_HASH_SHIFT)
1002 #define CCB_HASH_MASK (CCB_HASH_SIZE-1)
1003 #define CCB_HASH_CODE(dsa) (((dsa) >> 9) & CCB_HASH_MASK)
1008 #define SYM_DISC_ENABLED (1)
1009 #define SYM_TAGS_ENABLED (1<<1)
1010 #define SYM_SCAN_BOOT_DISABLED (1<<2)
1011 #define SYM_SCAN_LUNS_DISABLED (1<<3)
1014 * Host adapter miscellaneous flags.
1016 #define SYM_AVOID_BUS_RESET (1)
1017 #define SYM_SCAN_TARGETS_HILO (1<<1)
1021 * Some devices, for example the CHEETAH 2 LVD, disconnects without
1022 * saving the DATA POINTER then reselects and terminates the IO.
1023 * On reselection, the automatic RESTORE DATA POINTER makes the
1024 * CURRENT DATA POINTER not point at the end of the IO.
1025 * This behaviour just breaks our calculation of the residual.
1026 * For now, we just force an AUTO SAVE on disconnection and will
1027 * fix that in a further driver version.
1029 #define SYM_QUIRK_AUTOSAVE 1
1034 #define SYM_LOCK() lockmgr(&np->lock, LK_EXCLUSIVE)
1035 #define SYM_LOCK_ASSERT(_what) KKASSERT(lockstatus(&np->lock, curthread) == (_what));
1036 #define SYM_LOCK_DESTROY() lockuninit(&np->lock)
1037 #define SYM_LOCK_INIT() lockinit(&np->lock, "sym_lock", 0, LK_CANRECURSE)
1038 #if 0 /* XXX swildner */
1039 #define SYM_LOCK_INITIALIZED() mtx_initialized(&np->lock)
1041 #define SYM_UNLOCK() lockmgr(&np->lock, LK_RELEASE)
1043 #define SYM_SNOOP_TIMEOUT (10000000)
1044 #define SYM_PCI_IO PCIR_BAR(0)
1045 #define SYM_PCI_MMIO PCIR_BAR(1)
1046 #define SYM_PCI_RAM PCIR_BAR(2)
1047 #define SYM_PCI_RAM64 PCIR_BAR(3)
1050 * Back-pointer from the CAM CCB to our data structures.
1052 #define sym_hcb_ptr spriv_ptr0
1053 /* #define sym_ccb_ptr spriv_ptr1 */
1056 * We mostly have to deal with pointers.
1057 * Thus these typedef's.
1059 typedef struct sym_tcb *tcb_p;
1060 typedef struct sym_lcb *lcb_p;
1061 typedef struct sym_ccb *ccb_p;
1062 typedef struct sym_hcb *hcb_p;
1065 * Gather negotiable parameters value
1073 u8 options; /* PPR options */
1077 struct sym_trans current;
1078 struct sym_trans goal;
1079 struct sym_trans user;
1082 #define BUS_8_BIT MSG_EXT_WDTR_BUS_8_BIT
1083 #define BUS_16_BIT MSG_EXT_WDTR_BUS_16_BIT
1086 * Global TCB HEADER.
1088 * Due to lack of indirect addressing on earlier NCR chips,
1089 * this substructure is copied from the TCB to a global
1090 * address after selection.
1091 * For SYMBIOS chips that support LOAD/STORE this copy is
1092 * not needed and thus not performed.
1096 * Scripts bus addresses of LUN table accessed from scripts.
1097 * LUN #0 is a special case, since multi-lun devices are rare,
1098 * and we we want to speed-up the general case and not waste
1101 u32 luntbl_sa; /* bus address of this table */
1102 u32 lun0_sa; /* bus address of LCB #0 */
1104 * Actual SYNC/WIDE IO registers value for this target.
1105 * 'sval', 'wval' and 'uval' are read from SCRIPTS and
1106 * so have alignment constraints.
1108 /*0*/ u_char uval; /* -> SCNTL4 register */
1109 /*1*/ u_char sval; /* -> SXFER io register */
1110 /*2*/ u_char filler1;
1111 /*3*/ u_char wval; /* -> SCNTL3 io register */
1115 * Target Control Block
1120 * Assumed at offset 0.
1122 /*0*/ struct sym_tcbh head;
1125 * LUN table used by the SCRIPTS processor.
1126 * An array of bus addresses is used on reselection.
1128 u32 *luntbl; /* LCBs bus address table */
1131 * LUN table used by the C code.
1133 lcb_p lun0p; /* LCB of LUN #0 (usual case) */
1134 #if SYM_CONF_MAX_LUN > 1
1135 lcb_p *lunmp; /* Other LCBs [1..MAX_LUN] */
1139 * Bitmap that tells about LUNs that succeeded at least
1140 * 1 IO and therefore assumed to be a real device.
1141 * Avoid useless allocation of the LCB structure.
1143 u32 lun_map[(SYM_CONF_MAX_LUN+31)/32];
1146 * Bitmap that tells about LUNs that haven't yet an LCB
1147 * allocated (not discovered or LCB allocation failed).
1149 u32 busy0_map[(SYM_CONF_MAX_LUN+31)/32];
1152 * Transfer capabilities (SIP)
1154 struct sym_tinfo tinfo;
1157 * Keep track of the CCB used for the negotiation in order
1158 * to ensure that only 1 negotiation is queued at a time.
1160 ccb_p nego_cp; /* CCB used for the nego */
1163 * Set when we want to reset the device.
1168 * Other user settable limits and options.
1169 * These limits are read from the NVRAM if present.
1176 * Global LCB HEADER.
1178 * Due to lack of indirect addressing on earlier NCR chips,
1179 * this substructure is copied from the LCB to a global
1180 * address after selection.
1181 * For SYMBIOS chips that support LOAD/STORE this copy is
1182 * not needed and thus not performed.
1186 * SCRIPTS address jumped by SCRIPTS on reselection.
1187 * For not probed logical units, this address points to
1188 * SCRIPTS that deal with bad LU handling (must be at
1189 * offset zero of the LCB for that reason).
1194 * Task (bus address of a CCB) read from SCRIPTS that points
1195 * to the unique ITL nexus allowed to be disconnected.
1200 * Task table bus address (read from SCRIPTS).
1206 * Logical Unit Control Block
1211 * Assumed at offset 0.
1213 /*0*/ struct sym_lcbh head;
1216 * Task table read from SCRIPTS that contains pointers to
1217 * ITLQ nexuses. The bus address read from SCRIPTS is
1218 * inside the header.
1220 u32 *itlq_tbl; /* Kernel virtual address */
1223 * Busy CCBs management.
1225 u_short busy_itlq; /* Number of busy tagged CCBs */
1226 u_short busy_itl; /* Number of busy untagged CCBs */
1229 * Circular tag allocation buffer.
1231 u_short ia_tag; /* Tag allocation index */
1232 u_short if_tag; /* Tag release index */
1233 u_char *cb_tags; /* Circular tags buffer */
1236 * Set when we want to clear all tasks.
1244 u_char current_flags;
1248 * Action from SCRIPTS on a task.
1249 * Is part of the CCB, but is also used separately to plug
1250 * error handling action to perform from SCRIPTS.
1253 u32 start; /* Jumped by SCRIPTS after selection */
1254 u32 restart; /* Jumped by SCRIPTS on relection */
1258 * Phase mismatch context.
1260 * It is part of the CCB and is used as parameters for the
1261 * DATA pointer. We need two contexts to handle correctly the
1262 * SAVED DATA POINTER.
1265 struct sym_tblmove sg; /* Updated interrupted SG block */
1266 u32 ret; /* SCRIPT return address */
1270 * LUN control block lookup.
1271 * We use a direct pointer for LUN #0, and a table of
1272 * pointers which is only allocated for devices that support
1275 #if SYM_CONF_MAX_LUN <= 1
1276 #define sym_lp(np, tp, lun) (!lun) ? (tp)->lun0p : 0
1278 #define sym_lp(np, tp, lun) \
1279 (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : 0
1283 * Status are used by the host and the script processor.
1285 * The last four bytes (status[4]) are copied to the
1286 * scratchb register (declared as scr0..scr3) just after the
1287 * select/reselect, and copied back just after disconnecting.
1288 * Inside the script the XX_REG are used.
1292 * Last four bytes (script)
1296 #define HS_PRT nc_scr1
1298 #define SS_PRT nc_scr2
1300 #define HF_PRT nc_scr3
1303 * Last four bytes (host)
1305 #define actualquirks phys.head.status[0]
1306 #define host_status phys.head.status[1]
1307 #define ssss_status phys.head.status[2]
1308 #define host_flags phys.head.status[3]
1313 #define HF_IN_PM0 1u
1314 #define HF_IN_PM1 (1u<<1)
1315 #define HF_ACT_PM (1u<<2)
1316 #define HF_DP_SAVED (1u<<3)
1317 #define HF_SENSE (1u<<4)
1318 #define HF_EXT_ERR (1u<<5)
1319 #define HF_DATA_IN (1u<<6)
1320 #ifdef SYM_CONF_IARB_SUPPORT
1321 #define HF_HINT_IARB (1u<<7)
1325 * Global CCB HEADER.
1327 * Due to lack of indirect addressing on earlier NCR chips,
1328 * this substructure is copied from the ccb to a global
1329 * address after selection (or reselection) and copied back
1330 * before disconnect.
1331 * For SYMBIOS chips that support LOAD/STORE this copy is
1332 * not needed and thus not performed.
1337 * Start and restart SCRIPTS addresses (must be at 0).
1339 /*0*/ struct sym_actscr go;
1342 * SCRIPTS jump address that deal with data pointers.
1343 * 'savep' points to the position in the script responsible
1344 * for the actual transfer of data.
1345 * It's written on reception of a SAVE_DATA_POINTER message.
1347 u32 savep; /* Jump address to saved data pointer */
1348 u32 lastp; /* SCRIPTS address at end of data */
1349 u32 goalp; /* Not accessed for now from SCRIPTS */
1358 * Data Structure Block
1360 * During execution of a ccb by the script processor, the
1361 * DSA (data structure address) register points to this
1362 * substructure of the ccb.
1367 * Also assumed at offset 0 of the sym_ccb structure.
1369 /*0*/ struct sym_ccbh head;
1372 * Phase mismatch contexts.
1373 * We need two to handle correctly the SAVED DATA POINTER.
1374 * MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic
1375 * for address calculation from SCRIPTS.
1381 * Table data for Script
1383 struct sym_tblsel select;
1384 struct sym_tblmove smsg;
1385 struct sym_tblmove smsg_ext;
1386 struct sym_tblmove cmd;
1387 struct sym_tblmove sense;
1388 struct sym_tblmove wresid;
1389 struct sym_tblmove data [SYM_CONF_MAX_SG];
1393 * Our Command Control Block
1397 * This is the data structure which is pointed by the DSA
1398 * register when it is executed by the script processor.
1399 * It must be the first entry.
1401 struct sym_dsb phys;
1404 * Pointer to CAM ccb and related stuff.
1406 struct callout ch; /* callout handle */
1407 union ccb *cam_ccb; /* CAM scsiio ccb */
1408 u8 cdb_buf[16]; /* Copy of CDB */
1409 u8 *sns_bbuf; /* Bounce buffer for sense data */
1410 #define SYM_SNS_BBUF_LEN sizeof(struct scsi_sense_data)
1411 int data_len; /* Total data length */
1412 int segments; /* Number of SG segments */
1415 * Miscellaneous status'.
1417 u_char nego_status; /* Negotiation status */
1418 u_char xerr_status; /* Extended error flags */
1419 u32 extra_bytes; /* Extraneous bytes transferred */
1423 * We prepare a message to be sent after selection.
1424 * We may use a second one if the command is rescheduled
1425 * due to CHECK_CONDITION or COMMAND TERMINATED.
1426 * Contents are IDENTIFY and SIMPLE_TAG.
1427 * While negotiating sync or wide transfer,
1428 * a SDTR or WDTR message is appended.
1430 u_char scsi_smsg [12];
1431 u_char scsi_smsg2[12];
1434 * Auto request sense related fields.
1436 u_char sensecmd[6]; /* Request Sense command */
1437 u_char sv_scsi_status; /* Saved SCSI status */
1438 u_char sv_xerr_status; /* Saved extended status */
1439 int sv_resid; /* Saved residual */
1442 * Map for the DMA of user data.
1444 void *arg; /* Argument for some callback */
1445 bus_dmamap_t dmamap; /* DMA map for user data */
1447 #define SYM_DMA_NONE 0
1448 #define SYM_DMA_READ 1
1449 #define SYM_DMA_WRITE 2
1453 u32 ccb_ba; /* BUS address of this CCB */
1454 u_short tag; /* Tag for this transfer */
1455 /* NO_TAG means no tag */
1458 ccb_p link_ccbh; /* Host adapter CCB hash chain */
1460 link_ccbq; /* Link to free/busy CCB queue */
1461 u32 startp; /* Initial data pointer */
1462 int ext_sg; /* Extreme data pointer, used */
1463 int ext_ofs; /* to calculate the residual. */
1464 u_char to_abort; /* Want this IO to be aborted */
1467 #define CCB_BA(cp,lbl) (cp->ccb_ba + offsetof(struct sym_ccb, lbl))
1470 * Host Control Block
1477 * Due to poorness of addressing capabilities, earlier
1478 * chips (810, 815, 825) copy part of the data structures
1479 * (CCB, TCB and LCB) in fixed areas.
1481 #ifdef SYM_CONF_GENERIC_SUPPORT
1482 struct sym_ccbh ccb_head;
1483 struct sym_tcbh tcb_head;
1484 struct sym_lcbh lcb_head;
1487 * Idle task and invalid task actions and
1488 * their bus addresses.
1490 struct sym_actscr idletask, notask, bad_itl, bad_itlq;
1491 vm_offset_t idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
1494 * Dummy lun table to protect us against target
1495 * returning bad lun number on reselection.
1497 u32 *badluntbl; /* Table physical address */
1498 u32 badlun_sa; /* SCRIPT handler BUS address */
1501 * Bus address of this host control block.
1506 * Bit 32-63 of the on-chip RAM bus address in LE format.
1507 * The START_RAM64 script loads the MMRS and MMWS from this
1513 * Chip and controller indentification.
1518 * Initial value of some IO register bits.
1519 * These values are assumed to have been set by BIOS, and may
1520 * be used to probe adapter implementation differences.
1522 u_char sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
1523 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
1527 * Actual initial value of IO register bits used by the
1528 * driver. They are loaded at initialisation according to
1529 * features that are to be enabled/disabled.
1531 u_char rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4,
1532 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
1538 struct sym_tcb *target;
1540 struct sym_tcb target[SYM_CONF_MAX_TARGET];
1544 * Target control block bus address array used by the SCRIPT
1551 * CAM SIM information for this instance.
1553 struct cam_sim *sim;
1554 struct cam_path *path;
1557 * Allocated hardware resources.
1559 struct resource *irq_res;
1560 struct resource *io_res;
1561 struct resource *mmio_res;
1562 struct resource *ram_res;
1569 * My understanding of PCI is that all agents must share the
1570 * same addressing range and model.
1571 * But some hardware architecture guys provide complex and
1572 * brain-deaded stuff that makes shit.
1573 * This driver only support PCI compliant implementations and
1574 * deals with part of the BUS stuff complexity only to fit O/S
1581 bus_dma_tag_t bus_dmat; /* DMA tag from parent BUS */
1582 bus_dma_tag_t data_dmat; /* DMA tag for user data */
1584 * BUS addresses of the chip
1586 vm_offset_t mmio_ba; /* MMIO BUS address */
1587 int mmio_ws; /* MMIO Window size */
1589 vm_offset_t ram_ba; /* RAM BUS address */
1590 int ram_ws; /* RAM window size */
1593 * SCRIPTS virtual and physical bus addresses.
1594 * 'script' is loaded in the on-chip RAM if present.
1595 * 'scripth' stays in main memory for all chips except the
1596 * 53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
1598 u_char *scripta0; /* Copies of script and scripth */
1599 u_char *scriptb0; /* Copies of script and scripth */
1600 vm_offset_t scripta_ba; /* Actual script and scripth */
1601 vm_offset_t scriptb_ba; /* bus addresses. */
1602 vm_offset_t scriptb0_ba;
1603 u_short scripta_sz; /* Actual size of script A */
1604 u_short scriptb_sz; /* Actual size of script B */
1607 * Bus addresses, setup and patch methods for
1608 * the selected firmware.
1610 struct sym_fwa_ba fwa_bas; /* Useful SCRIPTA bus addresses */
1611 struct sym_fwb_ba fwb_bas; /* Useful SCRIPTB bus addresses */
1612 void (*fw_setup)(hcb_p np, const struct sym_fw *fw);
1613 void (*fw_patch)(hcb_p np);
1614 const char *fw_name;
1617 * General controller parameters and configuration.
1619 u_short device_id; /* PCI device id */
1620 u_char revision_id; /* PCI device revision id */
1621 u_int features; /* Chip features map */
1622 u_char myaddr; /* SCSI id of the adapter */
1623 u_char maxburst; /* log base 2 of dwords burst */
1624 u_char maxwide; /* Maximum transfer width */
1625 u_char minsync; /* Min sync period factor (ST) */
1626 u_char maxsync; /* Max sync period factor (ST) */
1627 u_char maxoffs; /* Max scsi offset (ST) */
1628 u_char minsync_dt; /* Min sync period factor (DT) */
1629 u_char maxsync_dt; /* Max sync period factor (DT) */
1630 u_char maxoffs_dt; /* Max scsi offset (DT) */
1631 u_char multiplier; /* Clock multiplier (1,2,4) */
1632 u_char clock_divn; /* Number of clock divisors */
1633 u32 clock_khz; /* SCSI clock frequency in KHz */
1634 u32 pciclk_khz; /* Estimated PCI clock in KHz */
1636 * Start queue management.
1637 * It is filled up by the host processor and accessed by the
1638 * SCRIPTS processor in order to start SCSI commands.
1640 volatile /* Prevent code optimizations */
1641 u32 *squeue; /* Start queue virtual address */
1642 u32 squeue_ba; /* Start queue BUS address */
1643 u_short squeueput; /* Next free slot of the queue */
1644 u_short actccbs; /* Number of allocated CCBs */
1647 * Command completion queue.
1648 * It is the same size as the start queue to avoid overflow.
1650 u_short dqueueget; /* Next position to scan */
1651 volatile /* Prevent code optimizations */
1652 u32 *dqueue; /* Completion (done) queue */
1653 u32 dqueue_ba; /* Done queue BUS address */
1656 * Miscellaneous buffers accessed by the scripts-processor.
1657 * They shall be DWORD aligned, because they may be read or
1658 * written with a script command.
1660 u_char msgout[8]; /* Buffer for MESSAGE OUT */
1661 u_char msgin [8]; /* Buffer for MESSAGE IN */
1662 u32 lastmsg; /* Last SCSI message sent */
1663 u_char scratch; /* Scratch for SCSI receive */
1666 * Miscellaneous configuration and status parameters.
1668 u_char usrflags; /* Miscellaneous user flags */
1669 u_char scsi_mode; /* Current SCSI BUS mode */
1670 u_char verbose; /* Verbosity for this controller*/
1671 u32 cache; /* Used for cache test at init. */
1674 * CCB lists and queue.
1676 ccb_p ccbh[CCB_HASH_SIZE]; /* CCB hashed by DSA value */
1677 SYM_QUEHEAD free_ccbq; /* Queue of available CCBs */
1678 SYM_QUEHEAD busy_ccbq; /* Queue of busy CCBs */
1681 * During error handling and/or recovery,
1682 * active CCBs that are to be completed with
1683 * error or requeued are moved from the busy_ccbq
1684 * to the comp_ccbq prior to completion.
1686 SYM_QUEHEAD comp_ccbq;
1689 * CAM CCB pending queue.
1691 SYM_QUEHEAD cam_ccbq;
1694 * IMMEDIATE ARBITRATION (IARB) control.
1696 * We keep track in 'last_cp' of the last CCB that has been
1697 * queued to the SCRIPTS processor and clear 'last_cp' when
1698 * this CCB completes. If last_cp is not zero at the moment
1699 * we queue a new CCB, we set a flag in 'last_cp' that is
1700 * used by the SCRIPTS as a hint for setting IARB.
1701 * We donnot set more than 'iarb_max' consecutive hints for
1702 * IARB in order to leave devices a chance to reselect.
1703 * By the way, any non zero value of 'iarb_max' is unfair. :)
1705 #ifdef SYM_CONF_IARB_SUPPORT
1706 u_short iarb_max; /* Max. # consecutive IARB hints*/
1707 u_short iarb_count; /* Actual # of these hints */
1712 * Command abort handling.
1713 * We need to synchronize tightly with the SCRIPTS
1714 * processor in order to handle things correctly.
1716 u_char abrt_msg[4]; /* Message to send buffer */
1717 struct sym_tblmove abrt_tbl; /* Table for the MOV of it */
1718 struct sym_tblsel abrt_sel; /* Sync params for selection */
1719 u_char istat_sem; /* Tells the chip to stop (SEM) */
1722 #define HCB_BA(np, lbl) (np->hcb_ba + offsetof(struct sym_hcb, lbl))
1725 * Return the name of the controller.
1727 static __inline const char *sym_name(hcb_p np)
1729 return device_get_nameunit(np->device);
1732 /*--------------------------------------------------------------------------*/
1733 /*------------------------------ FIRMWARES ---------------------------------*/
1734 /*--------------------------------------------------------------------------*/
1737 * This stuff will be moved to a separate source file when
1738 * the driver will be broken into several source modules.
1742 * Macros used for all firmwares.
1744 #define SYM_GEN_A(s, label) ((short) offsetof(s, label)),
1745 #define SYM_GEN_B(s, label) ((short) offsetof(s, label)),
1746 #define PADDR_A(label) SYM_GEN_PADDR_A(struct SYM_FWA_SCR, label)
1747 #define PADDR_B(label) SYM_GEN_PADDR_B(struct SYM_FWB_SCR, label)
1750 #ifdef SYM_CONF_GENERIC_SUPPORT
1752 * Allocate firmware #1 script area.
1754 #define SYM_FWA_SCR sym_fw1a_scr
1755 #define SYM_FWB_SCR sym_fw1b_scr
1756 #include <dev/disk/sym/sym_fw1.h>
1757 static const struct sym_fwa_ofs sym_fw1a_ofs = {
1758 SYM_GEN_FW_A(struct SYM_FWA_SCR)
1760 static const struct sym_fwb_ofs sym_fw1b_ofs = {
1761 SYM_GEN_FW_B(struct SYM_FWB_SCR)
1765 #endif /* SYM_CONF_GENERIC_SUPPORT */
1768 * Allocate firmware #2 script area.
1770 #define SYM_FWA_SCR sym_fw2a_scr
1771 #define SYM_FWB_SCR sym_fw2b_scr
1772 #include <dev/disk/sym/sym_fw2.h>
1773 static const struct sym_fwa_ofs sym_fw2a_ofs = {
1774 SYM_GEN_FW_A(struct SYM_FWA_SCR)
1776 static const struct sym_fwb_ofs sym_fw2b_ofs = {
1777 SYM_GEN_FW_B(struct SYM_FWB_SCR)
1778 SYM_GEN_B(struct SYM_FWB_SCR, start64)
1779 SYM_GEN_B(struct SYM_FWB_SCR, pm_handle)
1789 #ifdef SYM_CONF_GENERIC_SUPPORT
1791 * Patch routine for firmware #1.
1794 sym_fw1_patch(hcb_p np)
1796 struct sym_fw1a_scr *scripta0;
1797 struct sym_fw1b_scr *scriptb0;
1799 scripta0 = (struct sym_fw1a_scr *) np->scripta0;
1800 scriptb0 = (struct sym_fw1b_scr *) np->scriptb0;
1803 * Remove LED support if not needed.
1805 if (!(np->features & FE_LED0)) {
1806 scripta0->idle[0] = cpu_to_scr(SCR_NO_OP);
1807 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
1808 scripta0->start[0] = cpu_to_scr(SCR_NO_OP);
1811 #ifdef SYM_CONF_IARB_SUPPORT
1813 * If user does not want to use IMMEDIATE ARBITRATION
1814 * when we are reselected while attempting to arbitrate,
1815 * patch the SCRIPTS accordingly with a SCRIPT NO_OP.
1817 if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
1818 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
1821 * Patch some data in SCRIPTS.
1822 * - start and done queue initial bus address.
1823 * - target bus address table bus address.
1825 scriptb0->startpos[0] = cpu_to_scr(np->squeue_ba);
1826 scriptb0->done_pos[0] = cpu_to_scr(np->dqueue_ba);
1827 scriptb0->targtbl[0] = cpu_to_scr(np->targtbl_ba);
1829 #endif /* SYM_CONF_GENERIC_SUPPORT */
1832 * Patch routine for firmware #2.
1835 sym_fw2_patch(hcb_p np)
1837 struct sym_fw2a_scr *scripta0;
1838 struct sym_fw2b_scr *scriptb0;
1840 scripta0 = (struct sym_fw2a_scr *) np->scripta0;
1841 scriptb0 = (struct sym_fw2b_scr *) np->scriptb0;
1844 * Remove LED support if not needed.
1846 if (!(np->features & FE_LED0)) {
1847 scripta0->idle[0] = cpu_to_scr(SCR_NO_OP);
1848 scripta0->reselected[0] = cpu_to_scr(SCR_NO_OP);
1849 scripta0->start[0] = cpu_to_scr(SCR_NO_OP);
1852 #ifdef SYM_CONF_IARB_SUPPORT
1854 * If user does not want to use IMMEDIATE ARBITRATION
1855 * when we are reselected while attempting to arbitrate,
1856 * patch the SCRIPTS accordingly with a SCRIPT NO_OP.
1858 if (!SYM_CONF_SET_IARB_ON_ARB_LOST)
1859 scripta0->ungetjob[0] = cpu_to_scr(SCR_NO_OP);
1862 * Patch some variable in SCRIPTS.
1863 * - start and done queue initial bus address.
1864 * - target bus address table bus address.
1866 scriptb0->startpos[0] = cpu_to_scr(np->squeue_ba);
1867 scriptb0->done_pos[0] = cpu_to_scr(np->dqueue_ba);
1868 scriptb0->targtbl[0] = cpu_to_scr(np->targtbl_ba);
1871 * Remove the load of SCNTL4 on reselection if not a C10.
1873 if (!(np->features & FE_C10)) {
1874 scripta0->resel_scntl4[0] = cpu_to_scr(SCR_NO_OP);
1875 scripta0->resel_scntl4[1] = cpu_to_scr(0);
1879 * Remove a couple of work-arounds specific to C1010 if
1880 * they are not desirable. See `sym_fw2.h' for more details.
1882 if (!(np->device_id == PCI_ID_LSI53C1010_2 &&
1883 np->revision_id < 0x1 &&
1884 np->pciclk_khz < 60000)) {
1885 scripta0->datao_phase[0] = cpu_to_scr(SCR_NO_OP);
1886 scripta0->datao_phase[1] = cpu_to_scr(0);
1888 if (!(np->device_id == PCI_ID_LSI53C1010 &&
1889 /* np->revision_id < 0xff */ 1)) {
1890 scripta0->sel_done[0] = cpu_to_scr(SCR_NO_OP);
1891 scripta0->sel_done[1] = cpu_to_scr(0);
1895 * Patch some other variables in SCRIPTS.
1896 * These ones are loaded by the SCRIPTS processor.
1898 scriptb0->pm0_data_addr[0] =
1899 cpu_to_scr(np->scripta_ba +
1900 offsetof(struct sym_fw2a_scr, pm0_data));
1901 scriptb0->pm1_data_addr[0] =
1902 cpu_to_scr(np->scripta_ba +
1903 offsetof(struct sym_fw2a_scr, pm1_data));
1907 * Fill the data area in scripts.
1908 * To be done for all firmwares.
1911 sym_fw_fill_data (u32 *in, u32 *out)
1915 for (i = 0; i < SYM_CONF_MAX_SG; i++) {
1916 *in++ = SCR_CHMOV_TBL ^ SCR_DATA_IN;
1917 *in++ = offsetof (struct sym_dsb, data[i]);
1918 *out++ = SCR_CHMOV_TBL ^ SCR_DATA_OUT;
1919 *out++ = offsetof (struct sym_dsb, data[i]);
1924 * Setup useful script bus addresses.
1925 * To be done for all firmwares.
1928 sym_fw_setup_bus_addresses(hcb_p np, const struct sym_fw *fw)
1935 * Build the bus address table for script A
1936 * from the script A offset table.
1938 po = (const u_short *) fw->a_ofs;
1939 pa = (u32 *) &np->fwa_bas;
1940 for (i = 0 ; i < sizeof(np->fwa_bas)/sizeof(u32) ; i++)
1941 pa[i] = np->scripta_ba + po[i];
1944 * Same for script B.
1946 po = (const u_short *) fw->b_ofs;
1947 pa = (u32 *) &np->fwb_bas;
1948 for (i = 0 ; i < sizeof(np->fwb_bas)/sizeof(u32) ; i++)
1949 pa[i] = np->scriptb_ba + po[i];
1952 #ifdef SYM_CONF_GENERIC_SUPPORT
1954 * Setup routine for firmware #1.
1957 sym_fw1_setup(hcb_p np, const struct sym_fw *fw)
1959 struct sym_fw1a_scr *scripta0;
1961 scripta0 = (struct sym_fw1a_scr *) np->scripta0;
1964 * Fill variable parts in scripts.
1966 sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
1969 * Setup bus addresses used from the C code..
1971 sym_fw_setup_bus_addresses(np, fw);
1973 #endif /* SYM_CONF_GENERIC_SUPPORT */
1976 * Setup routine for firmware #2.
1979 sym_fw2_setup(hcb_p np, const struct sym_fw *fw)
1981 struct sym_fw2a_scr *scripta0;
1983 scripta0 = (struct sym_fw2a_scr *) np->scripta0;
1986 * Fill variable parts in scripts.
1988 sym_fw_fill_data(scripta0->data_in, scripta0->data_out);
1991 * Setup bus addresses used from the C code..
1993 sym_fw_setup_bus_addresses(np, fw);
1997 * Allocate firmware descriptors.
1999 #ifdef SYM_CONF_GENERIC_SUPPORT
2000 static const struct sym_fw sym_fw1 = SYM_FW_ENTRY(sym_fw1, "NCR-generic");
2001 #endif /* SYM_CONF_GENERIC_SUPPORT */
2002 static const struct sym_fw sym_fw2 = SYM_FW_ENTRY(sym_fw2, "LOAD/STORE-based");
2005 * Find the most appropriate firmware for a chip.
2007 static const struct sym_fw *
2008 sym_find_firmware(const struct sym_pci_chip *chip)
2010 if (chip->features & FE_LDSTR)
2012 #ifdef SYM_CONF_GENERIC_SUPPORT
2013 else if (!(chip->features & (FE_PFEN|FE_NOPM|FE_DAC)))
2021 * Bind a script to physical addresses.
2023 static void sym_fw_bind_script (hcb_p np, u32 *start, int len)
2025 u32 opcode, new, old, tmp1, tmp2;
2030 end = start + len/4;
2037 * If we forget to change the length
2038 * in scripts, a field will be
2039 * padded with 0. This is an illegal
2043 kprintf ("%s: ERROR0 IN SCRIPT at %d.\n",
2044 sym_name(np), (int) (cur-start));
2051 * We use the bogus value 0xf00ff00f ;-)
2052 * to reserve data area in SCRIPTS.
2054 if (opcode == SCR_DATA_ZERO) {
2059 if (DEBUG_FLAGS & DEBUG_SCRIPT)
2060 kprintf ("%d: <%x>\n", (int) (cur-start),
2064 * We don't have to decode ALL commands
2066 switch (opcode >> 28) {
2069 * LOAD / STORE DSA relative, don't relocate.
2075 * LOAD / STORE absolute.
2081 * COPY has TWO arguments.
2086 if ((tmp1 ^ tmp2) & 3) {
2087 kprintf ("%s: ERROR1 IN SCRIPT at %d.\n",
2088 sym_name(np), (int) (cur-start));
2092 * If PREFETCH feature not enabled, remove
2093 * the NO FLUSH bit if present.
2095 if ((opcode & SCR_NO_FLUSH) &&
2096 !(np->features & FE_PFEN)) {
2097 opcode = (opcode & ~SCR_NO_FLUSH);
2102 * MOVE/CHMOV (absolute address)
2104 if (!(np->features & FE_WIDE))
2105 opcode = (opcode | OPC_MOVE);
2110 * MOVE/CHMOV (table indirect)
2112 if (!(np->features & FE_WIDE))
2113 opcode = (opcode | OPC_MOVE);
2119 * dont't relocate if relative :-)
2121 if (opcode & 0x00800000)
2123 else if ((opcode & 0xf8400000) == 0x80400000)/*JUMP64*/
2140 * Scriptify:) the opcode.
2142 *cur++ = cpu_to_scr(opcode);
2145 * If no relocation, assume 1 argument
2146 * and just scriptize:) it.
2149 *cur = cpu_to_scr(*cur);
2155 * Otherwise performs all needed relocations.
2160 switch (old & RELOC_MASK) {
2161 case RELOC_REGISTER:
2162 new = (old & ~RELOC_MASK) + np->mmio_ba;
2165 new = (old & ~RELOC_MASK) + np->scripta_ba;
2168 new = (old & ~RELOC_MASK) + np->scriptb_ba;
2171 new = (old & ~RELOC_MASK) + np->hcb_ba;
2175 * Don't relocate a 0 address.
2176 * They are mostly used for patched or
2177 * script self-modified areas.
2186 panic("sym_fw_bind_script: "
2187 "weird relocation %x\n", old);
2191 *cur++ = cpu_to_scr(new);
2196 /*---------------------------------------------------------------------------*/
2197 /*--------------------------- END OF FIRMWARES -----------------------------*/
2198 /*---------------------------------------------------------------------------*/
2201 * Function prototypes.
2203 static void sym_save_initial_setting (hcb_p np);
2204 static int sym_prepare_setting (hcb_p np, struct sym_nvram *nvram);
2205 static int sym_prepare_nego (hcb_p np, ccb_p cp, int nego, u_char *msgptr);
2206 static void sym_put_start_queue (hcb_p np, ccb_p cp);
2207 static void sym_chip_reset (hcb_p np);
2208 static void sym_soft_reset (hcb_p np);
2209 static void sym_start_reset (hcb_p np);
2210 static int sym_reset_scsi_bus (hcb_p np, int enab_int);
2211 static int sym_wakeup_done (hcb_p np);
2212 static void sym_flush_busy_queue (hcb_p np, int cam_status);
2213 static void sym_flush_comp_queue (hcb_p np, int cam_status);
2214 static void sym_init (hcb_p np, int reason);
2215 static int sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp,
2217 static void sym_setsync (hcb_p np, ccb_p cp, u_char ofs, u_char per,
2218 u_char div, u_char fak);
2219 static void sym_setwide (hcb_p np, ccb_p cp, u_char wide);
2220 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2221 u_char per, u_char wide, u_char div, u_char fak);
2222 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
2223 u_char per, u_char wide, u_char div, u_char fak);
2224 static void sym_log_hard_error (hcb_p np, u_short sist, u_char dstat);
2225 static void sym_intr (void *arg);
2226 static void sym_poll (struct cam_sim *sim);
2227 static void sym_recover_scsi_int (hcb_p np, u_char hsts);
2228 static void sym_int_sto (hcb_p np);
2229 static void sym_int_udc (hcb_p np);
2230 static void sym_int_sbmc (hcb_p np);
2231 static void sym_int_par (hcb_p np, u_short sist);
2232 static void sym_int_ma (hcb_p np);
2233 static int sym_dequeue_from_squeue(hcb_p np, int i, int target, int lun,
2235 static void sym_sir_bad_scsi_status (hcb_p np, int num, ccb_p cp);
2236 static int sym_clear_tasks (hcb_p np, int status, int targ, int lun, int task);
2237 static void sym_sir_task_recovery (hcb_p np, int num);
2238 static int sym_evaluate_dp (hcb_p np, ccb_p cp, u32 scr, int *ofs);
2239 static void sym_modify_dp (hcb_p np, tcb_p tp, ccb_p cp, int ofs);
2240 static int sym_compute_residual (hcb_p np, ccb_p cp);
2241 static int sym_show_msg (u_char * msg);
2242 static void sym_print_msg (ccb_p cp, char *label, u_char *msg);
2243 static void sym_sync_nego (hcb_p np, tcb_p tp, ccb_p cp);
2244 static void sym_ppr_nego (hcb_p np, tcb_p tp, ccb_p cp);
2245 static void sym_wide_nego (hcb_p np, tcb_p tp, ccb_p cp);
2246 static void sym_nego_default (hcb_p np, tcb_p tp, ccb_p cp);
2247 static void sym_nego_rejected (hcb_p np, tcb_p tp, ccb_p cp);
2248 static void sym_int_sir (hcb_p np);
2249 static void sym_free_ccb (hcb_p np, ccb_p cp);
2250 static ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order);
2251 static ccb_p sym_alloc_ccb (hcb_p np);
2252 static ccb_p sym_ccb_from_dsa (hcb_p np, u32 dsa);
2253 static lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln);
2254 static void sym_alloc_lcb_tags (hcb_p np, u_char tn, u_char ln);
2255 static int sym_snooptest (hcb_p np);
2256 static void sym_selectclock(hcb_p np, u_char scntl3);
2257 static void sym_getclock (hcb_p np, int mult);
2258 static int sym_getpciclock (hcb_p np);
2259 static void sym_complete_ok (hcb_p np, ccb_p cp);
2260 static void sym_complete_error (hcb_p np, ccb_p cp);
2261 static void sym_callout (void *arg);
2262 static int sym_abort_scsiio (hcb_p np, union ccb *ccb, int timed_out);
2263 static void sym_reset_dev (hcb_p np, union ccb *ccb);
2264 static void sym_action (struct cam_sim *sim, union ccb *ccb);
2265 static int sym_setup_cdb (hcb_p np, struct ccb_scsiio *csio, ccb_p cp);
2266 static void sym_setup_data_and_start (hcb_p np, struct ccb_scsiio *csio,
2268 static int sym_fast_scatter_sg_physical(hcb_p np, ccb_p cp,
2269 bus_dma_segment_t *psegs, int nsegs);
2270 static int sym_scatter_sg_physical (hcb_p np, ccb_p cp,
2271 bus_dma_segment_t *psegs, int nsegs);
2272 static void sym_action2 (struct cam_sim *sim, union ccb *ccb);
2273 static void sym_update_trans (hcb_p np, tcb_p tp, struct sym_trans *tip,
2274 struct ccb_trans_settings *cts);
2275 static void sym_update_dflags(hcb_p np, u_char *flags,
2276 struct ccb_trans_settings *cts);
2278 static const struct sym_pci_chip *sym_find_pci_chip (device_t dev);
2279 static int sym_pci_probe (device_t dev);
2280 static int sym_pci_attach (device_t dev);
2282 static void sym_pci_free (hcb_p np);
2283 static int sym_cam_attach (hcb_p np);
2284 static void sym_cam_free (hcb_p np);
2286 static void sym_nvram_setup_host (hcb_p np, struct sym_nvram *nvram);
2287 static void sym_nvram_setup_target (hcb_p np, int targ, struct sym_nvram *nvp);
2288 static int sym_read_nvram (hcb_p np, struct sym_nvram *nvp);
2291 * Print something which allows to retrieve the controller type,
2292 * unit, target, lun concerned by a kernel message.
2294 static void PRINT_TARGET (hcb_p np, int target)
2296 kprintf ("%s:%d:", sym_name(np), target);
2299 static void PRINT_LUN(hcb_p np, int target, int lun)
2301 kprintf ("%s:%d:%d:", sym_name(np), target, lun);
2304 static void PRINT_ADDR (ccb_p cp)
2306 if (cp && cp->cam_ccb)
2307 xpt_print_path(cp->cam_ccb->ccb_h.path);
2311 * Take into account this ccb in the freeze count.
2313 static void sym_freeze_cam_ccb(union ccb *ccb)
2315 if (!(ccb->ccb_h.flags & CAM_DEV_QFRZDIS)) {
2316 if (!(ccb->ccb_h.status & CAM_DEV_QFRZN)) {
2317 ccb->ccb_h.status |= CAM_DEV_QFRZN;
2318 xpt_freeze_devq(ccb->ccb_h.path, 1);
2324 * Set the status field of a CAM CCB.
2326 static __inline void sym_set_cam_status(union ccb *ccb, cam_status status)
2328 ccb->ccb_h.status &= ~CAM_STATUS_MASK;
2329 ccb->ccb_h.status |= status;
2333 * Get the status field of a CAM CCB.
2335 static __inline int sym_get_cam_status(union ccb *ccb)
2337 return ccb->ccb_h.status & CAM_STATUS_MASK;
2341 * Enqueue a CAM CCB.
2343 static void sym_enqueue_cam_ccb(ccb_p cp)
2349 np = (hcb_p) cp->arg;
2351 assert(!(ccb->ccb_h.status & CAM_SIM_QUEUED));
2352 ccb->ccb_h.status = CAM_REQ_INPROG;
2354 callout_reset(&cp->ch, ccb->ccb_h.timeout * hz / 1000, sym_callout,
2356 ccb->ccb_h.status |= CAM_SIM_QUEUED;
2357 ccb->ccb_h.sym_hcb_ptr = np;
2359 sym_insque_tail(sym_qptr(&ccb->ccb_h.sim_links), &np->cam_ccbq);
2363 * Complete a pending CAM CCB.
2365 static void _sym_xpt_done(hcb_p np, union ccb *ccb)
2367 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2369 KASSERT((ccb->ccb_h.status & CAM_SIM_QUEUED) == 0,
2370 ("%s: status=CAM_SIM_QUEUED", __func__));
2372 if (ccb->ccb_h.flags & CAM_DEV_QFREEZE)
2373 sym_freeze_cam_ccb(ccb);
2377 static void sym_xpt_done(hcb_p np, union ccb *ccb, ccb_p cp)
2379 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2381 if (ccb->ccb_h.status & CAM_SIM_QUEUED) {
2382 callout_stop(&cp->ch);
2383 sym_remque(sym_qptr(&ccb->ccb_h.sim_links));
2384 ccb->ccb_h.status &= ~CAM_SIM_QUEUED;
2385 ccb->ccb_h.sym_hcb_ptr = NULL;
2387 _sym_xpt_done(np, ccb);
2390 static void sym_xpt_done2(hcb_p np, union ccb *ccb, int cam_status)
2392 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
2394 sym_set_cam_status(ccb, cam_status);
2395 _sym_xpt_done(np, ccb);
2399 * SYMBIOS chip clock divisor table.
2401 * Divisors are multiplied by 10,000,000 in order to make
2402 * calculations more simple.
2405 static const u32 div_10M[] =
2406 {2*_5M, 3*_5M, 4*_5M, 6*_5M, 8*_5M, 12*_5M, 16*_5M};
2409 * SYMBIOS chips allow burst lengths of 2, 4, 8, 16, 32, 64,
2410 * 128 transfers. All chips support at least 16 transfers
2411 * bursts. The 825A, 875 and 895 chips support bursts of up
2412 * to 128 transfers and the 895A and 896 support bursts of up
2413 * to 64 transfers. All other chips support up to 16
2416 * For PCI 32 bit data transfers each transfer is a DWORD.
2417 * It is a QUADWORD (8 bytes) for PCI 64 bit data transfers.
2419 * We use log base 2 (burst length) as internal code, with
2420 * value 0 meaning "burst disabled".
2424 * Burst length from burst code.
2426 #define burst_length(bc) (!(bc))? 0 : 1 << (bc)
2429 * Burst code from io register bits.
2431 #define burst_code(dmode, ctest4, ctest5) \
2432 (ctest4) & 0x80? 0 : (((dmode) & 0xc0) >> 6) + ((ctest5) & 0x04) + 1
2435 * Set initial io register bits from burst code.
2437 static __inline void sym_init_burst(hcb_p np, u_char bc)
2439 np->rv_ctest4 &= ~0x80;
2440 np->rv_dmode &= ~(0x3 << 6);
2441 np->rv_ctest5 &= ~0x4;
2444 np->rv_ctest4 |= 0x80;
2448 np->rv_dmode |= ((bc & 0x3) << 6);
2449 np->rv_ctest5 |= (bc & 0x4);
2455 * Print out the list of targets that have some flag disabled by user.
2457 static void sym_print_targets_flag(hcb_p np, int mask, char *msg)
2462 for (cnt = 0, i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2463 if (i == np->myaddr)
2465 if (np->target[i].usrflags & mask) {
2467 kprintf("%s: %s disabled for targets",
2477 * Save initial settings of some IO registers.
2478 * Assumed to have been set by BIOS.
2479 * We cannot reset the chip prior to reading the
2480 * IO registers, since informations will be lost.
2481 * Since the SCRIPTS processor may be running, this
2482 * is not safe on paper, but it seems to work quite
2485 static void sym_save_initial_setting (hcb_p np)
2487 np->sv_scntl0 = INB(nc_scntl0) & 0x0a;
2488 np->sv_scntl3 = INB(nc_scntl3) & 0x07;
2489 np->sv_dmode = INB(nc_dmode) & 0xce;
2490 np->sv_dcntl = INB(nc_dcntl) & 0xa8;
2491 np->sv_ctest3 = INB(nc_ctest3) & 0x01;
2492 np->sv_ctest4 = INB(nc_ctest4) & 0x80;
2493 np->sv_gpcntl = INB(nc_gpcntl);
2494 np->sv_stest1 = INB(nc_stest1);
2495 np->sv_stest2 = INB(nc_stest2) & 0x20;
2496 np->sv_stest4 = INB(nc_stest4);
2497 if (np->features & FE_C10) { /* Always large DMA fifo + ultra3 */
2498 np->sv_scntl4 = INB(nc_scntl4);
2499 np->sv_ctest5 = INB(nc_ctest5) & 0x04;
2502 np->sv_ctest5 = INB(nc_ctest5) & 0x24;
2506 * Prepare io register values used by sym_init() according
2507 * to selected and supported features.
2509 static int sym_prepare_setting(hcb_p np, struct sym_nvram *nvram)
2518 np->maxwide = (np->features & FE_WIDE)? 1 : 0;
2521 * Get the frequency of the chip's clock.
2523 if (np->features & FE_QUAD)
2525 else if (np->features & FE_DBLR)
2530 np->clock_khz = (np->features & FE_CLK80)? 80000 : 40000;
2531 np->clock_khz *= np->multiplier;
2533 if (np->clock_khz != 40000)
2534 sym_getclock(np, np->multiplier);
2537 * Divisor to be used for async (timer pre-scaler).
2539 i = np->clock_divn - 1;
2541 if (10ul * SYM_CONF_MIN_ASYNC * np->clock_khz > div_10M[i]) {
2546 np->rv_scntl3 = i+1;
2549 * The C1010 uses hardwired divisors for async.
2550 * So, we just throw away, the async. divisor.:-)
2552 if (np->features & FE_C10)
2556 * Minimum synchronous period factor supported by the chip.
2557 * Btw, 'period' is in tenths of nanoseconds.
2559 period = (4 * div_10M[0] + np->clock_khz - 1) / np->clock_khz;
2560 if (period <= 250) np->minsync = 10;
2561 else if (period <= 303) np->minsync = 11;
2562 else if (period <= 500) np->minsync = 12;
2563 else np->minsync = (period + 40 - 1) / 40;
2566 * Check against chip SCSI standard support (SCSI-2,ULTRA,ULTRA2).
2568 if (np->minsync < 25 &&
2569 !(np->features & (FE_ULTRA|FE_ULTRA2|FE_ULTRA3)))
2571 else if (np->minsync < 12 &&
2572 !(np->features & (FE_ULTRA2|FE_ULTRA3)))
2576 * Maximum synchronous period factor supported by the chip.
2578 period = (11 * div_10M[np->clock_divn - 1]) / (4 * np->clock_khz);
2579 np->maxsync = period > 2540 ? 254 : period / 10;
2582 * If chip is a C1010, guess the sync limits in DT mode.
2584 if ((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3)) {
2585 if (np->clock_khz == 160000) {
2587 np->maxsync_dt = 50;
2588 np->maxoffs_dt = 62;
2593 * 64 bit addressing (895A/896/1010) ?
2595 if (np->features & FE_DAC)
2597 np->rv_ccntl1 |= (XTIMOD | EXTIBMV);
2599 np->rv_ccntl1 |= (DDAC);
2603 * Phase mismatch handled by SCRIPTS (895A/896/1010) ?
2605 if (np->features & FE_NOPM)
2606 np->rv_ccntl0 |= (ENPMJ);
2610 * In dual channel mode, contention occurs if internal cycles
2611 * are used. Disable internal cycles.
2613 if (np->device_id == PCI_ID_LSI53C1010 &&
2614 np->revision_id < 0x2)
2615 np->rv_ccntl0 |= DILS;
2618 * Select burst length (dwords)
2620 burst_max = SYM_SETUP_BURST_ORDER;
2621 if (burst_max == 255)
2622 burst_max = burst_code(np->sv_dmode, np->sv_ctest4,
2626 if (burst_max > np->maxburst)
2627 burst_max = np->maxburst;
2630 * DEL 352 - 53C810 Rev x11 - Part Number 609-0392140 - ITEM 2.
2631 * This chip and the 860 Rev 1 may wrongly use PCI cache line
2632 * based transactions on LOAD/STORE instructions. So we have
2633 * to prevent these chips from using such PCI transactions in
2634 * this driver. The generic ncr driver that does not use
2635 * LOAD/STORE instructions does not need this work-around.
2637 if ((np->device_id == PCI_ID_SYM53C810 &&
2638 np->revision_id >= 0x10 && np->revision_id <= 0x11) ||
2639 (np->device_id == PCI_ID_SYM53C860 &&
2640 np->revision_id <= 0x1))
2641 np->features &= ~(FE_WRIE|FE_ERL|FE_ERMP);
2644 * Select all supported special features.
2645 * If we are using on-board RAM for scripts, prefetch (PFEN)
2646 * does not help, but burst op fetch (BOF) does.
2647 * Disabling PFEN makes sure BOF will be used.
2649 if (np->features & FE_ERL)
2650 np->rv_dmode |= ERL; /* Enable Read Line */
2651 if (np->features & FE_BOF)
2652 np->rv_dmode |= BOF; /* Burst Opcode Fetch */
2653 if (np->features & FE_ERMP)
2654 np->rv_dmode |= ERMP; /* Enable Read Multiple */
2656 if ((np->features & FE_PFEN) && !np->ram_ba)
2658 if (np->features & FE_PFEN)
2660 np->rv_dcntl |= PFEN; /* Prefetch Enable */
2661 if (np->features & FE_CLSE)
2662 np->rv_dcntl |= CLSE; /* Cache Line Size Enable */
2663 if (np->features & FE_WRIE)
2664 np->rv_ctest3 |= WRIE; /* Write and Invalidate */
2665 if (np->features & FE_DFS)
2666 np->rv_ctest5 |= DFS; /* Dma Fifo Size */
2671 if (SYM_SETUP_PCI_PARITY)
2672 np->rv_ctest4 |= MPEE; /* Master parity checking */
2673 if (SYM_SETUP_SCSI_PARITY)
2674 np->rv_scntl0 |= 0x0a; /* full arb., ena parity, par->ATN */
2677 * Get parity checking, host ID and verbose mode from NVRAM
2680 sym_nvram_setup_host (np, nvram);
2682 np->myaddr = OF_getscsinitid(np->device);
2686 * Get SCSI addr of host adapter (set by bios?).
2688 if (np->myaddr == 255) {
2689 np->myaddr = INB(nc_scid) & 0x07;
2691 np->myaddr = SYM_SETUP_HOST_ID;
2695 * Prepare initial io register bits for burst length
2697 sym_init_burst(np, burst_max);
2700 * Set SCSI BUS mode.
2701 * - LVD capable chips (895/895A/896/1010) report the
2702 * current BUS mode through the STEST4 IO register.
2703 * - For previous generation chips (825/825A/875),
2704 * user has to tell us how to check against HVD,
2705 * since a 100% safe algorithm is not possible.
2707 np->scsi_mode = SMODE_SE;
2708 if (np->features & (FE_ULTRA2|FE_ULTRA3))
2709 np->scsi_mode = (np->sv_stest4 & SMODE);
2710 else if (np->features & FE_DIFF) {
2711 if (SYM_SETUP_SCSI_DIFF == 1) {
2712 if (np->sv_scntl3) {
2713 if (np->sv_stest2 & 0x20)
2714 np->scsi_mode = SMODE_HVD;
2716 else if (nvram->type == SYM_SYMBIOS_NVRAM) {
2717 if (!(INB(nc_gpreg) & 0x08))
2718 np->scsi_mode = SMODE_HVD;
2721 else if (SYM_SETUP_SCSI_DIFF == 2)
2722 np->scsi_mode = SMODE_HVD;
2724 if (np->scsi_mode == SMODE_HVD)
2725 np->rv_stest2 |= 0x20;
2728 * Set LED support from SCRIPTS.
2729 * Ignore this feature for boards known to use a
2730 * specific GPIO wiring and for the 895A, 896
2731 * and 1010 that drive the LED directly.
2733 if ((SYM_SETUP_SCSI_LED ||
2734 (nvram->type == SYM_SYMBIOS_NVRAM ||
2735 (nvram->type == SYM_TEKRAM_NVRAM &&
2736 np->device_id == PCI_ID_SYM53C895))) &&
2737 !(np->features & FE_LEDC) && !(np->sv_gpcntl & 0x01))
2738 np->features |= FE_LED0;
2743 switch(SYM_SETUP_IRQ_MODE & 3) {
2745 np->rv_dcntl |= IRQM;
2748 np->rv_dcntl |= (np->sv_dcntl & IRQM);
2755 * Configure targets according to driver setup.
2756 * If NVRAM present get targets setup from NVRAM.
2758 for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
2759 tcb_p tp = &np->target[i];
2761 tp->tinfo.user.scsi_version = tp->tinfo.current.scsi_version= 2;
2762 tp->tinfo.user.spi_version = tp->tinfo.current.spi_version = 2;
2763 tp->tinfo.user.period = np->minsync;
2764 if (np->features & FE_ULTRA3)
2765 tp->tinfo.user.period = np->minsync_dt;
2766 tp->tinfo.user.offset = np->maxoffs;
2767 tp->tinfo.user.width = np->maxwide ? BUS_16_BIT : BUS_8_BIT;
2768 tp->usrflags |= (SYM_DISC_ENABLED | SYM_TAGS_ENABLED);
2769 tp->usrtags = SYM_SETUP_MAX_TAG;
2771 sym_nvram_setup_target (np, i, nvram);
2774 * For now, guess PPR/DT support from the period
2777 if (np->features & FE_ULTRA3) {
2778 if (tp->tinfo.user.period <= 9 &&
2779 tp->tinfo.user.width == BUS_16_BIT) {
2780 tp->tinfo.user.options |= PPR_OPT_DT;
2781 tp->tinfo.user.offset = np->maxoffs_dt;
2782 tp->tinfo.user.spi_version = 3;
2787 tp->usrflags &= ~SYM_TAGS_ENABLED;
2791 * Let user know about the settings.
2794 kprintf("%s: %s NVRAM, ID %d, Fast-%d, %s, %s\n", sym_name(np),
2795 i == SYM_SYMBIOS_NVRAM ? "Symbios" :
2796 (i == SYM_TEKRAM_NVRAM ? "Tekram" : "No"),
2798 (np->features & FE_ULTRA3) ? 80 :
2799 (np->features & FE_ULTRA2) ? 40 :
2800 (np->features & FE_ULTRA) ? 20 : 10,
2801 sym_scsi_bus_mode(np->scsi_mode),
2802 (np->rv_scntl0 & 0xa) ? "parity checking" : "NO parity");
2804 * Tell him more on demand.
2807 kprintf("%s: %s IRQ line driver%s\n",
2809 np->rv_dcntl & IRQM ? "totem pole" : "open drain",
2810 np->ram_ba ? ", using on-chip SRAM" : "");
2811 kprintf("%s: using %s firmware.\n", sym_name(np), np->fw_name);
2812 if (np->features & FE_NOPM)
2813 kprintf("%s: handling phase mismatch from SCRIPTS.\n",
2819 if (sym_verbose > 1) {
2820 kprintf ("%s: initial SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
2821 "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
2822 sym_name(np), np->sv_scntl3, np->sv_dmode, np->sv_dcntl,
2823 np->sv_ctest3, np->sv_ctest4, np->sv_ctest5);
2825 kprintf ("%s: final SCNTL3/DMODE/DCNTL/CTEST3/4/5 = "
2826 "(hex) %02x/%02x/%02x/%02x/%02x/%02x\n",
2827 sym_name(np), np->rv_scntl3, np->rv_dmode, np->rv_dcntl,
2828 np->rv_ctest3, np->rv_ctest4, np->rv_ctest5);
2831 * Let user be aware of targets that have some disable flags set.
2833 sym_print_targets_flag(np, SYM_SCAN_BOOT_DISABLED, "SCAN AT BOOT");
2835 sym_print_targets_flag(np, SYM_SCAN_LUNS_DISABLED,
2842 * Prepare the next negotiation message if needed.
2844 * Fill in the part of message buffer that contains the
2845 * negotiation and the nego_status field of the CCB.
2846 * Returns the size of the message in bytes.
2849 static int sym_prepare_nego(hcb_p np, ccb_p cp, int nego, u_char *msgptr)
2851 tcb_p tp = &np->target[cp->target];
2855 * Early C1010 chips need a work-around for DT
2856 * data transfer to work.
2858 if (!(np->features & FE_U3EN))
2859 tp->tinfo.goal.options = 0;
2861 * negotiate using PPR ?
2863 if (tp->tinfo.goal.options & PPR_OPT_MASK)
2866 * negotiate wide transfers ?
2868 else if (tp->tinfo.current.width != tp->tinfo.goal.width)
2871 * negotiate synchronous transfers?
2873 else if (tp->tinfo.current.period != tp->tinfo.goal.period ||
2874 tp->tinfo.current.offset != tp->tinfo.goal.offset)
2879 msgptr[msglen++] = M_EXTENDED;
2880 msgptr[msglen++] = 3;
2881 msgptr[msglen++] = M_X_SYNC_REQ;
2882 msgptr[msglen++] = tp->tinfo.goal.period;
2883 msgptr[msglen++] = tp->tinfo.goal.offset;
2886 msgptr[msglen++] = M_EXTENDED;
2887 msgptr[msglen++] = 2;
2888 msgptr[msglen++] = M_X_WIDE_REQ;
2889 msgptr[msglen++] = tp->tinfo.goal.width;
2892 msgptr[msglen++] = M_EXTENDED;
2893 msgptr[msglen++] = 6;
2894 msgptr[msglen++] = M_X_PPR_REQ;
2895 msgptr[msglen++] = tp->tinfo.goal.period;
2896 msgptr[msglen++] = 0;
2897 msgptr[msglen++] = tp->tinfo.goal.offset;
2898 msgptr[msglen++] = tp->tinfo.goal.width;
2899 msgptr[msglen++] = tp->tinfo.goal.options & PPR_OPT_DT;
2903 cp->nego_status = nego;
2906 tp->nego_cp = cp; /* Keep track a nego will be performed */
2907 if (DEBUG_FLAGS & DEBUG_NEGO) {
2908 sym_print_msg(cp, nego == NS_SYNC ? "sync msgout" :
2909 nego == NS_WIDE ? "wide msgout" :
2910 "ppr msgout", msgptr);
2918 * Insert a job into the start queue.
2920 static void sym_put_start_queue(hcb_p np, ccb_p cp)
2924 #ifdef SYM_CONF_IARB_SUPPORT
2926 * If the previously queued CCB is not yet done,
2927 * set the IARB hint. The SCRIPTS will go with IARB
2928 * for this job when starting the previous one.
2929 * We leave devices a chance to win arbitration by
2930 * not using more than 'iarb_max' consecutive
2931 * immediate arbitrations.
2933 if (np->last_cp && np->iarb_count < np->iarb_max) {
2934 np->last_cp->host_flags |= HF_HINT_IARB;
2943 * Insert first the idle task and then our job.
2944 * The MB should ensure proper ordering.
2946 qidx = np->squeueput + 2;
2947 if (qidx >= MAX_QUEUE*2) qidx = 0;
2949 np->squeue [qidx] = cpu_to_scr(np->idletask_ba);
2951 np->squeue [np->squeueput] = cpu_to_scr(cp->ccb_ba);
2953 np->squeueput = qidx;
2955 if (DEBUG_FLAGS & DEBUG_QUEUE)
2956 kprintf ("%s: queuepos=%d.\n", sym_name (np), np->squeueput);
2959 * Script processor may be waiting for reselect.
2963 OUTB (nc_istat, SIGP|np->istat_sem);
2968 * Soft reset the chip.
2970 * Raising SRST when the chip is running may cause
2971 * problems on dual function chips (see below).
2972 * On the other hand, LVD devices need some delay
2973 * to settle and report actual BUS mode in STEST4.
2975 static void sym_chip_reset (hcb_p np)
2977 OUTB (nc_istat, SRST);
2980 UDELAY(2000); /* For BUS MODE to settle */
2984 * Soft reset the chip.
2986 * Some 896 and 876 chip revisions may hang-up if we set
2987 * the SRST (soft reset) bit at the wrong time when SCRIPTS
2989 * So, we need to abort the current operation prior to
2990 * soft resetting the chip.
2992 static void sym_soft_reset (hcb_p np)
2997 OUTB (nc_istat, CABRT);
2998 for (i = 1000000 ; i ; --i) {
2999 istat = INB (nc_istat);
3011 kprintf("%s: unable to abort current chip operation.\n",
3013 sym_chip_reset (np);
3017 * Start reset process.
3019 * The interrupt handler will reinitialize the chip.
3021 static void sym_start_reset(hcb_p np)
3023 (void) sym_reset_scsi_bus(np, 1);
3026 static int sym_reset_scsi_bus(hcb_p np, int enab_int)
3031 sym_soft_reset(np); /* Soft reset the chip */
3033 OUTW (nc_sien, RST);
3035 * Enable Tolerant, reset IRQD if present and
3036 * properly set IRQ mode, prior to resetting the bus.
3038 OUTB (nc_stest3, TE);
3039 OUTB (nc_dcntl, (np->rv_dcntl & IRQM));
3040 OUTB (nc_scntl1, CRST);
3043 if (!SYM_SETUP_SCSI_BUS_CHECK)
3046 * Check for no terminators or SCSI bus shorts to ground.
3047 * Read SCSI data bus, data parity bits and control signals.
3048 * We are expecting RESET to be TRUE and other signals to be
3051 term = INB(nc_sstat0);
3052 term = ((term & 2) << 7) + ((term & 1) << 17); /* rst sdp0 */
3053 term |= ((INB(nc_sstat2) & 0x01) << 26) | /* sdp1 */
3054 ((INW(nc_sbdl) & 0xff) << 9) | /* d7-0 */
3055 ((INW(nc_sbdl) & 0xff00) << 10) | /* d15-8 */
3056 INB(nc_sbcl); /* req ack bsy sel atn msg cd io */
3058 if (!(np->features & FE_WIDE))
3061 if (term != (2<<7)) {
3062 kprintf("%s: suspicious SCSI data while resetting the BUS.\n",
3064 kprintf("%s: %sdp0,d7-0,rst,req,ack,bsy,sel,atn,msg,c/d,i/o = "
3065 "0x%lx, expecting 0x%lx\n",
3067 (np->features & FE_WIDE) ? "dp1,d15-8," : "",
3068 (u_long)term, (u_long)(2<<7));
3069 if (SYM_SETUP_SCSI_BUS_CHECK == 1)
3073 OUTB (nc_scntl1, 0);
3079 * The chip may have completed jobs. Look at the DONE QUEUE.
3081 * On architectures that may reorder LOAD/STORE operations,
3082 * a memory barrier may be needed after the reading of the
3083 * so-called `flag' and prior to dealing with the data.
3085 static int sym_wakeup_done (hcb_p np)
3091 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3096 dsa = scr_to_cpu(np->dqueue[i]);
3100 if ((i = i+2) >= MAX_QUEUE*2)
3103 cp = sym_ccb_from_dsa(np, dsa);
3106 sym_complete_ok (np, cp);
3110 kprintf ("%s: bad DSA (%x) in done queue.\n",
3111 sym_name(np), (u_int) dsa);
3119 * Complete all active CCBs with error.
3120 * Used on CHIP/SCSI RESET.
3122 static void sym_flush_busy_queue (hcb_p np, int cam_status)
3125 * Move all active CCBs to the COMP queue
3126 * and flush this queue.
3128 sym_que_splice(&np->busy_ccbq, &np->comp_ccbq);
3129 sym_que_init(&np->busy_ccbq);
3130 sym_flush_comp_queue(np, cam_status);
3137 * 0: initialisation.
3138 * 1: SCSI BUS RESET delivered or received.
3139 * 2: SCSI BUS MODE changed.
3141 static void sym_init (hcb_p np, int reason)
3146 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3149 * Reset chip if asked, otherwise just clear fifos.
3154 OUTB (nc_stest3, TE|CSF);
3155 OUTONB (nc_ctest3, CLF);
3161 phys = np->squeue_ba;
3162 for (i = 0; i < MAX_QUEUE*2; i += 2) {
3163 np->squeue[i] = cpu_to_scr(np->idletask_ba);
3164 np->squeue[i+1] = cpu_to_scr(phys + (i+2)*4);
3166 np->squeue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3169 * Start at first entry.
3176 phys = np->dqueue_ba;
3177 for (i = 0; i < MAX_QUEUE*2; i += 2) {
3179 np->dqueue[i+1] = cpu_to_scr(phys + (i+2)*4);
3181 np->dqueue[MAX_QUEUE*2-1] = cpu_to_scr(phys);
3184 * Start at first entry.
3189 * Install patches in scripts.
3190 * This also let point to first position the start
3191 * and done queue pointers used from SCRIPTS.
3196 * Wakeup all pending jobs.
3198 sym_flush_busy_queue(np, CAM_SCSI_BUS_RESET);
3203 OUTB (nc_istat, 0x00 ); /* Remove Reset, abort */
3204 UDELAY (2000); /* The 895 needs time for the bus mode to settle */
3206 OUTB (nc_scntl0, np->rv_scntl0 | 0xc0);
3207 /* full arb., ena parity, par->ATN */
3208 OUTB (nc_scntl1, 0x00); /* odd parity, and remove CRST!! */
3210 sym_selectclock(np, np->rv_scntl3); /* Select SCSI clock */
3212 OUTB (nc_scid , RRE|np->myaddr); /* Adapter SCSI address */
3213 OUTW (nc_respid, 1ul<<np->myaddr); /* Id to respond to */
3214 OUTB (nc_istat , SIGP ); /* Signal Process */
3215 OUTB (nc_dmode , np->rv_dmode); /* Burst length, dma mode */
3216 OUTB (nc_ctest5, np->rv_ctest5); /* Large fifo + large burst */
3218 OUTB (nc_dcntl , NOCOM|np->rv_dcntl); /* Protect SFBR */
3219 OUTB (nc_ctest3, np->rv_ctest3); /* Write and invalidate */
3220 OUTB (nc_ctest4, np->rv_ctest4); /* Master parity checking */
3222 /* Extended Sreq/Sack filtering not supported on the C10 */
3223 if (np->features & FE_C10)
3224 OUTB (nc_stest2, np->rv_stest2);
3226 OUTB (nc_stest2, EXT|np->rv_stest2);
3228 OUTB (nc_stest3, TE); /* TolerANT enable */
3229 OUTB (nc_stime0, 0x0c); /* HTH disabled STO 0.25 sec */
3232 * For now, disable AIP generation on C1010-66.
3234 if (np->device_id == PCI_ID_LSI53C1010_2)
3235 OUTB (nc_aipcntl1, DISAIP);
3239 * Errant SGE's when in narrow. Write bits 4 & 5 of
3240 * STEST1 register to disable SGE. We probably should do
3241 * that from SCRIPTS for each selection/reselection, but
3242 * I just don't want. :)
3244 if (np->device_id == PCI_ID_LSI53C1010 &&
3245 /* np->revision_id < 0xff */ 1)
3246 OUTB (nc_stest1, INB(nc_stest1) | 0x30);
3249 * DEL 441 - 53C876 Rev 5 - Part Number 609-0392787/2788 - ITEM 2.
3250 * Disable overlapped arbitration for some dual function devices,
3251 * regardless revision id (kind of post-chip-design feature. ;-))
3253 if (np->device_id == PCI_ID_SYM53C875)
3254 OUTB (nc_ctest0, (1<<5));
3255 else if (np->device_id == PCI_ID_SYM53C896)
3256 np->rv_ccntl0 |= DPR;
3259 * Write CCNTL0/CCNTL1 for chips capable of 64 bit addressing
3260 * and/or hardware phase mismatch, since only such chips
3261 * seem to support those IO registers.
3263 if (np->features & (FE_DAC|FE_NOPM)) {
3264 OUTB (nc_ccntl0, np->rv_ccntl0);
3265 OUTB (nc_ccntl1, np->rv_ccntl1);
3269 * If phase mismatch handled by scripts (895A/896/1010),
3270 * set PM jump addresses.
3272 if (np->features & FE_NOPM) {
3273 OUTL (nc_pmjad1, SCRIPTB_BA (np, pm_handle));
3274 OUTL (nc_pmjad2, SCRIPTB_BA (np, pm_handle));
3278 * Enable GPIO0 pin for writing if LED support from SCRIPTS.
3279 * Also set GPIO5 and clear GPIO6 if hardware LED control.
3281 if (np->features & FE_LED0)
3282 OUTB(nc_gpcntl, INB(nc_gpcntl) & ~0x01);
3283 else if (np->features & FE_LEDC)
3284 OUTB(nc_gpcntl, (INB(nc_gpcntl) & ~0x41) | 0x20);
3289 OUTW (nc_sien , STO|HTH|MA|SGE|UDC|RST|PAR);
3290 OUTB (nc_dien , MDPE|BF|SSI|SIR|IID);
3293 * For 895/6 enable SBMC interrupt and save current SCSI bus mode.
3294 * Try to eat the spurious SBMC interrupt that may occur when
3295 * we reset the chip but not the SCSI BUS (at initialization).
3297 if (np->features & (FE_ULTRA2|FE_ULTRA3)) {
3298 OUTONW (nc_sien, SBMC);
3303 np->scsi_mode = INB (nc_stest4) & SMODE;
3307 * Fill in target structure.
3308 * Reinitialize usrsync.
3309 * Reinitialize usrwide.
3310 * Prepare sync negotiation according to actual SCSI bus mode.
3312 for (i=0;i<SYM_CONF_MAX_TARGET;i++) {
3313 tcb_p tp = &np->target[i];
3317 tp->head.wval = np->rv_scntl3;
3320 tp->tinfo.current.period = 0;
3321 tp->tinfo.current.offset = 0;
3322 tp->tinfo.current.width = BUS_8_BIT;
3323 tp->tinfo.current.options = 0;
3327 * Download SCSI SCRIPTS to on-chip RAM if present,
3328 * and start script processor.
3331 if (sym_verbose > 1)
3332 kprintf ("%s: Downloading SCSI SCRIPTS.\n",
3334 if (np->ram_ws == 8192) {
3335 OUTRAM_OFF(4096, np->scriptb0, np->scriptb_sz);
3336 OUTL (nc_mmws, np->scr_ram_seg);
3337 OUTL (nc_mmrs, np->scr_ram_seg);
3338 OUTL (nc_sfs, np->scr_ram_seg);
3339 phys = SCRIPTB_BA (np, start64);
3342 phys = SCRIPTA_BA (np, init);
3343 OUTRAM_OFF(0, np->scripta0, np->scripta_sz);
3346 phys = SCRIPTA_BA (np, init);
3350 OUTL (nc_dsa, np->hcb_ba);
3354 * Notify the XPT about the RESET condition.
3357 xpt_async(AC_BUS_RESET, np->path, NULL);
3361 * Get clock factor and sync divisor for a given
3362 * synchronous factor period.
3365 sym_getsync(hcb_p np, u_char dt, u_char sfac, u_char *divp, u_char *fakp)
3367 u32 clk = np->clock_khz; /* SCSI clock frequency in kHz */
3368 int div = np->clock_divn; /* Number of divisors supported */
3369 u32 fak; /* Sync factor in sxfer */
3370 u32 per; /* Period in tenths of ns */
3371 u32 kpc; /* (per * clk) */
3375 * Compute the synchronous period in tenths of nano-seconds
3377 if (dt && sfac <= 9) per = 125;
3378 else if (sfac <= 10) per = 250;
3379 else if (sfac == 11) per = 303;
3380 else if (sfac == 12) per = 500;
3381 else per = 40 * sfac;
3389 * For earliest C10 revision 0, we cannot use extra
3390 * clocks for the setting of the SCSI clocking.
3391 * Note that this limits the lowest sync data transfer
3392 * to 5 Mega-transfers per second and may result in
3393 * using higher clock divisors.
3396 if ((np->features & (FE_C10|FE_U3EN)) == FE_C10) {
3398 * Look for the lowest clock divisor that allows an
3399 * output speed not faster than the period.
3403 if (kpc > (div_10M[div] << 2)) {
3408 fak = 0; /* No extra clocks */
3409 if (div == np->clock_divn) { /* Are we too fast ? */
3419 * Look for the greatest clock divisor that allows an
3420 * input speed faster than the period.
3423 if (kpc >= (div_10M[div] << 2)) break;
3426 * Calculate the lowest clock factor that allows an output
3427 * speed not faster than the period, and the max output speed.
3428 * If fak >= 1 we will set both XCLKH_ST and XCLKH_DT.
3429 * If fak >= 2 we will also set XCLKS_ST and XCLKS_DT.
3432 fak = (kpc - 1) / (div_10M[div] << 1) + 1 - 2;
3433 /* ret = ((2+fak)*div_10M[div])/np->clock_khz; */
3436 fak = (kpc - 1) / div_10M[div] + 1 - 4;
3437 /* ret = ((4+fak)*div_10M[div])/np->clock_khz; */
3441 * Check against our hardware limits, or bugs :).
3443 if (fak < 0) {fak = 0; ret = -1;}
3444 if (fak > 2) {fak = 2; ret = -1;}
3447 * Compute and return sync parameters.
3456 * Tell the SCSI layer about the new transfer parameters.
3459 sym_xpt_async_transfer_neg(hcb_p np, int target, u_int spi_valid)
3461 struct ccb_trans_settings cts;
3462 struct cam_path *path;
3464 tcb_p tp = &np->target[target];
3466 sts = xpt_create_path(&path, NULL, cam_sim_path(np->sim), target,
3468 if (sts != CAM_REQ_CMP)
3471 bzero(&cts, sizeof(cts));
3473 #define cts__scsi (cts.proto_specific.scsi)
3474 #define cts__spi (cts.xport_specific.spi)
3476 cts.type = CTS_TYPE_CURRENT_SETTINGS;
3477 cts.protocol = PROTO_SCSI;
3478 cts.transport = XPORT_SPI;
3479 cts.protocol_version = tp->tinfo.current.scsi_version;
3480 cts.transport_version = tp->tinfo.current.spi_version;
3482 cts__spi.valid = spi_valid;
3483 if (spi_valid & CTS_SPI_VALID_SYNC_RATE)
3484 cts__spi.sync_period = tp->tinfo.current.period;
3485 if (spi_valid & CTS_SPI_VALID_SYNC_OFFSET)
3486 cts__spi.sync_offset = tp->tinfo.current.offset;
3487 if (spi_valid & CTS_SPI_VALID_BUS_WIDTH)
3488 cts__spi.bus_width = tp->tinfo.current.width;
3489 if (spi_valid & CTS_SPI_VALID_PPR_OPTIONS)
3490 cts__spi.ppr_options = tp->tinfo.current.options;
3493 xpt_setup_ccb(&cts.ccb_h, path, /*priority*/1);
3494 xpt_async(AC_TRANSFER_NEG, path, &cts);
3495 xpt_free_path(path);
3498 #define SYM_SPI_VALID_WDTR \
3499 CTS_SPI_VALID_BUS_WIDTH | \
3500 CTS_SPI_VALID_SYNC_RATE | \
3501 CTS_SPI_VALID_SYNC_OFFSET
3502 #define SYM_SPI_VALID_SDTR \
3503 CTS_SPI_VALID_SYNC_RATE | \
3504 CTS_SPI_VALID_SYNC_OFFSET
3505 #define SYM_SPI_VALID_PPR \
3506 CTS_SPI_VALID_PPR_OPTIONS | \
3507 CTS_SPI_VALID_BUS_WIDTH | \
3508 CTS_SPI_VALID_SYNC_RATE | \
3509 CTS_SPI_VALID_SYNC_OFFSET
3512 * We received a WDTR.
3513 * Let everything be aware of the changes.
3515 static void sym_setwide(hcb_p np, ccb_p cp, u_char wide)
3517 tcb_p tp = &np->target[cp->target];
3519 sym_settrans(np, cp, 0, 0, 0, wide, 0, 0);
3522 * Tell the SCSI layer about the new transfer parameters.
3524 tp->tinfo.goal.width = tp->tinfo.current.width = wide;
3525 tp->tinfo.current.offset = 0;
3526 tp->tinfo.current.period = 0;
3527 tp->tinfo.current.options = 0;
3529 sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_WDTR);
3533 * We received a SDTR.
3534 * Let everything be aware of the changes.
3537 sym_setsync(hcb_p np, ccb_p cp, u_char ofs, u_char per, u_char div, u_char fak)
3539 tcb_p tp = &np->target[cp->target];
3540 u_char wide = (cp->phys.select.sel_scntl3 & EWS) ? 1 : 0;
3542 sym_settrans(np, cp, 0, ofs, per, wide, div, fak);
3545 * Tell the SCSI layer about the new transfer parameters.
3547 tp->tinfo.goal.period = tp->tinfo.current.period = per;
3548 tp->tinfo.goal.offset = tp->tinfo.current.offset = ofs;
3549 tp->tinfo.goal.options = tp->tinfo.current.options = 0;
3551 sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_SDTR);
3555 * We received a PPR.
3556 * Let everything be aware of the changes.
3558 static void sym_setpprot(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3559 u_char per, u_char wide, u_char div, u_char fak)
3561 tcb_p tp = &np->target[cp->target];
3563 sym_settrans(np, cp, dt, ofs, per, wide, div, fak);
3566 * Tell the SCSI layer about the new transfer parameters.
3568 tp->tinfo.goal.width = tp->tinfo.current.width = wide;
3569 tp->tinfo.goal.period = tp->tinfo.current.period = per;
3570 tp->tinfo.goal.offset = tp->tinfo.current.offset = ofs;
3571 tp->tinfo.goal.options = tp->tinfo.current.options = dt;
3573 sym_xpt_async_transfer_neg(np, cp->target, SYM_SPI_VALID_PPR);
3577 * Switch trans mode for current job and it's target.
3579 static void sym_settrans(hcb_p np, ccb_p cp, u_char dt, u_char ofs,
3580 u_char per, u_char wide, u_char div, u_char fak)
3585 u_char target = INB (nc_sdid) & 0x0f;
3586 u_char sval, wval, uval;
3593 assert (target == (cp->target & 0xf));
3594 tp = &np->target[target];
3596 sval = tp->head.sval;
3597 wval = tp->head.wval;
3598 uval = tp->head.uval;
3601 kprintf("XXXX sval=%x wval=%x uval=%x (%x)\n",
3602 sval, wval, uval, np->rv_scntl3);
3607 if (!(np->features & FE_C10))
3608 sval = (sval & ~0x1f) | ofs;
3610 sval = (sval & ~0x3f) | ofs;
3613 * Set the sync divisor and extra clock factor.
3616 wval = (wval & ~0x70) | ((div+1) << 4);
3617 if (!(np->features & FE_C10))
3618 sval = (sval & ~0xe0) | (fak << 5);
3620 uval = uval & ~(XCLKH_ST|XCLKH_DT|XCLKS_ST|XCLKS_DT);
3621 if (fak >= 1) uval |= (XCLKH_ST|XCLKH_DT);
3622 if (fak >= 2) uval |= (XCLKS_ST|XCLKS_DT);
3627 * Set the bus width.
3634 * Set misc. ultra enable bits.
3636 if (np->features & FE_C10) {
3637 uval = uval & ~(U3EN|AIPCKEN);
3639 assert(np->features & FE_U3EN);
3644 wval = wval & ~ULTRA;
3645 if (per <= 12) wval |= ULTRA;
3649 * Stop there if sync parameters are unchanged.
3651 if (tp->head.sval == sval &&
3652 tp->head.wval == wval &&
3653 tp->head.uval == uval)
3655 tp->head.sval = sval;
3656 tp->head.wval = wval;
3657 tp->head.uval = uval;
3660 * Disable extended Sreq/Sack filtering if per < 50.
3661 * Not supported on the C1010.
3663 if (per < 50 && !(np->features & FE_C10))
3664 OUTOFFB (nc_stest2, EXT);
3667 * set actual value and sync_status
3669 OUTB (nc_sxfer, tp->head.sval);
3670 OUTB (nc_scntl3, tp->head.wval);
3672 if (np->features & FE_C10) {
3673 OUTB (nc_scntl4, tp->head.uval);
3677 * patch ALL busy ccbs of this target.
3679 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
3680 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
3681 if (cp->target != target)
3683 cp->phys.select.sel_scntl3 = tp->head.wval;
3684 cp->phys.select.sel_sxfer = tp->head.sval;
3685 if (np->features & FE_C10) {
3686 cp->phys.select.sel_scntl4 = tp->head.uval;
3692 * log message for real hard errors
3694 * sym0 targ 0?: ERROR (ds:si) (so-si-sd) (sxfer/scntl3) @ name (dsp:dbc).
3695 * reg: r0 r1 r2 r3 r4 r5 r6 ..... rf.
3697 * exception register:
3702 * so: control lines as driven by chip.
3703 * si: control lines as seen by chip.
3704 * sd: scsi data lines as seen by chip.
3707 * sxfer: (see the manual)
3708 * scntl3: (see the manual)
3710 * current script command:
3711 * dsp: script address (relative to start of script).
3712 * dbc: first word of script command.
3714 * First 24 register of the chip:
3717 static void sym_log_hard_error(hcb_p np, u_short sist, u_char dstat)
3723 u_char *script_base;
3728 if (dsp > np->scripta_ba &&
3729 dsp <= np->scripta_ba + np->scripta_sz) {
3730 script_ofs = dsp - np->scripta_ba;
3731 script_size = np->scripta_sz;
3732 script_base = np->scripta0;
3733 script_name = "scripta";
3735 else if (np->scriptb_ba < dsp &&
3736 dsp <= np->scriptb_ba + np->scriptb_sz) {
3737 script_ofs = dsp - np->scriptb_ba;
3738 script_size = np->scriptb_sz;
3739 script_base = np->scriptb0;
3740 script_name = "scriptb";
3745 script_name = "mem";
3748 kprintf ("%s:%d: ERROR (%x:%x) (%x-%x-%x) (%x/%x) @ (%s %x:%08x).\n",
3749 sym_name (np), (unsigned)INB (nc_sdid)&0x0f, dstat, sist,
3750 (unsigned)INB (nc_socl), (unsigned)INB (nc_sbcl),
3751 (unsigned)INB (nc_sbdl), (unsigned)INB (nc_sxfer),
3752 (unsigned)INB (nc_scntl3), script_name, script_ofs,
3753 (unsigned)INL (nc_dbc));
3755 if (((script_ofs & 3) == 0) &&
3756 (unsigned)script_ofs < script_size) {
3757 kprintf ("%s: script cmd = %08x\n", sym_name(np),
3758 scr_to_cpu((int) *(u32 *)(script_base + script_ofs)));
3761 kprintf ("%s: regdump:", sym_name(np));
3763 kprintf (" %02x", (unsigned)INB_OFF(i));
3767 * PCI BUS error, read the PCI ststus register.
3769 if (dstat & (MDPE|BF)) {
3771 pci_sts = pci_read_config(np->device, PCIR_STATUS, 2);
3772 if (pci_sts & 0xf900) {
3773 pci_write_config(np->device, PCIR_STATUS, pci_sts, 2);
3774 kprintf("%s: PCI STATUS = 0x%04x\n",
3775 sym_name(np), pci_sts & 0xf900);
3781 * chip interrupt handler
3783 * In normal situations, interrupt conditions occur one at
3784 * a time. But when something bad happens on the SCSI BUS,
3785 * the chip may raise several interrupt flags before
3786 * stopping and interrupting the CPU. The additionnal
3787 * interrupt flags are stacked in some extra registers
3788 * after the SIP and/or DIP flag has been raised in the
3789 * ISTAT. After the CPU has read the interrupt condition
3790 * flag from SIST or DSTAT, the chip unstacks the other
3791 * interrupt flags and sets the corresponding bits in
3792 * SIST or DSTAT. Since the chip starts stacking once the
3793 * SIP or DIP flag is set, there is a small window of time
3794 * where the stacking does not occur.
3796 * Typically, multiple interrupt conditions may happen in
3797 * the following situations:
3799 * - SCSI parity error + Phase mismatch (PAR|MA)
3800 * When a parity error is detected in input phase
3801 * and the device switches to msg-in phase inside a
3803 * - SCSI parity error + Unexpected disconnect (PAR|UDC)
3804 * When a stupid device does not want to handle the
3805 * recovery of an SCSI parity error.
3806 * - Some combinations of STO, PAR, UDC, ...
3807 * When using non compliant SCSI stuff, when user is
3808 * doing non compliant hot tampering on the BUS, when
3809 * something really bad happens to a device, etc ...
3811 * The heuristic suggested by SYMBIOS to handle
3812 * multiple interrupts is to try unstacking all
3813 * interrupts conditions and to handle them on some
3814 * priority based on error severity.
3815 * This will work when the unstacking has been
3816 * successful, but we cannot be 100 % sure of that,
3817 * since the CPU may have been faster to unstack than
3818 * the chip is able to stack. Hmmm ... But it seems that
3819 * such a situation is very unlikely to happen.
3821 * If this happen, for example STO caught by the CPU
3822 * then UDC happenning before the CPU have restarted
3823 * the SCRIPTS, the driver may wrongly complete the
3824 * same command on UDC, since the SCRIPTS didn't restart
3825 * and the DSA still points to the same command.
3826 * We avoid this situation by setting the DSA to an
3827 * invalid value when the CCB is completed and before
3828 * restarting the SCRIPTS.
3830 * Another issue is that we need some section of our
3831 * recovery procedures to be somehow uninterruptible but
3832 * the SCRIPTS processor does not provides such a
3833 * feature. For this reason, we handle recovery preferently
3834 * from the C code and check against some SCRIPTS critical
3835 * sections from the C code.
3837 * Hopefully, the interrupt handling of the driver is now
3838 * able to resist to weird BUS error conditions, but donnot
3839 * ask me for any guarantee that it will never fail. :-)
3840 * Use at your own decision and risk.
3843 static void sym_intr1 (hcb_p np)
3845 u_char istat, istatc;
3849 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
3852 * interrupt on the fly ?
3854 * A `dummy read' is needed to ensure that the
3855 * clear of the INTF flag reaches the device
3856 * before the scanning of the DONE queue.
3858 istat = INB (nc_istat);
3860 OUTB (nc_istat, (istat & SIGP) | INTF | np->istat_sem);
3861 istat = INB (nc_istat); /* DUMMY READ */
3862 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("F ");
3863 (void)sym_wakeup_done (np);
3866 if (!(istat & (SIP|DIP)))
3869 #if 0 /* We should never get this one */
3871 OUTB (nc_istat, CABRT);
3875 * PAR and MA interrupts may occur at the same time,
3876 * and we need to know of both in order to handle
3877 * this situation properly. We try to unstack SCSI
3878 * interrupts for that reason. BTW, I dislike a LOT
3879 * such a loop inside the interrupt routine.
3880 * Even if DMA interrupt stacking is very unlikely to
3881 * happen, we also try unstacking these ones, since
3882 * this has no performance impact.
3889 sist |= INW (nc_sist);
3891 dstat |= INB (nc_dstat);
3892 istatc = INB (nc_istat);
3894 } while (istatc & (SIP|DIP));
3896 if (DEBUG_FLAGS & DEBUG_TINY)
3897 kprintf ("<%d|%x:%x|%x:%x>",
3900 (unsigned)INL(nc_dsp),
3901 (unsigned)INL(nc_dbc));
3903 * On paper, a memory barrier may be needed here.
3904 * And since we are paranoid ... :)
3909 * First, interrupts we want to service cleanly.
3911 * Phase mismatch (MA) is the most frequent interrupt
3912 * for chip earlier than the 896 and so we have to service
3913 * it as quickly as possible.
3914 * A SCSI parity error (PAR) may be combined with a phase
3915 * mismatch condition (MA).
3916 * Programmed interrupts (SIR) are used to call the C code
3918 * The single step interrupt (SSI) is not used in this
3921 if (!(sist & (STO|GEN|HTH|SGE|UDC|SBMC|RST)) &&
3922 !(dstat & (MDPE|BF|ABRT|IID))) {
3923 if (sist & PAR) sym_int_par (np, sist);
3924 else if (sist & MA) sym_int_ma (np);
3925 else if (dstat & SIR) sym_int_sir (np);
3926 else if (dstat & SSI) OUTONB_STD ();
3927 else goto unknown_int;
3932 * Now, interrupts that donnot happen in normal
3933 * situations and that we may need to recover from.
3935 * On SCSI RESET (RST), we reset everything.
3936 * On SCSI BUS MODE CHANGE (SBMC), we complete all
3937 * active CCBs with RESET status, prepare all devices
3938 * for negotiating again and restart the SCRIPTS.
3939 * On STO and UDC, we complete the CCB with the corres-
3940 * ponding status and restart the SCRIPTS.
3943 xpt_print_path(np->path);
3944 kprintf("SCSI BUS reset detected.\n");
3949 OUTB (nc_ctest3, np->rv_ctest3 | CLF); /* clear dma fifo */
3950 OUTB (nc_stest3, TE|CSF); /* clear scsi fifo */
3952 if (!(sist & (GEN|HTH|SGE)) &&
3953 !(dstat & (MDPE|BF|ABRT|IID))) {
3954 if (sist & SBMC) sym_int_sbmc (np);
3955 else if (sist & STO) sym_int_sto (np);
3956 else if (sist & UDC) sym_int_udc (np);
3957 else goto unknown_int;
3962 * Now, interrupts we are not able to recover cleanly.
3964 * Log message for hard errors.
3968 sym_log_hard_error(np, sist, dstat);
3970 if ((sist & (GEN|HTH|SGE)) ||
3971 (dstat & (MDPE|BF|ABRT|IID))) {
3972 sym_start_reset(np);
3978 * We just miss the cause of the interrupt. :(
3979 * Print a message. The timeout will do the real work.
3981 kprintf( "%s: unknown interrupt(s) ignored, "
3982 "ISTAT=0x%x DSTAT=0x%x SIST=0x%x\n",
3983 sym_name(np), istat, dstat, sist);
3986 static void sym_intr(void *arg)
3992 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("[");
3993 sym_intr1((hcb_p) arg);
3994 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("]");
3999 static void sym_poll(struct cam_sim *sim)
4001 sym_intr1(cam_sim_softc(sim));
4006 * generic recovery from scsi interrupt
4008 * The doc says that when the chip gets an SCSI interrupt,
4009 * it tries to stop in an orderly fashion, by completing
4010 * an instruction fetch that had started or by flushing
4011 * the DMA fifo for a write to memory that was executing.
4012 * Such a fashion is not enough to know if the instruction
4013 * that was just before the current DSP value has been
4016 * There are some small SCRIPTS sections that deal with
4017 * the start queue and the done queue that may break any
4018 * assomption from the C code if we are interrupted
4019 * inside, so we reset if this happens. Btw, since these
4020 * SCRIPTS sections are executed while the SCRIPTS hasn't
4021 * started SCSI operations, it is very unlikely to happen.
4023 * All the driver data structures are supposed to be
4024 * allocated from the same 4 GB memory window, so there
4025 * is a 1 to 1 relationship between DSA and driver data
4026 * structures. Since we are careful :) to invalidate the
4027 * DSA when we complete a command or when the SCRIPTS
4028 * pushes a DSA into a queue, we can trust it when it
4031 static void sym_recover_scsi_int (hcb_p np, u_char hsts)
4033 u32 dsp = INL (nc_dsp);
4034 u32 dsa = INL (nc_dsa);
4035 ccb_p cp = sym_ccb_from_dsa(np, dsa);
4038 * If we haven't been interrupted inside the SCRIPTS
4039 * critical pathes, we can safely restart the SCRIPTS
4040 * and trust the DSA value if it matches a CCB.
4042 if ((!(dsp > SCRIPTA_BA (np, getjob_begin) &&
4043 dsp < SCRIPTA_BA (np, getjob_end) + 1)) &&
4044 (!(dsp > SCRIPTA_BA (np, ungetjob) &&
4045 dsp < SCRIPTA_BA (np, reselect) + 1)) &&
4046 (!(dsp > SCRIPTB_BA (np, sel_for_abort) &&
4047 dsp < SCRIPTB_BA (np, sel_for_abort_1) + 1)) &&
4048 (!(dsp > SCRIPTA_BA (np, done) &&
4049 dsp < SCRIPTA_BA (np, done_end) + 1))) {
4050 OUTB (nc_ctest3, np->rv_ctest3 | CLF); /* clear dma fifo */
4051 OUTB (nc_stest3, TE|CSF); /* clear scsi fifo */
4053 * If we have a CCB, let the SCRIPTS call us back for
4054 * the handling of the error with SCRATCHA filled with
4055 * STARTPOS. This way, we will be able to freeze the
4056 * device queue and requeue awaiting IOs.
4059 cp->host_status = hsts;
4060 OUTL_DSP (SCRIPTA_BA (np, complete_error));
4063 * Otherwise just restart the SCRIPTS.
4066 OUTL (nc_dsa, 0xffffff);
4067 OUTL_DSP (SCRIPTA_BA (np, start));
4076 sym_start_reset(np);
4080 * chip exception handler for selection timeout
4082 static void sym_int_sto (hcb_p np)
4084 u32 dsp = INL (nc_dsp);
4086 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("T");
4088 if (dsp == SCRIPTA_BA (np, wf_sel_done) + 8)
4089 sym_recover_scsi_int(np, HS_SEL_TIMEOUT);
4091 sym_start_reset(np);
4095 * chip exception handler for unexpected disconnect
4097 static void sym_int_udc (hcb_p np)
4099 kprintf ("%s: unexpected disconnect\n", sym_name(np));
4100 sym_recover_scsi_int(np, HS_UNEXPECTED);
4104 * chip exception handler for SCSI bus mode change
4106 * spi2-r12 11.2.3 says a transceiver mode change must
4107 * generate a reset event and a device that detects a reset
4108 * event shall initiate a hard reset. It says also that a
4109 * device that detects a mode change shall set data transfer
4110 * mode to eight bit asynchronous, etc...
4111 * So, just reinitializing all except chip should be enough.
4113 static void sym_int_sbmc (hcb_p np)
4115 u_char scsi_mode = INB (nc_stest4) & SMODE;
4120 xpt_print_path(np->path);
4121 kprintf("SCSI BUS mode change from %s to %s.\n",
4122 sym_scsi_bus_mode(np->scsi_mode), sym_scsi_bus_mode(scsi_mode));
4125 * Should suspend command processing for a few seconds and
4126 * reinitialize all except the chip.
4132 * chip exception handler for SCSI parity error.
4134 * When the chip detects a SCSI parity error and is
4135 * currently executing a (CH)MOV instruction, it does
4136 * not interrupt immediately, but tries to finish the
4137 * transfer of the current scatter entry before
4138 * interrupting. The following situations may occur:
4140 * - The complete scatter entry has been transferred
4141 * without the device having changed phase.
4142 * The chip will then interrupt with the DSP pointing
4143 * to the instruction that follows the MOV.
4145 * - A phase mismatch occurs before the MOV finished
4146 * and phase errors are to be handled by the C code.
4147 * The chip will then interrupt with both PAR and MA
4150 * - A phase mismatch occurs before the MOV finished and
4151 * phase errors are to be handled by SCRIPTS.
4152 * The chip will load the DSP with the phase mismatch
4153 * JUMP address and interrupt the host processor.
4155 static void sym_int_par (hcb_p np, u_short sist)
4157 u_char hsts = INB (HS_PRT);
4158 u32 dsp = INL (nc_dsp);
4159 u32 dbc = INL (nc_dbc);
4160 u32 dsa = INL (nc_dsa);
4161 u_char sbcl = INB (nc_sbcl);
4162 u_char cmd = dbc >> 24;
4163 int phase = cmd & 7;
4164 ccb_p cp = sym_ccb_from_dsa(np, dsa);
4166 kprintf("%s: SCSI parity error detected: SCR1=%d DBC=%x SBCL=%x\n",
4167 sym_name(np), hsts, dbc, sbcl);
4170 * Check that the chip is connected to the SCSI BUS.
4172 if (!(INB (nc_scntl1) & ISCON)) {
4173 sym_recover_scsi_int(np, HS_UNEXPECTED);
4178 * If the nexus is not clearly identified, reset the bus.
4179 * We will try to do better later.
4185 * Check instruction was a MOV, direction was INPUT and
4188 if ((cmd & 0xc0) || !(phase & 1) || !(sbcl & 0x8))
4192 * Keep track of the parity error.
4194 OUTONB (HF_PRT, HF_EXT_ERR);
4195 cp->xerr_status |= XE_PARITY_ERR;
4198 * Prepare the message to send to the device.
4200 np->msgout[0] = (phase == 7) ? M_PARITY : M_ID_ERROR;
4203 * If the old phase was DATA IN phase, we have to deal with
4204 * the 3 situations described above.
4205 * For other input phases (MSG IN and STATUS), the device
4206 * must resend the whole thing that failed parity checking
4207 * or signal error. So, jumping to dispatcher should be OK.
4209 if (phase == 1 || phase == 5) {
4210 /* Phase mismatch handled by SCRIPTS */
4211 if (dsp == SCRIPTB_BA (np, pm_handle))
4213 /* Phase mismatch handled by the C code */
4216 /* No phase mismatch occurred */
4218 OUTL (nc_temp, dsp);
4219 OUTL_DSP (SCRIPTA_BA (np, dispatch));
4223 OUTL_DSP (SCRIPTA_BA (np, clrack));
4227 sym_start_reset(np);
4231 * chip exception handler for phase errors.
4233 * We have to construct a new transfer descriptor,
4234 * to transfer the rest of the current block.
4236 static void sym_int_ma (hcb_p np)
4249 u_char hflags, hflags0;
4258 rest = dbc & 0xffffff;
4262 * locate matching cp if any.
4264 cp = sym_ccb_from_dsa(np, dsa);
4267 * Donnot take into account dma fifo and various buffers in
4268 * INPUT phase since the chip flushes everything before
4269 * raising the MA interrupt for interrupted INPUT phases.
4270 * For DATA IN phase, we will check for the SWIDE later.
4272 if ((cmd & 7) != 1 && (cmd & 7) != 5) {
4275 if (np->features & FE_DFBC)
4276 delta = INW (nc_dfbc);
4281 * Read DFIFO, CTEST[4-6] using 1 PCI bus ownership.
4283 dfifo = INL(nc_dfifo);
4286 * Calculate remaining bytes in DMA fifo.
4287 * (CTEST5 = dfifo >> 16)
4289 if (dfifo & (DFS << 16))
4290 delta = ((((dfifo >> 8) & 0x300) |
4291 (dfifo & 0xff)) - rest) & 0x3ff;
4293 delta = ((dfifo & 0xff) - rest) & 0x7f;
4297 * The data in the dma fifo has not been transferred to
4298 * the target -> add the amount to the rest
4299 * and clear the data.
4300 * Check the sstat2 register in case of wide transfer.
4303 ss0 = INB (nc_sstat0);
4304 if (ss0 & OLF) rest++;
4305 if (!(np->features & FE_C10))
4306 if (ss0 & ORF) rest++;
4307 if (cp && (cp->phys.select.sel_scntl3 & EWS)) {
4308 ss2 = INB (nc_sstat2);
4309 if (ss2 & OLF1) rest++;
4310 if (!(np->features & FE_C10))
4311 if (ss2 & ORF1) rest++;
4317 OUTB (nc_ctest3, np->rv_ctest3 | CLF); /* dma fifo */
4318 OUTB (nc_stest3, TE|CSF); /* scsi fifo */
4322 * log the information
4324 if (DEBUG_FLAGS & (DEBUG_TINY|DEBUG_PHASE))
4325 kprintf ("P%x%x RL=%d D=%d ", cmd&7, INB(nc_sbcl)&7,
4326 (unsigned) rest, (unsigned) delta);
4329 * try to find the interrupted script command,
4330 * and the address at which to continue.
4334 if (dsp > np->scripta_ba &&
4335 dsp <= np->scripta_ba + np->scripta_sz) {
4336 vdsp = (u32 *)((char*)np->scripta0 + (dsp-np->scripta_ba-8));
4339 else if (dsp > np->scriptb_ba &&
4340 dsp <= np->scriptb_ba + np->scriptb_sz) {
4341 vdsp = (u32 *)((char*)np->scriptb0 + (dsp-np->scriptb_ba-8));
4346 * log the information
4348 if (DEBUG_FLAGS & DEBUG_PHASE) {
4349 kprintf ("\nCP=%p DSP=%x NXT=%x VDSP=%p CMD=%x ",
4350 cp, (unsigned)dsp, (unsigned)nxtdsp, vdsp, cmd);
4354 kprintf ("%s: interrupted SCRIPT address not found.\n",
4360 kprintf ("%s: SCSI phase error fixup: CCB already dequeued.\n",
4366 * get old startaddress and old length.
4368 oadr = scr_to_cpu(vdsp[1]);
4370 if (cmd & 0x10) { /* Table indirect */
4371 tblp = (u32 *) ((char*) &cp->phys + oadr);
4372 olen = scr_to_cpu(tblp[0]);
4373 oadr = scr_to_cpu(tblp[1]);
4376 olen = scr_to_cpu(vdsp[0]) & 0xffffff;
4379 if (DEBUG_FLAGS & DEBUG_PHASE) {
4380 kprintf ("OCMD=%x\nTBLP=%p OLEN=%x OADR=%x\n",
4381 (unsigned) (scr_to_cpu(vdsp[0]) >> 24),
4388 * check cmd against assumed interrupted script command.
4389 * If dt data phase, the MOVE instruction hasn't bit 4 of
4392 if (((cmd & 2) ? cmd : (cmd & ~4)) != (scr_to_cpu(vdsp[0]) >> 24)) {
4394 kprintf ("internal error: cmd=%02x != %02x=(vdsp[0] >> 24)\n",
4395 (unsigned)cmd, (unsigned)scr_to_cpu(vdsp[0]) >> 24);
4401 * if old phase not dataphase, leave here.
4405 kprintf ("phase change %x-%x %d@%08x resid=%d.\n",
4406 cmd&7, INB(nc_sbcl)&7, (unsigned)olen,
4407 (unsigned)oadr, (unsigned)rest);
4408 goto unexpected_phase;
4412 * Choose the correct PM save area.
4414 * Look at the PM_SAVE SCRIPT if you want to understand
4415 * this stuff. The equivalent code is implemented in
4416 * SCRIPTS for the 895A, 896 and 1010 that are able to
4417 * handle PM from the SCRIPTS processor.
4419 hflags0 = INB (HF_PRT);
4422 if (hflags & (HF_IN_PM0 | HF_IN_PM1 | HF_DP_SAVED)) {
4423 if (hflags & HF_IN_PM0)
4424 nxtdsp = scr_to_cpu(cp->phys.pm0.ret);
4425 else if (hflags & HF_IN_PM1)
4426 nxtdsp = scr_to_cpu(cp->phys.pm1.ret);
4428 if (hflags & HF_DP_SAVED)
4429 hflags ^= HF_ACT_PM;
4432 if (!(hflags & HF_ACT_PM)) {
4434 newcmd = SCRIPTA_BA (np, pm0_data);
4438 newcmd = SCRIPTA_BA (np, pm1_data);
4441 hflags &= ~(HF_IN_PM0 | HF_IN_PM1 | HF_DP_SAVED);
4442 if (hflags != hflags0)
4443 OUTB (HF_PRT, hflags);
4446 * fillin the phase mismatch context
4448 pm->sg.addr = cpu_to_scr(oadr + olen - rest);
4449 pm->sg.size = cpu_to_scr(rest);
4450 pm->ret = cpu_to_scr(nxtdsp);
4453 * If we have a SWIDE,
4454 * - prepare the address to write the SWIDE from SCRIPTS,
4455 * - compute the SCRIPTS address to restart from,
4456 * - move current data pointer context by one byte.
4458 nxtdsp = SCRIPTA_BA (np, dispatch);
4459 if ((cmd & 7) == 1 && cp && (cp->phys.select.sel_scntl3 & EWS) &&
4460 (INB (nc_scntl2) & WSR)) {
4464 * Set up the table indirect for the MOVE
4465 * of the residual byte and adjust the data
4468 tmp = scr_to_cpu(pm->sg.addr);
4469 cp->phys.wresid.addr = cpu_to_scr(tmp);
4470 pm->sg.addr = cpu_to_scr(tmp + 1);
4471 tmp = scr_to_cpu(pm->sg.size);
4472 cp->phys.wresid.size = cpu_to_scr((tmp&0xff000000) | 1);
4473 pm->sg.size = cpu_to_scr(tmp - 1);
4476 * If only the residual byte is to be moved,
4477 * no PM context is needed.
4479 if ((tmp&0xffffff) == 1)
4483 * Prepare the address of SCRIPTS that will
4484 * move the residual byte to memory.
4486 nxtdsp = SCRIPTB_BA (np, wsr_ma_helper);
4489 if (DEBUG_FLAGS & DEBUG_PHASE) {
4491 kprintf ("PM %x %x %x / %x %x %x.\n",
4492 hflags0, hflags, newcmd,
4493 (unsigned)scr_to_cpu(pm->sg.addr),
4494 (unsigned)scr_to_cpu(pm->sg.size),
4495 (unsigned)scr_to_cpu(pm->ret));
4499 * Restart the SCRIPTS processor.
4501 OUTL (nc_temp, newcmd);
4506 * Unexpected phase changes that occurs when the current phase
4507 * is not a DATA IN or DATA OUT phase are due to error conditions.
4508 * Such event may only happen when the SCRIPTS is using a
4509 * multibyte SCSI MOVE.
4511 * Phase change Some possible cause
4513 * COMMAND --> MSG IN SCSI parity error detected by target.
4514 * COMMAND --> STATUS Bad command or refused by target.
4515 * MSG OUT --> MSG IN Message rejected by target.
4516 * MSG OUT --> COMMAND Bogus target that discards extended
4517 * negotiation messages.
4519 * The code below does not care of the new phase and so
4520 * trusts the target. Why to annoy it ?
4521 * If the interrupted phase is COMMAND phase, we restart at
4523 * If a target does not get all the messages after selection,
4524 * the code assumes blindly that the target discards extended
4525 * messages and clears the negotiation status.
4526 * If the target does not want all our response to negotiation,
4527 * we force a SIR_NEGO_PROTO interrupt (it is a hack that avoids
4528 * bloat for such a should_not_happen situation).
4529 * In all other situation, we reset the BUS.
4530 * Are these assumptions reasonnable ? (Wait and see ...)
4537 case 2: /* COMMAND phase */
4538 nxtdsp = SCRIPTA_BA (np, dispatch);
4541 case 3: /* STATUS phase */
4542 nxtdsp = SCRIPTA_BA (np, dispatch);
4545 case 6: /* MSG OUT phase */
4547 * If the device may want to use untagged when we want
4548 * tagged, we prepare an IDENTIFY without disc. granted,
4549 * since we will not be able to handle reselect.
4550 * Otherwise, we just don't care.
4552 if (dsp == SCRIPTA_BA (np, send_ident)) {
4553 if (cp->tag != NO_TAG && olen - rest <= 3) {
4554 cp->host_status = HS_BUSY;
4555 np->msgout[0] = M_IDENTIFY | cp->lun;
4556 nxtdsp = SCRIPTB_BA (np, ident_break_atn);
4559 nxtdsp = SCRIPTB_BA (np, ident_break);
4561 else if (dsp == SCRIPTB_BA (np, send_wdtr) ||
4562 dsp == SCRIPTB_BA (np, send_sdtr) ||
4563 dsp == SCRIPTB_BA (np, send_ppr)) {
4564 nxtdsp = SCRIPTB_BA (np, nego_bad_phase);
4568 case 7: /* MSG IN phase */
4569 nxtdsp = SCRIPTA_BA (np, clrack);
4580 sym_start_reset(np);
4584 * Dequeue from the START queue all CCBs that match
4585 * a given target/lun/task condition (-1 means all),
4586 * and move them from the BUSY queue to the COMP queue
4587 * with CAM_REQUEUE_REQ status condition.
4588 * This function is used during error handling/recovery.
4589 * It is called with SCRIPTS not running.
4592 sym_dequeue_from_squeue(hcb_p np, int i, int target, int lun, int task)
4598 * Make sure the starting index is within range.
4600 assert((i >= 0) && (i < 2*MAX_QUEUE));
4603 * Walk until end of START queue and dequeue every job
4604 * that matches the target/lun/task condition.
4607 while (i != np->squeueput) {
4608 cp = sym_ccb_from_dsa(np, scr_to_cpu(np->squeue[i]));
4610 #ifdef SYM_CONF_IARB_SUPPORT
4611 /* Forget hints for IARB, they may be no longer relevant */
4612 cp->host_flags &= ~HF_HINT_IARB;
4614 if ((target == -1 || cp->target == target) &&
4615 (lun == -1 || cp->lun == lun) &&
4616 (task == -1 || cp->tag == task)) {
4617 sym_set_cam_status(cp->cam_ccb, CAM_REQUEUE_REQ);
4618 sym_remque(&cp->link_ccbq);
4619 sym_insque_tail(&cp->link_ccbq, &np->comp_ccbq);
4623 np->squeue[j] = np->squeue[i];
4624 if ((j += 2) >= MAX_QUEUE*2) j = 0;
4626 if ((i += 2) >= MAX_QUEUE*2) i = 0;
4628 if (i != j) /* Copy back the idle task if needed */
4629 np->squeue[j] = np->squeue[i];
4630 np->squeueput = j; /* Update our current start queue pointer */
4636 * Complete all CCBs queued to the COMP queue.
4638 * These CCBs are assumed:
4639 * - Not to be referenced either by devices or
4640 * SCRIPTS-related queues and datas.
4641 * - To have to be completed with an error condition
4644 * The device queue freeze count is incremented
4645 * for each CCB that does not prevent this.
4646 * This function is called when all CCBs involved
4647 * in error handling/recovery have been reaped.
4650 sym_flush_comp_queue(hcb_p np, int cam_status)
4655 while ((qp = sym_remque_head(&np->comp_ccbq)) != NULL) {
4657 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
4658 sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
4659 /* Leave quiet CCBs waiting for resources */
4660 if (cp->host_status == HS_WAIT)
4664 sym_set_cam_status(ccb, cam_status);
4665 sym_freeze_cam_ccb(ccb);
4666 sym_xpt_done(np, ccb, cp);
4667 sym_free_ccb(np, cp);
4672 * chip handler for bad SCSI status condition
4674 * In case of bad SCSI status, we unqueue all the tasks
4675 * currently queued to the controller but not yet started
4676 * and then restart the SCRIPTS processor immediately.
4678 * QUEUE FULL and BUSY conditions are handled the same way.
4679 * Basically all the not yet started tasks are requeued in
4680 * device queue and the queue is frozen until a completion.
4682 * For CHECK CONDITION and COMMAND TERMINATED status, we use
4683 * the CCB of the failed command to prepare a REQUEST SENSE
4684 * SCSI command and queue it to the controller queue.
4686 * SCRATCHA is assumed to have been loaded with STARTPOS
4687 * before the SCRIPTS called the C code.
4689 static void sym_sir_bad_scsi_status(hcb_p np, int num, ccb_p cp)
4691 tcb_p tp = &np->target[cp->target];
4693 u_char s_status = cp->ssss_status;
4694 u_char h_flags = cp->host_flags;
4699 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
4702 * Compute the index of the next job to start from SCRIPTS.
4704 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
4707 * The last CCB queued used for IARB hint may be
4708 * no longer relevant. Forget it.
4710 #ifdef SYM_CONF_IARB_SUPPORT
4716 * Now deal with the SCSI status.
4721 if (sym_verbose >= 2) {
4723 kprintf (s_status == S_BUSY ? "BUSY" : "QUEUE FULL\n");
4725 default: /* S_INT, S_INT_COND_MET, S_CONFLICT */
4726 sym_complete_error (np, cp);
4731 * If we get an SCSI error when requesting sense, give up.
4733 if (h_flags & HF_SENSE) {
4734 sym_complete_error (np, cp);
4739 * Dequeue all queued CCBs for that device not yet started,
4740 * and restart the SCRIPTS processor immediately.
4742 (void) sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
4743 OUTL_DSP (SCRIPTA_BA (np, start));
4746 * Save some info of the actual IO.
4747 * Compute the data residual.
4749 cp->sv_scsi_status = cp->ssss_status;
4750 cp->sv_xerr_status = cp->xerr_status;
4751 cp->sv_resid = sym_compute_residual(np, cp);
4754 * Prepare all needed data structures for
4755 * requesting sense data.
4761 cp->scsi_smsg2[0] = M_IDENTIFY | cp->lun;
4765 * If we are currently using anything different from
4766 * async. 8 bit data transfers with that target,
4767 * start a negotiation, since the device may want
4768 * to report us a UNIT ATTENTION condition due to
4769 * a cause we currently ignore, and we donnot want
4770 * to be stuck with WIDE and/or SYNC data transfer.
4772 * cp->nego_status is filled by sym_prepare_nego().
4774 cp->nego_status = 0;
4776 if (tp->tinfo.current.options & PPR_OPT_MASK)
4778 else if (tp->tinfo.current.width != BUS_8_BIT)
4780 else if (tp->tinfo.current.offset != 0)
4784 sym_prepare_nego (np,cp, nego, &cp->scsi_smsg2[msglen]);
4786 * Message table indirect structure.
4788 cp->phys.smsg.addr = cpu_to_scr(CCB_BA (cp, scsi_smsg2));
4789 cp->phys.smsg.size = cpu_to_scr(msglen);
4794 cp->phys.cmd.addr = cpu_to_scr(CCB_BA (cp, sensecmd));
4795 cp->phys.cmd.size = cpu_to_scr(6);
4798 * patch requested size into sense command
4800 cp->sensecmd[0] = 0x03;
4801 cp->sensecmd[1] = cp->lun << 5;
4802 if (tp->tinfo.current.scsi_version > 2 || cp->lun > 7)
4803 cp->sensecmd[1] = 0;
4804 cp->sensecmd[4] = SYM_SNS_BBUF_LEN;
4805 cp->data_len = SYM_SNS_BBUF_LEN;
4810 bzero(cp->sns_bbuf, SYM_SNS_BBUF_LEN);
4811 cp->phys.sense.addr = cpu_to_scr(vtobus(cp->sns_bbuf));
4812 cp->phys.sense.size = cpu_to_scr(SYM_SNS_BBUF_LEN);
4815 * requeue the command.
4817 startp = SCRIPTB_BA (np, sdata_in);
4819 cp->phys.head.savep = cpu_to_scr(startp);
4820 cp->phys.head.goalp = cpu_to_scr(startp + 16);
4821 cp->phys.head.lastp = cpu_to_scr(startp);
4822 cp->startp = cpu_to_scr(startp);
4824 cp->actualquirks = SYM_QUIRK_AUTOSAVE;
4825 cp->host_status = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
4826 cp->ssss_status = S_ILLEGAL;
4827 cp->host_flags = (HF_SENSE|HF_DATA_IN);
4828 cp->xerr_status = 0;
4829 cp->extra_bytes = 0;
4831 cp->phys.head.go.start = cpu_to_scr(SCRIPTA_BA (np, select));
4834 * Requeue the command.
4836 sym_put_start_queue(np, cp);
4839 * Give back to upper layer everything we have dequeued.
4841 sym_flush_comp_queue(np, 0);
4847 * After a device has accepted some management message
4848 * as BUS DEVICE RESET, ABORT TASK, etc ..., or when
4849 * a device signals a UNIT ATTENTION condition, some
4850 * tasks are thrown away by the device. We are required
4851 * to reflect that on our tasks list since the device
4852 * will never complete these tasks.
4854 * This function move from the BUSY queue to the COMP
4855 * queue all disconnected CCBs for a given target that
4856 * match the following criteria:
4857 * - lun=-1 means any logical UNIT otherwise a given one.
4858 * - task=-1 means any task, otherwise a given one.
4861 sym_clear_tasks(hcb_p np, int cam_status, int target, int lun, int task)
4863 SYM_QUEHEAD qtmp, *qp;
4868 * Move the entire BUSY queue to our temporary queue.
4870 sym_que_init(&qtmp);
4871 sym_que_splice(&np->busy_ccbq, &qtmp);
4872 sym_que_init(&np->busy_ccbq);
4875 * Put all CCBs that matches our criteria into
4876 * the COMP queue and put back other ones into
4879 while ((qp = sym_remque_head(&qtmp)) != NULL) {
4881 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
4883 if (cp->host_status != HS_DISCONNECT ||
4884 cp->target != target ||
4885 (lun != -1 && cp->lun != lun) ||
4887 (cp->tag != NO_TAG && cp->scsi_smsg[2] != task))) {
4888 sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
4891 sym_insque_tail(&cp->link_ccbq, &np->comp_ccbq);
4893 /* Preserve the software timeout condition */
4894 if (sym_get_cam_status(ccb) != CAM_CMD_TIMEOUT)
4895 sym_set_cam_status(ccb, cam_status);
4898 kprintf("XXXX TASK @%p CLEARED\n", cp);
4905 * chip handler for TASKS recovery
4907 * We cannot safely abort a command, while the SCRIPTS
4908 * processor is running, since we just would be in race
4911 * As long as we have tasks to abort, we keep the SEM
4912 * bit set in the ISTAT. When this bit is set, the
4913 * SCRIPTS processor interrupts (SIR_SCRIPT_STOPPED)
4914 * each time it enters the scheduler.
4916 * If we have to reset a target, clear tasks of a unit,
4917 * or to perform the abort of a disconnected job, we
4918 * restart the SCRIPTS for selecting the target. Once
4919 * selected, the SCRIPTS interrupts (SIR_TARGET_SELECTED).
4920 * If it loses arbitration, the SCRIPTS will interrupt again
4921 * the next time it will enter its scheduler, and so on ...
4923 * On SIR_TARGET_SELECTED, we scan for the more
4924 * appropriate thing to do:
4926 * - If nothing, we just sent a M_ABORT message to the
4927 * target to get rid of the useless SCSI bus ownership.
4928 * According to the specs, no tasks shall be affected.
4929 * - If the target is to be reset, we send it a M_RESET
4931 * - If a logical UNIT is to be cleared , we send the
4932 * IDENTIFY(lun) + M_ABORT.
4933 * - If an untagged task is to be aborted, we send the
4934 * IDENTIFY(lun) + M_ABORT.
4935 * - If a tagged task is to be aborted, we send the
4936 * IDENTIFY(lun) + task attributes + M_ABORT_TAG.
4938 * Once our 'kiss of death' :) message has been accepted
4939 * by the target, the SCRIPTS interrupts again
4940 * (SIR_ABORT_SENT). On this interrupt, we complete
4941 * all the CCBs that should have been aborted by the
4942 * target according to our message.
4944 static void sym_sir_task_recovery(hcb_p np, int num)
4949 int target=-1, lun=-1, task;
4954 * The SCRIPTS processor stopped before starting
4955 * the next command in order to allow us to perform
4956 * some task recovery.
4958 case SIR_SCRIPT_STOPPED:
4960 * Do we have any target to reset or unit to clear ?
4962 for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
4963 tp = &np->target[i];
4965 (tp->lun0p && tp->lun0p->to_clear)) {
4971 for (k = 1 ; k < SYM_CONF_MAX_LUN ; k++) {
4972 if (tp->lunmp[k] && tp->lunmp[k]->to_clear) {
4982 * If not, walk the busy queue for any
4983 * disconnected CCB to be aborted.
4986 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
4987 cp = sym_que_entry(qp,struct sym_ccb,link_ccbq);
4988 if (cp->host_status != HS_DISCONNECT)
4991 target = cp->target;
4998 * If some target is to be selected,
4999 * prepare and start the selection.
5002 tp = &np->target[target];
5003 np->abrt_sel.sel_id = target;
5004 np->abrt_sel.sel_scntl3 = tp->head.wval;
5005 np->abrt_sel.sel_sxfer = tp->head.sval;
5006 OUTL(nc_dsa, np->hcb_ba);
5007 OUTL_DSP (SCRIPTB_BA (np, sel_for_abort));
5012 * Now look for a CCB to abort that haven't started yet.
5013 * Btw, the SCRIPTS processor is still stopped, so
5014 * we are not in race.
5018 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
5019 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
5020 if (cp->host_status != HS_BUSY &&
5021 cp->host_status != HS_NEGOTIATE)
5025 #ifdef SYM_CONF_IARB_SUPPORT
5027 * If we are using IMMEDIATE ARBITRATION, we donnot
5028 * want to cancel the last queued CCB, since the
5029 * SCRIPTS may have anticipated the selection.
5031 if (cp == np->last_cp) {
5036 i = 1; /* Means we have found some */
5041 * We are done, so we donnot need
5042 * to synchronize with the SCRIPTS anylonger.
5043 * Remove the SEM flag from the ISTAT.
5046 OUTB (nc_istat, SIGP);
5050 * Compute index of next position in the start
5051 * queue the SCRIPTS intends to start and dequeue
5052 * all CCBs for that device that haven't been started.
5054 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
5055 i = sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
5058 * Make sure at least our IO to abort has been dequeued.
5060 assert(i && sym_get_cam_status(cp->cam_ccb) == CAM_REQUEUE_REQ);
5063 * Keep track in cam status of the reason of the abort.
5065 if (cp->to_abort == 2)
5066 sym_set_cam_status(cp->cam_ccb, CAM_CMD_TIMEOUT);
5068 sym_set_cam_status(cp->cam_ccb, CAM_REQ_ABORTED);
5071 * Complete with error everything that we have dequeued.
5073 sym_flush_comp_queue(np, 0);
5076 * The SCRIPTS processor has selected a target
5077 * we may have some manual recovery to perform for.
5079 case SIR_TARGET_SELECTED:
5080 target = (INB (nc_sdid) & 0xf);
5081 tp = &np->target[target];
5083 np->abrt_tbl.addr = cpu_to_scr(vtobus(np->abrt_msg));
5086 * If the target is to be reset, prepare a
5087 * M_RESET message and clear the to_reset flag
5088 * since we donnot expect this operation to fail.
5091 np->abrt_msg[0] = M_RESET;
5092 np->abrt_tbl.size = 1;
5098 * Otherwise, look for some logical unit to be cleared.
5100 if (tp->lun0p && tp->lun0p->to_clear)
5102 else if (tp->lunmp) {
5103 for (k = 1 ; k < SYM_CONF_MAX_LUN ; k++) {
5104 if (tp->lunmp[k] && tp->lunmp[k]->to_clear) {
5112 * If a logical unit is to be cleared, prepare
5113 * an IDENTIFY(lun) + ABORT MESSAGE.
5116 lcb_p lp = sym_lp(np, tp, lun);
5117 lp->to_clear = 0; /* We donnot expect to fail here */
5118 np->abrt_msg[0] = M_IDENTIFY | lun;
5119 np->abrt_msg[1] = M_ABORT;
5120 np->abrt_tbl.size = 2;
5125 * Otherwise, look for some disconnected job to
5126 * abort for this target.
5130 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
5131 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
5132 if (cp->host_status != HS_DISCONNECT)
5134 if (cp->target != target)
5138 i = 1; /* Means we have some */
5143 * If we have none, probably since the device has
5144 * completed the command before we won abitration,
5145 * send a M_ABORT message without IDENTIFY.
5146 * According to the specs, the device must just
5147 * disconnect the BUS and not abort any task.
5150 np->abrt_msg[0] = M_ABORT;
5151 np->abrt_tbl.size = 1;
5156 * We have some task to abort.
5157 * Set the IDENTIFY(lun)
5159 np->abrt_msg[0] = M_IDENTIFY | cp->lun;
5162 * If we want to abort an untagged command, we
5163 * will send an IDENTIFY + M_ABORT.
5164 * Otherwise (tagged command), we will send
5165 * an IDENTIFY + task attributes + ABORT TAG.
5167 if (cp->tag == NO_TAG) {
5168 np->abrt_msg[1] = M_ABORT;
5169 np->abrt_tbl.size = 2;
5172 np->abrt_msg[1] = cp->scsi_smsg[1];
5173 np->abrt_msg[2] = cp->scsi_smsg[2];
5174 np->abrt_msg[3] = M_ABORT_TAG;
5175 np->abrt_tbl.size = 4;
5178 * Keep track of software timeout condition, since the
5179 * peripheral driver may not count retries on abort
5180 * conditions not due to timeout.
5182 if (cp->to_abort == 2)
5183 sym_set_cam_status(cp->cam_ccb, CAM_CMD_TIMEOUT);
5184 cp->to_abort = 0; /* We donnot expect to fail here */
5188 * The target has accepted our message and switched
5189 * to BUS FREE phase as we expected.
5191 case SIR_ABORT_SENT:
5192 target = (INB (nc_sdid) & 0xf);
5193 tp = &np->target[target];
5196 ** If we didn't abort anything, leave here.
5198 if (np->abrt_msg[0] == M_ABORT)
5202 * If we sent a M_RESET, then a hardware reset has
5203 * been performed by the target.
5204 * - Reset everything to async 8 bit
5205 * - Tell ourself to negotiate next time :-)
5206 * - Prepare to clear all disconnected CCBs for
5207 * this target from our task list (lun=task=-1)
5211 if (np->abrt_msg[0] == M_RESET) {
5213 tp->head.wval = np->rv_scntl3;
5215 tp->tinfo.current.period = 0;
5216 tp->tinfo.current.offset = 0;
5217 tp->tinfo.current.width = BUS_8_BIT;
5218 tp->tinfo.current.options = 0;
5222 * Otherwise, check for the LUN and TASK(s)
5223 * concerned by the cancelation.
5224 * If it is not ABORT_TAG then it is CLEAR_QUEUE
5225 * or an ABORT message :-)
5228 lun = np->abrt_msg[0] & 0x3f;
5229 if (np->abrt_msg[1] == M_ABORT_TAG)
5230 task = np->abrt_msg[2];
5234 * Complete all the CCBs the device should have
5235 * aborted due to our 'kiss of death' message.
5237 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
5238 (void) sym_dequeue_from_squeue(np, i, target, lun, -1);
5239 (void) sym_clear_tasks(np, CAM_REQ_ABORTED, target, lun, task);
5240 sym_flush_comp_queue(np, 0);
5243 * If we sent a BDR, make uper layer aware of that.
5245 if (np->abrt_msg[0] == M_RESET)
5246 xpt_async(AC_SENT_BDR, np->path, NULL);
5251 * Print to the log the message we intend to send.
5253 if (num == SIR_TARGET_SELECTED) {
5254 PRINT_TARGET(np, target);
5255 sym_printl_hex("control msgout:", np->abrt_msg,
5257 np->abrt_tbl.size = cpu_to_scr(np->abrt_tbl.size);
5261 * Let the SCRIPTS processor continue.
5267 * Gerard's alchemy:) that deals with with the data
5268 * pointer for both MDP and the residual calculation.
5270 * I didn't want to bloat the code by more than 200
5271 * lignes for the handling of both MDP and the residual.
5272 * This has been achieved by using a data pointer
5273 * representation consisting in an index in the data
5274 * array (dp_sg) and a negative offset (dp_ofs) that
5275 * have the following meaning:
5277 * - dp_sg = SYM_CONF_MAX_SG
5278 * we are at the end of the data script.
5279 * - dp_sg < SYM_CONF_MAX_SG
5280 * dp_sg points to the next entry of the scatter array
5281 * we want to transfer.
5283 * dp_ofs represents the residual of bytes of the
5284 * previous entry scatter entry we will send first.
5286 * no residual to send first.
5288 * The function sym_evaluate_dp() accepts an arbitray
5289 * offset (basically from the MDP message) and returns
5290 * the corresponding values of dp_sg and dp_ofs.
5293 static int sym_evaluate_dp(hcb_p np, ccb_p cp, u32 scr, int *ofs)
5296 int dp_ofs, dp_sg, dp_sgmin;
5301 * Compute the resulted data pointer in term of a script
5302 * address within some DATA script and a signed byte offset.
5306 if (dp_scr == SCRIPTA_BA (np, pm0_data))
5308 else if (dp_scr == SCRIPTA_BA (np, pm1_data))
5314 dp_scr = scr_to_cpu(pm->ret);
5315 dp_ofs -= scr_to_cpu(pm->sg.size);
5319 * If we are auto-sensing, then we are done.
5321 if (cp->host_flags & HF_SENSE) {
5327 * Deduce the index of the sg entry.
5328 * Keep track of the index of the first valid entry.
5329 * If result is dp_sg = SYM_CONF_MAX_SG, then we are at the
5332 tmp = scr_to_cpu(cp->phys.head.goalp);
5333 dp_sg = SYM_CONF_MAX_SG;
5335 dp_sg -= (tmp - 8 - (int)dp_scr) / (2*4);
5336 dp_sgmin = SYM_CONF_MAX_SG - cp->segments;
5339 * Move to the sg entry the data pointer belongs to.
5341 * If we are inside the data area, we expect result to be:
5344 * dp_ofs = 0 and dp_sg is the index of the sg entry
5345 * the data pointer belongs to (or the end of the data)
5347 * dp_ofs < 0 and dp_sg is the index of the sg entry
5348 * the data pointer belongs to + 1.
5352 while (dp_sg > dp_sgmin) {
5354 tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5355 n = dp_ofs + (tmp & 0xffffff);
5363 else if (dp_ofs > 0) {
5364 while (dp_sg < SYM_CONF_MAX_SG) {
5365 tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5366 dp_ofs -= (tmp & 0xffffff);
5374 * Make sure the data pointer is inside the data area.
5375 * If not, return some error.
5377 if (dp_sg < dp_sgmin || (dp_sg == dp_sgmin && dp_ofs < 0))
5379 else if (dp_sg > SYM_CONF_MAX_SG ||
5380 (dp_sg == SYM_CONF_MAX_SG && dp_ofs > 0))
5384 * Save the extreme pointer if needed.
5386 if (dp_sg > cp->ext_sg ||
5387 (dp_sg == cp->ext_sg && dp_ofs > cp->ext_ofs)) {
5389 cp->ext_ofs = dp_ofs;
5403 * chip handler for MODIFY DATA POINTER MESSAGE
5405 * We also call this function on IGNORE WIDE RESIDUE
5406 * messages that do not match a SWIDE full condition.
5407 * Btw, we assume in that situation that such a message
5408 * is equivalent to a MODIFY DATA POINTER (offset=-1).
5411 static void sym_modify_dp(hcb_p np, tcb_p tp, ccb_p cp, int ofs)
5414 u32 dp_scr = INL (nc_temp);
5422 * Not supported for auto-sense.
5424 if (cp->host_flags & HF_SENSE)
5428 * Apply our alchemy:) (see comments in sym_evaluate_dp()),
5429 * to the resulted data pointer.
5431 dp_sg = sym_evaluate_dp(np, cp, dp_scr, &dp_ofs);
5436 * And our alchemy:) allows to easily calculate the data
5437 * script address we want to return for the next data phase.
5439 dp_ret = cpu_to_scr(cp->phys.head.goalp);
5440 dp_ret = dp_ret - 8 - (SYM_CONF_MAX_SG - dp_sg) * (2*4);
5443 * If offset / scatter entry is zero we donnot need
5444 * a context for the new current data pointer.
5452 * Get a context for the new current data pointer.
5454 hflags = INB (HF_PRT);
5456 if (hflags & HF_DP_SAVED)
5457 hflags ^= HF_ACT_PM;
5459 if (!(hflags & HF_ACT_PM)) {
5461 dp_scr = SCRIPTA_BA (np, pm0_data);
5465 dp_scr = SCRIPTA_BA (np, pm1_data);
5468 hflags &= ~(HF_DP_SAVED);
5470 OUTB (HF_PRT, hflags);
5473 * Set up the new current data pointer.
5474 * ofs < 0 there, and for the next data phase, we
5475 * want to transfer part of the data of the sg entry
5476 * corresponding to index dp_sg-1 prior to returning
5477 * to the main data script.
5479 pm->ret = cpu_to_scr(dp_ret);
5480 tmp = scr_to_cpu(cp->phys.data[dp_sg-1].addr);
5481 tmp += scr_to_cpu(cp->phys.data[dp_sg-1].size) + dp_ofs;
5482 pm->sg.addr = cpu_to_scr(tmp);
5483 pm->sg.size = cpu_to_scr(-dp_ofs);
5486 OUTL (nc_temp, dp_scr);
5487 OUTL_DSP (SCRIPTA_BA (np, clrack));
5491 OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5496 * chip calculation of the data residual.
5498 * As I used to say, the requirement of data residual
5499 * in SCSI is broken, useless and cannot be achieved
5500 * without huge complexity.
5501 * But most OSes and even the official CAM require it.
5502 * When stupidity happens to be so widely spread inside
5503 * a community, it gets hard to convince.
5505 * Anyway, I don't care, since I am not going to use
5506 * any software that considers this data residual as
5507 * a relevant information. :)
5510 static int sym_compute_residual(hcb_p np, ccb_p cp)
5512 int dp_sg, resid = 0;
5516 * Check for some data lost or just thrown away.
5517 * We are not required to be quite accurate in this
5518 * situation. Btw, if we are odd for output and the
5519 * device claims some more data, it may well happen
5520 * than our residual be zero. :-)
5522 if (cp->xerr_status & (XE_EXTRA_DATA|XE_SODL_UNRUN|XE_SWIDE_OVRUN)) {
5523 if (cp->xerr_status & XE_EXTRA_DATA)
5524 resid -= cp->extra_bytes;
5525 if (cp->xerr_status & XE_SODL_UNRUN)
5527 if (cp->xerr_status & XE_SWIDE_OVRUN)
5532 * If all data has been transferred,
5533 * there is no residual.
5535 if (cp->phys.head.lastp == cp->phys.head.goalp)
5539 * If no data transfer occurs, or if the data
5540 * pointer is weird, return full residual.
5542 if (cp->startp == cp->phys.head.lastp ||
5543 sym_evaluate_dp(np, cp, scr_to_cpu(cp->phys.head.lastp),
5545 return cp->data_len;
5549 * If we were auto-sensing, then we are done.
5551 if (cp->host_flags & HF_SENSE) {
5556 * We are now full comfortable in the computation
5557 * of the data residual (2's complement).
5559 resid = -cp->ext_ofs;
5560 for (dp_sg = cp->ext_sg; dp_sg < SYM_CONF_MAX_SG; ++dp_sg) {
5561 u_int tmp = scr_to_cpu(cp->phys.data[dp_sg].size);
5562 resid += (tmp & 0xffffff);
5566 * Hopefully, the result is not too wrong.
5572 * Print out the content of a SCSI message.
5575 static int sym_show_msg (u_char * msg)
5578 kprintf ("%x",*msg);
5579 if (*msg==M_EXTENDED) {
5581 if (i-1>msg[1]) break;
5582 kprintf ("-%x",msg[i]);
5585 } else if ((*msg & 0xf0) == 0x20) {
5586 kprintf ("-%x",msg[1]);
5592 static void sym_print_msg (ccb_p cp, char *label, u_char *msg)
5596 kprintf ("%s: ", label);
5598 (void) sym_show_msg (msg);
5603 * Negotiation for WIDE and SYNCHRONOUS DATA TRANSFER.
5605 * When we try to negotiate, we append the negotiation message
5606 * to the identify and (maybe) simple tag message.
5607 * The host status field is set to HS_NEGOTIATE to mark this
5610 * If the target doesn't answer this message immediately
5611 * (as required by the standard), the SIR_NEGO_FAILED interrupt
5612 * will be raised eventually.
5613 * The handler removes the HS_NEGOTIATE status, and sets the
5614 * negotiated value to the default (async / nowide).
5616 * If we receive a matching answer immediately, we check it
5617 * for validity, and set the values.
5619 * If we receive a Reject message immediately, we assume the
5620 * negotiation has failed, and fall back to standard values.
5622 * If we receive a negotiation message while not in HS_NEGOTIATE
5623 * state, it's a target initiated negotiation. We prepare a
5624 * (hopefully) valid answer, set our parameters, and send back
5625 * this answer to the target.
5627 * If the target doesn't fetch the answer (no message out phase),
5628 * we assume the negotiation has failed, and fall back to default
5629 * settings (SIR_NEGO_PROTO interrupt).
5631 * When we set the values, we adjust them in all ccbs belonging
5632 * to this target, in the controller's register, and in the "phys"
5633 * field of the controller's struct sym_hcb.
5637 * chip handler for SYNCHRONOUS DATA TRANSFER REQUEST (SDTR) message.
5639 static void sym_sync_nego(hcb_p np, tcb_p tp, ccb_p cp)
5641 u_char chg, ofs, per, fak, div;
5645 * Synchronous request message received.
5647 if (DEBUG_FLAGS & DEBUG_NEGO) {
5648 sym_print_msg(cp, "sync msgin", np->msgin);
5652 * request or answer ?
5654 if (INB (HS_PRT) == HS_NEGOTIATE) {
5655 OUTB (HS_PRT, HS_BUSY);
5656 if (cp->nego_status && cp->nego_status != NS_SYNC)
5662 * get requested values.
5669 * check values against our limits.
5672 if (ofs > np->maxoffs)
5673 {chg = 1; ofs = np->maxoffs;}
5675 if (ofs > tp->tinfo.user.offset)
5676 {chg = 1; ofs = tp->tinfo.user.offset;}
5681 if (per < np->minsync)
5682 {chg = 1; per = np->minsync;}
5684 if (per < tp->tinfo.user.period)
5685 {chg = 1; per = tp->tinfo.user.period;}
5690 if (ofs && sym_getsync(np, 0, per, &div, &fak) < 0)
5693 if (DEBUG_FLAGS & DEBUG_NEGO) {
5695 kprintf ("sdtr: ofs=%d per=%d div=%d fak=%d chg=%d.\n",
5696 ofs, per, div, fak, chg);
5700 * This was an answer message
5703 if (chg) /* Answer wasn't acceptable. */
5705 sym_setsync (np, cp, ofs, per, div, fak);
5706 OUTL_DSP (SCRIPTA_BA (np, clrack));
5711 * It was a request. Set value and
5712 * prepare an answer message
5714 sym_setsync (np, cp, ofs, per, div, fak);
5716 np->msgout[0] = M_EXTENDED;
5718 np->msgout[2] = M_X_SYNC_REQ;
5719 np->msgout[3] = per;
5720 np->msgout[4] = ofs;
5722 cp->nego_status = NS_SYNC;
5724 if (DEBUG_FLAGS & DEBUG_NEGO) {
5725 sym_print_msg(cp, "sync msgout", np->msgout);
5728 np->msgin [0] = M_NOOP;
5730 OUTL_DSP (SCRIPTB_BA (np, sdtr_resp));
5733 sym_setsync (np, cp, 0, 0, 0, 0);
5734 OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5738 * chip handler for PARALLEL PROTOCOL REQUEST (PPR) message.
5740 static void sym_ppr_nego(hcb_p np, tcb_p tp, ccb_p cp)
5742 u_char chg, ofs, per, fak, dt, div, wide;
5746 * Synchronous request message received.
5748 if (DEBUG_FLAGS & DEBUG_NEGO) {
5749 sym_print_msg(cp, "ppr msgin", np->msgin);
5753 * get requested values.
5758 wide = np->msgin[6];
5759 dt = np->msgin[7] & PPR_OPT_DT;
5762 * request or answer ?
5764 if (INB (HS_PRT) == HS_NEGOTIATE) {
5765 OUTB (HS_PRT, HS_BUSY);
5766 if (cp->nego_status && cp->nego_status != NS_PPR)
5772 * check values against our limits.
5774 if (wide > np->maxwide)
5775 {chg = 1; wide = np->maxwide;}
5776 if (!wide || !(np->features & FE_ULTRA3))
5779 if (wide > tp->tinfo.user.width)
5780 {chg = 1; wide = tp->tinfo.user.width;}
5783 if (!(np->features & FE_U3EN)) /* Broken U3EN bit not supported */
5786 if (dt != (np->msgin[7] & PPR_OPT_MASK)) chg = 1;
5790 if (ofs > np->maxoffs_dt)
5791 {chg = 1; ofs = np->maxoffs_dt;}
5793 else if (ofs > np->maxoffs)
5794 {chg = 1; ofs = np->maxoffs;}
5796 if (ofs > tp->tinfo.user.offset)
5797 {chg = 1; ofs = tp->tinfo.user.offset;}
5803 if (per < np->minsync_dt)
5804 {chg = 1; per = np->minsync_dt;}
5806 else if (per < np->minsync)
5807 {chg = 1; per = np->minsync;}
5809 if (per < tp->tinfo.user.period)
5810 {chg = 1; per = tp->tinfo.user.period;}
5815 if (ofs && sym_getsync(np, dt, per, &div, &fak) < 0)
5818 if (DEBUG_FLAGS & DEBUG_NEGO) {
5821 "dt=%x ofs=%d per=%d wide=%d div=%d fak=%d chg=%d.\n",
5822 dt, ofs, per, wide, div, fak, chg);
5829 if (chg) /* Answer wasn't acceptable */
5831 sym_setpprot (np, cp, dt, ofs, per, wide, div, fak);
5832 OUTL_DSP (SCRIPTA_BA (np, clrack));
5837 * It was a request. Set value and
5838 * prepare an answer message
5840 sym_setpprot (np, cp, dt, ofs, per, wide, div, fak);
5842 np->msgout[0] = M_EXTENDED;
5844 np->msgout[2] = M_X_PPR_REQ;
5845 np->msgout[3] = per;
5847 np->msgout[5] = ofs;
5848 np->msgout[6] = wide;
5851 cp->nego_status = NS_PPR;
5853 if (DEBUG_FLAGS & DEBUG_NEGO) {
5854 sym_print_msg(cp, "ppr msgout", np->msgout);
5857 np->msgin [0] = M_NOOP;
5859 OUTL_DSP (SCRIPTB_BA (np, ppr_resp));
5862 sym_setpprot (np, cp, 0, 0, 0, 0, 0, 0);
5863 OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5865 * If it was a device response that should result in
5866 * ST, we may want to try a legacy negotiation later.
5869 tp->tinfo.goal.options = 0;
5870 tp->tinfo.goal.width = wide;
5871 tp->tinfo.goal.period = per;
5872 tp->tinfo.goal.offset = ofs;
5877 * chip handler for WIDE DATA TRANSFER REQUEST (WDTR) message.
5879 static void sym_wide_nego(hcb_p np, tcb_p tp, ccb_p cp)
5885 * Wide request message received.
5887 if (DEBUG_FLAGS & DEBUG_NEGO) {
5888 sym_print_msg(cp, "wide msgin", np->msgin);
5892 * Is it a request from the device?
5894 if (INB (HS_PRT) == HS_NEGOTIATE) {
5895 OUTB (HS_PRT, HS_BUSY);
5896 if (cp->nego_status && cp->nego_status != NS_WIDE)
5902 * get requested values.
5905 wide = np->msgin[3];
5908 * check values against driver limits.
5910 if (wide > np->maxwide)
5911 {chg = 1; wide = np->maxwide;}
5913 if (wide > tp->tinfo.user.width)
5914 {chg = 1; wide = tp->tinfo.user.width;}
5917 if (DEBUG_FLAGS & DEBUG_NEGO) {
5919 kprintf ("wdtr: wide=%d chg=%d.\n", wide, chg);
5923 * This was an answer message
5926 if (chg) /* Answer wasn't acceptable. */
5928 sym_setwide (np, cp, wide);
5931 * Negotiate for SYNC immediately after WIDE response.
5932 * This allows to negotiate for both WIDE and SYNC on
5933 * a single SCSI command (Suggested by Justin Gibbs).
5935 if (tp->tinfo.goal.offset) {
5936 np->msgout[0] = M_EXTENDED;
5938 np->msgout[2] = M_X_SYNC_REQ;
5939 np->msgout[3] = tp->tinfo.goal.period;
5940 np->msgout[4] = tp->tinfo.goal.offset;
5942 if (DEBUG_FLAGS & DEBUG_NEGO) {
5943 sym_print_msg(cp, "sync msgout", np->msgout);
5946 cp->nego_status = NS_SYNC;
5947 OUTB (HS_PRT, HS_NEGOTIATE);
5948 OUTL_DSP (SCRIPTB_BA (np, sdtr_resp));
5952 OUTL_DSP (SCRIPTA_BA (np, clrack));
5957 * It was a request, set value and
5958 * prepare an answer message
5960 sym_setwide (np, cp, wide);
5962 np->msgout[0] = M_EXTENDED;
5964 np->msgout[2] = M_X_WIDE_REQ;
5965 np->msgout[3] = wide;
5967 np->msgin [0] = M_NOOP;
5969 cp->nego_status = NS_WIDE;
5971 if (DEBUG_FLAGS & DEBUG_NEGO) {
5972 sym_print_msg(cp, "wide msgout", np->msgout);
5975 OUTL_DSP (SCRIPTB_BA (np, wdtr_resp));
5978 OUTL_DSP (SCRIPTB_BA (np, msg_bad));
5982 * Reset SYNC or WIDE to default settings.
5984 * Called when a negotiation does not succeed either
5985 * on rejection or on protocol error.
5987 * If it was a PPR that made problems, we may want to
5988 * try a legacy negotiation later.
5990 static void sym_nego_default(hcb_p np, tcb_p tp, ccb_p cp)
5993 * any error in negotiation:
5994 * fall back to default mode.
5996 switch (cp->nego_status) {
5999 sym_setpprot (np, cp, 0, 0, 0, 0, 0, 0);
6001 tp->tinfo.goal.options = 0;
6002 if (tp->tinfo.goal.period < np->minsync)
6003 tp->tinfo.goal.period = np->minsync;
6004 if (tp->tinfo.goal.offset > np->maxoffs)
6005 tp->tinfo.goal.offset = np->maxoffs;
6009 sym_setsync (np, cp, 0, 0, 0, 0);
6012 sym_setwide (np, cp, 0);
6015 np->msgin [0] = M_NOOP;
6016 np->msgout[0] = M_NOOP;
6017 cp->nego_status = 0;
6021 * chip handler for MESSAGE REJECT received in response to
6022 * a WIDE or SYNCHRONOUS negotiation.
6024 static void sym_nego_rejected(hcb_p np, tcb_p tp, ccb_p cp)
6026 sym_nego_default(np, tp, cp);
6027 OUTB (HS_PRT, HS_BUSY);
6031 * chip exception handler for programmed interrupts.
6033 static void sym_int_sir (hcb_p np)
6035 u_char num = INB (nc_dsps);
6036 u32 dsa = INL (nc_dsa);
6037 ccb_p cp = sym_ccb_from_dsa(np, dsa);
6038 u_char target = INB (nc_sdid) & 0x0f;
6039 tcb_p tp = &np->target[target];
6042 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
6044 if (DEBUG_FLAGS & DEBUG_TINY) kprintf ("I#%d", num);
6048 * Command has been completed with error condition
6049 * or has been auto-sensed.
6051 case SIR_COMPLETE_ERROR:
6052 sym_complete_error(np, cp);
6055 * The C code is currently trying to recover from something.
6056 * Typically, user want to abort some command.
6058 case SIR_SCRIPT_STOPPED:
6059 case SIR_TARGET_SELECTED:
6060 case SIR_ABORT_SENT:
6061 sym_sir_task_recovery(np, num);
6064 * The device didn't go to MSG OUT phase after having
6065 * been selected with ATN. We donnot want to handle
6068 case SIR_SEL_ATN_NO_MSG_OUT:
6069 kprintf ("%s:%d: No MSG OUT phase after selection with ATN.\n",
6070 sym_name (np), target);
6073 * The device didn't switch to MSG IN phase after
6074 * having reseleted the initiator.
6076 case SIR_RESEL_NO_MSG_IN:
6077 kprintf ("%s:%d: No MSG IN phase after reselection.\n",
6078 sym_name (np), target);
6081 * After reselection, the device sent a message that wasn't
6084 case SIR_RESEL_NO_IDENTIFY:
6085 kprintf ("%s:%d: No IDENTIFY after reselection.\n",
6086 sym_name (np), target);
6089 * The device reselected a LUN we donnot know about.
6091 case SIR_RESEL_BAD_LUN:
6092 np->msgout[0] = M_RESET;
6095 * The device reselected for an untagged nexus and we
6098 case SIR_RESEL_BAD_I_T_L:
6099 np->msgout[0] = M_ABORT;
6102 * The device reselected for a tagged nexus that we donnot
6105 case SIR_RESEL_BAD_I_T_L_Q:
6106 np->msgout[0] = M_ABORT_TAG;
6109 * The SCRIPTS let us know that the device has grabbed
6110 * our message and will abort the job.
6112 case SIR_RESEL_ABORTED:
6113 np->lastmsg = np->msgout[0];
6114 np->msgout[0] = M_NOOP;
6115 kprintf ("%s:%d: message %x sent on bad reselection.\n",
6116 sym_name (np), target, np->lastmsg);
6119 * The SCRIPTS let us know that a message has been
6120 * successfully sent to the device.
6122 case SIR_MSG_OUT_DONE:
6123 np->lastmsg = np->msgout[0];
6124 np->msgout[0] = M_NOOP;
6125 /* Should we really care of that */
6126 if (np->lastmsg == M_PARITY || np->lastmsg == M_ID_ERROR) {
6128 cp->xerr_status &= ~XE_PARITY_ERR;
6129 if (!cp->xerr_status)
6130 OUTOFFB (HF_PRT, HF_EXT_ERR);
6135 * The device didn't send a GOOD SCSI status.
6136 * We may have some work to do prior to allow
6137 * the SCRIPTS processor to continue.
6139 case SIR_BAD_SCSI_STATUS:
6142 sym_sir_bad_scsi_status(np, num, cp);
6145 * We are asked by the SCRIPTS to prepare a
6148 case SIR_REJECT_TO_SEND:
6149 sym_print_msg(cp, "M_REJECT to send for ", np->msgin);
6150 np->msgout[0] = M_REJECT;
6153 * We have been ODD at the end of a DATA IN
6154 * transfer and the device didn't send a
6155 * IGNORE WIDE RESIDUE message.
6156 * It is a data overrun condition.
6158 case SIR_SWIDE_OVERRUN:
6160 OUTONB (HF_PRT, HF_EXT_ERR);
6161 cp->xerr_status |= XE_SWIDE_OVRUN;
6165 * We have been ODD at the end of a DATA OUT
6167 * It is a data underrun condition.
6169 case SIR_SODL_UNDERRUN:
6171 OUTONB (HF_PRT, HF_EXT_ERR);
6172 cp->xerr_status |= XE_SODL_UNRUN;
6176 * The device wants us to tranfer more data than
6177 * expected or in the wrong direction.
6178 * The number of extra bytes is in scratcha.
6179 * It is a data overrun condition.
6181 case SIR_DATA_OVERRUN:
6183 OUTONB (HF_PRT, HF_EXT_ERR);
6184 cp->xerr_status |= XE_EXTRA_DATA;
6185 cp->extra_bytes += INL (nc_scratcha);
6189 * The device switched to an illegal phase (4/5).
6193 OUTONB (HF_PRT, HF_EXT_ERR);
6194 cp->xerr_status |= XE_BAD_PHASE;
6198 * We received a message.
6200 case SIR_MSG_RECEIVED:
6203 switch (np->msgin [0]) {
6205 * We received an extended message.
6206 * We handle MODIFY DATA POINTER, SDTR, WDTR
6207 * and reject all other extended messages.
6210 switch (np->msgin [2]) {
6212 if (DEBUG_FLAGS & DEBUG_POINTER)
6213 sym_print_msg(cp,"modify DP",np->msgin);
6214 tmp = (np->msgin[3]<<24) + (np->msgin[4]<<16) +
6215 (np->msgin[5]<<8) + (np->msgin[6]);
6216 sym_modify_dp(np, tp, cp, tmp);
6219 sym_sync_nego(np, tp, cp);
6222 sym_ppr_nego(np, tp, cp);
6225 sym_wide_nego(np, tp, cp);
6232 * We received a 1/2 byte message not handled from SCRIPTS.
6233 * We are only expecting MESSAGE REJECT and IGNORE WIDE
6234 * RESIDUE messages that haven't been anticipated by
6235 * SCRIPTS on SWIDE full condition. Unanticipated IGNORE
6236 * WIDE RESIDUE messages are aliased as MODIFY DP (-1).
6239 if (DEBUG_FLAGS & DEBUG_POINTER)
6240 sym_print_msg(cp,"ign wide residue", np->msgin);
6241 sym_modify_dp(np, tp, cp, -1);
6244 if (INB (HS_PRT) == HS_NEGOTIATE)
6245 sym_nego_rejected(np, tp, cp);
6248 kprintf ("M_REJECT received (%x:%x).\n",
6249 scr_to_cpu(np->lastmsg), np->msgout[0]);
6258 * We received an unknown message.
6259 * Ignore all MSG IN phases and reject it.
6262 sym_print_msg(cp, "WEIRD message received", np->msgin);
6263 OUTL_DSP (SCRIPTB_BA (np, msg_weird));
6266 * Negotiation failed.
6267 * Target does not send us the reply.
6268 * Remove the HS_NEGOTIATE status.
6270 case SIR_NEGO_FAILED:
6271 OUTB (HS_PRT, HS_BUSY);
6273 * Negotiation failed.
6274 * Target does not want answer message.
6276 case SIR_NEGO_PROTO:
6277 sym_nego_default(np, tp, cp);
6285 OUTL_DSP (SCRIPTB_BA (np, msg_bad));
6288 OUTL_DSP (SCRIPTA_BA (np, clrack));
6295 * Acquire a control block
6297 static ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order)
6299 tcb_p tp = &np->target[tn];
6300 lcb_p lp = sym_lp(np, tp, ln);
6301 u_short tag = NO_TAG;
6306 * Look for a free CCB
6308 if (sym_que_empty(&np->free_ccbq))
6310 qp = sym_remque_head(&np->free_ccbq);
6313 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
6316 * If the LCB is not yet available and the LUN
6317 * has been probed ok, try to allocate the LCB.
6319 if (!lp && sym_is_bit(tp->lun_map, ln)) {
6320 lp = sym_alloc_lcb(np, tn, ln);
6326 * If the LCB is not available here, then the
6327 * logical unit is not yet discovered. For those
6328 * ones only accept 1 SCSI IO per logical unit,
6329 * since we cannot allow disconnections.
6332 if (!sym_is_bit(tp->busy0_map, ln))
6333 sym_set_bit(tp->busy0_map, ln);
6338 * If we have been asked for a tagged command.
6342 * Debugging purpose.
6344 assert(lp->busy_itl == 0);
6346 * Allocate resources for tags if not yet.
6349 sym_alloc_lcb_tags(np, tn, ln);
6354 * Get a tag for this SCSI IO and set up
6355 * the CCB bus address for reselection,
6356 * and count it for this LUN.
6357 * Toggle reselect path to tagged.
6359 if (lp->busy_itlq < SYM_CONF_MAX_TASK) {
6360 tag = lp->cb_tags[lp->ia_tag];
6361 if (++lp->ia_tag == SYM_CONF_MAX_TASK)
6363 lp->itlq_tbl[tag] = cpu_to_scr(cp->ccb_ba);
6366 cpu_to_scr(SCRIPTA_BA (np, resel_tag));
6372 * This command will not be tagged.
6373 * If we already have either a tagged or untagged
6374 * one, refuse to overlap this untagged one.
6378 * Debugging purpose.
6380 assert(lp->busy_itl == 0 && lp->busy_itlq == 0);
6382 * Count this nexus for this LUN.
6383 * Set up the CCB bus address for reselection.
6384 * Toggle reselect path to untagged.
6386 if (++lp->busy_itl == 1) {
6387 lp->head.itl_task_sa = cpu_to_scr(cp->ccb_ba);
6389 cpu_to_scr(SCRIPTA_BA (np, resel_no_tag));
6396 * Put the CCB into the busy queue.
6398 sym_insque_tail(&cp->link_ccbq, &np->busy_ccbq);
6401 * Remember all informations needed to free this CCB.
6408 if (DEBUG_FLAGS & DEBUG_TAGS) {
6409 PRINT_LUN(np, tn, ln);
6410 kprintf ("ccb @%p using tag %d.\n", cp, tag);
6416 sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6421 * Release one control block
6423 static void sym_free_ccb (hcb_p np, ccb_p cp)
6425 tcb_p tp = &np->target[cp->target];
6426 lcb_p lp = sym_lp(np, tp, cp->lun);
6428 if (DEBUG_FLAGS & DEBUG_TAGS) {
6429 PRINT_LUN(np, cp->target, cp->lun);
6430 kprintf ("ccb @%p freeing tag %d.\n", cp, cp->tag);
6438 * If tagged, release the tag, set the relect path
6440 if (cp->tag != NO_TAG) {
6442 * Free the tag value.
6444 lp->cb_tags[lp->if_tag] = cp->tag;
6445 if (++lp->if_tag == SYM_CONF_MAX_TASK)
6448 * Make the reselect path invalid,
6449 * and uncount this CCB.
6451 lp->itlq_tbl[cp->tag] = cpu_to_scr(np->bad_itlq_ba);
6453 } else { /* Untagged */
6455 * Make the reselect path invalid,
6456 * and uncount this CCB.
6458 lp->head.itl_task_sa = cpu_to_scr(np->bad_itl_ba);
6462 * If no JOB active, make the LUN reselect path invalid.
6464 if (lp->busy_itlq == 0 && lp->busy_itl == 0)
6466 cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
6469 * Otherwise, we only accept 1 IO per LUN.
6470 * Clear the bit that keeps track of this IO.
6473 sym_clr_bit(tp->busy0_map, cp->lun);
6476 * We donnot queue more than 1 ccb per target
6477 * with negotiation at any time. If this ccb was
6478 * used for negotiation, clear this info in the tcb.
6480 if (cp == tp->nego_cp)
6483 #ifdef SYM_CONF_IARB_SUPPORT
6485 * If we just complete the last queued CCB,
6486 * clear this info that is no longer relevant.
6488 if (cp == np->last_cp)
6493 * Unmap user data from DMA map if needed.
6495 if (cp->dmamapped) {
6496 bus_dmamap_unload(np->data_dmat, cp->dmamap);
6501 * Make this CCB available.
6504 cp->host_status = HS_IDLE;
6505 sym_remque(&cp->link_ccbq);
6506 sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6510 * Allocate a CCB from memory and initialize its fixed part.
6512 static ccb_p sym_alloc_ccb(hcb_p np)
6520 * Prevent from allocating more CCBs than we can
6521 * queue to the controller.
6523 if (np->actccbs >= SYM_CONF_MAX_START)
6527 * Allocate memory for this CCB.
6529 cp = sym_calloc_dma(sizeof(struct sym_ccb), "CCB");
6534 * Allocate a bounce buffer for sense data.
6536 cp->sns_bbuf = sym_calloc_dma(SYM_SNS_BBUF_LEN, "SNS_BBUF");
6541 * Allocate a map for the DMA of user data.
6543 if (bus_dmamap_create(np->data_dmat, 0, &cp->dmamap))
6551 * Initialize the callout.
6553 callout_init(&cp->ch);
6556 * Compute the bus address of this ccb.
6558 cp->ccb_ba = vtobus(cp);
6561 * Insert this ccb into the hashed list.
6563 hcode = CCB_HASH_CODE(cp->ccb_ba);
6564 cp->link_ccbh = np->ccbh[hcode];
6565 np->ccbh[hcode] = cp;
6568 * Initialize the start and restart actions.
6570 cp->phys.head.go.start = cpu_to_scr(SCRIPTA_BA (np, idle));
6571 cp->phys.head.go.restart = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
6574 * Initilialyze some other fields.
6576 cp->phys.smsg_ext.addr = cpu_to_scr(HCB_BA(np, msgin[2]));
6579 * Chain into free ccb queue.
6581 sym_insque_head(&cp->link_ccbq, &np->free_ccbq);
6586 sym_mfree_dma(cp->sns_bbuf, SYM_SNS_BBUF_LEN, "SNS_BBUF");
6587 sym_mfree_dma(cp, sizeof(*cp), "CCB");
6592 * Look up a CCB from a DSA value.
6594 static ccb_p sym_ccb_from_dsa(hcb_p np, u32 dsa)
6599 hcode = CCB_HASH_CODE(dsa);
6600 cp = np->ccbh[hcode];
6602 if (cp->ccb_ba == dsa)
6611 * Target control block initialisation.
6612 * Nothing important to do at the moment.
6614 static void sym_init_tcb (hcb_p np, u_char tn)
6617 * Check some alignments required by the chip.
6619 assert (((offsetof(struct sym_reg, nc_sxfer) ^
6620 offsetof(struct sym_tcb, head.sval)) &3) == 0);
6621 assert (((offsetof(struct sym_reg, nc_scntl3) ^
6622 offsetof(struct sym_tcb, head.wval)) &3) == 0);
6626 * Lun control block allocation and initialization.
6628 static lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln)
6630 tcb_p tp = &np->target[tn];
6631 lcb_p lp = sym_lp(np, tp, ln);
6634 * Already done, just return.
6639 * Check against some race.
6641 assert(!sym_is_bit(tp->busy0_map, ln));
6644 * Initialize the target control block if not yet.
6646 sym_init_tcb (np, tn);
6649 * Allocate the LCB bus address array.
6650 * Compute the bus address of this table.
6652 if (ln && !tp->luntbl) {
6655 tp->luntbl = sym_calloc_dma(256, "LUNTBL");
6658 for (i = 0 ; i < 64 ; i++)
6659 tp->luntbl[i] = cpu_to_scr(vtobus(&np->badlun_sa));
6660 tp->head.luntbl_sa = cpu_to_scr(vtobus(tp->luntbl));
6664 * Allocate the table of pointers for LUN(s) > 0, if needed.
6666 if (ln && !tp->lunmp) {
6667 tp->lunmp = sym_calloc(SYM_CONF_MAX_LUN * sizeof(lcb_p),
6675 * Make it available to the chip.
6677 lp = sym_calloc_dma(sizeof(struct sym_lcb), "LCB");
6682 tp->luntbl[ln] = cpu_to_scr(vtobus(lp));
6686 tp->head.lun0_sa = cpu_to_scr(vtobus(lp));
6690 * Let the itl task point to error handling.
6692 lp->head.itl_task_sa = cpu_to_scr(np->bad_itl_ba);
6695 * Set the reselect pattern to our default. :)
6697 lp->head.resel_sa = cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
6700 * Set user capabilities.
6702 lp->user_flags = tp->usrflags & (SYM_DISC_ENABLED | SYM_TAGS_ENABLED);
6709 * Allocate LCB resources for tagged command queuing.
6711 static void sym_alloc_lcb_tags (hcb_p np, u_char tn, u_char ln)
6713 tcb_p tp = &np->target[tn];
6714 lcb_p lp = sym_lp(np, tp, ln);
6718 * If LCB not available, try to allocate it.
6720 if (!lp && !(lp = sym_alloc_lcb(np, tn, ln)))
6724 * Allocate the task table and and the tag allocation
6725 * circular buffer. We want both or none.
6727 lp->itlq_tbl = sym_calloc_dma(SYM_CONF_MAX_TASK*4, "ITLQ_TBL");
6730 lp->cb_tags = sym_calloc(SYM_CONF_MAX_TASK, "CB_TAGS");
6732 sym_mfree_dma(lp->itlq_tbl, SYM_CONF_MAX_TASK*4, "ITLQ_TBL");
6733 lp->itlq_tbl = NULL;
6738 * Initialize the task table with invalid entries.
6740 for (i = 0 ; i < SYM_CONF_MAX_TASK ; i++)
6741 lp->itlq_tbl[i] = cpu_to_scr(np->notask_ba);
6744 * Fill up the tag buffer with tag numbers.
6746 for (i = 0 ; i < SYM_CONF_MAX_TASK ; i++)
6750 * Make the task table available to SCRIPTS,
6751 * And accept tagged commands now.
6753 lp->head.itlq_tbl_sa = cpu_to_scr(vtobus(lp->itlq_tbl));
6757 * Test the pci bus snoop logic :-(
6759 * Has to be called with interrupts disabled.
6761 #ifndef SYM_CONF_IOMAPPED
6762 static int sym_regtest (hcb_p np)
6766 * chip registers may NOT be cached.
6767 * write 0xffffffff to a read only register area,
6768 * and try to read it back.
6771 OUTL_OFF(offsetof(struct sym_reg, nc_dstat), data);
6772 data = INL_OFF(offsetof(struct sym_reg, nc_dstat));
6774 if (data == 0xffffffff) {
6776 if ((data & 0xe2f0fffd) != 0x02000080) {
6778 kprintf ("CACHE TEST FAILED: reg dstat-sstat2 readback %x.\n",
6786 static int sym_snooptest (hcb_p np)
6788 u32 sym_rd, sym_wr, sym_bk, host_rd, host_wr, pc, dstat;
6790 #ifndef SYM_CONF_IOMAPPED
6791 err |= sym_regtest (np);
6792 if (err) return (err);
6796 * Enable Master Parity Checking as we intend
6797 * to enable it for normal operations.
6799 OUTB (nc_ctest4, (np->rv_ctest4 & MPEE));
6803 pc = SCRIPTB0_BA (np, snooptest);
6807 * Set memory and register.
6809 np->cache = cpu_to_scr(host_wr);
6810 OUTL (nc_temp, sym_wr);
6812 * Start script (exchange values)
6814 OUTL (nc_dsa, np->hcb_ba);
6817 * Wait 'til done (with timeout)
6819 for (i=0; i<SYM_SNOOP_TIMEOUT; i++)
6820 if (INB(nc_istat) & (INTF|SIP|DIP))
6822 if (i>=SYM_SNOOP_TIMEOUT) {
6823 kprintf ("CACHE TEST FAILED: timeout.\n");
6827 * Check for fatal DMA errors.
6829 dstat = INB (nc_dstat);
6830 #if 1 /* Band aiding for broken hardwares that fail PCI parity */
6831 if ((dstat & MDPE) && (np->rv_ctest4 & MPEE)) {
6832 kprintf ("%s: PCI DATA PARITY ERROR DETECTED - "
6833 "DISABLING MASTER DATA PARITY CHECKING.\n",
6835 np->rv_ctest4 &= ~MPEE;
6839 if (dstat & (MDPE|BF|IID)) {
6840 kprintf ("CACHE TEST FAILED: DMA error (dstat=0x%02x).", dstat);
6844 * Save termination position.
6848 * Read memory and register.
6850 host_rd = scr_to_cpu(np->cache);
6851 sym_rd = INL (nc_scratcha);
6852 sym_bk = INL (nc_temp);
6855 * Check termination position.
6857 if (pc != SCRIPTB0_BA (np, snoopend)+8) {
6858 kprintf ("CACHE TEST FAILED: script execution failed.\n");
6859 kprintf ("start=%08lx, pc=%08lx, end=%08lx\n",
6860 (u_long) SCRIPTB0_BA (np, snooptest), (u_long) pc,
6861 (u_long) SCRIPTB0_BA (np, snoopend) +8);
6867 if (host_wr != sym_rd) {
6868 kprintf ("CACHE TEST FAILED: host wrote %d, chip read %d.\n",
6869 (int) host_wr, (int) sym_rd);
6872 if (host_rd != sym_wr) {
6873 kprintf ("CACHE TEST FAILED: chip wrote %d, host read %d.\n",
6874 (int) sym_wr, (int) host_rd);
6877 if (sym_bk != sym_wr) {
6878 kprintf ("CACHE TEST FAILED: chip wrote %d, read back %d.\n",
6879 (int) sym_wr, (int) sym_bk);
6887 * Determine the chip's clock frequency.
6889 * This is essential for the negotiation of the synchronous
6892 * Note: we have to return the correct value.
6893 * THERE IS NO SAFE DEFAULT VALUE.
6895 * Most NCR/SYMBIOS boards are delivered with a 40 Mhz clock.
6896 * 53C860 and 53C875 rev. 1 support fast20 transfers but
6897 * do not have a clock doubler and so are provided with a
6898 * 80 MHz clock. All other fast20 boards incorporate a doubler
6899 * and so should be delivered with a 40 MHz clock.
6900 * The recent fast40 chips (895/896/895A/1010) use a 40 Mhz base
6901 * clock and provide a clock quadrupler (160 Mhz).
6905 * Select SCSI clock frequency
6907 static void sym_selectclock(hcb_p np, u_char scntl3)
6910 * If multiplier not present or not selected, leave here.
6912 if (np->multiplier <= 1) {
6913 OUTB(nc_scntl3, scntl3);
6917 if (sym_verbose >= 2)
6918 kprintf ("%s: enabling clock multiplier\n", sym_name(np));
6920 OUTB(nc_stest1, DBLEN); /* Enable clock multiplier */
6922 * Wait for the LCKFRQ bit to be set if supported by the chip.
6923 * Otherwise wait 20 micro-seconds.
6925 if (np->features & FE_LCKFRQ) {
6927 while (!(INB(nc_stest4) & LCKFRQ) && --i > 0)
6930 kprintf("%s: the chip cannot lock the frequency\n",
6934 OUTB(nc_stest3, HSC); /* Halt the scsi clock */
6935 OUTB(nc_scntl3, scntl3);
6936 OUTB(nc_stest1, (DBLEN|DBLSEL));/* Select clock multiplier */
6937 OUTB(nc_stest3, 0x00); /* Restart scsi clock */
6941 * calculate SCSI clock frequency (in KHz)
6943 static unsigned getfreq (hcb_p np, int gen)
6945 unsigned int ms = 0;
6949 * Measure GEN timer delay in order
6950 * to calculate SCSI clock frequency
6952 * This code will never execute too
6953 * many loop iterations (if DELAY is
6954 * reasonably correct). It could get
6955 * too low a delay (too high a freq.)
6956 * if the CPU is slow executing the
6957 * loop for some reason (an NMI, for
6958 * example). For this reason we will
6959 * if multiple measurements are to be
6960 * performed trust the higher delay
6961 * (lower frequency returned).
6963 OUTW (nc_sien , 0); /* mask all scsi interrupts */
6964 (void) INW (nc_sist); /* clear pending scsi interrupt */
6965 OUTB (nc_dien , 0); /* mask all dma interrupts */
6966 (void) INW (nc_sist); /* another one, just to be sure :) */
6967 OUTB (nc_scntl3, 4); /* set pre-scaler to divide by 3 */
6968 OUTB (nc_stime1, 0); /* disable general purpose timer */
6969 OUTB (nc_stime1, gen); /* set to nominal delay of 1<<gen * 125us */
6970 while (!(INW(nc_sist) & GEN) && ms++ < 100000)
6971 UDELAY (1000); /* count ms */
6972 OUTB (nc_stime1, 0); /* disable general purpose timer */
6974 * set prescaler to divide by whatever 0 means
6975 * 0 ought to choose divide by 2, but appears
6976 * to set divide by 3.5 mode in my 53c810 ...
6978 OUTB (nc_scntl3, 0);
6981 * adjust for prescaler, and convert into KHz
6983 f = ms ? ((1 << gen) * 4340) / ms : 0;
6985 if (sym_verbose >= 2)
6986 kprintf ("%s: Delay (GEN=%d): %u msec, %u KHz\n",
6987 sym_name(np), gen, ms, f);
6992 static unsigned sym_getfreq (hcb_p np)
6997 (void) getfreq (np, gen); /* throw away first result */
6998 f1 = getfreq (np, gen);
6999 f2 = getfreq (np, gen);
7000 if (f1 > f2) f1 = f2; /* trust lower result */
7005 * Get/probe chip SCSI clock frequency
7007 static void sym_getclock (hcb_p np, int mult)
7009 unsigned char scntl3 = np->sv_scntl3;
7010 unsigned char stest1 = np->sv_stest1;
7014 * For the C10 core, assume 40 MHz.
7016 if (np->features & FE_C10) {
7017 np->multiplier = mult;
7018 np->clock_khz = 40000 * mult;
7025 * True with 875/895/896/895A with clock multiplier selected
7027 if (mult > 1 && (stest1 & (DBLEN+DBLSEL)) == DBLEN+DBLSEL) {
7028 if (sym_verbose >= 2)
7029 kprintf ("%s: clock multiplier found\n", sym_name(np));
7030 np->multiplier = mult;
7034 * If multiplier not found or scntl3 not 7,5,3,
7035 * reset chip and get frequency from general purpose timer.
7036 * Otherwise trust scntl3 BIOS setting.
7038 if (np->multiplier != mult || (scntl3 & 7) < 3 || !(scntl3 & 1)) {
7039 OUTB (nc_stest1, 0); /* make sure doubler is OFF */
7040 f1 = sym_getfreq (np);
7043 kprintf ("%s: chip clock is %uKHz\n", sym_name(np), f1);
7045 if (f1 < 45000) f1 = 40000;
7046 else if (f1 < 55000) f1 = 50000;
7049 if (f1 < 80000 && mult > 1) {
7050 if (sym_verbose >= 2)
7051 kprintf ("%s: clock multiplier assumed\n",
7053 np->multiplier = mult;
7056 if ((scntl3 & 7) == 3) f1 = 40000;
7057 else if ((scntl3 & 7) == 5) f1 = 80000;
7060 f1 /= np->multiplier;
7064 * Compute controller synchronous parameters.
7066 f1 *= np->multiplier;
7071 * Get/probe PCI clock frequency
7073 static int sym_getpciclock (hcb_p np)
7078 * For the C1010-33, this doesn't work.
7079 * For the C1010-66, this will be tested when I'll have
7080 * such a beast to play with.
7082 if (!(np->features & FE_C10)) {
7083 OUTB (nc_stest1, SCLK); /* Use the PCI clock as SCSI clock */
7084 f = (int) sym_getfreq (np);
7085 OUTB (nc_stest1, 0);
7092 /*============= DRIVER ACTION/COMPLETION ====================*/
7095 * Print something that tells about extended errors.
7097 static void sym_print_xerr(ccb_p cp, int x_status)
7099 if (x_status & XE_PARITY_ERR) {
7101 kprintf ("unrecovered SCSI parity error.\n");
7103 if (x_status & XE_EXTRA_DATA) {
7105 kprintf ("extraneous data discarded.\n");
7107 if (x_status & XE_BAD_PHASE) {
7109 kprintf ("illegal scsi phase (4/5).\n");
7111 if (x_status & XE_SODL_UNRUN) {
7113 kprintf ("ODD transfer in DATA OUT phase.\n");
7115 if (x_status & XE_SWIDE_OVRUN) {
7117 kprintf ("ODD transfer in DATA IN phase.\n");
7122 * Choose the more appropriate CAM status if
7123 * the IO encountered an extended error.
7125 static int sym_xerr_cam_status(int cam_status, int x_status)
7128 if (x_status & XE_PARITY_ERR)
7129 cam_status = CAM_UNCOR_PARITY;
7130 else if (x_status &(XE_EXTRA_DATA|XE_SODL_UNRUN|XE_SWIDE_OVRUN))
7131 cam_status = CAM_DATA_RUN_ERR;
7132 else if (x_status & XE_BAD_PHASE)
7133 cam_status = CAM_REQ_CMP_ERR;
7135 cam_status = CAM_REQ_CMP_ERR;
7141 * Complete execution of a SCSI command with extented
7142 * error, SCSI status error, or having been auto-sensed.
7144 * The SCRIPTS processor is not running there, so we
7145 * can safely access IO registers and remove JOBs from
7147 * SCRATCHA is assumed to have been loaded with STARTPOS
7148 * before the SCRIPTS called the C code.
7150 static void sym_complete_error (hcb_p np, ccb_p cp)
7152 struct ccb_scsiio *csio;
7154 int i, sense_returned;
7156 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7159 * Paranoid check. :)
7161 if (!cp || !cp->cam_ccb)
7164 if (DEBUG_FLAGS & (DEBUG_TINY|DEBUG_RESULT)) {
7165 kprintf ("CCB=%lx STAT=%x/%x/%x DEV=%d/%d\n", (unsigned long)cp,
7166 cp->host_status, cp->ssss_status, cp->host_flags,
7167 cp->target, cp->lun);
7172 * Get CAM command pointer.
7174 csio = &cp->cam_ccb->csio;
7177 * Check for extended errors.
7179 if (cp->xerr_status) {
7181 sym_print_xerr(cp, cp->xerr_status);
7182 if (cp->host_status == HS_COMPLETE)
7183 cp->host_status = HS_COMP_ERR;
7187 * Calculate the residual.
7189 csio->sense_resid = 0;
7190 csio->resid = sym_compute_residual(np, cp);
7192 if (!SYM_CONF_RESIDUAL_SUPPORT) {/* If user does not want residuals */
7193 csio->resid = 0; /* throw them away. :) */
7197 if (cp->host_flags & HF_SENSE) { /* Auto sense */
7198 csio->scsi_status = cp->sv_scsi_status; /* Restore status */
7199 csio->sense_resid = csio->resid; /* Swap residuals */
7200 csio->resid = cp->sv_resid;
7202 if (sym_verbose && cp->sv_xerr_status)
7203 sym_print_xerr(cp, cp->sv_xerr_status);
7204 if (cp->host_status == HS_COMPLETE &&
7205 cp->ssss_status == S_GOOD &&
7206 cp->xerr_status == 0) {
7207 cam_status = sym_xerr_cam_status(CAM_SCSI_STATUS_ERROR,
7208 cp->sv_xerr_status);
7209 cam_status |= CAM_AUTOSNS_VALID;
7211 * Bounce back the sense data to user and
7214 bzero(&csio->sense_data, sizeof(csio->sense_data));
7215 sense_returned = SYM_SNS_BBUF_LEN - csio->sense_resid;
7216 if (sense_returned < csio->sense_len)
7217 csio->sense_resid = csio->sense_len -
7220 csio->sense_resid = 0;
7221 bcopy(cp->sns_bbuf, &csio->sense_data,
7222 MIN(csio->sense_len, sense_returned));
7225 * If the device reports a UNIT ATTENTION condition
7226 * due to a RESET condition, we should consider all
7227 * disconnect CCBs for this unit as aborted.
7231 p = (u_char *) csio->sense_data;
7232 if (p[0]==0x70 && p[2]==0x6 && p[12]==0x29)
7233 sym_clear_tasks(np, CAM_REQ_ABORTED,
7234 cp->target,cp->lun, -1);
7239 cam_status = CAM_AUTOSENSE_FAIL;
7241 else if (cp->host_status == HS_COMPLETE) { /* Bad SCSI status */
7242 csio->scsi_status = cp->ssss_status;
7243 cam_status = CAM_SCSI_STATUS_ERROR;
7245 else if (cp->host_status == HS_SEL_TIMEOUT) /* Selection timeout */
7246 cam_status = CAM_SEL_TIMEOUT;
7247 else if (cp->host_status == HS_UNEXPECTED) /* Unexpected BUS FREE*/
7248 cam_status = CAM_UNEXP_BUSFREE;
7249 else { /* Extended error */
7252 kprintf ("COMMAND FAILED (%x %x %x).\n",
7253 cp->host_status, cp->ssss_status,
7256 csio->scsi_status = cp->ssss_status;
7258 * Set the most appropriate value for CAM status.
7260 cam_status = sym_xerr_cam_status(CAM_REQ_CMP_ERR,
7265 * Dequeue all queued CCBs for that device
7266 * not yet started by SCRIPTS.
7268 i = (INL (nc_scratcha) - np->squeue_ba) / 4;
7269 (void) sym_dequeue_from_squeue(np, i, cp->target, cp->lun, -1);
7272 * Restart the SCRIPTS processor.
7274 OUTL_DSP (SCRIPTA_BA (np, start));
7277 * Synchronize DMA map if needed.
7279 if (cp->dmamapped) {
7280 bus_dmamap_sync(np->data_dmat, cp->dmamap,
7281 (cp->dmamapped == SYM_DMA_READ ?
7282 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE));
7285 * Add this one to the COMP queue.
7286 * Complete all those commands with either error
7287 * or requeue condition.
7289 sym_set_cam_status((union ccb *) csio, cam_status);
7290 sym_remque(&cp->link_ccbq);
7291 sym_insque_head(&cp->link_ccbq, &np->comp_ccbq);
7292 sym_flush_comp_queue(np, 0);
7296 * Complete execution of a successful SCSI command.
7298 * Only successful commands go to the DONE queue,
7299 * since we need to have the SCRIPTS processor
7300 * stopped on any error condition.
7301 * The SCRIPTS processor is running while we are
7302 * completing successful commands.
7304 static void sym_complete_ok (hcb_p np, ccb_p cp)
7306 struct ccb_scsiio *csio;
7310 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7313 * Paranoid check. :)
7315 if (!cp || !cp->cam_ccb)
7317 assert (cp->host_status == HS_COMPLETE);
7320 * Get command, target and lun pointers.
7322 csio = &cp->cam_ccb->csio;
7323 tp = &np->target[cp->target];
7324 lp = sym_lp(np, tp, cp->lun);
7327 * Assume device discovered on first success.
7330 sym_set_bit(tp->lun_map, cp->lun);
7333 * If all data have been transferred, given than no
7334 * extended error did occur, there is no residual.
7337 if (cp->phys.head.lastp != cp->phys.head.goalp)
7338 csio->resid = sym_compute_residual(np, cp);
7341 * Wrong transfer residuals may be worse than just always
7342 * returning zero. User can disable this feature from
7343 * sym_conf.h. Residual support is enabled by default.
7345 if (!SYM_CONF_RESIDUAL_SUPPORT)
7349 * Synchronize DMA map if needed.
7351 if (cp->dmamapped) {
7352 bus_dmamap_sync(np->data_dmat, cp->dmamap,
7353 (cp->dmamapped == SYM_DMA_READ ?
7354 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE));
7357 * Set status and complete the command.
7359 csio->scsi_status = cp->ssss_status;
7360 sym_set_cam_status((union ccb *) csio, CAM_REQ_CMP);
7361 sym_xpt_done(np, (union ccb *) csio, cp);
7362 sym_free_ccb(np, cp);
7366 * Our callout handler
7368 static void sym_callout(void *arg)
7370 union ccb *ccb = (union ccb *) arg;
7371 hcb_p np = ccb->ccb_h.sym_hcb_ptr;
7374 * Check that the CAM CCB is still queued.
7381 switch(ccb->ccb_h.func_code) {
7383 (void) sym_abort_scsiio(np, ccb, 1);
7395 static int sym_abort_scsiio(hcb_p np, union ccb *ccb, int timed_out)
7400 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7403 * Look up our CCB control block.
7406 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
7407 ccb_p cp2 = sym_que_entry(qp, struct sym_ccb, link_ccbq);
7408 if (cp2->cam_ccb == ccb) {
7413 if (!cp || cp->host_status == HS_WAIT)
7417 * If a previous abort didn't succeed in time,
7418 * perform a BUS reset.
7421 sym_reset_scsi_bus(np, 1);
7426 * Mark the CCB for abort and allow time for.
7428 cp->to_abort = timed_out ? 2 : 1;
7429 callout_reset(&cp->ch, 10 * hz, sym_callout, (caddr_t) ccb);
7432 * Tell the SCRIPTS processor to stop and synchronize with us.
7434 np->istat_sem = SEM;
7435 OUTB (nc_istat, SIGP|SEM);
7440 * Reset a SCSI device (all LUNs of a target).
7442 static void sym_reset_dev(hcb_p np, union ccb *ccb)
7445 struct ccb_hdr *ccb_h = &ccb->ccb_h;
7447 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7449 if (ccb_h->target_id == np->myaddr ||
7450 ccb_h->target_id >= SYM_CONF_MAX_TARGET ||
7451 ccb_h->target_lun >= SYM_CONF_MAX_LUN) {
7452 sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7456 tp = &np->target[ccb_h->target_id];
7459 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
7461 np->istat_sem = SEM;
7462 OUTB (nc_istat, SIGP|SEM);
7466 * SIM action entry point.
7468 static void sym_action(struct cam_sim *sim, union ccb *ccb)
7475 u_char idmsg, *msgptr;
7477 struct ccb_scsiio *csio;
7478 struct ccb_hdr *ccb_h;
7480 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE, ("sym_action\n"));
7483 * Retrieve our controller data structure.
7485 np = (hcb_p) cam_sim_softc(sim);
7487 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7490 * The common case is SCSI IO.
7491 * We deal with other ones elsewhere.
7493 if (ccb->ccb_h.func_code != XPT_SCSI_IO) {
7494 sym_action2(sim, ccb);
7498 ccb_h = &csio->ccb_h;
7501 * Work around races.
7503 if ((ccb_h->status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
7509 * Minimal checkings, so that we will not
7510 * go outside our tables.
7512 if (ccb_h->target_id == np->myaddr ||
7513 ccb_h->target_id >= SYM_CONF_MAX_TARGET ||
7514 ccb_h->target_lun >= SYM_CONF_MAX_LUN) {
7515 sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7520 * Retrieve the target and lun descriptors.
7522 tp = &np->target[ccb_h->target_id];
7523 lp = sym_lp(np, tp, ccb_h->target_lun);
7526 * Complete the 1st INQUIRY command with error
7527 * condition if the device is flagged NOSCAN
7528 * at BOOT in the NVRAM. This may speed up
7529 * the boot and maintain coherency with BIOS
7530 * device numbering. Clearing the flag allows
7531 * user to rescan skipped devices later.
7532 * We also return error for devices not flagged
7533 * for SCAN LUNS in the NVRAM since some mono-lun
7534 * devices behave badly when asked for some non
7535 * zero LUN. Btw, this is an absolute hack.:-)
7537 if (!(ccb_h->flags & CAM_CDB_PHYS) &&
7538 (0x12 == ((ccb_h->flags & CAM_CDB_POINTER) ?
7539 csio->cdb_io.cdb_ptr[0] : csio->cdb_io.cdb_bytes[0]))) {
7540 if ((tp->usrflags & SYM_SCAN_BOOT_DISABLED) ||
7541 ((tp->usrflags & SYM_SCAN_LUNS_DISABLED) &&
7542 ccb_h->target_lun != 0)) {
7543 tp->usrflags &= ~SYM_SCAN_BOOT_DISABLED;
7544 sym_xpt_done2(np, ccb, CAM_DEV_NOT_THERE);
7550 * Get a control block for this IO.
7552 tmp = ((ccb_h->flags & CAM_TAG_ACTION_VALID) != 0);
7553 cp = sym_get_ccb(np, ccb_h->target_id, ccb_h->target_lun, tmp);
7555 sym_xpt_done2(np, ccb, CAM_RESRC_UNAVAIL);
7560 * Keep track of the IO in our CCB.
7565 * Build the IDENTIFY message.
7567 idmsg = M_IDENTIFY | cp->lun;
7568 if (cp->tag != NO_TAG || (lp && (lp->current_flags & SYM_DISC_ENABLED)))
7571 msgptr = cp->scsi_smsg;
7573 msgptr[msglen++] = idmsg;
7576 * Build the tag message if present.
7578 if (cp->tag != NO_TAG) {
7579 u_char order = csio->tag_action;
7587 order = M_SIMPLE_TAG;
7589 msgptr[msglen++] = order;
7592 * For less than 128 tags, actual tags are numbered
7593 * 1,3,5,..2*MAXTAGS+1,since we may have to deal
7594 * with devices that have problems with #TAG 0 or too
7595 * great #TAG numbers. For more tags (up to 256),
7596 * we use directly our tag number.
7598 #if SYM_CONF_MAX_TASK > (512/4)
7599 msgptr[msglen++] = cp->tag;
7601 msgptr[msglen++] = (cp->tag << 1) + 1;
7606 * Build a negotiation message if needed.
7607 * (nego_status is filled by sym_prepare_nego())
7609 cp->nego_status = 0;
7610 if (tp->tinfo.current.width != tp->tinfo.goal.width ||
7611 tp->tinfo.current.period != tp->tinfo.goal.period ||
7612 tp->tinfo.current.offset != tp->tinfo.goal.offset ||
7613 tp->tinfo.current.options != tp->tinfo.goal.options) {
7614 if (!tp->nego_cp && lp)
7615 msglen += sym_prepare_nego(np, cp, 0, msgptr + msglen);
7625 cp->phys.head.go.start = cpu_to_scr(SCRIPTA_BA (np, select));
7626 cp->phys.head.go.restart = cpu_to_scr(SCRIPTA_BA (np, resel_dsa));
7631 cp->phys.select.sel_id = cp->target;
7632 cp->phys.select.sel_scntl3 = tp->head.wval;
7633 cp->phys.select.sel_sxfer = tp->head.sval;
7634 cp->phys.select.sel_scntl4 = tp->head.uval;
7639 cp->phys.smsg.addr = cpu_to_scr(CCB_BA (cp, scsi_smsg));
7640 cp->phys.smsg.size = cpu_to_scr(msglen);
7645 if (sym_setup_cdb(np, csio, cp) < 0) {
7646 sym_xpt_done(np, ccb, cp);
7647 sym_free_ccb(np, cp);
7654 #if 0 /* Provision */
7655 cp->actualquirks = tp->quirks;
7657 cp->actualquirks = SYM_QUIRK_AUTOSAVE;
7658 cp->host_status = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
7659 cp->ssss_status = S_ILLEGAL;
7660 cp->xerr_status = 0;
7662 cp->extra_bytes = 0;
7665 * extreme data pointer.
7666 * shall be positive, so -1 is lower than lowest.:)
7672 * Build the data descriptor block
7675 sym_setup_data_and_start(np, csio, cp);
7679 * Setup buffers and pointers that address the CDB.
7680 * I bet, physical CDBs will never be used on the planet,
7681 * since they can be bounced without significant overhead.
7683 static int sym_setup_cdb(hcb_p np, struct ccb_scsiio *csio, ccb_p cp)
7685 struct ccb_hdr *ccb_h;
7689 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7691 ccb_h = &csio->ccb_h;
7694 * CDB is 16 bytes max.
7696 if (csio->cdb_len > sizeof(cp->cdb_buf)) {
7697 sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7700 cmd_len = csio->cdb_len;
7702 if (ccb_h->flags & CAM_CDB_POINTER) {
7703 /* CDB is a pointer */
7704 if (!(ccb_h->flags & CAM_CDB_PHYS)) {
7705 /* CDB pointer is virtual */
7706 bcopy(csio->cdb_io.cdb_ptr, cp->cdb_buf, cmd_len);
7707 cmd_ba = CCB_BA (cp, cdb_buf[0]);
7709 /* CDB pointer is physical */
7711 cmd_ba = ((u32)csio->cdb_io.cdb_ptr) & 0xffffffff;
7713 sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7718 /* CDB is in the CAM ccb (buffer) */
7719 bcopy(csio->cdb_io.cdb_bytes, cp->cdb_buf, cmd_len);
7720 cmd_ba = CCB_BA (cp, cdb_buf[0]);
7723 cp->phys.cmd.addr = cpu_to_scr(cmd_ba);
7724 cp->phys.cmd.size = cpu_to_scr(cmd_len);
7730 * Set up data pointers used by SCRIPTS.
7732 static __inline void
7733 sym_setup_data_pointers(hcb_p np, ccb_p cp, int dir)
7737 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7740 * No segments means no data.
7746 * Set the data pointer.
7750 goalp = SCRIPTA_BA (np, data_out2) + 8;
7751 lastp = goalp - 8 - (cp->segments * (2*4));
7754 cp->host_flags |= HF_DATA_IN;
7755 goalp = SCRIPTA_BA (np, data_in2) + 8;
7756 lastp = goalp - 8 - (cp->segments * (2*4));
7760 lastp = goalp = SCRIPTB_BA (np, no_data);
7764 cp->phys.head.lastp = cpu_to_scr(lastp);
7765 cp->phys.head.goalp = cpu_to_scr(goalp);
7766 cp->phys.head.savep = cpu_to_scr(lastp);
7767 cp->startp = cp->phys.head.savep;
7772 * Call back routine for the DMA map service.
7773 * If bounce buffers are used (why ?), we may sleep and then
7774 * be called there in another context.
7777 sym_execute_ccb(void *arg, bus_dma_segment_t *psegs, int nsegs, int error)
7785 np = (hcb_p) cp->arg;
7787 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7790 * Deal with weird races.
7792 if (sym_get_cam_status(ccb) != CAM_REQ_INPROG)
7796 * Deal with weird errors.
7800 sym_set_cam_status(cp->cam_ccb, CAM_REQ_ABORTED);
7805 * Build the data descriptor for the chip.
7809 /* 896 rev 1 requires to be careful about boundaries */
7810 if (np->device_id == PCI_ID_SYM53C896 && np->revision_id <= 1)
7811 retv = sym_scatter_sg_physical(np, cp, psegs, nsegs);
7813 retv = sym_fast_scatter_sg_physical(np,cp, psegs,nsegs);
7815 sym_set_cam_status(cp->cam_ccb, CAM_REQ_TOO_BIG);
7821 * Synchronize the DMA map only if we have
7822 * actually mapped the data.
7824 if (cp->dmamapped) {
7825 bus_dmamap_sync(np->data_dmat, cp->dmamap,
7826 (cp->dmamapped == SYM_DMA_READ ?
7827 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE));
7831 * Set host status to busy state.
7832 * May have been set back to HS_WAIT to avoid a race.
7834 cp->host_status = cp->nego_status ? HS_NEGOTIATE : HS_BUSY;
7837 * Set data pointers.
7839 sym_setup_data_pointers(np, cp, (ccb->ccb_h.flags & CAM_DIR_MASK));
7842 * Enqueue this IO in our pending queue.
7844 sym_enqueue_cam_ccb(cp);
7847 * When `#ifed 1', the code below makes the driver
7848 * panic on the first attempt to write to a SCSI device.
7849 * It is the first test we want to do after a driver
7850 * change that does not seem obviously safe. :)
7853 switch (cp->cdb_buf[0]) {
7854 case 0x0A: case 0x2A: case 0xAA:
7855 panic("XXXXXXXXXXXXX WRITE NOT YET ALLOWED XXXXXXXXXXXXXX");
7863 * Activate this job.
7865 sym_put_start_queue(np, cp);
7868 sym_xpt_done(np, ccb, cp);
7869 sym_free_ccb(np, cp);
7873 * How complex it gets to deal with the data in CAM.
7874 * The Bus Dma stuff makes things still more complex.
7877 sym_setup_data_and_start(hcb_p np, struct ccb_scsiio *csio, ccb_p cp)
7879 struct ccb_hdr *ccb_h;
7882 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7884 ccb_h = &csio->ccb_h;
7887 * Now deal with the data.
7889 cp->data_len = csio->dxfer_len;
7893 * No direction means no data.
7895 dir = (ccb_h->flags & CAM_DIR_MASK);
7896 if (dir == CAM_DIR_NONE) {
7897 sym_execute_ccb(cp, NULL, 0, 0);
7901 if (!(ccb_h->flags & CAM_SCATTER_VALID)) {
7903 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
7904 /* Buffer is virtual */
7905 cp->dmamapped = (dir == CAM_DIR_IN) ?
7906 SYM_DMA_READ : SYM_DMA_WRITE;
7907 retv = bus_dmamap_load(np->data_dmat, cp->dmamap,
7908 csio->data_ptr, csio->dxfer_len,
7909 sym_execute_ccb, cp, 0);
7910 if (retv == EINPROGRESS) {
7911 cp->host_status = HS_WAIT;
7912 xpt_freeze_simq(np->sim, 1);
7913 csio->ccb_h.status |= CAM_RELEASE_SIMQ;
7916 /* Buffer is physical */
7917 struct bus_dma_segment seg;
7919 seg.ds_addr = (bus_addr_t) csio->data_ptr;
7920 sym_execute_ccb(cp, &seg, 1, 0);
7923 /* Scatter/gather list */
7924 struct bus_dma_segment *segs;
7926 if ((ccb_h->flags & CAM_SG_LIST_PHYS) != 0) {
7927 /* The SG list pointer is physical */
7928 sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7932 if (!(ccb_h->flags & CAM_DATA_PHYS)) {
7933 /* SG buffer pointers are virtual */
7934 sym_set_cam_status(cp->cam_ccb, CAM_REQ_INVALID);
7938 /* SG buffer pointers are physical */
7939 segs = (struct bus_dma_segment *)csio->data_ptr;
7940 sym_execute_ccb(cp, segs, csio->sglist_cnt, 0);
7944 sym_xpt_done(np, (union ccb *) csio, cp);
7945 sym_free_ccb(np, cp);
7949 * Move the scatter list to our data block.
7952 sym_fast_scatter_sg_physical(hcb_p np, ccb_p cp,
7953 bus_dma_segment_t *psegs, int nsegs)
7955 struct sym_tblmove *data;
7956 bus_dma_segment_t *psegs2;
7958 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
7960 if (nsegs > SYM_CONF_MAX_SG)
7963 data = &cp->phys.data[SYM_CONF_MAX_SG-1];
7964 psegs2 = &psegs[nsegs-1];
7965 cp->segments = nsegs;
7968 data->addr = cpu_to_scr(psegs2->ds_addr);
7969 data->size = cpu_to_scr(psegs2->ds_len);
7970 if (DEBUG_FLAGS & DEBUG_SCATTER) {
7971 kprintf ("%s scatter: paddr=%lx len=%ld\n",
7972 sym_name(np), (long) psegs2->ds_addr,
7973 (long) psegs2->ds_len);
7975 if (psegs2 != psegs) {
7987 * Scatter a SG list with physical addresses into bus addressable chunks.
7988 * We need to ensure 16MB boundaries not to be crossed during DMA of
7989 * each segment, due to some chips being flawed.
7991 #define BOUND_MASK ((1UL<<24)-1)
7993 sym_scatter_sg_physical(hcb_p np, ccb_p cp, bus_dma_segment_t *psegs, int nsegs)
7999 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
8001 s = SYM_CONF_MAX_SG - 1;
8003 ps = psegs[t].ds_addr;
8004 pe = ps + psegs[t].ds_len;
8007 pn = (pe - 1) & ~BOUND_MASK;
8011 if (DEBUG_FLAGS & DEBUG_SCATTER) {
8012 kprintf ("%s scatter: paddr=%lx len=%ld\n",
8013 sym_name(np), pn, k);
8015 cp->phys.data[s].addr = cpu_to_scr(pn);
8016 cp->phys.data[s].size = cpu_to_scr(k);
8021 ps = psegs[t].ds_addr;
8022 pe = ps + psegs[t].ds_len;
8028 cp->segments = SYM_CONF_MAX_SG - 1 - s;
8030 return t >= 0 ? -1 : 0;
8035 * SIM action for non performance critical stuff.
8037 static void sym_action2(struct cam_sim *sim, union ccb *ccb)
8042 struct ccb_hdr *ccb_h;
8045 * Retrieve our controller data structure.
8047 np = (hcb_p) cam_sim_softc(sim);
8049 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
8051 ccb_h = &ccb->ccb_h;
8053 switch (ccb_h->func_code) {
8054 case XPT_SET_TRAN_SETTINGS:
8056 struct ccb_trans_settings *cts;
8059 tp = &np->target[ccb_h->target_id];
8062 * Update SPI transport settings in TARGET control block.
8063 * Update SCSI device settings in LUN control block.
8065 lp = sym_lp(np, tp, ccb_h->target_lun);
8066 if (cts->type == CTS_TYPE_CURRENT_SETTINGS) {
8067 sym_update_trans(np, tp, &tp->tinfo.goal, cts);
8069 sym_update_dflags(np, &lp->current_flags, cts);
8071 if (cts->type == CTS_TYPE_USER_SETTINGS) {
8072 sym_update_trans(np, tp, &tp->tinfo.user, cts);
8074 sym_update_dflags(np, &lp->user_flags, cts);
8077 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8080 case XPT_GET_TRAN_SETTINGS:
8082 struct ccb_trans_settings *cts;
8083 struct sym_trans *tip;
8087 tp = &np->target[ccb_h->target_id];
8088 lp = sym_lp(np, tp, ccb_h->target_lun);
8090 #define cts__scsi (&cts->proto_specific.scsi)
8091 #define cts__spi (&cts->xport_specific.spi)
8092 if (cts->type == CTS_TYPE_CURRENT_SETTINGS) {
8093 tip = &tp->tinfo.current;
8094 dflags = lp ? lp->current_flags : 0;
8097 tip = &tp->tinfo.user;
8098 dflags = lp ? lp->user_flags : tp->usrflags;
8101 cts->protocol = PROTO_SCSI;
8102 cts->transport = XPORT_SPI;
8103 cts->protocol_version = tip->scsi_version;
8104 cts->transport_version = tip->spi_version;
8106 cts__spi->sync_period = tip->period;
8107 cts__spi->sync_offset = tip->offset;
8108 cts__spi->bus_width = tip->width;
8109 cts__spi->ppr_options = tip->options;
8111 cts__spi->valid = CTS_SPI_VALID_SYNC_RATE
8112 | CTS_SPI_VALID_SYNC_OFFSET
8113 | CTS_SPI_VALID_BUS_WIDTH
8114 | CTS_SPI_VALID_PPR_OPTIONS;
8116 cts__spi->flags &= ~CTS_SPI_FLAGS_DISC_ENB;
8117 if (dflags & SYM_DISC_ENABLED)
8118 cts__spi->flags |= CTS_SPI_FLAGS_DISC_ENB;
8119 cts__spi->valid |= CTS_SPI_VALID_DISC;
8121 cts__scsi->flags &= ~CTS_SCSI_FLAGS_TAG_ENB;
8122 if (dflags & SYM_TAGS_ENABLED)
8123 cts__scsi->flags |= CTS_SCSI_FLAGS_TAG_ENB;
8124 cts__scsi->valid |= CTS_SCSI_VALID_TQ;
8127 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8130 case XPT_CALC_GEOMETRY:
8132 cam_calc_geometry(&ccb->ccg, /*extended*/1);
8133 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8138 struct ccb_pathinq *cpi = &ccb->cpi;
8139 cpi->version_num = 1;
8140 cpi->hba_inquiry = PI_MDP_ABLE|PI_SDTR_ABLE|PI_TAG_ABLE;
8141 if ((np->features & FE_WIDE) != 0)
8142 cpi->hba_inquiry |= PI_WIDE_16;
8143 cpi->target_sprt = 0;
8145 if (np->usrflags & SYM_SCAN_TARGETS_HILO)
8146 cpi->hba_misc |= PIM_SCANHILO;
8147 if (np->usrflags & SYM_AVOID_BUS_RESET)
8148 cpi->hba_misc |= PIM_NOBUSRESET;
8149 cpi->hba_eng_cnt = 0;
8150 cpi->max_target = (np->features & FE_WIDE) ? 15 : 7;
8151 /* Semantic problem:)LUN number max = max number of LUNs - 1 */
8152 cpi->max_lun = SYM_CONF_MAX_LUN-1;
8153 if (SYM_SETUP_MAX_LUN < SYM_CONF_MAX_LUN)
8154 cpi->max_lun = SYM_SETUP_MAX_LUN-1;
8155 cpi->bus_id = cam_sim_bus(sim);
8156 cpi->initiator_id = np->myaddr;
8157 cpi->base_transfer_speed = 3300;
8158 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
8159 strncpy(cpi->hba_vid, "Symbios", HBA_IDLEN);
8160 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
8161 cpi->unit_number = cam_sim_unit(sim);
8163 cpi->protocol = PROTO_SCSI;
8164 cpi->protocol_version = SCSI_REV_2;
8165 cpi->transport = XPORT_SPI;
8166 cpi->transport_version = 2;
8167 cpi->xport_specific.spi.ppr_options = SID_SPI_CLOCK_ST;
8168 if (np->features & FE_ULTRA3) {
8169 cpi->transport_version = 3;
8170 cpi->xport_specific.spi.ppr_options =
8171 SID_SPI_CLOCK_DT_ST;
8173 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8178 union ccb *abort_ccb = ccb->cab.abort_ccb;
8179 switch(abort_ccb->ccb_h.func_code) {
8181 if (sym_abort_scsiio(np, abort_ccb, 0) == 0) {
8182 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8186 sym_xpt_done2(np, ccb, CAM_UA_ABORT);
8193 sym_reset_dev(np, ccb);
8198 sym_reset_scsi_bus(np, 0);
8200 xpt_print_path(np->path);
8201 kprintf("SCSI BUS reset delivered.\n");
8204 sym_xpt_done2(np, ccb, CAM_REQ_CMP);
8207 case XPT_ACCEPT_TARGET_IO:
8208 case XPT_CONT_TARGET_IO:
8210 case XPT_NOTIFY_ACK:
8211 case XPT_IMMED_NOTIFY:
8214 sym_xpt_done2(np, ccb, CAM_REQ_INVALID);
8220 * Asynchronous notification handler.
8223 sym_async(void *cb_arg, u32 code, struct cam_path *path, void *arg)
8226 struct cam_sim *sim;
8230 sim = (struct cam_sim *) cb_arg;
8231 np = (hcb_p) cam_sim_softc(sim);
8233 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
8236 case AC_LOST_DEVICE:
8237 tn = xpt_path_target_id(path);
8238 if (tn >= SYM_CONF_MAX_TARGET)
8241 tp = &np->target[tn];
8245 tp->head.wval = np->rv_scntl3;
8248 tp->tinfo.current.period = tp->tinfo.goal.period = 0;
8249 tp->tinfo.current.offset = tp->tinfo.goal.offset = 0;
8250 tp->tinfo.current.width = tp->tinfo.goal.width = BUS_8_BIT;
8251 tp->tinfo.current.options = tp->tinfo.goal.options = 0;
8260 * Update transfer settings of a target.
8262 static void sym_update_trans(hcb_p np, tcb_p tp, struct sym_trans *tip,
8263 struct ccb_trans_settings *cts)
8265 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
8270 #define cts__spi (&cts->xport_specific.spi)
8271 if ((cts__spi->valid & CTS_SPI_VALID_BUS_WIDTH) != 0)
8272 tip->width = cts__spi->bus_width;
8273 if ((cts__spi->valid & CTS_SPI_VALID_SYNC_OFFSET) != 0)
8274 tip->offset = cts__spi->sync_offset;
8275 if ((cts__spi->valid & CTS_SPI_VALID_SYNC_RATE) != 0)
8276 tip->period = cts__spi->sync_period;
8277 if ((cts__spi->valid & CTS_SPI_VALID_PPR_OPTIONS) != 0)
8278 tip->options = (cts__spi->ppr_options & PPR_OPT_DT);
8279 if (cts->protocol_version != PROTO_VERSION_UNSPECIFIED &&
8280 cts->protocol_version != PROTO_VERSION_UNKNOWN)
8281 tip->scsi_version = cts->protocol_version;
8282 if (cts->transport_version != XPORT_VERSION_UNSPECIFIED &&
8283 cts->transport_version != XPORT_VERSION_UNKNOWN)
8284 tip->spi_version = cts->transport_version;
8287 * Scale against driver configuration limits.
8289 if (tip->width > SYM_SETUP_MAX_WIDE) tip->width = SYM_SETUP_MAX_WIDE;
8290 if (tip->offset > SYM_SETUP_MAX_OFFS) tip->offset = SYM_SETUP_MAX_OFFS;
8291 if (tip->period < SYM_SETUP_MIN_SYNC) tip->period = SYM_SETUP_MIN_SYNC;
8294 * Scale against actual controller BUS width.
8296 if (tip->width > np->maxwide)
8297 tip->width = np->maxwide;
8300 * Only accept DT if controller supports and SYNC/WIDE asked.
8302 if (!((np->features & (FE_C10|FE_ULTRA3)) == (FE_C10|FE_ULTRA3)) ||
8303 !(tip->width == BUS_16_BIT && tip->offset)) {
8304 tip->options &= ~PPR_OPT_DT;
8308 * Scale period factor and offset against controller limits.
8310 if (tip->options & PPR_OPT_DT) {
8311 if (tip->period < np->minsync_dt)
8312 tip->period = np->minsync_dt;
8313 if (tip->period > np->maxsync_dt)
8314 tip->period = np->maxsync_dt;
8315 if (tip->offset > np->maxoffs_dt)
8316 tip->offset = np->maxoffs_dt;
8319 if (tip->period < np->minsync)
8320 tip->period = np->minsync;
8321 if (tip->period > np->maxsync)
8322 tip->period = np->maxsync;
8323 if (tip->offset > np->maxoffs)
8324 tip->offset = np->maxoffs;
8329 * Update flags for a device (logical unit).
8332 sym_update_dflags(hcb_p np, u_char *flags, struct ccb_trans_settings *cts)
8334 SYM_LOCK_ASSERT(LK_EXCLUSIVE);
8336 #define cts__scsi (&cts->proto_specific.scsi)
8337 #define cts__spi (&cts->xport_specific.spi)
8338 if ((cts__spi->valid & CTS_SPI_VALID_DISC) != 0) {
8339 if ((cts__spi->flags & CTS_SPI_FLAGS_DISC_ENB) != 0)
8340 *flags |= SYM_DISC_ENABLED;
8342 *flags &= ~SYM_DISC_ENABLED;
8345 if ((cts__scsi->valid & CTS_SCSI_VALID_TQ) != 0) {
8346 if ((cts__scsi->flags & CTS_SCSI_FLAGS_TAG_ENB) != 0)
8347 *flags |= SYM_TAGS_ENABLED;
8349 *flags &= ~SYM_TAGS_ENABLED;
8356 /*============= DRIVER INITIALISATION ==================*/
8359 static device_method_t sym_pci_methods[] = {
8360 DEVMETHOD(device_probe, sym_pci_probe),
8361 DEVMETHOD(device_attach, sym_pci_attach),
8365 static driver_t sym_pci_driver = {
8371 static devclass_t sym_devclass;
8373 DRIVER_MODULE(sym, pci, sym_pci_driver, sym_devclass, NULL, NULL);
8374 MODULE_VERSION(sym, 1);
8375 MODULE_DEPEND(sym, cam, 1, 1, 1);
8376 MODULE_DEPEND(sym, pci, 1, 1, 1);
8379 static const struct sym_pci_chip sym_pci_dev_table[] = {
8380 {PCI_ID_SYM53C810, 0x0f, "810", 4, 8, 4, 64,
8383 #ifdef SYM_DEBUG_GENERIC_SUPPORT
8384 {PCI_ID_SYM53C810, 0xff, "810a", 4, 8, 4, 1,
8388 {PCI_ID_SYM53C810, 0xff, "810a", 4, 8, 4, 1,
8389 FE_CACHE_SET|FE_LDSTR|FE_PFEN|FE_BOF}
8392 {PCI_ID_SYM53C815, 0xff, "815", 4, 8, 4, 64,
8395 {PCI_ID_SYM53C825, 0x0f, "825", 6, 8, 4, 64,
8396 FE_WIDE|FE_BOF|FE_ERL|FE_DIFF}
8398 {PCI_ID_SYM53C825, 0xff, "825a", 6, 8, 4, 2,
8399 FE_WIDE|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|FE_RAM|FE_DIFF}
8401 {PCI_ID_SYM53C860, 0xff, "860", 4, 8, 5, 1,
8402 FE_ULTRA|FE_CLK80|FE_CACHE_SET|FE_BOF|FE_LDSTR|FE_PFEN}
8404 {PCI_ID_SYM53C875, 0x01, "875", 6, 16, 5, 2,
8405 FE_WIDE|FE_ULTRA|FE_CLK80|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8408 {PCI_ID_SYM53C875, 0xff, "875", 6, 16, 5, 2,
8409 FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8412 {PCI_ID_SYM53C875_2, 0xff, "875", 6, 16, 5, 2,
8413 FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8416 {PCI_ID_SYM53C885, 0xff, "885", 6, 16, 5, 2,
8417 FE_WIDE|FE_ULTRA|FE_DBLR|FE_CACHE0_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8420 #ifdef SYM_DEBUG_GENERIC_SUPPORT
8421 {PCI_ID_SYM53C895, 0xff, "895", 6, 31, 7, 2,
8422 FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|
8426 {PCI_ID_SYM53C895, 0xff, "895", 6, 31, 7, 2,
8427 FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8431 {PCI_ID_SYM53C896, 0xff, "896", 6, 31, 7, 4,
8432 FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8433 FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_LCKFRQ}
8435 {PCI_ID_SYM53C895A, 0xff, "895a", 6, 31, 7, 4,
8436 FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8437 FE_RAM|FE_RAM8K|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_LCKFRQ}
8439 {PCI_ID_LSI53C1010, 0x00, "1010-33", 6, 31, 7, 8,
8440 FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8441 FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_CRC|
8444 {PCI_ID_LSI53C1010, 0xff, "1010-33", 6, 31, 7, 8,
8445 FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8446 FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_CRC|
8449 {PCI_ID_LSI53C1010_2, 0xff, "1010-66", 6, 31, 7, 8,
8450 FE_WIDE|FE_ULTRA3|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFBC|FE_LDSTR|FE_PFEN|
8451 FE_RAM|FE_RAM8K|FE_64BIT|FE_DAC|FE_IO256|FE_NOPM|FE_LEDC|FE_66MHZ|FE_CRC|
8454 {PCI_ID_LSI53C1510D, 0xff, "1510d", 6, 31, 7, 4,
8455 FE_WIDE|FE_ULTRA2|FE_QUAD|FE_CACHE_SET|FE_BOF|FE_DFS|FE_LDSTR|FE_PFEN|
8456 FE_RAM|FE_IO256|FE_LEDC}
8459 #define sym_pci_num_devs NELEM(sym_pci_dev_table)
8462 * Look up the chip table.
8464 * Return a pointer to the chip entry if found,
8467 static const struct sym_pci_chip *
8468 sym_find_pci_chip(device_t dev)
8470 const struct sym_pci_chip *chip;
8475 if (pci_get_vendor(dev) != PCI_VENDOR_NCR)
8478 device_id = pci_get_device(dev);
8479 revision = pci_get_revid(dev);
8481 for (i = 0; i < sym_pci_num_devs; i++) {
8482 chip = &sym_pci_dev_table[i];
8483 if (device_id != chip->device_id)
8485 if (revision > chip->revision_id)
8494 * Tell upper layer if the chip is supported.
8497 sym_pci_probe(device_t dev)
8499 const struct sym_pci_chip *chip;
8501 chip = sym_find_pci_chip(dev);
8502 if (chip && sym_find_firmware(chip)) {
8503 device_set_desc(dev, chip->name);
8504 return (chip->lp_probe_bit & SYM_SETUP_LP_PROBE_MAP)?
8505 BUS_PROBE_LOW_PRIORITY : BUS_PROBE_DEFAULT;
8511 * Attach a sym53c8xx device.
8514 sym_pci_attach(device_t dev)
8516 const struct sym_pci_chip *chip;
8519 struct sym_hcb *np = NULL;
8520 struct sym_nvram nvram;
8521 const struct sym_fw *fw = NULL;
8523 bus_dma_tag_t bus_dmat;
8525 #if 0 /* XXX swildner */
8526 bus_dmat = bus_get_dma_tag(dev);
8532 * Only probed devices should be attached.
8533 * We just enjoy being paranoid. :)
8535 chip = sym_find_pci_chip(dev);
8536 if (chip == NULL || (fw = sym_find_firmware(chip)) == NULL)
8540 * Allocate immediately the host control block,
8541 * since we are only expecting to succeed. :)
8542 * We keep track in the HCB of all the resources that
8543 * are to be released on error.
8545 np = __sym_calloc_dma(bus_dmat, sizeof(*np), "HCB");
8547 np->bus_dmat = bus_dmat;
8550 device_set_softc(dev, np);
8555 * Copy some useful infos to the HCB.
8557 np->hcb_ba = vtobus(np);
8558 np->verbose = bootverbose;
8560 np->device_id = pci_get_device(dev);
8561 np->revision_id = pci_get_revid(dev);
8562 np->features = chip->features;
8563 np->clock_divn = chip->nr_divisor;
8564 np->maxoffs = chip->offset_max;
8565 np->maxburst = chip->burst_max;
8566 np->scripta_sz = fw->a_size;
8567 np->scriptb_sz = fw->b_size;
8568 np->fw_setup = fw->setup;
8569 np->fw_patch = fw->patch;
8570 np->fw_name = fw->name;
8573 np->target = sym_calloc_dma(SYM_CONF_MAX_TARGET * sizeof(*(np->target)),
8580 * Initialize the CCB free and busy queues.
8582 sym_que_init(&np->free_ccbq);
8583 sym_que_init(&np->busy_ccbq);
8584 sym_que_init(&np->comp_ccbq);
8585 sym_que_init(&np->cam_ccbq);
8588 * Allocate a tag for the DMA of user data.
8590 if (bus_dma_tag_create(np->bus_dmat, 1, (1<<24),
8591 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
8593 BUS_SPACE_MAXSIZE, SYM_CONF_MAX_SG,
8596 device_printf(dev, "failed to create DMA tag.\n");
8600 * Read and apply some fix-ups to the PCI COMMAND
8601 * register. We want the chip to be enabled for:
8603 * - PCI parity checking (reporting would also be fine)
8604 * - Write And Invalidate.
8606 command = pci_read_config(dev, PCIR_COMMAND, 2);
8607 command |= PCIM_CMD_BUSMASTEREN;
8608 command |= PCIM_CMD_PERRESPEN;
8609 command |= /* PCIM_CMD_MWIEN */ 0x0010;
8610 pci_write_config(dev, PCIR_COMMAND, command, 2);
8613 * Let the device know about the cache line size,
8614 * if it doesn't yet.
8616 cachelnsz = pci_read_config(dev, PCIR_CACHELNSZ, 1);
8619 pci_write_config(dev, PCIR_CACHELNSZ, cachelnsz, 1);
8623 * Alloc/get/map/retrieve everything that deals with MMIO.
8625 if ((command & PCIM_CMD_MEMEN) != 0) {
8626 int regs_id = SYM_PCI_MMIO;
8627 np->mmio_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
8628 ®s_id, RF_ACTIVE);
8630 if (!np->mmio_res) {
8631 device_printf(dev, "failed to allocate MMIO resources\n");
8634 np->mmio_ba = rman_get_start(np->mmio_res);
8640 np->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &i,
8641 RF_ACTIVE | RF_SHAREABLE);
8643 device_printf(dev, "failed to allocate IRQ resource\n");
8647 #ifdef SYM_CONF_IOMAPPED
8649 * User want us to use normal IO with PCI.
8650 * Alloc/get/map/retrieve everything that deals with IO.
8652 if ((command & PCI_COMMAND_IO_ENABLE) != 0) {
8653 int regs_id = SYM_PCI_IO;
8654 np->io_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
8655 ®s_id, RF_ACTIVE);
8658 device_printf(dev, "failed to allocate IO resources\n");
8662 #endif /* SYM_CONF_IOMAPPED */
8665 * If the chip has RAM.
8666 * Alloc/get/map/retrieve the corresponding resources.
8668 if ((np->features & (FE_RAM|FE_RAM8K)) &&
8669 (command & PCIM_CMD_MEMEN) != 0) {
8670 int regs_id = SYM_PCI_RAM;
8671 if (np->features & FE_64BIT)
8672 regs_id = SYM_PCI_RAM64;
8673 np->ram_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
8674 ®s_id, RF_ACTIVE);
8676 device_printf(dev,"failed to allocate RAM resources\n");
8679 np->ram_id = regs_id;
8680 np->ram_ba = rman_get_start(np->ram_res);
8684 * Save setting of some IO registers, so we will
8685 * be able to probe specific implementations.
8687 sym_save_initial_setting (np);
8690 * Reset the chip now, since it has been reported
8691 * that SCSI clock calibration may not work properly
8692 * if the chip is currently active.
8694 sym_chip_reset (np);
8697 * Try to read the user set-up.
8699 (void) sym_read_nvram(np, &nvram);
8702 * Prepare controller and devices settings, according
8703 * to chip features, user set-up and driver set-up.
8705 (void) sym_prepare_setting(np, &nvram);
8708 * Check the PCI clock frequency.
8709 * Must be performed after prepare_setting since it destroys
8710 * STEST1 that is used to probe for the clock doubler.
8712 i = sym_getpciclock(np);
8714 device_printf(dev, "PCI BUS clock seems too high: %u KHz.\n",i);
8717 * Allocate the start queue.
8719 np->squeue = (u32 *) sym_calloc_dma(sizeof(u32)*(MAX_QUEUE*2),"SQUEUE");
8722 np->squeue_ba = vtobus(np->squeue);
8725 * Allocate the done queue.
8727 np->dqueue = (u32 *) sym_calloc_dma(sizeof(u32)*(MAX_QUEUE*2),"DQUEUE");
8730 np->dqueue_ba = vtobus(np->dqueue);
8733 * Allocate the target bus address array.
8735 np->targtbl = (u32 *) sym_calloc_dma(256, "TARGTBL");
8738 np->targtbl_ba = vtobus(np->targtbl);
8741 * Allocate SCRIPTS areas.
8743 np->scripta0 = sym_calloc_dma(np->scripta_sz, "SCRIPTA0");
8744 np->scriptb0 = sym_calloc_dma(np->scriptb_sz, "SCRIPTB0");
8745 if (!np->scripta0 || !np->scriptb0)
8749 * Allocate the CCBs. We need at least ONE.
8751 for (i = 0; sym_alloc_ccb(np) != NULL; i++)
8757 * Calculate BUS addresses where we are going
8758 * to load the SCRIPTS.
8760 np->scripta_ba = vtobus(np->scripta0);
8761 np->scriptb_ba = vtobus(np->scriptb0);
8762 np->scriptb0_ba = np->scriptb_ba;
8765 np->scripta_ba = np->ram_ba;
8766 if (np->features & FE_RAM8K) {
8768 np->scriptb_ba = np->scripta_ba + 4096;
8770 np->scr_ram_seg = cpu_to_scr(np->scripta_ba >> 32);
8778 * Copy scripts to controller instance.
8780 bcopy(fw->a_base, np->scripta0, np->scripta_sz);
8781 bcopy(fw->b_base, np->scriptb0, np->scriptb_sz);
8784 * Setup variable parts in scripts and compute
8785 * scripts bus addresses used from the C code.
8787 np->fw_setup(np, fw);
8790 * Bind SCRIPTS with physical addresses usable by the
8791 * SCRIPTS processor (as seen from the BUS = BUS addresses).
8793 sym_fw_bind_script(np, (u32 *) np->scripta0, np->scripta_sz);
8794 sym_fw_bind_script(np, (u32 *) np->scriptb0, np->scriptb_sz);
8796 #ifdef SYM_CONF_IARB_SUPPORT
8798 * If user wants IARB to be set when we win arbitration
8799 * and have other jobs, compute the max number of consecutive
8800 * settings of IARB hints before we leave devices a chance to
8801 * arbitrate for reselection.
8803 #ifdef SYM_SETUP_IARB_MAX
8804 np->iarb_max = SYM_SETUP_IARB_MAX;
8811 * Prepare the idle and invalid task actions.
8813 np->idletask.start = cpu_to_scr(SCRIPTA_BA (np, idle));
8814 np->idletask.restart = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
8815 np->idletask_ba = vtobus(&np->idletask);
8817 np->notask.start = cpu_to_scr(SCRIPTA_BA (np, idle));
8818 np->notask.restart = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
8819 np->notask_ba = vtobus(&np->notask);
8821 np->bad_itl.start = cpu_to_scr(SCRIPTA_BA (np, idle));
8822 np->bad_itl.restart = cpu_to_scr(SCRIPTB_BA (np, bad_i_t_l));
8823 np->bad_itl_ba = vtobus(&np->bad_itl);
8825 np->bad_itlq.start = cpu_to_scr(SCRIPTA_BA (np, idle));
8826 np->bad_itlq.restart = cpu_to_scr(SCRIPTB_BA (np,bad_i_t_l_q));
8827 np->bad_itlq_ba = vtobus(&np->bad_itlq);
8830 * Allocate and prepare the lun JUMP table that is used
8831 * for a target prior the probing of devices (bad lun table).
8832 * A private table will be allocated for the target on the
8833 * first INQUIRY response received.
8835 np->badluntbl = sym_calloc_dma(256, "BADLUNTBL");
8839 np->badlun_sa = cpu_to_scr(SCRIPTB_BA (np, resel_bad_lun));
8840 for (i = 0 ; i < 64 ; i++) /* 64 luns/target, no less */
8841 np->badluntbl[i] = cpu_to_scr(vtobus(&np->badlun_sa));
8844 * Prepare the bus address array that contains the bus
8845 * address of each target control block.
8846 * For now, assume all logical units are wrong. :)
8848 for (i = 0 ; i < SYM_CONF_MAX_TARGET ; i++) {
8849 np->targtbl[i] = cpu_to_scr(vtobus(&np->target[i]));
8850 np->target[i].head.luntbl_sa =
8851 cpu_to_scr(vtobus(np->badluntbl));
8852 np->target[i].head.lun0_sa =
8853 cpu_to_scr(vtobus(&np->badlun_sa));
8857 * Now check the cache handling of the pci chipset.
8859 if (sym_snooptest (np)) {
8860 device_printf(dev, "CACHE INCORRECTLY CONFIGURED.\n");
8865 * Now deal with CAM.
8866 * Hopefully, we will succeed with that one.:)
8868 if (!sym_cam_attach(np))
8872 * Sigh! we are done.
8878 * We will try to free all the resources we have
8879 * allocated, but if we are a boot device, this
8880 * will not help that much.;)
8889 * Free everything that have been allocated for this device.
8891 static void sym_pci_free(hcb_p np)
8900 * First free CAM resources.
8905 * Now every should be quiet for us to
8906 * free other resources.
8909 bus_release_resource(np->device, SYS_RES_MEMORY,
8910 np->ram_id, np->ram_res);
8912 bus_release_resource(np->device, SYS_RES_MEMORY,
8913 SYM_PCI_MMIO, np->mmio_res);
8915 bus_release_resource(np->device, SYS_RES_IOPORT,
8916 SYM_PCI_IO, np->io_res);
8918 bus_release_resource(np->device, SYS_RES_IRQ,
8922 sym_mfree_dma(np->scriptb0, np->scriptb_sz, "SCRIPTB0");
8924 sym_mfree_dma(np->scripta0, np->scripta_sz, "SCRIPTA0");
8926 sym_mfree_dma(np->squeue, sizeof(u32)*(MAX_QUEUE*2), "SQUEUE");
8928 sym_mfree_dma(np->dqueue, sizeof(u32)*(MAX_QUEUE*2), "DQUEUE");
8930 while ((qp = sym_remque_head(&np->free_ccbq)) != NULL) {
8931 cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
8932 bus_dmamap_destroy(np->data_dmat, cp->dmamap);
8933 sym_mfree_dma(cp->sns_bbuf, SYM_SNS_BBUF_LEN, "SNS_BBUF");
8934 sym_mfree_dma(cp, sizeof(*cp), "CCB");
8938 sym_mfree_dma(np->badluntbl, 256,"BADLUNTBL");
8940 for (target = 0; target < SYM_CONF_MAX_TARGET ; target++) {
8941 tp = &np->target[target];
8942 for (lun = 0 ; lun < SYM_CONF_MAX_LUN ; lun++) {
8943 lp = sym_lp(np, tp, lun);
8947 sym_mfree_dma(lp->itlq_tbl, SYM_CONF_MAX_TASK*4,
8950 sym_mfree(lp->cb_tags, SYM_CONF_MAX_TASK,
8952 sym_mfree_dma(lp, sizeof(*lp), "LCB");
8954 #if SYM_CONF_MAX_LUN > 1
8956 sym_mfree(tp->lunmp, SYM_CONF_MAX_LUN*sizeof(lcb_p),
8962 sym_mfree_dma(np->target,
8963 SYM_CONF_MAX_TARGET * sizeof(*(np->target)), "TARGET");
8966 sym_mfree_dma(np->targtbl, 256, "TARGTBL");
8968 bus_dma_tag_destroy(np->data_dmat);
8969 #if 0 /* XXX swildner */
8970 if (SYM_LOCK_INITIALIZED() != 0)
8973 device_set_softc(np->device, NULL);
8974 sym_mfree_dma(np, sizeof(*np), "HCB");
8978 * Allocate CAM resources and register a bus to CAM.
8980 static int sym_cam_attach(hcb_p np)
8982 struct cam_devq *devq = NULL;
8983 struct cam_sim *sim = NULL;
8984 struct cam_path *path = NULL;
8988 * Establish our interrupt handler.
8990 err = bus_setup_intr(np->device, np->irq_res,
8992 sym_intr, np, &np->intr, NULL);
8994 device_printf(np->device, "bus_setup_intr() failed: %d\n",
9000 * Create the device queue for our sym SIM.
9002 devq = cam_simq_alloc(SYM_CONF_MAX_START);
9007 * Construct our SIM entry.
9009 sim = cam_sim_alloc(sym_action, sym_poll, "sym", np,
9010 device_get_unit(np->device),
9011 &np->lock, 1, SYM_SETUP_MAX_TAG, devq);
9012 cam_simq_release(devq);
9018 if (xpt_bus_register(sim, 0) != CAM_SUCCESS)
9022 if (xpt_create_path(&path, 0,
9023 cam_sim_path(np->sim), CAM_TARGET_WILDCARD,
9024 CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
9030 * Establish our async notification handler.
9032 if (xpt_register_async(AC_LOST_DEVICE, sym_async, sim, path) !=
9037 * Start the chip now, without resetting the BUS, since
9038 * it seems that this must stay under control of CAM.
9039 * With LVD/SE capable chips and BUS in SE mode, we may
9040 * get a spurious SMBC interrupt.
9059 * Free everything that deals with CAM.
9061 static void sym_cam_free(hcb_p np)
9066 bus_teardown_intr(np->device, np->irq_res, np->intr);
9073 xpt_bus_deregister(cam_sim_path(np->sim));
9074 cam_sim_free(np->sim);
9078 xpt_free_path(np->path);
9085 /*============ OPTIONNAL NVRAM SUPPORT =================*/
9088 * Get host setup from NVRAM.
9090 static void sym_nvram_setup_host (hcb_p np, struct sym_nvram *nvram)
9092 #ifdef SYM_CONF_NVRAM_SUPPORT
9094 * Get parity checking, host ID, verbose mode
9095 * and miscellaneous host flags from NVRAM.
9097 switch(nvram->type) {
9098 case SYM_SYMBIOS_NVRAM:
9099 if (!(nvram->data.Symbios.flags & SYMBIOS_PARITY_ENABLE))
9100 np->rv_scntl0 &= ~0x0a;
9101 np->myaddr = nvram->data.Symbios.host_id & 0x0f;
9102 if (nvram->data.Symbios.flags & SYMBIOS_VERBOSE_MSGS)
9104 if (nvram->data.Symbios.flags1 & SYMBIOS_SCAN_HI_LO)
9105 np->usrflags |= SYM_SCAN_TARGETS_HILO;
9106 if (nvram->data.Symbios.flags2 & SYMBIOS_AVOID_BUS_RESET)
9107 np->usrflags |= SYM_AVOID_BUS_RESET;
9109 case SYM_TEKRAM_NVRAM:
9110 np->myaddr = nvram->data.Tekram.host_id & 0x0f;
9119 * Get target setup from NVRAM.
9121 #ifdef SYM_CONF_NVRAM_SUPPORT
9122 static void sym_Symbios_setup_target(hcb_p np,int target, Symbios_nvram *nvram);
9123 static void sym_Tekram_setup_target(hcb_p np,int target, Tekram_nvram *nvram);
9127 sym_nvram_setup_target (hcb_p np, int target, struct sym_nvram *nvp)
9129 #ifdef SYM_CONF_NVRAM_SUPPORT
9131 case SYM_SYMBIOS_NVRAM:
9132 sym_Symbios_setup_target (np, target, &nvp->data.Symbios);
9134 case SYM_TEKRAM_NVRAM:
9135 sym_Tekram_setup_target (np, target, &nvp->data.Tekram);
9143 #ifdef SYM_CONF_NVRAM_SUPPORT
9145 * Get target set-up from Symbios format NVRAM.
9148 sym_Symbios_setup_target(hcb_p np, int target, Symbios_nvram *nvram)
9150 tcb_p tp = &np->target[target];
9151 Symbios_target *tn = &nvram->target[target];
9153 tp->tinfo.user.period = tn->sync_period ? (tn->sync_period + 3) / 4 : 0;
9154 tp->tinfo.user.width = tn->bus_width == 0x10 ? BUS_16_BIT : BUS_8_BIT;
9156 (tn->flags & SYMBIOS_QUEUE_TAGS_ENABLED)? SYM_SETUP_MAX_TAG : 0;
9158 if (!(tn->flags & SYMBIOS_DISCONNECT_ENABLE))
9159 tp->usrflags &= ~SYM_DISC_ENABLED;
9160 if (!(tn->flags & SYMBIOS_SCAN_AT_BOOT_TIME))
9161 tp->usrflags |= SYM_SCAN_BOOT_DISABLED;
9162 if (!(tn->flags & SYMBIOS_SCAN_LUNS))
9163 tp->usrflags |= SYM_SCAN_LUNS_DISABLED;
9167 * Get target set-up from Tekram format NVRAM.
9170 sym_Tekram_setup_target(hcb_p np, int target, Tekram_nvram *nvram)
9172 tcb_p tp = &np->target[target];
9173 struct Tekram_target *tn = &nvram->target[target];
9176 if (tn->flags & TEKRAM_SYNC_NEGO) {
9177 i = tn->sync_index & 0xf;
9178 tp->tinfo.user.period = Tekram_sync[i];
9181 tp->tinfo.user.width =
9182 (tn->flags & TEKRAM_WIDE_NEGO) ? BUS_16_BIT : BUS_8_BIT;
9184 if (tn->flags & TEKRAM_TAGGED_COMMANDS) {
9185 tp->usrtags = 2 << nvram->max_tags_index;
9188 if (tn->flags & TEKRAM_DISCONNECT_ENABLE)
9189 tp->usrflags |= SYM_DISC_ENABLED;
9191 /* If any device does not support parity, we will not use this option */
9192 if (!(tn->flags & TEKRAM_PARITY_CHECK))
9193 np->rv_scntl0 &= ~0x0a; /* SCSI parity checking disabled */
9196 #ifdef SYM_CONF_DEBUG_NVRAM
9198 * Dump Symbios format NVRAM for debugging purpose.
9200 static void sym_display_Symbios_nvram(hcb_p np, Symbios_nvram *nvram)
9204 /* display Symbios nvram host data */
9205 kprintf("%s: HOST ID=%d%s%s%s%s%s%s\n",
9206 sym_name(np), nvram->host_id & 0x0f,
9207 (nvram->flags & SYMBIOS_SCAM_ENABLE) ? " SCAM" :"",
9208 (nvram->flags & SYMBIOS_PARITY_ENABLE) ? " PARITY" :"",
9209 (nvram->flags & SYMBIOS_VERBOSE_MSGS) ? " VERBOSE" :"",
9210 (nvram->flags & SYMBIOS_CHS_MAPPING) ? " CHS_ALT" :"",
9211 (nvram->flags2 & SYMBIOS_AVOID_BUS_RESET)?" NO_RESET" :"",
9212 (nvram->flags1 & SYMBIOS_SCAN_HI_LO) ? " HI_LO" :"");
9214 /* display Symbios nvram drive data */
9215 for (i = 0 ; i < 15 ; i++) {
9216 struct Symbios_target *tn = &nvram->target[i];
9217 kprintf("%s-%d:%s%s%s%s WIDTH=%d SYNC=%d TMO=%d\n",
9219 (tn->flags & SYMBIOS_DISCONNECT_ENABLE) ? " DISC" : "",
9220 (tn->flags & SYMBIOS_SCAN_AT_BOOT_TIME) ? " SCAN_BOOT" : "",
9221 (tn->flags & SYMBIOS_SCAN_LUNS) ? " SCAN_LUNS" : "",
9222 (tn->flags & SYMBIOS_QUEUE_TAGS_ENABLED)? " TCQ" : "",
9224 tn->sync_period / 4,
9230 * Dump TEKRAM format NVRAM for debugging purpose.
9232 static const u_char Tekram_boot_delay[7] = {3, 5, 10, 20, 30, 60, 120};
9233 static void sym_display_Tekram_nvram(hcb_p np, Tekram_nvram *nvram)
9235 int i, tags, boot_delay;
9238 /* display Tekram nvram host data */
9239 tags = 2 << nvram->max_tags_index;
9241 if (nvram->boot_delay_index < 6)
9242 boot_delay = Tekram_boot_delay[nvram->boot_delay_index];
9243 switch((nvram->flags & TEKRAM_REMOVABLE_FLAGS) >> 6) {
9245 case 0: rem = ""; break;
9246 case 1: rem = " REMOVABLE=boot device"; break;
9247 case 2: rem = " REMOVABLE=all"; break;
9250 kprintf("%s: HOST ID=%d%s%s%s%s%s%s%s%s%s BOOT DELAY=%d tags=%d\n",
9251 sym_name(np), nvram->host_id & 0x0f,
9252 (nvram->flags1 & SYMBIOS_SCAM_ENABLE) ? " SCAM" :"",
9253 (nvram->flags & TEKRAM_MORE_THAN_2_DRIVES) ? " >2DRIVES" :"",
9254 (nvram->flags & TEKRAM_DRIVES_SUP_1GB) ? " >1GB" :"",
9255 (nvram->flags & TEKRAM_RESET_ON_POWER_ON) ? " RESET" :"",
9256 (nvram->flags & TEKRAM_ACTIVE_NEGATION) ? " ACT_NEG" :"",
9257 (nvram->flags & TEKRAM_IMMEDIATE_SEEK) ? " IMM_SEEK" :"",
9258 (nvram->flags & TEKRAM_SCAN_LUNS) ? " SCAN_LUNS" :"",
9259 (nvram->flags1 & TEKRAM_F2_F6_ENABLED) ? " F2_F6" :"",
9260 rem, boot_delay, tags);
9262 /* display Tekram nvram drive data */
9263 for (i = 0; i <= 15; i++) {
9265 struct Tekram_target *tn = &nvram->target[i];
9266 j = tn->sync_index & 0xf;
9267 sync = Tekram_sync[j];
9268 kprintf("%s-%d:%s%s%s%s%s%s PERIOD=%d\n",
9270 (tn->flags & TEKRAM_PARITY_CHECK) ? " PARITY" : "",
9271 (tn->flags & TEKRAM_SYNC_NEGO) ? " SYNC" : "",
9272 (tn->flags & TEKRAM_DISCONNECT_ENABLE) ? " DISC" : "",
9273 (tn->flags & TEKRAM_START_CMD) ? " START" : "",
9274 (tn->flags & TEKRAM_TAGGED_COMMANDS) ? " TCQ" : "",
9275 (tn->flags & TEKRAM_WIDE_NEGO) ? " WIDE" : "",
9279 #endif /* SYM_CONF_DEBUG_NVRAM */
9280 #endif /* SYM_CONF_NVRAM_SUPPORT */
9284 * Try reading Symbios or Tekram NVRAM
9286 #ifdef SYM_CONF_NVRAM_SUPPORT
9287 static int sym_read_Symbios_nvram (hcb_p np, Symbios_nvram *nvram);
9288 static int sym_read_Tekram_nvram (hcb_p np, Tekram_nvram *nvram);
9291 static int sym_read_nvram(hcb_p np, struct sym_nvram *nvp)
9293 #ifdef SYM_CONF_NVRAM_SUPPORT
9295 * Try to read SYMBIOS nvram.
9296 * Try to read TEKRAM nvram if Symbios nvram not found.
9298 if (SYM_SETUP_SYMBIOS_NVRAM &&
9299 !sym_read_Symbios_nvram (np, &nvp->data.Symbios)) {
9300 nvp->type = SYM_SYMBIOS_NVRAM;
9301 #ifdef SYM_CONF_DEBUG_NVRAM
9302 sym_display_Symbios_nvram(np, &nvp->data.Symbios);
9305 else if (SYM_SETUP_TEKRAM_NVRAM &&
9306 !sym_read_Tekram_nvram (np, &nvp->data.Tekram)) {
9307 nvp->type = SYM_TEKRAM_NVRAM;
9308 #ifdef SYM_CONF_DEBUG_NVRAM
9309 sym_display_Tekram_nvram(np, &nvp->data.Tekram);
9321 #ifdef SYM_CONF_NVRAM_SUPPORT
9323 * 24C16 EEPROM reading.
9325 * GPOI0 - data in/data out
9327 * Symbios NVRAM wiring now also used by Tekram.
9336 * Set/clear data/clock bit in GPIO0
9338 static void S24C16_set_bit(hcb_p np, u_char write_bit, u_char *gpreg,
9344 *gpreg |= write_bit;
9357 OUTB (nc_gpreg, *gpreg);
9362 * Send START condition to NVRAM to wake it up.
9364 static void S24C16_start(hcb_p np, u_char *gpreg)
9366 S24C16_set_bit(np, 1, gpreg, SET_BIT);
9367 S24C16_set_bit(np, 0, gpreg, SET_CLK);
9368 S24C16_set_bit(np, 0, gpreg, CLR_BIT);
9369 S24C16_set_bit(np, 0, gpreg, CLR_CLK);
9373 * Send STOP condition to NVRAM - puts NVRAM to sleep... ZZzzzz!!
9375 static void S24C16_stop(hcb_p np, u_char *gpreg)
9377 S24C16_set_bit(np, 0, gpreg, SET_CLK);
9378 S24C16_set_bit(np, 1, gpreg, SET_BIT);
9382 * Read or write a bit to the NVRAM,
9383 * read if GPIO0 input else write if GPIO0 output
9385 static void S24C16_do_bit(hcb_p np, u_char *read_bit, u_char write_bit,
9388 S24C16_set_bit(np, write_bit, gpreg, SET_BIT);
9389 S24C16_set_bit(np, 0, gpreg, SET_CLK);
9391 *read_bit = INB (nc_gpreg);
9392 S24C16_set_bit(np, 0, gpreg, CLR_CLK);
9393 S24C16_set_bit(np, 0, gpreg, CLR_BIT);
9397 * Output an ACK to the NVRAM after reading,
9398 * change GPIO0 to output and when done back to an input
9400 static void S24C16_write_ack(hcb_p np, u_char write_bit, u_char *gpreg,
9403 OUTB (nc_gpcntl, *gpcntl & 0xfe);
9404 S24C16_do_bit(np, 0, write_bit, gpreg);
9405 OUTB (nc_gpcntl, *gpcntl);
9409 * Input an ACK from NVRAM after writing,
9410 * change GPIO0 to input and when done back to an output
9412 static void S24C16_read_ack(hcb_p np, u_char *read_bit, u_char *gpreg,
9415 OUTB (nc_gpcntl, *gpcntl | 0x01);
9416 S24C16_do_bit(np, read_bit, 1, gpreg);
9417 OUTB (nc_gpcntl, *gpcntl);
9421 * WRITE a byte to the NVRAM and then get an ACK to see it was accepted OK,
9422 * GPIO0 must already be set as an output
9424 static void S24C16_write_byte(hcb_p np, u_char *ack_data, u_char write_data,
9425 u_char *gpreg, u_char *gpcntl)
9429 for (x = 0; x < 8; x++)
9430 S24C16_do_bit(np, 0, (write_data >> (7 - x)) & 0x01, gpreg);
9432 S24C16_read_ack(np, ack_data, gpreg, gpcntl);
9436 * READ a byte from the NVRAM and then send an ACK to say we have got it,
9437 * GPIO0 must already be set as an input
9439 static void S24C16_read_byte(hcb_p np, u_char *read_data, u_char ack_data,
9440 u_char *gpreg, u_char *gpcntl)
9446 for (x = 0; x < 8; x++) {
9447 S24C16_do_bit(np, &read_bit, 1, gpreg);
9448 *read_data |= ((read_bit & 0x01) << (7 - x));
9451 S24C16_write_ack(np, ack_data, gpreg, gpcntl);
9455 * Read 'len' bytes starting at 'offset'.
9457 static int sym_read_S24C16_nvram (hcb_p np, int offset, u_char *data, int len)
9459 u_char gpcntl, gpreg;
9460 u_char old_gpcntl, old_gpreg;
9465 /* save current state of GPCNTL and GPREG */
9466 old_gpreg = INB (nc_gpreg);
9467 old_gpcntl = INB (nc_gpcntl);
9468 gpcntl = old_gpcntl & 0x1c;
9470 /* set up GPREG & GPCNTL to set GPIO0 and GPIO1 in to known state */
9471 OUTB (nc_gpreg, old_gpreg);
9472 OUTB (nc_gpcntl, gpcntl);
9474 /* this is to set NVRAM into a known state with GPIO0/1 both low */
9476 S24C16_set_bit(np, 0, &gpreg, CLR_CLK);
9477 S24C16_set_bit(np, 0, &gpreg, CLR_BIT);
9479 /* now set NVRAM inactive with GPIO0/1 both high */
9480 S24C16_stop(np, &gpreg);
9482 /* activate NVRAM */
9483 S24C16_start(np, &gpreg);
9485 /* write device code and random address MSB */
9486 S24C16_write_byte(np, &ack_data,
9487 0xa0 | ((offset >> 7) & 0x0e), &gpreg, &gpcntl);
9488 if (ack_data & 0x01)
9491 /* write random address LSB */
9492 S24C16_write_byte(np, &ack_data,
9493 offset & 0xff, &gpreg, &gpcntl);
9494 if (ack_data & 0x01)
9497 /* regenerate START state to set up for reading */
9498 S24C16_start(np, &gpreg);
9500 /* rewrite device code and address MSB with read bit set (lsb = 0x01) */
9501 S24C16_write_byte(np, &ack_data,
9502 0xa1 | ((offset >> 7) & 0x0e), &gpreg, &gpcntl);
9503 if (ack_data & 0x01)
9506 /* now set up GPIO0 for inputting data */
9508 OUTB (nc_gpcntl, gpcntl);
9510 /* input all requested data - only part of total NVRAM */
9511 for (x = 0; x < len; x++)
9512 S24C16_read_byte(np, &data[x], (x == (len-1)), &gpreg, &gpcntl);
9514 /* finally put NVRAM back in inactive mode */
9516 OUTB (nc_gpcntl, gpcntl);
9517 S24C16_stop(np, &gpreg);
9520 /* return GPIO0/1 to original states after having accessed NVRAM */
9521 OUTB (nc_gpcntl, old_gpcntl);
9522 OUTB (nc_gpreg, old_gpreg);
9527 #undef SET_BIT /* 0 */
9528 #undef CLR_BIT /* 1 */
9529 #undef SET_CLK /* 2 */
9530 #undef CLR_CLK /* 3 */
9533 * Try reading Symbios NVRAM.
9536 static int sym_read_Symbios_nvram (hcb_p np, Symbios_nvram *nvram)
9538 static u_char Symbios_trailer[6] = {0xfe, 0xfe, 0, 0, 0, 0};
9539 u_char *data = (u_char *) nvram;
9540 int len = sizeof(*nvram);
9544 /* probe the 24c16 and read the SYMBIOS 24c16 area */
9545 if (sym_read_S24C16_nvram (np, SYMBIOS_NVRAM_ADDRESS, data, len))
9548 /* check valid NVRAM signature, verify byte count and checksum */
9549 if (nvram->type != 0 ||
9550 bcmp(nvram->trailer, Symbios_trailer, 6) ||
9551 nvram->byte_count != len - 12)
9554 /* verify checksum */
9555 for (x = 6, csum = 0; x < len - 6; x++)
9557 if (csum != nvram->checksum)
9564 * 93C46 EEPROM reading.
9569 * GPIO4 - chip select
9575 * Pulse clock bit in GPIO0
9577 static void T93C46_Clk(hcb_p np, u_char *gpreg)
9579 OUTB (nc_gpreg, *gpreg | 0x04);
9581 OUTB (nc_gpreg, *gpreg);
9585 * Read bit from NVRAM
9587 static void T93C46_Read_Bit(hcb_p np, u_char *read_bit, u_char *gpreg)
9590 T93C46_Clk(np, gpreg);
9591 *read_bit = INB (nc_gpreg);
9595 * Write bit to GPIO0
9597 static void T93C46_Write_Bit(hcb_p np, u_char write_bit, u_char *gpreg)
9599 if (write_bit & 0x01)
9606 OUTB (nc_gpreg, *gpreg);
9609 T93C46_Clk(np, gpreg);
9613 * Send STOP condition to NVRAM - puts NVRAM to sleep... ZZZzzz!!
9615 static void T93C46_Stop(hcb_p np, u_char *gpreg)
9618 OUTB (nc_gpreg, *gpreg);
9621 T93C46_Clk(np, gpreg);
9625 * Send read command and address to NVRAM
9627 static void T93C46_Send_Command(hcb_p np, u_short write_data,
9628 u_char *read_bit, u_char *gpreg)
9632 /* send 9 bits, start bit (1), command (2), address (6) */
9633 for (x = 0; x < 9; x++)
9634 T93C46_Write_Bit(np, (u_char) (write_data >> (8 - x)), gpreg);
9636 *read_bit = INB (nc_gpreg);
9640 * READ 2 bytes from the NVRAM
9642 static void T93C46_Read_Word(hcb_p np, u_short *nvram_data, u_char *gpreg)
9648 for (x = 0; x < 16; x++) {
9649 T93C46_Read_Bit(np, &read_bit, gpreg);
9651 if (read_bit & 0x01)
9652 *nvram_data |= (0x01 << (15 - x));
9654 *nvram_data &= ~(0x01 << (15 - x));
9659 * Read Tekram NvRAM data.
9661 static int T93C46_Read_Data(hcb_p np, u_short *data,int len,u_char *gpreg)
9666 for (x = 0; x < len; x++) {
9668 /* output read command and address */
9669 T93C46_Send_Command(np, 0x180 | x, &read_bit, gpreg);
9670 if (read_bit & 0x01)
9672 T93C46_Read_Word(np, &data[x], gpreg);
9673 T93C46_Stop(np, gpreg);
9680 * Try reading 93C46 Tekram NVRAM.
9682 static int sym_read_T93C46_nvram (hcb_p np, Tekram_nvram *nvram)
9684 u_char gpcntl, gpreg;
9685 u_char old_gpcntl, old_gpreg;
9688 /* save current state of GPCNTL and GPREG */
9689 old_gpreg = INB (nc_gpreg);
9690 old_gpcntl = INB (nc_gpcntl);
9692 /* set up GPREG & GPCNTL to set GPIO0/1/2/4 in to known state, 0 in,
9694 gpreg = old_gpreg & 0xe9;
9695 OUTB (nc_gpreg, gpreg);
9696 gpcntl = (old_gpcntl & 0xe9) | 0x09;
9697 OUTB (nc_gpcntl, gpcntl);
9699 /* input all of NVRAM, 64 words */
9700 retv = T93C46_Read_Data(np, (u_short *) nvram,
9701 sizeof(*nvram) / sizeof(short), &gpreg);
9703 /* return GPIO0/1/2/4 to original states after having accessed NVRAM */
9704 OUTB (nc_gpcntl, old_gpcntl);
9705 OUTB (nc_gpreg, old_gpreg);
9711 * Try reading Tekram NVRAM.
9714 static int sym_read_Tekram_nvram (hcb_p np, Tekram_nvram *nvram)
9716 u_char *data = (u_char *) nvram;
9717 int len = sizeof(*nvram);
9721 switch (np->device_id) {
9722 case PCI_ID_SYM53C885:
9723 case PCI_ID_SYM53C895:
9724 case PCI_ID_SYM53C896:
9725 x = sym_read_S24C16_nvram(np, TEKRAM_24C16_NVRAM_ADDRESS,
9728 case PCI_ID_SYM53C875:
9729 x = sym_read_S24C16_nvram(np, TEKRAM_24C16_NVRAM_ADDRESS,
9734 x = sym_read_T93C46_nvram(np, nvram);
9740 /* verify checksum */
9741 for (x = 0, csum = 0; x < len - 1; x += 2)
9742 csum += data[x] + (data[x+1] << 8);
9749 #endif /* SYM_CONF_NVRAM_SUPPORT */