xref: /netbsd-src/sys/arch/mac68k/dev/sbcvar.h (revision d0fed6c87ddc40a8bffa6f99e7433ddfc864dd83)
1 /*	$NetBSD: sbcvar.h,v 1.2 1997/03/15 18:10:03 is Exp $	*/
2 
3 /*
4  * Copyright (C) 1996 Scott Reynolds.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by Scott Reynolds for
17  *      the NetBSD Project.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Transfers smaller than this are done using PIO
35  * (on assumption they're not worth PDMA overhead)
36  */
37 #define	MIN_DMA_LEN 128
38 
39 /*
40  * Transfers larger than 8192 bytes need to be split up
41  * due to the size of the PDMA space.
42  */
43 #define	MAX_DMA_LEN 0x2000
44 
45 #ifdef SBC_DEBUG
46 # define	SBC_DB_INTR	0x01
47 # define	SBC_DB_DMA	0x02
48 # define	SBC_DB_REG	0x04
49 # define	SBC_DB_BREAK	0x08
50 # ifndef DDB
51 #  define	Debugger()	printf("Debug: sbc.c:%d\n", __LINE__)
52 # endif
53 # define	SBC_BREAK \
54 		do { if (sbc_debug & SBC_DB_BREAK) Debugger(); } while (0)
55 #else
56 # define	SBC_BREAK
57 #endif
58 
59 /*
60  * This structure is used to keep track of PDMA requests.
61  */
62 struct sbc_pdma_handle {
63 	int	dh_flags;	/* flags */
64 #define	SBC_DH_BUSY	0x01	/* This handle is in use */
65 #define	SBC_DH_OUT	0x02	/* PDMA data out (write) */
66 #define	SBC_DH_DONE	0x04	/* PDMA transfer is complete */
67 	u_char	*dh_addr;	/* data buffer */
68 	int	dh_len;		/* length of data buffer */
69 };
70 
71 /*
72  * The first structure member has to be the ncr5380_softc
73  * so we can just cast to go back and forth between them.
74  */
75 struct sbc_softc {
76 	struct ncr5380_softc ncr_sc;
77 	volatile struct sbc_regs *sc_regs;
78 	volatile vm_offset_t	sc_drq_addr;
79 	volatile vm_offset_t	sc_nodrq_addr;
80 	void			(*sc_clrintr) __P((struct ncr5380_softc *));
81 	int			sc_options;	/* options for this instance. */
82 	struct sbc_pdma_handle sc_pdma[SCI_OPENINGS];
83 };
84 
85 /*
86  * Options.  By default, SCSI interrupts and reselect are disabled.
87  * You may enable either of these features with the `flags' directive
88  * in your kernel's configuration file.
89  *
90  * Alternatively, you can patch your kernel with DDB or some other
91  * mechanism.  The sc_options member of the softc is OR'd with
92  * the value in sbc_options.
93  *
94  * The options code is based on the sparc 'si' driver's version of
95  * the same.
96  */
97 #define	SBC_PDMA	0x01	/* Use PDMA for polled transfers */
98 #define	SBC_INTR	0x02	/* Allow SCSI IRQ/DRQ interrupts */
99 #define	SBC_RESELECT	0x04	/* Allow disconnect/reselect */
100 #define	SBC_OPTIONS_MASK	(SBC_RESELECT|SBC_INTR|SBC_PDMA)
101 #define	SBC_OPTIONS_BITS	"\10\3RESELECT\2INTR\1PDMA"
102 
103 extern int	sbc_debug;
104 extern int	sbc_link_flags;
105 extern int	sbc_options;
106 extern struct scsi_adapter sbc_ops;
107 extern struct scsi_device sbc_dev;
108 
109 int	sbc_pdma_in __P((struct ncr5380_softc *, int, int, u_char *));
110 int	sbc_pdma_out __P((struct ncr5380_softc *, int, int, u_char *));
111 void	sbc_irq_intr __P((void *));
112 void	sbc_drq_intr __P((void *));
113 void	sbc_dma_alloc __P((struct ncr5380_softc *));
114 void	sbc_dma_free __P((struct ncr5380_softc *));
115 void	sbc_dma_poll __P((struct ncr5380_softc *));
116 void	sbc_dma_setup __P((struct ncr5380_softc *));
117 void	sbc_dma_start __P((struct ncr5380_softc *));
118 void	sbc_dma_eop __P((struct ncr5380_softc *));
119 void	sbc_dma_stop __P((struct ncr5380_softc *));
120 #ifdef SBC_DEBUG
121 void	decode_5380_intr __P((struct ncr5380_softc *));
122 #endif
123