aacvar.h revision 111141
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 111141 2003-02-19 21:38:29Z 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}; 183 184struct aac_fibmap { 185 TAILQ_ENTRY(aac_fibmap) fm_link; /* list linkage */ 186 struct aac_fib *aac_fibs; 187 bus_dmamap_t aac_fibmap; 188 struct aac_command *aac_commands; 189}; 190 191/* 192 * We gather a number of adapter-visible items into a single structure. 193 * 194 * The ordering of this strucure may be important; we copy the Linux driver: 195 * 196 * Adapter FIBs 197 * Init struct 198 * Queue headers (Comm Area) 199 * Printf buffer 200 * 201 * In addition, we add: 202 * Sync Fib 203 */ 204struct aac_common { 205 /* fibs for the controller to send us messages */ 206 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS]; 207 208 /* the init structure */ 209 struct aac_adapter_init ac_init; 210 211 /* arena within which the queue structures are kept */ 212 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) + 213 AAC_QUEUE_ALIGN]; 214 215 /* buffer for text messages from the controller */ 216 char ac_printf[AAC_PRINTF_BUFSIZE]; 217 218 /* fib for synchronous commands */ 219 struct aac_fib ac_sync_fib; 220}; 221 222/* 223 * Interface operations 224 */ 225struct aac_interface 226{ 227 int (*aif_get_fwstatus)(struct aac_softc *sc); 228 void (*aif_qnotify)(struct aac_softc *sc, int qbit); 229 int (*aif_get_istatus)(struct aac_softc *sc); 230 void (*aif_clr_istatus)(struct aac_softc *sc, int mask); 231 void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command, 232 u_int32_t arg0, u_int32_t arg1, 233 u_int32_t arg2, u_int32_t arg3); 234 int (*aif_get_mailboxstatus)(struct aac_softc *sc); 235 void (*aif_set_interrupts)(struct aac_softc *sc, int enable); 236}; 237extern struct aac_interface aac_rx_interface; 238extern struct aac_interface aac_sa_interface; 239extern struct aac_interface aac_fa_interface; 240 241#define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc))) 242#define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit))) 243#define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc))) 244#define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \ 245 (mask))) 246#define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \ 247 ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \ 248 (arg3))) 249#define AAC_GET_MAILBOXSTATUS(sc) ((sc)->aac_if.aif_get_mailboxstatus( \ 250 (sc))) 251#define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 252 0)) 253#define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 254 1)) 255 256#define AAC_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag, \ 257 sc->aac_bhandle, reg, val) 258#define AAC_GETREG4(sc, reg) bus_space_read_4 (sc->aac_btag, \ 259 sc->aac_bhandle, reg) 260#define AAC_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag, \ 261 sc->aac_bhandle, reg, val) 262#define AAC_GETREG2(sc, reg) bus_space_read_2 (sc->aac_btag, \ 263 sc->aac_bhandle, reg) 264#define AAC_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag, \ 265 sc->aac_bhandle, reg, val) 266#define AAC_GETREG1(sc, reg) bus_space_read_1 (sc->aac_btag, \ 267 sc->aac_bhandle, reg) 268 269/* Define the OS version specific locks */ 270#if __FreeBSD_version >= 500005 271#include <sys/lock.h> 272#include <sys/mutex.h> 273typedef struct mtx aac_lock_t; 274#define AAC_LOCK_INIT(l, s) mtx_init(l, s, NULL, MTX_DEF) 275#define AAC_LOCK_ACQUIRE(l) mtx_lock(l) 276#define AAC_LOCK_RELEASE(l) mtx_unlock(l) 277#else 278typedef struct simplelock aac_lock_t; 279#define AAC_LOCK_INIT(l, s) simple_lock_init(l) 280#define AAC_LOCK_ACQUIRE(l) simple_lock(l) 281#define AAC_LOCK_RELEASE(l) simple_unlock(l) 282#endif 283 284#if __FreeBSD_version >= 500005 285#include <sys/selinfo.h> 286#else 287#include <sys/select.h> 288#endif 289 290/* 291 * Per-controller structure. 292 */ 293struct aac_softc 294{ 295 /* bus connections */ 296 device_t aac_dev; 297 struct resource *aac_regs_resource; /* register interface 298 * window */ 299 int aac_regs_rid; /* resource ID */ 300 bus_space_handle_t aac_bhandle; /* bus space handle */ 301 bus_space_tag_t aac_btag; /* bus space tag */ 302 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */ 303 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command 304 * DMA tag */ 305 struct resource *aac_irq; /* interrupt */ 306 int aac_irq_rid; 307 void *aac_intr; /* interrupt handle */ 308 eventhandler_tag eh; 309 310 /* controller features, limits and status */ 311 int aac_state; 312#define AAC_STATE_SUSPEND (1<<0) 313#define AAC_STATE_OPEN (1<<1) 314#define AAC_STATE_INTERRUPTS_ON (1<<2) 315#define AAC_STATE_AIF_SLEEPER (1<<3) 316 struct FsaRevision aac_revision; 317 318 /* controller hardware interface */ 319 int aac_hwif; 320#define AAC_HWIF_I960RX 0 321#define AAC_HWIF_STRONGARM 1 322#define AAC_HWIF_FALCON 2 323#define AAC_HWIF_UNKNOWN -1 324 bus_dma_tag_t aac_common_dmat; /* common structure 325 * DMA tag */ 326 bus_dmamap_t aac_common_dmamap; /* common structure 327 * DMA map */ 328 struct aac_common *aac_common; 329 u_int32_t aac_common_busaddr; 330 struct aac_interface aac_if; 331 332 /* command/fib resources */ 333 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */ 334 TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh; 335 uint total_fibs; 336 struct aac_command *aac_commands; 337 338 /* command management */ 339 TAILQ_HEAD(,aac_command) aac_free; /* command structures 340 * available for reuse */ 341 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for 342 * controller resources */ 343 TAILQ_HEAD(,aac_command) aac_busy; 344 TAILQ_HEAD(,aac_command) aac_complete; /* commands which have been 345 * returned by the controller */ 346 struct bio_queue_head aac_bioq; 347 struct aac_queue_table *aac_queues; 348 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT]; 349 350 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */ 351 352 /* connected containters */ 353 TAILQ_HEAD(,aac_container) aac_container_tqh; 354 aac_lock_t aac_container_lock; 355 356 /* Protect the sync fib */ 357#define AAC_SYNC_LOCK_FORCE (1 << 0) 358 aac_lock_t aac_sync_lock; 359 360 /* delayed activity infrastructure */ 361#if __FreeBSD_version >= 500005 362 struct task aac_task_complete; /* deferred-completion 363 * task */ 364#endif 365 struct intr_config_hook aac_ich; 366 367 /* management interface */ 368 dev_t aac_dev_t; 369 aac_lock_t aac_aifq_lock; 370 struct aac_aif_command aac_aifq[AAC_AIFQ_LENGTH]; 371 int aac_aifq_head; 372 int aac_aifq_tail; 373 struct selinfo rcv_select; 374 struct proc *aifthread; 375 int aifflags; 376#define AAC_AIFFLAGS_RUNNING (1 << 0) 377#define AAC_AIFFLAGS_AIF (1 << 1) 378#define AAC_AIFFLAGS_EXIT (1 << 2) 379#define AAC_AIFFLAGS_EXITED (1 << 3) 380#define AAC_AIFFLAGS_PRINTF (1 << 4) 381#define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF) 382 u_int32_t quirks; 383#define AAC_QUIRK_PERC2QC (1 << 0) 384#define AAC_QUIRK_NOCAM (1 << 1) /* No SCSI passthrough */ 385#define AAC_QUIRK_CAM_NORESET (1 << 2) /* Fake SCSI resets */ 386#define AAC_QUIRK_CAM_PASSONLY (1 << 3) /* Only create pass devices */ 387 388 u_int32_t scsi_method_id; 389 TAILQ_HEAD(,aac_sim) aac_sim_tqh; 390}; 391 392 393/* 394 * Public functions 395 */ 396extern void aac_free(struct aac_softc *sc); 397extern int aac_attach(struct aac_softc *sc); 398extern int aac_detach(device_t dev); 399extern int aac_shutdown(device_t dev); 400extern int aac_suspend(device_t dev); 401extern int aac_resume(device_t dev); 402extern void aac_intr(void *arg); 403extern void aac_submit_bio(struct bio *bp); 404extern void aac_biodone(struct bio *bp); 405extern void aac_startio(struct aac_softc *sc); 406extern int aac_alloc_command(struct aac_softc *sc, 407 struct aac_command **cmp); 408extern void aac_release_command(struct aac_command *cm); 409extern int aac_alloc_sync_fib(struct aac_softc *sc, 410 struct aac_fib **fib, int flags); 411extern void aac_release_sync_fib(struct aac_softc *sc); 412extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command, 413 u_int32_t xferstate, struct aac_fib *fib, 414 u_int16_t datasize); 415 416/* 417 * Debugging levels: 418 * 0 - quiet, only emit warnings 419 * 1 - noisy, emit major function points and things done 420 * 2 - extremely noisy, emit trace items in loops, etc. 421 */ 422#ifdef AAC_DEBUG 423# define debug(level, fmt, args...) \ 424 do { \ 425 if (level <=AAC_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \ 426 } while (0) 427# define debug_called(level) \ 428 do { \ 429 if (level <= AAC_DEBUG) printf("%s: called\n", __func__); \ 430 } while (0) 431 432extern void aac_print_queues(struct aac_softc *sc); 433extern void aac_panic(struct aac_softc *sc, char *reason); 434extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib, 435 const char *caller); 436extern void aac_print_aif(struct aac_softc *sc, 437 struct aac_aif_command *aif); 438 439#define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__) 440 441#else 442# define debug(level, fmt, args...) 443# define debug_called(level) 444 445# define aac_print_queues(sc) 446# define aac_panic(sc, reason) 447 448# define AAC_PRINT_FIB(sc, fib) 449# define aac_print_aif(sc, aac_aif_command) 450#endif 451 452struct aac_code_lookup { 453 char *string; 454 u_int32_t code; 455}; 456 457/* 458 * Queue primitives for driver queues. 459 */ 460#define AACQ_ADD(sc, qname) \ 461 do { \ 462 struct aac_qstat *qs; \ 463 \ 464 qs = &(sc)->aac_qstat[qname]; \ 465 \ 466 qs->q_length++; \ 467 if (qs->q_length > qs->q_max) \ 468 qs->q_max = qs->q_length; \ 469 } while (0) 470 471#define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length-- 472#define AACQ_INIT(sc, qname) \ 473 do { \ 474 sc->aac_qstat[qname].q_length = 0; \ 475 sc->aac_qstat[qname].q_max = 0; \ 476 } while (0) 477 478 479#define AACQ_COMMAND_QUEUE(name, index) \ 480static __inline void \ 481aac_initq_ ## name (struct aac_softc *sc) \ 482{ \ 483 TAILQ_INIT(&sc->aac_ ## name); \ 484 AACQ_INIT(sc, index); \ 485} \ 486static __inline void \ 487aac_enqueue_ ## name (struct aac_command *cm) \ 488{ \ 489 int s; \ 490 \ 491 s = splbio(); \ 492 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 493 printf("command %p is on another queue, flags = %#x\n", \ 494 cm, cm->cm_flags); \ 495 panic("command is on another queue"); \ 496 } \ 497 TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 498 cm->cm_flags |= AAC_ON_ ## index; \ 499 AACQ_ADD(cm->cm_sc, index); \ 500 splx(s); \ 501} \ 502static __inline void \ 503aac_requeue_ ## name (struct aac_command *cm) \ 504{ \ 505 int s; \ 506 \ 507 s = splbio(); \ 508 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 509 printf("command %p is on another queue, flags = %#x\n", \ 510 cm, cm->cm_flags); \ 511 panic("command is on another queue"); \ 512 } \ 513 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 514 cm->cm_flags |= AAC_ON_ ## index; \ 515 AACQ_ADD(cm->cm_sc, index); \ 516 splx(s); \ 517} \ 518static __inline struct aac_command * \ 519aac_dequeue_ ## name (struct aac_softc *sc) \ 520{ \ 521 struct aac_command *cm; \ 522 int s; \ 523 \ 524 s = splbio(); \ 525 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \ 526 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 527 printf("command %p not in queue, flags = %#x, " \ 528 "bit = %#x\n", cm, cm->cm_flags, \ 529 AAC_ON_ ## index); \ 530 panic("command not in queue"); \ 531 } \ 532 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \ 533 cm->cm_flags &= ~AAC_ON_ ## index; \ 534 AACQ_REMOVE(sc, index); \ 535 } \ 536 splx(s); \ 537 return(cm); \ 538} \ 539static __inline void \ 540aac_remove_ ## name (struct aac_command *cm) \ 541{ \ 542 int s; \ 543 \ 544 s = splbio(); \ 545 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 546 printf("command %p not in queue, flags = %#x, " \ 547 "bit = %#x\n", cm, cm->cm_flags, \ 548 AAC_ON_ ## index); \ 549 panic("command not in queue"); \ 550 } \ 551 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 552 cm->cm_flags &= ~AAC_ON_ ## index; \ 553 AACQ_REMOVE(cm->cm_sc, index); \ 554 splx(s); \ 555} \ 556struct hack 557 558AACQ_COMMAND_QUEUE(free, AACQ_FREE); 559AACQ_COMMAND_QUEUE(ready, AACQ_READY); 560AACQ_COMMAND_QUEUE(busy, AACQ_BUSY); 561AACQ_COMMAND_QUEUE(complete, AACQ_COMPLETE); 562 563/* 564 * outstanding bio queue 565 */ 566static __inline void 567aac_initq_bio(struct aac_softc *sc) 568{ 569 bioq_init(&sc->aac_bioq); 570 AACQ_INIT(sc, AACQ_BIO); 571} 572 573static __inline void 574aac_enqueue_bio(struct aac_softc *sc, struct bio *bp) 575{ 576 int s; 577 578 s = splbio(); 579 bioq_insert_tail(&sc->aac_bioq, bp); 580 AACQ_ADD(sc, AACQ_BIO); 581 splx(s); 582} 583 584static __inline struct bio * 585aac_dequeue_bio(struct aac_softc *sc) 586{ 587 int s; 588 struct bio *bp; 589 590 s = splbio(); 591 if ((bp = bioq_first(&sc->aac_bioq)) != NULL) { 592 bioq_remove(&sc->aac_bioq, bp); 593 AACQ_REMOVE(sc, AACQ_BIO); 594 } 595 splx(s); 596 return(bp); 597} 598 599static __inline void 600aac_print_printf(struct aac_softc *sc) 601{ 602 /* 603 * XXX We have the ability to read the length of the printf string 604 * from out of the mailboxes. 605 */ 606 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE, 607 sc->aac_common->ac_printf); 608 AAC_QNOTIFY(sc, AAC_DB_PRINTF); 609} 610