xref: /netbsd/sys/dev/ic/sunscpalreg.h (revision bf9ec67e)
1 /*	$NetBSD: sunscpalreg.h,v 1.2 2001/07/15 16:32:40 fredette Exp $	*/
2 
3 /*-
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Matthew Fredette.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Macros for accessing the registers in the Sun "Sun-2" "sc"
41  * PAL+logic sequencer chips.
42  */
43 
44 /*
45  * Interface Control Register.
46  *
47  * This register pretty much just reflects the state of the SCSI
48  * bus, directly.  For example, the _COMMAND_DATA, _MESSAGE,
49  * and _INPUT_OUTPUT bits and their values correspond directly
50  * to SCSI bus signals.
51  *
52  * Note:
53  *	(r)	indicates bit is read only.
54  *	(rw)	indicates bit is read or write.
55  */
56 #define	SUNSCPAL_ICR_PARITY_ERROR	0x8000	/* (r) parity error */
57 #define	SUNSCPAL_ICR_BUS_ERROR		0x4000	/* (r) bus error */
58 #define	SUNSCPAL_ICR_ODD_LENGTH		0x2000	/* (r) odd length */
59 #define	SUNSCPAL_ICR_INTERRUPT_REQUEST	0x1000	/* (r) interrupt request */
60 #define	SUNSCPAL_ICR_REQUEST		0x0800	/* (r) request */
61 #define	SUNSCPAL_ICR_MESSAGE		0x0400	/* (r) message */
62 #define	SUNSCPAL_ICR_COMMAND_DATA	0x0200	/* (r) 1=command, 0=data */
63 #define	SUNSCPAL_ICR_INPUT_OUTPUT	0x0100	/* (r) 1=input (initiator should read), 0=output */
64 #define	SUNSCPAL_ICR_PARITY		0x0080	/* (r) parity */
65 #define	SUNSCPAL_ICR_BUSY		0x0040	/* (r) busy */
66 #define	SUNSCPAL_ICR_SELECT		0x0020	/* (rw) select */
67 #define	SUNSCPAL_ICR_RESET		0x0010	/* (rw) reset */
68 #define	SUNSCPAL_ICR_PARITY_ENABLE	0x0008	/* (rw) enable parity */
69 #define	SUNSCPAL_ICR_WORD_MODE		0x0004	/* (rw) word mode */
70 #define	SUNSCPAL_ICR_DMA_ENABLE		0x0002	/* (rw) enable DMA */
71 #define	SUNSCPAL_ICR_INTERRUPT_ENABLE	0x0001	/* (rw) enable interrupts */
72 
73 #define	SUNSCPAL_ICR_BITS	"\20\1INTEN\2DMAEN\3WM\4PAREN\5RESET\6SEL\7BSY\10PAR\11INPUT\12CMD\13MSG\14REQ\15INTRQ\16ODD\17BUSERR\20PARERR"
74 
75 /*
76  * This chip keeps its DMA count with its bits flipped.  Normally, you
77  * would just use the ~ operator everywhere.  However, apparently that
78  * operator doesn't always work as you would expect, i.e.:
79  *
80  * #include <stdio.h>
81  * int main() {
82  *   unsigned short x;
83  *   int y;
84  *   x = 0;
85  *   y = ~x;
86  *   printf("%d\n", y);
87  * }
88  *
89  * prints -1, not 65535.  So this macro does the bit-flipping
90  * carefully for you.
91  */
92 #define SUNSCPAL_DMA_COUNT_FLIP(x) (((unsigned short) (x)) ^ 0xFFFF)
93