1 /* $NetBSD: xyreg.h,v 1.6 2024/12/20 23:52:00 tsutsui Exp $ */ 2 3 /* 4 * Copyright (c) 1995 Charles D. Cranor 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /* 29 * x y r e g . h 30 * 31 * this file contains the description of the Xylogics 450/451's hardware 32 * data structures. 33 * 34 * author: Chuck Cranor <chuck@netbsd> 35 */ 36 37 #define XYC_MAXDEV 2 /* max devices per controller */ 38 #define XYC_CTLIOPB XYC_MAXDEV /* controller's iopb */ 39 #define XYC_RESETUSEC 1000000 /* max time for xyc reset (same as xdc?) */ 40 #define XYC_MAXIOPB (XYC_MAXDEV+1) 41 /* max number of iopbs that can be active */ 42 #define XYC_MAXTIME 4*1000000 /* four seconds before we give up and reset */ 43 #define XYC_MAXTRIES 4 /* max number of times to retry an operation */ 44 #define XYC_INTERLEAVE 1 /* interleave (from disk label?) */ 45 #define XYFM_BPS 0x200 /* must be 512! */ 46 47 /* 48 * xyc device interface 49 * (lives in VME address space) [note: bytes are swapped!] 50 */ 51 52 struct xyc { 53 volatile u_char xyc_reloc_hi; /* iopb relocation (low byte) */ 54 volatile u_char xyc_reloc_lo; /* iopb relocation (high byte) */ 55 volatile u_char xyc_addr_hi; /* iopb address (low byte) */ 56 volatile u_char xyc_addr_lo; /* iopb address (high byte) */ 57 volatile u_char xyc_rsetup; /* reset/update reg */ 58 volatile u_char xyc_csr; /* control and status register */ 59 }; 60 61 /* 62 * xyc_csr 63 */ 64 65 #define XYC_GBSY 0x80 /* go/busy */ 66 #define XYC_ERR 0x40 /* error */ 67 #define XYC_DERR 0x20 /* double error! */ 68 #define XYC_IPND 0x10 /* interrupt pending */ 69 #define XYC_ADRM 0x08 /* 24-bit addressing */ 70 #define XYC_AREQ 0x04 /* attention request */ 71 #define XYC_AACK 0x02 /* attention ack. */ 72 #define XYC_DRDY 0x01 /* drive ready */ 73 74 /* 75 * Input/Output Parameter Block (iopb) 76 * 77 * all controller commands are done via iopb's. to start a command you 78 * must do this: 79 * [1] allocate space in DVMA space for the iopb 80 * [2] fill out all the fields of the iopb 81 * [3] if the controller isn't busy, start the iopb by loading the address 82 * and reloc in the xyc's registers and setting the "go" bit [done] 83 * [4] controller busy: set AREQ bit, and wait for AACK bit. 84 * add iopb to the chain, and clear AREQ to resume I/O 85 * 86 * when the controller is done with a command it may interrupt (if you 87 * ask it to) and it will set the XYC_IPND bit in the csr. clear 88 * the interrupt by writing one to this bit. 89 * 90 * the format of the iopb is described in section 2.4 of the manual. 91 * note that it is byte-swapped on the sun. 92 */ 93 94 struct xy_iopb { 95 /* section 2.4.2: byte 1 */ 96 volatile u_char resv1:1; /* reserved */ 97 volatile u_char iei:1; /* interrupt on each IOPB done */ 98 volatile u_char ierr:1; /* interrupt on error (no effect on 450) */ 99 volatile u_char hdp:1; /* hold dual port drive */ 100 volatile u_char asr:1; /* autoseek retry */ 101 volatile u_char eef:1; /* enable extended fn. (overlap seek) */ 102 volatile u_char ecm:2; /* ECC correction mode */ 103 #define XY_ECM 2 /* use mode 2 (see section 2.4.2) */ 104 /* section 2.4.1: byte 0 */ 105 volatile u_char aud:1; /* auto-update iopb */ 106 volatile u_char relo:1; /* enable multibus relocation (>16bit addrs)*/ 107 volatile u_char chen:1; /* chain enable, "next iopb" is valid */ 108 volatile u_char ien:1; /* interrupt enable */ 109 volatile u_char com:4; /* command */ 110 #define XYCMD_NOP 0x0 /* no-op */ 111 #define XYCMD_WR 0x1 /* write */ 112 #define XYCMD_RD 0x2 /* read */ 113 #define XYCMD_WTH 0x3 /* write track headers */ 114 #define XYCMD_RTH 0x4 /* read track headers */ 115 #define XYCMD_SK 0x5 /* seek */ 116 #define XYCMD_RST 0x6 /* drive reset */ 117 #define XYCMD_WFM 0x7 /* write format */ 118 #define XYCMD_RDH 0x8 /* read header, data, and ECC */ 119 #define XYCMD_RDS 0x9 /* read drive status */ 120 #define XYCMD_WRH 0xa /* write header, data, and ECC */ 121 #define XYCMD_SDS 0xb /* set drive size */ 122 #define XYCMD_ST 0xc /* self test */ 123 #define XYCMD_R 0xd /* reserved */ 124 #define XYCMD_MBL 0xe /* maint. buffer load */ 125 #define XYCMD_MBD 0xf /* main. buffer dump */ 126 /* section 2.4.4: byte 3 */ 127 volatile u_char errno; /* error or completion code */ 128 /* section 2.4.3: byte 2 */ 129 volatile u_char errs:1; /* error summary bit */ 130 volatile u_char resv2:2; /* reserved */ 131 volatile u_char ctyp:3; /* controller type */ 132 #define XYCT_450 1 /* the 450 controller */ 133 volatile u_char resv3:1; /* reserved */ 134 volatile u_char done:1; /* done! */ 135 /* section 2.4.6: byte 5 */ 136 volatile u_char dt:2; /* drive type */ 137 #define XYC_MAXDT 3 /* largest drive type possible */ 138 volatile u_char resv4:4; /* reserved */ 139 volatile u_char unit:2; /* unit # */ 140 /* section 2.4.5: byte 4 */ 141 volatile u_char bw:1; /* byte(1)/word(0) xfer size */ 142 volatile u_char intlv:4; /* interleave factor (0=1:1, 1=2:1, etc.) */ 143 volatile u_char thro:3; /* DMA throttle (0=2,1=4,2=8, etc...) */ 144 #define XY_THRO 4 /* 4 == 32 DMA cycles */ 145 /* section 2.4.8: byte 7 */ 146 volatile u_char sect; /* sector # */ 147 /* section 2.4.7: byte 6 */ 148 volatile u_char head; /* head # */ 149 /* section 2.4.9: byte 8,9 */ 150 volatile u_short cyl; /* cyl # */ 151 /* section 2.4.10: byte a,b */ 152 volatile u_short scnt; /* sector count, also drive status */ 153 #define xy_dr_status scnt 154 #define XYS_ONCL 0x80 /* on-cylinder (active LOW) */ 155 #define XYS_DRDY 0x40 /* drive ready (active LOW) */ 156 #define XYS_WRPT 0x20 /* write protect */ 157 #define XYS_DPB 0x10 /* dual-port busy */ 158 #define XYS_SKER 0x08 /* hard seek error */ 159 #define XYS_DFLT 0x04 /* disk fault */ 160 /* section 2.4.11: byte c,d */ 161 volatile u_short dataa; /* data address */ 162 /* section 2.4.12: byte e,f */ 163 volatile u_short datar; /* data relocation pointer */ 164 /* section 2.4.14: byte 11 */ 165 volatile u_char subfn; /* sub-function */ 166 /* section 2.4.13: byte 10 */ 167 volatile u_char hoff; /* head offset for fixed/removable drives */ 168 /* section 2.4.15: byte 12,13 */ 169 volatile u_short nxtiopb; /* next iopb address (same relocation) */ 170 /* section 2.4.16: byte 14,15 */ 171 volatile u_short eccpat; /* ecc pattern */ 172 /* section 2.4.17: byte 16,17 */ 173 volatile u_short eccaddr; /* ecc address */ 174 }; 175 176 177 /* 178 * errors (section 2.4.4.1) 179 */ 180 181 /* software error codes */ 182 #define XY_ERR_FAIL 0xff /* general total failure */ 183 #define XY_ERR_DERR 0xfe /* double error */ 184 /* no error */ 185 #define XY_ERR_AOK 0x00 /* success */ 186 187 #define XY_ERR_IPEN 0x01 /* interrupt pending */ 188 #define XY_ERR_BCFL 0x03 /* busy conflict */ 189 #define XY_ERR_TIMO 0x04 /* operation timeout */ 190 #define XY_ERR_NHDR 0x05 /* header not found */ 191 #define XY_ERR_HARD 0x06 /* hard ECC error */ 192 #define XY_ERR_ICYL 0x07 /* illegal cylinder address */ 193 #define XY_ERR_ISEC 0x0a /* illegal sector address */ 194 #define XY_ERR_SMAL 0x0d /* last sector too small */ 195 #define XY_ERR_SACK 0x0e /* slave ACK error (non-existent memory) */ 196 #define XY_ERR_CHER 0x12 /* cylinder and head/header error */ 197 #define XY_ERR_SRTR 0x13 /* auto-seek retry successful */ 198 #define XY_ERR_WPRO 0x14 /* write-protect error */ 199 #define XY_ERR_UIMP 0x15 /* unimplemented command */ 200 #define XY_ERR_DNRY 0x16 /* drive not ready */ 201 #define XY_ERR_SZER 0x17 /* sector count zero */ 202 #define XY_ERR_DFLT 0x18 /* drive faulted */ 203 #define XY_ERR_ISSZ 0x19 /* illegal sector size */ 204 #define XY_ERR_SLTA 0x1a /* self test a */ 205 #define XY_ERR_SLTB 0x1b /* self test b */ 206 #define XY_ERR_SLTC 0x1c /* self test c */ 207 #define XY_ERR_SOFT 0x1e /* soft ECC error */ 208 #define XY_ERR_SFOK 0x1f /* soft ECC error recovered */ 209 #define XY_ERR_IHED 0x20 /* illegal head */ 210 #define XY_ERR_DSEQ 0x21 /* disk sequencer error */ 211 #define XY_ERR_SEEK 0x25 /* seek error */ 212 213 214 /* error actions */ 215 #define XY_ERA_PROG 0x10 /* program error: quit */ 216 #define XY_ERA_SOFT 0x30 /* soft error: we recovered */ 217 #define XY_ERA_HARD 0x40 /* hard error: retry */ 218 #define XY_ERA_RSET 0x60 /* hard error: reset, then retry */ 219 #define XY_ERA_WPRO 0x90 /* write protected */ 220 221 222