1 /*	$OpenBSD: aic6360var.h,v 1.3 2003/05/14 09:04:59 jason Exp $	*/
2 /*	$NetBSD: aic6360.c,v 1.52 1996/12/10 21:27:51 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 1994, 1995, 1996 Charles Hannum.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Charles M. Hannum.
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  * Copyright (c) 1994 Jarle Greipsland
22  * All rights reserved.
23  *
24  * Redistribution and use in source and binary forms, with or without
25  * modification, are permitted provided that the following conditions
26  * are met:
27  * 1. Redistributions of source code must retain the above copyright
28  *    notice, this list of conditions and the following disclaimer.
29  * 2. Redistributions in binary form must reproduce the above copyright
30  *    notice, this list of conditions and the following disclaimer in the
31  *    documentation and/or other materials provided with the distribution.
32  * 3. The name of the author may not be used to endorse or promote products
33  *    derived from this software without specific prior written permission.
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
36  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
37  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
39  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
40  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
41  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
42  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
43  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
44  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
45  * POSSIBILITY OF SUCH DAMAGE.
46  */
47 
48 /*
49  * Acknowledgements: Many of the algorithms used in this driver are
50  * inspired by the work of Julian Elischer (julian@tfs.com) and
51  * Charles Hannum (mycroft@duality.gnu.ai.mit.edu).  Thanks a million!
52  */
53 
54 #define AIC_NPORTS	0x20	/* I/O port space used */
55 
56 typedef u_long physaddr;
57 typedef u_long physlen;
58 
59 struct aic_dma_seg {
60 	physaddr seg_addr;
61 	physlen seg_len;
62 };
63 
64 #define AIC_NSEG	16
65 
66 /*
67  * ACB. Holds additional information for each SCSI command Comments: We
68  * need a separate scsi command block because we may need to overwrite it
69  * with a request sense command.  Basicly, we refrain from fiddling with
70  * the scsi_xfer struct (except do the expected updating of return values).
71  * We'll generally update: xs->{flags,resid,error,sense,status} and
72  * occasionally xs->retries.
73  */
74 struct aic_acb {
75 	struct scsi_generic scsi_cmd;
76 	int scsi_cmd_length;
77 	u_char *data_addr;		/* Saved data pointer */
78 	int data_length;		/* Residue */
79 
80 	u_char target_stat;		/* SCSI status byte */
81 
82 #ifdef notdef
83 	struct aic_dma_seg dma[AIC_NSEG]; /* Physical addresses+len */
84 #endif
85 
86 	TAILQ_ENTRY(aic_acb) chain;
87 	struct scsi_xfer *xs;	/* SCSI xfer ctrl block from above */
88 	int flags;
89 #define ACB_ALLOC	0x01
90 #define	ACB_NEXUS	0x02
91 #define ACB_SENSE	0x04
92 #define	ACB_ABORT	0x40
93 #define	ACB_RESET	0x80
94 	int timeout;
95 };
96 
97 /*
98  * Some info about each (possible) target on the SCSI bus.  This should
99  * probably have been a "per target+lunit" structure, but we'll leave it at
100  * this for now.
101  */
102 struct aic_tinfo {
103 	int	cmds;		/* #commands processed */
104 	int	dconns;		/* #disconnects */
105 	int	touts;		/* #timeouts */
106 	int	perrs;		/* #parity errors */
107 	int	senses;		/* #request sense commands sent */
108 	ushort	lubusy;		/* What local units/subr. are busy? */
109 	u_char  flags;
110 #define DO_SYNC		0x01	/* (Re)Negotiate synchronous options */
111 #define	DO_WIDE		0x02	/* (Re)Negotiate wide options */
112 	u_char  period;		/* Period suggestion */
113 	u_char  offset;		/* Offset suggestion */
114 	u_char	width;		/* Width suggestion */
115 };
116 
117 struct aic_softc {
118 	struct device sc_dev;
119 	struct isadev sc_id;
120 	void *sc_ih;
121 
122 	bus_space_tag_t sc_iot;
123 	bus_space_handle_t sc_ioh;
124 	int sc_irq, sc_drq;
125 
126 	struct scsi_link sc_link;	/* prototype for subdevs */
127 
128 	TAILQ_HEAD(, aic_acb) free_list, ready_list, nexus_list;
129 	struct aic_acb *sc_nexus;	/* current command */
130 	struct aic_acb sc_acb[8];
131 	struct aic_tinfo sc_tinfo[8];
132 
133 	/* Data about the current nexus (updated for every cmd switch) */
134 	u_char	*sc_dp;		/* Current data pointer */
135 	size_t	sc_dleft;	/* Data bytes left to transfer */
136 	u_char	*sc_cp;		/* Current command pointer */
137 	size_t	sc_cleft;	/* Command bytes left to transfer */
138 
139 	/* Adapter state */
140 	u_char	 sc_phase;	/* Current bus phase */
141 	u_char	 sc_prevphase;	/* Previous bus phase */
142 	u_char	 sc_state;	/* State applicable to the adapter */
143 #define	AIC_INIT	0
144 #define AIC_IDLE	1
145 #define AIC_SELECTING	2	/* SCSI command is arbiting  */
146 #define AIC_RESELECTED	3	/* Has been reselected */
147 #define AIC_CONNECTED	4	/* Actively using the SCSI bus */
148 #define	AIC_DISCONNECT	5	/* MSG_DISCONNECT received */
149 #define	AIC_CMDCOMPLETE	6	/* MSG_CMDCOMPLETE received */
150 #define AIC_CLEANING	7
151 	u_char	 sc_flags;
152 #define AIC_DROP_MSGIN	0x01	/* Discard all msgs (parity err detected) */
153 #define	AIC_ABORTING	0x02	/* Bailing out */
154 #define AIC_DOINGDMA	0x04	/* The FIFO data path is active! */
155 	u_char	sc_selid;	/* Reselection ID */
156 
157 	/* Message stuff */
158 	u_char	sc_msgpriq;	/* Messages we want to send */
159 	u_char	sc_msgoutq;	/* Messages sent during last MESSAGE OUT */
160 	u_char	sc_lastmsg;	/* Message last transmitted */
161 	u_char	sc_currmsg;	/* Message currently ready to transmit */
162 #define SEND_DEV_RESET		0x01
163 #define SEND_PARITY_ERROR	0x02
164 #define SEND_INIT_DET_ERR	0x04
165 #define SEND_REJECT		0x08
166 #define SEND_IDENTIFY  		0x10
167 #define SEND_ABORT		0x20
168 #define SEND_SDTR		0x40
169 #define	SEND_WDTR		0x80
170 #define AIC_MAX_MSG_LEN 8
171 	u_char  sc_omess[AIC_MAX_MSG_LEN];
172 	u_char	*sc_omp;		/* Outgoing message pointer */
173 	u_char	sc_imess[AIC_MAX_MSG_LEN];
174 	u_char	*sc_imp;		/* Incoming message pointer */
175 
176 	/* Hardware stuff */
177 	int	sc_initiator;		/* Our scsi id */
178 	int	sc_freq;		/* Clock frequency in MHz */
179 	int	sc_minsync;		/* Minimum sync period / 4 */
180 	int	sc_maxsync;		/* Maximum sync period / 4 */
181 };
182 
183 #if AIC_DEBUG
184 #define AIC_SHOWACBS	0x01
185 #define AIC_SHOWINTS	0x02
186 #define AIC_SHOWCMDS	0x04
187 #define AIC_SHOWMISC	0x08
188 #define AIC_SHOWTRACE	0x10
189 #define AIC_SHOWSTART	0x20
190 #define AIC_DOBREAK	0x40
191 #define	AIC_PRINT(b, s)	do {if ((aic_debug & (b)) != 0) printf s;} while (0)
192 #define	AIC_BREAK() \
193 	do { if ((aic_debug & AIC_DOBREAK) != 0) Debugger(); } while (0)
194 #define	AIC_ASSERT(x) \
195 	do { \
196 		if (!(x)) { \
197 			printf("%s at line %d: assertion failed\n", \
198 			    sc->sc_dev.dv_xname, __LINE__); \
199 			Debugger(); \
200 		} \
201 	} while (0)
202 #else
203 #define	AIC_PRINT(b, s)
204 #define	AIC_BREAK()
205 #define	AIC_ASSERT(x)
206 #endif
207 
208 #define AIC_ACBS(s)	AIC_PRINT(AIC_SHOWACBS, s)
209 #define AIC_INTS(s)	AIC_PRINT(AIC_SHOWINTS, s)
210 #define AIC_CMDS(s)	AIC_PRINT(AIC_SHOWCMDS, s)
211 #define AIC_MISC(s)	AIC_PRINT(AIC_SHOWMISC, s)
212 #define AIC_TRACE(s)	AIC_PRINT(AIC_SHOWTRACE, s)
213 #define AIC_START(s)	AIC_PRINT(AIC_SHOWSTART, s)
214 
215 void	aicattach(struct aic_softc *);
216 int	aicintr(void *);
217 int 	aic_find(bus_space_tag_t, bus_space_handle_t);
218