aacvar.h revision 133540
1/*- 2 * Copyright (c) 2000 Michael Smith 3 * Copyright (c) 2001 Scott Long 4 * Copyright (c) 2000 BSDi 5 * Copyright (c) 2001 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 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: head/sys/dev/aac/aacvar.h 133540 2004-08-12 05:05:06Z scottl $ 30 */ 31 32#include <sys/bio.h> 33#include <sys/lock.h> 34#include <sys/mutex.h> 35#include <sys/taskqueue.h> 36#include <sys/selinfo.h> 37#include <geom/geom_disk.h> 38 39 40/* 41 * Driver Parameter Definitions 42 */ 43 44/* 45 * The firmware interface allows for a 16-bit s/g list length. We limit 46 * ourselves to a reasonable maximum and ensure alignment. 47 */ 48#define AAC_MAXSGENTRIES 64 /* max S/G entries, limit 65535 */ 49 50/* 51 * We allocate a small set of FIBs for the adapter to use to send us messages. 52 */ 53#define AAC_ADAPTER_FIBS 8 54 55/* 56 * FIBs are allocated in page-size chunks and can grow up to the 512 57 * limit imposed by the hardware. 58 */ 59#define AAC_FIB_COUNT (PAGE_SIZE/sizeof(struct aac_fib)) 60#define AAC_PREALLOCATE_FIBS 128 61#define AAC_MAX_FIBS 504 62 63/* 64 * The controller reports status events in AIFs. We hang on to a number of 65 * these in order to pass them out to user-space management tools. 66 */ 67#define AAC_AIFQ_LENGTH 64 68 69/* 70 * Firmware messages are passed in the printf buffer. 71 */ 72#define AAC_PRINTF_BUFSIZE 256 73 74/* 75 * We wait this many seconds for the adapter to come ready if it is still 76 * booting 77 */ 78#define AAC_BOOT_TIMEOUT (3 * 60) 79 80/* 81 * Timeout for immediate commands. 82 */ 83#define AAC_IMMEDIATE_TIMEOUT 30 /* seconds */ 84 85/* 86 * Timeout for normal commands 87 */ 88#define AAC_CMD_TIMEOUT 30 /* seconds */ 89 90/* 91 * Rate at which we periodically check for timed out commands and kick the 92 * controller. 93 */ 94#define AAC_PERIODIC_INTERVAL 20 /* seconds */ 95 96/* 97 * Per-container data structure 98 */ 99struct aac_container 100{ 101 struct aac_mntobj co_mntobj; 102 device_t co_disk; 103 int co_found; 104 TAILQ_ENTRY(aac_container) co_link; 105}; 106 107/* 108 * Per-SIM data structure 109 */ 110struct aac_sim 111{ 112 device_t sim_dev; 113 int TargetsPerBus; 114 int BusNumber; 115 int InitiatorBusId; 116 struct aac_softc *aac_sc; 117 TAILQ_ENTRY(aac_sim) sim_link; 118}; 119 120/* 121 * Per-disk structure 122 */ 123struct aac_disk 124{ 125 device_t ad_dev; 126 struct aac_softc *ad_controller; 127 struct aac_container *ad_container; 128 struct disk *ad_disk; 129 int ad_flags; 130#define AAC_DISK_OPEN (1<<0) 131 int ad_cylinders; 132 int ad_heads; 133 int ad_sectors; 134 u_int32_t ad_size; 135 int unit; 136}; 137 138/* 139 * Per-command control structure. 140 */ 141struct aac_command 142{ 143 TAILQ_ENTRY(aac_command) cm_link; /* list linkage */ 144 145 struct aac_softc *cm_sc; /* controller that owns us */ 146 147 struct aac_fib *cm_fib; /* FIB associated with this 148 * command */ 149 u_int32_t cm_fibphys; /* bus address of the FIB */ 150 struct bio *cm_data; /* pointer to data in kernel 151 * space */ 152 u_int32_t cm_datalen; /* data length */ 153 bus_dmamap_t cm_datamap; /* DMA map for bio data */ 154 struct aac_sg_table *cm_sgtable; /* pointer to s/g table in 155 * command */ 156 int cm_flags; 157#define AAC_CMD_MAPPED (1<<0) /* command has had its data 158 * mapped */ 159#define AAC_CMD_DATAIN (1<<1) /* command involves data moving 160 * from controller to host */ 161#define AAC_CMD_DATAOUT (1<<2) /* command involves data moving 162 * from host to controller */ 163#define AAC_CMD_COMPLETED (1<<3) /* command has been completed */ 164#define AAC_CMD_TIMEDOUT (1<<4) /* command taken too long */ 165#define AAC_ON_AACQ_FREE (1<<5) 166#define AAC_ON_AACQ_READY (1<<6) 167#define AAC_ON_AACQ_BUSY (1<<7) 168#define AAC_ON_AACQ_MASK ((1<<5)|(1<<6)|(1<<7)) 169#define AAC_QUEUE_FRZN (1<<9) /* Freeze the processing of 170 * commands on the queue. */ 171 172 void (* cm_complete)(struct aac_command *cm); 173 void *cm_private; 174 time_t cm_timestamp; /* command creation time */ 175 int cm_queue; 176 int cm_index; 177}; 178 179struct aac_fibmap { 180 TAILQ_ENTRY(aac_fibmap) fm_link; /* list linkage */ 181 struct aac_fib *aac_fibs; 182 bus_dmamap_t aac_fibmap; 183 struct aac_command *aac_commands; 184}; 185 186/* 187 * We gather a number of adapter-visible items into a single structure. 188 * 189 * The ordering of this strucure may be important; we copy the Linux driver: 190 * 191 * Adapter FIBs 192 * Init struct 193 * Queue headers (Comm Area) 194 * Printf buffer 195 * 196 * In addition, we add: 197 * Sync Fib 198 */ 199struct aac_common { 200 /* fibs for the controller to send us messages */ 201 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS]; 202 203 /* the init structure */ 204 struct aac_adapter_init ac_init; 205 206 /* arena within which the queue structures are kept */ 207 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) + 208 AAC_QUEUE_ALIGN]; 209 210 /* buffer for text messages from the controller */ 211 char ac_printf[AAC_PRINTF_BUFSIZE]; 212 213 /* fib for synchronous commands */ 214 struct aac_fib ac_sync_fib; 215}; 216 217/* 218 * Interface operations 219 */ 220struct aac_interface 221{ 222 int (*aif_get_fwstatus)(struct aac_softc *sc); 223 void (*aif_qnotify)(struct aac_softc *sc, int qbit); 224 int (*aif_get_istatus)(struct aac_softc *sc); 225 void (*aif_clr_istatus)(struct aac_softc *sc, int mask); 226 void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command, 227 u_int32_t arg0, u_int32_t arg1, 228 u_int32_t arg2, u_int32_t arg3); 229 int (*aif_get_mailbox)(struct aac_softc *sc, int mb); 230 void (*aif_set_interrupts)(struct aac_softc *sc, int enable); 231}; 232extern struct aac_interface aac_rx_interface; 233extern struct aac_interface aac_sa_interface; 234extern struct aac_interface aac_fa_interface; 235 236#define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc))) 237#define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit))) 238#define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc))) 239#define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \ 240 (mask))) 241#define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \ 242 ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \ 243 (arg3))) 244#define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \ 245 (mb))) 246#define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 247 0)) 248#define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 249 1)) 250 251#define AAC_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag, \ 252 sc->aac_bhandle, reg, val) 253#define AAC_GETREG4(sc, reg) bus_space_read_4 (sc->aac_btag, \ 254 sc->aac_bhandle, reg) 255#define AAC_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag, \ 256 sc->aac_bhandle, reg, val) 257#define AAC_GETREG2(sc, reg) bus_space_read_2 (sc->aac_btag, \ 258 sc->aac_bhandle, reg) 259#define AAC_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag, \ 260 sc->aac_bhandle, reg, val) 261#define AAC_GETREG1(sc, reg) bus_space_read_1 (sc->aac_btag, \ 262 sc->aac_bhandle, reg) 263 264/* 265 * Per-controller structure. 266 */ 267struct aac_softc 268{ 269 /* bus connections */ 270 device_t aac_dev; 271 struct resource *aac_regs_resource; /* register interface 272 * window */ 273 int aac_regs_rid; /* resource ID */ 274 bus_space_handle_t aac_bhandle; /* bus space handle */ 275 bus_space_tag_t aac_btag; /* bus space tag */ 276 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */ 277 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command 278 * DMA tag */ 279 struct resource *aac_irq; /* interrupt */ 280 int aac_irq_rid; 281 void *aac_intr; /* interrupt handle */ 282 eventhandler_tag eh; 283 284 /* controller features, limits and status */ 285 int aac_state; 286#define AAC_STATE_SUSPEND (1<<0) 287#define AAC_STATE_OPEN (1<<1) 288#define AAC_STATE_INTERRUPTS_ON (1<<2) 289#define AAC_STATE_AIF_SLEEPER (1<<3) 290 struct FsaRevision aac_revision; 291 292 /* controller hardware interface */ 293 int aac_hwif; 294#define AAC_HWIF_I960RX 0 295#define AAC_HWIF_STRONGARM 1 296#define AAC_HWIF_FALCON 2 297#define AAC_HWIF_UNKNOWN -1 298 bus_dma_tag_t aac_common_dmat; /* common structure 299 * DMA tag */ 300 bus_dmamap_t aac_common_dmamap; /* common structure 301 * DMA map */ 302 struct aac_common *aac_common; 303 u_int32_t aac_common_busaddr; 304 struct aac_interface aac_if; 305 306 /* command/fib resources */ 307 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */ 308 TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh; 309 u_int total_fibs; 310 struct aac_command *aac_commands; 311 312 /* command management */ 313 TAILQ_HEAD(,aac_command) aac_free; /* command structures 314 * available for reuse */ 315 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for 316 * controller resources */ 317 TAILQ_HEAD(,aac_command) aac_busy; 318 struct bio_queue_head aac_bioq; 319 struct aac_queue_table *aac_queues; 320 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT]; 321 322 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */ 323 324 /* connected containters */ 325 TAILQ_HEAD(,aac_container) aac_container_tqh; 326 struct mtx aac_container_lock; 327 328 /* 329 * The general I/O lock. This protects the sync fib, the lists, the 330 * queues, and the registers. 331 */ 332 struct mtx aac_io_lock; 333 334 /* delayed activity infrastructure */ 335 struct task aac_task_complete; /* deferred-completion 336 * task */ 337 struct intr_config_hook aac_ich; 338 339 /* management interface */ 340 struct cdev *aac_dev_t; 341 struct mtx aac_aifq_lock; 342 struct aac_aif_command aac_aifq[AAC_AIFQ_LENGTH]; 343 int aac_aifq_head; 344 int aac_aifq_tail; 345 struct selinfo rcv_select; 346 struct proc *aifthread; 347 int aifflags; 348#define AAC_AIFFLAGS_RUNNING (1 << 0) 349#define AAC_AIFFLAGS_AIF (1 << 1) 350#define AAC_AIFFLAGS_EXIT (1 << 2) 351#define AAC_AIFFLAGS_EXITED (1 << 3) 352#define AAC_AIFFLAGS_PRINTF (1 << 4) 353#define AAC_AIFFLAGS_ALLOCFIBS (1 << 5) 354#define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \ 355 AAC_AIFFLAGS_ALLOCFIBS) 356 u_int32_t flags; 357#define AAC_FLAGS_PERC2QC (1 << 0) 358#define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */ 359#define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */ 360#define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */ 361#define AAC_FLAGS_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */ 362#define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem 363 * 2GB-4GB range */ 364#define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */ 365#define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */ 366#define AAC_FLAGS_BROKEN_MEMMAP (1 << 8) /* Broken HostPhysMemPages */ 367 368 u_int32_t supported_options; 369 int aac_max_fibs; 370 u_int32_t scsi_method_id; 371 TAILQ_HEAD(,aac_sim) aac_sim_tqh; 372}; 373 374 375/* 376 * Public functions 377 */ 378extern void aac_free(struct aac_softc *sc); 379extern int aac_attach(struct aac_softc *sc); 380extern int aac_detach(device_t dev); 381extern int aac_shutdown(device_t dev); 382extern int aac_suspend(device_t dev); 383extern int aac_resume(device_t dev); 384extern void aac_intr(void *arg); 385extern void aac_submit_bio(struct bio *bp); 386extern void aac_biodone(struct bio *bp); 387extern void aac_startio(struct aac_softc *sc); 388extern int aac_alloc_command(struct aac_softc *sc, 389 struct aac_command **cmp); 390extern void aac_release_command(struct aac_command *cm); 391extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command, 392 u_int32_t xferstate, struct aac_fib *fib, 393 u_int16_t datasize); 394 395/* 396 * Debugging levels: 397 * 0 - quiet, only emit warnings 398 * 1 - noisy, emit major function points and things done 399 * 2 - extremely noisy, emit trace items in loops, etc. 400 */ 401#ifdef AAC_DEBUG 402# define debug(level, fmt, args...) \ 403 do { \ 404 if (level <=AAC_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \ 405 } while (0) 406# define debug_called(level) \ 407 do { \ 408 if (level <= AAC_DEBUG) printf("%s: called\n", __func__); \ 409 } while (0) 410 411extern void aac_print_queues(struct aac_softc *sc); 412extern void aac_panic(struct aac_softc *sc, char *reason); 413extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib, 414 const char *caller); 415extern void aac_print_aif(struct aac_softc *sc, 416 struct aac_aif_command *aif); 417 418#define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__) 419 420#else 421# define debug(level, fmt, args...) 422# define debug_called(level) 423 424# define aac_print_queues(sc) 425# define aac_panic(sc, reason) 426 427# define AAC_PRINT_FIB(sc, fib) 428# define aac_print_aif(sc, aac_aif_command) 429#endif 430 431struct aac_code_lookup { 432 char *string; 433 u_int32_t code; 434}; 435 436/* 437 * Queue primitives for driver queues. 438 */ 439#define AACQ_ADD(sc, qname) \ 440 do { \ 441 struct aac_qstat *qs; \ 442 \ 443 qs = &(sc)->aac_qstat[qname]; \ 444 \ 445 qs->q_length++; \ 446 if (qs->q_length > qs->q_max) \ 447 qs->q_max = qs->q_length; \ 448 } while (0) 449 450#define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length-- 451#define AACQ_INIT(sc, qname) \ 452 do { \ 453 sc->aac_qstat[qname].q_length = 0; \ 454 sc->aac_qstat[qname].q_max = 0; \ 455 } while (0) 456 457 458#define AACQ_COMMAND_QUEUE(name, index) \ 459static __inline void \ 460aac_initq_ ## name (struct aac_softc *sc) \ 461{ \ 462 TAILQ_INIT(&sc->aac_ ## name); \ 463 AACQ_INIT(sc, index); \ 464} \ 465static __inline void \ 466aac_enqueue_ ## name (struct aac_command *cm) \ 467{ \ 468 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 469 printf("command %p is on another queue, flags = %#x\n", \ 470 cm, cm->cm_flags); \ 471 panic("command is on another queue"); \ 472 } \ 473 TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 474 cm->cm_flags |= AAC_ON_ ## index; \ 475 AACQ_ADD(cm->cm_sc, index); \ 476} \ 477static __inline void \ 478aac_requeue_ ## name (struct aac_command *cm) \ 479{ \ 480 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 481 printf("command %p is on another queue, flags = %#x\n", \ 482 cm, cm->cm_flags); \ 483 panic("command is on another queue"); \ 484 } \ 485 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 486 cm->cm_flags |= AAC_ON_ ## index; \ 487 AACQ_ADD(cm->cm_sc, index); \ 488} \ 489static __inline struct aac_command * \ 490aac_dequeue_ ## name (struct aac_softc *sc) \ 491{ \ 492 struct aac_command *cm; \ 493 \ 494 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \ 495 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 496 printf("command %p not in queue, flags = %#x, " \ 497 "bit = %#x\n", cm, cm->cm_flags, \ 498 AAC_ON_ ## index); \ 499 panic("command not in queue"); \ 500 } \ 501 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \ 502 cm->cm_flags &= ~AAC_ON_ ## index; \ 503 AACQ_REMOVE(sc, index); \ 504 } \ 505 return(cm); \ 506} \ 507static __inline void \ 508aac_remove_ ## name (struct aac_command *cm) \ 509{ \ 510 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 511 printf("command %p not in queue, flags = %#x, " \ 512 "bit = %#x\n", cm, cm->cm_flags, \ 513 AAC_ON_ ## index); \ 514 panic("command not in queue"); \ 515 } \ 516 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 517 cm->cm_flags &= ~AAC_ON_ ## index; \ 518 AACQ_REMOVE(cm->cm_sc, index); \ 519} \ 520struct hack 521 522AACQ_COMMAND_QUEUE(free, AACQ_FREE); 523AACQ_COMMAND_QUEUE(ready, AACQ_READY); 524AACQ_COMMAND_QUEUE(busy, AACQ_BUSY); 525 526/* 527 * outstanding bio queue 528 */ 529static __inline void 530aac_initq_bio(struct aac_softc *sc) 531{ 532 bioq_init(&sc->aac_bioq); 533 AACQ_INIT(sc, AACQ_BIO); 534} 535 536static __inline void 537aac_enqueue_bio(struct aac_softc *sc, struct bio *bp) 538{ 539 bioq_insert_tail(&sc->aac_bioq, bp); 540 AACQ_ADD(sc, AACQ_BIO); 541} 542 543static __inline struct bio * 544aac_dequeue_bio(struct aac_softc *sc) 545{ 546 struct bio *bp; 547 548 if ((bp = bioq_first(&sc->aac_bioq)) != NULL) { 549 bioq_remove(&sc->aac_bioq, bp); 550 AACQ_REMOVE(sc, AACQ_BIO); 551 } 552 return(bp); 553} 554 555static __inline void 556aac_print_printf(struct aac_softc *sc) 557{ 558 /* 559 * XXX We have the ability to read the length of the printf string 560 * from out of the mailboxes. 561 */ 562 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE, 563 sc->aac_common->ac_printf); 564 sc->aac_common->ac_printf[0] = 0; 565 AAC_QNOTIFY(sc, AAC_DB_PRINTF); 566} 567 568static __inline int 569aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib) 570{ 571 572 mtx_lock(&sc->aac_io_lock); 573 *fib = &sc->aac_common->ac_sync_fib; 574 return (0); 575} 576 577static __inline void 578aac_release_sync_fib(struct aac_softc *sc) 579{ 580 581 mtx_unlock(&sc->aac_io_lock); 582} 583 584