summaryrefslogtreecommitdiff
path: root/sys/arch/mvme88k/dev/sshvar.h
blob: a30d299f41d6904781fbcc08e564514eb95f68de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*	$OpenBSD: sshvar.h,v 1.3 2003/06/02 23:27:52 millert Exp $	*/

/*
 * Copyright (c) 1995 Theo de Raadt
 * Copyright (c) 1990 The Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Van Jacobson of Lawrence Berkeley Laboratory.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)sshvar.h	7.1 (Berkeley) 5/8/90
 */
#ifndef _SSHVAR_H_
#define _SSHVAR_H_

/*
 * The largest single request will be MAXPHYS bytes which will require
 * at most MAXPHYS/NBPG+1 chain elements to describe, i.e. if none of
 * the buffer pages are physically contiguous (MAXPHYS/NBPG) and the
 * buffer is not page aligned (+1).
 */
#define	DMAMAXIO	(MAXPHYS/NBPG+1)

/*
 * Data Structure for SCRIPTS program
 */
struct ssh_ds {
/*00*/	long	scsi_addr;		/* SCSI ID & sync */
/*04*/	long	idlen;			/* Identify message */
/*08*/	char	*idbuf;
/*0c*/	long	cmdlen;			/* SCSI command */
/*10*/	char	*cmdbuf;
/*14*/	long	stslen;			/* Status */
/*18*/	char	*stsbuf;
/*1c*/	long	msglen;			/* Message */
/*20*/	char	*msgbuf;
/*24*/	long	msginlen;		/* Message in */
/*28*/	char	*msginbuf;
/*2c*/	long	extmsglen;		/* Extended message in */
/*30*/	char	*extmsgbuf;
/*34*/	long	synmsglen;		/* Sync transfer request */
/*38*/	char	*synmsgbuf;
	struct {
/*3c*/		long datalen;
/*40*/		char *databuf;
	} chain[DMAMAXIO];
};

/*
 * ACB. Holds additional information for each SCSI command Comments: We
 * need a separate scsi command block because we may need to overwrite it
 * with a request sense command.  Basicly, we refrain from fiddling with
 * the scsi_xfer struct (except do the expected updating of return values).
 * We'll generally update: xs->{flags,resid,error,sense,status} and
 * occasionally xs->retries.
 */
struct ssh_acb {
/*00*/	TAILQ_ENTRY(ssh_acb) chain;
/*08*/	struct scsi_xfer *xs;	/* SCSI xfer ctrl block from above */
/*0c*/	int		flags;	/* Status */
#define ACB_FREE	0x00
#define ACB_ACTIVE	0x01
#define ACB_DONE	0x04
#define ACB_CHKSENSE	0x08
/*10*/	struct scsi_generic cmd;  /* SCSI command block */
/*1c*/	struct ssh_ds ds;
/*a0*/	void	*iob_buf;
/*a4*/	u_long	iob_curbuf;
/*a8*/	u_long	iob_len, iob_curlen;
/*b0*/	u_char	msgout[6];
/*b6*/	u_char	msg[6];
/*bc*/	u_char	stat[1];
/*bd*/	u_char	status;
/*be*/	u_char	dummy[2];
/*c0*/	int	 clen;
/*c4*/	char	*daddr;		/* Saved data pointer */
/*c8*/	int	 dleft;		/* Residue */
};

/*
 * Some info about each (possible) target on the SCSI bus.  This should
 * probably have been a "per target+lunit" structure, but we'll leave it at
 * this for now.  Is there a way to reliably hook it up to sc->fordriver??
 */
struct ssh_tinfo {
	int	cmds;		/* #commands processed */
	int	dconns;		/* #disconnects */
	int	touts;		/* #timeouts */
	int	perrs;		/* #parity errors */
	int	senses;		/* #request sense commands sent */
	ushort	lubusy;		/* What local units/subr. are busy? */
	u_char  flags;
	u_char  period;		/* Period suggestion */
	u_char  offset;		/* Offset suggestion */
} tinfo_t;

struct	ssh_softc {
	struct	device sc_dev;
	struct	intrhand sc_ih;
	struct	evcnt sc_intrcnt;

	u_char	sc_istat;
	u_char	sc_dstat;
	u_char	sc_sstat0;
	u_char	sc_sstat1;
	u_long	sc_intcode;
	struct	scsi_link sc_link;	/* proto for sub devices */
	u_long	sc_scriptspa;		/* physical address of scripts */
	ssh_regmap_p	sc_sshp;	/* the SSH */
	u_long	sc_active;		/* number of active I/O's */

	/* Lists of command blocks */
	TAILQ_HEAD(acb_list, ssh_acb) free_list,
				       ready_list,
				       nexus_list;

	struct ssh_acb *sc_nexus;	/* current command */
#define SSH_NACB 8
	struct ssh_acb *sc_acb;	/* the real command blocks */
	struct ssh_tinfo sc_tinfo[8];

	u_short	sc_clock_freq;
	u_char	sc_dcntl;
	u_char	sc_ctest0;
	u_char	sc_ctest7;
	u_short sc_tcp[4];
	u_char	sc_flags;
	u_char	sc_sien;
	u_char	sc_dien;
	u_char  sc_minsync;
	/* one for each target */
	struct syncpar {
		u_char state;
		u_char sxfer;
		u_char sbcl;
	} sc_sync[8];
};

/* sc_flags */
#define	SSH_INTSOFF	0x80	/* Interrupts turned off */
#define	SSH_INTDEFER	0x40	/* Level 6 interrupt has been deferred */
#define	SSH_ALIVE	0x01	/* controller initialized */
#define SSH_SELECTED	0x04	/* bus is in selected state. Needed for
				   correct abort procedure. */

/* sync states */
#define SYNC_START	0	/* no sync handshake started */
#define SYNC_SENT	1	/* we sent sync request, no answer yet */
#define SYNC_DONE	2	/* target accepted our (or inferior) settings,
				   or it rejected the request and we stay async */

#define	MSG_CMD_COMPLETE	0x00
#define MSG_EXT_MESSAGE		0x01
#define	MSG_SAVE_DATA_PTR	0x02
#define	MSG_RESTORE_PTR		0x03
#define	MSG_DISCONNECT		0x04
#define	MSG_INIT_DETECT_ERROR	0x05
#define	MSG_ABORT		0x06
#define	MSG_REJECT		0x07
#define	MSG_NOOP		0x08
#define	MSG_PARITY_ERROR	0x09
#define	MSG_BUS_DEVICE_RESET	0x0C
#define	MSG_IDENTIFY		0x80
#define	MSG_IDENTIFY_DR		0xc0	/* (disconnect/reconnect allowed) */
#define	MSG_SYNC_REQ		0x01

#define	STS_CHECKCOND	0x02	/* Check Condition (ie., read sense) */
#define	STS_CONDMET	0x04	/* Condition Met (ie., search worked) */
#define	STS_BUSY	0x08
#define	STS_INTERMED	0x10	/* Intermediate status sent */
#define	STS_EXT		0x80	/* Extended status valid */

void ssh_minphys(struct buf *bp);
int ssh_scsicmd(struct scsi_xfer *);

#endif /* _SSHVAR_H */