amrvar.h revision 140340
151974Smsmith/*- 265245Smsmith * Copyright (c) 1999,2000 Michael Smith 365245Smsmith * Copyright (c) 2000 BSDi 451974Smsmith * All rights reserved. 551974Smsmith * 651974Smsmith * Redistribution and use in source and binary forms, with or without 751974Smsmith * modification, are permitted provided that the following conditions 851974Smsmith * are met: 951974Smsmith * 1. Redistributions of source code must retain the above copyright 1051974Smsmith * notice, this list of conditions and the following disclaimer. 1151974Smsmith * 2. Redistributions in binary form must reproduce the above copyright 1251974Smsmith * notice, this list of conditions and the following disclaimer in the 1351974Smsmith * documentation and/or other materials provided with the distribution. 1451974Smsmith * 1551974Smsmith * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1651974Smsmith * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1751974Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1851974Smsmith * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1951974Smsmith * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2051974Smsmith * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2151974Smsmith * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2251974Smsmith * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2351974Smsmith * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2451974Smsmith * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2551974Smsmith * SUCH DAMAGE. 2651974Smsmith * 27106225Semoore * Copyright (c) 2002 Eric Moore 28106225Semoore * Copyright (c) 2002 LSI Logic Corporation 29106225Semoore * All rights reserved. 30106225Semoore * 31106225Semoore * Redistribution and use in source and binary forms, with or without 32106225Semoore * modification, are permitted provided that the following conditions 33106225Semoore * are met: 34106225Semoore * 1. Redistributions of source code must retain the above copyright 35106225Semoore * notice, this list of conditions and the following disclaimer. 36106225Semoore * 2. Redistributions in binary form must reproduce the above copyright 37106225Semoore * notice, this list of conditions and the following disclaimer in the 38106225Semoore * documentation and/or other materials provided with the distribution. 39105419Semoore * 3. The party using or redistributing the source code and binary forms 40106225Semoore * agrees to the disclaimer below and the terms and conditions set forth 41105419Semoore * herein. 42105419Semoore * 43106225Semoore * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 44106225Semoore * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45106225Semoore * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 46106225Semoore * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 47106225Semoore * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 48106225Semoore * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 49106225Semoore * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 50106225Semoore * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 51106225Semoore * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 52106225Semoore * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 53106225Semoore * SUCH DAMAGE. 54105419Semoore * 55106225Semoore * 5651974Smsmith * $FreeBSD: head/sys/dev/amr/amrvar.h 140340 2005-01-16 07:34:26Z scottl $ 5751974Smsmith */ 5851974Smsmith 5965245Smsmith#if __FreeBSD_version >= 500005 60112946Sphk# include <geom/geom_disk.h> 61140340Sscottl# include <sys/lock.h> 62140340Sscottl# include <sys/mutex.h> 6365245Smsmith#endif 6451974Smsmith 6565245Smsmith#ifdef AMR_DEBUG 6687599Sobrien# define debug(level, fmt, args...) do {if (level <= AMR_DEBUG) printf("%s: " fmt "\n", __func__ , ##args);} while(0) 6787599Sobrien# define debug_called(level) do {if (level <= AMR_DEBUG) printf("%s: called\n", __func__);} while(0) 6865245Smsmith#else 6965245Smsmith# define debug(level, fmt, args...) 7065245Smsmith# define debug_called(level) 7165245Smsmith#endif 7287599Sobrien#define xdebug(fmt, args...) printf("%s: " fmt "\n", __func__ , ##args) 7351974Smsmith 7451974Smsmith/* 7551974Smsmith * Per-logical-drive datastructure 7651974Smsmith */ 7751974Smsmithstruct amr_logdrive 7851974Smsmith{ 7951974Smsmith u_int32_t al_size; 8051974Smsmith int al_state; 8151974Smsmith int al_properties; 8251974Smsmith 8351974Smsmith /* synthetic geometry */ 8451974Smsmith int al_cylinders; 8551974Smsmith int al_heads; 8651974Smsmith int al_sectors; 8751974Smsmith 8851974Smsmith /* driver */ 8951974Smsmith device_t al_disk; 9051974Smsmith}; 9151974Smsmith 9265245Smsmith/* 9365245Smsmith * Due to the difficulty of using the zone allocator to create a new 9465245Smsmith * zone from within a module, we use our own clustering to reduce 9565245Smsmith * memory wastage due to allocating lots of these small structures. 9665245Smsmith * 9765245Smsmith * 16k gives us a little under 200 command structures, which should 9865245Smsmith * normally be plenty. We will grab more if we need them. 9965245Smsmith */ 10051974Smsmith 10165245Smsmith#define AMR_CMD_CLUSTERSIZE (16 * 1024) 10265245Smsmith 10351974Smsmith/* 10451974Smsmith * Per-command control structure. 10551974Smsmith */ 10651974Smsmithstruct amr_command 10751974Smsmith{ 10860938Sjake TAILQ_ENTRY(amr_command) ac_link; 10951974Smsmith 11051974Smsmith struct amr_softc *ac_sc; 11151974Smsmith u_int8_t ac_slot; 11265245Smsmith int ac_status; /* command completion status */ 11351974Smsmith struct amr_mailbox ac_mailbox; 11451974Smsmith int ac_flags; 11551974Smsmith#define AMR_CMD_DATAIN (1<<0) 11651974Smsmith#define AMR_CMD_DATAOUT (1<<1) 11765245Smsmith#define AMR_CMD_CCB_DATAIN (1<<2) 11865245Smsmith#define AMR_CMD_CCB_DATAOUT (1<<3) 11965245Smsmith#define AMR_CMD_PRIORITY (1<<4) 12065245Smsmith#define AMR_CMD_MAPPED (1<<5) 12165245Smsmith#define AMR_CMD_SLEEP (1<<6) 12265245Smsmith#define AMR_CMD_BUSY (1<<7) 12351974Smsmith 12465245Smsmith struct bio *ac_bio; 12565245Smsmith 12651974Smsmith void *ac_data; 12751974Smsmith size_t ac_length; 12851974Smsmith bus_dmamap_t ac_dmamap; 12951974Smsmith u_int32_t ac_dataphys; 13051974Smsmith 13165245Smsmith void *ac_ccb_data; 13265245Smsmith size_t ac_ccb_length; 13365245Smsmith bus_dmamap_t ac_ccb_dmamap; 13465245Smsmith u_int32_t ac_ccb_dataphys; 13565245Smsmith 13651974Smsmith void (* ac_complete)(struct amr_command *ac); 137105419Semoore void *ac_private; 13851974Smsmith}; 13951974Smsmith 14065245Smsmithstruct amr_command_cluster 14165245Smsmith{ 14265245Smsmith TAILQ_ENTRY(amr_command_cluster) acc_link; 14365245Smsmith struct amr_command acc_command[0]; 14465245Smsmith}; 14565245Smsmith 14665245Smsmith#define AMR_CMD_CLUSTERCOUNT ((AMR_CMD_CLUSTERSIZE - sizeof(struct amr_command_cluster)) / \ 14765245Smsmith sizeof(struct amr_command)) 14865245Smsmith 14965245Smsmith/* 15065245Smsmith * Per-controller-instance data 15165245Smsmith */ 15251974Smsmithstruct amr_softc 15351974Smsmith{ 15451974Smsmith /* bus attachments */ 15551974Smsmith device_t amr_dev; 15651974Smsmith struct resource *amr_reg; /* control registers */ 15751974Smsmith bus_space_handle_t amr_bhandle; 15851974Smsmith bus_space_tag_t amr_btag; 15951974Smsmith bus_dma_tag_t amr_parent_dmat; /* parent DMA tag */ 16051974Smsmith bus_dma_tag_t amr_buffer_dmat; /* data buffer DMA tag */ 16151974Smsmith struct resource *amr_irq; /* interrupt */ 16251974Smsmith void *amr_intr; 16351974Smsmith 16451974Smsmith /* mailbox */ 16558496Smsmith volatile struct amr_mailbox *amr_mailbox; 16658496Smsmith volatile struct amr_mailbox64 *amr_mailbox64; 16751974Smsmith u_int32_t amr_mailboxphys; 16851974Smsmith bus_dma_tag_t amr_mailbox_dmat; 16951974Smsmith bus_dmamap_t amr_mailbox_dmamap; 17051974Smsmith 17151974Smsmith /* scatter/gather lists and their controller-visible mappings */ 17251974Smsmith struct amr_sgentry *amr_sgtable; /* s/g lists */ 17351974Smsmith u_int32_t amr_sgbusaddr; /* s/g table base address in bus space */ 17451974Smsmith bus_dma_tag_t amr_sg_dmat; /* s/g buffer DMA tag */ 17551974Smsmith bus_dmamap_t amr_sg_dmamap; /* map for s/g buffers */ 17651974Smsmith 17751974Smsmith /* controller limits and features */ 178140340Sscottl int amr_nextslot; /* Next slot to use for newly allocated commands */ 17951974Smsmith int amr_maxio; /* maximum number of I/O transactions */ 18051974Smsmith int amr_maxdrives; /* max number of logical drives */ 18165245Smsmith int amr_maxchan; /* count of SCSI channels */ 18251974Smsmith 18351974Smsmith /* connected logical drives */ 18451974Smsmith struct amr_logdrive amr_drive[AMR_MAXLD]; 18551974Smsmith 18665245Smsmith /* controller state */ 18751974Smsmith int amr_state; 18851974Smsmith#define AMR_STATE_OPEN (1<<0) 18951974Smsmith#define AMR_STATE_SUSPEND (1<<1) 19051974Smsmith#define AMR_STATE_INTEN (1<<2) 19151974Smsmith#define AMR_STATE_SHUTDOWN (1<<3) 192131394Sps#define AMR_STATE_CRASHDUMP (1<<4) 193138422Sscottl#define AMR_STATE_QUEUE_FRZN (1<<5) 19451974Smsmith 19551974Smsmith /* per-controller queues */ 19665245Smsmith struct bio_queue_head amr_bioq; /* pending I/O with no commands */ 19765245Smsmith TAILQ_HEAD(,amr_command) amr_ready; /* commands ready to be submitted */ 19851974Smsmith struct amr_command *amr_busycmd[AMR_MAXCMD]; 19965245Smsmith int amr_busyslots; 20065245Smsmith TAILQ_HEAD(,amr_command) amr_completed; 20160938Sjake TAILQ_HEAD(,amr_command) amr_freecmds; 20265245Smsmith TAILQ_HEAD(,amr_command_cluster) amr_cmd_clusters; 20351974Smsmith 20465245Smsmith /* CAM attachments for passthrough */ 20565245Smsmith struct cam_sim *amr_cam_sim[AMR_MAX_CHANNELS]; 20665245Smsmith TAILQ_HEAD(, ccb_hdr) amr_cam_ccbq; 207139952Sdwhite struct cam_devq *amr_cam_devq; 20858883Smsmith 20965245Smsmith /* control device */ 210130585Sphk struct cdev *amr_dev_t; 21165245Smsmith 21251974Smsmith /* controller type-specific support */ 21351974Smsmith int amr_type; 21465245Smsmith#define AMR_TYPE_QUARTZ (1<<0) 21565245Smsmith#define AMR_IS_QUARTZ(sc) ((sc)->amr_type & AMR_TYPE_QUARTZ) 21665245Smsmith#define AMR_TYPE_40LD (1<<1) 21765245Smsmith#define AMR_IS_40LD(sc) ((sc)->amr_type & AMR_TYPE_40LD) 21865245Smsmith int (* amr_submit_command)(struct amr_softc *sc); 21951974Smsmith int (* amr_get_work)(struct amr_softc *sc, struct amr_mailbox *mbsave); 220107756Semoore int (*amr_poll_command)(struct amr_command *ac); 221138422Sscottl int (*amr_poll_command1)(struct amr_softc *sc, struct amr_command *ac); 222107756Semoore int support_ext_cdb; /* greater than 10 byte cdb support */ 22365245Smsmith 22465245Smsmith /* misc glue */ 22565245Smsmith struct intr_config_hook amr_ich; /* wait-for-interrupts probe hook */ 22665245Smsmith struct callout_handle amr_timeout; /* periodic status check */ 227140340Sscottl struct mtx amr_io_lock; 22851974Smsmith}; 22951974Smsmith 23051974Smsmith/* 23165245Smsmith * Interface between bus connections and driver core. 23258883Smsmith */ 23365245Smsmithextern int amr_attach(struct amr_softc *sc); 23465245Smsmithextern void amr_free(struct amr_softc *sc); 23565245Smsmithextern int amr_flush(struct amr_softc *sc); 23665245Smsmithextern int amr_done(struct amr_softc *sc); 23765245Smsmithextern void amr_startio(struct amr_softc *sc); 23858883Smsmith 23958883Smsmith/* 24065245Smsmith * Command buffer allocation. 24151974Smsmith */ 24265245Smsmithextern struct amr_command *amr_alloccmd(struct amr_softc *sc); 24365245Smsmithextern void amr_releasecmd(struct amr_command *ac); 24451974Smsmith 24551974Smsmith/* 24665245Smsmith * CAM interface 24751974Smsmith */ 24865245Smsmithextern int amr_cam_attach(struct amr_softc *sc); 24965245Smsmithextern void amr_cam_detach(struct amr_softc *sc); 25065245Smsmithextern int amr_cam_command(struct amr_softc *sc, struct amr_command **acp); 25151974Smsmith 25251974Smsmith/* 25351974Smsmith * MegaRAID logical disk driver 25451974Smsmith */ 25551974Smsmithstruct amrd_softc 25651974Smsmith{ 25751974Smsmith device_t amrd_dev; 25851974Smsmith struct amr_softc *amrd_controller; 25951974Smsmith struct amr_logdrive *amrd_drive; 260125975Sphk struct disk *amrd_disk; 26151974Smsmith int amrd_unit; 26251974Smsmith}; 26351974Smsmith 26451974Smsmith/* 26551974Smsmith * Interface between driver core and disk driver (should be using a bus?) 26651974Smsmith */ 26765245Smsmithextern int amr_submit_bio(struct amr_softc *sc, struct bio *bio); 268120988Spsextern int amr_dump_blocks(struct amr_softc *sc, int unit, u_int32_t lba, void *data, int blks); 26951974Smsmithextern void amrd_intr(void *data); 27051974Smsmith 27165245Smsmith/******************************************************************************** 27265245Smsmith * Enqueue/dequeue functions 27365245Smsmith */ 27465245Smsmithstatic __inline void 27565245Smsmithamr_enqueue_bio(struct amr_softc *sc, struct bio *bio) 27665245Smsmith{ 27765245Smsmith int s; 27865245Smsmith 27965245Smsmith s = splbio(); 28065245Smsmith bioq_insert_tail(&sc->amr_bioq, bio); 28165245Smsmith splx(s); 28265245Smsmith} 28365245Smsmith 28465245Smsmithstatic __inline struct bio * 28565245Smsmithamr_dequeue_bio(struct amr_softc *sc) 28665245Smsmith{ 28765245Smsmith struct bio *bio; 28865245Smsmith int s; 28965245Smsmith 29065245Smsmith s = splbio(); 29165245Smsmith if ((bio = bioq_first(&sc->amr_bioq)) != NULL) 29265245Smsmith bioq_remove(&sc->amr_bioq, bio); 29365245Smsmith splx(s); 29465245Smsmith return(bio); 29565245Smsmith} 29665245Smsmith 29765245Smsmithstatic __inline void 29865245Smsmithamr_enqueue_ready(struct amr_command *ac) 29965245Smsmith{ 30065245Smsmith int s; 30165245Smsmith 30265245Smsmith s = splbio(); 30365245Smsmith TAILQ_INSERT_TAIL(&ac->ac_sc->amr_ready, ac, ac_link); 30465245Smsmith splx(s); 30565245Smsmith} 30665245Smsmith 30765245Smsmithstatic __inline void 30865245Smsmithamr_requeue_ready(struct amr_command *ac) 30965245Smsmith{ 31065245Smsmith int s; 31165245Smsmith 31265245Smsmith s = splbio(); 31365245Smsmith TAILQ_INSERT_HEAD(&ac->ac_sc->amr_ready, ac, ac_link); 31465245Smsmith splx(s); 31565245Smsmith} 31665245Smsmith 31765245Smsmithstatic __inline struct amr_command * 31865245Smsmithamr_dequeue_ready(struct amr_softc *sc) 31965245Smsmith{ 32065245Smsmith struct amr_command *ac; 32165245Smsmith int s; 32265245Smsmith 32365245Smsmith s = splbio(); 32465245Smsmith if ((ac = TAILQ_FIRST(&sc->amr_ready)) != NULL) 32565245Smsmith TAILQ_REMOVE(&sc->amr_ready, ac, ac_link); 32665245Smsmith splx(s); 32765245Smsmith return(ac); 32865245Smsmith} 32965245Smsmith 33065245Smsmithstatic __inline void 33165245Smsmithamr_enqueue_completed(struct amr_command *ac) 33265245Smsmith{ 33365245Smsmith int s; 33465245Smsmith 33565245Smsmith s = splbio(); 33665245Smsmith TAILQ_INSERT_TAIL(&ac->ac_sc->amr_completed, ac, ac_link); 33765245Smsmith splx(s); 33865245Smsmith} 33965245Smsmith 34065245Smsmithstatic __inline struct amr_command * 34165245Smsmithamr_dequeue_completed(struct amr_softc *sc) 34265245Smsmith{ 34365245Smsmith struct amr_command *ac; 34465245Smsmith int s; 34565245Smsmith 34665245Smsmith s = splbio(); 34765245Smsmith if ((ac = TAILQ_FIRST(&sc->amr_completed)) != NULL) 34865245Smsmith TAILQ_REMOVE(&sc->amr_completed, ac, ac_link); 34965245Smsmith splx(s); 35065245Smsmith return(ac); 35165245Smsmith} 35265245Smsmith 35365245Smsmithstatic __inline void 35465245Smsmithamr_enqueue_free(struct amr_command *ac) 35565245Smsmith{ 35665245Smsmith int s; 35765245Smsmith 35865245Smsmith s = splbio(); 35965245Smsmith TAILQ_INSERT_TAIL(&ac->ac_sc->amr_freecmds, ac, ac_link); 36065245Smsmith splx(s); 36165245Smsmith} 36265245Smsmith 36365245Smsmithstatic __inline struct amr_command * 36465245Smsmithamr_dequeue_free(struct amr_softc *sc) 36565245Smsmith{ 36665245Smsmith struct amr_command *ac; 36765245Smsmith int s; 36865245Smsmith 36965245Smsmith s = splbio(); 37065245Smsmith if ((ac = TAILQ_FIRST(&sc->amr_freecmds)) != NULL) 37165245Smsmith TAILQ_REMOVE(&sc->amr_freecmds, ac, ac_link); 37265245Smsmith splx(s); 37365245Smsmith return(ac); 37465245Smsmith} 375