1 | // SPDX-License-Identifier: GPL-2.0 |
2 | /* |
3 | * xtsonic.c |
4 | * |
5 | * (C) 2001 - 2007 Tensilica Inc. |
6 | * Kevin Chea <kchea@yahoo.com> |
7 | * Marc Gauthier <marc@linux-xtensa.org> |
8 | * Chris Zankel <chris@zankel.net> |
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 the XT2000. |
18 | */ |
19 | |
20 | #include <linux/kernel.h> |
21 | #include <linux/module.h> |
22 | #include <linux/types.h> |
23 | #include <linux/fcntl.h> |
24 | #include <linux/gfp.h> |
25 | #include <linux/interrupt.h> |
26 | #include <linux/init.h> |
27 | #include <linux/ioport.h> |
28 | #include <linux/in.h> |
29 | #include <linux/string.h> |
30 | #include <linux/delay.h> |
31 | #include <linux/errno.h> |
32 | #include <linux/netdevice.h> |
33 | #include <linux/etherdevice.h> |
34 | #include <linux/skbuff.h> |
35 | #include <linux/platform_device.h> |
36 | #include <linux/dma-mapping.h> |
37 | #include <linux/slab.h> |
38 | #include <linux/pgtable.h> |
39 | |
40 | #include <asm/io.h> |
41 | #include <asm/dma.h> |
42 | |
43 | static char xtsonic_string[] = "xtsonic" ; |
44 | |
45 | extern unsigned xtboard_nvram_valid(void); |
46 | extern void xtboard_get_ether_addr(unsigned char *buf); |
47 | |
48 | #include "sonic.h" |
49 | |
50 | /* |
51 | * According to the documentation for the Sonic ethernet controller, |
52 | * EOBC should be 760 words (1520 bytes) for 32-bit applications, and, |
53 | * as such, 2 words less than the buffer size. The value for RBSIZE |
54 | * defined in sonic.h, however is only 1520. |
55 | * |
56 | * (Note that in 16-bit configurations, EOBC is 759 words (1518 bytes) and |
57 | * RBSIZE 1520 bytes) |
58 | */ |
59 | #undef SONIC_RBSIZE |
60 | #define SONIC_RBSIZE 1524 |
61 | |
62 | /* |
63 | * The chip provides 256 byte register space. |
64 | */ |
65 | #define SONIC_MEM_SIZE 0x100 |
66 | |
67 | /* |
68 | * Macros to access SONIC registers |
69 | */ |
70 | #define SONIC_READ(reg) \ |
71 | (0xffff & *((volatile unsigned int *)dev->base_addr+reg)) |
72 | |
73 | #define SONIC_WRITE(reg,val) \ |
74 | *((volatile unsigned int *)dev->base_addr+reg) = val |
75 | |
76 | /* |
77 | * We cannot use station (ethernet) address prefixes to detect the |
78 | * sonic controller since these are board manufacturer depended. |
79 | * So we check for known Silicon Revision IDs instead. |
80 | */ |
81 | static unsigned short known_revisions[] = |
82 | { |
83 | 0x101, /* SONIC 83934 */ |
84 | 0xffff /* end of list */ |
85 | }; |
86 | |
87 | static int xtsonic_open(struct net_device *dev) |
88 | { |
89 | int retval; |
90 | |
91 | retval = request_irq(irq: dev->irq, handler: sonic_interrupt, flags: 0, name: "sonic" , dev); |
92 | if (retval) { |
93 | printk(KERN_ERR "%s: unable to get IRQ %d.\n" , |
94 | dev->name, dev->irq); |
95 | return -EAGAIN; |
96 | } |
97 | |
98 | retval = sonic_open(dev); |
99 | if (retval) |
100 | free_irq(dev->irq, dev); |
101 | return retval; |
102 | } |
103 | |
104 | static int xtsonic_close(struct net_device *dev) |
105 | { |
106 | int err; |
107 | err = sonic_close(dev); |
108 | free_irq(dev->irq, dev); |
109 | return err; |
110 | } |
111 | |
112 | static const struct net_device_ops xtsonic_netdev_ops = { |
113 | .ndo_open = xtsonic_open, |
114 | .ndo_stop = xtsonic_close, |
115 | .ndo_start_xmit = sonic_send_packet, |
116 | .ndo_get_stats = sonic_get_stats, |
117 | .ndo_set_rx_mode = sonic_multicast_list, |
118 | .ndo_tx_timeout = sonic_tx_timeout, |
119 | .ndo_validate_addr = eth_validate_addr, |
120 | .ndo_set_mac_address = eth_mac_addr, |
121 | }; |
122 | |
123 | static int sonic_probe1(struct net_device *dev) |
124 | { |
125 | unsigned int silicon_revision; |
126 | struct sonic_local *lp = netdev_priv(dev); |
127 | unsigned int base_addr = dev->base_addr; |
128 | int i; |
129 | int err = 0; |
130 | unsigned char addr[ETH_ALEN]; |
131 | |
132 | if (!request_mem_region(base_addr, 0x100, xtsonic_string)) |
133 | return -EBUSY; |
134 | |
135 | /* |
136 | * get the Silicon Revision ID. If this is one of the known |
137 | * one assume that we found a SONIC ethernet controller at |
138 | * the expected location. |
139 | */ |
140 | silicon_revision = SONIC_READ(SONIC_SR); |
141 | i = 0; |
142 | while ((known_revisions[i] != 0xffff) && |
143 | (known_revisions[i] != silicon_revision)) |
144 | i++; |
145 | |
146 | if (known_revisions[i] == 0xffff) { |
147 | pr_info("SONIC ethernet controller not found (0x%4x)\n" , |
148 | silicon_revision); |
149 | return -ENODEV; |
150 | } |
151 | |
152 | /* |
153 | * Put the sonic into software reset, then retrieve ethernet address. |
154 | * Note: we are assuming that the boot-loader has initialized the cam. |
155 | */ |
156 | SONIC_WRITE(SONIC_CMD,SONIC_CR_RST); |
157 | SONIC_WRITE(SONIC_DCR, |
158 | SONIC_DCR_WC0|SONIC_DCR_DW|SONIC_DCR_LBR|SONIC_DCR_SBUS); |
159 | SONIC_WRITE(SONIC_CEP,0); |
160 | SONIC_WRITE(SONIC_IMR,0); |
161 | |
162 | SONIC_WRITE(SONIC_CMD,SONIC_CR_RST); |
163 | SONIC_WRITE(SONIC_CEP,0); |
164 | |
165 | for (i=0; i<3; i++) { |
166 | unsigned int val = SONIC_READ(SONIC_CAP0-i); |
167 | addr[i*2] = val; |
168 | addr[i*2+1] = val >> 8; |
169 | } |
170 | eth_hw_addr_set(dev, addr); |
171 | |
172 | lp->dma_bitmode = SONIC_BITMODE32; |
173 | |
174 | err = sonic_alloc_descriptors(dev); |
175 | if (err) |
176 | goto out; |
177 | |
178 | dev->netdev_ops = &xtsonic_netdev_ops; |
179 | dev->watchdog_timeo = TX_TIMEOUT; |
180 | |
181 | /* |
182 | * clear tally counter |
183 | */ |
184 | SONIC_WRITE(SONIC_CRCT,0xffff); |
185 | SONIC_WRITE(SONIC_FAET,0xffff); |
186 | SONIC_WRITE(SONIC_MPT,0xffff); |
187 | |
188 | return 0; |
189 | out: |
190 | release_region(dev->base_addr, SONIC_MEM_SIZE); |
191 | return err; |
192 | } |
193 | |
194 | |
195 | /* |
196 | * Probe for a SONIC ethernet controller on an XT2000 board. |
197 | * Actually probing is superfluous but we're paranoid. |
198 | */ |
199 | |
200 | int xtsonic_probe(struct platform_device *pdev) |
201 | { |
202 | struct net_device *dev; |
203 | struct sonic_local *lp; |
204 | struct resource *resmem, *resirq; |
205 | int err = 0; |
206 | |
207 | if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL) |
208 | return -ENODEV; |
209 | |
210 | if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL) |
211 | return -ENODEV; |
212 | |
213 | if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL) |
214 | return -ENOMEM; |
215 | |
216 | lp = netdev_priv(dev); |
217 | lp->device = &pdev->dev; |
218 | platform_set_drvdata(pdev, data: dev); |
219 | SET_NETDEV_DEV(dev, &pdev->dev); |
220 | |
221 | dev->base_addr = resmem->start; |
222 | dev->irq = resirq->start; |
223 | |
224 | if ((err = sonic_probe1(dev))) |
225 | goto out; |
226 | |
227 | pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n" , |
228 | dev->base_addr, dev->dev_addr, dev->irq); |
229 | |
230 | sonic_msg_init(dev); |
231 | |
232 | if ((err = register_netdev(dev))) |
233 | goto undo_probe1; |
234 | |
235 | return 0; |
236 | |
237 | undo_probe1: |
238 | dma_free_coherent(dev: lp->device, |
239 | SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode), |
240 | cpu_addr: lp->descriptors, dma_handle: lp->descriptors_laddr); |
241 | release_region(dev->base_addr, SONIC_MEM_SIZE); |
242 | out: |
243 | free_netdev(dev); |
244 | |
245 | return err; |
246 | } |
247 | |
248 | MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver" ); |
249 | |
250 | #include "sonic.c" |
251 | |
252 | static void xtsonic_device_remove(struct platform_device *pdev) |
253 | { |
254 | struct net_device *dev = platform_get_drvdata(pdev); |
255 | struct sonic_local *lp = netdev_priv(dev); |
256 | |
257 | unregister_netdev(dev); |
258 | dma_free_coherent(dev: lp->device, |
259 | SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode), |
260 | cpu_addr: lp->descriptors, dma_handle: lp->descriptors_laddr); |
261 | release_region (dev->base_addr, SONIC_MEM_SIZE); |
262 | free_netdev(dev); |
263 | } |
264 | |
265 | static struct platform_driver xtsonic_driver = { |
266 | .probe = xtsonic_probe, |
267 | .remove_new = xtsonic_device_remove, |
268 | .driver = { |
269 | .name = xtsonic_string, |
270 | }, |
271 | }; |
272 | |
273 | module_platform_driver(xtsonic_driver); |
274 | |