1 /* $NetBSD: mpt_netbsd.h,v 1.2 2003/04/16 23:02:14 thorpej 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 75 #ifndef _DEV_IC_MPT_NETBSD_H_ 76 #define _DEV_IC_MPT_NETBSD_H_ 77 78 #include <sys/param.h> 79 #include <sys/systm.h> 80 #include <sys/malloc.h> 81 #include <sys/kernel.h> 82 #include <sys/callout.h> 83 #include <sys/errno.h> 84 #include <sys/buf.h> 85 #include <sys/queue.h> 86 87 #include <uvm/uvm_extern.h> 88 89 #include <machine/bus.h> 90 #include <machine/intr.h> 91 92 #include <dev/scsipi/scsi_all.h> 93 #include <dev/scsipi/scsipi_all.h> 94 #include <dev/scsipi/scsiconf.h> 95 96 #include <dev/ic/mpt_mpilib.h> 97 98 /* Max MPT Reply we are willing to accept (must be a power of 2). */ 99 #define MPT_REPLY_SIZE 128 100 101 #define MPT_MAX_REQUESTS(mpt) ((mpt)->is_fc ? 1024 : 256) 102 #define MPT_REQUEST_AREA 512 103 #define MPT_SENSE_SIZE 32 /* included in MPT_REQUEST_AREA */ 104 #define MPT_REQ_MEM_SIZE(mpt) (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA) 105 106 /* 107 * We cannot tell prior to getting IOC facts how big the IOC's request 108 * area is. Because of this we cannot tell at compile time how many 109 * simple SG elements we can fit within an IOC request prior to having 110 * to put in a chain element. 111 * 112 * Experimentally we know that the Ultra4 parts have a 96 byte request 113 * element size and the Fibre Channel units have a 144 byte request 114 * element size. Therefore, if we have 512-32 (== 480) bytes of request 115 * area to play with, we have room for between 3 and 5 request sized 116 * regions- the first of which is the command plus a simple SG list, 117 * the rest of which are chained continuation SG lists. Given that the 118 * normal request we use is 48 bytes w/o the first SG element, we can 119 * assume we have 480-48 == 432 bytes to have simple SG elements and/or 120 * chain elements. If we assume 32 bit addressing, this works out to 121 * 54 SG or chain elements. If we assume 5 chain elements, then we have 122 * a maximum of 49 seperate actual SG segments. 123 */ 124 #define MPT_SGL_MAX 49 125 126 #define MPT_RQSL(mpt) ((mpt)->request_frame_size << 2) 127 #define MPT_NSGL(mpt) (MPT_RQSL(mpt) / sizeof(SGE_SIMPLE32)) 128 129 #define MPT_NSGL_FIRST(mpt) \ 130 ((((mpt)->request_frame_size << 2) - \ 131 sizeof(MSG_SCSI_IO_REQUEST) - \ 132 sizeof(SGE_IO_UNION)) / sizeof(SGE_SIMPLE32)) 133 134 /* 135 * Convert a physical address returned from IOC to a virtual address 136 * needed to access the data. 137 */ 138 #define MPT_REPLY_PTOV(m, x) \ 139 ((void *)(&(m)->reply[(((x) << 1) - (m)->reply_phys)])) 140 141 enum mpt_req_state { 142 REQ_FREE, 143 REQ_IN_PROGRESS, 144 REQ_TIMEOUT, 145 REQ_ON_CHIP, 146 REQ_DONE 147 }; 148 typedef struct req_entry { 149 uint16_t index; /* index of this entry */ 150 struct scsipi_xfer *xfer; /* scsipi xfer request */ 151 void *req_vbuf; /* virtual address of entry */ 152 void *sense_vbuf; /* virtual address of sense data */ 153 bus_addr_t req_pbuf; /* physical address of entry */ 154 bus_addr_t sense_pbuf; /* physical address of sense data */ 155 bus_dmamap_t dmap; /* DMA map for data buffer */ 156 SLIST_ENTRY(req_entry) link; /* pointer to next in list */ 157 enum mpt_req_state debug; /* debugging */ 158 uint32_t sequence; /* sequence number */ 159 } request_t; 160 161 typedef struct mpt_softc { 162 struct device sc_dev; /* base device glue */ 163 164 /* Locking context */ 165 int mpt_splsaved; 166 uint32_t mpt_islocked; 167 168 int verbose : 3, 169 mpt_locksetup : 1, 170 is_fc : 1, 171 bus : 1, 172 : 26; 173 174 /* IOC facts */ 175 uint16_t mpt_global_credits; 176 uint16_t request_frame_size; 177 uint8_t mpt_max_devices; 178 uint8_t mpt_max_buses; 179 180 /* Port facts */ 181 uint16_t mpt_ini_id; 182 183 /* Device configuration information */ 184 union { 185 struct mpt_spi_cfg { 186 fCONFIG_PAGE_SCSI_PORT_0 _port_page0; 187 fCONFIG_PAGE_SCSI_PORT_1 _port_page1; 188 fCONFIG_PAGE_SCSI_PORT_2 _port_page2; 189 fCONFIG_PAGE_SCSI_DEVICE_0 _dev_page0[16]; 190 fCONFIG_PAGE_SCSI_DEVICE_1 _dev_page1[16]; 191 uint16_t _tag_enable; 192 uint16_t _disc_enable; 193 uint16_t _update_params0; 194 uint16_t _update_params1; 195 uint16_t _report_xfer_mode; 196 } spi; 197 #define mpt_port_page0 cfg.spi._port_page0 198 #define mpt_port_page1 cfg.spi._port_page1 199 #define mpt_port_page2 cfg.spi._port_page2 200 #define mpt_dev_page0 cfg.spi._dev_page0 201 #define mpt_dev_page1 cfg.spi._dev_page1 202 #define mpt_tag_enable cfg.spi._tag_enable 203 #define mpt_disc_enable cfg.spi._disc_enable 204 #define mpt_update_params0 cfg.spi._update_params0 205 #define mpt_update_params1 cfg.spi._update_params1 206 #define mpt_report_xfer_mode cfg.spi._report_xfer_mode 207 208 struct mpt_fc_cfg { 209 uint8_t nada; 210 } fc; 211 } cfg; 212 213 bus_space_tag_t sc_st; 214 bus_space_handle_t sc_sh; 215 bus_dma_tag_t sc_dmat; 216 217 /* Reply memory */ 218 bus_dmamap_t reply_dmap; 219 char *reply; 220 bus_addr_t reply_phys; 221 222 /* Request memory */ 223 bus_dmamap_t request_dmap; 224 char *request; 225 bus_addr_t request_phys; 226 227 /* SCSIPI and software management */ 228 request_t *request_pool; 229 SLIST_HEAD(req_queue, req_entry) request_free_list; 230 231 struct scsipi_adapter sc_adapter; 232 struct scsipi_channel sc_channel; 233 234 uint32_t sequence; /* sequence number */ 235 uint32_t timeouts; /* timeout count */ 236 uint32_t success; /* success after timeout */ 237 238 /* Companion part in a 929 or 1030, or NULL. */ 239 struct mpt_softc *mpt2; 240 241 /* To restore configuration after hard reset. */ 242 void (*sc_set_config_regs)(struct mpt_softc *); 243 } mpt_softc_t; 244 245 #define MPT_SYNC_REQ(mpt, req, ops) \ 246 bus_dmamap_sync((mpt)->sc_dmat, (mpt)->request_dmap, \ 247 (req)->req_pbuf - (mpt)->request_phys, \ 248 MPT_REQUEST_AREA, (ops)) 249 250 #define mpt_read(mpt, reg) \ 251 bus_space_read_4((mpt)->sc_st, (mpt)->sc_sh, (reg)) 252 #define mpt_write(mpt, reg, val) \ 253 bus_space_write_4((mpt)->sc_st, (mpt)->sc_sh, (reg), (val)) 254 255 void mpt_scsipi_attach(mpt_softc_t *); 256 int mpt_dma_mem_alloc(mpt_softc_t *); 257 int mpt_intr(void *); 258 void mpt_prt(mpt_softc_t *, const char *, ...); 259 260 #define mpt_set_config_regs(mpt) \ 261 do { \ 262 if ((mpt)->sc_set_config_regs != NULL) \ 263 (*(mpt)->sc_set_config_regs)((mpt)); \ 264 } while (/*CONSTCOND*/0) 265 266 #endif /* _DEV_IC_MPT_NETBSD_H_ */ 267