ncr53c9xvar.h revision 1.29
1 /* $NetBSD: ncr53c9xvar.h,v 1.29 2000/12/20 03:19:34 eeh Exp $ */ 2 3 /*- 4 * Copyright (c) 1997 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 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 the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Copyright (c) 1994 Peter Galbavy. All rights reserved. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 3. All advertising materials mentioning features or use of this software 52 * must display the following acknowledgement: 53 * This product includes software developed by Peter Galbavy. 54 * 4. The name of the author may not be used to endorse or promote products 55 * derived from this software without specific prior written permission. 56 * 57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 67 */ 68 69 /* Set this to 1 for normal debug, or 2 for per-target tracing. */ 70 #define NCR53C9X_DEBUG 1 71 72 /* Wide or differential can have 16 targets */ 73 #define NCR_NTARG 8 74 #define NCR_NLUN 8 75 76 #define NCR_ABORT_TIMEOUT 2000 /* time to wait for abort */ 77 #define NCR_SENSE_TIMEOUT 1000 /* time to wait for sense */ 78 79 #define FREQTOCCF(freq) (((freq + 4) / 5)) 80 81 /* 82 * NCR 53c9x variants. Note, these values are used as indexes into 83 * a table; don't modify them unless you know what you're doing. 84 */ 85 #define NCR_VARIANT_ESP100 0 86 #define NCR_VARIANT_ESP100A 1 87 #define NCR_VARIANT_ESP200 2 88 #define NCR_VARIANT_NCR53C94 3 89 #define NCR_VARIANT_NCR53C96 4 90 #define NCR_VARIANT_ESP406 5 91 #define NCR_VARIANT_FAS408 6 92 #define NCR_VARIANT_FAS216 7 93 #define NCR_VARIANT_AM53C974 8 94 #define NCR_VARIANT_MAX 9 95 96 /* 97 * ECB. Holds additional information for each SCSI command Comments: We 98 * need a separate scsi command block because we may need to overwrite it 99 * with a request sense command. Basicly, we refrain from fiddling with 100 * the scsipi_xfer struct (except do the expected updating of return values). 101 * We'll generally update: xs->{flags,resid,error,sense,status} and 102 * occasionally xs->retries. 103 */ 104 struct ncr53c9x_ecb { 105 TAILQ_ENTRY(ncr53c9x_ecb) chain; 106 struct scsipi_xfer *xs; /* SCSI xfer ctrl block from above */ 107 int flags; 108 #define ECB_ALLOC 0x01 109 #define ECB_READY 0x02 110 #define ECB_SENSE 0x04 111 #define ECB_ABORT 0x40 112 #define ECB_RESET 0x80 113 #define ECB_TENTATIVE_DONE 0x100 114 int timeout; 115 116 struct { 117 u_char msg[3]; /* Selection Id msg and tags */ 118 struct scsi_generic cmd; /* SCSI command block */ 119 } cmd; 120 char *daddr; /* Saved data pointer */ 121 int clen; /* Size of command in cmd.cmd */ 122 int dleft; /* Residue */ 123 u_char stat; /* SCSI status byte */ 124 u_char tag[2]; /* TAG bytes */ 125 u_char pad[1]; 126 127 #if NCR53C9X_DEBUG > 1 128 char trace[1000]; 129 #endif 130 }; 131 #if NCR53C9X_DEBUG > 1 132 #define ECB_TRACE(ecb, msg, a, b) do { \ 133 const char *f = "[" msg "]"; \ 134 int n = strlen((ecb)->trace); \ 135 if (n < (sizeof((ecb)->trace)-100)) \ 136 sprintf((ecb)->trace + n, f, a, b); \ 137 } while(0) 138 #else 139 #define ECB_TRACE(ecb, msg, a, b) 140 #endif 141 142 /* 143 * Some info about each (possible) target and LUN on the SCSI bus. 144 * 145 * SCSI I and II devices can have up to 8 LUNs, each with up to 256 146 * outstanding tags. SCSI III devices have 64-bit LUN identifiers 147 * that can be sparsely allocated. 148 * 149 * Since SCSI II devices can have up to 8 LUNs, we use an array 150 * of 8 pointers to ncr53c9x_linfo structures for fast lookup. 151 * Longer LUNs need to traverse the linked list. 152 */ 153 154 struct ncr53c9x_linfo { 155 int64_t lun; 156 LIST_ENTRY(ncr53c9x_linfo) link; 157 time_t last_used; 158 unsigned char used; /* # slots in use */ 159 unsigned char avail; /* where to start scanning */ 160 unsigned char busy; 161 struct ncr53c9x_ecb *untagged; 162 struct ncr53c9x_ecb *queued[256]; 163 }; 164 165 struct ncr53c9x_tinfo { 166 int cmds; /* # of commands processed */ 167 int dconns; /* # of disconnects */ 168 int touts; /* # of timeouts */ 169 int perrs; /* # of parity errors */ 170 int senses; /* # of request sense commands sent */ 171 u_char flags; 172 #define T_NEED_TO_RESET 0x01 /* Should send a BUS_DEV_RESET */ 173 #define T_NEGOTIATE 0x02 /* (Re)Negotiate synchronous options */ 174 #define T_BUSY 0x04 /* Target is busy, i.e. cmd in progress */ 175 #define T_SYNCMODE 0x08 /* SYNC mode has been negotiated */ 176 #define T_SYNCHOFF 0x10 /* SYNC mode for is permanently off */ 177 #define T_RSELECTOFF 0x20 /* RE-SELECT mode is off */ 178 #define T_TAGOFF 0x40 /* TAG QUEUEs are off */ 179 u_char period; /* Period suggestion */ 180 u_char offset; /* Offset suggestion */ 181 u_char nextag; /* Next available tag */ 182 LIST_HEAD(lun_list, ncr53c9x_linfo) luns; 183 struct ncr53c9x_linfo *lun[NCR_NLUN]; /* For speedy lookups */ 184 }; 185 186 /* Look up a lun in a tinfo */ 187 #define TINFO_LUN(t, l) ( \ 188 (((l) < NCR_NLUN) && (((t)->lun[(l)]) != NULL)) \ 189 ? ((t)->lun[(l)]) \ 190 : ncr53c9x_lunsearch((t), (int64_t)(l)) \ 191 ) 192 193 /* Register a linenumber (for debugging) */ 194 #define LOGLINE(p) 195 196 #define NCR_SHOWECBS 0x01 197 #define NCR_SHOWINTS 0x02 198 #define NCR_SHOWCMDS 0x04 199 #define NCR_SHOWMISC 0x08 200 #define NCR_SHOWTRAC 0x10 201 #define NCR_SHOWSTART 0x20 202 #define NCR_SHOWPHASE 0x40 203 #define NCR_SHOWDMA 0x80 204 #define NCR_SHOWCCMDS 0x100 205 #define NCR_SHOWMSGS 0x200 206 207 #ifdef NCR53C9X_DEBUG 208 extern int ncr53c9x_debug; 209 #define NCR_ECBS(str) \ 210 do {if (ncr53c9x_debug & NCR_SHOWECBS) printf str;} while (0) 211 #define NCR_MISC(str) \ 212 do {if (ncr53c9x_debug & NCR_SHOWMISC) printf str;} while (0) 213 #define NCR_INTS(str) \ 214 do {if (ncr53c9x_debug & NCR_SHOWINTS) printf str;} while (0) 215 #define NCR_TRACE(str) \ 216 do {if (ncr53c9x_debug & NCR_SHOWTRAC) printf str;} while (0) 217 #define NCR_CMDS(str) \ 218 do {if (ncr53c9x_debug & NCR_SHOWCMDS) printf str;} while (0) 219 #define NCR_START(str) \ 220 do {if (ncr53c9x_debug & NCR_SHOWSTART) printf str;}while (0) 221 #define NCR_PHASE(str) \ 222 do {if (ncr53c9x_debug & NCR_SHOWPHASE) printf str;}while (0) 223 #define NCR_DMA(str) \ 224 do {if (ncr53c9x_debug & NCR_SHOWDMA) printf str;}while (0) 225 #define NCR_MSGS(str) \ 226 do {if (ncr53c9x_debug & NCR_SHOWMSGS) printf str;}while (0) 227 #else 228 #define NCR_ECBS(str) 229 #define NCR_MISC(str) 230 #define NCR_INTS(str) 231 #define NCR_TRACE(str) 232 #define NCR_CMDS(str) 233 #define NCR_START(str) 234 #define NCR_PHASE(str) 235 #define NCR_DMA(str) 236 #define NCR_MSGS(str) 237 #endif 238 239 #define NCR_MAX_MSG_LEN 8 240 241 struct ncr53c9x_softc; 242 243 /* 244 * Function switch used as glue to MD code. 245 */ 246 struct ncr53c9x_glue { 247 /* Mandatory entry points. */ 248 u_char (*gl_read_reg)(struct ncr53c9x_softc *, int); 249 void (*gl_write_reg)(struct ncr53c9x_softc *, int, u_char); 250 int (*gl_dma_isintr)(struct ncr53c9x_softc *); 251 void (*gl_dma_reset)(struct ncr53c9x_softc *); 252 int (*gl_dma_intr)(struct ncr53c9x_softc *); 253 int (*gl_dma_setup)(struct ncr53c9x_softc *, 254 caddr_t *, size_t *, int, size_t *); 255 void (*gl_dma_go)(struct ncr53c9x_softc *); 256 void (*gl_dma_stop)(struct ncr53c9x_softc *); 257 int (*gl_dma_isactive)(struct ncr53c9x_softc *); 258 259 /* Optional entry points. */ 260 void (*gl_clear_latched_intr)(struct ncr53c9x_softc *); 261 }; 262 263 struct ncr53c9x_softc { 264 struct device sc_dev; /* us as a device */ 265 266 struct evcnt sc_intrcnt; /* intr count */ 267 struct scsipi_link sc_link; /* scsipi link struct */ 268 struct device *sc_child; /* attached scsibus, if any */ 269 struct callout sc_watchdog; /* periodic timer */ 270 271 struct ncr53c9x_glue *sc_glue; /* glue to MD code */ 272 273 int sc_cfflags; /* Copy of config flags */ 274 275 /* register defaults */ 276 u_char sc_cfg1; /* Config 1 */ 277 u_char sc_cfg2; /* Config 2, not ESP100 */ 278 u_char sc_cfg3; /* Config 3, only ESP200 */ 279 u_char sc_cfg3_fscsi; /* Chip-specific FSCSI bit */ 280 u_char sc_cfg4; /* Config 3, only ESP200 */ 281 u_char sc_cfg5; /* Config 3, only ESP200 */ 282 u_char sc_ccf; /* Clock Conversion */ 283 u_char sc_timeout; 284 285 /* register copies, see espreadregs() */ 286 u_char sc_espintr; 287 u_char sc_espstat; 288 u_char sc_espstep; 289 u_char sc_espfflags; 290 291 /* Lists of command blocks */ 292 TAILQ_HEAD(ecb_list, ncr53c9x_ecb) 293 ready_list; 294 295 struct ncr53c9x_ecb *sc_nexus; /* Current command */ 296 struct ncr53c9x_tinfo sc_tinfo[NCR_NTARG]; 297 298 /* Data about the current nexus (updated for every cmd switch) */ 299 caddr_t sc_dp; /* Current data pointer */ 300 ssize_t sc_dleft; /* Data left to transfer */ 301 302 /* Adapter state */ 303 int sc_phase; /* Copy of what bus phase we are in */ 304 int sc_prevphase; /* Copy of what bus phase we were in */ 305 u_char sc_state; /* State applicable to the adapter */ 306 u_char sc_flags; /* See below */ 307 u_char sc_selid; 308 u_char sc_lastcmd; 309 310 /* Message stuff */ 311 u_short sc_msgify; /* IDENTIFY message associated with this nexus */ 312 u_short sc_msgout; /* What message is on its way out? */ 313 u_short sc_msgpriq; /* One or more messages to send (encoded) */ 314 u_short sc_msgoutq; /* What messages have been sent so far? */ 315 316 u_char *sc_omess; /* MSGOUT buffer */ 317 caddr_t sc_omp; /* Message pointer (for multibyte messages) */ 318 size_t sc_omlen; 319 u_char *sc_imess; /* MSGIN buffer */ 320 caddr_t sc_imp; /* Message pointer (for multibyte messages) */ 321 size_t sc_imlen; 322 323 caddr_t sc_cmdp; /* Command pointer (for DMAed commands) */ 324 size_t sc_cmdlen; /* Size of command in transit */ 325 326 /* Hardware attributes */ 327 int sc_freq; /* SCSI bus frequency in MHz */ 328 int sc_id; /* Our SCSI id */ 329 int sc_rev; /* Chip revision */ 330 int sc_features; /* Chip features */ 331 int sc_minsync; /* Minimum sync period / 4 */ 332 int sc_maxxfer; /* Maximum transfer size */ 333 }; 334 335 /* values for sc_state */ 336 #define NCR_IDLE 1 /* waiting for something to do */ 337 #define NCR_SELECTING 2 /* SCSI command is arbiting */ 338 #define NCR_RESELECTED 3 /* Has been reselected */ 339 #define NCR_IDENTIFIED 4 /* Has gotten IFY but not TAG */ 340 #define NCR_CONNECTED 5 /* Actively using the SCSI bus */ 341 #define NCR_DISCONNECT 6 /* MSG_DISCONNECT received */ 342 #define NCR_CMDCOMPLETE 7 /* MSG_CMDCOMPLETE received */ 343 #define NCR_CLEANING 8 344 #define NCR_SBR 9 /* Expect a SCSI RST because we commanded it */ 345 346 /* values for sc_flags */ 347 #define NCR_DROP_MSGI 0x01 /* Discard all msgs (parity err detected) */ 348 #define NCR_ABORTING 0x02 /* Bailing out */ 349 #define NCR_DOINGDMA 0x04 /* The FIFO data path is active! */ 350 #define NCR_SYNCHNEGO 0x08 /* Synch negotiation in progress. */ 351 #define NCR_ICCS 0x10 /* Expect status phase results */ 352 #define NCR_WAITI 0x20 /* Waiting for non-DMA data to arrive */ 353 #define NCR_ATN 0x40 /* ATN asserted */ 354 #define NCR_EXPECT_ILLCMD 0x80 /* Expect Illegal Command Interrupt */ 355 356 /* values for sc_features */ 357 #define NCR_F_HASCFG3 0x01 /* chip has CFG3 register */ 358 #define NCR_F_FASTSCSI 0x02 /* chip supports Fast mode */ 359 360 /* values for sc_msgout */ 361 #define SEND_DEV_RESET 0x0001 362 #define SEND_PARITY_ERROR 0x0002 363 #define SEND_INIT_DET_ERR 0x0004 364 #define SEND_REJECT 0x0008 365 #define SEND_IDENTIFY 0x0010 366 #define SEND_ABORT 0x0020 367 #define SEND_SDTR 0x0040 368 #define SEND_WDTR 0x0080 369 #define SEND_TAG 0x0100 370 371 /* SCSI Status codes */ 372 #define ST_MASK 0x3e /* bit 0,6,7 is reserved */ 373 374 /* phase bits */ 375 #define IOI 0x01 376 #define CDI 0x02 377 #define MSGI 0x04 378 379 /* Information transfer phases */ 380 #define DATA_OUT_PHASE (0) 381 #define DATA_IN_PHASE (IOI) 382 #define COMMAND_PHASE (CDI) 383 #define STATUS_PHASE (CDI|IOI) 384 #define MESSAGE_OUT_PHASE (MSGI|CDI) 385 #define MESSAGE_IN_PHASE (MSGI|CDI|IOI) 386 387 #define PHASE_MASK (MSGI|CDI|IOI) 388 389 /* Some pseudo phases for getphase()*/ 390 #define BUSFREE_PHASE 0x100 /* Re/Selection no longer valid */ 391 #define INVALID_PHASE 0x101 /* Re/Selection valid, but no REQ yet */ 392 #define PSEUDO_PHASE 0x100 /* "pseudo" bit */ 393 394 /* 395 * Macros to read and write the chip's registers. 396 */ 397 #define NCR_READ_REG(sc, reg) \ 398 (*(sc)->sc_glue->gl_read_reg)((sc), (reg)) 399 #define NCR_WRITE_REG(sc, reg, val) \ 400 (*(sc)->sc_glue->gl_write_reg)((sc), (reg), (val)) 401 402 #ifdef NCR53C9X_DEBUG 403 #define NCRCMD(sc, cmd) do { \ 404 if ((ncr53c9x_debug & NCR_SHOWCCMDS) != 0) \ 405 printf("<cmd:0x%x %d>", (unsigned)cmd, __LINE__); \ 406 sc->sc_lastcmd = cmd; \ 407 NCR_WRITE_REG(sc, NCR_CMD, cmd); \ 408 } while (0) 409 #else 410 #define NCRCMD(sc, cmd) NCR_WRITE_REG(sc, NCR_CMD, cmd) 411 #endif 412 413 /* 414 * DMA macros for NCR53c9x 415 */ 416 #define NCRDMA_ISINTR(sc) (*(sc)->sc_glue->gl_dma_isintr)((sc)) 417 #define NCRDMA_RESET(sc) (*(sc)->sc_glue->gl_dma_reset)((sc)) 418 #define NCRDMA_INTR(sc) (*(sc)->sc_glue->gl_dma_intr)((sc)) 419 #define NCRDMA_SETUP(sc, addr, len, datain, dmasize) \ 420 (*(sc)->sc_glue->gl_dma_setup)((sc), (addr), (len), (datain), (dmasize)) 421 #define NCRDMA_GO(sc) (*(sc)->sc_glue->gl_dma_go)((sc)) 422 #define NCRDMA_ISACTIVE(sc) (*(sc)->sc_glue->gl_dma_isactive)((sc)) 423 424 /* 425 * Macro to convert the chip register Clock Per Byte value to 426 * Sunchronous Transfer Period. 427 */ 428 #define ncr53c9x_cpb2stp(sc, cpb) \ 429 ((250 * (cpb)) / (sc)->sc_freq) 430 431 void ncr53c9x_attach(struct ncr53c9x_softc *, 432 struct scsipi_adapter *, struct scsipi_device *); 433 int ncr53c9x_detach(struct ncr53c9x_softc *, int); 434 int ncr53c9x_scsi_cmd(struct scsipi_xfer *); 435 void ncr53c9x_reset(struct ncr53c9x_softc *); 436 int ncr53c9x_intr(void *); 437 void ncr53c9x_init(struct ncr53c9x_softc *, int); 438 439 extern int ncr53c9x_dmaselect; 440
Indexes created Thu Oct 23 22:10:10 GMT 2025