aacvar.h revision 130585
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 130585 2004-06-16 09:47:26Z phk $ 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/* Define the OS version specific locks */ 265typedef struct mtx aac_lock_t; 266#define AAC_LOCK_INIT(l, s) mtx_init(l, s, NULL, MTX_DEF) 267#define AAC_LOCK_ACQUIRE(l) mtx_lock(l) 268#define AAC_LOCK_RELEASE(l) mtx_unlock(l) 269 270 271/* 272 * Per-controller structure. 273 */ 274struct aac_softc 275{ 276 /* bus connections */ 277 device_t aac_dev; 278 struct resource *aac_regs_resource; /* register interface 279 * window */ 280 int aac_regs_rid; /* resource ID */ 281 bus_space_handle_t aac_bhandle; /* bus space handle */ 282 bus_space_tag_t aac_btag; /* bus space tag */ 283 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */ 284 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command 285 * DMA tag */ 286 struct resource *aac_irq; /* interrupt */ 287 int aac_irq_rid; 288 void *aac_intr; /* interrupt handle */ 289 eventhandler_tag eh; 290 291 /* controller features, limits and status */ 292 int aac_state; 293#define AAC_STATE_SUSPEND (1<<0) 294#define AAC_STATE_OPEN (1<<1) 295#define AAC_STATE_INTERRUPTS_ON (1<<2) 296#define AAC_STATE_AIF_SLEEPER (1<<3) 297 struct FsaRevision aac_revision; 298 299 /* controller hardware interface */ 300 int aac_hwif; 301#define AAC_HWIF_I960RX 0 302#define AAC_HWIF_STRONGARM 1 303#define AAC_HWIF_FALCON 2 304#define AAC_HWIF_UNKNOWN -1 305 bus_dma_tag_t aac_common_dmat; /* common structure 306 * DMA tag */ 307 bus_dmamap_t aac_common_dmamap; /* common structure 308 * DMA map */ 309 struct aac_common *aac_common; 310 u_int32_t aac_common_busaddr; 311 struct aac_interface aac_if; 312 313 /* command/fib resources */ 314 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */ 315 TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh; 316 u_int total_fibs; 317 struct aac_command *aac_commands; 318 319 /* command management */ 320 TAILQ_HEAD(,aac_command) aac_free; /* command structures 321 * available for reuse */ 322 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for 323 * controller resources */ 324 TAILQ_HEAD(,aac_command) aac_busy; 325 struct bio_queue_head aac_bioq; 326 struct aac_queue_table *aac_queues; 327 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT]; 328 329 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */ 330 331 /* connected containters */ 332 TAILQ_HEAD(,aac_container) aac_container_tqh; 333 aac_lock_t aac_container_lock; 334 335 /* 336 * The general I/O lock. This protects the sync fib, the lists, the 337 * queues, and the registers. 338 */ 339 aac_lock_t aac_io_lock; 340 341 /* delayed activity infrastructure */ 342 struct task aac_task_complete; /* deferred-completion 343 * task */ 344 struct intr_config_hook aac_ich; 345 346 /* management interface */ 347 struct cdev *aac_dev_t; 348 aac_lock_t aac_aifq_lock; 349 struct aac_aif_command aac_aifq[AAC_AIFQ_LENGTH]; 350 int aac_aifq_head; 351 int aac_aifq_tail; 352 struct selinfo rcv_select; 353 struct proc *aifthread; 354 int aifflags; 355#define AAC_AIFFLAGS_RUNNING (1 << 0) 356#define AAC_AIFFLAGS_AIF (1 << 1) 357#define AAC_AIFFLAGS_EXIT (1 << 2) 358#define AAC_AIFFLAGS_EXITED (1 << 3) 359#define AAC_AIFFLAGS_PRINTF (1 << 4) 360#define AAC_AIFFLAGS_ALLOCFIBS (1 << 5) 361#define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \ 362 AAC_AIFFLAGS_ALLOCFIBS) 363 u_int32_t flags; 364#define AAC_FLAGS_PERC2QC (1 << 0) 365#define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */ 366#define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */ 367#define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */ 368#define AAC_FLAGS_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */ 369#define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem 370 * 2GB-4GB range */ 371#define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */ 372#define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */ 373#define AAC_FLAGS_BROKEN_MEMMAP (1 << 8) /* Broken HostPhysMemPages */ 374 375 u_int32_t supported_options; 376 int aac_max_fibs; 377 u_int32_t scsi_method_id; 378 TAILQ_HEAD(,aac_sim) aac_sim_tqh; 379}; 380 381 382/* 383 * Public functions 384 */ 385extern void aac_free(struct aac_softc *sc); 386extern int aac_attach(struct aac_softc *sc); 387extern int aac_detach(device_t dev); 388extern int aac_shutdown(device_t dev); 389extern int aac_suspend(device_t dev); 390extern int aac_resume(device_t dev); 391extern void aac_intr(void *arg); 392extern void aac_submit_bio(struct bio *bp); 393extern void aac_biodone(struct bio *bp); 394extern void aac_startio(struct aac_softc *sc); 395extern int aac_alloc_command(struct aac_softc *sc, 396 struct aac_command **cmp); 397extern void aac_release_command(struct aac_command *cm); 398extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command, 399 u_int32_t xferstate, struct aac_fib *fib, 400 u_int16_t datasize); 401 402/* 403 * Debugging levels: 404 * 0 - quiet, only emit warnings 405 * 1 - noisy, emit major function points and things done 406 * 2 - extremely noisy, emit trace items in loops, etc. 407 */ 408#ifdef AAC_DEBUG 409# define debug(level, fmt, args...) \ 410 do { \ 411 if (level <=AAC_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \ 412 } while (0) 413# define debug_called(level) \ 414 do { \ 415 if (level <= AAC_DEBUG) printf("%s: called\n", __func__); \ 416 } while (0) 417 418extern void aac_print_queues(struct aac_softc *sc); 419extern void aac_panic(struct aac_softc *sc, char *reason); 420extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib, 421 const char *caller); 422extern void aac_print_aif(struct aac_softc *sc, 423 struct aac_aif_command *aif); 424 425#define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__) 426 427#else 428# define debug(level, fmt, args...) 429# define debug_called(level) 430 431# define aac_print_queues(sc) 432# define aac_panic(sc, reason) 433 434# define AAC_PRINT_FIB(sc, fib) 435# define aac_print_aif(sc, aac_aif_command) 436#endif 437 438struct aac_code_lookup { 439 char *string; 440 u_int32_t code; 441}; 442 443/* 444 * Queue primitives for driver queues. 445 */ 446#define AACQ_ADD(sc, qname) \ 447 do { \ 448 struct aac_qstat *qs; \ 449 \ 450 qs = &(sc)->aac_qstat[qname]; \ 451 \ 452 qs->q_length++; \ 453 if (qs->q_length > qs->q_max) \ 454 qs->q_max = qs->q_length; \ 455 } while (0) 456 457#define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length-- 458#define AACQ_INIT(sc, qname) \ 459 do { \ 460 sc->aac_qstat[qname].q_length = 0; \ 461 sc->aac_qstat[qname].q_max = 0; \ 462 } while (0) 463 464 465#define AACQ_COMMAND_QUEUE(name, index) \ 466static __inline void \ 467aac_initq_ ## name (struct aac_softc *sc) \ 468{ \ 469 TAILQ_INIT(&sc->aac_ ## name); \ 470 AACQ_INIT(sc, index); \ 471} \ 472static __inline void \ 473aac_enqueue_ ## name (struct aac_command *cm) \ 474{ \ 475 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 476 printf("command %p is on another queue, flags = %#x\n", \ 477 cm, cm->cm_flags); \ 478 panic("command is on another queue"); \ 479 } \ 480 TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 481 cm->cm_flags |= AAC_ON_ ## index; \ 482 AACQ_ADD(cm->cm_sc, index); \ 483} \ 484static __inline void \ 485aac_requeue_ ## name (struct aac_command *cm) \ 486{ \ 487 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 488 printf("command %p is on another queue, flags = %#x\n", \ 489 cm, cm->cm_flags); \ 490 panic("command is on another queue"); \ 491 } \ 492 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 493 cm->cm_flags |= AAC_ON_ ## index; \ 494 AACQ_ADD(cm->cm_sc, index); \ 495} \ 496static __inline struct aac_command * \ 497aac_dequeue_ ## name (struct aac_softc *sc) \ 498{ \ 499 struct aac_command *cm; \ 500 \ 501 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \ 502 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 503 printf("command %p not in queue, flags = %#x, " \ 504 "bit = %#x\n", cm, cm->cm_flags, \ 505 AAC_ON_ ## index); \ 506 panic("command not in queue"); \ 507 } \ 508 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \ 509 cm->cm_flags &= ~AAC_ON_ ## index; \ 510 AACQ_REMOVE(sc, index); \ 511 } \ 512 return(cm); \ 513} \ 514static __inline void \ 515aac_remove_ ## name (struct aac_command *cm) \ 516{ \ 517 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 518 printf("command %p not in queue, flags = %#x, " \ 519 "bit = %#x\n", cm, cm->cm_flags, \ 520 AAC_ON_ ## index); \ 521 panic("command not in queue"); \ 522 } \ 523 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 524 cm->cm_flags &= ~AAC_ON_ ## index; \ 525 AACQ_REMOVE(cm->cm_sc, index); \ 526} \ 527struct hack 528 529AACQ_COMMAND_QUEUE(free, AACQ_FREE); 530AACQ_COMMAND_QUEUE(ready, AACQ_READY); 531AACQ_COMMAND_QUEUE(busy, AACQ_BUSY); 532 533/* 534 * outstanding bio queue 535 */ 536static __inline void 537aac_initq_bio(struct aac_softc *sc) 538{ 539 bioq_init(&sc->aac_bioq); 540 AACQ_INIT(sc, AACQ_BIO); 541} 542 543static __inline void 544aac_enqueue_bio(struct aac_softc *sc, struct bio *bp) 545{ 546 bioq_insert_tail(&sc->aac_bioq, bp); 547 AACQ_ADD(sc, AACQ_BIO); 548} 549 550static __inline struct bio * 551aac_dequeue_bio(struct aac_softc *sc) 552{ 553 struct bio *bp; 554 555 if ((bp = bioq_first(&sc->aac_bioq)) != NULL) { 556 bioq_remove(&sc->aac_bioq, bp); 557 AACQ_REMOVE(sc, AACQ_BIO); 558 } 559 return(bp); 560} 561 562static __inline void 563aac_print_printf(struct aac_softc *sc) 564{ 565 /* 566 * XXX We have the ability to read the length of the printf string 567 * from out of the mailboxes. 568 */ 569 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE, 570 sc->aac_common->ac_printf); 571 sc->aac_common->ac_printf[0] = 0; 572 AAC_QNOTIFY(sc, AAC_DB_PRINTF); 573} 574 575static __inline int 576aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib) 577{ 578 579 AAC_LOCK_ACQUIRE(&sc->aac_io_lock); 580 *fib = &sc->aac_common->ac_sync_fib; 581 return (0); 582} 583 584static __inline void 585aac_release_sync_fib(struct aac_softc *sc) 586{ 587 588 AAC_LOCK_RELEASE(&sc->aac_io_lock); 589} 590 591