1 /* $NetBSD: siopvar_common.h,v 1.21 2002/05/04 18:43:22 bouyer Exp $ */ 2 3 /* 4 * Copyright (c) 2000 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 #include "opt_siop.h" 34 35 /* common struct and routines used by siop and esiop */ 36 37 #ifndef SIOP_DEFAULT_TARGET 38 #define SIOP_DEFAULT_TARGET 7 39 #endif 40 41 /* tables used by SCRIPT */ 42 typedef struct scr_table { 43 u_int32_t count; 44 u_int32_t addr; 45 } scr_table_t __attribute__((__packed__)); 46 47 /* Number of scatter/gather entries */ 48 #define SIOP_NSG (MAXPHYS/NBPG + 1) /* XXX NBPG */ 49 50 /* 51 * This structure interfaces the SCRIPT with the driver; it describes a full 52 * transfer. 53 * If you change something here, don't forget to update offsets in {s,es}iop.ss 54 */ 55 struct siop_common_xfer { 56 u_int8_t msg_out[16]; /* 0 */ 57 u_int8_t msg_in[16]; /* 16 */ 58 u_int32_t status; /* 32 */ 59 u_int32_t pad1; /* 36 */ 60 u_int32_t id; /* 40 */ 61 u_int32_t pad2; /* 44 */ 62 scr_table_t t_msgin; /* 48 */ 63 scr_table_t t_extmsgin; /* 56 */ 64 scr_table_t t_extmsgdata; /* 64 */ 65 scr_table_t t_msgout; /* 72 */ 66 scr_table_t cmd; /* 80 */ 67 scr_table_t t_status; /* 88 */ 68 scr_table_t data[SIOP_NSG]; /* 96 */ 69 } __attribute__((__packed__)); 70 71 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 72 73 /* status can hold the SCSI_* status values, and 2 additionnal values: */ 74 #define SCSI_SIOP_NOCHECK 0xfe /* don't check the scsi status */ 75 #define SCSI_SIOP_NOSTATUS 0xff /* device didn't report status */ 76 77 /* 78 * This decribes a command handled by the SCSI controller 79 */ 80 struct siop_common_cmd { 81 struct siop_common_softc *siop_sc; /* points back to our adapter */ 82 struct siop_common_target *siop_target; /* pointer to our target def */ 83 struct scsipi_xfer *xs; /* xfer from the upper level */ 84 struct siop_common_xfer *siop_tables; /* tables for this cmd */ 85 bus_addr_t dsa; /* DSA value to load */ 86 bus_dmamap_t dmamap_cmd; 87 bus_dmamap_t dmamap_data; 88 int status; 89 int flags; 90 int tag; /* tag used for tagged command queuing */ 91 }; 92 93 /* status defs */ 94 #define CMDST_FREE 0 /* cmd slot is free */ 95 #define CMDST_READY 1 /* cmd slot is waiting for processing */ 96 #define CMDST_ACTIVE 2 /* cmd slot is being processed */ 97 #define CMDST_DONE 3 /* cmd slot has been processed */ 98 /* flags defs */ 99 #define CMDFL_TIMEOUT 0x0001 /* cmd timed out */ 100 #define CMDFL_TAG 0x0002 /* tagged cmd */ 101 102 /* per-target struct */ 103 struct siop_common_target { 104 int status; /* target status, see below */ 105 int flags; /* target flags, see below */ 106 u_int32_t id; /* for SELECT FROM */ 107 int period; 108 int offset; 109 }; 110 111 /* target status */ 112 #define TARST_PROBING 0 /* target is being probed */ 113 #define TARST_ASYNC 1 /* target needs sync/wide negotiation */ 114 #define TARST_WIDE_NEG 2 /* target is doing wide negotiation */ 115 #define TARST_SYNC_NEG 3 /* target is doing sync negotiation */ 116 #define TARST_PPR_NEG 4 /* target is doing sync negotiation */ 117 #define TARST_OK 5 /* sync/wide agreement is valid */ 118 119 /* target flags */ 120 #define TARF_SYNC 0x01 /* target can do sync */ 121 #define TARF_WIDE 0x02 /* target can do wide */ 122 #define TARF_TAG 0x04 /* target can do tags */ 123 #define TARF_DT 0x08 /* target can do DT clocking */ 124 #define TARF_ISWIDE 0x10 /* target is wide */ 125 #define TARF_ISDT 0x20 /* target is doing DT clocking */ 126 127 /* Driver internal state */ 128 struct siop_common_softc { 129 struct device sc_dev; 130 struct scsipi_channel sc_chan; 131 struct scsipi_adapter sc_adapt; 132 int features; /* chip's features */ 133 int ram_size; 134 int maxburst; 135 int maxoff; 136 int clock_div; /* async. clock divider (scntl3) */ 137 int clock_period; /* clock period (ns * 10) */ 138 int st_minsync; /* min and max sync period, */ 139 int dt_minsync; 140 int st_maxsync; /* as sent in or PPR messages */ 141 int dt_maxsync; 142 int mode; /* current SE/LVD/HVD mode */ 143 bus_space_tag_t sc_rt; /* bus_space registers tag */ 144 bus_space_handle_t sc_rh; /* bus_space registers handle */ 145 bus_addr_t sc_raddr; /* register adresses */ 146 bus_space_tag_t sc_ramt; /* bus_space ram tag */ 147 bus_space_handle_t sc_ramh; /* bus_space ram handle */ 148 bus_dma_tag_t sc_dmat; /* bus DMA tag */ 149 void (*sc_reset) __P((struct siop_common_softc*)); /* reset callback */ 150 bus_dmamap_t sc_scriptdma; /* DMA map for script */ 151 bus_addr_t sc_scriptaddr; /* on-board ram or physical adress */ 152 u_int32_t *sc_script; /* script location in memory */ 153 struct siop_common_target *targets[16]; /* per-target states */ 154 }; 155 156 /* features */ 157 #define SF_BUS_WIDE 0x00000001 /* wide bus */ 158 #define SF_BUS_ULTRA 0x00000002 /* Ultra (20Mhz) bus */ 159 #define SF_BUS_ULTRA2 0x00000004 /* Ultra2 (40Mhz) bus */ 160 #define SF_BUS_ULTRA3 0x00000008 /* Ultra3 (80Mhz) bus */ 161 #define SF_BUS_DIFF 0x00000010 /* differential bus */ 162 163 #define SF_CHIP_LED0 0x00000100 /* led on GPIO0 */ 164 #define SF_CHIP_LEDC 0x00000200 /* led on GPIO0 with hardware control */ 165 #define SF_CHIP_DBLR 0x00000400 /* clock doubler or quadrupler */ 166 #define SF_CHIP_QUAD 0x00000800 /* clock quadrupler, with PPL */ 167 #define SF_CHIP_FIFO 0x00001000 /* large fifo */ 168 #define SF_CHIP_PF 0x00002000 /* Intructions prefetch */ 169 #define SF_CHIP_RAM 0x00004000 /* on-board RAM */ 170 #define SF_CHIP_LS 0x00008000 /* load/store instruction */ 171 #define SF_CHIP_10REGS 0x00010000 /* 10 scratch registers */ 172 #define SF_CHIP_DFBC 0x00020000 /* Use DFBC register */ 173 #define SF_CHIP_DT 0x00040000 /* DT clocking */ 174 #define SF_CHIP_GEBUG 0x00080000 /* SCSI gross error bug */ 175 176 #define SF_PCI_RL 0x01000000 /* PCI read line */ 177 #define SF_PCI_RM 0x02000000 /* PCI read multiple */ 178 #define SF_PCI_BOF 0x04000000 /* PCI burst opcode fetch */ 179 #define SF_PCI_CLS 0x08000000 /* PCI cache line size */ 180 #define SF_PCI_WRI 0x10000000 /* PCI write and invalidate */ 181 182 int siop_common_attach __P((struct siop_common_softc *)); 183 void siop_common_reset __P((struct siop_common_softc *)); 184 void siop_setuptables __P((struct siop_common_cmd *)); 185 int siop_modechange __P((struct siop_common_softc *)); 186 187 int siop_wdtr_neg __P((struct siop_common_cmd *)); 188 int siop_sdtr_neg __P((struct siop_common_cmd *)); 189 int siop_ppr_neg __P((struct siop_common_cmd *)); 190 void siop_sdtr_msg __P((struct siop_common_cmd *, int, int, int)); 191 void siop_wdtr_msg __P((struct siop_common_cmd *, int, int)); 192 void siop_ppr_msg __P((struct siop_common_cmd *, int, int, int)); 193 void siop_update_xfer_mode __P((struct siop_common_softc *, int)); 194 /* actions to take at return of siop_wdtr_neg() and siop_sdtr_neg() */ 195 #define SIOP_NEG_NOP 0x0 196 #define SIOP_NEG_MSGOUT 0x1 197 #define SIOP_NEG_ACK 0x2 198 199 void siop_minphys __P((struct buf *)); 200 int siop_ioctl __P((struct scsipi_channel *, u_long, 201 caddr_t, int, struct proc *)); 202 void siop_sdp __P((struct siop_common_cmd *)); 203 void siop_clearfifo __P((struct siop_common_softc *)); 204 void siop_resetbus __P((struct siop_common_softc *)); 205