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