sys/dev/ic/adw.h

   1 /*      $NetBSD: adw.h,v 1.9.28.5 2005/03/04 16:41:24 skrll Exp $        */
   2
   3 /*
   4  * Generic driver definitions and exported functions for the Advanced
   5  * Systems Inc. SCSI controllers
   6  *
   7  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
   8  * All rights reserved.
   9  *
  10  * Author: Baldassare Dante Profeta <dante@mclink.it>
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *        This product includes software developed by the NetBSD
  23  *        Foundation, Inc. and its contributors.
  24  * 4. Neither the name of The NetBSD Foundation nor the names of its
  25  *    contributors may be used to endorse or promote products derived
  26  *    from this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 #ifndef _ADVANSYS_WIDE_H_
  42 #define _ADVANSYS_WIDE_H_
  43
  44 /******************************************************************************/
  45
  46 typedef int (* ADW_ISR_CALLBACK) (ADW_SOFTC *, ADW_SCSI_REQ_Q *);
  47 typedef void (* ADW_ASYNC_CALLBACK) (ADW_SOFTC *, u_int8_t);
  48
  49
  50 /*
  51  * per request scatter-gather element limit
  52  * We could have up to 256 SG lists.
  53  */
  54 #define ADW_MAX_SG_LIST         255
  55
  56 /*
  57  * Scatter-Gather Definitions per request.
  58  */
  59
  60 #define NO_OF_SG_PER_BLOCK      15
  61
  62 /* Number of SG blocks needed. */
  63 #define ADW_NUM_SG_BLOCK \
  64         ((ADW_MAX_SG_LIST + (NO_OF_SG_PER_BLOCK - 1))/NO_OF_SG_PER_BLOCK)
  65
  66
  67 struct adw_ccb {
  68         ADW_SCSI_REQ_Q          scsiq;
  69         ADW_SG_BLOCK            sg_block[ADW_NUM_SG_BLOCK];
  70
  71         struct scsi_sense_data scsi_sense;
  72
  73         TAILQ_ENTRY(adw_ccb)    chain;
  74         struct adw_ccb          *nexthash;
  75         u_int32_t               hashkey;
  76
  77         struct scsipi_xfer      *xs;    /* the scsipi_xfer for this cmd */
  78         int                     flags;  /* see below */
  79
  80         int                     timeout;
  81         /*
  82          * This DMA map maps the buffer involved in the transfer.
  83          */
  84         bus_dmamap_t            dmamap_xfer;
  85 };
  86
  87 typedef struct adw_ccb ADW_CCB;
  88
  89 /* flags for ADW_CCB */
  90 #define CCB_ALLOC       0x01
  91 #define CCB_ABORTING    0x02
  92 #define CCB_ABORTED     0x04
  93
  94
  95 #define ADW_MAX_CCB     63      /* Max. number commands per device (63) */
  96
  97 struct adw_control {
  98         ADW_CCB         ccbs[ADW_MAX_CCB];      /* all our control blocks */
  99         ADW_CARRIER     *carriers;              /* all our carriers */
 100 };
 101
 102 /*
 103  * Offset of a CCB from the beginning of the control DMA mapping.
 104  */
 105 #define ADW_CCB_OFF(c)  (offsetof(struct adw_control, ccbs[0]) +        \
 106                     (((u_long)(c)) - ((u_long)&sc->sc_control->ccbs[0])))
 107
 108 /******************************************************************************/
 109
 110 int adw_init(ADW_SOFTC *);
 111 void adw_attach(ADW_SOFTC *);
 112 int adw_intr(void *);
 113 ADW_CCB *adw_ccb_phys_kv(ADW_SOFTC *, u_int32_t);
 114
 115 /******************************************************************************/
 116
 117 #endif /* _ADVANSYS_ADW_H_ */