suni.h 9.8 KB

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