1// SPDX-License-Identifier: GPL-2.0
2/*
3 * jazzsonic.c
4 *
5 * (C) 2005 Finn Thain
6 *
7 * Converted to DMA API, and (from the mac68k project) introduced
8 * dhd's support for 16-bit cards.
9 *
10 * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
11 *
12 * This driver is based on work from Andreas Busse, but most of
13 * the code is rewritten.
14 *
15 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
16 *
17 * A driver for the onboard Sonic ethernet controller on Mips Jazz
18 * systems (Acer Pica-61, Mips Magnum 4000, Olivetti M700 and
19 * perhaps others, too)
20 */
21
22#include <linux/kernel.h>
23#include <linux/module.h>
24#include <linux/types.h>
25#include <linux/fcntl.h>
26#include <linux/gfp.h>
27#include <linux/interrupt.h>
28#include <linux/ioport.h>
29#include <linux/in.h>
30#include <linux/string.h>
31#include <linux/delay.h>
32#include <linux/errno.h>
33#include <linux/netdevice.h>
34#include <linux/etherdevice.h>
35#include <linux/skbuff.h>
36#include <linux/platform_device.h>
37#include <linux/dma-mapping.h>
38#include <linux/slab.h>
39#include <linux/pgtable.h>
40
41#include <asm/bootinfo.h>
42#include <asm/io.h>
43#include <asm/dma.h>
44#include <asm/jazz.h>
45#include <asm/jazzdma.h>
46
47static char jazz_sonic_string[] = "jazzsonic";
48
49#define SONIC_MEM_SIZE 0x100
50
51#include "sonic.h"
52
53/*
54 * Macros to access SONIC registers
55 */
56#define SONIC_READ(reg) (*((volatile unsigned int *)dev->base_addr+reg))
57
58#define SONIC_WRITE(reg,val) \
59do { \
60 *((volatile unsigned int *)dev->base_addr+(reg)) = (val); \
61} while (0)
62
63/*
64 * We cannot use station (ethernet) address prefixes to detect the
65 * sonic controller since these are board manufacturer depended.
66 * So we check for known Silicon Revision IDs instead.
67 */
68static unsigned short known_revisions[] =
69{
70 0x04, /* Mips Magnum 4000 */
71 0xffff /* end of list */
72};
73
74static int jazzsonic_open(struct net_device* dev)
75{
76 int retval;
77
78 retval = request_irq(irq: dev->irq, handler: sonic_interrupt, flags: 0, name: "sonic", dev);
79 if (retval) {
80 printk(KERN_ERR "%s: unable to get IRQ %d.\n",
81 dev->name, dev->irq);
82 return retval;
83 }
84
85 retval = sonic_open(dev);
86 if (retval)
87 free_irq(dev->irq, dev);
88 return retval;
89}
90
91static int jazzsonic_close(struct net_device* dev)
92{
93 int err;
94 err = sonic_close(dev);
95 free_irq(dev->irq, dev);
96 return err;
97}
98
99static const struct net_device_ops sonic_netdev_ops = {
100 .ndo_open = jazzsonic_open,
101 .ndo_stop = jazzsonic_close,
102 .ndo_start_xmit = sonic_send_packet,
103 .ndo_get_stats = sonic_get_stats,
104 .ndo_set_rx_mode = sonic_multicast_list,
105 .ndo_tx_timeout = sonic_tx_timeout,
106 .ndo_validate_addr = eth_validate_addr,
107 .ndo_set_mac_address = eth_mac_addr,
108};
109
110static int sonic_probe1(struct net_device *dev)
111{
112 unsigned int silicon_revision;
113 unsigned int val;
114 struct sonic_local *lp = netdev_priv(dev);
115 int err = -ENODEV;
116 int i;
117 unsigned char addr[ETH_ALEN];
118
119 if (!request_mem_region(dev->base_addr, SONIC_MEM_SIZE, jazz_sonic_string))
120 return -EBUSY;
121
122 /*
123 * get the Silicon Revision ID. If this is one of the known
124 * one assume that we found a SONIC ethernet controller at
125 * the expected location.
126 */
127 silicon_revision = SONIC_READ(SONIC_SR);
128 i = 0;
129 while (known_revisions[i] != 0xffff &&
130 known_revisions[i] != silicon_revision)
131 i++;
132
133 if (known_revisions[i] == 0xffff) {
134 pr_info("SONIC ethernet controller not found (0x%4x)\n",
135 silicon_revision);
136 goto out;
137 }
138
139 /*
140 * Put the sonic into software reset, then
141 * retrieve and print the ethernet address.
142 */
143 SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
144 SONIC_WRITE(SONIC_CEP,0);
145 for (i=0; i<3; i++) {
146 val = SONIC_READ(SONIC_CAP0-i);
147 addr[i*2] = val;
148 addr[i*2+1] = val >> 8;
149 }
150 eth_hw_addr_set(dev, addr);
151
152 lp->dma_bitmode = SONIC_BITMODE32;
153
154 err = sonic_alloc_descriptors(dev);
155 if (err)
156 goto out;
157
158 dev->netdev_ops = &sonic_netdev_ops;
159 dev->watchdog_timeo = TX_TIMEOUT;
160
161 /*
162 * clear tally counter
163 */
164 SONIC_WRITE(SONIC_CRCT,0xffff);
165 SONIC_WRITE(SONIC_FAET,0xffff);
166 SONIC_WRITE(SONIC_MPT,0xffff);
167
168 return 0;
169out:
170 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
171 return err;
172}
173
174/*
175 * Probe for a SONIC ethernet controller on a Mips Jazz board.
176 * Actually probing is superfluous but we're paranoid.
177 */
178static int jazz_sonic_probe(struct platform_device *pdev)
179{
180 struct net_device *dev;
181 struct sonic_local *lp;
182 struct resource *res;
183 int err = 0;
184
185 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
186 if (!res)
187 return -ENODEV;
188
189 dev = alloc_etherdev(sizeof(struct sonic_local));
190 if (!dev)
191 return -ENOMEM;
192
193 lp = netdev_priv(dev);
194 lp->device = &pdev->dev;
195 SET_NETDEV_DEV(dev, &pdev->dev);
196 platform_set_drvdata(pdev, data: dev);
197
198 dev->base_addr = res->start;
199 dev->irq = platform_get_irq(pdev, 0);
200 err = sonic_probe1(dev);
201 if (err)
202 goto out;
203
204 pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n",
205 dev->base_addr, dev->dev_addr, dev->irq);
206
207 sonic_msg_init(dev);
208
209 err = register_netdev(dev);
210 if (err)
211 goto undo_probe1;
212
213 return 0;
214
215undo_probe1:
216 dma_free_coherent(dev: lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
217 cpu_addr: lp->descriptors, dma_handle: lp->descriptors_laddr);
218 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
219out:
220 free_netdev(dev);
221
222 return err;
223}
224
225MODULE_DESCRIPTION("Jazz SONIC ethernet driver");
226MODULE_ALIAS("platform:jazzsonic");
227
228#include "sonic.c"
229
230static void jazz_sonic_device_remove(struct platform_device *pdev)
231{
232 struct net_device *dev = platform_get_drvdata(pdev);
233 struct sonic_local* lp = netdev_priv(dev);
234
235 unregister_netdev(dev);
236 dma_free_coherent(dev: lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
237 cpu_addr: lp->descriptors, dma_handle: lp->descriptors_laddr);
238 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
239 free_netdev(dev);
240}
241
242static struct platform_driver jazz_sonic_driver = {
243 .probe = jazz_sonic_probe,
244 .remove_new = jazz_sonic_device_remove,
245 .driver = {
246 .name = jazz_sonic_string,
247 },
248};
249
250module_platform_driver(jazz_sonic_driver);
251

source code of linux/drivers/net/ethernet/natsemi/jazzsonic.c