1/* SPDX-License-Identifier: GPL-2.0 */
2/* drivers/atm/uPD98402.h - NEC uPD98402 (PHY) declarations */
3
4/* Written 1995 by Werner Almesberger, EPFL LRC */
5
6
7#ifndef DRIVERS_ATM_uPD98402_H
8#define DRIVERS_ATM_uPD98402_H
9
10/*
11 * Registers
12 */
13
14#define uPD98402_CMR 0x00 /* Command Register */
15#define uPD98402_MDR 0x01 /* Mode Register */
16#define uPD98402_PICR 0x02 /* PHY Interrupt Cause Register */
17#define uPD98402_PIMR 0x03 /* PHY Interrupt Mask Register */
18#define uPD98402_ACR 0x04 /* Alarm Cause Register */
19#define uPD98402_ACMR 0x05 /* Alarm Cause Mask Register */
20#define uPD98402_PCR 0x06 /* Performance Cause Register */
21#define uPD98402_PCMR 0x07 /* Performance Cause Mask Register */
22#define uPD98402_IACM 0x08 /* Internal Alarm Cause Mask Register */
23#define uPD98402_B1ECT 0x09 /* B1 Error Count Register */
24#define uPD98402_B2ECT 0x0a /* B2 Error Count Register */
25#define uPD98402_B3ECT 0x0b /* B3 Error Count Regster */
26#define uPD98402_PFECB 0x0c /* Path FEBE Count Register */
27#define uPD98402_LECCT 0x0d /* Line FEBE Count Register */
28#define uPD98402_HECCT 0x0e /* HEC Error Count Register */
29#define uPD98402_FJCT 0x0f /* Frequence Justification Count Reg */
30#define uPD98402_PCOCR 0x10 /* Perf. Counter Overflow Cause Reg */
31#define uPD98402_PCOMR 0x11 /* Perf. Counter Overflow Mask Reg */
32#define uPD98402_C11T 0x20 /* C11T Data Register */
33#define uPD98402_C12T 0x21 /* C12T Data Register */
34#define uPD98402_C13T 0x22 /* C13T Data Register */
35#define uPD98402_F1T 0x23 /* F1T Data Register */
36#define uPD98402_K2T 0x25 /* K2T Data Register */
37#define uPD98402_C2T 0x26 /* C2T Data Register */
38#define uPD98402_F2T 0x27 /* F2T Data Register */
39#define uPD98402_C11R 0x30 /* C11T Data Register */
40#define uPD98402_C12R 0x31 /* C12T Data Register */
41#define uPD98402_C13R 0x32 /* C13T Data Register */
42#define uPD98402_F1R 0x33 /* F1T Data Register */
43#define uPD98402_K2R 0x35 /* K2T Data Register */
44#define uPD98402_C2R 0x36 /* C2T Data Register */
45#define uPD98402_F2R 0x37 /* F2T Data Register */
46
47/* CMR is at 0x00 */
48#define uPD98402_CMR_PFRF 0x01 /* Send path FERF */
49#define uPD98402_CMR_LFRF 0x02 /* Send line FERF */
50#define uPD98402_CMR_PAIS 0x04 /* Send path AIS */
51#define uPD98402_CMR_LAIS 0x08 /* Send line AIS */
52
53/* MDR is at 0x01 */
54#define uPD98402_MDR_ALP 0x01 /* ATM layer loopback */
55#define uPD98402_MDR_TPLP 0x02 /* PMD loopback, to host */
56#define uPD98402_MDR_RPLP 0x04 /* PMD loopback, to network */
57#define uPD98402_MDR_SS0 0x08 /* SS0 */
58#define uPD98402_MDR_SS1 0x10 /* SS1 */
59#define uPD98402_MDR_SS_MASK 0x18 /* mask */
60#define uPD98402_MDR_SS_SHIFT 3 /* shift */
61#define uPD98402_MDR_HEC 0x20 /* disable HEC inbound processing */
62#define uPD98402_MDR_FSR 0x40 /* disable frame scrambler */
63#define uPD98402_MDR_CSR 0x80 /* disable cell scrambler */
64
65/* PICR is at 0x02, PIMR is at 0x03 */
66#define uPD98402_INT_PFM 0x01 /* performance counter has changed */
67#define uPD98402_INT_ALM 0x02 /* line fault */
68#define uPD98402_INT_RFO 0x04 /* receive FIFO overflow */
69#define uPD98402_INT_PCO 0x08 /* performance counter overflow */
70#define uPD98402_INT_OTD 0x20 /* OTD has occurred */
71#define uPD98402_INT_LOS 0x40 /* Loss Of Signal */
72#define uPD98402_INT_LOF 0x80 /* Loss Of Frame */
73
74/* ACR is as 0x04, ACMR is at 0x05 */
75#define uPD98402_ALM_PFRF 0x01 /* path FERF */
76#define uPD98402_ALM_LFRF 0x02 /* line FERF */
77#define uPD98402_ALM_PAIS 0x04 /* path AIS */
78#define uPD98402_ALM_LAIS 0x08 /* line AIS */
79#define uPD98402_ALM_LOD 0x10 /* loss of delineation */
80#define uPD98402_ALM_LOP 0x20 /* loss of pointer */
81#define uPD98402_ALM_OOF 0x40 /* out of frame */
82
83/* PCR is at 0x06, PCMR is at 0x07 */
84#define uPD98402_PFM_PFEB 0x01 /* path FEBE */
85#define uPD98402_PFM_LFEB 0x02 /* line FEBE */
86#define uPD98402_PFM_B3E 0x04 /* B3 error */
87#define uPD98402_PFM_B2E 0x08 /* B2 error */
88#define uPD98402_PFM_B1E 0x10 /* B1 error */
89#define uPD98402_PFM_FJ 0x20 /* frequency justification */
90
91/* IACM is at 0x08 */
92#define uPD98402_IACM_PFRF 0x01 /* don't generate path FERF */
93#define uPD98402_IACM_LFRF 0x02 /* don't generate line FERF */
94
95/* PCOCR is at 0x010, PCOMR is at 0x11 */
96#define uPD98402_PCO_B1EC 0x01 /* B1ECT overflow */
97#define uPD98402_PCO_B2EC 0x02 /* B2ECT overflow */
98#define uPD98402_PCO_B3EC 0x04 /* B3ECT overflow */
99#define uPD98402_PCO_PFBC 0x08 /* PFEBC overflow */
100#define uPD98402_PCO_LFBC 0x10 /* LFEVC overflow */
101#define uPD98402_PCO_HECC 0x20 /* HECCT overflow */
102#define uPD98402_PCO_FJC 0x40 /* FJCT overflow */
103
104
105int uPD98402_init(struct atm_dev *dev);
106
107#endif
108