xref: /OK3568_Linux_fs/kernel/drivers/net/ethernet/amd/hplance.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /* hplance.c  : the  Linux/hp300/lance ethernet driver
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 05/1998 Peter Maydell <pmaydell@chiark.greenend.org.uk>
5*4882a593Smuzhiyun  * Based on the Sun Lance driver and the NetBSD HP Lance driver
6*4882a593Smuzhiyun  * Uses the generic 7990.c LANCE code.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/module.h>
10*4882a593Smuzhiyun #include <linux/kernel.h>
11*4882a593Smuzhiyun #include <linux/types.h>
12*4882a593Smuzhiyun #include <linux/interrupt.h>
13*4882a593Smuzhiyun #include <linux/ioport.h>
14*4882a593Smuzhiyun #include <linux/string.h>
15*4882a593Smuzhiyun #include <linux/delay.h>
16*4882a593Smuzhiyun #include <linux/init.h>
17*4882a593Smuzhiyun #include <linux/errno.h>
18*4882a593Smuzhiyun #include <linux/pgtable.h>
19*4882a593Smuzhiyun /* Used for the temporal inet entries and routing */
20*4882a593Smuzhiyun #include <linux/socket.h>
21*4882a593Smuzhiyun #include <linux/route.h>
22*4882a593Smuzhiyun #include <linux/dio.h>
23*4882a593Smuzhiyun #include <linux/netdevice.h>
24*4882a593Smuzhiyun #include <linux/etherdevice.h>
25*4882a593Smuzhiyun #include <linux/skbuff.h>
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #include <asm/io.h>
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #include "hplance.h"
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun /* We have 16392 bytes of RAM for the init block and buffers. This places
32*4882a593Smuzhiyun  * an upper limit on the number of buffers we can use. NetBSD uses 8 Rx
33*4882a593Smuzhiyun  * buffers and 2 Tx buffers, it takes (8 + 2) * 1544 bytes.
34*4882a593Smuzhiyun  */
35*4882a593Smuzhiyun #define LANCE_LOG_TX_BUFFERS 1
36*4882a593Smuzhiyun #define LANCE_LOG_RX_BUFFERS 3
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #include "7990.h"                                 /* use generic LANCE code */
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun /* Our private data structure */
41*4882a593Smuzhiyun struct hplance_private {
42*4882a593Smuzhiyun 	struct lance_private lance;
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /* function prototypes... This is easy because all the grot is in the
46*4882a593Smuzhiyun  * generic LANCE support. All we have to support is probing for boards,
47*4882a593Smuzhiyun  * plus board-specific init, open and close actions.
48*4882a593Smuzhiyun  * Oh, and we need to tell the generic code how to read and write LANCE registers...
49*4882a593Smuzhiyun  */
50*4882a593Smuzhiyun static int hplance_init_one(struct dio_dev *d, const struct dio_device_id *ent);
51*4882a593Smuzhiyun static void hplance_init(struct net_device *dev, struct dio_dev *d);
52*4882a593Smuzhiyun static void hplance_remove_one(struct dio_dev *d);
53*4882a593Smuzhiyun static void hplance_writerap(void *priv, unsigned short value);
54*4882a593Smuzhiyun static void hplance_writerdp(void *priv, unsigned short value);
55*4882a593Smuzhiyun static unsigned short hplance_readrdp(void *priv);
56*4882a593Smuzhiyun static int hplance_open(struct net_device *dev);
57*4882a593Smuzhiyun static int hplance_close(struct net_device *dev);
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun static struct dio_device_id hplance_dio_tbl[] = {
60*4882a593Smuzhiyun 	{ DIO_ID_LAN },
61*4882a593Smuzhiyun 	{ 0 }
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun static struct dio_driver hplance_driver = {
65*4882a593Smuzhiyun 	.name      = "hplance",
66*4882a593Smuzhiyun 	.id_table  = hplance_dio_tbl,
67*4882a593Smuzhiyun 	.probe     = hplance_init_one,
68*4882a593Smuzhiyun 	.remove    = hplance_remove_one,
69*4882a593Smuzhiyun };
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun static const struct net_device_ops hplance_netdev_ops = {
72*4882a593Smuzhiyun 	.ndo_open		= hplance_open,
73*4882a593Smuzhiyun 	.ndo_stop		= hplance_close,
74*4882a593Smuzhiyun 	.ndo_start_xmit		= lance_start_xmit,
75*4882a593Smuzhiyun 	.ndo_set_rx_mode	= lance_set_multicast,
76*4882a593Smuzhiyun 	.ndo_validate_addr	= eth_validate_addr,
77*4882a593Smuzhiyun 	.ndo_set_mac_address	= eth_mac_addr,
78*4882a593Smuzhiyun #ifdef CONFIG_NET_POLL_CONTROLLER
79*4882a593Smuzhiyun 	.ndo_poll_controller	= lance_poll,
80*4882a593Smuzhiyun #endif
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun /* Find all the HP Lance boards and initialise them... */
hplance_init_one(struct dio_dev * d,const struct dio_device_id * ent)84*4882a593Smuzhiyun static int hplance_init_one(struct dio_dev *d, const struct dio_device_id *ent)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	struct net_device *dev;
87*4882a593Smuzhiyun 	int err = -ENOMEM;
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	dev = alloc_etherdev(sizeof(struct hplance_private));
90*4882a593Smuzhiyun 	if (!dev)
91*4882a593Smuzhiyun 		goto out;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	err = -EBUSY;
94*4882a593Smuzhiyun 	if (!request_mem_region(dio_resource_start(d),
95*4882a593Smuzhiyun 				dio_resource_len(d), d->name))
96*4882a593Smuzhiyun 		goto out_free_netdev;
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	hplance_init(dev, d);
99*4882a593Smuzhiyun 	err = register_netdev(dev);
100*4882a593Smuzhiyun 	if (err)
101*4882a593Smuzhiyun 		goto out_release_mem_region;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	dio_set_drvdata(d, dev);
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	printk(KERN_INFO "%s: %s; select code %d, addr %pM, irq %d\n",
106*4882a593Smuzhiyun 	       dev->name, d->name, d->scode, dev->dev_addr, d->ipl);
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	return 0;
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun  out_release_mem_region:
111*4882a593Smuzhiyun 	release_mem_region(dio_resource_start(d), dio_resource_len(d));
112*4882a593Smuzhiyun  out_free_netdev:
113*4882a593Smuzhiyun 	free_netdev(dev);
114*4882a593Smuzhiyun  out:
115*4882a593Smuzhiyun 	return err;
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun 
hplance_remove_one(struct dio_dev * d)118*4882a593Smuzhiyun static void hplance_remove_one(struct dio_dev *d)
119*4882a593Smuzhiyun {
120*4882a593Smuzhiyun 	struct net_device *dev = dio_get_drvdata(d);
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	unregister_netdev(dev);
123*4882a593Smuzhiyun 	release_mem_region(dio_resource_start(d), dio_resource_len(d));
124*4882a593Smuzhiyun 	free_netdev(dev);
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun /* Initialise a single lance board at the given DIO device */
hplance_init(struct net_device * dev,struct dio_dev * d)128*4882a593Smuzhiyun static void hplance_init(struct net_device *dev, struct dio_dev *d)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun 	unsigned long va = (d->resource.start + DIO_VIRADDRBASE);
131*4882a593Smuzhiyun 	struct hplance_private *lp;
132*4882a593Smuzhiyun 	int i;
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	/* reset the board */
135*4882a593Smuzhiyun 	out_8(va + DIO_IDOFF, 0xff);
136*4882a593Smuzhiyun 	udelay(100);                              /* ariba! ariba! udelay! udelay! */
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	/* Fill the dev fields */
139*4882a593Smuzhiyun 	dev->base_addr = va;
140*4882a593Smuzhiyun 	dev->netdev_ops = &hplance_netdev_ops;
141*4882a593Smuzhiyun 	dev->dma = 0;
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	for (i = 0; i < 6; i++) {
144*4882a593Smuzhiyun 		/* The NVRAM holds our ethernet address, one nibble per byte,
145*4882a593Smuzhiyun 		 * at bytes NVRAMOFF+1,3,5,7,9...
146*4882a593Smuzhiyun 		 */
147*4882a593Smuzhiyun 		dev->dev_addr[i] = ((in_8(va + HPLANCE_NVRAMOFF + i*4 + 1) & 0xF) << 4)
148*4882a593Smuzhiyun 			| (in_8(va + HPLANCE_NVRAMOFF + i*4 + 3) & 0xF);
149*4882a593Smuzhiyun 	}
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	lp = netdev_priv(dev);
152*4882a593Smuzhiyun 	lp->lance.name = d->name;
153*4882a593Smuzhiyun 	lp->lance.base = va;
154*4882a593Smuzhiyun 	lp->lance.init_block = (struct lance_init_block *)(va + HPLANCE_MEMOFF); /* CPU addr */
155*4882a593Smuzhiyun 	lp->lance.lance_init_block = NULL;              /* LANCE addr of same RAM */
156*4882a593Smuzhiyun 	lp->lance.busmaster_regval = LE_C3_BSWP;        /* we're bigendian */
157*4882a593Smuzhiyun 	lp->lance.irq = d->ipl;
158*4882a593Smuzhiyun 	lp->lance.writerap = hplance_writerap;
159*4882a593Smuzhiyun 	lp->lance.writerdp = hplance_writerdp;
160*4882a593Smuzhiyun 	lp->lance.readrdp = hplance_readrdp;
161*4882a593Smuzhiyun 	lp->lance.lance_log_rx_bufs = LANCE_LOG_RX_BUFFERS;
162*4882a593Smuzhiyun 	lp->lance.lance_log_tx_bufs = LANCE_LOG_TX_BUFFERS;
163*4882a593Smuzhiyun 	lp->lance.rx_ring_mod_mask = RX_RING_MOD_MASK;
164*4882a593Smuzhiyun 	lp->lance.tx_ring_mod_mask = TX_RING_MOD_MASK;
165*4882a593Smuzhiyun }
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun /* This is disgusting. We have to check the DIO status register for ack every
168*4882a593Smuzhiyun  * time we read or write the LANCE registers.
169*4882a593Smuzhiyun  */
hplance_writerap(void * priv,unsigned short value)170*4882a593Smuzhiyun static void hplance_writerap(void *priv, unsigned short value)
171*4882a593Smuzhiyun {
172*4882a593Smuzhiyun 	struct lance_private *lp = (struct lance_private *)priv;
173*4882a593Smuzhiyun 	do {
174*4882a593Smuzhiyun 		out_be16(lp->base + HPLANCE_REGOFF + LANCE_RAP, value);
175*4882a593Smuzhiyun 	} while ((in_8(lp->base + HPLANCE_STATUS) & LE_ACK) == 0);
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun 
hplance_writerdp(void * priv,unsigned short value)178*4882a593Smuzhiyun static void hplance_writerdp(void *priv, unsigned short value)
179*4882a593Smuzhiyun {
180*4882a593Smuzhiyun 	struct lance_private *lp = (struct lance_private *)priv;
181*4882a593Smuzhiyun 	do {
182*4882a593Smuzhiyun 		out_be16(lp->base + HPLANCE_REGOFF + LANCE_RDP, value);
183*4882a593Smuzhiyun 	} while ((in_8(lp->base + HPLANCE_STATUS) & LE_ACK) == 0);
184*4882a593Smuzhiyun }
185*4882a593Smuzhiyun 
hplance_readrdp(void * priv)186*4882a593Smuzhiyun static unsigned short hplance_readrdp(void *priv)
187*4882a593Smuzhiyun {
188*4882a593Smuzhiyun 	struct lance_private *lp = (struct lance_private *)priv;
189*4882a593Smuzhiyun 	__u16 value;
190*4882a593Smuzhiyun 	do {
191*4882a593Smuzhiyun 		value = in_be16(lp->base + HPLANCE_REGOFF + LANCE_RDP);
192*4882a593Smuzhiyun 	} while ((in_8(lp->base + HPLANCE_STATUS) & LE_ACK) == 0);
193*4882a593Smuzhiyun 	return value;
194*4882a593Smuzhiyun }
195*4882a593Smuzhiyun 
hplance_open(struct net_device * dev)196*4882a593Smuzhiyun static int hplance_open(struct net_device *dev)
197*4882a593Smuzhiyun {
198*4882a593Smuzhiyun 	int status;
199*4882a593Smuzhiyun 	struct lance_private *lp = netdev_priv(dev);
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	status = lance_open(dev);                 /* call generic lance open code */
202*4882a593Smuzhiyun 	if (status)
203*4882a593Smuzhiyun 		return status;
204*4882a593Smuzhiyun 	/* enable interrupts at board level. */
205*4882a593Smuzhiyun 	out_8(lp->base + HPLANCE_STATUS, LE_IE);
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun 	return 0;
208*4882a593Smuzhiyun }
209*4882a593Smuzhiyun 
hplance_close(struct net_device * dev)210*4882a593Smuzhiyun static int hplance_close(struct net_device *dev)
211*4882a593Smuzhiyun {
212*4882a593Smuzhiyun 	struct lance_private *lp = netdev_priv(dev);
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun 	out_8(lp->base + HPLANCE_STATUS, 0);	/* disable interrupts at boardlevel */
215*4882a593Smuzhiyun 	lance_close(dev);
216*4882a593Smuzhiyun 	return 0;
217*4882a593Smuzhiyun }
218*4882a593Smuzhiyun 
hplance_init_module(void)219*4882a593Smuzhiyun static int __init hplance_init_module(void)
220*4882a593Smuzhiyun {
221*4882a593Smuzhiyun 	return dio_register_driver(&hplance_driver);
222*4882a593Smuzhiyun }
223*4882a593Smuzhiyun 
hplance_cleanup_module(void)224*4882a593Smuzhiyun static void __exit hplance_cleanup_module(void)
225*4882a593Smuzhiyun {
226*4882a593Smuzhiyun 	dio_unregister_driver(&hplance_driver);
227*4882a593Smuzhiyun }
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun module_init(hplance_init_module);
230*4882a593Smuzhiyun module_exit(hplance_cleanup_module);
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun MODULE_LICENSE("GPL");
233