amrvar.h revision 174544
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 174544 2007-12-12 05:55:03Z 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.53" 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 103union amr_ccb { 104 struct amr_passthrough ccb_pthru; 105 struct amr_ext_passthrough ccb_epthru; 106 uint8_t bytes[128]; 107}; 108 109/* 110 * Per-command control structure. 111 */ 112struct amr_command 113{ 114 TAILQ_ENTRY(amr_command) ac_link; 115 116 struct amr_softc *ac_sc; 117 u_int8_t ac_slot; 118 int ac_status; /* command completion status */ 119 union { 120 struct amr_sgentry *sg32; 121 struct amr_sg64entry *sg64; 122 } ac_sg; 123 u_int32_t ac_sgbusaddr; 124 u_int32_t ac_sg64_lo; 125 u_int32_t ac_sg64_hi; 126 struct amr_mailbox ac_mailbox; 127 int ac_flags; 128#define AMR_CMD_DATAIN (1<<0) 129#define AMR_CMD_DATAOUT (1<<1) 130#define AMR_CMD_CCB (1<<2) 131#define AMR_CMD_PRIORITY (1<<4) 132#define AMR_CMD_MAPPED (1<<5) 133#define AMR_CMD_SLEEP (1<<6) 134#define AMR_CMD_BUSY (1<<7) 135#define AMR_CMD_SG64 (1<<8) 136#define AC_IS_SG64(ac) ((ac)->ac_flags & AMR_CMD_SG64) 137 138 struct bio *ac_bio; 139 void (* ac_complete)(struct amr_command *ac); 140 void *ac_private; 141 142 void *ac_data; 143 size_t ac_length; 144 bus_dmamap_t ac_dmamap; 145 bus_dmamap_t ac_dma64map; 146 147 bus_dma_tag_t ac_tag; 148 bus_dmamap_t ac_datamap; 149 int ac_nsegments; 150 uint32_t ac_mb_physaddr; 151 152 union amr_ccb *ac_ccb; 153 uint32_t ac_ccb_busaddr; 154}; 155 156struct amr_command_cluster 157{ 158 TAILQ_ENTRY(amr_command_cluster) acc_link; 159 struct amr_command acc_command[0]; 160}; 161 162#define AMR_CMD_CLUSTERCOUNT ((AMR_CMD_CLUSTERSIZE - sizeof(struct amr_command_cluster)) / \ 163 sizeof(struct amr_command)) 164 165/* 166 * Per-controller-instance data 167 */ 168struct amr_softc 169{ 170 /* bus attachments */ 171 device_t amr_dev; 172 struct resource *amr_reg; /* control registers */ 173 bus_space_handle_t amr_bhandle; 174 bus_space_tag_t amr_btag; 175 bus_dma_tag_t amr_parent_dmat; /* parent DMA tag */ 176 bus_dma_tag_t amr_buffer_dmat; /* data buffer DMA tag */ 177 bus_dma_tag_t amr_buffer64_dmat; 178 struct resource *amr_irq; /* interrupt */ 179 void *amr_intr; 180 181 /* mailbox */ 182 volatile struct amr_mailbox *amr_mailbox; 183 volatile struct amr_mailbox64 *amr_mailbox64; 184 u_int32_t amr_mailboxphys; 185 bus_dma_tag_t amr_mailbox_dmat; 186 bus_dmamap_t amr_mailbox_dmamap; 187 188 /* scatter/gather lists and their controller-visible mappings */ 189 struct amr_sgentry *amr_sgtable; /* s/g lists */ 190 struct amr_sg64entry *amr_sg64table; /* 64bit s/g lists */ 191 u_int32_t amr_sgbusaddr; /* s/g table base address in bus space */ 192 bus_dma_tag_t amr_sg_dmat; /* s/g buffer DMA tag */ 193 bus_dmamap_t amr_sg_dmamap; /* map for s/g buffers */ 194 195 union amr_ccb *amr_ccb; 196 uint32_t amr_ccb_busaddr; 197 bus_dma_tag_t amr_ccb_dmat; 198 bus_dmamap_t amr_ccb_dmamap; 199 200 /* controller limits and features */ 201 int amr_nextslot; /* Next slot to use for newly allocated commands */ 202 int amr_maxio; /* maximum number of I/O transactions */ 203 int amr_maxdrives; /* max number of logical drives */ 204 int amr_maxchan; /* count of SCSI channels */ 205 206 /* connected logical drives */ 207 struct amr_logdrive amr_drive[AMR_MAXLD]; 208 209 /* controller state */ 210 int amr_state; 211#define AMR_STATE_OPEN (1<<0) 212#define AMR_STATE_SUSPEND (1<<1) 213#define AMR_STATE_INTEN (1<<2) 214#define AMR_STATE_SHUTDOWN (1<<3) 215#define AMR_STATE_CRASHDUMP (1<<4) 216#define AMR_STATE_QUEUE_FRZN (1<<5) 217#define AMR_STATE_LD_DELETE (1<<6) 218#define AMR_STATE_REMAP_LD (1<<7) 219 220 /* per-controller queues */ 221 struct bio_queue_head amr_bioq; /* pending I/O with no commands */ 222 TAILQ_HEAD(,amr_command) amr_ready; /* commands ready to be submitted */ 223 struct amr_command *amr_busycmd[AMR_MAXCMD]; 224 int amr_busyslots; 225 TAILQ_HEAD(,amr_command) amr_completed; 226 TAILQ_HEAD(,amr_command) amr_freecmds; 227 TAILQ_HEAD(,amr_command_cluster) amr_cmd_clusters; 228 229 /* CAM attachments for passthrough */ 230 struct cam_sim *amr_cam_sim[AMR_MAX_CHANNELS]; 231 TAILQ_HEAD(, ccb_hdr) amr_cam_ccbq; 232 struct cam_devq *amr_cam_devq; 233 234 /* control device */ 235 struct cdev *amr_dev_t; 236 struct mtx amr_list_lock; 237 238 /* controller type-specific support */ 239 int amr_type; 240#define AMR_TYPE_QUARTZ (1<<0) 241#define AMR_IS_QUARTZ(sc) ((sc)->amr_type & AMR_TYPE_QUARTZ) 242#define AMR_TYPE_40LD (1<<1) 243#define AMR_IS_40LD(sc) ((sc)->amr_type & AMR_TYPE_40LD) 244#define AMR_TYPE_SG64 (1<<2) 245#define AMR_IS_SG64(sc) ((sc)->amr_type & AMR_TYPE_SG64) 246 int (* amr_submit_command)(struct amr_command *ac); 247 int (* amr_get_work)(struct amr_softc *sc, struct amr_mailbox *mbsave); 248 int (*amr_poll_command)(struct amr_command *ac); 249 int (*amr_poll_command1)(struct amr_softc *sc, struct amr_command *ac); 250 int support_ext_cdb; /* greater than 10 byte cdb support */ 251 252 /* misc glue */ 253 struct intr_config_hook amr_ich; /* wait-for-interrupts probe hook */ 254 struct callout_handle amr_timeout; /* periodic status check */ 255 int amr_allow_vol_config; 256 int amr_linux_no_adapters; 257 int amr_ld_del_supported; 258 struct mtx amr_hw_lock; 259}; 260 261/* 262 * Interface between bus connections and driver core. 263 */ 264extern int amr_attach(struct amr_softc *sc); 265extern void amr_free(struct amr_softc *sc); 266extern int amr_flush(struct amr_softc *sc); 267extern int amr_done(struct amr_softc *sc); 268extern void amr_startio(struct amr_softc *sc); 269 270/* 271 * Command buffer allocation. 272 */ 273extern struct amr_command *amr_alloccmd(struct amr_softc *sc); 274extern void amr_releasecmd(struct amr_command *ac); 275 276/* 277 * CAM interface 278 */ 279extern int amr_cam_attach(struct amr_softc *sc); 280extern void amr_cam_detach(struct amr_softc *sc); 281extern int amr_cam_command(struct amr_softc *sc, struct amr_command **acp); 282 283/* 284 * MegaRAID logical disk driver 285 */ 286struct amrd_softc 287{ 288 device_t amrd_dev; 289 struct amr_softc *amrd_controller; 290 struct amr_logdrive *amrd_drive; 291 struct disk *amrd_disk; 292 int amrd_unit; 293}; 294 295/* 296 * Interface between driver core and disk driver (should be using a bus?) 297 */ 298extern int amr_submit_bio(struct amr_softc *sc, struct bio *bio); 299extern int amr_dump_blocks(struct amr_softc *sc, int unit, u_int32_t lba, void *data, int blks); 300extern void amrd_intr(void *data); 301 302/******************************************************************************** 303 * Enqueue/dequeue functions 304 */ 305static __inline void 306amr_enqueue_bio(struct amr_softc *sc, struct bio *bio) 307{ 308 309 bioq_insert_tail(&sc->amr_bioq, bio); 310} 311 312static __inline struct bio * 313amr_dequeue_bio(struct amr_softc *sc) 314{ 315 struct bio *bio; 316 317 if ((bio = bioq_first(&sc->amr_bioq)) != NULL) 318 bioq_remove(&sc->amr_bioq, bio); 319 return(bio); 320} 321 322static __inline void 323amr_enqueue_ready(struct amr_command *ac) 324{ 325 326 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_ready, ac, ac_link); 327} 328 329static __inline void 330amr_requeue_ready(struct amr_command *ac) 331{ 332 333 TAILQ_INSERT_HEAD(&ac->ac_sc->amr_ready, ac, ac_link); 334} 335 336static __inline struct amr_command * 337amr_dequeue_ready(struct amr_softc *sc) 338{ 339 struct amr_command *ac; 340 341 if ((ac = TAILQ_FIRST(&sc->amr_ready)) != NULL) 342 TAILQ_REMOVE(&sc->amr_ready, ac, ac_link); 343 return(ac); 344} 345 346static __inline void 347amr_enqueue_completed(struct amr_command *ac) 348{ 349 350 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_completed, ac, ac_link); 351} 352 353static __inline struct amr_command * 354amr_dequeue_completed(struct amr_softc *sc) 355{ 356 struct amr_command *ac; 357 358 if ((ac = TAILQ_FIRST(&sc->amr_completed)) != NULL) 359 TAILQ_REMOVE(&sc->amr_completed, ac, ac_link); 360 return(ac); 361} 362 363static __inline void 364amr_enqueue_free(struct amr_command *ac) 365{ 366 367 TAILQ_INSERT_TAIL(&ac->ac_sc->amr_freecmds, ac, ac_link); 368} 369 370static __inline struct amr_command * 371amr_dequeue_free(struct amr_softc *sc) 372{ 373 struct amr_command *ac; 374 375 if ((ac = TAILQ_FIRST(&sc->amr_freecmds)) != NULL) 376 TAILQ_REMOVE(&sc->amr_freecmds, ac, ac_link); 377 return(ac); 378} 379