1 /* 2 * drivers/atm/suni.h - S/UNI PHY driver 3 */ 4 5 /* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */ 6 7 #ifndef DRIVER_ATM_SUNI_H 8 #define DRIVER_ATM_SUNI_H 9 10 #include <linux/atmdev.h> 11 #include <linux/atmioc.h> 12 #include <linux/sonet.h> 13 14 /* SUNI registers */ 15 16 #define SUNI_MRI 0x00 /* Master Reset and Identity / Load 17 Meter */ 18 #define SUNI_MC 0x01 /* Master Configuration */ 19 #define SUNI_MIS 0x02 /* Master Interrupt Status */ 20 /* no 0x03 */ 21 #define SUNI_MCM 0x04 /* Master Clock Monitor */ 22 #define SUNI_MCT 0x05 /* Master Control */ 23 #define SUNI_CSCS 0x06 /* Clock Synthesis Control and Status */ 24 #define SUNI_CRCS 0x07 /* Clock Recovery Control and Status */ 25 /* 0x08-0x0F reserved */ 26 #define SUNI_RSOP_CIE 0x10 /* RSOP Control/Interrupt Enable */ 27 #define SUNI_RSOP_SIS 0x11 /* RSOP Status/Interrupt Status */ 28 #define SUNI_RSOP_SBL 0x12 /* RSOP Section BIP-8 LSB */ 29 #define SUNI_RSOP_SBM 0x13 /* RSOP Section BIP-8 MSB */ 30 #define SUNI_TSOP_CTRL 0x14 /* TSOP Control */ 31 #define SUNI_TSOP_DIAG 0x15 /* TSOP Diagnostic */ 32 /* 0x16-0x17 reserved */ 33 #define SUNI_RLOP_CS 0x18 /* RLOP Control/Status */ 34 #define SUNI_RLOP_IES 0x19 /* RLOP Interrupt Enable/Status */ 35 #define SUNI_RLOP_LBL 0x1A /* RLOP Line BIP-8/24 LSB */ 36 #define SUNI_RLOP_LB 0x1B /* RLOP Line BIP-8/24 */ 37 #define SUNI_RLOP_LBM 0x1C /* RLOP Line BIP-8/24 MSB */ 38 #define SUNI_RLOP_LFL 0x1D /* RLOP Line FEBE LSB */ 39 #define SUNI_RLOP_LF 0x1E /* RLOP Line FEBE */ 40 #define SUNI_RLOP_LFM 0x1F /* RLOP Line FEBE MSB */ 41 #define SUNI_TLOP_CTRL 0x20 /* TLOP Control */ 42 #define SUNI_TLOP_DIAG 0x21 /* TLOP Diagnostic */ 43 /* 0x22-0x27 reserved */ 44 #define SUNI_SSTB_CTRL 0x28 45 #define SUNI_RPOP_SC 0x30 /* RPOP Status/Control */ 46 #define SUNI_RPOP_IS 0x31 /* RPOP Interrupt Status */ 47 /* 0x32 reserved */ 48 #define SUNI_RPOP_IE 0x33 /* RPOP Interrupt Enable */ 49 /* 0x34-0x36 reserved */ 50 #define SUNI_RPOP_PSL 0x37 /* RPOP Path Signal Label */ 51 #define SUNI_RPOP_PBL 0x38 /* RPOP Path BIP-8 LSB */ 52 #define SUNI_RPOP_PBM 0x39 /* RPOP Path BIP-8 MSB */ 53 #define SUNI_RPOP_PFL 0x3A /* RPOP Path FEBE LSB */ 54 #define SUNI_RPOP_PFM 0x3B /* RPOP Path FEBE MSB */ 55 /* 0x3C reserved */ 56 #define SUNI_RPOP_PBC 0x3D /* RPOP Path BIP-8 Configuration */ 57 #define SUNI_RPOP_RC 0x3D /* RPOP Ring Control (PM5355) */ 58 /* 0x3E-0x3F reserved */ 59 #define SUNI_TPOP_CD 0x40 /* TPOP Control/Diagnostic */ 60 #define SUNI_TPOP_PC 0x41 /* TPOP Pointer Control */ 61 /* 0x42-0x44 reserved */ 62 #define SUNI_TPOP_APL 0x45 /* TPOP Arbitrary Pointer LSB */ 63 #define SUNI_TPOP_APM 0x46 /* TPOP Arbitrary Pointer MSB */ 64 /* 0x47 reserved */ 65 #define SUNI_TPOP_PSL 0x48 /* TPOP Path Signal Label */ 66 #define SUNI_TPOP_PS 0x49 /* TPOP Path Status */ 67 /* 0x4A-0x4F reserved */ 68 #define SUNI_RACP_CS 0x50 /* RACP Control/Status */ 69 #define SUNI_RACP_IES 0x51 /* RACP Interrupt Enable/Status */ 70 #define SUNI_RACP_MHP 0x52 /* RACP Match Header Pattern */ 71 #define SUNI_RACP_MHM 0x53 /* RACP Match Header Mask */ 72 #define SUNI_RACP_CHEC 0x54 /* RACP Correctable HCS Error Count */ 73 #define SUNI_RACP_UHEC 0x55 /* RACP Uncorrectable HCS Err Count */ 74 #define SUNI_RACP_RCCL 0x56 /* RACP Receive Cell Counter LSB */ 75 #define SUNI_RACP_RCC 0x57 /* RACP Receive Cell Counter */ 76 #define SUNI_RACP_RCCM 0x58 /* RACP Receive Cell Counter MSB */ 77 #define SUNI_RACP_CFG 0x59 /* RACP Configuration */ 78 /* 0x5A-0x5F reserved */ 79 #define SUNI_TACP_CS 0x60 /* TACP Control/Status */ 80 #define SUNI_TACP_IUCHP 0x61 /* TACP Idle/Unassigned Cell Hdr Pat */ 81 #define SUNI_TACP_IUCPOP 0x62 /* TACP Idle/Unassigned Cell Payload 82 Octet Pattern */ 83 #define SUNI_TACP_FIFO 0x63 /* TACP FIFO Configuration */ 84 #define SUNI_TACP_TCCL 0x64 /* TACP Transmit Cell Counter LSB */ 85 #define SUNI_TACP_TCC 0x65 /* TACP Transmit Cell Counter */ 86 #define SUNI_TACP_TCCM 0x66 /* TACP Transmit Cell Counter MSB */ 87 #define SUNI_TACP_CFG 0x67 /* TACP Configuration */ 88 #define SUNI_SPTB_CTRL 0x68 /* SPTB Control */ 89 /* 0x69-0x7F reserved */ 90 #define SUNI_MT 0x80 /* Master Test */ 91 /* 0x81-0xFF reserved */ 92 93 /* SUNI register values */ 94 95 96 /* MRI is reg 0 */ 97 #define SUNI_MRI_ID 0x0f /* R, SUNI revision number */ 98 #define SUNI_MRI_ID_SHIFT 0 99 #define SUNI_MRI_TYPE 0x70 /* R, SUNI type (lite is 011) */ 100 #define SUNI_MRI_TYPE_SHIFT 4 101 #define SUNI_MRI_TYPE_PM5346 0x3 /* S/UNI 155 LITE */ 102 #define SUNI_MRI_TYPE_PM5347 0x4 /* S/UNI 155 PLUS */ 103 #define SUNI_MRI_TYPE_PM5350 0x7 /* S/UNI 155 ULTRA */ 104 #define SUNI_MRI_TYPE_PM5355 0x1 /* S/UNI 622 */ 105 #define SUNI_MRI_RESET 0x80 /* RW, reset & power down chip 106 0: normal operation 107 1: reset & low power */ 108 109 /* MCM is reg 0x4 */ 110 #define SUNI_MCM_LLE 0x20 /* line loopback (PM5355) */ 111 #define SUNI_MCM_DLE 0x10 /* diagnostic loopback (PM5355) */ 112 113 /* MCT is reg 5 */ 114 #define SUNI_MCT_LOOPT 0x01 /* RW, timing source, 0: from 115 TRCLK+/- */ 116 #define SUNI_MCT_DLE 0x02 /* RW, diagnostic loopback */ 117 #define SUNI_MCT_LLE 0x04 /* RW, line loopback */ 118 #define SUNI_MCT_FIXPTR 0x20 /* RW, disable transmit payload pointer 119 adjustments 120 0: payload ptr controlled by TPOP 121 ptr control reg 122 1: payload pointer fixed at 522 */ 123 #define SUNI_MCT_LCDV 0x40 /* R, loss of cell delineation */ 124 #define SUNI_MCT_LCDE 0x80 /* RW, loss of cell delineation 125 interrupt (1: on) */ 126 /* RSOP_CIE is reg 0x10 */ 127 #define SUNI_RSOP_CIE_OOFE 0x01 /* RW, enable interrupt on frame alarm 128 state change */ 129 #define SUNI_RSOP_CIE_LOFE 0x02 /* RW, enable interrupt on loss of 130 frame state change */ 131 #define SUNI_RSOP_CIE_LOSE 0x04 /* RW, enable interrupt on loss of 132 signal state change */ 133 #define SUNI_RSOP_CIE_BIPEE 0x08 /* RW, enable interrupt on section 134 BIP-8 error (B1) */ 135 #define SUNI_RSOP_CIE_FOOF 0x20 /* W, force RSOP out of frame at next 136 boundary */ 137 #define SUNI_RSOP_CIE_DDS 0x40 /* RW, disable scrambling */ 138 139 /* RSOP_SIS is reg 0x11 */ 140 #define SUNI_RSOP_SIS_OOFV 0x01 /* R, out of frame */ 141 #define SUNI_RSOP_SIS_LOFV 0x02 /* R, loss of frame */ 142 #define SUNI_RSOP_SIS_LOSV 0x04 /* R, loss of signal */ 143 #define SUNI_RSOP_SIS_OOFI 0x08 /* R, out of frame interrupt */ 144 #define SUNI_RSOP_SIS_LOFI 0x10 /* R, loss of frame interrupt */ 145 #define SUNI_RSOP_SIS_LOSI 0x20 /* R, loss of signal interrupt */ 146 #define SUNI_RSOP_SIS_BIPEI 0x40 /* R, section BIP-8 interrupt */ 147 148 /* TSOP_CTRL is reg 0x14 */ 149 #define SUNI_TSOP_CTRL_LAIS 0x01 /* insert alarm indication signal */ 150 #define SUNI_TSOP_CTRL_DS 0x40 /* disable scrambling */ 151 152 /* TSOP_DIAG is reg 0x15 */ 153 #define SUNI_TSOP_DIAG_DFP 0x01 /* insert single bit error cont. */ 154 #define SUNI_TSOP_DIAG_DBIP8 0x02 /* insert section BIP err (cont) */ 155 #define SUNI_TSOP_DIAG_DLOS 0x04 /* set line to zero (loss of signal) */ 156 157 /* TLOP_DIAG is reg 0x21 */ 158 #define SUNI_TLOP_DIAG_DBIP 0x01 /* insert line BIP err (continuously) */ 159 160 /* SSTB_CTRL is reg 0x28 */ 161 #define SUNI_SSTB_CTRL_LEN16 0x01 /* path trace message length bit */ 162 163 /* RPOP_RC is reg 0x3D (PM5355) */ 164 #define SUNI_RPOP_RC_ENSS 0x40 /* enable size bit */ 165 166 /* TPOP_DIAG is reg 0x40 */ 167 #define SUNI_TPOP_DIAG_PAIS 0x01 /* insert STS path alarm ind (cont) */ 168 #define SUNI_TPOP_DIAG_DB3 0x02 /* insert path BIP err (continuously) */ 169 170 /* TPOP_APM is reg 0x46 */ 171 #define SUNI_TPOP_APM_APTR 0x03 /* RW, arbitrary pointer, upper 2 172 bits */ 173 #define SUNI_TPOP_APM_APTR_SHIFT 0 174 #define SUNI_TPOP_APM_S 0x0c /* RW, "unused" bits of payload 175 pointer */ 176 #define SUNI_TPOP_APM_S_SHIFT 2 177 #define SUNI_TPOP_APM_NDF 0xf0 /* RW, NDF bits */ 178 #define SUNI_TPOP_APM_NDF_SHIFT 4 179 180 #define SUNI_TPOP_S_SONET 0 /* set S bits to 00 */ 181 #define SUNI_TPOP_S_SDH 2 /* set S bits to 10 */ 182 183 /* RACP_IES is reg 0x51 */ 184 #define SUNI_RACP_IES_FOVRI 0x02 /* R, FIFO overrun */ 185 #define SUNI_RACP_IES_UHCSI 0x04 /* R, uncorrectable HCS error */ 186 #define SUNI_RACP_IES_CHCSI 0x08 /* R, correctable HCS error */ 187 #define SUNI_RACP_IES_OOCDI 0x10 /* R, change of cell delineation 188 state */ 189 #define SUNI_RACP_IES_FIFOE 0x20 /* RW, enable FIFO overrun interrupt */ 190 #define SUNI_RACP_IES_HCSE 0x40 /* RW, enable HCS error interrupt */ 191 #define SUNI_RACP_IES_OOCDE 0x80 /* RW, enable cell delineation state 192 change interrupt */ 193 194 /* TACP_CS is reg 0x60 */ 195 #define SUNI_TACP_CS_FIFORST 0x01 /* RW, reset transmit FIFO (sticky) */ 196 #define SUNI_TACP_CS_DSCR 0x02 /* RW, disable payload scrambling */ 197 #define SUNI_TACP_CS_HCAADD 0x04 /* RW, add coset polynomial to HCS */ 198 #define SUNI_TACP_CS_DHCS 0x10 /* RW, insert HCS errors */ 199 #define SUNI_TACP_CS_FOVRI 0x20 /* R, FIFO overrun */ 200 #define SUNI_TACP_CS_TSOCI 0x40 /* R, TSOC input high */ 201 #define SUNI_TACP_CS_FIFOE 0x80 /* RW, enable FIFO overrun interrupt */ 202 203 /* TACP_IUCHP is reg 0x61 */ 204 #define SUNI_TACP_IUCHP_CLP 0x01 /* RW, 8th bit of 4th octet of i/u 205 pattern */ 206 #define SUNI_TACP_IUCHP_PTI 0x0e /* RW, 5th-7th bits of 4th octet of i/u 207 pattern */ 208 #define SUNI_TACP_IUCHP_PTI_SHIFT 1 209 #define SUNI_TACP_IUCHP_GFC 0xf0 /* RW, 1st-4th bits of 1st octet of i/u 210 pattern */ 211 #define SUNI_TACP_IUCHP_GFC_SHIFT 4 212 213 /* SPTB_CTRL is reg 0x68 */ 214 #define SUNI_SPTB_CTRL_LEN16 0x01 /* path trace message length */ 215 216 /* MT is reg 0x80 */ 217 #define SUNI_MT_HIZIO 0x01 /* RW, all but data bus & MP interface 218 tri-state */ 219 #define SUNI_MT_HIZDATA 0x02 /* W, also tri-state data bus */ 220 #define SUNI_MT_IOTST 0x04 /* RW, enable test mode */ 221 #define SUNI_MT_DBCTRL 0x08 /* W, control data bus by CSB pin */ 222 #define SUNI_MT_PMCTST 0x10 /* W, PMC test mode */ 223 #define SUNI_MT_DS27_53 0x80 /* RW, select between 8- or 16- bit */ 224 225 226 #define SUNI_IDLE_PATTERN 0x6a /* idle pattern */ 227 228 229 #ifdef __KERNEL__ 230 struct suni_priv { 231 struct k_sonet_stats sonet_stats; /* link diagnostics */ 232 int loop_mode; /* loopback mode */ 233 int type; /* phy type */ 234 struct atm_dev *dev; /* device back-pointer */ 235 struct suni_priv *next; /* next SUNI */ 236 }; 237 238 int suni_init(struct atm_dev *dev); 239 #endif 240 241 #endif 242