amrvar.h revision 106225
1/*- 2 * Copyright (c) 1999,2000 Michael Smith 3 * Copyright (c) 2000 BSDi 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * Copyright (c) 2002 Eric Moore 28 * Copyright (c) 2002 LSI Logic Corporation 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 1. Redistributions of source code must retain the above copyright 35 * notice, this list of conditions and the following disclaimer. 36 * 2. Redistributions in binary form must reproduce the above copyright 37 * notice, this list of conditions and the following disclaimer in the 38 * documentation and/or other materials provided with the distribution. 39 * 3. The party using or redistributing the source code and binary forms 40 * agrees to the disclaimer below and the terms and conditions set forth 41 * herein. 42 * 43 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 53 * SUCH DAMAGE. 54 * 55 * 56 * $FreeBSD: head/sys/dev/amr/amrvar.h 106225 2002-10-30 22:00:11Z emoore $ 57 */ 58 59#if __FreeBSD_version >= 500005 60# include <sys/taskqueue.h> 61#endif 62 63#ifdef AMR_DEBUG 64# define debug(level, fmt, args...) do {if (level <= AMR_DEBUG) printf("%s: " fmt "\n", __func__ , ##args);} while(0) 65# define debug_called(level) do {if (level <= AMR_DEBUG) printf("%s: called\n", __func__);} while(0) 66#else 67# define debug(level, fmt, args...) 68# define debug_called(level) 69#endif 70#define xdebug(fmt, args...) printf("%s: " fmt "\n", __func__ , ##args) 71 72/* 73 * Per-logical-drive datastructure 74 */ 75struct amr_logdrive 76{ 77 u_int32_t al_size; 78 int al_state; 79 int al_properties; 80 81 /* synthetic geometry */ 82 int al_cylinders; 83 int al_heads; 84 int al_sectors; 85 86 /* driver */ 87 device_t al_disk; 88}; 89 90/* 91 * Due to the difficulty of using the zone allocator to create a new 92 * zone from within a module, we use our own clustering to reduce 93 * memory wastage due to allocating lots of these small structures. 94 * 95 * 16k gives us a little under 200 command structures, which should 96 * normally be plenty. We will grab more if we need them. 97 */ 98 99#define AMR_CMD_CLUSTERSIZE (16 * 1024) 100 101/* 102 * Per-command control structure. 103 */ 104struct amr_command 105{ 106 TAILQ_ENTRY(amr_command) ac_link; 107 108 struct amr_softc *ac_sc; 109 u_int8_t ac_slot; 110 int ac_status; /* command completion status */ 111 struct amr_mailbox ac_mailbox; 112 int ac_flags; 113#define AMR_CMD_DATAIN (1<<0) 114#define AMR_CMD_DATAOUT (1<<1) 115#define AMR_CMD_CCB_DATAIN (1<<2) 116#define AMR_CMD_CCB_DATAOUT (1<<3) 117#define AMR_CMD_PRIORITY (1<<4) 118#define AMR_CMD_MAPPED (1<<5) 119#define AMR_CMD_SLEEP (1<<6) 120#define AMR_CMD_BUSY (1<<7) 121 122 struct bio *ac_bio; 123 124 void *ac_data; 125 size_t ac_length; 126 bus_dmamap_t ac_dmamap; 127 u_int32_t ac_dataphys; 128 129 void *ac_ccb_data; 130 size_t ac_ccb_length; 131 bus_dmamap_t ac_ccb_dmamap; 132 u_int32_t ac_ccb_dataphys; 133 134 void (* ac_complete)(struct amr_command *ac); 135 void *ac_private; 136}; 137 138struct amr_command_cluster 139{ 140 TAILQ_ENTRY(amr_command_cluster) acc_link; 141 struct amr_command acc_command[0]; 142}; 143 144#define AMR_CMD_CLUSTERCOUNT ((AMR_CMD_CLUSTERSIZE - sizeof(struct amr_command_cluster)) / \ 145 sizeof(struct amr_command)) 146 147/* 148 * Per-controller-instance data 149 */ 150struct amr_softc 151{ 152 /* bus attachments */ 153 device_t amr_dev; 154 struct resource *amr_reg; /* control registers */ 155 bus_space_handle_t amr_bhandle; 156 bus_space_tag_t amr_btag; 157 bus_dma_tag_t amr_parent_dmat; /* parent DMA tag */ 158 bus_dma_tag_t amr_buffer_dmat; /* data buffer DMA tag */ 159 struct resource *amr_irq; /* interrupt */ 160 void *amr_intr; 161 162 /* mailbox */ 163 volatile struct amr_mailbox *amr_mailbox; 164 volatile struct amr_mailbox64 *amr_mailbox64; 165 u_int32_t amr_mailboxphys; 166 bus_dma_tag_t amr_mailbox_dmat; 167 bus_dmamap_t amr_mailbox_dmamap; 168 169 /* scatter/gather lists and their controller-visible mappings */ 170 struct amr_sgentry *amr_sgtable; /* s/g lists */ 171 u_int32_t amr_sgbusaddr; /* s/g table base address in bus space */ 172 bus_dma_tag_t amr_sg_dmat; /* s/g buffer DMA tag */ 173 bus_dmamap_t amr_sg_dmamap; /* map for s/g buffers */ 174 175 /* controller limits and features */ 176 int amr_maxio; /* maximum number of I/O transactions */ 177 int amr_maxdrives; /* max number of logical drives */ 178 int amr_maxchan; /* count of SCSI channels */ 179 180 /* connected logical drives */ 181 struct amr_logdrive amr_drive[AMR_MAXLD]; 182 183 /* controller state */ 184 int amr_state; 185#define AMR_STATE_OPEN (1<<0) 186#define AMR_STATE_SUSPEND (1<<1) 187#define AMR_STATE_INTEN (1<<2) 188#define AMR_STATE_SHUTDOWN (1<<3) 189 190 /* per-controller queues */ 191 struct bio_queue_head amr_bioq; /* pending I/O with no commands */ 192 TAILQ_HEAD(,amr_command) amr_ready; /* commands ready to be submitted */ 193 struct amr_command *amr_busycmd[AMR_MAXCMD]; 194 int amr_busyslots; 195 TAILQ_HEAD(,amr_command) amr_completed; 196 TAILQ_HEAD(,amr_command) amr_freecmds; 197 TAILQ_HEAD(,amr_command_cluster) amr_cmd_clusters; 198 199 /* CAM attachments for passthrough */ 200 struct cam_sim *amr_cam_sim[AMR_MAX_CHANNELS]; 201 TAILQ_HEAD(, ccb_hdr) amr_cam_ccbq; 202 203 /* control device */ 204 dev_t amr_dev_t; 205 206 /* controller type-specific support */ 207 int amr_type; 208#define AMR_TYPE_QUARTZ (1<<0) 209#define AMR_IS_QUARTZ(sc) ((sc)->amr_type & AMR_TYPE_QUARTZ) 210#define AMR_TYPE_40LD (1<<1) 211#define AMR_IS_40LD(sc) ((sc)->amr_type & AMR_TYPE_40LD) 212 int (* amr_submit_command)(struct amr_softc *sc); 213 int (* amr_get_work)(struct amr_softc *sc, struct amr_mailbox *mbsave); 214 int support_ext_cdb; /* greater than 10 byte cdb support */ 215 216 /* misc glue */ 217 struct intr_config_hook amr_ich; /* wait-for-interrupts probe hook */ 218 struct callout_handle amr_timeout; /* periodic status check */ 219#if __FreeBSD_version >= 500005 220 struct task amr_task_complete; /* deferred-completion task */ 221#endif 222}; 223 224/* 225 * Interface between bus connections and driver core. 226 */ 227extern int amr_attach(struct amr_softc *sc); 228extern void amr_free(struct amr_softc *sc); 229extern int amr_flush(struct amr_softc *sc); 230extern int amr_done(struct amr_softc *sc); 231extern void amr_startio(struct amr_softc *sc); 232 233/* 234 * Command buffer allocation. 235 */ 236extern struct amr_command *amr_alloccmd(struct amr_softc *sc); 237extern void amr_releasecmd(struct amr_command *ac); 238 239/* 240 * CAM interface 241 */ 242extern int amr_cam_attach(struct amr_softc *sc); 243extern void amr_cam_detach(struct amr_softc *sc); 244extern int amr_cam_command(struct amr_softc *sc, struct amr_command **acp); 245 246/* 247 * MegaRAID logical disk driver 248 */ 249struct amrd_softc 250{ 251 device_t amrd_dev; 252 dev_t amrd_dev_t; 253 struct amr_softc *amrd_controller; 254 struct amr_logdrive *amrd_drive; 255 struct disk amrd_disk; 256 struct devstat amrd_stats; 257 int amrd_unit; 258 int amrd_flags; 259#define AMRD_OPEN (1<<0) /* drive is open (can't detach) */ 260}; 261 262/* 263 * Interface between driver core and disk driver (should be using a bus?) 264 */ 265extern int amr_submit_bio(struct amr_softc *sc, struct bio *bio); 266extern void amrd_intr(void *data); 267 268/******************************************************************************** 269 * Enqueue/dequeue functions 270 */ 271static __inline void 272amr_enqueue_bio(struct amr_softc *sc, struct bio *bio) 273{ 274 int s; 275 276 s = splbio(); 277 bioq_insert_tail(&sc->amr_bioq, bio); 278 splx(s); 279} 280 281static __inline struct bio * 282amr_dequeue_bio(struct amr_softc *sc) 283{ 284 struct bio *bio; 285 int s; 286 287 s = splbio(); 288 if ((bio = bioq_first(&sc->amr_bioq)) != NULL) 289 bioq_remove(&sc->amr_bioq, bio); 290 splx(s); 291 return(bio); 292} 293 294static __inline void 295amr_enqueue_ready(struct amr_command *ac) 296{ 297 int s; 298 299 s = splbio(); 300 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_ready, ac, ac_link); 301 splx(s); 302} 303 304static __inline void 305amr_requeue_ready(struct amr_command *ac) 306{ 307 int s; 308 309 s = splbio(); 310 TAILQ_INSERT_HEAD(&ac->ac_sc->amr_ready, ac, ac_link); 311 splx(s); 312} 313 314static __inline struct amr_command * 315amr_dequeue_ready(struct amr_softc *sc) 316{ 317 struct amr_command *ac; 318 int s; 319 320 s = splbio(); 321 if ((ac = TAILQ_FIRST(&sc->amr_ready)) != NULL) 322 TAILQ_REMOVE(&sc->amr_ready, ac, ac_link); 323 splx(s); 324 return(ac); 325} 326 327static __inline void 328amr_enqueue_completed(struct amr_command *ac) 329{ 330 int s; 331 332 s = splbio(); 333 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_completed, ac, ac_link); 334 splx(s); 335} 336 337static __inline struct amr_command * 338amr_dequeue_completed(struct amr_softc *sc) 339{ 340 struct amr_command *ac; 341 int s; 342 343 s = splbio(); 344 if ((ac = TAILQ_FIRST(&sc->amr_completed)) != NULL) 345 TAILQ_REMOVE(&sc->amr_completed, ac, ac_link); 346 splx(s); 347 return(ac); 348} 349 350static __inline void 351amr_enqueue_free(struct amr_command *ac) 352{ 353 int s; 354 355 s = splbio(); 356 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_freecmds, ac, ac_link); 357 splx(s); 358} 359 360static __inline struct amr_command * 361amr_dequeue_free(struct amr_softc *sc) 362{ 363 struct amr_command *ac; 364 int s; 365 366 s = splbio(); 367 if ((ac = TAILQ_FIRST(&sc->amr_freecmds)) != NULL) 368 TAILQ_REMOVE(&sc->amr_freecmds, ac, ac_link); 369 splx(s); 370 return(ac); 371} 372