aacvar.h revision 1.11
1 /* $NetBSD: aacvar.h,v 1.11 2007/12/15 00:39:27 perry Exp $ */ 2 3 /*- 4 * Copyright (c) 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Andrew Doran. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 /*- 40 * Copyright (c) 2000 Michael Smith 41 * Copyright (c) 2000 BSDi 42 * Copyright (c) 2000 Niklas Hallqvist 43 * All rights reserved. 44 * 45 * Redistribution and use in source and binary forms, with or without 46 * modification, are permitted provided that the following conditions 47 * are met: 48 * 1. Redistributions of source code must retain the above copyright 49 * notice, this list of conditions and the following disclaimer. 50 * 2. Redistributions in binary form must reproduce the above copyright 51 * notice, this list of conditions and the following disclaimer in the 52 * documentation and/or other materials provided with the distribution. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 64 * SUCH DAMAGE. 65 * 66 * from FreeBSD: aacvar.h,v 1.1 2000/09/13 03:20:34 msmith Exp 67 * via OpenBSD: aacvar.h,v 1.2 2002/03/14 01:26:53 millert Exp 68 */ 69 70 #ifndef _PCI_AACVAR_H_ 71 #define _PCI_AACVAR_H_ 72 73 /* Debugging */ 74 #ifdef AAC_DEBUG 75 #define AAC_DPRINTF(mask, args) if ((aac_debug & (mask)) != 0) printf args 76 #define AAC_D_INTR 0x01 77 #define AAC_D_MISC 0x02 78 #define AAC_D_CMD 0x04 79 #define AAC_D_QUEUE 0x08 80 #define AAC_D_IO 0x10 81 extern int aac_debug; 82 83 #define AAC_PRINT_FIB(sc, fib) aac_print_fib((sc), (fib), __func__) 84 #else 85 #define AAC_DPRINTF(mask, args) 86 #define AAC_PRINT_FIB(sc, fib) 87 #endif 88 89 struct aac_code_lookup { 90 const char *string; 91 u_int32_t code; 92 }; 93 94 extern const struct aac_code_lookup aac_command_status_table[]; 95 extern const struct aac_code_lookup aac_container_types[]; 96 97 struct aac_softc; 98 99 /* 100 * We allocate a small set of FIBs for the adapter to use to send us messages. 101 */ 102 #define AAC_ADAPTER_FIBS 8 103 104 /* 105 * FIBs are allocated in page-size chunks and can grow up to the 512 106 * limit imposed by the hardware. 107 * XXX -- There should be some way to allocate these as-needed without 108 * allocating them at interrupt time. For now, though, allocate 109 * all that we'll ever need up-front. 110 */ 111 #define AAC_PREALLOCATE_FIBS(sc) ((sc)->sc_max_fibs) 112 113 /* 114 * Firmware messages are passed in the printf buffer. 115 */ 116 #define AAC_PRINTF_BUFSIZE 256 117 118 /* 119 * We wait this many seconds for the adapter to come ready if it is still 120 * booting. 121 */ 122 #define AAC_BOOT_TIMEOUT (3 * 60) 123 124 /* 125 * Wait this long for a lost interrupt to get detected. 126 */ 127 #define AAC_WATCH_TIMEOUT 10000 /* 10000 * 1ms = 10s */ 128 129 /* 130 * Timeout for immediate commands. 131 */ 132 #define AAC_IMMEDIATE_TIMEOUT 30 133 134 /* 135 * Delay 20ms after the qnotify in sync operations. Experimentally deduced. 136 */ 137 #define AAC_SYNC_DELAY 20000 138 139 /* 140 * sc->sc_max_sgs is the number of scatter-gather elements we can fit 141 * in one block I/O request (64-bit or 32-bit, depending) FIB, or the 142 * maximum number that the firmware will accept. We subtract one to 143 * deal with requests that do not start on an even page boundary. 144 */ 145 #define AAC_MAX_XFER(sc) (((sc)->sc_max_sgs - 1) * PAGE_SIZE) 146 147 /* 148 * Fixed sector size. 149 */ 150 #define AAC_SECTOR_SIZE 512 151 152 /* 153 * Number of CCBs to reserve for control operations. 154 */ 155 #define AAC_NCCBS_RESERVE 8 156 157 /* 158 * Quirk listings. 159 */ 160 #define AAC_QUIRK_PERC2QC (1 << 0) /* Dell PERC 2QC */ 161 #define AAC_QUIRK_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */ 162 #define AAC_QUIRK_4GB_WINDOW (1 << 5) /* Device can access host mem 163 * in 2GB-4GB range */ 164 #define AAC_QUIRK_NO4GB (1 << 6) /* Can't access host mem >2GB */ 165 #define AAC_QUIRK_256FIBS (1 << 7) /* Can only handle 256 cmds */ 166 #define AAC_QUIRK_BROKEN_MMAP (1 << 8) /* Broken HostPhysMemPages */ 167 #define AAC_QUIRK_NEW_COMM (1 << 11) /* New comm. i/f supported */ 168 #define AAC_QUIRK_RAW_IO (1 << 12) /* Raw I/O interface */ 169 #define AAC_QUIRK_ARRAY_64BIT (1 << 13) /* 64-bit array size */ 170 171 172 /* 173 * We gather a number of adapter-visible items into a single structure. 174 * 175 * The ordering of this structure may be important; we copy the Linux driver: 176 * 177 * Adapter FIBs 178 * Init struct 179 * Queue headers (Comm Area) 180 * Printf buffer 181 * 182 * In addition, we add: 183 * Sync Fib 184 */ 185 struct aac_common { 186 /* fibs for the controller to send us messages */ 187 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS]; 188 189 /* the init structure */ 190 struct aac_adapter_init ac_init; 191 192 /* arena within which the queue structures are kept */ 193 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) + AAC_QUEUE_ALIGN]; 194 195 /* buffer for text messages from the controller */ 196 char ac_printf[AAC_PRINTF_BUFSIZE]; 197 198 /* fib for synchronous commands */ 199 struct aac_fib ac_sync_fib; 200 }; 201 202 struct aac_ccb; 203 204 /* 205 * Interface operations 206 */ 207 struct aac_interface { 208 int (*aif_get_fwstatus)(struct aac_softc *); 209 void (*aif_qnotify)(struct aac_softc *, int); 210 int (*aif_get_istatus)(struct aac_softc *); 211 void (*aif_set_istatus)(struct aac_softc *, int); 212 void (*aif_set_mailbox)(struct aac_softc *, u_int32_t, 213 u_int32_t, u_int32_t, u_int32_t, u_int32_t); 214 uint32_t (*aif_get_mailbox)(struct aac_softc *, int); 215 void (*aif_set_interrupts)(struct aac_softc *, int); 216 int (*aif_send_command)(struct aac_softc *, struct aac_ccb *); 217 int (*aif_get_outb_queue)(struct aac_softc *); 218 void (*aif_set_outb_queue)(struct aac_softc *, int); 219 }; 220 221 #define AAC_GET_FWSTATUS(sc) ((sc)->sc_if.aif_get_fwstatus(sc)) 222 #define AAC_QNOTIFY(sc, qbit) \ 223 ((sc)->sc_if.aif_qnotify((sc), (qbit))) 224 #define AAC_GET_ISTATUS(sc) ((sc)->sc_if.aif_get_istatus(sc)) 225 #define AAC_CLEAR_ISTATUS(sc, mask) \ 226 ((sc)->sc_if.aif_set_istatus((sc), (mask))) 227 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \ 228 do { \ 229 ((sc)->sc_if.aif_set_mailbox((sc), (command), (arg0), \ 230 (arg1), (arg2), (arg3))); \ 231 } while(0) 232 #define AAC_GET_MAILBOX(sc, mb) ((sc)->sc_if.aif_get_mailbox(sc, mb)) 233 #define AAC_GET_MAILBOXSTATUS(sc) (AAC_GET_MAILBOX(sc, 0)) 234 #define AAC_MASK_INTERRUPTS(sc) \ 235 ((sc)->sc_if.aif_set_interrupts((sc), 0)) 236 #define AAC_UNMASK_INTERRUPTS(sc) \ 237 ((sc)->sc_if.aif_set_interrupts((sc), 1)) 238 #define AAC_SEND_COMMAND(sc, cm) \ 239 ((sc)->sc_if.aif_send_command((sc), cm)) 240 #define AAC_GET_OUTB_QUEUE(sc) \ 241 ((sc)->sc_if.aif_get_outb_queue((sc))) 242 #define AAC_SET_OUTB_QUEUE(sc, idx) \ 243 ((sc)->sc_if.aif_set_outb_queue((sc), (idx))) 244 245 #define AAC_SETREG4(sc, reg, val) \ 246 bus_space_write_4((sc)->sc_memt, (sc)->sc_memh, (reg), (val)) 247 #define AAC_GETREG4(sc, reg) \ 248 bus_space_read_4((sc)->sc_memt, (sc)->sc_memh, (reg)) 249 #define AAC_SETREG2(sc, reg, val) \ 250 bus_space_write_2((sc)->sc_memt, (sc)->sc_memh, (reg), (val)) 251 #define AAC_GETREG2(sc, reg) \ 252 bus_space_read_2((sc)->sc_memt, (sc)->sc_memh, (reg)) 253 #define AAC_SETREG1(sc, reg, val) \ 254 bus_space_write_1((sc)->sc_memt, (sc)->sc_memh, (reg), (val)) 255 #define AAC_GETREG1(sc, reg) \ 256 bus_space_read_1((sc)->sc_memt, (sc)->sc_memh, (reg)) 257 258 struct aac_fibmap { 259 TAILQ_ENTRY(aac_fibmap) fm_link; 260 struct aac_fib *fm_fibs; 261 bus_dma_segment_t fm_fibseg; 262 bus_dmamap_t fm_fibmap; 263 struct aac_ccb *fm_ccbs; 264 }; 265 266 /* 267 * A command control block, one for each corresponding command index 268 * of the controller. 269 */ 270 struct aac_ccb { 271 SIMPLEQ_ENTRY(aac_ccb) ac_chain; 272 273 struct aac_fib *ac_fib; 274 struct aac_fibmap *ac_fibmap; 275 bus_addr_t ac_fibphys; 276 bus_dmamap_t ac_dmamap_xfer; 277 278 void *ac_data; 279 size_t ac_datalen; 280 u_int ac_flags; 281 282 void (*ac_intr)(struct aac_ccb *); 283 struct device *ac_device; 284 void *ac_context; 285 }; 286 #define AAC_CCB_MAPPED 0x01 287 #define AAC_CCB_COMPLETED 0x02 288 #define AAC_CCB_DATA_IN 0x04 289 #define AAC_CCB_DATA_OUT 0x08 290 291 struct aac_drive { 292 u_int hd_present; 293 u_int hd_devtype; 294 u_int hd_size; 295 }; 296 297 /* 298 * Per-controller structure. 299 */ 300 struct aac_softc { 301 struct device sc_dv; 302 void *sc_ih; 303 bus_space_tag_t sc_memt; 304 bus_space_handle_t sc_memh; 305 bus_dma_tag_t sc_dmat; 306 bus_size_t sc_regsize; 307 308 struct FsaRevision sc_revision; 309 int sc_hwif; 310 int sc_quirks; 311 struct aac_interface sc_if; 312 313 u_int32_t sc_max_fibs; 314 u_int32_t sc_max_fibs_alloc; 315 u_int32_t sc_max_sectors; 316 u_int32_t sc_max_fib_size; 317 u_int32_t sc_max_sgs; 318 319 u_int32_t sc_total_fibs; 320 TAILQ_HEAD(,aac_fibmap) sc_fibmap_tqh; 321 322 struct aac_common *sc_common; 323 bus_dma_segment_t sc_common_seg; 324 bus_dmamap_t sc_common_dmamap; 325 struct aac_fib *sc_aif_fib; 326 327 struct aac_ccb *sc_ccbs; 328 SIMPLEQ_HEAD(, aac_ccb) sc_ccb_free; 329 SIMPLEQ_HEAD(, aac_ccb) sc_ccb_queue; 330 SIMPLEQ_HEAD(, aac_ccb) sc_ccb_complete; 331 332 struct aac_queue_table *sc_queues; 333 struct aac_queue_entry *sc_qentries[AAC_QUEUE_COUNT]; 334 struct aac_drive sc_hdr[AAC_MAX_CONTAINERS]; 335 int sc_nunits; 336 int sc_flags; 337 uint32_t sc_supported_options; 338 339 /* Set by parent */ 340 int (*sc_intr_set)(struct aac_softc *, 341 int (*)(void *), void *); 342 }; 343 #define AAC_HWIF_I960RX 0 344 #define AAC_HWIF_STRONGARM 1 345 #define AAC_HWIF_FALCON 2 346 #define AAC_HWIF_RKT 3 347 #define AAC_HWIF_UNKNOWN -1 348 349 #define AAC_ONLINE 2 350 351 struct aac_attach_args { 352 int aaca_unit; 353 }; 354 355 int aac_attach(struct aac_softc *); 356 void aac_ccb_enqueue(struct aac_softc *, struct aac_ccb *); 357 void aac_ccb_free(struct aac_softc *, struct aac_ccb *); 358 struct aac_ccb *aac_ccb_alloc(struct aac_softc *, int); 359 int aac_ccb_map(struct aac_softc *, struct aac_ccb *); 360 int aac_ccb_poll(struct aac_softc *, struct aac_ccb *, int); 361 int aac_ccb_submit(struct aac_softc *, struct aac_ccb *); 362 void aac_ccb_unmap(struct aac_softc *, struct aac_ccb *); 363 const char *aac_describe_code(const struct aac_code_lookup *, u_int32_t); 364 int aac_intr(void *); 365 366 #endif /* !_PCI_AACVAR_H_ */ 367
Indexes created Fri Sep 26 20:09:58 GMT 2025