xref: /netbsd-src/sys/dev/ic/mb89352var.h (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: mb89352var.h,v 1.10 2005/12/11 12:21:27 christos Exp $	*/
2 /*	NecBSD: mb89352var.h,v 1.4 1998/03/14 07:31:22 kmatsuda Exp 	*/
3 
4 /*-
5  * Copyright (c) 1996,97,98,99 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Charles M. Hannum, Masaru Oki and Kouichi Matsuda.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by Charles M. Hannum.
22  * 4. The name of the author may not be used to endorse or promote products
23  *    derived from this software without specific prior written permission.
24  *
25  * Copyright (c) 1994 Jarle Greipsland
26  * All rights reserved.
27  *
28  * Redistribution and use in source and binary forms, with or without
29  * modification, are permitted provided that the following conditions
30  * are met:
31  * 1. Redistributions of source code must retain the above copyright
32  *    notice, this list of conditions and the following disclaimer.
33  * 2. Redistributions in binary form must reproduce the above copyright
34  *    notice, this list of conditions and the following disclaimer in the
35  *    documentation and/or other materials provided with the distribution.
36  * 3. The name of the author may not be used to endorse or promote products
37  *    derived from this software without specific prior written permission.
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
40  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
41  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
43  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
44  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
45  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
48  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49  * POSSIBILITY OF SUCH DAMAGE.
50  */
51 /*
52  * [NetBSD for NEC PC-98 series]
53  *  Copyright (c) 1996, 1997, 1998
54  *	NetBSD/pc98 porting staff. All rights reserved.
55  *  Copyright (c) 1996, 1997, 1998
56  *	Kouich Matsuda. All rights reserved.
57  */
58 
59 #ifndef	_MB89352VAR_H_
60 #define	_MB89352VAR_H_
61 /*
62  * ACB. Holds additional information for each SCSI command Comments: We
63  * need a separate scsi command block because we may need to overwrite it
64  * with a request sense command.  Basicly, we refrain from fiddling with
65  * the scsi_xfer struct (except do the expected updating of return values).
66  * We'll generally update: xs->{flags,resid,error,sense,status} and
67  * occasionally xs->retries.
68  */
69 struct spc_acb {
70 	struct scsipi_generic scsipi_cmd;
71 	int scsipi_cmd_length;
72 	u_char *data_addr;		/* Saved data pointer */
73 	int data_length;		/* Residue */
74 
75 	u_char target_stat;		/* SCSI status byte */
76 
77 #ifdef notdef
78 	struct spc_dma_seg dma[SPC_NSEG]; /* Physical addresses+len */
79 #endif
80 
81 	TAILQ_ENTRY(spc_acb) chain;
82 	struct scsipi_xfer *xs;	/* SCSI xfer ctrl block from above */
83 	int flags;
84 #define ACB_ALLOC	0x01
85 #define ACB_NEXUS	0x02
86 #define ACB_SENSE	0x04
87 #define ACB_ABORT	0x40
88 #define ACB_RESET	0x80
89 	int timeout;
90 };
91 
92 /*
93  * Some info about each (possible) target on the SCSI bus.  This should
94  * probably have been a "per target+lunit" structure, but we'll leave it at
95  * this for now.
96  */
97 struct spc_tinfo {
98 	int	cmds;		/* #commands processed */
99 	int	dconns;		/* #disconnects */
100 	int	touts;		/* #timeouts */
101 	int	perrs;		/* #parity errors */
102 	int	senses;		/* #request sense commands sent */
103 	ushort	lubusy;		/* What local units/subr. are busy? */
104 	u_char  flags;
105 #define DO_SYNC		0x01	/* (Re)Negotiate synchronous options */
106 #define DO_WIDE		0x02	/* (Re)Negotiate wide options */
107 	u_char  period;		/* Period suggestion */
108 	u_char  offset;		/* Offset suggestion */
109 	u_char	width;		/* Width suggestion */
110 };
111 
112 struct spc_softc {
113 	struct device sc_dev;
114 
115 	bus_space_tag_t sc_iot;
116 	bus_space_handle_t sc_ioh;
117 
118 	struct scsipi_channel sc_channel; /* prototype for subdevs */
119 	struct scsipi_adapter sc_adapter;
120 
121 	TAILQ_HEAD(, spc_acb) free_list, ready_list, nexus_list;
122 	struct spc_acb *sc_nexus;	/* current command */
123 	struct spc_acb sc_acb[8];
124 	struct spc_tinfo sc_tinfo[8];
125 
126 	/* Data about the current nexus (updated for every cmd switch) */
127 	u_char	*sc_dp;		/* Current data pointer */
128 	size_t	sc_dleft;	/* Data bytes left to transfer */
129 	u_char	*sc_cp;		/* Current command pointer */
130 	size_t	sc_cleft;	/* Command bytes left to transfer */
131 
132 	/* Adapter state */
133 	u_char	 sc_phase;	/* Current bus phase */
134 	u_char	 sc_prevphase;	/* Previous bus phase */
135 	u_char	 sc_state;	/* State applicable to the adapter */
136 #define SPC_INIT	0
137 #define SPC_IDLE	1
138 #define SPC_SELECTING	2	/* SCSI command is arbiting  */
139 #define SPC_RESELECTED	3	/* Has been reselected */
140 #define SPC_CONNECTED	4	/* Actively using the SCSI bus */
141 #define SPC_DISCONNECT	5	/* MSG_DISCONNECT received */
142 #define SPC_CMDCOMPLETE	6	/* MSG_CMDCOMPLETE received */
143 #define SPC_CLEANING	7
144 	u_char	 sc_flags;
145 #define SPC_DROP_MSGIN	0x01	/* Discard all msgs (parity err detected) */
146 #define SPC_ABORTING	0x02	/* Bailing out */
147 #define SPC_DOINGDMA	0x04	/* doing DMA */
148 #define SPC_INACTIVE	0x80	/* The FIFO data path is active! */
149 	u_char	sc_selid;	/* Reselection ID */
150 	struct device *sc_child;/* Our child */
151 
152 	/* Message stuff */
153 	u_char	sc_msgpriq;	/* Messages we want to send */
154 	u_char	sc_msgoutq;	/* Messages sent during last MESSAGE OUT */
155 	u_char	sc_lastmsg;	/* Message last transmitted */
156 	u_char	sc_currmsg;	/* Message currently ready to transmit */
157 #define SEND_DEV_RESET		0x01
158 #define SEND_PARITY_ERROR	0x02
159 #define SEND_INIT_DET_ERR	0x04
160 #define SEND_REJECT		0x08
161 #define SEND_IDENTIFY		0x10
162 #define SEND_ABORT		0x20
163 #define SEND_SDTR		0x40
164 #define SEND_WDTR		0x80
165 #define SPC_MAX_MSG_LEN 8
166 	u_char  sc_omess[SPC_MAX_MSG_LEN];
167 	u_char	*sc_omp;		/* Outgoing message pointer */
168 	u_char	sc_imess[SPC_MAX_MSG_LEN];
169 	u_char	*sc_imp;		/* Incoming message pointer */
170 
171 	/* Hardware stuff */
172 	int	sc_initiator;		/* Our scsi id */
173 	int	sc_freq;		/* Clock frequency in MHz */
174 	int	sc_minsync;		/* Minimum sync period / 4 */
175 	int	sc_maxsync;		/* Maximum sync period / 4 */
176 
177 	/* DMA function set from MD code */
178 	void (*sc_dma_start)(struct spc_softc *, void *, size_t, int);
179 	void (*sc_dma_done)(struct spc_softc *);
180 };
181 
182 #if SPC_DEBUG
183 #define SPC_SHOWACBS	0x01
184 #define SPC_SHOWINTS	0x02
185 #define SPC_SHOWCMDS	0x04
186 #define SPC_SHOWMISC	0x08
187 #define SPC_SHOWTRACE	0x10
188 #define SPC_SHOWSTART	0x20
189 #define SPC_DOBREAK	0x40
190 extern int spc_debug; /* SPC_SHOWSTART|SPC_SHOWMISC|SPC_SHOWTRACE; */
191 #define SPC_PRINT(b, s)	do {if ((spc_debug & (b)) != 0) printf s;} while (0)
192 #define SPC_BREAK()	do {if ((spc_debug & SPC_DOBREAK) != 0) Debugger();} while (0)
193 #define SPC_ASSERT(x)	do {if (x) {} else {printf("%s at line %d: assertion failed\n", sc->sc_dev.dv_xname, __LINE__); Debugger();}} while (0)
194 #else
195 #define SPC_PRINT(b, s)
196 #define SPC_BREAK()
197 #define SPC_ASSERT(x)
198 #endif
199 
200 #define SPC_ACBS(s)	SPC_PRINT(SPC_SHOWACBS, s)
201 #define SPC_INTS(s)	SPC_PRINT(SPC_SHOWINTS, s)
202 #define SPC_CMDS(s)	SPC_PRINT(SPC_SHOWCMDS, s)
203 #define SPC_MISC(s)	SPC_PRINT(SPC_SHOWMISC, s)
204 #define SPC_TRACE(s)	SPC_PRINT(SPC_SHOWTRACE, s)
205 #define SPC_START(s)	SPC_PRINT(SPC_SHOWSTART, s)
206 
207 void	spc_attach(struct spc_softc *);
208 int	spc_activate(struct device *, enum devact);
209 int	spc_detach(struct device *, int);
210 int	spc_intr(void *);
211 int	spc_find(bus_space_tag_t, bus_space_handle_t, int);
212 void	spc_init(struct spc_softc *, int);
213 void	spc_sched(struct spc_softc *);
214 #endif	/* _MB89352VAR_H_ */
215