Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * drivers/atm/suni.h - S/UNI PHY driver
0004  */
0005  
0006 /* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */
0007 
0008 #ifndef DRIVER_ATM_SUNI_H
0009 #define DRIVER_ATM_SUNI_H
0010 
0011 #include <linux/atmdev.h>
0012 #include <linux/atmioc.h>
0013 #include <linux/sonet.h>
0014 
0015 /* SUNI registers */
0016 
0017 #define SUNI_MRI        0x00    /* Master Reset and Identity / Load
0018                        Meter */
0019 #define SUNI_MC         0x01    /* Master Configuration */
0020 #define SUNI_MIS        0x02    /* Master Interrupt Status */
0021               /* no 0x03 */
0022 #define SUNI_MCM        0x04    /* Master Clock Monitor */
0023 #define SUNI_MCT        0x05    /* Master Control */
0024 #define SUNI_CSCS       0x06    /* Clock Synthesis Control and Status */
0025 #define SUNI_CRCS       0x07    /* Clock Recovery Control and Status */
0026                  /* 0x08-0x0F reserved */
0027 #define SUNI_RSOP_CIE       0x10    /* RSOP Control/Interrupt Enable */
0028 #define SUNI_RSOP_SIS       0x11    /* RSOP Status/Interrupt Status */
0029 #define SUNI_RSOP_SBL       0x12    /* RSOP Section BIP-8 LSB */
0030 #define SUNI_RSOP_SBM       0x13    /* RSOP Section BIP-8 MSB */
0031 #define SUNI_TSOP_CTRL      0x14    /* TSOP Control */
0032 #define SUNI_TSOP_DIAG      0x15    /* TSOP Diagnostic */
0033                  /* 0x16-0x17 reserved */
0034 #define SUNI_RLOP_CS        0x18    /* RLOP Control/Status */
0035 #define SUNI_RLOP_IES       0x19    /* RLOP Interrupt Enable/Status */
0036 #define SUNI_RLOP_LBL       0x1A    /* RLOP Line BIP-8/24 LSB */
0037 #define SUNI_RLOP_LB        0x1B    /* RLOP Line BIP-8/24 */
0038 #define SUNI_RLOP_LBM       0x1C    /* RLOP Line BIP-8/24 MSB */
0039 #define SUNI_RLOP_LFL       0x1D    /* RLOP Line FEBE LSB */
0040 #define SUNI_RLOP_LF        0x1E    /* RLOP Line FEBE */
0041 #define SUNI_RLOP_LFM       0x1F    /* RLOP Line FEBE MSB */
0042 #define SUNI_TLOP_CTRL      0x20    /* TLOP Control */
0043 #define SUNI_TLOP_DIAG      0x21    /* TLOP Diagnostic */
0044                  /* 0x22-0x27 reserved */
0045 #define SUNI_SSTB_CTRL      0x28
0046 #define SUNI_RPOP_SC        0x30    /* RPOP Status/Control */
0047 #define SUNI_RPOP_IS        0x31    /* RPOP Interrupt Status */
0048                  /* 0x32 reserved */
0049 #define SUNI_RPOP_IE        0x33    /* RPOP Interrupt Enable */
0050                  /* 0x34-0x36 reserved */
0051 #define SUNI_RPOP_PSL       0x37    /* RPOP Path Signal Label */
0052 #define SUNI_RPOP_PBL       0x38    /* RPOP Path BIP-8 LSB */
0053 #define SUNI_RPOP_PBM       0x39    /* RPOP Path BIP-8 MSB */
0054 #define SUNI_RPOP_PFL       0x3A    /* RPOP Path FEBE LSB */
0055 #define SUNI_RPOP_PFM       0x3B    /* RPOP Path FEBE MSB */
0056                  /* 0x3C reserved */
0057 #define SUNI_RPOP_PBC       0x3D    /* RPOP Path BIP-8 Configuration */
0058 #define SUNI_RPOP_RC        0x3D    /* RPOP Ring Control (PM5355) */
0059                  /* 0x3E-0x3F reserved */
0060 #define SUNI_TPOP_CD        0x40    /* TPOP Control/Diagnostic */
0061 #define SUNI_TPOP_PC        0x41    /* TPOP Pointer Control */
0062                  /* 0x42-0x44 reserved */
0063 #define SUNI_TPOP_APL       0x45    /* TPOP Arbitrary Pointer LSB */
0064 #define SUNI_TPOP_APM       0x46    /* TPOP Arbitrary Pointer MSB */
0065                  /* 0x47 reserved */
0066 #define SUNI_TPOP_PSL       0x48    /* TPOP Path Signal Label */
0067 #define SUNI_TPOP_PS        0x49    /* TPOP Path Status */
0068                  /* 0x4A-0x4F reserved */
0069 #define SUNI_RACP_CS        0x50    /* RACP Control/Status */
0070 #define SUNI_RACP_IES       0x51    /* RACP Interrupt Enable/Status */
0071 #define SUNI_RACP_MHP       0x52    /* RACP Match Header Pattern */
0072 #define SUNI_RACP_MHM       0x53    /* RACP Match Header Mask */
0073 #define SUNI_RACP_CHEC      0x54    /* RACP Correctable HCS Error Count */
0074 #define SUNI_RACP_UHEC      0x55    /* RACP Uncorrectable HCS Err Count */
0075 #define SUNI_RACP_RCCL      0x56    /* RACP Receive Cell Counter LSB */
0076 #define SUNI_RACP_RCC       0x57    /* RACP Receive Cell Counter */
0077 #define SUNI_RACP_RCCM      0x58    /* RACP Receive Cell Counter MSB */
0078 #define SUNI_RACP_CFG       0x59    /* RACP Configuration */
0079                  /* 0x5A-0x5F reserved */
0080 #define SUNI_TACP_CS        0x60    /* TACP Control/Status */
0081 #define SUNI_TACP_IUCHP     0x61    /* TACP Idle/Unassigned Cell Hdr Pat */
0082 #define SUNI_TACP_IUCPOP    0x62    /* TACP Idle/Unassigned Cell Payload
0083                        Octet Pattern */
0084 #define SUNI_TACP_FIFO      0x63    /* TACP FIFO Configuration */
0085 #define SUNI_TACP_TCCL      0x64    /* TACP Transmit Cell Counter LSB */
0086 #define SUNI_TACP_TCC       0x65    /* TACP Transmit Cell Counter */
0087 #define SUNI_TACP_TCCM      0x66    /* TACP Transmit Cell Counter MSB */
0088 #define SUNI_TACP_CFG       0x67    /* TACP Configuration */
0089 #define SUNI_SPTB_CTRL      0x68    /* SPTB Control */
0090                  /* 0x69-0x7F reserved */
0091 #define SUNI_MT         0x80    /* Master Test */
0092                  /* 0x81-0xFF reserved */
0093 
0094 /* SUNI register values */
0095 
0096 
0097 /* MRI is reg 0 */
0098 #define SUNI_MRI_ID     0x0f    /* R, SUNI revision number */
0099 #define SUNI_MRI_ID_SHIFT   0
0100 #define SUNI_MRI_TYPE       0x70    /* R, SUNI type (lite is 011) */
0101 #define SUNI_MRI_TYPE_SHIFT     4
0102 #define SUNI_MRI_TYPE_PM5346    0x3 /* S/UNI 155 LITE */
0103 #define SUNI_MRI_TYPE_PM5347    0x4 /* S/UNI 155 PLUS */
0104 #define SUNI_MRI_TYPE_PM5350    0x7 /* S/UNI 155 ULTRA */
0105 #define SUNI_MRI_TYPE_PM5355    0x1 /* S/UNI 622 */
0106 #define SUNI_MRI_RESET      0x80    /* RW, reset & power down chip
0107                        0: normal operation
0108                        1: reset & low power */
0109 
0110 /* MCM is reg 0x4 */
0111 #define SUNI_MCM_LLE        0x20    /* line loopback (PM5355) */
0112 #define SUNI_MCM_DLE        0x10    /* diagnostic loopback (PM5355) */
0113 
0114 /* MCT is reg 5 */
0115 #define SUNI_MCT_LOOPT      0x01    /* RW, timing source, 0: from
0116                        TRCLK+/- */
0117 #define SUNI_MCT_DLE        0x02    /* RW, diagnostic loopback */
0118 #define SUNI_MCT_LLE        0x04    /* RW, line loopback */
0119 #define SUNI_MCT_FIXPTR     0x20    /* RW, disable transmit payload pointer
0120                        adjustments
0121                        0: payload ptr controlled by TPOP
0122                           ptr control reg
0123                        1: payload pointer fixed at 522 */
0124 #define SUNI_MCT_LCDV       0x40    /* R, loss of cell delineation */
0125 #define SUNI_MCT_LCDE       0x80    /* RW, loss of cell delineation
0126                        interrupt (1: on) */
0127 /* RSOP_CIE is reg 0x10 */
0128 #define SUNI_RSOP_CIE_OOFE  0x01    /* RW, enable interrupt on frame alarm
0129                        state change */
0130 #define SUNI_RSOP_CIE_LOFE  0x02    /* RW, enable interrupt on loss of
0131                        frame state change */
0132 #define SUNI_RSOP_CIE_LOSE  0x04    /* RW, enable interrupt on loss of
0133                        signal state change */
0134 #define SUNI_RSOP_CIE_BIPEE 0x08    /* RW, enable interrupt on section
0135                        BIP-8 error (B1) */
0136 #define SUNI_RSOP_CIE_FOOF  0x20    /* W, force RSOP out of frame at next
0137                        boundary */
0138 #define SUNI_RSOP_CIE_DDS   0x40    /* RW, disable scrambling */
0139 
0140 /* RSOP_SIS is reg 0x11 */
0141 #define SUNI_RSOP_SIS_OOFV  0x01    /* R, out of frame */
0142 #define SUNI_RSOP_SIS_LOFV  0x02    /* R, loss of frame */
0143 #define SUNI_RSOP_SIS_LOSV  0x04    /* R, loss of signal */
0144 #define SUNI_RSOP_SIS_OOFI  0x08    /* R, out of frame interrupt */
0145 #define SUNI_RSOP_SIS_LOFI  0x10    /* R, loss of frame interrupt */
0146 #define SUNI_RSOP_SIS_LOSI  0x20    /* R, loss of signal interrupt */
0147 #define SUNI_RSOP_SIS_BIPEI 0x40    /* R, section BIP-8 interrupt */
0148 
0149 /* TSOP_CTRL is reg 0x14 */
0150 #define SUNI_TSOP_CTRL_LAIS 0x01    /* insert alarm indication signal */
0151 #define SUNI_TSOP_CTRL_DS   0x40    /* disable scrambling */
0152 
0153 /* TSOP_DIAG is reg 0x15 */
0154 #define SUNI_TSOP_DIAG_DFP  0x01    /* insert single bit error cont. */
0155 #define SUNI_TSOP_DIAG_DBIP8    0x02    /* insert section BIP err (cont) */
0156 #define SUNI_TSOP_DIAG_DLOS 0x04    /* set line to zero (loss of signal) */
0157 
0158 /* TLOP_DIAG is reg 0x21 */
0159 #define SUNI_TLOP_DIAG_DBIP 0x01    /* insert line BIP err (continuously) */
0160 
0161 /* SSTB_CTRL is reg 0x28 */
0162 #define SUNI_SSTB_CTRL_LEN16    0x01    /* path trace message length bit */
0163 
0164 /* RPOP_RC is reg 0x3D (PM5355) */
0165 #define SUNI_RPOP_RC_ENSS   0x40    /* enable size bit */
0166 
0167 /* TPOP_DIAG is reg 0x40 */
0168 #define SUNI_TPOP_DIAG_PAIS 0x01    /* insert STS path alarm ind (cont) */
0169 #define SUNI_TPOP_DIAG_DB3  0x02    /* insert path BIP err (continuously) */
0170 
0171 /* TPOP_APM is reg 0x46 */
0172 #define SUNI_TPOP_APM_APTR  0x03    /* RW, arbitrary pointer, upper 2
0173                        bits */
0174 #define SUNI_TPOP_APM_APTR_SHIFT 0
0175 #define SUNI_TPOP_APM_S     0x0c    /* RW, "unused" bits of payload
0176                        pointer */
0177 #define SUNI_TPOP_APM_S_SHIFT   2
0178 #define SUNI_TPOP_APM_NDF   0xf0     /* RW, NDF bits */
0179 #define SUNI_TPOP_APM_NDF_SHIFT 4
0180 
0181 #define SUNI_TPOP_S_SONET   0   /* set S bits to 00 */
0182 #define SUNI_TPOP_S_SDH     2   /* set S bits to 10 */
0183 
0184 /* RACP_IES is reg 0x51 */
0185 #define SUNI_RACP_IES_FOVRI 0x02    /* R, FIFO overrun */
0186 #define SUNI_RACP_IES_UHCSI 0x04    /* R, uncorrectable HCS error */
0187 #define SUNI_RACP_IES_CHCSI 0x08    /* R, correctable HCS error */
0188 #define SUNI_RACP_IES_OOCDI 0x10    /* R, change of cell delineation
0189                        state */
0190 #define SUNI_RACP_IES_FIFOE 0x20    /* RW, enable FIFO overrun interrupt */
0191 #define SUNI_RACP_IES_HCSE  0x40    /* RW, enable HCS error interrupt */
0192 #define SUNI_RACP_IES_OOCDE 0x80    /* RW, enable cell delineation state
0193                        change interrupt */
0194 
0195 /* TACP_CS is reg 0x60 */
0196 #define SUNI_TACP_CS_FIFORST    0x01    /* RW, reset transmit FIFO (sticky) */
0197 #define SUNI_TACP_CS_DSCR   0x02    /* RW, disable payload scrambling */
0198 #define SUNI_TACP_CS_HCAADD 0x04    /* RW, add coset polynomial to HCS */
0199 #define SUNI_TACP_CS_DHCS   0x10    /* RW, insert HCS errors */
0200 #define SUNI_TACP_CS_FOVRI  0x20    /* R, FIFO overrun */
0201 #define SUNI_TACP_CS_TSOCI  0x40    /* R, TSOC input high */
0202 #define SUNI_TACP_CS_FIFOE  0x80    /* RW, enable FIFO overrun interrupt */
0203 
0204 /* TACP_IUCHP is reg 0x61 */
0205 #define SUNI_TACP_IUCHP_CLP 0x01    /* RW, 8th bit of 4th octet of i/u
0206                        pattern */
0207 #define SUNI_TACP_IUCHP_PTI 0x0e    /* RW, 5th-7th bits of 4th octet of i/u
0208                        pattern */
0209 #define SUNI_TACP_IUCHP_PTI_SHIFT 1
0210 #define SUNI_TACP_IUCHP_GFC 0xf0    /* RW, 1st-4th bits of 1st octet of i/u
0211                        pattern */
0212 #define SUNI_TACP_IUCHP_GFC_SHIFT 4
0213 
0214 /* SPTB_CTRL is reg 0x68 */
0215 #define SUNI_SPTB_CTRL_LEN16    0x01    /* path trace message length */
0216 
0217 /* MT is reg 0x80 */
0218 #define SUNI_MT_HIZIO       0x01    /* RW, all but data bus & MP interface
0219                        tri-state */
0220 #define SUNI_MT_HIZDATA     0x02    /* W, also tri-state data bus */
0221 #define SUNI_MT_IOTST       0x04    /* RW, enable test mode */
0222 #define SUNI_MT_DBCTRL      0x08    /* W, control data bus by CSB pin */
0223 #define SUNI_MT_PMCTST      0x10    /* W, PMC test mode */
0224 #define SUNI_MT_DS27_53     0x80    /* RW, select between 8- or 16- bit */
0225 
0226 
0227 #define SUNI_IDLE_PATTERN       0x6a    /* idle pattern */
0228 
0229 
0230 #ifdef __KERNEL__
0231 struct suni_priv {
0232     struct k_sonet_stats sonet_stats;   /* link diagnostics */
0233     int loop_mode;              /* loopback mode */
0234     int type;               /* phy type */
0235     struct atm_dev *dev;            /* device back-pointer */
0236     struct suni_priv *next;         /* next SUNI */
0237 };
0238 
0239 int suni_init(struct atm_dev *dev);
0240 #endif
0241 
0242 #endif