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