amrvar.h revision 148841
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 148841 2005-08-07 23:53:00Z scottl $ 57 */ 58 59#include <geom/geom_disk.h> 60#include <sys/lock.h> 61#include <sys/mutex.h> 62 63#define LSI_DESC_PCI "LSILogic MegaRAID 1.51" 64 65#ifdef AMR_DEBUG 66# define debug(level, fmt, args...) do {if (level <= AMR_DEBUG) printf("%s: " fmt "\n", __func__ , ##args);} while(0) 67# define debug_called(level) do {if (level <= AMR_DEBUG) printf("%s: called\n", __func__);} while(0) 68#else 69# define debug(level, fmt, args...) 70# define debug_called(level) 71#endif 72#define xdebug(fmt, args...) printf("%s: " fmt "\n", __func__ , ##args) 73 74/* 75 * Per-logical-drive datastructure 76 */ 77struct amr_logdrive 78{ 79 u_int32_t al_size; 80 int al_state; 81 int al_properties; 82 83 /* synthetic geometry */ 84 int al_cylinders; 85 int al_heads; 86 int al_sectors; 87 88 /* driver */ 89 device_t al_disk; 90}; 91 92/* 93 * Due to the difficulty of using the zone allocator to create a new 94 * zone from within a module, we use our own clustering to reduce 95 * memory wastage due to allocating lots of these small structures. 96 * 97 * 16k gives us a little under 200 command structures, which should 98 * normally be plenty. We will grab more if we need them. 99 */ 100 101#define AMR_CMD_CLUSTERSIZE (16 * 1024) 102 103/* 104 * Per-command control structure. 105 */ 106struct amr_command 107{ 108 TAILQ_ENTRY(amr_command) ac_link; 109 110 struct amr_softc *ac_sc; 111 u_int8_t ac_slot; 112 int ac_status; /* command completion status */ 113 struct amr_mailbox ac_mailbox; 114 int ac_flags; 115#define AMR_CMD_DATAIN (1<<0) 116#define AMR_CMD_DATAOUT (1<<1) 117#define AMR_CMD_CCB_DATAIN (1<<2) 118#define AMR_CMD_CCB_DATAOUT (1<<3) 119#define AMR_CMD_PRIORITY (1<<4) 120#define AMR_CMD_MAPPED (1<<5) 121#define AMR_CMD_SLEEP (1<<6) 122#define AMR_CMD_BUSY (1<<7) 123 124 struct bio *ac_bio; 125 126 void *ac_data; 127 size_t ac_length; 128 bus_dmamap_t ac_dmamap; 129 u_int32_t ac_dataphys; 130 131 void *ac_ccb_data; 132 size_t ac_ccb_length; 133 bus_dmamap_t ac_ccb_dmamap; 134 u_int32_t ac_ccb_dataphys; 135 136 void (* ac_complete)(struct amr_command *ac); 137 void *ac_private; 138}; 139 140struct amr_command_cluster 141{ 142 TAILQ_ENTRY(amr_command_cluster) acc_link; 143 struct amr_command acc_command[0]; 144}; 145 146#define AMR_CMD_CLUSTERCOUNT ((AMR_CMD_CLUSTERSIZE - sizeof(struct amr_command_cluster)) / \ 147 sizeof(struct amr_command)) 148 149/* 150 * Per-controller-instance data 151 */ 152struct amr_softc 153{ 154 /* bus attachments */ 155 device_t amr_dev; 156 struct resource *amr_reg; /* control registers */ 157 bus_space_handle_t amr_bhandle; 158 bus_space_tag_t amr_btag; 159 bus_dma_tag_t amr_parent_dmat; /* parent DMA tag */ 160 bus_dma_tag_t amr_buffer_dmat; /* data buffer DMA tag */ 161 struct resource *amr_irq; /* interrupt */ 162 void *amr_intr; 163 164 /* mailbox */ 165 volatile struct amr_mailbox *amr_mailbox; 166 volatile struct amr_mailbox64 *amr_mailbox64; 167 u_int32_t amr_mailboxphys; 168 bus_dma_tag_t amr_mailbox_dmat; 169 bus_dmamap_t amr_mailbox_dmamap; 170 171 /* scatter/gather lists and their controller-visible mappings */ 172 struct amr_sgentry *amr_sgtable; /* s/g lists */ 173 u_int32_t amr_sgbusaddr; /* s/g table base address in bus space */ 174 bus_dma_tag_t amr_sg_dmat; /* s/g buffer DMA tag */ 175 bus_dmamap_t amr_sg_dmamap; /* map for s/g buffers */ 176 177 /* controller limits and features */ 178 int amr_nextslot; /* Next slot to use for newly allocated commands */ 179 int amr_maxio; /* maximum number of I/O transactions */ 180 int amr_maxdrives; /* max number of logical drives */ 181 int amr_maxchan; /* count of SCSI channels */ 182 183 /* connected logical drives */ 184 struct amr_logdrive amr_drive[AMR_MAXLD]; 185 186 /* controller state */ 187 int amr_state; 188#define AMR_STATE_OPEN (1<<0) 189#define AMR_STATE_SUSPEND (1<<1) 190#define AMR_STATE_INTEN (1<<2) 191#define AMR_STATE_SHUTDOWN (1<<3) 192#define AMR_STATE_CRASHDUMP (1<<4) 193#define AMR_STATE_QUEUE_FRZN (1<<5) 194 195 /* per-controller queues */ 196 struct bio_queue_head amr_bioq; /* pending I/O with no commands */ 197 TAILQ_HEAD(,amr_command) amr_ready; /* commands ready to be submitted */ 198 struct amr_command *amr_busycmd[AMR_MAXCMD]; 199 int amr_busyslots; 200 TAILQ_HEAD(,amr_command) amr_completed; 201 TAILQ_HEAD(,amr_command) amr_freecmds; 202 TAILQ_HEAD(,amr_command_cluster) amr_cmd_clusters; 203 204 /* CAM attachments for passthrough */ 205 struct cam_sim *amr_cam_sim[AMR_MAX_CHANNELS]; 206 TAILQ_HEAD(, ccb_hdr) amr_cam_ccbq; 207 struct cam_devq *amr_cam_devq; 208 209 /* control device */ 210 struct cdev *amr_dev_t; 211 212 /* controller type-specific support */ 213 int amr_type; 214#define AMR_TYPE_QUARTZ (1<<0) 215#define AMR_IS_QUARTZ(sc) ((sc)->amr_type & AMR_TYPE_QUARTZ) 216#define AMR_TYPE_40LD (1<<1) 217#define AMR_IS_40LD(sc) ((sc)->amr_type & AMR_TYPE_40LD) 218 int (* amr_submit_command)(struct amr_softc *sc); 219 int (* amr_get_work)(struct amr_softc *sc, struct amr_mailbox *mbsave); 220 int (*amr_poll_command)(struct amr_command *ac); 221 int (*amr_poll_command1)(struct amr_softc *sc, struct amr_command *ac); 222 int support_ext_cdb; /* greater than 10 byte cdb support */ 223 224 /* misc glue */ 225 struct intr_config_hook amr_ich; /* wait-for-interrupts probe hook */ 226 struct callout_handle amr_timeout; /* periodic status check */ 227 struct mtx amr_io_lock; 228}; 229 230/* 231 * Interface between bus connections and driver core. 232 */ 233extern int amr_attach(struct amr_softc *sc); 234extern void amr_free(struct amr_softc *sc); 235extern int amr_flush(struct amr_softc *sc); 236extern int amr_done(struct amr_softc *sc); 237extern void amr_startio(struct amr_softc *sc); 238 239/* 240 * Command buffer allocation. 241 */ 242extern struct amr_command *amr_alloccmd(struct amr_softc *sc); 243extern void amr_releasecmd(struct amr_command *ac); 244 245/* 246 * CAM interface 247 */ 248extern int amr_cam_attach(struct amr_softc *sc); 249extern void amr_cam_detach(struct amr_softc *sc); 250extern int amr_cam_command(struct amr_softc *sc, struct amr_command **acp); 251 252/* 253 * MegaRAID logical disk driver 254 */ 255struct amrd_softc 256{ 257 device_t amrd_dev; 258 struct amr_softc *amrd_controller; 259 struct amr_logdrive *amrd_drive; 260 struct disk *amrd_disk; 261 int amrd_unit; 262}; 263 264/* 265 * Interface between driver core and disk driver (should be using a bus?) 266 */ 267extern int amr_submit_bio(struct amr_softc *sc, struct bio *bio); 268extern int amr_dump_blocks(struct amr_softc *sc, int unit, u_int32_t lba, void *data, int blks); 269extern void amrd_intr(void *data); 270 271/******************************************************************************** 272 * Enqueue/dequeue functions 273 */ 274static __inline void 275amr_enqueue_bio(struct amr_softc *sc, struct bio *bio) 276{ 277 int s; 278 279 s = splbio(); 280 bioq_insert_tail(&sc->amr_bioq, bio); 281 splx(s); 282} 283 284static __inline struct bio * 285amr_dequeue_bio(struct amr_softc *sc) 286{ 287 struct bio *bio; 288 int s; 289 290 s = splbio(); 291 if ((bio = bioq_first(&sc->amr_bioq)) != NULL) 292 bioq_remove(&sc->amr_bioq, bio); 293 splx(s); 294 return(bio); 295} 296 297static __inline void 298amr_enqueue_ready(struct amr_command *ac) 299{ 300 int s; 301 302 s = splbio(); 303 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_ready, ac, ac_link); 304 splx(s); 305} 306 307static __inline void 308amr_requeue_ready(struct amr_command *ac) 309{ 310 int s; 311 312 s = splbio(); 313 TAILQ_INSERT_HEAD(&ac->ac_sc->amr_ready, ac, ac_link); 314 splx(s); 315} 316 317static __inline struct amr_command * 318amr_dequeue_ready(struct amr_softc *sc) 319{ 320 struct amr_command *ac; 321 int s; 322 323 s = splbio(); 324 if ((ac = TAILQ_FIRST(&sc->amr_ready)) != NULL) 325 TAILQ_REMOVE(&sc->amr_ready, ac, ac_link); 326 splx(s); 327 return(ac); 328} 329 330static __inline void 331amr_enqueue_completed(struct amr_command *ac) 332{ 333 int s; 334 335 s = splbio(); 336 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_completed, ac, ac_link); 337 splx(s); 338} 339 340static __inline struct amr_command * 341amr_dequeue_completed(struct amr_softc *sc) 342{ 343 struct amr_command *ac; 344 int s; 345 346 s = splbio(); 347 if ((ac = TAILQ_FIRST(&sc->amr_completed)) != NULL) 348 TAILQ_REMOVE(&sc->amr_completed, ac, ac_link); 349 splx(s); 350 return(ac); 351} 352 353static __inline void 354amr_enqueue_free(struct amr_command *ac) 355{ 356 int s; 357 358 s = splbio(); 359 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_freecmds, ac, ac_link); 360 splx(s); 361} 362 363static __inline struct amr_command * 364amr_dequeue_free(struct amr_softc *sc) 365{ 366 struct amr_command *ac; 367 int s; 368 369 s = splbio(); 370 if ((ac = TAILQ_FIRST(&sc->amr_freecmds)) != NULL) 371 TAILQ_REMOVE(&sc->amr_freecmds, ac, ac_link); 372 splx(s); 373 return(ac); 374} 375