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