Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / sys / dev / disk / aic7xxx / aic79xx_inline.h
1 /*
2  * Inline routines shareable across OS platforms.
3  *
4  * Copyright (c) 1994-2001 Justin T. Gibbs.
5  * Copyright (c) 2000-2003 Adaptec Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions, and the following disclaimer,
13  *    without modification.
14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15  *    substantially similar to the "NO WARRANTY" disclaimer below
16  *    ("Disclaimer") and any redistribution must be conditioned upon
17  *    including a substantially similar Disclaimer requirement for further
18  *    binary redistribution.
19  * 3. Neither the names of the above-listed copyright holders nor the names
20  *    of any contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * Alternatively, this software may be distributed under the terms of the
24  * GNU General Public License ("GPL") version 2 as published by the Free
25  * Software Foundation.
26  *
27  * NO WARRANTY
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGES.
39  *
40  * $Id: //depot/aic7xxx/aic7xxx/aic79xx_inline.h#50 $
41  *
42  * $FreeBSD: src/sys/dev/aic7xxx/aic79xx_inline.h,v 1.3.2.5 2003/06/10 03:26:07 gibbs Exp $
43  * $DragonFly: src/sys/dev/disk/aic7xxx/aic79xx_inline.h,v 1.2 2003/06/17 04:28:21 dillon Exp $
44  */
45
46 #ifndef _AIC79XX_INLINE_H_
47 #define _AIC79XX_INLINE_H_
48
49 /******************************** Debugging ***********************************/
50 static __inline char *ahd_name(struct ahd_softc *ahd);
51
52 static __inline char *
53 ahd_name(struct ahd_softc *ahd)
54 {
55         return (ahd->name);
56 }
57
58 /************************ Sequencer Execution Control *************************/
59 static __inline void ahd_known_modes(struct ahd_softc *ahd,
60                                      ahd_mode src, ahd_mode dst);
61 static __inline ahd_mode_state ahd_build_mode_state(struct ahd_softc *ahd,
62                                                     ahd_mode src,
63                                                     ahd_mode dst);
64 static __inline void ahd_extract_mode_state(struct ahd_softc *ahd,
65                                             ahd_mode_state state,
66                                             ahd_mode *src, ahd_mode *dst);
67 static __inline void ahd_set_modes(struct ahd_softc *ahd, ahd_mode src,
68                                    ahd_mode dst);
69 static __inline void ahd_update_modes(struct ahd_softc *ahd);
70 static __inline void ahd_assert_modes(struct ahd_softc *ahd, ahd_mode srcmode,
71                                       ahd_mode dstmode, const char *file,
72                                       int line);
73 static __inline ahd_mode_state ahd_save_modes(struct ahd_softc *ahd);
74 static __inline void ahd_restore_modes(struct ahd_softc *ahd,
75                                        ahd_mode_state state);
76 static __inline int  ahd_is_paused(struct ahd_softc *ahd);
77 static __inline void ahd_pause(struct ahd_softc *ahd);
78 static __inline void ahd_unpause(struct ahd_softc *ahd);
79
80 static __inline void
81 ahd_known_modes(struct ahd_softc *ahd, ahd_mode src, ahd_mode dst)
82 {
83         ahd->src_mode = src;
84         ahd->dst_mode = dst;
85         ahd->saved_src_mode = src;
86         ahd->saved_dst_mode = dst;
87 }
88
89 static __inline ahd_mode_state
90 ahd_build_mode_state(struct ahd_softc *ahd, ahd_mode src, ahd_mode dst)
91 {
92         return ((src << SRC_MODE_SHIFT) | (dst << DST_MODE_SHIFT));
93 }
94
95 static __inline void
96 ahd_extract_mode_state(struct ahd_softc *ahd, ahd_mode_state state,
97                        ahd_mode *src, ahd_mode *dst)
98 {
99         *src = (state & SRC_MODE) >> SRC_MODE_SHIFT;
100         *dst = (state & DST_MODE) >> DST_MODE_SHIFT;
101 }
102
103 static __inline void
104 ahd_set_modes(struct ahd_softc *ahd, ahd_mode src, ahd_mode dst)
105 {
106         if (ahd->src_mode == src && ahd->dst_mode == dst)
107                 return;
108 #ifdef AHD_DEBUG
109         if (ahd->src_mode == AHD_MODE_UNKNOWN
110          || ahd->dst_mode == AHD_MODE_UNKNOWN)
111                 panic("Setting mode prior to saving it.\n");
112         if ((ahd_debug & AHD_SHOW_MODEPTR) != 0)
113                 printf("%s: Setting mode 0x%x\n", ahd_name(ahd),
114                        ahd_build_mode_state(ahd, src, dst));
115 #endif
116         ahd_outb(ahd, MODE_PTR, ahd_build_mode_state(ahd, src, dst));
117         ahd->src_mode = src;
118         ahd->dst_mode = dst;
119 }
120
121 static __inline void
122 ahd_update_modes(struct ahd_softc *ahd)
123 {
124         ahd_mode_state mode_ptr;
125         ahd_mode src;
126         ahd_mode dst;
127
128         mode_ptr = ahd_inb(ahd, MODE_PTR);
129 #ifdef AHD_DEBUG
130         if ((ahd_debug & AHD_SHOW_MODEPTR) != 0)
131                 printf("Reading mode 0x%x\n", mode_ptr);
132 #endif
133         ahd_extract_mode_state(ahd, mode_ptr, &src, &dst);
134         ahd_known_modes(ahd, src, dst);
135 }
136
137 static __inline void
138 ahd_assert_modes(struct ahd_softc *ahd, ahd_mode srcmode,
139                  ahd_mode dstmode, const char *file, int line)
140 {
141 #ifdef AHD_DEBUG
142         if ((srcmode & AHD_MK_MSK(ahd->src_mode)) == 0
143          || (dstmode & AHD_MK_MSK(ahd->dst_mode)) == 0) {
144                 panic("%s:%s:%d: Mode assertion failed.\n",
145                        ahd_name(ahd), file, line);
146         }
147 #endif
148 }
149
150 static __inline ahd_mode_state
151 ahd_save_modes(struct ahd_softc *ahd)
152 {
153         if (ahd->src_mode == AHD_MODE_UNKNOWN
154          || ahd->dst_mode == AHD_MODE_UNKNOWN)
155                 ahd_update_modes(ahd);
156
157         return (ahd_build_mode_state(ahd, ahd->src_mode, ahd->dst_mode));
158 }
159
160 static __inline void
161 ahd_restore_modes(struct ahd_softc *ahd, ahd_mode_state state)
162 {
163         ahd_mode src;
164         ahd_mode dst;
165
166         ahd_extract_mode_state(ahd, state, &src, &dst);
167         ahd_set_modes(ahd, src, dst);
168 }
169
170 #define AHD_ASSERT_MODES(ahd, source, dest) \
171         ahd_assert_modes(ahd, source, dest, __FILE__, __LINE__);
172
173 /*
174  * Determine whether the sequencer has halted code execution.
175  * Returns non-zero status if the sequencer is stopped.
176  */
177 static __inline int
178 ahd_is_paused(struct ahd_softc *ahd)
179 {
180         return ((ahd_inb(ahd, HCNTRL) & PAUSE) != 0);
181 }
182
183 /*
184  * Request that the sequencer stop and wait, indefinitely, for it
185  * to stop.  The sequencer will only acknowledge that it is paused
186  * once it has reached an instruction boundary and PAUSEDIS is
187  * cleared in the SEQCTL register.  The sequencer may use PAUSEDIS
188  * for critical sections.
189  */
190 static __inline void
191 ahd_pause(struct ahd_softc *ahd)
192 {
193         ahd_outb(ahd, HCNTRL, ahd->pause);
194
195         /*
196          * Since the sequencer can disable pausing in a critical section, we
197          * must loop until it actually stops.
198          */
199         while (ahd_is_paused(ahd) == 0)
200                 ;
201 }
202
203 /*
204  * Allow the sequencer to continue program execution.
205  * We check here to ensure that no additional interrupt
206  * sources that would cause the sequencer to halt have been
207  * asserted.  If, for example, a SCSI bus reset is detected
208  * while we are fielding a different, pausing, interrupt type,
209  * we don't want to release the sequencer before going back
210  * into our interrupt handler and dealing with this new
211  * condition.
212  */
213 static __inline void
214 ahd_unpause(struct ahd_softc *ahd)
215 {
216         /*
217          * Automatically restore our modes to those saved
218          * prior to the first change of the mode.
219          */
220         if (ahd->saved_src_mode != AHD_MODE_UNKNOWN
221          && ahd->saved_dst_mode != AHD_MODE_UNKNOWN) {
222                 if ((ahd->flags & AHD_UPDATE_PEND_CMDS) != 0)
223                         ahd_reset_cmds_pending(ahd);
224                 ahd_set_modes(ahd, ahd->saved_src_mode, ahd->saved_dst_mode);
225         }
226
227         if ((ahd_inb(ahd, INTSTAT) & ~CMDCMPLT) == 0)
228                 ahd_outb(ahd, HCNTRL, ahd->unpause);
229
230         ahd_known_modes(ahd, AHD_MODE_UNKNOWN, AHD_MODE_UNKNOWN);
231 }
232
233 /*********************** Scatter Gather List Handling *************************/
234 static __inline void    *ahd_sg_setup(struct ahd_softc *ahd, struct scb *scb,
235                                       void *sgptr, bus_addr_t addr,
236                                       bus_size_t len, int last);
237 static __inline void     ahd_setup_scb_common(struct ahd_softc *ahd,
238                                               struct scb *scb);
239 static __inline void     ahd_setup_data_scb(struct ahd_softc *ahd,
240                                             struct scb *scb);
241 static __inline void     ahd_setup_noxfer_scb(struct ahd_softc *ahd,
242                                               struct scb *scb);
243
244 static __inline void *
245 ahd_sg_setup(struct ahd_softc *ahd, struct scb *scb,
246              void *sgptr, bus_addr_t addr, bus_size_t len, int last)
247 {
248         scb->sg_count++;
249         if (sizeof(bus_addr_t) > 4
250          && (ahd->flags & AHD_64BIT_ADDRESSING) != 0) {
251                 struct ahd_dma64_seg *sg;
252
253                 sg = (struct ahd_dma64_seg *)sgptr;
254                 sg->addr = ahd_htole64(addr);
255                 sg->len = ahd_htole32(len | (last ? AHD_DMA_LAST_SEG : 0));
256                 return (sg + 1);
257         } else {
258                 struct ahd_dma_seg *sg;
259
260                 sg = (struct ahd_dma_seg *)sgptr;
261                 sg->addr = ahd_htole32(addr & 0xFFFFFFFF);
262                 sg->len = ahd_htole32(len | ((addr >> 8) & 0x7F000000)
263                                     | (last ? AHD_DMA_LAST_SEG : 0));
264                 return (sg + 1);
265         }
266 }
267
268 static __inline void
269 ahd_setup_scb_common(struct ahd_softc *ahd, struct scb *scb)
270 {
271         /* XXX Handle target mode SCBs. */
272         scb->crc_retry_count = 0;
273         if ((scb->flags & SCB_PACKETIZED) != 0) {
274                 /* XXX what about ACA??  It is type 4, but TAG_TYPE == 0x3. */
275                 scb->hscb->task_attribute = scb->hscb->control & SCB_TAG_TYPE;
276         } else {
277                 if (ahd_get_transfer_length(scb) & 0x01)
278                         scb->hscb->task_attribute = SCB_XFERLEN_ODD;
279                 else
280                         scb->hscb->task_attribute = 0;
281         }
282
283         if (scb->hscb->cdb_len <= MAX_CDB_LEN_WITH_SENSE_ADDR
284          || (scb->hscb->cdb_len & SCB_CDB_LEN_PTR) != 0)
285                 scb->hscb->shared_data.idata.cdb_plus_saddr.sense_addr =
286                     ahd_htole32(scb->sense_busaddr);
287 }
288
289 static __inline void
290 ahd_setup_data_scb(struct ahd_softc *ahd, struct scb *scb)
291 {
292         /*
293          * Copy the first SG into the "current" data ponter area.
294          */
295         if ((ahd->flags & AHD_64BIT_ADDRESSING) != 0) {
296                 struct ahd_dma64_seg *sg;
297
298                 sg = (struct ahd_dma64_seg *)scb->sg_list;
299                 scb->hscb->dataptr = sg->addr;
300                 scb->hscb->datacnt = sg->len;
301         } else {
302                 struct ahd_dma_seg *sg;
303                 uint32_t *dataptr_words;
304
305                 sg = (struct ahd_dma_seg *)scb->sg_list;
306                 dataptr_words = (uint32_t*)&scb->hscb->dataptr;
307                 dataptr_words[0] = sg->addr;
308                 dataptr_words[1] = 0;
309                 if ((ahd->flags & AHD_39BIT_ADDRESSING) != 0) {
310                         uint64_t high_addr;
311
312                         high_addr = ahd_le32toh(sg->len) & 0x7F000000;
313                         scb->hscb->dataptr |= ahd_htole64(high_addr << 8);
314                 }
315                 scb->hscb->datacnt = sg->len;
316         }
317         /*
318          * Note where to find the SG entries in bus space.
319          * We also set the full residual flag which the 
320          * sequencer will clear as soon as a data transfer
321          * occurs.
322          */
323         scb->hscb->sgptr = ahd_htole32(scb->sg_list_busaddr|SG_FULL_RESID);
324 }
325
326 static __inline void
327 ahd_setup_noxfer_scb(struct ahd_softc *ahd, struct scb *scb)
328 {
329         scb->hscb->sgptr = ahd_htole32(SG_LIST_NULL);
330         scb->hscb->dataptr = 0;
331         scb->hscb->datacnt = 0;
332 }
333
334 /************************** Memory mapping routines ***************************/
335 static __inline size_t  ahd_sg_size(struct ahd_softc *ahd);
336 static __inline void *
337                         ahd_sg_bus_to_virt(struct ahd_softc *ahd,
338                                            struct scb *scb,
339                                            uint32_t sg_busaddr);
340 static __inline uint32_t
341                         ahd_sg_virt_to_bus(struct ahd_softc *ahd,
342                                            struct scb *scb,
343                                            void *sg);
344 static __inline void    ahd_sync_scb(struct ahd_softc *ahd,
345                                      struct scb *scb, int op);
346 static __inline void    ahd_sync_sglist(struct ahd_softc *ahd,
347                                         struct scb *scb, int op);
348 static __inline void    ahd_sync_sense(struct ahd_softc *ahd,
349                                        struct scb *scb, int op);
350 static __inline uint32_t
351                         ahd_targetcmd_offset(struct ahd_softc *ahd,
352                                              u_int index);
353
354 static __inline size_t
355 ahd_sg_size(struct ahd_softc *ahd)
356 {
357         if ((ahd->flags & AHD_64BIT_ADDRESSING) != 0)
358                 return (sizeof(struct ahd_dma64_seg));
359         return (sizeof(struct ahd_dma_seg));
360 }
361
362 static __inline void *
363 ahd_sg_bus_to_virt(struct ahd_softc *ahd, struct scb *scb, uint32_t sg_busaddr)
364 {
365         bus_addr_t sg_offset;
366
367         /* sg_list_phys points to entry 1, not 0 */
368         sg_offset = sg_busaddr - (scb->sg_list_busaddr - ahd_sg_size(ahd));
369         return ((uint8_t *)scb->sg_list + sg_offset);
370 }
371
372 static __inline uint32_t
373 ahd_sg_virt_to_bus(struct ahd_softc *ahd, struct scb *scb, void *sg)
374 {
375         bus_addr_t sg_offset;
376
377         /* sg_list_phys points to entry 1, not 0 */
378         sg_offset = ((uint8_t *)sg - (uint8_t *)scb->sg_list)
379                   - ahd_sg_size(ahd);
380
381         return (scb->sg_list_busaddr + sg_offset);
382 }
383
384 static __inline void
385 ahd_sync_scb(struct ahd_softc *ahd, struct scb *scb, int op)
386 {
387         ahd_dmamap_sync(ahd, ahd->scb_data.hscb_dmat,
388                         scb->hscb_map->dmamap,
389                         /*offset*/(uint8_t*)scb->hscb - scb->hscb_map->vaddr,
390                         /*len*/sizeof(*scb->hscb), op);
391 }
392
393 static __inline void
394 ahd_sync_sglist(struct ahd_softc *ahd, struct scb *scb, int op)
395 {
396         if (scb->sg_count == 0)
397                 return;
398
399         ahd_dmamap_sync(ahd, ahd->scb_data.sg_dmat,
400                         scb->sg_map->dmamap,
401                         /*offset*/scb->sg_list_busaddr - ahd_sg_size(ahd),
402                         /*len*/ahd_sg_size(ahd) * scb->sg_count, op);
403 }
404
405 static __inline void
406 ahd_sync_sense(struct ahd_softc *ahd, struct scb *scb, int op)
407 {
408         ahd_dmamap_sync(ahd, ahd->scb_data.sense_dmat,
409                         scb->sense_map->dmamap,
410                         /*offset*/scb->sense_busaddr,
411                         /*len*/AHD_SENSE_BUFSIZE, op);
412 }
413
414 static __inline uint32_t
415 ahd_targetcmd_offset(struct ahd_softc *ahd, u_int index)
416 {
417         return (((uint8_t *)&ahd->targetcmds[index])
418                - (uint8_t *)ahd->qoutfifo);
419 }
420
421 /*********************** Miscelaneous Support Functions ***********************/
422 static __inline void    ahd_complete_scb(struct ahd_softc *ahd,
423                                          struct scb *scb);
424 static __inline void    ahd_update_residual(struct ahd_softc *ahd,
425                                             struct scb *scb);
426 static __inline struct ahd_initiator_tinfo *
427                         ahd_fetch_transinfo(struct ahd_softc *ahd,
428                                             char channel, u_int our_id,
429                                             u_int remote_id,
430                                             struct ahd_tmode_tstate **tstate);
431 static __inline uint16_t
432                         ahd_inw(struct ahd_softc *ahd, u_int port);
433 static __inline void    ahd_outw(struct ahd_softc *ahd, u_int port,
434                                  u_int value);
435 static __inline uint32_t
436                         ahd_inl(struct ahd_softc *ahd, u_int port);
437 static __inline void    ahd_outl(struct ahd_softc *ahd, u_int port,
438                                  uint32_t value);
439 static __inline uint64_t
440                         ahd_inq(struct ahd_softc *ahd, u_int port);
441 static __inline void    ahd_outq(struct ahd_softc *ahd, u_int port,
442                                  uint64_t value);
443 static __inline u_int   ahd_get_scbptr(struct ahd_softc *ahd);
444 static __inline void    ahd_set_scbptr(struct ahd_softc *ahd, u_int scbptr);
445 static __inline u_int   ahd_get_hnscb_qoff(struct ahd_softc *ahd);
446 static __inline void    ahd_set_hnscb_qoff(struct ahd_softc *ahd, u_int value);
447 static __inline u_int   ahd_get_hescb_qoff(struct ahd_softc *ahd);
448 static __inline void    ahd_set_hescb_qoff(struct ahd_softc *ahd, u_int value);
449 static __inline u_int   ahd_get_snscb_qoff(struct ahd_softc *ahd);
450 static __inline void    ahd_set_snscb_qoff(struct ahd_softc *ahd, u_int value);
451 static __inline u_int   ahd_get_sescb_qoff(struct ahd_softc *ahd);
452 static __inline void    ahd_set_sescb_qoff(struct ahd_softc *ahd, u_int value);
453 static __inline u_int   ahd_get_sdscb_qoff(struct ahd_softc *ahd);
454 static __inline void    ahd_set_sdscb_qoff(struct ahd_softc *ahd, u_int value);
455 static __inline u_int   ahd_inb_scbram(struct ahd_softc *ahd, u_int offset);
456 static __inline u_int   ahd_inw_scbram(struct ahd_softc *ahd, u_int offset);
457 static __inline uint32_t
458                         ahd_inl_scbram(struct ahd_softc *ahd, u_int offset);
459 static __inline void    ahd_swap_with_next_hscb(struct ahd_softc *ahd,
460                                                 struct scb *scb);
461 static __inline void    ahd_queue_scb(struct ahd_softc *ahd, struct scb *scb);
462 static __inline uint8_t *
463                         ahd_get_sense_buf(struct ahd_softc *ahd,
464                                           struct scb *scb);
465 static __inline uint32_t
466                         ahd_get_sense_bufaddr(struct ahd_softc *ahd,
467                                               struct scb *scb);
468
469 static __inline void
470 ahd_complete_scb(struct ahd_softc *ahd, struct scb *scb)
471 {
472         uint32_t sgptr;
473
474         sgptr = ahd_le32toh(scb->hscb->sgptr);
475         if ((sgptr & SG_STATUS_VALID) != 0)
476                 ahd_handle_scb_status(ahd, scb);
477         else
478                 ahd_done(ahd, scb);
479 }
480
481 /*
482  * Determine whether the sequencer reported a residual
483  * for this SCB/transaction.
484  */
485 static __inline void
486 ahd_update_residual(struct ahd_softc *ahd, struct scb *scb)
487 {
488         uint32_t sgptr;
489
490         sgptr = ahd_le32toh(scb->hscb->sgptr);
491         if ((sgptr & SG_STATUS_VALID) != 0)
492                 ahd_calc_residual(ahd, scb);
493 }
494
495 /*
496  * Return pointers to the transfer negotiation information
497  * for the specified our_id/remote_id pair.
498  */
499 static __inline struct ahd_initiator_tinfo *
500 ahd_fetch_transinfo(struct ahd_softc *ahd, char channel, u_int our_id,
501                     u_int remote_id, struct ahd_tmode_tstate **tstate)
502 {
503         /*
504          * Transfer data structures are stored from the perspective
505          * of the target role.  Since the parameters for a connection
506          * in the initiator role to a given target are the same as
507          * when the roles are reversed, we pretend we are the target.
508          */
509         if (channel == 'B')
510                 our_id += 8;
511         *tstate = ahd->enabled_targets[our_id];
512         return (&(*tstate)->transinfo[remote_id]);
513 }
514
515 #define AHD_COPY_COL_IDX(dst, src)                              \
516 do {                                                            \
517         dst->hscb->scsiid = src->hscb->scsiid;                  \
518         dst->hscb->lun = src->hscb->lun;                        \
519 } while (0)
520
521 static __inline uint16_t
522 ahd_inw(struct ahd_softc *ahd, u_int port)
523 {
524         return ((ahd_inb(ahd, port+1) << 8) | ahd_inb(ahd, port));
525 }
526
527 static __inline void
528 ahd_outw(struct ahd_softc *ahd, u_int port, u_int value)
529 {
530         ahd_outb(ahd, port, value & 0xFF);
531         ahd_outb(ahd, port+1, (value >> 8) & 0xFF);
532 }
533
534 static __inline uint32_t
535 ahd_inl(struct ahd_softc *ahd, u_int port)
536 {
537         return ((ahd_inb(ahd, port))
538               | (ahd_inb(ahd, port+1) << 8)
539               | (ahd_inb(ahd, port+2) << 16)
540               | (ahd_inb(ahd, port+3) << 24));
541 }
542
543 static __inline void
544 ahd_outl(struct ahd_softc *ahd, u_int port, uint32_t value)
545 {
546         ahd_outb(ahd, port, (value) & 0xFF);
547         ahd_outb(ahd, port+1, ((value) >> 8) & 0xFF);
548         ahd_outb(ahd, port+2, ((value) >> 16) & 0xFF);
549         ahd_outb(ahd, port+3, ((value) >> 24) & 0xFF);
550 }
551
552 static __inline uint64_t
553 ahd_inq(struct ahd_softc *ahd, u_int port)
554 {
555         return ((ahd_inb(ahd, port))
556               | (ahd_inb(ahd, port+1) << 8)
557               | (ahd_inb(ahd, port+2) << 16)
558               | (ahd_inb(ahd, port+3) << 24)
559               | (((uint64_t)ahd_inb(ahd, port+4)) << 32)
560               | (((uint64_t)ahd_inb(ahd, port+5)) << 40)
561               | (((uint64_t)ahd_inb(ahd, port+6)) << 48)
562               | (((uint64_t)ahd_inb(ahd, port+7)) << 56));
563 }
564
565 static __inline void
566 ahd_outq(struct ahd_softc *ahd, u_int port, uint64_t value)
567 {
568         ahd_outb(ahd, port, value & 0xFF);
569         ahd_outb(ahd, port+1, (value >> 8) & 0xFF);
570         ahd_outb(ahd, port+2, (value >> 16) & 0xFF);
571         ahd_outb(ahd, port+3, (value >> 24) & 0xFF);
572         ahd_outb(ahd, port+4, (value >> 32) & 0xFF);
573         ahd_outb(ahd, port+5, (value >> 40) & 0xFF);
574         ahd_outb(ahd, port+6, (value >> 48) & 0xFF);
575         ahd_outb(ahd, port+7, (value >> 56) & 0xFF);
576 }
577
578 static __inline u_int
579 ahd_get_scbptr(struct ahd_softc *ahd)
580 {
581         AHD_ASSERT_MODES(ahd, ~(AHD_MODE_UNKNOWN_MSK|AHD_MODE_CFG_MSK),
582                          ~(AHD_MODE_UNKNOWN_MSK|AHD_MODE_CFG_MSK));
583         return (ahd_inb(ahd, SCBPTR) | (ahd_inb(ahd, SCBPTR + 1) << 8));
584 }
585
586 static __inline void
587 ahd_set_scbptr(struct ahd_softc *ahd, u_int scbptr)
588 {
589         AHD_ASSERT_MODES(ahd, ~(AHD_MODE_UNKNOWN_MSK|AHD_MODE_CFG_MSK),
590                          ~(AHD_MODE_UNKNOWN_MSK|AHD_MODE_CFG_MSK));
591         ahd_outb(ahd, SCBPTR, scbptr & 0xFF);
592         ahd_outb(ahd, SCBPTR+1, (scbptr >> 8) & 0xFF);
593 }
594
595 static __inline u_int
596 ahd_get_hnscb_qoff(struct ahd_softc *ahd)
597 {
598         return (ahd_inw_atomic(ahd, HNSCB_QOFF));
599 }
600
601 static __inline void
602 ahd_set_hnscb_qoff(struct ahd_softc *ahd, u_int value)
603 {
604         ahd_outw_atomic(ahd, HNSCB_QOFF, value);
605 }
606
607 static __inline u_int
608 ahd_get_hescb_qoff(struct ahd_softc *ahd)
609 {
610         return (ahd_inb(ahd, HESCB_QOFF));
611 }
612
613 static __inline void
614 ahd_set_hescb_qoff(struct ahd_softc *ahd, u_int value)
615 {
616         ahd_outb(ahd, HESCB_QOFF, value);
617 }
618
619 static __inline u_int
620 ahd_get_snscb_qoff(struct ahd_softc *ahd)
621 {
622         u_int oldvalue;
623
624         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
625         oldvalue = ahd_inw(ahd, SNSCB_QOFF);
626         ahd_outw(ahd, SNSCB_QOFF, oldvalue);
627         return (oldvalue);
628 }
629
630 static __inline void
631 ahd_set_snscb_qoff(struct ahd_softc *ahd, u_int value)
632 {
633         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
634         ahd_outw(ahd, SNSCB_QOFF, value);
635 }
636
637 static __inline u_int
638 ahd_get_sescb_qoff(struct ahd_softc *ahd)
639 {
640         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
641         return (ahd_inb(ahd, SESCB_QOFF));
642 }
643
644 static __inline void
645 ahd_set_sescb_qoff(struct ahd_softc *ahd, u_int value)
646 {
647         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
648         ahd_outb(ahd, SESCB_QOFF, value);
649 }
650
651 static __inline u_int
652 ahd_get_sdscb_qoff(struct ahd_softc *ahd)
653 {
654         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
655         return (ahd_inb(ahd, SDSCB_QOFF) | (ahd_inb(ahd, SDSCB_QOFF + 1) << 8));
656 }
657
658 static __inline void
659 ahd_set_sdscb_qoff(struct ahd_softc *ahd, u_int value)
660 {
661         AHD_ASSERT_MODES(ahd, AHD_MODE_CCHAN_MSK, AHD_MODE_CCHAN_MSK);
662         ahd_outb(ahd, SDSCB_QOFF, value & 0xFF);
663         ahd_outb(ahd, SDSCB_QOFF+1, (value >> 8) & 0xFF);
664 }
665
666 static __inline u_int
667 ahd_inb_scbram(struct ahd_softc *ahd, u_int offset)
668 {
669         u_int value;
670
671         /*
672          * Workaround PCI-X Rev A. hardware bug.
673          * After a host read of SCB memory, the chip
674          * may become confused into thinking prefetch
675          * was required.  This starts the discard timer
676          * running and can cause an unexpected discard
677          * timer interrupt.  The work around is to read
678          * a normal register prior to the exhaustion of
679          * the discard timer.  The mode pointer register
680          * has no side effects and so serves well for
681          * this purpose.
682          *
683          * Razor #528
684          */
685         value = ahd_inb(ahd, offset);
686         if ((ahd->flags & AHD_PCIX_SCBRAM_RD_BUG) != 0)
687                 ahd_inb(ahd, MODE_PTR);
688         return (value);
689 }
690
691 static __inline u_int
692 ahd_inw_scbram(struct ahd_softc *ahd, u_int offset)
693 {
694         return (ahd_inb_scbram(ahd, offset)
695               | (ahd_inb_scbram(ahd, offset+1) << 8));
696 }
697
698 static __inline uint32_t
699 ahd_inl_scbram(struct ahd_softc *ahd, u_int offset)
700 {
701         return (ahd_inb_scbram(ahd, offset)
702               | (ahd_inb_scbram(ahd, offset+1) << 8)
703               | (ahd_inb_scbram(ahd, offset+2) << 16)
704               | (ahd_inb_scbram(ahd, offset+3) << 24));
705 }
706
707 static __inline struct scb *
708 ahd_lookup_scb(struct ahd_softc *ahd, u_int tag)
709 {
710         struct scb* scb;
711
712         if (tag >= AHD_SCB_MAX)
713                 return (NULL);
714         scb = ahd->scb_data.scbindex[tag];
715         if (scb != NULL)
716                 ahd_sync_scb(ahd, scb,
717                              BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE);
718         return (scb);
719 }
720
721 static __inline void
722 ahd_swap_with_next_hscb(struct ahd_softc *ahd, struct scb *scb)
723 {
724         struct hardware_scb *q_hscb;
725         uint32_t saved_hscb_busaddr;
726
727         /*
728          * Our queuing method is a bit tricky.  The card
729          * knows in advance which HSCB (by address) to download,
730          * and we can't disappoint it.  To achieve this, the next
731          * HSCB to download is saved off in ahd->next_queued_hscb.
732          * When we are called to queue "an arbitrary scb",
733          * we copy the contents of the incoming HSCB to the one
734          * the sequencer knows about, swap HSCB pointers and
735          * finally assign the SCB to the tag indexed location
736          * in the scb_array.  This makes sure that we can still
737          * locate the correct SCB by SCB_TAG.
738          */
739         q_hscb = ahd->next_queued_hscb;
740         saved_hscb_busaddr = q_hscb->hscb_busaddr;
741         memcpy(q_hscb, scb->hscb, sizeof(*scb->hscb));
742         q_hscb->hscb_busaddr = saved_hscb_busaddr;
743         q_hscb->next_hscb_busaddr = scb->hscb->hscb_busaddr;
744
745         /* Now swap HSCB pointers. */
746         ahd->next_queued_hscb = scb->hscb;
747         scb->hscb = q_hscb;
748
749         /* Now define the mapping from tag to SCB in the scbindex */
750         ahd->scb_data.scbindex[SCB_GET_TAG(scb)] = scb;
751 }
752
753 /*
754  * Tell the sequencer about a new transaction to execute.
755  */
756 static __inline void
757 ahd_queue_scb(struct ahd_softc *ahd, struct scb *scb)
758 {
759         ahd_swap_with_next_hscb(ahd, scb);
760
761         if (SCBID_IS_NULL(SCB_GET_TAG(scb)))
762                 panic("Attempt to queue invalid SCB tag %x\n",
763                       SCB_GET_TAG(scb));
764
765         /*
766          * Keep a history of SCBs we've downloaded in the qinfifo.
767          */
768         ahd->qinfifo[AHD_QIN_WRAP(ahd->qinfifonext)] = SCB_GET_TAG(scb);
769         ahd->qinfifonext++;
770
771         if (scb->sg_count != 0)
772                 ahd_setup_data_scb(ahd, scb);
773         else
774                 ahd_setup_noxfer_scb(ahd, scb);
775         ahd_setup_scb_common(ahd, scb);
776
777         /*
778          * Make sure our data is consistent from the
779          * perspective of the adapter.
780          */
781         ahd_sync_scb(ahd, scb, BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);
782
783 #ifdef AHD_DEBUG
784         if ((ahd_debug & AHD_SHOW_QUEUE) != 0) {
785                 uint64_t host_dataptr;
786
787                 host_dataptr = ahd_le64toh(scb->hscb->dataptr);
788                 printf("%s: Queueing SCB 0x%x bus addr 0x%x - 0x%x%x/0x%x\n",
789                        ahd_name(ahd),
790                        SCB_GET_TAG(scb), ahd_le32toh(scb->hscb->hscb_busaddr),
791                        (u_int)((host_dataptr >> 32) & 0xFFFFFFFF),
792                        (u_int)(host_dataptr & 0xFFFFFFFF),
793                        ahd_le32toh(scb->hscb->datacnt));
794         }
795 #endif
796         /* Tell the adapter about the newly queued SCB */
797         ahd_set_hnscb_qoff(ahd, ahd->qinfifonext);
798 }
799
800 static __inline uint8_t *
801 ahd_get_sense_buf(struct ahd_softc *ahd, struct scb *scb)
802 {
803         return (scb->sense_data);
804 }
805
806 static __inline uint32_t
807 ahd_get_sense_bufaddr(struct ahd_softc *ahd, struct scb *scb)
808 {
809         return (scb->sense_busaddr);
810 }
811
812 /************************** Interrupt Processing ******************************/
813 static __inline void    ahd_sync_qoutfifo(struct ahd_softc *ahd, int op);
814 static __inline void    ahd_sync_tqinfifo(struct ahd_softc *ahd, int op);
815 static __inline u_int   ahd_check_cmdcmpltqueues(struct ahd_softc *ahd);
816 static __inline int     ahd_intr(struct ahd_softc *ahd);
817
818 static __inline void
819 ahd_sync_qoutfifo(struct ahd_softc *ahd, int op)
820 {
821         ahd_dmamap_sync(ahd, ahd->shared_data_dmat, ahd->shared_data_dmamap,
822                         /*offset*/0, /*len*/AHC_SCB_MAX * sizeof(uint16_t), op);
823 }
824
825 static __inline void
826 ahd_sync_tqinfifo(struct ahd_softc *ahd, int op)
827 {
828 #ifdef AHD_TARGET_MODE
829         if ((ahd->flags & AHD_TARGETROLE) != 0) {
830                 ahd_dmamap_sync(ahd, ahd->shared_data_dmat,
831                                 ahd->shared_data_dmamap,
832                                 ahd_targetcmd_offset(ahd, 0),
833                                 sizeof(struct target_cmd) * AHD_TMODE_CMDS,
834                                 op);
835         }
836 #endif
837 }
838
839 /*
840  * See if the firmware has posted any completed commands
841  * into our in-core command complete fifos.
842  */
843 #define AHD_RUN_QOUTFIFO 0x1
844 #define AHD_RUN_TQINFIFO 0x2
845 static __inline u_int
846 ahd_check_cmdcmpltqueues(struct ahd_softc *ahd)
847 {
848         u_int retval;
849
850         retval = 0;
851         ahd_dmamap_sync(ahd, ahd->shared_data_dmat, ahd->shared_data_dmamap,
852                         /*offset*/ahd->qoutfifonext, /*len*/2,
853                         BUS_DMASYNC_POSTREAD);
854         if ((ahd->qoutfifo[ahd->qoutfifonext]
855              & QOUTFIFO_ENTRY_VALID_LE) == ahd->qoutfifonext_valid_tag)
856                 retval |= AHD_RUN_QOUTFIFO;
857 #ifdef AHD_TARGET_MODE
858         if ((ahd->flags & AHD_TARGETROLE) != 0
859          && (ahd->flags & AHD_TQINFIFO_BLOCKED) == 0) {
860                 ahd_dmamap_sync(ahd, ahd->shared_data_dmat,
861                                 ahd->shared_data_dmamap,
862                                 ahd_targetcmd_offset(ahd, ahd->tqinfifofnext),
863                                 /*len*/sizeof(struct target_cmd),
864                                 BUS_DMASYNC_POSTREAD);
865                 if (ahd->targetcmds[ahd->tqinfifonext].cmd_valid != 0)
866                         retval |= AHD_RUN_TQINFIFO;
867         }
868 #endif
869         return (retval);
870 }
871
872 /*
873  * Catch an interrupt from the adapter
874  */
875 static __inline int
876 ahd_intr(struct ahd_softc *ahd)
877 {
878         u_int   intstat;
879
880         if ((ahd->pause & INTEN) == 0) {
881                 /*
882                  * Our interrupt is not enabled on the chip
883                  * and may be disabled for re-entrancy reasons,
884                  * so just return.  This is likely just a shared
885                  * interrupt.
886                  */
887                 return (0);
888         }
889
890         /*
891          * Instead of directly reading the interrupt status register,
892          * infer the cause of the interrupt by checking our in-core
893          * completion queues.  This avoids a costly PCI bus read in
894          * most cases.
895          */
896         if ((ahd->flags & AHD_ALL_INTERRUPTS) == 0
897          && (ahd_check_cmdcmpltqueues(ahd) != 0))
898                 intstat = CMDCMPLT;
899         else
900                 intstat = ahd_inb(ahd, INTSTAT);
901
902         if ((intstat & INT_PEND) == 0)
903                 return (0);
904
905         if (intstat & CMDCMPLT) {
906                 ahd_outb(ahd, CLRINT, CLRCMDINT);
907
908                 /*
909                  * Ensure that the chip sees that we've cleared
910                  * this interrupt before we walk the output fifo.
911                  * Otherwise, we may, due to posted bus writes,
912                  * clear the interrupt after we finish the scan,
913                  * and after the sequencer has added new entries
914                  * and asserted the interrupt again.
915                  */
916                 if ((ahd->bugs & AHD_INTCOLLISION_BUG) != 0) {
917                         if (ahd_is_paused(ahd)) {
918                                 /*
919                                  * Potentially lost SEQINT.
920                                  * If SEQINTCODE is non-zero,
921                                  * simulate the SEQINT.
922                                  */
923                                 if (ahd_inb(ahd, SEQINTCODE) != NO_SEQINT)
924                                         intstat |= SEQINT;
925                         }
926                 } else {
927                         ahd_flush_device_writes(ahd);
928                 }
929                 ahd_run_qoutfifo(ahd);
930                 ahd->cmdcmplt_counts[ahd->cmdcmplt_bucket]++;
931                 ahd->cmdcmplt_total++;
932 #ifdef AHD_TARGET_MODE
933                 if ((ahd->flags & AHD_TARGETROLE) != 0)
934                         ahd_run_tqinfifo(ahd, /*paused*/FALSE);
935 #endif
936         }
937
938         /*
939          * Handle statuses that may invalidate our cached
940          * copy of INTSTAT separately.
941          */
942         if (intstat == 0xFF && (ahd->features & AHD_REMOVABLE) != 0) {
943                 /* Hot eject.  Do nothing */
944         } else if (intstat & HWERRINT) {
945                 ahd_handle_hwerrint(ahd);
946         } else if ((intstat & (PCIINT|SPLTINT)) != 0) {
947                 ahd->bus_intr(ahd);
948         } else {
949
950                 if ((intstat & SEQINT) != 0)
951                         ahd_handle_seqint(ahd, intstat);
952
953                 if ((intstat & SCSIINT) != 0)
954                         ahd_handle_scsiint(ahd, intstat);
955         }
956         return (1);
957 }
958
959 #endif  /* _AIC79XX_INLINE_H_ */