xref: /OK3568_Linux_fs/kernel/drivers/atm/uPD98402.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /* drivers/atm/uPD98402.c - NEC uPD98402 (PHY) declarations */
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun /* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/module.h>
8*4882a593Smuzhiyun #include <linux/mm.h>
9*4882a593Smuzhiyun #include <linux/errno.h>
10*4882a593Smuzhiyun #include <linux/atmdev.h>
11*4882a593Smuzhiyun #include <linux/sonet.h>
12*4882a593Smuzhiyun #include <linux/init.h>
13*4882a593Smuzhiyun #include <linux/slab.h>
14*4882a593Smuzhiyun #include <linux/uaccess.h>
15*4882a593Smuzhiyun #include <linux/atomic.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #include "uPD98402.h"
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #if 0
21*4882a593Smuzhiyun #define DPRINTK(format,args...) printk(KERN_DEBUG format,##args)
22*4882a593Smuzhiyun #else
23*4882a593Smuzhiyun #define DPRINTK(format,args...)
24*4882a593Smuzhiyun #endif
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun struct uPD98402_priv {
28*4882a593Smuzhiyun 	struct k_sonet_stats sonet_stats;/* link diagnostics */
29*4882a593Smuzhiyun 	unsigned char framing;		/* SONET/SDH framing */
30*4882a593Smuzhiyun 	int loop_mode;			/* loopback mode */
31*4882a593Smuzhiyun 	spinlock_t lock;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define PRIV(dev) ((struct uPD98402_priv *) dev->phy_data)
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun #define PUT(val,reg) dev->ops->phy_put(dev,val,uPD98402_##reg)
38*4882a593Smuzhiyun #define GET(reg) dev->ops->phy_get(dev,uPD98402_##reg)
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 
fetch_stats(struct atm_dev * dev,struct sonet_stats __user * arg,int zero)41*4882a593Smuzhiyun static int fetch_stats(struct atm_dev *dev,struct sonet_stats __user *arg,int zero)
42*4882a593Smuzhiyun {
43*4882a593Smuzhiyun 	struct sonet_stats tmp;
44*4882a593Smuzhiyun  	int error = 0;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	atomic_add(GET(HECCT),&PRIV(dev)->sonet_stats.uncorr_hcs);
47*4882a593Smuzhiyun 	sonet_copy_stats(&PRIV(dev)->sonet_stats,&tmp);
48*4882a593Smuzhiyun 	if (arg) error = copy_to_user(arg,&tmp,sizeof(tmp));
49*4882a593Smuzhiyun 	if (zero && !error) {
50*4882a593Smuzhiyun 		/* unused fields are reported as -1, but we must not "adjust"
51*4882a593Smuzhiyun 		   them */
52*4882a593Smuzhiyun 		tmp.corr_hcs = tmp.tx_cells = tmp.rx_cells = 0;
53*4882a593Smuzhiyun 		sonet_subtract_stats(&PRIV(dev)->sonet_stats,&tmp);
54*4882a593Smuzhiyun 	}
55*4882a593Smuzhiyun 	return error ? -EFAULT : 0;
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 
set_framing(struct atm_dev * dev,unsigned char framing)59*4882a593Smuzhiyun static int set_framing(struct atm_dev *dev,unsigned char framing)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun 	static const unsigned char sonet[] = { 1,2,3,0 };
62*4882a593Smuzhiyun 	static const unsigned char sdh[] = { 1,0,0,2 };
63*4882a593Smuzhiyun 	const char *set;
64*4882a593Smuzhiyun 	unsigned long flags;
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun 	switch (framing) {
67*4882a593Smuzhiyun 		case SONET_FRAME_SONET:
68*4882a593Smuzhiyun 			set = sonet;
69*4882a593Smuzhiyun 			break;
70*4882a593Smuzhiyun 		case SONET_FRAME_SDH:
71*4882a593Smuzhiyun 			set = sdh;
72*4882a593Smuzhiyun 			break;
73*4882a593Smuzhiyun 		default:
74*4882a593Smuzhiyun 			return -EINVAL;
75*4882a593Smuzhiyun 	}
76*4882a593Smuzhiyun 	spin_lock_irqsave(&PRIV(dev)->lock, flags);
77*4882a593Smuzhiyun 	PUT(set[0],C11T);
78*4882a593Smuzhiyun 	PUT(set[1],C12T);
79*4882a593Smuzhiyun 	PUT(set[2],C13T);
80*4882a593Smuzhiyun 	PUT((GET(MDR) & ~uPD98402_MDR_SS_MASK) | (set[3] <<
81*4882a593Smuzhiyun 	    uPD98402_MDR_SS_SHIFT),MDR);
82*4882a593Smuzhiyun 	spin_unlock_irqrestore(&PRIV(dev)->lock, flags);
83*4882a593Smuzhiyun 	return 0;
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 
get_sense(struct atm_dev * dev,u8 __user * arg)87*4882a593Smuzhiyun static int get_sense(struct atm_dev *dev,u8 __user *arg)
88*4882a593Smuzhiyun {
89*4882a593Smuzhiyun 	unsigned long flags;
90*4882a593Smuzhiyun 	unsigned char s[3];
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	spin_lock_irqsave(&PRIV(dev)->lock, flags);
93*4882a593Smuzhiyun 	s[0] = GET(C11R);
94*4882a593Smuzhiyun 	s[1] = GET(C12R);
95*4882a593Smuzhiyun 	s[2] = GET(C13R);
96*4882a593Smuzhiyun 	spin_unlock_irqrestore(&PRIV(dev)->lock, flags);
97*4882a593Smuzhiyun 	return (put_user(s[0], arg) || put_user(s[1], arg+1) ||
98*4882a593Smuzhiyun 	    put_user(s[2], arg+2) || put_user(0xff, arg+3) ||
99*4882a593Smuzhiyun 	    put_user(0xff, arg+4) || put_user(0xff, arg+5)) ? -EFAULT : 0;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 
set_loopback(struct atm_dev * dev,int mode)103*4882a593Smuzhiyun static int set_loopback(struct atm_dev *dev,int mode)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun 	unsigned char mode_reg;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	mode_reg = GET(MDR) & ~(uPD98402_MDR_TPLP | uPD98402_MDR_ALP |
108*4882a593Smuzhiyun 	    uPD98402_MDR_RPLP);
109*4882a593Smuzhiyun 	switch (__ATM_LM_XTLOC(mode)) {
110*4882a593Smuzhiyun 		case __ATM_LM_NONE:
111*4882a593Smuzhiyun 			break;
112*4882a593Smuzhiyun 		case __ATM_LM_PHY:
113*4882a593Smuzhiyun 			mode_reg |= uPD98402_MDR_TPLP;
114*4882a593Smuzhiyun 			break;
115*4882a593Smuzhiyun 		case __ATM_LM_ATM:
116*4882a593Smuzhiyun 			mode_reg |= uPD98402_MDR_ALP;
117*4882a593Smuzhiyun 			break;
118*4882a593Smuzhiyun 		default:
119*4882a593Smuzhiyun 			return -EINVAL;
120*4882a593Smuzhiyun 	}
121*4882a593Smuzhiyun 	switch (__ATM_LM_XTRMT(mode)) {
122*4882a593Smuzhiyun 		case __ATM_LM_NONE:
123*4882a593Smuzhiyun 			break;
124*4882a593Smuzhiyun 		case __ATM_LM_PHY:
125*4882a593Smuzhiyun 			mode_reg |= uPD98402_MDR_RPLP;
126*4882a593Smuzhiyun 			break;
127*4882a593Smuzhiyun 		default:
128*4882a593Smuzhiyun 			return -EINVAL;
129*4882a593Smuzhiyun 	}
130*4882a593Smuzhiyun 	PUT(mode_reg,MDR);
131*4882a593Smuzhiyun 	PRIV(dev)->loop_mode = mode;
132*4882a593Smuzhiyun 	return 0;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 
uPD98402_ioctl(struct atm_dev * dev,unsigned int cmd,void __user * arg)136*4882a593Smuzhiyun static int uPD98402_ioctl(struct atm_dev *dev,unsigned int cmd,void __user *arg)
137*4882a593Smuzhiyun {
138*4882a593Smuzhiyun 	switch (cmd) {
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 		case SONET_GETSTATZ:
141*4882a593Smuzhiyun                 case SONET_GETSTAT:
142*4882a593Smuzhiyun 			return fetch_stats(dev,arg, cmd == SONET_GETSTATZ);
143*4882a593Smuzhiyun 		case SONET_SETFRAMING:
144*4882a593Smuzhiyun 			return set_framing(dev, (int)(unsigned long)arg);
145*4882a593Smuzhiyun 		case SONET_GETFRAMING:
146*4882a593Smuzhiyun 			return put_user(PRIV(dev)->framing,(int __user *)arg) ?
147*4882a593Smuzhiyun 			    -EFAULT : 0;
148*4882a593Smuzhiyun 		case SONET_GETFRSENSE:
149*4882a593Smuzhiyun 			return get_sense(dev,arg);
150*4882a593Smuzhiyun 		case ATM_SETLOOP:
151*4882a593Smuzhiyun 			return set_loopback(dev, (int)(unsigned long)arg);
152*4882a593Smuzhiyun 		case ATM_GETLOOP:
153*4882a593Smuzhiyun 			return put_user(PRIV(dev)->loop_mode,(int __user *)arg) ?
154*4882a593Smuzhiyun 			    -EFAULT : 0;
155*4882a593Smuzhiyun 		case ATM_QUERYLOOP:
156*4882a593Smuzhiyun 			return put_user(ATM_LM_LOC_PHY | ATM_LM_LOC_ATM |
157*4882a593Smuzhiyun 			    ATM_LM_RMT_PHY,(int __user *)arg) ? -EFAULT : 0;
158*4882a593Smuzhiyun 		default:
159*4882a593Smuzhiyun 			return -ENOIOCTLCMD;
160*4882a593Smuzhiyun 	}
161*4882a593Smuzhiyun }
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun #define ADD_LIMITED(s,v) \
165*4882a593Smuzhiyun     { atomic_add(GET(v),&PRIV(dev)->sonet_stats.s); \
166*4882a593Smuzhiyun     if (atomic_read(&PRIV(dev)->sonet_stats.s) < 0) \
167*4882a593Smuzhiyun 	atomic_set(&PRIV(dev)->sonet_stats.s,INT_MAX); }
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 
stat_event(struct atm_dev * dev)170*4882a593Smuzhiyun static void stat_event(struct atm_dev *dev)
171*4882a593Smuzhiyun {
172*4882a593Smuzhiyun 	unsigned char events;
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun 	events = GET(PCR);
175*4882a593Smuzhiyun 	if (events & uPD98402_PFM_PFEB) ADD_LIMITED(path_febe,PFECB);
176*4882a593Smuzhiyun 	if (events & uPD98402_PFM_LFEB) ADD_LIMITED(line_febe,LECCT);
177*4882a593Smuzhiyun 	if (events & uPD98402_PFM_B3E) ADD_LIMITED(path_bip,B3ECT);
178*4882a593Smuzhiyun 	if (events & uPD98402_PFM_B2E) ADD_LIMITED(line_bip,B2ECT);
179*4882a593Smuzhiyun 	if (events & uPD98402_PFM_B1E) ADD_LIMITED(section_bip,B1ECT);
180*4882a593Smuzhiyun }
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun #undef ADD_LIMITED
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 
uPD98402_int(struct atm_dev * dev)186*4882a593Smuzhiyun static void uPD98402_int(struct atm_dev *dev)
187*4882a593Smuzhiyun {
188*4882a593Smuzhiyun 	static unsigned long silence = 0;
189*4882a593Smuzhiyun 	unsigned char reason;
190*4882a593Smuzhiyun 
191*4882a593Smuzhiyun 	while ((reason = GET(PICR))) {
192*4882a593Smuzhiyun 		if (reason & uPD98402_INT_LOS)
193*4882a593Smuzhiyun 			printk(KERN_NOTICE "%s(itf %d): signal lost\n",
194*4882a593Smuzhiyun 			    dev->type,dev->number);
195*4882a593Smuzhiyun 		if (reason & uPD98402_INT_PFM) stat_event(dev);
196*4882a593Smuzhiyun 		if (reason & uPD98402_INT_PCO) {
197*4882a593Smuzhiyun 			(void) GET(PCOCR); /* clear interrupt cause */
198*4882a593Smuzhiyun 			atomic_add(GET(HECCT),
199*4882a593Smuzhiyun 			    &PRIV(dev)->sonet_stats.uncorr_hcs);
200*4882a593Smuzhiyun 		}
201*4882a593Smuzhiyun 		if ((reason & uPD98402_INT_RFO) &&
202*4882a593Smuzhiyun 		    (time_after(jiffies, silence) || silence == 0)) {
203*4882a593Smuzhiyun 			printk(KERN_WARNING "%s(itf %d): uPD98402 receive "
204*4882a593Smuzhiyun 			    "FIFO overflow\n",dev->type,dev->number);
205*4882a593Smuzhiyun 			silence = (jiffies+HZ/2)|1;
206*4882a593Smuzhiyun 		}
207*4882a593Smuzhiyun 	}
208*4882a593Smuzhiyun }
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 
uPD98402_start(struct atm_dev * dev)211*4882a593Smuzhiyun static int uPD98402_start(struct atm_dev *dev)
212*4882a593Smuzhiyun {
213*4882a593Smuzhiyun 	DPRINTK("phy_start\n");
214*4882a593Smuzhiyun 	if (!(dev->phy_data = kmalloc(sizeof(struct uPD98402_priv),GFP_KERNEL)))
215*4882a593Smuzhiyun 		return -ENOMEM;
216*4882a593Smuzhiyun 	spin_lock_init(&PRIV(dev)->lock);
217*4882a593Smuzhiyun 	memset(&PRIV(dev)->sonet_stats,0,sizeof(struct k_sonet_stats));
218*4882a593Smuzhiyun 	(void) GET(PCR); /* clear performance events */
219*4882a593Smuzhiyun 	PUT(uPD98402_PFM_FJ,PCMR); /* ignore frequency adj */
220*4882a593Smuzhiyun 	(void) GET(PCOCR); /* clear overflows */
221*4882a593Smuzhiyun 	PUT(~uPD98402_PCO_HECC,PCOMR);
222*4882a593Smuzhiyun 	(void) GET(PICR); /* clear interrupts */
223*4882a593Smuzhiyun 	PUT(~(uPD98402_INT_PFM | uPD98402_INT_ALM | uPD98402_INT_RFO |
224*4882a593Smuzhiyun 	  uPD98402_INT_LOS),PIMR); /* enable them */
225*4882a593Smuzhiyun 	(void) fetch_stats(dev,NULL,1); /* clear kernel counters */
226*4882a593Smuzhiyun 	atomic_set(&PRIV(dev)->sonet_stats.corr_hcs,-1);
227*4882a593Smuzhiyun 	atomic_set(&PRIV(dev)->sonet_stats.tx_cells,-1);
228*4882a593Smuzhiyun 	atomic_set(&PRIV(dev)->sonet_stats.rx_cells,-1);
229*4882a593Smuzhiyun 	return 0;
230*4882a593Smuzhiyun }
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 
uPD98402_stop(struct atm_dev * dev)233*4882a593Smuzhiyun static int uPD98402_stop(struct atm_dev *dev)
234*4882a593Smuzhiyun {
235*4882a593Smuzhiyun 	/* let SAR driver worry about stopping interrupts */
236*4882a593Smuzhiyun 	kfree(PRIV(dev));
237*4882a593Smuzhiyun 	return 0;
238*4882a593Smuzhiyun }
239*4882a593Smuzhiyun 
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun static const struct atmphy_ops uPD98402_ops = {
242*4882a593Smuzhiyun 	.start		= uPD98402_start,
243*4882a593Smuzhiyun 	.ioctl		= uPD98402_ioctl,
244*4882a593Smuzhiyun 	.interrupt	= uPD98402_int,
245*4882a593Smuzhiyun 	.stop		= uPD98402_stop,
246*4882a593Smuzhiyun };
247*4882a593Smuzhiyun 
248*4882a593Smuzhiyun 
uPD98402_init(struct atm_dev * dev)249*4882a593Smuzhiyun int uPD98402_init(struct atm_dev *dev)
250*4882a593Smuzhiyun {
251*4882a593Smuzhiyun DPRINTK("phy_init\n");
252*4882a593Smuzhiyun 	dev->phy = &uPD98402_ops;
253*4882a593Smuzhiyun 	return 0;
254*4882a593Smuzhiyun }
255*4882a593Smuzhiyun 
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun MODULE_LICENSE("GPL");
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun EXPORT_SYMBOL(uPD98402_init);
260*4882a593Smuzhiyun 
uPD98402_module_init(void)261*4882a593Smuzhiyun static __init int uPD98402_module_init(void)
262*4882a593Smuzhiyun {
263*4882a593Smuzhiyun 	return 0;
264*4882a593Smuzhiyun }
265*4882a593Smuzhiyun module_init(uPD98402_module_init);
266*4882a593Smuzhiyun /* module_exit not defined so not unloadable */
267