Home | History | Annotate | Line # | Download | only in ic
esiopvar.h revision 1.12 
      1 /*	$NetBSD: esiopvar.h,v 1.12 2005/02/27 00:27:01 perry Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2002 Manuel Bouyer.
      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  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *	This product includes software developed by Manuel Bouyer.
     17  * 4. The name of the author may not be used to endorse or promote products
     18  *    derived from this software without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  *
     31  */
     32 
     33 /* structure and definitions for the siop driver */
     34 
     35 /* Number of tag */
     36 #define ESIOP_NTAG 256
     37 
     38 /*
     39  * description of a command scheduler slot. The script uses a ring of
     40  * A_ncmd_slots of this.
     41  */
     42 struct esiop_slot {
     43 	u_int32_t dsa; /* DSA of the xfer. The first 2 bits holds flags */
     44 } __attribute__((__packed__));
     45 
     46 #define CMD_SLOTSIZE (sizeof(struct esiop_slot) / sizeof(u_int32_t))
     47 
     48 /*
     49  * xfer description of the script: tables and reselect script
     50  * In struct siop_common_cmd siop_xfer will point to this.
     51  * If you change this don't forget to update o_cmd_* and cmd_slot_size in script
     52  */
     53 struct esiop_xfer {
     54 	struct siop_common_xfer siop_tables;
     55 	u_int32_t tlq; /* target/lun/tag loaded in scratchC by script */
     56 		      /* will also containt scratcha at end of command */
     57 } __attribute__((__packed__));
     58 
     59 /*
     60  * This describes a command handled by the SCSI controller
     61  * These are chained in either a free list or a active list
     62  * We have one queue per target
     63  */
     64 
     65 struct esiop_cmd {
     66 	TAILQ_ENTRY (esiop_cmd) next;
     67 	struct siop_common_cmd cmd_c;
     68 	struct esiop_cbd *esiop_cbdp; /* pointer to our siop_cbd */
     69 };
     70 #define cmd_tables cmd_c.siop_tables
     71 
     72 /* command block descriptors: an array of siop_cmd + an array of siop_xfer */
     73 struct esiop_cbd {
     74 	TAILQ_ENTRY (esiop_cbd) next;
     75 	struct esiop_cmd *cmds;
     76 	struct esiop_xfer *xfers;
     77 	bus_dmamap_t xferdma; /* DMA map for this block of xfers */
     78 };
     79 
     80 TAILQ_HEAD(cmd_list, esiop_cmd);
     81 TAILQ_HEAD(cbd_list, esiop_cbd);
     82 
     83 /* DSA table descriptor for tags. Free tables are in a list */
     84 struct esiop_dsatbl {
     85 	TAILQ_ENTRY (esiop_dsatbl) next;
     86 	u_int32_t *tbl; /* the table itself */
     87 	u_int32_t tbl_dsa; /* DSA of base of this table */
     88 	bus_addr_t tbl_offset; /* offset of this table in the map */
     89 	struct esiop_dsatblblk *tblblk; /* pointer back to our block */
     90 };
     91 
     92 /* DSA table block descriptor. */
     93 struct esiop_dsatblblk {
     94 	TAILQ_ENTRY (esiop_dsatblblk) next;
     95 	bus_dmamap_t blkmap; /* DMA map of this block */
     96 };
     97 
     98 TAILQ_HEAD(tbl_list, esiop_dsatbl);
     99 TAILQ_HEAD(tblblk_list, esiop_dsatblblk);
    100 
    101 /* Number of table per block */
    102 #define ESIOP_NTPB ((PAGE_SIZE) / (sizeof(u_int32_t) * ESIOP_NTAG))
    103 
    104 /* per lun struct */
    105 struct esiop_lun {
    106 	struct esiop_cmd *active; /* active non-tagged command */
    107 	struct esiop_cmd *tactive[ESIOP_NTAG]; /* active tagged commands */
    108 	int lun_flags; /* per-lun flags */
    109 	struct esiop_dsatbl *lun_tagtbl; /* the tag DSA table */
    110 };
    111 
    112 /*
    113  * per target struct; siop_common_cmd->target and siop_common_softc->targets[]
    114  * will point to this
    115  */
    116 struct esiop_target {
    117 	struct siop_common_target target_c;
    118 	struct esiop_lun *esiop_lun[8]; /* per-lun state */
    119 	u_int32_t lun_table_offset; /* pointer to our DSA table */
    120 };
    121 
    122 static __inline__ void esiop_table_sync(struct esiop_cmd *, int);
    123 static __inline__ void
    124 esiop_table_sync(esiop_cmd, ops)
    125 	struct esiop_cmd *esiop_cmd;
    126 	int ops;
    127 {
    128 	struct siop_common_softc *sc  = esiop_cmd->cmd_c.siop_sc;
    129 	bus_addr_t offset;
    130 
    131 	offset = esiop_cmd->cmd_c.dsa -
    132 	    esiop_cmd->esiop_cbdp->xferdma->dm_segs[0].ds_addr;
    133 	bus_dmamap_sync(sc->sc_dmat, esiop_cmd->esiop_cbdp->xferdma, offset,
    134 	    sizeof(struct esiop_xfer), ops);
    135 }
    136 
    137 
    138 
    139 /* Driver internal state */
    140 struct esiop_softc {
    141 	struct siop_common_softc sc_c;
    142 	u_int32_t sc_semoffset;		/* semaphore */
    143 	u_int32_t sc_shedoffset;	/* base of scheduler ring */
    144 	int sc_currschedslot;		/* current scheduler slot */
    145 	struct cbd_list cmds;		/* list of command block descriptors */
    146 	struct cmd_list free_list;	/* cmd descr free list */
    147 	struct tbl_list free_tagtbl;	/* list of free tag DSA tables */
    148 	struct tblblk_list tag_tblblk;	/* tag DSA table blocks */
    149 	u_int32_t sc_flags;
    150 	u_int32_t sc_free_offset;	/* pointer to free RAM */
    151 	u_int32_t sc_target_table_offset;/* pointer to target DSA table */
    152 	int sc_currdoneslot;		/* current done slot */
    153 	bus_dmamap_t sc_done_map;	/* dma map for done ring (shared) */
    154 	bus_addr_t sc_done_offset; 	/* offset of ring in sc_done_map */
    155 	u_int32_t *sc_done_slot;	/* The done ring itself */
    156 };
    157 
    158 /* defs for sc_flags */
    159 #define SCF_CHAN_NOSLOT	0x0001		/* channel out of scheduler slot */
    160 #define SCF_CHAN_ADAPTREQ 0x0002	/* esiop_scsipi_request() is running */
    161 
    162 void    esiop_attach(struct esiop_softc *);
    163 int	esiop_intr(void *);
    164 void	esiop_add_dev(struct esiop_softc *, int, int);
    165 void	esiop_del_dev(struct esiop_softc *, int, int);
    166