aic7xxx_inline.h revision 70204
1/* 2 * Inline routines shareable across OS platforms. 3 * 4 * Copyright (c) 1994, 1995, 1996, 1997, 1998, 1999, 2000 Justin T. Gibbs. 5 * 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 * without modification. 13 * 2. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * Alternatively, this software may be distributed under the terms of the 17 * GNU Public License ("GPL"). 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $Id: //depot/src/aic7xxx/aic7xxx_inline.h#12 $ 32 * 33 * $FreeBSD: head/sys/dev/aic7xxx/aic7xxx_inline.h 70204 2000-12-20 01:11:37Z gibbs $ 34 */ 35 36#ifndef _AIC7XXX_INLINE_H_ 37#define _AIC7XXX_INLINE_H_ 38 39/************************* Sequencer Execution Control ************************/ 40static __inline int sequencer_paused(struct ahc_softc *ahc); 41static __inline void ahc_pause_bug_fix(struct ahc_softc *ahc); 42static __inline void pause_sequencer(struct ahc_softc *ahc); 43static __inline void unpause_sequencer(struct ahc_softc *ahc); 44 45/* 46 * Work around any chip bugs related to halting sequencer execution. 47 * On Ultra2 controllers, we must clear the CIOBUS stretch signal by 48 * reading a register that will set this signal and deassert it. 49 * Without this workaround, if the chip is paused, by an interrupt or 50 * manual pause while accessing scb ram, accesses to certain registers 51 * will hang the system (infinite pci retries). 52 */ 53static __inline void 54ahc_pause_bug_fix(struct ahc_softc *ahc) 55{ 56 if ((ahc->features & AHC_ULTRA2) != 0) 57 (void)ahc_inb(ahc, CCSCBCTL); 58} 59 60/* 61 * Determine whether the sequencer has halted code execution. 62 * Returns non-zero status if the sequencer is stopped. 63 */ 64static __inline int 65sequencer_paused(struct ahc_softc *ahc) 66{ 67 return ((ahc_inb(ahc, HCNTRL) & PAUSE) != 0); 68} 69 70/* 71 * Request that the sequencer stop and wait, indefinitely, for it 72 * to stop. The sequencer will only acknowledge that it is paused 73 * once it has reached an instruction boundary and PAUSEDIS is 74 * cleared in the SEQCTL register. The sequencer may use PAUSEDIS 75 * for critical sections. 76 */ 77static __inline void 78pause_sequencer(struct ahc_softc *ahc) 79{ 80 ahc_outb(ahc, HCNTRL, ahc->pause); 81 82 /* 83 * Since the sequencer can disable pausing in a critical section, we 84 * must loop until it actually stops. 85 */ 86 while (sequencer_paused(ahc) == 0) 87 ; 88 89 ahc_pause_bug_fix(ahc); 90} 91 92/* 93 * Allow the sequencer to continue program execution. 94 * We check here to ensure that no additional interrupt 95 * sources that would cause the sequencer to halt have been 96 * asserted. If, for example, a SCSI bus reset is detected 97 * while we are fielding a different, pausing, interrupt type, 98 * we don't want to release the sequencer before going back 99 * into our interrupt handler and dealing with this new 100 * condition. 101 */ 102static __inline void 103unpause_sequencer(struct ahc_softc *ahc) 104{ 105 if ((ahc_inb(ahc, INTSTAT) & (SCSIINT | SEQINT | BRKADRINT)) == 0) 106 ahc_outb(ahc, HCNTRL, ahc->unpause); 107} 108 109/*********************** Untagged Transaction Routines ************************/ 110static __inline void ahc_freeze_untagged_queues(struct ahc_softc *ahc); 111static __inline void ahc_release_untagged_queues(struct ahc_softc *ahc); 112 113/* 114 * Block our completion routine from starting the next untagged 115 * transaction for this target or target lun. 116 */ 117static __inline void 118ahc_freeze_untagged_queues(struct ahc_softc *ahc) 119{ 120 if ((ahc->features & AHC_SCB_BTT) == 0) 121 ahc->untagged_queue_lock++; 122} 123 124/* 125 * Allow the next untagged transaction for this target or target lun 126 * to be executed. We use a counting semaphore to allow the lock 127 * to be acquired recursively. Once the count drops to zero, the 128 * transaction queues will be run. 129 */ 130static __inline void 131ahc_release_untagged_queues(struct ahc_softc *ahc) 132{ 133 if ((ahc->features & AHC_SCB_BTT) == 0) { 134 ahc->untagged_queue_lock--; 135 if (ahc->untagged_queue_lock == 0) 136 ahc_run_untagged_queues(ahc); 137 } 138} 139 140/************************** Memory mapping routines ***************************/ 141static __inline struct ahc_dma_seg * 142 ahc_sg_bus_to_virt(struct scb *scb, 143 uint32_t sg_busaddr); 144static __inline uint32_t 145 ahc_sg_virt_to_bus(struct scb *scb, 146 struct ahc_dma_seg *sg); 147static __inline uint32_t 148 ahc_hscb_busaddr(struct ahc_softc *ahc, u_int index); 149 150static __inline struct ahc_dma_seg * 151ahc_sg_bus_to_virt(struct scb *scb, uint32_t sg_busaddr) 152{ 153 int sg_index; 154 155 sg_index = (sg_busaddr - scb->sg_list_phys)/sizeof(struct ahc_dma_seg); 156 /* sg_list_phys points to entry 1, not 0 */ 157 sg_index++; 158 159 return (&scb->sg_list[sg_index]); 160} 161 162static __inline uint32_t 163ahc_sg_virt_to_bus(struct scb *scb, struct ahc_dma_seg *sg) 164{ 165 int sg_index; 166 167 /* sg_list_phys points to entry 1, not 0 */ 168 sg_index = sg - &scb->sg_list[1]; 169 170 return (scb->sg_list_phys + (sg_index * sizeof(*scb->sg_list))); 171} 172 173static __inline uint32_t 174ahc_hscb_busaddr(struct ahc_softc *ahc, u_int index) 175{ 176 return (ahc->scb_data->hscb_busaddr 177 + (sizeof(struct hardware_scb) * index)); 178} 179 180/******************************** Debugging ***********************************/ 181static __inline char *ahc_name(struct ahc_softc *ahc); 182 183static __inline char * 184ahc_name(struct ahc_softc *ahc) 185{ 186 return (ahc->name); 187} 188 189/*********************** Miscelaneous Support Functions ***********************/ 190 191static __inline int ahc_check_residual(struct scb *scb); 192static __inline struct ahc_initiator_tinfo * 193 ahc_fetch_transinfo(struct ahc_softc *ahc, 194 char channel, u_int our_id, 195 u_int remote_id, 196 struct tmode_tstate **tstate); 197static __inline struct scb* 198 ahc_get_scb(struct ahc_softc *ahc); 199static __inline void ahc_free_scb(struct ahc_softc *ahc, struct scb *scb); 200static __inline void ahc_swap_with_next_hscb(struct ahc_softc *ahc, 201 struct scb *scb); 202static __inline void ahc_queue_scb(struct ahc_softc *ahc, struct scb *scb); 203 204/* 205 * Determine whether the sequencer reported a residual 206 * for this SCB/transaction. 207 */ 208static __inline int 209ahc_check_residual(struct scb *scb) 210{ 211 struct status_pkt *sp; 212 213 sp = &scb->hscb->shared_data.status; 214 if ((scb->hscb->sgptr & SG_RESID_VALID) != 0) 215 return (1); 216 return (0); 217} 218 219/* 220 * Return pointers to the transfer negotiation information 221 * for the specified our_id/remote_id pair. 222 */ 223static __inline struct ahc_initiator_tinfo * 224ahc_fetch_transinfo(struct ahc_softc *ahc, char channel, u_int our_id, 225 u_int remote_id, struct tmode_tstate **tstate) 226{ 227 /* 228 * Transfer data structures are stored from the perspective 229 * of the target role. Since the parameters for a connection 230 * in the initiator role to a given target are the same as 231 * when the roles are reversed, we pretend we are the target. 232 */ 233 if (channel == 'B') 234 our_id += 8; 235 *tstate = ahc->enabled_targets[our_id]; 236 return (&(*tstate)->transinfo[remote_id]); 237} 238 239/* 240 * Get a free scb. If there are none, see if we can allocate a new SCB. 241 */ 242static __inline struct scb * 243ahc_get_scb(struct ahc_softc *ahc) 244{ 245 struct scb *scb; 246 247 if ((scb = SLIST_FIRST(&ahc->scb_data->free_scbs)) == NULL) { 248 ahc_alloc_scbs(ahc); 249 scb = SLIST_FIRST(&ahc->scb_data->free_scbs); 250 if (scb == NULL) 251 return (NULL); 252 } 253 SLIST_REMOVE_HEAD(&ahc->scb_data->free_scbs, links.sle); 254 return (scb); 255} 256 257/* 258 * Return an SCB resource to the free list. 259 */ 260static __inline void 261ahc_free_scb(struct ahc_softc *ahc, struct scb *scb) 262{ 263 struct hardware_scb *hscb; 264 265 hscb = scb->hscb; 266 /* Clean up for the next user */ 267 ahc->scb_data->scbindex[hscb->tag] = NULL; 268 scb->flags = SCB_FREE; 269 hscb->control = 0; 270 271 SLIST_INSERT_HEAD(&ahc->scb_data->free_scbs, scb, links.sle); 272 273 /* Notify the OSM that a resource is now available. */ 274 ahc_platform_scb_free(ahc, scb); 275} 276 277static __inline struct scb * 278ahc_lookup_scb(struct ahc_softc *ahc, u_int tag) 279{ 280 return (ahc->scb_data->scbindex[tag]); 281 282} 283 284static __inline void 285ahc_swap_with_next_hscb(struct ahc_softc *ahc, struct scb *scb) 286{ 287 struct hardware_scb *q_hscb; 288 u_int saved_tag; 289 290 /* 291 * Our queuing method is a bit tricky. The card 292 * knows in advance which HSCB to download, and we 293 * can't disappoint it. To achieve this, the next 294 * SCB to download is saved off in ahc->next_queued_scb. 295 * When we are called to queue "an arbitrary scb", 296 * we copy the contents of the incoming HSCB to the one 297 * the sequencer knows about, swap HSCB pointers and 298 * finally assign the SCB to the tag indexed location 299 * in the scb_array. This makes sure that we can still 300 * locate the correct SCB by SCB_TAG. 301 */ 302 q_hscb = ahc->next_queued_scb->hscb; 303 saved_tag = q_hscb->tag; 304 memcpy(q_hscb, scb->hscb, sizeof(*scb->hscb)); 305 if ((scb->flags & SCB_CDB32_PTR) != 0) { 306 q_hscb->shared_data.cdb_ptr = 307 ahc_hscb_busaddr(ahc, q_hscb->tag) 308 + offsetof(struct hardware_scb, cdb32); 309 } 310 q_hscb->tag = saved_tag; 311 q_hscb->next = scb->hscb->tag; 312 313 /* Now swap HSCB pointers. */ 314 ahc->next_queued_scb->hscb = scb->hscb; 315 scb->hscb = q_hscb; 316 317 /* Now define the mapping from tag to SCB in the scbindex */ 318 ahc->scb_data->scbindex[scb->hscb->tag] = scb; 319} 320 321/* 322 * Tell the sequencer about a new transaction to execute. 323 */ 324static __inline void 325ahc_queue_scb(struct ahc_softc *ahc, struct scb *scb) 326{ 327 ahc_swap_with_next_hscb(ahc, scb); 328 329 if (scb->hscb->tag == SCB_LIST_NULL 330 || scb->hscb->next == SCB_LIST_NULL) 331 panic("Attempt to queue invalid SCB tag %x:%x\n", 332 scb->hscb->tag, scb->hscb->next); 333 334 /* 335 * Keep a history of SCBs we've downloaded in the qinfifo. 336 */ 337 ahc->qinfifo[ahc->qinfifonext++] = scb->hscb->tag; 338 if ((ahc->features & AHC_QUEUE_REGS) != 0) { 339 ahc_outb(ahc, HNSCB_QOFF, ahc->qinfifonext); 340 } else { 341 if ((ahc->features & AHC_AUTOPAUSE) == 0) 342 pause_sequencer(ahc); 343 ahc_outb(ahc, KERNEL_QINPOS, ahc->qinfifonext); 344 if ((ahc->features & AHC_AUTOPAUSE) == 0) 345 unpause_sequencer(ahc); 346 } 347} 348 349/************************** Interrupt Processing ******************************/ 350static __inline u_int ahc_check_cmdcmpltqueues(struct ahc_softc *ahc); 351static __inline void ahc_intr(struct ahc_softc *ahc); 352 353/* 354 * See if the firmware has posted any completed commands 355 * into our in-core command complete fifos. 356 */ 357#define AHC_RUN_QOUTFIFO 0x1 358#define AHC_RUN_TQINFIFO 0x2 359static __inline u_int 360ahc_check_cmdcmpltqueues(struct ahc_softc *ahc) 361{ 362 u_int retval; 363 364 retval = 0; 365 if (ahc->qoutfifo[ahc->qoutfifonext] != SCB_LIST_NULL) 366 retval |= AHC_RUN_QOUTFIFO; 367#ifdef AHC_TARGET_MODE 368 if ((ahc->flags & AHC_TARGETROLE) != 0 369 && ahc->targetcmds[ahc->tqinfifonext].cmd_valid != 0) 370 retval |= AHC_RUN_TQINFIFO; 371#endif 372 return (retval); 373} 374 375/* 376 * Catch an interrupt from the adapter 377 */ 378static __inline void 379ahc_intr(struct ahc_softc *ahc) 380{ 381 u_int intstat; 382 u_int queuestat; 383 384 /* 385 * Instead of directly reading the interrupt status register, 386 * infer the cause of the interrupt by checking our in-core 387 * completion queues. This avoids a costly PCI bus read in 388 * most cases. 389 */ 390 intstat = 0; 391 if ((queuestat = ahc_check_cmdcmpltqueues(ahc)) != 0) 392 intstat = CMDCMPLT; 393 394 if ((intstat & INT_PEND) == 0 395 || (ahc->flags & AHC_ALL_INTERRUPTS) != 0) { 396 397 intstat = ahc_inb(ahc, INTSTAT); 398#if AHC_PCI_CONFIG > 0 399 if (ahc->unsolicited_ints > 500 400 && (ahc->chip & AHC_PCI) != 0 401 && (ahc_inb(ahc, ERROR) & PCIERRSTAT) != 0) 402 ahc_pci_intr(ahc); 403#endif 404 } 405 406 if (intstat == 0xFF) 407 /* Hot eject */ 408 return; 409 410 if ((intstat & INT_PEND) == 0) { 411 ahc->unsolicited_ints++; 412 return; 413 } 414 ahc->unsolicited_ints = 0; 415 416 if (intstat & CMDCMPLT) { 417 ahc_outb(ahc, CLRINT, CLRCMDINT); 418 419 /* 420 * Ensure that the chip sees that we've cleared 421 * this interrupt before we walk the output fifo. 422 * Otherwise, we may, due to posted bus writes, 423 * clear the interrupt after we finish the scan, 424 * and after the sequencer has added new entries 425 * and asserted the interrupt again. 426 */ 427 ahc_flush_device_writes(ahc); 428#ifdef AHC_TARGET_MODE 429 if ((queuestat & AHC_RUN_QOUTFIFO) != 0) 430#endif 431 ahc_run_qoutfifo(ahc); 432#ifdef AHC_TARGET_MODE 433 if ((queuestat & AHC_RUN_TQINFIFO) != 0) 434 ahc_run_tqinfifo(ahc, /*paused*/FALSE); 435#endif 436 } 437 if (intstat & BRKADRINT) { 438 ahc_handle_brkadrint(ahc); 439 /* Fatal error, no more interrupts to handle. */ 440 return; 441 } 442 443 if ((intstat & (SEQINT|SCSIINT)) != 0) 444 ahc_pause_bug_fix(ahc); 445 446 if ((intstat & SEQINT) != 0) 447 ahc_handle_seqint(ahc, intstat); 448 449 if ((intstat & SCSIINT) != 0) 450 ahc_handle_scsiint(ahc, intstat); 451} 452 453#endif /* _AIC7XXX_INLINE_H_ */ 454