sys/dev/ic/mpt_netbsd.h

   1 /*      $NetBSD: mpt_netbsd.h,v 1.7 2007/10/19 11:59:57 ad Exp $        */
   2
   3 /*
   4  * Copyright (c) 2003 Wasabi Systems, Inc.
   5  * All rights reserved.
   6  *
   7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed for the NetBSD Project by
  20  *      Wasabi Systems, Inc.
  21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
  22  *    or promote products derived from this software without specific prior
  23  *    written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 /*
  39  * Copyright (c) 2000, 2001 by Greg Ansley, Adam Prewett
  40  *
  41  * Partially derived from Matt Jacobs ISP driver.
  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 immediately at the beginning of the file, without modification,
  48  *    this list of conditions, and the following disclaimer.
  49  * 2. The name of the author may not be used to endorse or promote products
  50  *    derived from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  56  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  */
  62 /*
  63  * Additional Copyright (c) 2002 by Matthew Jacob under same license.
  64  */
  65
  66 /*
  67  * mpt_netbsd.h:
  68  *
  69  * NetBSD-specific definitions for LSI Fusion adapters.
  70  *
  71  * Adapted from the FreeBSD "mpt" driver by Jason R. Thorpe for
  72  * Wasabi Systems, Inc.
  73  *
  74  * Additional contributions by Garrett D'Amore on behalf of TELES AG.
  75  */
  76
  77 #ifndef _DEV_IC_MPT_NETBSD_H_
  78 #define _DEV_IC_MPT_NETBSD_H_
  79
  80 #include <sys/param.h>
  81 #include <sys/systm.h>
  82 #include <sys/malloc.h>
  83 #include <sys/kernel.h>
  84 #include <sys/callout.h>
  85 #include <sys/errno.h>
  86 #include <sys/buf.h>
  87 #include <sys/queue.h>
  88 #include <sys/device.h>
  89
  90 #include <uvm/uvm_extern.h>
  91
  92 #include <sys/bus.h>
  93 #include <sys/intr.h>
  94
  95 #include <dev/scsipi/scsi_all.h>
  96 #include <dev/scsipi/scsipi_all.h>
  97 #include <dev/scsipi/scsiconf.h>
  98
  99 #include <dev/ic/mpt_mpilib.h>
 100
 101 /* Max MPT Reply we are willing to accept (must be a power of 2). */
 102 #define MPT_REPLY_SIZE          128
 103
 104 #define MPT_MAX_REQUESTS(mpt)   ((mpt)->is_fc ? 1024 : 256)
 105 #define MPT_REQUEST_AREA        512
 106 #define MPT_SENSE_SIZE          32      /* included in MPT_REQUEST_AREA */
 107 #define MPT_REQ_MEM_SIZE(mpt)   (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
 108
 109 /*
 110  * We cannot tell prior to getting IOC facts how big the IOC's request
 111  * area is. Because of this we cannot tell at compile time how many
 112  * simple SG elements we can fit within an IOC request prior to having
 113  * to put in a chain element.
 114  *
 115  * Experimentally we know that the Ultra4 parts have a 96 byte request
 116  * element size and the Fibre Channel units have a 144 byte request
 117  * element size. Therefore, if we have 512-32 (== 480) bytes of request
 118  * area to play with, we have room for between 3 and 5 request sized
 119  * regions- the first of which is the command  plus a simple SG list,
 120  * the rest of which are chained continuation SG lists. Given that the
 121  * normal request we use is 48 bytes w/o the first SG element, we can
 122  * assume we have 480-48 == 432 bytes to have simple SG elements and/or
 123  * chain elements. If we assume 32 bit addressing, this works out to
 124  * 54 SG or chain elements. If we assume 5 chain elements, then we have
 125  * a maximum of 49 separate actual SG segments.
 126  */
 127 #define MPT_SGL_MAX             49
 128
 129 #define MPT_RQSL(mpt)           ((mpt)->request_frame_size << 2)
 130 #define MPT_NSGL(mpt)           (MPT_RQSL(mpt) / sizeof(SGE_SIMPLE32))
 131
 132 #define MPT_NSGL_FIRST(mpt)                                     \
 133         ((((mpt)->request_frame_size << 2) -                    \
 134           sizeof(MSG_SCSI_IO_REQUEST) -                         \
 135           sizeof(SGE_IO_UNION)) / sizeof(SGE_SIMPLE32))
 136
 137 /*
 138  * Convert a physical address returned from IOC to a virtual address
 139  * needed to access the data.
 140  */
 141 #define MPT_REPLY_PTOV(m, x)                                    \
 142         ((void *)(&(m)->reply[(((x) << 1) - (m)->reply_phys)]))
 143
 144 enum mpt_req_state {
 145         REQ_FREE,
 146         REQ_IN_PROGRESS,
 147         REQ_TIMEOUT,
 148         REQ_ON_CHIP,
 149         REQ_DONE
 150 };
 151 typedef struct req_entry {
 152         uint16_t        index;          /* index of this entry */
 153         struct scsipi_xfer *xfer;       /* scsipi xfer request */
 154         void            *req_vbuf;      /* virtual address of entry */
 155         void            *sense_vbuf;    /* virtual address of sense data */
 156         bus_addr_t      req_pbuf;       /* physical address of entry */
 157         bus_addr_t      sense_pbuf;     /* physical address of sense data */
 158         bus_dmamap_t    dmap;           /* DMA map for data buffer */
 159         SLIST_ENTRY(req_entry) link;    /* pointer to next in list */
 160         enum mpt_req_state debug;       /* debugging */
 161         uint32_t        sequence;       /* sequence number */
 162 } request_t;
 163
 164 typedef struct mpt_softc {
 165         struct device   sc_dev;         /* base device glue */
 166
 167         /* Locking context */
 168         int             mpt_splsaved;
 169         uint32_t        mpt_islocked;
 170
 171         int             verbose : 3,
 172                         mpt_locksetup : 1,
 173                         is_fc : 1,
 174                         is_scsi : 1,
 175                         is_sas : 1,
 176                         bus : 1,
 177                         : 23;
 178
 179         /* IOC facts */
 180         uint16_t        mpt_global_credits;
 181         uint16_t        request_frame_size;
 182         uint8_t         mpt_max_devices;
 183         uint8_t         mpt_max_buses;
 184
 185         /* Port facts */
 186         uint16_t        mpt_ini_id;
 187
 188         /* Device configuration information */
 189         union {
 190                 struct mpt_spi_cfg {
 191                         fCONFIG_PAGE_SCSI_PORT_0        _port_page0;
 192                         fCONFIG_PAGE_SCSI_PORT_1        _port_page1;
 193                         fCONFIG_PAGE_SCSI_PORT_2        _port_page2;
 194                         fCONFIG_PAGE_SCSI_DEVICE_0      _dev_page0[16];
 195                         fCONFIG_PAGE_SCSI_DEVICE_1      _dev_page1[16];
 196                         uint16_t                        _tag_enable;
 197                         uint16_t                        _disc_enable;
 198                         uint16_t                        _update_params0;
 199                         uint16_t                        _update_params1;
 200                         uint16_t                        _report_xfer_mode;
 201                 } spi;
 202 #define mpt_port_page0          cfg.spi._port_page0
 203 #define mpt_port_page1          cfg.spi._port_page1
 204 #define mpt_port_page2          cfg.spi._port_page2
 205 #define mpt_dev_page0           cfg.spi._dev_page0
 206 #define mpt_dev_page1           cfg.spi._dev_page1
 207 #define mpt_tag_enable          cfg.spi._tag_enable
 208 #define mpt_disc_enable         cfg.spi._disc_enable
 209 #define mpt_update_params0      cfg.spi._update_params0
 210 #define mpt_update_params1      cfg.spi._update_params1
 211 #define mpt_report_xfer_mode    cfg.spi._report_xfer_mode
 212
 213                 struct mpt_fc_cfg {
 214                         uint8_t         nada;
 215                 } fc;
 216         } cfg;
 217
 218         bus_space_tag_t         sc_st;
 219         bus_space_handle_t      sc_sh;
 220         bus_dma_tag_t           sc_dmat;
 221
 222         /* Reply memory */
 223         bus_dmamap_t            reply_dmap;
 224         char                    *reply;
 225         bus_addr_t              reply_phys;
 226
 227         /* Request memory */
 228         bus_dmamap_t            request_dmap;
 229         char                    *request;
 230         bus_addr_t              request_phys;
 231
 232         /* SCSIPI and software management */
 233         request_t               *request_pool;
 234         SLIST_HEAD(req_queue, req_entry) request_free_list;
 235
 236         struct scsipi_adapter   sc_adapter;
 237         struct scsipi_channel   sc_channel;
 238
 239         uint32_t                sequence;       /* sequence number */
 240         uint32_t                timeouts;       /* timeout count */
 241         uint32_t                success;        /* success after timeout */
 242
 243         /* To restore configuration after hard reset. */
 244         void                    (*sc_set_config_regs)(struct mpt_softc *);
 245 } mpt_softc_t;
 246
 247 #define MPT_SYNC_REQ(mpt, req, ops)                             \
 248         bus_dmamap_sync((mpt)->sc_dmat, (mpt)->request_dmap,    \
 249             (req)->req_pbuf - (mpt)->request_phys,              \
 250             MPT_REQUEST_AREA, (ops))
 251
 252 #define mpt_read(mpt, reg)                                      \
 253         bus_space_read_4((mpt)->sc_st, (mpt)->sc_sh, (reg))
 254 #define mpt_write(mpt, reg, val)                                \
 255         bus_space_write_4((mpt)->sc_st, (mpt)->sc_sh, (reg), (val))
 256
 257 void    mpt_scsipi_attach(mpt_softc_t *);
 258 int     mpt_dma_mem_alloc(mpt_softc_t *);
 259 int     mpt_intr(void *);
 260 void    mpt_prt(mpt_softc_t *, const char *, ...);
 261
 262 #define mpt_set_config_regs(mpt)                                \
 263 do {                                                            \
 264         if ((mpt)->sc_set_config_regs != NULL)                  \
 265                 (*(mpt)->sc_set_config_regs)((mpt));            \
 266 } while (/*CONSTCOND*/0)
 267
 268 #endif /* _DEV_IC_MPT_NETBSD_H_ */